pycryptodome API reference

171 public APIs from pycryptodome (Legrandin/pycryptodome) — 67 classes, 45 functions, 59 methods. Signatures extracted by static analysis of the actual source.

Repository: Legrandin/pycryptodome

Kind	Count
Classes	67
Functions	45
Methods	59

API list

funcDoc.sphinx_rtd_theme.get_html_theme_path()

Return list of HTML theme paths.

funclib.Crypto.Cipher.AES.new(key, mode, *args, **kwargs)

Create a new AES cipher.

funclib.Crypto.Cipher.ARC2.new(key, mode, *args, **kwargs)

Create a new RC2 cipher.

classlib.Crypto.Cipher.ARC4.ARC4Cipher

ARC4 cipher object.

methodlib.Crypto.Cipher.ARC4.ARC4Cipher.decrypt(ciphertext)

Decrypt a piece of data.

methodlib.Crypto.Cipher.ARC4.ARC4Cipher.encrypt(plaintext)

Encrypt a piece of data.

funclib.Crypto.Cipher.ARC4.new(key, *args, **kwargs)

Create a new ARC4 cipher.

classlib.Crypto.Cipher.ChaCha20.ChaCha20Cipher

ChaCha20 (or XChaCha20) cipher object.

methodlib.Crypto.Cipher.ChaCha20.ChaCha20Cipher.decrypt(ciphertext, output=None)

Decrypt a piece of data.

methodlib.Crypto.Cipher.ChaCha20.ChaCha20Cipher.encrypt(plaintext, output=None)

Encrypt a piece of data.

funclib.Crypto.Cipher.DES.new(key, mode, *args, **kwargs)

Create a new DES cipher.

funclib.Crypto.Cipher.DES3.adjust_key_parity(key_in)

Set the parity bits in a TDES key.

funclib.Crypto.Cipher.DES3.new(key, mode, *args, **kwargs)

Create a new Triple DES cipher.

classlib.Crypto.Cipher.PKCS1_OAEP.PKCS1OAEP_Cipher

Cipher object for PKCS#1 OAEP.

classlib.Crypto.Cipher.Salsa20.Salsa20Cipher

Salsa20 cipher object.

methodlib.Crypto.Cipher.Salsa20.Salsa20Cipher.decrypt(ciphertext, output=None)

Decrypt a piece of data.

methodlib.Crypto.Cipher.Salsa20.Salsa20Cipher.encrypt(plaintext, output=None)

Encrypt a piece of data.

classlib.Crypto.Cipher._mode_cbc.CbcMode

*Cipher-Block Chaining (CBC)*.

classlib.Crypto.Cipher._mode_ccm.CcmMode

Counter with CBC-MAC (CCM).

methodlib.Crypto.Cipher._mode_ccm.CcmMode.digest()

Compute the *binary* MAC tag.

methodlib.Crypto.Cipher._mode_ccm.CcmMode.hexdigest()

Compute the *printable* MAC tag.

methodlib.Crypto.Cipher._mode_ccm.CcmMode.verify(received_mac_tag)

Validate the *binary* MAC tag.

classlib.Crypto.Cipher._mode_cfb.CfbMode

*Cipher FeedBack (CFB)*.

classlib.Crypto.Cipher._mode_ctr.CtrMode

*CounTeR (CTR)* mode.

classlib.Crypto.Cipher._mode_eax.EaxMode

*EAX* mode.

methodlib.Crypto.Cipher._mode_eax.EaxMode.digest()

Compute the *binary* MAC tag.

methodlib.Crypto.Cipher._mode_eax.EaxMode.hexdigest()

Compute the *printable* MAC tag.

methodlib.Crypto.Cipher._mode_eax.EaxMode.verify(received_mac_tag)

Validate the *binary* MAC tag.

classlib.Crypto.Cipher._mode_ecb.EcbMode

*Electronic Code Book (ECB)*.

classlib.Crypto.Cipher._mode_gcm.GcmMode

