Class JceExternalPublicKeyDataDecryptorFactoryBuilder

java.lang.Object

org.bouncycastle.openpgp.api.operator.jcajce.JceExternalPublicKeyDataDecryptorFactoryBuilder

public abstract class JceExternalPublicKeyDataDecryptorFactoryBuilder
extends Object

Builder for a PublicKeyDataDecryptorFactory whose private key material is held outside the OpenPGP key - typically on a hardware token - as described by OpenPGP External Secret Keys and signalled by SecretKeyPacket.USAGE_EXTERNAL. This is the JCA/JCE analogue of BcExternalPublicKeyDataDecryptorFactory.

All session-key recovery logic (packet parsing, length checks, the RFC 6637 / RFC 9580 KDF and key unwrap sequencing) is inherited from AbstractExternalPublicKeyDataDecryptorFactory, with the cryptographic primitives bound to the configured JCA provider; a subclass supplies only the raw private-key operation by implementing build(OpenPGPKey.OpenPGPSecretKey) with a JceExternalPublicKeyDataDecryptorFactoryBuilder.PublicKeyCryptoCallback, which receives the sender's ephemeral key as a JCA PublicKey built through the configured provider.

Note that a secret key handled through this builder need not actually be external: if the supplied key carries usable software key material, the factory built delegates to JcePublicKeyDataDecryptorFactoryBuilder so the (much cheaper) in-process path is used instead.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JceExternalPublicKeyDataDecryptorFactoryBuilder.PublicKeyCryptoCallback	Callback isolating the raw public-key operations performed while recovering an OpenPGP session key.

Constructor Summary

Constructors

Constructor	Description
JceExternalPublicKeyDataDecryptorFactoryBuilder()

Method Summary

Modifier and Type	Method	Description
abstract PublicKeyDataDecryptorFactory	build(OpenPGPKey.OpenPGPSecretKey secretKey)	Build a decryptor factory for the given secret key, routing the raw private-key operation to wherever the key material is actually held.
protected PublicKeyDataDecryptorFactory	build(PGPKeyPair keyPair, JceExternalPublicKeyDataDecryptorFactoryBuilder.PublicKeyCryptoCallback cryptoCallback)
JceExternalPublicKeyDataDecryptorFactoryBuilder	setContentProvider(String providerName)
JceExternalPublicKeyDataDecryptorFactoryBuilder	setContentProvider(Provider provider)
JceExternalPublicKeyDataDecryptorFactoryBuilder	setProvider(String providerName)	Set the provider name to use for creating cryptographic primitives in the resulting factory the builder produces.
JceExternalPublicKeyDataDecryptorFactoryBuilder	setProvider(Provider provider)	Set the provider object to use for creating cryptographic primitives in the resulting factory the builder produces.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JceExternalPublicKeyDataDecryptorFactoryBuilder

public JceExternalPublicKeyDataDecryptorFactoryBuilder()

Method Details

setProvider

public JceExternalPublicKeyDataDecryptorFactoryBuilder setProvider(Provider provider)

Set the provider object to use for creating cryptographic primitives in the resulting factory the builder produces.

Parameters:

provider - provider object for cryptographic primitives.

Returns:

the current builder.

setProvider

public JceExternalPublicKeyDataDecryptorFactoryBuilder setProvider(String providerName)

Set the provider name to use for creating cryptographic primitives in the resulting factory the builder produces.

Parameters:

providerName - the name of the provider to reference for cryptographic primitives.

Returns:

the current builder.

setContentProvider

public JceExternalPublicKeyDataDecryptorFactoryBuilder setContentProvider(Provider provider)

setContentProvider

public JceExternalPublicKeyDataDecryptorFactoryBuilder setContentProvider(String providerName)

build

public abstract PublicKeyDataDecryptorFactory build(OpenPGPKey.OpenPGPSecretKey secretKey)
                                             throws PGPException

Build a decryptor factory for the given secret key, routing the raw private-key operation to wherever the key material is actually held.

Parameters:

secretKey - the (typically external) OpenPGP secret key

Returns:

decryptor factory

Throws:

PGPException - if the key cannot be unlocked

build

protected PublicKeyDataDecryptorFactory build(PGPKeyPair keyPair,
 JceExternalPublicKeyDataDecryptorFactoryBuilder.PublicKeyCryptoCallback cryptoCallback)
                                       throws PGPException

Throws:

PGPException