Class JcaOpenPGPApi

java.lang.Object

org.bouncycastle.openpgp.api.OpenPGPApi

org.bouncycastle.openpgp.api.jcajce.JcaOpenPGPApi

public class JcaOpenPGPApi
extends OpenPGPApi

Implementation of OpenPGPApi using the JCA/JCE implementation of OpenPGP classes.

Constructor Summary

Constructors

Constructor	Description
JcaOpenPGPApi(Provider provider)
JcaOpenPGPApi(Provider provider, SecureRandom random)
JcaOpenPGPApi(Provider provider, SecureRandom random, OpenPGPPolicy policy)
JcaOpenPGPApi(Provider provider, OpenPGPPolicy policy)

Method Summary

Modifier and Type	Method	Description
OpenPGPKeyGenerator	generateKey(int version)	Return an OpenPGPKeyGenerator which can be used to generate OpenPGPKeys of the given key version.
OpenPGPKeyGenerator	generateKey(int version, Date creationTime)	Return an OpenPGPKeyGenerator which can be used to generate OpenPGPKeys of the given key version.
OpenPGPKeyGenerator	generateKey(int version, Date creationTime, boolean aeadProtection)	Return an OpenPGPKeyGenerator which can be used to generate OpenPGPKeys of the given key version.

Methods inherited from class OpenPGPApi

createDetachedSignature, decryptAndOrVerifyMessage, editKey, editKey, editKey, generateKey, generateKey, generateKey, getImplementation, readKeyOrCertificate, signAndOrEncryptMessage, verifyDetachedSignature

Methods inherited from class Object

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

Constructor Details

JcaOpenPGPApi

public JcaOpenPGPApi(Provider provider)

JcaOpenPGPApi

public JcaOpenPGPApi(Provider provider,
 SecureRandom random)

JcaOpenPGPApi

public JcaOpenPGPApi(Provider provider,
 OpenPGPPolicy policy)

JcaOpenPGPApi

public JcaOpenPGPApi(Provider provider,
 SecureRandom random,
 OpenPGPPolicy policy)

Method Details

generateKey

public OpenPGPKeyGenerator generateKey(int version)
                                throws PGPException

Description copied from class: OpenPGPApi

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)

Specified by:

generateKey in class OpenPGPApi

Parameters:

version - key version number

Returns:

key generator

Throws:

PGPException - if the key generator cannot be set up

generateKey

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

Description copied from class: OpenPGPApi

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)

Specified by:

generateKey in class OpenPGPApi

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(int version,
 Date creationTime,
 boolean aeadProtection)
                                throws PGPException

Description copied from class: OpenPGPApi

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)

Specified by:

generateKey in class OpenPGPApi

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