加密函数

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

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

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

HMAC

引入版本：v25.12.0

使用指定的哈希算法和密钥，为给定消息计算 HMAC (基于哈希的消息认证码) 。

支持的哈希算法：

blake2b512
blake2s256
md4
md5
md5-sha1
mdc2
ripemd (别名：RIPEMD160、ripemd)
ripemd160
rmd160 (别名：RIPEMD160、rmd160)
sha1
sha224
sha256
sha3-224
sha3-256
sha3-384
sha3-512
sha384
sha512
sha512-224
sha512-256
shake128
shake256
sm3
ssl3-md5 (别名：MD5、ssl3-md5)
ssl3-sha1 (别名：SHA1、ssl3-sha1)
whirlpool

语法

HMAC(mode, message, key)

参数

mode — 哈希算法名称 (不区分大小写) 。支持：md5、sha1、sha224、sha256、sha384、sha512。String
message — 用于计算 HMAC 的消息。String
key — 用于 HMAC 的密钥 (秘钥) 。String

返回值

返回一个包含 HMAC 摘要的二进制字符串。String

示例

HMAC-SHA256 基本用法

SELECT hex(HMAC('sha256', 'The quick brown fox jumps over the lazy dog', 'secret_key'));

┌─hex(HMAC('sha256', 'The quick brown fox jumps over the lazy dog', 'secret_key'))─┐
│ 31FD15FA0F61FD40DC09D919D4AA5B4141A0B27C1D51E74A6789A890AAAA187C                 │
└──────────────────────────────────────────────────────────────────────────────────┘

不同哈希算法

SELECT
    hex(HMAC('md5', 'message', 'key')) AS hmac_md5,
    hex(HMAC('sha1', 'message', 'key')) AS hmac_sha1,
    hex(HMAC('sha256', 'message', 'key')) AS hmac_sha256;

┌─hmac_md5─────────────────────────┬─hmac_sha1────────────────────────────────┬─hmac_sha256──────────────────────────────────────────────────────┐
│ 4E4748E62B463521F6775FBF921234B5 │ 2088DF74D5F2146B48146CAF4965377E9D0BE3A4 │ 6E9EF29B75FFFC5B7ABAE527D58FDADB2FE42E7219011976917343065F58ED4A │
└──────────────────────────────────┴──────────────────────────────────────────┴──────────────────────────────────────────────────────────────────┘

不区分大小写模式

SELECT
    hmac('SHA256', 'message', 'key') = HMAC('sha256', 'message', 'key') AS same_result,
    HMAC('SHA256', 'message', 'key') = Hmac('Sha256', 'message', 'key') AS also_same;

┌─same_result─┬─also_same─┐
│           1 │         1 │
└─────────────┴───────────┘

aes_decrypt_mysql

引入自：v20.12.0

解密由 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 数据

-- Let's decrypt data we've previously encrypted with MySQL:
mysql> SET  block_encryption_mode='aes-256-ofb';
Query OK, 0 rows affected (0.00 sec)

mysql> SELECT aes_encrypt('Secret', '123456789101213141516171819202122', 'iviviviviviviviv123456') as ciphertext;
+------------------------+
| ciphertext             |
+------------------------+
| 0x24E9E4966469         |
+------------------------+
1 row in set (0.00 sec)

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

┌─plaintext─┐
│ Secret    │
└───────────┘

aes_encrypt_mysql

引入版本：v20.12.0

以与 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

示例

相同输入比较

-- Given equal input encrypt and aes_encrypt_mysql produce the same ciphertext:
SELECT encrypt('aes-256-ofb', 'Secret', '12345678910121314151617181920212', 'iviviviviviviviv') = aes_encrypt_mysql('aes-256-ofb', 'Secret', '12345678910121314151617181920212', 'iviviviviviviviv') AS ciphertexts_equal;

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

密钥过长时加密失败

-- But encrypt fails when key or iv is longer than expected:
SELECT encrypt('aes-256-ofb', 'Secret', '123456789101213141516171819202122', 'iviviviviviviviv123');

Received exception from server (version 22.6.1):
Code: 36. DB::Exception: Received from localhost:9000. DB::Exception: Invalid key size: 33 expected 32: While processing encrypt('aes-256-ofb', 'Secret', '123456789101213141516171819202122', 'iviviviviviviviv123').

