javax.security.sasl
인터페이스 SaslClient

public interface SaslClient

SASL 인증을 클라이언트로서 실행합니다.

프로토콜 라이브러리 (LDAP 라이브러리등)는 특정의 SASL 도구에 의해 정의된 인증을 실행하기 위해서 이 클래스의 인스턴스를 취득합니다. SaslClient 인스턴스에 대한 메서드를 호출하면, 챌린지가 처리되어SaslClient에 의해 구현된 SASL 도구에 따라 응답이 작성됩니다. 인증이 처리될 때, SASL 클라이언트의 인증 교환 상태가 암호화됩니다.

다음에 LDAP 라이브러리가 어떻게 SaslClient를 사용할까의 예를 나타냅니다. 우선, SaslClient 인스턴스를 취득합니다.

 SaslClient sc = Sasl.createSaslClient(mechanisms, authorizationId, protocol, serverName, props, callbackHandler);

이것으로 클라이언트를 인증에 사용할 수 있습니다. 예를 들어 LDAP 라이브러리는 다음과 같이 클라이언트를 사용할 수 있습니다.

 // Get initial response and send to server byte[] response = (sc.hasInitialResponse() ?  sc.evaluateChallenge(new byte[0]) :
 null);
 LdapResult res = ldap.sendBindRequest(dn, sc.getName(), response);
 while (! sc.isComplete() &&  (res.status == SASL_BIND_IN_PROGRESS || res.status == SUCCESS)) { response = sc.evaluateChallenge(res.getBytes());
 if (res.status == SUCCESS) { // we're done;
 don't expect to send another BIND if (response ! = null) {             throw new SaslException(                    "Protocol error:
 attempting to send response after completion");
           } break;
 } res = ldap.sendBindRequest(dn, sc.getName(), response);
 } if (sc.isComplete() && res.status == SUCCESS) { String qop = (String) sc.getNegotiatedProperty(Sasl.QOP);
 if (qop ! = null  && (qop.equalsIgnoreCase("auth-int")  || qop.equalsIgnoreCase("auth-conf"))) {

// Use SaslClient.wrap() and SaslClient.unwrap() for future // communication with server        ldap.in = new SecureInputStream(sc, ldap.in);   ldap.out = new SecureOutputStream(sc, ldap.out); } }

도구에 초기 응답이 포함되어 있는 경우, 라이브러리는 비어있는 챌린지로 evaluateChallenge()를 호출해, 초기 응답을 취득합니다. IMAP4 등의 프로토콜은 서버에의 최초의 인증 커멘드를 가지는 초기 응답이 포함되지 않기 때문에 최초로 hasInitialResponse() 또는 evaluateChallenge()를 호출하지 말고 인증을 개시합니다. 서버가 인증 커멘드에 응답하면, 초기 챌린지가 송신됩니다. 클라이언트가 최초로 데이터를 송신하는 SASL 도구에 서는 서버는 데이터를 포함하지 않는 챌린지를 발행해 두지 않으면 안됩니다. 거기에 따라, 비어있는 챌린지에 한 evaluateChallenge()에 의 호출이 클라이언트로 행해집니다.

도입된 버전 :

1.5

관련 항목:

Sasl, SaslClientFactory

메서드 개요

void	dispose () SaslClient가 사용하고 있는 system resource 또는 보안상 중요한 정보를 파기합니다.
byte[]	evaluateChallenge (byte[] challenge) 챌린지 데이터를 평가해, 응답을 작성합니다.
String	getMechanismName () 이 SASL 클라이언트의 IANA 등록된 도구 명 (CRAM-MD5, GSSAPI 등)을 리턴합니다.
Object	getNegotiatedProperty (String propName) 네고시에이트 된 프로퍼티를 꺼냅니다.
boolean	hasInitialResponse () 이 도구에 옵션의 초기 응답이 포함되어 있는지를 조사합니다.
boolean	isComplete () 인증 교환이 완료했는지 어떠했는지를 판정합니다.
byte[]	unwrap (byte[] incoming, int offset, int len) 서버로부터 수신한 바이트 배열을 랩 해제합니다.
byte[]	wrap (byte[] outgoing, int offset, int len) 서버에 송신하는 바이트 배열을 랩 합니다.

메서드의 상세

getMechanismName

String  getMechanismName()

이 SASL 클라이언트의 IANA 등록된 도구 명 (CRAM-MD5, GSSAPI 등)을 리턴합니다.

반환값:

IANA 등록된 도구 명을 나타내는 null 이외의 캐릭터 라인

hasInitialResponse

boolean hasInitialResponse()

이 도구에 옵션의 초기 응답이 포함되어 있는지를 조사합니다. true인 경우, 호출측은 초기 응답을 취득하기 위해서 비어있는 배열로 evaluateChallenge()를 호출할 필요가 있습니다.

반환값:

이 도구에 초기 응답이 포함되어 있는 경우는 true

evaluateChallenge

byte[] evaluateChallenge(byte[] challenge)
                         throws SaslException 

챌린지 데이터를 평가해, 응답을 작성합니다. 인증 프로세스시에 챌린지가 서버로부터 수신되었을 경우는 서버에 송신하는 다음의 적절한 응답을 준비하기 위해서 이 메서드가 호출됩니다.

파라미터:

challenge - 서버로부터 송신된 null 이외의 챌린지. 챌린지 배열의 길이는 0인 경우도 있다

반환값:

서버에 송신하는 응답 (null인 경우도 있다). 챌린지가 「SUCCESS」상태를 수반해, 챌린지에 클라이언트가 그 상태를 갱신하기 위한 데이터 밖에 포함되지 않고, 또한 서버에 송신하는 응답이 없는 경우에 null이 된다. 클라이언트가 데이터를 포함하지 않는 응답을 송신하는 경우, 응답은 길이 0 바이트 배열이 된다

예외:

SaslException - 챌린지의 처리시 또는 응답의 작성시에 에러가 발생했을 경우

isComplete

boolean isComplete()

인증 교환이 완료했는지 어떠했는지를 판정합니다. 이 메서드는 언제라도 호출할 수 있습니다만, 일반적으로 호출해 옆이 서버로부터 교환이 완료했다고 하는 통지를 받을 때까지는 불려가 지 않습니다 (프로토콜 고유의 방법).

반환값:

인증 교환이 완료했을 경우는 true, 그렇지 않은 경우는 false

unwrap

byte[] unwrap(byte[] incoming,
              int offset,
              int len)
              throws SaslException 

서버로부터 수신한 바이트 배열을 랩 해제합니다. 이 메서드는 인증 교환이 완료했다 (isComplete()가 true를 돌려준) 나중에 인증 교환의 보호 품질로서 네고시에이트 된 정합성 또는 기밀성이 갖춰지고 있는 경우에게만 호출합니다. 그렇지 않은 경우는 IllegalStateException이 발생 됩니다.

incoming는 길이를 나타내는 최초의 4개의 8중창 필드를 제외한, RFC 2222에 정의된 SASL 버퍼의 내용입니다. offset와 len는 incoming 사용 부분을 지정합니다.

파라미터:

incoming - 서버로부터 수신한 encode 된 바이트를 포함한 null 이외의 바이트 배열

offset - 사용하는 바이트의 incoming에 서의 개시 위치

len - 사용하는 incoming 바이트수

반환값:

복호화 된 바이트를 포함한 null 이외의 바이트 배열

예외:

SaslException - incoming를 정상적으로 랩 해제할 수 없는 경우

IllegalStateException - 인증 교환이 완료하지 않았던 경우, 또는 네고시에이트 된 보호 품질에 정합성도 기밀성도 갖춰지지 않은 경우

wrap

byte[] wrap(byte[] outgoing,
            int offset,
            int len)
            throws SaslException 

서버에 송신하는 바이트 배열을 랩 합니다. 이 메서드는 인증 교환이 완료했다 (isComplete()가 true를 돌려준) 나중에 인증 교환의 보호 품질로서 네고시에이트 된 정합성 또는 기밀성이 갖춰지고 있는 경우에게만 호출합니다. 그렇지 않은 경우는 IllegalStateException이 발생 됩니다.

이 메서드의 결과는 길이를 나타내는 최초의 4개의 8중창 필드를 제외한, RFC 2222에 정의된 SASL 버퍼의 내용을 구성합니다. offset와 len는 outgoing 사용 부분을 지정합니다.

파라미터:

outgoing - encode 하는 바이트를 포함한 null 이외의 바이트 배열

offset - 사용하는 바이트의 outgoing에 서의 개시 위치

len - 사용하는 outgoing 바이트수

반환값:

encode 된 바이트를 포함한 null 이외의 바이트 배열

예외:

SaslException - outgoing를 정상적으로 랩 할 수 없는 경우

IllegalStateException - 인증 교환이 완료하지 않았던 경우, 또는 네고시에이트 된 보호 품질에 정합성도 기밀성도 갖춰지지 않은 경우

getNegotiatedProperty

Object  getNegotiatedProperty(String  propName)

네고시에이트 된 프로퍼티를 꺼냅니다. 이 메서드는 인증 교환이 완료했다 (isComplete()가 true를 돌려준) 나중에 마셔 호출할 수 있습니다 . 그렇지 않은 경우는 IllegalStateException이 발생 됩니다.

파라미터:

propName - null 이외의 프로퍼티명

반환값:

네고시에이트 된 프로퍼티의 값. null인 경우는 프로퍼티가 네고시에이트 되지 않았는지, 이 도구에 적용할 수 없다

예외:

IllegalStateException - 이 인증 교환이 완료하지 않았던 경우

dispose

void dispose()
             throws SaslException 

SaslClient가 사용하고 있는 system resource 또는 보안상 중요한 정보를 파기합니다. 이 메서드를 호출하면, SaslClient 인스턴스가 무효가 됩니다. 이 메서드나무등입니다.

예외:

SaslException - 자원을 파기하고 있을 때 문제가 발생했을 경우