PHP - openssl_pkey_new() 函式

定義和用法

openssl_pkey_new() 函式將返回一個資源識別符號，該識別符號包含新的私鑰和公鑰對。

描述

openssl_pkey_new() 函式返回一個資源識別符號。您可以使用 openssl_pkey_get_details() 函式獲取生成的金鑰的所有詳細資訊。金鑰（公鑰/私鑰對）稍後將與其他 openssl 函式一起使用，例如 openssl_sign()、openssl_csr_new()（獲取 CSR 證書），這有助於建立加密數字簽名。

語法

openssl_pkey_new ([ array $configargs ] ) : resource

引數

序號	引數	描述
1	configargs	引數 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	整數	無	要建立的私鑰型別。它可以是 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_new() 函式將返回一個資源識別符號。如果金鑰生成失敗，它將返回 false。

PHP 版本

此函式適用於 PHP 5.0.0 以上版本。

示例 1

openssl_pkey_new() 的工作原理

<?php
   // Generate a new private (and public) key pair
   $privkey = openssl_pkey_new(array(
      "digest_alg"=>'md5',
      "private_key_bits" => 2048,
      "private_key_type" => OPENSSL_KEYTYPE_RSA,
   ));
   var_dump($privkey);
?>

這將產生以下結果

resource(2) of type (OpenSSL key)

示例 2

openssl_pkey_new() 和 openssl_pkey_get_details 的工作原理

<?php
   // Generate a new private (and public) key pair
   $privkey = openssl_pkey_new(array(
      "digest_alg"=>'md5',
      "private_key_bits" => 2048,
      "private_key_type" => OPENSSL_KEYTYPE_RSA,
   ));
   $key_details = openssl_pkey_get_details($privkey);
   print_r($key_details);
?>

這將產生以下結果

Array (
   [bits] => 2048
   [key] => -----BEGIN PUBLIC KEY-----
   MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA1IGWxnWzICSkjrOVrYkw
   9EKpIhcAYbhaymiwQY/ii9d7hnuGhpjjitDxzFftGafL6XOFKOhgbO2yrcpFxRKu
   AY3t5wyUcqUJV6CNwV2Hipk90psUcTmK3+pcCzcqCKr7sLWlHI48lse92xane8Sf
   CATNNbr9vmqUaTZ9FQqWihm3o/rNGuZTwMSKvcKsVguFpwrEDJaSLP1nt7RSHGc+
   PixQSXp3PtQCH+S0CM9jt1jD9NkYXuuAlNbrsPm1fl2zAGR5Vh15evz5765lZ2mH
   LIZScfsO/qgai3R6foaBlJM5tiSeiVZgnnQDKFBi5XK2GhzDnKggJe4tdY7awTFm
   CQIDAQAB
   -----END PUBLIC KEY-----

   [rsa] => Array (
      [n] => ԁ��u� $��0�B�"a�Z�h�A��{�{��W���s�(�`l��E�����r�	W��]��=қq9��\7*���<�ǽ��{ğ�5��j�i6}
      �����S�Ċ�¬V��
      ���,�g��Rg>>,PIzw>���c�X��^뀔��~]�dyVyz��egi�,�Rq����tz~��9�$��V`�t(Pb�r�Ü� %�-u��1f	
         [e] => 
         [d] => F"��3��4��!K�yF��R�lY�9�]Ξ��A��@�f��~�<�YPєG��=��TkTP�rl�Mԓ{�lŮ^��!��q�˂�7�|�f��lE+#�@.�GIH�tS�R.mbc�U~��7&w�ݥ�P.Fe�ϨU�@��m��X�ECsemjI$@/�$l��)�8�@���c�w�NRo��+!'�.��fvT7�=n")LQ�sd�%zZ��G��{�{�1A^��v��E
         [p] => �>u)��1bǰK�r��pHE��k���LBE��y�'�3-�/��Pd��jeFV1����?�.O���:�bl2�z�U�{��{��*��A���<�}m4��J�Y�'�f@���
         [q] => ߦz\��96�=��V]"k��2w��>�r�袤�6�/�-Z�_��8!Y��I��L���_3Ym���.p�֏^��>�I:��oZ��"��=��8���뻢1��:�
         [dmp1] => z"�TW*��Ƴm�$�HQ�$0��sa��j� #�
         P�*�P��Q�G\42�a�26(�5�K�7zj��xj7��@e�$.6��b�Dq]]I}�L�m�d��54)@:���#
         [dmq1] => +��4}��\dc�R�K�Bw�\�E6�����%_�m$3蚞9�Fh�D�uz��$�8HPK�ˇԁ^�K�k�]e�g�>ºX�"<ƌ�`ė��&,9E��MS"��¥�)
         [iqmp] => !��߷�=�z�=ܰ7��V�6q�~���3V��t�P�$��O�kgv��3=W\ѝm���	�J���5^�K��a�t��~��U�.��!�l�v�#��z*���	���r
      )
      [type] => 0
   )

示例 3

從 openssl_pkey_new() 讀取公鑰

<?php
   echo "The hash of Welcome to Tutorialspoint is - ". hash('crc32b', 'Welcome to Tutorialspoint');
?>

這將產生以下結果

示例 4

將 openssl_pkey_new() 中的公鑰儲存到檔案中

<?php
   // Generate a new private (and public) key pair

   $privkey = openssl_pkey_new(array(
      "digest_alg"=>'md5',
      "private_key_bits" => 2048,
      "private_key_type" => OPENSSL_KEYTYPE_RSA,
   ));
   $keydetails = openssl_pkey_get_details($privkey);

   // To save the public key to a file 
   file_put_contents('mypublic.key', $keydetails['key']);
?>

檔案 mypublic.key 的內容是

php_function_reference.htm

列印頁面