Galois Counter Mode (GCM).

methodlib.Crypto.Cipher._mode_gcm.GcmMode.hexdigest()

Compute the *printable* MAC tag.

methodlib.Crypto.Cipher._mode_gcm.GcmMode.verify(received_mac_tag)

Validate the *binary* MAC tag.

classlib.Crypto.Cipher._mode_kw.KWMode

Key Wrap (KW) mode.

methodlib.Crypto.Cipher._mode_kw.KWMode.seal(plaintext:Union[bytes, bytearray]) -> bytes

Encrypt and authenticate (wrap) a cryptographic key.

methodlib.Crypto.Cipher._mode_kw.KWMode.unseal(ciphertext:Union[bytes, bytearray]) -> bytes

Decrypt and authenticate (unwrap) a cryptographic key.

classlib.Crypto.Cipher._mode_kwp.KWPMode

Key Wrap with Padding (KWP) mode.

methodlib.Crypto.Cipher._mode_kwp.KWPMode.seal(plaintext:Union[bytes, bytearray]) -> bytes

Encrypt and authenticate (wrap) a cryptographic key.

methodlib.Crypto.Cipher._mode_kwp.KWPMode.unseal(ciphertext:Union[bytes, bytearray]) -> bytes

Decrypt and authenticate (unwrap) a cryptographic key.

classlib.Crypto.Cipher._mode_ocb.OcbMode

Offset Codebook (OCB) mode.

methodlib.Crypto.Cipher._mode_ocb.OcbMode.digest()

Compute the *binary* MAC tag.

methodlib.Crypto.Cipher._mode_ocb.OcbMode.hexdigest()

Compute the *printable* MAC tag.

methodlib.Crypto.Cipher._mode_ocb.OcbMode.update(assoc_data)

Process the associated data.

methodlib.Crypto.Cipher._mode_ocb.OcbMode.verify(received_mac_tag)

Validate the *binary* MAC tag.

classlib.Crypto.Cipher._mode_ofb.OfbMode

*Output FeedBack (OFB)*.

classlib.Crypto.Cipher._mode_openpgp.OpenPgpMode

OpenPGP mode.

classlib.Crypto.Cipher._mode_siv.SivMode

Synthetic Initialization Vector (SIV).

methodlib.Crypto.Cipher._mode_siv.SivMode.digest()

Compute the *binary* MAC tag.

methodlib.Crypto.Cipher._mode_siv.SivMode.hexdigest()

Compute the *printable* MAC tag.

methodlib.Crypto.Cipher._mode_siv.SivMode.verify(received_mac_tag)

Validate the *binary* MAC tag.

classlib.Crypto.Hash.BLAKE2b.BLAKE2b_Hash

A BLAKE2b hash object.

methodlib.Crypto.Hash.BLAKE2b.BLAKE2b_Hash.new(**kwargs)

Return a new instance of a BLAKE2b hash object.

funclib.Crypto.Hash.BLAKE2b.new(**kwargs)

Create a new hash object.

classlib.Crypto.Hash.BLAKE2s.BLAKE2s_Hash

A BLAKE2s hash object.

funclib.Crypto.Hash.BLAKE2s.new(**kwargs)

Create a new hash object.

classlib.Crypto.Hash.CMAC.CMAC

A CMAC hash object.

methodlib.Crypto.Hash.CMAC.CMAC.copy()

Return a copy ("clone") of the CMAC object.

funclib.Crypto.Hash.CMAC.new(key, msg=None, ciphermod=None, cipher_params=None, mac_len=None, update_after_digest=False)

Create a new MAC object.

classlib.Crypto.Hash.HMAC.HMAC

An HMAC hash object.

funclib.Crypto.Hash.HMAC.new(key, msg=b'', digestmod=None)

Create a new MAC object.

classlib.Crypto.Hash.KMAC128.KMAC_Hash

A KMAC hash object.

funclib.Crypto.Hash.KMAC128.new(**kwargs)

Create a new KMAC128 object.

