openssl_pkey_get_private

(PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8)

openssl_pkey_get_private — 秘密鍵を取得する

説明

openssl_pkey_get_private(OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $private_key, ?string $passphrase = null): OpenSSLAsymmetricKey|false

openssl_pkey_get_private() は private_key をパースし、他の関数で使用できるよう準備します。

パラメータ

private_key

private_key は以下のいずれかです。

  1. file://path/to/file.pem 形式の文字列。 このファイルは、PEM エンコードされた証明書/秘密鍵である必要が あります（両方を含むことも可能です）。
  2. PEM フォーマットの秘密鍵。

passphrase

指定されたキーが（パスフレーズを用いて）暗号化されている場合は、 オプションのパラメータ passphrase を使用する必要があります。

戻り値

成功した場合に、 OpenSSLAsymmetricKey クラスのインスタンスを返します。 エラー時に false を返します。

変更履歴

バージョン 説明
8.0.0 成功した場合に、 この関数は OpenSSLAsymmetricKey クラスのインスタンスを返すようになりました。 これより前のバージョンでは、 OpenSSL key 型のリソースを返していました。
8.0.0 private_key は、 OpenSSLAsymmetricKey または OpenSSLCertificate クラスのインスタンスを受け入れるようになりました。 これより前のバージョンでは、 OpenSSL key または OpenSSL X.509 型のリソースを受け入れていました。
8.0.0 passphrase は、nullable になりました。
関連キーワード: 　private, 取得, key, pkey, OpenSSLAsymmetricKey, passphrase, バージョン, 関数, インスタンス, クラス