All Classes and Interfaces
Class
Description
AEAD Algorithm IDs.
Packet representing non-standard, LibrePGP OCB (AEAD) encrypted data.
Implementation provider for AEAD-based
PBESecretKeyEncryptors.reader for Base64 armored objects - read the headers and then start returning
bytes when the data is reached.
Output stream that writes data in ASCII Armored format.
Return a factory for
PBESecretKeyEncryptor instances which protect the secret key material by deriving
a key-encryption-key using S2K.ARGON_2 S2K and apply
that key using SecretKeyPacket.USAGE_AEAD.Return a factory for
PBESecretKeyEncryptor instances which protect the secret key material by deriving
a key-encryption-key using S2K.SALTED_AND_ITERATED S2K and apply
that key using SecretKeyPacket.USAGE_SHA1 (CFB mode).Implementation of
OpenPGPApi using Bouncy Castles implementation of OpenPGP classes.Implementation of
OpenPGPImplementation using Bouncy Castles implementation of OpenPGP classes.Bouncy Castle implementation of
OpenPGPKeyGenerator.A
PBEDataDecryptorFactory for handling PBE decryption operations using the Bouncy Castle
lightweight API to implement cryptographic primitives.A BC lightweight method generator for supporting PBE based encryption operations.
Implemented by packets written as headers followed by
a stream of data.
Stream reader for PGP objects
base interface for a PGP key
Base class for a PGP object.
Basic output stream.
PGPDataEncryptorBuilder implementation that uses the Bouncy Castle lightweight API to
implement cryptographic primitives.PGPObjectFactory that uses the Bouncy Castle lightweight API to implement cryptographic
primitives.A decryptor factory for handling public key decryption operations.
A method generator for supporting public key based encryption operations.
A decryptor factory for handling PGP session keys.
GnuPG keybox blob.
Base interface for a blob integrity checking operator.
Simple routine to encrypt and decrypt using a passphrase.
Base class for both the compress and decompress classes.
An input stream that decompresses from the BZip2 format (with the file
header chars) to be read as any other stream.
An output stream that compresses into the BZip2 format (with the file
header chars) into another stream.
A PGP blob holds key material.
A simple utility class that creates clear signed files and verifies them.
A generic compressed data object.
Basic tags for compression algorithms.
Basic type for a PGP packet.
A simple utility class that creates seperate signatures for files and verifies them.
A simple utility class that directly signs a public key and writes the signed key to "SignedKey.asc" in
the current working directory.
Implementation of an
InputStream that double-buffers data from an underlying input stream.A simple utility class that generates a public/secret keyring containing a DSA signing
key and an El Gamal key for encryption.
base class for a DSA Public Key.
base class for a DSA Secret Key.
Base class for an ECDH Public Key.
Base class for an ECDSA Public Key.
Base class for an EC Public Key.
Base class for an EC Secret Key.
Public key of type
PublicKeyAlgorithmTags.Ed25519.Secret key of type
PublicKeyAlgorithmTags.Ed25519.Public key of type
PublicKeyAlgorithmTags.Ed448.Secret key of type
PublicKeyAlgorithmTags.Ed448.Base class for an EdDSA Public Key.
Base class for an Edwards Curve (EdDSA) Secret Key.
base class for an ElGamal Public Key.
base class for an ElGamal Secret Key.
A simple utility class that generates an RSA key ring.
Signature Subpacket for embedding one Signature into another.
Encryption Mode.
basic packet for an experimental packet.
Signature Subpacket for marking a signature as exportable or non-exportable.
Signature Subpacket encoding, which features are supported by the key-holders implementation.
First blob contains meta data about the KeyBox.
Basic tags for hash algorithms.
User-Attribute Subpacket used to encode an image, e.g.
An OpenPGP signature is not correct.
A block of data associated with other packets in a PGP object stream.
InputStream that performs verification of integrity protection upon IntegrityProtectedInputStream.close().Signature Subpacket containing the fingerprint of the intended recipients primary key.
Exception that gets thrown if the user tries to encrypt a message for an
OpenPGPCertificate that does not contain any usable, valid encryption keys.Signature Subpacket containing the fingerprint of the issuers signing (sub-) key.
Signature Subpacket containing the key-id of the issuers signing (sub-) key.
Implementation of
OpenPGPApi using the JCA/JCE implementation of OpenPGP classes.Implementation of
OpenPGPImplementation using the JCA/JCE implementation of OpenPGP classes.JCA/JCE implementation of the
OpenPGPKeyGenerator.A builder for
PGPDigestCalculatorProvider instances that obtain cryptographic primitives
using the JCA API.A PGP key pair class that is constructed from JCA/JCE key pairs.
PGPObjectFactory that uses the sources cryptographic primitives from the JCA API.A JCA PrivateKey carrier.
Builder for
PBEDataDecryptorFactory instances that obtain cryptographic primitives using
the JCE API.JCE based generator for password based encryption (PBE) data protection methods.
PGPDataEncryptorBuilder implementation that sources cryptographic primitives using the
JCE APIs.A simple utility class that encrypts/decrypts public key based
encryption files.
A simple utility class that encrypts/decrypts public key based
encryption large files.
A PGP blob holds key material.
KeyBox provides an implementation of the PGP keybox.
Signature Subpacket containing the number of seconds after the key's creation date, after which the key expires.
Signature Subpacket encoding the capabilities / intended uses of a key.
Utility class for matching key-ids / fingerprints.
Callback to generate a
PGPKeyPair from a PGPKeyPairGenerator instance.This is a deprecated LibrePGP signature subpacket with encryption mode numbers to indicate which modes
the key holder prefers to use with OCB Encrypted Data Packets (
AEADEncDataPacket).Generic literal data packet.
An OpenPGP Signature is malformed (missing required subpackets, etc.).
Basic type for a marker packet
Encryption mode (SEIPDv1 / SEIPDv2 / OED) and algorithms.
The OpenPGP certificate (public key) required to verify a signature is not available.
basic packet for a modification detection code packet.
a multiple precision integer
Signature Subpacket encoding custom notations.
Public/Secret BCPGKey which is encoded as an array of octets rather than an MPI.
One-Pass-Signature packet.
Wraps PGP key headers and pgp key SExpression
Main entry to the high level OpenPGP API.
OpenPGP certificates (TPKs - transferable public keys) are long-living structures that may change during
their lifetime.
Component on an OpenPGP certificate.
A component key is either an
OpenPGPCertificate.OpenPGPPrimaryKey, or an OpenPGPCertificate.OpenPGPSubkey.OpenPGP Signature made over some
OpenPGPCertificate.OpenPGPCertificateComponent on a OpenPGPCertificate.An identity bound to the
OpenPGPCertificate.OpenPGPPrimaryKey of a OpenPGPCertificate.The primary key of a
OpenPGPCertificate.Chain of
signatures."Positive" signature chain link.
Link in a
OpenPGPCertificate.OpenPGPSignatureChain."Negative" signature chain link.
Collection of multiple
OpenPGPCertificate.OpenPGPSignatureChain objects.A subkey on a
OpenPGPCertificate.A UserAttribute.
A UserId.
High-Level OpenPGP Signature Generator for Detached Signatures.
High-Level Processor for Messages Signed Using Detached OpenPGP Signatures.
Bouncy Castle provides two implementations of OpenPGP operators.
An
OpenPGPKey (TSK - transferable secret key) is the pendant to an OpenPGPCertificate,
but containing the secret key material in addition to the public components.Unlocked
OpenPGPKey.OpenPGPSecretKey.Secret key component of a
OpenPGPCertificate.OpenPGPPrimaryKey or
OpenPGPCertificate.OpenPGPSubkey.Exception representing an unusable or invalid
OpenPGPKey
or OpenPGPCertificate.High-level generator class for OpenPGP v6 keys.
Implementation of the
OpenPGPKeyMaterialProvider which caches items in a HashMap.Implementation of
OpenPGPKeyMaterialPool tailored to providing
OpenPGPCertificates.Implementation of
OpenPGPKeyMaterialPool tailored to provide OpenPGPKeys.Interface for providing OpenPGP keys or certificates.
Interface for requesting
OpenPGPCertificates by providing a KeyIdentifier.Interface for requesting
OpenPGPKeys by providing a KeyIdentifier.Reader for
OpenPGPKeys or OpenPGPCertificates.Generator for OpenPGP messages.
An
InputStream that processes an OpenPGP message.Implementation of an
OutputStream tailored to creating OpenPGP messages.Factory class for wrapping output streams.
Factory interface for creating PGPPadding objects.
Callback to handle
PGPExceptions.Policy for OpenPGP algorithms and features.
The
OpenPGPPolicy.OpenPGPNotationRegistry can be used to register known notations, such that signatures containing
notation instances of the same name, which are marked as critical do not invalidate the signature.An OpenPGP signature.
An
OpenPGPSignature made over a binary or textual document (e.g.SignatureSubpacket and the OpenPGPSignature that contains it.Deprecated.
Will be removed
OpenPGP Packet Header Length Format.
Basic PGP packet tag types.
A factory for performing PBE decryption operations.
A simple utility class that encrypts/decrypts password based
encryption files.
PGP style PBE encryption method.
Provider for
PBESecretKeyDecryptorBuilder instances.Class responsible for encrypting secret key material or data packets using a passphrase.
Factory class for password-based secret key encryptors.
A data encryptor, using AEAD.
Generator for producing filtered literal data packets which are automatically canonicalized.
A PGP compressed data object.
Generator for producing compressed data packets.
Builder for
PGPContentSigner objects.Provider class for
PGPContentSignerBuilder instances.Provider for
PGPContentVerifierBuilder instances.A decryptor that wraps a stream of PGP encrypted data to decrypt, and optionally integrity check,
the data.
Base interface of factories for
PGPDataDecryptor.A data encryptor, combining a cipher instance and an optional integrity check calculator.
A builder for
PGPDataEncryptor instances, which can be used to encrypt data objects.Thrown if the iv at the start of a data stream indicates the wrong key
is being used.
A digest calculator, which consumes a stream of data and computes a digest value over it.
A factory for digest algorithms.
A PGP encrypted data object.
Generator for encrypted objects.
A holder for a list of PGP encryption method packets and the encrypted data associated with them.
generic exception class for PGP encoding/decoding problems
An encryption method that can be applied to encrypt data in a
PGPEncryptedDataGenerator.key flag values for the KeyFlags subpacket.
General class to handle JCA key pairs and convert them into OpenPGP ones.
Parent class for PGP public and secret key rings.
Generator for a PGP primary and subkey ring.
Thrown if the key checksum is invalid.
A single literal data packet in a PGP object stream.
Generator for producing literal data packets.
a PGP marker packet - in general these should be ignored other than where
the idea is to preserve the original input stream.
General class for reading a PGP object stream.
A one pass signature object.
Holder for a list of PGPOnePassSignatures
Utility class that provides padding addition and removal for PGP session keys.
The PGPPadding contains random data, and can be used to defend against traffic analysis on version 2 SEIPD messages
and Transferable Public Keys.
A password based encryption object.
general class to contain a private key for use with other openPGP
objects.
general class to handle a PGP public key object.
A public key encrypted data object.
Class to hold a single master public key and its subkeys.
Often a PGP key ring file is made up of a succession of master/sub-key key rings.
general class to handle and construct a PGP secret key object.
Class to hold a single master secret key and its subkeys.
Often a PGP key ring file is made up of a succession of master/sub-key key rings.
The basis of PGP encrypted data - encrypted data encrypted using a symmetric session key.
A PGP signature object.
Generator for PGP Signatures.
A list of PGP signatures - normally in the signature block after literal data.
Generator for signature subpackets.
Container for a list of signature subpackets.
Base interface for thread safe signature verified objects.
Builder for thread-safe verifiers for a range of PGP signature types.
Container for a list of user attribute subpackets.
PGP utilities.
Generator for old style PGP V3 Signatures.
Signature Subpacket for encoding a URI pointing to a document containing the policy under which the
signature was created.
Signature Subpacket containing the AEAD cipher suites (AEAD algorithm, Symmetric Key Algorithm pairs)
preferred by the key holder's implementation.
Algorithm combination of a
SymmetricKeyAlgorithmTags and a AEADAlgorithmTags.Signature Subpacket containing algorithm preferences of the key holder's implementation.
Signature Subpacket containing the URI of the users preferred key server.
Signature Subpacket marking a User ID as primary.
Public Key Algorithm IDs.
Factory for public-key based
PGPDataDecryptors.basic packet for a PGP public key
Abstract generator class for encryption methods that produce PKESK (public-key encrypted session key) packets.
Base class for OpenPGP public (primary) keys.
A PGP blob holds key material.
Utility methods related to OpenPGP public key algorithms.
basic packet for a PGP public key
Basic class which just lists the contents of the public key file passed
as an argument.
Signature Subpacket containing a regular expression limiting the scope of the signature.
Signature Subpacket marking a signature as non-revocable.
Deprecated.
since RFC9580
Revocation Key Class values.
Signature Subpacket for encoding the reason why a key was revoked.
Revocation reason tags.
Deprecated.
this class is no longer required and will be removed.
A simple utility class that generates an RSA key ring.
base class for an RSA Public Key.
base class for an RSA Secret (or Private) Key.
Parameter specifier for the PGP string-to-key password based key derivation function.
Parameters for Argon2 S2K.
Parameters for the
S2K.GNU_DUMMY_S2K method.Base class for OpenPGP secret (primary) keys.
basic packet for a PGP secret key
Factory for
PGPDataDecryptor objects that use a PGPSessionKey to decrypt the content of an
OpenPGP message.A parser for secret keys stored in SExpr
Signature Subpacket containing the time at which the signature was created.
Signature Subpacket containing the number of seconds after the signatures creation
time after which the signature expires.
generic signature packet
Parameters for signature generation.
Callback, allowing the user to modify
SignatureParameters before use.Basic type for a PGP Signature sub-packet.
reader for signature sub-packets
Callback to modify the contents of a
PGPSignatureSubpacketGenerator.Basic PGP signature sub-packet tag types.
Signature Subpacket containing the hash value of another signature to which this signature applies to.
A simple utility class that signs and verifies files.
Signature Subpacket containing the User ID of the identity as which the issuer created the signature.
Interface for selecting a subset of keys from a
PGPKeyRing.Basic type for a symmetric key encrypted packet
A symmetric key encrypted packet with an associated integrity check code.
Basic tags for symmetric key algorithms.
Basic type for a symmetric encrypted session key packet
Basic type for a trust packet
Signature Subpacket encoding the level and amount of trust the issuer places into the certified key or identity.
Key class for unknown/unsupported OpenPGP key types.
Basic type for a user attribute packet.
Basic type for a user attribute sub-packet.
reader for user attribute sub-packets
Basic PGP user attribute sub-packet tag types.
Superclass for user identities (
UserIDPacket, UserAttributePacket).Basic type for a user ID packet.
Utility class for parsing and formatting UTC timestamps.
Public key of type
PublicKeyAlgorithmTags.X25519.Secret key of type
PublicKeyAlgorithmTags.X25519.Public key of type
PublicKeyAlgorithmTags.X448.Secret key of type
PublicKeyAlgorithmTags.X448.