sodium_crypto_secretbox

(PHP 7 >= 7.2.0, PHP 8)

sodium_crypto_secretbox — Criptografia de chave compartilhada autenticada

Descrição

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

Criptografa uma mensagem com uma chave simétrica (compartilhada).

Parâmetros

message: A mensagem de texto simples a ser criptografada.
nonce: Um número que deve ser usado apenas uma vez por mensagem. 24 bytes de comprimento. Este é um limite grande o suficiente para ser gerado aleatoriamente (por exemplo, random_bytes()).
key: Chave de criptografia (256-bit).

Valor Retornado

Retorna a string criptografada.

Erros/Exceções

Se nonce tiver um comprimento de bytes diferente de SODIUM_CRYPTO_SECRETBOX_NONCEBYTES (24 bytes), uma SodiumException será lançada.
Se key tiver um comprimento de bytes diferente de SODIUM_CRYPTO_SECRETBOX_KEYBYTES (32 bytes), uma SodiumException será lançada.
Lança uma SodiumException em caso de falha.

Exemplos

Exemplo #1 Exemplo de sodium_crypto_secretbox()

<?php
// A chave $key deve ser mantida confidencial
$key = sodium_crypto_secretbox_keygen();
// Não reutilize $nonce com a mesma chave
$nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
$plaintext = "message to be encrypted";
$ciphertext = sodium_crypto_secretbox($plaintext, $nonce, $key);

var_dump(bin2hex($ciphertext));
// O mesmo nonce e chave são necessários para descriptografar o $ciphertext
var_dump(sodium_crypto_secretbox_open($ciphertext, $nonce, $key));
?>

O exemplo acima produzirá algo semelhante a:

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

Veja Também

sodium_crypto_secretbox_open() - Descriptografia de chave compartilhada autenticada
sodium_crypto_secretbox_keygen() - Gera chave aleatória para sodium_crypto_secretbox
random_bytes() - Obtém bytes aleatórios criptograficamente seguros