jsonacl
v0.0.4
Published
Simple ACL built using a JSON file to persist permissions
Downloads
1
Maintainers
Readme
Access Control List Class
Simple implementation of ACL (Access Control Lists):
- Run the tests with:
node test.js
API
Acl(filename)
:
- create an ACL object
filename
is json file where the permissions can be saved
Acl.grant(granter, object, verb, role)
:
granter
- therole
performing thegrant
operation. This role must have 'grant' permissions (verb
) to be able to perform grant.role
now has permission to performverb
operations onobject
object
is created withgrant
permission forgranter
if it does not exist- returns true if successful and false otherwise
Acl.revoke(granter, object, verb, role)
:
granter
- therole
performing therevoke
operation. This role must have 'grant' permissions (verb
) to be able to perform revoke.role
does not has permission to performverb
operations onobject
anymore (it is not necessary thatrole
hasverb
permissions to performrevoke
)- returns
true
if successful andfalse
otherwise
Acl.init
:
- read saved permissions from the file specified in the constructor
Acl.save
:
- save the permissions to the file specified in the constructor
Example
var Acl = require('./acl.js');
var a = new Acl('acl.json');
a.grant('jonas', 'mytable', 'get', 'pelle');
a.isAllowed('mytable', 'get', 'pelle'); // true
a.isAllowed('mytable', 'get', 'sture'); // undefined (interpret as false)
a.revoke('jonas', 'mytable', 'get', 'pelle');
a.isAllowed('mytable', 'get', 'pelle'); // false
a.save(); // save json to acl.json
var b = new Acl('acl.json');
b.init() // b now contains the permissions
.then(function(){ // init returns a promise (see promisejs.org for details)
console.log(b.grants);
});