funclib.Crypto.Hash.KMAC256.new(**kwargs)

Create a new KMAC256 object.

classlib.Crypto.Hash.KangarooTwelve.K12_XOF

A KangarooTwelve hash object.

methodlib.Crypto.Hash.KangarooTwelve.K12_XOF.read(length)

Produce more bytes of the digest.

methodlib.Crypto.Hash.KangarooTwelve.K12_XOF.update(data)

Hash the next piece of data.

classlib.Crypto.Hash.MD2.MD2Hash

An MD2 hash object.

funclib.Crypto.Hash.MD2.new(data=None)

Create a new hash object.

classlib.Crypto.Hash.MD4.MD4Hash

Class that implements an MD4 hash

classlib.Crypto.Hash.MD5.MD5Hash

A MD5 hash object.

methodlib.Crypto.Hash.MD5.MD5Hash.new(data=None)

Create a fresh SHA-1 hash object.

funclib.Crypto.Hash.MD5.new(data=None)

Create a new hash object.

classlib.Crypto.Hash.Poly1305.Poly1305_MAC

An Poly1305 MAC object.

funclib.Crypto.Hash.Poly1305.new(**kwargs)

Create a new Poly1305 MAC object.

classlib.Crypto.Hash.RIPEMD160.RIPEMD160Hash

A RIPEMD-160 hash object.

funclib.Crypto.Hash.RIPEMD160.new(data=None)

Create a new hash object.

classlib.Crypto.Hash.SHA1.SHA1Hash

A SHA-1 hash object.

methodlib.Crypto.Hash.SHA1.SHA1Hash.new(data=None)

Create a fresh SHA-1 hash object.

funclib.Crypto.Hash.SHA1.new(data=None)

Create a new hash object.

classlib.Crypto.Hash.SHA224.SHA224Hash

A SHA-224 hash object.

methodlib.Crypto.Hash.SHA224.SHA224Hash.new(data=None)

Create a fresh SHA-224 hash object.

funclib.Crypto.Hash.SHA224.new(data=None)

Create a new hash object.

classlib.Crypto.Hash.SHA256.SHA256Hash

A SHA-256 hash object.

methodlib.Crypto.Hash.SHA256.SHA256Hash.new(data=None)

Create a fresh SHA-256 hash object.

funclib.Crypto.Hash.SHA256.new(data=None)

Create a new hash object.

classlib.Crypto.Hash.SHA384.SHA384Hash

A SHA-384 hash object.

methodlib.Crypto.Hash.SHA384.SHA384Hash.new(data=None)

Create a fresh SHA-384 hash object.

funclib.Crypto.Hash.SHA384.new(data=None)

Create a new hash object.

classlib.Crypto.Hash.SHA3_224.SHA3_224_Hash

A SHA3-224 hash object.

funclib.Crypto.Hash.SHA3_224.new(*args, **kwargs)

Create a new hash object.

classlib.Crypto.Hash.SHA3_256.SHA3_256_Hash

A SHA3-256 hash object.

funclib.Crypto.Hash.SHA3_256.new(*args, **kwargs)

Create a new hash object.

classlib.Crypto.Hash.SHA3_384.SHA3_384_Hash

A SHA3-384 hash object.

funclib.Crypto.Hash.SHA3_384.new(*args, **kwargs)

Create a new hash object.

classlib.Crypto.Hash.SHA3_512.SHA3_512_Hash

A SHA3-512 hash object.

funclib.Crypto.Hash.SHA3_512.new(*args, **kwargs)

Create a new hash object.

funclib.Crypto.Hash.SHA512.new(data=None, truncate=None)

Create a new hash object.

classlib.Crypto.Hash.SHAKE128.SHAKE128_XOF

A SHAKE128 hash object.

classlib.Crypto.Hash.SHAKE256.SHAKE256_XOF

A SHAKE256 hash object.

classlib.Crypto.Hash.TupleHash128.TupleHash

A Tuple hash object.

