Класс 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), каждый поставщик должен предоставить (и задокументировать) значения по умолчанию.
Каждая реализация Java платформы должна поддерживать следующие стандартные KeyGenerator алгоритмы с размерами ключей в скобках:
-
AES(128) -
DES(56) -
DESede(168) HmacSHA1HmacSHA256
- С момента:
- 1.4
- См. также:
SecretKey
Конструкторы
| Модификатор | Конструктор и описание |
|---|---|
protected |
KeyGenerator(KeyGeneratorSpi keyGenSpi,
Provider provider,
String algorithm) Создает объект KeyGenerator. |
Методы
| Модификатор и тип | Метод и описание |
|---|---|
SecretKey |
generateKey() Генерирует секретный ключ. |
String |
getAlgorithm() Возвращает имя алгоритма этого объекта |
static KeyGenerator |
getInstance(String algorithm) Возвращает объект |
static KeyGenerator |
getInstance(String algorithm,
Provider provider) Возвращает объект |
static KeyGenerator |
getInstance(String algorithm,
String provider) Возвращает объект |
Provider |
getProvider() Возвращает поставщика этого объекта |
void |
init(AlgorithmParameterSpec params) Инициализирует этот генератор ключей указанным набором параметров. |
void |
init(AlgorithmParameterSpec params,
SecureRandom random) Инициализирует этот генератор ключей указанным набором параметров и предоставленным пользователем источником случайных чисел. |
void |
init(int keysize) Инициализирует этот генератор ключей для определённого размера ключа. |
void |
init(int keysize,
SecureRandom random) Инициализирует этот генератор ключей для определённого размера ключа, используя предоставленный пользователем источник случайных чисел. |
void |
init(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().
- Параметры:
-
algorithm- стандартное имя запрашиваемого алгоритма ключа. Сведения о стандартных именах алгоритмов см. в разделе KeyGenerator в документации Java Cryptography Architecture по стандартным именам алгоритмов. - Возвращает:
- новый объект
KeyGenerator. - Исключения:
-
NullPointerException- если указанный алгоритм равен null. -
NoSuchAlgorithmException- если ни один провайдер не поддерживает реализацию KeyGeneratorSpi для указанного алгоритма. - См. также:
Provider
getInstance
public static final KeyGenerator getInstance(String algorithm,
String provider)
throws NoSuchAlgorithmException,
NoSuchProviderException Возвращает объект KeyGenerator, который генерирует секретные ключи для указанного алгоритма.
Возвращается новый объект KeyGenerator, инкапсулирующий реализацию KeyGeneratorSpi от указанного провайдера. Указанный провайдер должен быть зарегистрирован в списке провайдеров безопасности.
Обратите внимание, что список зарегистрированных провайдеров можно получить с помощью метода Security.getProviders().
- Параметры:
-
algorithm- стандартное имя запрашиваемого алгоритма ключа. Сведения о стандартных именах алгоритмов см. в разделе KeyGenerator в документации Java Cryptography Architecture по стандартным именам алгоритмов. -
provider- имя провайдера. - Возвращает:
- новый объект
KeyGenerator. - Исключения:
-
NullPointerException- если указанный алгоритм равен null. -
NoSuchAlgorithmException- если реализация KeyGeneratorSpi для указанного алгоритма недоступна от указанного провайдера. -
NoSuchProviderException- если указанный провайдер не зарегистрирован в списке провайдеров безопасности. -
IllegalArgumentException- еслиproviderравен null или пуст. - См. также:
Provider
getInstance
public static final KeyGenerator getInstance(String algorithm,
Provider provider)
throws NoSuchAlgorithmException Возвращает объект KeyGenerator, который генерирует секретные ключи для указанного алгоритма.
Возвращается новый объект KeyGenerator, инкапсулирующий реализацию KeyGeneratorSpi из указанного объекта Provider. Обратите внимание, что указанный объект Provider не обязательно должен быть зарегистрирован в списке провайдеров.
- Параметры:
-
algorithm- стандартное имя запрашиваемого алгоритма ключа. Сведения о стандартных именах алгоритмов см. в разделе KeyGenerator в документации Java Cryptography Architecture по стандартным именам алгоритмов. -
provider- провайдер. - Возвращает:
- новый объект
KeyGenerator. - Исключения:
-
NullPointerException- если указанный алгоритм равен null. -
NoSuchAlgorithmException- если реализация KeyGeneratorSpi для указанного алгоритма недоступна от указанного объекта Provider. -
IllegalArgumentException- еслиproviderравен 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.