Extension Private Datasets


Extension Basics

Title
Private Datasets
Name
ckanext-privatedatasets
Type
Public extension
Description
Create private datasets with controlled user access and acquisition workflow via external services.
CKAN versions
Download-Url (zip)
Last commit
5 years ago (2020-03-16 11:11:32)
Url to repo
Category
Authentication & Security


Background Infos

Description (long)
Show details

CKAN Private Datasets

This CKAN extension allows a user to create private datasets that only certain users will be able to see. When a dataset is being created, it’s possible to specify the list of users that can see this dataset. In addition, the extension provides an HTTP API that allows to add users programmatically.

This project is part of FIWARE.

Key Features

  • Selective Privacy: Create private datasets with specific user access lists
  • Acquisition Workflow: Integrate external acquisition services (e.g., FiWare Store) via notification callbacks
  • Searchable Private Datasets: Control whether private datasets appear in search results
  • Acquired Datasets Dashboard: Users can view datasets they have acquired
  • Acquire Button: Display acquisition links on private datasets
  • API Integration: Programmatic user access management via HTTP API
  • Custom Notification Parsers: Create custom parsers for different acquisition services
  • SSL Client Verification: Secure notification callbacks with client-side certificates
  • Dashboard Integration: “Acquired Datasets” tab in user dashboard (CKAN 2.8+)

Technical Details

The extension adds three additional fields to private datasets: - allowed_users: List of users who can access the private dataset - searchable: Whether the private dataset appears in search results - acquire_url: External URL where users can acquire access to the dataset

When a private dataset is viewed by non-authorized users, an “Acquire” button links to the external acquisition service. After successful acquisition, the service sends a notification to CKAN’s API endpoint (/api/action/dataset_acquired), which grants the user access.

The extension provides a default parser for FiWare Store notifications but allows custom parsers via the ckan.privatedatasets.parser configuration setting.

Version
0.4.1
Version release date
2020-03-15
Contact name
CoNWeT Lab - Universidad Politécnica de Madrid / Future Internet Consulting and Development Solutions S.L.
Contakt email
Contact Url
(not set)


Installation Guide

Configuration hints

This extension manages private dataset access control.

You need to configure a notification parser to handle acquisition callbacks from external services.

The default FiWare Store parser is provided, but you can create custom parsers.

Optional: Show acquire URL field during dataset creation/editing

Optional: Secure the notification callback with SSL client certificates

Plugins to configure (ckan.ini)
privatedatasets
CKAN Settings (ckan.ini)
# Notification parser class (required)
# Specifies which parser handles acquisition notifications from external services
# Default FiWare parser: ckanext.privatedatasets.parsers.fiware:FiWareNotificationParser
# ckan.privatedatasets.parser = ckanext.privatedatasets.parsers.fiware:FiWareNotificationParser

# Show acquire URL field when creating datasets (optional, default: False)
# ckan.privatedatasets.show_acquire_url_on_create = True

# Show acquire URL field when editing datasets (optional, default: False)
# ckan.privatedatasets.show_acquire_url_on_edit = True
DB migration to be executed
(not set)
<< back to Extensions