KeyAgreement (Платформа Java SE 7)

java.lang. Объект
- javax.crypto. KeyAgreement

```
public class KeyAgreement
extends Object
```
Этот класс обеспечивает функциональность согласования ключей (или ключевой обмен) протокол.
Ключи, включенные в установление совместно используемого секрета, создаются одним из ключевых генераторов (KeyPairGenerator или KeyGenerator), a KeyFactory, или в результате от промежуточной фазы протокола согласования ключей.
Для каждого из корреспондентов в ключевом обмене, doPhase потребности, которые вызовут. Например, если этот ключевой обмен с одной другой стороной, doPhase потребности, которые вызовут однажды, с lastPhase отметьте набор к true. Если этот ключевой обмен с двумя другими сторонами, doPhase потребности, которые вызовут дважды, в первый раз устанавливая lastPhase флаг к false, и во второй раз, устанавливающий это в true. Может быть любое число сторон, включенных в ключевой обмен.
Каждая реализация платформы Java обязана поддерживать следующий стандарт KeyAgreement алгоритм:
- DiffieHellman
Этот алгоритм описывается в разделе KeyAgreement Документации Имени Алгоритма Стандарта Архитектуры Криптографии Java. Консультируйтесь с документацией выпуска для своей реализации, чтобы видеть, поддерживаются ли какие-либо другие алгоритмы.
С тех пор:

1.4

См. Также:
KeyGenerator, SecretKey

Сводка конструктора

Конструкторы
Модификатор	Конструктор и Описание
`protected`	`KeyAgreement(KeyAgreementSpi keyAgreeSpi, Provider provider, String algorithm)` Создает объект KeyAgreement.

Сводка метода

Методы
Модификатор и Тип	Метод и Описание
`Ключ`	`doPhase(Key key, boolean lastPhase)` Выполняет следующую фазу этого согласования ключей с данным ключом, который был получен от одной из других сторон, включенных в это согласование ключей.
`byte[]`	`generateSecret()` Генерирует совместно используемый секрет и возвращает это в новом буфере.
`int`	`generateSecret(byte[] sharedSecret, int offset)` Генерирует совместно используемый секрет, и помещает это в буфер `sharedSecret`, начало в `offset` включительно.
`SecretKey`	`generateSecret(String algorithm)` Создает совместно используемый секрет и возвращает это как a `SecretKey` объект указанного алгоритма.
`Строка`	`getAlgorithm()` Возвращает имя алгоритма этого `KeyAgreement` объект.
`static KeyAgreement`	`getInstance(String algorithm)` Возвраты a `KeyAgreement` возразите, что реализует указанный алгоритм согласования ключей.
`static KeyAgreement`	`getInstance(String algorithm, Provider provider)` Возвраты a `KeyAgreement` возразите, что реализует указанный алгоритм согласования ключей.
`static KeyAgreement`	`getInstance(String algorithm, String provider)` Возвраты a `KeyAgreement` возразите, что реализует указанный алгоритм согласования ключей.
`Провайдер`	`getProvider()` Возвращает провайдера этого `KeyAgreement` объект.
`void`	`init(Key key)` Инициализирует это согласование ключей с данным ключом, который обязан содержать все параметры алгоритма, требуемые для этого согласования ключей.
`void`	`init(Key key, AlgorithmParameterSpec params)` Инициализирует это согласование ключей с данным ключом и набором параметров алгоритма.
`void`	`init(Key key, AlgorithmParameterSpec params, SecureRandom random)` Инициализирует это согласование ключей с данным ключом, набором параметров алгоритма, и источником случайности.
`void`	`init(Key key, SecureRandom random)` Инициализирует это согласование ключей с данным ключом и источником случайности.

Методы java.lang унаследованный от класса. Объект
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Деталь конструктора
  - KeyAgreement
```
protected KeyAgreement(KeyAgreementSpi keyAgreeSpi,
            Provider provider,
            String algorithm)
```
    Создает объект KeyAgreement.
    
    Параметры:
    keyAgreeSpi - делегат
    provider - провайдер
    algorithm - алгоритм
