For the latest news and information visit
The GNU Crypto project

gnu.crypto.sasl
Class ClientMechanism

java.lang.Object
  extended by gnu.crypto.sasl.ClientMechanism
All Implemented Interfaces:
SaslClient
Direct Known Subclasses:
AnonymousClient, CramMD5Client, PlainClient, SRPClient

public abstract class ClientMechanism
extends Object
implements SaslClient

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

Version:
$Revision: 1.4 $

Field Summary
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 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.
 
Constructor Summary
protected ClientMechanism(String mechanism)
           
 
Method Summary
 void dispose()
           
protected  byte[] engineUnwrap(byte[] incoming, int offset, int len)
           
protected  byte[] engineWrap(byte[] outgoing, int offset, int len)
           
abstract  byte[] evaluateChallenge(byte[] challenge)
           
 String getAuthorizationID()
           
 String getMechanismName()
           
protected  String getNegotiatedMaxBuffer()
           
protected  String getNegotiatedPolicyForwardSecrecy()
           
protected  String getNegotiatedPolicyNoActive()
           
protected  String getNegotiatedPolicyNoAnonymous()
           
protected  String getNegotiatedPolicyNoDictionary()
           
protected  String getNegotiatedPolicyNoPlainText()
           
protected  String getNegotiatedPolicyPassCredentials()
           
 Object getNegotiatedProperty(String propName)
           
protected  String getNegotiatedQOP()
           
protected  String getNegotiatedRawSendSize()
           
protected  String getNegotiatedServerAuth()
           
protected  String getNegotiatedStrength()
           
protected  String getReuse()
           
abstract  boolean hasInitialResponse()
           
 void init(Map attributes)
          Initialises the mechanism with designated attributes.
protected abstract  void initMechanism()
           
 boolean isComplete()
           
 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)
           
 byte[] wrap(byte[] outgoing, int offset, int len)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

mechanism

protected String mechanism
Name of this mechanism.


authorizationID

protected String authorizationID
The authorisation identity.


protocol

protected String protocol
Name of protocol using this mechanism.


serverName

protected String serverName
Name of server to authenticate to.


properties

protected Map properties
Properties of qualities desired for this mechanism.


handler

protected 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(String mechanism)
Method Detail

initMechanism

protected abstract void initMechanism()
                               throws SaslException
Throws:
SaslException

resetMechanism

protected abstract void resetMechanism()
                                throws SaslException
Throws:
SaslException

evaluateChallenge

public abstract byte[] evaluateChallenge(byte[] challenge)
                                  throws SaslException
Specified by:
evaluateChallenge in interface SaslClient
Throws:
SaslException

hasInitialResponse

public abstract boolean hasInitialResponse()
Specified by:
hasInitialResponse in interface SaslClient

isComplete

public boolean isComplete()
Specified by:
isComplete in interface SaslClient

unwrap

public byte[] unwrap(byte[] incoming,
                     int offset,
                     int len)
              throws SaslException
Specified by:
unwrap in interface SaslClient
Throws:
SaslException

wrap

public byte[] wrap(byte[] outgoing,
                   int offset,
                   int len)
            throws SaslException
Specified by:
wrap in interface SaslClient
Throws:
SaslException

getMechanismName

public String getMechanismName()
Specified by:
getMechanismName in interface SaslClient

getNegotiatedProperty

public Object getNegotiatedProperty(String propName)
Specified by:
getNegotiatedProperty in interface SaslClient

dispose

public void dispose()
             throws SaslException
Specified by:
dispose in interface SaslClient
Throws:
SaslException

getAuthorizationID

public String getAuthorizationID()

getNegotiatedQOP

protected String getNegotiatedQOP()

getNegotiatedStrength

protected String getNegotiatedStrength()

getNegotiatedServerAuth

protected String getNegotiatedServerAuth()

getNegotiatedMaxBuffer

protected String getNegotiatedMaxBuffer()

getNegotiatedRawSendSize

protected String getNegotiatedRawSendSize()

getNegotiatedPolicyNoPlainText

protected String getNegotiatedPolicyNoPlainText()

getNegotiatedPolicyNoActive

protected String getNegotiatedPolicyNoActive()

getNegotiatedPolicyNoDictionary

protected String getNegotiatedPolicyNoDictionary()

getNegotiatedPolicyNoAnonymous

protected String getNegotiatedPolicyNoAnonymous()

getNegotiatedPolicyForwardSecrecy

protected String getNegotiatedPolicyForwardSecrecy()

getNegotiatedPolicyPassCredentials

protected String getNegotiatedPolicyPassCredentials()

getReuse

protected String getReuse()

engineUnwrap

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

engineWrap

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

init

public void init(Map 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:
IllegalMechanismStateException - if the instance is already initialised.
SaslException - if an exception occurs during the process.

reset

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.

For the latest news and information visit
The GNU Crypto project

Copyright © 2001, 2002, 2003 Free Software Foundation, Inc. All Rights Reserved.