Package org.pgpainless.key.modification.secretkeyring

Class SecretKeyRingEditor

java.lang.Object

org.pgpainless.key.modification.secretkeyring.SecretKeyRingEditor

All Implemented Interfaces:

SecretKeyRingEditorInterface

public class SecretKeyRingEditor
extends Object
implements SecretKeyRingEditorInterface

Nested Class Summary

Nested classes/interfaces inherited from interface org.pgpainless.key.modification.secretkeyring.SecretKeyRingEditorInterface

SecretKeyRingEditorInterface.WithKeyRingEncryptionSettings, SecretKeyRingEditorInterface.WithPassphrase

Constructor Summary

Constructors

Constructor	Description
SecretKeyRingEditor(org.bouncycastle.openpgp.PGPSecretKeyRing secretKeyRing)

Method Summary

Modifier and Type	Method	Description
SecretKeyRingEditorInterface	addPrimaryUserId(CharSequence userId, SecretKeyRingProtector protector)	Add a user-id to the key ring and mark it as primary.
SecretKeyRingEditorInterface	addSubKey(org.bouncycastle.openpgp.PGPKeyPair subkey, SelfSignatureSubpackets.Callback bindingSignatureCallback, SecretKeyRingProtector subkeyProtector, SecretKeyRingProtector primaryKeyProtector, KeyFlag keyFlag, KeyFlag... additionalKeyFlags)	Add a subkey to the key ring.
SecretKeyRingEditorInterface	addSubKey(KeySpec keySpec, Passphrase subKeyPassphrase, SecretKeyRingProtector secretKeyRingProtector)	Add a subkey to the key ring.
SecretKeyRingEditorInterface	addSubKey(KeySpec keySpec, Passphrase subkeyPassphrase, SelfSignatureSubpackets.Callback subpacketsCallback, SecretKeyRingProtector secretKeyRingProtector)	Add a subkey to the key ring.
SecretKeyRingEditorInterface	addUserId(CharSequence userId, SecretKeyRingProtector secretKeyRingProtector)	Add a user-id to the key ring.
SecretKeyRingEditorInterface	addUserId(CharSequence userId, SelfSignatureSubpackets.Callback signatureSubpacketCallback, SecretKeyRingProtector protector)	Add a user-id to the key ring.
SecretKeyRingEditorInterface.WithKeyRingEncryptionSettings	changePassphraseFromOldPassphrase(Passphrase oldPassphrase, KeyRingProtectionSettings oldProtectionSettings)	Change the passphrase of the whole key ring.
SecretKeyRingEditorInterface.WithKeyRingEncryptionSettings	changeSubKeyPassphraseFromOldPassphrase(Long keyId, Passphrase oldPassphrase, KeyRingProtectionSettings oldProtectionSettings)
org.bouncycastle.openpgp.PGPSignature	createRevocationCertificate(long subkeyId, SecretKeyRingProtector secretKeyRingProtector, RevocationAttributes revocationAttributes)	Create a detached revocation certificate, which can be used to revoke the specified subkey.
org.bouncycastle.openpgp.PGPSignature	createRevocationCertificate(long subkeyId, SecretKeyRingProtector secretKeyRingProtector, RevocationSignatureSubpackets.Callback certificateSubpacketsCallback)	Create a detached revocation certificate, which can be used to revoke the specified subkey.
org.bouncycastle.openpgp.PGPSignature	createRevocationCertificate(SecretKeyRingProtector secretKeyRingProtector, RevocationAttributes revocationAttributes)	Create a detached revocation certificate, which can be used to revoke the whole key.
org.bouncycastle.openpgp.PGPSecretKeyRing	done()	Return the PGPSecretKeyRing.
SecretKeyRingEditorInterface	removeUserId(CharSequence userId, SecretKeyRingProtector protector)	Convenience method to revoke a single user-id using a soft revocation signature.
SecretKeyRingEditorInterface	removeUserId(SelectUserId userIdSelector, SecretKeyRingProtector protector)	Convenience method to revoke selected user-ids using soft revocation signatures.
SecretKeyRingEditorInterface	revoke(SecretKeyRingProtector secretKeyRingProtector, RevocationAttributes revocationAttributes)	Revoke the key ring using the provided revocation attributes.
SecretKeyRingEditorInterface	revoke(SecretKeyRingProtector secretKeyRingProtector, RevocationSignatureSubpackets.Callback subpacketsCallback)	Revoke the key ring.
SecretKeyRingEditorInterface	revokeSubKey(long subKeyId, SecretKeyRingProtector protector, RevocationAttributes revocationAttributes)	Revoke the subkey binding signature of a subkey.
SecretKeyRingEditorInterface	revokeSubKey(long keyID, SecretKeyRingProtector secretKeyRingProtector, RevocationSignatureSubpackets.Callback subpacketsCallback)	Revoke the subkey binding signature of a subkey.
SecretKeyRingEditorInterface	revokeUserId(CharSequence userId, SecretKeyRingProtector secretKeyRingProtector, RevocationAttributes revocationAttributes)	Revoke the given userID using the provided revocation attributes.
SecretKeyRingEditorInterface	revokeUserId(CharSequence userId, SecretKeyRingProtector secretKeyRingProtector, RevocationSignatureSubpackets.Callback subpacketCallback)	Revoke the provided user-id.
SecretKeyRingEditorInterface	revokeUserIds(SelectUserId userIdSelector, SecretKeyRingProtector secretKeyRingProtector, RevocationAttributes revocationAttributes)	Revoke all user-ids that match the provided SelectUserId filter.
SecretKeyRingEditorInterface	revokeUserIds(SelectUserId userIdSelector, SecretKeyRingProtector secretKeyRingProtector, RevocationSignatureSubpackets.Callback subpacketsCallback)	Revoke all user-ids that match the provided SelectUserId filter.
SecretKeyRingEditorInterface	setExpirationDate(Date expiration, SecretKeyRingProtector secretKeyRingProtector)	Set the expiration date for the primary key of the key ring.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pgpainless.key.modification.secretkeyring.SecretKeyRingEditorInterface

