org.apache.directory.server.ldap.handlers.sasl

Class AbstractSaslCallbackHandler

java.lang.Object

org.apache.directory.server.ldap.handlers.sasl.AbstractSaslCallbackHandler

All Implemented Interfaces:

CallbackHandler

Direct Known Subclasses:

CramMd5CallbackHandler, DigestMd5CallbackHandler, GssapiCallbackHandler

public abstract class AbstractSaslCallbackHandler
extends Object
implements CallbackHandler

Base class for all SASL CallbackHandlers. Implementations of SASL mechanisms selectively override the methods relevant to their mechanism.

Author:

Apache Directory Project

See Also:

CallbackHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected CoreSession	adminSession The admin core session
protected org.apache.directory.api.ldap.model.message.BindRequest	bindRequest The associated BindRequest
protected DirectoryService	directoryService A reference on the DirectoryService instance
protected LdapSession	ldapSession The reference on the user ldap session

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSaslCallbackHandler(DirectoryService directoryService, org.apache.directory.api.ldap.model.message.BindRequest bindRequest) Creates a new instance of AbstractSaslCallbackHandler.

Method Summary

Modifier and Type	Method and Description
protected abstract void	authorize(AuthorizeCallback callback) Final check to authorize user.
protected LdapContext	getContext(org.apache.mina.core.session.IoSession session, org.apache.directory.api.ldap.model.message.BindRequest bindRequest, Hashtable<String,Object> env) Convenience method for acquiring an LdapContext for the client to use for the duration of a session.
protected Hashtable<String,Object>	getEnvironment(org.apache.mina.core.session.IoSession session) Convenience method for getting an environment suitable for acquiring an LdapContext for the client.
protected String	getRealm() Implementors use this method to access the realm resulting from a callback.
protected String	getUsername() Implementors use this method to access the username resulting from a callback.
void	handle(Callback[] callbacks) SaslServer will use this method to call various callbacks, depending on the SASL mechanism in use for a session.
protected abstract org.apache.directory.api.ldap.model.entry.Attribute	lookupPassword(String username, String realm) Implementors set the password based on a lookup, using the username and realm as keys.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ldapSession

protected LdapSession ldapSession

The reference on the user ldap session

adminSession

protected CoreSession adminSession

The admin core session

directoryService

protected final DirectoryService directoryService

A reference on the DirectoryService instance

bindRequest

protected final org.apache.directory.api.ldap.model.message.BindRequest bindRequest

The associated BindRequest

Constructor Detail

AbstractSaslCallbackHandler

protected AbstractSaslCallbackHandler(DirectoryService directoryService,
                                      org.apache.directory.api.ldap.model.message.BindRequest bindRequest)

Creates a new instance of AbstractSaslCallbackHandler.

Parameters:

directoryService - The DirectoryService instance

bindRequest - The Bind request

Method Detail

getUsername

protected String getUsername()

Implementors use this method to access the username resulting from a callback. Callback default name will be username, eg 'hnelson', for CRAM-MD5 and DIGEST-MD5. The NameCallback is not used by GSSAPI.

Returns:

The user name

getRealm

protected String getRealm()

Implementors use this method to access the realm resulting from a callback. Callback default text will be realm name, eg 'example.com', for DIGEST-MD5. The RealmCallback is not used by GSSAPI nor by CRAM-MD5.

Returns:

The realm

lookupPassword

protected abstract org.apache.directory.api.ldap.model.entry.Attribute lookupPassword(String username,
                                                                                      String realm)

Implementors set the password based on a lookup, using the username and realm as keys.

• For DIGEST-MD5, lookup password based on username and realm.
• For CRAM-MD5, lookup password based on username.
• For GSSAPI, this callback is unused.

Parameters:

username - The username.

realm - The realm.

Returns:

The Password entry attribute resulting from the lookup. It may contain more than one password

authorize

protected abstract void authorize(AuthorizeCallback callback)
                           throws Exception

Final check to authorize user. Used by all SASL mechanisms. This is the only callback used by GSSAPI. Implementors use setAuthorizedID() to set the base Dn after canonicalization. Implementors must setAuthorized() to true if authentication was successful.

Parameters:

callback - An AuthorizeCallback.

Throws:

Exception - If the authorization failed

handle

public void handle(Callback[] callbacks)

SaslServer will use this method to call various callbacks, depending on the SASL mechanism in use for a session.

Specified by:

handle in interface CallbackHandler

Parameters:

callbacks - An array of one or more callbacks.

getContext

protected LdapContext getContext(org.apache.mina.core.session.IoSession session,
                                 org.apache.directory.api.ldap.model.message.BindRequest bindRequest,
                                 Hashtable<String,Object> env)

Convenience method for acquiring an LdapContext for the client to use for the duration of a session.

Parameters:

session - The current session.

bindRequest - The current BindRequest.

env - An environment to be used to acquire an LdapContext.

Returns:

An LdapContext for the client.

getEnvironment

protected Hashtable<String,Object> getEnvironment(org.apache.mina.core.session.IoSession session)

Convenience method for getting an environment suitable for acquiring an LdapContext for the client.

Parameters:

session - The current session.

Returns:

An environment suitable for acquiring an LdapContext for the client.