它基于 PHP-Casbin, 一个强大的、高效的开源访问控制框架,支持基于ACL
, RBAC
, ABAC
等访问控制模型。
https://github.com/Tinywan/webman-permission
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规范的容器实例。如果你不想使用 php-di ,可以在这里创建并返回一个其它符合PSR-11规范的容器实例。
当使用php-di后,开发者无需手动实例化DatabaseAdapter
,webman会自动帮你完成。如果在实例化DatabaseAdapter
过程中有其它类的依赖(RuleModel),webman也会自动实例化并注入。开发者不需要任何的初始化工作。
控制模型 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,
# 数据库连接表
'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 '对不起,您没有该资源访问权限';
}
它提供了非常丰富的 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 。
This project is licensed under the Apache 2.0 license.
感谢分享
弃用了么?
没有,仓库地址放到官方仓库了。仓库地址:https://github.com/php-casbin/webman-permission