Django 权限机制的实现

本文首发于Gevin的博客

原文连接：Django权限机制的实现

未经 Gevin 受权，禁止转载

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的前缀，格式为<app label>.<permission codename>。

不管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，均仅仅检查全局权限。

4. 结论

Django原生提供了一种简单的全局权限（global permission）控制机制，但不少应用场景下，对象权限（object permission）更加有用；django-guardian是目前比较活跃的一个django extension，提供了一种有效的object permission控制机制，与django原生机制一脉相承，推荐使用。