sodium_crypto_secretbox

Function • Params and return types changed in PHP 8.0

Authenticated shared-key encryption.

PHP 5

PHP 7.0-7.1

Added

PHP 7.3-7.4

Improved

PHP 8.1

PHP 8.2

PHP 8.3

PHP 8.4

PHP 8.5

sodium_crypto_secretbox(
    string $message,
    string $nonce,
    string $key
  ): string

Typestring

The plaintext message to encrypt.

Typestring

A number that must be only used once, per message. 24 bytes long. This is a large enough bound to generate randomly (i.e. random_bytes).

Typestring

Encryption key (256-bit).

Typestring

Returns the encrypted string.

Changes to the `sodium_crypto_secretbox` Function

  sodium_crypto_secretbox(
-     $string,
+     string $message,
-     $nonce,
+     string $nonce,
-     $key
+     string $key
-   )
+   ): string