Modifier and Type	Class and Description
private static record	DHKEM.Handler
private static enum	DHKEM.Params
public static class	DHKEM.RFC9180DeriveKeyPairSR

Modifier and Type	Field and Description
private static final byte[]	CANDIDATE
private static final byte[]	DKP_PRK
private static final byte[]	EAE_PRK
private static final byte[]	EMPTY
private static final byte[]	HPKE_V1
private static final byte[]	KEM
private static final byte[]	SHARED_SECRET
private static final byte[]	SK

Access	Constructor and Description
public	DHKEM()

Modifier and Type	Method and Description
private static byte[]	concat(byte[]... inputs)
public KEMSpi.DecapsulatorSpi	engineNewAuthDecapsulator(PrivateKey skR, PublicKey pkS, AlgorithmParameterSpec spec)
public KEMSpi.EncapsulatorSpi	engineNewAuthEncapsulator(PublicKey pkR, PrivateKey skS, AlgorithmParameterSpec spec, SecureRandom secureRandom)
public KEMSpi.DecapsulatorSpi	engineNewDecapsulator(PrivateKey sk, AlgorithmParameterSpec spec) Implements javax.crypto.KEMSpi.engineNewDecapsulator. Creates a KEM decapsulator on the KEM receiver side.
public KEMSpi.EncapsulatorSpi	engineNewEncapsulator(PublicKey pk, AlgorithmParameterSpec spec, SecureRandom secureRandom) Implements javax.crypto.KEMSpi.engineNewEncapsulator. Creates a KEM encapsulator on the KEM sender side.
private static SecureRandom	getSecureRandom(SecureRandom userSR)
public static byte[]	i2OSP(int n, int w)
public static HKDFParameterSpec	labeledExpand(HKDFParameterSpec.Builder builder, byte[] suiteId, byte[] label, byte[] info, int length)
public static HKDFParameterSpec	labeledExpand(SecretKey prk, byte[] suiteId, byte[] label, byte[] info, int length)
public static HKDFParameterSpec.Builder	labeledExtract(byte[] suiteId, byte[] label)
private static byte[]	labeledInfo(byte[] suiteId, byte[] label, byte[] info, int length)
private DHKEM.Params	paramsFromKey(AsymmetricKey k)

CANDIDATE	back to summary
private static final byte[] CANDIDATE

DKP_PRK	back to summary
private static final byte[] DKP_PRK

EAE_PRK	back to summary
private static final byte[] EAE_PRK

EMPTY	back to summary
private static final byte[] EMPTY

HPKE_V1	back to summary
private static final byte[] HPKE_V1

KEM	back to summary
private static final byte[] KEM

SHARED_SECRET	back to summary
private static final byte[] SHARED_SECRET

SK	back to summary
private static final byte[] SK

DHKEM	back to summary
public DHKEM()

Method Detail

concat	back to summary
private static byte[] concat(byte[]... inputs)

engineNewAuthDecapsulator	back to summary
public KEMSpi.DecapsulatorSpi engineNewAuthDecapsulator(PrivateKey skR, PublicKey pkS, AlgorithmParameterSpec spec) throws InvalidAlgorithmParameterException, InvalidKeyException

engineNewAuthEncapsulator	back to summary
public KEMSpi.EncapsulatorSpi engineNewAuthEncapsulator(PublicKey pkR, PrivateKey skS, AlgorithmParameterSpec spec, SecureRandom secureRandom) throws InvalidAlgorithmParameterException, InvalidKeyException

engineNewDecapsulator back to summary

engineNewDecapsulator	back to summary
public KEMSpi.DecapsulatorSpi engineNewDecapsulator(PrivateKey sk, AlgorithmParameterSpec spec) throws InvalidAlgorithmParameterException, InvalidKeyException Implements javax.crypto.KEMSpi.engineNewDecapsulator. Doc from javax.crypto.KEMSpi.engineNewDecapsulator. Creates a KEM decapsulator on the KEM receiver side. Annotations @Override Exceptions InvalidAlgorithmParameterException: if `spec` is invalid or one is required but `spec` is `null` InvalidKeyException: if `privateKey` is `null` or invalid

