Ubuntu / Debian
sudo apt-get install -y python-dev libldap2-dev libsasl2-dev libssl-dev ldap-utilsCentOS / RHEL / Fedora
sudo dnf install python2-devel python3-devel openldap-devel| option | required | default | description |
|---|---|---|---|
| bind_dn | yes | DN of the service account to bind with the LDAP server | |
| bind_password | yes | Password of the service account | |
| base_ou | yes | Base OU to search for user and group entries | |
| group_dns | yes | Which groups user must be member of to be granted access (group names are considered case-insensitive) | |
| group_dns_check | no | and |
What kind of check to perform when validating user group membership (and / or). When and behavior is used, user needs to be part of all the specified groups and when or behavior is used, user needs to be part of at least one or more of the specified groups. |
| host | yes | Hostname of the LDAP server. Multiple comma-separated entries are allowed. | |
| port | yes | Port of the LDAP server | |
| use_ssl | no | false |
Use LDAPS to connect |
| use_tls | no | false |
Start TLS on LDAP to connect |
| cacert | no | None |
Path to the CA cert used to validate certificate |
| id_attr | no | uid |
Field name of the user ID attribute; ignored if account_pattern is specified. |
| account_pattern | no | {id_attr}={{username}} |
LDAP subtree pattern to match user. The user's username is escaped and interpolated into this string (see example). |
| group_pattern | no | (|(&(objectClass=*)(|(member={user_dn})(uniqueMember={user_dn})(memberUid={username})))) |
LDAP subtree pattern for user groups. Both user_dn and username are escaped and then interpolated into this string (see example). |
| scope | no | subtree |
Search scope (base, onelevel, or subtree) |
| network_timeout | no | 10.0 |
Timeout for network operations (in seconds) |
| chase_referrals | no | false |
True if the referrals should be automatically chased within the underlying LDAP C lib |
| debug | no | false |
Enable debug mode. When debug mode is enabled all the calls (including the results) to LDAP server are logged |
| client_options | no | A dictionary with additional Python LDAP client options which can be passed to set_connection() method |
|
| cache_user_groups_response | no | true |
When true, LDAP user groups response is cached for 120 seconds (by default) in memory. This decreases load on LDAP server and increases performance when remote LDAP group to RBAC role sync is enabled and / or when the same user authenticates concurrency in a short time frame. Keep in mind that even when this feature is enabled, single (authenticate) request to LDAP server will still be performed when user authenticates to st2auth - authentication information is not cached - only user groups are cached. |
| cache_user_groups_ttl | no | 120 |
How long (in seconds) |
| base_ou_group | no | None |
Base OU to search for group entries. If not specified will default to None and take value of base_ou |
The LDAP backend attempts a few different LDAP operations to authenticate users against an LDAP server:
- Attempts an LDAP bind with the StackStorm service credentials
bind_dnandbind_password. - Searches the LDAP server for the username provided by the StackStorm user, and saves the user's
bind_dnattribute asuser_dn. - Fetches the user's LDAP groups and compares them against the groups in the
group_dnsconfiguration using the logic fromgroup_dns_check, theuser_dnfrom step 2, and theusernamesupplied by the StackStorm user. - Attempts to re-bind to the LDAP server with the StackStorm user's supplied username and password.
If all of the steps succeed, then the user is authenticated. If any of those steps fail, then the authentication fails.
Please refer to the standalone mode in the configuration section for authentication for basic setup concept. The following is an example of the auth section in the StackStorm configuration file for the LDAP backend.
[auth]
mode = standalone
backend = ldap
backend_kwargs = {"bind_dn": "CN=st2admin,ou=users,dc=example,dc=com", "bind_password": "foobar123", "base_ou": "dc=example,dc=com", "group_dns": ["CN=st2users,ou=groups,dc=example,dc=com", "CN=st2developers,ou=groups,dc=example,dc=com"], "host": "identity.example.com", "port": 636, "use_ssl": true, "cacert": "/path/to/cacert.pem"}
enable = True
debug = False
use_ssl = True
cert = /path/to/mycert.crt
key = /path/to/mycert.key
logging = /path/to/st2auth.logging.conf
api_url = http://myhost.example.com:9101/Note: Key in the client_options dictionary must be an integer representing a LDAP constant option value.
For example:
backend_kwargs = {..., "client_options": {"20482": 9}}In this case, "20482" represents ldap.OPT_TIMEOUT option.
To retrieve a integer value of a particular client option constant, you can run the following code:
import ldap
print(ldap.OPT_TIMEOUT)Additionally, this simple example uses the default values for the id_attr, account_pattern, and group_pattern configuration options. This means that the user's account will be queried with the default LDAP search pattern uid={username}, and the groups will be queried with the default LDAP search pattern (|(&(objectClass=*)(|(member={user_dn})(uniqueMember={user_dn})(memberUid={username})))).
If your LDAP server uses a different name for the user ID attribute, you can simply specify the id_attr configuration option.
[auth]
mode = standalone
backend = ldap
backend_kwargs = {"bind_dn": "CN=st2admin,ou=users,dc=example,dc=com", "bind_password": "foobar123", "base_ou": "dc=example,dc=com", "id_attr": "username", "group_dns": ["CN=st2users,ou=groups,dc=example,dc=com", "CN=st2developers,ou=groups,dc=example,dc=com"], "host": "identity.example.com", "port": 636, "use_ssl": true, "cacert": "/path/to/cacert.pem"}
enable = True
debug = False
use_ssl = True
cert = /path/to/mycert.crt
key = /path/to/mycert.key
logging = /path/to/st2auth.logging.conf
api_url = http://myhost.example.com:9101/In this example, the user's account will be queried with the LDAP search pattern username={username}, and the user's groups will be queried with the default LDAP search pattern from above.
[auth]
mode = standalone
backend = ldap
backend_kwargs = {"bind_dn": "CN=st2admin,ou=users,dc=example,dc=com", "bind_password": "foobar123", "base_ou": "dc=example,dc=com", "account_pattern": "(&(objectClass=person)(|(accountName={username})(mail={username})))", "group_pattern": "(&(objectClass=userGroup)(|(member={user_dn})(uniqueMember={user_dn})(memberUsername={username})))", "group_dns": ["CN=st2users,ou=groups,dc=example,dc=com", "CN=st2developers,ou=groups,dc=example,dc=com"], "host": "identity.example.com", "port": 636, "use_ssl": true, "cacert": "/path/to/cacert.pem"}
enable = True
debug = False
use_ssl = True
cert = /path/to/mycert.crt
key = /path/to/mycert.key
logging = /path/to/st2auth.logging.conf
api_url = http://myhost.example.com:9101/Note: You do not have to override both account_pattern and group_pattern together, you may only need to override one of them.
It's easier to read the account_pattern string (&(objectClass=person)(|(accountName={username})(mail={username}))) if it is reformatted to show the nesting:
(&
(objectClass=person)
(|
(accountName={username})
(mail={username})
)
)
The Python string format patterns {username} will be interpolated with the LDAP username of users who are authenticating with StackStorm. This means that the account_pattern search string will query the LDAP server for a user who has the LDAP objectClass attribute equal to person and whose LDAP accountName or LDAP mail attributes are equal to the username they submit to StackStorm.
For group_pattern, the usage is similar, but it has an additional user_dn variable that will be interpolated into the string:
(&
(objectClass=userGroup)
(|
(member={user_dn})
(uniqueMember={user_dn})
(memberUsername={username})
)
)
This search string will query for LDAP objects that have objectClass attributes equal to userGroup and whose LDAP member or uniqueMember attributes are equal to the user's LDAP user_dn value or whose LDAP memberUsername attributes are equal to the username they submit to StackStorm.
The user_dn value is the user's bind_dn attribute returned by the LDAP server in step 2.
Unit tests:
make unit-testsCopyright 2015-2020 Extreme Networks, Inc.
Copyright 2020 StackStorm, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:
http://www.apache.org/licenses/LICENSE-2.0
By contributing you agree that these contributions are your own (or approved by your employer) and you grant a full, complete, irrevocable copyright license to all users and developers of the project, present and future, pursuant to the license of the project.
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent