A JavaScript sandboxing library that uses web worker threads
JavaScript
199
23 commits
updated Jan 2, 2018
README
DISCONTINUED - Not safe; Do not use
JSandbox
Version 0.2.3
JSandbox is an open source JavaScript sandboxing library that makes use of HTML5 web workers. JSandbox makes it possible to run untrusted JavaScript without having to worry about any potential dangers.
Getting Started
- Download JSandbox.
- Include
<link rel="jsandbox" href="path/to/jsandbox-worker.js" />anywhere in your document. I recommend putting it in the document's<head>. - Place
<script type="text/javascript" src="path/to/jsandbox.js"></script>anywhere after the<link>tag. - Read the API documentation below.
Example Code
This example code demonstrates the JSandbox API.
Tested Working Browsers
- Firefox 3.5+
- Google Chrome 4+
API
Worker script location
Instead of using a <link> tag, you may define JSandbox.url to specify the location
of the JSandbox worker script.
Methods
All of these methods can be accessed on the JSandbox constructor (in one-use sandboxes)
and JSandbox instances:
eval(options)-
eval()soptions.data. Ifoptions.callbackis a function, it is passed the results as long as no errors occur. Ifoptions.onerroris a function and an error occurs, it is passed the error object. The code iseval()ed in a top-level pseudo-function-scope. If you define a variable using avarstatement, the variable is private to the eval.thisis still the global object. If this method is called onJSandbox, theJSandboxobject is returned. Otherwise, the ID of the request is returned. exec(options)-
Executes code in a faster method than
eval, but does not pass a return value to the callback function (though the function is still called if defined). Unlikeeval, the code is run in the global scope (varstatements affectthis). load(options)-
If
options.datais a string,options.datawill attempt to be loaded in the sandbox. Ifoptions.datais an array, every string it contains will attempt be loaded. Ifoptions.onerroris a function and an error is thrown while parsing a script or a script could not be resolved,options.onerroris passed the error object. Otherwise,options.callbackis called when the scripts are finished loading.
Instance-only methods
These methods can only be on JSandbox instances:
abort(requestID)- Aborts a pending request with the ID,
requestID. terminate()- Terminates the worker thread and any pending requests are aborted. You cannot use the JSandbox instance on which you called this method after it is called.
options object
The following are all of the properties that may be included in an options object.
data[Required]-
In the case of
evalandexec, it is the code to execute. In the case ofload, it is an array of the script(s) to load. If you only need to load one script, just pass a string instead. input- The input data available to the code via the input variable. The input should be JSON-convertible.
callback- The callback to pass the return value of the executed code if no exceptions were thrown.
onerror- The callback to pass an exception if one is thrown upon executing the code.
Alternative syntax
Any method that takes an options object can also be called using the following positional-arguments syntax:
someMethod(data [, callback] [, input] [, onerror]);
The global JSandbox object can also be referenced as Sandbox.
Similar repos
Languages
JavaScript
58.0%
HTML
42.0%
A JavaScript sandboxing library that uses web worker threads
JavaScript
199
23 commits
updated Jan 2, 2018
README
DISCONTINUED - Not safe; Do not use
JSandbox
Version 0.2.3
JSandbox is an open source JavaScript sandboxing library that makes use of HTML5 web workers. JSandbox makes it possible to run untrusted JavaScript without having to worry about any potential dangers.
Getting Started
- Download JSandbox.
- Include
<link rel="jsandbox" href="path/to/jsandbox-worker.js" />anywhere in your document. I recommend putting it in the document's<head>. - Place
<script type="text/javascript" src="path/to/jsandbox.js"></script>anywhere after the<link>tag. - Read the API documentation below.
Example Code
This example code demonstrates the JSandbox API.
Tested Working Browsers
- Firefox 3.5+
- Google Chrome 4+
API
Worker script location
Instead of using a <link> tag, you may define JSandbox.url to specify the location
of the JSandbox worker script.
Methods
All of these methods can be accessed on the JSandbox constructor (in one-use sandboxes)
and JSandbox instances:
eval(options)-
eval()soptions.data. Ifoptions.callbackis a function, it is passed the results as long as no errors occur. Ifoptions.onerroris a function and an error occurs, it is passed the error object. The code iseval()ed in a top-level pseudo-function-scope. If you define a variable using avarstatement, the variable is private to the eval.thisis still the global object. If this method is called onJSandbox, theJSandboxobject is returned. Otherwise, the ID of the request is returned. exec(options)-
Executes code in a faster method than
eval, but does not pass a return value to the callback function (though the function is still called if defined). Unlikeeval, the code is run in the global scope (varstatements affectthis). load(options)-
If
options.datais a string,options.datawill attempt to be loaded in the sandbox. Ifoptions.datais an array, every string it contains will attempt be loaded. Ifoptions.onerroris a function and an error is thrown while parsing a script or a script could not be resolved,options.onerroris passed the error object. Otherwise,options.callbackis called when the scripts are finished loading.
Instance-only methods
These methods can only be on JSandbox instances:
abort(requestID)- Aborts a pending request with the ID,
requestID. terminate()- Terminates the worker thread and any pending requests are aborted. You cannot use the JSandbox instance on which you called this method after it is called.
options object
The following are all of the properties that may be included in an options object.
data[Required]-
In the case of
evalandexec, it is the code to execute. In the case ofload, it is an array of the script(s) to load. If you only need to load one script, just pass a string instead. input- The input data available to the code via the input variable. The input should be JSON-convertible.
callback- The callback to pass the return value of the executed code if no exceptions were thrown.
onerror- The callback to pass an exception if one is thrown upon executing the code.
Alternative syntax
Any method that takes an options object can also be called using the following positional-arguments syntax:
someMethod(data [, callback] [, input] [, onerror]);
The global JSandbox object can also be referenced as Sandbox.
Similar repos
Languages
JavaScript
58.0%
HTML
42.0%