Duktape Javascript Virtual Machine
This project is a wrapper around the Duktape Embedded Javascript Engine compiled to webassembly/asmjs.
- Airtight sandbox for unsafe js code.
- Kills unresponsive scripts after 10 seconds (Prevents
while(true) {}
lock up). - Restricted code (impossible to access node.js or window methods and objects).
- Runs in modern web browsers using Webassembly with asmjs fallback.
- Runs on anything that supports NodeJS 8 or greater (zero native code/compilation).
- VM supports ES5 and earlier javascript with async and sync exection.
- Supports bidirectional messaging and asynchronous operations.
- Only 110KB gzipped.
Quick Example
;
Installation
npm i duktape-vm --save
Using in Typescript/Babel project:
;
Using in Node:
const DuktapeVM = DuktapeVM;
To use directly in the browser, drop ONE of the tags below into your <head>
.
The library will attach DuktapeVM
to window/global, allowing you to access it anywhere in your code.
<!-- Webassembly Only Version (Fast with 75% browser support), 110KB --> <!-- AsmJS Only Version (Slower with 95% browser support), 115KB --> <!-- Webassembly with AsmJS fallback (Fast with 95% browser support), 220KB -->
Virtual Machine Available Globals
The vm doesn't expose any platform specific methods like window
, document
, global
, fetch
or anything like that. Only a subset of APIs are available: setInterval
, setTimeout
, clearTimeout
, clearInterval
, Date
, Array
, String
, Number
, Object
, RegExp
, JSON
, parseInt
, isNaN
and Promise
.
Additional methods and variables can be provided by passing them into the DuktapeVM constructor.
Setup & Usage
DuktapeVM` // Provide data and methods to VM instance // vm_breakout() allows you to eval code in the parent window/global space. // vm_breakout is only available here, it's not available in subsequent "vm.eval" or "vm.evalAsync" calls. // all methods should be attached to the exports object exports.console = function(message) { // print to parent console vm_breakout("console.log('" + message + "');") }; // you can also inline js libraries here // global scope is available on the variable "self"`.then
MIT License
Copyright (c) 2018 Scott Lott
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.