API Reference

• ciphers package
  • Base classes
    • BaseSymmetricCipher
      • BaseSymmetricCipher.is_encrypting()
      • BaseSymmetricCipher.update()
      • BaseSymmetricCipher.update_into()
    • BaseNonAEADCipher
      • BaseNonAEADCipher.finalize()
    • BaseAEADCipher
      • BaseAEADCipher.authenticate()
      • BaseAEADCipher.finalize()
      • BaseAEADCipher.calculate_tag()
    • BaseAEADOneShotCipher
      • BaseAEADOneShotCipher.update()
      • BaseAEADOneShotCipher.update_into()
    • BaseHash
      • BaseHash.digest_size
      • BaseHash.block_size
      • BaseHash.update()
      • BaseHash.digest()
      • BaseHash.hexdigest()
      • BaseHash.copy()
      • BaseHash.name
      • BaseHash.new()
    • BaseRSAPrivateKey
      • BaseRSAPrivateKey.n
      • BaseRSAPrivateKey.e
      • BaseRSAPrivateKey.p
      • BaseRSAPrivateKey.q
      • BaseRSAPrivateKey.d
      • BaseRSAPrivateKey.key_size
      • BaseRSAPrivateKey.decryptor()
      • BaseRSAPrivateKey.signer()
      • BaseRSAPrivateKey.public_key()
      • BaseRSAPrivateKey.serialize()
      • BaseRSAPrivateKey.load()
    • BaseRSAPublicKey
      • BaseRSAPublicKey.n
      • BaseRSAPublicKey.e
      • BaseRSAPublicKey.key_size
      • BaseRSAPublicKey.encryptor()
      • BaseRSAPublicKey.verifier()
      • BaseRSAPublicKey.serialize()
      • BaseRSAPublicKey.load()
    • BaseAsymmetricPadding
      • BaseAsymmetricPadding.name
    • BaseMGF
    • BaseEllepticCurveExchangeAlgorithm
    • BaseEllepticCurveSignatureAlgorithm
    • BaseECCPrivateKey
      • BaseECCPrivateKey.key_size
      • BaseECCPrivateKey.curve
      • BaseECCPrivateKey.public_key()
      • BaseECCPrivateKey.serialize()
      • BaseECCPrivateKey.load()
      • BaseECCPrivateKey.exchange()
      • BaseECCPrivateKey.signer()
    • BaseECCPublicKey
      • BaseECCPublicKey.key_size
      • BaseECCPublicKey.curve
      • BaseECCPublicKey.serialize()
      • BaseECCPublicKey.load()
      • BaseECCPublicKey.verifier()
    • BaseSignerContext
      • BaseSignerContext.sign()
    • BaseVerifierContext
      • BaseVerifierContext.verify()
    • BaseEdDSASignerContext
      • BaseEdDSASignerContext.sign()
    • BaseEdDSAVerifierContext
      • BaseEdDSAVerifierContext.verify()
    • BaseEncryptorContext
      • BaseEncryptorContext.encrypt()
    • BaseDecryptorContext
      • BaseDecryptorContext.decrypt()
    • BaseDHParameters
      • BaseDHParameters.g
      • BaseDHParameters.p
      • BaseDHParameters.q
      • BaseDHParameters.private_key()
      • BaseDHParameters.serialize()
      • BaseDHParameters.load()
      • BaseDHParameters.load_from_parameters()
    • BaseDHPrivateKey
      • BaseDHPrivateKey.parameters()
      • BaseDHPrivateKey.key_size
      • BaseDHPrivateKey.public_key()
      • BaseDHPrivateKey.exchange()
      • BaseDHPrivateKey.serialize()
      • BaseDHPrivateKey.x
      • BaseDHPrivateKey.load()
    • BaseDHPublicKey
      • BaseDHPublicKey.parameters()
      • BaseDHPublicKey.key_size
      • BaseDHPublicKey.serialize()
      • BaseDHPublicKey.y
      • BaseDHPublicKey.load()
  • Exception classes
    • DecryptionError
    • SignatureError
    • FinalizationError
    • UnsupportedAlgorithm
    • UnsupportedMode
    • AlreadyFinalized
    • NotFinalized
    • NotYetFinalized
  • Symmetric cipher modes
    • Modes
      • Modes.MODE_GCM
      • Modes.MODE_CTR
      • Modes.MODE_CFB
      • Modes.MODE_CFB8
      • Modes.MODE_OFB
      • Modes.MODE_CCM
      • Modes.MODE_EAX
      • Modes.MODE_SIV
      • Modes.MODE_OCB
    • SPECIAL
  • Algorithm loaders
    • Symmetric Ciphers
      • AES
      • Camellia
      • ChaCha20
    • Asymmetric Ciphers
      • Diffie-Hellman Key Exchange
      • Elleptic-curve Cryptography
      • RSA Asymmetric Cipher
    • Hash functions
      • Hash functions
  • Backend of PyFLocker
    • Backends
      • Backends.CRYPTOGRAPHY
      • Backends.CRYPTODOME
    • load_algorithm()
    • load_backend()
    • Implementations
      • Cryptodome specific implementation
      • Cryptography specific implementation
    • Various tools
      • Tools related to symmetric ciphers
      • Tools related to asymmetric ciphers
• locker – Easy File Encryption
  • The Header
    • Parts of Header
  • Operation details
    • Password derivation
    • Cipher creation
    • Authentication
    • Finalization
  • KDFunc
  • MAX_METADATA_LEN
  • MAX_TAG_LEN
  • MAX_SALT_LEN
  • MAX_NONCE_LEN
  • HEADER_PAYLOAD
  • AUTHENTICATION_PAYLOAD
  • MAGIC
  • PBKDF2_HMAC()
  • METADATA
  • EXTENSION
  • encryptf()
  • decryptf()
  • encrypt()
  • decrypt()
  • lockerf()
  • locker()
  • extract_header_from_file()