Django內置權限擴展案例

當Django的內置權限無法滿足需求的時候就自己擴展吧~

背景介紹

overmind項目使用了Django內置的權限系統，Django內置權限系統基於model層做控制，新的model創建後會默認新建三個權限，分別爲：add、change、delete，如果給用戶或組賦予delete的權限，那麼用戶將可以刪除這個model下的所有數據。

原本overmind只管理了我們自己部門的數據庫，權限設置只針對具體的功能不針對細粒度的數據庫實例，例如用戶A 有審覈的權限，那麼用戶A 可以審覈所有的DB，此時使用內置的權限系統就可以滿足需求了，但隨着系統的不斷完善要接入其他部門的數據庫管理，這就要求針對不同用戶開放不同DB的權限了，例如A部門的用戶只能操作A部門的DB，Django內置基於model的權限無法滿足需求了。

實現過程

先來確定下需求：

1. 保持原本的基於功能的權限控制不變，例如用戶A有查詢權限，B有審覈權限
2. 增加針對DB實例的權限控制，例如用戶A只能查詢特定的DB，B只能審覈特定的DB

對於上邊需求1用內置的權限系統已經可以實現，這裏不贅述，重點看下需求2，DB信息都存放在同一個表裏，不同用戶能操作不同的DB，也就是需要把每一條DB信息與有權限操作的用戶進行關聯，爲了方便操作，我們考慮把DB跟用戶組關聯，在用戶組裏的用戶都有權限，而操作類型經過分析主要有兩類讀和寫，那麼需要給每個MySQL實例添加兩個字段分別記錄對此實例有讀和寫權限的用戶組

如下代碼在原來的model基礎上添加read_groups和write_groups字段，DB實例跟用戶組應是ManyToManyField多對多關係，一個實例可以關聯多個用戶組，一個用戶組也可以屬於多個實例

class Mysql(models.Model):
    Env = (
        (1, 'Dev'),
        (2, 'Qa'),
        (3, 'Prod'),
    )
    create_time = models.DateTimeField(auto_now_add=True, verbose_name='創建時間')
    update_time = models.DateTimeField(auto_now=True, verbose_name='更新時間')

    project_id = models.IntegerField(verbose_name='項目')
    project_tmp = models.CharField(max_length=128, default='')
    environment = models.IntegerField(choices=Env, verbose_name='環境')

    master_host = models.GenericIPAddressField(verbose_name='master主機')
    master_port = models.IntegerField(default=3306, verbose_name='master端口')

    slave_host = models.GenericIPAddressField(null=True, verbose_name='slave主機')
    slave_port = models.IntegerField(null=True, default=3306, verbose_name='slave端口')

    database = models.CharField(max_length=64, verbose_name='數據庫')

    read_groups = models.ManyToManyField(Group, related_name='read', verbose_name='讀權限')
    write_groups = models.ManyToManyField(Group, related_name='write', verbose_name='寫權限')

    description = models.TextField(null=True, verbose_name='備註')

model確定了，接下來我們分三部分詳細介紹下權限驗證的具體實現

列表頁權限控制

如上圖列表頁，每個用戶進入系統後只能查看自己有讀權限的MySQL實例列表，管理員能查看所有，代碼如下：

def mysql(request):
    if request.method == 'GET':
        if request.user.is_superuser:
            _lists = Mysql.objects.all().order_by('id')
        else:
            # 獲取登錄用戶的所有組
            _user_groups = request.user.groups.all()

            # 構造一個空的QuerySet然後合併
            _lists = Mysql.objects.none()
            for group in _user_groups:
                _lists = _lists | group.read.all()

        return render(request, 'overmind/mysql.index.html', {'request': request, 'lPage': _lists})

實現的思路是：獲取登錄用戶的所有組，然後循環查詢每個組有讀取權限的數據庫實例，最後把每個組有權限讀的數據庫實例進行合併返回

