webman 權限訪問控制庫 webman-permission

說明

它基于 PHP-Casbin, 一個強大的、高效的開源訪問控制框架，支持基于ACL, RBAC, ABAC等訪問控制模型。

項目地址

https://github.com/Tinywan/webman-permission

Requirements

• PHP > 7.2
• ThinkORM
• PHP-DI

安裝

composer require tinywan/webman-permission

依賴自動注入配置

修改配置config/container.php，其最終內容如下：

$builder = new \DI\ContainerBuilder();
$builder->addDefinitions(config('dependence', []));
$builder->useAutowiring(true);
$builder->useAnnotations(true);
return $builder->build();

config/container.php里最終返回一個符合PSR-11規(guī)范的容器實例。如果你不想使用 php-di ，可以在這里創(chuàng)建并返回一個其它符合PSR-11規(guī)范的容器實例。

當使用php-di后，開發(fā)者無需手動實例化DatabaseAdapter，webman會自動幫你完成。如果在實例化DatabaseAdapter過程中有其它類的依賴（RuleModel），webman也會自動實例化并注入。開發(fā)者不需要任何的初始化工作。

配置

控制模型 model 配置文件 config/permission.php 內容如下

return [
    'default' => 'basic',
    'enforcers' => [
        'basic' => [
            # Model 設置
            'model' => [
                'config_type' => 'file',
                'config_file_path' => config_path() . '/casbin-basic-model.conf',
                'config_text' => ''
            ],
            # 適配器
            'adapter' => webman\permission\adapter\DatabaseAdapter::class,
            # 數(shù)據(jù)庫連接表
            'database' => [
                'connection' => '',
                'rules_table' => 'train_rule',
                'rules_name' => 'rule',
            ],
            # 多進程策略定時刷新時間，單位秒
            'policy_refresh_time_interval' => 30
        ],
    ]
];

策略 policy 配置文件 config/casbin-basic-model.conf 內容如下

[request_definition]
r = sub, obj, act

[policy_definition]
p = sub, obj, act

[role_definition]
g = _, _

[policy_effect]
e = some(where (p.eft == allow))

[matchers]
m = g(r.sub, p.sub) && r.obj == p.obj && r.act == p.act

進程啟動配置

打開 config/bootstrap.php，加入如下配置：

return [
    // ThinkOrm 一定要 Permission 之前加載哦
    support\bootstrap\ThinkOrm::class, 
    webman\permission\Permission::class,
];

用法

快速開始

安裝成功后，可以這樣使用:

use webman\permission\Permission;

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

你可以檢查一個用戶是否擁有某個權限:

if (Permission::enforce("eve", "articles", "edit")) {
    echo '恭喜你！通過權限認證';
} else {
    echo '對不起，您沒有該資源訪問權限';
}

使用 Casbin Api

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

獲取所有角色:

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

獲取所有的角色的授權規(guī)則：

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 。

感謝

Casbin，你可以查看全部文檔在其 官網 上。

License

This project is licensed under the Apache 2.0 license.