Cifrado autenticado con una clave compartida

# 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

- Si `nonce` tiene una longitud de bytes diferente de `SODIUM_CRYPTO_SECRETBOX_NONCEBYTES` (24 bytes), una SodiumException será lanzada.
- Si `key` tiene una longitud de bytes diferente de `SODIUM_CRYPTO_SECRETBOX_KEYBYTES` (32 bytes), una SodiumException será lanzada.
- Lanza una SodiumException en caso de fallo.

### 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

- sodium_crypto_secretbox_open() - Desencriptación autenticada con una clave compartida
- sodium_crypto_secretbox_keygen() - Genera una clave aleatoria para sodium_crypto_secretbox
- random_bytes() - Obtiene bytes aleatorios criptográficamente seguros

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open