Class ServerMechanism

protected IAuthInfoProvider authenticator

The provider for authentication information.

protected String authorizationID

The authorisation identity.

protected byte[] channelBinding

Channel binding data to use with this mechanism instance.

protected boolean complete

Whether authentication phase is completed (true) or not (false).

protected CallbackHandler handler

Callback handler to use with this mechanism instance.

protected String mechanism

Name of this mechanism.

protected Map<K,V> properties

Properties of qualities desired for this mechanism.

protected String protocol

Name of protocol using this mechanism.

protected String serverName

Name of server to authenticate to.

protected int state

The state of the authentication automaton. -1 means uninitialised.

protected ServerMechanism(String mechanism)

public void dispose()
            throws SaslException

Disposes of any system resources or security-sensitive information the SaslServer might be using. Invoking this method invalidates the SaslServer instance. This method is idempotent.

Specified by:

dispose in interface SaslServer

Throws:

SaslException - if a problem was encountered while disposing of the resources.

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

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

public abstract byte[] evaluateResponse(byte[] response)
            throws SaslException

Evaluates the response data and generates a challenge. If a response is received from the client during the authentication process, this method is called to prepare an appropriate next challenge to submit to the client. The challenge is null if the authentication has succeeded and no more challenge data is to be sent to the client. It is non-null if the authentication must be continued by sending a challenge to the client, or if the authentication has succeeded but challenge data needs to be processed by the client. SaslServer.isComplete() should be called after each call to evaluateResponse(),to determine if any further response is needed from the client.

Specified by:

evaluateResponse in interface SaslServer

Parameters:

response - the non-null (but possibly empty) response sent by the client.

Returns:

the possibly null challenge to send to the client. It is null if the authentication has succeeded and there is no more challenge data to be sent to the client.

Throws:

SaslException - if an error occurred while processing the response or generating a challenge.

public String getAuthorizationID()

Reports the authorization ID in effect for the client of this session This method can only be called if SaslServer.isComplete() returns true.

Specified by:

getAuthorizationID in interface SaslServer

Returns:

the authorization ID of the client.

Throws:

IllegalStateException - if this authentication session has not completed.

public String getMechanismName()

Returns the IANA-registered mechanism name of this SASL server (e.g. "CRAM-MD5", "GSSAPI").

Specified by:

getMechanismName in interface SaslServer

Returns:

a non-null string representing the IANA-registered mechanism name.

protected String getNegotiatedMaxBuffer()

protected String getNegotiatedPolicyForwardSecrecy()

protected String getNegotiatedPolicyNoActive()

protected String getNegotiatedPolicyNoAnonymous()

protected String getNegotiatedPolicyNoDictionary()

protected String getNegotiatedPolicyNoPlainText()

protected String getNegotiatedPolicyPassCredentials()

public Object getNegotiatedProperty(String propName)

Retrieves the negotiated property. This method can be called only after the authentication exchange has completed (i.e., when SaslServer.isComplete() returns true); otherwise, an IllegalStateException is thrown.

Specified by:

getNegotiatedProperty in interface SaslServer

Returns:

the value of the negotiated property. If null, the property was not negotiated or is not applicable to this mechanism.

Throws:

IllegalStateException - if this authentication exchange has not completed.

protected String getNegotiatedQOP()

protected String getNegotiatedRawSendSize()

protected String getNegotiatedServerAuth()

protected String getNegotiatedStrength()

protected String getReuse()

public void init(Map<K,V> attributes)
            throws SaslException

Initialises the mechanism with designated attributes. Permissible names and values are mechanism specific.

Parameters:

attributes - a set of name-value pairs that describes the desired future behaviour of this instance.

Throws:

SaslException - if an exception occurs during the process.

protected abstract void initMechanism()
            throws SaslException

public boolean isComplete()

Determines if the authentication exchange has completed. This method is typically called after each invocation of SaslServer.evaluateResponse(byte[]) to determine whether the authentication has completed successfully or should be continued.

Specified by:

isComplete in interface SaslServer

Returns:

true if the authentication exchange has completed; false otherwise.

public void reset()
            throws SaslException

Resets the mechanism instance for re-initialisation and use with other characteristics.

Throws:

SaslException - if an exception occurs during the process.

protected abstract void resetMechanism()
            throws SaslException

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

Unwraps a byte array received from the client. This method can be called only after the authentication exchange has completed (i.e., when SaslServer.isComplete() returns true) and only if the authentication exchange has negotiated integrity and/or privacy as the quality of protection; otherwise, an IllegalStateException is thrown.

incoming is the contents of the SASL buffer as defined in RFC 2222 without the leading four octet field that represents the length. offset and len specify the portion of incoming to use.

Specified by:

unwrap in interface SaslServer

Parameters:

incoming - a non-null byte array containing the encoded bytes from the client.

offset - the starting position at incoming of the bytes to use.

len - the number of bytes from incoming to use.

Returns:

a non-null byte array containing the decoded bytes.

Throws:

SaslException - if incoming cannot be successfully unwrapped.

IllegalStateException - if the authentication exchange has not completed, or if the negotiated quality of protection has neither integrity nor privacy.

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

Wraps a byte array to be sent to the client. This method can be called only after the authentication exchange has completed (i.e., when SaslServer.isComplete() returns true) and only if the authentication exchange has negotiated integrity and/or privacy as the quality of protection; otherwise, an IllegalStateException is thrown.

The result of this method will make up the contents of the SASL buffer as defined in RFC 2222 without the leading four octet field that represents the length. offset and len specify the portion of outgoing to use.

Specified by:

wrap in interface SaslServer

Parameters:

outgoing - a non-null byte array containing the bytes to encode.

offset - the starting position at outgoing of the bytes to use.

len - the number of bytes from outgoing to use.

Returns:

a non-null byte array containing the encoded bytes.

Throws:

SaslException - if outgoing cannot be successfully wrapped.

IllegalStateException - if the authentication exchange has not completed, or if the negotiated quality of protection has neither integrity nor privacy.