org.bouncycastle.openpgp.api

Class OpenPGPKeyEditor

java.lang.Object

org.bouncycastle.openpgp.api.AbstractOpenPGPKeySignatureGenerator

org.bouncycastle.openpgp.api.OpenPGPKeyEditor

public class OpenPGPKeyEditor
extends AbstractOpenPGPKeySignatureGenerator

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
OpenPGPKeyEditor(OpenPGPKey key, KeyPassphraseProvider passphraseProvider)
OpenPGPKeyEditor(OpenPGPKey key, KeyPassphraseProvider passphraseProvider, OpenPGPImplementation implementation)
OpenPGPKeyEditor(OpenPGPKey key, KeyPassphraseProvider passphraseProvider, OpenPGPImplementation implementation, OpenPGPPolicy policy)

Method Summary

Modifier and Type	Method and Description
OpenPGPKeyEditor	addDirectKeySignature(SignatureParameters.Callback signatureCallback)
OpenPGPKeyEditor	addEncryptionSubkey()
OpenPGPKeyEditor	addEncryptionSubkey(KeyPairGeneratorCallback keyGenCallback)
OpenPGPKeyEditor	addEncryptionSubkey(KeyPairGeneratorCallback keyGenCallback, int version, java.util.Date creationTime)
OpenPGPKeyEditor	addEncryptionSubkey(PGPKeyPair encryptionSubkey, SignatureParameters.Callback bindingSigCallback)
OpenPGPKeyEditor	addSigningSubkey()
OpenPGPKeyEditor	addSigningSubkey(KeyPairGeneratorCallback keyGenCallback)
OpenPGPKeyEditor	addSigningSubkey(KeyPairGeneratorCallback keyGenCallback, int version, java.util.Date creationTime)
OpenPGPKeyEditor	addSigningSubkey(PGPKeyPair signingSubkey, SignatureParameters.Callback bindingSigCallback, SignatureParameters.Callback backSigCallback)
OpenPGPKeyEditor	addSubkey(PGPKeyPair subkey, SignatureParameters.Callback bindingSigCallback, SignatureParameters.Callback backSigCallback) Add a component key to the certificate.
OpenPGPKeyEditor	addUserId(java.lang.String userId) Add a user-id to the primary key.
OpenPGPKeyEditor	addUserId(java.lang.String userId, SignatureParameters.Callback signatureCallback) Add a user-id to the primary key, modifying the contents of the certification signature using the given SignatureParameters.Callback.
OpenPGPKeyEditor	changePassphrase(KeyIdentifier componentKeyIdentifier, char[] oldPassphrase, char[] newPassphrase, boolean useAEAD) Change the passphrase of the given component key.
OpenPGPKeyEditor	changePassphrase(KeyIdentifier componentKeyIdentifier, KeyPassphraseProvider passphraseProvider, char[] newPassphrase, boolean useAEAD) Change the passphrase of the given component key.
OpenPGPKey	done() Return the modified OpenPGPKey.
OpenPGPKeyEditor	revokeComponentKey(OpenPGPCertificate.OpenPGPComponentKey componentKey)
OpenPGPKeyEditor	revokeComponentKey(OpenPGPCertificate.OpenPGPComponentKey componentKey, SignatureParameters.Callback revocationSignatureCallback)
OpenPGPKeyEditor	revokeIdentity(OpenPGPCertificate.OpenPGPIdentityComponent identity) Revoke the given OpenPGPCertificate.OpenPGPIdentityComponent.
OpenPGPKeyEditor	revokeIdentity(OpenPGPCertificate.OpenPGPIdentityComponent identity, SignatureParameters.Callback signatureCallback) Revoke the given OpenPGPCertificate.OpenPGPUserId, allowing modification of the revocation signature using the given SignatureParameters.Callback.
OpenPGPKeyEditor	revokeKey()
OpenPGPKeyEditor	revokeKey(SignatureParameters.Callback revocationSignatureCallback)

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

OpenPGPKeyEditor

public OpenPGPKeyEditor(OpenPGPKey key,
                        KeyPassphraseProvider passphraseProvider)
                 throws PGPException

Throws:

PGPException

OpenPGPKeyEditor

public OpenPGPKeyEditor(OpenPGPKey key,
                        KeyPassphraseProvider passphraseProvider,
                        OpenPGPImplementation implementation)
                 throws PGPException

Throws:

PGPException

OpenPGPKeyEditor

public OpenPGPKeyEditor(OpenPGPKey key,
                        KeyPassphraseProvider passphraseProvider,
                        OpenPGPImplementation implementation,
                        OpenPGPPolicy policy)
                 throws PGPException

Throws:

PGPException

Method Detail

addDirectKeySignature

public OpenPGPKeyEditor addDirectKeySignature(SignatureParameters.Callback signatureCallback)
                                       throws PGPException

Throws:

PGPException

addUserId

public OpenPGPKeyEditor addUserId(java.lang.String userId)
                           throws PGPException

Add a user-id to the primary key. If the key already contains the given user-id, a new certification signature will be added to the user-id.

Parameters:

userId - user-id

Returns:

this

Throws:

PGPException - if the key cannot be modified

addUserId

public OpenPGPKeyEditor addUserId(java.lang.String userId,
                                  SignatureParameters.Callback signatureCallback)
                           throws PGPException

Add a user-id to the primary key, modifying the contents of the certification signature using the given SignatureParameters.Callback. If the key already contains the given user-id, a new certification signature will be added to the user-id.

Parameters:

userId - user-id

signatureCallback - callback to modify the certification signature contents

