Package org.conscrypt

Class HpkeImpl

java.lang.Object

org.conscrypt.HpkeImpl

All Implemented Interfaces:

HpkeSpi

Direct Known Subclasses:

HpkeImpl.HpkeMlKemImpl, HpkeImpl.HpkeX25519Impl, HpkeImpl.HpkeXwingImpl

@Internal
public abstract class HpkeImpl
extends java.lang.Object
implements HpkeSpi

Implementation of HpkeSpi. Should not be used directly, but rather by one of the subclasses of HpkeContext.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	HpkeImpl.HpkeMlKemImpl
private static class	HpkeImpl.HpkeX25519Impl
private static class	HpkeImpl.HpkeXwingImpl
static class	HpkeImpl.MlKem1024HkdfSha256Aes128Gcm	Implementation of MLKEM_1024/HKDF_SHA256/AES_128_GCM.
static class	HpkeImpl.MlKem1024HkdfSha256Aes256Gcm	Implementation of MLKEM_1024/HKDF_SHA256/AES_256_GCM.
static class	HpkeImpl.MlKem1024HkdfSha256ChaCha20Poly1305	Implementation of MLKEM_1024/HKDF_SHA256/CHACHA20_POLY1305.
static class	HpkeImpl.MlKem768HkdfSha256Aes128Gcm	Implementation of MLKEM_768/HKDF_SHA256/AES_128_GCM.
static class	HpkeImpl.MlKem768HkdfSha256Aes256Gcm	Implementation of MLKEM_768/HKDF_SHA256/AES_256_GCM.
static class	HpkeImpl.MlKem768HkdfSha256ChaCha20Poly1305	Implementation of MLKEM_768/HKDF_SHA256/CHACHA20_POLY1305.
static class	HpkeImpl.X25519_AES_128	Implementation of X25519/HKDF_SHA256/AES_128_GCM.
static class	HpkeImpl.X25519_AES_256	Implementation of X25519/HKDF_SHA256/AES_256_GCM.
static class	HpkeImpl.X25519_CHACHA20	Implementation of X25519/HKDF_SHA256/CHACHA20_POLY1305.
static class	HpkeImpl.XwingHkdfSha256Aes128Gcm	Implementation of XWING/HKDF_SHA256/AES_128_GCM.
static class	HpkeImpl.XwingHkdfSha256Aes256Gcm	Implementation of XWING/HKDF_SHA256/AES_256_GCM.
static class	HpkeImpl.XwingHkdfSha256ChaCha20Poly1305	Implementation of XWING/HKDF_SHA256/CHACHA20_POLY1305.

Field Summary

Fields

Modifier and Type	Field	Description
private NativeRef.EVP_HPKE_CTX	ctx
private byte[]	encapsulated
private HpkeSuite	hpkeSuite
private static OpenSslXwingKeyFactory	xwingKeyFactory

Fields inherited from interface org.conscrypt.HpkeSpi

DEFAULT_PSK, DEFAULT_PSK_ID

Constructor Summary

Constructors

Constructor	Description
HpkeImpl(HpkeSuite hpkeSuite)

Method Summary

Modifier and Type	Method	Description
private void	checkArgumentsForBaseModeOnly(java.security.Key senderKey, byte[] psk, byte[] psk_id)
private void	checkInitialised()
private void	checkIsRecipient()
private void	checkIsSender()
private void	checkNotInitialised()
byte[]	engineExport(int length, byte[] exporterContext)	Exports secret key material from this SPI as described in RFC 9180.
void	engineInitRecipient(byte[] encapsulated, java.security.PrivateKey recipientKey, byte[] info, java.security.PublicKey senderKey, byte[] psk, byte[] psk_id)	Initialises an HPKE recipient SPI.
void	engineInitSender(java.security.PublicKey recipientKey, byte[] info, java.security.PrivateKey senderKey, byte[] psk, byte[] psk_id)	Initialises an HPKE sender SPI.
void	engineInitSenderForTesting(java.security.PublicKey recipientKey, byte[] info, java.security.PrivateKey senderKey, byte[] psk, byte[] psk_id, byte[] sKe)	Initialises an HPKE sender SPI.
byte[]	engineOpen(byte[] ciphertext, byte[] aad)	Opens a message, using the internal key schedule maintained by an HPKE recipient.
byte[]	engineSeal(byte[] plaintext, byte[] aad)	Seals a message, using the internal key schedule maintained by an HPKE sender.
byte[]	getEncapsulated()	Returns the encapsulated key material for an HPKE sender.
(package private) abstract byte[]	getPrivateRecipientKeyBytes(java.security.PrivateKey recipientKey)
(package private) abstract byte[]	getRecipientPublicKeyBytes(java.security.PublicKey recipientKey)

Methods inherited from class java.lang.Object

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

Field Detail

hpkeSuite

private final HpkeSuite hpkeSuite

ctx

private NativeRef.EVP_HPKE_CTX ctx

encapsulated

private byte[] encapsulated

