Casbin

Casbin

  • 文档
  • API
  • 编辑器
  • Casdoor
  • 论坛
  • OA
  • 趋势
  • 帮助
  • 博客
  • Languages icon中文
    • English
    • 한국어
    • Русский
    • Français
    • 日本語
    • 参与翻译
  • GitHub

›扩充功能

基础知识

  • 概述
  • 开始使用
  • 工作原理
  • 教程

Model

  • 支持的Models
  • Model语法
  • 函数
  • 基于角色的访问控制
  • 域内RBAC
  • Casbin RBAC v.s. RBAC96
  • ABAC
  • 优先级模型

存储

  • Model存储
  • Policy存储
  • 政策子集加载

扩充功能

  • 适配器
  • 观察者
  • 调度器
  • 角色管理器
  • 中间件

API

  • API 教程
  • 管理 API
  • RBAC API
  • RoleManager API
  • 数据权限

高级用法

  • 多线程
  • 基准测试
  • 性能优化

管理

  • 管理员门户
  • Casbin 服务
  • 日志 & 错误处理
  • 前端使用

编辑器

  • 在线编辑器
  • IDE 插件

更多

  • 本项目使用者
  • 隐私政策
  • 服务条款
Translate

适配器

在Casbin中,策略存储作为adapter(Casbin的中间件) 实现。 Casbin用户可以使用adapter从存储中加载策略规则 (aka LoadPolicy()) 或者将策略规则保存到其中 (aka SavePolicy())。 为了保持代码轻量级,我们没有把adapter代码放在主库中。

目前支持的适配器列表

Casbin的适配器完整列表如下。 我们欢迎任何第三方对adapter进行新的贡献,如果有请通知我们,我们将把它放在这个列表中:)

