Class HpkeContext

java.lang.Object

org.conscrypt.HpkeContext

Direct Known Subclasses:

HpkeContextRecipient, HpkeContextSender

public abstract class HpkeContext
extends Object

Hybrid Public Key Encryption (HPKE) sender APIs.

Base class for HPKE sender and recipient contexts.

This is the client API for HPKE usage, all operations are delegated to an implementation class implementing HpkeSpi which is located using the JCA Provider mechanism.

The implementation maintains the context for an HPKE exchange, including the key schedule to use for seal and open operations. Secret key material based on the context may also be generated and exported as per RFC 9180.

See Also:

• RFC 9180 (HPKE)

Field Summary

Fields

Modifier and Type	Field	Description
protected final HpkeSpi	spi

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HpkeContext(HpkeSpi spi)

Method Summary

Modifier and Type	Method	Description
byte[]	export(int length, byte[] context)	Exports secret key material from this HpkeContext as described in RFC 9180.
private static Provider	findFirstProvider(String algorithm)
protected static HpkeSpi	findSpi(String algorithm)
protected static HpkeSpi	findSpi(String algorithm, String providerName)
protected static HpkeSpi	findSpi(String algorithm, Provider provider)
HpkeSpi	getSpi()	Returns the HpkeSpi being used by this HpkeContext.

Methods inherited from class Object

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

Field Details

spi

protected final HpkeSpi spi

Constructor Details

HpkeContext

protected HpkeContext(HpkeSpi spi)

Method Details

export

public byte[] export(int length,
 byte[] context)

Exports secret key material from this HpkeContext as described in RFC 9180.

Parameters:

length - expected output length

context - optional context string, may be null or empty

Returns:

exported value

Throws:

IllegalArgumentException - if the length is not valid for the KDF in use

IllegalStateException - if this HpkeContext has not been initialised

getSpi

public HpkeSpi getSpi()

Returns the HpkeSpi being used by this HpkeContext.

Returns:

the SPI

findSpi

protected static HpkeSpi findSpi(String algorithm)
                          throws NoSuchAlgorithmException

Throws:

NoSuchAlgorithmException

findFirstProvider

private static Provider findFirstProvider(String algorithm)
                                   throws NoSuchAlgorithmException

Throws:

NoSuchAlgorithmException

findSpi

protected static HpkeSpi findSpi(String algorithm,
 String providerName)
                          throws NoSuchAlgorithmException,
IllegalArgumentException,
NoSuchProviderException

Throws:

NoSuchAlgorithmException

IllegalArgumentException

NoSuchProviderException

findSpi

protected static HpkeSpi findSpi(String algorithm,
 Provider provider)
                          throws NoSuchAlgorithmException,
IllegalArgumentException

Throws:

NoSuchAlgorithmException

IllegalArgumentException