aes_encrypt 函数

  • 项目

适用于：check marked yes Databricks SQL check marked yes Databricks Runtime 10.3 及更高版本

使用 AES 加密对二进制文件进行加密。

语法

aes_encrypt(expr, key [, mode [, padding[, iv[, aad]]]])

参数

  • expr：要加密的 BINARY 表达式。
  • key：一个 BINARY 表达式。 要用于加密 expr 的密钥。 它的长度必须为 16、24 或 32 个字节。
  • mode：描述加密模式的可选 STRING 表达式。
  • padding：可选的 STRING 表达式，描述加密如何将值填充到密钥长度。
  • iv：为 GCM 或 CBC 模式提供初始化矢量 (IV) 的可选 STRING 表达式。 适用于 Databricks SQL 和 Databricks Runtime 13.3 及更高版本。
  • aad：一个可选的 STRING 表达式，在 GCM 模式中提供经过身份验证的其他数据 (AAD)。 适用于 Databricks SQL 和 Databricks Runtime 13.3 及更高版本。

返回

一个 BINARY。

mode 必须是下列项之一（不区分大小写）：

  • 'CBC'：使用 Cipher-Block Chaining (CBC) 模式。 适用于 Databricks SQL、Databricks Runtime 13.2 及更高版本。
  • 'ECB'：使用电子密码本 (ECB) 模式。
  • 'GCM'：使用 Galois/计数器模式 (GCM)。 这是默认值。

padding 必须是下列项之一（不区分大小写）：

  • 'NONE'：不使用填充。 仅对 'GCM' 有效。
  • 'PKCS'：使用公钥加密标准 (PKCS) 填充。 仅对 'ECB' 和 'CBC' 有效。 PKCS 填充会添加 1 到密钥长度数之间的数目的字节以将 expr 填充到 key 长度的倍数。 每个填充字节的值是要填充的字节数。
  • 'DEFAULT'：将 'NONE' 用于 'GCM' 模式，将 'PKCS' 用于 'ECB' 和 'CBC' 模式。

iv，指定时，GCM 必须为 12 字节，CBC 必须为 16 字节。

算法取决于密钥的长度：

  • 16：AES-128
  • 24：AES-192
  • 32：AES-256

示例

> SELECT base64(aes_encrypt('Spark', 'abcdefghijklmnop'));
  4A5jOAh9FNGwoMeuJukfllrLdHEZxA2DyuSQAWz77dfn

> SELECT cast(aes_decrypt(unbase64('4A5jOAh9FNGwoMeuJukfllrLdHEZxA2DyuSQAWz77dfn'),
                          'abcdefghijklmnop') AS STRING);
  Spark

> SELECT base64(aes_encrypt('Spark SQL', '1234567890abcdef', 'ECB', 'PKCS'));
  3lmwu+Mw0H3fi5NDvcu9lg==

> SELECT cast(aes_decrypt(unbase64('3lmwu+Mw0H3fi5NDvcu9lg=='),
                          '1234567890abcdef', 'ECB', 'PKCS') AS STRING);
  Spark SQL

> SELECT base64(aes_encrypt('Spark SQL', '1234567890abcdef', 'GCM'));
  2sXi+jZd/ws+qFC1Tnzvvde5lz+8Haryz9HHBiyrVohXUG7LHA==

> SELECT cast(aes_decrypt(unbase64('2sXi+jZd/ws+qFC1Tnzvvde5lz+8Haryz9HHBiyrVohXUG7LHA=='),
                          '1234567890abcdef', 'GCM') AS STRING);
  Spark SQL

> SELECT base64(aes_encrypt('Spark SQL', '1234567890abcdef', 'GCM', 'DEFAULT', '123456789012', 'Some AAD'));
  MTIzNDU2Nzg5MDEyMdXvR41sJqwZ6hnTU8FRTTtXbL8yeChIZA==

> SELECT cast(aes_decrypt(unbase64('MTIzNDU2Nzg5MDEyMdXvR41sJqwZ6hnTU8FRTTtXbL8yeChIZA=='),
                          '1234567890abcdef', 'GCM', 'DEFAULT', 'Some AAD') AS STRING);
  Spark SQL