暗号化関数

これらの関数は、AES (Advanced Encryption Standard) アルゴリズムを使用してデータの暗号化および復号化を実装します。

キーの長さは暗号化モードによって異なり、-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データの復号化

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

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

この関数は、以下のモードを使用して 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-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