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
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@ uses [Semantic Versioning](https://semver.org/).
lea's CA, trust store, audit volume and proxy address; the supported
versions table up to v0.12.0. `pages.yml` pins its actions by commit
SHA, as `SECURITY.md` says.
- The install steps (README, `docs/install.md`, the site) name cosign
v2.5.0 or later and lockhub's `lox` v0.12.1 or later beside lea v0.16.0
or later: the `lockhttp` formula pulls in neither `lox` nor cosign, and
`lox add` and `lox run` verify every image with cosign (lockssh#44,
lockfamily#70). The brew line is
`brew install davidgodefroid/tap/lockhttp davidgodefroid/tap/lox cosign`.

## [0.12.0] - 2026-11-14

Expand Down
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,19 +66,27 @@ In-agent approval is a convenience; a separate approval process is a boundary.

## Install

lockhttp needs lockhub's `lox` v0.12.1 or later (it passes
`--runtime-gids` to the lockhttp v0.12 console), cosign v2.5.0 or later
(`lox add` and `lox run` verify every image with it) and
[lea](https://github.com/DavidGodefroid/lea) v0.16.0 or later. The
`lockhttp` formula pulls in none of them: name them with it.

```sh
brew trust davidgodefroid/tap
brew install davidgodefroid/tap/lox davidgodefroid/tap/lockhttp
brew install davidgodefroid/tap/lockhttp davidgodefroid/tap/lox cosign
brew install davidgodefroid/tap/lea
```

lockhttp runs in Docker: Homebrew installs the `lockhttp` launcher, which runs
every command in the release's signed image. `lox` is lockhub's CLI, and the
gate runs inside [lea](https://github.com/DavidGodefroid/lea). The whole
family instead: `brew install davidgodefroid/tap/lockfamily`.
family instead, `lox` and cosign included:
`brew install davidgodefroid/tap/lockfamily`.

Without Homebrew, the Lock Family's installer puts the same tools in
`~/.local/bin` ([lockfamily install](https://github.com/DavidGodefroid/lockfamily/blob/main/docs/install.md)):
`~/.local/bin` ([lockfamily install](https://github.com/DavidGodefroid/lockfamily/blob/main/docs/install.md));
cosign v2.5.0 or later must be on `PATH`:

```sh
curl -fsSL https://lockfamily.dev/install.sh | sh
Expand Down
9 changes: 7 additions & 2 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,12 @@ a shell script that runs every command in the release's image
(`ghcr.io/davidgodefroid/lockhttp:X.Y.Z`, amd64 and arm64). With Homebrew:
`brew trust davidgodefroid/tap` (Homebrew asks to trust a third-party tap
once), then `brew install davidgodefroid/tap/lockhttp` (or
`davidgodefroid/tap/lockfamily` for the whole family). Without Homebrew,
`davidgodefroid/tap/lockfamily` for the whole family, `lox` and cosign
included). The `lockhttp` formula pulls in neither `lox` nor cosign: name
them with it, `brew install davidgodefroid/tap/lockhttp davidgodefroid/tap/lox cosign`.
lockhttp v0.12 needs lockhub's `lox` v0.12.1 or later (it passes
`--runtime-gids` to the console) and cosign v2.5.0 or later (`lox add`
and `lox run` verify every image with it). Without Homebrew,
the Lock Family's installer puts the same launcher in `~/.local/bin`
([lockfamily install](https://github.com/DavidGodefroid/lockfamily/blob/main/docs/install.md)):

Expand Down Expand Up @@ -73,7 +78,7 @@ the lock's name): see lockhub's
# 1. Install the Lock Family (lox, lea and the launchers), or only this tool;
# Homebrew asks to trust a third-party tap once
brew trust davidgodefroid/tap
brew install davidgodefroid/tap/lockfamily # or: brew install davidgodefroid/tap/lockhttp
brew install davidgodefroid/tap/lockfamily # or, with lox and cosign: brew install davidgodefroid/tap/lockhttp davidgodefroid/tap/lox cosign
# or the launcher alone: see Install

# 2. In lea's projects directory (LEA_PROJECTS_DIR: lea reads
Expand Down
4 changes: 2 additions & 2 deletions site/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,9 @@ <h1 id="hero-title">Your agent browses. <span class="key">You hold the key.</spa
<div class="install">
<div class="install-head"><span>Install with Homebrew</span></div>
<pre tabindex="0" aria-label="Install commands"><code><span class="cmd">brew trust davidgodefroid/tap</span>
<span class="cmd">brew install davidgodefroid/tap/lox davidgodefroid/tap/lockhttp</span>
<span class="cmd">brew install davidgodefroid/tap/lockhttp davidgodefroid/tap/lox cosign</span>
<span class="cmd">brew install davidgodefroid/tap/lea</span></code></pre>
<p class="install-note">Needs Docker. The gate runs inside <a href="https://github.com/DavidGodefroid/lea">lea</a>, hence its formula. Then <code>lox add lockhttp</code>, <code>lox run</code>, and <code>LEA_LOCKHTTP=1</code> in lea’s <code>lea.conf</code>. The whole family: <code>brew install davidgodefroid/tap/lockfamily</code>.</p>
<p class="install-note">Needs Docker, lockhub’s <code>lox</code> v0.12.1 or later and cosign v2.5.0 or later, which <code>lox</code> verifies every image with. The gate runs inside <a href="https://github.com/DavidGodefroid/lea">lea</a>, hence its formula. Then <code>lox add lockhttp</code>, <code>lox run</code>, and <code>LEA_LOCKHTTP=1</code> in lea’s <code>lea.conf</code>. The whole family, <code>lox</code> and cosign included: <code>brew install davidgodefroid/tap/lockfamily</code>.</p>
</div>
<div class="actions">
<a class="button primary" href="install/">Install guide</a>
Expand Down
13 changes: 7 additions & 6 deletions site/install/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,9 @@ <h2 id="homebrew">With Homebrew</h2>
<div class="install">
<div class="install-head"><span>Install with Homebrew</span></div>
<pre tabindex="0" aria-label="Install commands"><code><span class="cmd">brew trust davidgodefroid/tap</span>
<span class="cmd">brew install davidgodefroid/tap/lox davidgodefroid/tap/lockhttp</span>
<span class="cmd">brew install davidgodefroid/tap/lockhttp davidgodefroid/tap/lox cosign</span>
<span class="cmd">brew install davidgodefroid/tap/lea</span></code></pre>
<p class="install-note">Homebrew asks you to trust a third-party tap once. <code>brew install davidgodefroid/tap/lockfamily</code> installs the whole family instead.</p>
<p class="install-note">Homebrew asks you to trust a third-party tap once. The <code>lockhttp</code> formula pulls in neither <code>lox</code> nor cosign: name them with it. <code>brew install davidgodefroid/tap/lockfamily</code> installs the whole family instead, <code>lox</code> and cosign included.</p>
</div>
<ol class="steps prose">
<li><p>In lea’s projects directory (<code>LEA_PROJECTS_DIR</code>), <code>lox add lockhttp</code> asks only for the lock’s name. It writes the policy, runs <code>lockhttp doctor --fix</code>, shows a short review and starts the console.</p>
Expand All @@ -94,16 +94,17 @@ <h2 id="script">Without Homebrew</h2>
lockhttp version</code></pre>
<div class="prose">
<p>It verifies the cosign signature of each release and of its image. The launcher runs the image by its digest. lea uses this launcher from v0.16.0.</p>
<p>cosign is required. Linux (Docker Engine) and macOS (Docker Desktop); on Windows, WSL 2 with Docker Desktop.</p>
<p>cosign v2.5.0 or later is required. Linux (Docker Engine) and macOS (Docker Desktop); on Windows, WSL 2 with Docker Desktop.</p>
</div>
</section>

<section aria-labelledby="requirements">
<h2 id="requirements">Requirements</h2>
<ul class="prose">
<li>Docker, and <code>cosign</code> for the Lock Family installer.</li>
<li><a href="https://github.com/DavidGodefroid/lea">lea</a>: it runs the agents in containers on internal networks, and runs the gate beside its proxy (Docker, or rootless Podman).</li>
<li><a href="https://github.com/DavidGodefroid/lockhub">lockhub</a>’s <code>lox</code>: the gate runs hub-attached only, and you answer held requests on the hub.</li>
<li>Docker.</li>
<li><a href="https://docs.sigstore.dev/cosign/system_config/installation/">cosign</a> v2.5.0 or later on <code>PATH</code>: <code>lox add</code> and <code>lox run</code> verify every image with it, and the Lock Family installer checks the release’s and the image’s signatures.</li>
<li><a href="https://github.com/DavidGodefroid/lea">lea</a> v0.16.0 or later: it runs the agents in containers on internal networks, and runs the gate beside its proxy (Docker, or rootless Podman).</li>
<li><a href="https://github.com/DavidGodefroid/lockhub">lockhub</a>’s <code>lox</code> v0.12.1 or later: it passes <code>--runtime-gids</code> to the lockhttp v0.12 console; the gate runs hub-attached only, and you answer held requests on the hub.</li>
</ul>
</section>

Expand Down
Loading