Skip to content
A flexible JSON based access control system for Node.js
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dist
lib
test
.gitignore
.travis.yml
LICENCE
README.md
index.js
package.json

README.md

GuardHouse

A flexible access control permissions framework

Build Status

GuardHouse is designed to make the creation and processing of complex access control restrictions using an easy to understand and store JSON data format.

Installation

npm install guardhouse

Features

  • Simple To Use GuardHouse has been designed to be as simple and easy to use as possible, avoiding the complexities so often present in access control libraries by acting as nothing more than a structured framework.
  • Flexible Access Control Rules Access control rules are declared using a heirarchical structure which is easy to read and manage. Permissions can be inherited, allowing simple rules to cover a large variety of permission targets, while wildcard rules allow for added flexibility in dynamic contexts.

Example

var guest_acl = {
	api: {
		account: true,
		users: {
			read: true
		},
		'*': false
	}
};

var admin_acl = {
	api: true,
	admin: true,
	'*': true
};

var guardhouse = require('guardhouse');
guardhouse.can(guest_acl, 'admin.user.delete');
// -> False
guardhouse.can(admin_acl, 'admin.user.delete');
// -> True



var securedFunction = guardhouse.wrap('admin.functions', someFunction);
securedFunction.auth(guest_acl)();
// -> throws an error

securedFunction.can(guest_acl);
// -> False

securedFunction.auth(admin_acl)(params);
// -> someFunction(params)

Features

GuardHouse includes a powerful permission merging engine which allows partial permissions to be granted to a user, or revoked, in a non-destructive manner. This simplifies common permission management tasks considerably.

var guardhouse = require('guardhouse');
guardhouse.grant(user_acl, {
	a: {
		b: true
	}
});

guardhouse.revoke(user_acl, {
	a: {
		c: false
	}
});

Customization

GuardHouse supports a number of customization options which influence its behaviour, including blacklist/whitelist modes, custom rule parsing logic and a number of other features.

var guardhouse = require('guardhouse');

// Set to true for blacklist mode
guardhouse.options.default = false;

// Change to '/' for easy use with web paths
guardhouse.options.targetProcessor = guardhouse.PathProcessor('.');

GuardHouse comes with a customizable target processor which is capable of parsing standard paths with customizable delimiters. It is possible to create your own processor if you wish, provided it follows the convention layed out below.

function CustomPathProcessor(path) {
	return path.split(':'); // Must return an array of path segments
}

Use With Express.js

It is often useful to provide access control for web services and APIs. GuardHouse can easily be integrated with Express using a middleware like the following.

var GuardHouse = require('guardhouse');
GuardHouse.options.targetProcessor = GuardHouse.PathProcessor('/');

app.use(authenticationMiddleware);

app.use(function(req, res, next) {
	if(!req.user) 
		return res.json(401, { error: 'You have not provided a valid set of credentials.' });

	if(!Guardhouse.can(req.user.permissions, req.path))
		return res.json(403, { error: 'You do not have permission to access this API feature.' });

	next();
});

Licence

This module is made available under the MIT Licence. You can read the full licence in the LICENCE file.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.