Skip to content
Kong Logo | Kong Docs Logo
search
  • We're Hiring!
  • Docs
    • Kong Gateway
    • Kong Konnect
    • Kong Mesh
    • Plugin Hub
    • decK
    • Kubernetes Ingress Controller
    • Insomnia
    • Kuma

    • Docs contribution guidelines
  • Plugin Hub
  • Support
  • Community
  • Kong Academy
Get a Demo Start Free Trial
  • Kong Gateway
  • Kong Konnect
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kubernetes Ingress Controller
  • Insomnia
  • Kuma

  • Docs contribution guidelines
  • 3.2.x (latest)
  • 3.1.x
  • 3.0.x
  • 2.8.x
  • 2.7.x
  • 2.6.x
  • Older Enterprise versions (2.1-2.5)
  • Older OSS versions (2.1-2.5)
  • Archive (pre-2.1)
    • Overview of Kong Gateway
      • Version Support Policy
      • Third Party Dependencies
      • Browser Support
    • Stability
    • Release Notes
      • Services
        • Overview
        • Configure Routes with Expressions
      • Upstreams
      • Plugins
      • Routing Traffic
      • Load Balancing
      • Health Checks and Circuit Breakers
      • Kong Performance Testing
    • Glossary
    • Get Kong
    • Services and Routes
    • Rate Limiting
    • Proxy Caching
    • Key Authentication
    • Load-Balancing
      • Overview
        • Overview
        • Deploy Kong Gateway in Hybrid mode
      • DB-less Deployment
      • Traditional
      • Overview
        • Helm
        • OpenShift with Helm
        • kubectl apply
        • Kubernetes Deployment Options
        • Using docker run
        • Build your own Docker images
        • Amazon Linux
        • Debian
        • Red Hat
        • Ubuntu
      • Running Kong as a non-root user
      • Securing the Admin API
      • Using systemd
      • Start Kong Gateway Securely
      • Programatically Creating Admins
      • Enabling RBAC
      • Overview
      • Download your License
      • Deploy Enterprise License
      • Using the License API
      • Monitor Licenses Usage
      • Default Ports
      • DNS Considerations
      • Network and Firewall
      • CP/DP Communication through a Forward Proxy
        • Configure PostgreSQL TLS
        • Troubleshooting PostgreSQL TLS
    • Kong Configuration File
    • Environment Variables
    • Serving a Website and APIs from Kong
      • Overview
      • Prometheus
      • StatsD
      • Datadog
      • Overview
      • Writing a Custom Trace Exporter
      • Tracing API Reference
    • Resource Sizing Guidelines
    • Security Update Process
    • Blue-Green Deployments
    • Canary Deployments
    • Clustering Reference
      • Log Reference
      • Dynamic log level updates
      • Customize Gateway Logs
      • Upgrade Kong Gateway 3.x.x
      • Migrate from OSS to Enterprise
    • Overview
      • Overview
      • Metrics
      • Analytics with InfluxDB
      • Analytics with Prometheus
      • Estimate Analytics Storage in PostgreSQL
      • Overview
      • Getting Started
      • Advanced Usage
        • Overview
        • Environment Variables
        • AWS Secrets Manager
        • Google Secrets Manager
        • Hashicorp Vault
        • Securing the Database with AWS Secrets Manager
      • Reference Format
      • Overview
      • Get Started with Dynamic Plugin Ordering
      • Overview
      • Enable the Dev Portal
      • Publish an OpenAPI Spec
      • Structure and File Types
      • Themes Files
      • Working with Templates
      • Using the Editor
        • Basic Auth
        • Key Auth
        • OIDC
        • Sessions
        • Adding Custom Registration Fields
        • Manage Developers
        • Developer Roles and Content Permissions
        • Authorization Provider Strategy
        • Enable Application Registration
        • Enable Key Authentication for Application Registration
          • External OAuth2 Support
          • Set up Okta and Kong for External Oauth
          • Set up Azure AD and Kong for External Authentication
        • Manage Applications
        • Theme Editing
        • Migrating Templates Between Workspaces
        • Markdown Rendering Module
        • Customizing Portal Emails
        • Adding and Using JavaScript Assets
        • Single Page App in Dev Portal
        • Alternate OpenAPI Renderer
      • SMTP
      • Workspaces
      • Helpers CLI
      • Portal API Documentation
    • Audit Logging
    • Keyring and Data Encryption
    • Workspaces
    • Consumer Groups
    • Event Hooks
    • Configure Data Plane Resilience
    • About Control Plane Outage Management
      • Overview
      • Install the FIPS Compliant Package
      • FIPS 140-2 Compliant Plugins
    • Overview
    • Enable Kong Manager
      • Services and Routes
      • Rate Limiting
      • Proxy Caching
      • Authentication with Consumers
      • Load Balancing
      • Overview
      • Create a Super Admin
      • Workspaces and Teams
      • Reset Passwords and RBAC Tokens
      • Basic Auth
        • Configure LDAP
        • LDAP Service Directory Mapping
        • Configure OIDC
        • OIDC Authenticated Group Mapping
      • Sessions
        • Overview
        • Enable RBAC
        • Add a Role and Permissions
        • Create a User
        • Create an Admin
    • Networking Configuration
    • Workspaces
    • Create Consumer Groups
    • Sending Email
    • Overview
    • File Structure
    • Implementing Custom Logic
    • Plugin Configuration
    • Accessing the Data Store
    • Storing Custom Entities
    • Caching Custom Entities
    • Extending the Admin API
    • Writing Tests
    • (un)Installing your Plugin
      • Overview
      • kong.client
      • kong.client.tls
      • kong.cluster
      • kong.ctx
      • kong.ip
      • kong.jwe
      • kong.log
      • kong.nginx
      • kong.node
      • kong.request
      • kong.response
      • kong.router
      • kong.service
      • kong.service.request
      • kong.service.response
      • kong.table
      • kong.tracing
      • kong.vault
      • kong.websocket.client
      • kong.websocket.upstream
      • Go
      • Javascript
      • Python
      • Running Plugins in Containers
      • External Plugin Performance
    • Overview
        • Overview
        • OpenID Connect with Curity
        • OpenID Connect with Azure AD
        • OpenID Connect with Google
        • OpenID Connect with Okta
        • OpenID Connect with Auth0
        • OpenID Connect with Cognito
      • Authentication Reference
      • Allow Multiple Authentication Plugins
    • Rate Limiting Plugin
      • Add a Body Value
    • GraphQL
      • gRPC Plugins
      • Configure a gRPC service
    • Overview
    • Information Routes
    • Health Routes
    • Tags
    • Debug Routes
    • Services
    • Routes
    • Consumers
    • Plugins
    • Certificates
    • CA Certificates
    • SNIs
    • Upstreams
    • Targets
    • Vaults
    • Keys
    • Licenses
    • Workspaces
    • RBAC
    • Admins
    • Developers
    • Consumer Groups
    • Event Hooks
    • Keyring and Data Encryption
    • Audit Logs
    • kong.conf
    • Injecting Nginx Directives
    • CLI
    • Key Management
    • Performance Testing Framework
    • Router Expressions Language
    • FAQ

