All Classes and Interfaces

Class
Description
 
List of AEAD algorithms defined in crypto-refresh-06.
The AlgorithmSuite class is consulted when new OpenPGP keys are being generated to set preferred algorithms on the key.
Factory class for instantiating preconfigured ArmoredInputStreams.
Factory to create configured ArmoredOutputStreams.
Utility class for dealing with ASCII armored OpenPGP data.
Basic SecretKeyRingProtector implementation that respects the users KeyRingProtectionSettings when encrypting keys.
 
 
 
 
Implementation of ProviderFactory using a BouncyCastleProvider.
Implementation of the PublicKeyDataDecryptorFactory which caches decrypted session keys.
Implementation of the SecretKeyRingProtector which holds a map of key ids and their passwords.
 
 
A chain link contains a node in the trust chain.
Interface for a CA that can authenticate trust-worthy certificates.
A collection of static methods that validate signing certificates (public keys) and verify signature correctness.
 
 
Subset of SignatureType, reduced to certification types.
API for creating certifications and delegations (Signatures) on keys.
 
 
 
 
 
Utility class to deal with cleartext-signed messages.
 
Enumeration of possible compression algorithms.
Options for decryption and signature verification.
Source for OpenPGP certificates.
Utility class that causes read(bytes, offset, length) to properly throw exceptions caused by faulty CRC checksums.
OutputStream which applies CR-LF encoding of its input data, based on the desired StreamEncoding.
Custom PublicKeyDataDecryptorFactory which can enable customized implementations of message decryption using public keys.
 
Builder class that takes an InputStream of ciphertext (or plaintext signed data) and combines it with a configured ConsumerOptions object to form a DecryptionStream which can be used to decrypt an OpenPGP message or verify signatures.
 
 
Abstract definition of an InputStream which can be used to decrypt / verify OpenPGP messages.
 
Subset of SignatureType, used for signatures over documents.
 
 
Edwards-curve Digital Signature Algorithm (EdDSA).
 
Deprecated.
the use of ElGamal is not recommended anymore.
Deprecated.
the use of ElGamal keys is no longer recommended.
Elliptic curves for use with ECDH/ECDSA.
 
 
 
Options for the encryption process.
 
 
 
 
OutputStream that produces an OpenPGP message.
Implementations of KeyRingSelectionStrategy which select key rings based on the exact user-id.
PublicKeyRingSelectionStrategy which accepts PGPPublicKeyRings if those have a user-id which exactly matches the given
SecretKeyRingSelectionStrategy which accepts PGPSecretKeyRings if those have a user-id which exactly matches the given
An enumeration of features that may be set in the Features subpacket.
 
This class can be used to remove private keys from secret software-keys by replacing them with stub secret keys in the style of GnuPGs proprietary extensions.
 
Filter for selecting keys.
Enable integration of hardware-backed OpenPGP keys.
 
Implementation of PublicKeyDataDecryptorFactory which delegates decryption of encrypted session keys to a HardwareSecurity.DecryptionCallback.
 
An enumeration of different hashing algorithms.
Interface for a class that negotiates HashAlgorithms.
 
Implementation of the MultiPassStrategy.
 
 
 
 
 
