Integrate LDAP with GitLab

{{< details >}}

• Tier: Free, Premium, Ultimate
• Offering: GitLab Self-Managed

{{< /details >}}

GitLab integrates with LDAP - Lightweight Directory Access Protocol to support user authentication.

This integration works with most LDAP-compliant directory servers, including:

• Microsoft Active Directory.
• Apple Open Directory.
• OpenLDAP.
• 389 Server.

[!note] GitLab does not support Microsoft Active Directory Trusts.

Users added through LDAP:

• Usually use a licensed seat.
• Can authenticate with Git using either their GitLab username or their email and LDAP password, even if password authentication for Git is disabled.

The LDAP distinguished name (DN) is associated with existing GitLab users when:

• The existing user signs in to GitLab with LDAP for the first time.
• The LDAP email address is the primary email address of an existing GitLab user. If the LDAP email attribute isn't found in the GitLab user database, a new user is created.

If an existing GitLab user wants to enable LDAP sign-in for themselves, they should:

1. Check that their GitLab email address matches their LDAP email address.
2. Sign in to GitLab by using their LDAP credentials.

[!note] After a user links an LDAP identity to their GitLab account, they can no longer use the standard username and password authentication flow. Instead, users must authenticate with their LDAP credentials. Attempts to sign in with their username and password authentication, return an invalid login or password error.

Security

GitLab verifies if a user is still active in LDAP.

Users are considered inactive in LDAP when they:

• Are removed from the directory completely.
• Reside outside the configured base DN or user_filter search.
• Are marked as disabled or deactivated in Active Directory through the user account control attribute. This means attribute userAccountControl:1.2.840.113556.1.4.803 has bit 2 set.

To check if a user is active or inactive in LDAP, use the following PowerShell command and the Active Directory Module to check the Active Directory:

Get-ADUser -Identity <username> -Properties userAccountControl | Select-Object Name, userAccountControl

GitLab checks LDAP users' status:

• When signing in using any authentication provider.
• Once per hour for active web sessions or Git requests using tokens or SSH keys.
• When performing Git over HTTP requests using LDAP username and password.
• Once per day during User Sync.

If the user is no longer active in LDAP, they are:

• Signed out.
• Placed in an ldap_blocked status.
• Unable to sign in using any authentication provider until they are reactivated in LDAP.

Security risks

You should only use LDAP integration if your LDAP users cannot:

• Change their mail, email or userPrincipalName attributes on the LDAP server. These users can potentially take over any account on your GitLab server.
• Share email addresses. LDAP users with the same email address can share the same GitLab account.

Configure LDAP

Prerequisites:

• You must have an email address to use LDAP, regardless of whether or not you use that email address to sign in.

To configure LDAP, you edit the settings in a configuration file:

• Your configuration file must contain the following basic configuration settings:
  • label
  • host
  • port
  • uid
  • base
  • encryption
• You can include the following optional settings in your configuration file:
  • Optional basic configuration settings.
  • SSL settings.
  • Attribute settings.
  • LDAP sync settings.
• You can also configure LDAP to:
  • Use multiple servers.
  • Filter users.
  • Automatically set LDAP usernames to lowercase.
  • Disable LDAP web sign in.
  • Provide smart card authentication for GitLab
  • Use encrypted credentials.

The file you edit differs depending on your GitLab setup:

{{< tabs >}}

{{< tab title="Linux package (Omnibus)" >}}

1. Edit /etc/gitlab/gitlab.rb:

   rubyCopy

   gitlab_rails['ldap_enabled'] = true
   gitlab_rails['ldap_servers'] = {
     'main' => {
       'label' => 'LDAP',
       'host' => 'ldap.mydomain.com',
       'port' => 636,
       'uid' => 'sAMAccountName',
       'bind_dn' => 'CN=Gitlab,OU=Users,DC=domain,DC=com',
       'password' => '<bind_user_password>',
       'encryption' => 'simple_tls',
       'verify_certificates' => true,
       'timeout' => 10,
       'active_directory' => false,
       'user_filter' => '(employeeType=developer)',
       'base' => 'dc=example,dc=com',
       'lowercase_usernames' => 'false',
       'retry_empty_result_with_codes' => [80],
       'allow_username_or_email_login' => false,
       'block_auto_created_users' => false
     }
   }
   

2. Save the file and reconfigure GitLab:

   shellCopy

   sudo gitlab-ctl reconfigure
   

{{< /tab >}}

{{< tab title="Helm chart (Kubernetes)" >}}

