java.security
클래스 MessageDigest

java.lang.Object 
  |
  +--java.security.MessageDigestSpi 
        |
        +--java.security.MessageDigest

public abstract class MessageDigest

extends MessageDigestSpi

이 MessageDigest 클래스는 MD5 또는 SHA 등의 메세지 다이제스트 알고리즘의 기능을 제공합니다. 메세지 다이제스트는 임의의 사이즈의 데이타를 뽑아 고정장의 해시치를 출력하는 안전한 한방향의 해시 기능입니다.

MessageDigest 오브젝트는 초기화되어 기동됩니다. 데이터는 MessageDigest 오브젝트를 개입시켜 update 메소드를 사용해 처리됩니다. reset 메소드를 호출하는 것으로, 임의의 시점에서 다이제스트를 리셋트 할 수 있습니다. 갱신 대상의 데이터가 모두 갱신된 시점에서,digest 메소드의 1 개를 호출하는 것으로, 해시 계산을 종료할 필요가 있습니다.

digest 메소드는 지정 회수의 갱신에 대해서 1 회 호출하는 것만으로 끝납니다. digest 메소드의 호출이 종료한 뒤, MessageDigest 오브젝트는 초기화 상태에 리셋트 됩니다.

구현은 Cloneable 인터페이스를 자유롭게 받아들여지게 되어 있습니다. 클라이언트 어플리케이션은 복제의 생성을 시행해 CloneNotSupportedException 를 캐치 하면, 복제의 생성이 가능한가 어떤가를 조사할 수가 있습니다.

 MessageDigest md = MessageDigest.getInstance("SHA");

 try {
     md.update(toChapter1);
     MessageDigest tc1 = md.clone();
     byte[] toChapter1Digest = tc1.digest();
     md.update(toChapter2);
     ...etc.
 } catch (CloneNotSupportedException cnse) {
     throw new DigestException("couldn't make digest of partial content");
 }
 

사용하는 구현예가 복제 가능하지 않은 경우에서도, 다이제스트의 수를 미리 알고 있을 때는 몇개의 인스턴스를 생성하는 것에 의해, 중간적인 다이제스트를 계산할 수 있습니다.

이 클래스는 역사적인 사정으로부터 MessageDigest 클래스를 계승한 abstract 클래스가 되어 있습니다. 어플리케이션의 개발자는 MessageDigest 클래스에서 정의된 메소드인 만큼 배려해 주세요. 슈퍼 클래스의 모든 메소드는 메세지 다이제스트 알고리즘의 독자적인 구현을 제공할 필요가 있는 암호 서비스 프로바이더로 사용되는 것을 상정하고 있습니다.

관련 항목:

DigestInputStream , DigestOutputStream

생성자의 개요

protected

MessageDigest (String algorithm) 지정된 알고리즘명을 사용해 메세지 다이제스트를 작성합니다.

메소드의 개요

Object	clone () 구현이 복제 가능한 경우는 복제를 돌려줍니다.
byte[]	digest () 패딩등의 최종 처리를 행해 해시 계산을 완료합니다.
byte[]	digest (byte[] input) 지정된 바이트 배열을 사용해 다이제스트에 대해서 최종의 갱신을 실행한 뒤, 다이제스트 계산을 완료합니다.
int	digest (byte[] buf, int offset, int len) 패딩등의 최종 처리를 행해 해시 계산을 완료합니다.
String	getAlgorithm () 구현의 상세하게 의존하지 않는 알고리즘을 식별하는 캐릭터 라인을 돌려줍니다.
int	getDigestLength () 다이제스트의 길이를 바이트로 돌려줍니다.
static MessageDigest	getInstance (String algorithm) 지정된 다이제스트 알고리즘을 구현하는 MessageDigest 오브젝트를 작성합니다.
static MessageDigest	getInstance (String algorithm, Provider provider) 지정된 알고리즘이 프로바이더로부터 사용 가능한 경우에, 지정된 프로바이더로부터 공급되는 그 알고리즘을 구현하는 MessageDigest 오브젝트를 작성합니다.
static MessageDigest	getInstance (String algorithm, String provider) 지정된 알고리즘이 프로바이더로부터 사용 가능한 경우에, 지정된 프로바이더로부터 공급되는 그 알고리즘을 구현하는 MessageDigest 오브젝트를 작성합니다.
Provider	getProvider () 이 메세지 다이제스트 오브젝트의 프로바이더를 돌려줍니다.
static boolean	isEqual (byte[] digesta, byte[] digestb) 2 개의 다이제스트가 동일한지 어떤지를 비교합니다.
void	reset () 재이용을 위해서(때문에) 다이제스트를 리셋트 합니다.
String	toString () 이 메세지 다이제스트 오브젝트의 캐릭터 라인 표현을 돌려줍니다.
void	update (byte input) 지정된 바이트 데이터를 사용해 다이제스트를 갱신합니다.
void	update (byte[] input) 지정된 바이트 배열을 사용해 다이제스트를 갱신합니다.
void	update (byte[] input, int offset, int len) 지정된 바이트 데이터의 배열을 사용해, 지정된 오프셋(offset)로부터 개시해 다이제스트를 갱신합니다.

