Spec-Zone.ru › OpenJDK 21

Класс ExemptionMechanism

java.lang.Object
javax.crypto.ExemptionMechanism
public class ExemptionMechanism extends Object
Этот класс предоставляет функциональность механизма исключения, примерами которого являются восстановление ключа, ослабление ключа и эскроу ключа.

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

Since:
1.4

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

ExemptionMechanism(ExemptionMechanismSpi exmechSpi, Provider provider, String mechanism)
Модификатор Конструктор Описание
protected
Создаёт объект ExemptionMechanism.

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

Модификатор и тип Метод Описание
final byte[] genExemptionBlob()
Генерирует блок ключа механизма исключения.
final int genExemptionBlob(byte[] output)
Генерирует блок ключа механизма исключения и сохраняет результат в буфере output.
final int genExemptionBlob(byte[] output, int outputOffset)
Генерирует блок ключа механизма исключения и сохраняет результат в буфере output, начиная с позиции outputOffset включительно.
static final ExemptionMechanism getInstance(String algorithm)
Возвращает объект ExemptionMechanism, реализующий указанный алгоритм механизма исключения.
static final ExemptionMechanism getInstance(String algorithm, String provider)
Возвращает объект ExemptionMechanism, реализующий указанный алгоритм механизма исключения.
static final ExemptionMechanism getInstance(String algorithm, Provider provider)
Возвращает объект ExemptionMechanism, реализующий указанный алгоритм механизма исключения.
final String getName()
Возвращает имя механизма исключения для этого объекта ExemptionMechanism.
final int getOutputSize(int inputLen)
Возвращает длину (в байтах) буфера вывода, необходимую для хранения результата следующей операции genExemptionBlob, с учётом длины ввода inputLen (в байтах).
final Provider getProvider()
Возвращает поставщика для этого объекта ExemptionMechanism.
final void init(Key key)
Инициализирует этот механизм исключения ключом.
final void init(Key key, AlgorithmParameters params)
Инициализирует этот механизм исключения ключом и набором параметров алгоритма.
final void init(Key key, AlgorithmParameterSpec params)
Инициализирует этот механизм исключения ключом и набором параметров алгоритма.
final boolean isCryptoAllowed(Key key)
Возвращает, был ли результат блока успешно сгенерирован этим механизмом исключения.

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

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

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

ExemptionMechanism

protected ExemptionMechanism(ExemptionMechanismSpi exmechSpi, Provider provider, String mechanism)
Создаёт объект ExemptionMechanism.
Параметры:
exmechSpi - делегат
provider - провайдер
mechanism - механизм исключения

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

getName

public final String getName()
Возвращает имя механизма исключения для этого объекта ExemptionMechanism.

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

Возвращает:
имя механизма исключения для этого объекта ExemptionMechanism.

getInstance

public static final ExemptionMechanism getInstance(String algorithm) throws NoSuchAlgorithmException
Возвращает объект ExemptionMechanism, реализующий указанный алгоритм механизма исключения.

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

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

Примечание реализации:
Реализация JDK дополнительно использует свойство jdk.security.provider.preferred Security для определения предпочтительного порядка поставщиков для указанного алгоритма. Это может отличаться от порядка поставщиков, возвращаемого методом Security.getProviders().
Параметры:
algorithm - стандартное имя запрошенного механизма исключения. См. раздел Механизмы исключения в Спецификации стандартных имён алгоритмов Java Security для получения информации о стандартных именах механизмов исключения.
Возвращает:
новый объект ExemptionMechanism
Исключения:
NoSuchAlgorithmException - если ни один Provider не поддерживает реализацию ExemptionMechanismSpi для указанного алгоритма
NullPointerException - если algorithm null
См. также:
  • Provider

getInstance

public static final ExemptionMechanism getInstance(String algorithm, String provider) throws NoSuchAlgorithmException, NoSuchProviderException
Возвращает объект ExemptionMechanism, реализующий указанный алгоритм механизма исключения.

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

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

Параметры:
algorithm - стандартное имя запрошенного механизма исключения. См. раздел Механизмы исключения в Спецификации стандартных имён алгоритмов Java Security для получения информации о стандартных именах механизмов исключения.
provider - имя поставщика.
Возвращает:
новый объект ExemptionMechanism
Исключения:
IllegalArgumentException - если provider null или пусто
NoSuchAlgorithmException - если реализация ExemptionMechanismSpi для указанного алгоритма недоступна от указанного поставщика
NoSuchProviderException - если указанный поставщик не зарегистрирован в списке поставщиков безопасности
NullPointerException - если algorithm null
См. также:
  • Provider

getInstance

public static final ExemptionMechanism getInstance(String algorithm, Provider provider) throws NoSuchAlgorithmException
Возвращает объект ExemptionMechanism, реализующий указанный алгоритм механизма исключения.

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

Параметры:
algorithm - стандартное имя запрошенного механизма исключения. См. раздел Механизмы исключения в Спецификации стандартных имён алгоритмов Java Security для получения информации о стандартных именах механизмов исключения.
provider - поставщик.
Возвращает:
новый объект ExemptionMechanism
Исключения:
IllegalArgumentException - если provider null
NoSuchAlgorithmException - если реализация ExemptionMechanismSpi для указанного алгоритма недоступна от указанного объекта Provider
NullPointerException - если algorithm null
См. также:
  • Provider

getProvider