1. Export the Helm values:

   shellCopy

   helm get values gitlab > gitlab_values.yaml
   

2. Edit gitlab_values.yaml:

   yamlCopy

   global:
     appConfig:
       ldap:
         servers:
           main:
             label: 'LDAP'
             host: 'ldap.mydomain.com'
             port: 636
             uid: 'sAMAccountName'
             bind_dn: 'CN=Gitlab,OU=Users,DC=domain,DC=com'
             password: '<bind_user_password>'
             encryption: 'simple_tls'
             verify_certificates: true
             timeout: 10
             active_directory: false
             user_filter: '(employeeType=developer)'
             base: 'dc=example,dc=com'
             lowercase_usernames: false
             retry_empty_result_with_codes: [80]
             allow_username_or_email_login: false
             block_auto_created_users: false
   

3. Save the file and apply the new values:

   shellCopy

   helm upgrade -f gitlab_values.yaml gitlab gitlab/gitlab
   

For more information, see how to configure LDAP for a GitLab instance that was installed by using the Helm chart.

{{< /tab >}}

{{< tab title="Docker" >}}

1. Edit docker-compose.yml:

   yamlCopy

   version: "3.6"
   services:
     gitlab:
       image: 'gitlab/gitlab-ee:latest'
       restart: always
       hostname: 'gitlab.example.com'
       environment:
         GITLAB_OMNIBUS_CONFIG: |
           gitlab_rails['ldap_enabled'] = true
           gitlab_rails['ldap_servers'] = {
             'main' => {
               'label' => 'LDAP',
               'host' => 'ldap.mydomain.com',
               'port' => 636,
               'uid' => 'sAMAccountName',
               'bind_dn' => 'CN=Gitlab,OU=Users,DC=domain,DC=com',
               'password' => '<bind_user_password>',
               'encryption' => 'simple_tls',
               'verify_certificates' => true,
               'timeout' => 10,
               'active_directory' => false,
               'user_filter' => '(employeeType=developer)',
               'base' => 'dc=example,dc=com',
               'lowercase_usernames' => 'false',
               'retry_empty_result_with_codes' => [80],
               'allow_username_or_email_login' => false,
               'block_auto_created_users' => false
             }
           }
   

2. Save the file and restart GitLab:

   shellCopy

   docker compose up -d
   

{{< /tab >}}

{{< tab title="Self-compiled (source)" >}}

1. Edit /home/git/gitlab/config/gitlab.yml:

   yamlCopy

   production: &base
     ldap:
       enabled: true
       servers:
         main:
           label: 'LDAP'
           host: 'ldap.mydomain.com'
           port: 636
           uid: 'sAMAccountName'
           bind_dn: 'CN=Gitlab,OU=Users,DC=domain,DC=com'
           password: '<bind_user_password>'
           encryption: 'simple_tls'
           verify_certificates: true
           timeout: 10
           active_directory: false
           user_filter: '(employeeType=developer)'
           base: 'dc=example,dc=com'
           lowercase_usernames: false
           retry_empty_result_with_codes: [80]
           allow_username_or_email_login: false
           block_auto_created_users: false
   

2. Save the file and restart GitLab:

   shellCopy

   # For systems running systemd
   sudo systemctl restart gitlab.target
   
   # For systems running SysV init
   sudo service gitlab restart
   

For more information about the various LDAP options, see the ldap setting in gitlab.yml.example.

{{< /tab >}}

{{< /tabs >}}

After configuring LDAP, to test the configuration, use the LDAP check Rake task.

Basic configuration settings

The following basic settings are available:

• '(employeeType=developer)'
• '(&(objectclass=user)(\|(samaccountname=momo)(samaccountname=toto)))' | | lowercase_usernames | {{< icon name="dotted-circle" >}} No | Boolean | If enabled, GitLab converts the name to lowercase. | | retry_empty_result_with_codes | {{< icon name="dotted-circle" >}} No | Array | An array of LDAP query response code that attempt to retry the operation if the result/content is empty. For Google Secure LDAP, set this value to [80]. |

[!note] GitLab is unaffected by the stricter binding requirements for Microsoft Active Directory Services introduced with Microsoft advisory ADV190023. For more information, see issue 201894.

SSL configuration settings

You can configure SSL configuration settings under tls_options name/value pairs. The following settings are all optional:

The examples below illustrate how to set ca_file and ssl_version in tls_options:

{{< tabs >}}

{{< tab title="Linux package (Omnibus)" >}}

