LDAP Authentication Advanced: Authenticate consumers by username - Plugin

Authenticate consumers by username

Configure the plugin to add LDAP authentication and authenticate consumers by username.

Prerequisites

You have an LDAP server running

Environment variables

LDAP_HOST: The host for the LDAP server to use.

Set up the plugin

Add this section to your declarative configuration file:

_format_version: "3.0"
plugins:
  - name: ldap-auth-advanced
    config:
      ldap_host: ${{ env "DECK_LDAP_HOST" }}
      ldap_port: 389
      start_tls: true
      base_dn: dc=example,dc=com
      verify_ldap_host: false
      attribute: cn
      cache_ttl: 60
      header_type: ldap
      consumer_by: username

Make the following request:

curl -i -X POST http://localhost:8001/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "ldap-auth-advanced",
      "config": {
        "ldap_host": "'$LDAP_HOST'",
        "ldap_port": 389,
        "start_tls": true,
        "base_dn": "dc=example,dc=com",
        "verify_ldap_host": false,
        "attribute": "cn",
        "cache_ttl": 60,
        "header_type": "ldap",
        "consumer_by": "username"
      }
    }
    '

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "ldap-auth-advanced",
      "config": {
        "ldap_host": "'$LDAP_HOST'",
        "ldap_port": 389,
        "start_tls": true,
        "base_dn": "dc=example,dc=com",
        "verify_ldap_host": false,
        "attribute": "cn",
        "cache_ttl": 60,
        "header_type": "ldap",
        "consumer_by": "username"
      }
    }
    '

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
controlPlaneId: The id of the control plane.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

echo "
apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
  name: ldap-auth-advanced
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
  labels:
    global: 'true'
config:
  ldap_host: '$LDAP_HOST'
  ldap_port: 389
  start_tls: true
  base_dn: dc=example,dc=com
  verify_ldap_host: false
  attribute: cn
  cache_ttl: 60
  header_type: ldap
  consumer_by: username
plugin: ldap-auth-advanced
" | kubectl apply -f -

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_ldap_auth_advanced" "my_ldap_auth_advanced" {
  enabled = true

  config = {
    ldap_host = var.ldap_host
    ldap_port = 389
    start_tls = true
    base_dn = "dc=example,dc=com"
    verify_ldap_host = false
    attribute = "cn"
    cache_ttl = 60
    header_type = "ldap"
    consumer_by = "username"
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
}

This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value.

variable "ldap_host" {
  type = string
}

Add this section to your declarative configuration file:

_format_version: "3.0"
plugins:
  - name: ldap-auth-advanced
    service: serviceName|Id
    config:
      ldap_host: ${{ env "DECK_LDAP_HOST" }}
      ldap_port: 389
      start_tls: true
      base_dn: dc=example,dc=com
      verify_ldap_host: false
      attribute: cn
      cache_ttl: 60
      header_type: ldap
      consumer_by: username

Make sure to replace the following placeholders with your own values:

serviceName|Id: The id or name of the service the plugin configuration will target.

Make the following request:

curl -i -X POST http://localhost:8001/services/{serviceName|Id}/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "ldap-auth-advanced",
      "config": {
        "ldap_host": "'$LDAP_HOST'",
        "ldap_port": 389,
        "start_tls": true,
        "base_dn": "dc=example,dc=com",
        "verify_ldap_host": false,
        "attribute": "cn",
        "cache_ttl": 60,
        "header_type": "ldap",
        "consumer_by": "username"
      }
    }
    '

Make sure to replace the following placeholders with your own values:

serviceName|Id: The id or name of the service the plugin configuration will target.

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/services/{serviceId}/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "ldap-auth-advanced",
      "config": {
        "ldap_host": "'$LDAP_HOST'",
        "ldap_port": 389,
        "start_tls": true,
        "base_dn": "dc=example,dc=com",
        "verify_ldap_host": false,
        "attribute": "cn",
        "cache_ttl": 60,
        "header_type": "ldap",
        "consumer_by": "username"
      }
    }
    '

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
controlPlaneId: The id of the control plane.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
serviceId: The id of the service the plugin configuration will target.

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: ldap-auth-advanced
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
config:
  ldap_host: '$LDAP_HOST'
  ldap_port: 389
  start_tls: true
  base_dn: dc=example,dc=com
  verify_ldap_host: false
  attribute: cn
  cache_ttl: 60
  header_type: ldap
  consumer_by: username
