返回使用key和给定哈希algorithm的密钥哈希消息认证码(HMAC)。message 结果以原始MAC字节的形式返回;用:func:hex 或:func:base64 封装,作为文本值。 默认算法为 SHA-256.
HMAC通过共享密钥验证消息的完整性和真实性:持有共享key密钥key的接收者可以重新计算代码,确认消息未被篡改,且来自知密钥方。 常见用途包括签署 API 请求、验证 webhook 负载,以及通过串联 HMAC 调用(例如 AWS 签名版 4)推导签名密钥。
Syntax
from pyspark.sql import functions as sf
sf.hmac(key, message, algorithm=None)
参数
| Parameter | 类型 | Description |
|---|---|---|
key |
pyspark.sql.Column 或 str |
秘密密钥,作为二进制值。 |
message |
pyspark.sql.Column 或 str |
认证信息,作为二进制值。 |
algorithm |
pyspark.sql.Column 或 str,可选 |
哈希算法。 有效数值:SHA-224、SHA-256、SHA-384、SHA-512、SHA-1、MD5。 默认是SHA-256。 |
Returns
pyspark.sql.Column:一个包含原始HMAC字节的新列。
Examples
示例1:使用默认的SHA-256算法计算HMAC
from pyspark.sql import functions as sf
df = spark.createDataFrame([("key", "message")], ["key", "message"])
df.select(sf.hex(sf.hmac(df.key, df.message))).show(truncate=False)
+----------------------------------------------------------------+
|hex(hmac(key, message, SHA-256)) |
+----------------------------------------------------------------+
|6E9EF29B75FFFC5B7ABAE527D58FDADB2FE42E7219011976917343065F58ED4A|
+----------------------------------------------------------------+
示例2:用显式算法计算HMAC
from pyspark.sql import functions as sf
df = spark.createDataFrame([("key", "message")], ["key", "message"])
df.select(sf.hex(sf.hmac(df.key, df.message, sf.lit("SHA-1")))).show(truncate=False)
+----------------------------------------+
|hex(hmac(key, message, SHA-1)) |
+----------------------------------------+
|2088DF74D5F2146B48146CAF4965377E9D0BE3A4|
+----------------------------------------+