PHPのお勉強！

PHP TOP
PHP 8.4.2 Released!

    openssl_seal

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

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

    説明

    openssl_seal(
        #[\SensitiveParameter] string $data,
        string &$sealed_data,
        array &$encrypted_keys,
        array $public_key,
        string $cipher_algo,
        string &$iv = null
    ): int|false

    openssl_seal() は、指定された cipher_algo を使用して ランダムに生成された秘密鍵で data をシール(暗号化)します。 その鍵は続いて public_key 配列内の各公開鍵で暗号化され、 それぞれ暗号化されたエンベロープキーは encrypted_keys パラメータで返されます。 これによって、(公開鍵が利用可能なら) 複数の受信者にシールされた データを送信できます。各受信者は、シールされたデータと受信者の公開鍵で暗号化されたエンベロープキー の両方を受け取らなければいけません。 生成された IV (初期化ベクトル) は iv パラメータで返されます。

    パラメータ

    data

    シールするデータ。

    sealed_data

    シール済みのデータ。

    encrypted_keys

    暗号化したキーの配列。

    public_key

    公開鍵を含んだ OpenSSLAsymmetricKey クラスのインスタンスの配列。

    cipher_algo

    暗号化方式

    警告

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

    iv

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

    警告

    初期化ベクトルは明示的に設定できません。設定された値はランダムに生成された値で上書きされます。

    戻り値

    成功時にシール(暗号化)されたデータの長さ、エラー時に false を返します。成功時には、暗号化されたデータが sealed_data に、エンベロープキーが encrypted_keys に返されます。

    変更履歴

    バージョン 説明
    8.0.0 public_key は、 OpenSSLAsymmetricKey クラスのインスタンスの配列を受け入れるようになりました。 これより前のバージョンでは、 OpenSSL key 型のリソースの配列を受け入れていました。
    8.0.0 cipher_algo は、オプションではなくなりました。
    8.0.0 iv は、nullable になりました。

    例

    例1 openssl_seal() の例

    <?php
    // $data には、暗号化されるデータが含まれていると仮定
    $data = "test";

    // 公開鍵を取得する
    $pk1 = openssl_get_publickey("file://cert1.pem");
    $pk2 = openssl_get_publickey("file://cert2.pem");

    // メッセージを暗号化。$pk1 および $pk2 の所有者のみが、$sealed を
    // それぞれ $ekeys[0] および $ekeys[1] で復号することが可能
    if (openssl_seal($data, $sealed, $ekeys, array($pk1, $pk2), 'AES256', $iv) > 0) {
    // $sealed と $iv の値を格納し、後で openssl_open で使用することもできます。
    echo "success\n";
    }
    ?>

    参考

    • openssl_open() - シール(暗号化)されたデータをオープン(復号)する

    Found A Problem?

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 6 notes

    up
    6
    Dominik M.
    4 years ago
    Please note that openssl_seal() cannot be used for EC encryption.
    Took me literally two hours to find out because the OpenSSL documentation is so bad.
    up
    9
    amer.alhabsi AT gmail DOT com
    8 years ago
    while the default is using RC4, it is possible to use other more secure algorithms. These are specified as the fifth parameter. Also, one needs to add an initialization vector (random bytes). Eg.

    <?php
    $data     = "This is top secret.";
    // fetch public keys for our recipients, and ready them
    $cert = file_get_contents('./cert.pem');

    $pk1 = openssl_get_publickey($cert);
    $iv = openssl_random_pseudo_bytes(32);
    openssl_seal($data, $sealed, $ekeys, array($pk1), "AES256", $iv);

    // free the keys from memory
    openssl_free_key($pk1);
    echo     base64_encode($sealed);
    ?>
    up
    3
    aaron dot lawrence at umajin dot com
    3 years ago
    Some critical details that are not in the docs, nor widely written about elsewhere.

    - The envelope key is a 128-bit RSA key, randomly generated.
    - The data is encrypted with (A)RC4 using the envelope key.
    - The envelope key is encrypted for transmission with PKCS1 v1.5. It is NOT the OAEP padding variant. PKCS1 v1.5 is even older, and not widely supported anymore.

    At least this was true for openssl_seal in PHP 7.2 that we are using.

    (Note: In Python you can decrypt this envelope key with the Cryptography package, using padding.PKCS1v15())

    The combination of RC4 and PKCS1 v1.5 make this function actually semi-obsolete for security use in my opinion.
    up
    5
    devel@no-spam
    19 years ago
    "seals (encrypts) data by using RC4 with a randomly generated secret key"
    It should be noted that the randomly generated secret key is 128 bits long (openssl: EVP_rc4(void): RC4 stream cipher. This is a variable key length cipher with default key length 128 bits.)
    up
    4
    bowfingermail at gmx dot net
    9 years ago
    According to several sources (e.g. crypto101.io or Wikipedia) RC4 is not safe and not supposed to be used anymore.
    So, shouldn't openssl_seal use another stream cipher in place of RC4?
    up
    -3
    hfuecks at nospam dot org
    17 years ago
    openssl_seal() can work well when you need to pass data securely to other platforms / languages. What openssl_seal() does is;

    1. Generate a random key
    2. Encrypt the data symmetrically with RC4 using the random key
    3. Encrypt the random key itself with RSA using the public key / certificate
    4. Returns the encrypted data and the encrypted key

    So to decrypt the steps are simply;

    1. Decrypt the key using RSA and your private key
    2. Decrypt the data using RC4 and the decrypted key

    The trickiest part may be figuring out how handle the private key - BouncyCastle ( http://www.bouncycastle.org/ ) provides a PEMReader for Java and C# while Not Yet commons-ssl ( http://juliusdavies.ca/commons-ssl/ ) has a KeyStoreBuilder to build Java keystores out of a PEM certificate.

    A complete example in Java is described at http://blog.local.ch/archive/2007/10/29/openssl-php-to-java.html
    ＋add a note