Class HKDFParameterSpec.Extract

java.lang.Object

javax.crypto.spec.HKDFParameterSpec.Extract

All Implemented Interfaces:

AlgorithmParameterSpec, HKDFParameterSpecPREVIEW

Enclosing interface:

HKDFParameterSpecPREVIEW

public static final class HKDFParameterSpec.Extract
extends Object
implements HKDFParameterSpecPREVIEW

Extract is a preview API of the Java platform.

Programs can only use Extract when preview features are enabled.

Preview features may be removed in a future release, or upgraded to permanent features of the Java platform.

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

Since:

24

Nested Class Summary

Nested classes/interfaces declared in interface javax.crypto.spec.HKDFParameterSpec^PREVIEW

HKDFParameterSpec.BuilderPREVIEW, HKDFParameterSpec.ExpandPREVIEW, HKDFParameterSpec.ExtractPREVIEW, HKDFParameterSpec.ExtractThenExpandPREVIEW

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 java.lang.Object

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

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[])^PREVIEW 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[])^PREVIEW 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