Think Authz:支援 ACL、RBAC、ABAC 等模型的授權(角色和許可權控制)庫

techlee發表於2019-10-26

Think Authorization 基於 PHP-Casbin, 一個強大的、高效的開源訪問控制框架,支援基於ACL, RBAC, ABAC等訪問控制模型。

在這之前,你需要了解 Casbin 的相關知識。

安裝

該擴充套件需要 PHP 7.1+ 和 ThinkPHP 6.0+,針對 TP 5.1 請使用 Think-Casbin .

使用composer安裝:

composer require casbin/think-authz

註冊服務,在應用的全域性公共檔案service.php中加入:

return [
    // ...

    tauthz\TauthzService::class,
];

釋出配置檔案和資料庫遷移檔案:

php think tauthz:publish

這將自動生成 config/tauthz-rbac-model.confconfig/tauthz.php 檔案。

執行遷移工具(確保資料庫配置資訊正確):

php think migrate:run

這將創將建立名為 rules 的表。

用法

快速開始

安裝成功後,可以這樣使用:


use tauthz\facade\Enforcer;

// adds permissions to a user
Enforcer::addPermissionForUser('eve', 'articles', 'read');
// adds a role for a user.
Enforcer::addRoleForUser('eve', 'writer');
// adds permissions to a rule
Enforcer::addPolicy('writer', 'articles','edit');

你可以檢查一個使用者是否擁有某個許可權:

// to check if a user has permission
if (Enforcer::enforce("eve", "articles", "edit")) {
    // permit eve to edit articles
} else {
    // deny the request, show an error
}

使用 Enforcer Api

它提供了非常豐富的 API,以促進對 Policy 的各種操作:

獲取所有角色:

Enforcer::getAllRoles(); // ['writer', 'reader']

獲取所有的角色的授權規則:

Enforcer::getPolicy();

獲取某個使用者的所有角色:

Enforcer::getRolesForUser('eve'); // ['writer']

獲取某個角色的所有使用者:

Enforcer::getUsersForRole('writer'); // ['eve']

決定使用者是否擁有某個角色:

Enforcer::hasRoleForUser('eve', 'writer'); // true or false

給使用者新增角色:

Enforcer::addRoleForUser('eve', 'writer');

賦予許可權給某個使用者或角色:

// to user
Enforcer::addPermissionForUser('eve', 'articles', 'read');
// to role
Enforcer::addPermissionForUser('writer', 'articles','edit');

刪除使用者的角色:

Enforcer::deleteRoleForUser('eve', 'writer');

刪除某個使用者的所有角色:

Enforcer::deleteRolesForUser('eve');

刪除單個角色:

Enforcer::deleteRole('writer');

刪除某個許可權:

Enforcer::deletePermission('articles', 'read'); // returns false if the permission does not exist (aka not affected).

刪除某個使用者或角色的許可權:

Enforcer::deletePermissionForUser('eve', 'articles', 'read');

刪除某個使用者或角色的所有許可權:

// to user
Enforcer::deletePermissionsForUser('eve');
// to role
Enforcer::deletePermissionsForUser('writer');

獲取使用者或角色的所有許可權:

Enforcer::getPermissionsForUser('eve'); // return array

決定某個使用者是否擁有某個許可權

Enforcer::hasPermissionForUser('eve', 'articles', 'read');  // true or false

更多 API 參考 Casbin API

使用中介軟體

該擴充套件包帶有一個 Basic 中介軟體。 您可以將它們新增到您的app/middleware.php檔案中:

<?php

return [
    // ... 其他中介軟體
    'alias' => [
        'authz'  => \tauthz\middleware\Basic::class,
    ],
];

然後就可以使用它們來保護路由了:

Route::get('news/:id','News/Show')
    ->middleware('authz', ['news', 'read']);

最後

Casbin 專案地址:https://github.com/php-casbin/php-casbin

Think Authorization 專案地址:https://github.com/php-casbin/think-authz

你可以檢視 Casbin 的完整文件 Casbin Docs.

相關文章