Class HKDFParameterSpec.Extract

java.lang.Object

javax.crypto.spec.HKDFParameterSpec.Extract

All Implemented Interfaces:

AlgorithmParameterSpec, HKDFParameterSpec

Enclosing interface:

HKDFParameterSpec

public static final class HKDFParameterSpec.Extract
extends Object
implements HKDFParameterSpec

Defines the input parameters of an Extract operation as defined in RFC 5869.

Since:

25

Nested Class Summary

Nested classes/interfaces declared in interface HKDFParameterSpec

HKDFParameterSpec.Builder, HKDFParameterSpec.Expand, HKDFParameterSpec.Extract, HKDFParameterSpec.ExtractThenExpand

Modifier and Type	Interface	Description
static final class	HKDFParameterSpec.Builder	This Builder builds Extract and ExtractThenExpand objects.
static final class	HKDFParameterSpec.Expand	Defines the input parameters of an Expand operation as defined in RFC 5869.
static final class	HKDFParameterSpec.Extract	Defines the input parameters of an Extract operation as defined in RFC 5869.
static final class	HKDFParameterSpec.ExtractThenExpand	Defines the input parameters of an Extract-then-Expand operation as defined in RFC 5869.

Method Summary

Modifier and Type	Method	Description
List<SecretKey>	ikms()	Returns an unmodifiable List of input keying material values in the order they were added.
List<SecretKey>	salts()	Returns an unmodifiable List of salt values in the order they were added.

Methods declared in class Object

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

Modifier and Type	Method	Description
protected Object	clone()	Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object o)	Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. May cause performance issues, deadlocks and hangs.
final Class<? extends Object>	getClass()	Answers the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode()	Answers an integer hash code for the receiver.
final void	notify()	Causes one thread which is waiting on the receiver to be made ready to run.
final void	notifyAll()	Causes all threads which are waiting on the receiver to be made ready to run.
String	toString()	Answers a string containing a concise, human-readable description of the receiver.
final void	wait()	Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
final void	wait(long time)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
final void	wait(long time, int frac)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

Method Details

ikms

public List<SecretKey> ikms()

Returns an unmodifiable List of input keying material values in the order they were added. Returns an empty list if there are no input keying material values.

Input keying material values added by HKDFParameterSpec.Builder.addIKM(byte[]) are converted to a SecretKeySpec object. Empty arrays are discarded.

Implementation Note:

An HKDF implementation should concatenate the input keying materials into a single value to be used in HKDF-Extract.

Returns:

the unmodifiable List of input keying material values

salts

public List<SecretKey> salts()

Returns an unmodifiable List of salt values in the order they were added. Returns an empty list if there are no salt values.

Salt values added by HKDFParameterSpec.Builder.addSalt(byte[]) are converted to a SecretKeySpec object. Empty arrays are discarded.

Implementation Note:

An HKDF implementation should concatenate the salts into a single value to be used in HKDF-Extract.

Returns:

the unmodifiable List of salt values