Класс 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. Сведения о поддержке других алгоритмов см. в документации к выпуску вашей реализации.

Начиная с:

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

Методы, объявленные в классе 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 Reference Implementation дополнительно использует свойство jdk.security.provider.preferred Security для определения предпочтительного порядка поставщиков для указанного алгоритма. Этот порядок может отличаться от порядка поставщиков, возвращаемого методом Security.getProviders().

Параметры:

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

Возвращает:

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

Вызывает исключение:

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

NullPointerException — если algorithm имеет значение null

Внешние спецификации

См. также:

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

Внешние спецификации

См. также:

getInstance

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

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

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

Параметры:

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

Возвращает:

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

Вызывает исключение:

IllegalArgumentException — если provider имеет значение null

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

NullPointerException — если algorithm имеет значение null

Внешние спецификации

См. также:

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, 2025, 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/25/docs/api/java.base/javax/crypto/SecretKeyFactory.html