Package org.bouncycastle.openpgp.api

Class OpenPGPApi

java.lang.Object

org.bouncycastle.openpgp.api.OpenPGPApi

Direct Known Subclasses:

BcOpenPGPApi, JcaOpenPGPApi

public abstract class OpenPGPApi
extends Object

Main entry to the high level OpenPGP API.

Constructor Summary

Constructors

Constructor	Description
OpenPGPApi(OpenPGPImplementation implementation)	Instantiate an OpenPGPApi based on the given OpenPGPImplementation.
OpenPGPApi(OpenPGPImplementation implementation, OpenPGPPolicy policy)	Instantiate an OpenPGPApi object, passing in an OpenPGPImplementation and custom OpenPGPPolicy.

Method Summary

Modifier and Type	Method	Description
OpenPGPDetachedSignatureGenerator	createDetachedSignature()	Create one or more detached signatures over some data.
OpenPGPMessageProcessor	decryptAndOrVerifyMessage()	Decrypt and/or verify an OpenPGP message.
OpenPGPKeyEditor	editKey(OpenPGPKey key)
OpenPGPKeyEditor	editKey(OpenPGPKey key, char[] primaryKeyPassphrase)
OpenPGPKeyEditor	editKey(OpenPGPKey key, KeyPassphraseProvider primaryKeyPassphraseProvider)	Modify an OpenPGPKey.
OpenPGPKeyGenerator	generateKey()	Return an OpenPGPKeyGenerator which can be used to generate OpenPGPKeys.
abstract OpenPGPKeyGenerator	generateKey(int version)	Return an OpenPGPKeyGenerator which can be used to generate OpenPGPKeys of the given key version.
abstract OpenPGPKeyGenerator	generateKey(int version, Date creationTime)	Return an OpenPGPKeyGenerator which can be used to generate OpenPGPKeys of the given key version.
abstract OpenPGPKeyGenerator	generateKey(int version, Date creationTime, boolean aeadProtection)	Return an OpenPGPKeyGenerator which can be used to generate OpenPGPKeys of the given key version.
OpenPGPKeyGenerator	generateKey(Date creationTime)	Return an OpenPGPKeyGenerator which can be used to generate OpenPGPKeys.
OpenPGPKeyGenerator	generateKey(Date creationTime, boolean aeadProtection)	Return an OpenPGPKeyGenerator which can be used to generate OpenPGPKeys.
OpenPGPImplementation	getImplementation()	Return the underlying OpenPGPImplementation of this API handle.
OpenPGPKeyReader	readKeyOrCertificate()	Return an OpenPGPKeyReader which can be used to parse binary or ASCII armored OpenPGPKeys or OpenPGPCertificates.
OpenPGPMessageGenerator	signAndOrEncryptMessage()	Create an inline-signed and/or encrypted OpenPGP message.
OpenPGPDetachedSignatureProcessor	verifyDetachedSignature()	Verify detached signatures over some data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OpenPGPApi

public OpenPGPApi(OpenPGPImplementation implementation)

Instantiate an OpenPGPApi based on the given OpenPGPImplementation.

Parameters:

implementation - OpenPGP implementation

OpenPGPApi

public OpenPGPApi(OpenPGPImplementation implementation,
 OpenPGPPolicy policy)

Instantiate an OpenPGPApi object, passing in an OpenPGPImplementation and custom OpenPGPPolicy.

Parameters:

implementation - OpenPGP implementation

policy - algorithm policy

Method Details

readKeyOrCertificate

public OpenPGPKeyReader readKeyOrCertificate()

Return an OpenPGPKeyReader which can be used to parse binary or ASCII armored OpenPGPKeys or OpenPGPCertificates.

Returns:

key reader

generateKey

public OpenPGPKeyGenerator generateKey()
                                throws PGPException

Return an OpenPGPKeyGenerator which can be used to generate OpenPGPKeys. This method returns a generator for OpenPGP v6 keys as defined by rfc9580.

Returns:

key generator

Throws:

PGPException - if the key generator cannot be set up

generateKey

public abstract OpenPGPKeyGenerator generateKey(int version)
                                         throws PGPException

Return an OpenPGPKeyGenerator which can be used to generate OpenPGPKeys of the given key version. Valid version numbers are:

• PublicKeyPacket.VERSION_4 (rfc4880)
• PublicKeyPacket.VERSION_6 (rfc9580)
• PublicKeyPacket.LIBREPGP_5 (LibrePGP; experimental)

Parameters:

version - key version number

Returns:

key generator

Throws:

PGPException - if the key generator cannot be set up

generateKey

public OpenPGPKeyGenerator generateKey(Date creationTime)
                                throws PGPException

Return an OpenPGPKeyGenerator which can be used to generate OpenPGPKeys. The key and signatures will have a creation time of the passed creationTime. This method returns a generator for OpenPGP v6 keys as defined by rfc9580.

Parameters:

creationTime - key + signature creation time

Returns:

key generator

Throws:

PGPException - if the key generator cannot be set up

generateKey

public abstract OpenPGPKeyGenerator generateKey(int version,
 Date creationTime)
                                         throws PGPException

Return an OpenPGPKeyGenerator which can be used to generate OpenPGPKeys of the given key version. The key and signatures will have a creation time of the passed creationTime. Valid version numbers are:

• PublicKeyPacket.VERSION_4 (rfc4880)
• PublicKeyPacket.VERSION_6 (rfc9580)
• PublicKeyPacket.LIBREPGP_5 (LibrePGP; experimental)

Parameters:

version - key version number

creationTime - key + signatures creation time

Returns:

key generator

Throws:

PGPException - if the key generator cannot be set up

generateKey

public OpenPGPKeyGenerator generateKey(Date creationTime,
 boolean aeadProtection)
                                throws PGPException

Return an OpenPGPKeyGenerator which can be used to generate OpenPGPKeys. The key and signatures will have a creation time of the passed creationTime. If aeadProtection is true, the key will use AEAD+Argon2 to protect the secret key material, otherwise it will use salted+iterated CFB mode. This method returns a generator for OpenPGP v6 keys as defined by rfc9580.

Parameters:

creationTime - key + signature creation time

aeadProtection - whether to use AEAD or CFB protection

Returns:

key generator

Throws:

PGPException - if the key generator cannot be set up

generateKey

public abstract OpenPGPKeyGenerator generateKey(int version,
 Date creationTime,
 boolean aeadProtection)
                                         throws PGPException

Return an OpenPGPKeyGenerator which can be used to generate OpenPGPKeys of the given key version. The key and signatures will have a creation time of the passed creationTime. If aeadProtection is true, the key will use AEAD+Argon2 to protect the secret key material, otherwise it will use salted+iterated CFB mode. Valid version numbers are:

• PublicKeyPacket.VERSION_4 (rfc4880)
• PublicKeyPacket.VERSION_6 (rfc9580)
• PublicKeyPacket.LIBREPGP_5 (LibrePGP; experimental)

Parameters:

creationTime - key + signature creation time

aeadProtection - whether to use AEAD or CFB protection

Returns:

key generator

Throws:

PGPException - if the key generator cannot be set up

signAndOrEncryptMessage

public OpenPGPMessageGenerator signAndOrEncryptMessage()

Create an inline-signed and/or encrypted OpenPGP message.

Returns:

message generator

createDetachedSignature

public OpenPGPDetachedSignatureGenerator createDetachedSignature()

Create one or more detached signatures over some data.

Returns:

signature generator

decryptAndOrVerifyMessage

public OpenPGPMessageProcessor decryptAndOrVerifyMessage()

Decrypt and/or verify an OpenPGP message.

Returns:

message processor

verifyDetachedSignature

public OpenPGPDetachedSignatureProcessor verifyDetachedSignature()

Verify detached signatures over some data.

Returns:

signature processor

editKey

public OpenPGPKeyEditor editKey(OpenPGPKey key)
                         throws PGPException

Throws:

PGPException

editKey

public OpenPGPKeyEditor editKey(OpenPGPKey key,
 char[] primaryKeyPassphrase)
                         throws PGPException

Throws:

PGPException

editKey

public OpenPGPKeyEditor editKey(OpenPGPKey key,
 KeyPassphraseProvider primaryKeyPassphraseProvider)
                         throws PGPException

Modify an OpenPGPKey.

Parameters:

key - OpenPGP key

Returns:

key editor

Throws:

PGPException

getImplementation

public OpenPGPImplementation getImplementation()

Return the underlying OpenPGPImplementation of this API handle.

Returns:

OpenPGP implementation