Go
Java
Node.js
PHP
Python
.NET
Rust
适配器类型作者自动保存描述
File Adapter (内置)FileCasbin❌For .CSV (Comma-Separated Values) files
Filtered File Adapter (内置)File@faceless-saint❌对于 CSV (逗号分隔的值) 个带策略子集加载支持的文件
SQL AdapterSQL@Blank-Xu✅MySQL,PostgreSQL,SQL Server和SQLite3在 master分支中受到database/sql的支持,Oacle在 oracle分支中也受到database/sql的支持
Xorm AdapterORMCasbin✅通过 Xorm实现,支持MySQL, PostgreSQL, Sqlite3, SQL Server等多种存储引擎的adapter
Gorm AdapterORMCasbin✅通过 Gorm实现,支持MySQL, PostgreSQL, Sqlite3, SQL Server等多种存储引擎的adapter
Beego ORM AdapterORMCasbin✅MySQL, PostgreSQL, Sqlite3 在Beego ORM 中受到支持.
SQLX AdapterORM@memwey✅通过 SQLX实现,支持MySQL, PostgreSQL, SQLite, Oracle
Sqlx AdapterSQL@Blank-Xu✅MySQL,PostgreSQL,SQL Server和SQLite3在 master分支中受到支持,Oacle在 oracle分支中受到sqlx的支持
GF ORM AdapterORM@vance-liu✅MySQL, SQLite, PostgreSQL, Oracle, SQL Server 受到 GoFrame ORM 的支持
GoFrame ORM AdapterORM@kotlin2018✅MySQL, SQLite, PostgreSQL, Oracle, SQL Server 受到 GoFrame ORM 的支持
Filtered PostgreSQL AdapterSQLCasbin✅针对 PostgreSQL
PostgreSQL AdapterSQL@cychiuae✅针对 PostgreSQL
PostgreSQL Adapter (存档)SQLGoing❌针对 PostgreSQL
RQLite AdapterSQLEDOMO Systems✅对于 RQLite
MongoDB AdapterNoSQLCasbin✅基于 MongoDB driver for Go针对 MongoDB
RethinkDB AdapterNoSQL@adityapandey9✅用于 RethinkDB
Cassandra AdapterNoSQLCasbin❌对于 Apache Cassandra DB
DynamoDB AdapterNoSQLHOOQ❌对于 Amazon DynamoDB
DynacasbinNoSQLNewbMiao✅用于 Amazon DynamoDB
ArangoDB AdapterNoSQL@adamwasila✅用于 ArangoDB
Amazon S3 AdapterCloudSoluto❌用于 Minio 和 Amazon S3
Azure Cosmos DB AdapterCloud@spacycoder✅用于 Microsoft Azure Cosmos DB
GCP Firestore AdapterCloud@reedom❌用于 Google Cloud Platform Firestore
GCP Cloud Storage AdapterCloudqurami❌用于 Google Cloud Platform Cloud Storage
Consul AdapterKV store@ankitm123❌用于 HashiCorp Consul
Redis AdapterKV storeCasbin❌用于 Redis
Etcd AdapterKV store@sebastianliu❌用于 etcd
BoltDB AdapterKV store@speza✅用于 Bolt
Bolt AdapterKV store@wirepair❌用于 Bolt
BadgerDB AdapterKV store@inits✅用于 BadgerDB
Protobuf AdapterStreamCasbin❌用于 Google Protocol Buffers
JSON AdapterStringCasbin❌用于 JSON
String AdapterString@qiangmzsx❌用于 String
HTTP File AdapterHTTP@h4ckedneko❌用于 http.FileSystem
适配器类型作者自动保存描述
File Adapter (内置)FileCasbin❌对于 CSV (逗号分隔的值) 文件
JDBC AdapterJDBCCasbin✅MySQL, Oracle, PostgreSQL, DB2, Sybase, SQL 服务器由 JDBC 支持
Hibernate AdapterORMCasbin✅Oracle, DB2, SQL Server, Sybase, MySQL, PostgreSQL 由 Hibernate支持
MyBatis AdapterORMCasbin✅MySQL, Oracle, PostgreSQL, DB2, Sybase, SQL Server (与 JDBC 相同) 由 MyBatis 3 支持
Hutool AdapterORM@mapleafgo✅MySQL, Oracle, PostgreSQL, SQLite 由 Hutool 支持
MongoDB AdapterNoSQLCasbin✅MongoDB 由 Mongodb-driver-sync 支持
DynamoDB AdapterNoSQLCasbin❌对于 Amazon DynamoDB
适配器类型作者自动保存描述
File Adapter (内置)FileCasbin❌对于 CSV (逗号分隔的值) 文件
Filtered File Adapter (内置)FileCasbin❌对于带策略子集 .CSV (逗号分隔值) 文件加载支持
String Adapter (内置)String@calebfaruki❌用于 String
Basic AdapterNative ORMCasbin✅pg, mysql, mysql2, sqlite3, oracedb, mssql 是适配器本身支持的
Sequelize AdapterORMCasbin✅MySQL、 PostgreSQL、 SQLite、 Microsoft SQL Server 由 Sequelize 支持
TypeORM AdapterORMCasbin✅MySQL, PostgreSQL, MariaDB, SQLite, MS SQL Server, Oracle, WebSQL, MongoDB 由 TypeORM 支持
Prisma AdapterORMCasbin✅MySQL, PostgreSQL, MariaDB, SQLite, MS SQL Server, AWS Aurora, Azure SQL 由 Prisma支持
Knex AdapterORM@sarneeh and knex✅MSSQL, MySQL, PostgreSQL, SQLite3, Oracle 由 Knex.js支持
Objection.js AdapterORM@willsoto✅MSSQL, MySQL, PostgreSQL, SQLite3, Oracle 由 Objection.js 支持
Node PostgreSQL Native AdapterSQL@touchifyapp✅PostgreSQL adapter with advanced policy subset loading support and improved performances built with node-postgres.
Mongoose AdapterNoSQLelastic.io and Casbin✅MongoDB is supported by Mongoose
Node MongoDB Native AdapterNoSQL@juicycleff✅For Node MongoDB Native
DynamoDB AdapterNoSQL@fospitia✅For Amazon DynamoDB
Couchbase AdapterNoSQL@MarkMYoung✅For Couchbase
Redis AdapterKV storeCasbin❌For Redis
Redis AdapterKV store@NandaKishorJeripothula❌For Redis
适配器类型作者自动保存描述
File Adapter (built-in)FileCasbin❌For .CSV (Comma-Separated Values) files
Database AdapterORMCasbin✅MySQL, PostgreSQL, SQLite, Microsoft SQL Server are supported by techone/database
Zend Db AdapterORMCasbin✅MySQL, PostgreSQL, SQLite, Oracle, IBM DB2, Microsoft SQL Server, Other PDO Driver are supported by zend-db
Doctrine DBAL Adapter (Recommend)ORMCasbin✅Powerful PHP database abstraction layer (DBAL) with many features for database schema introspection and management.
Medoo AdapterORMCasbin✅Medoo is a lightweight PHP Database Framework to Accelerate Development, supports all SQL databases, including MySQL, MSSQL, SQLite, MariaDB, PostgreSQL, Sybase, Oracle and more.
Laminas-db AdapterORMCasbin✅MySQL, PostgreSQL, Oracle, IBM DB2, Microsoft Sql Server, PDO, etc. are supported by laminas-db
Zend-db AdapterORMCasbin✅MySQL, PostgreSQL, Oracle, IBM DB2, Microsoft Sql Server, PDO, etc. are supported by zend-db
Redis AdapterKV store@nsnake❌For Redis
适配器类型作者自动保存描述
File Adapter (built-in)FileCasbin❌For .CSV (Comma-Separated Values) files
SQLAlchemy AdapterORMCasbin✅PostgreSQL, MySQL, SQLite, Oracle, Microsoft SQL Server, Firebird, Sybase are supported by SQLAlchemy
Async Databases AdapterORMCasbin✅PostgreSQL, MySQL, SQLite, Oracle, Microsoft SQL Server, Firebird, Sybase are supported by Databases
Peewee AdapterORM@shblhy✅PostgreSQL, MySQL, SQLite are supported by Peewee
MongoEngine AdapterORM@zhangbailong945❌MongoDB is supported by MongoEngine
Couchbase AdapterNoSQLScienceLogic✅ (without remove_filtered_policy())For Couchbase
DynamoDB AdapterNoSQL@abqadeer✅For DynamoDB
Pymongo AdapterNoSQLCasbin❌MongoDB is supported by Pymongo
AdapterTypeAuthorAutoSaveDescription
File Adapter (built-in)FileCasbin❌For .CSV (Comma-Separated Values) files
EF AdapterORMCasbin❌MySQL, PostgreSQL, SQLite, Microsoft SQL Server, Oracle, DB2, etc. are supported by Entity Framework 6
EFCore AdapterORMCasbin✅MySQL, PostgreSQL, SQLite, Microsoft SQL Server, Oracle, DB2, etc. are supported by Entity Framework Core
AdapterTypeAuthorAutoSaveDescription
File Adapter (built-in)FileCasbin❌For .CSV (Comma-Separated Values) files
Diesel AdapterORMCasbin✅SQLite, PostgreSQL, MySQL are supported by Diesel
Sqlx AdapterORMCasbin✅PostgreSQL, MySQL are supported by Sqlx with fully asynchronous operation
YAML AdapterStringCasbin✅For YAML
note
  1. 如果使用显式或隐式adapter调用casbin.NewEnforcer(),策略将自动加载。
  2. 可以调用e.LoadPolicy() 来从存储中重新加载策略规则。
  3. 如果adapter不支持Auto-Save特性,则在添加或删除策略时不能将策略规则自动保存回存储器。 你必须手动调用 SavePolicy() 来保存所有的策略规则

