Package org.pgpainless.encryption_signing

Interface EncryptionBuilderInterface.SignWith

All Known Subinterfaces:

EncryptionBuilderInterface.SignWithOrDontSign, EncryptionBuilderInterface.ToRecipientsOrSign

Enclosing interface:

EncryptionBuilderInterface

public static interface EncryptionBuilderInterface.SignWith

Method Summary

Modifier and Type	Method	Description
default EncryptionBuilderInterface.AdditionalSignWith	signDetachedWith(SecretKeyRingProtector secretKeyDecryptor, org.bouncycastle.openpgp.PGPSecretKeyRing signingKey)	Create a detached signature using the provided secret key.
default EncryptionBuilderInterface.AdditionalSignWith	signDetachedWith(SecretKeyRingProtector secretKeyDecryptor, org.bouncycastle.openpgp.PGPSecretKeyRing signingKey, java.lang.String userId)	Create a detached signature using the provided secret key with the algorithm preferences of the provided user-id.
EncryptionBuilderInterface.AdditionalSignWith	signDetachedWith(SecretKeyRingProtector secretKeyDecryptor, org.bouncycastle.openpgp.PGPSecretKeyRing signingKey, java.lang.String userId, DocumentSignatureType signatureType)	Create a detached signature using the provided secret key with the algorithm preferences of the provided user-id.
default EncryptionBuilderInterface.AdditionalSignWith	signInlineWith(SecretKeyRingProtector secretKeyDecryptor, org.bouncycastle.openpgp.PGPSecretKeyRing signingKey)	Create an inline signature using the provided secret key.
default EncryptionBuilderInterface.AdditionalSignWith	signInlineWith(SecretKeyRingProtector secretKeyDecryptor, org.bouncycastle.openpgp.PGPSecretKeyRing signingKey, java.lang.String userId)	Create an inline signature using the provided secret key.
EncryptionBuilderInterface.AdditionalSignWith	signInlineWith(SecretKeyRingProtector secretKeyDecryptor, org.bouncycastle.openpgp.PGPSecretKeyRing signingKey, java.lang.String userId, DocumentSignatureType signatureType)	Create an inline signature using the provided secret key with the algorithm preferences of the provided user-id.
EncryptionBuilderInterface.AdditionalSignWith	signWith(SecretKeyRingProtector decryptor, org.bouncycastle.openpgp.PGPSecretKeyRing... keyRings)	Deprecated. use signInlineWith(SecretKeyRingProtector, PGPSecretKeyRing) instead.
EncryptionBuilderInterface.AdditionalSignWith	signWith(SecretKeyRingProtector decryptor, org.bouncycastle.openpgp.PGPSecretKeyRingCollection keyRings)	Deprecated. use signInlineWith(SecretKeyRingProtector, PGPSecretKeyRing) instead.

Method Detail

signWith

@Deprecated
EncryptionBuilderInterface.AdditionalSignWith signWith(@Nonnull
                                                       SecretKeyRingProtector decryptor,
                                                       @Nonnull
                                                       org.bouncycastle.openpgp.PGPSecretKeyRing... keyRings)
                                                throws KeyValidationException,
                                                       org.bouncycastle.openpgp.PGPException

Deprecated.

use signInlineWith(SecretKeyRingProtector, PGPSecretKeyRing) instead.

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

Throws:

KeyValidationException

org.bouncycastle.openpgp.PGPException

signWith

@Deprecated
EncryptionBuilderInterface.AdditionalSignWith signWith(@Nonnull
                                                       SecretKeyRingProtector decryptor,
                                                       @Nonnull
                                                       org.bouncycastle.openpgp.PGPSecretKeyRingCollection keyRings)
                                                throws KeyValidationException,
                                                       org.bouncycastle.openpgp.PGPException

Deprecated.

use signInlineWith(SecretKeyRingProtector, PGPSecretKeyRing) instead.

Sign inline using the passed in secret keys.

Parameters:

decryptor - for unlocking the secret keys

keyRings - secret keys

Returns:

api handle

Throws:

KeyValidationException

org.bouncycastle.openpgp.PGPException

signInlineWith

default EncryptionBuilderInterface.AdditionalSignWith signInlineWith(@Nonnull
                                                                     SecretKeyRingProtector secretKeyDecryptor,
                                                                     @Nonnull
                                                                     org.bouncycastle.openpgp.PGPSecretKeyRing signingKey)
                                                              throws org.bouncycastle.openpgp.PGPException,
                                                                     KeyValidationException

