casedy / feathers-permissions

Advanced permission handling for Feathers services

feathers-permissions

Flexible and powerful permissions module for Feathers

This module is not published yet. It's awaiting one more breaking change and then will go out. If you are feeling adventurous you can use by referencing feathersjs/feathers-permission in your package.json.

Installation

npm install feathers-permissions --save

Documentation

Feathers permissions allows you to grant and manage permissions in a flexible nature. Each object that requires permissions must have an array or a comma separated string of permissions stored on it (typically in your database). It typically goes hand in hand with feathers-authentication.

Usage With Feathers + Feathers Authentication

Here's an example of a Feathers server that uses feathers-permissions.

// app
const feathers = require('feathers');
const rest = require('feathers-rest');
const hooks = require('feathers-hooks');
const bodyParser = require('body-parser');
const errorHandler = require('feathers-errors/handler');
const hooks = require('feathers-permissions').hooks;
const middleware = require('feathers-permissions').middleware;
const memory = require('feathers-memory');

// Initialize the application
const app = feathers()
  .configure(rest())
  .configure(hooks())
  // Needed for parsing bodies (login)
  .use(bodyParser.json())
  .use(bodyParser.urlencoded({ extended: true }))
  // Initialize your feathers plugin
  .use('/users', memory())
  .use(errorHandler());

app.service('users').before({

});

app.listen(3030);

console.log('Feathers app started on 127.0.0.1:3030');

Usage With Feathers + Passport

Usage With Express + Passport

This is assuming you are not using sockets.

// app
const express = require('express');
const bodyParser = require('body-parser');
const errorHandler = require('feathers-errors/handler');
const notFound = require('feathers-errors/not-found');
const middleware = require('feathers-permissions').middleware;
const passport = require('passport');
const local = require('passport-local');

// Initialize the application
const app = express()
  // Needed for parsing bodies (login)
  .use(bodyParser.json())
  .use(bodyParser.urlencoded({ extended: true }));

app.get('login', (req, res, next) => {

});

app.post('login', (req, res, next) => {

});

const options = {
    permissions: ['admin', 'superadmin'],
    on: 'user',
    field: 'role'
};

app.get('/protected', middleware.checkPermissions(options), middleware.isPermitted, (req, res, next) => {
    
});

app.use(notFound());
app.use(errorHandler());

app.listen(3030);

console.log('Express app started on 127.0.0.1:3030');

License

Copyright (c) 2016

Licensed under the MIT license.