try_aes_decrypt 函数

  • 项目

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

解密使用 AES 加密生成的二进制文件，如果由于任何原因而失败，则返回 NULL。

语法

try_aes_decrypt(expr, key [, mode [, padding [, aad]]])

参数

  • expr：要解密的二进制表达式。
  • key：二进制表达式。 必须与最初用于生成加密值的密钥匹配，并且长度为 16、24 或 32 字节。
  • mode：一个可选的字符串表达式，描述用于生成加密值的加密模式。
  • padding：一个可选的字符串表达式，描述加密如何处理将值填充到密钥长度。
  • aad：一个可选的 STRING 表达式，在 GCM 模式中提供经过身份验证的其他数据 (AAD)。 必须与用于生成加密值的 aad 匹配。 适用于 Databricks SQL 和 Databricks Runtime 13.3 及更高版本。

返回

一个 BINARY。

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

  • 'ECB'：使用电子密码本 (ECB) 模式。
  • 'GCM'：使用 Galois/计数器模式 (GCM)。 这是默认值。

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

  • 'NONE'：不使用填充。 仅对 'GCM' 有效。
  • 'PKCS'：使用公钥加密标准 (PKCS) 填充。 仅对 'ECB' 有效。
  • 'DEFAULT'：将 'NONE' 用于 'GCM'，将 'PKCS' 用于 'ECB' 模式。

算法取决于密钥的长度：

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

若要在出现错误情况时引发错误而不是 NULL，请使用 try_aes_decrypt。

示例

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

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

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

> SELECT cast(try_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==

-- try_aes_decrypt tolerates an error where aes_decrypt does not.
> SELECT cast(aes_decrypt(x'1234567890abcdef1234567890abcdef', '1234567890abcdef', 'GCM') AS STRING);
  Error: INVALID_PARAMETER_VALUE.AES_KEY

> SELECT cast(try_aes_decrypt(x'1234567890abcdef1234567890abcdef', '1234567890abcdef', 'GCM') AS STRING);
  NULL

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

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