1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
# django-rest-framework-guardian
[](https://github.com/rpkilby/django-rest-framework-guardian/actions/workflows/main.yml)
[](https://codecov.io/gh/rpkilby/django-rest-framework-guardian)
[](https://pypi.org/project/djangorestframework-guardian)
[](https://pypi.org/project/djangorestframework-guardian)
[](https://pypi.org/project/djangorestframework-guardian/)
django-rest-framework-guardian provides django-guardian integrations for Django REST Framework.
## Installation & Setup
To use django-rest-framework-guardian, install it into your environment.
```sh
$ pip install djangorestframework-guardian
```
Ensure both Django REST Framework and django-guardian are configured and added to your `INSTALLED_APPS` setting.
```python
INSTALLED_APPS = [
'rest_framework',
'guardian',
]
AUTHENTICATION_BACKENDS = [
'django.contrib.auth.backends.ModelBackend',
'guardian.backends.ObjectPermissionBackend',
]
```
## ObjectPermissionsFilter
The filter will ensure that querysets only returns objects for which the user has the appropriate view permission.
If you're using `ObjectPermissionsFilter`, you'll probably also want to add an appropriate object permissions
class, to ensure that users can only operate on instances if they have the appropriate object permissions. The easiest
way to do this is to subclass `DjangoObjectPermissions` and add `'view'` permissions to the `perms_map` attribute.
An example using both `ObjectPermissionsFilter` and `DjangoObjectPermissions` might look like the following:
**permissions.py**:
```python
from rest_framework import permissions
class CustomObjectPermissions(permissions.DjangoObjectPermissions):
"""
Similar to `DjangoObjectPermissions`, but adding 'view' permissions.
"""
perms_map = {
'GET': ['%(app_label)s.view_%(model_name)s'],
'OPTIONS': ['%(app_label)s.view_%(model_name)s'],
'HEAD': ['%(app_label)s.view_%(model_name)s'],
'POST': ['%(app_label)s.add_%(model_name)s'],
'PUT': ['%(app_label)s.change_%(model_name)s'],
'PATCH': ['%(app_label)s.change_%(model_name)s'],
'DELETE': ['%(app_label)s.delete_%(model_name)s'],
}
```
**views.py**:
```python
from rest_framework import viewsets
from rest_framework_guardian import filters
from myapp.models import Event
from myapp.permissions import CustomObjectPermissions
from myapp.serializers import EventSerializer
class EventViewSet(viewsets.ModelViewSet):
"""
Viewset that only lists events if user has 'view' permissions, and only
allows operations on individual events if user has appropriate 'view', 'add',
'change' or 'delete' permissions.
"""
queryset = Event.objects.all()
serializer_class = EventSerializer
permission_classes = [CustomObjectPermissions]
filter_backends = [filters.ObjectPermissionsFilter]
```
## ObjectPermissionsAssignmentMixin
A serializer mixin that allows permissions to be easily assigned to users and/or groups.
So each time an object is created or updated, the `permissions_map` returned by `Serializer.get_permissions_map` will be used to assign permission(s) to that object.
Please note that the existing permissions will remain intact.
A usage example might look like the following:
```python
from rest_framework_guardian.serializers import ObjectPermissionsAssignmentMixin
from blog.models import Post
class PostSerializer(ObjectPermissionsAssignmentMixin, serializers.ModelSerializer):
class Meta:
model = Post
fields = '__all__'
def get_permissions_map(self, created):
current_user = self.context['request'].user
readers = Group.objects.get(name='readers')
supervisors = Group.objects.get(name='supervisors')
return {
'view_post': [current_user, readers],
'change_post': [current_user],
'delete_post': [current_user, supervisors]
}
```
## Release Process
- Update changelog
- Update package version in setup.py
- Create git tag for version
- Build & upload release to PyPI
```bash
$ pip install -U setuptools build twine
$ rm -rf dist/
$ python -m build
$ twine upload -r test dist/*
$ twine upload dist/*
```
## License
See: [LICENSE](https://github.com/rpkilby/django-rest-framework-guardian/blob/master/LICENSE)
|