public KEMSpi.DecapsulatorSpi engineNewDecapsulator(PrivateKey sk, AlgorithmParameterSpec spec) throws InvalidAlgorithmParameterException, InvalidKeyException

Implements javax.crypto.KEMSpi.engineNewDecapsulator.

Doc from javax.crypto.KEMSpi.engineNewDecapsulator.

Creates a KEM decapsulator on the KEM receiver side.

Annotations

@Override

Exceptions

InvalidAlgorithmParameterException:: if spec is invalid or one is required but spec is null
InvalidKeyException:: if privateKey is null or invalid

engineNewEncapsulator back to summary

engineNewEncapsulator	back to summary
public KEMSpi.EncapsulatorSpi engineNewEncapsulator(PublicKey pk, AlgorithmParameterSpec spec, SecureRandom secureRandom) throws InvalidAlgorithmParameterException, InvalidKeyException Implements javax.crypto.KEMSpi.engineNewEncapsulator. Doc from javax.crypto.KEMSpi.engineNewEncapsulator. Creates a KEM encapsulator on the KEM sender side. Annotations @Override Exceptions InvalidAlgorithmParameterException: if `spec` is invalid or one is required but `spec` is `null` InvalidKeyException: if `publicKey` is `null` or invalid

public KEMSpi.EncapsulatorSpi engineNewEncapsulator(PublicKey pk, AlgorithmParameterSpec spec, SecureRandom secureRandom) throws InvalidAlgorithmParameterException, InvalidKeyException

Implements javax.crypto.KEMSpi.engineNewEncapsulator.

Doc from javax.crypto.KEMSpi.engineNewEncapsulator.

Creates a KEM encapsulator on the KEM sender side.

Annotations

@Override

Exceptions

InvalidAlgorithmParameterException:: if spec is invalid or one is required but spec is null
InvalidKeyException:: if publicKey is null or invalid

getSecureRandom	back to summary
private static SecureRandom getSecureRandom(SecureRandom userSR)

i2OSP	back to summary
public static byte[] i2OSP(int n, int w)

labeledExpand	back to summary
public static HKDFParameterSpec labeledExpand(HKDFParameterSpec.Builder builder, byte[] suiteId, byte[] label, byte[] info, int length)

labeledExpand	back to summary
public static HKDFParameterSpec labeledExpand(SecretKey prk, byte[] suiteId, byte[] label, byte[] info, int length)

labeledExtract	back to summary
public static HKDFParameterSpec.Builder labeledExtract(byte[] suiteId, byte[] label)

labeledInfo	back to summary
private static byte[] labeledInfo(byte[] suiteId, byte[] label, byte[] info, int length)

paramsFromKey	back to summary
private DHKEM.Params paramsFromKey(AsymmetricKey k) throws InvalidKeyException

com.sun.crypto.provider back to summary

private final Record DHKEM.Handler

Class Inheritance

extends Record
implements EncapsulatorSpi, DecapsulatorSpi

java.lang.Object
java.lang.Record
com.sun.crypto.provider.DHKEM.Handler

All Implemented Interfaces

javax.crypto.KEMSpi.DecapsulatorSpi, javax.crypto.KEMSpi.EncapsulatorSpi

Record Components

params:DHKEM.Params
secureRandom:SecureRandom
skS:PrivateKey
pkS:PublicKey
skR:PrivateKey
pkR:PublicKey

Field Summary

Modifier and Type	Field and Description
private final DHKEM.Params	params Record Component accessed by params().
private final PublicKey	pkR Record Component accessed by pkR().
private final PublicKey	pkS Record Component accessed by pkS().
private final SecureRandom	secureRandom Record Component accessed by secureRandom().
private final PrivateKey	skR Record Component accessed by skR().
private final PrivateKey	skS Record Component accessed by skS().

Constructor Summary

Access	Constructor and Description
private	Handler(DHKEM.Params params, SecureRandom secureRandom, PrivateKey skS, PublicKey pkS, PrivateKey skR, PublicKey pkR)

