Add the require-checksums input (#1139)

Adds `require-checksums`, which enforces the "intrinsic or explicitly
provided checksum" idea. See #1032.

<details>
<summary>Automated notes</summary>

Add the opt-in input `require-checksums`. When enabled, setup-uv
verifies the archive against the workflow's `checksum` input or the
digest bundled for the resolved uv version, architecture, and platform.
If neither is available, setup fails before downloading the archive. By
default, setup-uv continues to accept manifest checksums as it does
today.

The setting also applies to custom manifests, which can still supply
download URLs. On persistent runners, strict mode keys tool-cache
entries by the expected archive digest so a previous manifest-verified
installation cannot bypass the check.

Closes #1032. Builds on #1033.

## Validation

- `npm ci --ignore-scripts` and `npm run all` passed under Node 24 (182
tests).
- The packaged-action regression test installs a custom build into a
temporary runner tool cache. It checks that strict mode rejects a
manifest-only version even with a warm cache, reuses a verified
installation for the same digest, and rejects a changed digest or a
custom build that conflicts with the bundled digest.

</details>

---------

Signed-off-by: William Woodruff <william@yossarian.net>
This commit is contained in:
William Woodruff authored and GitHub committed 2026-11-16 22:24:53 +01:00
1 parent fc0acc2d6f
commit de938e707d
16 files changed
+235 -43

No files matched your search

+3 -1
View File
@@ -15,7 +15,9 @@ This document covers advanced options for configuring which version of uv to ins
Use `latest-known` to install the newest uv version whose checksums were bundled with the version of setup-uv used by your workflow. Version resolution is performed locally without fetching the latest release, so updating setup-uv also updates the version selected by `latest-known`.
When `manifest-file` is set, `latest-known` still selects a version from setup-uv's bundled checksum table, but the artifact and checksum come from the custom manifest.
When `manifest-file` is set, `latest-known` still selects a version from setup-uv's bundled checksum table.
By default the custom manifest supplies the artifact and checksum. To require a bundled or explicitly
supplied checksum, enable `require-checksums`. [Checksum validation](customization.md#validate-checksum)
```yaml
- name: Install the latest version of uv known to setup-uv
+24 -1
View File
@@ -4,7 +4,7 @@ This document covers advanced customization options including checksum validatio
## Validate checksum
Downloaded executables are automatically verified using checksums bundled with this action or,
Downloaded archives are automatically verified using checksums bundled with this action or,
for newer, not yet bundled versions, the checksum from [`astral-sh/versions`](https://github.com/astral-sh/versions).
You can specify a checksum to override those values. The sha256 hashes can also be found on the
[releases page](https://github.com/astral-sh/uv/releases) of the uv repo.
@@ -17,6 +17,29 @@ You can specify a checksum to override those values. The sha256 hashes can also
checksum: "e11b01402ab645392c7ad6044db63d37e4fd1e745e015306993b07695ea5f9f8"
```
For an additional layer of protection, you can set `require-checksums: true`.
This prevents setup-uv from trusting an unknown version's checksum from
[`astral-sh/versions`](https://github.com/astral-sh/versions) *unless* it is also
present in the action's own bundled data *or* explicitly provided with `checksum`.
This can be combined with `version: latest-known` to select the newest bundled release,
meaning that this newer requires an external checksum source:
```yaml
- name: Install the latest known version of uv
uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
with:
version: latest-known
require-checksums: true
```
With this mode, you'll need to update setup-uv itself to get newer uv versions
*unless* you explicitly pass in a `checksum` with a version that post-dates the setup-uv
release.
On runners with a persistent tool cache, this mode reuses only installations previously verified
against the same digest. The first run may download uv again.
## Manifest file
By default, setup-uv reads version metadata from
+1 -1
View File
@@ -38,7 +38,7 @@ Material failures are unauthorized executable selection, credential disclosure,
### Security invariants
1. **Published runtime:** review `action.yml`, committed `dist/*.cjs`, and runner-interpreted shipped files; source-only fixes do not protect consumers.
2. **Executable identity:** precedence is workflow version, version file, project configuration, then `latest`. Manifest authority, platform, variant, URL, checksum, mirror fallback, extraction, and cache placement must bind the intended artifact. A tool-cache hit bypasses download validation and depends on cache provenance.
2. **Executable identity:** precedence is workflow version, version file, project configuration, then `latest`. Manifest authority, platform, variant, URL, checksum, mirror fallback, extraction, and cache placement must bind the intended artifact. A tool-cache hit bypasses download validation and depends on cache provenance. With `require-checksums`, only entries keyed by the explicit or bundled archive digest are eligible.
3. **Credential recipients:** tokens and URL credentials may reach only workflow-authorized origins, redirects, paths, and logs. Metadata authority does not imply token-recipient authority.
4. **Executable boundaries:** checkout-selected interpreters are authorized by default. Explicit workflow selections must win, and independent cache, runner, or remote state must not substitute executables or gain additional authority.
5. **Paths and action channels:** path/environment changes, virtual-environment clearing, outputs, state, and problem matchers must affect only authorized targets and keep untrusted values as data.