Top Description Interfaces Classes
module bcpg

Package org.bouncycastle.openpgp


High level classes for dealing with OpenPGP objects.

Note

These are based on the org.bouncycastle.bcpg classes and use a streaming model, so for some objects which have an input stream associated it is necessary to read to the end of the input stream on the object before trying to read another object from the orginal input stream.

A word on key ring files. For the purpose of this package a PGP key ring is a master key and a collection of sub-keys associated with it. These public and secret key rings are handled by the PGPPublicKey ring class and the PGPSecretKeyRing class respectively. In the case where you are trying to read an key file which has multiple key rings in it, use PGPSecretKeyRingCollection for the secret key file and PGPPublicKeyRingCollection for the public key file.

Interface Summary

Modifier and TypeInterface and Description
public interface
public interface
PGPKeyFlags

key flag values for the KeyFlags subpacket.

public interface
PGPSignatureVerifier

Base interface for thread safe signature verified objects.

pack-priv interface
StreamGenerator

Callback interface for generators that produce a stream to be informed when the stream has been closed by the client.

Class Summary

Modifier and TypeClass and Description
pack-priv class
public class
pack-priv class
public class
OpenedPGPKeyData

Wraps PGP key headers and pgp key SExpression

public class
PGPCanonicalizedDataGenerator

Generator for producing filtered literal data packets which are automatically canonicalized.

public class
PGPCompressedData

A PGP compressed data object.

public class
PGPCompressedDataGenerator

Generator for producing compressed data packets.

public class
PGPDataValidationException

Thrown if the iv at the start of a data stream indicates the wrong key is being used.

pack-priv abstract class
public abstract class
PGPEncryptedData

A PGP encrypted data object.

public class
PGPEncryptedDataGenerator

Generator for encrypted objects.

public class
PGPEncryptedDataList

A holder for a list of PGP encryption method packets and the encrypted data associated with them.

public class
PGPException

generic exception class for PGP encoding/decoding problems

public class
public class
public class
public class
PGPKeyPair

General class to handle JCA key pairs and convert them into OpenPGP ones.

public abstract class
PGPKeyRing

Parent class for PGP public and secret key rings.

public class
PGPKeyRingGenerator

Generator for a PGP primary and subkey ring.

public class
PGPKeyValidationException

Thrown if the key checksum is invalid.

public class
PGPLiteralData

A single literal data packet in a PGP object stream.

public class
PGPLiteralDataGenerator

Generator for producing literal data packets.

public class
PGPMarker

a PGP marker packet - in general these should be ignored other than where the idea is to preserve the original input stream.

public class
PGPObjectFactory

General class for reading a PGP object stream.

public class
PGPOnePassSignature

A one pass signature object.

public class
PGPOnePassSignatureList

Holder for a list of PGPOnePassSignatures

public class
PGPPadding

The PGPPadding contains random data, and can be used to defend against traffic analysis on version 2 SEIPD messages and Transferable Public Keys.

public class
PGPPBEEncryptedData

A password based encryption object.

public class
PGPPrivateKey

general class to contain a private key for use with other openPGP objects.

public class
PGPPublicKey

general class to handle a PGP public key object.

public class
PGPPublicKeyEncryptedData

A public key encrypted data object.

public class
PGPPublicKeyRing

Class to hold a single master public key and its subkeys.

public class
PGPPublicKeyRingCollection

Often a PGP key ring file is made up of a succession of master/sub-key key rings.

public class
public class
PGPSecretKey

general class to handle and construct a PGP secret key object.

public class
PGPSecretKeyRing

Class to hold a single master secret key and its subkeys.

public class
PGPSecretKeyRingCollection

Often a PGP key ring file is made up of a succession of master/sub-key key rings.

public class
public class
PGPSessionKeyEncryptedData

The basis of PGP encrypted data - encrypted data encrypted using a symmetric session key.

public class
PGPSignature

A PGP signature object.

public class
PGPSignatureGenerator

Generator for PGP Signatures.

public class
PGPSignatureList

A list of PGP signatures - normally in the signature block after literal data.

public class
PGPSignatureSubpacketGenerator

Generator for signature subpackets.

public class
PGPSignatureSubpacketVector

Container for a list of signature subpackets.

public class
PGPSignatureVerifierBuilder

Builder for thread-safe verifiers for a range of PGP signature types.

public class
public class
PGPUserAttributeSubpacketVector

Container for a list of user attribute subpackets.

public class
public class
PGPUtil

PGP utilities.

public class
PGPV3SignatureGenerator

Generator for old style PGP V3 Signatures.

pack-priv class
pack-priv class