Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
40 changes: 39 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,50 @@ commands, `--json` output and exit codes. Each release's notes start with its se

## [Unreleased]

## [0.5.1] - 2026-10-18

### Changed

- When the system has no CA certificates, the error for a request that cannot start or reach the API
now suggests installing the system CA certificates package (for example `ca-certificates`). The
HTTP client reports that case only as "No CA certificates were loaded from the system".
([#196](https://github.com/Hodeitek/hodeishield-cli/issues/196))
- `--help` no longer prints the values of `HODEISHIELD_API_URL` and `HODEISHIELD_PROFILE` when they
are set in the environment.
- The `login` help, the session notice and the README name the screen where an app's access is
revoked "Account → Applications", as the web app does, and the README and `config set --help`
match the code on `login --no-browser` and the configuration keys.
([#199](https://github.com/Hodeitek/hodeishield-cli/issues/199))
- CI now runs the proxy and TLS inspection test on macOS and Windows as well as Linux.

### Fixed

- Usage errors no longer list `--api-url` or `--profile` in the `Usage:` line when only
`HODEISHIELD_API_URL` or `HODEISHIELD_PROFILE` sets them. The variables still work the same and
`--help` still names them.
([#201](https://github.com/Hodeitek/hodeishield-cli/issues/201))

### Documentation

- The README lists the Linux prerequisites to install and to verify a download, gives a checksum
command that BusyBox also runs, and has Windows steps to check a download and to get Scoop and
cosign.
([#195](https://github.com/Hodeitek/hodeishield-cli/issues/195))
- The README says how to uninstall the archive and `install.sh` installs, in which order (remove the
settings before the binary), what an uninstall leaves behind on Windows, how to remove the zip
and how to check the MSI.
([#197](https://github.com/Hodeitek/hodeishield-cli/issues/197))
- The Quick start points servers and CI from the interactive sign-in to the tenant API key.
([#198](https://github.com/Hodeitek/hodeishield-cli/issues/198))
- The README says that `login` and `logout` exit with code 1 when the system keychain cannot be
reached.
([#200](https://github.com/Hodeitek/hodeishield-cli/issues/200))
- The Install section links to the steps for a binary that macOS or Windows blocks, and the Windows
steps (`Unblock-File`, SmartScreen's "More info → Run anyway") apply to every version.
([#16](https://github.com/Hodeitek/hodeishield-cli/issues/16))
- The README says that two profiles signed in as the same user, to the same tenant, with the same
flow share one sign-in, so logging out of either one signs out both.

## [0.5.0] - 2026-10-15

### Added
Expand Down Expand Up @@ -388,7 +425,8 @@ commands, `--json` output and exit codes. Each release's notes start with its se
- Profiles (`config`), shell completions, and release archives for Linux, macOS and Windows signed
with Sigstore and with SLSA provenance.

[Unreleased]: https://github.com/Hodeitek/hodeishield-cli/compare/v0.5.0...HEAD
[Unreleased]: https://github.com/Hodeitek/hodeishield-cli/compare/v0.5.1...HEAD
[0.5.1]: https://github.com/Hodeitek/hodeishield-cli/compare/v0.5.0...v0.5.1
[0.5.0]: https://github.com/Hodeitek/hodeishield-cli/compare/v0.4.4...v0.5.0
[0.4.4]: https://github.com/Hodeitek/hodeishield-cli/compare/v0.4.3...v0.4.4
[0.4.3]: https://github.com/Hodeitek/hodeishield-cli/compare/v0.4.2...v0.4.3
Expand Down
6 changes: 3 additions & 3 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ default-members = ["crates/hodeishield-api", "crates/hodeishield-cli"]

[workspace.package]
authors = ["Hodeitek S.L. <info@hodeitek.com>"]
version = "0.5.0"
version = "0.5.1"
edition = "2024"
rust-version = "1.98"
license = "Apache-2.0"
Expand Down
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Windows blocks the downloaded binary, see
| Windows x86_64 | `hodeishield-<version>-x86_64-pc-windows-msvc.zip` |
| Windows arm64 | `hodeishield-<version>-aarch64-pc-windows-msvc.zip` (from 0.4.0) |

`<version>` has no leading `v`: release `v0.5.0` ships `hodeishield-0.5.0-…`. The Linux binaries are
`<version>` has no leading `v`: release `v0.5.1` ships `hodeishield-0.5.1-…`. The Linux binaries are
statically linked and run on any distribution. Homebrew and Scoop packages (next section) and a
[container image](#container-image) are also available.

Expand All @@ -76,7 +76,7 @@ neither is part of a distribution's default install.
From source, with the Rust toolchain installed (pin the release tag you want):

```sh
cargo install --locked --git https://github.com/Hodeitek/hodeishield-cli --tag v0.5.0 hodeishield-cli
cargo install --locked --git https://github.com/Hodeitek/hodeishield-cli --tag v0.5.1 hodeishield-cli
```

### Homebrew and Scoop
Expand Down Expand Up @@ -222,7 +222,7 @@ exact version, or better its digest. The image carries no documentation: the
0.4.2, as `USER-INFORMATION.md` in its archives.

```sh
v=0.5.0 # the version you want
v=0.5.1 # the version you want
docker pull ghcr.io/hodeitek/hodeishield-cli:$v
docker run --rm -e HODEISHIELD_API_KEY ghcr.io/hodeitek/hodeishield-cli:$v vendors list
```
Expand All @@ -236,7 +236,7 @@ The image is signed by digest with cosign (keyless) and carries the release's Cy
signed attestation. Verify both before you rely on the image:

```sh
v=0.5.0
v=0.5.1
image=ghcr.io/hodeitek/hodeishield-cli:$v
cosign verify $image \
--certificate-identity https://github.com/Hodeitek/hodeishield-cli/.github/workflows/container-image.yml@refs/tags/v$v \
Expand Down Expand Up @@ -272,11 +272,11 @@ Each release has a `SHA256SUMS` file, a Sigstore bundle (`*.sigstore.json`) for
`SHA256SUMS`, and SLSA provenance (`hodeishield.intoto.jsonl`). In short:

```sh
grep hodeishield-0.5.0-x86_64-unknown-linux-musl.tar.gz SHA256SUMS | sha256sum -c -
grep hodeishield-0.5.1-x86_64-unknown-linux-musl.tar.gz SHA256SUMS | sha256sum -c -

cosign verify-blob hodeishield-0.5.0-x86_64-unknown-linux-musl.tar.gz \
--bundle hodeishield-0.5.0-x86_64-unknown-linux-musl.tar.gz.sigstore.json \
--certificate-identity https://github.com/Hodeitek/hodeishield-cli/.github/workflows/release.yml@refs/tags/v0.5.0 \
cosign verify-blob hodeishield-0.5.1-x86_64-unknown-linux-musl.tar.gz \
--bundle hodeishield-0.5.1-x86_64-unknown-linux-musl.tar.gz.sigstore.json \
--certificate-identity https://github.com/Hodeitek/hodeishield-cli/.github/workflows/release.yml@refs/tags/v0.5.1 \
--certificate-oidc-issuer https://token.actions.githubusercontent.com \
--certificate-github-workflow-trigger push
```
Expand All @@ -287,12 +287,12 @@ On Windows, PowerShell has no `sha256sum`: compare the hash of the zip or MSI wi
fail with a missing-source error), and the same `verify-blob` command works with Windows paths:

```powershell
(Get-FileHash .\hodeishield-0.5.0-x86_64-pc-windows-msvc.zip -Algorithm SHA256).Hash.ToLower()
Select-String hodeishield-0.5.0-x86_64-pc-windows-msvc.zip SHA256SUMS # the two hashes must match
(Get-FileHash .\hodeishield-0.5.1-x86_64-pc-windows-msvc.zip -Algorithm SHA256).Hash.ToLower()
Select-String hodeishield-0.5.1-x86_64-pc-windows-msvc.zip SHA256SUMS # the two hashes must match
# the same two lines with .msi for the MSI
cosign verify-blob .\hodeishield-0.5.0-x86_64-pc-windows-msvc.zip `
--bundle .\hodeishield-0.5.0-x86_64-pc-windows-msvc.zip.sigstore.json `
--certificate-identity https://github.com/Hodeitek/hodeishield-cli/.github/workflows/release.yml@refs/tags/v0.5.0 `
cosign verify-blob .\hodeishield-0.5.1-x86_64-pc-windows-msvc.zip `
--bundle .\hodeishield-0.5.1-x86_64-pc-windows-msvc.zip.sigstore.json `
--certificate-identity https://github.com/Hodeitek/hodeishield-cli/.github/workflows/release.yml@refs/tags/v0.5.1 `
--certificate-oidc-issuer https://token.actions.githubusercontent.com `
--certificate-github-workflow-trigger push
```
Expand Down Expand Up @@ -327,7 +327,7 @@ on the binary, so the block still applies. A download with `curl` does not set i
place:

```sh
curl -LO https://github.com/Hodeitek/hodeishield-cli/releases/download/v0.5.0/hodeishield-0.5.0-universal-apple-darwin.tar.gz
curl -LO https://github.com/Hodeitek/hodeishield-cli/releases/download/v0.5.1/hodeishield-0.5.1-universal-apple-darwin.tar.gz
```

**Windows.** SmartScreen can warn about a signed file that is still new to it, and versions before
Expand Down
2 changes: 1 addition & 1 deletion docs/release-signing.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ an RFC 3161 timestamp from `http://timestamp.acs.microsoft.com`.
- **Switch.** The repository variable `WINDOWS_SIGNING_ENABLED` turns the signing on, and only for a
run started by a pushed `v*` tag.

The signatures of every signed release so far (0.2.0 to 0.5.0) carry:
The signatures of every signed release so far (0.2.0 to 0.5.1) carry:

| Field | Value |
|---|---|
Expand Down
24 changes: 12 additions & 12 deletions docs/verifying-releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,14 @@ From 0.4.2, every archive, `.deb`, `.rpm` and MSI also contains `USER-INFORMATIO
too. The `.deb` and `.rpm` install it in `/usr/share/doc/hodeishield/`, the MSI next to
`hodeishield.exe`.

The steps below use `v0.5.0` and `hodeishield-0.5.0-x86_64-unknown-linux-musl.tar.gz`
The steps below use `v0.5.1` and `hodeishield-0.5.1-x86_64-unknown-linux-musl.tar.gz`
as examples — substitute the actual version and archive you downloaded.

## 1. Download the files

From the release page, download:

- the archive you want (e.g. `hodeishield-0.5.0-x86_64-unknown-linux-musl.tar.gz`)
- the archive you want (e.g. `hodeishield-0.5.1-x86_64-unknown-linux-musl.tar.gz`)
- `SHA256SUMS`
- the matching `<archive>.sigstore.json`
- `SHA256SUMS.sigstore.json`
Expand All @@ -46,7 +46,7 @@ From the release page, download:
## 2. Check the checksum

```sh
grep hodeishield-0.5.0-x86_64-unknown-linux-musl.tar.gz SHA256SUMS | sha256sum -c -
grep hodeishield-0.5.1-x86_64-unknown-linux-musl.tar.gz SHA256SUMS | sha256sum -c -
```

Checking only the line of your archive works with GNU `sha256sum` and with the BusyBox one on
Expand All @@ -65,7 +65,7 @@ in the format cosign v3 reads by default. Older cosign versions cannot read them
```sh
cosign verify-blob \
--bundle SHA256SUMS.sigstore.json \
--certificate-identity https://github.com/Hodeitek/hodeishield-cli/.github/workflows/release.yml@refs/tags/v0.5.0 \
--certificate-identity https://github.com/Hodeitek/hodeishield-cli/.github/workflows/release.yml@refs/tags/v0.5.1 \
--certificate-oidc-issuer https://token.actions.githubusercontent.com \
--certificate-github-workflow-trigger push \
SHA256SUMS
Expand All @@ -75,11 +75,11 @@ Repeat for the archive itself, using its own `.sigstore.json`:

```sh
cosign verify-blob \
--bundle hodeishield-0.5.0-x86_64-unknown-linux-musl.tar.gz.sigstore.json \
--certificate-identity https://github.com/Hodeitek/hodeishield-cli/.github/workflows/release.yml@refs/tags/v0.5.0 \
--bundle hodeishield-0.5.1-x86_64-unknown-linux-musl.tar.gz.sigstore.json \
--certificate-identity https://github.com/Hodeitek/hodeishield-cli/.github/workflows/release.yml@refs/tags/v0.5.1 \
--certificate-oidc-issuer https://token.actions.githubusercontent.com \
--certificate-github-workflow-trigger push \
hodeishield-0.5.0-x86_64-unknown-linux-musl.tar.gz
hodeishield-0.5.1-x86_64-unknown-linux-musl.tar.gz
```

A successful verification confirms the file was signed by the
Expand All @@ -92,11 +92,11 @@ The SBOM is verified the same way, with its own bundle:

```sh
cosign verify-blob \
--bundle hodeishield-0.5.0-x86_64-unknown-linux-musl.cdx.json.sigstore.json \
--certificate-identity https://github.com/Hodeitek/hodeishield-cli/.github/workflows/release.yml@refs/tags/v0.5.0 \
--bundle hodeishield-0.5.1-x86_64-unknown-linux-musl.cdx.json.sigstore.json \
--certificate-identity https://github.com/Hodeitek/hodeishield-cli/.github/workflows/release.yml@refs/tags/v0.5.1 \
--certificate-oidc-issuer https://token.actions.githubusercontent.com \
--certificate-github-workflow-trigger push \
hodeishield-0.5.0-x86_64-unknown-linux-musl.cdx.json
hodeishield-0.5.1-x86_64-unknown-linux-musl.cdx.json
```

## 4. Verify SLSA build provenance
Expand All @@ -105,10 +105,10 @@ Requires [`slsa-verifier`](https://github.com/slsa-framework/slsa-verifier).

```sh
slsa-verifier verify-artifact \
hodeishield-0.5.0-x86_64-unknown-linux-musl.tar.gz \
hodeishield-0.5.1-x86_64-unknown-linux-musl.tar.gz \
--provenance-path hodeishield.intoto.jsonl \
--source-uri github.com/Hodeitek/hodeishield-cli \
--source-tag v0.5.0
--source-tag v0.5.1
```

`hodeishield.intoto.jsonl` is attached to the release and covers every
Expand Down
Loading