github-edit-pageEdit this page

report-issueReport an issue

enterprise-switcher-iconSwitch to OSS

On this page
  • Prerequisites
  • Enable LDAP authentication
  • Configure LDAP authentication
  • Define roles with permissions
  • User-admin mapping
  • Group-role assignment
    • Example
  • Set up a directory user as the first super admin
Kong Gateway
3.2.x (latest)
  • Home
  • Kong Gateway
  • Kong Manager
  • Authentication and Authorization
  • Ldap
  • Mapping LDAP Service Directory Groups to Kong Roles

Mapping LDAP Service Directory Groups to Kong Roles

Service directory mapping allows organizations to use their LDAP Directory for authentication and authorization in Kong Gateway.

After starting Kong Gateway with the desired configuration, you can create new admins whose usernames match those in your LDAP directory. Those users will then be able to accept invitations to join Kong Manager and log in with their LDAP credentials.

How service directory mapping works in Kong:

  • Roles are created in Kong Gateway using the Admin API or Kong Manager.
  • Groups are created and roles are associated with the groups.
  • When users log in to Kong Manager, they get permissions based on the group(s) they belong to.

For example, if a user’s group changes in the service directory, their Kong admin account’s associated role also changes in Kong Gateway the next time they log in to Kong Manager. The mapping removes the task of manually managing access in Kong Gateway, as it makes the service directory the system of record.

