PHP openssl_pkey_export_to_file() 函数用法及示例

PHP OpenSSL 函数手册

openssl_pkey_export_to_file()函数用于将密钥导出到文件中。

定义和用法

openssl_pkey_export_to_file()函数会将密钥导出到文件中。

openssl_pkey_export_to_file()函数以PEM格式保存密钥，PEM代表Privacy-Enhanced Mail，主要存储加密密钥和证书。

语法

openssl_pkey_export_to_file ( mixed $key , string $outfilename [, string $passphrase [, array $configargs ]] ) : bool

参数

序号参数描述
1

key

要导出到文件的密钥。

2

outfilename

outfilename是保存.pem文件的路径。

3

passphrase

可用于保护文件的密码。

4

configargs

参数configargs是需要提供给函数以生成私钥/公钥对的配置详细信息，详细信息如下所述。

配置参数

默认情况下，openssl_pkey_new()使用openssl.cnf中存在的配置详细信息。但是使用configargs可以覆盖它们。配置详细信息如下：

configargs类型openssl.conf中使用的密钥描述
digest_alg字符串default_md您从openssl_get_md_methods()获得的摘要方法。
x509_extensions字符串x509_extensions创建x509证书时使用的扩展名。
req_extensions字符串req_extensions创建CSR时使用的扩展名。
private_key_bits整数default_bits指定在生成私钥时要使用的位数。
private_key_type整数none要创建的私钥类型。它可以是OPENSSL_KEYTYPE_DSA，OPENSSL_KEYTYPE_DH，OPENSSL_KEYTYPE_RSA或OPENSSL_KEYTYPE_EC中的一种。默认值为OPENSSL_KEYTYPE_RSA。
encrypt_key布尔值encrypt_key导出的密钥是否被加密？
encrypt_key_cipher整数none密码常数，例如OPENSSL_CIPHER_RC2_40（整数），OPENSSL_CIPHER_RC2_128（整数），OPENSSL_CIPHER_RC2_64（整数），OPENSSL_CIPHER_DES（整数），OPENSSL_CIPHER_3DES（整数）等。
curve_name字符串none此openssl_get_curve_names()函数返回的曲线名称之一。
config字符串N/A您可以根据需要在openssl.conf中更改配置，并在此处提供其路径。

返回值

PHP openssl_pkey_export_to_file()函数如果成功则返回true，否则返回false。

PHP版本

此函数将从大于5.0.0的PHP版本开始工作。

实例1

openssl_pkey_export_to_file()的工作-

<?php
        //创建私钥
	$privkey = openssl_pkey_new();
	openssl_pkey_export_to_file($privkey, 'C:/xampp/htdocs/modules/openssl/keytest.pem');
?>

存储在文件keytest.pem中的详细信息如下-

