跳转至主要内容

Get Started

安装

go get github.com/casbin/casbin/v2

新建一个Casbin执行器

Casbin使用配置文件来定义访问控制模型。

有两个配置文件:model.confpolicy.csvmodel.conf存储访问模型,而policy.csv存储具体的用户权限配置。 Casbin的使用非常直接。 我们只需要创建一个主要结构:执行器。 在构建这个结构时,model.confpolicy.csv将被加载。

换句话说,要创建一个Casbin执行器,您需要提供一个模型和一个适配器

Casbin提供了一个您可以使用的文件适配器。 查看适配器以获取更多信息。

import "github.com/casbin/casbin/v2"

e, err := casbin.NewEnforcer("path/to/model.conf", "path/to/policy.csv")
  • 使用模型文本和其他适配器:
import (
"log"

"github.com/casbin/casbin/v2"
"github.com/casbin/casbin/v2/model"
xormadapter "github.com/casbin/xorm-adapter/v2"
_ "github.com/go-sql-driver/mysql"
)

// Initialize a Xorm adapter with MySQL database.
a, err := xormadapter.NewAdapter("mysql", "mysql_username:mysql_password@tcp(127.0.0.1:3306)/")
if err != nil {
log.Fatalf("error: adapter: %s", err)
}

m, err := model.NewModelFromString(`
[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
`)
if err != nil {
log.Fatalf("error: model: %s", err)
}

e, err := casbin.NewEnforcer(m, a)
if err != nil {
log.Fatalf("error: enforcer: %s", err)
}

检查权限

在访问发生之前,在您的代码中添加一个执行钩子:

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

ok, err := e.Enforce(sub, obj, act)

if err != nil {
// handle err
}

if ok == true {
// permit alice to read data1
} else {
// deny the request, show an error
}

// You could use BatchEnforce() to enforce some requests in batches.
// This method returns a bool slice, and this slice's index corresponds to the row index of the two-dimensional array.
// e.g. results[0] is the result of {"alice", "data1", "read"}
results, err := e.BatchEnforce([][]interface{}{{"alice", "data1", "read"}, {"bob", "data2", "write"}, {"jack", "data3", "read"}})

Casbin还提供了运行时权限管理的API。 例如,您可以如下获取分配给用户的所有角色:

roles, err := e.GetRolesForUser("alice")

查看管理APIRBAC API以获取更多用法。

请参考测试用例以获取更多用法。