Django-RESTful Api之认证和权限
这篇讲什么
- 认证回答「你是谁」,权限回答「你能不能做这件事」,DRF 把两者做成可插拔的列表,既能全局配也能按视图配。
- 这篇用「学生只属于创建者」这个例子,把模型上的所有者字段、只读的
owner、默认认证方式、权限类与对象级权限、可浏览 API 的登录入口都跑了一遍。实测环境 Django 5.2.19 + DRF 3.18.3。
要解决的问题
- 没有认证和权限,任何资源都能被任何人改。目标规则:
- 学生与它的创建者互相关联;
- 只有登录用户才能创建学生;
- 只有创建者能更新和删除自己的学生;
- 未登录(游客)只能读。
- 这里有两个层次:认证回答「你是谁」,权限回答「你能不能做这件事」。DRF 里它们是两个可插拔列表,实测都能全局配或按视图配。
- 本篇实测环境:Django 5.2.19 + DRF 3.18.3。
模型上加所有者
1 | from django.contrib.auth.models import User |
-
老笔记「删库删迁移重建」那一段在开发期可以,但更稳的做法是加一个可空的
owner再迁移,历史数据不会被清掉:1
2python manage.py makemigrations school
python manage.py migrate -
建用户用
python manage.py createsuperuser;脚本里非交互创建要带三个环境变量(这条在《Django-站点管理》里实测过):1
2DJANGO_SUPERUSER_USERNAME=admin DJANGO_SUPERUSER_EMAIL=a@b.c DJANGO_SUPERUSER_PASSWORD=password \
python manage.py createsuperuser --noinput
序列化器:owner 只读
1 | class StudentSerializer(serializers.ModelSerializer): |
ReadOnlyField让owner只出现在输出里,客户端 POST 时传了也会被忽略——所有者由服务端填(见下面perform_create)。- 实测输出里
owner就是用户名字符串("owner": "alice"),不带 context 也不会报错(它不是超链接字段)。
认证:默认只有 Session + Basic
-
实测默认配置:
1
DEFAULT_AUTHENTICATION_CLASSES: ['SessionAuthentication', 'BasicAuthentication']
TokenAuthentication不在默认里,想用必须自己加。老笔记「用http://user:pass@host/students/1访问」走的就是 Basic。
-
实测各认证方式的真实表现(同一个受
IsAuthenticatedOrReadOnly保护的接口):1
2
3
4
5
6
7
8
9
10
11默认配置(Session+Basic):
匿名 GET -> 200 # 只读放行
匿名 POST -> 403
Basic 正确密码 GET -> 200
Basic 错密码 -> 403 | WWW-Authenticate: None
django 登录后 GET -> 200
只配 TokenAuthentication:
Token POST -> 201 | owner: 2
不带 Token 的 POST -> 401 | {'detail': 'Authentication credentials were not provided.'}
不带 Token 的 GET -> 200-
401 与 403 的分界实测出来了:有认证类接得住你却没带凭据 → 401;认证通过但权限不够(或压根没有能接的认证类)→ 403。
-
Basic 错密码是 403 而不是 401,这点和直觉不同,前端别只判 401。
-
Token 的生成与使用:
settings.py 1
2
3
4
5
6INSTALLED_APPS = [..., "rest_framework", "rest_framework.authtoken"]
REST_FRAMEWORK = {
"DEFAULT_AUTHENTICATION_CLASSES": [
"rest_framework.authentication.TokenAuthentication",
],
}1
2
3from rest_framework.authtoken.models import Token
token, _ = Token.objects.get_or_create(user=request.user) # 6.2 起也有 TokenProxy客户端每次带上:
Authorization: Token <key>。 -
测试里绕过认证用
client.force_authenticate(user=u)(实测 200),别在测试里真的走 HTTP Basic。 -
JWT 不在 DRF 本体里,要装
djangorestframework-simplejwt(本机未装,属于第三方)。
-
权限:类、开关与对象级
-
实测
rest_framework.permissions里可用的类:1
2
3AllowAny, IsAuthenticated, IsAdminUser, IsAuthenticatedOrReadOnly,
DjangoModelPermissions, DjangoModelPermissionsOrAnonReadOnly, DjangoObjectPermissions,
BasePermission, SAFE_METHODS, AND / OR / NOT(3.10 起的组合器)1
SAFE_METHODS: ('GET', 'HEAD', 'OPTIONS')
-
视图上挂权限:
1
2
3
4
5
6
7
8
9
10
11
12
13class OwnerStudents(generics.ListCreateAPIView):
queryset = Student.objects.all()
serializer_class = StudentSerializer
permission_classes = (permissions.IsAuthenticatedOrReadOnly,)
def perform_create(self, serializer):
serializer.save(owner=self.request.user) # 所有者由服务端填
class OwnerStudentDetail(generics.RetrieveUpdateDestroyAPIView):
queryset = Student.objects.all()
serializer_class = StudentSerializer
permission_classes = (permissions.IsAuthenticatedOrReadOnly, IsOwnerOrReadOnly) -
对象级权限自己写:
school/permissions.py 1
2
3
4
5
6
7
8from rest_framework import permissions
class IsOwnerOrReadOnly(permissions.BasePermission):
def has_object_permission(self, request, view, obj):
if request.method in permissions.SAFE_METHODS:
return True
return obj.owner == request.user- 注意
has_object_permission只在取到对象之后才会被调用;列表接口(没有单个对象)不会走它,所以列表还得靠get_queryset()过滤。
- 注意
-
实测权限矩阵(owner=alice,other=bob):
1
2
3
4
5owner PUT: 200
别人 PUT: 403 | {'detail': 'You do not have permission to perform this action.'}
别人 GET: 200
别人 DELETE: 403
匿名 GET detail: 200 -
关掉认证检查(比如公开的回调接口)实测两种写法:
views.py 1
2
3
4
5
def anon_only(request, format=None):
return Response({"ok": True})只写
permission_classes=[AllowAny]还不够:SessionAuthentication仍会跑 CSRF 检查,跨站 POST 会 403;要彻底不管就authentication_classes=[]。
可浏览 API 的登录入口
1 | from django.urls import include, path |
-
实测:
1
2/api-auth/login/: 200 | 含 username 输入: True
浏览器访问接口: 200 | 含 <form: True | 含 CSRF: False- 登录框是 Django 的
auth视图包了一层,账号体系完全复用 Django 的。 - 「含 CSRF: False」指匿名浏览页面上的数据表单不带 token;登录后同一页面就会出现可提交的表单。这是可浏览 API 的调试便利,不要把它当生产接口。
- 登录框是 Django 的
-
生产上一般直接关掉可浏览 API,只留 JSON:
settings.py 1
2
3REST_FRAMEWORK = {
"DEFAULT_RENDERER_CLASSES": ["rest_framework.renderers.JSONRenderer"],
}关掉后实测
Accept: text/html会得到 406(表现层没有了)。
新手卡点清单
-
都是实测踩过的:
卡点 症状(实测原文) 正确做法 以为 Token 认证默认开着 带 Authorization: Token ...仍 403加 rest_framework.authtoken并把TokenAuthentication配进认证类只配 Session/Basic 却按 401 处理未登录 实测是 403 401/403 都要分支 Basic 密码错以为会 401 实测 403, WWW-Authenticate: None前端提示「用户名或密码错误」而不是弹认证框 让客户端传 owner传了也没用( ReadOnlyField忽略)服务端 perform_create里owner=self.request.user列表接口指望 has_object_permission不会被调用,别人数据照样列出来 用 get_queryset()过滤只写 AllowAny不关认证跨站 POST 被 SessionAuthentication的 CSRF 拦成 403同时 authentication_classes=[]permission_classes写成permissions.IsAuthenticated(漏括号/漏元组)迭代到类本身,行为诡异 写成元组/列表,元素是类 测试里真发 Basic 头 依赖账号密码,慢且脆 client.force_authenticate(user=...)生产开着可浏览 API 页面暴露接口清单 只留 JSONRenderer
参考
- Django REST framework:Authentication:四种内置认证类与
TokenAuthentication的安装步骤。 - Django REST framework:Permissions:内置权限类、
SAFE_METHODS、has_object_permission。 - Django REST framework:REST framework tokens:
rest_framework.authtoken应用与Token模型。 - Django REST framework:Browseable API:可浏览页面与
api-auth登录入口。 - djangorestframework-simplejwt 项目主页:需要 JWT 时的第三方实现。