plugin: ldap-auth-advanced
" | kubectl apply -f -

Next, apply the KongPlugin resource by annotating the service resource:

kubectl annotate -n kong service SERVICE_NAME konghq.com/plugins=ldap-auth-advanced

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_ldap_auth_advanced" "my_ldap_auth_advanced" {
  enabled = true

  config = {
    ldap_host = var.ldap_host
    ldap_port = 389
    start_tls = true
    base_dn = "dc=example,dc=com"
    verify_ldap_host = false
    attribute = "cn"
    cache_ttl = 60
    header_type = "ldap"
    consumer_by = "username"
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  service = {
    id = konnect_gateway_service.my_service.id
  }
}

This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value.

variable "ldap_host" {
  type = string
}

Add this section to your declarative configuration file:

_format_version: "3.0"
plugins:
  - name: ldap-auth-advanced
    route: routeName|Id
    config:
      ldap_host: ${{ env "DECK_LDAP_HOST" }}
      ldap_port: 389
      start_tls: true
      base_dn: dc=example,dc=com
      verify_ldap_host: false
      attribute: cn
      cache_ttl: 60
      header_type: ldap
      consumer_by: username

Make sure to replace the following placeholders with your own values:

routeName|Id: The id or name of the route the plugin configuration will target.

Make the following request:

curl -i -X POST http://localhost:8001/routes/{routeName|Id}/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "ldap-auth-advanced",
      "config": {
        "ldap_host": "'$LDAP_HOST'",
        "ldap_port": 389,
        "start_tls": true,
        "base_dn": "dc=example,dc=com",
        "verify_ldap_host": false,
        "attribute": "cn",
        "cache_ttl": 60,
        "header_type": "ldap",
        "consumer_by": "username"
      }
    }
    '

Make sure to replace the following placeholders with your own values:

routeName|Id: The id or name of the route the plugin configuration will target.

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/routes/{routeId}/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "ldap-auth-advanced",
      "config": {
        "ldap_host": "'$LDAP_HOST'",
        "ldap_port": 389,
        "start_tls": true,
        "base_dn": "dc=example,dc=com",
        "verify_ldap_host": false,
        "attribute": "cn",
        "cache_ttl": 60,
        "header_type": "ldap",
        "consumer_by": "username"
      }
    }
    '

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
controlPlaneId: The id of the control plane.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
routeId: The id of the route the plugin configuration will target.

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: ldap-auth-advanced
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
config:
  ldap_host: '$LDAP_HOST'
  ldap_port: 389
  start_tls: true
  base_dn: dc=example,dc=com
  verify_ldap_host: false
  attribute: cn
  cache_ttl: 60
  header_type: ldap
  consumer_by: username
plugin: ldap-auth-advanced
" | kubectl apply -f -

Next, apply the KongPlugin resource by annotating the httproute or ingress resource:

kubectl annotate -n kong httproute  konghq.com/plugins=ldap-auth-advanced

kubectl annotate -n kong ingress  konghq.com/plugins=ldap-auth-advanced

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_ldap_auth_advanced" "my_ldap_auth_advanced" {
  enabled = true

  config = {
    ldap_host = var.ldap_host
    ldap_port = 389
    start_tls = true
    base_dn = "dc=example,dc=com"
    verify_ldap_host = false
    attribute = "cn"
    cache_ttl = 60
    header_type = "ldap"
    consumer_by = "username"
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  route = {
    id = konnect_gateway_route.my_route.id
  }
}

This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value.

variable "ldap_host" {
  type = string
}

LDAP Authentication Advanced

Authenticate consumers by username

Prerequisites

Environment variables

Set up the plugin

Help us make these docs great!

Still need help