# _hashlib - pydoc - phpman Help on module _hashlib: ## NAME _hashlib - OpenSSL interface for hashlib module ## MODULE REFERENCE The following documentation is automatically generated from the Python source files. It may be incomplete, incorrect or include features that are considered implementation detail and may vary between Python implementations. When in doubt, consult the module reference at the location listed above. ## CLASSES builtins.ValueError(builtins.Exception) UnsupportedDigestmodError builtins.object HASH HASHXOF HMAC ### class HASH | HASH(name, string=b'') | | A hash is an object used to calculate a checksum of a string of information. | | Methods: | | update() -- updates the current digest with an additional string | digest() -- return the current digest value | hexdigest() -- return the current digest as a string of hexadecimal digits | copy() -- return a copy of the current hash object | | Attributes: | | name -- the hash algorithm being used by this object | digest_size -- number of bytes in this hashes output | | Methods defined here: | | __repr__(self, /) | Return repr(self). | | copy(self, /) | Return a copy of the hash object. | | digest(self, /) | Return the digest value as a bytes object. | | hexdigest(self, /) | Return the digest value as a string of hexadecimal digits. | | update(self, obj, /) | Update this hash object's state with the provided string. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | block_size | | digest_size | | name ### class HASHXOF | HASHXOF(name, string=b'') | | A hash is an object used to calculate a checksum of a string of information. | | Methods: | | update() -- updates the current digest with an additional string | digest(length) -- return the current digest value | hexdigest(length) -- return the current digest as a string of hexadecimal digits | copy() -- return a copy of the current hash object | | Attributes: | | name -- the hash algorithm being used by this object | digest_size -- number of bytes in this hashes output | | Method resolution order: | HASHXOF | HASH | builtins.object | | Methods defined here: | | digest(self, /, length) | Return the digest value as a bytes object. | | hexdigest(self, /, length) | Return the digest value as a string of hexadecimal digits. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | digest_size | | ---------------------------------------------------------------------- | Methods inherited from HASH: | | __repr__(self, /) | Return repr(self). | | copy(self, /) | Return a copy of the hash object. | | update(self, obj, /) | Update this hash object's state with the provided string. | | ---------------------------------------------------------------------- | Data descriptors inherited from HASH: | | block_size | | name ### class HMAC | The object used to calculate HMAC of a message. | | Methods: | | update() -- updates the current digest with an additional string | digest() -- return the current digest value | hexdigest() -- return the current digest as a string of hexadecimal digits | copy() -- return a copy of the current hash object | | Attributes: | | name -- the name, including the hash algorithm used by this object | digest_size -- number of bytes in digest() output | | Methods defined here: | | __repr__(self, /) | Return repr(self). | | copy(self, /) | Return a copy ("clone") of the HMAC object. | | digest(self, /) | Return the digest of the bytes passed to the update() method so far. | | hexdigest(self, /) | Return hexadecimal digest of the bytes passed to the update() method so far. | | This may be used to exchange the value safely in email or other non-binary | environments. | | update(self, /, msg) | Update the HMAC object with msg. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | block_size | | digest_size | | name ### class UnsupportedDigestmodError | Method resolution order: | UnsupportedDigestmodError | builtins.ValueError | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors defined here: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Methods inherited from builtins.ValueError: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.ValueError: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args ## FUNCTIONS ### compare_digest Return 'a == b'. This function uses an approach designed to prevent timing analysis, making it appropriate for cryptography. a and b must both be of the same type: either str (ASCII only), or any bytes-like object. Note: 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. ### get_fips_mode Determine the OpenSSL FIPS mode of operation. For OpenSSL 3.0.0 and newer it returns the state of the default provider in the default OSSL context. It's not quite the same as FIPS_mode() but good enough for unittests. Effectively any non-zero return value indicates FIPS mode; values other than 1 may have additional significance. ### hmac_digest Single-shot HMAC. ### hmac_new Return a new hmac object. ### new Return a new hash object using the named algorithm. An optional string argument may be provided and will be automatically hashed. The MD5 and SHA1 algorithms are always supported. ### openssl_md5 Returns a md5 hash object; optionally initialized with a string ### openssl_sha1 Returns a sha1 hash object; optionally initialized with a string ### openssl_sha224 Returns a sha224 hash object; optionally initialized with a string ### openssl_sha256 Returns a sha256 hash object; optionally initialized with a string ### openssl_sha384 Returns a sha384 hash object; optionally initialized with a string ### openssl_sha3_224 Returns a sha3-224 hash object; optionally initialized with a string ### openssl_sha3_256 Returns a sha3-256 hash object; optionally initialized with a string ### openssl_sha3_384 Returns a sha3-384 hash object; optionally initialized with a string ### openssl_sha3_512 Returns a sha3-512 hash object; optionally initialized with a string ### openssl_sha512 Returns a sha512 hash object; optionally initialized with a string ### openssl_shake_128 Returns a shake-128 variable hash object; optionally initialized with a string ### openssl_shake_256 Returns a shake-256 variable hash object; optionally initialized with a string ### pbkdf2_hmac Password based key derivation function 2 (PKCS #5 v2.0) with HMAC as pseudorandom function. ### scrypt scrypt password-based key derivation function. ## DATA openssl_md_meth_names = frozenset({'blake2b', 'blake2s', 'md5', 'md5-s... ## FILE /usr/lib/python3.10/lib-dynload/_hashlib.cpython-310-x86_64-linux-gnu.so