DIGEST-MD5 SASL Mechanism Handler

The DIGEST-MD5 SASL mechanism is used to perform all processing related to SASL DIGEST-MD5 authentication.

The DIGEST-MD5 SASL mechanism is very similar to the CRAM-MD5 mechanism in that it allows for password-based authentication without exposing the password in the clear (although it does require that both the client and the server have access to the clear-text password). Like the CRAM-MD5 mechanism, it uses data that is randomly generated by the server to make it resistant to replay attacks, but it also includes randomly-generated data from the client, which makes it also resistant to problems resulting from weak server-side random number generation.

Parent

The DIGEST-MD5 SASL Mechanism Handler object inherits from SASL Mechanism Handler.

Dependencies

DIGEST-MD5 SASL Mechanism Handlers depend on the following objects:

Properties

Use the --advanced option to access advanced properties.

Basic Properties

enabled

SynopsisIndicates whether the SASL mechanism handler is enabled for use.
Default ValueNone
Allowed Valuestrue
false
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

identity-mapper

SynopsisSpecifies 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 ValueNone
Allowed ValuesThe name of an existing Identity Mapper. The referenced identity mapper must be enabled when the DIGEST-MD5 SASL Mechanism Handler is enabled.
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

quality-of-protection

SynopsisThe name of a property that specifies the quality of protection the server will support.
Default Valuenone
Allowed Values

confidentiality: Quality of protection equals authentication with integrity and confidentiality protection.

integrity: Quality of protection equals authentication with integrity protection.

none: QOP equals authentication only.

Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

realm

SynopsisSpecifies the realms that is to be used by the server for DIGEST-MD5 authentication.
DescriptionIf this value is not provided, then the server defaults to use the fully qualified hostname of the machine.
Default ValueIf this value is not provided, then the server defaults to use the fully qualified hostname of the machine.
Allowed ValuesAny realm string that does not contain a comma.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

server-fqdn

SynopsisSpecifies the DNS-resolvable fully-qualified domain name for the server that is used when validating the digest-uri parameter during the authentication process.
DescriptionIf this configuration attribute is present, then the server expects that clients use a digest-uri equal to "ldap/" followed by the value of this attribute. For example, if the attribute has a value of "directory.example.com", then the server expects clients to use a digest-uri of "ldap/directory.example.com". If no value is provided, then the server does not attempt to validate the digest-uri provided by the client and accepts any value.
Default ValueThe server attempts to determine the fully-qualified domain name dynamically.
Allowed ValuesThe fully-qualified address that is expected for clients to use when connecting to the server and authenticating via DIGEST-MD5.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

Advanced Properties

java-class

SynopsisSpecifies the fully-qualified name of the Java class that provides the SASL mechanism handler implementation.
Default Valueorg.opends.server.extensions.DigestMD5SASLMechanismHandler
Allowed ValuesA Java class that extends or implements:
org.opends.server.api.SASLMechanismHandler
Multi-valuedNo
RequiredYes
Admin Action RequiredThe object must be disabled and re-enabled for changes to take effect.
AdvancedYes
Read-OnlyNo