Method Summary

Modifier and Type	Method and Description
public SecretKey	engineDecapsulate(byte[] encapsulation, int from, int to, String algorithm) Implements javax.crypto.KEMSpi.DecapsulatorSpi.engineDecapsulate. The key decapsulation function.
public KEM.Encapsulated	engineEncapsulate(int from, int to, String algorithm) Implements javax.crypto.KEMSpi.EncapsulatorSpi.engineEncapsulate. The key encapsulation function.
public int	engineEncapsulationSize() Implements javax.crypto.KEMSpi.EncapsulatorSpi.engineEncapsulationSize, javax.crypto.KEMSpi.DecapsulatorSpi.engineEncapsulationSize. Returns the size of the key encapsulation message.
public int	engineSecretSize() Implements javax.crypto.KEMSpi.EncapsulatorSpi.engineSecretSize, javax.crypto.KEMSpi.DecapsulatorSpi.engineSecretSize. Returns the size of the shared secret.
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public DHKEM.Params	params() Record Component getter of params.
public PublicKey	pkR() Record Component getter of pkR.
public PublicKey	pkS() Record Component getter of pkS.
public SecureRandom	secureRandom() Record Component getter of secureRandom.
public PrivateKey	skR() Record Component getter of skR.
public PrivateKey	skS() Record Component getter of skS.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

params	back to summary
private final DHKEM.Params params Record Component accessed by params().

pkR	back to summary
private final PublicKey pkR Record Component accessed by pkR().

pkS	back to summary
private final PublicKey pkS Record Component accessed by pkS().

secureRandom	back to summary
private final SecureRandom secureRandom Record Component accessed by secureRandom().

skR	back to summary
private final PrivateKey skR Record Component accessed by skR().

skS	back to summary
private final PrivateKey skS Record Component accessed by skS().

Constructor Detail

Handler	back to summary
private Handler(DHKEM.Params params, SecureRandom secureRandom, PrivateKey skS, PublicKey pkS, PrivateKey skR, PublicKey pkR)

Method Detail

engineDecapsulate back to summary

engineDecapsulate	back to summary
public SecretKey engineDecapsulate(byte[] encapsulation, int from, int to, String algorithm) throws DecapsulateException Implements javax.crypto.KEMSpi.DecapsulatorSpi.engineDecapsulate. Doc from javax.crypto.KEMSpi.DecapsulatorSpi.engineDecapsulate. The key decapsulation function. An invocation of this method recovers the secret key from the key encapsulation message. An implementation must support the case where `from` is 0, `to` is the same as the return value of `secretSize()`, and `algorithm` is "Generic". Annotations @Override Exceptions DecapsulateException: if an error occurs during the decapsulation process

public SecretKey engineDecapsulate(byte[] encapsulation, int from, int to, String algorithm) throws DecapsulateException

Implements javax.crypto.KEMSpi.DecapsulatorSpi.engineDecapsulate.

Doc from javax.crypto.KEMSpi.DecapsulatorSpi.engineDecapsulate.

The key decapsulation function.

An invocation of this method recovers the secret key from the key encapsulation message.

An implementation must support the case where from is 0, to is the same as the return value of secretSize(), and algorithm is "Generic".

Annotations

@Override

Exceptions

DecapsulateException:: if an error occurs during the decapsulation process

engineEncapsulate back to summary

engineEncapsulate	back to summary
public KEM.Encapsulated engineEncapsulate(int from, int to, String algorithm) Implements javax.crypto.KEMSpi.EncapsulatorSpi.engineEncapsulate. Doc from javax.crypto.KEMSpi.EncapsulatorSpi.engineEncapsulate. The key encapsulation function. Each invocation of this method must generate a new secret key and key encapsulation message that is returned in an `KEM.Encapsulated` object. An implementation must support the case where `from` is 0, `to` is the same as the return value of `secretSize()`, and `algorithm` is "Generic". Annotations @Override

