Skip to content

[enhance](auth) introduction of ldaps support via configuration property #3351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
iaorekhov-1980 wants to merge 5 commits into
base: master
Choose a base branch
from
Open

[enhance](auth) introduction of ldaps support via configuration property #3351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
880cb9a
fix: 1st version of ldaps docs
iaorekhov-1980 Feb 9, 2026
794e6a0
fix: improved version of ldaps docs
iaorekhov-1980 Feb 9, 2026
135da3b
fix: final version of DORIS documentation
iaorekhov-1980 Feb 9, 2026
330c4bd
fix: fixed typo within description of ldap_use_ssl
iaorekhov-1980 Feb 16, 2026
5f0035e
fix: typo on ldap_use_ssl description
iaorekhov-1980 Feb 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions docs/admin-manual/auth/authentication/ldap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,28 @@ In LDAP, data is organized in a tree structure. Here's an example of a typical L
```
ldap_authentication_enabled = true
ldap_host = ladp-host
ldap_port = 389
# change ldap_port value if ldap_use_ssl specified to true as different port (636) is used for LDAPS
ldap_port = 389
ldap_admin_name = uid=admin,o=emr
ldap_user_basedn = ou=people,o=emr
ldap_user_filter = (&(uid={login}))
ldap_group_basedn = ou=group,o=emr
# specify ldap_use_ssl to true to use to switch to secured LDAPS protocol, specify false or comment property to use default behavior with plain LDAP
ldap_use_ssl = true
```

> Important for LDAPS:
>
> When `ldap_use_ssl = true`, ensure your LDAP server certificate is trusted by the Doris FE JVM.
>
> If using a custom or self-signed Certificate Authority (CA), you must configure the Java trustStore.
>
> Add the following parameters to JAVA_OPTS in `fe/conf/fe.conf` (adjust the path to your cacerts file):
> ```
> # Example for JDK 17
> JAVA_OPTS_FOR_JDK_17 = "-Djavax.net.ssl.trustStore=/path/to/your/cacerts -Djavax.net.ssl.trustStorePassword=changeit ..."
> ```

3. After starting `fe`, log in to Doris with `root` or `admin` account and set the LDAP admin password:

```sql
Expand Down Expand Up @@ -250,7 +265,9 @@ You can refresh the cache with the `refresh ldap` statement. See [REFRESH-LDAP](

## Known Limitations

- Currently, Doris's LDAP functionality only supports cleartext password verification, meaning that when users log in, passwords are transmitted in plaintext between `client` and `fe`, and between `fe` and LDAP service.
- Currently, Doris's LDAP functionality only supports cleartext password verification, meaning that when users log in, passwords are transmitted in plaintext between `client` and `fe`, but connection between `fe` and LDAP service can be secured optionally.
- **For `ldap_use_ssl = false` (default behavior)**: Passwords are transmitted in plain text between the Doris FE and the LDAP server.
- **To secure the connection**: Set `ldap_use_ssl = true` to encrypt traffic between Doris FE and the LDAP server. Note that SSL/TLS encryption between the **client and Doris FE** must be configured separately.

## FAQ

Expand Down
21 changes: 19 additions & 2 deletions versioned_docs/version-3.x/admin-manual/auth/authentication/ldap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,28 @@ In LDAP, data is organized in a tree structure. Here's an example of a typical L
```
ldap_authentication_enabled = true
ldap_host = ladp-host
ldap_port = 389
# change ldap_port value if ldap_use_ssl specified to true as different port (636) is used for LDAPS
ldap_port = 389
ldap_admin_name = uid=admin,o=emr
ldap_user_basedn = ou=people,o=emr
ldap_user_filter = (&(uid={login}))
ldap_group_basedn = ou=group,o=emr
# specify ldap_use_ssl to true to use to secured LDAPS protocol, specify false or comment property to use default behavior with plain LDAP
ldap_use_ssl = true
```

> Important for LDAPS:
>
> When `ldap_use_ssl = true`, ensure your LDAP server certificate is trusted by the Doris FE JVM.
>
> If using a custom or self-signed Certificate Authority (CA), you must configure the Java trustStore.
>
> Add the following parameters to JAVA_OPTS in `fe/conf/fe.conf` (adjust the path to your cacerts file):
> ```
> # Example for JDK 17
> JAVA_OPTS_FOR_JDK_17 = "-Djavax.net.ssl.trustStore=/path/to/your/cacerts -Djavax.net.ssl.trustStorePassword=changeit ..."
> ```

3. After starting `fe`, log in to Doris with `root` or `admin` account and set the LDAP admin password:

```sql
Expand Down Expand Up @@ -250,7 +265,9 @@ You can refresh the cache with the `refresh ldap` statement. See [REFRESH-LDAP](

## Known Limitations

- Currently, Doris's LDAP functionality only supports cleartext password verification, meaning that when users log in, passwords are transmitted in plaintext between `client` and `fe`, and between `fe` and LDAP service.
- Currently, Doris's LDAP functionality only supports cleartext password verification, meaning that when users log in, passwords are transmitted in plaintext between `client` and `fe`, but connection between `fe` and LDAP service can be secured optionally.
- **For `ldap_use_ssl = false` (default behavior)**: Passwords are transmitted in plain text between the Doris FE and the LDAP server.
- **To secure the connection**: Set `ldap_use_ssl = true` to encrypt traffic between Doris FE and the LDAP server. Note that SSL/TLS encryption between the **client and Doris FE** must be configured separately.

## FAQ

Expand Down
21 changes: 19 additions & 2 deletions versioned_docs/version-4.x/admin-manual/auth/authentication/ldap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,28 @@ In LDAP, data is organized in a tree structure. Here's an example of a typical L
```
ldap_authentication_enabled = true
ldap_host = ladp-host
ldap_port = 389
# change ldap_port value if ldap_use_ssl specified to true as different port (636) is used for LDAPS
ldap_port = 389
ldap_admin_name = uid=admin,o=emr
ldap_user_basedn = ou=people,o=emr
ldap_user_filter = (&(uid={login}))
ldap_group_basedn = ou=group,o=emr
# specify ldap_use_ssl to true to use to secured LDAPS protocol, specify false or comment property to use default behavior with plain LDAP
ldap_use_ssl = true
```

> Important for LDAPS:
>
> When `ldap_use_ssl = true`, ensure your LDAP server certificate is trusted by the Doris FE JVM.
>
> If using a custom or self-signed Certificate Authority (CA), you must configure the Java trustStore.
>
> Add the following parameters to JAVA_OPTS in `fe/conf/fe.conf` (adjust the path to your cacerts file):
> ```
> # Example for JDK 17
> JAVA_OPTS_FOR_JDK_17 = "-Djavax.net.ssl.trustStore=/path/to/your/cacerts -Djavax.net.ssl.trustStorePassword=changeit ..."
> ```

3. After starting `fe`, log in to Doris with `root` or `admin` account and set the LDAP admin password:

```sql
Expand Down Expand Up @@ -250,7 +265,9 @@ You can refresh the cache with the `refresh ldap` statement. See [REFRESH-LDAP](

## Known Limitations

- Currently, Doris's LDAP functionality only supports cleartext password verification, meaning that when users log in, passwords are transmitted in plaintext between `client` and `fe`, and between `fe` and LDAP service.
- Currently, Doris's LDAP functionality only supports cleartext password verification, meaning that when users log in, passwords are transmitted in plaintext between `client` and `fe`, but connection between `fe` and LDAP service can be secured optionally.
- **For `ldap_use_ssl = false` (default behavior)**: Passwords are transmitted in plain text between the Doris FE and the LDAP server.
- **To secure the connection**: Set `ldap_use_ssl = true` to encrypt traffic between Doris FE and the LDAP server. Note that SSL/TLS encryption between the **client and Doris FE** must be configured separately.

## FAQ

Expand Down