/*
|
* The contents of this file are subject to the terms of the Common Development and
|
* Distribution License (the License). You may not use this file except in compliance with the
|
* License.
|
*
|
* You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
|
* specific language governing permission and limitations under the License.
|
*
|
* When distributing Covered Software, include this CDDL Header Notice in each file and include
|
* the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
|
* Header, with the fields enclosed by brackets [] replaced by your own identifying
|
* information: "Portions Copyright [year] [name of copyright owner]".
|
*
|
* Copyright 2006-2008 Sun Microsystems, Inc.
|
* Portions Copyright 2014-2016 ForgeRock AS.
|
*/
|
package org.opends.server.api;
|
import org.forgerock.i18n.LocalizableMessage;
|
|
|
|
import java.util.List;
|
|
import org.forgerock.opendj.server.config.server.SASLMechanismHandlerCfg;
|
import org.forgerock.opendj.config.server.ConfigException;
|
import org.opends.server.core.BindOperation;
|
import org.opends.server.types.InitializationException;
|
|
|
|
/**
|
* 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.
|
*
|
* @param <T> The type of configuration handled by this SASL
|
* mechanism handler.
|
*/
|
@org.opends.server.types.PublicAPI(
|
stability=org.opends.server.types.StabilityLevel.VOLATILE,
|
mayInstantiate=false,
|
mayExtend=true,
|
mayInvoke=false)
|
public abstract class SASLMechanismHandler
|
<T extends SASLMechanismHandlerCfg>
|
{
|
/**
|
* 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.
|
*
|
* @param configuration The configuration to use to initialize
|
* this SASL mechanism handler.
|
*
|
* @throws ConfigException If an unrecoverable problem arises in
|
* the process of performing the
|
* initialization.
|
*
|
* @throws InitializationException If a problem occurs during
|
* initialization that is not
|
* related to the server
|
* configuration.
|
*/
|
public abstract void initializeSASLMechanismHandler(T configuration)
|
throws ConfigException, InitializationException;
|
|
|
|
/**
|
* 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.
|
* <BR><BR>
|
* Note that implementations which use a subclass of the provided
|
* configuration class will likely need to cast the configuration
|
* to the appropriate subclass type.
|
*
|
* @param configuration The SASL mechanism handler
|
* configuration for which to make the
|
* determination.
|
* @param unacceptableReasons A list that may be used to hold the
|
* reasons that the provided
|
* configuration is not acceptable.
|
*
|
* @return {@code true} if the provided configuration is acceptable
|
* for this SASL mechanism handler, or {@code false} if
|
* not.
|
*/
|
public boolean isConfigurationAcceptable(
|
SASLMechanismHandlerCfg configuration,
|
List<LocalizableMessage> unacceptableReasons)
|
{
|
// This default implementation does not perform any special
|
// validation. It should be overridden by SASL mechanism handler
|
// implementations that wish to perform more detailed validation.
|
return true;
|
}
|
|
|
|
/**
|
* Performs any finalization that may be necessary for this SASL
|
* mechanism handler. By default, no finalization is performed.
|
*/
|
public void finalizeSASLMechanismHandler()
|
{
|
// No implementation is required by default.
|
}
|
|
|
|
/**
|
* Processes the SASL bind operation. SASL mechanism
|
* implementations must ensure that the following actions are taken
|
* during the processing of this method:
|
* <UL>
|
* <LI>The {@code BindOperation.setResultCode} method must be used
|
* to set the appropriate result code.</LI>
|
* <LI>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 {@code BindOperation.setSASLAuthUserEntry}
|
* method to provide it with the entry for the user that
|
* attempted to authenticate.</LI>
|
* <LI>If the bind processing was successful, then the
|
* {@code BindOperation.setAuthenticationInfo} method must be
|
* used to set the authentication info for the bind
|
* operation.</LI>
|
* <LI>If the bind processing was not successful, then the
|
* {@code BindOperation.setAuthFailureReason} method should be
|
* used to provide a message explaining why the authentication
|
* failed.</LI>
|
* </UL>
|
*
|
* @param bindOperation The SASL bind operation to be processed.
|
*/
|
public abstract void processSASLBind(BindOperation bindOperation);
|
|
|
|
/**
|
* Indicates whether the specified SASL mechanism is password-based
|
* or uses some other form of credentials (e.g., an SSL client
|
* certificate or Kerberos ticket).
|
*
|
* @param mechanism The name of the mechanism for which to make
|
* the determination. This will only be invoked
|
* with names of mechanisms for which this
|
* handler has previously registered.
|
*
|
* @return {@code true} if this SASL mechanism is password-based,
|
* or {@code false} if it uses some other form of
|
* credentials.
|
*/
|
public abstract boolean isPasswordBased(String mechanism);
|
|
|
|
/**
|
* Indicates whether the specified 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).
|
*
|
* @param mechanism The name of the mechanism for which to make
|
* the determination. This will only be invoked
|
* with names of mechanisms for which this
|
* handler has previously registered.
|
*
|
* @return {@code true} if this SASL mechanism should be considered
|
* secure, or {@code false} if not.
|
*/
|
public abstract boolean isSecure(String mechanism);
|
}
|
