Class HKDFParameterSpec.ExtractThenExpand

java.lang.Object
javax.crypto.spec.HKDFParameterSpec.ExtractThenExpand
All Implemented Interfaces:
AlgorithmParameterSpec, HKDFParameterSpec
Enclosing interface:
HKDFParameterSpec
public static final class HKDFParameterSpec.ExtractThenExpand extends Object implements HKDFParameterSpec
Defines the input parameters of an Extract-then-Expand 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.
    byte[]
    info()
    Returns the optional context and application specific information.
    int
    length()
    Returns the length of the output keying material.
    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()
    Creates and returns a copy of this object.
    boolean
    equals(Object obj)
    Indicates whether some other object is "equal to" this one.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Finalization is deprecated and subject to removal in a future release.
    final Class<?>
    getClass()
    Returns the runtime class of this Object.
    int
    hashCode()
    Returns a hash code value for this object.
    final void
    notify()
    Wakes up a single thread that is waiting on this object's monitor.
    final void
    notifyAll()
    Wakes up all threads that are waiting on this object's monitor.
    String
    toString()
    Returns a string representation of the object.
    final void
    wait()
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
    final void
    wait(long timeoutMillis)
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
    final void
    wait(long timeoutMillis, int nanos)
    Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

  • 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 the HKDF-Extract phase.
      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 the HKDF-Extract phase.
      Returns:
      the unmodifiable List of salt values

    • info

      public byte[] info()
      Returns the optional context and application specific information.
      Returns:
      a clone of the optional context and application specific information, or null if not specified

    • length

      public int length()
      Returns the length of the output keying material.
      Returns:
      the length of the output keying material