For the latest news and information visit
The GNU Crypto project

gnu.crypto.sasl
Class ClientMechanism

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

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

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

Version:
$Revision: 1.2 $

Field Summary
protected  java.lang.String authorisationID
          The authorisation identity.
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()
           
protected  byte[] engineUnwrap(byte[] incoming, int offset, int len)
           
protected  byte[] engineWrap(byte[] outgoing, int offset, int len)
           
abstract  byte[] evaluateChallenge(byte[] challenge)
           
 java.lang.String getAuthorizationID()
           
 java.lang.String getMechanismName()
           
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)
           
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()
           
 void init(java.util.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 java.lang.String mechanism
Name of this mechanism.


authorisationID

protected java.lang.String authorisationID
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.


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
Throws:
javax.security.sasl.SaslException

resetMechanism

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

evaluateChallenge

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

hasInitialResponse

public abstract boolean hasInitialResponse()
Specified by:
hasInitialResponse in interface javax.security.sasl.SaslClient

isComplete

public boolean isComplete()
Specified by:
isComplete in interface javax.security.sasl.SaslClient

unwrap

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

wrap

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

getMechanismName

public java.lang.String getMechanismName()
Specified by:
getMechanismName in interface javax.security.sasl.SaslClient

getNegotiatedProperty

public java.lang.Object getNegotiatedProperty(java.lang.String propName)
                                       throws javax.security.sasl.SaslException
Specified by:
getNegotiatedProperty in interface javax.security.sasl.SaslClient
Throws:
javax.security.sasl.SaslException

dispose

public void dispose()
             throws javax.security.sasl.SaslException
Specified by:
dispose in interface javax.security.sasl.SaslClient
Throws:
javax.security.sasl.SaslException

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
Throws:
javax.security.sasl.SaslException

engineWrap

protected byte[] engineWrap(byte[] outgoing,
                            int offset,
                            int len)
                     throws javax.security.sasl.SaslException
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.

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.
javax.security.sasl.SaslException - if an exception occurs during the process.

reset

public void reset()
           throws javax.security.sasl.SaslException
Resets the mechanism instance for re-initialisation and use with other characteristics.

Throws:
javax.security.sasl.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.