PHP - openssl_pkey_export_to_file() 函数_PHP 菜鸟教程

定义用法

openssl_pkey_export_to_file() 函数会将密钥导出到文件中。相关请看 OpenSSL 函数。

描述

openssl_pkey_export_to_file() 函数以 PEM 格式保存密钥。PEM 代表隐私增强邮件，它主要存储加密密钥和证书。

语法

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

参数

参数	描述
key	要导出到文件的密钥。
outfilename	outfilename 是要保存 .pem 文件的路径。
passphrase	可用于保护文件的密码。
configargs	参数 configargs 是生成私钥/公钥对时需要提供给函数的配置详细信息。详情如下所述。

参数 configargs

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

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

返回值

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

PHP 版本

此函数将在 PHP 版本高于 5.0.0 的情况下工作。

示例 1

openssl_pkey_export_to_file() 的工作 -

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

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

示例 2

要从 .pem 文件获取密钥 -

<?php
   // 创建私钥
   $privkey = openssl_pkey_new();
   openssl_pkey_export_to_file($privkey, 'C:/htdocs/openssl/keytest.pem');
    
   // 使用带有私钥的.pem文件。
   $testprivatekey = openssl_get_privatekey(file_get_contents('C:/htdocs/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 存储的详细信息如下 -

<< PHP - openssl_pkey_get_public() 函数 PHP - openssl_private_encrypt() 函数 >>