Create an inline signature using the provided secret key. The signature will be of type DocumentSignatureType.BINARY_DOCUMENT.

Parameters:

secretKeyDecryptor - for unlocking the secret key

signingKey - signing key

Returns:

api handle

Throws:

org.bouncycastle.openpgp.PGPException

KeyValidationException

signInlineWith

default EncryptionBuilderInterface.AdditionalSignWith signInlineWith(@Nonnull
                                                                     SecretKeyRingProtector secretKeyDecryptor,
                                                                     @Nonnull
                                                                     org.bouncycastle.openpgp.PGPSecretKeyRing signingKey,
                                                                     java.lang.String userId)
                                                              throws org.bouncycastle.openpgp.PGPException,
                                                                     KeyValidationException

Create an inline signature using the provided secret key. If userId is not null, the preferences of the matching user-id on the key will be used for signing. The signature will be of type DocumentSignatureType.BINARY_DOCUMENT.

Parameters:

secretKeyDecryptor - for unlocking the secret key

signingKey - signing key

userId - userId whose preferences shall be used for signing

Returns:

api handle

Throws:

org.bouncycastle.openpgp.PGPException

KeyValidationException

signInlineWith

EncryptionBuilderInterface.AdditionalSignWith signInlineWith(@Nonnull
                                                             SecretKeyRingProtector secretKeyDecryptor,
                                                             @Nonnull
                                                             org.bouncycastle.openpgp.PGPSecretKeyRing signingKey,
                                                             java.lang.String userId,
                                                             DocumentSignatureType signatureType)
                                                      throws KeyValidationException,
                                                             org.bouncycastle.openpgp.PGPException

Create an inline signature using the provided secret key with the algorithm preferences of the provided user-id.

Parameters:

secretKeyDecryptor - for unlocking the secret key

signingKey - signing key

userId - user-id whose preferences shall be used for signing

signatureType - signature type

Returns:

api handle

Throws:

KeyValidationException

org.bouncycastle.openpgp.PGPException

signDetachedWith

default EncryptionBuilderInterface.AdditionalSignWith signDetachedWith(@Nonnull
                                                                       SecretKeyRingProtector secretKeyDecryptor,
                                                                       @Nonnull
                                                                       org.bouncycastle.openpgp.PGPSecretKeyRing signingKey)
                                                                throws org.bouncycastle.openpgp.PGPException,
                                                                       KeyValidationException

Create a detached signature using the provided secret key.

Parameters:

secretKeyDecryptor - for unlocking the secret key

signingKey - signing key

Returns:

api handle

Throws:

org.bouncycastle.openpgp.PGPException

KeyValidationException

signDetachedWith

default EncryptionBuilderInterface.AdditionalSignWith signDetachedWith(@Nonnull
                                                                       SecretKeyRingProtector secretKeyDecryptor,
                                                                       @Nonnull
                                                                       org.bouncycastle.openpgp.PGPSecretKeyRing signingKey,
                                                                       java.lang.String userId)
                                                                throws org.bouncycastle.openpgp.PGPException,
                                                                       KeyValidationException

Create a detached signature using the provided secret key with the algorithm preferences of the provided user-id.

Parameters:

secretKeyDecryptor - for unlocking the secret key

signingKey - signing key

userId - user-id whose preferences shall be used for signing

Returns:

api handle

Throws:

org.bouncycastle.openpgp.PGPException

KeyValidationException

signDetachedWith

EncryptionBuilderInterface.AdditionalSignWith signDetachedWith(@Nonnull
                                                               SecretKeyRingProtector secretKeyDecryptor,
                                                               @Nonnull
                                                               org.bouncycastle.openpgp.PGPSecretKeyRing signingKey,
                                                               java.lang.String userId,
                                                               DocumentSignatureType signatureType)
                                                        throws org.bouncycastle.openpgp.PGPException,
                                                               KeyValidationException

Create a detached signature using the provided secret key with the algorithm preferences of the provided user-id.

Parameters:

secretKeyDecryptor - for unlocking the secret key

signingKey - signing key

userId - user-id whose preferences shall be used for signing

signatureType - type of the signature

Returns:

api handle

Throws:

org.bouncycastle.openpgp.PGPException

KeyValidationException