Класс KeyGenerator

java.lang.Object

javax.crypto.KeyGenerator

public class KeyGenerator extends Object

Этот класс предоставляет функциональность генератора секретных (симметричных) ключей.

Генераторы ключей создаются с помощью одного из методов класса getInstance.

Объекты KeyGenerator являются повторно используемыми, т.е. после генерации ключа тот же объект KeyGenerator может быть повторно использован для генерации других ключей.

Существуют два способа генерации ключа: независимый от алгоритма и зависящий от алгоритма. Единственное различие между ними заключается в инициализации объекта:

Инициализация, независимая от алгоритма
Все генераторы ключей используют понятия размер ключа и источник случайности. В этом классе KeyGenerator есть метод init, который принимает эти два универсальных типа аргументов. Также есть метод, принимающий только аргумент keysize, и использующий реализацию SecureRandom наиболее приоритетного установленного провайдера в качестве источника случайности (или системный источник случайности, если ни один из установленных провайдеров не предоставляет реализацию SecureRandom), и метод, принимающий только источник случайности.

Поскольку при вызове вышеперечисленных методов, независимых от алгоритма, init, не указываются другие параметры, то провайдеру предоставляется возможность самостоятельно определять алгоритм-специфические параметры (если таковые имеются) для каждого ключа.
Инициализация, зависящая от алгоритма
В ситуациях, когда набор параметров, специфичных для алгоритма, уже существует, существуют два метода init, которые имеют аргумент AlgorithmParameterSpec. Один также имеет аргумент SecureRandom, в то время как другой использует реализацию SecureRandom наиболее приоритетного установленного провайдера в качестве источника случайности (или системный источник случайности, если ни один из установленных провайдеров не предоставляет реализацию SecureRandom).

В случае, если клиент не инициализирует KeyGenerator явно (через вызов метода init), каждый провайдер должен предоставить (и задокументировать) значение по умолчанию для инициализации. См. разделы "Ограничения на размер ключа" документа JDK Providers для получения информации о значениях по умолчанию для KeyGenerator, используемых провайдерами JDK. Однако обратите внимание, что значения по умолчанию могут отличаться в разных провайдерах. Кроме того, значение по умолчанию для провайдера может измениться в будущей версии. Поэтому рекомендуется явно инициализировать KeyGenerator вместо того, чтобы полагаться на значения по умолчанию, специфичные для провайдера.

Каждая реализация Java платформы обязана поддерживать следующие стандартные алгоритмы KeyGenerator с размерами ключей в скобках:

AES (128)
DESede (168)
HmacSHA1
HmacSHA256

Эти алгоритмы описаны в разделе KeyGenerator спецификации Java Security Standard Algorithm Names. Обратитесь к документации релиза вашей реализации, чтобы узнать, какие другие алгоритмы поддерживаются.

С:

1.4

См. также:

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

KeyGenerator(KeyGeneratorSpi keyGenSpi,
 Provider provider,
 String algorithm)

Модификатор	Конструктор	Описание
`protected`	Создает объект `KeyGenerator`.

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

Модификатор и тип	Метод	Описание
`final SecretKey`	`generateKey()`	Генерирует секретный ключ.
`final String`	`getAlgorithm()`	Возвращает имя алгоритма этого объекта `KeyGenerator`.
`static final KeyGenerator`	`getInstance(String algorithm)`	Возвращает объект `KeyGenerator`, который генерирует секретные ключи для указанного алгоритма.
`static final KeyGenerator`	`getInstance(String algorithm, String provider)`	Возвращает объект `KeyGenerator`, который генерирует секретные ключи для указанного алгоритма.
`static final KeyGenerator`	`getInstance(String algorithm, Provider provider)`	Возвращает объект `KeyGenerator`, который генерирует секретные ключи для указанного алгоритма.
`final Provider`	`getProvider()`	Возвращает провайдера этого объекта `KeyGenerator`.
`final void`	`init(int keysize)`	Инициализирует этот генератор ключей для определенного размера ключа.
`final void`	`init(int keysize, SecureRandom random)`	Инициализирует этот генератор ключей для определенного размера ключа, используя предоставленный пользователем источник случайности.
`final void`	`init(SecureRandom random)`	Инициализирует этот генератор ключей.
`final void`	`init(AlgorithmParameterSpec params)`	Инициализирует этот генератор ключей с заданным набором параметров.
`final void`	`init(AlgorithmParameterSpec params, SecureRandom random)`	Инициализирует этот генератор ключей с заданным набором параметров и предоставленным пользователем источником случайности.

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

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

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

KeyGenerator

protected KeyGenerator(KeyGeneratorSpi keyGenSpi, Provider provider, String algorithm)

Создаёт объект KeyGenerator.

Параметры:: keyGenSpi - делегат; provider - провайдер; algorithm - алгоритм

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

getAlgorithm

public final String getAlgorithm()

Возвращает имя алгоритма этого объекта KeyGenerator.

Это то же имя, которое было указано в одном из вызовов getInstance, которые создали этот объект KeyGenerator.

Возвращает:: имя алгоритма этого объекта KeyGenerator.

getInstance

public static final KeyGenerator getInstance(String algorithm) throws NoSuchAlgorithmException

Возвращает объект KeyGenerator, который генерирует секретные ключи для указанного алгоритма.

Этот метод проходит по списку зарегистрированных провайдеров безопасности, начиная с наиболее предпочтительного. Возвращается новый объект KeyGenerator, инкапсулирующий реализацию KeyGeneratorSpi от первого провайдера, который поддерживает указанный алгоритм.

Обратите внимание, что список зарегистрированных провайдеров можно получить с помощью метода Security.getProviders().

Замечание по реализации:

Реализация JDK дополнительно использует свойство jdk.security.provider.preferred Security, чтобы определить порядок предпочтительных провайдеров для указанного алгоритма. Это может отличаться от порядка провайдеров, возвращаемых методом Security.getProviders().

Параметры:

algorithm - стандартное имя запрашиваемого алгоритма ключа. См. раздел KeyGenerator в Спецификации имён стандартных алгоритмов Java Security для получения информации об именах стандартных алгоритмов.

Возвращает:

новый объект KeyGenerator

Исключения:

NoSuchAlgorithmException - если ни один провайдер не поддерживает реализацию Provider для указанного алгоритма

NullPointerException - если algorithm является null

См. также:

getInstance

public static final KeyGenerator getInstance(String algorithm, String provider) throws NoSuchAlgorithmException, NoSuchProviderException

Возвращает объект KeyGenerator, который генерирует секретные ключи для указанного алгоритма.

Возвращается новый объект KeyGenerator, инкапсулирующий реализацию KeyGeneratorSpi от указанного провайдера. Указанный провайдер должен быть зарегистрирован в списке провайдеров безопасности.

Параметры:

provider - имя провайдера.

Возвращает:

новый объект KeyGenerator

Исключения:

IllegalArgumentException - если provider является null или пустым

NoSuchAlgorithmException - если реализация KeyGeneratorSpi для указанного алгоритма недоступна от указанного провайдера

NoSuchProviderException - если указанный провайдер не зарегистрирован в списке провайдеров безопасности

NullPointerException - если algorithm является null

См. также:

getInstance

public static final KeyGenerator getInstance(String algorithm, Provider provider) throws NoSuchAlgorithmException

Возвращает объект KeyGenerator, который генерирует секретные ключи для указанного алгоритма.

Возвращается новый объект KeyGenerator, инкапсулирующий реализацию KeyGeneratorSpi от указанного объекта провайдера. Обратите внимание, что указанный объект провайдера не обязательно должен быть зарегистрирован в списке провайдеров.

Параметры:

provider - провайдер.

Возвращает:

новый объект KeyGenerator

Исключения:

IllegalArgumentException - если provider является null

NoSuchAlgorithmException - если реализация KeyGeneratorSpi для указанного алгоритма недоступна от указанного объекта Provider

NullPointerException - если algorithm является null

См. также:

getProvider

public final Provider getProvider()

Возвращает провайдера этого объекта KeyGenerator.

Возвращает:: провайдер этого объекта KeyGenerator

init

public final void init(SecureRandom random)

Инициализирует этот генератор ключей.

Параметры:: random - источник случайности для этого генератора

init

public final void init(AlgorithmParameterSpec params) throws InvalidAlgorithmParameterException

Инициализирует этот генератор ключей заданным набором параметров.

Если этому генератору ключей требуются случайные байты, он получит их, используя реализацию SecureRandom провайдера с наивысшим приоритетом, установленного в системе, в качестве источника случайности. (Если ни один из установленных провайдеров не предоставляет реализацию SecureRandom, будет использоваться системный источник случайности.)

Параметры:: params - параметры генерации ключа
Исключения:: InvalidAlgorithmParameterException - если заданные параметры неподходящие для этого генератора ключей

init

public final void init(AlgorithmParameterSpec params, SecureRandom random) throws InvalidAlgorithmParameterException

Инициализирует этот генератор ключей заданным набором параметров и предоставленным пользователем источником случайности.

Параметры:: params - параметры генерации ключа; random - источник случайности для этого генератора ключей
Исключения:: InvalidAlgorithmParameterException - если params неподходящие для этого генератора ключей

init

public final void init(int keysize)

Инициализирует этот генератор ключей для определённого размера ключа.

Параметры:: keysize - размер ключа. Это метрика, специфичная для алгоритма, указанная в битах.
Исключения:: InvalidParameterException - если размер ключа неверный или не поддерживается.

init

public final void init(int keysize, SecureRandom random)

Инициализирует этот генератор ключей для определённого размера ключа, используя предоставленный пользователем источник случайности.

Параметры:: keysize - размер ключа. Это метрика, специфичная для алгоритма, указанная в битах.; random - источник случайности для этого генератора ключей
Исключения:: InvalidParameterException - если размер ключа неверный или не поддерживается.

generateKey

public final SecretKey generateKey()

Генерирует секретный ключ.

Возвращает:: новый ключ

© 1993, 2023, 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.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/javax/crypto/KeyGenerator.html