Package org.bouncycastle.openpgp.api

Class OpenPGPV6KeyGenerator.WithPrimaryKey

java.lang.Object

org.bouncycastle.openpgp.api.OpenPGPV6KeyGenerator.WithPrimaryKey

Enclosing class:

OpenPGPV6KeyGenerator

public static class OpenPGPV6KeyGenerator.WithPrimaryKey
extends java.lang.Object

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

Method Summary

Modifier and Type	Method	Description
OpenPGPV6KeyGenerator.WithPrimaryKey	addEncryptionSubkey()	Add an encryption-capable subkey to the OpenPGP key.
OpenPGPV6KeyGenerator.WithPrimaryKey	addEncryptionSubkey(char[] passphrase)	Add an encryption-capable subkey to the OpenPGP key.
OpenPGPV6KeyGenerator.WithPrimaryKey	addEncryptionSubkey(KeyPairGeneratorCallback keyGenCallback)	Add an encryption-capable subkey to the OpenPGP key.
OpenPGPV6KeyGenerator.WithPrimaryKey	addEncryptionSubkey(KeyPairGeneratorCallback keyGenCallback, char[] passphrase)	Add an encryption-capable subkey to the OpenPGP key.
OpenPGPV6KeyGenerator.WithPrimaryKey	addEncryptionSubkey(KeyPairGeneratorCallback generatorCallback, SignatureSubpacketsFunction bindingSubpacketsCallback)	Add an encryption-capable subkey to the OpenPGP key.
OpenPGPV6KeyGenerator.WithPrimaryKey	addEncryptionSubkey(KeyPairGeneratorCallback keyGenCallback, SignatureSubpacketsFunction bindingSignatureCallback, char[] passphrase)	Add an encryption-capable subkey to the OpenPGP key.
OpenPGPV6KeyGenerator.WithPrimaryKey	addEncryptionSubkey(PGPKeyPair encryptionSubkey, SignatureSubpacketsFunction bindingSubpacketsCallback, PBESecretKeyEncryptor keyEncryptor)	Add an encryption-capable subkey to the OpenPGP key.
OpenPGPV6KeyGenerator.WithPrimaryKey	addSigningSubkey()	Add a signing-capable subkey to the OpenPGP key.
OpenPGPV6KeyGenerator.WithPrimaryKey	addSigningSubkey(char[] passphrase)	Add a signing-capable subkey to the OpenPGP key.
OpenPGPV6KeyGenerator.WithPrimaryKey	addSigningSubkey(KeyPairGeneratorCallback keyGenCallback)	Add a signing-capable subkey to the OpenPGP key.
OpenPGPV6KeyGenerator.WithPrimaryKey	addSigningSubkey(KeyPairGeneratorCallback keyGenCallback, char[] passphrase)	Add a signing-capable subkey to the OpenPGP key.
OpenPGPV6KeyGenerator.WithPrimaryKey	addSigningSubkey(KeyPairGeneratorCallback keyGenCallback, SignatureSubpacketsFunction bindingSignatureCallback, SignatureSubpacketsFunction backSignatureCallback, char[] passphrase)	Add a signing-capable subkey to the OpenPGP key.
OpenPGPV6KeyGenerator.WithPrimaryKey	addSigningSubkey(PGPKeyPair signingSubkey, SignatureSubpacketsFunction bindingSignatureCallback, SignatureSubpacketsFunction backSignatureCallback, PBESecretKeyEncryptor keyEncryptor)	Add a signing-capable subkey to the OpenPGP key.
OpenPGPV6KeyGenerator.WithPrimaryKey	addUserId(java.lang.String userId)	Attach a User-ID with a positive certification to the key.
OpenPGPV6KeyGenerator.WithPrimaryKey	addUserId(java.lang.String userId, int certificationType, SignatureSubpacketsFunction userIdSubpackets)	Attach a User-ID with a positive certification to the key.
OpenPGPV6KeyGenerator.WithPrimaryKey	addUserId(java.lang.String userId, SignatureSubpacketsFunction userIdSubpackets)	Attach a User-ID with a positive certification to the key.
PGPSecretKeyRing	build()	Build the OpenPGP key, allowing individual passphrases for the subkeys.
PGPSecretKeyRing	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 java.lang.Object

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

Method Detail

addUserId

