exjsb
v2.0.1
Published
A simple JS execution sandbox with insulation mode for secure code execution
Maintainers
Readme
ExJSB
A simple JavaScript execution sandbox supporting both Module and CommonJS.
Notice
Please make sure to enable --experimental-vm-modules by default when running, otherwise errors may occur.
This environment runs with ES6 modules, so please ensure your Node.js version is greater than 16.0.
Description
By leveraging the vm module and additional techniques, the main thread can execute external JavaScript files while providing an isolated mode.
When encountering process-related instructions, this can effectively prevent malicious code from stopping the program.
The original idea came from the fact that PHP can run specific code on servers (such as login).
To enhance the usability of JavaScript + HTTP, I created this.
Compared to native import and require, this method supports both formats simultaneously.
When an error occurs, it asynchronously reports back to the main thread, ensuring the entire process will not crash.
Since it uses dynamic loading, there’s no need to repeatedly set up everything like require or import.
Caching can also be garbage-collected (yes, I’m looking at you, import).
It also supports import.meta.url, which allows the use of __dirname.
Installation
npm install exjsbExample
./index.js
import { ExJSB } from 'exjsb';
import { fileURLToPath } from "node:url";
import path, { dirname } from "node:path";
const __filename = fileURLToPath(import.meta.url);
const __dirname = dirname(__filename);
//create a ExJSB Object, and open insulation mode.
const exjsb = new ExJSB(path.join(__dirname, "script.js"), true);
//initialization the vm.
await exjsb.initialization((err) => {console.log(err)});
//excute add function.
let result = await exjsb.run((err) => {console.log(err)}, "add", 5, 8, 10);
console.log(result); //23
//remove the object
exjsb.destroy();script.js
import fs from 'fs'; //Ok.
const os = require("os"); //Ok.
import { fileURLToPath } from "node:url";
import path, { dirname } from "node:path";
const __filename = fileURLToPath(import.meta.url); //Support.
const __dirname = dirname(__filename);
//export the add function.
export function add(a, b, c){
console.log(__dirname);
console.log(fs);
console.log(os.cpus());
return a + b + c;
}