Класс SecretKeyFactory

java.lang.Object

javax.crypto.SecretKeyFactory

public class SecretKeyFactory extends Object

Этот класс представляет собой фабрику для секретных ключей.

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

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

Разработчики приложений должны обратиться к документации своего поставщика, чтобы узнать, какие спецификации ключей поддерживаются методами generateSecret и getKeySpec. Например, фабрика секретных ключей DESede (Triple DES), поставляемая поставщиком "SunJCE", поддерживает DESedeKeySpec в качестве прозрачного представления ключей Triple DES.

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

DESede

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

Since:

1.4

См. также:

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

SecretKeyFactory(SecretKeyFactorySpi keyFacSpi,
 Provider provider,
 String algorithm)

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

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

Модификатор и тип	Метод	Описание
`final SecretKey`	`generateSecret(KeySpec keySpec)`	Генерирует объект `SecretKey` из предоставленной спецификации ключа (материала ключа).
`final String`	`getAlgorithm()`	Возвращает имя алгоритма этого объекта `SecretKeyFactory`.
`static final SecretKeyFactory`	`getInstance(String algorithm)`	Возвращает объект `SecretKeyFactory`, который преобразует секретные ключи указанного алгоритма.
`static final SecretKeyFactory`	`getInstance(String algorithm, String provider)`	Возвращает объект `SecretKeyFactory`, который преобразует секретные ключи указанного алгоритма.
`static final SecretKeyFactory`	`getInstance(String algorithm, Provider provider)`	Возвращает объект `SecretKeyFactory`, который преобразует секретные ключи указанного алгоритма.
`final KeySpec`	`getKeySpec(SecretKey key, Class<?> keySpec)`	Возвращает спецификацию (материал ключа) заданного объекта ключа в запрошенном формате.
`final Provider`	`getProvider()`	Возвращает поставщика этого объекта `SecretKeyFactory`.
`final SecretKey`	`translateKey(SecretKey key)`	Преобразует объект ключа, чей поставщик может быть неизвестен или потенциально недоверен, в соответствующий объект ключа этой фабрики секретных ключей.

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

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

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

SecretKeyFactory

protected SecretKeyFactory(SecretKeyFactorySpi keyFacSpi, Provider provider, String algorithm)

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

Параметры:: keyFacSpi - делегат; provider - поставщик; algorithm - алгоритм секретного ключа

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

getInstance

public static final SecretKeyFactory getInstance(String algorithm) throws NoSuchAlgorithmException

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

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

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

Описание реализации:

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

Параметры:

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

Возвращает:

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

Исключения:

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

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

См. также:

Provider

getInstance

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

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

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

Параметры:

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

Возвращает:

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

Исключения:

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

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

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

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

См. также:

Provider

getInstance

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

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

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

Параметры:

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

Возвращает:

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

Исключения:

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

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

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

См. также:

Provider

getProvider

public final Provider getProvider()

Возвращает поставщика этого объекта SecretKeyFactory.

Возвращает:: поставщик этого объекта SecretKeyFactory

getAlgorithm

public final String getAlgorithm()

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

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

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

generateSecret

public final SecretKey generateSecret(KeySpec keySpec) throws InvalidKeySpecException

Генерирует объект SecretKey из предоставленного задания ключа (ключевого материала).

Параметры:: keySpec - задание (ключевой материал) секретного ключа
Возвращает:: секретный ключ
Исключения:: InvalidKeySpecException - если заданное задание ключа не подходит для этого фабрики секретных ключей для создания секретного ключа.

getKeySpec

public final KeySpec getKeySpec(SecretKey key, Class<?> keySpec) throws InvalidKeySpecException

Возвращает задание (ключевой материал) данного объекта ключа в запрошенном формате.

Параметры:: key - ключ; keySpec - запрошенный формат, в котором должен быть возвращён ключевой материал
Возвращает:: базовое задание ключа (ключевой материал) в запрошенном формате
Исключения:: InvalidKeySpecException - если запрошенное задание ключа не подходит для данного ключа (например, алгоритмы, связанные с key и keySpec не совпадают, или key ссылается на ключ на криптографическом аппаратном устройстве, тогда как keySpec является заданием программного ключа), или данный ключ не может быть обработан (например, у данного ключа есть алгоритм или формат, не поддерживаемый этой фабрикой секретных ключей).

translateKey

public final SecretKey translateKey(SecretKey key) throws InvalidKeyException

Преобразует объект ключа, поставщик которого может быть неизвестен или потенциально небезопасен, в соответствующий объект ключа этой фабрики секретных ключей.

Параметры:: key - ключ, поставщик которого неизвестен или небезопасен
Возвращает:: преобразованный ключ
Исключения:: InvalidKeyException - если данный ключ не может быть обработан этой фабрикой секретных ключей.

© 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/SecretKeyFactory.html