boxed = crypto.aead.encrypt(key, nonce, plaintext)
boxed = crypto.aead.encrypt(key, nonce, plaintext, associatedData)
| Parameter | Description |
|---|---|
| key | a uint8 vector of 32 bytes or 64 hexadecimal characters: secret key. |
| nonce | a uint8 vector of 24 bytes or 48 hexadecimal characters: unique per message for a given key (use crypto.random). |
| plaintext | a uint8 vector (raw bytes) or a character vector (UTF-8 bytes): content to encrypt. |
| associatedData | a uint8 vector (raw bytes) or a character vector (UTF-8 bytes): optional data authenticated but not encrypted; the same value must be given to decrypt. |
| Parameter | Description |
|---|---|
| boxed | a uint8 row vector: the 16-byte authentication tag followed by the ciphertext (same length as the plaintext). |
crypto.aead.encrypt encrypts and authenticates a message with XChaCha20-Poly1305, an authenticated encryption scheme with a 256-bit key and a 192-bit nonce.
The nonce must be unique for every message encrypted with the same key; a repeated nonce breaks the security. Generate it with crypto.random(24) and store it alongside the encrypted message (it is not secret).
key = crypto.random(32);
nonce = crypto.random(24);
boxed = crypto.aead.encrypt(key, nonce, 'a secret message');
char(crypto.aead.decrypt(key, nonce, boxed))| Version | Description |
|---|---|
| 2.0.0 | initial version |