Класс 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), каждый провайдер должен предоставить (и задокументировать) значения по умолчанию для инициализации. Сведения о значениях по умолчанию для KeyGenerator, используемых провайдерами JDK, можно найти в разделах ограничений размера ключа документа JDK Providers. Однако обратите внимание, что значения по умолчанию могут различаться между различными провайдерами. Кроме того, значения по умолчанию для провайдера могут измениться в будущих версиях. Поэтому рекомендуется явно инициализировать KeyGenerator, а не полагаться на значения по умолчанию, специфичные для провайдера.

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

AES (128)
DESede (168)
HmacSHA1
HmacSHA256

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

Since:

1.4

See Also:

SecretKey

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

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 не поддерживает реализацию KeyGeneratorSpi для указанного алгоритма

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

См. также:

Provider

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

См. также:

Provider

getInstance

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

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

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

Параметры:

provider - поставщик.

Возвращает:

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

Исключения:

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

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

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

См. также:

Provider

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, 2021, 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/17/docs/api/java.base/javax/crypto/KeyGenerator.html