changePassphraseFromOldPassphrase, changeSubKeyPassphraseFromOldPassphrase, createRevocationCertificate, revoke, revokeSubKey, revokeSubKey, revokeSubKey, revokeUserId

Constructor Detail

SecretKeyRingEditor

public SecretKeyRingEditor(org.bouncycastle.openpgp.PGPSecretKeyRing secretKeyRing)

Method Detail

addUserId

public SecretKeyRingEditorInterface addUserId(@Nonnull
                                              CharSequence userId,
                                              @Nonnull
                                              SecretKeyRingProtector secretKeyRingProtector)
                                       throws org.bouncycastle.openpgp.PGPException

Description copied from interface: SecretKeyRingEditorInterface

Add a user-id to the key ring.

Specified by:

addUserId in interface SecretKeyRingEditorInterface

Parameters:

userId - user-id

secretKeyRingProtector - protector to unlock the secret key

Returns:

the builder

Throws:

org.bouncycastle.openpgp.PGPException

addUserId

public SecretKeyRingEditorInterface addUserId(@Nonnull
                                              CharSequence userId,
                                              @Nullable
                                              SelfSignatureSubpackets.Callback signatureSubpacketCallback,
                                              @Nonnull
                                              SecretKeyRingProtector protector)
                                       throws org.bouncycastle.openpgp.PGPException

Description copied from interface: SecretKeyRingEditorInterface

Add a user-id to the key ring.

Specified by:

addUserId in interface SecretKeyRingEditorInterface

Parameters:

userId - user-id

signatureSubpacketCallback - callback that can be used to modify signature subpackets of the certification signature.

protector - protector to unlock the primary secret key

Returns:

the builder

Throws:

org.bouncycastle.openpgp.PGPException

addPrimaryUserId

public SecretKeyRingEditorInterface addPrimaryUserId(@Nonnull
                                                     CharSequence userId,
                                                     @Nonnull
                                                     SecretKeyRingProtector protector)
                                              throws org.bouncycastle.openpgp.PGPException

Description copied from interface: SecretKeyRingEditorInterface

Add a user-id to the key ring and mark it as primary. If the user-id is already present, a new certification signature will be created.

Specified by:

addPrimaryUserId in interface SecretKeyRingEditorInterface

Parameters:

userId - user id

protector - protector to unlock the secret key

