java.lang.Object
- javax.crypto.KeyAgreementSpi

```
public abstract class KeyAgreementSpi
extends Object
```
このクラスは、KeyAgreementクラスのサービス・プロバイダ・インタフェース (SPI)を定義します。特定の鍵合意アルゴリズムの実装を提供する各暗号化サービス・プロバイダは、このクラスのすべての抽象メソッドを実装する必要があります。
共有の秘密作成に関係する鍵は、KeyPairGeneratorまたはKeyGeneratorのいずれかの鍵ジェネレータか、KeyFactoryにより、または鍵協定プロトコル(engineDoPhase)の中間フェーズの結果として作成されます。
鍵交換の対応関係ごとに、engineDoPhaseを呼び出す必要があります。たとえば、鍵交換の相手が1つの場合は、lastPhaseフラグをtrueに設定してengineDoPhaseを1回呼び出す必要があります。鍵交換の相手が2つの場合は、最初はlastPhaseフラグをfalseに設定し、2回目はtrueに設定して、engineDoPhaseを2回呼び出す必要があります。鍵交換の相手の数は任意です。

導入されたバージョン:

1.4

関連項目:

KeyGenerator, SecretKey

コンストラクタのサマリー

コンストラクタ
コンストラクタ説明

KeyAgreementSpi()

メソッドのサマリー

すべてのメソッドインスタンス・メソッド抽象メソッド
修飾子と型	メソッド	説明
`protected abstract Key`	`engineDoPhase(Key key, boolean lastPhase)`	この鍵合意に関係する相手のだれかから受け取った、指定された鍵を使用してこの鍵合意の次の段階を実行します。
`protected abstract byte[]`	`engineGenerateSecret()`	共有の秘密情報を生成して新しいバッファ内に返します。
`protected abstract int`	`engineGenerateSecret(byte[] sharedSecret, int offset)`	共有の秘密情報を生成して、`offset`から始まる`sharedSecret`バッファ内に格納します。
`protected abstract SecretKey`	`engineGenerateSecret(String algorithm)`	共有の秘密情報を作成して、それを要求されたアルゴリズム型の秘密鍵オブジェクトとして返します。
`protected abstract void`	`engineInit(Key key, SecureRandom random)`	指定された鍵と乱数発生の元でこの鍵合意を初期化します。
`protected abstract void`	`engineInit(Key key, AlgorithmParameterSpec params, SecureRandom random)`	指定された鍵、アルゴリズム・パラメータのセット、および乱数発生の元を使用してこの鍵合意を初期化します。

クラス java.lang.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 - 当事者の非公開情報。たとえば、Diffie-Hellmanの鍵合意の場合は、当事者自身のDiffie-Hellman非公開鍵
    
    random - 乱数発生の元
    
    例外:
    
    InvalidKeyException - 指定された鍵がこの鍵合意に不適切な場合。たとえば、型が間違っている場合、またはアルゴリズムの型に互換性がない場合。
  - engineInit
```
protected abstract void engineInit(Key key,
                                   AlgorithmParameterSpec params,
                                   SecureRandom random)
                            throws InvalidKeyException,
                                   InvalidAlgorithmParameterException
```
    指定された鍵、アルゴリズム・パラメータのセット、および乱数発生の元を使用してこの鍵合意を初期化します。
    
    パラメータ:
    
    key - 当事者の非公開情報。たとえば、Diffie-Hellmanの鍵合意の場合は、当事者自身のDiffie-Hellman非公開鍵
    
    params - 鍵合意パラメータ
    
    random - 乱数発生の元
    
    例外:
    
    InvalidKeyException - 指定された鍵がこの鍵合意に不適切な場合。たとえば、型が間違っている場合、またはアルゴリズムの型に互換性がない場合。
    
    InvalidAlgorithmParameterException - 指定されたパラメータがこの鍵合意に不適切な場合。
  - engineDoPhase