例子

这里我们提供几个例子:

文件适配器 (内置)

以下代码展示了如何通过内置文件适配器初始化一个enforcer:

Go
PHP
Rust
import "github.com/casbin/casbin"

e := casbin.NewEnforcer("examples/basic_model.conf", "examples/basic_policy.csv")
use Casbin\Enforcer;

$e = new Enforcer('examples/basic_model.conf', 'examples/basic_policy.csv');
use casbin::prelude::*;

let mut e = Enforcer::new("examples/basic_model.conf", "examples/basic_policy.csv").await?;

它等同于如下代码:

Go
PHP
Rust
import (
"github.com/casbin/casbin"
"github.com/casbin/casbin/file-adapter"
)

a := fileadapter.NewAdapter("examples/basic_policy.csv")
e := casbin.NewEnforcer("examples/basic_model.conf", a)
use Casbin\Enforcer;
use Casbin\Persist\Adapters\FileAdapter;

$a = new FileAdapter('examples/basic_policy.csv');
$e = new Enforcer('examples/basic_model.conf', $a);
use casbin::prelude::*;

let a = FileAdapter::new("examples/basic_policy.csv");
let e = Enforcer::new("examples/basic_model.conf", a).await?;

MySQL 适配器

下面展示了如何从MySQL数据库初始化一个enforcer。 此处样例中的MySQL数据库运行在127.0.0.1:3306上,用户为root,密码为空。

