Skip to main content

An extension for authentication with OIDC/Keycloak

Project description

[![Tests](https://github.com/Mat-O-Lab/ckanext-sso/actions/workflows/test.yml/badge.svg)](https://github.com/Mat-O-Lab/ckanext-sso/actions/workflows/test.yml)

# ckanext-sso

## Introduction 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.

## Compatibility with core CKAN versions | CKAN version    | Compatible?   | | ————— | ————- | | 2.9 and earlier  | not tested    | | 2.10             | yes    | | 2.11            | yes    |

## Features

  • 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.

## Installation

To install the extension:

1. Activate your CKAN virtual environment, for example: `bash . /usr/lib/ckan/default/bin/activate ` 2. Use pip to install package `bash pip install ckanext-sso ` 3. Add sso to the ckan.plugins setting in your CKAN    config file (by default the config file is located at    /etc/ckan/default/ckan.ini).

4. Restart CKAN. For example, if you’ve deployed CKAN with Apache on Ubuntu: `bash sudo service apache2 reload `

## Configuration

`bash ckan.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] `

## Usage

After installing the extension and configuring the settings, you can now log in to CKAN using your SSO credentials.

## Contributing

Contributions are welcome! Please read our [contributing guide](CONTRIBUTING.md) to learn more.

## License

This project is licensed under the terms of the [MIT License](LICENSE).

# Acknowledgments The authors would like to thank the developers of the original project https://github.com/dathere/ckanext-sso.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ckanext_sso-1.0.2.tar.gz (19.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ckanext_sso-1.0.2-py3-none-any.whl (20.1 kB view details)

Uploaded Python 3

File details

Details for the file ckanext_sso-1.0.2.tar.gz.

File metadata

  • Download URL: ckanext_sso-1.0.2.tar.gz
  • Upload date:
  • Size: 19.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for ckanext_sso-1.0.2.tar.gz
Algorithm Hash digest
SHA256 9ac713607e9f55ce84712a87577bab21df141e3d1ef039669f475c0a181ebaf0
MD5 c6a615e71a5ee74577eca1671ee73795
BLAKE2b-256 f96b9e0d18332b020f1fb0624c7f987efa93f08b60aa064913e4c4a1ab15fa11

See more details on using hashes here.

Provenance

The following attestation bundles were made for ckanext_sso-1.0.2.tar.gz:

Publisher: pypi.yml on Mat-O-Lab/ckanext-sso

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ckanext_sso-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: ckanext_sso-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 20.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for ckanext_sso-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a0f559defed7df0e06ec38da74d68fed6a51658123a8f7d07a92845a865f5e97
MD5 1e1efd3d7d2d64d960c7d42689aca87d
BLAKE2b-256 dc4714487b0324c8876eca538823755699231399ea6b0c62d787202fe6714996

See more details on using hashes here.

Provenance

The following attestation bundles were made for ckanext_sso-1.0.2-py3-none-any.whl:

Publisher: pypi.yml on Mat-O-Lab/ckanext-sso

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page