javax.crypto
클래스 KeyAgreement

java.lang.Object 
  javax.crypto.KeyAgreement

public class KeyAgreement
extends Object 

이 클래스는 키의 합의 프로토콜, 즉 키의 교환 프로토콜의 기능을 제공합니다. 공유의 비밀 정보의 확립에 관계된 키는 키 제네레이터 (KeyPairGenerator 또는 KeyGenerator)의 1개, 또는 KeyFactory에 의해 혹은 키 합의 프로토콜의 중간 단계의 결과로서 작성됩니다. 키 교환의 대응 관계 마다, doPhase를 호출할 필요가 있습니다. 예를 들어 키 교환의 상대가 1개의 경우는 lastPhase 플래그를 true로 설정해 doPhase를 1회 호출할 필요가 있습니다. 키 교환의 상대가 2개의 경우는 처음은 lastPhase 플래그를 false로 설정해, 2번째는 true로 설정해, doPhase를 2회 호출할 필요가 있습니다. 키 교환의 상대의 수는 임의입니다.

도입된 버전 :

1.4

관련 항목:

KeyGenerator, SecretKey

생성자 개요

protected

KeyAgreement (KeyAgreementSpi keyAgreeSpi, Provider provider, String algorithm) KeyAgreement 객체를 작성합니다.

메서드 개요

Key	doPhase (Key key, boolean lastPhase) 이 키 합의에 관계된 상대의 누군가로부터 받은 지정된 키를 사용해 이 키 합의의 다음의 단계를 실행합니다.
byte[]	generateSecret () 공유의 비밀 정보를 생성해 새로운 버퍼내에 리턴합니다.
int	generateSecret (byte[] sharedSecret, int offset) 공유의 비밀 정보를 생성해, offset로 부터 시작되는 sharedSecret 버퍼내에 포함합니다.
SecretKey	generateSecret (String algorithm) 공유의 비밀 정보를 작성해, 그것이 지정된 알고리즘의 SecretKey 객체로서 리턴합니다.
String	getAlgorithm () 이 KeyAgreement 객체의 알고리즘명을 리턴합니다.
static KeyAgreement	getInstance (String algorithm) 지정된 키 합의 알고리즘을 구현하는 KeyAgreement 객체를 작성합니다.
static KeyAgreement	getInstance (String algorithm, Provider provider) 지정된 프로바이더로부터, 지정된 키 합의 알고리즘의 KeyAgreement 객체를 생성합니다.
static KeyAgreement	getInstance (String algorithm, String provider) 지정된 프로바이더로부터, 지정된 키 합의 알고리즘의 KeyAgreement 객체를 작성합니다.
Provider	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. Object 로부터 상속된 메서드

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 객체의 알고리즘명을 리턴합니다.

이것은 이 KeyAgreement 객체를 작성한 getInstance 호출의 1개 로 지정된 이름과 같습니다.

반환값:

이 KeyAgreement 객체의 알고리즘명

getInstance

public static final KeyAgreement  getInstance(String  algorithm)
                                      throws NoSuchAlgorithmException 

지정된 키 합의 알고리즘을 구현하는 KeyAgreement 객체를 작성합니다. 디폴트의 프로바이더의 패키지가 요구된 키 합의 알고리즘의 구현을 제공하고 있는 경우는 그 구현을 가진 KeyAgreement 클래스의 인스턴스가 리턴됩니다 . 알고리즘이 디폴트의 패키지로 얻을 수 없는 경우는 다른 프로바이더 패키지가 검색됩니다.

파라미터:

algorithm - 요구된 키 합의 알고리즘의 표준적인 이름. 알고리즘의 표준명에 대해서는 「Java 암호화 아키텍쳐 API 사양 및 레퍼런스」의 부록 A를 참조

반환값:

새로운 KeyAgreement 객체

예외:

NullPointerException - 지정된 알고리즘이 null인 경우

NoSuchAlgorithmException - 지정된 알고리즘이, 디폴트의 프로바이더 패키지에도, 검색한 것 외의 프로바이더 패키지에도 없는 경우

getInstance

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

                                             NoSuchProviderException 

지정된 프로바이더로부터, 지정된 키 합의 알고리즘의 KeyAgreement 객체를 작성합니다.

파라미터:

algorithm - 요구된 키 합의 알고리즘의 표준적인 이름. 알고리즘의 표준명에 대해서는 「Java 암호화 아키텍쳐 API 사양 및 레퍼런스」의 부록 A를 참조

provider - 프로바이더명

반환값:

새로운 KeyAgreement 객체

예외:

NullPointerException - 지정된 알고리즘이 null인 경우

NoSuchAlgorithmException - 지정된 프로바이더로 지정된 알고리즘이 없는 경우

NoSuchProviderException - 지정된 프로바이더가 설정되어 있지 않은 경우

IllegalArgumentException - provider가 null인 경우

getInstance

public static final KeyAgreement  getInstance(String  algorithm,
                                             Provider  provider)
                                      throws NoSuchAlgorithmException 

지정된 프로바이더로부터, 지정된 키 합의 알고리즘의 KeyAgreement 객체를 생성합니다. provider는 등록되어 있을 필요는 없는 것에 주의해 주세요.

파라미터:

algorithm - 요구된 키 합의 알고리즘의 표준적인 이름. 알고리즘의 표준명에 대해서는 「Java 암호화 아키텍쳐 API 사양 및 레퍼런스」의 부록 A를 참조

provider - 프로바이더

반환값:

새로운 KeyAgreement 객체

예외:

NullPointerException - 지정된 알고리즘이 null인 경우

NoSuchAlgorithmException - 지정된 프로바이더로 지정된 알고리즘이 없는 경우

IllegalArgumentException - provider가 null인 경우

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 - 이 단계의 키. 예를 들어 2 당사자 사이의 Diffie-Hellman인 경우는 상대의 Diffie-Hellman 공개키

lastPhase - 이것이 이 키 합의의 마지막 단계인가 어떤가를 나타내는 플래그

반환값:

이 단계의 결과의 (중간) 키. 이 단계에서 키가 생성되지 않는 경우는 null

예외:

InvalidKeyException - 지정된 키가 이 단계에 부적절한 경우

IllegalStateException - 이 키 합의가 초기화되어 있지 않은 경우

generateSecret

public final byte[] generateSecret()
                            throws IllegalStateException 

공유의 비밀 정보를 생성해 새로운 버퍼내에 리턴합니다.

이 메서드는 이 KeyAgreement 객체를 리셋 하므로 게다가 다른 키 합의에 재사용할 수 있습니다. 이 키 합의가 init 메서드의 1개 로 재초기화되지 않는 경우, 그 후의 키 합의에서는 같은 비공개 정보와 알고리즘 파라미터가 사용됩니다.

반환값:

공유의 비밀 정보가 들어간 새로운 버퍼

예외:

IllegalStateException - 이 키 합의가 아직 완료하고 있지 않는 경우

generateSecret

public final int generateSecret(byte[] sharedSecret,
                                int offset)
                         throws IllegalStateException,

                                ShortBufferException 

공유의 비밀 정보를 생성해, offset로 부터 시작되는 sharedSecret 버퍼내에 포함합니다.

sharedSecret 버퍼가 너무 작아 결과를 보관 유지할 수 없는 경우는 ShortBufferException가 발생 됩니다. 이 경우 보다 큰 출력 버퍼를 사용해 이 호출을 반복합니다.

이 메서드는 이 KeyAgreement 객체를 리셋 하므로 게다가 다른 키 합의에 재사용할 수 있습니다. 이 키 합의가 init 메서드의 1개 로 재초기화되지 않는 경우, 그 후의 키 합의에서는 같은 비공개 정보와 알고리즘 파라미터가 사용됩니다.

파라미터:

sharedSecret - 공유의 비밀 정보를 포함하는 버퍼

offset - 공유의 비밀 정보가 포함되는 sharedSecret 내의 오프셋(offset)

반환값:

sharedSecret에 포함된 바이트수

예외:

IllegalStateException - 이 키 합의가 아직 완료하고 있지 않는 경우

ShortBufferException - 지정된 출력 버퍼가 너무 작아 비밀 정보를 보관 유지할 수 없는 경우

generateSecret

public final SecretKey  generateSecret(String  algorithm)
                               throws IllegalStateException,

                                      NoSuchAlgorithmException,

                                      InvalidKeyException 

공유의 비밀 정보를 작성해, 그것이 지정된 알고리즘의 SecretKey 객체로서 리턴합니다.

이 메서드는 이 KeyAgreement 객체를 리셋 하므로 게다가 다른 키 합의에 재사용할 수 있습니다. 이 키 합의가 init 메서드의 1개 로 재초기화되지 않는 경우, 그 후의 키 합의에서는 같은 비공개 정보와 알고리즘 파라미터가 사용됩니다.

파라미터:

algorithm - 요구된 비밀키 알고리즘

반환값:

공유의 비밀키

예외:

IllegalStateException - 이 키 합의가 아직 완료하고 있지 않는 경우

NoSuchAlgorithmException - 지정된 비밀키 알고리즘이 없는 경우

InvalidKeyException - 공유의 비밀키 데이터를 사용해, 지정된 알고리즘의 비밀키를 생성할 수 없는 경우 (예를 들어 키 데이터가 너무 짧다)