- Деталь метода
  - getAlgorithm
```
public final String getAlgorithm()
```
    Возвращает имя алгоритма этого KeyAgreement объект.
    Это - то же самое имя, которое было определено в одном из getInstance вызовы, которые создали это KeyAgreement объект.
    
    Возвраты:
    имя алгоритма этого KeyAgreement объект.
  - getInstance
```
public static final KeyAgreement getInstance(String algorithm)
                                      throws NoSuchAlgorithmException
```
    Возвраты a KeyAgreement возразите, что реализует указанный алгоритм согласования ключей.
    Этот метод пересекает список зарегистрированных поставщиков систем обеспечения безопасности, запускающихся с самого привилегированного Провайдера. Возвращается новый объект KeyAgreement инкапсуляция реализации KeyAgreementSpi от первого Провайдера, который поддерживает указанный алгоритм.
    Отметьте, что список зарегистрированных провайдеров может быть получен через Security.getProviders() метод.
    
    Параметры:
    algorithm - стандартное имя требуемого алгоритма согласования ключей. См. раздел KeyAgreement в Документации Имени Алгоритма Стандарта Архитектуры Криптографии Java для информации о стандартных именах алгоритма.
    
    Возвраты:
    новое KeyAgreement объект.
    
    Броски:
    
    NullPointerException - если указанный алгоритм является нулем.
    
    NoSuchAlgorithmException - если никакой Провайдер не поддерживает реализацию KeyAgreementSpi для указанного алгоритма.
    См. Также:
    Provider
  - getInstance
```
public static final KeyAgreement getInstance(String algorithm,
                       String provider)
                                      throws NoSuchAlgorithmException,
                                             NoSuchProviderException
```
    Возвраты a KeyAgreement возразите, что реализует указанный алгоритм согласования ключей.
    Возвращается новый объект KeyAgreement инкапсуляция реализации KeyAgreementSpi от указанного провайдера. Указанный провайдер должен быть зарегистрирован в списке поставщика систем обеспечения безопасности.
    Отметьте, что список зарегистрированных провайдеров может быть получен через Security.getProviders() метод.
    
    Параметры:
    algorithm - стандартное имя требуемого алгоритма согласования ключей. См. раздел KeyAgreement в Документации Имени Алгоритма Стандарта Архитектуры Криптографии Java для информации о стандартных именах алгоритма.
    provider - имя провайдера.
    
    Возвраты:
    новое KeyAgreement объект.
    
    Броски:
    
    NullPointerException - если указанный алгоритм является нулем.
    
    NoSuchAlgorithmException - если реализация KeyAgreementSpi для указанного алгоритма не доступна от указанного провайдера.
    
    NoSuchProviderException - если указанный провайдер не регистрируется в списке поставщика систем обеспечения безопасности.
    
    IllegalArgumentException - если provider нуль или пустой.
    См. Также:
    Provider
  - getInstance
```
public static final KeyAgreement getInstance(String algorithm,
                       Provider provider)
                                      throws NoSuchAlgorithmException
```
    Возвраты a KeyAgreement возразите, что реализует указанный алгоритм согласования ключей.
    Возвращается новый объект KeyAgreement инкапсуляция реализации KeyAgreementSpi от указанного объекта Провайдера. Отметьте, что указанный объект Провайдера не должен быть зарегистрирован в списке провайдера.
    
    Параметры:
    algorithm - стандартное имя требуемого алгоритма согласования ключей. См. раздел KeyAgreement в Документации Имени Алгоритма Стандарта Архитектуры Криптографии Java для информации о стандартных именах алгоритма.
    provider - провайдер.
    
    Возвраты:
    новое KeyAgreement объект.
    
    Броски:
    
    NullPointerException - если указанный алгоритм является нулем.
    
    NoSuchAlgorithmException - если реализация KeyAgreementSpi для указанного алгоритма не доступна от указанного объекта Провайдера.
    
    IllegalArgumentException - если provider нуль.
    См. Также:
    Provider
  - getProvider
