Skip to main content

ckanext-resourceauthorizer - Resource authorizing extension

Resourceauthorizer is a extension for enalbing the acl-based permission control at resource-level in CKAN, which currently only support role-based access permission at dataset-level.

This extension provides an ability to let users specify who (users or organizations) can or cannot access a certain resource.

Notes:

  • Access permission setting for an organization will affect all members of the organization.

  • Extension always uses access permission at user-level as the final decision if there exists both rules for user and organization.

  • Allowing user/organization to access a resource will enable the access of the dataset metadata for that user/organization.

https://drive.google.com/uc?id=1QUiZNw96luC8uE8ujy1cF4N8F_sYYQgV

Requirements

This extension was developed and tested under CKAN-2.7.3

Installation

To install ckanext-resourceauthorizer:

  1. Activate your CKAN virtual environment, for example:

    . /usr/lib/ckan/default/bin/activate
  2. Install the ckanext-resourceauthorizer Python package into your virtual environment:

    pip install ckanext-resourceauthorizer
  3. Add resourceauthorizer to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/production.ini).

  4. Restart CKAN. For example if you’ve deployed CKAN with Apache on Ubuntu:

    sudo service apache2 reload

Config Settings

Run the following command to create the necessary tables in the database (ensuring the pyenv is activated):

(pyenv) $ paster --plugin=ckanext-resourceauthorizer resourceauthorizer initdb --config=/etc/ckan/default/production.ini

Run the following command to reindex the CKAN metadata in solr (ensuring the pyenv is activated):

(pyenv) $ paster --plugin=ckan search-index rebuild --config=/etc/ckan/default/production.ini

Finally, restart CKAN to have the changes take affect:

sudo service apache2 restart

Development Installation

To install ckanext-resourceauthorizer for development, activate your CKAN virtualenv and do:

git clone https://github.com/etri-sodas/ckanext-resourceauthorizer.git
cd ckanext-resourceauthorizer
python setup.py develop
pip install -r dev-requirements.txt

Running the Tests

To run the tests, do:

nosetests --nologcapture --with-pylons=test.ini

To run the tests and produce a coverage report, first make sure you have coverage installed in your virtualenv (pip install coverage) then run:

nosetests --nologcapture --with-pylons=test.ini --with-coverage --cover-package=ckanext.resourceauthorizer --cover-inclusive --cover-erase --cover-tests

Registering ckanext-resourceauthorizer on PyPI

ckanext-resourceauthorizer should be availabe on PyPI as https://pypi.python.org/pypi/ckanext-resourceauthorizer. If that link doesn’t work, then you can register the project on PyPI for the first time by following these steps:

  1. Create a source distribution of the project:

    python setup.py sdist
  2. Register the project:

    python setup.py register
  3. Upload the source distribution to PyPI:

    python setup.py sdist upload
  4. Tag the first release of the project on GitHub with the version number from the setup.py file. For example if the version number in setup.py is 0.0.1 then do:

    git tag 0.0.1
    git push --tags

Acknowledgements

This work was supported by Institute for Information & communications Technology Promotion (IITP) grant funded by the Korea government (MSIT) (No.2017-00253, Development of an Advanced Open Data Distribution Platform based on International Standards)

Metadata

Release files for ckanext-resourceauthorizer 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ckanext-resourceauthorizer 0.0.1
File Size Uploaded Provenance Actions
ckanext-resourceauthorizer-0.0.1.tar.gz 26.2 kB Without provenance Details for ckanext-resourceauthorizer-0.0.1.tar.gz

Release files / ckanext-resourceauthorizer-0.0.1.tar.gz

Download URL ckanext-resourceauthorizer-0.0.1.tar.gz
Size 26.2 kB
Tags Source
SHA-256 checksum
How to use checksums
f06a99c15cd70b501187c4b38a2075391cebee6f00df16e7b70c16a9ba551ddd
BLAKE2b-256 checksum
How to use checksums
0d903d4943efc42a441ff8720a0310a91bca7d50e68e6cd0af2fc2914a8e66b8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for ckanext-resourceauthorizer 0.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.1 This release

1 release file No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page