Skip to content

Latest commit

 

History

History
198 lines (120 loc) · 4.38 KB

README.rst

File metadata and controls

198 lines (120 loc) · 4.38 KB
Raw

node_vm2

Documentation Status test

Warning

This project is no longer maintained. Please use deno_vm instead.

A Python 3 to Node.js + vm2 binding, helps you execute JavaScript safely.

vm2

vm2 is a node module to create real sandbox in node. The official node API vm, can only create isolate context and doesn't prevent harmful code to damage your computer.

How it works

The module launchs a Node.js REPL server, which can be communicated with JSON. All JavaScript code are encoded in JSON and sent to the server. After the server executing the code in vm2, the result is sent back to Python.

Install

You need Node.js.

https://nodejs.org/

Install node_vm2 from pypi wheel.

pip install node_vm2

Also make sure you have node executable in PATH, or you can specify the executable with environment variable NODE_EXECUTABLE.

Additionally, you will need npm to build node_vm2 from source.

Usage

Most of the APIs are bound to vm2.

Simple eval:

from node_vm2 import eval

print(eval("['foo', 'bar'].join()"))

Use VM:

from node_vm2 import VM

with VM() as vm:
   vm.run("""
      var sum = 0, i;
      for (i = 0; i < 10; i++) sum += i;
   """)
   print(vm.run("sum"))

Use NodeVM:

from node_vm2 import NodeVM

js = """exports.greet = name => console.log(`Hello ${name}!`);"""

with NodeVM.code(js) as module:
   module.call_member("greet", "John")

It is possible to do async task with Promise:

from datetime import datetime
from node_vm2 import NodeVM

js = """
exports.test = () => {
   return new Promise(resolve => {
      setTimeout(() => {
         resolve("hello")
      }, 3000);
   });
};
"""
with NodeVM.code(js) as module:
   print(datetime.now())
   print(module.call_member("test"))
   print(datetime.now())

If you like to allow the VM to crash your server (e.g. process.exit()), you should create the VM in a separate server so it won't affect other VMs:

from node_vm2 import VMServer, VM

with VMServer() as server:
   with VM(server=server) as vm:
      # now the vm is created in a new server
      print(vm.run("1 + 2 + 3"))

API reference

http://node-vm2.readthedocs.io/

Changelog

  • 0.4.6 (Oct 23, 2023)
    • Change: add deprecation warning.
    • Update vm2 to 3.9.19.
  • 0.4.5 (Sep 1, 2022)
    • Update vm2 to 3.9.11.
  • 0.4.4 (Mar 14, 2022)
    • Update vm2 to 3.9.9.
  • 0.4.3 (Feb 15, 2022)
    • Update vm2 to 3.9.7.
  • 0.4.2 (Feb 9, 2022)
    • Update vm2 to 3.9.6.
    • Fix: filename is optional.
  • 0.4.1 (Oct 20, 2021)
    • Update vm2 to 3.9.5.
  • 0.4.0 (Sep 2, 2021)
    • Update vm2 to 3.9.3.
    • Change: throw VMError when failed running node.
  • 0.3.7 (Mar 23, 2020)
    • Update vm2 to 3.9.0.
  • 0.3.6 (Apr 22, 2019)
    • Update vm2 to 3.8.0. Fix security issues.
  • 0.3.5 (Feb 10, 2019)
    • Update vm2 to 3.6.10. Fix security issues.
  • 0.3.4 (Aug 10, 2018)
    • Update vm2 to 3.6.3. Fix security issues.
  • 0.3.3 (Jul 23, 2018)
    • Fix: don't bundle dev dependencies.
  • 0.3.2 (Jul 23, 2018)
    • Fix: getting a freezed object would crash the server.
    • Update vm2 to 3.6.2. Fix security issues.
  • 0.3.1 (Apr 25, 2017)
    • Add command arg to VMServer.
    • Fix: A dead default server is created if process spawning failed.
  • 0.3.0 (Apr 23, 2017)
    • Change: use event queue to handle console redirects.
    • Reconize object thrown by VM which doesn't inherit built-in Error.
  • 0.2.0 (Mar 25, 2017)
    • Drop NodeBridge.
    • Add VMServer.
    • Make all VMs share a default VMServer.
    • Method rename: VM.connect -> VM.create, VM.close -> VM.destroy.
  • 0.1.0 (Mar 23, 2017)
    • First release