Returns:

the builder

Throws:

org.bouncycastle.openpgp.PGPException

removeUserId

public SecretKeyRingEditorInterface removeUserId(SelectUserId userIdSelector,
                                                 SecretKeyRingProtector protector)
                                          throws org.bouncycastle.openpgp.PGPException

Description copied from interface: SecretKeyRingEditorInterface

Convenience method to revoke selected user-ids using soft revocation signatures. The revocation will use RevocationAttributes.Reason.USER_ID_NO_LONGER_VALID, so that the user-id can be re-certified at a later point.

Specified by:

removeUserId in interface SecretKeyRingEditorInterface

Parameters:

userIdSelector - selector to select user-ids

protector - protector to unlock the primary key

Returns:

the builder

Throws:

org.bouncycastle.openpgp.PGPException

removeUserId

public SecretKeyRingEditorInterface removeUserId(CharSequence userId,
                                                 SecretKeyRingProtector protector)
                                          throws org.bouncycastle.openpgp.PGPException

Description copied from interface: SecretKeyRingEditorInterface

Convenience method to revoke a single user-id using a soft revocation signature. The revocation will use RevocationAttributes.Reason.USER_ID_NO_LONGER_VALID. so that the user-id can be re-certified at a later point.

Specified by:

removeUserId in interface SecretKeyRingEditorInterface

Parameters:

userId - user-id to revoke

protector - protector to unlock the primary key

Returns:

the builder

Throws:

org.bouncycastle.openpgp.PGPException

addSubKey

public SecretKeyRingEditorInterface addSubKey(@Nonnull
                                              KeySpec keySpec,
                                              @Nonnull
                                              Passphrase subKeyPassphrase,
                                              @Nonnull
                                              SecretKeyRingProtector secretKeyRingProtector)
                                       throws InvalidAlgorithmParameterException,
                                              NoSuchAlgorithmException,
                                              org.bouncycastle.openpgp.PGPException,
                                              IOException

Description copied from interface: SecretKeyRingEditorInterface

Add a subkey to the key ring. The subkey will be generated from the provided KeySpec.

Specified by:

addSubKey in interface SecretKeyRingEditorInterface

Parameters:

keySpec - key specification

subKeyPassphrase - passphrase to encrypt the sub key

secretKeyRingProtector - protector to unlock the secret key of the key ring

Returns:

the builder

Throws:

InvalidAlgorithmParameterException

NoSuchAlgorithmException

org.bouncycastle.openpgp.PGPException

IOException

addSubKey

public SecretKeyRingEditorInterface addSubKey(@Nonnull
                                              KeySpec keySpec,
                                              @Nullable
                                              Passphrase subkeyPassphrase,
                                              @Nullable
                                              SelfSignatureSubpackets.Callback subpacketsCallback,
                                              @Nonnull
                                              SecretKeyRingProtector secretKeyRingProtector)
                                       throws org.bouncycastle.openpgp.PGPException,
                                              InvalidAlgorithmParameterException,
                                              NoSuchAlgorithmException,
                                              IOException

Description copied from interface: SecretKeyRingEditorInterface

Add a subkey to the key ring. The subkey will be generated from the provided KeySpec.

Specified by:

addSubKey in interface SecretKeyRingEditorInterface

Parameters:

keySpec - key spec of the subkey

subkeyPassphrase - passphrase to encrypt the subkey

subpacketsCallback - callback to modify the subpackets of the subkey binding signature

secretKeyRingProtector - protector to unlock the primary key

Returns:

builder

Throws:

org.bouncycastle.openpgp.PGPException

InvalidAlgorithmParameterException

NoSuchAlgorithmException

IOException

addSubKey

public SecretKeyRingEditorInterface addSubKey(@Nonnull
                                              org.bouncycastle.openpgp.PGPKeyPair subkey,
                                              @Nullable
                                              SelfSignatureSubpackets.Callback bindingSignatureCallback,
                                              @Nonnull
                                              SecretKeyRingProtector subkeyProtector,
                                              @Nonnull
                                              SecretKeyRingProtector primaryKeyProtector,
                                              @Nonnull
                                              KeyFlag keyFlag,
                                              KeyFlag... additionalKeyFlags)
                                       throws org.bouncycastle.openpgp.PGPException,
                                              IOException,
                                              NoSuchAlgorithmException