Prerequisites

  • Kong Gateway installed and configured
  • Kong Manager access
  • A local LDAP directory

Enable LDAP authentication

Configure service directory mapping to use your LDAP directory for authentication and authorization.

  1. Start Kong Gateway. From the shell, enter:

     kong start [-c /path/to/kong/conf]
    
  2. To enable LDAP Authentication and enforce RBAC for Kong Manager, configure Kong through kong.conf with the following properties:

     enforce_rbac = on
     admin_gui_auth = ldap-auth-advanced
     admin_gui_session_conf = { "secret":"set-your-string-here" }
    

    Kong Manager also uses the Sessions plugin in the background. This plugin (configured with admin_gui_session_conf) requires a secret and is configured securely by default.

    • Under all circumstances, the secret must be manually set to a string.
    • If using HTTP instead of HTTPS, cookie_secure must be manually set to false.
    • If using different domains for the Admin API and Kong Manager, cookie_same_site must be set to off.

    Learn more about these properties in Session Security in Kong Manager, and see example configurations.

Configure LDAP authentication

Configure LDAP authentication for Kong Manager with the following properties. Note the attribute variables defined below:

admin_gui_auth_conf = {
 "anonymous":"", \
 "attribute":"<ENTER_YOUR_ATTRIBUTE_HERE>", \
 "bind_dn":"<ENTER_YOUR_BIND_DN_HERE>", \
 "base_dn":"<ENTER_YOUR_BASE_DN_HERE>", \
 "cache_ttl": 2, \
 "header_type":"Basic", \
 "keepalive":60000, \
 "ldap_host":"<ENTER_YOUR_LDAP_HOST_HERE>", \
 "ldap_password":"<ENTER_YOUR_LDAP_PASSWORD_HERE>", \
 "ldap_port":389, \
 "start_tls":false, \
 "timeout":10000, \
 "verify_ldap_host":true, \
 "consumer_by":["username", "custom_id"], \
 "group_base_dn":"<ENTER_YOUR_GROUP_BASE_DN_HERE>",
 "group_name_attribute":"<ENTER_YOUR_GROUP_NAME_ATTRIBUTE_HERE>",
 "group_member_attribute":"<ENTER_YOUR_GROUP_MEMBER_ATTRIBUTE_HERE>",
}
Attribute Description
attribute The attribute used to identify LDAP users.
For example, to map LDAP users to admins by their username, set uid.
bind_dn LDAP Bind DN (Distinguished Name). Used to perform LDAP search for the user. This bind_dn should have permissions to search for the user being authenticated.
For example, uid=einstein,ou=scientists,dc=ldap,dc=com.
base_dn LDAP Base DN (Distinguished Name).
For example, ou=scientists,dc=ldap,dc=com.
ldap_host LDAP host domain.
For example, ec2-XX-XXX-XX-XXX.compute-1.amazonaws.com.
ldap_port The default LDAP port is 389. 636 is the port required for SSL LDAP and AD. If ldaps is configured, you must use port 636. For more complex Active Directory (AD) environments, instead of Domain Controller and port 389, consider using a Global Catalog host and port, which is port 3268 by default.
ldap_password LDAP password.
As with any configuration property, sensitive information may be set as an environment variable instead of being written directly in the configuration file.
group_base_dn Sets a distinguished name for the entry where LDAP searches for groups begin.
The default is the value from conf.base_dn.
group_name_attribute Sets the attribute holding the name of a group, typically called name (in Active Directory) or cn (in OpenLDAP).
The default is the value from conf.attribute.
group_member_attribute Sets the attribute holding the members of the LDAP group.
The default is memberOf.

