# sodium_crypto_secretbox

(PHP 7 >= 7.2.0, PHP 8)

sodium_crypto_secretbox — Chiffrement authentifié avec une clé partagée

### Description

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

Chiffre un message avec une clé symétrique (partagée).

### Liste de paramètres

`message`

  Le message en clair à chiffrer.

`nonce`

  Un nombre qui doit être utilisé une seule fois, par message. 24 octets de long. Ceci est une limite suffisamment grande pour être générée aléatoirement (i.e. random_bytes()).

`key`

  La clé de chiffrement (256 bits).

### Valeurs de retour

Renvoie la chaîne chiffrée.

### Erreurs / Exceptions

- Si `nonce` a une longueur de bytes différente de `SODIUM_CRYPTO_SECRETBOX_NONCEBYTES` (24 bytes), une SodiumException sera lancée.
- Si `key` a une longueur de bytes différente de `SODIUM_CRYPTO_SECRETBOX_KEYBYTES` (32 bytes), une SodiumException sera lancée.
- Lance une SodiumException en cas d'échec.

### Exemples

Exemple #1 Exemple de sodium_crypto_secretbox()

`<?php
// La $key doit être gardée confidentielle
$key = sodium_crypto_secretbox_keygen();
// Ne pas réutiliser $nonce avec la même clé
$nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
$plaintext = "message to be encrypted";
$ciphertext = sodium_crypto_secretbox($plaintext, $nonce, $key);
var_dump(bin2hex($ciphertext));
// Le même nonce et la même clé sont nécessaires pour déchiffrer le $ciphertext
var_dump(sodium_crypto_secretbox_open($ciphertext, $nonce, $key));
?>`

Résultat de l'exemple ci-dessus est similaire à :

    string(78) "3a1fa3e9f7b72ef8be51d40abf8e296c6899c185d07b18b4c93e7f26aa776d24c50852cd6b1076"
    string(23) "message to be encrypted"

### Voir aussi

- sodium_crypto_secretbox_open() - Déchiffrement authentifié avec une clé partagée
- sodium_crypto_secretbox_keygen() - Génère une clé aléatoire pour sodium_crypto_secretbox
- random_bytes() - Récupère des octets aléatoires cryptographiquement sécurisés