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.
(PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8)
openssl_seal — Запечатывает, или зашифровывает, данные
$data
,&$sealed_data
,&$encrypted_keys
,$public_key
,$cipher_algo
,&$iv
= null
Функция openssl_seal() запечатывает, или шифрует, данные data
алгоритмом cipher_algo
со случайно сгенерированным секретным ключом.
Затем функция шифрует ключ каждым открытым ключом в массиве public_key
,
и каждый зашифрованный ключ конверта возвращается массиве encrypted_keys
.
Это помогает отправлять запечатанные данные набору получателей (при условии, что открытые ключи получателей доступны).
Каждый получатель получит запечатанные данные и ключ конверта, который функция зашифровала
открытым ключом получателя. После чего функция генерирует вектор инициализации
(англ. Initialization Vector, IV) и возвращает значение вектора в параметре iv
.
data
Данные, которые требуется запечатать.
sealed_data
Данные, которые запечатала функция.
encrypted_keys
Массив зашифрованных ключей.
public_key
Массив экземпляров класса OpenSSLAsymmetricKey, которые содержат открытые ключи.
cipher_algo
Алгоритм шифрования.
До PHP 8.0 по умолчанию параметру назначали значение 'RC4'
,
которое считают небезопасным. Настоятельно рекомендуют явно указывать безопасный
метод шифрования.
iv
Вектор инициализации для расшифровки данных data
. Параметр устанавливают,
только если методу шифрования требуется вектор инициализации. Значение вектора узнают путём вызова
функции openssl_cipher_iv_length() с алгоритмом шифрования cipher_algo
.
Вектор инициализации невозможно указать явно. Значение, которое установили в параметре, перезаписывается значением, которое функция сгенерировала случайно.
Функция возвращает длину запечатанных данных или false
.
В случае успешного выполнения параметр sealed_data
будет содержать
запечатанные данные, а параметр encrypted_keys
— зашифрованные ключи.
Версия | Описание |
---|---|
8.0.0 |
Параметр public_key теперь принимает массив (array) экземпляров
класса OpenSSLAsymmetricKey;
раньше принимался массив (array) ресурсов (resource) с типом OpenSSL key .
|
8.0.0 |
Параметр cipher_algo теперь обязательный параметр.
|
8.0.0 |
Параметр iv теперь принимает значение null.
|
Пример #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";
}
?>
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.
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);
?>
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.
"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.)
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?
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