Package org.pgpainless.encryption_signing

Interface EncryptionBuilderInterface.SignWith

All Known Subinterfaces:

EncryptionBuilderInterface.DetachedSign

Enclosing interface:

EncryptionBuilderInterface

public static interface EncryptionBuilderInterface.SignWith

Method Summary

Modifier and Type	Method	Description
default EncryptionBuilderInterface.DocumentType	signWith(org.bouncycastle.openpgp.PGPSecretKey... keys)	Pass in a list of secret keys used for signing.
EncryptionBuilderInterface.DocumentType	signWith(SecretKeyRingProtector decryptor, org.bouncycastle.openpgp.PGPSecretKey... keys)	Pass in a list of secret keys used for signing, along with a SecretKeyRingProtector used to unlock the secret keys.
EncryptionBuilderInterface.DocumentType	signWith(SecretKeyRingProtector decryptor, org.bouncycastle.openpgp.PGPSecretKeyRing... keyRings)	Pass in a list of secret keys used for signing, along with a SecretKeyRingProtector used to unlock the secret keys.
<O> EncryptionBuilderInterface.DocumentType	signWith(SecretKeyRingSelectionStrategy<O> selectionStrategy, SecretKeyRingProtector decryptor, MultiMap<O,org.bouncycastle.openpgp.PGPSecretKeyRingCollection> keys)	Pass in a map of secret keys for signing, as well as a SecretKeySelectionStrategy that is used to determine suitable secret keys.

Method Detail

signWith

default EncryptionBuilderInterface.DocumentType signWith(@Nonnull
                                                         org.bouncycastle.openpgp.PGPSecretKey... keys)

Pass in a list of secret keys used for signing. Those keys are considered unlocked (ie. not password protected). If you need to use password protected keys instead, use signWith(SecretKeyRingProtector, PGPSecretKey...).

Parameters:

keys - secret keys

Returns:

api handle

signWith

EncryptionBuilderInterface.DocumentType signWith(@Nonnull
                                                 SecretKeyRingProtector decryptor,
                                                 @Nonnull
                                                 org.bouncycastle.openpgp.PGPSecretKey... keys)

Pass in a list of secret keys used for signing, along with a SecretKeyRingProtector used to unlock the secret keys.

Parameters:

decryptor - SecretKeyRingProtector used to unlock the secret keys

keys - secret keys used for signing

Returns:

api handle

signWith

EncryptionBuilderInterface.DocumentType signWith(@Nonnull
                                                 SecretKeyRingProtector decryptor,
                                                 @Nonnull
                                                 org.bouncycastle.openpgp.PGPSecretKeyRing... keyRings)

Pass in a list of secret keys used for signing, along with a SecretKeyRingProtector used to unlock the secret keys.

Parameters:

decryptor - SecretKeyRingProtector used to unlock the secret keys

keyRings - secret keys used for signing

Returns:

api handle

signWith

<O> EncryptionBuilderInterface.DocumentType signWith(@Nonnull
                                                     SecretKeyRingSelectionStrategy<O> selectionStrategy,
                                                     @Nonnull
                                                     SecretKeyRingProtector decryptor,
                                                     @Nonnull
                                                     MultiMap<O,org.bouncycastle.openpgp.PGPSecretKeyRingCollection> keys)
                                              throws SecretKeyNotFoundException

Pass in a map of secret keys for signing, as well as a SecretKeySelectionStrategy that is used to determine suitable secret keys. If the keys are locked by a password, the provided SecretKeyRingProtector will be used to unlock the keys.

Type Parameters:

O - selection criteria type (eg. email address)

Parameters:

selectionStrategy - key selection strategy

decryptor - decryptor for unlocking secret keys

keys - secret keys

Returns:

api handle

Throws:

SecretKeyNotFoundException - in case no suitable secret key can be found