Skip to content

Latest commit

 

History

History
53 lines (41 loc) · 2.67 KB

README.md

File metadata and controls

53 lines (41 loc) · 2.67 KB
Raw

sandbox.js

Build Status JavaScript Style Guide semantic-release

This is a module that allows for executing functions within a sandbox in Node.js. It provides a runInSandbox function that takes a function as argument, as well as an optional context and an optional module whitelist. If the context contains a require property and a whitelist is specified, the require property will be replaced by a "secure" require function before the specified function is executed in the sandbox. The "secure" require function is a wrapper around the default require function provided by Node.js, and does nothing more than either loading a module or throwing an error, based on the whitelist. If no whitelist is specified, we default to an empty whitelist.

Usage

    const sandbox = require('sandbox.js'),
          context = {require: require},
          theAnswerFun = function() { return 42; },
          consoleFun = function() { require('console').log('Hello World!'); },
          httpFun = function() { return require('http').STATUS_CODES['200']; };

    sandbox.runInSandbox(theAnswerFun); // => 42

    sandbox.runInSandbox(consoleFun); // => ReferenceError: require is not defined
    sandbox.runInSandbox(consoleFun, context); // => Error: 'console' is not whitelisted
    sandbox.runInSandbox(consoleFun, context, ['http']); // => Error: 'console' is not whitelisted
    sandbox.runInSandbox(consoleFun, context, ['console']); // => Hello World!

    sandbox.runInSandbox(httpFun); // => ReferenceError: require is not defined
    sandbox.runInSandbox(httpFun, context); // => Error: 'http' is not whitelisted
    sandbox.runInSandbox(httpFun, context, ['console']); // => Error: 'http' is not whitelisted
    sandbox.runInSandbox(httpFun, context, ['http']);  // => 'OK'

LICENSE

Copyright 2016 Klaus Trainer

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.