```
public final Provider getProvider()
```
    Возвращает провайдера этого KeyAgreement объект.
    
    Возвраты:
    провайдер этого KeyAgreement объект
  - init
```
public final void init(Key key)
                throws InvalidKeyException
```
    Инициализирует это согласование ключей с данным ключом, который обязан содержать все параметры алгоритма, требуемые для этого согласования ключей.
    Если это согласование ключей потребует каких-либо случайных байтов, то это получит их использующий SecureRandom реализация самого высокого приоритета установленный провайдер как источник случайности. (Если ни один из установленных провайдеров не предоставит реализацию SecureRandom, то обеспеченный системой источник случайности будет использоваться.)
    
    Параметры:
    key - частная информация стороны. Например, в случае согласования ключей Diffie-Hellman, это было бы собственным закрытым ключом стороны Diffie-Hellman.
    
    Броски:
    
    InvalidKeyException - если данный ключ является несоответствующим для этого согласования ключей, например, имеет неправильный тип или имеет несовместимый тип алгоритма.
  - init
```
public final void init(Key key,
        SecureRandom random)
                throws InvalidKeyException
```
    Инициализирует это согласование ключей с данным ключом и источником случайности. Данный ключ обязан содержать все параметры алгоритма, требуемые для этого согласования ключей.
    Если алгоритм согласования ключей требует случайных байтов, это получает их от данного источника случайности, random. Однако, если базовая реализация алгоритма не требует никаких случайных байтов, random игнорируется.
    
    Параметры:
    key - частная информация стороны. Например, в случае согласования ключей Diffie-Hellman, это было бы собственным закрытым ключом стороны Diffie-Hellman.
    random - источник случайности
    
    Броски:
    
    InvalidKeyException - если данный ключ является несоответствующим для этого согласования ключей, например, имеет неправильный тип или имеет несовместимый тип алгоритма.
  - init
```
public final void init(Key key,
        AlgorithmParameterSpec params)
                throws InvalidKeyException,
                       InvalidAlgorithmParameterException
```
    Инициализирует это согласование ключей с данным ключом и набором параметров алгоритма.
    Если это согласование ключей потребует каких-либо случайных байтов, то это получит их использующий SecureRandom реализация самого высокого приоритета установленный провайдер как источник случайности. (Если ни один из установленных провайдеров не предоставит реализацию SecureRandom, то обеспеченный системой источник случайности будет использоваться.)
    
    Параметры:
    key - частная информация стороны. Например, в случае согласования ключей Diffie-Hellman, это было бы собственным закрытым ключом стороны Diffie-Hellman.
    params - параметры согласования ключей
    
    Броски:
    
    InvalidKeyException - если данный ключ является несоответствующим для этого согласования ключей, например, имеет неправильный тип или имеет несовместимый тип алгоритма.
    
    InvalidAlgorithmParameterException - если данные параметры являются несоответствующими для этого согласования ключей.
  - init
```
public final void init(Key key,
        AlgorithmParameterSpec params,
        SecureRandom random)
                throws InvalidKeyException,
                       InvalidAlgorithmParameterException
```
    Инициализирует это согласование ключей с данным ключом, набором параметров алгоритма, и источником случайности.
    
    Параметры:
    key - частная информация стороны. Например, в случае согласования ключей Diffie-Hellman, это было бы собственным закрытым ключом стороны Diffie-Hellman.
    params - параметры согласования ключей
    random - источник случайности
    
    Броски:
    
    InvalidKeyException - если данный ключ является несоответствующим для этого согласования ключей, например, имеет неправильный тип или имеет несовместимый тип алгоритма.
    
    InvalidAlgorithmParameterException - если данные параметры являются несоответствующими для этого согласования ключей.
  - doPhase
