Go 每日一库之 casbin

时间  2020-06-22
标签 每日 casbin 繁體版
原文   原文链接

简介

权限管理在几乎每一个系统中都是必备的模块。若是项目开发每次都要实现一次权限管理，无疑会浪费开发时间，增长开发成本。所以，casbin库出现了。casbin是一个强大、高效的访问控制库。支持经常使用的多种访问控制模型，如ACL/RBAC/ABAC等。能够实现灵活的访问权限控制。同时，casbin支持多种编程语言，Go/Java/Node/PHP/Python/.NET/Rust。咱们只须要一次学习，多处运用。html

快速使用

咱们依然使用 Go Module 编写代码，先初始化：mysql

$ mkdir casbin && cd casbin
$ go mod init github.com/darjun/go-daily-lib/casbin
复制代码

而后安装casbin，目前是v2版本：git

$ go get github.com/casbin/casbin/v2
复制代码

权限实际上就是控制谁能对什么资源进行什么操做。casbin将访问控制模型抽象到一个基于 PERM（Policy，Effect，Request，Matchers） 元模型的配置文件（模型文件）中。所以切换或更新受权机制只须要简单地修改配置文件。github

policy是策略或者说是规则的定义。它定义了具体的规则。golang

request是对访问请求的抽象，它与e.Enforce()函数的参数是一一对应的sql

matcher匹配器会将请求与定义的每一个policy一一匹配，生成多个匹配结果。数据库

effect根据对请求运用匹配器得出的全部结果进行汇总，来决定该请求是容许仍是拒绝。编程

下面这张图很好地描绘了这个过程：bash

咱们首先编写模型文件：微信

[request_definition]
r = sub, obj, act

[policy_definition]
p = sub, obj, act

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

[policy_effect]
e = some(where (p.eft == allow))
复制代码

上面模型文件规定了权限由sub,obj,act三要素组成，只有在策略列表中有和它彻底相同的策略时，该请求才能经过。匹配器的结果能够经过p.eft获取，some(where (p.eft == allow))表示只要有一条策略容许便可。

而后咱们策略文件（即谁能对什么资源进行什么操做）：

p, dajun, data1, read
p, lizi, data2, write
复制代码

上面policy.csv文件的两行内容表示dajun对数据data1有read权限，lizi对数据data2有write权限。

接下来就是使用的代码：

package main

import (
  "fmt"
  "log"

  "github.com/casbin/casbin/v2"
)

func check(e *casbin.Enforcer, sub, obj, act string) {
  ok, _ := e.Enforce(sub, obj, act)
  if ok {
    fmt.Printf("%s CAN %s %s\n", sub, act, obj)
  } else {
    fmt.Printf("%s CANNOT %s %s\n", sub, act, obj)
  }
}

func main() {
  e, err := casbin.NewEnforcer("./model.conf", "./policy.csv")
  if err != nil {
    log.Fatalf("NewEnforecer failed:%v\n", err)
  }

  check(e, "dajun", "data1", "read")
  check(e, "lizi", "data2", "write")
  check(e, "dajun", "data1", "write")
  check(e, "dajun", "data2", "read")
}
复制代码

代码其实不复杂。首先建立一个casbin.Enforcer对象，加载模型文件model.conf和策略文件policy.csv，调用其Enforce方法来检查权限。运行程序：

$ go run main.go
dajun CAN read data1
lizi CAN write data2
dajun CANNOT write data1
dajun CANNOT read data2
复制代码

请求必须彻底匹配某条策略才能经过。("dajun", "data1", "read")匹配p, dajun, data1, read，("lizi", "data2", "write")匹配p, lizi, data2, write，因此前两个检查经过。第 3 个由于"dajun"没有对data1的write权限，第 4 个由于dajun对data2没有read权限，因此检查都不能经过。输出结果符合预期。

sub/obj/act依次对应传给Enforce方法的三个参数。实际上这里的sub/obj/act和read/write/data1/data2是我本身随便取的，你彻底可使用其它的名字，只要能先后一致便可。

上面例子中实现的就是ACL（access-control-list，访问控制列表）。ACL显示定义了每一个主体对每一个资源的权限状况，未定义的就没有权限。咱们还能够加上超级管理员，超级管理员能够进行任何操做。假设超级管理员为root，咱们只须要修改匹配器：

[matchers]
e = r.sub == p.sub && r.obj == p.obj && r.act == p.act || r.sub == "root"
复制代码

只要访问主体是root一概放行。

验证：

func main() {
  e, err := casbin.NewEnforcer("./model.conf", "./policy.csv")
  if err != nil {
    log.Fatalf("NewEnforecer failed:%v\n", err)
  }

  check(e, "root", "data1", "read")
  check(e, "root", "data2", "write")
  check(e, "root", "data1", "execute")
  check(e, "root", "data3", "rwx")
}
复制代码

由于sub = "root"时，匹配器必定能经过，运行结果：

$ go run main.go
root CAN read data1
root CAN write data2
root CAN execute data1
root CAN rwx data3
复制代码

RBAC 模型

ACL模型在用户和资源都比较少的状况下没什么问题，可是用户和资源量一大，ACL就会变得异常繁琐。想象一下，每次新增一个用户，都要把他须要的权限从新设置一遍是多么地痛苦。RBAC（role-based-access-control）模型经过引入角色（role）这个中间层来解决这个问题。每一个用户都属于一个角色，例如开发者、管理员、运维等，每一个角色都有其特定的权限，权限的增长和删除都经过角色来进行。这样新增一个用户时，咱们只须要给他指派一个角色，他就能拥有该角色的全部权限。修改角色的权限时，属于这个角色的用户权限就会相应的修改。

在casbin中使用RBAC模型须要在模型文件中添加role_definition模块：

[role_definition]
g = _, _

[matchers]
m = g(r.sub, p.sub) && r.obj == p.obj && r.act == p.act
复制代码

g = _,_定义了用户——角色，角色——角色的映射关系，前者是后者的成员，拥有后者的权限。而后在匹配器中，咱们不须要判断r.sub与p.sub彻底相等，只须要使用g(r.sub, p.sub)来判断请求主体r.sub是否属于p.sub这个角色便可。最后咱们修改策略文件添加用户——角色定义：

p, admin, data, read
p, admin, data, write
p, developer, data, read
g, dajun, admin
g, lizi, developer
复制代码

上面的policy.csv文件规定了，dajun属于admin管理员，lizi属于developer开发者，使用g来定义这层关系。另外admin对数据data用read和write权限，而developer对数据data只有read权限。

package main

import (
  "fmt"
  "log"

  "github.com/casbin/casbin/v2"
)

func check(e *casbin.Enforcer, sub, obj, act string) {
  ok, _ := e.Enforce(sub, obj, act)
  if ok {
    fmt.Printf("%s CAN %s %s\n", sub, act, obj)
  } else {
    fmt.Printf("%s CANNOT %s %s\n", sub, act, obj)
  }
}

func main() {
  e, err := casbin.NewEnforcer("./model.conf", "./policy.csv")
  if err != nil {
    log.Fatalf("NewEnforecer failed:%v\n", err)
  }

  check(e, "dajun", "data", "read")
  check(e, "dajun", "data", "write")
  check(e, "lizi", "data", "read")
  check(e, "lizi", "data", "write")
}
复制代码

很显然lizi所属角色没有write权限：

dajun CAN read data
dajun CAN write data
lizi CAN read data
lizi CANNOT write data
复制代码

多个RBAC

casbin支持同时存在多个RBAC系统，即用户和资源都有角色：

[role_definition]
g=_,_
g2=_,_

[matchers]
m = g(r.sub, p.sub) && g2(r.obj, p.obj) && r.act == p.act
复制代码

上面的模型文件定义了两个RBAC系统g和g2，咱们在匹配器中使用g(r.sub, p.sub)判断请求主体属于特定组，g2(r.obj, p.obj)判断请求资源属于特定组，且操做一致便可放行。

策略文件:

p, admin, prod, read
p, admin, prod, write
p, admin, dev, read
p, admin, dev, write
p, developer, dev, read
p, developer, dev, write
p, developer, prod, read
g, dajun, admin
g, lizi, developer
g2, prod.data, prod
g2, dev.data, dev
复制代码

先看角色关系，即最后 4 行，dajun属于admin角色，lizi属于developer角色，prod.data属于生产资源prod角色，dev.data属于开发资源dev角色。admin角色拥有对prod和dev类资源的读写权限，developer只能拥有对dev的读写权限和prod的读权限。

check(e, "dajun", "prod.data", "read")
check(e, "dajun", "prod.data", "write")
check(e, "lizi", "dev.data", "read")
check(e, "lizi", "dev.data", "write")
check(e, "lizi", "prod.data", "write")
复制代码

第一个函数中e.Enforce()方法在实际执行的时候先获取dajun所属角色admin，再获取prod.data所属角色prod，根据文件中第一行p, admin, prod, read容许请求。最后一个函数中lizi属于角色developer，而prod.data属于角色prod，全部策略都不容许，故该请求被拒绝：

dajun CAN read prod.data
dajun CAN write prod.data
lizi CAN read dev.data
lizi CAN write dev.data
lizi CANNOT write prod.data
复制代码

多层角色

casbin还能为角色定义所属角色，从而实现多层角色关系，这种权限关系是能够传递的。例如dajun属于高级开发者senior，seinor属于开发者，那么dajun也属于开发者，拥有开发者的全部权限。咱们能够定义开发者共有的权限，而后额外为senior定义一些特殊的权限。

模型文件不用修改，策略文件改动以下：

p, senior, data, write
p, developer, data, read
g, dajun, senior
g, senior, developer
g, lizi, developer
复制代码

上面policy.csv文件定义了高级开发者senior对数据data有write权限，普通开发者developer对数据只有read权限。同时senior也是developer，因此senior也继承其read权限。dajun属于senior，因此dajun对data有read和write权限，而lizi只属于developer，对数据data只有read权限。

check(e, "dajun", "data", "read")
check(e, "dajun", "data", "write")
check(e, "lizi", "data", "read")
check(e, "lizi", "data", "write")
复制代码

RBAC domain

在casbin中，角色能够是全局的，也能够是特定domain（领域）或tenant（租户），能够简单理解为组。例如dajun在组tenant1中是管理员，拥有比较高的权限，在tenant2可能只是个弟弟。

使用RBAC domain须要对模型文件作如下修改：

[request_definition]
r = sub, dom, obj, act

[policy_definition]
p = sub, dom, obj, act

[role_definition]
g = _,_,_

[matchers]
m = g(r.sub, p.sub, r.dom) && r.dom == p.dom && r.obj == p.obj && r.act == p.obj
复制代码

g=_,_,_表示前者在后者中拥有中间定义的角色，在匹配器中使用g要带上dom。

p, admin, tenant1, data1, read
p, admin, tenant2, data2, read
g, dajun, admin, tenant1
g, dajun, developer, tenant2
复制代码

在tenant1中，只有admin能够读取数据data1。在tenant2中，只有admin能够读取数据data2。dajun在tenant1中是admin，可是在tenant2中不是。

func check(e *casbin.Enforcer, sub, domain, obj, act string) {
  ok, _ := e.Enforce(sub, domain, obj, act)
  if ok {
    fmt.Printf("%s CAN %s %s in %s\n", sub, act, obj, domain)
  } else {
    fmt.Printf("%s CANNOT %s %s in %s\n", sub, act, obj, domain)
  }
}

func main() {
  e, err := casbin.NewEnforcer("./model.conf", "./policy.csv")
  if err != nil {
    log.Fatalf("NewEnforecer failed:%v\n", err)
  }

  check(e, "dajun", "tenant1", "data1", "read")
  check(e, "dajun", "tenant2", "data2", "read")
}
复制代码

结果不出意料：

dajun CAN read data1 in tenant1
dajun CANNOT read data2 in tenant2
复制代码

ABAC

RBAC模型对于实现比较规则的、相对静态的权限管理很是有用。可是对于特殊的、动态的需求，RBAC就显得有点力不从心了。例如，咱们在不一样的时间段对数据data实现不一样的权限控制。正常工做时间9:00-18:00全部人均可以读写data，其余时间只有数据全部者能读写。这种需求咱们能够很方便地使用ABAC（attribute base access list）模型完成：

[request_definition]
r = sub, obj, act

[policy_definition]
p = sub, obj, act

[matchers]
m = r.sub.Hour >= 9 && r.sub.Hour < 18 || r.sub.Name == r.obj.Owner

[policy_effect]
e = some(where (p.eft == allow))
复制代码

该规则不须要策略文件：

type Object struct {
  Name  string
  Owner string
}

type Subject struct {
  Name string
  Hour int
}

func check(e *casbin.Enforcer, sub Subject, obj Object, act string) {
  ok, _ := e.Enforce(sub, obj, act)
  if ok {
    fmt.Printf("%s CAN %s %s at %d:00\n", sub.Name, act, obj.Name, sub.Hour)
  } else {
    fmt.Printf("%s CANNOT %s %s at %d:00\n", sub.Name, act, obj.Name, sub.Hour)
  }
}

func main() {
  e, err := casbin.NewEnforcer("./model.conf", "./policy.csv")
  if err != nil {
    log.Fatalf("NewEnforecer failed:%v\n", err)
  }

  o := Object{"data", "dajun"}
  s1 := Subject{"dajun", 10}
  check(e, s1, o, "read")

  s2 := Subject{"lizi", 10}
  check(e, s2, o, "read")

  s3 := Subject{"dajun", 20}
  check(e, s3, o, "read")

  s4 := Subject{"lizi", 20}
  check(e, s4, o, "read")
}
复制代码

显然lizi在20:00不能read数据data：

dajun CAN read data at 10:00
lizi CAN read data at 10:00
dajun CAN read data at 20:00
lizi CANNOT read data at 20:00
复制代码

咱们知道，在model.conf文件中能够经过r.sub和r.obj，r.act来访问传给Enforce方法的参数。实际上sub/obj能够是结构体对象，得益于govaluate库的强大功能，咱们能够在model.conf文件中获取这些结构体的字段值。如上面的r.sub.Name、r.Obj.Owner等。govaluate库的内容能够参见我以前的一篇文章《Go 每日一库之 govaluate》。

使用ABAC模型能够很是灵活的权限控制，可是通常状况下RBAC就已经够用了。

模型存储

上面代码中，咱们一直将模型存储在文件中。casbin也能够实如今代码中动态初始化模型，例如get-started的例子能够改写为：

func main() {
  m := model.NewModel()
  m.AddDef("r", "r", "sub, obj, act")
  m.AddDef("p", "p", "sub, obj, act")
  m.AddDef("e", "e", "some(where (p.eft == allow))")
  m.AddDef("m", "m", "r.sub == g.sub && r.obj == p.obj && r.act == p.act")

  a := fileadapter.NewAdapter("./policy.csv")
  e, err := casbin.NewEnforcer(m, a)
  if err != nil {
    log.Fatalf("NewEnforecer failed:%v\n", err)
  }

  check(e, "dajun", "data1", "read")
  check(e, "lizi", "data2", "write")
  check(e, "dajun", "data1", "write")
  check(e, "dajun", "data2", "read")
}
复制代码

一样地，咱们也能够从字符串中加载模型：

func main() {
  text := ` [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 `

  m, _ := model.NewModelFromString(text)
  a := fileadapter.NewAdapter("./policy.csv")
  e, _ := casbin.NewEnforcer(m, a)

  check(e, "dajun", "data1", "read")
  check(e, "lizi", "data2", "write")
  check(e, "dajun", "data1", "write")
  check(e, "dajun", "data2", "read")
}
复制代码

可是这两种方式并不推荐。

策略存储

在前面的例子中，咱们都是将策略存储在policy.csv文件中。通常在实际应用中，不多使用文件存储。casbin以第三方适配器的方式支持多种存储方式包括MySQL/MongoDB/Redis/Etcd等，还能够实现本身的存储。完整列表看这里casbin.org/docs/en/ada…。下面咱们介绍使用Gorm Adapter。先链接到数据库，执行下面的SQL：

CREATE DATABASE IF NOT EXISTS casbin;

USE casbin;

CREATE TABLE IF NOT EXISTS casbin_rule (
  p_type VARCHAR(100) NOT NULL,
  v0 VARCHAR(100),
  v1 VARCHAR(100),
  v2 VARCHAR(100),
  v3 VARCHAR(100),
  v4 VARCHAR(100),
  v5 VARCHAR(100)
);

INSERT INTO casbin_rule VALUES
('p', 'dajun', 'data1', 'read', '', '', ''),
('p', 'lizi', 'data2', 'write', '', '', '');
复制代码

而后使用Gorm Adapter加载policy，Gorm Adapter默认使用casbin库中的casbin_rule表：

package main

import (
  "fmt"

  "github.com/casbin/casbin/v2"
  gormadapter "github.com/casbin/gorm-adapter/v2"
  _ "github.com/go-sql-driver/mysql"
)

func check(e *casbin.Enforcer, sub, obj, act string) {
  ok, _ := e.Enforce(sub, obj, act)
  if ok {
    fmt.Printf("%s CAN %s %s\n", sub, act, obj)
  } else {
    fmt.Printf("%s CANNOT %s %s\n", sub, act, obj)
  }
}

func main() {
  a, _ := gormadapter.NewAdapter("mysql", "root:12345@tcp(127.0.0.1:3306)/")
  e, _ := casbin.NewEnforcer("./model.conf", a)

  check(e, "dajun", "data1", "read")
  check(e, "lizi", "data2", "write")
  check(e, "dajun", "data1", "write")
  check(e, "dajun", "data2", "read")
}
复制代码

运行：

dajun CAN read data1
lizi CAN write data2
dajun CANNOT write data1
dajun CANNOT read data2
复制代码

使用函数

咱们能够在匹配器中使用函数。casbin内置了一些函数keyMatch/keyMatch2/keyMatch3/keyMatch4都是匹配 URL 路径的，regexMatch使用正则匹配，ipMatch匹配 IP 地址。参见casbin.org/docs/en/fun…。使用内置函数咱们能很容易对路由进行权限划分：

[matchers]
m = r.sub == p.sub && keyMatch(r.obj, p.obj) && r.act == p.act
复制代码
p, dajun, user/dajun/*, read
p, lizi, user/lizi/*, read
复制代码

不一样用户只能访问其对应路由下的 URL：

func main() {
  e, err := casbin.NewEnforcer("./model.conf", "./policy.csv")
  if err != nil {
    log.Fatalf("NewEnforecer failed:%v\n", err)
  }

  check(e, "dajun", "user/dajun/1", "read")
  check(e, "lizi", "user/lizi/2", "read")
  check(e, "dajun", "user/lizi/1", "read")
}
复制代码

输出：

dajun CAN read user/dajun/1
lizi CAN read user/lizi/2
dajun CANNOT read user/lizi/1
复制代码

咱们固然也能够定义本身的函数。先定义一个函数，返回 bool：

func KeyMatch(key1, key2 string) bool {
  i := strings.Index(key2, "*")
  if i == -1 {
    return key1 == key2
  }

  if len(key1) > i {
    return key1[:i] == key2[:i]
  }

  return key1 == key2[:i]
}
复制代码

这里实现了一个简单的正则匹配，只处理*。

而后将这个函数用interface{}类型包装一层：

func KeyMatchFunc(args ...interface{}) (interface{}, error) {
  name1 := args[0].(string)
  name2 := args[1].(string)

  return (bool)(KeyMatch(name1, name2)), nil
}
复制代码

而后添加到权限认证器中：

e.AddFunction("my_func", KeyMatchFunc)
复制代码

这样咱们就能够在匹配器中使用该函数实现正则匹配了：

[matchers]
m = r.sub == p.sub && my_func(r.obj, p.obj) && r.act == p.act
复制代码

接下来咱们在策略文件中为dajun赋予权限：

p, dajun, data/*, read
复制代码

dajun对匹配模式data/*的文件都有read权限。

验证一下：

check(e, "dajun", "data/1", "read")
check(e, "dajun", "data/2", "read")
check(e, "dajun", "data/1", "write")
check(e, "dajun", "mydata", "read")
复制代码

dajun对data/1没有write权限，mydata不符合data/*模式，也没有read权限：

dajun CAN read data/1
dajun CAN read data/2
dajun CANNOT write data/1
dajun CANNOT read mydata
复制代码

总结

casbin功能强大，简单高效，且多语言通用。值得学习。

你们若是发现好玩、好用的 Go 语言库，欢迎到 Go 每日一库 GitHub 上提交 issue😄

参考

  1. casbin GitHub：github.com/casbin/casb…
  2. casbin 官网：casbin.org/
  3. 一种基于元模型的访问控制策略描述语言：www.jos.org.cn/html/2020/2…
  4. Go 每日一库 GitHub：github.com/darjun/go-d…

我

个人博客：darjun.github.io

欢迎关注个人微信公众号【GoUpUp】，共同窗习，一块儿进步~

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程