Description copied from interface: SecretKeyRingEditorInterface

Add a subkey to the key ring.

Specified by:

addSubKey in interface SecretKeyRingEditorInterface

Parameters:

subkey - subkey key pair

bindingSignatureCallback - callback to modify the subpackets of the subkey binding signature

subkeyProtector - protector to unlock and encrypt the subkey

primaryKeyProtector - protector to unlock the primary key

keyFlag - first key flag for the subkey

additionalKeyFlags - optional additional key flags

Returns:

builder

Throws:

org.bouncycastle.openpgp.PGPException

IOException

NoSuchAlgorithmException

revoke

public SecretKeyRingEditorInterface revoke(@Nonnull
                                           SecretKeyRingProtector secretKeyRingProtector,
                                           @Nullable
                                           RevocationAttributes revocationAttributes)
                                    throws org.bouncycastle.openpgp.PGPException

Description copied from interface: SecretKeyRingEditorInterface

Revoke the key ring using the provided revocation attributes. The attributes define, whether the revocation was a hard revocation or not.

Specified by:

revoke in interface SecretKeyRingEditorInterface

Parameters:

secretKeyRingProtector - protector of the primary key

revocationAttributes - reason for the revocation

Returns:

the builder

Throws:

org.bouncycastle.openpgp.PGPException

revoke

public SecretKeyRingEditorInterface revoke(@Nonnull
                                           SecretKeyRingProtector secretKeyRingProtector,
                                           @Nullable
                                           RevocationSignatureSubpackets.Callback subpacketsCallback)
                                    throws org.bouncycastle.openpgp.PGPException

Description copied from interface: SecretKeyRingEditorInterface

Revoke the key ring. You can use the RevocationSignatureSubpackets.Callback to modify the revocation signatures subpackets, e.g. in order to define whether this is a hard or soft revocation.

Specified by:

revoke in interface SecretKeyRingEditorInterface

Parameters:

secretKeyRingProtector - protector to unlock the primary secret key

subpacketsCallback - callback to modify the revocations subpackets

Returns:

builder

Throws:

org.bouncycastle.openpgp.PGPException

revokeSubKey

public SecretKeyRingEditorInterface revokeSubKey(long subKeyId,
                                                 SecretKeyRingProtector protector,
                                                 RevocationAttributes revocationAttributes)
                                          throws org.bouncycastle.openpgp.PGPException

Description copied from interface: SecretKeyRingEditorInterface

Revoke the subkey binding signature of a subkey. The subkey with the provided key-id will be revoked. If no suitable subkey is found, a NoSuchElementException will be thrown.

Specified by:

revokeSubKey in interface SecretKeyRingEditorInterface

Parameters:

subKeyId - id of the subkey

protector - protector to unlock the primary key

revocationAttributes - reason for the revocation

Returns:

the builder

Throws:

org.bouncycastle.openpgp.PGPException

revokeSubKey

public SecretKeyRingEditorInterface revokeSubKey(long keyID,
                                                 @Nonnull
                                                 SecretKeyRingProtector secretKeyRingProtector,
                                                 @Nullable
                                                 RevocationSignatureSubpackets.Callback subpacketsCallback)
                                          throws org.bouncycastle.openpgp.PGPException

Description copied from interface: SecretKeyRingEditorInterface

Revoke the subkey binding signature of a subkey. The subkey with the provided key-id will be revoked. If no suitable subkey is found, q NoSuchElementException will be thrown. The provided subpackets callback is used to modify the revocation signatures subpackets.

Specified by:

revokeSubKey in interface SecretKeyRingEditorInterface

Parameters:

keyID - id of the subkey

secretKeyRingProtector - protector to unlock the secret key ring

subpacketsCallback - callback which can be used to modify the subpackets of the revocation signature

Returns:

the builder

Throws:

org.bouncycastle.openpgp.PGPException

createRevocationCertificate

public org.bouncycastle.openpgp.PGPSignature createRevocationCertificate(@Nonnull
                                                                         SecretKeyRingProtector secretKeyRingProtector,
                                                                         @Nullable
                                                                         RevocationAttributes revocationAttributes)
                                                                  throws org.bouncycastle.openpgp.PGPException

