gnu.crypto.sasl

Class ClientMechanism

Implemented Interfaces:
SaslClient
Known Direct 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

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)

Field Details

authorizationID

protected String authorizationID
The authorisation identity.

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).

handler

protected CallbackHandler handler
Callback handler to use with this mechanism instance.

mechanism

protected String mechanism
Name of this mechanism.

properties

protected Map properties
Properties of qualities desired for this mechanism.

protocol

protected String protocol
Name of protocol using this mechanism.

serverName

protected String serverName
Name of server to authenticate to.

state

protected int state
The state of the authentication automaton.

Constructor Details

ClientMechanism

protected ClientMechanism(String mechanism)

Method Details

dispose

public void dispose()
            throws SaslException

engineUnwrap

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

engineWrap

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

evaluateChallenge

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

getAuthorizationID

public String getAuthorizationID()

getMechanismName

public String getMechanismName()

getNegotiatedMaxBuffer

protected String getNegotiatedMaxBuffer()

getNegotiatedPolicyForwardSecrecy

protected String getNegotiatedPolicyForwardSecrecy()

getNegotiatedPolicyNoActive

protected String getNegotiatedPolicyNoActive()

getNegotiatedPolicyNoAnonymous

protected String getNegotiatedPolicyNoAnonymous()

getNegotiatedPolicyNoDictionary

protected String getNegotiatedPolicyNoDictionary()

getNegotiatedPolicyNoPlainText

protected String getNegotiatedPolicyNoPlainText()

getNegotiatedPolicyPassCredentials

protected String getNegotiatedPolicyPassCredentials()

getNegotiatedProperty

public Object getNegotiatedProperty(String propName)

getNegotiatedQOP

protected String getNegotiatedQOP()

getNegotiatedRawSendSize

protected String getNegotiatedRawSendSize()

getNegotiatedServerAuth

protected String getNegotiatedServerAuth()

getNegotiatedStrength

protected String getNegotiatedStrength()

getReuse

protected String getReuse()

hasInitialResponse

public abstract boolean hasInitialResponse()

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.

initMechanism

protected abstract void initMechanism()
            throws SaslException

isComplete

public boolean isComplete()

reset

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

resetMechanism

protected abstract void resetMechanism()
            throws SaslException

unwrap

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

wrap

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

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