Node-Casbin 你可能需要的访问控制框架

Node-Casbin 是一个用 Node.js 语言打造的轻量级开源访问控制框架, 采用了元模型的设计思想，支持多种经典的访问控制方案，如基于角色的访问控制 RBAC、基于属性的访问控制 ABAC 等。

主要特性

• 支持自定义请求的格式，默认的请求格式为{subject, object, action}
• 具有访问控制模型 model 和策略 policy 两个核心概念
• 支持 RBAC 中的多层角色继承，不止主体可以有角色，资源也可以具有角色
• 支持超级用户，如 root 或 Administrator，超级用户可以不受授权策略的约束访问任意资源
• 支持多种内置的操作符，如 keyMatch，方便对路径式的资源进行管理，如 /foo/bar 可以映射到 /foo*

Node-Casbin 不做的事情

• 身份认证 authentication （即验证用户的用户名、密码），Node-Casbin 只负责访问控制。应该有其他专门的组件负责身份认证，然后由 Node-Casbin 进行访问控制，二者是相互配合的关系
• 管理用户列表或角色列表。Node-Casbin 认为由项目自身来管理用户、角色列表更为合适，Node-Casbin 假设所有策略和请求中出现的用户、角色、资源都是合法有效的

安装

# yarn  
yarn add casbin
# npm  
npm install casbin --save
复制代码

上手使用

引入 Node-Casbin

import { Enforcer } from 'casbin'
复制代码

初始化一个 enforcer，传入两个参数：模型文件路径和策略文件路径

const enforcer = await Enforcer.newEnforcer('path/to/model.conf', 'path/to/policy.csv');
复制代码

在你的代码需要进行访问控制的位置，加入如下钩子

const sub = 'alice'; // the user that wants to access a resource.
const obj = 'data1'; // the resource that is going to be accessed.
const act = 'read'; // the operation that the user performs on the resource.

if (enforcer.enforce(sub, obj, act) == true) {
    // permit alice to read data1
} else {
    // deny the request, show an error
}
复制代码

采用管理 API 进行权限的管理，如获取一个用户所有的角色

const roles = enforcer.getRoles('alice')
复制代码

请参考 test 目录获得更多的使用方法。

中间件

• express-authz
• koa-authz
• egg-authz

社区

Node-Casbin 目前正在积极向社区进行推送，目前通过插件的方式已经支持express、Koa2 等 Web 框架进行集成，将来会推广到更多 Web 框架以及社区。 Casbin 已经有 Golang 版本、Java 版本和 PHP 版本。有跨语言需求的开发者可以只用 Casbin 这一套框架就实现多个不同语言的项目的权限管理任务。

Casbin (Go)： github.com/casbin/casb…
jCasbin (Java)： github.com/casbin/jcas…
PHP-Casbin (PHP)： github.com/sstutz/php-…
Node-Casbin (Node.js): github.com/casbin/node…

如何贡献

如果你希望参与贡献
欢迎 Pull Request
欢迎 报告 Bug
或者加入 QQ 群：546057381（ Casbin 访问控制讨论群）