獲取登錄用戶的所有組用到了ManyToMany的查詢方法：request.user.groups.all()

最終返回的一個結果是QuerySet，所以我們需要先構造一個空的Queryset：Mysql.objects.none()

QuerySet合並不能用簡單的相加，應爲：QuerySet-1 | QuerySet-2

查詢接口權限控制

如上圖系統中有很多功能是需要根據項目、環境查詢對應的DB信息的，對於此類接口也需要控制用戶只能查詢自己有權限讀的DB實例，管理員能查看所有，代碼如下：

def get_project_database(request, project, environment):
    if request.method == 'GET':
        _jsondata = {}

        if request.user.is_superuser:
            # 返回所有項目和環境匹配的DB
            _lists = Mysql.objects.filter(
                project_id=int(project),
                environment=int(environment)
            )

            _jsondata = {i.id: i.database for i in _lists}
        else:
            # 只返回用戶有權限查詢的DB
            _user_groups = request.user.groups.all()

            for group in _user_groups:
                # 循環mysql表中有read_groups權限的所有組
                for mysql in group.read.all():
                    if mysql.project_id == int(project) and mysql.environment == int(environment):
                        _jsondata[mysql.id] = mysql.database

        return JsonResponse(_jsondata)

實現思路與上邊類似，只是多了一步根據項目和環境再進行判斷

需要根據group去反查都有哪些DB實例包含了該組，這裏用到了M2M的related_name屬性：group.read.all()

更多關於Django ORM查詢的內容可以看這篇文章Django model select的各種用法詳解有詳細的總結

執行操作權限控制

除了上邊的兩個場景之外我們還需要在執行具體的操作之前去判斷是否有權限，例如執行審覈操作前判斷用戶是否對此DB有寫權限

有很多地方都需要做這個判斷，所以把這個權限判斷單獨寫個方法來處理，代碼如下：

def check_permission(perm, mysql, user):
    # 如果用戶是超級管理員則有權限
    if user.is_superuser:
        return True

    # 取出用戶所屬的所有組
    _user_groups = user.groups.all()

    # 取出Mysql對應權限的所有組
    if perm == 'read':
        _mysql_groups = mysql.read_groups.all()
    if perm == 'write':
        _mysql_groups = mysql.write_groups.all()

    # 用戶組和DB權限組取交集，有則表示有權限，否則沒有權限
    group_list = list(set(_user_groups).intersection(set(_mysql_groups)))

    return False if len(group_list) == 0 else True

實現思路是：根據傳入的第三個用戶參數，來獲取到用戶所有的組，然後根據傳入的第一個參數類型讀取或寫入和第二個參數DB實例來獲取到有權限的所有組，然後對兩個組取交集，交集不爲空則表示有權限，爲空則沒有

M2M的.all()取出來的結果是個list，兩個list取交集的方法爲：list(set(list-A).intersection(set(list-B)))

view中使用就很簡單了，如下：

def query(request):
    if request.method == 'POST':
        postdata = request.body.decode('utf-8')
        _host = get_object_or_404(Mysql, id=int(postdata.get('database')))

        # 檢查用戶是否有DB的查詢權限
        if check_permission('read', _host, request.user) == False:
            return JsonResponse({'state': 0, 'message': '當前用戶沒有查詢此DB的權限'})

寫在最後

1. Django有第三方的基於object的權限管理模塊Django-guardian，本項目沒有使用主要是因爲一來權限需求並不複雜，自己實現也很方便，二來個人在非必要的情況下並不喜歡引用過多第三方的包，後續升級維護都是負擔
2. 方案和代碼不盡完美，各位有更好的方案建議或更優雅的代碼寫法歡迎與我交流

---

如果你覺得文章不錯，請點右下角【好看】。如果你覺得讀的不盡興，推薦閱讀以下文章：

• Django+JWT實現Token認證
• 我們自研的那些Devops工具