External SASL Mechanism Handler

The External SASL Mechanism Handler performs all processing related to SASL EXTERNAL authentication.

Parent

The External SASL Mechanism Handler object inherits from SASL Mechanism Handler.

Dependencies

External SASL Mechanism Handlers depend on the following objects:

Properties

Use the --advanced option to access advanced properties.

Basic Properties

certificate-attribute

SynopsisSpecifies the name of the attribute to hold user certificates.
DescriptionThis property must specify the name of a valid attribute type defined in the server schema.
Default ValueuserCertificate
Allowed ValuesThe name of an attribute type defined in the LDAP schema.
Multi-valuedNo
RequiredNo
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

certificate-mapper

SynopsisSpecifies the name of the certificate mapper that should be used to match client certificates to user entries.
Default ValueNone
Allowed ValuesThe name of an existing Certificate Mapper. The referenced certificate mapper must be enabled when the External SASL Mechanism Handler is enabled.
Multi-valuedNo
RequiredYes
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

certificate-validation-policy

SynopsisIndicates whether to attempt to validate the peer certificate against a certificate held in the user's entry.
Default ValueNone
Allowed Values

always: Always require the peer certificate to be present in the user's entry.

ifpresent: If the user's entry contains one or more certificates, require that one of them match the peer certificate.

never: Do not look for the peer certificate to be present in the user's entry.

Multi-valuedNo
RequiredYes
Admin Action RequiredNone
AdvancedNo
Read-OnlyNo

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

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.ExternalSASLMechanismHandler
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