(PHP 7 >= 7.2.0, PHP 8)
sodium_crypto_secretbox — Шифрует общим ключом с проверкой подлинности
$message, string $nonce, #[\SensitiveParameter]string $key): string Функция шифрует сообщения симметричным (общим) ключом.
messagenoncekeyФункция возвращает зашифрованную строку.
nonce отличается от значения константы
SODIUM_CRYPTO_SECRETBOX_NONCEBYTES
(24 байта).
key отличается от значения константы
SODIUM_CRYPTO_SECRETBOX_KEYBYTES
(32 байта).
Пример #1 Пример использования функции sodium_crypto_secretbox()
<?php
// Значение переменной $key должно храниться в секрете
$key = sodium_crypto_secretbox_keygen();
// Не используйте переменную $nonce повторно с тем же ключом
$nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
$plaintext = "message to be encrypted";
$ciphertext = sodium_crypto_secretbox($plaintext, $nonce, $key);
var_dump(bin2hex($ciphertext));
// Для расшифровки переменной $ciphertext требуются те же nonce и ключ
var_dump(sodium_crypto_secretbox_open($ciphertext, $nonce, $key));
?>Вывод приведённого примера будет похож на:
string(78) "3a1fa3e9f7b72ef8be51d40abf8e296c6899c185d07b18b4c93e7f26aa776d24c50852cd6b1076" string(23) "message to be encrypted"
An example to how encrypt or decrypt using sodium:
<?php
$key = random_bytes(SODIUM_CRYPTO_SECRETBOX_KEYBYTES);
$nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
$ciphertext = sodium_crypto_secretbox("Hello World !", $nonce, $key);
$plaintext = sodium_crypto_secretbox_open($ciphertext, $nonce, $key);
if ($plaintext === false) {
throw new Exception("Bad ciphertext");
}
echo $plaintext;A typical safe pattern is to generate both the key and nonce, then store or transmit the nonce alongside the ciphertext.
<?php
// Generate a random key (must be kept secret)
$key = sodium_crypto_secretbox_keygen();
// Generate a unique nonce for this message (24 bytes)
$nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
$message = "Hello secure world";
// Encrypt
$ciphertext = sodium_crypto_secretbox($message, $nonce, $key);
// Store or transmit: nonce + ciphertext (key is kept secret)
$stored = base64_encode($nonce . $ciphertext);
// -------------------
// Decode and split
$decoded = base64_decode($stored, true);
$nonce = substr($decoded, 0, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
$ciphertext = substr($decoded, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
// Decrypt
$decrypted = sodium_crypto_secretbox_open($ciphertext, $nonce, $key);
if ($decrypted === false) {
die("Decryption failed (message tampered or invalid key)");
}
echo $decrypted;
?>A typical safe pattern is to generate both the key and nonce, then store or transmit the nonce alongside the ciphertext.
<?php
// Generate a random key (must be kept secret)
$key = sodium_crypto_secretbox_keygen();
// Generate a unique nonce for this message (24 bytes)
$nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
$message = "Hello secure world";
// Encrypt
$ciphertext = sodium_crypto_secretbox($message, $nonce, $key);
// Store or transmit: nonce + ciphertext (key is kept secret)
$stored = base64_encode($nonce . $ciphertext);
// -------------------
// Decode and split
$decoded = base64_decode($stored, true);
$nonce = substr($decoded, 0, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
$ciphertext = substr($decoded, SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
// Decrypt
$decrypted = sodium_crypto_secretbox_open($ciphertext, $nonce, $key);
if ($decrypted === false) {
die("Decryption failed (message tampered or invalid key)");
}
echo $decrypted;
?>