1. Edit /etc/gitlab/gitlab.rb:

   rubyCopy

   gitlab_rails['ldap_enabled'] = true
   gitlab_rails['ldap_servers'] = {
     'main' => {
       'label' => 'LDAP',
       'host' => 'ldap.mydomain.com',
       'port' => 636,
       'uid' => 'sAMAccountName',
       'encryption' => 'simple_tls',
       'base' => 'dc=example,dc=com',
       'tls_options' => {
         'ca_file' => '/path/to/ca_file.pem',
         'ssl_version' => 'TLSv1_2'
       }
     }
   }
   

2. Save the file and reconfigure GitLab:

   shellCopy

   sudo gitlab-ctl reconfigure
   

{{< /tab >}}

{{< tab title="Helm chart (Kubernetes)" >}}

1. Export the Helm values:

   shellCopy

   helm get values gitlab > gitlab_values.yaml
   

2. Edit gitlab_values.yaml:

   yamlCopy

   global:
     appConfig:
       ldap:
         servers:
           main:
             label: 'LDAP'
             host: 'ldap.mydomain.com'
             port: 636
             uid: 'sAMAccountName'
             base: 'dc=example,dc=com'
             encryption: 'simple_tls'
             tls_options:
               ca_file: '/path/to/ca_file.pem'
               ssl_version: 'TLSv1_2'
   

3. Save the file and apply the new values:

   shellCopy

   helm upgrade -f gitlab_values.yaml gitlab gitlab/gitlab
   

For more information, see how to configure LDAP for a GitLab instance that was installed by using the Helm chart.

{{< /tab >}}

{{< tab title="Docker" >}}

1. Edit docker-compose.yml:

   yamlCopy

   version: "3.6"
   services:
     gitlab:
       image: 'gitlab/gitlab-ee:latest'
       restart: always
       hostname: 'gitlab.example.com'
       environment:
         GITLAB_OMNIBUS_CONFIG: |
           gitlab_rails['ldap_enabled'] = true
           gitlab_rails['ldap_servers'] = {
             'main' => {
               'label' => 'LDAP',
               'host' => 'ldap.mydomain.com',
               'port' => 636,
               'uid' => 'sAMAccountName',
               'encryption' => 'simple_tls',
               'base' => 'dc=example,dc=com',
               'tls_options' => {
                 'ca_file' => '/path/to/ca_file.pem',
                 'ssl_version' => 'TLSv1_2'
               }
             }
           }
   

2. Save the file and restart GitLab:

   shellCopy

   docker compose up -d
   

{{< /tab >}}

{{< tab title="Self-compiled (source)" >}}

1. Edit /home/git/gitlab/config/gitlab.yml:

   yamlCopy

   production: &base
     ldap:
       enabled: true
       servers:
         main:
           label: 'LDAP'
           host: 'ldap.mydomain.com'
           port: 636
           uid: 'sAMAccountName'
           encryption: 'simple_tls'
           base: 'dc=example,dc=com'
           tls_options:
             ca_file: '/path/to/ca_file.pem'
             ssl_version: 'TLSv1_2'
   

2. Save the file and restart GitLab:

   shellCopy

   # For systems running systemd
   sudo systemctl restart gitlab.target
   
   # For systems running SysV init
   sudo service gitlab restart
   

{{< /tab >}}

{{< /tabs >}}

Attribute configuration settings

GitLab uses these LDAP attributes to create an account for the LDAP user. The specified attribute can be either:

• The attribute name as a string. For example, 'mail'.
• An array of attribute names to try in order. For example, ['mail', 'email'].

The user's LDAP sign in is the LDAP attribute specified as uid.

All of the following LDAP attributes are optional. If you define these attributes, All of the following LDAP attributes are optional. You only need to specify attributes that differ from the default. If you specify one, for example username, you do not need to specify the others, defaults will apply.

If you define any of them, you must do so in an attributes hash.

Example configuration that uses displayName for the user's name and an array of attributes for email:

{{< tabs >}}

{{< tab title="Linux package (Omnibus)" >}}

1. Edit /etc/gitlab/gitlab.rb:

   rubyCopy

   gitlab_rails['ldap_servers'] = {
     'main' => {
       # Other configuration settings ...
       'attributes' => {
         'username' => 'uid',
         'email' => ['mail', 'email', 'userPrincipalName'],
         'name' => 'displayName',
         'first_name' => 'givenName',
         'last_name' => 'sn'
       }
     }
   }
   

2. Save the file and reconfigure GitLab:

   shellCopy

   sudo gitlab-ctl reconfigure
   

