gnu.crypto.sasl

Class ServerMechanism

public abstract class ServerMechanism extends Object implements SaslServer

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

Version: $Revision: 1.4 $

Field Summary
protected IAuthInfoProviderauthenticator
The provider for authentication information.
protected StringauthorizationID
The authorisation identity.
protected byte[]channelBinding
Channel binding data to use with this mechanism instance.
protected booleancomplete
Whether authentication phase is completed (true) or not (false).
protected CallbackHandlerhandler
Callback handler to use with this mechanism instance.
protected Stringmechanism
Name of this mechanism.
protected Mapproperties
Properties of qualities desired for this mechanism.
protected Stringprotocol
Name of protocol using this mechanism.
protected StringserverName
Name of server to authenticate to.
protected intstate
The state of the authentication automaton.
Constructor Summary
protected ServerMechanism(String mechanism)
Method Summary
voiddispose()
protected byte[]engineUnwrap(byte[] incoming, int offset, int len)
protected byte[]engineWrap(byte[] outgoing, int offset, int len)
abstract byte[]evaluateResponse(byte[] response)
StringgetAuthorizationID()
StringgetMechanismName()
protected StringgetNegotiatedMaxBuffer()
protected StringgetNegotiatedPolicyForwardSecrecy()
protected StringgetNegotiatedPolicyNoActive()
protected StringgetNegotiatedPolicyNoAnonymous()
protected StringgetNegotiatedPolicyNoDictionary()
protected StringgetNegotiatedPolicyNoPlainText()
protected StringgetNegotiatedPolicyPassCredentials()
ObjectgetNegotiatedProperty(String propName)
protected StringgetNegotiatedQOP()
protected StringgetNegotiatedRawSendSize()
protected StringgetNegotiatedServerAuth()
protected StringgetNegotiatedStrength()
protected StringgetReuse()
voidinit(Map attributes)

Initialises the mechanism with designated attributes.

protected abstract voidinitMechanism()
booleanisComplete()
voidreset()

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

protected abstract voidresetMechanism()
byte[]unwrap(byte[] incoming, int offset, int len)
byte[]wrap(byte[] outgoing, int offset, int len)

Field Detail

authenticator

protected IAuthInfoProvider authenticator
The provider for authentication information.

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. -1 means uninitialised.

Constructor Detail

ServerMechanism

protected ServerMechanism(String mechanism)

Method Detail

dispose

public void dispose()

engineUnwrap

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

engineWrap

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

evaluateResponse

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

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

init

public void init(Map attributes)

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.

initMechanism

protected abstract void initMechanism()

isComplete

public boolean isComplete()

reset

public void reset()

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

Throws: SaslException if an exception occurs during the process.

resetMechanism

protected abstract void resetMechanism()

unwrap

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

wrap

public byte[] wrap(byte[] outgoing, int offset, int len)
Copyright © 2001, 2002, 2003 Free Software Foundation, Inc. All Rights Reserved.