Package org.pgpainless.decryption_verification

Interface DecryptionBuilderInterface.DecryptWith

Enclosing interface:

DecryptionBuilderInterface

public static interface DecryptionBuilderInterface.DecryptWith

Method Summary

Modifier and Type	Method	Description
default DecryptionBuilderInterface.Verify	decryptWith(org.bouncycastle.openpgp.PGPSecretKeyRingCollection secretKeyRings)	Decrypt the encrypted data using the secret keys found in the provided PGPSecretKeyRingCollection.
DecryptionBuilderInterface.Verify	decryptWith(SecretKeyRingProtector decryptor, org.bouncycastle.openpgp.PGPSecretKeyRing secretKeyRing)	Decrypt the encrypted data using the provided PGPSecretKeyRing.
DecryptionBuilderInterface.Verify	decryptWith(SecretKeyRingProtector decryptor, org.bouncycastle.openpgp.PGPSecretKeyRingCollection secretKeyRings)	Decrypt the encrypted data using the secret keys found in the provided PGPSecretKeyRingCollection.
DecryptionBuilderInterface.Verify	decryptWith(Passphrase passphrase)	Decrypt the encrypted data using a passphrase.
DecryptionBuilderInterface.Verify	doNotDecrypt()	Do not attempt to decrypt the provided data.

Method Detail

decryptWith

default DecryptionBuilderInterface.Verify decryptWith(@Nonnull
                                                      org.bouncycastle.openpgp.PGPSecretKeyRingCollection secretKeyRings)

Decrypt the encrypted data using the secret keys found in the provided PGPSecretKeyRingCollection. Here it is assumed that the secret keys are not password protected. For password protected secret keys use decryptWith(SecretKeyRingProtector, PGPSecretKeyRingCollection) and pass in a PasswordBasedSecretKeyRingProtector.

Parameters:

secretKeyRings - secret keys

Returns:

api handle

decryptWith

DecryptionBuilderInterface.Verify decryptWith(@Nonnull
                                              SecretKeyRingProtector decryptor,
                                              @Nonnull
                                              org.bouncycastle.openpgp.PGPSecretKeyRingCollection secretKeyRings)

Decrypt the encrypted data using the secret keys found in the provided PGPSecretKeyRingCollection. The secret keys are being unlocked by the provided SecretKeyRingProtector.

Parameters:

decryptor - for unlocking locked secret keys

secretKeyRings - secret keys

Returns:

api handle

decryptWith

DecryptionBuilderInterface.Verify decryptWith(@Nonnull
                                              SecretKeyRingProtector decryptor,
                                              @Nonnull
                                              org.bouncycastle.openpgp.PGPSecretKeyRing secretKeyRing)
                                       throws org.bouncycastle.openpgp.PGPException,
                                              java.io.IOException

Decrypt the encrypted data using the provided PGPSecretKeyRing. The secret key is unlocked by the provided SecretKeyRingProtector.

Parameters:

decryptor - for unlocking locked secret key

secretKeyRing - secret key

Returns:

api handle

Throws:

org.bouncycastle.openpgp.PGPException

java.io.IOException

decryptWith

DecryptionBuilderInterface.Verify decryptWith(@Nonnull
                                              Passphrase passphrase)

Decrypt the encrypted data using a passphrase. Note: The passphrase MUST NOT be empty.

Parameters:

passphrase - passphrase

Returns:

api handle

doNotDecrypt

DecryptionBuilderInterface.Verify doNotDecrypt()

Do not attempt to decrypt the provided data. Useful for signature verification of signed-only data.

Returns:

api handle