feat(ldap-auth): use lua-resty-ldap instead of lualdap #7590
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kingluo
force-pushed
the
use-lua-resty-ldap
branch
from
054b6e9
to
52b4ee9
Compare
spacewander
reviewed
Aug 2, 2022
apisix/plugins/ldap-auth.lua
Outdated
| @@ -30,11 +30,13 @@ local schema = { | |||
| title = "work with route or service object", | |||
| properties = { | |||
| base_dn = { type = "string" }, | |||
| ldap_uri = { type = "string" }, | |||
| ldap_host = { type = "string" }, | |||
There was a problem hiding this comment.
We should keep the compatibility of the configuration
| verify_ldap_host = conf.verify_ldap_host, | ||
| base_dn = conf.base_dn, | ||
| attribute = uid, | ||
| keepalive = 60000, |
There was a problem hiding this comment.
Let's doc the newly added timeout and keepalive
There was a problem hiding this comment.
@spacewander These items are not exported to admin api, we only use default values. So we need to doc the default values? But it's kind of internal parameters.
apisix/plugins/ldap-auth.lua
Outdated
| } | ||
| local res, err = ldap.ldap_authenticate(user.username, user.password, ldapconf) | ||
| if not res then | ||
| core.log.error(err) |
There was a problem hiding this comment.
We use warning level log for this situation:
apisix/apisix/plugins/jwt-auth.lua
Line 369 in 5cbcf24
and it would be better to add a prefix in the error message
tzssangglass
reviewed
Aug 2, 2022
tzssangglass
previously approved these changes
Aug 3, 2022
spacewander
reviewed
Aug 3, 2022
apisix/plugins/ldap-auth.lua
Outdated
| } | ||
| local res, err = ldap.ldap_authenticate(user.username, user.password, ldapconf) | ||
| if not res then | ||
| core.log.warn("ldap-auth: ", err) |
There was a problem hiding this comment.
The prefix should be more meaningful
docs/en/latest/plugins/ldap-auth.md
Outdated
| @@ -49,7 +49,8 @@ For Route: | |||
| |----------|---------|----------|---------|------------------------------------------------------------------------| | |||
| | base_dn | string | True | | Base dn of the LDAP server. For example, `ou=users,dc=example,dc=org`. | | |||
| | ldap_uri | string | True | | URI of the LDAP server. | | |||
| | use_tls | boolean | False | `true` | If set to `true` uses TLS. | | |||
| | use_tls | boolean | False | `false` | If set to `true` uses TLS. | | |||
| | verify_ldap_host| boolean | False | `false` | Whether to verify the server certificate when `use_tls` is enabled; If set to `true`, you must set `ssl_trusted_certificate` in `config.yaml`, and make sure the host of `ldap_uri` matches the host in server certificate. | | |||
There was a problem hiding this comment.
This field doesn't have default value in the code. Why add a default value in the doc?
docs/en/latest/plugins/ldap-auth.md
Outdated
| @@ -49,7 +49,8 @@ For Route: | |||
| |----------|---------|----------|---------|------------------------------------------------------------------------| | |||
| | base_dn | string | True | | Base dn of the LDAP server. For example, `ou=users,dc=example,dc=org`. | | |||
| | ldap_uri | string | True | | URI of the LDAP server. | | |||
| | use_tls | boolean | False | `true` | If set to `true` uses TLS. | | |||
| | use_tls | boolean | False | `false` | If set to `true` uses TLS. | | |||
| | verify_ldap_host| boolean | False | `false` | Whether to verify the server certificate when `use_tls` is enabled; If set to `true`, you must set `ssl_trusted_certificate` in `config.yaml`, and make sure the host of `ldap_uri` matches the host in server certificate. | | |||
There was a problem hiding this comment.
According to the description, we should name this field tls_verify? It doesn't verify the host but the TLS relative stuff.
spacewander
approved these changes
Aug 4, 2022
tzssangglass
approved these changes
Aug 4, 2022
Liu-Junlin
pushed a commit
to Liu-Junlin/apisix
that referenced
this pull request
Nov 4, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Use lua-resty-ldap to do nonblocking ldap auth.
Checklist