Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

duktape-vm

Package Overview
Dependencies
Maintainers
1
Versions
8
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

duktape-vm

Javascript VM running in WebAssembly

  • 0.0.2
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
1
decreased by-90%
Maintainers
1
Weekly downloads
 
Created
Source

Duktape Javascript Virtual Machine

NPM

This project is a thin wrapper around the Duktape Embedded Javascript Engine compiled to webassembly/asmjs.

  • Airtight sandbox for unsafe js code.
  • Runs in modern web browsers using Webassembly with asmjs fallback.
  • Runs on anything that supports NodeJS (no native code/compilation!).
  • Restricted code (cannot access node.js or window methods).
  • VM supports ES5 and earlier javascript.
  • Supports bidirectional messaging.
  • Only 140KB gzipped.

2 minute example


const obj = {
    key: "value";
}

const vm = await 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" calls.

    exports.console = function(message) {
        // print to parent console
        vm_breakout("console.log(" + message + ");")
    };

    exports.someObj = ${JSON.stringify(obj)};
`);

vm.eval("2 + 2") // returns "4";
vm.eval("exports.console('hello, world!')") // prints "hello, world!" to the browser console
vm.eval("exports.someObj.key") // returns "value";

vm.eval(`
    exports.onMessage(function(msg) {
        // got message from parent!
    })
    
    // send message to parent
    exports.message("some message to parent");
`);

// send message to instance
vm.message("this is a message to the vm");

// listen for messages from vm
vm.onMessage((msg) => {
    console.log("Got message from vm: " + msg);
})

// destroy instance
vm.destroy();

Installation

npm i duktape-vm --save

Using in Typescript/Babel project:

import { DuktapeVM } from "duktape-vm";

Using in Node:

const DuktapeVM = require("duktape-vm").DuktapeVM;

To use directly in the browser, drop ONE of the tags below into your <head>.

<!-- Webassembly Only Version (Fast with 75% browser support), 140KB -->
<script src="https://cdn.jsdelivr.net/npm/duktape-vm@0.0.2/build/duktape-vm.min.js"></script>

<!-- AsmJS Only Version (Slower with 95% browser support), 150KB -->
<script src="https://cdn.jsdelivr.net/npm/duktape-vm@0.0.2/build/duktape-vm.min.asm.js"></script>

<!-- Webassembly AND AsmJS Version (Fast with 95% browser support), 280KB -->
<script src="https://cdn.jsdelivr.net/npm/duktape-vm@0.0.2/build/duktape-vm.min.both.js"></script>

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.

Keywords

FAQs

Package last updated on 17 Aug 2018

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc