加密函数

这些函数使用 AES（高级加密标准）算法对数据进行加密和解密。

密钥长度取决于加密模式：在 -128-、-196- 和 -256- 模式下，分别为 16、24 和 32 字节。

初始化向量的长度始终为 16 字节（超过 16 字节的部分会被忽略）。

aes_decrypt_mysql

自 v20.12 版本引入

解密由 MySQL 的 AES_ENCRYPT 函数加密的数据。

对于相同的输入，生成的明文与 decrypt 相同。当 key 或 iv 长于正常长度时，aes_decrypt_mysql 的行为与 MySQL 的 aes_decrypt 保持一致，即对 key 进行“折叠”处理，并忽略 iv 多出的比特位。

支持以下解密模式：

aes-128-ecb, aes-192-ecb, aes-256-ecb
aes-128-cbc, aes-192-cbc, aes-256-cbc
aes-128-cfb128
aes-128-ofb, aes-192-ofb, aes-256-ofb

语法

aes_decrypt_mysql(mode, ciphertext, key[, iv])

参数

mode — 解密模式。String
ciphertext — 需要解密的密文。String
key — 解密密钥。String
iv — 可选。初始化向量。String

返回值

返回解密后的字符串。String

示例

解密 MySQL 数据

-- 解密之前使用 MySQL 加密的数据:
mysql> SET  block_encryption_mode='aes-256-ofb';
查询成功,0 行受影响 (0.00 秒)

mysql> SELECT aes_encrypt('Secret', '123456789101213141516171819202122', 'iviviviviviviviv123456') as ciphertext;
+------------------------+
| ciphertext             |
+------------------------+
| 0x24E9E4966469         |
+------------------------+
1 行结果 (0.00 秒)

SELECT aes_decrypt_mysql('aes-256-ofb', unhex('24E9E4966469'), '123456789101213141516171819202122', 'iviviviviviviviv123456') AS plaintext

┌─plaintext─┐
│ 秘密      │
└───────────┘

aes_encrypt_mysql

引入版本：v20.12

以与 MySQL 的 AES_ENCRYPT 函数相同的方式对文本进行加密。生成的密文可以通过 MySQL 的 AES_DECRYPT 函数解密。在相同输入下，生成与 encrypt 函数相同的密文。当 key 或 iv 长度超过通常长度时，aes_encrypt_mysql 的行为将与 MySQL 的 aes_encrypt 保持一致，即对 key 进行“折叠”处理，并忽略 iv 多余的比特。

支持的加密模式有：

aes-128-ecb, aes-192-ecb, aes-256-ecb
aes-128-cbc, aes-192-cbc, aes-256-cbc
aes-128-ofb, aes-192-ofb, aes-256-ofb

语法

aes_encrypt_mysql(mode, plaintext, key[, iv])

参数

mode — 加密模式。String
plaintext — 需要加密的文本。String
key — 加密密钥。如果密钥长度超过 mode 要求，将执行 MySQL 特有的密钥折叠处理。String
iv — 可选。初始化向量。仅前 16 个字节会被使用。String

返回值

密文的二进制字符串。String

示例

等值输入比较

-- 给定相同的输入,encrypt 和 aes_encrypt_mysql 生成相同的密文:
SELECT encrypt('aes-256-ofb', 'Secret', '12345678910121314151617181920212', 'iviviviviviviviv') = aes_encrypt_mysql('aes-256-ofb', 'Secret', '12345678910121314151617181920212', 'iviviviviviviviv') AS ciphertexts_equal;

┌─ciphertexts_equal─┐
│                 1 │
└───────────────────┘

使用过长密钥时加密失败

-- 但当密钥或初始化向量长度超过预期时,encrypt 会失败:
SELECT encrypt('aes-256-ofb', 'Secret', '123456789101213141516171819202122', 'iviviviviviviviv123');

从服务器收到异常（版本 22.6.1）：
代码：36. DB::Exception: 从 localhost:9000 收到。DB::Exception: 密钥大小无效：实际为 33，期望为 32：处理 encrypt('aes-256-ofb', 'Secret', '123456789101213141516171819202122', 'iviviviviviviviv123') 时发生错误。

MySQL 兼容性

-- aes_encrypt_mysql 生成与 MySQL 兼容的输出：
SELECT hex(aes_encrypt_mysql('aes-256-ofb', 'Secret', '123456789101213141516171819202122', 'iviviviviviviviv123')) AS ciphertext;

┌─密文───┐
│ 24E9E4966469 │
└──────────────┘

