安裝
該擴充套件需要 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.conf
和 config/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 。
使用中介軟體
該擴充套件包帶有一個 \tauthz\middleware\Basic::class
中介軟體:
Route::get('news/:id','News/Show')
->middleware(\tauthz\middleware\Basic::class, ['news', 'read']);
感謝
License
This project is licensed under the Apache 2.0 license.
本作品採用《CC 協議》,轉載必須註明作者和本文連結