{{< /tab >}}

{{< tab title="Helm chart (Kubernetes)" >}}

1. Export the Helm values:

   shellCopy

   helm get values gitlab > gitlab_values.yaml
   

2. Edit gitlab_values.yaml:

   yamlCopy

   global:
     appConfig:
       ldap:
         servers:
           main:
             # Other configuration settings ...
             attributes:
               username: 'uid'
               email:
                 - 'mail'
                 - 'email'
                 - 'userPrincipalName'
               name: 'displayName'
               first_name: 'givenName'
               last_name: 'sn'
   

3. Save the file and apply the new values:

   shellCopy

   helm upgrade -f gitlab_values.yaml gitlab gitlab/gitlab
   

{{< /tab >}}

{{< tab title="Docker" >}}

1. Edit docker-compose.yml:

   yamlCopy

   version: "3.6"
   services:
     gitlab:
       image: 'gitlab/gitlab-ee:latest'
       restart: always
       hostname: 'gitlab.example.com'
       environment:
         GITLAB_OMNIBUS_CONFIG: |
           gitlab_rails['ldap_servers'] = {
             'main' => {
               # Other configuration settings ...
               'attributes' => {
                 'username' => 'uid',
                 'email' => ['mail', 'email', 'userPrincipalName'],
                 'name' => 'displayName',
                 'first_name' => 'givenName',
                 'last_name' => 'sn'
               }
             }
           }
   

2. Save the file and restart GitLab:

   shellCopy

   docker compose up -d
   

{{< /tab >}}

{{< tab title="Self-compiled (source)" >}}

1. Edit /home/git/gitlab/config/gitlab.yml:

   yamlCopy

   production: &base
     ldap:
       servers:
         main:
           # Other configuration settings ...
           attributes:
             username: 'uid'
             email:
               - 'mail'
               - 'email'
               - 'userPrincipalName'
             name: 'displayName'
             first_name: 'givenName'
             last_name: 'sn'
   

2. Save the file and restart GitLab:

   shellCopy

   # For systems running systemd
   sudo systemctl restart gitlab.target
   
   # For systems running SysV init
   sudo service gitlab restart
   

{{< /tab >}}

{{< /tabs >}}

LDAP sync configuration settings

{{< details >}}

• Tier: Premium, Ultimate
• Offering: GitLab Self-Managed

{{< /details >}}

These LDAP sync configuration settings are optional, excluding group_base which required when external_groups is configured:

[!note] If Sidekiq is configured on a different server to the Rails server, you must add the LDAP configuration to every Sidekiq server as well for LDAP synchronisation to work.

Use multiple LDAP servers

{{< details >}}

• Tier: Premium, Ultimate
• Offering: GitLab Self-Managed

{{< /details >}}

If you have users on multiple LDAP servers, you can configure GitLab to use them. To add additional LDAP servers:

1. Duplicate the main LDAP configuration.
2. Edit each duplicate configuration with the details of the additional servers.
   • For each additional server, choose a different provider ID, like main, secondary, or tertiary. Use lowercase alphanumeric characters. GitLab uses the provider ID to associate each user with a specific LDAP server.
   • For each entry, use a unique label value. These values are used for the tab names on the sign-in page.

The following example shows how to configure three LDAP servers with minimal configuration:

{{< tabs >}}

{{< tab title="Linux package (Omnibus)" >}}

1. Edit /etc/gitlab/gitlab.rb:

   rubyCopy

   gitlab_rails['ldap_enabled'] = true
   gitlab_rails['ldap_servers'] = {
     'main' => {
       'label' => 'GitLab AD',
       'host' => 'ad.mydomain.com',
       'port' => 636,
       'uid' => 'sAMAccountName',
       'encryption' => 'simple_tls',
       'base' => 'dc=example,dc=com',
     },
   
     'secondary' => {
       'label' => 'GitLab Secondary AD',
       'host' => 'ad-secondary.mydomain.com',
       'port' => 636,
       'uid' => 'sAMAccountName',
       'encryption' => 'simple_tls',
       'base' => 'dc=example,dc=com',
     },
   
     'tertiary' => {
       'label' => 'GitLab Tertiary AD',
       'host' => 'ad-tertiary.mydomain.com',
       'port' => 636,
       'uid' => 'sAMAccountName',
       'encryption' => 'simple_tls',
       'base' => 'dc=example,dc=com',
     }
   }
   

2. Save the file and reconfigure GitLab:

   shellCopy

   sudo gitlab-ctl reconfigure
   

