GSSAPI SASL Mechanism Handler

The GSSAPI SASL mechanism performs all processing related to SASL GSSAPI authentication using Kerberos V5.

The GSSAPI SASL mechanism provides the ability for clients to authenticate themselves to the server using existing authentication in a Kerberos environment. This mechanism provides the ability to achieve single sign-on for Kerberos-based clients.

Parent

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

Dependencies

GSSAPI SASL Mechanism Handlers depend on the following objects:

GSSAPI SASL Mechanism Handler Properties

You can use configuration expressions to set property values at startup time. For details, see Property Value Substitution.

Basic Properties Advanced Properties

enabled
identity-mapper
kdc-address
keytab
principal-name
quality-of-protection
realm
server-fqdn

java-class

Basic Properties

Use the --advanced option to access advanced properties.

enabled

Synopsis

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

No

Read-Only

No

identity-mapper

Synopsis

Specifies the name(s) of the identity mapper(s) that are to be used with this SASL mechanism handler to match the Kerberos principal included in the SASL bind request to the corresponding user in the directory.

Default Value

None

Allowed Values

The name of an existing identity-mapper.

The referenced identity mapper(s) must be enabled when the GSSAPI SASL Mechanism Handler is enabled.

Multi-valued

Yes

Required

Yes

Admin Action Required

None

Advanced

No

Read-Only

No

kdc-address

Synopsis

Specifies the address of the KDC that is to be used for Kerberos processing.

Description

If provided, this property must be a fully-qualified DNS-resolvable name. If this property is not provided, then the server attempts to determine it from the system-wide Kerberos configuration.

Default Value

The server attempts to determine the KDC address from the underlying system configuration.

Allowed Values

A string.

Multi-valued

No

Required

No

Admin Action Required

None

Advanced

No

Read-Only

No

keytab

Synopsis

Specifies the path to the keytab file that should be used for Kerberos processing.

Description

If provided, this is either an absolute path or one that is relative to the server instance root.

Default Value

The server attempts to use the system-wide default keytab.

Allowed Values

A string.

Multi-valued

No

Required

No

Admin Action Required

None

Advanced

No

Read-Only

No

principal-name

Synopsis

Specifies the principal name.

Description

It can either be a simple user name or a service name such as host/example.com. If this property is not provided, then the server attempts to build the principal name by appending the fully qualified domain name to the string "ldap/".

Default Value

The server attempts to determine the principal name from the underlying system configuration.

Allowed Values

A string.

Multi-valued

No

Required

No

Admin Action Required

None

Advanced

No

Read-Only

No

quality-of-protection

Synopsis

The name of a property that specifies the quality of protection the server will support.

Default Value

none

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-valued

No

Required

No

Admin Action Required

None

Advanced

No

Read-Only

No

realm

Synopsis

Specifies the realm to be used for GSSAPI authentication.

Default Value

The server attempts to determine the realm from the underlying system configuration.

Allowed Values

A string.

Multi-valued

No

Required

No

Admin Action Required

None

Advanced

No

Read-Only

No

server-fqdn

Synopsis

Specifies the DNS-resolvable fully-qualified domain name for the system.

Default Value

The server attempts to determine the fully-qualified domain name dynamically .

Allowed Values

A string.

Multi-valued

No

Required

No

Admin Action Required

None

Advanced

No

Read-Only

No

Advanced Properties

Use the --advanced option to access advanced properties.

java-class

Synopsis

Specifies the fully-qualified name of the Java class that provides the SASL mechanism handler implementation.

Default Value

org.opends.server.extensions.GSSAPISASLMechanismHandler

Allowed Values

A Java class that extends or implements:

  • org.opends.server.api.SASLMechanismHandler

Multi-valued

No

Required

Yes

Admin Action Required

The object must be disabled and re-enabled for changes to take effect.

Advanced

Yes

Read-Only

No