클래스 java.security. MessageDigestSpi 에서 상속받은 메소드

engineDigest , engineDigest , engineGetDigestLength , engineReset , engineUpdate , engineUpdate

클래스 java.lang. Object 에서 상속받은 메소드

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

생성자의 상세

MessageDigest

protected MessageDigest(String  algorithm)

지정된 알고리즘명을 사용해 메세지 다이제스트를 작성합니다.

파라미터:

algorithm - 다이제스트 알고리즘의 표준명. 알고리즘의 표준명에 대해서는 「Java 암호화 아키텍쳐 API 사양 & 레퍼런스」의 부록 A 를 참조

메소드의 상세

getInstance

public static MessageDigest  getInstance(String  algorithm)
                                 throws NoSuchAlgorithmException 

지정된 다이제스트 알고리즘을 구현하는 MessageDigest 오브젝트를 작성합니다. 디폴트의 프로바이더의 패키지가, 요구된 다이제스트 알고리즘의 구현을 제공하고 있는 경우는 그 구현을 가진 MessageDigest 클래스의 인스턴스가 돌려주어집니다. 알고리즘이 디폴트의 패키지로 얻을 수 없는 경우는 다른 패키지가 검색됩니다.

파라미터:

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

반환값:

지정된 알고리즘을 구현하는 MessageDigest 오브젝트

예외:

NoSuchAlgorithmException - 알고리즘이 호출해 옆의 환경에서 사용 가능하지 않은 경우

getInstance

public static MessageDigest  getInstance(String  algorithm,
                                        String  provider)
                                 throws NoSuchAlgorithmException ,
                                        NoSuchProviderException 

지정된 알고리즘이 프로바이더로부터 사용 가능한 경우에, 지정된 프로바이더로부터 공급되는 그 알고리즘을 구현하는 MessageDigest 오브젝트를 작성합니다.

파라미터:

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

provider - 프로바이더명

반환값:

지정된 알고리즘을 구현하는 MessageDigest 오브젝트

예외:

NoSuchAlgorithmException - 요구된 프로바이더가 제공하는 패키지에서는 알고리즘을 사용할 수 없는 경우

NoSuchProviderException - 프로바이더가 그 환경에서 사용할 수 없는 경우

IllegalArgumentException - 프로바이더의 이름이 null 나 비었을 경우

관련 항목:

Provider

getInstance

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

지정된 알고리즘이 프로바이더로부터 사용 가능한 경우에, 지정된 프로바이더로부터 공급되는 그 알고리즘을 구현하는 MessageDigest 오브젝트를 작성합니다. 주: provider 를 등록할 필요는 없습니다.

파라미터:

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

provider - 프로바이더

반환값:

지정된 알고리즘을 구현하는 MessageDigest 오브젝트

예외:

NoSuchAlgorithmException - 요구된 프로바이더가 제공하는 패키지에서는 알고리즘을 사용할 수 없는 경우

IllegalArgumentException - provider 가 null 의 경우

도입된 버젼:

1.4

관련 항목:

Provider

getProvider

public final Provider  getProvider()

이 메세지 다이제스트 오브젝트의 프로바이더를 돌려줍니다.

반환값:

이 메세지 다이제스트 오브젝트의 프로바이더

update

