Repository files navigation

Documentation |Tutorials |Extensions

Breaking News:Laravel-authz is now available, an authorization library for the Laravel framework.

PHP-Casbin is a powerful and efficient open-source access control library for PHP projects. It provides support for enforcing authorization based on variousaccess 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

Require this package in thecomposer.json of your project. This will download the package:

composer require casbin/casbin

1. New a Casbin enforcer with a model file and a policy file:

require_once'./vendor/autoload.php';useCasbin\Enforcer;$e =newEnforcer("path/to/model.conf","path/to/policy.csv");

2. 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}

• Supported models
• How it works?
• Features
• Documentation
• Online editor
• Tutorials
• Policy management
• Policy persistence
• Role manager
• Examples
• Middlewares
• Our adopters

1. ACL (Access Control List)
2. ACL withsuperuser
3. ACL without users: especially useful for systems that don't have authentication or user log-ins.
4. 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.
5. RBAC (Role-Based Access Control)
6. RBAC with resource roles: both users and resources can have roles (or groups) at the same time.
7. RBAC with domains/tenants: users can have different role sets for different domains/tenants.
8. ABAC (Attribute-Based Access Control): syntax sugar likeresource.Owner can be used to get the attribute for a resource.
9. RESTful: supports paths like/res/*,/res/:id and HTTP methods likeGET,POST,PUT,DELETE.
10. Deny-override: both allow and deny authorizations are supported, deny overrides the allow.
11. Priority: the policy rules can be prioritized like firewall rules.

In php-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 php-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, readp, bob, data2, write

It means:

• alice can read data1
• bob can write data2

What php-casbin does:

1. enforce the policy in the classic{subject, object, action} form or a customized form as you defined, both allow and deny authorizations are supported.
2. handle the storage of the access control model and its policy.
3. manage the role-user mappings and role-role mappings (aka role hierarchy in RBAC).
4. support built-in superuser likeroot oradministrator. A superuser can do anything without explict permissions.
5. multiple built-in operators to support the rule matching. For example,keyMatch can map a resource key/foo/bar to the pattern/foo*.

What php-casbin does NOT do:

1. authentication (aka verifyusername andpassword when a user logs in)
2. 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 php-casbin is not designed as a password container. However, php-casbin stores the user-role mapping for the RBAC scenario.

https://casbin.org/docs/en/overview

You can also use the online editor (http://casbin.org/editor/) to write your php-casbin model and policy in your web browser. It provides functionality such assyntax highlighting andcode completion, just like an IDE for a programming language.

https://casbin.org/docs/tutorials

php-casbin provides two sets of APIs to manage permissions:

• Management API: the primitive API that provides full support for php-casbin policy management.
• 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.

https://casbin.org/docs/en/adapters

https://casbin.org/docs/en/role-managers

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 theApache 2.0 license.

If you have any issues or feature requests, please contact us. PR is welcomed.

• https://github.com/php-casbin/php-casbin/issues
• techlee@qq.com
• Tencent QQ group:546057381