Skip to content

Commit 75e5612

Browse files
RafaelGSStargos
RafaelGSS
authored and
targos
committed
src,permission: --allow-wasi & prevent WASI exec
PR-URL: #53124 Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
1 parent 6708536 commit 75e5612

17 files changed

+183
-7
lines changed

‎doc/api/cli.md

+50
Original file line numberDiff line numberDiff line change
@@ -269,6 +269,53 @@ Examples can be found in the [File System Permissions][] documentation.
269269

270270
Relative paths are NOT supported through the CLI flag.
271271

272+
### `--allow-wasi`
273+
274+
<!-- YAML
275+
added: REPLACEME
276+
-->
277+
278+
> Stability: 1.1 - Active development
279+
280+
When using the [Permission Model][], the process will not be capable of creating
281+
any WASI instances by default.
282+
For security reasons, the call will throw an `ERR_ACCESS_DENIED` unless the
283+
user explicitly passes the flag `--allow-wasi` in the main Node.js process.
284+
285+
Example:
286+
287+
```js
288+
const { WASI } = require('node:wasi');
289+
// Attempt to bypass the permission
290+
new WASI({
291+
version: 'preview1',
292+
// Attempt to mount the whole filesystem
293+
preopens: {
294+
'/': '/',
295+
},
296+
});
297+
```
298+
299+
```console
300+
$ node --experimental-permission --allow-fs-read=* index.js
301+
node:wasi:99
302+
const wrap = new _WASI(args, env, preopens, stdio);
303+
^
304+
305+
Error: Access to this API has been restricted
306+
at new WASI (node:wasi:99:18)
307+
at Object.<anonymous> (/home/index.js:3:1)
308+
at Module._compile (node:internal/modules/cjs/loader:1476:14)
309+
at Module._extensions..js (node:internal/modules/cjs/loader:1555:10)
310+
at Module.load (node:internal/modules/cjs/loader:1288:32)
311+
at Module._load (node:internal/modules/cjs/loader:1104:12)
312+
at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:191:14)
313+
at node:internal/main/run_main_module:30:49 {
314+
code: 'ERR_ACCESS_DENIED',
315+
permission: 'WASI',
316+
}
317+
```
318+
272319
### `--allow-worker`
273320

274321
<!-- YAML
@@ -925,6 +972,7 @@ following permissions are restricted:
925972
[`--allow-fs-read`][], [`--allow-fs-write`][] flags
926973
* Child Process - manageable through [`--allow-child-process`][] flag
927974
* Worker Threads - manageable through [`--allow-worker`][] flag
975+
* WASI - manageable through [`--allow-wasi`][] flag
928976

929977
### `--experimental-require-module`
930978

@@ -2738,6 +2786,7 @@ one is included in the list below.
27382786
* `--allow-child-process`
27392787
* `--allow-fs-read`
27402788
* `--allow-fs-write`
2789+
* `--allow-wasi`
27412790
* `--allow-worker`
27422791
* `--conditions`, `-C`
27432792
* `--diagnostic-dir`
@@ -3293,6 +3342,7 @@ node --stack-trace-limit=12 -p -e "Error.stackTraceLimit" # prints 12
32933342
[`--allow-child-process`]: #--allow-child-process
32943343
[`--allow-fs-read`]: #--allow-fs-read
32953344
[`--allow-fs-write`]: #--allow-fs-write
3345+
[`--allow-wasi`]: #--allow-wasi
32963346
[`--allow-worker`]: #--allow-worker
32973347
[`--build-snapshot`]: #--build-snapshot
32983348
[`--cpu-prof-dir`]: #--cpu-prof-dir

‎doc/api/permissions.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -482,7 +482,7 @@ flag.
482482

483483
When starting Node.js with `--experimental-permission`,
484484
the ability to access the file system through the `fs` module, spawn processes,
485-
use `node:worker_threads`, native addons, and enable the runtime inspector
485+
use `node:worker_threads`, use native addons, use WASI, and enable the runtime inspector
486486
will be restricted.
487487

