Configuration Reference Home
OpenDJ - Plain SASL Mechanism Handler

Plain SASL Mechanism Handler

The Plain SASL Mechanism Handler performs all processing related to SASL PLAIN authentication.

The PLAIN SASL mechanism provides the ability for clients to authenticate using a username and password. This authentication is very similar to standard LDAP simple authentication, with the exception that it can authenticate based on an authentication ID (for example, a username) rather than requiring a full DN, and it can also include an authorization ID in addition to the authentication ID. Note that the SASL PLAIN mechanism does not make any attempt to protect the password.

Parent Component

The Plain SASL Mechanism Handler component inherits from the SASL Mechanism Handler

Relations From this Component

The following components have a direct AGGREGATION relation FROM Plain SASL Mechanism Handlers :

Properties

A description of each property follows.


Basic Properties: Advanced Properties:
↓ enabled ↓ java-class
↓ identity-mapper

Basic Properties

enabled

Description
Indicates whether the SASL mechanism handler is enabled for use.
Default Value
None
Allowed Values
true
false
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No

identity-mapper

Description
Specifies the name of the identity mapper that is to be used with this SASL mechanism handler to match the authentication or authorization ID included in the SASL bind request to the corresponding user in the directory.
Default Value
None
Allowed Values
The DN of any Identity Mapper. The referenced identity mapper must be enabled when the Plain SASL Mechanism Handler is enabled.
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No


Advanced Properties

java-class

Description
Specifies the fully-qualified name of the Java class that provides the SASL mechanism handler implementation.
Default Value
org.opends.server.extensions.PlainSASLMechanismHandler
Allowed Values
A java class that implements or extends the class(es) :
org.opends.server.api.SASLMechanismHandler
Multi-valued
No
Required
Yes
Admin Action Required
The Plain SASL Mechanism Handler must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
Yes
Read-only
No