{{< /tab >}}

{{< tab title="Helm chart (Kubernetes)" >}}

1. Export the Helm values:

   shellCopy

   helm get values gitlab > gitlab_values.yaml
   

2. Edit gitlab_values.yaml:

   yamlCopy

   global:
     appConfig:
       ldap:
         servers:
           main:
             label: 'GitLab AD'
             host: 'ad.mydomain.com'
             port: 636
             uid: 'sAMAccountName'
             base: 'dc=example,dc=com'
             encryption: 'simple_tls'
           secondary:
             label: 'GitLab Secondary AD'
             host: 'ad-secondary.mydomain.com'
             port: 636
             uid: 'sAMAccountName'
             base: 'dc=example,dc=com'
             encryption: 'simple_tls'
           tertiary:
             label: 'GitLab Tertiary AD'
             host: 'ad-tertiary.mydomain.com'
             port: 636
             uid: 'sAMAccountName'
             base: 'dc=example,dc=com'
             encryption: 'simple_tls'
   

3. Save the file and apply the new values:

   shellCopy

   helm upgrade -f gitlab_values.yaml gitlab gitlab/gitlab
   

{{< /tab >}}

{{< tab title="Docker" >}}

1. Edit docker-compose.yml:

   yamlCopy

   version: "3.6"
   services:
     gitlab:
       image: 'gitlab/gitlab-ee:latest'
       restart: always
       hostname: 'gitlab.example.com'
       environment:
         GITLAB_OMNIBUS_CONFIG: |
           gitlab_rails['ldap_enabled'] = true
           gitlab_rails['ldap_servers'] = {
             'main' => {
               'label' => 'GitLab AD',
               'host' => 'ad.mydomain.com',
               'port' => 636,
               'uid' => 'sAMAccountName',
               'encryption' => 'simple_tls',
               'base' => 'dc=example,dc=com',
             },
   
             'secondary' => {
               'label' => 'GitLab Secondary AD',
               'host' => 'ad-secondary.mydomain.com',
               'port' => 636,
               'uid' => 'sAMAccountName',
               'encryption' => 'simple_tls',
               'base' => 'dc=example,dc=com',
             },
   
             'tertiary' => {
               'label' => 'GitLab Tertiary AD',
               'host' => 'ad-tertiary.mydomain.com',
               'port' => 636,
               'uid' => 'sAMAccountName',
               'encryption' => 'simple_tls',
               'base' => 'dc=example,dc=com',
             }
           }
   

2. Save the file and restart GitLab:

   shellCopy

   docker compose up -d
   

{{< /tab >}}

{{< tab title="Self-compiled (source)" >}}

1. Edit /home/git/gitlab/config/gitlab.yml:

   yamlCopy

   production: &base
     ldap:
       enabled: true
       servers:
         main:
           label: 'GitLab AD'
           host: 'ad.mydomain.com'
           port: 636
           uid: 'sAMAccountName'
           base: 'dc=example,dc=com'
           encryption: 'simple_tls'
         secondary:
           label: 'GitLab Secondary AD'
           host: 'ad-secondary.mydomain.com'
           port: 636
           uid: 'sAMAccountName'
           base: 'dc=example,dc=com'
           encryption: 'simple_tls'
         tertiary:
           label: 'GitLab Tertiary AD'
           host: 'ad-tertiary.mydomain.com'
           port: 636
           uid: 'sAMAccountName'
           base: 'dc=example,dc=com'
           encryption: 'simple_tls'
   

2. Save the file and restart GitLab:

   shellCopy

   # For systems running systemd
   sudo systemctl restart gitlab.target
   
   # For systems running SysV init
   sudo service gitlab restart
   

For more information about the various LDAP options, see the ldap setting in gitlab.yml.example.

{{< /tab >}}

{{< /tabs >}}

This example results in a sign-in page with the following tabs:

• GitLab AD.
• GitLab Secondary AD.
• GitLab Tertiary AD.

Set up LDAP user filter

To limit all GitLab access to a subset of the LDAP users on your LDAP server, first narrow the configured base. However, to further filter users if necessary, you can set up an LDAP user filter. The filter must comply with RFC 4515.

{{< tabs >}}

{{< tab title="Linux package (Omnibus)" >}}

1. Edit /etc/gitlab/gitlab.rb:

   rubyCopy

   gitlab_rails['ldap_servers'] = {
     'main' => {
       'user_filter' => '(employeeType=developer)'
     }
   }
   