488488
```console
@@ -507,7 +507,7 @@ Allowing access to spawning a process and creating worker threads can be done
507507
using the [`--allow-child-process`][] and [`--allow-worker`][] respectively.
508508

509509
To allow native addons when using permission model, use the [`--allow-addons`][]
510-
flag.
510+
flag. For WASI, use the [`--allow-wasi`][] flag.
511511

512512
#### Runtime API
513513

@@ -574,6 +574,7 @@ There are constraints you need to know before using this system:
574574
* Worker Threads
575575
* Inspector protocol
576576
* File system access
577+
* WASI
577578
* The Permission Model is initialized after the Node.js environment is set up.
578579
However, certain flags such as `--env-file` or `--openssl-config` are designed
579580
to read files before environment initialization. As a result, such flags are
@@ -597,6 +598,7 @@ There are constraints you need to know before using this system:
597598
[`--allow-child-process`]: cli.md#--allow-child-process
598599
[`--allow-fs-read`]: cli.md#--allow-fs-read
599600
[`--allow-fs-write`]: cli.md#--allow-fs-write
601+
[`--allow-wasi`]: cli.md#--allow-wasi
600602
[`--allow-worker`]: cli.md#--allow-worker
601603
[`--experimental-permission`]: cli.md#--experimental-permission
602604
[`permission.has()`]: process.md#processpermissionhasscope-reference

‎doc/node.1

+3
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,9 @@ Allow using native addons when using the permission model.
8888
.It Fl -allow-child-process
8989
Allow spawning process when using the permission model.
9090
.
91+
.It Fl -allow-wasi
92+
Allow execution of WASI when using the permission model.
93+
.
9194
.It Fl -allow-worker
9295
Allow creating worker threads when using the permission model.
9396
.

‎lib/internal/process/pre_execution.js

+2
Original file line numberDiff line numberDiff line change
@@ -590,6 +590,7 @@ function initializePermission() {
590590
const warnFlags = [
591591
'--allow-addons',
592592
'--allow-child-process',
593+
'--allow-wasi',
593594
'--allow-worker',
594595
];
595596
for (const flag of warnFlags) {
@@ -631,6 +632,7 @@ function initializePermission() {
631632
'--allow-fs-write',
632633
'--allow-addons',
633634
'--allow-child-process',
635+
'--allow-wasi',
634636
'--allow-worker',
635637
];
636638
ArrayPrototypeForEach(availablePermissionFlags, (flag) => {

‎node.gyp

+2
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,7 @@
153153
'src/permission/fs_permission.cc',
154154
'src/permission/inspector_permission.cc',
155155
'src/permission/permission.cc',
156+
'src/permission/wasi_permission.cc',
156157
'src/permission/worker_permission.cc',
157158
'src/pipe_wrap.cc',
158159
'src/process_wrap.cc',
@@ -277,6 +278,7 @@
277278
'src/permission/fs_permission.h',
278279
'src/permission/inspector_permission.h',
279280
'src/permission/permission.h',
281+
'src/permission/wasi_permission.h',
280282
'src/permission/worker_permission.h',
281283
'src/pipe_wrap.h',
282284
'src/req_wrap.h',

‎src/env.cc

+3
Original file line numberDiff line numberDiff line change
@@ -921,6 +921,9 @@ Environment::Environment(IsolateData* isolate_data,
921921
permission()->Apply(
922922
this, {"*"}, permission::PermissionScope::kWorkerThreads);
923923
}
924+
if (!options_->allow_wasi) {
925+
permission()->Apply(this, {"*"}, permission::PermissionScope::kWASI);
926+
}
924927

925928
if (!options_->allow_fs_read.empty()) {
926929
permission()->Apply(this,

‎src/node_options.cc

+4
Original file line numberDiff line numberDiff line change
@@ -468,6 +468,10 @@ EnvironmentOptionsParser::EnvironmentOptionsParser() {
468468
"allow use of child process when any permissions are set",
469469
&EnvironmentOptions::allow_child_process,
470470
kAllowedInEnvvar);
471+
AddOption("--allow-wasi",
472+
"allow wasi when any permissions are set",
473+
&EnvironmentOptions::allow_wasi,
474+
kAllowedInEnvvar);
471475
AddOption("--allow-worker",
472476
"allow worker threads when any permissions are set",
473477
&EnvironmentOptions::allow_worker_threads,

‎src/node_options.h

+1
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,7 @@ class EnvironmentOptions : public Options {
131131
std::vector<std::string> allow_fs_write;
132132
bool allow_addons = false;
133133
bool allow_child_process = false;
134+
bool allow_wasi = false;
134135
bool allow_worker_threads = false;
135136
bool experimental_repl_await = true;
136137
bool experimental_vm_modules = false;

‎src/node_wasi.cc

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1-
#include "env-inl.h"
1+
#include "node_wasi.h"
22
#include "base_object-inl.h"
33
#include "debug_utils-inl.h"
4+
#include "env-inl.h"
45
#include "memory_tracker-inl.h"
5-
#include "node_mem-inl.h"
6-
#include "util-inl.h"
76
#include "node.h"
87
#include "node_errors.h"
8+
#include "node_mem-inl.h"
9+
#include "permission/permission.h"
10+
#include "util-inl.h"
911
#include "uv.h"
1012
#include "uvwasi.h"
11-
#include "node_wasi.h"
1213

1314
namespace node {
1415
namespace wasi {
@@ -120,8 +121,9 @@ void WASI::New(const FunctionCallbackInfo<Value>& args) {
120121
CHECK(args[1]->IsArray());
121122
CHECK(args[2]->IsArray());
122123
CHECK(args[3]->IsArray());
123-
124124
Environment* env = Environment::GetCurrent(args);
125+
THROW_IF_INSUFFICIENT_PERMISSIONS(
126+
env, permission::PermissionScope::kWASI, "");
125127
Local<Context> context = env->context();
126128
Local<Array> argv = args[0].As<Array>();
127129
const uint32_t argc = argv->Length();

‎src/permission/permission.cc

+5
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ Permission::Permission() : enabled_(false) {
8282
std::make_shared<WorkerPermission>();
8383
std::shared_ptr<PermissionBase> inspector =
8484
std::make_shared<InspectorPermission>();
85+
std::shared_ptr<PermissionBase> wasi = std::make_shared<WASIPermission>();
8586
#define V(Name, _, __) \
8687
nodes_.insert(std::make_pair(PermissionScope::k##Name, fs));
8788
FILESYSTEM_PERMISSIONS(V)
@@ -98,6 +99,10 @@ Permission::Permission() : enabled_(false) {
9899
nodes_.insert(std::make_pair(PermissionScope::k##Name, inspector));
99100
INSPECTOR_PERMISSIONS(V)
100101
#undef V
102+
#define V(Name, _, __) \
103+
nodes_.insert(std::make_pair(PermissionScope::k##Name, wasi));
104+
WASI_PERMISSIONS(V)
105+
#undef V
101106
}
102107

103108
Local<Value> CreateAccessDeniedError(Environment* env,

‎src/permission/permission.h

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
#include "permission/fs_permission.h"
1010
#include "permission/inspector_permission.h"
1111
#include "permission/permission_base.h"
12+
#include "permission/wasi_permission.h"
1213
#include "permission/worker_permission.h"
1314
#include "v8.h"
1415

‎src/permission/permission_base.h

+3
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ namespace permission {
2121

2222
#define CHILD_PROCESS_PERMISSIONS(V) V(ChildProcess, "child", PermissionsRoot)
2323

24+
#define WASI_PERMISSIONS(V) V(WASI, "wasi", PermissionsRoot)
25+
2426
#define WORKER_THREADS_PERMISSIONS(V) \
2527
V(WorkerThreads, "worker", PermissionsRoot)
2628

@@ -29,6 +31,7 @@ namespace permission {
2931
#define PERMISSIONS(V) \
3032
FILESYSTEM_PERMISSIONS(V) \
3133
CHILD_PROCESS_PERMISSIONS(V) \
34+
WASI_PERMISSIONS(V) \
3235
WORKER_THREADS_PERMISSIONS(V) \
3336
INSPECTOR_PERMISSIONS(V)
3437

‎src/permission/wasi_permission.cc

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
#include "permission/wasi_permission.h"
2+
3+
#include <string>
4+
#include <vector>
5+
6+
namespace node {
7+
8+
namespace permission {
9+
10+
// Currently, WASIPermission manage a single state
11+
// Once denied, it's always denied
12+
void WASIPermission::Apply(Environment* env,
13+
const std::vector<std::string>& allow,
14+
PermissionScope scope) {
15+
deny_all_ = true;
16+
}
17+
18+
bool WASIPermission::is_granted(Environment* env,
19+
PermissionScope perm,
20+
const std::string_view& param) const {
21+
return deny_all_ == false;
22+
}
23+
24+
} // namespace permission
25+
} // namespace node

‎src/permission/wasi_permission.h

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
#ifndef SRC_PERMISSION_WASI_PERMISSION_H_
2+
#define SRC_PERMISSION_WASI_PERMISSION_H_
3+
4+
#if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
5+
6+
#include <vector>
7+
#include "permission/permission_base.h"
8+
9+
namespace node {
10+
11+
namespace permission {
12+
13+
class WASIPermission final : public PermissionBase {
14+
public:
15+
void Apply(Environment* env,
16+
const std::vector<std::string>& allow,
17+
PermissionScope scope) override;
18+
bool is_granted(Environment* env,
19+
PermissionScope perm,
20+
const std::string_view& param = "") const override;
21+
22+
private:
23+
bool deny_all_;
24+
};
25+
26+
} // namespace permission
27+
28+
} // namespace node
29+
30+
#endif // defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
31+
#endif // SRC_PERMISSION_WASI_PERMISSION_H_

‎test/parallel/test-permission-allow-wasi-cli.js

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
// Flags: --experimental-permission --allow-wasi --allow-fs-read=*
2+
'use strict';
3+
4+
const common = require('../common');
5+
common.skipIfWorker();
6+
7+
const assert = require('assert');
8+
const { WASI } = require('wasi');
9+
10+
// Guarantee the initial state
11+
{
12+
assert.ok(process.permission.has('wasi'));
13+
}
14+
15+
// When a permission is set by cli, the process shouldn't be able
16+
// to create WASI instance unless --allow-wasi is sent
17+
{
18+
// doesNotThrow
19+
new WASI({
20+
version: 'preview1',
21+
});
22+
}

‎test/parallel/test-permission-warning-flags.js

+1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ const assert = require('assert');
77
const warnFlags = [
88
'--allow-addons',
99
'--allow-child-process',
10+
'--allow-wasi',
1011
'--allow-worker',
1112
];
1213

‎test/parallel/test-permission-wasi.js

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
// Flags: --experimental-permission --allow-fs-read=*
2+
'use strict';
3+
4+
const common = require('../common');
5+
const assert = require('node:assert');
6+
7+
const { WASI } = require('wasi');
8+
9+
{
10+
assert.throws(() => {
11+
new WASI({
12+
version: 'preview1',
13+
preopens: { '/': '/' },
14+
});
15+
}, common.expectsError({
16+
code: 'ERR_ACCESS_DENIED',
17+
permission: 'WASI',
18+
}));
19+
}

0 commit comments

Comments
 (0)