xwingKeyFactory

private static final OpenSslXwingKeyFactory xwingKeyFactory

Constructor Detail

HpkeImpl

public HpkeImpl(HpkeSuite hpkeSuite)

Method Detail

getRecipientPublicKeyBytes

abstract byte[] getRecipientPublicKeyBytes(java.security.PublicKey recipientKey)
                                    throws java.security.InvalidKeyException

Throws:

java.security.InvalidKeyException

engineInitSender

public void engineInitSender(java.security.PublicKey recipientKey,
                             byte[] info,
                             java.security.PrivateKey senderKey,
                             byte[] psk,
                             byte[] psk_id)
                      throws java.security.InvalidKeyException

Description copied from interface: HpkeSpi

Initialises an HPKE sender SPI.

Specified by:

engineInitSender in interface HpkeSpi

Parameters:

recipientKey - public key of the recipient

info - application-supplied information, may be null or empty

senderKey - private key of the sender, for symmetric auth modes only, else null

psk - pre-shared key, for PSK auth modes only, else null

psk_id - pre-shared key ID, for PSK auth modes only, else null

Throws:

java.security.InvalidKeyException - if recipientKey is null or an unsupported key format

engineInitSenderForTesting

public void engineInitSenderForTesting(java.security.PublicKey recipientKey,
                                       byte[] info,
                                       java.security.PrivateKey senderKey,
                                       byte[] psk,
                                       byte[] psk_id,
                                       byte[] sKe)
                                throws java.security.InvalidKeyException

Description copied from interface: HpkeSpi

Initialises an HPKE sender SPI.

Specified by:

engineInitSenderForTesting in interface HpkeSpi

Parameters:

recipientKey - public key of the recipient

info - application-supplied information, may be null or empty

senderKey - private key of the sender, for symmetric auth modes only, else null

psk - pre-shared key, for PSK auth modes only, else null

psk_id - pre-shared key ID, for PSK auth modes only, else null

sKe - optional random seed, should be null for all uses except for validation against known test vectors

Throws:

java.security.InvalidKeyException - if recipientKey is null or an unsupported key format or senderKey is an unsupported key format

getPrivateRecipientKeyBytes

abstract byte[] getPrivateRecipientKeyBytes(java.security.PrivateKey recipientKey)
                                     throws java.security.InvalidKeyException

Throws:

java.security.InvalidKeyException

engineInitRecipient

public void engineInitRecipient(byte[] encapsulated,
                                java.security.PrivateKey recipientKey,
                                byte[] info,
                                java.security.PublicKey senderKey,
                                byte[] psk,
                                byte[] psk_id)
                         throws java.security.InvalidKeyException

Description copied from interface: HpkeSpi

Initialises an HPKE recipient SPI.

Specified by:

engineInitRecipient in interface HpkeSpi

Parameters:

encapsulated - encapsulated ephemeral key from a sender

recipientKey - private key of the recipient

info - application-supplied information, may be null or empty

senderKey - public key of sender, for asymmetric auth modes only, else null

psk - pre-shared key, for PSK auth modes only, else null

psk_id - pre-shared key ID, for PSK auth modes only, else null

Throws:

java.security.InvalidKeyException - if recipientKey is null or an unsupported key format or senderKey is an unsupported key format

checkArgumentsForBaseModeOnly

private void checkArgumentsForBaseModeOnly(java.security.Key senderKey,
                                           byte[] psk,
                                           byte[] psk_id)

engineSeal

public byte[] engineSeal(byte[] plaintext,
                         byte[] aad)

Description copied from interface: HpkeSpi

Seals a message, using the internal key schedule maintained by an HPKE sender.

Specified by:

engineSeal in interface HpkeSpi

Parameters:

plaintext - the plaintext

aad - optional associated data, may be null or empty

Returns:

the ciphertext

engineExport

public byte[] engineExport(int length,
                           byte[] exporterContext)

Description copied from interface: HpkeSpi

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

Specified by:

engineExport in interface HpkeSpi

Parameters:

length - expected output length

exporterContext - optional context string, may be null or empty

Returns:

exported value

engineOpen

public byte[] engineOpen(byte[] ciphertext,
                         byte[] aad)
                  throws java.security.GeneralSecurityException

Description copied from interface: HpkeSpi

Opens a message, using the internal key schedule maintained by an HPKE recipient.

Specified by:

engineOpen in interface HpkeSpi

Parameters:

ciphertext - the ciphertext

aad - optional associated data, may be null or empty

Returns:

the plaintext

Throws:

java.security.GeneralSecurityException - on decryption failures

checkInitialised

private void checkInitialised()

checkNotInitialised

private void checkNotInitialised()

checkIsSender

private void checkIsSender()

checkIsRecipient

private void checkIsRecipient()

getEncapsulated

public byte[] getEncapsulated()

Description copied from interface: HpkeSpi

Returns the encapsulated key material for an HPKE sender.

Specified by:

getEncapsulated in interface HpkeSpi

Returns:

the key material