Returns:

this

Throws:

PGPException - if the key cannot be modified

revokeIdentity

public OpenPGPKeyEditor revokeIdentity(OpenPGPCertificate.OpenPGPIdentityComponent identity)
                                throws PGPException

Revoke the given OpenPGPCertificate.OpenPGPIdentityComponent.

Parameters:

identity - user-id to be revoked

Returns:

this

Throws:

PGPException - if the key cannot be modified

revokeIdentity

public OpenPGPKeyEditor revokeIdentity(OpenPGPCertificate.OpenPGPIdentityComponent identity,
                                       SignatureParameters.Callback signatureCallback)
                                throws PGPException

Revoke the given OpenPGPCertificate.OpenPGPUserId, allowing modification of the revocation signature using the given SignatureParameters.Callback.

Parameters:

identity - user-id to revoke

signatureCallback - callback to modify the revocation signature contents

Returns:

this

Throws:

PGPException - if the key cannot be modified

addEncryptionSubkey

public OpenPGPKeyEditor addEncryptionSubkey()
                                     throws PGPException

Throws:

PGPException

addEncryptionSubkey

public OpenPGPKeyEditor addEncryptionSubkey(KeyPairGeneratorCallback keyGenCallback)
                                     throws PGPException

Throws:

PGPException

addEncryptionSubkey

public OpenPGPKeyEditor addEncryptionSubkey(KeyPairGeneratorCallback keyGenCallback,
                                            int version,
                                            java.util.Date creationTime)
                                     throws PGPException

Throws:

PGPException

addEncryptionSubkey

public OpenPGPKeyEditor addEncryptionSubkey(PGPKeyPair encryptionSubkey,
                                            SignatureParameters.Callback bindingSigCallback)
                                     throws PGPException

Throws:

PGPException

addSigningSubkey

public OpenPGPKeyEditor addSigningSubkey()
                                  throws PGPException

Throws:

PGPException

addSigningSubkey

public OpenPGPKeyEditor addSigningSubkey(KeyPairGeneratorCallback keyGenCallback)
                                  throws PGPException

Throws:

PGPException

addSigningSubkey

public OpenPGPKeyEditor addSigningSubkey(KeyPairGeneratorCallback keyGenCallback,
                                         int version,
                                         java.util.Date creationTime)
                                  throws PGPException

Throws:

PGPException

addSigningSubkey

public OpenPGPKeyEditor addSigningSubkey(PGPKeyPair signingSubkey,
                                         SignatureParameters.Callback bindingSigCallback,
                                         SignatureParameters.Callback backSigCallback)
                                  throws PGPException

Throws:

PGPException

addSubkey

public OpenPGPKeyEditor addSubkey(PGPKeyPair subkey,
                                  SignatureParameters.Callback bindingSigCallback,
                                  SignatureParameters.Callback backSigCallback)
                           throws PGPException

Add a component key to the certificate. The bindingSigCallback can be used to modify the subkey binding signature. If it is null, no subkey binding signature will be generated. The backSigCallback can be used to modify the embedded primary key binding signature. If it is null, no primary key binding signature will be generated. You MUST only pass a non-null value here, if the subkey is capable of creating signatures.

Parameters:

subkey - component key

bindingSigCallback - callback to modify the subkey binding signature

backSigCallback - callback to modify the embedded primary key binding signature

Returns:

this

Throws:

PGPException

revokeComponentKey

public OpenPGPKeyEditor revokeComponentKey(OpenPGPCertificate.OpenPGPComponentKey componentKey)
                                    throws PGPException

Throws:

PGPException

revokeComponentKey

public OpenPGPKeyEditor revokeComponentKey(OpenPGPCertificate.OpenPGPComponentKey componentKey,
                                           SignatureParameters.Callback revocationSignatureCallback)
                                    throws PGPException

Throws:

PGPException

revokeKey

public OpenPGPKeyEditor revokeKey()
                           throws PGPException

Throws:

PGPException

revokeKey

public OpenPGPKeyEditor revokeKey(SignatureParameters.Callback revocationSignatureCallback)
                           throws PGPException

Throws:

PGPException

changePassphrase

public OpenPGPKeyEditor changePassphrase(KeyIdentifier componentKeyIdentifier,
                                         char[] oldPassphrase,
                                         char[] newPassphrase,
                                         boolean useAEAD)
                                  throws OpenPGPKeyException,
                                         PGPException

Change the passphrase of the given component key.

Parameters:

componentKeyIdentifier - identifier of the component key, whose passphrase shall be changed

oldPassphrase - old passphrase (or null)

newPassphrase - new passphrase (or null)

useAEAD - whether to use AEAD

Returns:

this

Throws:

OpenPGPKeyException - if the secret component of the component key is missing

PGPException - if the key passphrase cannot be changed

changePassphrase

public OpenPGPKeyEditor changePassphrase(KeyIdentifier componentKeyIdentifier,
                                         KeyPassphraseProvider passphraseProvider,
                                         char[] newPassphrase,
                                         boolean useAEAD)
                                  throws OpenPGPKeyException,
                                         PGPException

Change the passphrase of the given component key.

Parameters:

componentKeyIdentifier - identifier of the component key, whose passphrase shall be changed

passphraseProvider - provider for the old key passphrase

newPassphrase - new passphrase (or null)

useAEAD - whether to use AEAD

Returns:

this

Throws:

OpenPGPKeyException - if the secret component of the component key is missing

PGPException - if the key passphrase cannot be changed

done

public OpenPGPKey done()

Return the modified OpenPGPKey.

Returns:

modified key