org.bouncycastle.openpgp.api

Class OpenPGPKeyGenerator

java.lang.Object

org.bouncycastle.openpgp.api.AbstractOpenPGPKeySignatureGenerator

org.bouncycastle.openpgp.api.OpenPGPKeyGenerator

Direct Known Subclasses:

BcOpenPGPKeyGenerator, JcaOpenPGPKeyGenerator

public class OpenPGPKeyGenerator
extends AbstractOpenPGPKeySignatureGenerator

High-level generator class for OpenPGP v6 keys.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	OpenPGPKeyGenerator.WithPrimaryKey Intermediate builder class.

Field Summary

Fields inherited from class org.bouncycastle.openpgp.api.AbstractOpenPGPKeySignatureGenerator

defaultAeadAlgorithmPreferences, defaultCompressionAlgorithmPreferences, defaultFeatures, defaultHashAlgorithmPreferences, defaultSymmetricKeyPreferences, directKeySignatureSubpackets, encryptionSubkeySubpackets, signingSubkeySubpackets

Constructor Summary

Constructors

Constructor and Description
OpenPGPKeyGenerator(OpenPGPImplementation implementation, boolean aead, java.util.Date creationTime)
OpenPGPKeyGenerator(OpenPGPImplementation implementationProvider, int version, boolean aead, java.util.Date creationTime)
OpenPGPKeyGenerator(OpenPGPImplementation implementationProvider, int keyVersion, PGPKeyPairGeneratorProvider kpGenProvider, PGPDigestCalculatorProvider digestCalculatorProvider, PBESecretKeyEncryptorFactory keyEncryptionBuilderProvider, KeyFingerPrintCalculator keyFingerPrintCalculator, java.util.Date creationTime) Generate a new OpenPGP key generator for v6 keys.

Method Summary

Modifier and Type	Method and Description
OpenPGPKeyGenerator.WithPrimaryKey	classicKey(java.lang.String userId) Generate an OpenPGP key consisting of a certify-only primary key, a dedicated signing-subkey and dedicated encryption-subkey.
OpenPGPKeyGenerator.WithPrimaryKey	compositeRSAKey(int bitStrength, java.lang.String userId) Generate an OpenPGP key composed of 3 individual component keys based on RSA of the given strength in bits.
OpenPGPKeyGenerator.WithPrimaryKey	ed25519x25519Key(java.lang.String userId) Generate an OpenPGP key consisting of an Ed25519 certify-only primary key, a dedicated Ed25519 sign-only subkey and dedicated X25519 encryption-only subkey.
OpenPGPKeyGenerator.WithPrimaryKey	ed448x448Key(java.lang.String userId) Generate an OpenPGP key consisting of an Ed448 certify-only primary key, a dedicated Ed448 sign-only subkey and dedicated X448 encryption-only subkey.
OpenPGPKeyGenerator.WithPrimaryKey	signOnlyKey() Generate a sign-only OpenPGP key.
OpenPGPKeyGenerator.WithPrimaryKey	singletonRSAKey(int bitStrength, java.lang.String userId) Generate an OpenPGP key based on a single, multipurpose RSA key of the given strength.
OpenPGPKeyGenerator.WithPrimaryKey	withPrimaryKey() Generate an OpenPGP key with a certification-capable primary key.
OpenPGPKeyGenerator.WithPrimaryKey	withPrimaryKey(KeyPairGeneratorCallback keyGenCallback) Generate an OpenPGP key with a certification-capable primary key.
OpenPGPKeyGenerator.WithPrimaryKey	withPrimaryKey(KeyPairGeneratorCallback keyGenCallback, SignatureParameters.Callback preferenceSignatureCallback) Generate an OpenPGP key with a certification-capable primary key.

Methods inherited from class org.bouncycastle.openpgp.api.AbstractOpenPGPKeySignatureGenerator

setDefaultAeadAlgorithmPreferences, setDefaultCompressionAlgorithmPreferences, setDefaultFeatures, setDefaultHashAlgorithmPreferences, setDefaultSymmetricKeyPreferences, setDirectKeySignatureSubpackets, setEncryptionSubkeySubpackets, setSigningSubkeySubpackets

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenPGPKeyGenerator

public OpenPGPKeyGenerator(OpenPGPImplementation implementation,
                           boolean aead,
                           java.util.Date creationTime)
                    throws PGPException

Throws:

PGPException

OpenPGPKeyGenerator

public OpenPGPKeyGenerator(OpenPGPImplementation implementationProvider,
                           int version,
                           boolean aead,
                           java.util.Date creationTime)
                    throws PGPException

Throws:

PGPException

OpenPGPKeyGenerator

public OpenPGPKeyGenerator(OpenPGPImplementation implementationProvider,
                           int keyVersion,
                           PGPKeyPairGeneratorProvider kpGenProvider,
                           PGPDigestCalculatorProvider digestCalculatorProvider,
                           PBESecretKeyEncryptorFactory keyEncryptionBuilderProvider,
                           KeyFingerPrintCalculator keyFingerPrintCalculator,
                           java.util.Date creationTime)

Generate a new OpenPGP key generator for v6 keys.

Parameters:

kpGenProvider - key pair generator provider

