Uses of Interface
org.pgpainless.key.protection.SecretKeyRingProtector

Packages that use SecretKeyRingProtector

Package	Description
org.pgpainless.decryption_verification	Classes used to decryption and verification of OpenPGP encrypted / signed data.
org.pgpainless.encryption_signing	Classes used to encrypt or sign data using OpenPGP.
org.pgpainless.key.modification.secretkeyring	Classes that deal with modifications made to PGPSecretKeyRings.
org.pgpainless.key.protection	Classes related to OpenPGP secret key password protection.
org.pgpainless.key.protection.fixes	Secret Key Protection Fixes.
org.pgpainless.key.util	Utility functions to deal with OpenPGP keys.
org.pgpainless.signature.builder	Classes related to OpenPGP signatures.
org.pgpainless.signature.consumer	Classes related to OpenPGP signature verification.

Uses of SecretKeyRingProtector in org.pgpainless.decryption_verification

Methods in org.pgpainless.decryption_verification that return SecretKeyRingProtector

Modifier and Type	Method	Description
SecretKeyRingProtector	ConsumerOptions.getSecretKeyProtector(org.bouncycastle.openpgp.PGPSecretKeyRing decryptionKeyRing)

Methods in org.pgpainless.decryption_verification with parameters of type SecretKeyRingProtector

Modifier and Type	Method	Description
ConsumerOptions	ConsumerOptions.addDecryptionKey(org.bouncycastle.openpgp.PGPSecretKeyRing key, SecretKeyRingProtector keyRingProtector)	Add a key for message decryption.
ConsumerOptions	ConsumerOptions.addDecryptionKeys(org.bouncycastle.openpgp.PGPSecretKeyRingCollection keys, SecretKeyRingProtector keyRingProtector)	Add the keys in the provided key collection for message decryption.

Uses of SecretKeyRingProtector in org.pgpainless.encryption_signing

Methods in org.pgpainless.encryption_signing with parameters of type SecretKeyRingProtector

Modifier and Type	Method	Description
SigningOptions	SigningOptions.addDetachedSignature(SecretKeyRingProtector secretKeyDecryptor, org.bouncycastle.openpgp.PGPSecretKeyRing secretKey, String userId, DocumentSignatureType signatureType)	Create a detached signature.
SigningOptions	SigningOptions.addDetachedSignature(SecretKeyRingProtector secretKeyDecryptor, org.bouncycastle.openpgp.PGPSecretKeyRing secretKey, String userId, DocumentSignatureType signatureType, BaseSignatureSubpackets.Callback subpacketCallback)	Create a detached signature.
SigningOptions	SigningOptions.addDetachedSignature(SecretKeyRingProtector secretKeyDecryptor, org.bouncycastle.openpgp.PGPSecretKeyRing secretKey, DocumentSignatureType signatureType)	Create a detached signature.
SigningOptions	SigningOptions.addDetachedSignatures(SecretKeyRingProtector secretKeyDecryptor, Iterable<org.bouncycastle.openpgp.PGPSecretKeyRing> signingKeys, DocumentSignatureType signatureType)	Add detached signatures with all key rings from the provided secret key ring collection.
SigningOptions	SigningOptions.addInlineSignature(SecretKeyRingProtector secretKeyDecryptor, org.bouncycastle.openpgp.PGPSecretKeyRing secretKey, String userId, DocumentSignatureType signatureType)	Add an inline-signature.
SigningOptions	SigningOptions.addInlineSignature(SecretKeyRingProtector secretKeyDecryptor, org.bouncycastle.openpgp.PGPSecretKeyRing secretKey, String userId, DocumentSignatureType signatureType, BaseSignatureSubpackets.Callback subpacketsCallback)	Add an inline-signature.
SigningOptions	SigningOptions.addInlineSignature(SecretKeyRingProtector secretKeyDecryptor, org.bouncycastle.openpgp.PGPSecretKeyRing secretKey, DocumentSignatureType signatureType)	Add an inline-signature.
SigningOptions	SigningOptions.addInlineSignatures(SecretKeyRingProtector secrectKeyDecryptor, Iterable<org.bouncycastle.openpgp.PGPSecretKeyRing> signingKeys, DocumentSignatureType signatureType)	Add inline signatures with all secret key rings in the provided secret key ring collection.

Uses of SecretKeyRingProtector in org.pgpainless.key.modification.secretkeyring

