casbin - 轻量级访问控制框架


Apache
跨平台
Google Go

软件简介

casbin

casbin 是一个用 Go 语言打造的轻量级开源访问控制框架,采用了元模型的设计思想,支持多种经典的访问控制方案,如基于角色的访问控制
RBAC、基于属性的访问控制 ABAC 等。

casbin 的主要特性包括:

  1. 支持自定义请求的格式,默认的请求格式为{subject, object, action};

  2. 具有访问控制模型 model 和策略 policy 两个核心概念;

  3. 支持 RBAC 中的多层角色继承,不止主体可以有角色,资源也可以具有角色;

  4. 支持超级用户,如 root 或 Administrator,超级用户可以不受授权策略的约束访问任意资源;

  5. 支持多种内置的操作符,如 keyMatch,方便对路径式的资源进行管理,如 /foo/bar 可以映射到 /foo*;

casbin 不做的事情:

  1. 身份认证 authentication(即验证用户的用户名、密码),casbin 只负责访问控制。应该有其他专门的组件负责身份认证,然后由 casbin 进行访问控制,二者是相互配合的关系;

  2. 管理用户列表或角色列表。casbin 认为由项目自身来管理用户、角色列表更为合适,casbin 假设所有策略和请求中出现的用户、角色、资源都是合法有效的。

安装

go get github.com/hsluoyz/casbin

HelloWorld 例子

初始化一个 enforcer,传入两个参数:模型文件路径和策略文件路径;

e := &Enforcer{}
e.Init("examples/basic_model.conf", "examples/basic_policy.csv")

在你的代码需要进行访问控制的位置,加入如下钩子;

sub := "alice"
obj := "data1"
act := "read"

if e.Enforce(sub, obj, act) == true {
    // permit alice to read data1
} else {
    // deny the request, show an error
}

采用管理API进行权限的管理,如获取一个用户所有的角色;

roles := e.GetRoles("alice")

请参考 _test.go 测试文件获得更多的使用方法。