JSPM

trollbridge

0.1.3
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 116
  • Score
    100M100P100Q72034F
  • License MIT

A lightweight permissions library for express & Node

Package Exports

  • trollbridge

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (trollbridge) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

node-trollbridge

A permissions system for Node and Express

How to use

include the troll library and setup any of the strategies you want to include.

You can make your own strategy functions or use some of the premade ones

var trollbridge = require('trollbridge');
trollbridge.addStrategies([
   trollbridge.PREMADESTRATEGIES.PASSPORT,
   require('./myownstrategy')
]);

When creating routes, add a middleware for each route you want to secure

app.get('/user/edit', trollbridge.shallNotPass('edit_user'), userEditFunct));

You can also include a locals variable for templating languages

app.use(function(req, res, next) {
    res.locals.has_permission = trollbridge.layoutHasPermission(req);
    next();
})

and then in your template

{% if has_permission('edit_user') %}
<a href="/user/edit">Edit User</a>
{% endif %}

Creating Strategies

Strategies will throw an error if they are unable to be authenticated.

//sample strategy
module.exports = function(req, permission) {
    if (!req.isAuthenticated()) {
        throw "User is not authenticated";
    }

    if (typeof req.user === 'undefined' || req.user == null) {
        throw "Should not be able to login";
    }
}