Django RBAC Permissions

A Django package which enables RBAC with hierarchy and constraints enabled.

Quick Start

1. Add django_rbac_permissions to your INSTALLED_APPS setting like this:

   INSTALLED_APPS = [
        ...
        'django_rbac_permissions',
        'django_json_widget'  # Optional
   ]

   If you want to see your JSONFields in a pretty widget, include django_json_widget in your INSTALLED_APPS as well.

2. Run python manage.py migrate to create the models.

3. If you want to define your modules (applications) in which you have resources which should check for role authorization, you must define a module configuration model. Ex:

   class RoleModuleConfiguration(models.Model):
         posts = models.BooleanField(default=True)
         users = models.BooleanField(default=True)
         role_name = models.CharField(max_length=255)

   Each BooleanField symbolizes a module (application) and decides whether the given role_name is authorized to access it.

   You must also set MODULE_CONFIGURATION_PATH as the path, in which your model is residing.

4. If you also want to control the authorization in your admin page, you must add the middleware class CheckAdminRoleAuthorizationMiddleware to your MIDDLEWARE configuration in your Django settings file:

    MIDDLEWARE = [
    ...
    'rbac_permissions.middleware.CheckAdminRoleAuthorizationMiddleware'
    ]

5. There are some optional configuration parameters that you can set in your settings.py file.

• GRANT_NONEXISTENT_PATH_ACCESS decides whether you want to grant access to a nonexistent resource (in this case, this means either the url does not exist or the url is not added to any Transaction yet.) The default is False.
• PERMISSION_DENIED_URL sets the url name of your view, which returns a HTTP_FORBIDDEN_403 status code. This will be the view, which will be redirected by the decorator user_groups_required, if the user is denied access. The default is permission-denied.
• HTTP_FORBIDDEN_MESSAGE is the default message when the user is denied access. Completely optional.
• ROLE_RULE_DENIED_ACCESS_MESSAGE is the message returned by the view, when the required role matches one of the user's roles, but the current rule set of the Transaction denies access to this user's role or roles. Completely optional.

6. Start the development server and visit http://127.0.0.1:8000/admin/ to create a Role or Transaction.