Home/ Manual/ sodium / functions/ sodium_crypto_aead_aes256gcm_encrypt

sodium_crypto_aead_aes256gcm_encrypt

PHP function Edit on GitHub ✎

(PHP 7 >= 7.2.0, PHP 8)

Encrypt then authenticate with AES-256-GCM

Description

sodium_crypto_aead_aes256gcm_encrypt(string $message, string $additional_data, string $nonce, string $key): string

Encrypt then authenticate with AES-256-GCM. Only available if sodium_crypto_aead_aes256gcm_is_available() returns true.

message: The plaintext message to encrypt.
additional_data: Additional, authenticated data. This is used in the verification of the authentication tag appended to the ciphertext, but it is not encrypted or stored in the ciphertext.
nonce: A number that must be only used once, per message. 12 bytes long.
key: Encryption key (256-bit).

Returns the ciphertext and authentication tag as a string of raw binary bytes. (Format: ciphertext, then tag.)