ldap.md 20 KB
Newer Older
1 2 3 4
---
type: reference
---

5
<!-- If the change is EE-specific, put it in `ldap-ee.md`, NOT here. -->
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
6

Drew Blessing's avatar
Drew Blessing committed
7 8 9
# LDAP

GitLab integrates with LDAP to support user authentication.
10 11 12 13 14 15 16 17 18

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

- Microsoft Active Directory
- Apple Open Directory
- Open LDAP
- 389 Server.

GitLab Enterprise Editions (EE) include enhanced integration,
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
19 20
including group membership syncing as well as multiple LDAP servers support.

21 22
For more details about EE-specific LDAP features, see the
[LDAP Enterprise Edition documentation](ldap-ee.md).
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
23

24 25 26 27 28 29 30 31 32
NOTE: **Note:**
The information on this page is relevant for both GitLab CE and EE.

## Overview

[LDAP](https://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol)
stands for **Lightweight Directory Access Protocol**, which is a standard
application protocol for accessing and maintaining distributed directory
information services over an Internet Protocol (IP) network.
Drew Blessing's avatar
Drew Blessing committed
33 34 35

## Security

36 37 38 39 40 41 42 43
GitLab assumes that LDAP users:

- Are not able to change their LDAP `mail`, `email`, or `userPrincipalName` attribute.
  An LDAP user who is allowed to change their email on the LDAP server can potentially
  [take over any account](#enabling-ldap-sign-in-for-existing-gitlab-users)
  on your GitLab server.
- Have unique email addresses, otherwise it is possible for LDAP users with the same
  email address to share the same GitLab account.
Drew Blessing's avatar
Drew Blessing committed
44 45

We recommend against using LDAP integration if your LDAP users are
46 47
allowed to change their 'mail', 'email' or 'userPrincipalName' attribute on
the LDAP server or share email addresses.
Drew Blessing's avatar
Drew Blessing committed
48 49 50

### User deletion

51
If a user is deleted from the LDAP server, they will be blocked in GitLab as
Drew Blessing's avatar
Drew Blessing committed
52
well. Users will be immediately blocked from logging in. However, there is an
53
LDAP check cache time of one hour (see note) which means users that
Drew Blessing's avatar
Drew Blessing committed
54
are already logged in or are using Git over SSH will still be able to access
55
GitLab for up to one hour. Manually block the user in the GitLab Admin Area to
Drew Blessing's avatar
Drew Blessing committed
56 57
immediately block all access.

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
58 59
NOTE: **Note**:
GitLab Enterprise Edition Starter supports a
60
[configurable sync time](ldap-ee.md#adjusting-ldap-user-sync-schedule),
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
61
with a default of one hour.
Drew Blessing's avatar
Drew Blessing committed
62

63 64 65 66 67 68
## Git password authentication

LDAP-enabled users can always authenticate with Git using their GitLab username
or email and LDAP password, even if password authentication for Git is disabled
in the application settings.

69
## Google Secure LDAP **(CORE ONLY)**
70 71 72 73 74 75 76

> Introduced in GitLab 11.9.

[Google Cloud Identity](https://cloud.google.com/identity/) provides a Secure
LDAP service that can be configured with GitLab for authentication and group sync.
See [Google Secure LDAP](google_secure_ldap.md) for detailed configuration instructions.

Drew Blessing's avatar
Drew Blessing committed
77 78
## Configuration

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
79 80 81 82
NOTE: **Note**:
In GitLab Enterprise Edition Starter, you can configure multiple LDAP servers
to connect to one GitLab server.

83 84 85 86 87 88
For a complete guide on configuring LDAP with:

- GitLab Community Edition, see
  [How to configure LDAP with GitLab CE](how_to_configure_ldap_gitlab_ce/index.md).
- Enterprise Editions, see
  [How to configure LDAP with GitLab EE](how_to_configure_ldap_gitlab_ee/index.md). **(STARTER ONLY)**
89

Drew Blessing's avatar
Drew Blessing committed
90
To enable LDAP integration you need to add your LDAP server settings in
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
91 92
`/etc/gitlab/gitlab.rb` or `/home/git/gitlab/config/gitlab.yml` for Omnibus
GitLab and installations from source respectively.
Drew Blessing's avatar
Drew Blessing committed
93

94 95 96 97
There is a Rake task to check LDAP configuration. After configuring LDAP
using the documentation below, see [LDAP check Rake task](../raketasks/check.md#ldap-check)
for information on the LDAP check Rake task.

Drew Blessing's avatar
Drew Blessing committed
98 99 100 101 102 103 104 105 106 107
Prior to version 7.4, GitLab used a different syntax for configuring
LDAP integration. The old LDAP integration syntax still works but may be
removed in a future version. If your `gitlab.rb` or `gitlab.yml` file contains
LDAP settings in both the old syntax and the new syntax, only the __old__
syntax will be used by GitLab.

The configuration inside `gitlab_rails['ldap_servers']` below is sensitive to
incorrect indentation. Be sure to retain the indentation given in the example.
Copy/paste can sometimes cause problems.

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
108 109 110 111 112 113
NOTE: **Note:**
The `encryption` value `ssl` corresponds to 'Simple TLS' in the LDAP
library. `tls` corresponds to StartTLS, not to be confused with regular TLS.
Normally, if you specify `ssl` it will be on port 636, while `tls` (StartTLS)
would be on port 389. `plain` also operates on port 389.

114 115 116
NOTE: **Note:**
LDAP users must have an email address set, regardless of whether it is used to log in.

Drew Blessing's avatar
Drew Blessing committed
117 118 119 120
**Omnibus configuration**

```ruby
gitlab_rails['ldap_enabled'] = true
121
gitlab_rails['prevent_ldap_sign_in'] = false
Drew Blessing's avatar
Drew Blessing committed
122
gitlab_rails['ldap_servers'] = YAML.load <<-EOS # remember to close this block with 'EOS' below
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
123 124 125 126 127 128 129 130 131 132
##
## 'main' is the GitLab 'provider ID' of this LDAP server
##
main:
  ##
  ## A human-friendly name for your LDAP server. It is OK to change the label later,
  ## for instance if you find out it is too large to fit on the web page.
  ##
  ## Example: 'Paris' or 'Acme, Ltd.'
  ##
Drew Blessing's avatar
Drew Blessing committed
133
  label: 'LDAP'
134

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
135 136 137
  ##
  ## Example: 'ldap.mydomain.com'
  ##
Drew Blessing's avatar
Drew Blessing committed
138
  host: '_your_ldap_server'
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
139 140 141 142 143

  ##
  ## This port is an example, it is sometimes different but it is always an
  ## integer and not a string.
  ##
144
  port: 389 # usually 636 for SSL
145 146
  uid: 'sAMAccountName' # This should be the attribute, not the value that maps to uid.

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
147
  ##
Ed Goforth's avatar
Ed Goforth committed
148
  ## Examples: 'america\momo' or 'CN=Gitlab Git,CN=Users,DC=mydomain,DC=com'
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
149
  ##
Drew Blessing's avatar
Drew Blessing committed
150 151 152
  bind_dn: '_the_full_dn_of_the_user_you_will_bind_with'
  password: '_the_password_of_the_bind_user'

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
153 154 155 156 157 158 159 160 161 162
  ##
  ## Encryption method. The "method" key is deprecated in favor of
  ## "encryption".
  ##
  ##   Examples: "start_tls" or "simple_tls" or "plain"
  ##
  ##   Deprecated values: "tls" was replaced with "start_tls" and "ssl" was
  ##   replaced with "simple_tls".
  ##
  ##
163 164
  encryption: 'plain'

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
165 166 167 168
  ##
  ## Enables SSL certificate verification if encryption method is
  ## "start_tls" or "simple_tls". Defaults to true since GitLab 10.0 for
  ## security. This may break installations upon upgrade to 10.0, that did
169
  ## not know their LDAP SSL certificates were not set up properly.
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
170
  ##
171
  verify_certificates: true
172

173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
  # OpenSSL::SSL::SSLContext options.
  tls_options:
    # Specifies the path to a file containing a PEM-format CA certificate,
    # e.g. if you need to use an internal CA.
    #
    #   Example: '/etc/ca.pem'
    #
    ca_file: ''

    # Specifies the SSL version for OpenSSL to use, if the OpenSSL default
    # is not appropriate.
    #
    #   Example: 'TLSv1_1'
    #
    ssl_version: ''

    # Specific SSL ciphers to use in communication with LDAP servers.
    #
    # Example: 'ALL:!EXPORT:!LOW:!aNULL:!eNULL:!SSLv2'
    ciphers: ''

    # Client certificate
    #
    # Example:
    #   cert: |
    #     -----BEGIN CERTIFICATE-----
    #     MIIDbDCCAlSgAwIBAgIGAWkJxLmKMA0GCSqGSIb3DQEBCwUAMHcxFDASBgNVBAoTC0dvb2dsZSBJ
    #     bmMuMRYwFAYDVQQHEw1Nb3VudGFpbiBWaWV3MRQwEgYDVQQDEwtMREFQIENsaWVudDEPMA0GA1UE
    #     CxMGR1N1aXRlMQswCQYDVQQGEwJVUzETMBEGA1UECBMKQ2FsaWZvcm5pYTAeFw0xOTAyMjAwNzE4
    #     rntnF4d+0dd7zP3jrWkbdtoqjLDT/5D7NYRmVCD5vizV98FJ5//PIHbD1gL3a9b2MPAc6k7NV8tl
    #     ...
    #     4SbuJPAiJxC1LQ0t39dR6oMCAMab3hXQqhL56LrR6cRBp6Mtlphv7alu9xb/x51y2x+g2zWtsf80
    #     Jrv/vKMsIh/sAyuogb7hqMtp55ecnKxceg==
    #     -----END CERTIFICATE -----
    cert: ''

    # Client private key
    #   key: |
    #     -----BEGIN PRIVATE KEY-----
    #     MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQC3DmJtLRmJGY4xU1QtI3yjvxO6
    #     bNuyE4z1NF6Xn7VSbcAaQtavWQ6GZi5uukMo+W5DHVtEkgDwh92ySZMuJdJogFbNvJvHAayheCdN
    #     7mCQ2UUT9jGXIbmksUn9QMeJVXTZjgJWJzPXToeUdinx9G7+lpVa62UATEd1gaI3oyL72WmpDy/C
    #     rntnF4d+0dd7zP3jrWkbdtoqjLDT/5D7NYRmVCD5vizV98FJ5//PIHbD1gL3a9b2MPAc6k7NV8tl
    #     ...
    #     +9IhSYX+XIg7BZOVDeYqlPfxRvQh8vy3qjt/KUihmEPioAjLaGiihs1Fk5ctLk9A2hIUyP+sEQv9
    #     l6RG+a/mW+0rCWn8JAd464Ps9hE=
    #     -----END PRIVATE KEY-----
    key: ''
221

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
222 223 224 225 226
  ##
  ## Set a timeout, in seconds, for LDAP queries. This helps avoid blocking
  ## a request if the LDAP server becomes unresponsive.
  ## A value of 0 means there is no timeout.
  ##
Drew Blessing's avatar
Drew Blessing committed
227 228
  timeout: 10

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
229 230 231 232 233
  ##
  ## This setting specifies if LDAP server is Active Directory LDAP server.
  ## For non AD servers it skips the AD specific queries.
  ## If your LDAP server is not AD, set this to false.
  ##
Drew Blessing's avatar
Drew Blessing committed
234 235
  active_directory: true

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
236 237 238 239 240 241 242 243 244 245 246
  ##
  ## If allow_username_or_email_login is enabled, GitLab will ignore everything
  ## after the first '@' in the LDAP username submitted by the user on login.
  ##
  ## Example:
  ## - the user enters 'jane.doe@example.com' and 'p@ssw0rd' as LDAP credentials;
  ## - GitLab queries the LDAP server with 'jane.doe' and 'p@ssw0rd'.
  ##
  ## If you are using "uid: 'userPrincipalName'" on ActiveDirectory you need to
  ## disable this setting, because the userPrincipalName contains an '@'.
  ##
Drew Blessing's avatar
Drew Blessing committed
247 248
  allow_username_or_email_login: false

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
249 250 251 252 253
  ##
  ## To maintain tight control over the number of active users on your GitLab installation,
  ## enable this setting to keep new users blocked until they have been cleared by the admin
  ## (default: false).
  ##
Drew Blessing's avatar
Drew Blessing committed
254 255
  block_auto_created_users: false

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
256 257 258 259 260 261
  ##
  ## Base where we can search for users
  ##
  ##   Ex. 'ou=People,dc=gitlab,dc=example' or 'DC=mydomain,DC=com'
  ##
  ##
Drew Blessing's avatar
Drew Blessing committed
262 263
  base: ''

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
264 265 266 267 268 269 270 271 272 273 274
  ##
  ## Filter LDAP users
  ##
  ##   Format: RFC 4515 https://tools.ietf.org/search/rfc4515
  ##   Ex. (employeeType=developer)
  ##
  ##   Note: GitLab does not support omniauth-ldap's custom filter syntax.
  ##
  ##   Example for getting only specific users:
  ##   '(&(objectclass=user)(|(samaccountname=momo)(samaccountname=toto)))'
  ##
Drew Blessing's avatar
Drew Blessing committed
275 276
  user_filter: ''

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
277 278 279 280 281 282
  ##
  ## LDAP attributes that GitLab will use to create an account for the LDAP user.
  ## The specified attribute can either be the attribute name as a string (e.g. 'mail'),
  ## or an array of attribute names to try in order (e.g. ['mail', 'email']).
  ## Note that the user's LDAP login will always be the attribute specified as `uid` above.
  ##
Drew Blessing's avatar
Drew Blessing committed
283
  attributes:
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
284 285 286 287 288 289 290
    ##
    ## The username will be used in paths for the user's own projects
    ## (like `gitlab.example.com/username/project`) and when mentioning
    ## them in issues, merge request and comments (like `@username`).
    ## If the attribute specified for `username` contains an email address,
    ## the GitLab username will be the part of the email address before the '@'.
    ##
Drew Blessing's avatar
Drew Blessing committed
291 292 293
    username: ['uid', 'userid', 'sAMAccountName']
    email:    ['mail', 'email', 'userPrincipalName']

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
294 295 296 297 298
    ##
    ## If no full name could be found at the attribute specified for `name`,
    ## the full name is determined using the attributes specified for
    ## `first_name` and `last_name`.
    ##
Drew Blessing's avatar
Drew Blessing committed
299 300 301 302
    name:       'cn'
    first_name: 'givenName'
    last_name:  'sn'

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
303 304 305
  ##
  ## If lowercase_usernames is enabled, GitLab will lower case the username.
  ##
306 307
  lowercase_usernames: false

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
308
  ##
309
  ## EE only
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
310
  ##
311

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
312 313 314 315
  ## Base where we can search for groups
  ##
  ##   Ex. ou=groups,dc=gitlab,dc=example
  ##
316 317
  group_base: ''

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
318 319 320 321 322 323
  ## The CN of a group containing GitLab administrators
  ##
  ##   Ex. administrators
  ##
  ##   Note: Not `cn=administrators` or the full DN
  ##
324 325
  admin_group: ''

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
326 327 328 329 330 331 332 333 334 335 336 337 338
  ## An array of CNs of groups containing users that should be considered external
  ##
  ##   Ex. ['interns', 'contractors']
  ##
  ##   Note: Not `cn=interns` or the full DN
  ##
  external_groups: []

  ##
  ## The LDAP attribute containing a user's public SSH key
  ##
  ##   Example: sshPublicKey
  ##
339
  sync_ssh_keys: false
Drew Blessing's avatar
Drew Blessing committed
340

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
341 342 343 344 345 346 347
## GitLab EE only: add more LDAP servers
## Choose an ID made of a-z and 0-9 . This ID will be stored in the database
## so that GitLab can remember which LDAP server a user belongs to.
#uswest2:
#  label:
#  host:
#  ....
Drew Blessing's avatar
Drew Blessing committed
348 349 350 351 352 353 354 355
EOS
```

**Source configuration**

Use the same format as `gitlab_rails['ldap_servers']` for the contents under
`servers:` in the example below:

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
356
```yaml
Drew Blessing's avatar
Drew Blessing committed
357 358 359 360
production:
  # snip...
  ldap:
    enabled: false
361
    prevent_ldap_sign_in: false
Drew Blessing's avatar
Drew Blessing committed
362
    servers:
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
363 364 365 366 367 368 369 370 371
      ##
      ## 'main' is the GitLab 'provider ID' of this LDAP server
      ##
      main:
        ##
        ## A human-friendly name for your LDAP server. It is OK to change the label later,
        ## for instance if you find out it is too large to fit on the web page.
        ##
        ## Example: 'Paris' or 'Acme, Ltd.'
Drew Blessing's avatar
Drew Blessing committed
372
        label: 'LDAP'
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
373
        ## snip...
Drew Blessing's avatar
Drew Blessing committed
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405
```

## Using an LDAP filter to limit access to your GitLab server

If you want to limit all GitLab access to a subset of the LDAP users on your
LDAP server, the first step should be to narrow the configured `base`. However,
it is sometimes necessary to filter users further. In this case, you can set up
an LDAP user filter. The filter must comply with
[RFC 4515](https://tools.ietf.org/search/rfc4515).

**Omnibus configuration**

```ruby
gitlab_rails['ldap_servers'] = YAML.load <<-EOS
main:
  # snip...
  user_filter: '(employeeType=developer)'
EOS
```

**Source configuration**

```yaml
production:
  ldap:
    servers:
      main:
        # snip...
        user_filter: '(employeeType=developer)'
```

Tip: If you want to limit access to the nested members of an Active Directory
James Lopez's avatar
James Lopez committed
406
group, you can use the following syntax:
Drew Blessing's avatar
Drew Blessing committed
407

408
```text
409
(memberOf:1.2.840.113556.1.4.1941:=CN=My Group,DC=Example,DC=com)
Drew Blessing's avatar
Drew Blessing committed
410 411
```

412
Find more information about this "LDAP_MATCHING_RULE_IN_CHAIN" filter at
413
<https://docs.microsoft.com/en-us/windows/win32/adsi/search-filter-syntax>. Support for
414
nested members in the user filter should not be confused with
415
[group sync nested groups support](ldap-ee.md#supported-ldap-group-typesattributes). **(STARTER ONLY)**
416

Drew Blessing's avatar
Drew Blessing committed
417
Please note that GitLab does not support the custom filter syntax used by
418
OmniAuth LDAP.
Drew Blessing's avatar
Drew Blessing committed
419

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
420 421
### Escaping special characters

422
The `user_filter` DN can contain special characters. For example:
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
423

424
- A comma:
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
425

426
  ```text
427 428
  OU=GitLab, Inc,DC=gitlab,DC=com
  ```
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
429

430
- Open and close brackets:
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
431

432
  ```text
433 434
  OU=Gitlab (Inc),DC=gitlab,DC=com
  ```
435

436 437
  These characters must be escaped as documented in
  [RFC 4515](https://tools.ietf.org/search/rfc4515).
438 439 440

- Escape commas with `\2C`. For example:

441
  ```text
442 443
  OU=GitLab\2C Inc,DC=gitlab,DC=com
  ```
444 445 446

- Escape open and close brackets with `\28` and `\29`, respectively. For example:

447
  ```text
448 449
  OU=Gitlab \28Inc\29,DC=gitlab,DC=com
  ```
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
450

Drew Blessing's avatar
Drew Blessing committed
451 452 453 454 455 456 457 458 459 460 461
## Enabling LDAP sign-in for existing GitLab users

When a user signs in to GitLab with LDAP for the first time, and their LDAP
email address is the primary email address of an existing GitLab user, then
the LDAP DN will be associated with the existing user. If the LDAP email
attribute is not found in GitLab's database, a new user is created.

In other words, if an existing GitLab user wants to enable LDAP sign-in for
themselves, they should check that their GitLab email address matches their
LDAP email address, and then sign into GitLab via their LDAP credentials.

462 463 464 465 466 467 468 469 470 471 472
## Enabling LDAP username lowercase

Some LDAP servers, depending on their configurations, can return uppercase usernames. This can lead to several confusing issues like, for example, 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`.

**Omnibus configuration**

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

473 474 475 476 477 478 479
   ```ruby
   gitlab_rails['ldap_servers'] = YAML.load <<-EOS
   main:
     # snip...
     lowercase_usernames: true
   EOS
   ```
480

481
1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect.
482 483 484 485 486

**Source configuration**

1. Edit `config/gitlab.yaml`:

487 488 489 490 491 492 493 494
   ```yaml
   production:
     ldap:
       servers:
         main:
           # snip...
           lowercase_usernames: true
   ```
495 496

1. [Restart GitLab](../restart_gitlab.md#installations-from-source) for the changes to take effect.
497

498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529
## Disable LDAP web sign in

It can be 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 will not see a **LDAP** tab on the sign in page.
This does not disable [using LDAP credentials for Git access](#git-password-authentication).

**Omnibus configuration**

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

   ```ruby
   gitlab_rails['prevent_ldap_sign_in'] = true
   ```

1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect.

**Source configuration**

1. Edit `config/gitlab.yaml`:

   ```yaml
   production:
     ldap:
       prevent_ldap_sign_in: true
   ```

1. [Restart GitLab](../restart_gitlab.md#installations-from-source) for the changes to take effect.

530 531 532 533 534 535
## Encryption

### TLS Server Authentication

There are two encryption methods, `simple_tls` and `start_tls`.

Michael Kozono's avatar
Michael Kozono committed
536
For either encryption method, if setting `verify_certificates: false`, TLS
537 538 539
encryption is established with the LDAP server before any LDAP-protocol data is
exchanged but no validation of the LDAP server's SSL certificate is performed.

Michael Kozono's avatar
Michael Kozono committed
540
>**Note**: Before GitLab 9.5, `verify_certificates: false` is the default if
541 542
unspecified.

Drew Blessing's avatar
Drew Blessing committed
543 544 545 546 547 548 549 550 551 552 553
## Limitations

### TLS Client Authentication

Not implemented by `Net::LDAP`.
You should disable anonymous LDAP authentication and enable simple or SASL
authentication. The TLS client authentication setting in your LDAP server cannot
be mandatory and clients cannot be authenticated with the TLS protocol.

## Troubleshooting

554 555 556 557 558 559 560
If a user account is blocked or unblocked due to the LDAP configuration, a
message will be logged to `application.log`.

If there is an unexpected error during an LDAP lookup (configuration error,
timeout), the login is rejected and a message will be logged to
`production.log`.

561 562
### Debug LDAP user filter with ldapsearch

563
This example uses `ldapsearch` and assumes you are using ActiveDirectory. The
564 565 566
following query returns the login names of the users that will be allowed to
log in to GitLab if you configure your own user_filter.

567
```shell
568 569 570 571 572
ldapsearch -H ldaps://$host:$port -D "$bind_dn" -y bind_dn_password.txt  -b "$base" "$user_filter" sAMAccountName
```

- Variables beginning with a `$` refer to a variable from the LDAP section of
  your configuration file.
573
- Replace `ldaps://` with `ldap://` if you are using the plain authentication method.
574 575 576 577
  Port `389` is the default `ldap://` port and `636` is the default `ldaps://`
  port.
- We are assuming the password for the bind_dn user is in bind_dn_password.txt.

Drew Blessing's avatar
Drew Blessing committed
578 579 580
### Invalid credentials when logging in

- Make sure the user you are binding with has enough permissions to read the user's
581
  tree and traverse it.
Drew Blessing's avatar
Drew Blessing committed
582 583 584 585
- Check that the `user_filter` is not blocking otherwise valid users.
- Run the following check command to make sure that the LDAP settings are
  correct and GitLab can see your users:

586
  ```shell
587 588
  # For Omnibus installations
  sudo gitlab-rake gitlab:ldap:check
Drew Blessing's avatar
Drew Blessing committed
589

590 591 592
  # For installations from source
  sudo -u git -H bundle exec rake gitlab:ldap:check RAILS_ENV=production
  ```
Drew Blessing's avatar
Drew Blessing committed
593

594
### Connection refused
Drew Blessing's avatar
Drew Blessing committed
595 596

If you are getting 'Connection Refused' errors when trying to connect to the
597 598 599
LDAP server please double-check the LDAP `port` and `encryption` settings used by
GitLab. Common combinations are `encryption: 'plain'` and `port: 389`, OR
`encryption: 'simple_tls'` and `port: 636`.
600 601 602 603 604 605 606 607 608 609 610 611

### Connection times out

If GitLab cannot reach your LDAP endpoint, you will see a message like this:

```
Could not authenticate you from Ldapmain because "Connection timed out - user specified timeout".
```

If your configured LDAP provider and/or endpoint is offline or otherwise unreachable by GitLab, no LDAP user will be able to authenticate and log in. GitLab does not cache or store credentials for LDAP users to provide authentication during an LDAP outage.

Contact your LDAP provider or administrator if you are seeing this error.
612 613 614 615 616 617 618 619 620 621 622 623 624

### No file specified as Settingslogic source

If `sudo gitlab-ctl reconfigure` fails with the following error, or you are seeing it in
the logs, you may have malformed YAML in `/etc/gitlab/gitlab.rb`:

```plaintext
Errno::ENOENT: No such file or directory - No file specified as Settingslogic source
```

This issue is frequently due to the spacing in your YAML file. To fix the problem,
verify the syntax with **spacing** against the
[documentation for the configuration of LDAP](#configuration).