openssl_seal

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

openssl_seal — Scelle des données

Description

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

La openssl_seal() scelle (chiffre) data en utilisant le cipher_algo spécifié avec une clé secrète générée aléatoirement. La clé est ensuite chiffrée avec chacune des clés publiques dans le tableau public_key, et chaque clé d'enveloppe chiffrée est retournée dans encrypted_keys. Cela permet d'envoyer des données scellées à plusieurs destinataires (à condition que leurs clés publiques soient disponibles). Chaque destinataire doit recevoir à la fois les données scellées et la clé d'enveloppe qui a été chiffrée avec la clé publique du destinataire. Le VI (vecteur d'initialisation) est généré, et sa valeur est retournée dans iv.

Liste de paramètres

data

Les données à sceller

sealed_data

Les données scellées.

encrypted_keys

Tableau des clés chiffrées.

public_key

Tableau d'instances OpenSSLAsymmetricKey contenant les clés publiques.

cipher_algo

La méthode de chiffrement.

Attention

La valeur par défaut pour les versions de PHP antérieures à 8.0 est ('RC4'), qui est considérée comme non sécurisée. Il est fortement recommandé de spécifier explicitement une méthode de chiffrement sécurisée.

iv

Le vecteur d'initialisation pour le déchiffrement de data. Il est requis si la méthode de chiffrement nécessite un VI. Cela peut être déterminé en appelant openssl_cipher_iv_length() avec cipher_algo.

Attention

Le VI ne peut pas être défini explicitement. Toute valeur qui y est définie est écrasée par une valeur générée aléatoirement.

Valeurs de retour

Retourne la longueur des données scellées en cas de succès, et false sinon. En cas de succès, les données scellées sont placées dans le paramètre sealed_data, et les clés d'enveloppe dans encrypted_keys.

Historique

Version	Description
8.0.0	`public_key` accepte désormais un tableau d'instance de OpenSSLAsymmetricKey ; auparavant, un tableau de resources de type `OpenSSL key` était acceptée.
8.0.0	`cipher_algo` n'est désormais plus un paramètre optionnel.
8.0.0	`iv` est désormais nullable.

Exemples

Exemple #1 Exemple avec openssl_seal()

<?php

$data = "test";

// récupérer les clés publiques
$pk1 = openssl_get_publickey("file://cert1.pem");
$pk2 = openssl_get_publickey("file://cert2.pem");


// scelle le message : seuls, les possesseurs de $pk1 et $pk2 peuvent déchiffrer
// le message $sealed avec les clés $ekeys[0] et $ekeys[1] (respectivement).
openssl_seal($data, $sealed, $ekeys, array($pk1, $pk2));

if (openssl_seal($data, $sealed, $ekeys, array($pk1, $pk2), 'AES256', $iv) > 0) {
    // éventuellement stocker les valeurs $sealed et $iv et les utiliser plus tard dans openssl_open
    echo "succès\n";
}
?>

Voir aussi

openssl_open() - Ouvre des données scellées

Found A Problem?

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

＋add a note

User Contributed Notes 6 notes

down

amer.alhabsi AT gmail DOT com ¶

9 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);
?>

down

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.

down

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.)

down

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?

down

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.

down

-4

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