Класс 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

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

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. Сведения о стандартных именах алгоритмов секретных ключей см. в разделе «Алгоритмы секретных ключей» спецификации стандартных имён алгоритмов безопасности 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.
https://docs.oracle.com/en/java/javase/25/docs/api/java.base/javax/crypto/KeyAgreementSpi.html