Skip to content

Commit 0f5af0a

Browse files
committed
clarify docs
1 parent b9cee88 commit 0f5af0a

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

doc/api/code_integrity.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
> Stability: 1.1 - Active development
88
9+
This feature is only available on Windows platforms.
10+
911
Code integrity refers to the assurance that software code has not been
1012
altered or tampered with in any unauthorized way. It ensures that
1113
the code running on a system is exactly what was intended by the developers.
@@ -39,7 +41,8 @@ a file's integrity. Application developers are responsible for generating and
3941
distributing the signature information for their Node.js application.
4042
Application developers are also expected to design their application
4143
in robust ways to avoid unintended code execution. This includes
42-
use of `eval` and loading modules outside of standard methods.
44+
avoiding the use of `eval` and avoiding loading modules outside
45+
of standard methods.
4346

4447
Signature information for files which Node.js is intended to execute
4548
can be stored in a catalog file. Application developers can generate
@@ -62,15 +65,15 @@ Be sure that the catalog is generated using the final version of the files that
6265
The application developer should then sign the generated catalog with their Code Signing certificate
6366
to ensure the catalog is not tampered with between distribution and execution.
6467

65-
This can be done with the [Set-AuthenticodeSignature commandlet](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.security/set-authenticodesignature).
68+
This can be done with the [Set-AuthenticodeSignature commandlet][].
6669

6770
### Windows Code Integrity and System Administrators
6871

6972
This section is intended for system administrators who want to enable Node.js
7073
code integrity features in their environments.
7174

7275
This section assumes familiarity with managing WDAC polcies.
73-
Official documentation for WDAC can be found [here](https://learn.microsoft.com/en-us/windows/security/application-security/application-control/windows-defender-application-control/).
76+
[Official documentation for WDAC][].
7477

7578
Code integrity enforcement on Windows has two toggleable settings:
7679
`EnforceCodeIntegrity` and `DisableInteractiveMode`. These settings are configured
@@ -131,3 +134,5 @@ Code integrity on MacOS is not yet implemented. Currently, there is no
131134
timeline for implementation.
132135

133136
[Security Policy]: https://github.com/nodejs/node/blob/main/SECURITY.md
137+
[Set-AuthenticodeSignature commandlet]: https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.security/set-authenticodesignature
138+
[Official documentation for WDAC]: https://learn.microsoft.com/en-us/windows/security/application-security/application-control/windows-defender-application-control/

0 commit comments

Comments
 (0)