2. Save the file and reconfigure GitLab:

   shellCopy

   sudo gitlab-ctl reconfigure
   

{{< /tab >}}

{{< tab title="Helm chart (Kubernetes)" >}}

1. Export the Helm values:

   shellCopy

   helm get values gitlab > gitlab_values.yaml
   

2. Edit gitlab_values.yaml:

   yamlCopy

   global:
     appConfig:
       ldap:
         servers:
           main:
             user_filter: '(employeeType=developer)'
   

3. Save the file and apply the new values:

   shellCopy

   helm upgrade -f gitlab_values.yaml gitlab gitlab/gitlab
   

{{< /tab >}}

{{< tab title="Docker" >}}

1. Edit docker-compose.yml:

   yamlCopy

   version: "3.6"
   services:
     gitlab:
       image: 'gitlab/gitlab-ee:latest'
       restart: always
       hostname: 'gitlab.example.com'
       environment:
         GITLAB_OMNIBUS_CONFIG: |
           gitlab_rails['ldap_servers'] = {
             'main' => {
               'user_filter' => '(employeeType=developer)'
             }
           }
   

2. Save the file and restart GitLab:

   shellCopy

   docker compose up -d
   

{{< /tab >}}

{{< tab title="Self-compiled (source)" >}}

1. Edit /home/git/gitlab/config/gitlab.yml:

   yamlCopy

   production: &base
     ldap:
       servers:
         main:
           user_filter: '(employeeType=developer)'
   

2. Save the file and restart GitLab:

   shellCopy

   # For systems running systemd
   sudo systemctl restart gitlab.target
   
   # For systems running SysV init
   sudo service gitlab restart
   

{{< /tab >}}

{{< /tabs >}}

To limit access to the nested members of an Active Directory group, use the following syntax:

(memberOf:1.2.840.113556.1.4.1941:=CN=My Group,DC=Example,DC=com)

For more information about LDAP_MATCHING_RULE_IN_CHAIN filters, see Search Filter Syntax.

Support for nested members in the user filter shouldn't be confused with group sync nested groups support.

GitLab does not support the custom filter syntax used by OmniAuth LDAP.

Escape special characters in user_filter

The user_filter DN can contain special characters. For example:

• A comma:

  plaintextCopy

  OU=GitLab, Inc,DC=gitlab,DC=com
  

• Open and close brackets:

  plaintextCopy

  OU=GitLab (Inc),DC=gitlab,DC=com
  

These characters must be escaped as documented in RFC 4515.

• Escape commas with \2C. For example:

  plaintextCopy

  OU=GitLab\2C Inc,DC=gitlab,DC=com
  

• Escape open brackets with \28 and close brackets with \29. For example:

  plaintextCopy

  OU=GitLab \28Inc\29,DC=gitlab,DC=com
  

Enable LDAP username lowercase

Some LDAP servers, depending on their configuration, can return uppercase usernames. This can lead to several confusing issues such as creating links or namespaces with uppercase names.

GitLab can automatically lowercase usernames provided by the LDAP server by enabling the configuration option lowercase_usernames. By default, this configuration option is false.

{{< tabs >}}

{{< tab title="Linux package (Omnibus)" >}}

1. Edit /etc/gitlab/gitlab.rb:

   rubyCopy

   gitlab_rails['ldap_servers'] = {
     'main' => {
       'lowercase_usernames' => true
     }
   }
   

2. Save the file and reconfigure GitLab:

   shellCopy

   sudo gitlab-ctl reconfigure
   

{{< /tab >}}

{{< tab title="Helm chart (Kubernetes)" >}}

1. Export the Helm values:

   shellCopy

   helm get values gitlab > gitlab_values.yaml
   

2. Edit gitlab_values.yaml:

   yamlCopy

   global:
     appConfig:
       ldap:
         servers:
           main:
             lowercase_usernames: true
   

3. Save the file and apply the new values:

   shellCopy

   helm upgrade -f gitlab_values.yaml gitlab gitlab/gitlab
   

{{< /tab >}}

{{< tab title="Docker" >}}

1. Edit docker-compose.yml:

   yamlCopy

   version: "3.6"
   services:
     gitlab:
       image: 'gitlab/gitlab-ee:latest'
       restart: always
       hostname: 'gitlab.example.com'
       environment:
         GITLAB_OMNIBUS_CONFIG: |
           gitlab_rails['ldap_servers'] = {
             'main' => {
               'lowercase_usernames' => true
             }
           }
   

2. Save the file and restart GitLab:

   shellCopy

   docker compose up -d
   

