Pitboss-NG (next gen)

A module for running untrusted code

1var Pitboss = require('pitboss-ng').Pitboss;
2
3var untrustedCode = "var a = !true;\n a";
4
5var sandbox = new Pitboss(untrustedCode, {
6  memoryLimit: 32*1024, // 32 MB memory limit (default is 64 MB)
7  timeout: 5*1000, // 5000 ms to perform tasks or die (default is 500 ms = 0.5 s)
8  heartBeatTick: 100 // interval between memory-limit checks (default is 100 ms)
9});
10
11sandbox.run({
12  context: {       // context is an object of variables/values accessible by the untrusted code
13    'foo': 'bar',  // context must be JSON.stringify positive
14    'key': 'value' //  = no RegExp, Date, circular references, Buffer or more crazy things
15  },
16  libraries: {
17    myModule: path.join(__dirname, './my/own/module'),
18    // will be available as global "myModule" variable for the untrusted code
19    'crypto': 'crypto', // you can also require system/installed packages
20    '_': 'underscore'   // require underscore the traditional way
21  }
22}, function callback (err, result) {
23  // result is synchronous "return" of the last line in your untrusted code, here "a = !true", so false
24  console.log('Result is:', result); // prints "Result is: false"
25  sandbox.kill(); // don't forget to kill the sandbox, if you don't need it anymore
26});
27
28// OR other option: libraries can be an array of system modules
29sandbox.run({
30  context: {}, // no data-variables are passed to context
31  libraries: ['console', 'lodash'] // we will be using global "lodash" & "console"
32}, function callback (err, result) {
33  // finished, kill the sandboxed process
34  sandbox.kill();
35});

Runs JS code and returns the last eval'd statement

1var assert = require('chai').assert;
2var Pitboss = require('pitboss-ng').Pitboss;
3
4var code = "num = num % 5;\nnum;"
5
6var sandbox = new Pitboss(code);
7
8sandbox.run({context: {'num': 23}}, function (err, result) {
9  assert.equal(3, result);
10  sandbox.kill(); // sandbox is not needed anymore, so kill the sandboxed process
11});

Allows you to pass you own libraries into sandboxed content

1var assert = require('chai').assert;
2var Pitboss = require('pitboss-ng').Pitboss;
3
4var code = "num = num % 5;\n console.log('from sandbox: ' + num);\n num;"
5
6var sandbox = new Pitboss(code);
7
8sandbox.run({context: {'num': 23}, libraries: ['console']}, function (err, result) {
9  // will print "from sandbox: 5"
10  assert.equal(3, result);
11  sandbox.kill(); // sandbox is not needed anymore, so end it
12});

Handles processes that take too damn long

1var assert = require('chai').assert;
2var Pitboss = require('pitboss-ng').Pitboss;
3
4var code = "while(true) { num % 3 };";
5
6var sandbox = new Pitboss(code, {timeout: 2000});
7sandbox.run({context: {'num': 23}}, function (err, result) {
8  assert.equal("Timedout", err);
9  sandbox.kill();
10});

Doesn't choke under pressure (or shitty code)

1var assert = require('chai').assert;
2var Pitboss = require('pitboss-ng').Pitboss;
3
4var code = "Not a JavaScript at all!";
5
6var sandbox = new Pitboss(code, {timeout: 2000});
7
8sandbox.run({context: {num: 23}}, function (err, result) {
9  assert.include(err, "VM Syntax Error");
10  assert.include(err, "Unexpected identifier");
11  sandbox.kill();
12});

Doesn't handle this! But 'ulimit' or 'pidusage' does!

1var assert = require('chai').assert;
2var Pitboss = require('pitboss-ng').Pitboss;
3
4var code = "var str = ''; while (true) { str = str + 'Memory is a finite resource!'; }";
5
6var sandbox = new Pitboss(code, {timeout: 10000});
7
8sandbox.run({context: {num: 23}}, function (err, result) {
9  assert.equal("Process failed", err);
10  sandbox.kill();
11});

And since Pitboss-NG forks each process, ulimit kills only the runner