LDAP Authentication Configuration

You are browsing documentation for an outdated plugin version.

Configuration

This plugin is compatible with DB-less mode.

Compatible protocols

The LDAP Authentication plugin is compatible with the following protocols:

grpc, grpcs, http, https, ws, wss

Parameters

Here's a list of all the parameters which can be used in this plugin's configuration:

• name or plugin

  string required

  The name of the plugin, in this case ldap-auth.

  • If using the Kong Admin API, Konnect API, declarative configuration, or decK files, the field is name.
  • If using the KongPlugin object in Kubernetes, the field is plugin.

• instance_name

  string

  An optional custom name to identify an instance of the plugin, for example ldap-auth_my-service.

  The instance name shows up in Kong Manager and in Konnect, so it's useful when running the same plugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance via the Kong Admin API.

  An instance name must be unique within the following context:

  • Within a workspace for Kong Gateway Enterprise
  • Within a control plane or control plane group for Konnect
  • Globally for Kong Gateway (OSS)

• service.name or service.id

  string

  The name or ID of the service the plugin targets. Set one of these parameters if adding the plugin to a service through the top-level /plugins endpoint. Not required if using /services/{serviceName|Id}/plugins.

• route.name or route.id

  string

  The name or ID of the route the plugin targets. Set one of these parameters if adding the plugin to a route through the top-level /plugins endpoint. Not required if using /routes/{routeName|Id}/plugins.

• enabled

  boolean default: true

  Whether this plugin will be applied.

• config

  record required
  • ldap_host

    string required

    A string representing a host name, such as example.com.

  • ldap_port

    integer required default: 389 between: 0 65535

    An integer representing a port number between 0 and 65535, inclusive.

  • ldaps

    boolean required default: false

    Set to true to connect using the LDAPS protocol (LDAP over TLS). When ldaps is configured, you must use port 636. If the ldap setting is enabled, ensure the start_tls setting is disabled.

  • start_tls

    boolean required default: false

    Set it to true to issue StartTLS (Transport Layer Security) extended operation over ldap connection. If the start_tls setting is enabled, ensure the ldaps setting is disabled.

  • verify_ldap_host

    boolean required default: false

    Set to true to authenticate LDAP server. The server certificate will be verified according to the CA certificates specified by the lua_ssl_trusted_certificate directive.

  • base_dn

    string required

    Base DN as the starting point for the search; e.g., dc=example,dc=com

  • attribute

    string required

    Attribute to be used to search the user; e.g. cn

  • cache_ttl

    number required default: 60

    Cache expiry time in seconds.

  • hide_credentials

    boolean required default: false

    An optional boolean value telling the plugin to hide the credential to the upstream server. It will be removed by Kong before proxying the request.

  • timeout

    number default: 10000

    An optional timeout in milliseconds when waiting for connection with LDAP server.

  • keepalive

    number default: 60000

    An optional value in milliseconds that defines how long an idle connection to LDAP server will live before being closed.

  • anonymous

    string

    An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request fails with an authentication failure 4xx.

  • header_type

    string default: ldap

    An optional string to use as part of the Authorization header

  • realm

    string

    When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.