Класс KeyAgreementSpi

java.lang.Object

javax.crypto.KeyAgreementSpi

public abstract class KeyAgreementSpi extends Object

Этот класс определяет интерфейс поставщика службы (SPI) для класса KeyAgreement. Все абстрактные методы этого класса должны быть реализованы каждым поставщиком криптографических служб, который желает предоставить реализацию определённого алгоритма согласования ключей.

Ключи, участвующие в установлении общего секрета, создаются одним из генераторов ключей (KeyPairGenerator или KeyGenerator), KeyFactory либо в результате промежуточного этапа протокола согласования ключей (engineDoPhase).

Для каждого участника обмена ключами необходимо вызвать engineDoPhase. Например, если в обмене ключами участвует ещё одна сторона, engineDoPhase необходимо вызвать один раз, установив флаг lastPhase в значение true. Если в обмене ключами участвуют ещё две стороны, engineDoPhase необходимо вызвать дважды: при первом вызове установить флаг lastPhase в значение false, а при втором — в значение true. В обмене ключами может участвовать любое количество сторон.

Начиная с:

1.4

См. также:

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

Конструктор	Описание
`KeyAgreementSpi()`	Конструктор для вызова подклассами.

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

Модификатор и тип	Метод	Описание
`protected abstract Key`	`engineDoPhase(Key key, boolean lastPhase)`	Выполняет следующий этап этого согласования ключей с указанным ключом, полученным от одной из других сторон, участвующих в согласовании.
`protected abstract byte[]`	`engineGenerateSecret()`	Создаёт общий секрет и возвращает его в новом буфере.
`protected abstract int`	`engineGenerateSecret(byte[] sharedSecret, int offset)`	Создаёт общий секрет и помещает его в буфер `sharedSecret`, начиная с позиции `offset` включительно.
`protected abstract SecretKey`	`engineGenerateSecret(String algorithm)`	Создаёт общий секрет и возвращает его в виде объекта секретного ключа запрошенного типа алгоритма.
`protected abstract void`	`engineInit(Key key, SecureRandom random)`	Инициализирует это согласование ключей с указанным ключом и источником случайных данных.
`protected abstract void`	`engineInit(Key key, AlgorithmParameterSpec params, SecureRandom random)`	Инициализирует это согласование ключей с указанным ключом, набором параметров алгоритма и источником случайных данных.

Методы, объявленные в классе Object

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

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создаёт и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Указывает, является ли какой-либо другой объект «равным» этому объекту.
`protected void`	`finalize()`	Устарело, будет удалено: этот элемент API может быть удалён в будущей версии. Финализация объявлена устаревшей и может быть удалена в одном из следующих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`int`	`hashCode()`	Возвращает значение хеш-кода для этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать пробуждения, обычно вследствие вызова notify или прерывания.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать пробуждения, обычно вследствие вызова notify или прерывания, либо до истечения заданного времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать пробуждения, обычно вследствие вызова notify или прерывания, либо до истечения заданного времени.

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

KeyAgreementSpi

public KeyAgreementSpi()

Конструктор для вызова подклассами.

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

engineInit

protected abstract void engineInit(Key key, SecureRandom random) throws InvalidKeyException

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

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

Параметры:: key — закрытая информация стороны. Например, в случае согласования ключей Диффи — Хеллмана это будет собственный закрытый ключ Диффи — Хеллмана стороны.; random — источник случайных данных
Исключения:: InvalidKeyException — если указанный ключ не подходит для этого согласования ключей, например, имеет неверный тип или несовместимый тип алгоритма.

engineInit

protected abstract void engineInit(Key key, AlgorithmParameterSpec params, SecureRandom random) throws InvalidKeyException, InvalidAlgorithmParameterException

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

Параметры:: key — закрытая информация стороны. Например, в случае согласования ключей Диффи — Хеллмана это будет собственный закрытый ключ Диффи — Хеллмана стороны.; params — параметры согласования ключей; random — источник случайных данных
Исключения:: InvalidKeyException — если указанный ключ не подходит для этого согласования ключей, например, имеет неверный тип или несовместимый тип алгоритма.; InvalidAlgorithmParameterException — если указанные параметры не подходят для этого согласования ключей.

engineDoPhase

protected abstract Key engineDoPhase(Key key, boolean lastPhase) throws InvalidKeyException, IllegalStateException

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

Параметры:: key — ключ для этого этапа. Например, при согласовании ключей Диффи — Хеллмана между двумя сторонами это будет открытый ключ Диффи — Хеллмана другой стороны.; lastPhase — флаг, указывающий, является ли этот этап последним этапом согласования ключей.
Возвращает:: ключ (промежуточный), полученный в результате этого этапа, или null, если на этом этапе ключ не формируется
Исключения:: InvalidKeyException — если указанный ключ не подходит для этого этапа.; IllegalStateException — если это согласование ключей не было инициализировано.

engineGenerateSecret

protected abstract byte[] engineGenerateSecret() throws IllegalStateException

Создаёт общий секрет и возвращает его в новом буфере.

Этот метод сбрасывает объект KeyAgreementSpi до состояния, в котором он находился после последнего вызова одного из методов init. После вызова generateSecret объект можно повторно использовать для дальнейших операций согласования ключей: вызвать doPhase для передачи новых ключей, а затем вызвать generateSecret для создания нового секрета. В этом случае закрытая информация и параметры алгоритма, переданные в init, будут использоваться в нескольких операциях согласования ключей. После generateSecret можно вызвать метод init, чтобы изменить закрытую информацию, используемую в последующих операциях.

Возвращает:: новый буфер с общим секретом
Исключения:: IllegalStateException — если это согласование ключей не было инициализировано или если не был вызван doPhase для передачи ключей всех участников согласования

engineGenerateSecret

protected abstract int engineGenerateSecret(byte[] sharedSecret, int offset) throws IllegalStateException, ShortBufferException

Создаёт общий секрет и помещает его в буфер sharedSecret, начиная с позиции offset включительно.

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

Параметры:: sharedSecret — буфер для общего секрета; offset — смещение в sharedSecret, начиная с которого будет сохранён общий секрет
Возвращает:: количество байтов, помещённых в sharedSecret
Исключения:: IllegalStateException — если это согласование ключей не было инициализировано или если не был вызван doPhase для передачи ключей всех участников согласования; ShortBufferException — если указанный выходной буфер слишком мал для хранения секрета

engineGenerateSecret

protected abstract SecretKey engineGenerateSecret(String algorithm) throws IllegalStateException, NoSuchAlgorithmException, InvalidKeyException

Создаёт общий секрет и возвращает его в виде объекта секретного ключа запрошенного типа алгоритма.

Параметры:

algorithm — запрошенный алгоритм секретного ключа. Он отличается от алгоритма KeyAgreement, переданного методу getInstance. Сведения о стандартных именах алгоритмов секретных ключей см. в разделе SecretKey Algorithms спецификации Стандартные имена алгоритмов безопасности Java. Укажите «Generic», если результат будет использоваться в качестве исходного ключевого материала для функции получения ключа (KDF).

Возвращает:

секретный ключ общего секрета. Длина ключевого материала может быть скорректирована для совместимости с указанным алгоритмом независимо от того, допускается ли извлечение ключа. Если algorithm указано как «Generic» и поддерживается реализацией, возвращается общий секрет целиком.

Исключения:

IllegalStateException — если это согласование ключей не было инициализировано или если не был вызван doPhase для передачи ключей всех участников согласования

NoSuchAlgorithmException — если указанный алгоритм секретного ключа не поддерживается

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.