hmac — 用于消息认证的密钥散列¶
源代码: Lib/hmac.py
此模块实现了 RFC 2104 中描述的 HMAC 算法。
- hmac.new(key, msg=None, digestmod)¶
返回一个新的 hmac 对象。key 是一个字节或字节数组对象，给出密钥。如果存在 msg，则进行方法调用
update(msg)。digestmod 是要使用的 HMAC 对象的摘要名称、摘要构造函数或模块。它可以是适合hashlib.new()的任何名称。尽管其参数位置，它是必需的。在 3.4 版本中更改: 参数 key 可以是字节或字节数组对象。参数 msg 可以是
hashlib支持的任何类型。参数 digestmod 可以是散列算法的名称。在 3.8 版本中更改: 现在需要 digestmod 参数。当您没有初始 msg 时，将其作为关键字参数传递可以避免尴尬。
- hmac.digest(key, msg, digest)¶
返回给定密钥 key 和 digest 的 msg 的摘要。该函数等效于
HMAC(key, msg, digest).digest()，但使用优化的 C 或内联实现，对于适合内存的消息更快。参数 key、msg 和 digest 的含义与new()中的相同。CPython 实现细节，仅当 digest 是一个字符串并且是 OpenSSL 支持的摘要算法名称时，才使用优化的 C 实现。
3.7 版本中新增。
HMAC 对象具有以下方法
- HMAC.update(msg)¶
使用 msg 更新 hmac 对象。重复调用等效于对所有参数的串联进行单个调用：
m.update(a); m.update(b)等效于m.update(a + b)。在 3.4 版本中更改: 参数 msg 可以是
hashlib支持的任何类型。
- HMAC.digest()¶
返回到目前为止传递给
update()方法的字节的摘要。此字节对象的长度将与提供给构造函数的摘要的 digest_size 相同。它可能包含非 ASCII 字节，包括 NUL 字节。警告
在验证例程中将
digest()的输出与外部提供的摘要进行比较时，建议使用compare_digest()函数而不是==运算符，以减少定时攻击的漏洞。
- HMAC.hexdigest()¶
与
digest()类似，只是摘要作为长度为其两倍的字符串返回，其中仅包含十六进制数字。这可以用于在电子邮件或其他非二进制环境中安全地交换值。警告
在验证例程中将
hexdigest()的输出与外部提供的摘要进行比较时，建议使用compare_digest()函数而不是==运算符，以减少定时攻击的漏洞。
- HMAC.copy()¶
返回 hmac 对象的副本（“克隆”）。这可以用于有效地计算共享公共初始子字符串的字符串的摘要。
散列对象具有以下属性
- HMAC.digest_size¶
以字节为单位的 HMAC 摘要结果的大小。
- HMAC.block_size¶
散列算法的内部块大小，以字节为单位。
3.4 版本中新增。
- HMAC.name¶
此 HMAC 的规范名称，始终为小写，例如
hmac-md5。3.4 版本中新增。
在 3.10 版本中更改: 删除了未记录的属性 HMAC.digest_cons、HMAC.inner 和 HMAC.outer。
此模块还提供以下辅助函数
- hmac.compare_digest(a, b)¶
返回
a == b。此函数使用一种旨在通过避免基于内容的短路行为来防止定时分析的方法，使其适用于密码学。a 和 b 必须是相同的类型：要么是str(仅限 ASCII，例如由HMAC.hexdigest()返回的），要么是 类似字节的对象。注意
如果 a 和 b 的长度不同，或者发生错误，则定时攻击可能会在理论上泄露有关 a 和 b 的类型和长度的信息，但不会泄露它们的值。
3.3 版本中新增。
在 3.10 版本中更改: 该函数在可用时在内部使用 OpenSSL 的
CRYPTO_memcmp()。
参见
- 模块
hashlib 提供安全散列函数的 Python 模块。