{{< /tab >}}

{{< tab title="Self-compiled (source)" >}}

1. Edit config/gitlab.yaml:

   yamlCopy

   production:
     ldap:
       servers:
         main:
           lowercase_usernames: true
   

2. Save the file and restart GitLab:

   shellCopy

   # For systems running systemd
   sudo systemctl restart gitlab.target
   
   # For systems running SysV init
   sudo service gitlab restart
   

{{< /tab >}}

{{< /tabs >}}

Disable LDAP web sign in

It can be useful to prevent using LDAP credentials through the web UI when an alternative such as SAML is preferred. This allows LDAP to be used for group sync, while also allowing your SAML identity provider to handle additional checks like custom 2FA.

When LDAP web sign in is disabled, users don't see an LDAP tab on the sign-in page. This does not disable using LDAP credentials for Git access.

{{< tabs >}}

{{< tab title="Linux package (Omnibus)" >}}

1. Edit /etc/gitlab/gitlab.rb:

   rubyCopy

   gitlab_rails['prevent_ldap_sign_in'] = true
   

2. Save the file and reconfigure GitLab:

   shellCopy

   sudo gitlab-ctl reconfigure
   

{{< /tab >}}

{{< tab title="Helm chart (Kubernetes)" >}}

1. Export the Helm values:

   shellCopy

   helm get values gitlab > gitlab_values.yaml
   

2. Edit gitlab_values.yaml:

   yamlCopy

   global:
     appConfig:
       ldap:
         preventSignin: true
   

3. Save the file and apply the new values:

   shellCopy

   helm upgrade -f gitlab_values.yaml gitlab gitlab/gitlab
   

{{< /tab >}}

{{< tab title="Docker" >}}

1. Edit docker-compose.yml:

   yamlCopy

   version: "3.6"
   services:
     gitlab:
       image: 'gitlab/gitlab-ee:latest'
       restart: always
       hostname: 'gitlab.example.com'
       environment:
         GITLAB_OMNIBUS_CONFIG: |
           gitlab_rails['prevent_ldap_sign_in'] = true
   

2. Save the file and restart GitLab:

   shellCopy

   docker compose up -d
   

{{< /tab >}}

{{< tab title="Self-compiled (source)" >}}

1. Edit config/gitlab.yaml:

   yamlCopy

   production:
     ldap:
       prevent_ldap_sign_in: true
   

2. Save the file and restart GitLab:

   shellCopy

   # For systems running systemd
   sudo systemctl restart gitlab.target
   
   # For systems running SysV init
   sudo service gitlab restart
   

{{< /tab >}}

{{< /tabs >}}

Provide smart card authentication for GitLab

For more information on using smart cards with LDAP servers and GitLab, see Smart card authentication.

Use encrypted credentials

Instead of having the LDAP integration credentials stored in plaintext in the configuration files, you can optionally use an encrypted file for the LDAP credentials.

Prerequisites:

• To use encrypted credentials, you must first enable the encrypted configuration.

The encrypted configuration for LDAP exists in an encrypted YAML file. The unencrypted contents of the file should be a subset of the secret settings from your servers block in the LDAP configuration.

The supported configuration items for the encrypted file are:

• bind_dn
• password

{{< tabs >}}

{{< tab title="Linux package (Omnibus)" >}}

1. If initially your LDAP configuration in /etc/gitlab/gitlab.rb looked like:

   rubyCopy

     gitlab_rails['ldap_servers'] = {
       'main' => {
         'bind_dn' => 'admin',
         'password' => '123'
       }
     }
   

2. Edit the encrypted secret:

   shellCopy

   sudo gitlab-rake gitlab:ldap:secret:edit EDITOR=vim
   

3. Enter the unencrypted contents of the LDAP secret:

   yamlCopy

   main:
     bind_dn: admin
     password: '123'
   

4. Edit /etc/gitlab/gitlab.rb and remove the settings for bind_dn and password.

5. Save the file and reconfigure GitLab:

   shellCopy

   sudo gitlab-ctl reconfigure
   

{{< /tab >}}

{{< tab title="Helm chart (Kubernetes)" >}}

Use a Kubernetes secret to store the LDAP password. For more information, read about Helm LDAP secrets.

{{< /tab >}}

{{< tab title="Docker" >}}

1. If initially your LDAP configuration in docker-compose.yml looked like:

   yamlCopy

   version: "3.6"
   services:
     gitlab:
       image: 'gitlab/gitlab-ee:latest'
       restart: always
       hostname: 'gitlab.example.com'
       environment:
         GITLAB_OMNIBUS_CONFIG: |
           gitlab_rails['ldap_servers'] = {
             'main' => {
               'bind_dn' => 'admin',
               'password' => '123'
             }
           }
   

