django-guardian 1.2.4

Implementation of per object permissions for Django 1.2 or later.

django-guardian is implementation of per object permissions [1] as authorization backend which is supported since Django 1.2. It won't work with older Django releases.

Documentation

Online documentation is available at http://django-guardian.rtfd.org/.

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',
    )
    
  2. Add extra authorization backend:

    AUTHENTICATION_BACKENDS = (
        'django.contrib.auth.backends.ModelBackend', # default
        'guardian.backends.ObjectPermissionBackend',
    )
    
  3. Configure anonymous user ID

    ANONYMOUS_USER_ID = -1
    

Usage

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

Lets start really quickly:

>>> jack = User.objects.create_user('jack', 'jack@example.com', 'topsecretagentjack')
>>> admins = Group.objects.create(name='admins')
>>> jack.has_perm('change_group', admins)
False
>>> UserObjectPermission.objects.assign_perm('change_group', user=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)
[1]Great paper about this feature is available at djangoadvent articles.
BSD

Author

Lukasz Balcerzak

Pip

django-guardian==1.2.4

Classifiers

  • Topic :: Security
  • Programming Language :: Python :: 3
  • Programming Language :: Python :: 2
  • Programming Language :: Python
  • Operating System :: OS Independent
  • License :: OSI Approved :: BSD License
  • Intended Audience :: Developers
  • Framework :: Django
  • Environment :: Web Environment
  • Development Status :: 5 - Production/Stable
File Type Python Version Uploaded On Downloads
django-guardian-1.2.4.tar.gz Source July 14, 2014 21,741
Version Release Date
1.2.4 July 14, 2014
1.2.3 July 14, 2014
1.2.2 July 2, 2014
1.2.1 July 2, 2014
1.2.0 March 7, 2014
1.1.1 May 31, 2013
1.1.0 May 26, 2013
1.1.0.beta Feb. 26, 2013
1.0.4 July 15, 2012
1.0.3 July 25, 2011
1.0.2 April 12, 2011
1.0.1 March 25, 2011
1.0.0 Jan. 27, 2011
1.0.0.beta2 Jan. 14, 2011
1.0.0.beta1 Jan. 11, 2011
1.0.0.alpha2 Dec. 2, 2010
1.0.0.alpha1 Nov. 23, 2010
0.2.3 Nov. 17, 2010
0.2.2 Oct. 11, 2010
0.2.1 Oct. 3, 2010
0.2.0 Oct. 3, 2010
0.1.1 Sept. 27, 2010
0.1.0 June 5, 2010
Date Package Version Action
Nov. 4, 2014, 1:17 p.m. django-guardian 1.0.0.alpha1 Release Created
Nov. 4, 2014, 1:17 p.m. django-guardian 1.0.0.beta1 Release Created
Nov. 4, 2014, 1:17 p.m. django-guardian 1.0.4 Release Created
Nov. 4, 2014, 1:17 p.m. django-guardian 1.0.0.beta2 Release Created
Nov. 4, 2014, 1:17 p.m. django-guardian 1.2.1 Release Created
Nov. 4, 2014, 1:17 p.m. django-guardian 1.2.0 Release Created
Nov. 4, 2014, 1:17 p.m. django-guardian 1.2.3 Release Created
Nov. 4, 2014, 1:17 p.m. django-guardian 1.2.2 Release Created
Nov. 4, 2014, 1:17 p.m. django-guardian 1.2.4 Release Created
Nov. 4, 2014, 1:17 p.m. django-guardian 1.1.0.beta Release Created
Nov. 4, 2014, 1:17 p.m. django-guardian 0.1.1 Release Created
Nov. 4, 2014, 1:17 p.m. django-guardian 0.1.0 Release Created
Nov. 4, 2014, 1:17 p.m. django-guardian 0.2.0 Release Created
Nov. 4, 2014, 1:17 p.m. django-guardian 0.2.1 Release Created
Nov. 4, 2014, 1:17 p.m. django-guardian 0.2.2 Release Created
Nov. 4, 2014, 1:17 p.m. django-guardian 0.2.3 Release Created
Nov. 4, 2014, 1:17 p.m. django-guardian 1.0.0.alpha2 Release Created
Nov. 4, 2014, 1:17 p.m. django-guardian 1.0.3 Release Created
Nov. 4, 2014, 1:17 p.m. django-guardian 1.0.2 Release Created
Nov. 4, 2014, 1:17 p.m. django-guardian 1.0.1 Release Created
Nov. 4, 2014, 1:17 p.m. django-guardian 1.0.0 Release Created
Nov. 4, 2014, 1:17 p.m. django-guardian 1.1.0 Release Created
Nov. 4, 2014, 1:17 p.m. django-guardian 1.1.1 Release Created
Nov. 4, 2014, 1:17 p.m. django-guardian Package Created