更长的 IV 也会产生相同的结果

-- 注意即使提供更长的 IV 也会产生相同的结果
SELECT hex(aes_encrypt_mysql('aes-256-ofb', 'Secret', '123456789101213141516171819202122', 'iviviviviviviviv123456')) AS ciphertext

┌─密文───┐
│ 24E9E4966469 │
└──────────────┘

decrypt

自 v20.12 引入

此函数使用以下模式对经 AES 加密的二进制字符串进行解密：

aes-128-ecb, aes-192-ecb, aes-256-ecb
aes-128-cbc, aes-192-cbc, aes-256-cbc
aes-128-ofb, aes-192-ofb, aes-256-ofb
aes-128-gcm, aes-192-gcm, aes-256-gcm
aes-128-ctr, aes-192-ctr, aes-256-ctr
aes-128-cfb, aes-128-cfb1, aes-128-cfb8

语法

decrypt(mode, ciphertext, key[, iv, aad])

参数

mode — 解密模式。String
ciphertext — 待解密的密文。String
key — 解密密钥。String
iv — 初始化向量。对 -gcm 模式必需，对其他模式可选。String
aad — 附加认证数据。如果该值不正确，将无法解密。仅在 -gcm 模式下生效，在其他模式下会抛出异常。String

返回值

返回解密后的明文。String

示例

正确解密已加密的数据

-- 重用加密函数示例中的表
SELECT comment, hex(secret) FROM encryption_test;

┌─comment──────────────┬─hex(secret)──────────────────────────────────┐
│ aes-256-gcm          │ A8A3CCBC6426CFEEB60E4EAE03D3E94204C1B09E0254 │
│ aes-256-gcm 带 AAD │ A8A3CCBC6426D9A1017A0A932322F1852260A4AD6837 │
└──────────────────────┴──────────────────────────────────────────────┘
┌─comment──────────────────────────┬─hex(secret)──────────────────────┐
│ aes-256-ofb 不带 IV              │ B4972BDC4459                     │
│ aes-256-ofb 不带 IV，使用不同密钥 │ 2FF57C092DC9                     │
│ aes-256-ofb 带 IV                │ 5E6CB398F653                     │
│ aes-256-cbc 不带 IV              │ 1BC0629A92450D9E73A00E7D02CF4142 │
└──────────────────────────────────┴──────────────────────────────────┘

对加密数据进行错误解密

SELECT comment, decrypt('aes-256-cfb128', secret, '12345678910121314151617181920212') AS plaintext FROM encryption_test

-- 注意,只有部分数据被正确解密,其余部分显示为乱码,这是因为加密时使用的 `mode`、`key` 或 `iv` 参数不同所致。
┌─comment──────────────┬─plaintext──┐
│ aes-256-gcm          │ OQ�E
                             �t�7T�\���\�   │
│ aes-256-gcm with AAD │ OQ�E
                             �\��si����;�o�� │
└──────────────────────┴────────────┘
┌─comment──────────────────────────┬─plaintext─┐
│ aes-256-ofb no IV                │ Secret    │
│ aes-256-ofb no IV, different key │ �4�
                                        �         │
│ aes-256-ofb with IV              │ ���6�~        │
│aes-256-cbc no IV                │ �2*4�h3c�4w��@
└──────────────────────────────────┴───────────┘

encrypt

自 v20.12 起引入

使用 AES 按以下任一模式将明文加密为密文：

aes-128-ecb, aes-192-ecb, aes-256-ecb
aes-128-cbc, aes-192-cbc, aes-256-cbc
aes-128-ofb, aes-192-ofb, aes-256-ofb
aes-128-gcm, aes-192-gcm, aes-256-gcm
aes-128-ctr, aes-192-ctr, aes-256-ctr
aes-128-cfb, aes-128-cfb1, aes-128-cfb8

语法

encrypt(mode, plaintext, key[, iv, aad])

参数

mode — 加密模式。String
plaintext — 需要加密的文本。String
key — 加密密钥。String
iv — 初始化向量。对于 -gcm 模式必需，其他模式可选。String
aad — 附加认证数据。它本身不会被加密，但会影响解密。仅在 -gcm 模式下生效，其他模式下会抛出异常。String

返回值

返回二进制字符串形式的密文。String

示例

加密示例

CREATE TABLE encryption_test
(
    `comment` String,
    `secret` String
)
ENGINE = MergeTree;