Methods in org.pgpainless.key.modification.secretkeyring with parameters of type SecretKeyRingProtector

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

Uses of SecretKeyRingProtector in org.pgpainless.key.protection

Classes in org.pgpainless.key.protection that implement SecretKeyRingProtector

Modifier and Type	Class	Description
class	BaseSecretKeyRingProtector
class	CachingSecretKeyRingProtector	Implementation of the SecretKeyRingProtector which holds a map of key ids and their passwords.
class	PasswordBasedSecretKeyRingProtector	Provides PBESecretKeyDecryptor and PBESecretKeyEncryptor objects while getting the passphrases from a SecretKeyPassphraseProvider and using settings from an KeyRingProtectionSettings.
class	UnprotectedKeysProtector	Implementation of the SecretKeyRingProtector which assumes that all handled keys are not password protected.

Methods in org.pgpainless.key.protection that return SecretKeyRingProtector

Modifier and Type	Method	Description
static SecretKeyRingProtector	SecretKeyRingProtector.fromPassphraseMap(Map<Long,Passphrase> passphraseMap)	Use the provided map of key-ids and passphrases to unlock keys.
static SecretKeyRingProtector	SecretKeyRingProtector.unlockAllKeysWith(Passphrase passphrase, org.bouncycastle.openpgp.PGPSecretKeyRing keys)	Deprecated. use unlockEachKeyWith(Passphrase, PGPSecretKeyRing) instead.
static SecretKeyRingProtector	SecretKeyRingProtector.unlockAnyKeyWith(Passphrase passphrase)	Use the provided passphrase to unlock any key.
static SecretKeyRingProtector	SecretKeyRingProtector.unlockEachKeyWith(Passphrase passphrase, org.bouncycastle.openpgp.PGPSecretKeyRing keys)	Use the provided passphrase to lock/unlock all keys in the provided key ring.
static SecretKeyRingProtector	SecretKeyRingProtector.unlockSingleKeyWith(Passphrase passphrase, long keyId)
static SecretKeyRingProtector	SecretKeyRingProtector.unlockSingleKeyWith(Passphrase passphrase, org.bouncycastle.openpgp.PGPSecretKey key)	Use the provided passphrase to lock/unlock only the provided (sub-)key.
static SecretKeyRingProtector	SecretKeyRingProtector.unprotectedKeys()	Protector for unprotected keys.

Methods in org.pgpainless.key.protection with parameters of type SecretKeyRingProtector

Modifier and Type	Method	Description
static org.bouncycastle.openpgp.PGPPrivateKey	UnlockSecretKey.unlockSecretKey(org.bouncycastle.openpgp.PGPSecretKey secretKey, SecretKeyRingProtector protector)

Uses of SecretKeyRingProtector in org.pgpainless.key.protection.fixes

Methods in org.pgpainless.key.protection.fixes with parameters of type SecretKeyRingProtector

Modifier and Type	Method	Description
static org.bouncycastle.openpgp.PGPSecretKeyRing	S2KUsageFix.replaceUsageChecksumWithUsageSha1(org.bouncycastle.openpgp.PGPSecretKeyRing keys, SecretKeyRingProtector protector)	Repair method for keys which use S2K usage
static org.bouncycastle.openpgp.PGPSecretKeyRing	S2KUsageFix.replaceUsageChecksumWithUsageSha1(org.bouncycastle.openpgp.PGPSecretKeyRing keys, SecretKeyRingProtector protector, boolean skipKeysWithMissingPassphrase)	Repair method for keys which use S2K usage

Uses of SecretKeyRingProtector in org.pgpainless.key.util

Methods in org.pgpainless.key.util with parameters of type SecretKeyRingProtector

Modifier and Type	Method	Description
static org.bouncycastle.openpgp.PGPPrivateKey	KeyRingUtils.unlockSecretKey(org.bouncycastle.openpgp.PGPSecretKey secretKey, SecretKeyRingProtector protector)	Unlock a PGPSecretKey and return the resulting PGPPrivateKey.

Uses of SecretKeyRingProtector in org.pgpainless.signature.builder

Constructors in org.pgpainless.signature.builder with parameters of type SecretKeyRingProtector

Constructor	Description
AbstractSignatureBuilder(org.bouncycastle.openpgp.PGPSecretKey certificationKey, SecretKeyRingProtector protector, org.bouncycastle.openpgp.PGPSignature archetypeSignature)
AbstractSignatureBuilder(SignatureType signatureType, org.bouncycastle.openpgp.PGPSecretKey signingKey, SecretKeyRingProtector protector)
AbstractSignatureBuilder(SignatureType signatureType, org.bouncycastle.openpgp.PGPSecretKey signingKey, SecretKeyRingProtector protector, HashAlgorithm hashAlgorithm, SignatureSubpackets hashedSubpackets, SignatureSubpackets unhashedSubpackets)
DirectKeySignatureBuilder(org.bouncycastle.openpgp.PGPSecretKey signingKey, SecretKeyRingProtector protector)
DirectKeySignatureBuilder(org.bouncycastle.openpgp.PGPSecretKey certificationKey, SecretKeyRingProtector protector, org.bouncycastle.openpgp.PGPSignature archetypeSignature)
PrimaryKeyBindingSignatureBuilder(org.bouncycastle.openpgp.PGPSecretKey subkey, SecretKeyRingProtector subkeyProtector)
RevocationSignatureBuilder(SignatureType signatureType, org.bouncycastle.openpgp.PGPSecretKey signingKey, SecretKeyRingProtector protector)
SelfSignatureBuilder(org.bouncycastle.openpgp.PGPSecretKey signingKey, SecretKeyRingProtector protector)
SelfSignatureBuilder(org.bouncycastle.openpgp.PGPSecretKey primaryKey, SecretKeyRingProtector primaryKeyProtector, org.bouncycastle.openpgp.PGPSignature oldCertification)
SelfSignatureBuilder(SignatureType signatureType, org.bouncycastle.openpgp.PGPSecretKey signingKey, SecretKeyRingProtector protector)
SubkeyBindingSignatureBuilder(org.bouncycastle.openpgp.PGPSecretKey signingKey, SecretKeyRingProtector protector)
SubkeyBindingSignatureBuilder(org.bouncycastle.openpgp.PGPSecretKey signingKey, SecretKeyRingProtector protector, org.bouncycastle.openpgp.PGPSignature oldSubkeyBinding)
ThirdPartyCertificationSignatureBuilder(org.bouncycastle.openpgp.PGPSecretKey signingKey, SecretKeyRingProtector protector)	Create a new certification signature builder.
ThirdPartyCertificationSignatureBuilder(org.bouncycastle.openpgp.PGPSecretKey signingKey, SecretKeyRingProtector protector, org.bouncycastle.openpgp.PGPSignature archetypeSignature)	Create a new certification signature builder.
ThirdPartyCertificationSignatureBuilder(SignatureType signatureType, org.bouncycastle.openpgp.PGPSecretKey signingKey, SecretKeyRingProtector protector)	Create a new certification signature builder.
UniversalSignatureBuilder(org.bouncycastle.openpgp.PGPSecretKey certificationKey, SecretKeyRingProtector protector, org.bouncycastle.openpgp.PGPSignature archetypeSignature)
UniversalSignatureBuilder(SignatureType signatureType, org.bouncycastle.openpgp.PGPSecretKey signingKey, SecretKeyRingProtector protector)

Uses of SecretKeyRingProtector in org.pgpainless.signature.consumer

Methods in org.pgpainless.signature.consumer with parameters of type SecretKeyRingProtector

Modifier and Type	Method	Description
org.bouncycastle.openpgp.PGPSecretKeyRing	ProofUtil.addProof(org.bouncycastle.openpgp.PGPSecretKeyRing secretKey, SecretKeyRingProtector protector, String userId, ProofUtil.Proof proof)
org.bouncycastle.openpgp.PGPSecretKeyRing	ProofUtil.addProof(org.bouncycastle.openpgp.PGPSecretKeyRing secretKey, SecretKeyRingProtector protector, ProofUtil.Proof proof)
org.bouncycastle.openpgp.PGPSecretKeyRing	ProofUtil.addProofs(org.bouncycastle.openpgp.PGPSecretKeyRing secretKey, SecretKeyRingProtector protector, String userId, List<ProofUtil.Proof> proofs)
org.bouncycastle.openpgp.PGPSecretKeyRing	ProofUtil.addProofs(org.bouncycastle.openpgp.PGPSecretKeyRing secretKey, SecretKeyRingProtector protector, List<ProofUtil.Proof> proofs)