Skip to main content

Implementation of per object permissions for Django.

Project description

https://travis-ci.org/django-guardian/django-guardian.svg?branch=devel

django-guardian is an implementation of per object permissions [1] on top of Django’s authorization backend

Documentation

Online documentation is available at https://django-guardian.readthedocs.io/.

Requirements

  • Python 2.7 or 3.4+

  • A supported version of Django (currently 1.11+)

Travis CI tests on Django version 1.11, 2.0, and master.

Installation

To install django-guardian simply run:

pip install django-guardian

Configuration

We need to hook django-guardian into our project.

  1. Put guardian into your INSTALLED_APPS at settings module:

INSTALLED_APPS = (
 ...
 'guardian',
)
  1. Add extra authorization backend to your settings.py:

AUTHENTICATION_BACKENDS = (
    'django.contrib.auth.backends.ModelBackend', # default
    'guardian.backends.ObjectPermissionBackend',
)
  1. Create guardian database tables by running:

    python manage.py migrate

Usage

After installation and project hooks we can finally use object permissions with Django.

Lets start really quickly:

>>> from django.contrib.auth.models import User, Group
>>> jack = User.objects.create_user('jack', 'jack@example.com', 'topsecretagentjack')
>>> admins = Group.objects.create(name='admins')
>>> jack.has_perm('change_group', admins)
False
>>> from guardian.models import UserObjectPermission
>>> UserObjectPermission.objects.assign_perm('change_group', jack, obj=admins)
<UserObjectPermission: admins | jack | change_group>
>>> jack.has_perm('change_group', admins)
True

Of course our agent jack here would not be able to change_group globally:

>>> jack.has_perm('change_group')
False

Admin integration

Replace admin.ModelAdmin with GuardedModelAdmin for those models which should have object permissions support within admin panel.

For example:

from django.contrib import admin
from myapp.models import Author
from guardian.admin import GuardedModelAdmin

# Old way:
#class AuthorAdmin(admin.ModelAdmin):
#    pass

# With object permissions support
class AuthorAdmin(GuardedModelAdmin):
    pass

admin.site.register(Author, AuthorAdmin)

Project details


Download files

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

Source Distribution

django-guardian-1.5.1.tar.gz (155.0 kB view details)

Uploaded Source

Built Distribution

django_guardian-1.5.1-py2.py3-none-any.whl (101.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-guardian-1.5.1.tar.gz.

File metadata

  • Download URL: django-guardian-1.5.1.tar.gz
  • Upload date:
  • Size: 155.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.5

File hashes

Hashes for django-guardian-1.5.1.tar.gz
Algorithm Hash digest
SHA256 60a4932e322b4474ab76400f3f542ecdf9bee069dbed0ce0c7af55559ec83d3a
MD5 81e27cf61cc7b789e247275bcaf59ed9
BLAKE2b-256 34d7d28bf8d81c726e61efadc396cec5413681383208b469d790fe8ad9025669

See more details on using hashes here.

Provenance

File details

Details for the file django_guardian-1.5.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_guardian-1.5.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e4cf6a6406f5e6341e20dfda4f6fb9977da7708323c9d4aa7317c585b694ed86
MD5 6fbf4eca737f1d1989fe06b827567ccb
BLAKE2b-256 bda18bd715298dab3ceb91e3756bf904186c3d934df9fec8755e82c45a9be7e7

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page