openssl_pkey_export

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

openssl_pkey_exportエクスポート可能な形式で、キーを文字列に取得する

説明

openssl_pkey_export(
    OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $key,
    string &$output,
    ?string $passphrase = null,
    ?array $options = null
): bool

openssl_pkey_export() は、 key を PEM エンコードした文字列として取得し、 output(参照渡し)に格納します。

注意: この関数を正しく動作させるには、正しい形式の openssl.cnf をインストールしておく必要があります。 詳細な情報は、インストールについてのセクション を参照ください。

パラメータ

key

output

passphrase

オプションで passphrase を使用してキーを保護することが可能です。

options

options により openssl 設定ファイルの設定を 追加したり上書きしたりすることで、エクスポート処理の詳細設定が可能です。 options についての詳細な情報は openssl_csr_new() を参照ください。

戻り値

成功した場合に true を、失敗した場合に false を返します。

変更履歴

バージョン 説明
8.0.0 key は、 OpenSSLAsymmetricKey または OpenSSLCertificate クラスのインスタンスを受け入れるようになりました。 これより前のバージョンでは、 OpenSSL key または OpenSSL X.509 型のリソースを受け入れていました。
関連キーワード:  形式, 取得, キー, pkey, export, key, string, 参照, passphrase, output