Skip to content
Open
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
11 changes: 8 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@

Notable changes to Innerwall, newest first. Versions follow semantic versioning; before 1.0, a minor version may change anything.

## Unreleased
## v0.5.2 — an entry admits what it says, and renewal survives a suspend

- **The agent renews at once when its renewal point passed while the host was suspended** (#218). The renewal timer runs on the monotonic clock, which stands still while a host is suspended or its VM paused, and the wall clock was read only when a wait was scheduled, never while one was in progress. A host suspended across its renewal point therefore resumed with a timer that still believed hours remained: it reconnected and reported normally and attempted no renewal, and the third of the lifetime kept for retries was spent unseen, leaving only the expired path to recover. Every wait the renewer schedules, the renewal point and each retry, now also has a wall-clock deadline, and the daemon asks the renewer to compare the wall clock with it whenever the sync stream is established and on each heartbeat, moments it has just reached the control plane. A deadline already passed ends the wait at once, and one passed by more than a minute is logged at warning level: `the renewal point passed while the timer was not running (the host was suspended or paused); renewing now`, with the renewal point, the wall clock, and the expiry. The check sends nothing and adds no polling; it never moves the renewal point or re-rolls its jitter, never shortens a wait that has not come due by the wall clock, and leaves the backoff, its caps, and the attempt count as they were. Agent only; nothing in the control plane or the wire contract changes.
One change refuses what was admitted before: an entry typed as a protocol and a separator with nothing after it (`tcp:`, `tcp/`, `udp:`, `udp/`, `icmp:`, `icmp/`) was read as every port of the protocol, or as `icmp`, and is now refused on the command line's `--entry` and in the console's entry inputs (#239). Every port is written as the bare protocol, `tcp`, as it always could be. A script that passes `--entry tcp:` or `--entry tcp/` must pass `--entry tcp` instead. Stored services and rules are unaffected, as are documents and REST bodies, which carry the protocol and its ports as separate fields. Beside it, an agent whose host was suspended across its renewal point renews at once on resume, the console reads entries and refused text as the command line and the control plane do, and the control plane's log names a credential refused past the renewal grace and says where a retired workload's stream ended.

- **The agent renews at once when its renewal point passed while the host was suspended** (#218). The renewal timer runs on the monotonic clock, which stands still while a host is suspended or its VM paused, and the wall clock was read only when a wait was scheduled, never while one was in progress. A host suspended across its renewal point therefore resumed with a timer that still believed hours remained: it reconnected and reported normally and attempted no renewal, and the third of the lifetime kept for retries was spent unseen, leaving only the expired path to recover. Every wait the renewer schedules, the renewal point and each retry, now also has a wall-clock deadline, and the daemon asks the renewer to compare the wall clock with it whenever the sync stream is established and on each heartbeat, moments it has just reached the control plane. A deadline already passed ends the wait at once, and one passed by more than a minute is logged at warning level: `the renewal point passed while the timer was not running (the host was suspended or paused); renewing now`, with the renewal point, the wall clock, and the expiry. The check sends nothing and adds no polling; it never moves the renewal point or re-rolls its jitter, never shortens a wait that has not come due by the wall clock, and leaves the backoff, its caps, and the attempt count as they were. Agent only; nothing in the control plane or the wire contract changes. ADR-0016 takes a dated amendment.
- **The console reads whitespace in an entry as the command line does** (#242). The command line's `--entry`, and the control plane's admission of a document's entry, trim whitespace around the protocol and around each port item, so `tcp :5432` is admitted as `tcp:5432`. The console's entry inputs allowed whitespace only around the whole text and after the separator: a service definition's entry field refused `tcp :5432`, and a rule's services field read it as the name of a service definition, which the save then refused as one that does not exist. Both fields now read whitespace where the control plane does: around the text, between the protocol and the separator, and around each port item (`tcp : 5432, 6012`), and a rule's services field reads such text as an entry. A definition's field, which takes several entries separated by whitespace, keeps whitespace beside a separator, a comma, or a range's dash with the entry it is in (`tcp : 5432, 6000 - 6010 udp/53` is two entries). The refusals of #239 hold with whitespace present (`tcp :`, `tcp :5432, `, ` :5432`, `icmp :`), whitespace inside a protocol is still no entry and inside a port number is still refused, and a service name with spaces that is not shaped as an entry (`tcp proxy`) is still a name. The protocol and each port item are sent trimmed, as before. Console only.
- **An entry with a separator and no ports is refused, not read as every port** (#239). `tcp:` and `tcp/`, a protocol and a separator with nothing after it, were admitted as every port of the protocol, on the command line's `--entry` and in the console's entry inputs (a service definition's entry field and a rule's services field), and nothing said so: a separator typed and the ports forgotten, or a paste cut short, wrote an entry broader than intended. They are now refused, as are `udp:`, `udp/`, and `icmp:`, with a refusal that names both fixes: list the ports, or write the protocol alone. This changes what was admitted: every port of a protocol is written as the bare protocol, `tcp`, which is unchanged, as is `icmp`. The console also dropped an empty item in a port list (`tcp/5432,`, `tcp/,5432`) and now refuses it, as the command line already did; an entry with no protocol (`:5432`), which both surfaces refused as an entry, is now refused in a rule's services field too, where it was read as the name of a service. A document's portless entry (`{"protocol": "tcp"}`, `"ports": []`) has no separator to leave dangling and still means every port; nothing stored or sent changes.
- **An entry with a separator and no ports is refused, not read as every port** (#239). `tcp:` and `tcp/`, a protocol and a separator with nothing after it, were admitted as every port of the protocol, on the command line's `--entry` and in the console's entry inputs (a service definition's entry field and a rule's services field), and nothing said so: a separator typed and the ports forgotten, or a paste cut short, wrote an entry broader than intended. They are now refused, as are `udp:`, `udp/`, `icmp:`, and `icmp/` (the last two read as `icmp` before), with a refusal that names both fixes: list the ports, or write the protocol alone. This changes what was admitted: every port of a protocol is written as the bare protocol, `tcp`, which is unchanged, as is `icmp`, and a script that passes `--entry tcp:` must pass `--entry tcp`. The console also dropped an empty item in a port list (`tcp/5432,`, `tcp/,5432`) and now refuses it, as the command line already did; an entry with no protocol (`:5432`), which both surfaces refused as an entry, is now refused in a rule's services field too, where it was read as the name of a service. A document's portless entry (`{"protocol": "tcp"}`, `"ports": []`) has no separator to leave dangling and still means every port; nothing stored or sent changes.
- **The command line reads the display form of an entry** (#231). `--entry` on `service create` and `service update` read only the colon form (`tcp:5432`), so `tcp/5432`, the form the console, the docs' prose, and the flow surfaces draw an entry in, was read as the protocol `tcp/5432` and refused as unknown. A slash now reads as a colon does, with the same port grammar after it (`tcp/5432`, `udp/53`, `tcp/6000-6010,7000`), as the console's entry inputs already read both (#216); `icmp` is unchanged. Neither character can appear in a protocol name or a port spec, so no entry admitted before changes meaning. Entries are still written as `tcp:5432` by the command line, and nothing stored or sent changes.
- **A peer typed as `key:value` that names no address group says how a label is written** (#233). The policy editor's peer field reads text without an `=` that is not shaped like an address as the name of an address group, so a label typed with the wrong separator, `role:db`, was refused at save as a group that does not exist, with an offer to create one, and nothing pointed at the label the operator meant. Admission takes any non-empty text as a group name, so `role:db` can name a real group and the field still reads it as one. When the write is refused because no such group exists and the name reads as a label with `=` in place of `:` (`role:db`, `app:web env:prod`), the refusal now ends "A label is written key=value: role=db." The offer to create the group stays. A group that exists is saved as before and draws no hint, and addresses and prefixes with colons (`fd00::1`, `2001:db8::/32`) are read as addresses, as before. Console only.
- **A service definition writes nothing while its entry field holds text it refused** (#237). The definition dialog's entry field refuses text that is no entry, such as `5432` with no protocol or `http/80`, and keeps it in the field, marked, with the reason and "The text in the field was not added." Even so, Create service and Save service wrote the entries the chips held and left the typed one out: a service that admits less than the operator composed, and, for a definition rules reference, a write that takes effect at once. Either save now writes nothing while the field holds refused text, by click or from the keyboard, as the policy editor's saves do since #232; the dialog stays open with the refusal beside the field. Valid text left in the field is still taken as it loses focus, and an empty field never holds a save. The address group's CIDR field refuses nothing (admission checks each CIDR) and is held to the same check. Console only.
Expand All @@ -16,6 +18,9 @@ Notable changes to Innerwall, newest first. Versions follow semantic versioning;
- **The console reads the command line's entry form wherever an entry enters** (#216). The command line and the deploy guide write a service entry as `tcp:5432`; the console draws it as `tcp/5432`. A service definition's entry field already read both, but its placeholder and its refusal named only the slash form, and a rule's services field read `tcp:5432` as the name of a service definition, which the save then refused as one that does not exist. Both fields now read an entry through one parser that takes either separator (`tcp:5432`, `tcp/5432`, `udp:53`, `tcp:6000-6010,6012`, `icmp`) and sends the same entry whichever was typed; the definition field's placeholder shows both forms and its refusal names both. Entries are still drawn as `tcp/5432`. Console only.
- **A label typed and left in its field is taken when the field loses focus** (#217). A rule's peer field and the flow map's label filter committed a requirement only on Enter: `role=db` typed and left by clicking or tabbing on stayed text, and a save then failed without saying the value had never been taken. Every chip input that reads labels through the console's label parser (a ruleset's scope, a rule's peers and selectors, the fleet's and the flow map's label filters, the label editor, and the provisioning-token mint) now commits valid text on leaving the field as on Enter, so a save or a mint with a valid label still in the field writes it. Text the parser cannot read stays in the field, marked, with the reason and "The text in the field was not added." Console only.
- **The control plane logs a refusal of a credential expired beyond the renewal grace** (#221). Such a credential is refused at every door until the host is enrolled again, and its agent retries renewal and the sync stream indefinitely, each refusal naming re-enrollment; the control plane logged none of them, while a retired workload's identical retries log one line each, so a host stuck needing re-enrollment read as a stall in the control plane's log. Each refusal now logs `refused a credential expired beyond the renewal grace` at warning level, with `workload_id`, `door`, `expired_at`, and the `grace` in force, one line per refused call like the retired refusal. The transient refusal within the grace, which renewal ends, is not logged. The refusal the agent receives is unchanged. Nothing in the agent or the wire contract changes.
- **Go 1.26.11** (#253). Builds move to Go 1.26.11, whose net/http fixes a crash of an HTTP/1 server in the handling of a size-limited request body (GO-2026-6859). The known-vulnerabilities gate failed on Go 1.26.10 because the operator surface reads every request body through `http.MaxBytesReader`, the login route included, so the affected call is reachable on the operator listener before authentication. The agent gateway does not use it. A control plane that stops leaves enforcement in place: agents fail static and keep their last acknowledged policy (ADR-0011). No Innerwall code changes.

No migrations, no change to the operator API's contract, no agent-contract change: both binaries replace v0.5.1 in place, in either order. The one thing to change before upgrading is a script that passes an entry ending in a separator.

## v0.5.1 — the install docs name their own release

Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ RUN npm run build

# The Go base is pinned to the patch release go.mod requires, so the image
# never builds with an older, unpatched toolchain.
FROM golang:1.26.10-alpine AS build
FROM golang:1.26.11-alpine AS build
# git lets the toolchain stamp the binary with the commit it was built from
# (vcs.revision), which the control plane reports as its version.
RUN apk add --no-cache git
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Open-source microsegmentation for heterogeneous server estates: VMs, bare metal,

A small agent on each workload observes the connections that reach it and programs the operating system's native firewall. A control plane turns label-based policy into per-host rulesets, pushes them over persistent streams, and renders the estate's real traffic as a live dependency map. An operator console embedded in the control plane shows that map, the fleet, the policy, and what enforcing it would break.

**Status: v0.5.1.** Enrollment and short-lived workload identity, the policy sync stream, flow telemetry with evidence gaps, policy authoring with dry runs, simulation, and enforcement on Linux (nftables), and the operator console all work end to end. Releases ship binaries — downloadable, checksummed, and signed — and a published control-plane image, which the Docker Compose quickstart now runs exactly as published, never rebuilding it from the checkout. Install from a release: [docs/reference/versioning-and-install.md](docs/reference/versioning-and-install.md). What is deliberately not built yet, and what comes next, is in [ROADMAP.md](ROADMAP.md); what changed in each release is in [CHANGELOG.md](CHANGELOG.md).
**Status: v0.5.2.** Enrollment and short-lived workload identity, the policy sync stream, flow telemetry with evidence gaps, policy authoring with dry runs, simulation, and enforcement on Linux (nftables), and the operator console all work end to end. Releases ship binaries — downloadable, checksummed, and signed — and a published control-plane image, which the Docker Compose quickstart now runs exactly as published, never rebuilding it from the checkout. Install from a release: [docs/reference/versioning-and-install.md](docs/reference/versioning-and-install.md). What is deliberately not built yet, and what comes next, is in [ROADMAP.md](ROADMAP.md); what changed in each release is in [CHANGELOG.md](CHANGELOG.md).

## The console

Expand Down Expand Up @@ -39,15 +39,15 @@ Each image puts a screen of the shipped console in its dark theme (left) beside
> [!IMPORTANT]
> **Before you start: decide where the agents will run.** The agent runs only on Linux, as root, with nftables. If any agent will run on a machine other than the one running the control plane (always the case when Docker runs on macOS or Windows), first read [Name the control plane before the first start](docs/deploy/multi-host-evaluation.md#name-the-control-plane-before-the-first-start). The gateway's certificate is generated once, at the first start, and names only that machine's local names, so an agent on another machine cannot enroll against it. If the stack already started without the right names, `innerwall ca issue-server` reissues the certificate from the same signing authority and a restart presents it; nothing is enrolled again ([a stack that has already started](docs/deploy/multi-host-evaluation.md#a-stack-that-has-already-started)).

The supported v1 deployment is one control-plane binary and one Postgres (ADR-0017). Run the released image with Docker Compose, or install the released binaries. These docs describe v0.5.1, and every command below names it.
The supported v1 deployment is one control-plane binary and one Postgres (ADR-0017). Run the released image with Docker Compose, or install the released binaries. These docs describe v0.5.2, and every command below names it.

### With Docker Compose

```sh
git clone https://github.com/innerwall-dev/innerwall.git
cd innerwall
git checkout v0.5.1 # the release these docs describe; a fresh clone is main
echo 'INNERWALL_IMAGE=ghcr.io/innerwall-dev/innerwall:0.5.1' > .env
git checkout v0.5.2 # the release these docs describe; a fresh clone is main
echo 'INNERWALL_IMAGE=ghcr.io/innerwall-dev/innerwall:0.5.2' > .env
docker compose up -d # pulls the released control-plane image and starts it with Postgres
```

Expand All @@ -69,7 +69,7 @@ Open `https://localhost:8080/` and log in. The certificate is self-signed, so th

### With the release binaries

The control plane is one binary, for Linux or macOS: download `innerwall_0.5.1_<os>_<arch>.tar.gz`, verify it, and install it as [versioning and install](docs/reference/versioning-and-install.md#install-from-a-release) shows (the agent below takes the same steps). Then, with a reachable Postgres:
The control plane is one binary, for Linux or macOS: download `innerwall_0.5.2_<os>_<arch>.tar.gz`, verify it, and install it as [versioning and install](docs/reference/versioning-and-install.md#install-from-a-release) shows (the agent below takes the same steps). Then, with a reachable Postgres:

```sh
export INNERWALL_DATABASE_URL='postgres://innerwall:innerwall@127.0.0.1:5432/innerwall?sslmode=disable'
Expand Down Expand Up @@ -105,7 +105,7 @@ cp ./state/ca/ca.crt ./ca.crt
On the host to protect, download the agent, verify it against the release's signed checksums, and install it (`ARCH` is `amd64` or `arm64`):

```sh
VERSION=0.5.1 ARCH=amd64
VERSION=0.5.2 ARCH=amd64
ASSET=innerwall-agent_${VERSION}_linux_${ARCH}.tar.gz
base=https://github.com/innerwall-dev/innerwall/releases/download/v$VERSION
for f in "$ASSET" checksums.txt checksums.txt.sig checksums.txt.pem; do curl -fsSLO "$base/$f"; done
Expand Down
2 changes: 1 addition & 1 deletion docs/deploy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
One control-plane binary and one Postgres, co-located or adjacent (ADR-0017). `docker-compose.yml` at the repository root is that deployment. In a checkout of the release's tag, name the release's control-plane image in `.env` and start it:

```sh
echo 'INNERWALL_IMAGE=ghcr.io/innerwall-dev/innerwall:0.5.1' > .env
echo 'INNERWALL_IMAGE=ghcr.io/innerwall-dev/innerwall:0.5.2' > .env
docker compose up -d
```

Expand Down
Loading
Loading