Description copied from interface: SecretKeyRingEditorInterface

Create a detached revocation certificate, which can be used to revoke the whole key.

Specified by:

createRevocationCertificate in interface SecretKeyRingEditorInterface

Parameters:

secretKeyRingProtector - protector to unlock the primary key.

revocationAttributes - reason for the revocation

Returns:

revocation certificate

Throws:

org.bouncycastle.openpgp.PGPException

createRevocationCertificate

public org.bouncycastle.openpgp.PGPSignature createRevocationCertificate(long subkeyId,
                                                                         @Nonnull
                                                                         SecretKeyRingProtector secretKeyRingProtector,
                                                                         @Nullable
                                                                         RevocationAttributes revocationAttributes)
                                                                  throws org.bouncycastle.openpgp.PGPException

Description copied from interface: SecretKeyRingEditorInterface

Create a detached revocation certificate, which can be used to revoke the specified subkey.

Specified by:

createRevocationCertificate in interface SecretKeyRingEditorInterface

Parameters:

subkeyId - id of the subkey to be revoked

secretKeyRingProtector - protector to unlock the primary key.

revocationAttributes - reason for the revocation

Returns:

revocation certificate

Throws:

org.bouncycastle.openpgp.PGPException

createRevocationCertificate

public org.bouncycastle.openpgp.PGPSignature createRevocationCertificate(long subkeyId,
                                                                         @Nonnull
                                                                         SecretKeyRingProtector secretKeyRingProtector,
                                                                         @Nullable
                                                                         RevocationSignatureSubpackets.Callback certificateSubpacketsCallback)
                                                                  throws org.bouncycastle.openpgp.PGPException

Description copied from interface: SecretKeyRingEditorInterface

Create a detached revocation certificate, which can be used to revoke the specified subkey.

Specified by:

createRevocationCertificate in interface SecretKeyRingEditorInterface

Parameters:

subkeyId - id of the subkey to be revoked

secretKeyRingProtector - protector to unlock the primary key.

certificateSubpacketsCallback - callback to modify the subpackets of the revocation certificate.

Returns:

revocation certificate

Throws:

org.bouncycastle.openpgp.PGPException

revokeUserId

public SecretKeyRingEditorInterface revokeUserId(@Nonnull
                                                 CharSequence userId,
                                                 @Nonnull
                                                 SecretKeyRingProtector secretKeyRingProtector,
                                                 @Nullable
                                                 RevocationAttributes revocationAttributes)
                                          throws org.bouncycastle.openpgp.PGPException

Description copied from interface: SecretKeyRingEditorInterface

Revoke the given userID using the provided revocation attributes.

Specified by:

revokeUserId in interface SecretKeyRingEditorInterface

Parameters:

userId - userId to revoke

secretKeyRingProtector - protector to unlock the primary key

revocationAttributes - reason for the revocation

Returns:

the builder

Throws:

org.bouncycastle.openpgp.PGPException

revokeUserId

public SecretKeyRingEditorInterface revokeUserId(@Nonnull
                                                 CharSequence userId,
                                                 @Nonnull
                                                 SecretKeyRingProtector secretKeyRingProtector,
                                                 @Nullable
                                                 RevocationSignatureSubpackets.Callback subpacketCallback)
                                          throws org.bouncycastle.openpgp.PGPException

Description copied from interface: SecretKeyRingEditorInterface

Revoke the provided user-id. Note: If you don't provide a RevocationSignatureSubpackets.Callback which sets a revocation reason (RevocationAttributes), the revocation might be considered hard. So if you intend to re-certify the user-id at a later point to make it valid again, make sure to set a soft revocation reason in the signatures hashed area using the subpacket callback.

Specified by:

revokeUserId in interface SecretKeyRingEditorInterface

Parameters:

userId - userid to be revoked

secretKeyRingProtector - protector to unlock the primary secret key

subpacketCallback - callback to modify the revocations subpackets

Returns:

builder

Throws:

org.bouncycastle.openpgp.PGPException

revokeUserIds

