1
0
Fork 0
mirror of https://github.com/pgpainless/pgpainless.git synced 2024-12-23 03:17:58 +01:00

Add missing javadoc to CustomPublicKeyDataDecryptorFactory

This commit is contained in:
Paul Schaub 2023-01-04 18:55:57 +01:00
parent 41cc71c274
commit 980daeca31
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311

View file

@ -7,8 +7,21 @@ package org.pgpainless.decryption_verification;
import org.bouncycastle.openpgp.operator.PublicKeyDataDecryptorFactory; import org.bouncycastle.openpgp.operator.PublicKeyDataDecryptorFactory;
import org.pgpainless.key.SubkeyIdentifier; import org.pgpainless.key.SubkeyIdentifier;
/**
* Custom {@link PublicKeyDataDecryptorFactory} which can enable customized implementations of message decryption
* using public keys.
* This class can for example be used to implement message encryption using hardware tokens like smartcards or
* TPMs.
* @see ConsumerOptions#addCustomDecryptorFactory(CustomPublicKeyDataDecryptorFactory)
*/
public interface CustomPublicKeyDataDecryptorFactory extends PublicKeyDataDecryptorFactory { public interface CustomPublicKeyDataDecryptorFactory extends PublicKeyDataDecryptorFactory {
/**
* Return the {@link SubkeyIdentifier} for which this particular {@link CustomPublicKeyDataDecryptorFactory}
* is intended.
*
* @return subkey identifier
*/
SubkeyIdentifier getSubkeyIdentifier(); SubkeyIdentifier getSubkeyIdentifier();
} }