Package org.opends.server.extensions

Class ExternalSASLMechanismHandler

java.lang.Object
org.opends.server.api.SASLMechanismHandler<ExternalSaslMechanismHandlerCfg>
org.opends.server.extensions.ExternalSASLMechanismHandler
All Implemented Interfaces:
ConfigurationChangeListener<ExternalSaslMechanismHandlerCfg>
public final class ExternalSASLMechanismHandler extends SASLMechanismHandler<ExternalSaslMechanismHandlerCfg> implements ConfigurationChangeListener<ExternalSaslMechanismHandlerCfg>
This class provides an implementation of a SASL mechanism that relies on some form of authentication that has already been done outside the LDAP layer. At the present time, this implementation only provides support for SSL-based clients that presented their own certificate to the Directory Server during the negotiation process. Future implementations may be updated to look in other places to find and evaluate this external authentication information.

  • Constructor Details

    • ExternalSASLMechanismHandler

      public ExternalSASLMechanismHandler()
      Creates a new instance of this SASL mechanism handler. No initialization should be done in this method, as it should all be performed in the initializeSASLMechanismHandler method.

  • Method Details

    • getMechanismName

      public String getMechanismName()
      Description copied from class: SASLMechanismHandler
      Returns the SASL mechanism name.
      Specified by:
      getMechanismName in class SASLMechanismHandler<ExternalSaslMechanismHandlerCfg>
      Returns:
      the SASL mechanism name.

    • initializeSASLMechanismHandler

      public void initializeSASLMechanismHandler(ExternalSaslMechanismHandlerCfg configuration, ServerContext serverContext)
      Description copied from class: SASLMechanismHandler
      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.
      Specified by:
      initializeSASLMechanismHandler in class SASLMechanismHandler<ExternalSaslMechanismHandlerCfg>
      Parameters:
      configuration - The configuration to use to initialize this SASL mechanism handler.
      serverContext - The server context

    • finalizeSASLMechanismHandler

      public void finalizeSASLMechanismHandler()
      Description copied from class: SASLMechanismHandler
      Performs any finalization that may be necessary for this SASL mechanism handler. By default, no finalization is performed.
      Overrides:
      finalizeSASLMechanismHandler in class SASLMechanismHandler<ExternalSaslMechanismHandlerCfg>

    • processSASLBind

      public void processSASLBind(BindOperation bindOperation)
      Description copied from class: SASLMechanismHandler
      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.
      Specified by:
      processSASLBind in class SASLMechanismHandler<ExternalSaslMechanismHandlerCfg>
      Parameters:
      bindOperation - The SASL bind operation to be processed.

    • isPasswordBased

      public boolean isPasswordBased()
      Description copied from class: SASLMechanismHandler
      Indicates whether this SASL mechanism is password-based or uses some other form of credentials (e.g., an SSL client certificate or Kerberos ticket).
      Specified by:
      isPasswordBased in class SASLMechanismHandler<ExternalSaslMechanismHandlerCfg>
      Returns:
      true if this SASL mechanism is password-based, or false if it uses some other form of credentials.

    • isSecure

      public boolean isSecure()
      Description copied from class: SASLMechanismHandler
      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).
      Specified by:
      isSecure in class SASLMechanismHandler<ExternalSaslMechanismHandlerCfg>
      Returns:
      true if this SASL mechanism should be considered secure, or false if not.

    • isConfigurationChangeAcceptable

      public boolean isConfigurationChangeAcceptable(ExternalSaslMechanismHandlerCfg configuration, List<LocalizableMessage> unacceptableReasons)
      Description copied from interface: ConfigurationChangeListener
      Indicates whether the proposed change to the configuration is acceptable to this change listener.
      Specified by:
      isConfigurationChangeAcceptable in interface ConfigurationChangeListener<ExternalSaslMechanismHandlerCfg>
      Parameters:
      configuration - The new configuration containing the changes.
      unacceptableReasons - A list that can be used to hold messages about why the provided configuration is not acceptable.
      Returns:
      Returns true if the proposed change is acceptable, or false if it is not.

    • applyConfigurationChange

      public ConfigChangeResult applyConfigurationChange(ExternalSaslMechanismHandlerCfg configuration)
      Description copied from interface: ConfigurationChangeListener
      Applies the configuration changes to this change listener.
      Specified by:
      applyConfigurationChange in interface ConfigurationChangeListener<ExternalSaslMechanismHandlerCfg>
      Parameters:
      configuration - The new configuration containing the changes.
      Returns:
      Returns information about the result of changing the configuration.