:mod:`!hmac` --- Keyed-Hashing for Message Authentication
Python 3.14 Docs · نسخهٔ 3.14.10 · PSF License
:mod:!hmac --- Keyed-Hashing for Message Authentication
:synopsis: Keyed-Hashing for Message Authentication (HMAC) implementation
Source code: Lib/hmac.py
--------------
This module implements the HMAC algorithm as described by 2104. The interface allows to use any hash function with a *fixed* digest size. In particular, extendable output functions such as SHAKE-128 or SHAKE-256 cannot be used with HMAC.
Return a new hmac object. *key* is a bytes or bytearray object giving the secret key. If *msg* is present, the method call `update(msg) is made. *digestmod* is the digest name, digest constructor or module for the HMAC object to use. It may be any name suitable to hashlib.new`. Despite its argument position, it is required.
Parameter *key* can be a bytes or bytearray object. Parameter *msg* can be of any type supported by hashlib. Parameter *digestmod* can be the name of a hash algorithm.
The *digestmod* argument is now required. Pass it as a keyword argument to avoid awkwardness when you do not have an initial *msg*.
Return digest of *msg* for given secret *key* and *digest*. The function is equivalent to `HMAC(key, msg, digest).digest(), but uses an optimized C or inline implementation, which is faster for messages that fit into memory. The parameters *key*, *msg*, and *digest* have the same meaning as in ~hmac.new`.
CPython implementation detail, the optimized C implementation is only used when *digest* is a string and name of a digest algorithm, which is supported by OpenSSL.
An HMAC object has the following methods:
Update the hmac object with *msg*. Repeated calls are equivalent to a single call with the concatenation of all the arguments: `m.update(a); m.update(b) is equivalent to m.update(a + b)`.
Parameter *msg* can be of any type supported by hashlib.
Return the digest of the bytes passed to the update method so far. This bytes object will be the same length as the *digest_size* of the digest given to the constructor. It may contain non-ASCII bytes, including NUL bytes.
When comparing the output of digest to an externally supplied digest during a verification routine, it is recommended to use the compare_digest function instead of the `==` operator to reduce the vulnerability to timing attacks.
Like digest except the digest is returned as a string twice the length containing only hexadecimal digits. This may be used to exchange the value safely in email or other non-binary environments.
When comparing the output of hexdigest to an externally supplied digest during a verification routine, it is recommended to use the compare_digest function instead of the `==` operator to reduce the vulnerability to timing attacks.
Return a copy ("clone") of the hmac object. This can be used to efficiently compute the digests of strings that share a common initial substring.
A hash object has the following attributes:
The size of the resulting HMAC digest in bytes.
The internal block size of the hash algorithm in bytes.
The canonical name of this HMAC, always lowercase, e.g. `hmac-md5`.
Removed the undocumented attributes `HMAC.digest_cons, HMAC.inner, and HMAC.outer`.
This module also provides the following helper function:
Return `a == b. This function uses an approach designed to prevent timing analysis by avoiding content-based short circuiting behaviour, making it appropriate for cryptography. *a* and *b* must both be of the same type: either str (ASCII only, as e.g. returned by HMAC.hexdigest), or a bytes-like object`.
If *a* and *b* are of different lengths, or if an error occurs, a timing attack could theoretically reveal information about the types and lengths of *a* and *b*—but not their values.
The function uses OpenSSL's `CRYPTO_memcmp()` internally when available.
Module hashlib The Python module providing secure hash functions.