public SecretKeyRingEditorInterface revokeUserIds(@Nonnull
                                                  SelectUserId userIdSelector,
                                                  @Nonnull
                                                  SecretKeyRingProtector secretKeyRingProtector,
                                                  @Nullable
                                                  RevocationAttributes revocationAttributes)
                                           throws org.bouncycastle.openpgp.PGPException

Description copied from interface: SecretKeyRingEditorInterface

Revoke all user-ids that match the provided SelectUserId filter. The provided RevocationAttributes will be set as reason for revocation in each revocation signature. Note: If you intend to re-certify these user-ids at a later point, make sure to choose a soft revocation reason. See RevocationAttributes.Reason for more information.

Specified by:

revokeUserIds in interface SecretKeyRingEditorInterface

Parameters:

userIdSelector - user-id selector

secretKeyRingProtector - protector to unlock the primary secret key

revocationAttributes - revocation attributes

Returns:

builder

Throws:

org.bouncycastle.openpgp.PGPException

revokeUserIds

public SecretKeyRingEditorInterface revokeUserIds(@Nonnull
                                                  SelectUserId userIdSelector,
                                                  @Nonnull
                                                  SecretKeyRingProtector secretKeyRingProtector,
                                                  @Nullable
                                                  RevocationSignatureSubpackets.Callback subpacketsCallback)
                                           throws org.bouncycastle.openpgp.PGPException

Description copied from interface: SecretKeyRingEditorInterface

Revoke all user-ids that match the provided SelectUserId filter. The provided RevocationSignatureSubpackets.Callback will be used to modify the revocation signatures subpackets. Note: If you intend to re-certify these user-ids at a later point, make sure to set a soft revocation reason in the revocation signatures hashed subpacket area using the callback. See RevocationAttributes.Reason for more information.

Specified by:

revokeUserIds in interface SecretKeyRingEditorInterface

Parameters:

userIdSelector - user-id selector

secretKeyRingProtector - protector to unlock the primary secret key

subpacketsCallback - callback to modify the revocations subpackets

Returns:

builder

Throws:

org.bouncycastle.openpgp.PGPException

setExpirationDate

public SecretKeyRingEditorInterface setExpirationDate(@Nullable
                                                      Date expiration,
                                                      @Nonnull
                                                      SecretKeyRingProtector secretKeyRingProtector)
                                               throws org.bouncycastle.openpgp.PGPException

Description copied from interface: SecretKeyRingEditorInterface

Set the expiration date for the primary key of the key ring. If the key is supposed to never expire, then an expiration date of null is expected.

Specified by:

setExpirationDate in interface SecretKeyRingEditorInterface

Parameters:

expiration - new expiration date or null

secretKeyRingProtector - to unlock the secret key

Returns:

the builder

Throws:

org.bouncycastle.openpgp.PGPException

changePassphraseFromOldPassphrase

public SecretKeyRingEditorInterface.WithKeyRingEncryptionSettings changePassphraseFromOldPassphrase(@Nullable
                                                                                                    Passphrase oldPassphrase,
                                                                                                    @Nonnull
                                                                                                    KeyRingProtectionSettings oldProtectionSettings)

Description copied from interface: SecretKeyRingEditorInterface

Change the passphrase of the whole key ring.

Specified by:

changePassphraseFromOldPassphrase in interface SecretKeyRingEditorInterface

Parameters:

oldPassphrase - old passphrase or null, if the key was unprotected

oldProtectionSettings - custom settings for the old passphrase

Returns:

next builder step

changeSubKeyPassphraseFromOldPassphrase

public SecretKeyRingEditorInterface.WithKeyRingEncryptionSettings changeSubKeyPassphraseFromOldPassphrase(@Nonnull
                                                                                                          Long keyId,
                                                                                                          @Nullable
                                                                                                          Passphrase oldPassphrase,
                                                                                                          @Nonnull
                                                                                                          KeyRingProtectionSettings oldProtectionSettings)

Specified by:

changeSubKeyPassphraseFromOldPassphrase in interface SecretKeyRingEditorInterface

done

public org.bouncycastle.openpgp.PGPSecretKeyRing done()

Description copied from interface: SecretKeyRingEditorInterface

Return the PGPSecretKeyRing.

Specified by:

done in interface SecretKeyRingEditorInterface

Returns:

the key