Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

gnu.javax.crypto.sasl
Class ClientMechanism  view ClientMechanism download ClientMechanism.java

java.lang.Object
  extended bygnu.javax.crypto.sasl.ClientMechanism
All Implemented Interfaces:
javax.security.sasl.SaslClient

public abstract class ClientMechanism
extends java.lang.Object
implements javax.security.sasl.SaslClient

A base class to facilitate implementing SASL client-side mechanisms.


Field Summary
protected  java.lang.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  javax.security.auth.callback.CallbackHandler handler
          Callback handler to use with this mechanism instance.
protected  java.lang.String mechanism
          Name of this mechanism.
protected  java.util.Map properties
          Properties of qualities desired for this mechanism.
protected  java.lang.String protocol
          Name of protocol using this mechanism.
protected  java.lang.String serverName
          Name of server to authenticate to.
protected  int state
          The state of the authentication automaton.
 
Constructor Summary
protected ClientMechanism(java.lang.String mechanism)
           
 
Method Summary
 void dispose()
          Disposes of any system resources or security-sensitive information the SaslClient might be using.
protected  byte[] engineUnwrap(byte[] incoming, int offset, int len)
           
protected  byte[] engineWrap(byte[] outgoing, int offset, int len)
           
abstract  byte[] evaluateChallenge(byte[] challenge)
          Evaluates the challenge data and generates a response.
 java.lang.String getAuthorizationID()
           
 java.lang.String getMechanismName()
          Returns the IANA-registered mechanism name of this SASL client.
protected  java.lang.String getNegotiatedMaxBuffer()
           
protected  java.lang.String getNegotiatedPolicyForwardSecrecy()
           
protected  java.lang.String getNegotiatedPolicyNoActive()
           
protected  java.lang.String getNegotiatedPolicyNoAnonymous()
           
protected  java.lang.String getNegotiatedPolicyNoDictionary()
           
protected  java.lang.String getNegotiatedPolicyNoPlainText()
           
protected  java.lang.String getNegotiatedPolicyPassCredentials()
           
 java.lang.Object getNegotiatedProperty(java.lang.String propName)
          Retrieves the negotiated property.
protected  java.lang.String getNegotiatedQOP()
           
protected  java.lang.String getNegotiatedRawSendSize()
           
protected  java.lang.String getNegotiatedServerAuth()
           
protected  java.lang.String getNegotiatedStrength()
           
protected  java.lang.String getReuse()
           
abstract  boolean hasInitialResponse()
          Determines if this mechanism has an optional initial response.
 void init(java.util.Map attributes)
          Initialises the mechanism with designated attributes.
protected abstract  void initMechanism()
           
 boolean isComplete()
          Determines if the authentication exchange has completed.
 void reset()
          Resets the mechanism instance for re-initialisation and use with other characteristics.
protected abstract  void resetMechanism()
           
 byte[] unwrap(byte[] incoming, int offset, int len)
          Unwraps a byte array received from the server.
 byte[] wrap(byte[] outgoing, int offset, int len)
          Wraps a byte array to be sent to the server.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

mechanism

protected java.lang.String mechanism
Name of this mechanism.


authorizationID

protected java.lang.String authorizationID
The authorisation identity.


protocol

protected java.lang.String protocol
Name of protocol using this mechanism.


serverName

protected java.lang.String serverName
Name of server to authenticate to.


properties

protected java.util.Map properties
Properties of qualities desired for this mechanism.


handler

protected javax.security.auth.callback.CallbackHandler handler
Callback handler to use with this mechanism instance.


channelBinding

protected byte[] channelBinding
Channel binding data to use with this mechanism instance.


complete

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


state

protected int state
The state of the authentication automaton.

Constructor Detail

ClientMechanism

protected ClientMechanism(java.lang.String mechanism)
Method Detail

initMechanism

protected abstract void initMechanism()
                               throws javax.security.sasl.SaslException

resetMechanism

protected abstract void resetMechanism()
                                throws javax.security.sasl.SaslException

evaluateChallenge

public abstract byte[] evaluateChallenge(byte[] challenge)
                                  throws javax.security.sasl.SaslException
Description copied from interface: javax.security.sasl.SaslClient
Evaluates the challenge data and generates a response. If a challenge is received from the server during the authentication process, this method is called to prepare an appropriate next response to submit to the server.

Specified by:
evaluateChallenge in interface javax.security.sasl.SaslClient

hasInitialResponse