public OpenPGPV6KeyGenerator.WithPrimaryKey addUserId(java.lang.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 OpenPGPV6KeyGenerator.WithPrimaryKey addUserId(java.lang.String userId,
                                                      SignatureSubpacketsFunction userIdSubpackets)
                                               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

userIdSubpackets - callback to modify the certification subpackets

Returns:

builder

Throws:

PGPException - if the user-id cannot be added

addUserId

public OpenPGPV6KeyGenerator.WithPrimaryKey addUserId(java.lang.String userId,
                                                      int certificationType,
                                                      SignatureSubpacketsFunction userIdSubpackets)
                                               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

certificationType - signature type

userIdSubpackets - callback to modify the certification subpackets

Returns:

builder

Throws:

PGPException - if the user-id cannot be added

addEncryptionSubkey

public OpenPGPV6KeyGenerator.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 OpenPGPV6KeyGenerator.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 OpenPGPV6KeyGenerator.WithPrimaryKey addEncryptionSubkey(KeyPairGeneratorCallback generatorCallback,
                                                                SignatureSubpacketsFunction 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 OpenPGPV6KeyGenerator.WithPrimaryKey addEncryptionSubkey(char[] passphrase)
                                                         throws PGPException

Add an encryption-capable subkey to the OpenPGP key. The subkey will be protected using the provided subkey passphrase. 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[]). See PGPKeyPairGenerator.generateEncryptionSubkey() for the key type.

Parameters:

passphrase - nullable subkey passphrase

Returns:

builder

Throws:

PGPException - if the key cannot be generated

addEncryptionSubkey

public OpenPGPV6KeyGenerator.WithPrimaryKey addEncryptionSubkey(KeyPairGeneratorCallback keyGenCallback,
                                                                char[] passphrase)
                                                         throws PGPException

Add an encryption-capable subkey to the OpenPGP key. The key type can be specified by overriding KeyPairGeneratorCallback. The subkey will be protected using the provided subkey passphrase. 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 key type

passphrase - nullable passphrase for the encryption subkey

Returns:

builder

Throws:

PGPException - if the key cannot be generated

addEncryptionSubkey

public OpenPGPV6KeyGenerator.WithPrimaryKey addEncryptionSubkey(KeyPairGeneratorCallback keyGenCallback,
                                                                SignatureSubpacketsFunction bindingSignatureCallback,
                                                                char[] passphrase)
                                                         throws PGPException

Add an encryption-capable subkey to the OpenPGP key. The key type can be specified by overriding KeyPairGeneratorCallback. The binding signatures subpackets can be modified by overriding the SignatureSubpacketsFunction. The subkey will be protected using the provided subkey passphrase. 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 key type

bindingSignatureCallback - nullable callback to modify the binding signature subpackets

passphrase - nullable passphrase for the encryption subkey

Returns:

builder

Throws:

PGPException - if the key cannot be generated

addEncryptionSubkey

public OpenPGPV6KeyGenerator.WithPrimaryKey addEncryptionSubkey(PGPKeyPair encryptionSubkey,
                                                                SignatureSubpacketsFunction bindingSubpacketsCallback,
                                                                PBESecretKeyEncryptor keyEncryptor)
                                                         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

keyEncryptor - nullable encryptor to encrypt the encryption subkey

Returns:

builder

Throws:

PGPException - if the key cannot be generated

addSigningSubkey

public OpenPGPV6KeyGenerator.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 OpenPGPV6KeyGenerator.WithPrimaryKey addSigningSubkey(KeyPairGeneratorCallback keyGenCallback)
                                                      throws PGPException

Add a signing-capable subkey to the OpenPGP key. The binding signature will contain a primary-key back-signature. The key type can be specified by overriding KeyPairGeneratorCallback.

Parameters:

keyGenCallback - callback to specify the signing-subkey type

Returns:

builder

Throws:

PGPException - if the key cannot be generated

addSigningSubkey

public OpenPGPV6KeyGenerator.WithPrimaryKey addSigningSubkey(char[] passphrase)
                                                      throws PGPException

Add a signing-capable subkey to the OpenPGP key. See PGPKeyPairGenerator.generateSigningSubkey() for the key type. 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:

passphrase - nullable passphrase

Returns:

builder

Throws:

PGPException - if the key cannot be generated

addSigningSubkey

public OpenPGPV6KeyGenerator.WithPrimaryKey addSigningSubkey(KeyPairGeneratorCallback keyGenCallback,
                                                             char[] passphrase)
                                                      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

passphrase - nullable passphrase

Returns:

builder

Throws:

PGPException - if the key cannot be generated

addSigningSubkey

public OpenPGPV6KeyGenerator.WithPrimaryKey addSigningSubkey(KeyPairGeneratorCallback keyGenCallback,
                                                             SignatureSubpacketsFunction bindingSignatureCallback,
                                                             SignatureSubpacketsFunction backSignatureCallback,
                                                             char[] passphrase)
                                                      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

passphrase - nullable passphrase

Returns:

builder

Throws:

PGPException - if the key cannot be generated

addSigningSubkey

public OpenPGPV6KeyGenerator.WithPrimaryKey addSigningSubkey(PGPKeyPair signingSubkey,
                                                             SignatureSubpacketsFunction bindingSignatureCallback,
                                                             SignatureSubpacketsFunction backSignatureCallback,
                                                             PBESecretKeyEncryptor keyEncryptor)
                                                      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

keyEncryptor - nullable encryptor to protect the signing subkey

Returns:

builder

Throws:

PGPException - if the key cannot be generated

build

public PGPSecretKeyRing build()
                       throws PGPException

Build the OpenPGP key, allowing individual passphrases for the subkeys.

Returns:

OpenPGP key

Throws:

PGPException - if the key cannot be generated

build

public PGPSecretKeyRing 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)