Skip to content

Commit 9e360df

Browse files
RafaelGSSrichardlau
authored andcommitted
doc: fix limitations and known issues in pm
PR-URL: #51184 Reviewed-By: Yagiz Nizipli <[email protected]> Reviewed-By: Stephen Belanger <[email protected]> Reviewed-By: Paolo Insogna <[email protected]>
1 parent f4d7f04 commit 9e360df

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

doc/api/permissions.md

+16-12
Original file line numberDiff line numberDiff line change
@@ -564,26 +564,30 @@ be ignored. For example: `/home/*.js` will work similar to `/home/*`.
564564

565565
There are constraints you need to know before using this system:
566566

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

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

0 commit comments

Comments
 (0)