funclib.Crypto.Hash.TupleHash128.new(**kwargs)

Create a new TupleHash128 object.

funclib.Crypto.Hash.TupleHash256.new(**kwargs)

Create a new TupleHash256 object.

classlib.Crypto.Hash.TurboSHAKE128.TurboSHAKE

A TurboSHAKE hash object.

funclib.Crypto.Hash.TurboSHAKE128.new(**kwargs)

Create a new TurboSHAKE128 object.

funclib.Crypto.Hash.TurboSHAKE256.new(**kwargs)

Create a new TurboSHAKE256 object.

classlib.Crypto.Hash.cSHAKE128.cSHAKE_XOF

A cSHAKE hash object.

classlib.Crypto.Hash.keccak.Keccak_Hash

A Keccak hash object.

methodlib.Crypto.Hash.keccak.Keccak_Hash.new(**kwargs)

Create a fresh Keccak hash object.

funclib.Crypto.Hash.keccak.new(**kwargs)

Create a new hash object.

funclib.Crypto.IO.PEM.decode(pem_data, passphrase=None)

Decode a PEM block into binary.

classlib.Crypto.Math._IntegerGMP.IntegerGMP

A fast, arbitrary precision integer

methodlib.Crypto.Math._IntegerGMP.IntegerGMP.jacobi_symbol(a, n)

Compute the Jacobi symbol

classlib.Crypto.Math._IntegerNative.IntegerNative

A class to model a natural integer (including zero)

classlib.Crypto.Protocol.HPKE.MODE

HPKE modes

classlib.Crypto.Protocol.SecretSharing.Shamir

Shamir's secret sharing scheme.

methodlib.Crypto.Protocol.SecretSharing.Shamir.split(k, n, secret, ssss=False)

Split a secret into ``n`` shares.

classlib.Crypto.PublicKey.DSA.DsaKey

Class defining an actual DSA key.

methodlib.Crypto.PublicKey.DSA.DsaKey.domain()

The DSA domain parameters.

methodlib.Crypto.PublicKey.DSA.DsaKey.export_key(format='PEM', pkcs8=None, passphrase=None, protection=None, randfunc=None)

Export this DSA key.

methodlib.Crypto.PublicKey.DSA.DsaKey.has_private()

Whether this is a DSA private key

methodlib.Crypto.PublicKey.DSA.DsaKey.public_key()

A matching DSA public key.

funclib.Crypto.PublicKey.DSA.generate(bits, randfunc=None, domain=None)

Generate a new DSA key pair.

funclib.Crypto.PublicKey.DSA.import_key(extern_key, passphrase=None)

Import a DSA key.

classlib.Crypto.PublicKey.ECC.EccKey

Class defining an ECC key.

methodlib.Crypto.PublicKey.ECC.EccKey.export_key(**kwargs)

Export this ECC key.

methodlib.Crypto.PublicKey.ECC.EccKey.public_key()

A matching ECC public key.

classlib.Crypto.PublicKey.ElGamal.ElGamalKey

Class defining an ElGamal key.

methodlib.Crypto.PublicKey.ElGamal.ElGamalKey.publickey()

A matching ElGamal public key.

classlib.Crypto.PublicKey.RSA.RsaKey

Class defining an RSA key, private or public.

methodlib.Crypto.PublicKey.RSA.RsaKey.blind(M, B)

:meta private:

methodlib.Crypto.PublicKey.RSA.RsaKey.decrypt(ciphertext)

:meta private:

methodlib.Crypto.PublicKey.RSA.RsaKey.encrypt(plaintext, K)

:meta private:

methodlib.Crypto.PublicKey.RSA.RsaKey.exportKey(*args, **kwargs)

:meta private:

methodlib.Crypto.PublicKey.RSA.RsaKey.has_private()

Whether this is an RSA private key

methodlib.Crypto.PublicKey.RSA.RsaKey.public_key()

A matching RSA public key.

methodlib.Crypto.PublicKey.RSA.RsaKey.publickey()

