https://github.com/clayrisser/role-based-access-control
unopinionated role based access control
https://github.com/clayrisser/role-based-access-control
access-control node nodejs rbac rbac-management role-based-access-control
Last synced: 5 months ago
JSON representation
unopinionated role based access control
- Host: GitHub
- URL: https://github.com/clayrisser/role-based-access-control
- Owner: clayrisser
- License: mit
- Created: 2018-11-25T01:43:05.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2023-07-13T05:26:08.000Z (almost 3 years ago)
- Last Synced: 2025-10-05T06:09:45.410Z (8 months ago)
- Topics: access-control, node, nodejs, rbac, rbac-management, role-based-access-control
- Language: TypeScript
- Size: 512 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# role-based-access-control
[](https://www.npmjs.com/package/role-based-access-control)
[](https://www.npmjs.com/package/role-based-access-control)
[](https://www.npmjs.com/package/role-based-access-control)
[](https://github.com/codejamninja/role-based-access-control)
> unopinionated role based access control
Please ★ this repo if you found it useful ★ ★ ★
## Features
* unopinionated
* supports multiple roles
* supports custom policies
## Installation
```sh
npm install --save role-based-access-control
```
## Dependencies
* [NodeJS](https://nodejs.org)
## Usage
Import `role-based-access-control`
```js
import { Policy, Role, Statement, Subject } from 'role-based-access-control';
```
Create statements
```js
const statements = {
readFile: new Statement('read', 'file'),
readFolder: new Statement('read', 'folder'),
removeFile: new Statement('remove', 'file'),
removeFolder: new Statement('remove', 'folder'),
writeFile: new Statement('write', 'file'),
writeFolder: new Statement('write', 'folder')
};
```
Create policies from statements
```js
const policies = {
readFile: new Policy('readFile', [statements.readFile]),
readFolder: new Policy('readFolder', [statements.readFolder]),
removeFile: new Policy('removeFile', [statements.removeFile]),
removeFolder: new Policy('removeFolder', [statements.removeFolder]),
writeFile: new Policy('readFile', [statements.writeFile]),
writeFolder: new Policy('readFolder', [statements.writeFolder]),
readAll: new Policy('readAll', [statements.readFile, statements.readFolder]),
removeAll: new Policy('removeAll', [
statements.removeFile,
statements.removeFolder
]),
writeAll: new Policy('readAll', [
statements.writeFile,
statements.writeFolder
]),
allFiles: new Policy('allFiles', [
statements.readFile,
statements.writeFile,
statements.removeFile
]),
allFolders: new Policy('allFolders', [
statements.readFolder,
statements.writeFolder,
statements.removeFolder
])
};
```
Create roles from policies
```js
const roles = {
visitor: new Role('visitor', [policies.readAll]),
user: new Role('user', [policies.readAll, policies.writeAll]),
admin: new Role('admin', [policies.allFiles, policies.allFolders])
};
```
Assign roles to subjects
```js
const someVisitor = new Subject('someVisitor', [roles.visitor]);
const someAdmin = new Subject('someVisitor', [roles.admin]);
```
Check if subject can execute statement
```js
someVisitor.can(statements.readFile); // true
someVisitor.can(statements.deleteFile); // false
someAdmin.can(statements.readFile); // true
someAdmin.can(statements.deleteFile); // true
```
## Support
Submit an [issue](https://github.com/codejamninja/role-based-access-control/issues/new)
## Roadmap
* Support role inheritance
* Support blocking statements
* Support resource ownership
* Support role tagging
## Contributing
Review the [guidelines for contributing](https://github.com/codejamninja/role-based-access-control/blob/master/CONTRIBUTING.md)
## License
[MIT License](https://github.com/codejamninja/role-based-access-control/blob/master/LICENSE)
[Jam Risser](https://codejam.ninja) © 2018
## Changelog
Review the [changelog](https://github.com/codejamninja/role-based-access-control/blob/master/CHANGELOG.md)
## Credits
* [Jam Risser](https://codejam.ninja) - Author
## Support on Liberapay
A ridiculous amount of coffee ☕ ☕ ☕ was consumed in the process of building this project.
[Add some fuel](https://liberapay.com/codejamninja/donate) if you'd like to keep me going!
[](https://liberapay.com/codejamninja/donate)
[](https://liberapay.com/codejamninja/donate)