| # Node-Casbin |
| |
| [![NPM version][npm-image]][npm-url] |
| [![NPM download][download-image]][download-url] |
| [](https://packagephobia.now.sh/result?p=casbin) |
| [](https://codebeat.co/projects/github-com-casbin-node-casbin-master) |
| [](https://github.com/casbin/node-casbin/actions) |
| [](https://coveralls.io/github/casbin/node-casbin?branch=master) |
| [](https://github.com/casbin/node-casbin/releases/latest) |
| [](https://gitter.im/casbin/lobby) |
| |
| [npm-image]: https://img.shields.io/npm/v/casbin.svg?style=flat-square |
| [npm-url]: https://npmjs.org/package/casbin |
| [download-image]: https://img.shields.io/npm/dm/casbin.svg?style=flat-square |
| [download-url]: https://npmjs.org/package/casbin |
| |
| 💖 [**Looking for an open-source identity and access management solution like Okta, Auth0, Keycloak ? Learn more about: Casdoor**](https://casdoor.org/) |
| |
| <a href="https://casdoor.org/"><img src="https://user-images.githubusercontent.com/3787410/147868267-6ac74908-5654-4f9c-ac79-8852af9ff925.png" alt="casdoor" style="width: 50%; height: 50%"/></a> |
| |
| **News**: still worry about how to write the correct `node-casbin` policy? [Casbin online editor](http://casbin.org/en/editor) is coming to help! |
| |
|  |
| |
| `node-casbin` is a powerful and efficient open-source access control library for Node.JS projects. It provides support for enforcing authorization based on various [access control models](https://en.wikipedia.org/wiki/Computer_security_model). |
| |
| ## All the languages supported by Casbin: |
| |
| | [](https://github.com/casbin/casbin) | [](https://github.com/casbin/jcasbin) | [](https://github.com/casbin/node-casbin) | [](https://github.com/php-casbin/php-casbin) | |
| | -------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | |
| | [Casbin](https://github.com/casbin/casbin) | [jCasbin](https://github.com/casbin/jcasbin) | [node-Casbin](https://github.com/casbin/node-casbin) | [PHP-Casbin](https://github.com/php-casbin/php-casbin) | |
| | production-ready | production-ready | production-ready | production-ready | |
| |
| | [](https://github.com/casbin/pycasbin) | [](https://github.com/casbin-net/Casbin.NET) | [](https://github.com/casbin/casbin-cpp) | [](https://github.com/casbin/casbin-rs) | |
| | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------- | |
| | [PyCasbin](https://github.com/casbin/pycasbin) | [Casbin.NET](https://github.com/casbin-net/Casbin.NET) | [Casbin-CPP](https://github.com/casbin/casbin-cpp) | [Casbin-RS](https://github.com/casbin/casbin-rs) | |
| | production-ready | production-ready | beta-test | production-ready | |
| |
| ## Documentation |
| |
| https://casbin.org/docs/en/overview |
| |
| ## Feature |
| |
| - 😎 Written in TypeScript to provide the type definitions |
| - 🎯 Support multiple access model such as ACL, RBAC, ABAC |
| - 🎮 Run everywhere on JavaScript platforms such as WEB, Node.js, React-Native, Electron, etc. |
| |
| ## Installation |
| |
| ```shell script |
| # NPM |
| npm install casbin@beta --save |
| |
| # Yarn |
| yarn add casbin@beta |
| ``` |
| |
| ## Get started |
| |
| New an enforcer with a model string and a memory policy, see [Model](#official-model) section for details: |
| |
| ```typescript |
| import { newEnforcer, newModel, MemoryAdapter } from 'casbin'; |
| |
| const model = newModel(` |
| [request_definition] |
| r = sub, obj, act |
| [policy_definition] |
| p = sub, obj, act |
| [role_definition] |
| g = _, _ |
| [policy_effect] |
| e = some(where (p.eft == allow)) |
| [matchers] |
| m = g(r.sub, p.sub) && r.obj == p.obj && r.act == p.act |
| `); |
| |
| const adapter = new MemoryAdapter(` |
| p, alice, data1, read |
| p, bob, data2, write |
| p, data2_admin, data2, read |
| p, data2_admin, data2, write |
| g, alice, data2_admin |
| `); |
| |
| const enforcer = await newEnforcer(model, adapter); |
| ``` |
| |
| > **Note**: you can also initialize an enforcer with policy in DB instead of file, see [Persistence](#policy-persistence) section for details. |
| |
| Add an enforcement hook into your code right before the access happens: |
| |
| ```typescript |
| const sub = 'alice'; // the user that wants to access a resource. |
| const obj = 'data1'; // the resource that is going to be accessed. |
| const act = 'read'; // the operation that the user performs on the resource. |
| |
| // Async: |
| const res = await enforcer.enforce(sub, obj, act); |
| // Sync: |
| // const res = enforcer.enforceSync(sub, obj, act); |
| |
| if (res) { |
| // permit alice to read data1 |
| } else { |
| // deny the request, show an error |
| } |
| ``` |
| |
| Besides the static policy file, `node-casbin` also provides API for permission management at run-time. |
| For example, You can get all the roles assigned to a user as below: |
| |
| ```typescript |
| const roles = await enforcer.getRolesForUser('alice'); |
| ``` |
| |
| See [Policy management APIs](#policy-management) for more usage. |
| |
| ## Policy management |
| |
| Casbin provides two sets of APIs to manage permissions: |
| |
| - [Management API](https://casbin.org/docs/en/management-api): the primitive API that provides full support for Casbin policy management. |
| - [RBAC API](https://casbin.org/docs/en/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. |
| |
| ## Official Model |
| |
| https://casbin.org/docs/en/supported-models |
| |
| ## Policy persistence |
| |
| https://casbin.org/docs/en/adapters |
| |
| ## Policy consistence between multiple nodes |
| |
| https://casbin.org/docs/en/watchers |
| |
| ## Role manager |
| |
| https://casbin.org/docs/en/role-managers |
| |
| ## Contributors |
| |
| This project exists thanks to all the people who contribute. |
| <a href="https://github.com/casbin/node-casbin/graphs/contributors"><img src="https://opencollective.com/node-casbin/contributors.svg?width=890&button=false" /></a> |
| |
| ## Backers |
| |
| Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/casbin#backer)] |
| |
| <a href="https://opencollective.com/casbin#backers" target="_blank"><img src="https://opencollective.com/casbin/backers.svg?width=890"></a> |
| |
| ## Sponsors |
| |
| Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/casbin#sponsor)] |
| |
| <a href="https://opencollective.com/casbin/sponsor/0/website" target="_blank"><img src="https://opencollective.com/casbin/sponsor/0/avatar.svg"></a> |
| <a href="https://opencollective.com/casbin/sponsor/1/website" target="_blank"><img src="https://opencollective.com/casbin/sponsor/1/avatar.svg"></a> |
| <a href="https://opencollective.com/casbin/sponsor/2/website" target="_blank"><img src="https://opencollective.com/casbin/sponsor/2/avatar.svg"></a> |
| <a href="https://opencollective.com/casbin/sponsor/3/website" target="_blank"><img src="https://opencollective.com/casbin/sponsor/3/avatar.svg"></a> |
| <a href="https://opencollective.com/casbin/sponsor/4/website" target="_blank"><img src="https://opencollective.com/casbin/sponsor/4/avatar.svg"></a> |
| <a href="https://opencollective.com/casbin/sponsor/5/website" target="_blank"><img src="https://opencollective.com/casbin/sponsor/5/avatar.svg"></a> |
| <a href="https://opencollective.com/casbin/sponsor/6/website" target="_blank"><img src="https://opencollective.com/casbin/sponsor/6/avatar.svg"></a> |
| <a href="https://opencollective.com/casbin/sponsor/7/website" target="_blank"><img src="https://opencollective.com/casbin/sponsor/7/avatar.svg"></a> |
| <a href="https://opencollective.com/casbin/sponsor/8/website" target="_blank"><img src="https://opencollective.com/casbin/sponsor/8/avatar.svg"></a> |
| <a href="https://opencollective.com/casbin/sponsor/9/website" target="_blank"><img src="https://opencollective.com/casbin/sponsor/9/avatar.svg"></a> |
| |
| ## License |
| |
| This project is licensed under the [Apache 2.0 license](LICENSE). |
| |
| ## Contact |
| |
| If you have any issues or feature requests, please contact us. PR is welcomed. |
| |
| - https://github.com/casbin/node-casbin/issues |
| - hsluoyz@gmail.com |
| - Tencent QQ group: [546057381](//shang.qq.com/wpa/qunwpa?idkey=8ac8b91fc97ace3d383d0035f7aa06f7d670fd8e8d4837347354a31c18fac885) |
