Функции шифрования

Эти функции реализуют шифрование и расшифровку данных с использованием алгоритма AES (Advanced Encryption Standard).

Длина ключа зависит от режима шифрования: 16, 24 и 32 байта для режимов -128-, -196- и -256- соответственно.

Длина вектора инициализации всегда составляет 16 байт (байты, превышающие 16, игнорируются).

aes_decrypt_mysql

Представлено в: v20.12

Расшифровывает данные, зашифрованные функцией MySQL AES_ENCRYPT.

Возвращает тот же расшифрованный текст, что и decrypt при одинаковых входных данных. Когда key или iv длиннее, чем обычно, aes_decrypt_mysql будет следовать тому же поведению, что и aes_decrypt MySQL, который "сворачивает" 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

Шифрует текст так же, как функция AES_ENCRYPT MySQL. Полученный зашифрованный текст может быть расшифрован с помощью функции AES_DECRYPT MySQL. Возвращает тот же зашифрованный текст, что и функция encrypt при одинаковых входных данных. Когда key или iv длиннее, чем обычно, aes_encrypt_mysql будет следовать тому же поведению, что и aes_encrypt MySQL, который "сворачивает" 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

Эта функция расшифровывает двоичную строку, зашифрованную с использованием 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

Шифрует открытый текст в зашифрованный, используя 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

Похоже на функцию decrypt, но возвращает NULL, если расшифровка не удалась при использовании неверного ключа.

Синтаксис

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

Аргументы

mode — Режим расшифровки. String
ciphertext — Зашифрованный текст, который следует расшифровать. String
key — Ключ для расшифровки. String
iv — Необязательно. Вектор инициализации. Обязательный для режимов -gcm, необязательный для других режимов. String
aad — Необязательно. Дополнительные аутентифицированные данные. Не будет расшифрован, если это значение неверно. Работает только в режимах -gcm, для других режимов вызывает исключение. 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 │ ᴺᵁᴸᴸ   │
└─────────────────────┴─────────┴────────┘

aes_decrypt_mysql​

aes_encrypt_mysql​

decrypt​

encrypt​

tryDecrypt​

aes_decrypt_mysql

aes_encrypt_mysql

decrypt

encrypt

tryDecrypt