_hashlib

OpenSSL interface for hashlib module

Classes

HASH

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

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.

block_size = <attribute 'block_size' of '_hashlib.HASH' objects>

digest_size = <attribute 'digest_size' of '_hashlib.HASH' objects>

name = <attribute 'name' of '_hashlib.HASH' objects>

HASHXOF

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

copy(self, /)

  Return a copy of the hash object.

digest(self, /, length)

  Return the digest value as a bytes object.

hexdigest(self, /, length)

  Return the digest value as a string of hexadecimal digits.

update(self, obj, /)

  Update this hash object's state with the provided string.

block_size = <attribute 'block_size' of '_hashlib.HASH' objects>

digest_size = <attribute 'digest_size' of '_hashlib.HASHXOF' objects>

name = <attribute 'name' of '_hashlib.HASH' objects>

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

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.

block_size = <attribute 'block_size' of '_hashlib.HMAC' objects>

digest_size = <attribute 'digest_size' of '_hashlib.HMAC' objects>

name = <attribute 'name' of '_hashlib.HMAC' objects>

Functions

compare_digest

compare_digest(a, b, /)

  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

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

hmac_digest(key, msg, digest)

  Single-shot HMAC.

hmac_new

hmac_new(key, msg=b'', digestmod=None)

  Return a new hmac object.

new

new(name, string=b'', *, usedforsecurity=True)

  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

openssl_md5(string=b'', *, usedforsecurity=True)

  Returns a md5 hash object; optionally initialized with a string

openssl_sha1

openssl_sha1(string=b'', *, usedforsecurity=True)

  Returns a sha1 hash object; optionally initialized with a string

openssl_sha224

openssl_sha224(string=b'', *, usedforsecurity=True)

  Returns a sha224 hash object; optionally initialized with a string

openssl_sha256

openssl_sha256(string=b'', *, usedforsecurity=True)

  Returns a sha256 hash object; optionally initialized with a string

openssl_sha384

openssl_sha384(string=b'', *, usedforsecurity=True)

  Returns a sha384 hash object; optionally initialized with a string

openssl_sha3_224

openssl_sha3_224(string=b'', *, usedforsecurity=True)

  Returns a sha3-224 hash object; optionally initialized with a string

openssl_sha3_256

openssl_sha3_256(string=b'', *, usedforsecurity=True)

  Returns a sha3-256 hash object; optionally initialized with a string

openssl_sha3_384

openssl_sha3_384(string=b'', *, usedforsecurity=True)

  Returns a sha3-384 hash object; optionally initialized with a string

openssl_sha3_512

openssl_sha3_512(string=b'', *, usedforsecurity=True)

  Returns a sha3-512 hash object; optionally initialized with a string

openssl_sha512

openssl_sha512(string=b'', *, usedforsecurity=True)

  Returns a sha512 hash object; optionally initialized with a string

openssl_shake_128

openssl_shake_128(string=b'', *, usedforsecurity=True)

  Returns a shake-128 variable hash object; optionally initialized with a string

openssl_shake_256

openssl_shake_256(string=b'', *, usedforsecurity=True)

  Returns a shake-256 variable hash object; optionally initialized with a string

pbkdf2_hmac

pbkdf2_hmac(hash_name, password, salt, iterations, dklen=None)

  Password based key derivation function 2 (PKCS #5 v2.0) with HMAC as pseudorandom function.

scrypt

scrypt(password, *, salt=None, n=None, r=None, p=None, maxmem=0, dklen=64)

  scrypt password-based key derivation function.

Other members

openssl_md_meth_names = frozenset({'sha3_384', 'sha3_224', 'ripemd160', 'sm3', 'shake_128', 'shake_256', 'mdc2', 'sha384', 'sha256', 'sha1', 'sha3_256', 'blake2s', 'whirlpool', 'sha512_224', 'sha512', 'sha224', 'md5-sha1', 'sha512_256', 'blake2b', 'md4', 'sha3_512', 'md5'})