public final Provider getProvider()
Возвращает поставщика этого объекта ExemptionMechanism.
Возвращает:
поставщик этого объекта ExemptionMechanism.

isCryptoAllowed

public final boolean isCryptoAllowed(Key key) throws ExemptionMechanismException
Возвращает, был ли успешно сгенерирован результат BLOB этим механизмом исключения.

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

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

getOutputSize

public final int getOutputSize(int inputLen) throws IllegalStateException
Возвращает длину в байтах, которую должен иметь буфер вывода для хранения результата следующей операции genExemptionBlob, учитывая длину входных данных inputLen (в байтах).

Фактическая длина вывода следующего вызова genExemptionBlob может быть меньше, чем длина, возвращенная этим методом.

Параметры:
inputLen - длина входных данных (в байтах)
Возвращает:
необходимый размер буфера вывода (в байтах)
Исключения:
IllegalStateException - если этот механизм исключения находится в неправильном состоянии (например, еще не инициализирован)

init

public final void init(Key key) throws InvalidKeyException, ExemptionMechanismException
Инициализирует этот механизм исключения с ключом.

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

Параметры:
key - ключ для этого механизма исключения
Исключения:
InvalidKeyException - если заданный ключ не подходит для этого механизма исключения.
ExemptionMechanismException - если возникли проблемы во время инициализации.

init

public final void init(Key key, AlgorithmParameterSpec params) throws InvalidKeyException, InvalidAlgorithmParameterException, ExemptionMechanismException
Инициализирует этот механизм исключения с ключом и набором параметров алгоритма.

Если этому механизму исключения требуются какие-либо параметры алгоритма и params null, предполагается, что реализация основного механизма исключения сгенерирует необходимые параметры самостоятельно (используя значения по умолчанию, специфичные для поставщика); в случае, если параметры алгоритма должны быть указаны вызывающей стороной, генерируется InvalidAlgorithmParameterException.

Параметры:
key - ключ для этого механизма исключения
params - параметры алгоритма
Исключения:
InvalidKeyException - если заданный ключ не подходит для этого механизма исключения.
InvalidAlgorithmParameterException - если заданные параметры алгоритма не подходят для этого механизма исключения.
ExemptionMechanismException - если возникли проблемы во время инициализации.

Инициализация

public final void init(Key key, AlgorithmParameters params) throws InvalidKeyException, InvalidAlgorithmParameterException, ExemptionMechanismException
Инициализирует этот механизм исключений с помощью ключа и набора параметров алгоритма.

Если этому механизму исключений требуются какие-либо параметры алгоритма, и params является null, предполагается, что реализация базового механизма исключений сгенерирует необходимые параметры самостоятельно (используя значения по умолчанию, специфичные для провайдера); в случае, если параметры алгоритма должны быть указаны вызывающей стороной, будет возбуждено исключение InvalidAlgorithmParameterException.

Параметры:
key - ключ для этого механизма исключений
params - параметры алгоритма
Исключения:
InvalidKeyException - если предоставленный ключ не подходит для этого механизма исключений.
InvalidAlgorithmParameterException - если предоставленные параметры алгоритма не подходят для этого механизма исключений.
ExemptionMechanismException - если при инициализации возникли проблемы.

Создание BLOB ключа исключения

public final byte[] genExemptionBlob() throws IllegalStateException, ExemptionMechanismException
Генерирует BLOB ключа механизма исключений.
Возвращает:
новый буфер с результатом BLOB ключа.
Исключения:
IllegalStateException - если этот механизм исключений находится в неправильном состоянии (например, не был инициализирован).
ExemptionMechanismException - если при генерации возникли проблемы.

Создание BLOB ключа исключения

public final int genExemptionBlob(byte[] output) throws IllegalStateException, ShortBufferException, ExemptionMechanismException
Генерирует BLOB ключа механизма исключений и сохраняет результат в буфере output.

Если буфер output слишком мал для хранения результата, будет возбуждено исключение ShortBufferException. В этом случае повторите вызов с более крупным буфером вывода. Используйте getOutputSize для определения необходимого размера буфера.

Параметры:
output - буфер для результата
Возвращает:
количество байт, сохранённых в output
Исключения:
IllegalStateException - если этот механизм исключений находится в неправильном состоянии (например, не был инициализирован).
ShortBufferException - если предоставленный буфер вывода слишком мал для хранения результата.
ExemptionMechanismException - если при генерации возникли проблемы.

Создание BLOB ключа исключения

public final int genExemptionBlob(byte[] output, int outputOffset) throws IllegalStateException, ShortBufferException, ExemptionMechanismException
Генерирует BLOB ключа механизма исключений и сохраняет результат в буфере output, начиная с позиции outputOffset включительно.

Если буфер output слишком мал для хранения результата, будет возбуждено исключение ShortBufferException. В этом случае повторите вызов с более крупным буфером вывода. Используйте getOutputSize для определения необходимого размера буфера.

Параметры:
output - буфер для результата
outputOffset - смещение в output , где сохраняется результат
Возвращает:
количество байт, сохранённых в output
Исключения:
IllegalStateException - если этот механизм исключений находится в неправильном состоянии (например, не был инициализирован).
ShortBufferException - если предоставленный буфер вывода слишком мал для хранения результата.
ExemptionMechanismException - если при генерации возникли проблемы.

© 1993, 2023, 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/21/docs/api/java.base/javax/crypto/ExemptionMechanism.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API