
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コンテキストと同じ方法でモジュールを読み込めます。
オプション:
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.external.modules - 許可する外部モジュールの配列。ワイルドカードも使用できます。たとえば['@scope/*-ver-??]を指定すると、@scope/something-ver-aa、@scope/other-ver-11などの名前を持つモジュールを読み込めます。*はパス区切り文字には一致しません。require.external.transitive - 外部モジュールの推移的依存関係を許可するかどうかを示す真偽値(既定:false)。警告:推移的に読み込まれたモジュールは、それまでは直接読み込めなかった場合でも、どのモジュールからでも通常の方法で読み込めるようになります。require.builtin - 許可する組み込みモジュールの配列。["*"]ですべてを許可できます(既定:なし)。警告:新しい組み込みモジュールが追加される可能性があるため、"*"は危険な場合があります。require.root - ローカルモジュールの読み込みを制限するパス(既定:すべてのパス)。require.mock - モックモジュールの集合。組み込みと外部の両方に対応します。require.context - host(既定)はホスト側でモジュールを読み込み、プロキシを通じてサンドボックスへ渡します。sandboxはサンドボックス内で読み込み、コンパイル、インポートを行います。callback(moduleFilename, ext)はモジュールごとにコンテキストを動的に選択します。何も指定しない場合の既定値はsandboxです。eventsを除く組み込みモジュールは、常にホスト側で読み込まれてサンドボックスへプロキシ経由で渡されます。require.import - NodeVMの起動時に読み込むモジュールの配列。require.resolve - 通常の場所でモジュールが見つからない場合に使用する追加の検索関数。require.customRequire - ホスト側からモジュールを読み込む際にrequireの代わりに使用する関数。require.strict - falseを指定すると、requireで読み込むモジュールにstrictモードを強制しません(既定:true)。require.fs - 独自のファイルシステム実装。nesting - 警告:スクリプトからホストの任意のモジュールを読み込めるNodeVMを作成できるようになるため、許可するとセキュリティ上のリスクがあります。trueでVMの入れ子を許可します(既定:false)。wrapper - commonjs(既定)はスクリプトをCommonJSラッパーに包みます。noneはスクリプトが返す値を取得します。argv - process.argvへ渡す配列。env - process.envへ渡すオブジェクト。strict - trueでモジュールをstrictモードで読み込みます(既定: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でリゾルバーを作成し、複数の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,
});