Class OpenPGPKeyGenerator.WithPrimaryKey

java.lang.Object

org.bouncycastle.openpgp.api.OpenPGPKeyGenerator.WithPrimaryKey

Enclosing class:

OpenPGPKeyGenerator

public class OpenPGPKeyGenerator.WithPrimaryKey
extends Object

Intermediate builder class. Constructs an OpenPGP key from a specified primary key.

Method Summary

Modifier and Type	Method	Description
OpenPGPKeyGenerator.WithPrimaryKey	addEncryptionSubkey()	Add an encryption-capable subkey to the OpenPGP key.
OpenPGPKeyGenerator.WithPrimaryKey	addEncryptionSubkey(KeyPairGeneratorCallback keyGenCallback)	Add an encryption-capable subkey to the OpenPGP key.
OpenPGPKeyGenerator.WithPrimaryKey	addEncryptionSubkey(KeyPairGeneratorCallback generatorCallback, SignatureParameters.Callback bindingSubpacketsCallback)	Add an encryption-capable subkey to the OpenPGP key.
OpenPGPKeyGenerator.WithPrimaryKey	addEncryptionSubkey(PGPKeyPair encryptionSubkey, SignatureParameters.Callback bindingSubpacketsCallback)	Add an encryption-capable subkey to the OpenPGP key.
OpenPGPKeyGenerator.WithPrimaryKey	addSigningSubkey()	Add a signing-capable subkey to the OpenPGP key.
OpenPGPKeyGenerator.WithPrimaryKey	addSigningSubkey(KeyPairGeneratorCallback keyGenCallback)	Add a signing-capable subkey to the OpenPGP key.
OpenPGPKeyGenerator.WithPrimaryKey	addSigningSubkey(KeyPairGeneratorCallback keyGenCallback, SignatureParameters.Callback bindingSignatureCallback, SignatureParameters.Callback backSignatureCallback)	Add a signing-capable subkey to the OpenPGP key.
OpenPGPKeyGenerator.WithPrimaryKey	addSigningSubkey(PGPKeyPair signingSubkey, SignatureParameters.Callback bindingSignatureCallback, SignatureParameters.Callback backSignatureCallback)	Add a signing-capable subkey to the OpenPGP key.
OpenPGPKeyGenerator.WithPrimaryKey	addUserId(String userId)	Attach a User-ID with a positive certification to the key.
OpenPGPKeyGenerator.WithPrimaryKey	addUserId(String userId, SignatureParameters.Callback signatureParameters)	Attach a User-ID with a positive certification to the key.
OpenPGPKey	build()	Build the OpenPGP key without protecting the secret keys.
OpenPGPKey	build(char[] passphrase)	Build the OpenPGP key using a single passphrase used to protect all subkeys.
protected void	sanitizeKeyEncryptor(PBESecretKeyEncryptor keyEncryptor)

Methods inherited from class Object

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

Method Details

addUserId

public OpenPGPKeyGenerator.WithPrimaryKey addUserId(String userId)
                                             throws PGPException

Attach a User-ID with a positive certification to the key.

Parameters:

userId - user-id

Returns:

builder

Throws:

PGPException - if the user-id cannot be added

addUserId

public OpenPGPKeyGenerator.WithPrimaryKey addUserId(String userId,
 SignatureParameters.Callback signatureParameters)
                                             throws PGPException

Attach a User-ID with a positive certification to the key. The subpackets of the user-id certification can be modified using the userIdSubpackets callback.

Parameters:

userId - user-id

signatureParameters - signature parameters

Returns:

builder

Throws:

PGPException - if the user-id cannot be added

addEncryptionSubkey

public OpenPGPKeyGenerator.WithPrimaryKey addEncryptionSubkey()
                                                       throws PGPException

Add an encryption-capable subkey to the OpenPGP key. See PGPKeyPairGenerator.generateEncryptionSubkey() for the key type.

Returns:

builder

Throws:

PGPException - if the key cannot be generated

addEncryptionSubkey

public OpenPGPKeyGenerator.WithPrimaryKey addEncryptionSubkey(KeyPairGeneratorCallback keyGenCallback)
                                                       throws PGPException

Add an encryption-capable subkey to the OpenPGP key. The type of the subkey can be decided by implementing the KeyPairGeneratorCallback.

Parameters:

keyGenCallback - callback to decide the encryption subkey type

Returns:

builder

Throws:

PGPException - if the key cannot be generated

addEncryptionSubkey

public OpenPGPKeyGenerator.WithPrimaryKey addEncryptionSubkey(KeyPairGeneratorCallback generatorCallback,
 SignatureParameters.Callback bindingSubpacketsCallback)
                                                       throws PGPException

Add an encryption-capable subkey to the OpenPGP key. The type of the subkey can be decided by implementing the KeyPairGeneratorCallback. The binding signature can be modified by implementing the SignatureSubpacketsFunction.