digestCalculatorProvider - digest calculator provider

keyEncryptionBuilderProvider - secret key encryption builder provider (AEAD)

keyFingerPrintCalculator - calculator for key fingerprints

creationTime - key creation time

Method Detail

classicKey

public OpenPGPKeyGenerator.WithPrimaryKey classicKey(java.lang.String userId)
                                              throws PGPException

Generate an OpenPGP key consisting of a certify-only primary key, a dedicated signing-subkey and dedicated encryption-subkey. The key will optionally carry the provided user-id. See PGPKeyPairGenerator.generatePrimaryKey() for the primary key type, PGPKeyPairGenerator.generateSigningSubkey() for the signing-subkey type and PGPKeyPairGenerator.generateEncryptionSubkey() for the encryption-subkey key type.

Parameters:

userId - nullable user id

Returns:

OpenPGP key

Throws:

PGPException - if the key cannot be prepared

ed25519x25519Key

public OpenPGPKeyGenerator.WithPrimaryKey ed25519x25519Key(java.lang.String userId)
                                                    throws PGPException

Generate an OpenPGP key consisting of an Ed25519 certify-only primary key, a dedicated Ed25519 sign-only subkey and dedicated X25519 encryption-only subkey. The key will optionally carry the provided user-id.

Parameters:

userId - nullable user id

Returns:

OpenPGP key

Throws:

PGPException - if the key cannot be generated

ed448x448Key

public OpenPGPKeyGenerator.WithPrimaryKey ed448x448Key(java.lang.String userId)
                                                throws PGPException

Generate an OpenPGP key consisting of an Ed448 certify-only primary key, a dedicated Ed448 sign-only subkey and dedicated X448 encryption-only subkey. The key will optionally carry the provided user-id.

Parameters:

userId - nullable user id

Returns:

OpenPGP key

Throws:

PGPException - if the key cannot be generated

signOnlyKey

public OpenPGPKeyGenerator.WithPrimaryKey signOnlyKey()
                                               throws PGPException

Generate a sign-only OpenPGP key. The key consists of a single, user-id-less primary key, which is capable of signing and certifying. See PGPKeyPairGenerator.generatePrimaryKey() for the key type.

Returns:

sign-only (+certify) OpenPGP key

Throws:

PGPException - if the key cannot be generated

singletonRSAKey

public OpenPGPKeyGenerator.WithPrimaryKey singletonRSAKey(int bitStrength,
                                                          java.lang.String userId)
                                                   throws PGPException

Generate an OpenPGP key based on a single, multipurpose RSA key of the given strength. The key will carry a direct-key signature containing default preferences and flags. If the passed in userId is non-null, it will be added to the key.

Parameters:

bitStrength - strength of the RSA key in bits (recommended values: 3072 and above).

userId - optional user-id

Returns:

builder

Throws:

PGPException - if the key cannot be generated.

compositeRSAKey

public OpenPGPKeyGenerator.WithPrimaryKey compositeRSAKey(int bitStrength,
                                                          java.lang.String userId)
                                                   throws PGPException

Generate an OpenPGP key composed of 3 individual component keys based on RSA of the given strength in bits. The primary key will be used to certify third-party keys. A subkey is used for signing and a third subkey is used for encryption of messages both for storage and communications. The primary key will carry a direct-key signature containing default preferences and flags. The subkeys will be bound with subkey binding signatures. If the passed in userId is non-null, it will be added to the key.

Parameters:

bitStrength - strength of the keys in bits (recommended values: 3072 and above)

userId - optional user-id

Returns:

builder

Throws:

PGPException - if the key cannot be generated

withPrimaryKey

public OpenPGPKeyGenerator.WithPrimaryKey withPrimaryKey()
                                                  throws PGPException

Generate an OpenPGP key with a certification-capable primary key. See PGPKeyPairGenerator.generatePrimaryKey() for the primary key type

Returns:

builder

Throws:

PGPException - if the key cannot be generated

withPrimaryKey

public OpenPGPKeyGenerator.WithPrimaryKey withPrimaryKey(KeyPairGeneratorCallback keyGenCallback)
                                                  throws PGPException

Generate an OpenPGP key with a certification-capable primary key. The primary key type can be decided using the KeyPairGeneratorCallback.

Parameters:

keyGenCallback - callback to decide the key type

Returns:

builder

Throws:

PGPException - if the key cannot be generated

withPrimaryKey

public OpenPGPKeyGenerator.WithPrimaryKey withPrimaryKey(KeyPairGeneratorCallback keyGenCallback,
                                                         SignatureParameters.Callback preferenceSignatureCallback)
                                                  throws PGPException

Generate an OpenPGP key with a certification-capable primary key. The primary key type can be decided using the KeyPairGeneratorCallback. The SignatureParameters.Callback can be used to modify the preferences in the direct-key self signature. If the callback itself is null, the generator will create a default direct-key signature. If the result of SignatureParameters.Callback.apply(SignatureParameters) is null, no direct-key signature will be generated for the key.

Parameters:

keyGenCallback - callback to decide the key type

preferenceSignatureCallback - callback to modify the direct-key signature

Returns:

builder

Throws:

PGPException - if the key cannot be generated