説明

openssl_open(
    string $data,
    #[\SensitiveParameter] string &$output,
    string $encrypted_key,
    #[\SensitiveParameter] OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $private_key,
    string $cipher_algo,
    ?string $iv = null
): bool

openssl_open() は、 private_key を使用して encrypted_key から復号されたエンベロープキーによって data をオープン(復号)します。復号は cipher_algo と iv を使用して行なわれます。 IV は暗号方式が要求する場合にのみ必要です。復号されたデータは output に格納されます。エンベロープキーは通常、秘密鍵に関連付けられた公開鍵を用いてデータがシール(暗号化) されたときに生成されます。詳細は openssl_seal() を参照ください。

パラメータ

data

シール(暗号化)されたデータ。

output

成功した場合、オープンしたデータをこのパラメータに格納して返します。

encrypted_key

private_key を用いて復号できる暗号化された対称鍵。

private_key

encrypted_keyの復号に用いられる秘密鍵。

cipher_algo

dataの復号に使用される暗号化方式。

警告

PHP 8.0 より前のデフォルト値 ('RC4') は安全ではありません。明示的にセキュアな暗号化方式を指定することを強く推奨します。

iv

dataの復号に用いられる初期化ベクトル。暗号方式が IV を要求する場合に必要です。これは cipher_algo で openssl_cipher_iv_length() を呼び出すことで確認できます。

戻り値

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

変更履歴

バージョン	説明
8.0.0	`private_key` は、 OpenSSLAsymmetricKey または OpenSSLCertificate クラスのインスタンスを受け入れるようになりました。これより前のバージョンでは、 `OpenSSL key` または `OpenSSL X.509 CSR` 型のリソースを受け入れていました。
8.0.0	`cipher_algo` は、オプションではなくなりました。

例

例1 openssl_open() の例

<?php

// $sealed, $env_key および $iv に暗号化されたデータおよびエンベロープキーと
// IV が含まれていると仮定。すべてシール元(暗号化側)から与えられる。

// private_key.pem に置かれたファイルから秘密鍵を取得する
$pkey = openssl_get_privatekey("file://private_key.pem");

// データを復号化し、$open に保存
if (openssl_open($sealed, $open, $env_key, $pkey, 'AES256', $iv)) {
    echo "Here is the opened data: ", $open;
} else {
    echo "Failed to open data";
}
?>

参考

openssl_seal() - データをシール(暗号化)する