Класс HKDFParameterSpec.Builder

java.lang.Object

javax.crypto.spec.HKDFParameterSpec.Builder

Охватывающий интерфейс:: HKDFParameterSpec

public static final class HKDFParameterSpec.Builder extends Object

Этот Builder создает объекты Extract и ExtractThenExpand.

Builder инициализируется с помощью метода ofExtract интерфейса HKDFParameterSpec. Как указано в описании класса, при необходимости можно вызвать addIKM и/или addSalt. Наконец, объект «создается» вызовом extractOnly или thenExpand для соответствующих вариантов использования Extract и ExtractThenExpand. Обратите внимание, что Builder не является потокобезопасным.

С версии:: 25

Краткое описание методов

Модификатор и тип	Метод	Описание
`HKDFParameterSpec.Builder`	`addIKM(byte[] ikm)`	Добавляет исходный ключевой материал (IKM) в построитель.
`HKDFParameterSpec.Builder`	`addIKM(SecretKey ikm)`	Добавляет исходный ключевой материал (IKM) в построитель.
`HKDFParameterSpec.Builder`	`addSalt(byte[] salt)`	Добавляет соль в построитель.
`HKDFParameterSpec.Builder`	`addSalt(SecretKey salt)`	Добавляет соль в построитель.
`HKDFParameterSpec.Extract`	`extractOnly()`	Создает объект `Extract` на основе текущего состояния `Builder`.
`HKDFParameterSpec.ExtractThenExpand`	`thenExpand(byte[] info, int length)`	Создает объект `ExtractThenExpand` на основе текущего состояния `Builder`.

Методы, объявленные в классе Object

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

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создает и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Указывает, равен ли этот объект другому объекту.
`protected void`	`finalize()`	Устарело, будет удалено: этот элемент API может быть удален в будущей версии. Финализация объявлена устаревшей и будет удалена в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`int`	`hashCode()`	Возвращает хеш-код этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Переводит текущий поток в состояние ожидания до его пробуждения, обычно посредством вызова метода notify или interrupt.
`final void`	`wait(long timeoutMillis)`	Переводит текущий поток в состояние ожидания до его пробуждения, обычно посредством вызова метода notify или interrupt, либо до истечения заданного промежутка реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Переводит текущий поток в состояние ожидания до его пробуждения, обычно посредством вызова метода notify или interrupt, либо до истечения заданного промежутка реального времени.

Подробное описание методов

extractOnly

public HKDFParameterSpec.Extract extractOnly()

Создает объект Extract на основе текущего состояния Builder.

Возвращает:: неизменяемый объект Extract

thenExpand

public HKDFParameterSpec.ExtractThenExpand thenExpand(byte[] info, int length)

Создает объект ExtractThenExpand на основе текущего состояния Builder.

Примечание по реализации:: Реализации HKDF проверяют, что длина не превышает 255 * длина HMAC. Реализации HKDF также проверяют, что значение info, равное null, трактуется как массив байтов нулевой длины.
Параметры:: info — необязательный контекст и сведения, специфичные для приложения (может быть null); массив байтов клонируется, чтобы предотвратить его последующее изменение; length — длина выходного ключевого материала (должна быть больше 0)
Возвращает:: неизменяемый объект ExtractThenExpand
Исключения:: IllegalArgumentException — если length не больше 0

addIKM

public HKDFParameterSpec.Builder addIKM(SecretKey ikm)

Добавляет исходный ключевой материал (IKM) в построитель.

Пользователи могут вызывать addIKM несколько раз, если значение исходного ключевого материала собирается по частям или если часть IKM предоставляется аппаратным криптографическим устройством. Метод ikms() объекта Extract или ExtractThenExpand, созданного впоследствии, возвращает собранный исходный ключевой материал в виде списка объектов SecretKey.

Параметры:: ikm — значение исходного ключевого материала (IKM)
Возвращает:: этот построитель
Исключения:: NullPointerException — если аргумент ikm равен null

addIKM

public HKDFParameterSpec.Builder addIKM(byte[] ikm)

Добавляет исходный ключевой материал (IKM) в построитель. Обратите внимание, что массив байтов длины ноль, равный ikm, будет отброшен.

Параметры:: ikm — значение исходного ключевого материала (IKM); массив байтов ikm будет преобразован в SecretKeySpec, то есть массив байтов будет клонирован в конструкторе SecretKeySpec
Возвращает:: этот построитель
Исключения:: NullPointerException — если аргумент ikm равен null

addSalt

public HKDFParameterSpec.Builder addSalt(SecretKey salt)

Добавляет соль в построитель.

Пользователи могут вызывать addSalt несколько раз, если значение соли собирается по частям или если часть соли предоставляется аппаратным криптографическим устройством. Метод salts() объекта Extract или ExtractThenExpand, созданного впоследствии, возвращает собранную соль в виде списка объектов SecretKey.

Параметры:: salt — значение соли
Возвращает:: этот построитель
Исключения:: NullPointerException — если salt равен null

addSalt

public HKDFParameterSpec.Builder addSalt(byte[] salt)

Добавляет соль в построитель. Обратите внимание, что массив байтов длины ноль, равный salt, будет отброшен.

Параметры:: salt — значение соли; массив байтов salt будет преобразован в SecretKeySpec, то есть массив байтов будет клонирован в конструкторе SecretKeySpec
Возвращает:: этот построитель
Исключения:: NullPointerException — если salt равен null

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.