feat(foundryup): avoid unnecessary downloads and verify hashes of downloaded binaries upon install
#10902
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
…ng binaries against artifact, correctly handle releases without artifacts attached
|
Install Install Install Install |
…one currently in use, also make sure to activate it before exiting
zerosnacks
changed the title
foundryup): verify hashes of downloaded binaries upon installfoundryup): avoid unnecessary downloads and verify hashes of downloaded binaries upon install
|
Some scenarios to consider
|
|
Good call!
This is currently the case, see
Done, I did make it so that
This is currently the case, we look now in the versions directory for a matching tag. So instead of matching against |
|
all good tested on Win
|
grandizzy
requested review from
DaniPopes,
klkvr,
mattsse,
grandizzy and
yash-atreya
as code owners
0xrusowsky
previously approved these changes
Jul 7, 2025
good point, yeah, docs should explicitly say that running with |
I've updated the documentation in the book here: https://76c73263.foundry-book.pages.dev/introduction/installation#verifying-the-integrity-and-provenance-of-binaries that points out you can at any time manually verify the integrity of the binary as well (this shows valid matches for all releases going back to the point where this was introduced).
I think once we are sure |
5 tasks
…yup` and inform user update of `foundryup` is available (#10952) * add warning if foundryup installation if out of date prompting user to update * update copy * make sort compliant * avoid overwriting if version is already up to date * clean up * avoid temp file when simply checking the version * clean up, clarifying comments
(CI failures are unrelated) |
0xrusowsky
previously approved these changes
Jul 10, 2025
Co-authored-by: 0xrusowsky <[email protected]>
0xrusowsky
approved these changes
Jul 10, 2025
mattsse
reviewed
Jul 10, 2025
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.
Motivation
Closes: #10755
Closes: #9519
Adds notice prompt to update the
foundryupinstallation when runningfoundryup.Solution
With the release workflow we now generate attestation artifact links alongside the release: nightly-e0d3e2a842fb5fcff4e02ad0ac0ae72bbdd4f5b3
We downloads the attestation artifact
.txtbased on the architecture. If an attestation artifact.txtis found in the release we continue and extract the link from the text file. This link points to the actual attestation artifact (.sigstore). We download this artifact and extract the base64 encoded payload from it, this contains the SHA256 hashes. We store these hashes in a globalHASH_NAMES / HASH_VALUESarrays that we can access later by lookup.Next we check the SHA256 sum of the current binaries of the version to install against the hashes of the verification artifact (so not necessarily the one activated but rather the binaries stored in
~/.foundry/versions/). If these two do not match we can assume the local version is out of date and we need to download the binaries. If there is an exact match we know they are up to date and we can exit early, preventing an unnecessary download. Previously we would always download the binaries no matter what.Finally, once the binaries are downloaded, we match the newly downloaded binaries against the earlier stored
HASH_NAMES / HASH_VALUES. This should always match exactly, if it does not there is a potential security issue as the user is installing a version that is different than the one produced by the release workflow.Includes a
-f / --forceflag to skip verification and force fresh installBecause we versioned
foundryupwe can inform the user their installation is out of date by matching it against the version of the current version onmasterYou can test the functionality by changing
FOUNDRYUP_INSTALLER_VERSION="1.3.0"toFOUNDRYUP_INSTALLER_VERSION="1.0.0"in the PR. If the version of the installer is greater than the one onmasterwe proceed without informing.Steps to test
git clone && git checkout
grandizzy/attestation-url./foundryup/foundryup -i nightly-e0d3e2a842fb5fcff4e02ad0ac0ae72bbdd4f5b3
this tests the verification flow, next rerun:
./foundryup/foundryup -i nightly-e0d3e2a842fb5fcff4e02ad0ac0ae72bbdd4f5b3
this tests the early exit on exact hash match
./foundryup/foundryup -i nightly-e0d3e2a842fb5fcff4e02ad0ac0ae72bbdd4f5b3 --force
this tests the force skipping of verification
Optional:
Change
FOUNDRYUP_INSTALLER_VERSION="1.3.0"toFOUNDRYUP_INSTALLER_VERSION="1.0.0"in./foundrup/foundryup, rerun the steps above. You will see being prompted to update your installer.Note
HASHES[bin]withdeclare -A, this is not compatible with MacOS.To do
PR Checklist