ckanext-auth 0.4.1

2FA authentication for CKAN

This extension partially based on the ckanext-security

The extension provides a 2FA authentication mechanism for CKAN.

There are two methods of 2FA available:

• TOTP (Time-based One-Time Password) with authenticator apps like Google Authenticator, Authy, etc.
• Email

Requirements

Python 3.11+

This extension uses Redis, so it must be configured for CKAN.

Compatibility with core CKAN versions:

CKAN version	Compatible?
2.9 and earlier	no
2.10	yes
2.11	yes

If you want to add compatibility with CKAN 2.9 and earlier, you can contact me and I'll help you with that.

Installation

To install ckanext-auth:

1. Activate your CKAN virtual environment, for example:

. /usr/lib/ckan/default/bin/activate

2. Clone the source and install it on the virtualenv

git clone https://github.com/DataShades/ckanext-auth.git
cd ckanext-auth
pip install -e .

3. Add auth to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/ckan.ini).

4. Apply database migrations:

ckan db upgrade

5. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu:

sudo service apache2 reload

Config settings

There are several configuration settings available for this extension. Check the config declaration file.

If you have the ckanext-admin-panel installed, the configuration settings will be available in the admin panel too.

How to

• If you want to change the email for email 2FA, you can do it by creating a new template file at auth/emails/verification_code.html.

Tests

To run the tests, do:

pytest --ckan-ini=test.ini

License

AGPL