Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pycasbin/django-authorization
Per object permissions for Django, see example at: https://github.com/pycasbin/django-authorization-example
https://github.com/pycasbin/django-authorization
access-control authorization casbin django django-framework middleware python rbac
Last synced: 4 months ago
JSON representation
Per object permissions for Django, see example at: https://github.com/pycasbin/django-authorization-example
- Host: GitHub
- URL: https://github.com/pycasbin/django-authorization
- Owner: pycasbin
- License: apache-2.0
- Created: 2020-10-12T03:50:54.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-24T15:30:23.000Z (9 months ago)
- Last Synced: 2024-04-24T16:08:48.187Z (9 months ago)
- Topics: access-control, authorization, casbin, django, django-framework, middleware, python, rbac
- Language: Python
- Homepage: https://github.com/casbin/pycasbin
- Size: 40 KB
- Stars: 23
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Django Authorization
[](https://github.com/pycasbin/django-authorization/actions/workflows/release.yml)
[](https://coveralls.io/github/pycasbin/django-authorization?branch=master)
[](https://pypi.org/project/django-authorization/)
[](https://pypi.org/project/django-authorization/)
[](https://discord.gg/S5UjpzGZjN)
Django-authorization is an authorization library for Django framework.
Based on [Casbin](https://github.com/casbin/pycasbin) and [Django-casbin](https://github.com/pycasbin/django-casbin) (middleware, light weight of this plugin), an authorization library that that supports access control models like ACL, RBAC, ABAC.
- [Django Authorization](#django-authorization)
* [Installation and Configure](#installation-and-configure)
* [Usage](#usage)
+ [Some Important Concepts:](#some-important-concepts-)
+ [Middleware Usage](#middleware-usage)
+ [Decorator Usage](#decorator-usage)
+ [Command Line Usage](#command-line-usage)
* [License](#license)
## Installation and Configure
```
pip install django-authorization
```
We recommend that you first configure the adapter for persistent storage of the policy, such as:
[django-orm-adapter](https://github.com/pycasbin/django-orm-adapter), After integrating it into the project continue with the configuration of django-authrization
```python
# 1. Add the app to INSTALLED_APPS
INSTALLED_APPS = [
"django.contrib.admin",
"django.contrib.auth",
"django.contrib.contenttypes",
"django.contrib.sessions",
"django.contrib.messages",
"django.contrib.staticfiles",
"dauthz.apps.DauthzConfig", # add this app to INSTALLED_APPS
]
# 2. Add configure of dauthz
DAUTHZ = {
# DEFAULT Dauthz enforcer
"DEFAULT": {
# Casbin model setting.
"MODEL": {
# Available Settings: "file", "text"
"CONFIG_TYPE": "file",
"CONFIG_FILE_PATH": Path(__file__).parent.joinpath("dauthz-model.conf"),
"CONFIG_TEXT": "",
},
# Casbin adapter .
"ADAPTER": {
"NAME": "casbin_adapter.adapter.Adapter",
# 'OPTION_1': '',
},
"LOG": {
# Changes whether Dauthz will log messages to the Logger.
"ENABLED": False,
},
},
}
```
to better prompt the configure method of django-authorization, we made a django-app based on django-authorization, you can see it in [django-authorization-example](https://github.com/pycasbin/django-authorization-example)
## Usage
### Some Important Concepts:
such as .conf file, policy, sub, obj, act, please refer to the [casbin website](https://casbin.org/)
### Middleware Usage
```python
# Install middleware for django-authorization as required
MIDDLEWARE = [
"django.middleware.security.SecurityMiddleware",
"django.contrib.sessions.middleware.SessionMiddleware",
"django.middleware.common.CommonMiddleware",
"django.middleware.csrf.CsrfViewMiddleware",
"django.contrib.auth.middleware.AuthenticationMiddleware",
"django.contrib.messages.middleware.MessageMiddleware",
"django.middleware.clickjacking.XFrameOptionsMiddleware",
"dauthz.middlewares.request_middleware.RequestMiddleware", # add the middleware
]
```
You can freely set the casbin enforcer for the middleware via API: set_enforcer_for_request_middleware(enforcer_name) and set_enforcer_for_enforcer_middleware(enforcer_name)
### Decorator Usage
Request decorator will check the authorization status of user, path, method
```python
# use request decorator
@request_decorator
def some_view(request):
return HttpResponse("Hello World")
```
Enforcer decorator will check the authorization status of user, obj, edit. example:
```python
# use enforcer decorator
# sub: user in request obj: "artical" act: "edit"
@enforcer_decorator("artical", "edit")
def some_view(request):
return HttpResponse("Hello World")
```
### Command Line Usage
The command line operation allows you to operate directly on the enforcer's database. Three sets of commands are available: policy commands, group commands and role commands.
```shell
Add/Get policy, usage:
python manage.py policy [opt: --enforcer=] add
python manage.py policy [opt: --enforcer=] get
Add/Get role to user, usage:
python manage.py role [opt: --enforcer=] add
python manage.py role [opt: --enforcer=] get
Add/Get group policy, usage:
python manage.py group [opt: --enforcer=] add [opt:]
python manage.py group [opt: --enforcer=] get [opt:]
```
### Backend Usage
You can integrate Pycasbin with [Django authentication system](https://docs.djangoproject.com/en/4.2/topics/auth/default/#permissions-and-authorization). For more usage, you can refer to `tests/test_backend.py`. To enable the backend, you need to specify it in `settings.py`.
```python
AUTHENTICATION_BACKENDS = [
"dauthz.backends.CasbinBackend",
"django.contrib.auth.backends.ModelBackend",
]
```
Note that you still need to add permissions for users with pycasbin `add_policy()` due to the mechanism of the django permission system.
## License
This project is licensed under the [Apache 2.0 license](https://github.com/php-casbin/laravel-authz/blob/master/LICENSE).