PHP - 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 是需要提供給函式以生成私鑰/公鑰對的配置詳細資訊。詳細資訊如下所示。

configargs

預設情況下，openssl_pkey_new() 使用 openssl.cnf 中存在的配置詳細資訊。但是，使用 configargs 可以覆蓋它們。配置詳細資訊如下

configargs 中的 key	型別	openssl.conf 中使用的 key	描述
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	整數	無	要建立的私鑰型別。可以是 OPENSSL_KEYTYPE_DSA、OPENSSL_KEYTYPE_DH、OPENSSL_KEYTYPE_RSA 或 OPENSSL_KEYTYPE_EC 之一。預設值為 OPENSSL_KEYTYPE_RSA。
encrypt_key	布林值	encrypt_key	匯出的金鑰是否加密？
encrypt_key_cipher	整數	無	加密常量，例如 OPENSSL_CIPHER_RC2_40（整數）、OPENSSL_CIPHER_RC2_128（整數）、OPENSSL_CIPHER_RC2_64（整數）、OPENSSL_CIPHER_DES（整數）、OPENSSL_CIPHER_3DES（整數）等。
curve_name	字串	無	此函式 openssl_get_curve_names() 返回的曲線名稱之一。
config	字串	N/A	可以根據需要更改 openssl.conf 中的配置，並在此處提供其路徑。

返回值

PHP openssl_pkey_export_to_file() 函式在成功時返回 true，失敗時返回 false。

PHP 版本

此函式適用於 PHP 5.0.0 及更高版本。

示例 1

openssl_pkey_export_to_file() 的工作原理 -

<?php
   //creating private key
   $privkey = openssl_pkey_new();
   openssl_pkey_export_to_file($privkey, 'C:/xampp/htdocs/modules/openssl/keytest.pem');
?>

keytest.pem 檔案中儲存的詳細資訊如下所示 -

示例 2

從 .pem 檔案中獲取金鑰 -

<?php
   //creating private key
   $privkey = openssl_pkey_new();
   openssl_pkey_export_to_file($privkey, 'C:/xampp/htdocs/modules/openssl/keytest.pem');
	
   //using .pem file with private key.
   $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 檔案中儲存的詳細資訊如下所示 -

php_function_reference.htm

列印頁面