Класс 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)`	Генерирует блок ключа механизма исключения и сохраняет результат в буфере %%%CODE_BLOCK_7%%.
`final int`	`genExemptionBlob(byte[] output, int outputOffset)`	Генерирует блок ключа механизма исключения и сохраняет результат в буфере %%%CODE_BLOCK_10%%, начиная с позиции %%%CODE_BLOCK_11%% включительно.
`static final ExemptionMechanism`	`getInstance(String algorithm)`	Возвращает объект, реализующий указанный алгоритм механизма исключения.
`static final ExemptionMechanism`	`getInstance(String algorithm, String provider)`	Возвращает объект, реализующий указанный алгоритм механизма исключения.
`static final ExemptionMechanism`	`getInstance(String algorithm, Provider provider)`	Возвращает объект, реализующий указанный алгоритм механизма исключения.
`final String`	`getName()`	Возвращает имя механизма исключения для этого объекта %%%CODE_BLOCK_23%%.
`final int`	`getOutputSize(int inputLen)`	Возвращает длину (в байтах), необходимую для буфера вывода, чтобы содержать результат следующей операции `genExemptionBlob`, с учетом длины входных данных %%%CODE_BLOCK_27%% (в байтах).
`final Provider`	`getProvider()`	Возвращает поставщика этого объекта %%%CODE_BLOCK_30%%.
`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 Standard Algorithm Names.

Возвращает:

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

Исключения:

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

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

См. также:

Provider

getInstance

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

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

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

Параметры:

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 не обязательно должен быть зарегистрирован в списке поставщиков.

Параметры:

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

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

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

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

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

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

Возвращает:: новый буфер с результатом блока ключей.
Исключения:: 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

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

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

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