2. Get inside the container, and edit the encrypted secret:

   shellCopy

   sudo docker exec -t <container_name> bash
   gitlab-rake gitlab:ldap:secret:edit EDITOR=vim
   

3. Enter the unencrypted contents of the LDAP secret:

   yamlCopy

   main:
     bind_dn: admin
     password: '123'
   

4. Edit docker-compose.yml and remove the settings for bind_dn and password.

5. Save the file and restart GitLab:

   shellCopy

   docker compose up -d
   

{{< /tab >}}

{{< tab title="Self-compiled (source)" >}}

1. If initially your LDAP configuration in /home/git/gitlab/config/gitlab.yml looked like:

   yamlCopy

   production:
     ldap:
       servers:
         main:
           bind_dn: admin
           password: '123'
   

2. Edit the encrypted secret:

   shellCopy

   bundle exec rake gitlab:ldap:secret:edit EDITOR=vim RAILS_ENVIRONMENT=production
   

3. Enter the unencrypted contents of the LDAP secret:

   yamlCopy

   main:
    bind_dn: admin
    password: '123'
   

4. Edit /home/git/gitlab/config/gitlab.yml and remove the settings for bind_dn and password.

5. Save the file and restart GitLab:

   shellCopy

   # For systems running systemd
   sudo systemctl restart gitlab.target
   
   # For systems running SysV init
   sudo service gitlab restart
   

{{< /tab >}}

{{< /tabs >}}

Updating LDAP DN and email

When an LDAP server creates a user in GitLab, the user's LDAP DN is linked to their GitLab account as an identifier.

When a user tries to sign in with LDAP, GitLab tries to find the user using the DN saved on that user's account.

• If GitLab finds the user by the DN and the user's email address:
  • Matches the GitLab account's email address, GitLab does not take any further action.
  • Has changed, GitLab updates its record of the user's email to match the one in LDAP.
• If GitLab cannot find a user by their DN, it tries to find the user by their email. If GitLab:
  • Finds the user by their email, GitLab updates the DN stored in the user's GitLab account. Both values now match the information stored in LDAP.
  • Cannot find the user by their email address (both the DN and the email address have changed), see User DN and email have changed.

Disable anonymous LDAP authentication

GitLab doesn't support TLS client authentication. Complete these steps on your LDAP server.

1. Disable anonymous authentication.
2. Enable one of the following authentication types:
   • Simple authentication.
   • Simple Authentication and Security Layer (SASL) authentication.

The TLS client authentication setting in your LDAP server cannot be mandatory and clients cannot be authenticated with the TLS protocol.

Users deleted from LDAP

Users deleted from the LDAP server:

• Are immediately blocked from signing in to GitLab.
• No longer consume a license.

However, these users can continue to use Git with SSH until the next time the LDAP check cache runs.

To delete the account immediately, you can manually block the user.

Update user email addresses

Email addresses on the LDAP server are considered the source of truth for users when LDAP is used to sign in.

Updating user email addresses must be done on the LDAP server that manages the user. The email address for GitLab is updated either:

• When the user next signs in.
• When the next user sync is run.

The updated user's previous email address becomes the secondary email address to preserve that user's commit history.

You can find more details on the expected behavior of user updates in our LDAP troubleshooting section.

Google Secure LDAP

Google Cloud Identity provides a Secure LDAP service that can be configured with GitLab for authentication and group sync. See Google Secure LDAP for detailed configuration instructions.

Synchronize users and groups

For more information on synchronizing users and groups between LDAP and GitLab, see LDAP synchronization.

Move from LDAP to SAML

1. Add SAML configuration to:

   • gitlab.rb for Linux package installations.
   • values.yml for Helm chart installations.

2. Optional. Disable the LDAP auth from the sign-in page.

3. Optional. To fix issues with linking users, you can first remove those users' LDAP identities.

4. Confirm that users are able to sign in to their accounts. If a user cannot sign in, check if that user's LDAP is still there and remove it if necessary. If this issue persists, check the logs to identify the problem.

5. In the configuration file, change:

   • omniauth_auto_link_user to saml only.
   • omniauth_auto_link_ldap_user to false.
   • ldap_enabled to false. You can also comment out the LDAP provider settings.

Troubleshooting

See our administrator guide to troubleshooting LDAP.