# All Classes

- All Classes Interface Summary Class Summary Enum Summary Exception Summary
  Class | Description
  --- | ---
  AllTests |
  AllTests |
  AllTests |
  ArmoredInputStream | reader for Base64 armored objects - read the headers and then start returning bytes when the data is reached.
  ArmoredInputStreamTest |
  ArmoredOutputStream | Output stream that writes data in ASCII Armored format.
  BcBlobVerifier |
  BcKeyBox |
  BcKeyFingerprintCalculator |
  BcPBEDataDecryptorFactory | A `PBEDataDecryptorFactory` for handling PBE decryption operations using the Bouncy Castle lightweight API to implement cryptographic primitives.
  BcPBEKeyEncryptionMethodGenerator | A BC lightweight method generator for supporting PBE based encryption operations.
  BcPBESecretKeyDecryptorBuilder |
  BcPBESecretKeyEncryptorBuilder |
  BCPGInputStream | Stream reader for PGP objects
  BCPGKey | base interface for a PGP key
  BCPGObject | Base class for a PGP object.
  BCPGOutputStream | Basic output stream.
  BcPGPContentSignerBuilder |
  BcPGPContentVerifierBuilderProvider |
  BcPGPDataEncryptorBuilder | `PGPDataEncryptorBuilder` implementation that uses the Bouncy Castle lightweight API to implement cryptographic primitives.
  BcPGPDigestCalculatorProvider |
  BcPGPDSAElGamalTest |
  BcPGPDSATest |
  BcPGPKeyConverter |
  BcPGPKeyPair |
  BcPGPKeyRingTest |
  BcPGPObjectFactory | `PGPObjectFactory` that uses the Bouncy Castle lightweight API to implement cryptographic primitives.
  BcPGPPBETest |
  BcPGPPublicKeyRing |
  BcPGPPublicKeyRingCollection |
  BcPGPRSATest |
  BcPGPSecretKeyRing |
  BcPGPSecretKeyRingCollection |
  BcPublicKeyDataDecryptorFactory | A decryptor factory for handling public key decryption operations.
  BcPublicKeyKeyEncryptionMethodGenerator | A method generator for supporting public key based encryption operations.
  Blob | GnuPG keybox blob.
  BlobType |
  BlobVerifier | Base interface for a blob integrity checking operator.
  ByteArrayHandler | Simple routine to encrypt and decrypt using a passphrase.
  CertificateBlob | A PGP blob holds key material.
  ClearSignedFileProcessor | A simple utility class that creates clear signed files and verifies them.
  CompressedDataPacket | A generic compressed data object.
  CompressionAlgorithmTags | Basic tags for compression algorithms
  ContainedPacket | Basic type for a PGP packet.
  CRC24 |
  DetachedSignatureProcessor | A simple utility class that creates seperate signatures for files and verifies them.
  DirectKeySignature | A simple utility class that directly signs a public key and writes the signed key to "SignedKey.asc" in the current working directory.
  DSA2Test | GPG compatability test vectors
  DSAElGamalKeyRingGenerator | A simple utility class that generates a public/secret keyring containing a DSA signing key and an El Gamal key for encryption.
  DSAPublicBCPGKey | base class for a DSA Public Key.
  DSASecretBCPGKey | base class for a DSA Secret Key.
  ECDHPublicBCPGKey | base class for an ECDH Public Key.
  ECDSAPublicBCPGKey | base class for an ECDSA Public Key.
  ECPublicBCPGKey | base class for an EC Public Key.
  ECSecretBCPGKey | base class for an EC Secret Key.
  EdDSAPublicBCPGKey | base class for an EdDSA Public Key.
  EdSecretBCPGKey | base class for an Edwards Curve Secret Key.
  ElGamalPublicBCPGKey | base class for an ElGamal Public Key.
  ElGamalSecretBCPGKey | base class for an ElGamal Secret Key.
  EmbeddedSignature | Packet embedded signature
  ExperimentalPacket | basic packet for an experimental packet.
  Exportable | packet giving signature creation time.
  Features |
  FirstBlob | First blob contains meta data about the KeyBox.
  HashAlgorithmTags | basic tags for hash algorithms
  ImageAttribute | Basic type for a image attribute packet.
  InputStreamPacket | A block of data associated with other packets in a PGP object stream.
  IntendedRecipientFingerprint | packet giving the intended recipient fingerprint.
  IssuerFingerprint | packet giving the issuer key fingerprint.
  IssuerKeyID | packet giving the issuer key ID.
  JcaBlobVerifier |
  JcaBlobVerifierBuilder |
  JcaKeyBox |
  JcaKeyBoxBuilder |
  JcaKeyFingerprintCalculator |
  JcaPGPContentSignerBuilder |
  JcaPGPContentVerifierBuilderProvider |
  JcaPGPDigestCalculatorProviderBuilder | A builder for `PGPDigestCalculatorProvider` instances that obtain cryptographic primitives using the JCA API.
  JcaPGPKeyConverter |
  JcaPGPKeyPair | A PGP key pair class that is constructed from JCA/JCE key pairs.
  JcaPGPObjectFactory | `PGPObjectFactory` that uses the sources cryptographic primitives from the JCA API.
  JcaPGPPrivateKey | A JCA PrivateKey carrier.
  JcaPGPPublicKeyRing |
  JcaPGPPublicKeyRingCollection |
  JcaPGPSecretKeyRing |
  JcaPGPSecretKeyRingCollection |
  JcePBEDataDecryptorFactoryBuilder | Builder for `PBEDataDecryptorFactory` instances that obtain cryptographic primitives using the JCE API.
  JcePBEKeyEncryptionMethodGenerator | JCE based generator for password based encryption (PBE) data protection methods.
  JcePBEProtectionRemoverFactory |
  JcePBESecretKeyDecryptorBuilder |
  JcePBESecretKeyEncryptorBuilder |
  JcePGPDataEncryptorBuilder | `PGPDataEncryptorBuilder` implementation that sources cryptographic primitives using the JCE APIs.
  JcePublicKeyDataDecryptorFactoryBuilder |
  JcePublicKeyKeyEncryptionMethodGenerator |
  KeyBasedFileProcessor | A simple utility class that encrypts/decrypts public key based encryption files.
  KeyBasedLargeFileProcessor | A simple utility class that encrypts/decrypts public key based encryption large files.
  KeyBlob | A PGP blob holds key material.
  KeyBox | KeyBox provides an implementation of the PGP keybox.
  KeyBoxTest |
  KeyExpirationTime | packet giving time after creation at which the key expires.
  KeyFingerPrintCalculator |
  KeyFlags | Packet holding the key flag values.
  KeyInformation |
  LiteralDataPacket | Generic literal data packet.
  MarkerPacket | Basic type for a marker packet
  ModDetectionCodePacket | basic packet for a modification detection code packet.
  MPInteger | a multiple precision integer
  NotationData | Class provided a NotationData object according to RFC2440, Chapter 5.2.3.15.
  OnePassSignaturePacket | generic signature object
  OutputStreamPacket |
  Packet |
  PacketTags | Basic PGP packet tag types.
  PBEDataDecryptorFactory | A factory for performing PBE decryption operations.
  PBEFileProcessor | A simple utility class that encrypts/decrypts password based encryption files.
  PBEKeyEncryptionMethodGenerator | PGP style PBE encryption method.
  PBEProtectionRemoverFactory |
  PBESecretKeyDecryptor |
  PBESecretKeyEncryptor |
  PGPAlgorithmParameters |
  PGPArmoredTest |
  PGPClearSignedSignatureTest |
  PGPCompressedData | A PGP compressed data object.
  PGPCompressedDataGenerator | Generator for producing compressed data packets.
  PGPCompressionTest |
  PGPContentSigner |
  PGPContentSignerBuilder |
  PGPContentVerifier |
  PGPContentVerifierBuilder |
  PGPContentVerifierBuilderProvider |
  PGPDataDecryptor | A decryptor that wraps a stream of PGP encrypted data to decrypt, and optionally integrity check, the data.
  PGPDataDecryptorFactory | Base interface of factories for `PGPDataDecryptor`.
  PGPDataDecryptorProvider |
  PGPDataEncryptor | A data encryptor, combining a cipher instance and an optional integrity check calculator.
  PGPDataEncryptorBuilder | A builder for `PGPDataEncryptor` instances, which can be used to encrypt data objects.
  PGPDataValidationException | Thrown if the iv at the start of a data stream indicates the wrong key is being used.
  PGPDigestCalculator | A digest calculator, which consumes a stream of data and computes a digest value over it.
  PGPDigestCalculatorProvider | A factory for digest algorithms.
  PGPDSAElGamalTest |
  PGPDSATest |
  PGPECDHTest |
  PGPECDSATest |
  PGPECMessageTest |
  PGPEdDSATest |
  PGPEncryptedData | A PGP encrypted data object.
  PGPEncryptedDataGenerator | Generator for encrypted objects.
  PGPEncryptedDataList | A holder for a list of PGP encryption method packets and the encrypted data associated with them.
  PGPException | generic exception class for PGP encoding/decoding problems
  PGPKdfParameters |
  PGPKeyEncryptionMethodGenerator | An encryption method that can be applied to encrypt data in a `PGPEncryptedDataGenerator`.
  PGPKeyFlags | key flag values for the KeyFlags subpacket.
  PGPKeyPair | General class to handle JCA key pairs and convert them into OpenPGP ones.
  PGPKeyRing | Parent class for PGP public and secret key rings.
  PGPKeyRingGenerator | Generator for a PGP master and subkey ring.
  PGPKeyRingTest |
  PGPKeyValidationException | Thrown if the key checksum is invalid.
  PGPLiteralData | A single literal data packet in a PGP object stream.
  PGPLiteralDataGenerator | Generator for producing literal data packets.
  PGPMarker | a PGP marker packet - in general these should be ignored other than where the idea is to preserve the original input stream.
  PGPMarkerTest |
  PGPNoPrivateKeyTest |
  PGPObjectFactory | General class for reading a PGP object stream.
  PGPOnePassSignature | A one pass signature object.
  PGPOnePassSignatureList | Holder for a list of PGPOnePassSignatures
  PGPPacketTest |
  PGPPad | Utility class that provides padding addition and removal for PGP session keys.
  PGPParsingTest |
  PGPPBEEncryptedData | A password based encryption object.
  PGPPBETest |
  PGPPrivateKey | general class to contain a private key for use with other openPGP objects.
  PGPPublicKey | general class to handle a PGP public key object.
  PGPPublicKeyEncryptedData | A public key encrypted data object.
  PGPPublicKeyRing | Class to hold a single master public key and its subkeys.
  PGPPublicKeyRingCollection | Often a PGP key ring file is made up of a succession of master/sub-key key rings.
  PGPRSATest |
  PGPRuntimeOperationException |
  PGPSecretKey | general class to handle and construct a PGP secret key object.
  PGPSecretKeyRing | Class to hold a single master secret key and its subkeys.
  PGPSecretKeyRingCollection | Often a PGP key ring file is made up of a succession of master/sub-key key rings.
  PGPSignature | A PGP signature object.
  PGPSignatureGenerator | Generator for PGP Signatures.
  PGPSignatureList | A list of PGP signatures - normally in the signature block after literal data.
  PGPSignatureSubpacketGenerator | Generator for signature subpackets.
  PGPSignatureSubpacketVector | Container for a list of signature subpackets.
  PGPSignatureTest |
  PGPUnicodeTest |
  PGPUserAttributeSubpacketVector | Container for a list of user attribute subpackets.
  PGPUserAttributeSubpacketVectorGenerator |
  PGPUtil | PGP utilities.
  PGPUtilTest |
  PGPV3SignatureGenerator | Generator for old style PGP V3 Signatures.
  PreferredAlgorithms | packet giving signature creation time.
  PrimaryUserID | packet giving whether or not the signature is signed using the primary user ID for the key.
  PublicKeyAlgorithmTags | Public Key Algorithm tag numbers
  PublicKeyDataDecryptorFactory |
  PublicKeyEncSessionPacket | basic packet for a PGP public key
  PublicKeyKeyEncryptionMethodGenerator |
  PublicKeyPacket | basic packet for a PGP public key
  PublicKeyRingBlob | A PGP blob holds key material.
  PublicSubkeyPacket | basic packet for a PGP public key
  PubringDump | Basic class which just lists the contents of the public key file passed as an argument.
  RegressionTest |
  RegressionTest |
  Revocable | packet giving whether or not is revocable.
  RevocationKey | Represents revocation key OpenPGP signature sub packet.
  RevocationKeyTags |
  RevocationReason | Represents revocation reason OpenPGP signature sub packet.
  RevocationReasonTags |
  RFC6637KDFCalculator | Deprecated. this class is no longer required and will be removed.
  RFC6637Utils |
  RSAKeyPairGenerator | A simple utility class that generates a RSA PGPPublicKey/PGPSecretKey pair.
  RSAPublicBCPGKey | base class for an RSA Public Key.
  RSASecretBCPGKey | base class for an RSA Secret (or Private) Key.
  S2K | Parameter specifier for the PGP string-to-key password based key derivation function.
  SecretKeyPacket | basic packet for a PGP secret key
  SecretSubkeyPacket | basic packet for a PGP secret key
  SExprParser | A parser for secret keys stored in SExpr
  SExprTest |
  SignatureCreationTime | packet giving signature creation time.
  SignatureExpirationTime | packet giving signature expiration time.
  SignaturePacket | generic signature packet
  SignatureSubpacket | Basic type for a PGP Signature sub-packet.
  SignatureSubpacketInputStream | reader for signature sub-packets
  SignatureSubpacketTags | Basic PGP signature sub-packet tag types.
  SignatureTarget | RFC 4880, Section 5.2.3.25 - Signature Target subpacket.
  SignedFileProcessor | A simple utility class that signs and verifies files.
  SignerUserID | packet giving the User ID of the signer.
  SymmetricEncDataPacket | Basic type for a symmetric key encrypted packet
  SymmetricEncIntegrityPacket | A symmetric key encrypted packet with an associated integrity check code.
  SymmetricKeyAlgorithmTags | Basic tags for symmetric key algorithms
  SymmetricKeyEncSessionPacket | Basic type for a symmetric encrypted session key packet
  TrustPacket | Basic type for a trust packet
  TrustSignature | packet giving trust.
  UserAttributePacket | Basic type for a user attribute packet.
  UserAttributeSubpacket | Basic type for a user attribute sub-packet.
  UserAttributeSubpacketInputStream | reader for user attribute sub-packets
  UserAttributeSubpacketTags | Basic PGP user attribute sub-packet tag types.
  UserID |
  UserIDPacket | Basic type for a user ID packet.