https://github.com/bredele/robac
Role based access control
https://github.com/bredele/robac
access control jsonwebtoken role
Last synced: over 1 year ago
JSON representation
Role based access control
- Host: GitHub
- URL: https://github.com/bredele/robac
- Owner: bredele
- License: mit
- Created: 2019-02-28T18:55:12.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-03-07T17:17:59.000Z (over 7 years ago)
- Last Synced: 2025-03-27T01:23:51.586Z (over 1 year ago)
- Topics: access, control, jsonwebtoken, role
- Language: JavaScript
- Size: 24.4 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Robac
> [](https://travis-ci.org/bredele/robac)
[](https://www.npmjs.com/package/robac)
[](http://npm-stat.com/charts.html?package=robac)
[](https://github.com/bredele/contributing-guide/blob/master/community.md)
**Ro**les **ba**sed **a**ccess **c**ontrol for HTTP servers using JWT authorization.
## Example
This module look for `roles.json` files in a given folder and returns a middleware that indicates if the access to a requested URL is forbidden or not. Access is given only if one or multiple `roles` within a JSON Web Token match the `roles` specified in the JSON file.
```js
const http = require('http')
const roles = require('robac')
// parse folder, look for roles.json files with roles field and
// create roles based access control.
const handler = roles(__dirname, 'jwtsecret')
http.createServer((req, res) => {
handler(req, (err) => {
if (err) {
// not authorized
} else {
// serve page when authorized
}
})
})
```
Check out [an example](./test/example.js)
## Installation
```shell
npm install robac --save
```
[](https://nodei.co/npm/robac/)
## Question
For questions and feedback please use our [twitter account](https://twitter.com/bredeleca). For support, bug reports and or feature requests please make sure to read our
community guideline and use the issue list of this repo and make sure it's not present yet in our reporting checklist.
## Contribution
Robac is an open source project and would not exist without its community. If you want to participate please make sure to read our guideline before making a pull request. If you have any robac related project, component or other let everyone know in our wiki.
## License
The MIT License (MIT)
Copyright (c) 2016 Olivier Wietrich
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.