Extension SAML2 Authentication


Extension Basics

Title
SAML2 Authentication
Name
ckanext-saml
Type
Public extension
Description
Adds SAML2 authentication with Identity Provider integration
CKAN versions

~2.9, ~2.10, ~2.11

Show details
Download-Url (zip)
Download-Url commit date
2025-09-15
Url to repo
Category
Authentication & Security


Background Infos

Description (long)
Show details

This extension enables SAML2-based authentication for CKAN by integrating with an external Identity Provider (IdP). The CKAN instance acts as a Service Provider (SP), allowing users to log in through their organization’s IdP using SAML2 protocol. The extension provides seamless single sign-on functionality and supports advanced ADFS configurations. Comprehensive documentation is available at https://datashades.github.io/ckanext-saml/ with detailed setup guides, configuration examples, and troubleshooting information.

Version
0.3.10
Version release date
2025-09-15
Contact name
DataShades
Contakt email
Contact Url
(not set)


Installation Guide

Configuration hints

Installation via PyPI: pip install ckanext-saml. Add ‘saml’ to ckan.plugins in your CKAN configuration. SAML2 Authentication: Configure your CKAN instance as Service Provider (SP) to connect with your Identity Provider (IdP) using SAML2 protocol for single sign-on. Full documentation: https://datashades.github.io/ckanext-saml/ provides comprehensive guides for IdP configuration, SP metadata setup, attribute mapping, and advanced features. Quick Start: Install via PyPI, add plugin to configuration, follow setup documentation for IdP connection. ADFS Support: Optional ADFS-specific features with lxml dependency (lxml==4.6.4). Development: git clone repository, pip install -e . for editable installation. Testing: pytest –ckan-ini=test.ini for running test suite. Documentation Building: Built with mkdocs - use ‘mkdocs build && mkdocs gh-deploy’ to deploy, ‘mkdocs serve -a 127.0.0.1:8001’ for local development server. Dependencies: python3-saml, typing-extensions, ckanext-toolbelt. Python 3.7+ required. See full documentation for IdP configuration examples, troubleshooting, and best practices.

Plugins to configure (ckan.ini)
saml
CKAN Settings (ckan.ini)
(not set)
DB migration to be executed
(not set)
<< back to Extensions