Add binary signature verification #558
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
code-asher
force-pushed
the
asher/binary-verification
branch
2 times, most recently
from
753e955 to
3e18934
Compare
The main thing here is to pass in an Axios client instead of the SDK client since this does not need to make API calls and we will need to pass a separate client without headers when downloading external signatures. Otherwise the structure remains the same. Some variables are renamed due to being in a new context and some strings messages are simplified.
A tiny refactor since I will need to get a third config option.
code-asher
force-pushed
the
asher/binary-verification
branch
2 times, most recently
from
33b14b9 to
18c3c88
Compare
code-asher
force-pushed
the
asher/binary-verification
branch
from
18c3c88 to
860b1aa
Compare
They are not needed, and the packaging step will error that it looks like you are trying to package secrets due to the test key fixtures.
aslilac
approved these changes
Jul 25, 2025
| aGN86JBOmwpU87sfFxLI7HdI02DkvlxYYK3vYlA6zEyWaeLZ3VNr6tHcQmOnFe8Q | ||
| 26gcS0AQcxQZrcWTCZ8DJYF+RnXjSVRmHV/3YDts4JyMKcD6QX8s/3aaldk= | ||
| =dLmT | ||
| -----END PGP PUBLIC KEY BLOCK----- |
There was a problem hiding this comment.
Suggested change
| -----END PGP PUBLIC KEY BLOCK----- | |
| -----END PGP PUBLIC KEY BLOCK----- | |
all of the test files have trailing new lines but this one does not
| case VerificationErrorCode.Invalid: | ||
| return "Signature does not match"; | ||
| default: | ||
| return "Failed to read signature"; |
There was a problem hiding this comment.
Suggested change
| return "Failed to read signature"; | |
| return "Failed to verify signature"; |
since this is the default, it might not necessarily be about reading I guess?
| // Download the binary to a temporary file. | ||
| await fs.mkdir(path.dirname(binPath), { recursive: true }); | ||
| const tempFile = | ||
| binPath + ".temp-" + Math.random().toString(36).substring(8); |
There was a problem hiding this comment.
this is such a silly way to get a couple random characters lol. I love it.
| ): Promise<number> { | ||
| const baseUrl = client.defaults.baseURL; | ||
|
|
||
| const controller = new AbortController(); |
There was a problem hiding this comment.
I've known about this api for years and literally never seen someone use it in production. 🥹 so proud!!
Comment on lines
+84
to
+91
| return new VerificationError(VerificationErrorCode.Invalid, error); | ||
| } | ||
| } catch (e) { | ||
| const error = `Failed to read signature or binary: ${errToStr(e)}.`; | ||
| logger?.warn(error); | ||
| return new VerificationError(VerificationErrorCode.Read, error); | ||
| } | ||
| return true; |
There was a problem hiding this comment.
I feel weird about returning errors in js. if these were thrown instead we could do something like...
try {
await verifySignature(...);
// more happy path here
} catch (error) {
if (error instanceof VerificationError) {
// unhappy path here
}
}which is maybe a bit noisier than what you're currently doing, but is also a bit more "when in rome", y'know?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I extracted the download function (since I needed to reuse it to download signatures) to a separate commit so it is easier to review the signature additions separately, if that is of interest.
This downloads the detached signature from Coder if available or releases.coder.com if not, then verifies the binary using that detached signature and the bundled public key. The check is performed only when the binary is first download.