https://github.com/node-casbin/sequelize-adapter
Sequelize adapter for Casbin
https://github.com/node-casbin/sequelize-adapter
abac access-control acl adapter auth authorization authz casbin node-casbin orm rbac sequelize
Last synced: 3 months ago
JSON representation
Sequelize adapter for Casbin
- Host: GitHub
- URL: https://github.com/node-casbin/sequelize-adapter
- Owner: node-casbin
- License: apache-2.0
- Created: 2018-08-17T04:52:02.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-12-09T08:22:28.000Z (over 1 year ago)
- Last Synced: 2025-03-30T08:11:32.348Z (4 months ago)
- Topics: abac, access-control, acl, adapter, auth, authorization, authz, casbin, node-casbin, orm, rbac, sequelize
- Language: TypeScript
- Homepage: https://github.com/casbin/node-casbin
- Size: 1.36 MB
- Stars: 64
- Watchers: 3
- Forks: 34
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sequelize Adapter
[![NPM version][npm-image]][npm-url]
[![NPM download][download-image]][download-url]
[](https://codebeat.co/projects/github-com-node-casbin-sequelize-adapter-master)
[](https://github.com/node-casbin/sequelize-adapter/actions/workflows/ci.yml)
[](https://coveralls.io/github/node-casbin/sequelize-adapter?branch=master)
[](https://discord.gg/S5UjpzGZjN)
[npm-image]: https://img.shields.io/npm/v/casbin-sequelize-adapter.svg?style=flat-square
[npm-url]: https://npmjs.org/package/casbin-sequelize-adapter
[download-image]: https://img.shields.io/npm/dm/casbin-sequelize-adapter.svg?style=flat-square
[download-url]: https://npmjs.org/package/casbin-sequelize-adapter
Sequelize Adapter is the [Sequelize](https://github.com/sequelize/sequelize) adapter for [Node-Casbin](https://github.com/casbin/node-casbin). With this library, Node-Casbin can load policy from Sequelize supported database or save policy to it.
Based on [Officially Supported Databases](http://docs.sequelizejs.com/), the current supported databases are:
- PostgreSQL
- MySQL
- SQLite
- MSSQL
You may find other 3rd-party supported DBs in Sequelize website or other places.
## Installation
NPM Install
```bash
npm install casbin-sequelize-adapter --save
```
Yarn Install
```bash
yarn add casbin-sequelize-adapter
```
## Testing Locally
Start mysql for tests:
```bash
docker compose up -d
```
```bash
yarn test
```
## Simple Example
```typescript
import casbin from 'casbin';
import { SequelizeAdapter } from 'casbin-sequelize-adapter';
async function myFunction() {
// Initialize a Sequelize adapter and use it in a Node-Casbin enforcer:
// The adapter can not automatically create database.
// But the adapter will automatically and use the table named "casbin_rule".
// The second boolean argument: autoCreateTable determines whether the adapter will automatically create the "casbin_rule" table.
// ORM should not create databases automatically.
const a = await SequelizeAdapter.newAdapter(
{
username: 'root',
password: '',
database: 'casbin',
dialect: 'mysql',
},
true,
);
const e = await casbin.newEnforcer('examples/rbac_model.conf', a);
// Check the permission.
e.enforce('alice', 'data1', 'read');
// Modify the policy.
// await e.addPolicy(...);
// await e.removePolicy(...);
// Save the policy back to DB.
await e.savePolicy();
}
```
## Getting Help
- [Node-Casbin](https://github.com/casbin/node-casbin)
## License
This project is under Apache 2.0 License. See the [LICENSE](LICENSE) file for the full license text.