Parameters:

generatorCallback - callback to specify the encryption key type.

bindingSubpacketsCallback - nullable callback to modify the binding signature subpackets

Returns:

builder

Throws:

PGPException - if the key cannot be generated

addEncryptionSubkey

public OpenPGPKeyGenerator.WithPrimaryKey addEncryptionSubkey(PGPKeyPair encryptionSubkey,
 SignatureParameters.Callback bindingSubpacketsCallback)
                                                       throws PGPException

Add an encryption-capable subkey to the OpenPGP key. IMPORTANT: The custom key encryptor will only be used, if in the final step the key is retrieved using build(). If instead build(char[]) is used, the key-specific encryptor is overwritten with an encryptor built from the argument passed into build(char[]).

Parameters:

encryptionSubkey - encryption subkey

bindingSubpacketsCallback - nullable callback to modify the subkey binding signature subpackets

Returns:

builder

Throws:

PGPException - if the key cannot be generated

addSigningSubkey

public OpenPGPKeyGenerator.WithPrimaryKey addSigningSubkey()
                                                    throws PGPException

Add a signing-capable subkey to the OpenPGP key. The binding signature will contain a primary-key back-signature. See PGPKeyPairGenerator.generateSigningSubkey() for the key type.

Returns:

builder

Throws:

PGPException - if the key cannot be generated

addSigningSubkey

public OpenPGPKeyGenerator.WithPrimaryKey addSigningSubkey(KeyPairGeneratorCallback keyGenCallback)
                                                    throws PGPException

Add a signing-capable subkey to the OpenPGP key. The signing-key type can be specified by overriding the KeyPairGeneratorCallback. The binding signature will contain a primary-key back-signature. IMPORTANT: The custom subkey passphrase will only be used, if in the final step the key is retrieved using build(). If instead build(char[]) is used, the key-specific passphrase is overwritten with the argument passed into build(char[]).

Parameters:

keyGenCallback - callback to specify the signing-key type

Returns:

builder

Throws:

PGPException - if the key cannot be generated

addSigningSubkey

public OpenPGPKeyGenerator.WithPrimaryKey addSigningSubkey(KeyPairGeneratorCallback keyGenCallback,
 SignatureParameters.Callback bindingSignatureCallback,
 SignatureParameters.Callback backSignatureCallback)
                                                    throws PGPException

Add a signing-capable subkey to the OpenPGP key. The signing-key type can be specified by overriding the KeyPairGeneratorCallback. The binding signature will contain a primary-key back-signature. The contents of the binding signature(s) can be modified by overriding the respective SignatureSubpacketsFunction instances. IMPORTANT: The custom subkey passphrase will only be used, if in the final step the key is retrieved using build(). If instead build(char[]) is used, the key-specific passphrase is overwritten with the argument passed into build(char[]).

Parameters:

keyGenCallback - callback to specify the signing-key type

bindingSignatureCallback - callback to modify the contents of the signing subkey binding signature

backSignatureCallback - callback to modify the contents of the embedded primary key binding signature

Returns:

builder

Throws:

PGPException - if the key cannot be generated

addSigningSubkey

public OpenPGPKeyGenerator.WithPrimaryKey addSigningSubkey(PGPKeyPair signingSubkey,
 SignatureParameters.Callback bindingSignatureCallback,
 SignatureParameters.Callback backSignatureCallback)
                                                    throws PGPException

Add a signing-capable subkey to the OpenPGP key. The signing-key type can be specified by overriding the KeyPairGeneratorCallback. The binding signature will contain a primary-key back-signature. The contents of the binding signature(s) can be modified by overriding the respective SignatureSubpacketsFunction instances. IMPORTANT: The custom key encryptor will only be used, if in the final step the key is retrieved using build(). If instead build(char[]) is used, the key-specific encryptor is overwritten with an encryptor built from the argument passed into build(char[]).

Parameters:

signingSubkey - signing subkey

bindingSignatureCallback - callback to modify the contents of the signing subkey binding signature

backSignatureCallback - callback to modify the contents of the embedded primary key binding signature

Returns:

builder

Throws:

PGPException - if the key cannot be generated

build

public OpenPGPKey build()
                 throws PGPException

Build the OpenPGP key without protecting the secret keys.

Returns:

OpenPGP key

Throws:

PGPException - if the key cannot be generated

build

public OpenPGPKey build(char[] passphrase)
                 throws PGPException

Build the OpenPGP key using a single passphrase used to protect all subkeys. The passphrase will override whichever key protectors were specified in previous builder steps.

Parameters:

passphrase - nullable passphrase

Returns:

OpenPGP key

Throws:

PGPException - if the key cannot be generated

sanitizeKeyEncryptor

protected void sanitizeKeyEncryptor(PBESecretKeyEncryptor keyEncryptor)