public KEM.Encapsulated engineEncapsulate(int from, int to, String algorithm)

Implements javax.crypto.KEMSpi.EncapsulatorSpi.engineEncapsulate.

Doc from javax.crypto.KEMSpi.EncapsulatorSpi.engineEncapsulate.

The key encapsulation function.

Each invocation of this method must generate a new secret key and key encapsulation message that is returned in an KEM.Encapsulated object.

An implementation must support the case where from is 0, to is the same as the return value of secretSize(), and algorithm is "Generic".

Annotations

@Override

engineEncapsulationSize	back to summary
public int engineEncapsulationSize() Implements javax.crypto.KEMSpi.EncapsulatorSpi.engineEncapsulationSize, javax.crypto.KEMSpi.DecapsulatorSpi.engineEncapsulationSize. Doc from javax.crypto.KEMSpi.EncapsulatorSpi.engineEncapsulationSize. Returns the size of the key encapsulation message. Annotations @Override

engineEncapsulationSize

back to summary

public int engineEncapsulationSize()

Implements javax.crypto.KEMSpi.EncapsulatorSpi.engineEncapsulationSize, javax.crypto.KEMSpi.DecapsulatorSpi.engineEncapsulationSize.

Doc from javax.crypto.KEMSpi.EncapsulatorSpi.engineEncapsulationSize.

Returns the size of the key encapsulation message.

Annotations

@Override

engineSecretSize	back to summary
public int engineSecretSize() Implements javax.crypto.KEMSpi.EncapsulatorSpi.engineSecretSize, javax.crypto.KEMSpi.DecapsulatorSpi.engineSecretSize. Doc from javax.crypto.KEMSpi.EncapsulatorSpi.engineSecretSize. Returns the size of the shared secret. Annotations @Override

engineSecretSize

back to summary

public int engineSecretSize()

Implements javax.crypto.KEMSpi.EncapsulatorSpi.engineSecretSize, javax.crypto.KEMSpi.DecapsulatorSpi.engineSecretSize.

Doc from javax.crypto.KEMSpi.EncapsulatorSpi.engineSecretSize.

Returns the size of the shared secret.

Annotations

@Override

equals back to summary

equals	back to summary
public final boolean equals(Object o) Implements abstract java.lang.Record.equals. Doc from java.lang.Record.equals. Indicates whether some other object is "equal to" this one. In addition to the general contract of `Object.equals`, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: R copy = new R(r.c1(), r.c2(), ..., r.cn()); then it must be the case that `r.equals(copy)`.

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

hashCode	back to summary
public final int hashCode() Implements abstract java.lang.Record.hashCode. Doc from java.lang.Record.hashCode. Returns a hash code value for the record. Obeys the general contract of `Object.hashCode`. For records, hashing behavior is constrained by the refined contract of `Record.equals`, so that any two records created from the same components must have the same hash code.

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

params	back to summary
public DHKEM.Params params() Record Component getter of params.

pkR	back to summary
public PublicKey pkR() Record Component getter of pkR.

pkS	back to summary
public PublicKey pkS() Record Component getter of pkS.

secureRandom	back to summary
public SecureRandom secureRandom() Record Component getter of secureRandom.

skR	back to summary
public PrivateKey skR() Record Component getter of skR.

skS	back to summary
public PrivateKey skS() Record Component getter of skS.

toString back to summary

toString	back to summary
public final String toString() Implements abstract java.lang.Record.toString. Doc from java.lang.Record.toString. Returns a string representation of the record. In accordance with the general contract of `Object#toString()`, the `toString` method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read. In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

com.sun.crypto.provider back to summary

private final Enum DHKEM.Params

Class Inheritance

extends Enum<DHKEM.Params>

java.lang.Object
java.lang.Enum
com.sun.crypto.provider.DHKEM.Params

Field Summary

