156628cf72
### _Why are the changes needed?_ I'd like to update LDAP doc to guide users for setup LDAP authentication in Kyuubi. ### _How was this patch tested?_ - [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible - [x] Add screenshots for manual tests if appropriate <img width="1395" alt="image" src="https://github.com/apache/kyuubi/assets/26535726/6925a8e3-dfaf-48ad-a442-bb635fe75830"> - [ ] [Run test](https://kyuubi.readthedocs.io/en/master/contributing/code/testing.html#running-tests) locally before make a pull request Closes #5083 from zhaohehuhu/Improvement-0721. Closes #5083 8c0e149dd [Cheng Pan] polish 22f8d3aa6 [Cheng Pan] nit 822fa66b3 [hezhao2] sync 78ae12345 [hezhao2] further explanation for LDAP filters 7ebc61acf [Cheng Pan] Update docs/security/ldap.md bb06810f7 [Cheng Pan] Update docs/security/ldap.md 8d19fdf31 [Cheng Pan] Update docs/security/ldap.md c2fa2806e [Cheng Pan] Update docs/security/ldap.md 2acbb87db [hezhao2] update LDAP doc 22027e1f2 [hezhao2] update LDAP doc Lead-authored-by: hezhao2 <hezhao2@cisco.com> Co-authored-by: Cheng Pan <pan3793@gmail.com> Co-authored-by: Cheng Pan <chengpan@apache.org> Signed-off-by: Cheng Pan <chengpan@apache.org>
2.9 KiB
2.9 KiB
Configure Kyuubi to use LDAP Authentication
Kyuubi can be configured to enable frontend LDAP authentication for clients, such as the BeeLine, or the JDBC and ODBC drivers. At present, only simple LDAP authentication mechanism involving username and password is supported. The client sends a username and password to the Kyuubi server, and the Kyuubi server validates these credentials using an external LDAP service.
Enable LDAP Authentication
To enable LDAP authentication for Kyuubi, LDAP-related configurations is required to be configured in
$KYUUBI_HOME/conf/kyuubi-defaults.conf on each node where Kyuubi server is installed.
For example,
kyuubi.authentication=LDAP
kyuubi.authentication.ldap.baseDN=dc=org
kyuubi.authentication.ldap.domain=apache.org
kyuubi.authentication.ldap.binddn=uid=kyuubi,OU=Users,DC=apache,DC=org
kyuubi.authentication.ldap.bindpw=kyuubi123123
kyuubi.authentication.ldap.url=ldap://hostname.com:389/
User and Group Filter in LDAP
Kyuubi also supports complex LDAP cases as Apache Hive does.
For example,
# Group Membership
kyuubi.authentication.ldap.groupClassKey=groupOfNames
kyuubi.authentication.ldap.groupDNPattern=CN=%s,OU=Groups,DC=apache,DC=org
kyuubi.authentication.ldap.groupFilter=group1,group2
kyuubi.authentication.ldap.groupMembershipKey=memberUid
# User Search List
kyuubi.authentication.ldap.userDNPattern=CN=%s,CN=Users,DC=apache,DC=org
kyuubi.authentication.ldap.userFilter=hive-admin,hive,hive-test,hive-user
# Custom Query
kyuubi.authentication.ldap.customLDAPQuery=(&(objectClass=group)(objectClass=top)(instanceType=4)(cn=Domain*)), (&(objectClass=person)(|(sAMAccountName=admin)(|(memberOf=CN=Domain Admins,CN=Users,DC=domain,DC=com)(memberOf=CN=Administrators,CN=Builtin,DC=domain,DC=com))))
Please refer to Settings for LDAP authentication in Kyuubi for all configurations.