MySQL 兼容性

-- aes_encrypt_mysql produces MySQL-compatible output:
SELECT hex(aes_encrypt_mysql('aes-256-ofb', 'Secret', '123456789101213141516171819202122', 'iviviviviviviviv123')) AS ciphertext;

┌─ciphertext───┐
│ 24E9E4966469 │
└──────────────┘

使用更长的 IV 会得到相同的结果

-- Notice how supplying even longer IV produces the same result
SELECT hex(aes_encrypt_mysql('aes-256-ofb', 'Secret', '123456789101213141516171819202122', 'iviviviviviviviv123456')) AS ciphertext

┌─ciphertext───┐
│ 24E9E4966469 │
└──────────────┘

decrypt

自 v20.12.0 引入

此函数使用以下模式，对经 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

示例

正确解密已加密的数据

-- Re-using the table from the encrypt function example
SELECT comment, hex(secret) FROM encryption_test;

┌─comment──────────────┬─hex(secret)──────────────────────────────────┐
│ aes-256-gcm          │ A8A3CCBC6426CFEEB60E4EAE03D3E94204C1B09E0254 │
│ aes-256-gcm with AAD │ A8A3CCBC6426D9A1017A0A932322F1852260A4AD6837 │
└──────────────────────┴──────────────────────────────────────────────┘
┌─comment──────────────────────────┬─hex(secret)──────────────────────┐
│ aes-256-ofb no IV                │ B4972BDC4459                     │
│ aes-256-ofb no IV, different key │ 2FF57C092DC9                     │
│ aes-256-ofb with IV              │ 5E6CB398F653                     │
│ aes-256-cbc no IV                │ 1BC0629A92450D9E73A00E7D02CF4142 │
└──────────────────────────────────┴──────────────────────────────────┘

错误解密加密数据

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

-- Notice how only a portion of the data was properly decrypted, and the rest is gibberish since either `mode`, `key`, or `iv` were different upon encryption.
┌─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.0 引入

使用 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 no IV', encrypt('aes-256-ofb', 'Secret', '12345678910121314151617181920212')),
('aes-256-ofb no IV, different key', encrypt('aes-256-ofb', 'Secret', 'keykeykeykeykeykeykeykeykeykeyke')),
('aes-256-ofb with IV', encrypt('aes-256-ofb', 'Secret', '12345678910121314151617181920212', 'iviviviviviviviv')),
('aes-256-cbc no IV', encrypt('aes-256-cbc', 'Secret', '12345678910121314151617181920212'));

SELECT comment, hex(secret) FROM encryption_test;

┌─comment──────────────────────────┬─hex(secret)──────────────────────┐
│ aes-256-ofb no IV                │ B4972BDC4459                     │
│ aes-256-ofb no IV, different key │ 2FF57C092DC9                     │
│ aes-256-ofb with IV              │ 5E6CB398F653                     │
│ aes-256-cbc no IV                │ 1BC0629A92450D9E73A00E7D02CF4142 │
└──────────────────────────────────┴──────────────────────────────────┘

GCM 模式示例

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

('aes-256-gcm with AAD', 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 with AAD │ A8A3CCBC6426D9A1017A0A932322F1852260A4AD6837 │
└──────────────────────┴──────────────────────────────────────────────┘

tryDecrypt

自 v22.10.0 起引入

类似于 decrypt 函数，但在因使用错误密钥而解密失败时返回 NULL。

语法

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

参数

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

返回值

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

示例

创建表并插入数据

-- Let's create a table where user_id is the unique user id, encrypted is an encrypted string field, iv is an initial vector for decrypt/encrypt.
-- Assume that users know their id and the key to decrypt the encrypted field:
CREATE TABLE decrypt_null
(
    dt DateTime,
    user_id UInt32,
    encrypted String,
    iv String
)
ENGINE = MergeTree;

-- Insert some data:
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');

-- Try decrypt with one key
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 │ ᴺᵁᴸᴸ   │
└─────────────────────┴─────────┴────────┘

HMAC​

aes_decrypt_mysql​

aes_encrypt_mysql​

decrypt​

encrypt​

tryDecrypt​

HMAC

aes_decrypt_mysql

aes_encrypt_mysql

decrypt

encrypt

tryDecrypt