Package: casbin
PyCasbinSponsored byBuild auth with fraud prevention, faster.Try Stytch for API-first authentication, user & org management, multi-tenant SSO, MFA, device fingerprinting, and more.💖Looking for an open-source identity and access management solution like Okta, Auth0, Keycloak ? Learn more about: CasdoorNews: 🔥 How to use it withDjango? TryDjango Authorization, an authorization library forDjangoframework.News: Async is now supported by Pycasbin >= 1.23.0!News: still worry about how to write the correct Casbin policy?Casbin online editoris 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 variousaccess control models.All the languages supported by Casbin:CasbinjCasbinnode-CasbinPHP-Casbinproduction-readyproduction-readyproduction-readyproduction-readyPyCasbinCasbin.NETCasbin-CPPCasbin-RSproduction-readyproduction-readybeta-testproduction-readyTable of contentsSupported modelsHow it works?FeaturesInstallationDocumentationOnline editorTutorialsGet startedPolicy managementPolicy persistenceRole managerAsync EnforcerBenchmarksExamplesMiddlewaresOur adoptersSupported modelsACL (Access Control List)ACL withsuperuserACL without users: especially useful for systems that don't have authentication or user log-ins.ACL without resources: some scenarios may target for a type of resources instead of an individual resource by using permissions likewrite-article,read-log. It doesn't control the access to a specific article or log.RBAC (Role-Based Access Control)RBAC with resource roles: both users and resources can have roles (or groups) at the same time.RBAC with domains/tenants: users can have different role sets for different domains/tenants.ABAC (Attribute-Based Access Control): syntax sugar likeresource.Ownercan be used to get the attribute for a resource.RESTful: supports paths like/res/*,/res/:idand HTTP methods likeGET,POST,PUT,DELETE.Deny-override: both allow and deny authorizations are supported, deny overrides the allow.Priority: the policy rules can be prioritized like firewall rules.How it works?In Casbin, an access control model is abstracted into a CONF file based on thePERM 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.actAn example policy for ACL model is like:p, alice, data1, read
p, bob, data2, writeIt means:alice can read data1bob can write data2We also support multi-line mode by appending '\'  in the end:# Matchers[matchers]m=r.sub == p.sub && r.obj == p.obj\&& r.act == p.actFurther more, if you are using ABAC,  you can try operatorinlike following in Casbingolangedition (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 youSHOULDmake sure that the length of the array isMOREthan1, otherwise there will cause it to panic.For more operators, you may take a look atgovaluateFeaturesWhat Casbin does:enforce the policy in the classic{subject, object, action}form or a customized form as you defined, both allow and deny authorizations are supported.handle the storage of the access control model and its policy.manage the role-user mappings and role-role mappings (aka role hierarchy in RBAC).support built-in superuser likerootoradministrator. A superuser can do anything without explict permissions.multiple built-in operators to support the rule matching. For example,keyMatchcan map a resource key/foo/barto the pattern/foo*.What Casbin does NOT do:authentication (aka verifyusernameandpasswordwhen a user logs in)manage the list of users or roles. I believe it's more convenient for the project itself to manage these entities. Users usually have their passwords, and Casbin is not designed as a password container. However, Casbin stores the user-role mapping for the RBAC scenario.Installationpip install casbinDocumentationhttps://casbin.org/docs/overviewOnline editorYou 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 assyntax highlightingandcode completion, just like an IDE for a programming language.Tutorialshttps://casbin.org/docs/tutorialsGet startedNew a Casbin enforcer with a model file and a policy file:importcasbine=casbin.Enforcer("path/to/model.conf","path/to/policy.csv")Note: you can also initialize an enforcer with policy in DB instead of file, seePolicy persistencesection 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.ife.enforce(sub,obj,act):# permit alice to read data1passelse:# deny the request, show an errorpassBesides 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.get_roles_for_user("alice")SeePolicy management APIsfor more usage.Please refer to thetestsfiles for more usage.Policy managementCasbin provides two sets of APIs to manage permissions:Management API: the primitive API that provides full support for Casbin policy management. Seeherefor examples.RBAC API: a more friendly API for RBAC. This API is a subset of Management API. The RBAC users could use this API to simplify the code. Seeherefor examples.We also provide a web-based UI for model management and policy management:Policy persistencehttps://casbin.org/docs/adaptersRole managerhttps://casbin.org/docs/role-managersAsync EnforcerIf your code useasync/awaitand is heavily dependent on I/O operations, you can adopt Async Enforcer!Create an async engine and new a Casbin AsyncEnforcer with a model file and an async Pycasbin adapter (AsyncAdapter subclass):importasyncioimportosimportcasbinfromsqlalchemy.ext.asyncioimportcreate_async_engine,AsyncSessionfromsqlalchemy.ormimportsessionmakerfromcasbin_async_sqlalchemy_adapterimportAdapter,CasbinRuleasyncdefget_enforcer():engine=create_async_engine("sqlite+aiosqlite://",future=True)adapter=Adapter(engine)awaitadapter.create_table()async_session=sessionmaker(engine,expire_on_commit=False,class_=AsyncSession)asyncwithasync_session()ass: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"))awaits.commit()e=casbin.AsyncEnforcer("path/to/model.conf",adapter)awaite.load_policy()returneNote: you can see all supported adapters inAdapters | Casbin.Built-in async adapters are available incasbin.persist.adapters.asyncio.Add an enforcement hook into your code right before the access happens:asyncdefmain():e=awaitget_enforcer()ife.enforce("alice","data1","read"):print("alice can read data1")else:print("alice can not read data1")Run the code:asyncio.run(main())Please refer to thetestsfiles for more usage.Benchmarkshttps://casbin.org/docs/benchmarkExamplesModelModel filePolicy fileACLbasic_model.confbasic_policy.csvACL with superuserbasic_model_with_root.confbasic_policy.csvACL without usersbasic_model_without_users.confbasic_policy_without_users.csvACL without resourcesbasic_model_without_resources.confbasic_policy_without_resources.csvRBACrbac_model.confrbac_policy.csvRBAC with resource rolesrbac_model_with_resource_roles.confrbac_policy_with_resource_roles.csvRBAC with domains/tenantsrbac_model_with_domains.confrbac_policy_with_domains.csvABACabac_model.confN/ARESTfulkeymatch_model.confkeymatch_policy.csvDeny-overriderbac_model_with_deny.confrbac_policy_with_deny.csvPrioritypriority_model.confpriority_policy.csvMiddlewaresAuthz middlewares for web frameworks:https://casbin.org/docs/middlewaresOur adoptershttps://casbin.org/docs/adoptersContributorsThis project exists thanks to all the people who contribute.BackersThank you to all our backers! 🙏 [Become a backer]SponsorsSupport this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]LicenseThis project is licensed under theApache 2.0 license.ContactIf you have any issues or feature requests, please contact us. PR is welcomed.https://github.com/casbin/pycasbin/issuestechlee@qq.comTencent QQ group:546057381