News: still worry about how to write the correct Casbin policy? Casbin online editor
is coming to help! Try it at: https://casbin.org/editor/
Casbin-RS is a powerful and efficient open-source access control library for Rust projects. It provides support for enforcing authorization based on various access control models.
![]() |
![]() |
![]() |
![]() |
---|---|---|---|
Casbin | jCasbin | node-Casbin | PHP-Casbin |
production-ready | production-ready | production-ready | production-ready |
![]() |
![]() |
![]() |
![]() |
---|---|---|---|
PyCasbin | Casbin.NET | Casbin-CPP | Casbin-RS |
production-ready | production-ready | production-ready | production-ready |
Add this package to Cargo.toml
of your project. (Check https://crates.io/crates/casbin for right version)
[dependencies]
casbin = { version = "2.4.0", default-features = false, features = ["runtime-async-std", "logging", "incremental"] }
tokio = { version = "1.10.0", features = ["fs", "io-util"] }
Warning: tokio v1.0
or later is supported from casbin v2.0.6
, we recommend that you upgrade the relevant components to ensure that they work properly. The last version that supports tokio v0.2
is casbin v2.0.5
, you can choose according to your needs.
use casbin::prelude::*;
#[tokio::main]
async fn main() -> Result<()> {
let mut e = Enforcer::new("examples/rbac_with_domains_model.conf", "examples/rbac_with_domains_policy.csv").await?;
e.enable_log(true);
e.enforce(("alice", "domain1", "data1", "read"))?;
Ok(())
}
Add an enforcement hook into your code right before the access happens:
let sub = "alice"; // the user that wants to access a resource.
let obj = "data1"; // the resource that is going to be accessed.
let act = "read"; // the operation that the user performs on the resource.
if let Ok(authorized) = e.enforce((sub, obj, act)) {
if authorized {
// permit alice to read data1
} else {
// deny the request
}
} else {
// error occurs
}
💡 Please note that the Enforcer instance is not thread-safe, so in order to use it
in a environment where multiple threads might access it, you have to protect it
using an RwLock like so: let e = Arc::new(RwLock::new(e));
.
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-rs, 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-rs 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-rs 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-rs does NOT do:
username
and password
when a user logs in)https://casbin.org/docs/overview
You can also use the online editor (http://casbin.org/editor/) to write your casbin-rs model and policy in your web browser. It provides functionality such as syntax highlighting
and code completion
, just like an IDE for a programming language.
https://casbin.org/docs/tutorials
casbin-rs provides two sets of APIs to manage permissions:
We also provide a web-based UI for model management and policy management:
https://casbin.org/docs/role-managers
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 |
Authz middlewares for web frameworks: https://casbin.org/docs/middlewares
https://casbin.org/docs/adopters
This project exists thanks to all the people who contribute.
Thank you to all our backers! 🙏 [Become a backer]
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]
This project is licensed under the Apache 2.0 license.
If you have any issues or feature requests, please contact us. PR is welcomed.