public void update(byte input)

지정된 바이트 데이터를 사용해 다이제스트를 갱신합니다.

파라미터:

input - 다이제스트를 갱신하는 바이트

update

public void update(byte[] input,
                   int offset,
                   int len)

지정된 바이트 데이터의 배열을 사용해, 지정된 오프셋(offset)로부터 개시해 다이제스트를 갱신합니다.

파라미터:

input - 바이트의 배열

offset - 바이트의 배열에서의 개시 오프셋(offset)

len - offset 로부터 개시해 사용되는 바이트수

update

public void update(byte[] input)

지정된 바이트 배열을 사용해 다이제스트를 갱신합니다.

파라미터:

input - 바이트의 배열

digest

public byte[] digest()

패딩등의 최종 처리를 행해 해시 계산을 완료합니다. 이 호출뒤, 다이제스트는 리셋트 됩니다.

반환값:

계산된 해시치에 대한 바이트 데이터의 배열

digest

public int digest(byte[] buf,
                  int offset,
                  int len)
           throws DigestException 

패딩등의 최종 처리를 행해 해시 계산을 완료합니다. 이 호출뒤, 다이제스트는 리셋트 됩니다.

파라미터:

buf - 계산 끝난 다이제스트의 출력처 버퍼

offset - 출력 버퍼에 다이제스트의 저장을 개시하는 위치를 나타내는 오프셋(offset)

len - 다이제스트를 할당하는 버퍼의 바이트수

반환값:

buf 에 저장된 바이트수

예외:

DigestException - 에러가 발생하는 경우

digest

public byte[] digest(byte[] input)

지정된 바이트 배열을 사용해 다이제스트에 대해서 최종의 갱신을 실행한 뒤, 다이제스트 계산을 완료합니다. 즉, 이 메소드는 update(input) 메소드를 호출해 input 배열을 update 메소드에 건네준 뒤,digest() 메소드를 호출합니다.

파라미터:

input - 다이제스트의 완료전에 갱신하는 대상의 입력

반환값:

계산된 해시치에 대한 바이트 데이터의 배열

toString

public String  toString()

이 메세지 다이제스트 오브젝트의 캐릭터 라인 표현을 돌려줍니다.

오버라이드(override):

클래스 Object 내의 toString

반환값:

이 오브젝트의 캐릭터 라인 표현

isEqual

public static boolean isEqual(byte[] digesta,
                              byte[] digestb)

2 개의 다이제스트가 동일한지 어떤지를 비교합니다. 단순한 1 바이트 비교를 실행합니다.

파라미터:

digesta - 비교할 뿐의 다이제스트

digestb - 비교하는 것 외 (분)편의 다이제스트

반환값:

다이제스트가 동일한 경우는 true, 그렇지 않은 경우는 false

reset

public void reset()

재이용을 위해서(때문에) 다이제스트를 리셋트 합니다.

getAlgorithm

public final String  getAlgorithm()

구현의 상세하게 의존하지 않는 알고리즘을 식별하는 캐릭터 라인을 돌려줍니다. 이름은 표준적인 「SHA」, 「MD5」등의 Java 시큐러티명으로 할 필요가 있습니다. 알고리즘의 표준명에 대해서는 「Java 암호화 아키텍쳐 API 사양 & 레퍼런스」의 부록 A 를 참조해 주세요.

반환값:

알고리즘의 이름

getDigestLength

public final int getDigestLength()

다이제스트의 길이를 바이트로 돌려줍니다. 이 처리가 프로바이더에 의해 서포트되지 않고 한편 구현이 복제 가능하지 않는 경우는 0 을 돌려줍니다.

반환값:

바이트 단위의 다이제스트장. 이 처리가 프로바이더에 의해 서포트되지 않고 한편 구현이 복제 가능하지 않는 경우는 0

도입된 버젼:

1.2

clone

public Object  clone()
             throws CloneNotSupportedException 

구현이 복제 가능한 경우는 복제를 돌려줍니다.

오버라이드(override):

클래스 MessageDigestSpi 내의 clone

반환값:

구현이 복제 가능한 경우는 복제

예외:

CloneNotSupportedException - Cloneable 를 서포트하고 있지 않는 구현으로 불려 갔을 경우