Django 权限机制的实现
本文涉及的技术,已应用于我基于 django 1.8+ 开发的博客系统——MayBlog,欢迎交流。
1. Django 权限机制概述
权限机制能够约束用户行为,控制页面的显示内容,也能使 API 更加安全和灵活;用好权限机制,能让系统更加强大和健壮。因此,基于 Django 的开发,理清 Django 权限机制是非常必要的。
1.1. Django 的权限控制
Django 用 user, group 和 permission 完成了权限机制,这个权限机制是将属于 model 的某个 permission 赋予 user 或 group,可以理解为全局的权限,即如果用户 A 对数据模型(model)B 有可写权限,那么 A 能修改 model B 的所有实例(objects)。group 的权限也是如此,如果为 group C 赋予 model B 的可写权限,则隶属于 group C 的所有用户,都可以修改 model B 的所有实例。
这种权限机制只能解决一些简单的应用需求,而大部分应用场景下,需要更细分的权限机制。以博客系统为例,博客系统的用户可分为『管理员』、『编辑』、『作者』和『读者』四个用户组;博客系统管理员和编辑具有查看、修改和删除所有的文章的权限,作者只能修改和删除自己写的文章,而读者则只有阅读权限。管理员、编辑和读者的权限,我们可以用全局权限做控制,而对于作者,全局权限无法满足需求,仅通过全局权限,要么允许作者编辑不属于自己的文章,要么让作者连自己的文章都无法修改。
上述的应用场景,Django 自带的权限机制无法满足需求,需要引入另一种更细的权限机制:对象权限(object permission)。
Object Permission 是一种对象颗粒度上的权限机制,它允许为每个具体对象授权。仍沿用最开始的例子,如果 model B 有三个实例 B1,B2 和 B3,如果我们把 B1 的可写权限赋予用户 A,则 A 可以修改 B1 对象,而对 B2,B3 无法修改。对 group 也一样,如果将 B2 的可写权限赋予 group C,则隶属于 group C 的所有用户均可以修改 B2,但无法修改 B1 和 B3。结合 Django 自带权限机制和 object permission,博客系统中作者的权限控制迎刃而解:系统全局上不允许作者编辑文章,而对于属于作者的具体文章,赋予编辑权限即可。
Django 其实包含了 object permission 的框架,但没有具体实现,object permission 的实现需要借助第三方 app django-guardian,我们在开发中用调用 django guradian 封装好的方法即可。
1.2. Django 的权限项
Django 用 permission 对象存储权限项,每个 model 默认都有三个 permission,即 add model, change model 和 delete model。例如,定义一个名为『Car』model,定义好 Car 之后,会自动创建相应的三个 permission:add_car, change_car 和 delete_car。Django 还允许自定义 permission,例如,我们可以为 Car 创建新的权限项:drive_car, clean_car, fix_car 等等
需要注意的是,permission 总是与 model 对应的,如果一个 object 不是 model 的实例,我们无法为它创建/分配权限。
2. Django 自带权限机制的应用
2.1. Permission
如上文所述,Django 定义每个 model 后,默认都会添加该 model 的 add, change 和 delete 三个 permission,自定义的 permission 可以在我们定义 model 时手动添加:
class Task(models.Model):
...
class Meta:
permissions = (
("view_task", "Can see available tasks"),
("change_task_status", "Can change the status of tasks"),
("close_task", "Can remove a task by setting its status as closed"),
)
每个 permission 都是 django.contrib.auth.Permission 类型的实例,该类型包含三个字段 name, codename 和 content_type,其中 content_type 反应了 permission 属于哪个 model,codename 如上面的 view_task,代码逻辑中检查权限时要用, name 是 permission 的描述,将 permission 打印到屏幕或页面时默认显示的就是 name
在 model 中创建自定义权限,从系统开发的角度,可理解为创建系统的内置权限,如果需求中涉及到用户使用系统时创建自定义权限,则要通过下面方法:
from myapp.models import BlogPost
from django.contrib.auth.models import Permission
from django.contrib.contenttypes.models import ContentType
content_type = ContentType.objects.get_for_model(BlogPost)
permission = Permission.objects.create(codename='can_publish',
name='Can Publish Posts',
content_type=content_type)
2.2. User Permission 管理
User 对象的 user_permission 字段管理用户的权限:
myuser.user_permissions = [permission_list]
myuser.user_permissions.add(permission, permission, ...) #增加权限
myuser.user_permissions.remove(permission, permission, ...) #删除权限
myuser.user_permissions.clear() #清空权限
##############################################################
# 注:上面的 permission 为 django.contrib.auth.Permission 类型的实例
##############################################################
检查用户权限用 has_perm() 方法:
myuser.has_perm('myapp.fix_car')
has_perm() 方法的参数,即 permission 的 codename,但传递参数时需要加上 model 所属 app 的前缀,格式为.。
无论 permission 赋予 user 还是 group,has_perm() 方法均适用
附注:
user.get_all_permissions() 方法列出用户的所有权限,返回值是 permission name 的 list
user.get_group_permissions() 方法列出用户所属 group 的权限,返回值是 permission name 的 list
2.3. Group Permission 管理
group permission 管理逻辑与 user permission 管理一致,group 中使用 permissions 字段做权限管理:
group.permissions = [permission_list]
group.permissions.add(permission, permission, ...)
group.permissions.remove(permission, permission, ...)
group.permissions.clear()
权限检查:
依然使用 user.has_perm() 方法。
2.4. permission_required 装饰器
权限能约束用户行为,当业务逻辑中涉及到权限检查时,decorator 能够分离权限验证和核心的业务逻辑,使代码更简洁,逻辑更清晰。permission 的 decorator 为 permission_required:
from django.contrib.auth.decorators import permission_required
@permission_required('car.drive_car')
def my_view(request):
...
2.5. Template 中的权限检查
Template 中使用全局变量 perms 存储当前用户的所有权限,权限检查可以参考下面例子:
{% if perms.main.add_page %}
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Pages <span class="caret"></span></a>
<ul class="dropdown-menu" role="menu">
<li><a href="{% url 'main:admin_pages' %}">All Pages</a></li>
<li><a href="{% url 'main:admin_page' %}">New Page</a></li>
<li><a href="{% url 'main:admin_pages' %}?draft=true">Drafts</a></li>
</ul>
</li>
{% endif %}
3. 基于 Django-guardian 的 object permission 的应用
Django-guardian 基于 django 的原生逻辑扩展了 django 的权限机制,应用 django-guardian 后,可以使用 django-guardian 提供的方法以及 django 的原生方法检查全局权限,django-guardian 提供的 object permission 机制使 django 的权限机制更加完善。
django-guardian 详细的使用文档请参考官方文档,其 object permission 常用方法如下:
from guardian.shortcuts import assign_perm, get_perms
from guardian.core import ObjectPermissionChecker
from guardian.decorators import permission_required
3.1. 添加 object permission
添加 object permission 使用 assign_perm() 方法,如为用户添加对 mycar 对象的 drive_car 权限:
assign_perm('myapp.drive_car', request.user, mycar)
assign_perm() 方法也可用于 group
assign_perm('myapp.drive_car', mygroup, mycar)
3.2. 权限检查
3.2.1. Global permission
get_perms() 方法用于检查用户的“全局权限”(global permission),与 user.has_perm() 异曲同工,如:
#############################
# It works!
#############################
if not 'main.change_post' in get_perms(request.user, post):
raise HttpResponse('Forbidden')
#############################
# It works, too!
#############################
if not request.user.has_perm('main.change_post')
return HttpResponse('Forbidden')
例子中虽然把 post object 作为参数传给 get_perms() 方法,但它只检查 user 的全局权限中是否有 main.change_post 权限,很多情况下可用原生的 user.has_perm 取代,但 user 和 group 均可作为 get_perms() 的传入参数,某些情况下可以使代码更简洁。
3.2.2. Object permission
Django-guardian 中使用 ObjectPermissionChecker 检查用户的 object permission,示例如下:
checker = ObjectPermissionChecker(request.user)
print checker.has_perm('main.change_post', post)
3.3. permission_required 装饰器
guardian.decorators.permission_required 是 django-guardian 权限检查的 decorator,既可以检查全局权限,又可以检查对象权限(object permission),其中,accept_global_perms 参数指出是否检查 user 的 global permission,如:
from guardian.decorators import permission_required
class DeletePost(View):
@method_decorator(permission_required('main.delete_post',
(models.Post, 'id', 'pk'),
accept_global_perms=True))
def get(self, request, pk):
try:
pk = int(pk)
cur_post = models.Post.objects.get(pk=pk)
is_draft = cur_post.is_draft
url = reverse('main:admin_posts')
if is_draft:
url = '{0}?draft=true'.format(url)
cur_post.delete()
except models.Post.DoesNotExist:
raise Http404
return redirect(url)
注:decorator 中的 (models.Post, ‘id’, ‘pk’)
部分,用于指定 object 实例,如果忽略这个参数,则不论 accept_global_perms 值为 True 还是 False,均仅仅检查全局权限。
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
上一篇: 关于 Django 的权限管理
下一篇: 彻底找到 Tomcat 启动速度慢的元凶
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论