Define roles with permissions

Define roles with permissions in Kong Gateway, using the Admin API’s RBAC endpoints or using Kong Manager’s Teams page. You must manually define which Kong roles correspond to each of the service directory’s groups using either of the following:

  • In Kong Manager’s directory mapping section. Find it under Teams > Groups tab.
  • With the Admin API’s directory mapping endpoints.

Kong Gateway will not write to the service directory. For example, a Kong Gateway admin cannot create users or groups in the directory. You must create users and groups independently before mapping them to Kong Gateway.

User-admin mapping

To map a service directory user to a Kong admin, map the admin’s username to the name value corresponding to the attribute configured in admin_gui_auth_conf. Create an admin account in Kong Manager or use the Admin API.

For instructions on how to pair the bootstrapped super admin with a directory user, see Set up a directory user as the first super admin.

If you already have admins with assigned roles and want to use group mapping instead, it is necessary to first remove all of their roles. The service directory will serve as the system of record for user privileges. Assigned roles will affect a user’s privileges in addition to any roles mapped from groups.

Group-role assignment

Using service directory mapping, groups are mapped to roles. When a user logs in, they are identified with their admin username and authenticated with the matching user credentials in the service directory. The groups in the service directory are then automatically matched to the associated roles that the organization has defined.

Example

  1. Example Corp maps the service directory group, T1-Mgmt, to the Kong role super-admin.
  2. Example Corp maps a service directory user, named example-user, to a Kong admin account with the same name, example-user.
  3. The user, example-user, is assigned to the group T1-Mgmt in the LDAP Directory.

When example-user logs in as an admin to Kong Manager, they will automatically have the role of super-admin as a result of the mapping.

If Example Corp decides to revoke example-user’s privileges by removing their assignment to T1-Mgmt, they will no longer have the super-admin role when they attempt to log in.

Set up a directory user as the first super admin

Setting up a directory user as the first super admin is recommended by Kong.

The example shows an attribute configured with a unique identifier (UID), and the directory user you want to make the super admin has a distinguished name (DN) entry of UID=example-user:

curl -i -X PATCH https://localhost:8001/admins/kong_admin \
  --header 'Kong-Admin-Token: <RBAC_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{"username":"example-user"}'

This user will be able to log in, but until you map a group belonging to example-user to a role, the user will only use the directory for authentication. Once you map the super-admin role to a group that example-user is in, then you can delete the super-admin role from the example-user admin. The group you pick needs to be “super” in your directory, otherwise as other admins log in with a generic group, for example the “employee” group, they will also become super-admins.

Important: If you delete the super-admin role from your only admin, and have not yet mapped the super-admin role to a group that admin belongs to, then you will not be able to log in to Kong Manager.

Alternatives:

  • Start Kong with RBAC turned off, map a group to the super-admin role, and then create an admin to correspond to a user belonging to that group. Doing so ensures that the super admin’s privileges are entirely tied to the directory group, whereas bootstrapping a super admin only uses the directory for authentication.

  • Create all admin accounts for matching directory users and ensure that their existing groups map to appropriate roles before enforcing RBAC.

Thank you for your feedback.
Was this page useful?
  • Kong
    THE CLOUD CONNECTIVITY COMPANY

    Kong powers reliable digital connections across APIs, hybrid and multi-cloud environments.

    • Company
    • Customers
    • Events
    • Investors
    • Careers Hiring!
    • Partners
    • Press
    • Contact
  • Products
    • Kong Konnect
    • Kong Gateway
    • Kong Mesh
    • Get Started
    • Pricing
  • Resources
    • eBooks
    • Webinars
    • Briefs
    • Blog
    • API Gateway
    • Microservices
  • Open Source
    • Install Kong Gateway
    • Kong Community
    • Kubernetes Ingress
    • Kuma
    • Insomnia
  • Solutions
    • Decentralize
    • Secure & Govern
    • Create a Dev Platform
    • API Gateway
    • Kubernetes
    • Service Mesh
Star
  • Terms•Privacy
© Kong Inc. 2023