Address the key via key-id.
Address the key via a user-id (e.g.
 
 
 
 
 
 
 
 
 
Enumeration of different key flags.
 
 
This exception gets thrown, when the integrity of an OpenPGP key is broken.
 
 
 
Utility class to quickly extract certain information from a PGPPublicKeyRing/PGPSecretKeyRing.
 
Secret key protection settings for iterated and salted S2K.
 
Filter for selecting public / secret key rings based on identifiers (e.g.
 
 
 
 
 
 
Exception that gets thrown if the OpenPGP message is malformed.
Implementation of the SecretKeyPassphraseProvider that holds a map of different passphrases.
Inspect an OpenPGP message to determine IDs of its encryption keys or whether it is passphrase protected.
 
View for extracting metadata about a MessageMetadata.Message.
 
 
 
 
 
 
 
 
 
Exception that is thrown when decryption fails due to a missing decryption key or decryption passphrase.
Strategy defining how missing secret key passphrases are handled.
 
 
Exception that gets thrown when the verification of a modification detection code failed.
 
Since for verification of cleartext signed messages, we need to read the whole data twice in order to verify signatures, a strategy for how to cache the read data is required.
Registry for known notations.
Tuple-class that bundles together a PGPOnePassSignature object, a PGPPublicKeyRing destined to verify the signature, the PGPSignature itself and a record of whether the signature was verified.
Abstract super class of different version OpenPGP fingerprints.
InputStream used to determine the nature of potential OpenPGP data.
 
 
This class describes the syntax for OpenPGP messages as specified by rfc4880.
Legacy class containing metadata about an OpenPGP message.
 
 
This class represents a hex encoded, uppercase OpenPGP v4 fingerprint.
This class represents a hex encoded, upper case OpenPGP v5 fingerprint.
This class represents a hex encoded, upper case OpenPGP v6 fingerprint.
 
Provides PBESecretKeyDecryptor and PBESecretKeyEncryptor objects while getting the passphrases from a SecretKeyPassphraseProvider and using settings from an KeyRingProtectionSettings.
Pushdown Automaton for validating context-free languages.
 
This class describes a logic of handling a collection of different PGPKeyRing.
Policy class used to configure acceptable algorithm suites etc.
 
 
 
 
 
 
 
Allow the use of different Provider implementations to provide cryptographic primitives by setting a ProviderFactory singleton.
Enumeration of public key algorithms as defined in RFC4880.
Utility class to verify keys against Key Overwriting (KO) attacks.
Abstract KeyRingSelectionStrategy for PGPPublicKeyRings.
 
Reason for revocation.
 
 
 
 
 
 
 
 
Key type that specifies the RSA_GENERAL algorithm.
 
Repair class to fix keys which use S2K usage of value SecretKeyPacket.USAGE_CHECKSUM.
Interface to allow the user to provide a Passphrase for an encrypted OpenPGP secret key.
 
 
 
 
Task of the SecretKeyRingProtector is to map encryptor/decryptor objects to key-ids.
Abstract KeyRingSelectionStrategy for PGPSecretKeyRings.
Filter for selecting user-ids from keys and from lists.
 
 
 
A SessionKey is the symmetric key that is used to encrypt/decrypt an OpenPGP message.
Tuple-class which bundles together a signature, the signing key that created the signature, an identifier of the signing key and a record of whether the signature was verified.
Comparator which can be used to sort signatures with regard to their creation time.
 
Pick signatures from keys.
Enumeration of possible subpackets that might be found in the hashed and unhashed area of an OpenPGP signature.
 
 
 
 
Utility class to access signature subpackets from signatures.
Enum that enlists all the Signature Types defined in rfc4880 section 5.2.1 See PGPSignature for comparison.
Utility methods related to signatures.
 
A collection of validators that perform validation steps over signatures.
Comparator which sorts signatures based on an ordering and on revocation hardness.
Tuple of a signature and an identifier of its corresponding verification key.
Tuple object of a SignatureVerification and the corresponding SignatureValidationException that caused the verification to fail.
Collection of static methods for signature verification.
 
A method of signing.
Implementation of the SecretKeyPassphraseProvider that holds a single Passphrase.
 
Set of states of the automaton.
Enumeration of possible encoding formats of the content of the literal data packet.
 
Tuple class used to identify a subkey by fingerprints of the primary key of the subkeys key ring, as well as the subkeys fingerprint.
Enumeration of possible symmetric encryption algorithms.
Interface for symmetric key algorithm negotiation.
This interface can be used to define a custom syntax for the PDA.
Since we need to update signatures with data from the underlying stream, this class is used to tee out the data.
 
Certification signature builder used to certify other users keys.
 
Result of applying a transition rule.
Facade class for TrustSignature.
 
 
Exception that gets thrown if unacceptable algorithms are encountered.
Signature builder without restrictions on subpacket contents.
 
Implementation of the SecretKeyRingProtector which assumes that all handled keys are not password protected.
 
 
 
 
Implementations of KeyRingSelectionStrategy which accept PGP KeyRings based on a whitelist of acceptable keyIds.
KeyRingSelectionStrategy which accepts PGPPublicKeyRings if the
KeyRingSelectionStrategy which accepts PGPSecretKeyRings if the
Implementations of KeyRingSelectionStrategy which accept all keyRings.
 
 
Implementation of the MultiPassStrategy.
 
 
 
 
Implementations of KeyRingSelectionStrategy which accept KeyRings containing a given XMPP address of the format "xmpp:alice@pgpainless.org".
PublicKeyRingSelectionStrategy which accepts a given PGPPublicKeyRing if its primary key has a user-id that matches the given
SecretKeyRingSelectionStrategy which accepts a given PGPSecretKeyRing if its primary key has a user-id that matches the given
This class represents a hex encoded, upper case OpenPGP v5 or v6 fingerprint.