wasm-sandbox-cli 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 N-API for Rust
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,88 @@
+# wasm-sandbox
+
+Node.js WebAssembly sandbox CLI tool built on [@wasm-sandbox/runtime](https://www.npmjs.com/package/@wasm-sandbox/runtime).
+
+## Installation
+
+```bash
+npm install -g wasmsand-box
+# or use npx
+npx wasmsand-box <command>
+```
+
+## Usage
+
+### Run WebAssembly Module
+
+```bash
+# Basic run
+wasmsand-box run example.wasm
+
+# Pass arguments
+wasmsand-box run example.wasm arg1 arg2 arg3
+
+# Invoke specific function
+wasmsand-box run --invoke add example.wasm 1 2
+
+# Set working directory
+wasmsand-box run --work-dir ./ example.wasm
+
+# Map directory
+wasmsand-box run --map-dir ./host/path::/guest/path example.wasm
+
+# Set environment variables
+wasmsand-box run --env FOO=BAR --env BAZ=QUX example.wasm
+
+# Limit resources
+wasmsand-box run --wasm-timeout 10 --wasm-max-memory-size 1073741824 example.wasm
+```
+
+### Start HTTP Server
+
+```bash
+# Basic server
+wasmsand-box serve example.wasm
+
+# Specify port and IP
+wasmsand-box serve -p 3000 -i 127.0.0.1 example.wasm
+
+# Configure network access
+wasmsand-box serve --allowed-outbound-hosts https://*.github.com example.wasm
+
+# Set config variables
+wasmsand-box serve --config-var KEY=VALUE --keyvalue-var DATA=VALUE example.wasm
+```
+
+## Command Options
+
+### run Command
+
+| Option | Description |
+|--------|-------------|
+| `--program-name <name>` | Override argv[0] value |
+| `--invoke <function>` | Invoke specific function |
+| `--work-dir <dir>` | Grant host directory access |
+| `--map-dir <mapping>` | Map host directory to guest, format: `host::guest` |
+| `--env <var>` | Pass environment variable, format: `NAME=VALUE` |
+| `--allowed-outbound-hosts <host>` | Allowed network destinations |
+| `--block-networks <network>` | Blocked IP networks |
+| `--wasm-timeout <seconds>` | Maximum execution time (seconds) |
+| `--wasm-max-memory-size <bytes>` | Maximum memory size (bytes) |
+| `--wasm-max-stack <bytes>` | Maximum stack size (bytes) |
+| `--wasm-fuel <units>` | Execution fuel units |
+| `--wasm-cache-dir <dir>` | Precompiled module cache directory |
+
+### serve Command
+
+| Option | Description |
+|--------|-------------|
+| `-i, --ip <ip>` | Bind IP address |
+| `-p, --port <port>` | Bind port |
+| `--config-var <var>` | WASI config variable, format: `NAME=VALUE` |
+| `--keyvalue-var <var>` | WASI key-value API preset data |
+
+Other options are same as `run` command.
+
+## License
+
+MIT

package/cli.js

@@ -0,0 +1,117 @@
+#!/usr/bin/env node
+
+import { readFileSync } from 'fs'
+import { fileURLToPath } from 'url'
+import { dirname, join } from 'path'
+
+import { Command } from 'commander';
+import wasm_sandbox from '@wasm-sandbox/runtime';
+
+const __dirname = dirname(fileURLToPath(import.meta.url))
+const { name, version, description } = JSON.parse(readFileSync(join(__dirname, 'package.json'), 'utf8'))
+
+const program = new Command();
+
+program
+  .name(name)
+  .version(version)
+  .description(description);
+
+program
+  .command('run <wasm> [args...]')
+  .option('--program-name <name>')
+  .option('--invoke <function>')
+  .option('--work-dir <dir>')
+  .option('--map-dir <mapping...>')
+  .option('--env <var...>')
+  .option('--allowed-outbound-hosts <host...>')
+  .option('--block-networks <network...>')
+  .option('--wasm-timeout <seconds>', '', parseInt)
+  .option('--wasm-max-memory-size <bytes>', '', parseInt)
+  .option('--wasm-max-stack <bytes>', '', parseInt)
+  .option('--wasm-fuel <units>', '', parseInt)
+  .option('--wasm-cache-dir <dir>')
+  .action((wasm, args, opts) => {
+    wasm_sandbox.run({
+      wasmFile: wasm,
+      args,
+      programName: opts.programName,
+      invoke: opts.invoke,
+      workDir: opts.workDir,
+      mapDirs: opts.mapDir?.map(m => {
+        const [key, value] = m.split('::');
+        return { key, value: value || key };
+      }),
+      envVars: opts.env?.map(e => {
+        const [key, value] = e.split('=');
+        return { key, value };
+      }),
+      allowedOutboundHosts: opts.allowedOutboundHosts,
+      blockNetworks: opts.blockNetworks,
+      wasmTimeout: opts.wasmTimeout,
+      wasmMaxMemorySize: opts.wasmMaxMemorySize,
+      wasmMaxWasmStack: opts.wasmMaxStack,
+      wasmFuel: opts.wasmFuel,
+      wasmCacheDir: opts.wasmCacheDir
+    });
+  });
+
+program
+  .command('serve <wasm>')
+  .option('-i, --ip <ip>')
+  .option('-p, --port <port>', '', parseInt)
+  .option('--work-dir <dir>')
+  .option('--map-dir <mapping...>')
+  .option('--env <var...>')
+  .option('--allowed-outbound-hosts <host...>')
+  .option('--block-networks <network...>')
+  .option('--config-var <var...>')
+  .option('--keyvalue-var <var...>')
+  .option('--wasm-timeout <seconds>', '', parseInt)
+  .option('--wasm-max-memory-size <bytes>', '', parseInt)
+  .option('--wasm-max-stack <bytes>', '', parseInt)
+  .option('--wasm-fuel <units>', '', parseInt)
+  .option('--wasm-cache-dir <dir>')
+  .action((wasm, opts) => {
+    const mapDirs = {};
+    opts.mapDir?.forEach(m => {
+      const [key, value] = m.split('::');
+      mapDirs[key] = value || key;
+    });
+
+    const envVars = {};
+    opts.env?.forEach(e => {
+      const [key, value] = e.split('=');
+      envVars[key] = value;
+    });
+
+    const configVars = opts.configVar?.map(v => {
+      const [key, value] = v.split('=');
+      return { key, value };
+    });
+
+    const keyvalueVars = opts.keyvalueVar?.map(v => {
+      const [key, value] = v.split('=');
+      return { key, value };
+    });
+
+    wasm_sandbox.serve({
+      wasmFile: wasm,
+      ip: opts.ip,
+      port: opts.port,
+      workDir: opts.workDir,
+      mapDirs,
+      envVars,
+      allowedOutboundHosts: opts.allowedOutboundHosts,
+      blockNetworks: opts.blockNetworks,
+      configVars,
+      keyvalueVars,
+      wasmTimeout: opts.wasmTimeout,
+      wasmMaxMemorySize: opts.wasmMaxMemorySize,
+      wasmMaxWasmStack: opts.wasmMaxStack,
+      wasmFuel: opts.wasmFuel,
+      wasmCacheDir: opts.wasmCacheDir
+    });
+  });
+
+program.parse();

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "wasm-sandbox-cli",
+  "version": "1.0.0",
+  "description": "wasm-sandbox cli tool",
+  "author": "guyoung",
+  "homepage": "https://github.com/guyoung/wasm-sandbox-node/tree/main/cli",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/guyoung/wasm-sandbox-node.git"
+  },
+  "license": "MIT",
+  "keywords": [
+    "wasm",
+    "webassembly",
+    "wasi",
+    "sandbox"
+  ],
+  "files": [
+    "cli.js",
+    "README.md",
+    "README_zh-CN.md"
+  ],
+  "type": "module",
+  "bin": {
+    "wasmsand-box": "cli.js",
+    "wasmsand-box-cli": "cli.js"
+  },
+  "dependencies": {
+    "@wasm-sandbox/runtime": "^1.0.5",
+    "commander": "^14.0.3"
+  }
+}