Go
Rust
PHP
import (
"github.com/casbin/casbin"
"github.com/casbin/mysql-adapter"
)

a := mysqladapter.NewAdapter("mysql", "root:@tcp(127.0.0.1:3306)/")
e := casbin.NewEnforcer("examples/basic_model.conf", a)
// https://github.com/casbin-rs/diesel-adapter
// 请确保您激活了 `mysql` 特性

use casbin::prelude::*;
use diesel_adapter::{ConnOptions, DieselAdapter};

let mut conn_opts = ConnOptions::default();
conn_opts
.set_hostname("127.0.0.1")
.set_port(3306)
.set_host("127.0.0.1:3306") // overwrite hostname, port config
.set_database("casbin")
.set_auth("casbin_rs", "casbin_rs");

let a = DieselAdapter::new(conn_opts)?;
let mut e = Enforcer::new("examples/basic_model.conf", a).await?;
// https://github.com/php-casbin/dbal-adapter

use Casbin\Enforcer;
use CasbinAdapter\DBAL\Adapter as DatabaseAdapter;

$config = [
// Either 'driver' with one of the following values:
// pdo_mysql,pdo_sqlite,pdo_pgsql,pdo_oci (unstable),pdo_sqlsrv,pdo_sqlsrv,
// mysqli,sqlanywhere,sqlsrv,ibm_db2 (unstable),drizzle_pdo_mysql
'driver' => 'pdo_mysql',
'host' => '127.0.0.1',
'dbname' => 'test',
'user' => 'root',
'password' => '',
'port' => '3306',
];

$a = DatabaseAdapter::newAdapter($config);
$e = new Enforcer('examples/basic_model.conf', $a);

使用自建的adapter

您可以按照如下所示的方式使用您自定义的适配器:

import (
    "github.com/casbin/casbin"
    "github.com/your-username/your-repo"
)

a := yourpackage.NewAdapter(params)
e := casbin.NewEnforcer("examples/basic_model.conf", a)

在运行时进行加载或保存配置信息

您可以在初始化后重新加载模型与策略,或保存新的策略:

// 从模型CONF文件重新加载模型。
e.LoadModel()

// 从文件或数据库中重新加载策略。
e.LoadPolicy()

// 保存当前策略 (通常使用 Casbin API更改后) 返回文件或数据库。
e.SavePolicy()

自动保存

自动保存机制 (Auto-Save) 是适配器的特性之一。 如果当前适配器支持自动保存特性,该适配器可以向存储中添加一个策略规则,或者从存储中移除一个策略规则。 这与SavePolicy()不同,因为后者将删除存储中的所有策略规则,并将所有策略规则从Casbin enforcer保存到存储中。 因此,当策略规则的数量较多时,使用SavePolicy()可能会出现性能问题。