```
public final Key doPhase(Key key,
          boolean lastPhase)
                  throws InvalidKeyException,
                         IllegalStateException
```
    Выполняет следующую фазу этого согласования ключей с данным ключом, который был получен от одной из других сторон, включенных в это согласование ключей.
    
    Параметры:
    key - ключ для этой фазы. Например, в случае Diffie-Hellman между 2 сторонами, это было бы открытым ключом другой стороны Diffie-Hellman.
    lastPhase - флаг, который указывает, является ли это последней фазой этого согласования ключей.
    
    Возвраты:
    (промежуточный) ключ, следующий из этой фазы, или нуля, если эта фаза не приводит к ключу
    
    Броски:
    
    InvalidKeyException - если данный ключ является несоответствующим для этой фазы.
    
    IllegalStateException - если это согласование ключей не было инициализировано.
  - generateSecret
```
public final byte[] generateSecret()
                            throws IllegalStateException
```
    Генерирует совместно используемый секрет и возвращает это в новом буфере.
    Этот метод сбрасывает это KeyAgreement объект, так, чтобы это могло быть снова использовано для дальнейших согласований ключей. Если это согласование ключей не повторно инициализируется с одним из init методы, та же самая частная информация и параметры алгоритма будут использоваться для последующих согласований ключей.
    
    Возвраты:
    новый буфер с совместно используемым секретом
    
    Броски:
    
    IllegalStateException - если это согласование ключей еще не было завершено
  - generateSecret
```
public final int generateSecret(byte[] sharedSecret,
                 int offset)
                         throws IllegalStateException,
                                ShortBufferException
```
    Генерирует совместно используемый секрет, и помещает это в буфер sharedSecret, начало в offset включительно.
    Если sharedSecret буфер является слишком маленьким, чтобы содержать результат, a ShortBufferException бросается. В этом случае этот вызов должен быть повторен с большим буфером вывода.
    Этот метод сбрасывает это KeyAgreement объект, так, чтобы это могло быть снова использовано для дальнейших согласований ключей. Если это согласование ключей не повторно инициализируется с одним из init методы, та же самая частная информация и параметры алгоритма будут использоваться для последующих согласований ключей.
    
    Параметры:
    sharedSecret - буфер для совместно используемого секрета
    offset - смещение в sharedSecret где совместно используемый секрет будет сохранен
    
    Возвраты:
    число байтов, помещенных в sharedSecret
    
    Броски:
    
    IllegalStateException - если это согласование ключей еще не было завершено
    
    ShortBufferException - если данный буфер вывода является слишком небольшим, чтобы содержать секрет
  - generateSecret
```
public final SecretKey generateSecret(String algorithm)
                               throws IllegalStateException,
                                      NoSuchAlgorithmException,
                                      InvalidKeyException
```
    Создает совместно используемый секрет и возвращает это как a SecretKey объект указанного алгоритма.
    Этот метод сбрасывает это KeyAgreement объект, так, чтобы это могло быть снова использовано для дальнейших согласований ключей. Если это согласование ключей не повторно инициализируется с одним из init методы, та же самая частная информация и параметры алгоритма будут использоваться для последующих согласований ключей.
    
    Параметры:
    algorithm - требуемый алгоритм секретного ключа
    
    Возвраты:
    совместно используемый секретный ключ
    
    Броски:
    
    IllegalStateException - если это согласование ключей еще не было завершено
    
    NoSuchAlgorithmException - если указанный алгоритм секретного ключа не доступен
    
    InvalidKeyException - если совместно используемый материал секретного ключа не может использоваться, чтобы генерировать секретный ключ указанного алгоритма (например, ключевой материал слишком короток),

Представьте ошибку или функцию
Для дальнейшей ссылки API и документации разработчика, см. Java Документация SE. Та документация содержит более подробные, предназначенные разработчиком описания, с концептуальными краткими обзорами, определениями сроков, обходных решений, и рабочих примеров кода.
Авторское право © 1993, 2011, Oracle и/или его филиалы. Все права защищены.

Класс KeyAgreement

Сводка конструктора

Сводка метода

Методы java.lang унаследованный от класса. Объект

Деталь конструктора

KeyAgreement

Деталь метода

getAlgorithm

getInstance

getInstance

getInstance

getProvider

init

init

init

init

doPhase

generateSecret

generateSecret

generateSecret