Node.js v24.0.0 文档
- Node.js v24.0.0
- 目录
-
索引
- 断言测试
- 异步上下文跟踪
- 异步钩子
- Buffer
- C++ 插件
- 使用 Node-API 的 C/C++ 插件
- C++ 嵌入器 API
- 子进程
- Cluster
- 命令行选项
- Console
- Crypto
- Debugger
- 已弃用的 API
- 诊断通道
- DNS
- Domain
- Errors
- Events
- 文件系统
- Globals
- HTTP
- HTTP/2
- HTTPS
- Inspector
- 国际化
- 模块: CommonJS 模块
- 模块: ECMAScript 模块
- 模块:
node:module
API - 模块: 包
- 模块: TypeScript
- Net
- OS
- Path
- 性能钩子
- 权限
- Process
- Punycode
- 查询字符串
- Readline
- REPL
- Report
- 单可执行文件应用程序
- SQLite
- Stream
- 字符串解码器
- 测试运行器
- Timers
- TLS/SSL
- Trace events
- TTY
- UDP/数据报
- URL
- Utilities
- V8
- VM
- WASI
- Web Crypto API
- Web Streams API
- Worker threads
- Zlib
- 其他版本
- 选项
WebAssembly 系统接口 (WASI)#
node:wasi
模块当前不提供某些 WASI 运行时提供的全面的文件系统安全属性。未来是否会完全支持安全的文件系统沙箱可能不会实现。同时,不要依赖它来运行不受信任的代码。
源代码: lib/wasi.js
WASI API 提供了 WebAssembly 系统接口 规范的实现。 WASI 使 WebAssembly 应用程序可以通过一组类似 POSIX 的函数访问底层操作系统。
import { readFile } from 'node:fs/promises';
import { WASI } from 'node:wasi';
import { argv, env } from 'node:process';
const wasi = new WASI({
version: 'preview1',
args: argv,
env,
preopens: {
'/local': '/some/real/path/that/wasm/can/access',
},
});
const wasm = await WebAssembly.compile(
await readFile(new URL('./demo.wasm', import.meta.url)),
);
const instance = await WebAssembly.instantiate(wasm, wasi.getImportObject());
wasi.start(instance);
'use strict';
const { readFile } = require('node:fs/promises');
const { WASI } = require('node:wasi');
const { argv, env } = require('node:process');
const { join } = require('node:path');
const wasi = new WASI({
version: 'preview1',
args: argv,
env,
preopens: {
'/local': '/some/real/path/that/wasm/can/access',
},
});
(async () => {
const wasm = await WebAssembly.compile(
await readFile(join(__dirname, 'demo.wasm')),
);
const instance = await WebAssembly.instantiate(wasm, wasi.getImportObject());
wasi.start(instance);
})();
要运行上面的示例,请创建一个名为 demo.wat
的新 WebAssembly 文本格式文件
(module
;; Import the required fd_write WASI function which will write the given io vectors to stdout
;; The function signature for fd_write is:
;; (File Descriptor, *iovs, iovs_len, nwritten) -> Returns number of bytes written
(import "wasi_snapshot_preview1" "fd_write" (func $fd_write (param i32 i32 i32 i32) (result i32)))
(memory 1)
(export "memory" (memory 0))
;; Write 'hello world\n' to memory at an offset of 8 bytes
;; Note the trailing newline which is required for the text to appear
(data (i32.const 8) "hello world\n")
(func $main (export "_start")
;; Creating a new io vector within linear memory
(i32.store (i32.const 0) (i32.const 8)) ;; iov.iov_base - This is a pointer to the start of the 'hello world\n' string
(i32.store (i32.const 4) (i32.const 12)) ;; iov.iov_len - The length of the 'hello world\n' string
(call $fd_write
(i32.const 1) ;; file_descriptor - 1 for stdout
(i32.const 0) ;; *iovs - The pointer to the iov array, which is stored at memory location 0
(i32.const 1) ;; iovs_len - We're printing 1 string stored in an iov - so one.
(i32.const 20) ;; nwritten - A place in memory to store the number of bytes written
)
drop ;; Discard the number of bytes written from the top of the stack
)
)
使用 wabt 将 .wat
编译为 .wasm
wat2wasm demo.wat
安全性#
WASI 提供了一种基于能力的模型,通过该模型,应用程序被提供它们自己的自定义 env
、preopens
、stdin
、stdout
、stderr
和 exit
能力。
当前的 Node.js 威胁模型不提供某些 WASI 运行时中存在的安全沙箱。
虽然支持能力特性,但它们在 Node.js 中不构成安全模型。 例如,文件系统沙箱可以通过各种技术逃逸。 该项目正在探索是否可以在将来添加这些安全保证。
类: WASI
#
WASI
类提供了 WASI 系统调用 API 以及用于处理基于 WASI 的应用程序的额外便利方法。 每个 WASI
实例代表一个不同的环境。
new WASI([options])
#
options
<Object>args
<Array> WebAssembly 应用程序将看到的作为命令行参数的字符串数组。 第一个参数是 WASI 命令本身的虚拟路径。 默认:[]
。env
<Object> 一个类似于process.env
的对象,WebAssembly 应用程序将看到它作为其环境。 默认:{}
。preopens
<Object> 此对象表示 WebAssembly 应用程序的本地目录结构。preopens
的字符串键被视为文件系统中的目录。preopens
中对应的值是主机上这些目录的真实路径。returnOnExit
<boolean> 默认情况下,当 WASI 应用程序调用__wasi_proc_exit()
时,wasi.start()
将返回指定的退出代码,而不是终止进程。 将此选项设置为false
将导致 Node.js 进程以指定的退出代码退出。 默认:true
。stdin
<integer> 在 WebAssembly 应用程序中用作标准输入的文件描述符。 默认:0
。stdout
<integer> 在 WebAssembly 应用程序中用作标准输出的文件描述符。 默认:1
。stderr
<integer> 在 WebAssembly 应用程序中用作标准错误的文件描述符。 默认:2
。version
<string> 请求的 WASI 版本。 目前唯一支持的版本是unstable
和preview1
。 此选项是必需的。
wasi.getImportObject()
#
返回一个可以传递给 WebAssembly.instantiate()
的导入对象,如果没有其他 WASM 导入需要超出 WASI 提供的那些。
如果将版本 unstable
传递给构造函数,它将返回
{ wasi_unstable: wasi.wasiImport }
如果将版本 preview1
传递给构造函数,或者未指定任何版本,它将返回
{ wasi_snapshot_preview1: wasi.wasiImport }
wasi.start(instance)
#
instance
<WebAssembly.Instance>
尝试通过调用其 _start()
导出,开始执行 instance
作为 WASI 命令。 如果 instance
不包含 _start()
导出,或者如果 instance
包含 _initialize()
导出,则会抛出异常。
start()
要求 instance
导出一个名为 memory
的 WebAssembly.Memory
。 如果 instance
没有 memory
导出,则会抛出异常。
如果 start()
被多次调用,则会抛出异常。
wasi.initialize(instance)
#
instance
<WebAssembly.Instance>
尝试通过调用其 _initialize()
导出(如果存在)来初始化 instance
作为 WASI reactor。 如果 instance
包含 _start()
导出,则会抛出异常。
initialize()
要求 instance
导出一个名为 memory
的 WebAssembly.Memory
。 如果 instance
没有 memory
导出,则会抛出异常。
如果 initialize()
被多次调用,则会抛出异常。
wasi.wasiImport
#
wasiImport
是一个实现 WASI 系统调用 API 的对象。 在实例化 WebAssembly.Instance
期间,应将此对象作为 wasi_snapshot_preview1
导入传递。