ckanext-sso is an extension for CKAN, a powerful data management system that makes data accessible and usable. This extension provides Single Sign-On (SSO) capabilities, allowing users to log in to CKAN using various SSO providers.
| CKAN version | Compatible? |
|---|---|
| 2.9 and earlier | no, use v1.0.5 (support dropped in v1.1.0) |
| 2.10 | yes |
| 2.11 | yes |
| 2.12 | yes |
- SSO Integration: Seamlessly integrate with popular SSO providers.
- Easy Configuration: Simple setup to connect with your existing SSO system.
- Enhanced Security: Leverage SSO for a secure authentication experience.
To install the extension:
- Activate your CKAN virtual environment, for example:
. /usr/lib/ckan/default/bin/activate- Use pip to install package
pip install ckanext-sso-
Add
ssoto theckan.pluginssetting in your CKAN config file (by default the config file is located at/etc/ckan/default/ckan.ini). -
Restart CKAN. For example, if you've deployed CKAN with Apache on Ubuntu:
sudo service apache2 reloadckan.plugins = sso {OTHER PLUGINS}
## ckanext-sso
ckanext.sso.authorization_endpoint = [authorization_endpoint]
ckanext.sso.client_id = [client_id]
ckanext.sso.redirect_url = [https://myckansite.com/dashboard]
ckanext.sso.client_secret = [client_secret]
ckanext.sso.response_type = [code]
ckanext.sso.scope = [openid profile email]
ckanext.sso.access_token_url = [access_token_url]
ckanext.sso.user_info = [user_info_url]
ckanext.sso.disable_ckan_login = [True|False]
ckanext.sso.role = ["member"|"editor"|"admin"]
ckanext.sso.profile_username_field = [preferred_username]With Docker the same options can be set as CKANINI__CKANEXT__SSO__<OPTION> environment variables.
| Option | Default | Description |
|---|---|---|
authorization_endpoint, access_token_url, user_info |
placeholder URLs | OpenID Connect endpoints of your provider (e.g. Keycloak .../protocol/openid-connect/{auth,token,userinfo}) |
client_id, client_secret |
placeholders | Client registered at the provider |
redirect_url |
http://localhost/dashboard |
Must be https://<your-ckan>/dashboard and registered at the provider |
response_type, scope |
code, openid profile email |
OAuth2 settings |
disable_ckan_login |
false |
Hide the CKAN username/password login |
profile_username_field |
preferred_username |
Claim of the user info that the CKAN username is derived from (falls back to name when the claim is missing). Only applies to newly created users; existing users are matched by email |
role |
member |
Role given to a user in the organizations they are mapped to (see below) |
ldap_server, ldap_base_dn, ldap_user, ldap_pass |
empty | Optional LDAP lookup, see below |
On login the groups claim of the provider (leading / removed) is compared with the names of your CKAN organizations and groups. A match with an organization adds the user with the role from ckanext.sso.role; a match with a group adds the user as member. Names that do not exist in CKAN are ignored.
If ckanext.sso.ldap_server is set, the user is looked up in LDAP by email and the departmentNumber attribute is treated like an additional group name in the mapping above:
ckanext.sso.ldap_server = ldap://ad.example.com
ckanext.sso.ldap_base_dn = ou=People,dc=example,dc=com
ckanext.sso.ldap_user = <bind user>
ckanext.sso.ldap_pass = <password>LDAP is off unless ldap_server is set. A connection error, an unknown user or a missing attribute is logged and the login continues without a department.
After installing the extension and configuring the settings, you can now log in to CKAN using your SSO credentials.
Contributions are welcome! Please read our contributing guide to learn more.
This project is licensed under the terms of the GNU Affero General Public License v3.
The authors would like to thank the developers of the original project https://github.com/dathere/ckanext-sso.