vm2 是一个沙箱,可以在白名单 Node 内置模块的情况下运行不受信任的代码。
如需深入了解 vm2 的内部机制,请参阅 CONTRIBUTING.md 文件。
亲自试试:
import { runInNewContext } from "node:vm";
runInNewContext('this.constructor.constructor("return process")().exit()');
console.log('Never gets executed.');
import { VM } from 'vm2';
new VM().run('this.constructor.constructor("return process")().exit()');
// Throws ReferenceError: process is not defined
npm install vm2
import { VM } from 'vm2';
const vm = new VM();
vm.run(`process.exit()`); // TypeError: process.exit is not a function
import { NodeVM } from 'vm2';
const vm = new NodeVM({
require: {
external: true,
root: './',
},
});
vm.run(
`
var request = require('request');
request('http://www.google.com', function (error, response, body) {
console.error(error);
if (!error && response.statusCode == 200) {
console.log(body); // Show the HTML for the Google homepage.
}
});
`,
'vm.js',
);
VM 是一个简单的沙箱,用于在没有 require 功能的情况下同步运行不受信任的代码。仅可使用 JavaScript 内置对象和 Node 的 Buffer。调度函数(setInterval、setTimeout 和 setImmediate)默认不可用。
选项:
timeout - 脚本超时时间(毫秒)。警告:你可能希望将此选项与 allowAsync=false 一起使用。此外,对沙箱返回的对象进行操作可能会运行任意代码并绕过超时。在另一种情况下,应使用 typeof 测试返回的对象是否为原始类型,并完全丢弃它(使用此类对象进行日志记录或创建错误消息也可能再次运行任意代码)。sandbox - VM 的全局对象。compiler - javascript(默认)、typescript、coffeescript 或自定义编译器函数。如果值设置为 typescript 或 coffeescript,该库期望你已预装编译器。eval - 如果设置为 false,任何对 eval 或函数构造函数(Function、GeneratorFunction 等)的调用都将抛出 EvalError(默认值:true)。wasm - 如果设置为 false,任何编译 WebAssembly 模块的尝试都将抛出 WebAssembly.CompileError(默认值:true)。allowAsync - 如果设置为 false,任何使用 async 运行代码的尝试都将抛出 VMError(默认值:true)。重要:超时仅对通过 run 运行的同步代码有效。超时不适用于 VM 返回的任何方法。在某些情况下超时不起作用 - 参见 #244。
import { VM } from 'vm2';
const vm = new VM({
timeout: 1000,
allowAsync: false,
sandbox: {},
});
vm.run('process.exit()'); // throws ReferenceError: process is not defined
你还可以从 VM 中获取值。
let number = vm.run('1337'); // returns 1337
提示:更多用法示例请参阅测试。
与 VM 不同,NodeVM 允许你以与常规 Node 上下文相同的方式 require 模块。
选项:
console - inherit 启用控制台,redirect 重定向到事件,off 禁用控制台(默认:inherit)。sandbox - VM 的全局对象。compiler - javascript(默认)、typescript、coffeescript 或自定义编译器函数(接收代码及其文件路径)。如果值设置为 typescript 或 coffeescript,该库期望你已预装编译器。eval - 如果设置为 false,任何对 eval 或函数构造器(Function、GeneratorFunction 等)的调用都将抛出 EvalError(默认:true)。wasm - 如果设置为 false,任何编译 WebAssembly 模块的尝试都将抛出 WebAssembly.CompileError(默认:true)。sourceExtensions - 视为源代码的文件扩展名数组(默认:['js'])。require - true、一个对象或一个 Resolver,用于启用 require 方法(默认:false)。require.external - 值可以是 true、允许的外部模块数组或一个对象(默认:false)。所有匹配 /node_modules/${any_allowed_external_module}/(?!/node_modules/) 的路径都允许被 require。require.external.modules - 允许的外部模块数组。也支持通配符,例如指定 ['@scope/*-ver-??] 将允许使用所有名称为 @scope/something-ver-aa、@scope/other-ver-11 等形式的模块。* 通配符不匹配路径分隔符。require.external.transitive - 布尔值,指示是否允许外部模块的传递依赖(默认:false)。警告:当模块被传递 require 时,任何模块随后都能正常 require 它,即使在它被加载之前这是不可能的。require.builtin - 允许的内置模块数组,接受 ["*"] 表示全部(默认:无)。警告:"*" 可能很危险,因为可能会添加新的内置模块。require.root - 可 require 本地模块的受限路径(默认:所有路径)。require.mock - 模拟模块集合(外部或内置)。require.context - host(默认)在宿主中 require 模块并将它们代理到沙箱中。sandbox 在沙箱中加载、编译和 require 模块。callback(moduleFilename, ext) 为每个模块动态选择上下文。如果未指定,默认为沙箱。除 events 外,内置模块始终在宿主中 require 并代理到沙箱中。require.import - 启动时加载到 NodeVM 中的模块数组。require.resolve - 当模块在传统 node 查找路径之一中未找到时的额外查找函数。require.customRequire - 用于替代 require 函数从宿主加载模块。require.strict - false 表示不强制 require 加载的模块使用严格模式(默认:true)。require.fs - 自定义文件系统实现。nesting - 警告:允许此项存在安全风险,因为脚本可以创建一个 NodeVM,从而 require 任何宿主模块。true 启用 VM 嵌套(默认:false)。wrapper - commonjs(默认)将脚本包装到 CommonJS 包装器中,none 获取脚本返回的值。argv - 传递给 process.argv 的数组。env - 传递给 process.env 的对象。strict - true 表示以严格模式加载模块(默认:false)。重要:超时对 NodeVM 无效,因此它无法抵御 while (true) {} 或类似的恶意代码。
请记住:你允许的模块越多,沙箱就越脆弱。
import { NodeVM } from 'vm2';
const vm = new NodeVM({
console: 'inherit',
sandbox: {},
require: {
external: true,
builtin: ['fs', 'path'],
root: './',
mock: {
fs: {
readFileSync: () => 'Nice try!',
},
},
},
});
// Sync
let functionInSandbox = vm.run('module.exports = function(who) { console.log("hello "+ who); }');
functionInSandbox('world');
// Async
let functionWithCallbackInSandbox = vm.run('module.exports = function(who, callback) { callback("hello "+ who); }');
functionWithCallbackInSandbox('world', greeting => {
console.log(greeting);
});
当 wrapper 设置为 none 时,NodeVM 对同步代码的行为更接近 VM。
assert.ok(vm.run('return true') === true);
提示:更多用法示例请参见测试。
要通过相对路径加载模块,如果脚本是字符串,你必须将正在运行的脚本的完整路径作为第二个参数传递给 vm 的 run 方法。随后,该文件名会显示在脚本生成的任何堆栈跟踪中。
vm.run('require("foobar")', '/data/myvmscript.js');
如果你正在运行的脚本是 VMScript,则路径会在 VMScript 构造函数中给出。
const script = new VMScript('require("foobar")', { filename: '/data/myvmscript.js' });
vm.run(script);
可以通过 makeResolverFromLegacyOptions 创建 resolver,并将其用于多个 NodeVM 实例,从而共享已编译的模块代码,有可能加快加载速度。NodeVM 的第一个示例可以使用 makeResolverFromLegacyOptions 重写如下。
const resolver = makeResolverFromLegacyOptions({
external: true,
builtin: ['fs', 'path'],
root: './',
mock: {
fs: {
readFileSync: () => 'Nice try!',
},
},
});
const vm = new NodeVM({
console: 'inherit',
sandbox: {},
require: resolver,
});
你可以通过使用预编译脚本来提升性能。预编译的 VMScript 可以多次运行。需要注意的是,代码并不绑定到任何 VM(上下文);相反,它在每次运行之前才进行绑定,且仅针对该次运行。
import { VM, VMScript } from 'vm2';
const vm = new VM();
const script = new VMScript('Math.random()');
console.log(vm.run(script));
console.log(vm.run(script));
它同时适用于 VM 和 NodeVM。
import { NodeVM, VMScript } from 'vm2';
const vm = new NodeVM();
const script = new VMScript('module.exports = Math.random()');
console.log(vm.run(script));
console.log(vm.run(script));
代码在首次运行时自动编译。可以随时使用 script.compile() 编译代码。代码编译完成后,该方法不再产生任何效果。
代码编译和同步代码执行中的错误可以通过 try-catch 处理。异步代码执行中的错误可以通过将 uncaughtException 事件处理器附加到 Node 的 process 上来处理。
try {
var script = new VMScript('Math.random()').compile();
} catch (err) {
console.error('Failed to compile script.', err);
}
try {
vm.run(script);
} catch (err) {
console.error('Failed to execute script.', err);
}