Класс 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)
  • DES (56)
  • DESede (168)
  • HmacSHA1
  • HmacSHA256
Эти алгоритмы описаны в разделе KeyGenerator спецификации Java Security Standard Algorithm Names. Обратитесь к документации выпуска вашей реализации, чтобы узнать, поддерживаются ли другие алгоритмы.
С момента:
1.4
См. также:
SecretKey

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

Модификатор Конструктор Описание
protected KeyGenerator​(KeyGeneratorSpi keyGenSpi, Provider provider, String algorithm)

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

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

Модификатор и тип Метод Описание
SecretKey generateKey()

Генерирует секретный ключ.
String getAlgorithm()

Возвращает имя алгоритма этого объекта KeyGenerator.
static KeyGenerator getInstance​(String algorithm)

Возвращает объект KeyGenerator, который генерирует секретные ключи для указанного алгоритма.
static KeyGenerator getInstance​(String algorithm, String provider)

Возвращает объект KeyGenerator, который генерирует секретные ключи для указанного алгоритма.
static KeyGenerator getInstance​(String algorithm, Provider provider)

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

Возвращает поставщика этого объекта KeyGenerator.
void init​(int keysize)

Инициализирует этот генератор ключей для определенного размера ключа.
void init​(int keysize, SecureRandom random)

Инициализирует этот генератор ключей для определенного размера ключа, используя предоставленный пользователем источник случайности.
void init​(SecureRandom random)

Инициализирует этот генератор ключей.
void init​(AlgorithmParameterSpec params)

Инициализирует этот генератор ключей с указанным набором параметров.
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 Standard Algorithm Names для получения информации о стандартных именах алгоритмов.
Возвращает:
новый объект KeyGenerator
Исключения:
NoSuchAlgorithmException - если ни один Provider не поддерживает реализацию KeyGeneratorSpi для указанного алгоритма
NullPointerException - если algorithm является null
См. также:
Provider

getInstance

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

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

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

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

Параметры:
algorithm - стандартное имя запрошенного алгоритма ключа. См. раздел KeyGenerator в Спецификации Java Security Standard Algorithm Names для получения информации о стандартных именах алгоритмов.
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 не обязательно должен быть зарегистрирован в списке провайдеров.

Параметры:
algorithm - стандартное имя запрошенного алгоритма ключа. См. раздел KeyGenerator в Спецификации Java Security Standard Algorithm Names для получения информации о стандартных именах алгоритмов.
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)

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

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

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

init

public final void init(int keysize,
                       SecureRandom random)

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

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

generateKey

public final SecretKey generateKey()

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

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

© 1993, 2020, 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/11/docs/api/java.base/javax/crypto/KeyGenerator.html

Spec-Zone .ru
спецификации, руководства, описания, API