sodium_crypto_secretbox

    (PHP 7 >= 7.2.0, PHP 8)

    sodium_crypto_secretbox — Cifrado autenticado con una clave compartida

    Descripción

    function sodium_crypto_secretbox(#[\SensitiveParameter]string $message, string $nonce, #[\SensitiveParameter]string $key): string

    Cifra un mensaje con una clave simétrica (compartida).

    Parámetros

    message
    El mensaje en claro a cifrar.
    nonce
    Un número que debe ser utilizado una sola vez, por mensaje. 24 bytes de largo. Este es un límite suficientemente grande para ser generado aleatoriamente (i.e. random_bytes()).
    key
    La clave de cifrado (256 bits).

    Valores devueltos

    Devuelve la cadena cifrada.

    Errores/Excepciones

    Ejemplos

    Ejemplo #1 Ejemplo de sodium_crypto_secretbox()

    <?php
// La $key debe ser mantenida confidencial
$key = sodium_crypto_secretbox_keygen();
// No reutilizar $nonce con la misma clave
$nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
$plaintext = "mensaje a ser cifrado";
$ciphertext = sodium_crypto_secretbox($plaintext, $nonce, $key);

var_dump(bin2hex($ciphertext));
// El mismo nonce y la misma clave son necesarios para descifrar el $ciphertext
var_dump(sodium_crypto_secretbox_open($ciphertext, $nonce, $key));
?>

    Resultado del ejemplo anterior es similar a:

    string(78) "3a1fa3e9f7b72ef8be51d40abf8e296c6899c185d07b18b4c93e7f26aa776d24c50852cd6b1076"
string(23) "mensaje a ser cifrado"

    Ver también

    Found A Problem?

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

    User Contributed Notes 3 notes

    up
    1
    celso fontes
    5 years ago
    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;
    up
    0
    Anonymous
    19 days ago
    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;

?>
    up
    0
    Anonymous
    19 days ago
    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;

?>
    ＋add a note
    To Top