diff options
| author | Evan Read <eread@gitlab.com> | 2019-06-25 01:21:26 +0000 |
|---|---|---|
| committer | Evan Read <eread@gitlab.com> | 2019-06-25 01:21:26 +0000 |
| commit | e8bb778ff2ed507fb64cbb344a741bc69bfb30db (patch) | |
| tree | 22cd66987bcdfefb136efd56cac04465f2ae90d4 | |
| parent | db6fbee83f63de28d3c2dd5b176359c6371b7832 (diff) | |
| parent | ffbdbcee8e8f8de2f0f278ed1a3b60c1f9f1a7a7 (diff) | |
| download | gitlab-ce-e8bb778ff2ed507fb64cbb344a741bc69bfb30db.tar.gz | |
Merge branch 'patch-68' into 'master'
Add brackets escape example to LDAP doc
See merge request gitlab-org/gitlab-ce!29285
| -rw-r--r-- | doc/administration/auth/ldap.md | 35 |
1 files changed, 24 insertions, 11 deletions
diff --git a/doc/administration/auth/ldap.md b/doc/administration/auth/ldap.md index 54279897e04..1f2961ea39a 100644 --- a/doc/administration/auth/ldap.md +++ b/doc/administration/auth/ldap.md @@ -396,21 +396,34 @@ omniauth-ldap. ### Escaping special characters -If the `user_filter` DN contains special characters. For example, a comma: +The `user_filter` DN can contain special characters. For example: -``` -OU=GitLab, Inc,DC=gitlab,DC=com -``` +- A comma: -This character needs to be escaped as documented in [RFC 4515](https://tools.ietf.org/search/rfc4515). + ``` + OU=GitLab, Inc,DC=gitlab,DC=com + ``` -Due to the way the string is parsed, the special character needs to be converted -to hex and `\\5C\\` (`5C` = `\` in hex) added before it. -As an example the above DN would look like +- Open and close brackets: -``` -OU=GitLab\\5C\\2C Inc,DC=gitlab,DC=com -``` + ``` + OU=Gitlab (Inc),DC=gitlab,DC=com + ``` + + These characters must be escaped as documented in + [RFC 4515](https://tools.ietf.org/search/rfc4515). + +- Escape commas with `\2C`. For example: + + ``` + OU=GitLab\2C Inc,DC=gitlab,DC=com + ``` + +- Escape open and close brackets with `\28` and `\29`, respectively. For example: + + ``` + OU=Gitlab \28Inc\29,DC=gitlab,DC=com + ``` ## Enabling LDAP sign-in for existing GitLab users |