https://github.com/zweifisch/permitted
role & permission control
https://github.com/zweifisch/permitted
Last synced: about 2 months ago
JSON representation
role & permission control
- Host: GitHub
- URL: https://github.com/zweifisch/permitted
- Owner: zweifisch
- Created: 2015-08-01T01:45:07.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2017-09-23T05:45:42.000Z (over 7 years ago)
- Last Synced: 2025-02-28T17:53:53.195Z (3 months ago)
- Language: JavaScript
- Size: 8.79 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# permitted
[![NPM Version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
role based access control
## usage
```js
import {User, Policy} from 'permitted'
let policy = new Policy({
article: {
read: ['user', 'editor'],
write: 'editor'
},
user: {
manage: 'admin'
}
})
let user = new User('admin', policy)
user.can('read', 'article') // false
user.can('manage', 'user') // true
user.is('admin') // true
```
### role inheritance
```js
import {User, Policy} from 'permitted'
let hierachy = {
admin: ['user', 'editor'],
editor: 'user'
}
let policy = {
article: {
read: 'user',
write: 'editor'
},
issue: {
report: ['user', '!admin']
}
}
let user = new User('admin', new Policy(policy, hierarchy))
user.is('editor') // true
user.can('read', 'article') // true
user.can('report', 'issue') // false
```
### the root role
root can do anything
```js
let root = new User('root', new Policy(policy, hierarchy))
```
to specify another role other than `root`, provide a third params to Policy consturctor
```js
new Policy(policy, hierarchy, 'admin')
```
### attach extra data to user object
```js
let user = new User(['role', 'elor'], policy, {id: req.session.id})
console.log(user.id)
```
## koa middleware
```js
import {User, Policy, can} from permitted
app.use((ctx, next) => {
req.user = new User(req.session.roles, new Policy(policy, hierachy))
next()
})
app.get('/articles/:id', can('read', 'article'), ctx => {
// ...
})
```
[npm-image]: https://img.shields.io/npm/v/permitted.svg?style=flat
[npm-url]: https://npmjs.org/package/permitted
[travis-image]: https://img.shields.io/travis/zweifisch/permitted.svg?style=flat
[travis-url]: https://travis-ci.org/zweifisch/permitted