INSERT INTO encryption_test VALUES
('aes-256-ofb 无 IV', encrypt('aes-256-ofb', 'Secret', '12345678910121314151617181920212')),
('aes-256-ofb 无 IV，使用不同密钥', encrypt('aes-256-ofb', 'Secret', 'keykeykeykeykeykeykeykeykeykeyke')),
('aes-256-ofb 带 IV', encrypt('aes-256-ofb', 'Secret', '12345678910121314151617181920212', 'iviviviviviviviv')),
('aes-256-cbc 无 IV', encrypt('aes-256-cbc', 'Secret', '12345678910121314151617181920212'));

SELECT comment, hex(secret) FROM encryption_test;

┌─comment──────────────────────────┬─hex(secret)──────────────────────┐
│ aes-256-ofb 无初始化向量                │ B4972BDC4459                     │
│ aes-256-ofb 无初始化向量,使用不同密钥 │ 2FF57C092DC9                     │
│ aes-256-ofb 带初始化向量              │ 5E6CB398F653                     │
│ aes-256-cbc 无初始化向量                │ 1BC0629A92450D9E73A00E7D02CF4142 │
└──────────────────────────────────┴──────────────────────────────────┘

GCM 模式示例

INSERT INTO encryption_test VALUES
('aes-256-gcm', encrypt('aes-256-gcm', 'Secret', '12345678910121314151617181920212', 'iviviviviviviviv')),

('aes-256-gcm 附加认证数据', encrypt('aes-256-gcm', 'Secret', '12345678910121314151617181920212', 'iviviviviviviviv', 'aad'));

SELECT comment, hex(secret) FROM encryption_test WHERE comment LIKE '%gcm%';

┌─comment──────────────┬─hex(secret)──────────────────────────────────┐
│ aes-256-gcm          │ A8A3CCBC6426CFEEB60E4EAE03D3E94204C1B09E0254 │
│ aes-256-gcm 带 AAD   │ A8A3CCBC6426D9A1017A0A932322F1852260A4AD6837 │
└──────────────────────┴──────────────────────────────────────────────┘

tryDecrypt

自 v22.10 起引入

与 decrypt 函数类似，但在使用错误的密钥导致解密失败时返回 NULL。

语法

tryDecrypt(mode, ciphertext, key[, iv, aad])

参数

mode — 解密模式。String
ciphertext — 待解密的密文。String
key — 解密密钥。String
iv — 可选。初始化向量。在 -gcm 模式下必需，在其他模式下可选。String
aad — 可选。附加的认证数据。如果该值不正确，将无法完成解密。仅在 -gcm 模式下生效，在其他模式下会抛出异常。String

返回值

返回解密后的字符串，如果解密失败则返回 NULL。Nullable(String)

示例

创建表并插入数据

-- 创建一个表，其中 user_id 是唯一用户 ID，encrypted 是加密字符串字段，iv 是解密/加密的初始向量。
-- 假设用户知道自己的 ID 和解密该加密字段的密钥：
CREATE TABLE decrypt_null
(
    dt DateTime,
    user_id UInt32,
    encrypted String,
    iv String
)
ENGINE = MergeTree;

-- 插入一些数据：
INSERT INTO decrypt_null VALUES
('2022-08-02 00:00:00', 1, encrypt('aes-256-gcm', 'value1', 'keykeykeykeykeykeykeykeykeykey01', 'iv1'), 'iv1'),
('2022-09-02 00:00:00', 2, encrypt('aes-256-gcm', 'value2', 'keykeykeykeykeykeykeykeykeykey02', 'iv2'), 'iv2'),
('2022-09-02 00:00:01', 3, encrypt('aes-256-gcm', 'value3', 'keykeykeykeykeykeykeykeykeykey03', 'iv3'), 'iv3');

-- 尝试使用单个密钥解密
SELECT
    dt,
    user_id,
    tryDecrypt('aes-256-gcm', encrypted, 'keykeykeykeykeykeykeykeykeykey02', iv) AS value
FROM decrypt_null
ORDER BY user_id ASC

┌──────────────────dt─┬─user_id─┬─value──┐
│ 2022-08-02 00:00:00 │       1 │ ᴺᵁᴸᴸ   │
│ 2022-09-02 00:00:00 │       2 │ value2 │
│ 2022-09-02 00:00:01 │       3 │ ᴺᵁᴸᴸ   │
└─────────────────────┴─────────┴────────┘

aes_decrypt_mysql​

aes_encrypt_mysql​

decrypt​

encrypt​

tryDecrypt​

aes_decrypt_mysql

aes_encrypt_mysql

decrypt

encrypt

tryDecrypt