```
protected abstract Key engineDoPhase(Key key,
                                     boolean lastPhase)
                              throws InvalidKeyException,
                                     IllegalStateException
```
    この鍵合意に関係する相手のだれかから受け取った、指定された鍵を使用してこの鍵合意の次の段階を実行します。
    
    パラメータ:
    
    key - この段階の鍵。たとえば、2当事者間のDiffie-Hellmanの場合は、相手のDiffie-Hellman公開鍵
    
    lastPhase - これがこの鍵合意の最後の段階かどうかを示すフラグ。
    
    戻り値:
    
    この段階の結果の(中間)鍵。この段階で鍵が生成されない場合はnull
    
    例外:
    
    InvalidKeyException - 指定された鍵がこの段階に不適切な場合。
    
    IllegalStateException - この鍵合意が初期化されていない場合。
  - engineGenerateSecret
```
protected abstract byte[] engineGenerateSecret()
                                        throws IllegalStateException
```
    共有の秘密情報を生成して新しいバッファ内に返します。
    このメソッドは、このKeyAgreementSpiオブジェクトをリセットするので、さらにほかの鍵合意に再使用できます。この鍵合意がengineInitメソッドの1つで再初期化されない場合、その後の鍵合意では、同じ非公開情報とアルゴリズム・パラメータが使用されます。
    
    戻り値:
    
    共有の秘密情報の入った新しいバッファ
    
    例外:
    
    IllegalStateException - この鍵合意がまだ完了していない場合
  - engineGenerateSecret
```
protected abstract int engineGenerateSecret(byte[] sharedSecret,
                                            int offset)
                                     throws IllegalStateException,
                                            ShortBufferException
```
    共有の秘密情報を生成して、offsetから始まるsharedSecretバッファ内に格納します。
    sharedSecretバッファが小さすぎて結果を保持できない場合は、ShortBufferExceptionがスローされます。この場合、より大きな出力バッファを使用してこの呼出しを繰り返します。
    このメソッドは、このKeyAgreementSpiオブジェクトをリセットするので、さらにほかの鍵合意に再使用できます。この鍵合意がengineInitメソッドの1つで再初期化されない場合、その後の鍵合意では、同じ非公開情報とアルゴリズム・パラメータが使用されます。
    
    パラメータ:
    
    sharedSecret - 共有の秘密情報を格納するバッファ
    
    offset - 共有の秘密情報が格納されるsharedSecret内のオフセット
    
    戻り値:
    
    sharedSecretに格納されたバイト数
    
    例外:
    
    IllegalStateException - この鍵合意がまだ完了していない場合
    
    ShortBufferException - 指定された出力バッファが小さすぎて秘密情報を保持できない場合
  - engineGenerateSecret
```
protected abstract SecretKey engineGenerateSecret(String algorithm)
                                           throws IllegalStateException,
                                                  NoSuchAlgorithmException,
                                                  InvalidKeyException
```
    共有の秘密情報を作成して、それを要求されたアルゴリズム型の秘密鍵オブジェクトとして返します。
    このメソッドは、このKeyAgreementSpiオブジェクトをリセットするので、さらにほかの鍵合意に再使用できます。この鍵合意がengineInitメソッドの1つで再初期化されない場合、その後の鍵合意では、同じ非公開情報とアルゴリズム・パラメータが使用されます。
    
    パラメータ:
    
    algorithm - 要求された秘密鍵アルゴリズム
    
    戻り値:
    
    共有の秘密鍵
    
    例外:
    
    IllegalStateException - この鍵合意がまだ完了していない場合
    
    NoSuchAlgorithmException - 要求された秘密鍵アルゴリズムがない場合
    
    InvalidKeyException - 共有の秘密鍵データを使用して、要求されたアルゴリズム型の秘密鍵を生成できない場合(鍵データが短すぎるなど)

クラスKeyAgreementSpi

コンストラクタのサマリー

メソッドのサマリー

クラス java.lang.Objectから継承されたメソッド

コンストラクタの詳細

KeyAgreementSpi

メソッドの詳細

engineInit

engineInit

engineDoPhase

engineGenerateSecret

engineGenerateSecret

engineGenerateSecret