Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

Provides an object permission system based on field values (eg: object.owner == user)

Project description

django-field-object-permissions is an object permission system based on field values of the object. (eg: object.owner == user)

Install

To install just run:

pip install django-field-object-permissions

Configuration

  1. Put fieldobjectpermissions to your INSTALLED_APPS of the settings module:

    INSTALLED_APPS = (
       ...
       'fieldobjectpermissions',
    )
    

2. Replace the default authentication backend (fieldobjectpermissions is based on it):

AUTHENTICATION_BACKENDS = (
    # django.contrib.auth.backends.ModelBackend,  # Default
    fieldobjectpermissions.backends.FieldObjectPermissionsBackend,
)
  1. These new values are optional, defaults are shown below:

    FIELD_OBJECT_PERMISSIONS = {
        'OWNER_FIELDS': ('owner',),
        'GROUP_FIELDS': ('group',),
        'OWNER_ACTIONS': ('change', 'delete'),
        'GROUP_ACTIONS': ('change', 'delete'),
    }
    

4. Run python manage.py migrate as there are post-migration triggers to create the extra permissions required.

Usage

You can now assign permissions like owner_change_foo to allow only the user who matches the value of the owner field to change an object (or the superuser, of course).

Or the permission group_delete_foo to all allow any user who is a member of a group listed in the group field of an object to delete it (or the superuser, you know this).

These permissions are created in a post-migrate signal handler, and will only be created for models with have the required field(s).

By specifying multiple fields for OWNER_FIELDS or GROUP_FIELDS only one of the listed fields needs to exist for permission creation. And only one needs to match for permission to be granted by the auth backend.

Project details


Release history Release notifications

This version
History Node

0.1.1

History Node

0.1.0

History Node

0.0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
django-field-object-permissions-0.1.1.tar.gz (4.9 kB) Copy SHA256 hash SHA256 Source None Apr 10, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page