README

easy-rbac-sync

~~Promise based~~ HRBAC (Hierarchical Role Based Access Control) implementation for Node.js

Installation

npm install easy-rbac-sync

Test

npm test

Initialization

Require or import and create rbac object.

import RBAC from 'easy-rbac-sync'
// const {default: RBAC} = require('easy-rbac-sync');
const rbac = new RBAC(opts);

Or use create function

const rbac = require('easy-rbac-sync').create(opts);

Options

Options for RBAC are an object.

The expected configuration object example:

{
  user: { // Role name
    can: [ // list of allowed operations
      'account',
      'post:add',
      {
          name: 'post:save',
          when: (params) => params.userId === params.ownerId
      },
      'user:create',
      {
        name: 'user:*',
        when: (params) => params.id === params.userId
      }
    ]
  },
  manager: {
    can: ['post:save', 'post:delete', 'account:*'],
    inherits: ['user']
  },
  admin: {
    can: ['rule the server'],
    inherits: ['manager']
  }
}

The roles property is required and must be an object. The keys of this object are counted to be the names of roles.

Each role must have a can property, which is an array. Elements in the array can be strings or objects.

If the element is a string then it is expected to be the name of the permitted operation.

If the element is an object:

It must have the name and when properties
- name property must be a string
- when property must be a function that returns a promise

Wildcards (v3.1+)

Each name of operation can include * character as a wildcard match. It will match anything in its stead. So something like account:* will match everything starting with account:.

Specific operations are always prioritized over wildcard operations. This means that if you have a definition like:

{
  user: {
    can: [
      'user:create',
      {
        name: 'user:*',
        when: (params) => params.id === params.userId
      }
    ]
  }
}

Then user:create will not run the provided when operation, whereas everything else starting with user: does

Usage can(role, operation, params?)

After initialization you can use the can function of the object to check if role should have access to an operation.

The function will return a Promise that will resolve if the role can access the operation or reject if something goes wrong or the user is not allowed to access.

const answer = rbac.can('user', 'post:add')
// true | false

The function accepts parameters as the third parameter, it will be used if there is a when type operation in the validation hierarchy.

const answer = rbac.can('user', 'post:save', {userId: 1, ownerId: 2})
// true | false

You can also validate multiple roles at the same time, by providing an array of roles.

const answer = rbac.can(['user', 'manager'], 'post:save', {userId: 1, ownerId: 2})
// true | false

License

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.

Usage no npm install needed!