Package org.opends.server.api

Class SASLMechanismHandler<T extends SaslMechanismHandlerCfg>

java.lang.Object

org.opends.server.api.SASLMechanismHandler<T>

Type Parameters:

T - The type of configuration handled by this SASL mechanism handler.

Direct Known Subclasses:

AnonymousSASLMechanismHandler, CRAMMD5SASLMechanismHandler, DigestMD5SASLMechanismHandler, ExternalSASLMechanismHandler, GSSAPISASLMechanismHandler, PlainSASLMechanismHandler, ScramSha256SASLMechanismHandler, ScramSha512SASLMechanismHandler

@PublicAPI(stability=VOLATILE,
           mayInstantiate=false,
           mayExtend=true,
           mayInvoke=false)
public abstract class SASLMechanismHandler<T extends SaslMechanismHandlerCfg>
extends Object

This class defines the set of methods and structures that must be implemented by a Directory Server module that implements the functionality required for one or more SASL mechanisms.

Constructor Summary

Constructors

Constructor	Description
SASLMechanismHandler()

Method Summary

Modifier and Type	Method	Description
void	finalizeSASLMechanismHandler()	Performs any finalization that may be necessary for this SASL mechanism handler.
abstract String	getMechanismName()	Returns the SASL mechanism name.
abstract void	initializeSASLMechanismHandler(T configuration, ServerContext serverContext)	Initializes this SASL mechanism handler based on the information in the provided configuration entry.
boolean	isConfigurationAcceptable(T configuration, List<LocalizableMessage> unacceptableReasons)	Indicates whether the provided configuration is acceptable for this SASL mechanism handler.
abstract boolean	isPasswordBased()	Indicates whether this SASL mechanism is password-based or uses some other form of credentials (e.g., an SSL client certificate or Kerberos ticket).
abstract boolean	isSecure()	Indicates whether this SASL mechanism should be considered secure (i.e., it does not expose the authentication credentials in a manner that is useful to a third-party observer, and other aspects of the authentication are generally secure).
abstract void	processSASLBind(BindOperation bindOperation)	Processes the SASL bind operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

SASLMechanismHandler

public SASLMechanismHandler()

Method Detail

getMechanismName

public abstract String getMechanismName()

Returns the SASL mechanism name.

Returns:

the SASL mechanism name.

initializeSASLMechanismHandler

public abstract void initializeSASLMechanismHandler(T configuration,
                                                    ServerContext serverContext)
                                             throws ConfigException,
                                                    InitializationException

Initializes this SASL mechanism handler based on the information in the provided configuration entry. It should also register itself with the Directory Server for the particular kinds of SASL mechanisms that it will process.

Parameters:

configuration - The configuration to use to initialize this SASL mechanism handler.

serverContext - The server context

Throws:

ConfigException - If an unrecoverable problem arises in the process of performing the initialization.

InitializationException - If a problem occurs during initialization that is not related to the server configuration.

isConfigurationAcceptable

public boolean isConfigurationAcceptable(T configuration,
                                         List<LocalizableMessage> unacceptableReasons)

Indicates whether the provided configuration is acceptable for this SASL mechanism handler. It should be possible to call this method on an uninitialized SASL mechanism handler instance in order to determine whether the SASL mechanism handler would be able to use the provided configuration.

Parameters:

configuration - The SASL mechanism handler configuration for which to make the determination.

unacceptableReasons - A list that may be used to hold the reasons that the provided configuration is not acceptable.

Returns:

true if the provided configuration is acceptable for this SASL mechanism handler, or false if not.

finalizeSASLMechanismHandler

public void finalizeSASLMechanismHandler()

Performs any finalization that may be necessary for this SASL mechanism handler. By default, no finalization is performed.

processSASLBind

public abstract void processSASLBind(BindOperation bindOperation)

Processes the SASL bind operation. SASL mechanism implementations must ensure that the following actions are taken during the processing of this method:

• The BindOperation.setResultCode method must be used to set the appropriate result code.
• If the SASL processing gets far enough to be able to map the request to a user entry (regardless of whether the authentication is ultimately successful), then this method must call the BindOperation.setSASLAuthUserEntry method to provide it with the entry for the user that attempted to authenticate.
• If the bind processing was successful, then the BindOperation.setAuthenticationInfo method must be used to set the authentication info for the bind operation.
• If the bind processing was not successful, then the BindOperation.setAuthFailureReason method should be used to provide a message explaining why the authentication failed.

Parameters:

bindOperation - The SASL bind operation to be processed.

isPasswordBased

public abstract boolean isPasswordBased()

Indicates whether this SASL mechanism is password-based or uses some other form of credentials (e.g., an SSL client certificate or Kerberos ticket).

Returns:

true if this SASL mechanism is password-based, or false if it uses some other form of credentials.

isSecure

public abstract boolean isSecure()

Indicates whether this SASL mechanism should be considered secure (i.e., it does not expose the authentication credentials in a manner that is useful to a third-party observer, and other aspects of the authentication are generally secure).

Returns:

true if this SASL mechanism should be considered secure, or false if not.