Класс ExemptionMechanism

java.lang.Object
- javax.crypto.ExemptionMechanism

public class ExemptionMechanism
extends Object

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

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

Since:: 1.4

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

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

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

Модификатор и тип	Метод	Описание
`byte[]`	`genExemptionBlob()`	Генерирует фрагмент ключа механизма исключения.
`int`	`genExemptionBlob(byte[] output)`	Генерирует фрагмент ключа механизма исключения и сохраняет результат в буфере `output`.
`int`	`genExemptionBlob(byte[] output, int outputOffset)`	Генерирует фрагмент ключа механизма исключения и сохраняет результат в буфере `output`, начиная с индекса `outputOffset` включительно.
`static ExemptionMechanism`	`getInstance(String algorithm)`	Возвращает объект `ExemptionMechanism`, реализующий указанный алгоритм механизма исключения.
`static ExemptionMechanism`	`getInstance(String algorithm, String provider)`	Возвращает объект `ExemptionMechanism`, реализующий указанный алгоритм механизма исключения.
`static ExemptionMechanism`	`getInstance(String algorithm, Provider provider)`	Возвращает объект `ExemptionMechanism`, реализующий указанный алгоритм механизма исключения.
`String`	`getName()`	Возвращает имя механизма исключения для этого объекта `ExemptionMechanism`.
`int`	`getOutputSize(int inputLen)`	Возвращает длину (в байтах), необходимую для буфера вывода, чтобы содержать результат следующей операции `genExemptionBlob`, учитывая длину входных данных `inputLen` (в байтах).
`Provider`	`getProvider()`	Возвращает поставщика для этого объекта `ExemptionMechanism`.
`void`	`init(Key key)`	Инициализирует этот механизм исключения ключом.
`void`	`init(Key key, AlgorithmParameters params)`	Инициализирует этот механизм исключения ключом и набором параметров алгоритма.
`void`	`init(Key key, AlgorithmParameterSpec params)`	Инициализирует этот механизм исключения ключом и набором параметров алгоритма.
`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 - стандартное имя запрошенного механизма исключения. См. раздел ExemptionMechanism в Спецификации имен стандартных алгоритмов безопасности Java для получения информации о стандартных именах механизмов исключения.
Возвращает:: новый объект ExemptionMechanism
Исключения:: NoSuchAlgorithmException - если ни один поставщик Provider не поддерживает реализацию ExemptionMechanismSpi для указанного алгоритма; NullPointerException - если algorithm является null
См. также:: Provider

getInstance

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

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

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

Параметры:: algorithm - стандартное имя запрошенного механизма исключения. См. раздел ExemptionMechanism в Спецификации имен стандартных алгоритмов безопасности Java для получения информации о стандартных именах механизмов исключения.; 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 от указанного объекта Provider. Обратите внимание, что указанный объект Provider не обязательно должен быть зарегистрирован в списке поставщиков.

Параметры:: algorithm - стандартное имя запрошенного механизма исключения. См. раздел ExemptionMechanism в Спецификации имен стандартных алгоритмов безопасности Java для получения информации о стандартных именах механизмов исключения.; provider - поставщик.
Возвращает:: новый объект ExemptionMechanism
Исключения:: IllegalArgumentException - если provider равен null; NoSuchAlgorithmException - если реализация ExemptionMechanismSpi для указанного алгоритма недоступна от указанного Provider object; 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 - если при инициализации возникли проблемы.

init

public final void init(Key key,
                       AlgorithmParameters params)
                throws InvalidKeyException,
                       InvalidAlgorithmParameterException,
                       ExemptionMechanismException

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

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

genExemptionBlob

public final byte[] genExemptionBlob()
                              throws IllegalStateException,
                                     ExemptionMechanismException

Генерирует BLOB ключа механизма исключения.

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

genExemptionBlob

public final int genExemptionBlob(byte[] output)
                           throws IllegalStateException,
                                  ShortBufferException,
                                  ExemptionMechanismException

Генерирует BLOB ключа механизма исключения и сохраняет результат в буфере output.

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

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

genExemptionBlob

public final int genExemptionBlob(byte[] output,
                                  int outputOffset)
                           throws IllegalStateException,
                                  ShortBufferException,
                                  ExemptionMechanismException

Генерирует блок ключа механизма исключений и сохраняет результат в буфер output, начиная с позиции outputOffset.

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

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

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