public abstract boolean hasInitialResponse()
Description copied from interface: javax.security.sasl.SaslClient
Determines if this mechanism has an optional initial response. If true, caller should call SaslClient.evaluateChallenge(byte[])>SaslClient.evaluateChallenge(byte[]) 55 with an empty array to get the initial response.

Specified by:
hasInitialResponse in interface javax.security.sasl.SaslClient

isComplete

public boolean isComplete()
Description copied from interface: javax.security.sasl.SaslClient
Determines if the authentication exchange has completed. This method may be called at any time, but typically, it will not be called until the caller has received indication from the server (in a protocol-specific manner) that the exchange has completed.

Specified by:
isComplete in interface javax.security.sasl.SaslClient

unwrap

public byte[] unwrap(byte[] incoming,
                     int offset,
                     int len)
              throws javax.security.sasl.SaslException
Description copied from interface: javax.security.sasl.SaslClient

Unwraps a byte array received from the server. This method can be called only after the authentication exchange has completed (i.e., when SaslClient.isComplete()>SaslClient.isComplete() 55 returns true) and only if the authentication exchange has negotiated integrity and/or privacy as the quality of protection; otherwise, an java.lang.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 javax.security.sasl.SaslClient

wrap

public byte[] wrap(byte[] outgoing,
                   int offset,
                   int len)
            throws javax.security.sasl.SaslException
Description copied from interface: javax.security.sasl.SaslClient

Wraps a byte array to be sent to the server. This method can be called only after the authentication exchange has completed (i.e., when SaslClient.isComplete()>SaslClient.isComplete() 55 returns true) and only if the authentication exchange has negotiated integrity and/or privacy as the quality of protection; otherwise, an java.lang.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 javax.security.sasl.SaslClient

getMechanismName

public java.lang.String getMechanismName()
Description copied from interface: javax.security.sasl.SaslClient
Returns the IANA-registered mechanism name of this SASL client. (e.g. "CRAM-MD5", "GSSAPI").

Specified by:
getMechanismName in interface javax.security.sasl.SaslClient

getNegotiatedProperty

public java.lang.Object getNegotiatedProperty(java.lang.String propName)
Description copied from interface: javax.security.sasl.SaslClient
Retrieves the negotiated property. This method can be called only after the authentication exchange has completed (i.e., when SaslClient.isComplete()>SaslClient.isComplete() 55 returns true); otherwise, an java.lang.IllegalStateException is thrown.

Specified by:
getNegotiatedProperty in interface javax.security.sasl.SaslClient

dispose

public void dispose()
             throws javax.security.sasl.SaslException
Description copied from interface: javax.security.sasl.SaslClient
Disposes of any system resources or security-sensitive information the SaslClient might be using. Invoking this method invalidates the SaslClient instance. This method is idempotent.

Specified by:
dispose in interface javax.security.sasl.SaslClient

getAuthorizationID

public java.lang.String getAuthorizationID()

getNegotiatedQOP

protected java.lang.String getNegotiatedQOP()

getNegotiatedStrength

protected java.lang.String getNegotiatedStrength()

getNegotiatedServerAuth

protected java.lang.String getNegotiatedServerAuth()

getNegotiatedMaxBuffer

protected java.lang.String getNegotiatedMaxBuffer()

getNegotiatedRawSendSize

protected java.lang.String getNegotiatedRawSendSize()

getNegotiatedPolicyNoPlainText

protected java.lang.String getNegotiatedPolicyNoPlainText()

getNegotiatedPolicyNoActive

protected java.lang.String getNegotiatedPolicyNoActive()

getNegotiatedPolicyNoDictionary

protected java.lang.String getNegotiatedPolicyNoDictionary()

getNegotiatedPolicyNoAnonymous

protected java.lang.String getNegotiatedPolicyNoAnonymous()

getNegotiatedPolicyForwardSecrecy

protected java.lang.String getNegotiatedPolicyForwardSecrecy()

getNegotiatedPolicyPassCredentials

protected java.lang.String getNegotiatedPolicyPassCredentials()

getReuse

protected java.lang.String getReuse()

engineUnwrap

protected byte[] engineUnwrap(byte[] incoming,
                              int offset,
                              int len)
                       throws javax.security.sasl.SaslException

engineWrap

protected byte[] engineWrap(byte[] outgoing,
                            int offset,
                            int len)
                     throws javax.security.sasl.SaslException

init

public void init(java.util.Map attributes)
          throws javax.security.sasl.SaslException

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


reset

public void reset()
           throws javax.security.sasl.SaslException

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