encrypt

Requires a Node.js runtime ('qsu/node')

Encrypt with the algorithm of your choice (algorithm default: aes-256-cbc, ivSize default: 16) using a string and a secret (secret).

secret is used as the raw key, so its byte length must match the algorithm: 32 bytes for aes-256-*, 24 for aes-192-* and 16 for aes-128-*. A shorter or longer key throws Invalid key length. Note that this is a byte length, not a character count — a multi-byte character takes more than one byte.

The result is iv:encrypted. For AEAD algorithms (gcm, ccm, ocb, poly1305) it is iv:authTag:encrypted, because these modes need the authentication tag to decrypt. Pass the returned string to decrypt with the same algorithm and toBase64 values.

Parameters

Name	Type	Required	Default
str	stringstr	●	–
The text to encrypt. An empty string returns an empty string.
secret	stringstr	●	–
The key. Its byte length must match the algorithm (32 bytes for aes-256-*).
algorithm	stringstr	–	'aes-256-cbc'
ivSize	numberint	–	16
The IV byte length. Use 12 for aes-256-gcm.
toBase64	booleanbool	–	falseFalse
Encode the output as base64 instead of hex.

Returns

string

str

Examples

const secret = '12345678901234567890123456789012'; // 32 bytes

encrypt('test', secret); // 'iv:encrypted'
encrypt('test', secret, 'aes-256-gcm', 12); // 'iv:authTag:encrypted'

secret = '12345678901234567890123456789012'  # 32 bytes

encrypt('test', secret)  # 'iv:encrypted'