Guardia

Javascript library for the Specification and Enforcement of Security Policies at application level.

Description

• TODO

Install

GUARDIA depends on some external libraries. Make sure you include these libraries before guardia:

• trait.js @ npm

Usage

Guardia is an internal DSL as such you need an entry point to the features offered by the language. The next code snippet shows how to do it.

'use strict';
const G = require('./guardia');

Guardia's API comprises a set of properties and a set of combinators that allows to compose those properties in more complex ones.

Construct | Description -----------------------------------------|----------------------------------------------------- Allow(arr : Array) => TBase | Allow the execution of the supplied properties Deny(arr : Array) => TBase | Deny the execution of the supplied properties Not(p: TBase) => TBase | Negates the result of the policy given as parameter And(pArr: Array) => TBase | Perform logical AND using policies given as parameters Or(pArr: Array) => TBase | Perform logical OR using policies given as parameters
ParamAt((...ps)=> Boolean, pIdx: Number, arr : Array) => TBase | Apply a function to one parameter of the actual execution StateFnParam((...ps)=> Boolean,s: String, arr : Array) => TBase | Apply a function to one state during an execution step getVType(idx: Number, fn : Function) => Object | Returns an object in the following way fn(params[idx]), where params is injected by the enforcement mechanism.

Policy Specification

To declare a policy you should make a property using the constructs provided by Guardia. For example, let say that the execution of alert() is forbidden in or application. For this we can use Deny or a combination of Not(Allow(...)).

const denyAlert = G.Deny(['alert']);
const denyAlert2 = G.Not(G.Allow(['alert']));

Declaring a property is not enough, you need to deploy in the object that you want to protect. To do that you need to use installPolicy(policyObj) method. This method receive a policy configuration object that contains four fields. installPolicy(policyObj) returns an object that contains on(target) method that receive the object that you want to protect.

 const policyObj = {
     whenRead : [denyAlert]
     //whenWrite : [..]
     //readListeners : [..]
     //writeListeners : [..]
 }

protectedTarget = G.installPolicy(policyObject).on(target);

Allow

const allowedProperties = G.Allow(['prop1', 'prop2', 'method1']);

Deny

const forbiddenProperties = G.Deny(['private1', 'private2', 'privateMethod1']);

Not

const forbiddenProperties = G.Not(G.Allow((['private1', 'private2', 'privateMethod1']));

ParamAt

const noIframeCreation = G.Not(G.And(G.Allow(['createElement']),G.ParamAt(equals, G.getVType(0, String),'iframe')));

Example # 1

Te first example aims to prevent the creation of boxes like alert().

const noAlert = G.Deny(['alert','prompt', 'confirm']);
G.installPolicy({
    whenRead:[noAlert]
}).on(window);

//then try to use alert method
window.alert('UPS!');

Deny([...]) have the same behavior as Not(Allow([...])). The next example how to use Allow([...]) for white list access to properties or methods of the target object.

let account = {
      amount: 1000,
      balance(){
          return this.amount;
      },
      deposit(x){
          this.amount = this.amount + x;
      }
}

const justAllow = G.Allow(['balance','deposit']);
const noOverride = G.Not(G.Allow(['amount','balance','deposit']));
account = G.installPolicy({
      whenRead: [justAllow],
      whenWrite:[noOverride]
}).on(account);

protectedAccount.deposit(120);
protectedAccount.balance();

protectedAccount.amount = 1234; // throws an exception
console.log(protectedAccount.amount); // throws exception

In the previous example we are able to protect the account object. But we desire to prevent negative values flowing to deposit(). For this knd of behavior GUARDIA provide us with ParamAt().

const ge = (a,b) => { return a > b };
const justAllow = G.Or(G.Allow(['balance']),
                        G.And(G.Allow(['deposit']),G.ParamAt(ge,G.getVType(0,Number),0)));
const noOverride = G.Not(G.Allow(['amount','balance','deposit']));

account = G.installPolicy({
      whenRead: [justAllow],
      whenWrite:[noOverride]
}).on(account);

account.deposit(-12); // throws an execption