Extension Restricted


Extension Basics

Title
Restricted
Name
ckanext-restricted
Type
Public extension
Description
CKAN extension for restricting access to resources
CKAN versions
Download-Url (zip)
Last commit
3 months ago (2025-10-08 12:35:17)
Url to repo
Category
Standards Compliance


Background Infos

Description (long)
Show details

.. You should enable this project on travis-ci.org and coveralls.io to make these badges work. The necessary Travis and Coverage config files have been generated for you.

=============

ckanext-restricted

.. Put a description of your extension here: What does it do? What features does it have? Consider including some screenshots or embedding a video!

CKAN extension to restrict the accessibility to the resources of a dataset. This way the package metadata is accessible but not the data itself (resource). The resource access restriction level can be individually defined for every package.

Users can request access to a dataset by pressing a button and filling up a simple form. The package owner can allow individual users to access the resource. If the users allowed individually will be notified by mail. It also includes notifying by mail on every new user registration that can be disabled (explained later in this document). The mails are generated from templates that can be extended.

All information inside the restricted fields (except ‘level’) is hidden for users other than the ones who can edit the dataset. We used this to keep a shared-secret key field for accessing remotely hosted resources (https://github.com/EnviDat/ckanext-envidat_theme/blob/4265ecfe90e10eb1f095e8e8d19fe43554ab6799/ckanext/envidat_theme/helpers.py#L28). The allowed usernames are hidden partially to the non-editors, in our case was critical because they were very similar to the user emails (https://github.com/EnviDat/ckanext-restricted/blob/2d7b2915ef50249fe8d9ec43ceaf532918506539/ckanext/restricted/action.py#L153).

restricted_resources_metadata.PNG restricted_resources_preview.PNG

.. figure:: restricted_resources_preview.PNG :align: center :alt: Package view with restricted resources :figclass: align-center

Package view with restricted resources

.. figure:: restricted_resources_metadata.PNG :align: center :alt: Resource metadata includi

Version
0.0.4
Version release date
2017-10-05
Contact name
(not set)
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

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