当适配器支持自动保存机制时,您可以通过Enforcer.EnableAutoSave() 函数来开启或关闭该机制。 默认情况下启用该选项(如果适配器支持自动保存的话)。

note
  1. Auto-Save 特性是可选的。 Adapter可以选择是否实现它。
  2. Auto-Save 只在Casbin enforcer使用的adapter支持它时才有效。
  3. 请参阅上面适配器列表中的自动保存 列,以查看自动保存是否有适配器支持。

下面是一个关于如何使用Auto-Save的例子:

import (
    "github.com/casbin/casbin"
    "github.com/casbin/xorm-adapter"
    _ "github.com/go-sql-driver/mysql"
)

// enforcer会默认开启AutoSave机制.
a := xormadapter.NewAdapter("mysql", "mysql_username:mysql_password@tcp(127.0.0.1:3306)/")
e := casbin.NewEnforcer("examples/basic_model.conf", a)

// 禁用AutoSave机制
e.EnableAutoSave(false)

// 因为禁用了AutoSave,当前策略的改变只在内存中生效
// 这些策略在持久层中仍是不变的
e.AddPolicy(...)
e.RemovePolicy(...)

// 开启AutoSave机制
e.EnableAutoSave(true)

// 因为开启了AutoSave机制,现在内存中的改变会同步回写到持久层中
e.AddPolicy(...)
e.RemovePolicy(...)

有关更多示例,请参见: https://github.com/casbin/xorm-adapter/blob/master/adapter_test.go

如何编写 Adapter

Adapter应实现Adapter 中定义的接口,其中必须实现的为LoadPolicy(model model.Model) error和SavePolicy(model model.Model) error。

其他三个函数是可选的。 如果adapter支持Auto-Save特性,则应该实现它们。

方法类型描述
LoadPolicy()强制的从存储中加载所有策略规则
SavePolicy()强制的将所有策略规则保存到存储中
AddPolicy()可选择的向存储中添加策略规则
RemovePolicy()可选择的从存储中删除策略规则
RemoveFilteredPolicy()可选择的从存储中删除匹配筛选器的策略规则
note

如果一个适配器不支持Auto-Save,它应该为以下三个可选函数提供一个空实现。 以下是Golang中的一个样例:

/ AddPolicy 向存储器添加了一条策略规则。
func (a *Adapter) AddPolicy(sec string, ptype string, rule []string) error {
    return errors.New("not implemented")
}

// RemovePolicy 从存储器中移除一条策略规则。
func (a *Adapter) RemovePolicy(sec string, ptype string, rule []string) error {
    return errors.New("not implemented")
}

// RemoveFilteredPolicy 从存储器中移除可匹配过滤器的策略规则。
func (a *Adapter) RemoveFilteredPolicy(sec string, ptype string, fieldIndex int, fieldValues ...string) error {
    return errors.New("not implemented")
}

Casbin enforcer在调用这三个可选实现的接口时,会忽略返回的not implemented 错误。

谁负责创建数据库?

作为约定,adapter应该能够自动创建一个名为casbin的数据库(如果它不存在的话),并将其用于策略存储。 具体请参考Xorm adapter的实现:https://github.com/casbin/xorm-adapter

← 政策子集加载观察者 →
  • 目前支持的适配器列表
  • 例子
    • 文件适配器 (内置)
    • MySQL 适配器
  • 使用自建的adapter
  • 在运行时进行加载或保存配置信息
  • 自动保存
    • 如何编写 Adapter
    • 谁负责创建数据库?
Casbin
Docs
Getting StartedManagement APIRBAC APIMiddlewares
Community
Who's using Casbin?ForumStack OverflowProject Chat
Casbin          jCasbin
Node-Casbin   PHP-CasbinPyCasbin          Casbin.NETCasbin-CPP        Casbin-RS
Follow @CasbinNews
Copyright © 2021 Casbin contributors.