海馬克

回傳使用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)

參數

參數 類型 Description
key pyspark.sql.Column 或 str 秘密金鑰,作為二進位值。
message pyspark.sql.Column 或 str 訊息要驗證,作為二進位值。
algorithm pyspark.sql.Column 或是力量,選用 雜湊演算法。 有效數值: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|
+----------------------------------------+