Modifier and Type	Field and Description
private final String	hkdfAlgorithm
private final String	kaAlgorithm
private final int	kem_id
private final String	keyAlgorithm
private final int	npk
private final int	nsecret
private final int	nsk
public static final DHKEM.Params	P256
public static final DHKEM.Params	P384
public static final DHKEM.Params	P521
private final AlgorithmParameterSpec	spec
private final byte[]	suiteId
public static final DHKEM.Params	X25519
public static final DHKEM.Params	X448

Constructor Summary

Access	Constructor and Description
private	Params(int kem_id, int nsecret, int nsk, int npk, String kaAlgorithm, String keyAlgorithm, AlgorithmParameterSpec spec, String hkdfAlgorithm)

Method Summary

Modifier and Type	Method and Description
private SecretKey	deriveKey(String alg, int from, int to, byte[] kem_context, SecretKey... dhs)
public KeyPair	deriveKeyPair(byte[] ikm)
private PrivateKey	deserializePrivateKey(byte[] data)
private PublicKey	deserializePublicKey(byte[] data)
private SecretKey	dh(PrivateKey skE, PublicKey pkR)
private SecretKey	extractAndExpand(byte[] kem_context, String alg, SecretKey... dhs)
private KeyPair	generateKeyPair(SecureRandom sr)
private PublicKey	getPublicKey(PrivateKey sk)
private boolean	isEC()
private byte[]	serializePublicKey(PublicKey k)
public static DHKEM.Params	valueOf(String name)
public static DHKEM.Params[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

hkdfAlgorithm	back to summary
private final String hkdfAlgorithm

kaAlgorithm	back to summary
private final String kaAlgorithm

kem_id	back to summary
private final int kem_id

keyAlgorithm	back to summary
private final String keyAlgorithm

npk	back to summary
private final int npk

nsecret	back to summary
private final int nsecret

nsk	back to summary
private final int nsk

P256	back to summary
public static final DHKEM.Params P256

P384	back to summary
public static final DHKEM.Params P384

P521	back to summary
public static final DHKEM.Params P521

spec	back to summary
private final AlgorithmParameterSpec spec

suiteId	back to summary
private final byte[] suiteId

X25519	back to summary
public static final DHKEM.Params X25519

X448	back to summary
public static final DHKEM.Params X448

Constructor Detail

Params	back to summary
private Params(int kem_id, int nsecret, int nsk, int npk, String kaAlgorithm, String keyAlgorithm, AlgorithmParameterSpec spec, String hkdfAlgorithm)

Method Detail

deriveKey	back to summary
private SecretKey deriveKey(String alg, int from, int to, byte[] kem_context, SecretKey... dhs) throws NoSuchAlgorithmException

deriveKeyPair	back to summary
public KeyPair deriveKeyPair(byte[] ikm) throws Exception

deserializePrivateKey	back to summary
private PrivateKey deserializePrivateKey(byte[] data) throws Exception

deserializePublicKey	back to summary
private PublicKey deserializePublicKey(byte[] data) throws IOException, NoSuchAlgorithmException, InvalidKeySpecException

dh	back to summary
private SecretKey dh(PrivateKey skE, PublicKey pkR) throws NoSuchAlgorithmException, InvalidKeyException

extractAndExpand	back to summary
private SecretKey extractAndExpand(byte[] kem_context, String alg, SecretKey... dhs) throws NoSuchAlgorithmException

generateKeyPair	back to summary
private KeyPair generateKeyPair(SecureRandom sr)

getPublicKey	back to summary
private PublicKey getPublicKey(PrivateKey sk) throws InvalidKeyException

isEC	back to summary
private boolean isEC()

serializePublicKey	back to summary
private byte[] serializePublicKey(PublicKey k)

valueOf	back to summary
public static DHKEM.Params valueOf(String name)

values	back to summary
public static DHKEM.Params[] values()

public Class DHKEM

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Record DHKEM.Handler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum DHKEM.Params

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class DHKEM.RFC9180DeriveKeyPairSR

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Field and Description
private final byte[]	ikm
private static final long	serialVersionUID Hides java.security.SecureRandom.serialVersionUID.

Modifier and Type	Method and Description
private KeyPair	derive(DHKEM.Params params)
public KeyPair	derive(int kem_id)