使用 Casbin 作为 ThinkPHP 的权限控制中间件

2022-10-13,,,,

php-casbin 是一个强大的、高效的开源访问控制框架,它支持基于各种访问控制模型的权限管理。

think-casbin 是一个专为 thinkphp5.1 定制的 casbin 的扩展包,使开发者更便捷的在 thinkphp 项目中使用 casbin。

 

安装

  1. 创建 thinkphp 项目(如果没有):
composer create-project topthink/think=5.1.* tp5

 

  1. 在 thinkphp 项目里,安装 think-casbin 扩展:
composer require casbin/think-adapter

 

  1. 发布资源:
php think casbin:publish

 

这将自动创建 model 配置文件 config/casbin-basic-model.conf,和 casbin 的配置文件 config/casbin.php

  1. 数据迁移:

由于 think-casbin 默认将 casbin 的策略(policy)存储在数据库中,所以需要初始化数据库表信息。

执行前,请确保数据库连接信息配置正确,如需单独修改 casbin 的数据库连接信息或表名,可以修改 config/casbin.php 里的配置。

php think casbin:migrate

 

这将会自动创建 casbin 的策略(policy)表 casbin_rule

 

中间件

thinkphp 从 5.1.6+ 版本开始,正式引入中间件的支持。

可以通过命令行指令快速生成中间件

php think make:middleware authorization

 

这个指令会 application/http/middleware 目录下面生成一个 authorization 中间件。

在中间件中,获取当前用户名、uri、请求方法,通过 casbin 验证权限:

 1 <?php
 2 
 3 namespace app\http\middleware;
 4 
 5 use casbin;
 6 use think\facade\session;
 7 
 8 class authorization
 9 {
10     public function handle($request, \closure $next)
11     {
12         // 当前登录用户名,这里以session为例
13         // $user = session::get('user_name') ?: 'test_user';
14         $user = session::get('user_name');
15 
16         $url = $request->url();
17         $action = $request->method();
18 
19         if (!$user){
20             return response()->data('unauthenticated.')->code(401);
21         }
22 
23         if (!casbin::enforce($user, $url, $action)) {
24             return response()->data('unauthorized.')->code(403);
25         }
26 
27         return $next($request);
28     }
29 }

 

 

casbin model 配置

config\casbin-basic-model.conf 配置文件:

 1 [request_definition]
 2 r = sub, obj, act
 3 
 4 [policy_definition]
 5 p = sub, obj, act
 6 
 7 [policy_effect]
 8 e = some(where (p.eft == allow))
 9 
10 [matchers]
11 m = r.sub == p.sub && keymatch2(r.obj, p.obj) && r.act == p.act

 

 

验证

在执行授权之前,先在数据库 casbin_rule 表中添加一些默认的策略:

id ptype v0 v1 v2
1 p test_user /users get
2 p test_user /users/:id get

添加路由及其中间件:

 1 route::group('users', function () {
 2 
 3     route::get('', function () {
 4         return 'users data.';
 5     });
 6 
 7     route::get('/:id', function ($id) {
 8         return 'user: '.$id;
 9     });
10 
11 })->middleware(\app\http\middleware\authorization::class);

 

先登录用户保存用户名到 session ,可以访问 /users/users/1 验证一下权限。

 

更多 api 参考

  • management api
  • rbac api

《使用 Casbin 作为 ThinkPHP 的权限控制中间件.doc》

下载本文的Word格式文档,以方便收藏与打印。