Skip to content

doc: add steps about signing the binary in single-executable docs #46764

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
RaisinTen wants to merge 2 commits into from
Closed

doc: add steps about signing the binary in single-executable docs #46764

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ce1284b
doc: add steps about signing the binary in single-executable docs
RaisinTen Feb 22, 2023
70effbb
doc: clarify that signing is optional on Windows
RaisinTen Feb 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
doc: clarify that signing is optional on Windows 
Refs: #46764 (comment)
Signed-off-by: Darshan Sen <[email protected]>
  • Loading branch information
@RaisinTen
RaisinTen committed Feb 24, 2023
commit 70effbb736b4e335f38d9e7886290b66ba553f46
12 changes: 10 additions & 2 deletions doc/api/single-executable-applications.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,10 @@ tool, [postject][]:
$ codesign --remove-signature hello
```

* On Windows:
* On Windows (optional):

[signtool][] can be used from the installed [Windows SDK][]. If this step is
skipped, ignore any signature-related warning from postject.

```console
$ signtool remove /s hello
Expand Down Expand Up @@ -83,7 +86,10 @@ tool, [postject][]:
$ codesign --sign - hello
```

* On Windows:
* On Windows (optional):

A certificate needs to be present for this to work. However, the unsigned
binary would still be runnable.

```console
$ signtool sign /fd SHA256 hello
Expand Down Expand Up @@ -160,9 +166,11 @@ to help us document them.
[ELF]: https://en.wikipedia.org/wiki/Executable_and_Linkable_Format
[Mach-O]: https://en.wikipedia.org/wiki/Mach-O
[PE]: https://en.wikipedia.org/wiki/Portable_Executable
[Windows SDK]: https://developer.microsoft.com/en-us/windows/downloads/windows-sdk/
[`process.execPath`]: process.md#processexecpath
[`require()`]: modules.md#requireid
[`require.main`]: modules.md#accessing-the-main-module
[fuse]: https://www.electronjs.org/docs/latest/tutorial/fuses
[postject]: https://github.com/nodejs/postject
[signtool]: https://learn.microsoft.com/en-us/windows/win32/seccrypto/signtool
[single executable applications]: https://github.com/nodejs/single-executable