Node-Casbin 开源项目教程

Node-Casbin 开源项目教程

node-casbinAn authorization library that supports access control models like ACL, RBAC, ABAC in Node.js and Browser项目地址:https://gitcode.com/gh_mirrors/no/node-casbin

1. 项目的目录结构及介绍

Node-Casbin 是一个强大的访问控制库，支持多种访问控制模型。以下是其基本的目录结构：

node-casbin/
├── src/
│   ├── core/
│   ├── model/
│   ├── persist/
│   ├── rbac/
│   ├── util/
│   └── index.ts
├── test/
│   ├── model/
│   ├── rbac/
│   └── util/
├── examples/
│   ├── basic_model.conf
│   ├── basic_policy.csv
│   └── main.ts
├── .gitignore
├── package.json
├── README.md
└── tsconfig.json

目录结构介绍

• src/: 包含项目的核心代码。
  • core/: 核心功能模块。
  • model/: 模型定义模块。
  • persist/: 持久化模块。
  • rbac/: 基于角色的访问控制模块。
  • util/: 工具函数模块。
  • index.ts: 入口文件。
• test/: 包含项目的测试代码。
• examples/: 包含示例代码和配置文件。
• .gitignore: Git 忽略文件配置。
• package.json: 项目依赖和脚本配置。
• README.md: 项目说明文档。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

Node-Casbin 的启动文件是 src/index.ts。这个文件是项目的入口点，负责初始化和导出核心模块。

// src/index.ts
export * from './core/Enforcer';
export * from './model/Model';
export * from './persist/Adapter';
export * from './rbac/RoleManager';
export * from './util/Util';

启动文件介绍

• Enforcer: 核心执行器，负责访问控制决策。
• Model: 模型定义，包括策略和规则。
• Adapter: 持久化适配器，用于加载和保存策略。
• RoleManager: 角色管理器，用于 RBAC 角色管理。
• Util: 工具函数，提供一些辅助功能。

3. 项目的配置文件介绍

Node-Casbin 的配置文件主要有两个：basic_model.conf 和 basic_policy.csv，它们位于 examples/ 目录下。

basic_model.conf

这是一个基本的模型配置文件，定义了访问控制模型的结构和规则。

[request_definition]
r = sub, obj, act

[policy_definition]
p = sub, obj, act

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

[matchers]
m = r.sub == p.sub && r.obj == p.obj && r.act == p.act

basic_policy.csv

这是一个基本的策略文件，定义了具体的访问控制规则。

p, alice, data1, read
p, bob, data2, write

配置文件介绍

• basic_model.conf: 定义了请求定义、策略定义、策略效果和匹配器。
• basic_policy.csv: 定义了具体的策略规则，如用户 alice 对 data1 有 read 权限，用户 bob 对 data2 有 write 权限。

通过这些配置文件，可以灵活地定义和调整访问控制策略。

node-casbinAn authorization library that supports access control models like ACL, RBAC, ABAC in Node.js and Browser项目地址:https://gitcode.com/gh_mirrors/no/node-casbin