Skip to content

Commit 0a147b3

Browse files
committed
doc,permissions: fix limitations and known issues
1 parent 215f4d0 commit 0a147b3

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

doc/api/permissions.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -557,30 +557,34 @@ Wildcards are supported too:
557557
* `--allow-fs-read=/home/test*` will allow read access to everything
558558
that matches the wildcard. e.g: `/home/test/file1` or `/home/test2`
559559

560-
#### Limitations and known issues
560+
#### Permission Model constraints
561561

562562
There are constraints you need to know before using this system:
563563

564+
* The model does not inherit to a child node process or a worker thread.
565+
* When using the Permission Model the following features will be restricted:
566+
* Native modules
567+
* Child process
568+
* Worker Threads
569+
* Inspector protocol
570+
* File system access
571+
* The Permission Model is initialized after the Node.js environment is set up.
572+
However, certain flags such as `--env-file` or `--openssl-config` are designed
573+
to read files before environment initialization. As a result, such flags are
574+
not subject to the rules of the Permission Model.
575+
* OpenSSL engines cannot be requested at runtime when the Permission
576+
Model is enabled, affecting the built-in crypto, https, and tls modules.
577+
578+
#### Limitations and Known Issues
579+
564580
* When the permission model is enabled, Node.js may resolve some paths
565581
differently than when it is disabled.
566-
* Native modules are restricted by default when using the Permission Model.
567-
* OpenSSL engines currently cannot be requested at runtime when the Permission
568-
Model is enabled, affecting the built-in crypto, https, and tls modules.
569582
* Relative paths are not supported through the CLI (`--allow-fs-*`).
570-
* The model does not inherit to a child node process.
571-
* The model does not inherit to a worker thread.
572583
* Symbolic links will be followed even to locations outside of the set of paths
573584
that access has been granted to. Relative symbolic links may allow access to
574585
arbitrary files and directories. When starting applications with the
575586
permission model enabled, you must ensure that no paths to which access has
576587
been granted contain relative symbolic links.
577-
* When creating symlinks the target (first argument) should have read and
578-
write access.
579-
* Permission changes are not retroactively applied to existing resources.
580-
* The Permission Model is initialized after the Node.js environment is set up.
581-
However, certain flags such as `--env-file` or `--openssl-config` are designed
582-
to read files before environment initialization. As a result, such flags are
583-
not subject to the rules of the Permission Model.
584588

585589
[Import maps]: https://url.spec.whatwg.org/#relative-url-with-fragment-string
586590
[Security Policy]: https://github.com/nodejs/node/blob/main/SECURITY.md

0 commit comments

Comments
 (0)