
신뢰할 수 없는 JavaScript를 프로세스 내에서 실행하기 위한 Node.js 샌드박스로, Proxies와 제어된 require를 사용하여 내장 및 외부 모듈 접근을 제한합니다.
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 - require 메서드를 활성화하려면 true, 객체 또는 Resolver를 지정합니다 (기본값: 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 - 목(mock) 모듈 모음입니다 (외부 또는 내장 모두).require.context - host (기본값)는 호스트에서 모듈을 require하고 샌드박스로 프록시합니다. sandbox는 샌드박스에서 모듈을 로드, 컴파일 및 require합니다. callback(moduleFilename, ext)는 모듈별로 컨텍스트를 동적으로 선택합니다. 아무것도 지정하지 않으면 기본값은 샌드박스입니다. events를 제외한 내장 모듈은 항상 호스트에서 require되어 샌드박스로 프록시됩니다.require.import - 시작 시 NodeVM에 로드할 모듈 배열입니다.require.resolve - 전통적인 node 조회 경로 중 하나에서 모듈을 찾지 못한 경우 사용할 추가 조회 함수입니다.require.customRequire - 호스트에서 모듈을 로드하기 위해 require 함수 대신 사용합니다.require.strict - require로 로드된 모듈에 엄격 모드를 강제하지 않으려면 false로 설정합니다 (기본값: true).require.fs - 사용자 정의 파일 시스템 구현입니다.nesting - 경고: 이를 허용하면 스크립트가 모든 호스트 모듈을 require할 수 있는 NodeVM을 생성할 수 있으므로 보안 위험입니다. VM 중첩을 활성화하려면 true로 설정합니다 (기본값: 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를 사용하여 다시 작성할 수 있습니다.