Package org.pgpainless.key.protection

Interface SecretKeyRingProtector

All Known Subinterfaces:

SecretKeyRingProtectorAdapter

All Known Implementing Classes:

PassphraseMapKeyRingProtector, PasswordBasedSecretKeyRingProtector, UnprotectedKeysProtector

public interface SecretKeyRingProtector

Interface that is used to provide secret key ring encryptors and decryptors.

Method Summary

Modifier and Type	Method	Description
static SecretKeyRingProtector	fromPassphraseMap(java.util.Map<java.lang.Long,Passphrase> passphraseMap)
org.bouncycastle.openpgp.operator.PBESecretKeyDecryptor	getDecryptor(java.lang.Long keyId)	Return a decryptor for the key of id keyId.
org.bouncycastle.openpgp.operator.PBESecretKeyEncryptor	getEncryptor(java.lang.Long keyId)	Return an encryptor for the key of id keyId.
static SecretKeyRingProtector	unlockAllKeysWith(Passphrase passphrase, org.bouncycastle.openpgp.PGPSecretKeyRing keys)
static SecretKeyRingProtector	unlockSingleKeyWith(Passphrase passphrase, org.bouncycastle.openpgp.PGPSecretKey key)
static SecretKeyRingProtector	unprotectedKeys()

Method Detail

getDecryptor

@Nullable
org.bouncycastle.openpgp.operator.PBESecretKeyDecryptor getDecryptor(java.lang.Long keyId)
                                                              throws org.bouncycastle.openpgp.PGPException

Return a decryptor for the key of id keyId. This method returns null if the key is unprotected.

Parameters:

keyId - id of the key

Returns:

decryptor for the key

Throws:

org.bouncycastle.openpgp.PGPException

getEncryptor

@Nullable
org.bouncycastle.openpgp.operator.PBESecretKeyEncryptor getEncryptor(java.lang.Long keyId)
                                                              throws org.bouncycastle.openpgp.PGPException

Return an encryptor for the key of id keyId. This method returns null if the key is unprotected.

Parameters:

keyId - id of the key

Returns:

encryptor for the key

Throws:

org.bouncycastle.openpgp.PGPException - if the encryptor cannot be created for some reason

unlockAllKeysWith

static SecretKeyRingProtector unlockAllKeysWith(Passphrase passphrase,
                                                org.bouncycastle.openpgp.PGPSecretKeyRing keys)

unlockSingleKeyWith

static SecretKeyRingProtector unlockSingleKeyWith(Passphrase passphrase,
                                                  org.bouncycastle.openpgp.PGPSecretKey key)

unprotectedKeys

static SecretKeyRingProtector unprotectedKeys()

fromPassphraseMap

static SecretKeyRingProtector fromPassphraseMap(java.util.Map<java.lang.Long,Passphrase> passphraseMap)