:meta private:

methodlib.Crypto.PublicKey.RSA.RsaKey.sign(M, K)

:meta private:

methodlib.Crypto.PublicKey.RSA.RsaKey.size()

:meta private:

methodlib.Crypto.PublicKey.RSA.RsaKey.size_in_bits()

Size of the RSA modulus in bits

methodlib.Crypto.PublicKey.RSA.RsaKey.unblind(M, B)

:meta private:

methodlib.Crypto.PublicKey.RSA.RsaKey.verify(M, signature)

:meta private:

funclib.Crypto.PublicKey.RSA.generate(bits, randfunc=None, e=65537)

Create a new RSA key pair.

classlib.Crypto.PublicKey._point.EccPoint

A class to model a point on an Elliptic Curve.

methodlib.Crypto.PublicKey._point.EccPoint.copy()

Return a copy of this point.

methodlib.Crypto.PublicKey._point.EccPoint.size_in_bits()

Size of each coordinate, in bits.

funclib.Crypto.SelfTest.run(module=None, verbosity=0, stream=None, tests=None, config=None, **kwargs)

Execute self-tests.

funclib.Crypto.SelfTest.st_common.b2a_hex(s)

Convert binary to hexadecimal

classlib.Crypto.Signature.DSS.DssSigScheme

A (EC)DSA signature object.

classlib.Crypto.Signature.eddsa.EdDSASigScheme

An EdDSA signature object.

classlib.Crypto.Signature.pkcs1_15.PKCS115_SigScheme

A signature object for ``RSASSA-PKCS1-v1_5``.

classlib.Crypto.Signature.pss.PSS_SigScheme

A signature object for ``RSASSA-PSS``.

funclib.Crypto.Util.Padding.pad(data_to_pad, block_size, style='pkcs7')

Apply standard padding.

funclib.Crypto.Util.Padding.unpad(padded_data, block_size, style='pkcs7')

Remove standard padding.

classlib.Crypto.Util._raw_api.SmartPointer

Class to hold a non-managed piece of memory

classlib.Crypto.Util._raw_api.VoidPointer_cffi

Model a newly allocated pointer to void

classlib.Crypto.Util._raw_api.VoidPointer_ctypes

Model a newly allocated pointer to void

funclib.Crypto.Util._raw_api.c_size_t(x)

Convert a Python integer to size_t

funclib.Crypto.Util._raw_api.c_ulong(x)

Convert a Python integer to unsigned long

funclib.Crypto.Util._raw_api.get_raw_buffer(buf)

Convert a C buffer into a Python byte sequence

classlib.Crypto.Util.asn1.DerBitString

Class to model a DER BIT STRING.

classlib.Crypto.Util.asn1.DerBoolean

Class to model a DER-encoded BOOLEAN.

classlib.Crypto.Util.asn1.DerInteger

Class to model a DER INTEGER.

classlib.Crypto.Util.asn1.DerNull

Class to model a DER NULL element.

classlib.Crypto.Util.asn1.DerObject

Base class for defining a single DER object.

classlib.Crypto.Util.asn1.DerObjectId

Class to model a DER OBJECT ID.

classlib.Crypto.Util.asn1.DerOctetString

Class to model a DER OCTET STRING.

classlib.Crypto.Util.asn1.DerSequence

Class to model a DER SEQUENCE.

classlib.Crypto.Util.asn1.DerSetOf

Class to model a DER SET OF.

methodlib.Crypto.Util.asn1.DerSetOf.add(elem)

Add an element to the set.

funclib.Crypto.Util.number.bytes_to_long(s)

Convert a byte string to a long integer (big endian).

funclib.Crypto.Util.number.getPrime(N, randfunc=None)

Return a random N-bit prime number.

funclib.Crypto.Util.number.isPrime(N, false_positive_prob=1e-06, randfunc=None)

Test if a number *N* is a prime.

About this data

These signatures were extracted from the public source of Legrandin/pycryptodome using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries