An authorization library that supports access control models like ACL, RBAC, ABAC in Python
Sponsored by
Build auth with fraud prevention, faster.
Try Stytch for API-first authentication, user & org management, multi-tenant SSO, MFA, device fingerprinting, and more.
News: 🔥 How to use it with Django
? Try Django Authorization, an authorization library for Django
framework.
News: Async is now supported by Pycasbin >= 1.23.0!
News: still worry about how to write the correct Casbin policy? Casbin online editor
is coming to help! Try it at: http://casbin.org/editor/
Casbin is a powerful and efficient open-source access control library for Python 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 | beta-test | production-ready |
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:
We also support multi-line mode by appending '\' in the end:
# Matchers
[matchers]
m = r.sub == p.sub && r.obj == p.obj \
&& r.act == p.act
Further more, if you are using ABAC, you can try operator in
like following in Casbin golang edition (jCasbin and Node-Casbin are not supported yet):
# Matchers
[matchers]
m = r.obj == p.obj && r.act == p.act || r.obj in ('data2', 'data3')
But you SHOULD make sure that the length of the array is MORE than 1, otherwise there will cause it to panic.
For more operators, you may take a look at govaluate
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)pip install casbin
https://casbin.org/docs/overview
You can also use the online editor (http://casbin.org/editor/) to write your Casbin 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
import casbin
e = casbin.Enforcer("path/to/model.conf", "path/to/policy.csv")
Note: you can also initialize an enforcer with policy in DB instead of file, see Policy persistence section for details.
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):
# permit alice to read data1
pass
else:
# deny the request, show an error
pass
roles = e.get_roles_for_user("alice")
See Policy management APIs for more usage.
tests
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:
https://casbin.org/docs/adapters
https://casbin.org/docs/role-managers
If your code use async
/ await
and is heavily dependent on I/O operations, you can adopt Async Enforcer!
import asyncio
import os
import casbin
from sqlalchemy.ext.asyncio import create_async_engine, AsyncSession
from sqlalchemy.orm import sessionmaker
from casbin_async_sqlalchemy_adapter import Adapter, CasbinRule
async def get_enforcer():
engine = create_async_engine("sqlite+aiosqlite://", future=True)
adapter = Adapter(engine)
await adapter.create_table()
async_session = sessionmaker(engine, expire_on_commit=False, class_=AsyncSession)
async with async_session() as s:
s.add(CasbinRule(ptype="p", v0="alice", v1="data1", v2="read"))
s.add(CasbinRule(ptype="p", v0="bob", v1="data2", v2="write"))
s.add(CasbinRule(ptype="p", v0="data2_admin", v1="data2", v2="read"))
s.add(CasbinRule(ptype="p", v0="data2_admin", v1="data2", v2="write"))
s.add(CasbinRule(ptype="g", v0="alice", v1="data2_admin"))
await s.commit()
e = casbin.AsyncEnforcer("path/to/model.conf", adapter)
await e.load_policy()
return e
Note: you can see all supported adapters in Adapters | Casbin.
Built-in async adapters are available in casbin.persist.adapters.asyncio
.
async def main():
e = await get_enforcer()
if e.enforce("alice", "data1", "read"):
print("alice can read data1")
else:
print("alice can not read data1")
asyncio.run(main())
tests
files for more usage.https://casbin.org/docs/benchmark
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.