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 訪問控制討論羣）