WebAssembly System Interface (WASI) — Node.js

Интерфейс системы WebAssembly (WASI)

Уровень стабильности: 1 - Экспериментальный

Модуль node:wasi в настоящее время не предоставляет полные свойства безопасности файловой системы, которые предоставляют некоторые реализации WASI. Полная поддержка безопасного контейнеризации файловой системы может быть реализована в будущем, а может и нет. В настоящее время не полагайтесь на него для запуска небезопасного кода.

Исходный код: lib/wasi.js

API WASI предоставляет реализацию спецификации Интерфейса системы WebAssembly. WASI предоставляет приложениям WebAssembly доступ к операционной системе через набор функций, похожих на POSIX.

Модули MJS

import { readFile } from 'node:fs/promises';
import { WASI } from '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);

Модули CJS

'use strict';
const { readFile } = require('node:fs/promises');
const { WASI } = require('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);
})();

Для запуска приведенного выше примера, создайте новый файл WebAssembly в формате текста с именем demo.wat.

(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
    )
) copy

Используйте wabt для компиляции .wat в .wasm.

wat2wasm demo.wat copy

Безопасность

История

Версия	Изменения
v21.2.0, v20.11.0	Уточнение свойств безопасности WASI.
v21.2.0, v20.11.0	Добавлено в: v21.2.0, v20.11.0

WASI использует модель на основе возможностей, предоставляя приложениям собственные настраиваемые env, preopens, stdin, stdout, stderr, и exit возможности.

Текущая модель угроз Node.js не обеспечивает безопасную изоляцию, как это есть в некоторых реализациях WASI.

Хотя возможности поддерживаются, они не образуют модель безопасности в Node.js. Например, изоляция файловой системы может быть обойдена с помощью различных методов. Проект исследует возможность добавления этих гарантий безопасности в будущем.

Класс: `WASI`

Добавлено в: v13.3.0, v12.16.0

Класс WASI предоставляет API системных вызовов WASI и дополнительные удобные методы для работы с приложениями на основе WASI. Каждый экземпляр WASI представляет собой отдельную среду.

`new WASI([options])`

История

Версия	Изменения
v20.1.0	Значение по умолчанию returnOnExit изменено на true.
v20.0.0	Параметр version теперь является обязательным и не имеет значения по умолчанию.
v19.8.0	Поле version добавлено в параметры.
v13.3.0, v12.16.0	Добавлено в: v13.3.0, v12.16.0

options <Объект>
- args <Массив> Массив строк, которые приложение WebAssembly будет воспринимать как аргументы командной строки. Первый аргумент — это виртуальный путь к самой команде WASI. По умолчанию: [].
- env <Объект> Объект, похожий на process.env, который приложение WebAssembly будет воспринимать как свою среду. По умолчанию: {}.
- preopens <Объект> Этот объект представляет локальную структуру каталогов приложения WebAssembly. Строковые ключи preopens обрабатываются как каталоги в файловой системе. Соответствующие значения в preopens — это реальные пути к этим каталогам на хост-машине.
- returnOnExit <логический тип> По умолчанию, когда приложения WASI вызывают __wasi_proc_exit() wasi.start(), будет возвращено указанное значение кода выхода, а не завершение процесса. Установка этого параметра в false приведет к завершению процесса Node.js с указанным кодом выхода. По умолчанию: true.
- stdin <целое число> Дескриптор файла, используемый в качестве стандартного ввода в приложении WebAssembly. По умолчанию: 0.
- stdout <целое число> Дескриптор файла, используемый в качестве стандартного вывода в приложении WebAssembly. По умолчанию: 1.
- stderr <целое число> Дескриптор файла, используемый в качестве стандартной ошибки в приложении WebAssembly. По умолчанию: 2.
- version <строка> Запрашиваемая версия WASI. В настоящее время поддерживаются только версии unstable и preview1. Этот параметр является обязательным.

`wasi.getImportObject()`

Добавлено в: v19.8.0

Возвращает объект импорта, который можно передать в WebAssembly.instantiate(), если другие импорты WASM не требуются помимо тех, что предоставляются WASI.

Если версия unstable была передана в конструктор, она вернет:

{ wasi_unstable: wasi.wasiImport } copy

Если версия preview1 была передана в конструктор или версия не была указана, она вернет:

{ wasi_snapshot_preview1: wasi.wasiImport } copy

`wasi.start(instance)`

Добавлено в: v13.3.0, v12.16.0

instance <WebAssembly.Instance>

Попытка начать выполнение instance в качестве команды WASI, вызвав экспорт _start(). Если instance не содержит экспорт _start(), или если instance содержит экспорт _initialize(), будет выброшено исключение.

start() требует, чтобы instance экспортировал WebAssembly.Memory с именем memory. Если instance не имеет экспорта memory, будет выброшено исключение.

Если start() вызывается более одного раза, будет выброшено исключение.

`wasi.initialize(instance)`

Добавлено в: v14.6.0, v12.19.0

instance <WebAssembly.Instance>

Попытка инициализации instance как реактора WASI, вызвав экспорт _initialize(), если он присутствует. Если instance содержит экспорт _start(), будет выброшено исключение.

initialize() требует, чтобы instance экспортировал WebAssembly.Memory с именем memory. Если instance не имеет экспорта memory, будет выброшено исключение.

Если initialize() вызывается более одного раза, будет выброшено исключение.

`wasi.wasiImport`

Добавлено в: v13.3.0, v12.16.0

<Объект>

wasiImport — это объект, реализующий API системных вызовов WASI. Этот объект должен быть передан как импорт wasi_snapshot_preview1 при создании экземпляра WebAssembly.Instance.

© Joyent, Inc. and other Node contributors
Licensed under the MIT License.
Node.js is a trademark of Joyent, Inc. and is used with its permission.
We are not endorsed by or affiliated with Joyent.
https://nodejs.org/api/wasi.html

Интерфейс системы WebAssembly (WASI)

Безопасность

Класс: WASI

new WASI([options])

wasi.getImportObject()

wasi.start(instance)

wasi.initialize(instance)

wasi.wasiImport

Класс: `WASI`

`new WASI([options])`

`wasi.getImportObject()`

`wasi.start(instance)`

`wasi.initialize(instance)`

`wasi.wasiImport`