Package org.bouncycastle.openpgp.api

The api package contains a high-level OpenPGP API layer on top of the openpgp mid-level API.

See: Description

Interface Summary

Interface	Description
KeyPairGeneratorCallback	Callback to generate a PGPKeyPair from a PGPKeyPairGenerator instance.
KeyPassphraseProvider
MissingMessagePassphraseCallback
OpenPGPKeyMaterialProvider<M extends OpenPGPCertificate>	Interface for providing OpenPGP keys or certificates.
OpenPGPKeyMaterialProvider.OpenPGPCertificateProvider	Interface for requesting OpenPGPCertificates by providing a KeyIdentifier.
OpenPGPKeyMaterialProvider.OpenPGPKeyProvider	Interface for requesting OpenPGPKeys by providing a KeyIdentifier.
OpenPGPMessageGenerator.ArmoredOutputStreamFactory
OpenPGPMessageGenerator.CompressionNegotiator
OpenPGPMessageOutputStream.OutputStreamFactory	Factory class for wrapping output streams.
OpenPGPMessageOutputStream.PaddingPacketFactory	Factory interface for creating PGPPadding objects.
OpenPGPMessageProcessor.PGPExceptionCallback	Callback to handle PGPExceptions.
OpenPGPPolicy	Policy for OpenPGP algorithms and features.
SignatureParameters.Callback	Callback, allowing the user to modify SignatureParameters before use.
SignatureSubpacketsFunction	Callback to modify the contents of a PGPSignatureSubpacketGenerator.
SubkeySelector	Interface for selecting a subset of keys from a PGPKeyRing.

Class Summary

Class	Description
AbstractOpenPGPDocumentSignatureGenerator<T extends AbstractOpenPGPDocumentSignatureGenerator<T>>
AbstractOpenPGPKeySignatureGenerator
DoubleBufferedInputStream<I extends java.io.InputStream>	Implementation of an InputStream that double-buffers data from an underlying input stream.
KeyPairGeneratorCallback.Util
KeyPassphraseProvider.DefaultKeyPassphraseProvider
MessageEncryptionMechanism	Encryption mode (SEIPDv1 / SEIPDv2 / OED) and algorithms.
OpenPGPApi	Main entry to the high level OpenPGP API.
OpenPGPCertificate	OpenPGP certificates (TPKs - transferable public keys) are long-living structures that may change during their lifetime.
OpenPGPCertificate.OpenPGPCertificateComponent	Component on an OpenPGP certificate.
OpenPGPCertificate.OpenPGPComponentKey	A component key is either an OpenPGPCertificate.OpenPGPPrimaryKey, or an OpenPGPCertificate.OpenPGPSubkey.
OpenPGPCertificate.OpenPGPComponentSignature	OpenPGP Signature made over some OpenPGPCertificate.OpenPGPCertificateComponent on a OpenPGPCertificate.
OpenPGPCertificate.OpenPGPIdentityComponent	An identity bound to the OpenPGPCertificate.OpenPGPPrimaryKey of a OpenPGPCertificate.
OpenPGPCertificate.OpenPGPPrimaryKey	The primary key of a OpenPGPCertificate.
OpenPGPCertificate.OpenPGPSignatureChain	Chain of signatures.
OpenPGPCertificate.OpenPGPSignatureChain.Certification	"Positive" signature chain link.
OpenPGPCertificate.OpenPGPSignatureChain.Link	Link in a OpenPGPCertificate.OpenPGPSignatureChain.
OpenPGPCertificate.OpenPGPSignatureChain.Revocation	"Negative" signature chain link.
OpenPGPCertificate.OpenPGPSignatureChains	Collection of multiple OpenPGPCertificate.OpenPGPSignatureChain objects.
OpenPGPCertificate.OpenPGPSubkey	A subkey on a OpenPGPCertificate.
OpenPGPCertificate.OpenPGPUserAttribute	A UserAttribute.
OpenPGPCertificate.OpenPGPUserId	A UserId.
OpenPGPDefaultPolicy
OpenPGPDetachedSignatureGenerator	High-Level OpenPGP Signature Generator for Detached Signatures.
OpenPGPDetachedSignatureProcessor	High-Level Processor for Messages Signed Using Detached OpenPGP Signatures.
OpenPGPEncryptionNegotiator
OpenPGPImplementation	Bouncy Castle provides two implementations of OpenPGP operators.
OpenPGPKey	An OpenPGPKey (TSK - transferable secret key) is the pendant to an OpenPGPCertificate, but containing the secret key material in addition to the public components.
OpenPGPKey.OpenPGPPrivateKey	Unlocked OpenPGPKey.OpenPGPSecretKey.
OpenPGPKey.OpenPGPSecretKey	Secret key component of a OpenPGPCertificate.OpenPGPPrimaryKey or OpenPGPCertificate.OpenPGPSubkey.
OpenPGPKeyEditor
OpenPGPKeyGenerator	High-level generator class for OpenPGP v6 keys.
OpenPGPKeyMaterialPool<M extends OpenPGPCertificate>	Implementation of the OpenPGPKeyMaterialProvider which caches items in a HashMap.
OpenPGPKeyMaterialPool.OpenPGPCertificatePool	Implementation of OpenPGPKeyMaterialPool tailored to providing OpenPGPCertificates.
OpenPGPKeyMaterialPool.OpenPGPKeyPool	Implementation of OpenPGPKeyMaterialPool tailored to provide OpenPGPKeys.
OpenPGPKeyReader	Reader for OpenPGPKeys or OpenPGPCertificates.
OpenPGPMessageGenerator	Generator for OpenPGP messages.
OpenPGPMessageInputStream	An InputStream that processes an OpenPGP message.
OpenPGPMessageInputStream.Result
OpenPGPMessageOutputStream	Implementation of an OutputStream tailored to creating OpenPGP messages.
OpenPGPMessageProcessor
OpenPGPMessageProcessor.Configuration
OpenPGPPolicy.OpenPGPNotationRegistry	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.
OpenPGPSignature	An OpenPGP signature.
OpenPGPSignature.OpenPGPDocumentSignature	An OpenPGPSignature made over a binary or textual document (e.g. a message).
OpenPGPSignature.OpenPGPSignatureSubpacket	SignatureSubpacket and the OpenPGPSignature that contains it.
SignatureParameters	Parameters for signature generation.
SignatureParameters.Callback.Util

Enum Summary

Enum	Description
EncryptedDataPacketType	Encryption Mode.

Package org.bouncycastle.openpgp.api Description

The

api

package contains a high-level OpenPGP API layer on top of the

openpgp

mid-level API. It is tailored to provide a modern OpenPGP experience, following the guidance from rfc9580 ("OpenPGP v6"), while also being interoperable with rfc4880 ("OpenPGP v4").

From an architectural point of view, the hierarchy of the individual layers is as follows:

• api

  specifies a high-level API using mid-level implementations from

  openpgp

  . This layer strives to be easy to use, hard to misuse and secure by default.

• openpgp

  defines a powerful, flexible, but quite verbose API using packet definitions from

  bcpg

  .

• bcpg

  implements serialization / deserialization of OpenPGP packets. It does not contain any business logic.