AES_ENCRYPT()

The AES_ENCRYPT() function encrypts str with key_str using AES and returns the ciphertext as a BLOB.

Description

The AES_ENCRYPT() function encrypts str with key_str using AES and returns the ciphertext as a BLOB. The encryption mode is selected by the session variable block_encryption_mode.

MatrixOne currently supports two modes:

  • aes-128-ecb (default). Key is derived to 16 bytes; the optional init_vector argument is ignored.

  • aes-256-cbc. Key is derived to 32 bytes; the init_vector argument is required and must be at least 16 bytes.

The function returns NULL in any of the following cases:

  • str or key_str is NULL.

  • block_encryption_mode is set to an unsupported value.

  • CBC mode is selected but the IV is missing, NULL, or shorter than 16 bytes.

  • Key derivation or the underlying AES operation fails.

Syntax

> AES_ENCRYPT(str, key_str)
> AES_ENCRYPT(str, key_str, init_vector)

Arguments

Arguments

Description

str

Required. The plaintext string to encrypt. Accepts VARCHAR, CHAR, TEXT, or BLOB.

key_str

Required. The encryption key.

init_vector

Optional. The initialization vector, required when block_encryption_mode selects a CBC mode. Must be at least 16 bytes.

Examples

mysql> SET block_encryption_mode = 'aes-128-ecb';
mysql> SELECT HEX(AES_ENCRYPT('MatrixOne', 'my-secret-key'));
+-------------------------------------------------+
| hex(aes_encrypt(matrixone, my-secret-key))      |
+-------------------------------------------------+
| 3B1A...                                         |
+-------------------------------------------------+

mysql> SET block_encryption_mode = 'aes-256-cbc';
mysql> SELECT HEX(AES_ENCRYPT('MatrixOne', 'my-secret-key', '0123456789abcdef'));

See also