-----BEGIN PRIVATE KEY-----
MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDaqNK97A+mL9Xu
IDt3rz9yfFUvrLcDEvsDa9JsjQByJVbdRtaNl6nfg91/LfKO8zAeG8srd292jcYk
9MgBhkpMCHvF/QhWjA4IdPLdWHCbYfjF/LHmo/z022/FqTnjQtFws992/ClhZdo6
kpDlU/H2lmbnCwrsqHlqcQ7bzBgC5U5SW0t3A03PSqxQTIFPOHi1Yx1Il5jH/H11
6UXDKogAWsseRpdwVdsCy6Wj3rkybr1pr7CDkHSS49MAvJ4e6xhs+je12lrtyChR
ZTIYLICzEG7a1n0BPGAI1bQcivHXNipUkAYFn221gKRuB+9SQvC3VKbNXy8Oc7N9
HEahD8S3AgMBAAECggEBAKzEU68og7zlcvzxjsskNtd4kb5Xk0rkhlzPprWKO131
TssLm57IxLoMcMh6P3rff5dqkn9HoVRk9LhiiF1cA/xLf7CSGzJ2+ueHsBVgOaks
IeodnVsFG2tEru3YphqAwwdvuBNFblS8q084WzA3waj6cVgAi6MuArEtn3XfruEp
Yryc4Y1I1SB92x4y85tZ/PcomumPH0djKQeuhzy7f7GloJRfdshNENRbkdLc65N5
j8hy7WxMSa0dpJ3ZJMmgNfek9nALntSZfOsHGMZ/Wog8eV6+HzCwqqrMkR15pZI1
HqvVszU1iwoUJvlGoxInJOqJ2c6lBSBOBBR8DuuQixECgYEA+8RKXcw0U3VU8zJO
NTFzSDEtFYKZ5Bg4IPaYSTSo/ojiL3VrLeocRq3/2zdeCw8wx9eNZbcBW93lWVxK
q2G0X4XgonorEEONBvL9aE/D7wBCMYPWDXd/KQVZW8CPwcy10g2oIi3SqbcTQ/gT
fcmcHAQD2wVgo9XBlg24ESAP01MCgYEA3lYGasOvDweca5GCiP4m1oOH605haIUU
f5CDWXbZ6QjcoUQQB0CoDtTl3QpBd3KGbd+PbqU8xb44+LhrVIsjUyZs6k+eLACe
Dufzq00mIRSl/TZ0R3q17lAMmxId9QramDScpmqqqXonpOpdEoonThynhLyANgX3
eYGLXeqaII0CgYBPVi/JFwx2MEcwy+1xPcACQ9zdJmawRiGJ4atjhkCq1R/RrMK1
mUyHyVUTE4ODIKpSj05zexPmiyo22qp9DzDz2RBMowrm+SJ7yh6ovFoV+pLhX5YY
cEuV9aWPEEM84vF42+zbuGzmJlbf2FDsFpgnC+zbG/q0Jiv2ySPz4ZKbGQKBgQDM
ek9ih1+LshNAts1Xkm5DoSoy1Z4uUx48B7tVX0If2N+YjRE0qlklctWIiXMWGMTb
bdzrBJq0vjKFRI6pbWFqio9mmxy8GUFEMjzekZB8ohHao+cjCg8iAorlXy8f+wB5
NQHQ547XWRn2yPgaIebuJtpF8Fr11Fz6aZK0KBvhzQKBgGRwuxq6IhIROupoDRpU
RHuqICeQQYcf7Cfk7+ZyYJnA1fbOowj4Q5zvbWa6N2Ygyq2KIl0P5YL4Atb7aRKS
e6ol8lIKZM9ysbS+wR0OhhTJs/9CqpgvDbYNQFiaVZtGRpSNCxHkhn0cAR7lzK4P
ROQC7p9zXJhAmzE8/hTD9eaH
-----END PRIVATE KEY-----

实例2

从.pem文件中获取密钥-

<?php
        //创建私钥
	$privkey = openssl_pkey_new();
	openssl_pkey_export_to_file($privkey, 'C:/xampp/htdocs/modules/openssl/keytest.pem');
	
	//使用带有私钥的.pem文件。
	$testprivatekey = openssl_get_privatekey(file_get_contents('C:/xampp/htdocs/modules/openssl/keytest.pem'));
	if ($testprivatekey === false) {
		var_dump(openssl_error_string());
	} else {
		//var_dump($testprivatekey);
		$key_details = openssl_pkey_get_details($testprivatekey);
		print_r($key_details["key"]);	
	}
?>

存储在文件test-csr1.pem中的详细信息如下-

-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAnbGAblUCP6sZvbi2JM4G
PcLmKK9flGQq6EE+yvMWrEUnIPGOLJUEB06dE8inIMQTYDmdmjn7HgUAlIDaViw+
aSv3XBZJqBTm7xtW4488oKuCzdBuJbnomtGttFWOk4cjb8kG+Kza6v0AB+P0eUru
cPkwnJF4F1pGY1pszSMsL3/s7OcIzjiKUKu5vHJxUWO7baVovq+gv9+O24Pd0GhB
t6RC/pgK/42YqZ2YW5V+JiuCFFkTVPusviunAOLLpDwoyPIROvXdML2TKopiowOd
nmOkNRrW81duRF8Z4dcn7jnf2sKExpLBgAtcV05OufZIv3VeeTD0ISbCJhn0zmx/
SQIDAQAB
-----END PUBLIC KEY-----

PHP OpenSSL 函数手册