Django許可權機制的實現

本文首載於Gevin的博客

本文涉及的技術，已應用於我基於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 BlogPostfrom django.contrib.auth.models import Permissionfrom django.contrib.contenttypes.models import ContentTypecontent_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的listuser.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_permsfrom guardian.core import ObjectPermissionCheckerfrom 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_requiredclass 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原生機制一脈相承，推薦使用。