Update the location of Revel plugin.
News: Casbin is also started to port to Java, contribution is welcomed. See: https://github.com/casbin/jcasbin
Casbin is a powerful and efficient open-source access control library for Golang projects. It provides support for enforcing authorization based on various access control models.
If you want to easily add authentication and authorization to your Go projects, feel free to check out Auth0's Go SDK and free plan at auth0.com/overview
write-article, read-log. It doesn't control the access to a specific article or log.resource.Owner can be used to get the attribute for a resource./res/*, /res/:id and HTTP methods like GET, POST, PUT, DELETE.In Casbin, an access control model is abstracted into a CONF file based on the PERM metamodel (Policy, Effect, Request, Matchers). So switching or upgrading the authorization mechanism for a project is just as simple as modifying a configuration. You can customize your own access control model by combining the available models. For example, you can get RBAC roles and ABAC attributes together inside one model and share one set of policy rules.
The most basic and simplest model in Casbin is ACL. ACL's model CONF is:
# Request definition [request_definition] r = sub, obj, act # Policy definition [policy_definition] p = sub, obj, act # Policy effect [policy_effect] e = some(where (p.eft == allow)) # Matchers [matchers] m = r.sub == p.sub && r.obj == p.obj && r.act == p.act
An example policy for ACL model is like:
p, alice, data1, read p, bob, data2, write
It means:
What Casbin does:
{subject, object, action} form or a customized form as you defined, both allow and deny authorizations are supported.root or administrator. A superuser can do anything without explict permissions.keyMatch can map a resource key /foo/bar to the pattern /foo*.What Casbin does NOT do:
username and password when a user logs in)go get github.com/casbin/casbin
See: Our Wiki
New a Casbin enforcer with a model file and a policy file:
e := casbin.NewEnforcer("path/to/model.conf", "path/to/policy.csv")
Note: you can also initialize an enforcer with policy in DB instead of file, see Persistence section for details.
Add an enforcement hook into your code right before the access happens:
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. if e.Enforce(sub, obj, act) == true { // permit alice to read data1 } else { // deny the request, show an error }
Besides the static policy file, Casbin also provides API for permission management at run-time. For example, You can get all the roles assigned to a user as below:
roles := e.GetRoles("alice")
See Policy management APIs for more usage.
_test.go files for more usage.Casbin provides two sets of APIs to manage permissions:
We also provide a web-based UI for model management and policy management:
In Casbin, the policy storage is implemented as an adapter (aka middleware for Casbin). To keep light-weight, we don't put adapter code in the main library. A complete list of Casbin adapters is provided as below. Any 3rd-party contribution on a new adapter is welcomed, please inform us and I will put it in this list:)
| Adapter | Type | Author | Description |
|---|---|---|---|
| File Adapter (built-in) | File | Casbin | Persistence for .CSV (Comma-Separated Values) files |
| Xorm Adapter | ORM | Casbin | MySQL, PostgreSQL, TiDB, SQLite, SQL Server, Oracle are supported by Xorm |
| Gorm Adapter | ORM | Casbin | MySQL, PostgreSQL, Sqlite3, SQL Server are supported by Gorm |
| Beego ORM Adapter | ORM | Casbin | MySQL, PostgreSQL, Sqlite3 are supported by Beego ORM |
| MongoDB Adapter | NoSQL | Casbin | Persistence for MongoDB |
| Cassandra Adapter | NoSQL | Casbin | Persistence for Apache Cassandra DB |
| Consul Adapter | KV store | @ankitm123 | Persistence for HashiCorp Consul |
| Redis Adapter | KV store | Casbin | Persistence for Redis |
| Protobuf Adapter | Stream | Casbin | Persistence for Google Protocol Buffers |
| RQLite Adapter | SQL | EDOMO Systems | Persistence for RQLite |
| PostgreSQL Adapter | SQL | Going | Persistence for PostgreSQL |
| RethinkDB Adapter | NoSQL | @adityapandey9 | Persistence for RethinkDB |
For details of adapters, please refer to the documentation: https://github.com/casbin/casbin/wiki/Policy-persistence
We support to use etcd to keep consistence between multiple Casbin enforcer instances. Please see: https://github.com/casbin/etcd-watcher
We support different implementations of a RBAC role manager. The currently supported adapters are:
| Role manager | Description |
|---|---|
| Default role manager | Supports role hierarchy |
| Session role manager | Supports role hierarchy, time-range-based sessions |
For developers: all role managers must implement the RoleManager interface.
To use a custom role manager implementation:
type myCustomRoleManager struct {} // assumes the type satisfies the RoleManager interface func newRoleManager() rbac.RoleManagerConstructor { return func() rbac.RoleManager { return &myCustomRoleManager{} } } e := casbin.NewEnforcer("path/to/model.conf", "path/to/policy.csv") e.SetRoleManager(newRoleManager())
If you use Casbin in a multi-threading manner, you can use the synchronized wrapper of the Casbin enforcer: https://github.com/casbin/casbin/blob/master/enforcer_synced.go.
It also supports the AutoLoad feature, which means the Casbin enforcer will automatically load the latest policy rules from DB if it has changed. Call StartAutoLoadPolicy() to start automatically loading policy periodically and call StopAutoLoadPolicy() to stop it.
The overhead of policy enforcement is benchmarked in model_b_test.go. The testbed is:
Intel(R) Core(TM) i7-6700HQ CPU @ 2.60GHz, 2601 Mhz, 4 Core(s), 8 Logical Processor(s)
The benchmarking result of go test -bench=. -benchmem is as follows (op = an Enforce() call, ms = millisecond, KB = kilo bytes):
| Test case | Size | Time overhead | Memory overhead |
|---|---|---|---|
| ACL | 2 rules (2 users) | 0.015493 ms/op | 5.649 KB |
| RBAC | 5 rules (2 users, 1 role) | 0.021738 ms/op | 7.522 KB |
| RBAC (small) | 1100 rules (1000 users, 100 roles) | 0.164309 ms/op | 80.620 KB |
| RBAC (medium) | 11000 rules (10000 users, 1000 roles) | 2.258262 ms/op | 765.152 KB |
| RBAC (large) | 110000 rules (100000 users, 10000 roles) | 23.916776 ms/op | 7.606 MB |
| RBAC with resource roles | 6 rules (2 users, 2 roles) | 0.021146 ms/op | 7.906 KB |
| RBAC with domains/tenants | 6 rules (2 users, 1 role, 2 domains) | 0.032696 ms/op | 10.755 KB |
| ABAC | 0 rule (0 user) | 0.007510 ms/op | 2.328 KB |
| RESTful | 5 rules (3 users) | 0.045398 ms/op | 91.774 KB |
| Deny-override | 6 rules (2 users, 1 role) | 0.023281 ms/op | 8.370 KB |
| Priority | 9 rules (2 users, 2 roles) | 0.016389 ms/op | 5.313 KB |
| Model | Model file | Policy file |
|---|---|---|
| ACL | basic_model.conf | basic_policy.csv |
| ACL with superuser | basic_model_with_root.conf | basic_policy.csv |
| ACL without users | basic_model_without_users.conf | basic_policy_without_users.csv |
| ACL without resources | basic_model_without_resources.conf | basic_policy_without_resources.csv |
| RBAC | rbac_model.conf | rbac_policy.csv |
| RBAC with resource roles | rbac_model_with_resource_roles.conf | rbac_policy_with_resource_roles.csv |
| RBAC with domains/tenants | rbac_model_with_domains.conf | rbac_policy_with_domains.csv |
| ABAC | abac_model.conf | N/A |
| RESTful | keymatch_model.conf | keymatch_policy.csv |
| Deny-override | rbac_model_with_deny.conf | rbac_policy_with_deny.csv |
| Priority | priority_model.conf | priority_policy.csv |
This project is licensed under the Apache 2.0 license.
If you have any issues or feature requests, please contact us. PR is welcomed.
