【PHP8.x】openssl_pkey_get_details関数の使い方
作成日: 更新日:
『openssl_pkey_get_details関数は、指定されたキーリソースまたはキーオブジェクトから詳細情報を抽出し、連想配列として返す関数です。この関数は、openssl_pkey_new
関数などで生成されたOpenSSLAsymmetricKey
オブジェクトや証明書リソース、PEM形式でエンコードされたキー文字列などを引数に取ります。処理が成功すると、キーの詳細情報が格納された連想配列が返され、失敗した場合はfalse
が返されます。返される連想配列には、キーのビット数を示すbits
、公開鍵のPEM形式文字列であるkey
、そしてキーの種類(RSA、DSA、ECなど)を示すtype
といった共通の要素が含まれています。さらに、キーのtype
に応じて、RSAキーであればモジュラスや指数、ECキーであれば曲線名といった、その鍵の種類に固有のパラメータ群も配列内に格納されます。この関数を使用することで、プログラム上で鍵の強度や種類、構成要素を動的に確認できるため、鍵の検証やデバッグ、特定の暗号アルゴリズムの選択などに活用することが可能です。
基本的な使い方
構文(syntax)
openssl_pkey_get_details(OpenSSLAsymmetricKey $key): array|false
引数(parameters)
OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $key
- OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $key: 公開鍵の情報を取得したい公開鍵リソース。OpenSSLAsymmetricKey オブジェクト、OpenSSLCertificate オブジェクト、または鍵情報を表す配列や文字列を指定できます。
戻り値(return)
array|false
openssl_pkey_get_details 関数は、指定された公開鍵または秘密鍵の詳細情報を配列で返します。鍵の詳細情報が得られなかった場合は false を返します。