9 Commits

Author SHA1 Message Date
Privatae 2043fa5e9e bastion 0.62.0
ci / fuzz (push) Successful in 3m27s
ci / personal-data (push) Successful in 4s
ci / test (push) Successful in 3m39s
2026-11-02 21:31:58 +00:00
Privatae 79646bda13 bastion 0.61.2
ci / personal-data (push) Successful in 5s
ci / test (push) Successful in 3m56s
ci / fuzz (push) Successful in 3m48s
2026-11-02 15:46:29 +00:00
Privatae d4594d18b7 bastion 0.61.1
ci / test (push) Successful in 5m45s
ci / personal-data (push) Successful in 9s
ci / fuzz (push) Successful in 3m30s
2026-11-02 08:00:14 +00:00
Privatae 1176f7fd0b bastion 0.61.0
ci / personal-data (push) Successful in 8s
ci / test (push) Successful in 7m17s
ci / fuzz (push) Successful in 6m33s
2026-11-02 06:20:42 +00:00
Privatae 4f8285ef18 bastion 0.60.0
ci / personal-data (push) Successful in 4s
ci / test (push) Successful in 3m36s
ci / fuzz (push) Successful in 3m35s
2026-11-02 00:10:58 +00:00
Privatae 4a5c310482 bastion 0.58.1
ci / personal-data (push) Successful in 5s
ci / test (push) Successful in 4m6s
ci / fuzz (push) Failing after 2m58s
2026-10-29 21:20:20 +00:00
Privatae 01889e2a48 bastion 0.58.0
ci / personal-data (push) Successful in 4s
ci / test (push) Successful in 4m5s
ci / fuzz (push) Successful in 4m10s
2026-10-29 15:54:51 +00:00
Privatae 081763a675 bastion 0.57.0
ci / personal-data (push) Successful in 4s
ci / test (push) Successful in 4m30s
ci / fuzz (push) Successful in 3m25s
2026-10-28 20:35:45 +00:00
Privatae 4012da0b75 bastion 0.56.0
ci / personal-data (push) Successful in 10s
ci / test (push) Successful in 5m30s
ci / fuzz (push) Successful in 3m16s
2026-10-28 02:24:07 +00:00
232 changed files with 31952 additions and 1567 deletions
+11 -3
View File
@@ -40,11 +40,13 @@ jobs:
# The backup tests check this code against the age command itself: a # The backup tests check this code against the age command itself: a
# pinned age release, its archive checked against the SHA-256 below, # pinned age release, its archive checked against the SHA-256 below,
# and PRIVATAE_REQUIRE_AGE makes those tests fail rather than skip if # and PRIVATAE_REQUIRE_AGE makes those tests fail rather than skip if
# it is missing. # it is missing. openssl is what install.sh checks a release's
# signature with; PRIVATAE_REQUIRE_OPENSSL makes install_sig_sh_test.go
# fail rather than skip without one that does Ed25519.
run: | run: |
docker run --rm --cpus 6 -e GOMAXPROCS=6 -v "$PWD":/src -w /src/client-go \ docker run --rm --cpus 6 -e GOMAXPROCS=6 -v "$PWD":/src -w /src/client-go \
-e GOTOOLCHAIN=local -e CGO_ENABLED=0 -e PRIVATAE_REQUIRE_AGE=1 "$GO_IMAGE" sh -euc ' -e GOTOOLCHAIN=local -e CGO_ENABLED=0 -e PRIVATAE_REQUIRE_AGE=1 -e PRIVATAE_REQUIRE_OPENSSL=1 "$GO_IMAGE" sh -euc '
apk add -q --no-cache poppler-utils python3 setpriv curl git git-daemon apk add -q --no-cache poppler-utils python3 setpriv curl git git-daemon openssl
case "$(uname -m)" in case "$(uname -m)" in
x86_64) a=amd64; sum=cbe24006683f8eb669266162894b9a522a1af52f2665fbc63a4bb032ed26ac10 ;; x86_64) a=amd64; sum=cbe24006683f8eb669266162894b9a522a1af52f2665fbc63a4bb032ed26ac10 ;;
aarch64) a=arm64; sum=6b8dc4333c53a5a57c9e5834e3a48f92605d7154014cd07269ff3327db5d37f4 ;; aarch64) a=arm64; sum=6b8dc4333c53a5a57c9e5834e3a48f92605d7154014cd07269ff3327db5d37f4 ;;
@@ -131,8 +133,14 @@ jobs:
- name: every fuzz target, 5 seconds each - name: every fuzz target, 5 seconds each
# A short pass on every commit. Run deploy/fuzz.sh with its default of # A short pass on every commit. Run deploy/fuzz.sh with its default of
# 20 seconds before changing a wall a host's input goes through. # 20 seconds before changing a wall a host's input goes through.
# fuzz.sh does not fail on Go's own -fuzztime report, on the Go
# releases whose fuzzer reports its deadline as a failure, and fails on
# anything else; test_fuzz.sh checks both, with planted failing
# inputs, before the targets run, and fails once the image's Go no
# longer needs the workaround.
run: | run: |
docker run --rm --cpus 6 -e GOMAXPROCS=6 -v "$PWD":/src -w /src \ docker run --rm --cpus 6 -e GOMAXPROCS=6 -v "$PWD":/src -w /src \
-e GOTOOLCHAIN=local -e CGO_ENABLED=0 "$GO_IMAGE" sh -euc ' -e GOTOOLCHAIN=local -e CGO_ENABLED=0 "$GO_IMAGE" sh -euc '
apk add -q --no-cache bash apk add -q --no-cache bash
bash deploy/test_fuzz.sh
deploy/fuzz.sh 5' deploy/fuzz.sh 5'
+8 -1
View File
@@ -166,6 +166,13 @@ jobs:
git fetch -q --depth=1 "$REPO_URL" "$WANT" git fetch -q --depth=1 "$REPO_URL" "$WANT"
git checkout -q --detach FETCH_HEAD git checkout -q --detach FETCH_HEAD
test "$(git rev-parse HEAD)" = "$WANT" test "$(git rev-parse HEAD)" = "$WANT"
- name: the fuzz runner fails on a failing input and on nothing else
# fuzz.sh does not fail on Go's own -fuzztime report, on the Go
# releases whose fuzzer reports its deadline as a failure, and fails on
# anything else; this checks both, with planted failing inputs, before
# the targets run, and fails once the image's Go no longer needs the
# workaround.
run: bash deploy/test_fuzz.sh
- name: every fuzz target, 5 seconds each - name: every fuzz target, 5 seconds each
# A short pass on every commit. Run deploy/fuzz.sh with its default of # A short pass on every commit. Run deploy/fuzz.sh with its default of
# 20 seconds before changing a wall a host's input goes through. # 20 seconds before changing a wall a host's input goes through.
@@ -236,6 +243,6 @@ jobs:
sudo env PATH="/opt/go-pinned/bin:$PATH" HOME="$HOME" AGE_BIN="$AGE_BIN" PRIVATAE_REQUIRE_AGE=1 GOTOOLCHAIN=local CGO_ENABLED=0 \ sudo env PATH="/opt/go-pinned/bin:$PATH" HOME="$HOME" AGE_BIN="$AGE_BIN" PRIVATAE_REQUIRE_AGE=1 GOTOOLCHAIN=local CGO_ENABLED=0 \
GOFLAGS=-mod=readonly GOMODCACHE="$HOME/go/pkg/mod" GOCACHE="$HOME/.cache/go-build" \ GOFLAGS=-mod=readonly GOMODCACHE="$HOME/go/pkg/mod" GOCACHE="$HOME/.cache/go-build" \
go test -count=1 -json -run "^($tests)\$" . > "$RUNNER_TEMP/claims.json" || { go test -count=1 -json -run "^($tests)\$" . > "$RUNNER_TEMP/claims.json" || {
grep -h '"Action":"fail"' "$RUNNER_TEMP/claims.json" | head -40; exit 1; } bash ../deploy/check-claims.sh --failed "$RUNNER_TEMP/claims.json"; exit 1; }
- name: none of them skipped - name: none of them skipped
run: bash deploy/check-claims.sh --skipped "$RUNNER_TEMP/claims.json" run: bash deploy/check-claims.sh --skipped "$RUNNER_TEMP/claims.json"
+481 -5
View File
@@ -2,11 +2,10 @@
All notable changes to the bastion. All notable changes to the bastion.
The version in `deploy/VERSION` on `main` is the next release, not necessarily The published version is whatever <https://privatae.ai/bastion/version.json>
the one machines run. A merged change waits there until it is published. The names at the moment, and it is the only version a bastion will update to. This
published version is whatever <https://privatae.ai/bastion/version.json> names public repository receives each release after it is published, so its
at the moment, and it is the only version a bastion will update to. Between a `deploy/VERSION` can trail that manifest.
merge and a publish, `main` is ahead of the manifest.
Two things can keep a version listed here from reaching most machines: Two things can keep a version listed here from reaching most machines:
@@ -23,6 +22,483 @@ From 0.39.1 on, a heading marks a version *not published* or *held* once
that is settled. The newest entries may not be published yet; the manifest that is settled. The newest entries may not be published yet; the manifest
says which version is. Older entries are not marked. says which version is. Older entries are not marked.
## 0.62.0
Windows, with the bastion installed for the whole machine (the
`PrivataeBastion` service), from the account that owns the machine:
- **`privatae-bastion ui` opens the console from your own account,** with no
Administrator terminal, as it does on Linux and macOS. It asks the service
over a new pipe, which knows your account from Windows and serves only the
account recorded as the machine's owner. Before this it signed in with a
key of your account's own, which the service's console refused with a bare
401.
- **Your agents and you reach the machine's bastion as on Linux and macOS:**
an agent asks to stop another (`stop`, `request`), reads the machine
(`agents`, `activity`, `status`, `doctor`, the `--json` reads), and you
answer from your own account (`approvals`, `approve`, `deny`, `switch`, the
drops). These were refused beside the service.
- **Moving to the service keeps the machine's pairings.** When an install
moves the bastion from your account to the service, the service takes over
your account's bastion state (pairings, keys, grants, audit) before it first
starts, and the copy in your profile is removed. Every Host it served goes
on being served, and nothing is paired again. The service started empty
before, and the machine went silent to its Hosts.
- **No dead ends.** A console page opened with no session names the command
that opens it on this machine. A second start says which bastion is already
running (its process, its program, how it was started) and how to open,
check or restart it. It no longer suggests ending the running one in Task
Manager.
- **An update never leaves a sign-in task's bastion stopped.** After a
self-update, the new copy waits for the old one to exit before it takes the
machine's run lock. It could find the lock still held, refuse as a second
copy, and leave nothing running.
## 0.61.2
- **A machine a Host holds stops dialling it.** When a Host's owner
quarantines this machine there, the Host refuses each of the bastion's lane
connections, and three of the five lanes dialled again at once, the other
two a second later: tens of connections a second, each a TLS handshake.
Now a refusal holds all of that pairing's lanes for 5 seconds, twice as long
after each further refusal up to 5 minutes; and while the Host's heartbeat
reply says the machine is quarantined, the lanes do not dial at all. The
first reply that no longer says so brings them back. Other Hosts the
machine is paired with are not slowed.
## 0.61.1
- **An op that creates a folder runs on every Linux kernel.** Where the
kernel's overlay keeps an index (or has `redirect_dir` or `metacopy` on, as
Azure's kernel does), it marks each new folder opaque, and the bastion took
that for a replaced folder: every op that created one was refused as "a path
outside the effects in disguise". A new folder is now read as created, with
what it holds; a folder that replaces one the machine holds is still
refused.
## 0.61.0
- **An agent on the machine reads the rest of it.** `agents show <pid|session>`
is one agent in full (its command line in `--json` only, since arguments can
carry a key). `switch --list`, `ops`, `device-approvals`, `backup key show`,
`backup requests` and `backup shares` print as one value with `--json`.
Beside a whole-machine install, the owner's account reads them from the
machine's bastion over its ask socket, as `agents` and `activity` already
were; no other account is answered.
- **`doctor [--json]` says what is wrong with the install**, each problem with
its fix: whether the bastion runs, whether a newer version is published, the
owner account, the machine's second factor, accounts whose asks are held,
each Host pairing, the switch list and the ops sandbox. Exit status 1 on a
problem.
- **The machine's owner answers from their own account.** `approve`, `deny`
and `switch` act on the machine's bastion over its ask socket instead of on
an empty bastion of the account's own. `approve` shows the request and takes
the owner's code at the terminal; `switch … on` takes the code; `deny` and
`switch … off` take nothing, since they only take reach away. Each act is a
line in the machine's audit log naming the account.
- **And takes reach back the same way:** `approvals drop`, `grants drop`,
`ops drop` and `device-deny`. Another account is refused each of them with
the command the administrator would type.
- **The installer checks the release's signature.** `install.sh` verifies the
manifest's signature against the release keys it carries before it downloads
the program, and refuses a signature that does not verify. Where no openssl can
check an Ed25519 signature it says so and keeps the digest check alone, as
before. `install.ps1` still checks the digest only.
- **One Host's folder is never answered for another's store.** On a machine
paired with two Hosts that each hold a store with the same id, one local agent
served both, so the second Host's searches and reads reached the first
Host's folder. Each pairing's stores now have their own agents, and each
Host's heartbeat reports only its own.
- **A stopped pairing's last heartbeat acts on nothing.** A beat out when its
pairing stopped (an unpair, a revoke) came back afterwards and could still
act on the reply, writing into the pairing's folder after an unpair had
removed it. A stopped pairing now waits for its heartbeat, whose request ends
with it.
- On Windows the owner's reads and acts are refused beside the bastion's
service with the administrator's command: there is no ask pipe there yet.
## 0.60.0
- **An agent can follow its own stop request to the end.** `request <id>
[--wait 5m] [--json]`, and `--wait` and `--json` on `stop`, say where an
ask stands: `waiting`, `approved` (being carried out), `stopped`,
`not_stopped` with the reason, `denied`, `refused` or `unknown`. Exit
status is 0 for stopped, 1 for not, and 3 when still waiting after
`--wait`. Each account sees only its own requests.
- **An account whose asks keep being refused is held.** Five refused asks
from one account within ten minutes (the owner denied them, or they were
refused: not an agent, refused in the last day, too many waiting) hold its
asks for ten minutes, doubling on repeats and forgiven after a clean day,
as a Host pairing is held. The owner lifts it with
`quarantine clear --asker <account>`.
- **A deny blocks the same stop for 24 hours from the deny**, not from the
ask.
- **Every row about a request names who asked to stop what.** The asking
account, the asking process and the agent it descends from, and the
target, each with how it was started, on the ask, the approval or denial
and the stop itself. Activity shows asks and denials.
- **An agent in the owner's account reads the whole machine.** Installed for
the whole machine, the bastion keeps its records in root's state. From the
account recorded as the machine's owner, `status`, `agents`, `schedules`,
`tool-servers`, `posture`, `baseline show`, `baseline diff`, `activity`,
`report` and `approvals` now ask the running bastion over its local socket
and show the whole machine, with no sudo and no browser. Any other account
is refused; `agents`, `schedules`, `tool-servers` and `posture` then show
what that account can read itself, and say so.
- **New commands.** `schedules` (scheduled jobs that start an agent),
`tool-servers` (MCP tool servers and what is wrong with each), `posture`
(Linux: the firewall, SSH, fail2ban, security updates, disk and load), and
`baseline show|diff|record`; the `observe:baseline*` names still work.
- **`--json` on `status` and `approvals`**, and `report --out -` prints the
report instead of writing a file. `status` says NOT ANSWERING when the
bastion is installed for the whole machine and its service is not running.
- **What changes for existing installs.**
- No read prints the delegation tag a Host gives an agent; the
administrator's `agents --json` and the report file used to carry it.
- `schedules --json` and `tool-servers --json`, and the same parts of
`report --json`, use snake_case keys like every other read.
- On Linux and macOS, `status`, `activity` and `report` from the owner's
account are no longer refused beside the system service; they read it.
## 0.59.0
- **The bastion works on its own, with no Host.** It keeps watching the
machine with no Host connected, and `status` says it is running on its
own. Connecting a Host is optional and comes last.
- **Every AI agent on the machine, in the console and at a terminal.** The
console's home page lists each agent and what it is doing: for Claude
Code, the session's title, folder, git branch, permission mode and what
it is running now; for the others, the folder and tool servers.
`agents [--json] [--prompts]` prints the same list. None of it goes into
the heartbeat or to a Host.
- **The machine's owner can stop an agent without a Host.** `stop <pid or
session>` at a terminal, or Stop on the agent's page, takes the owner's
code: a second factor for the machine itself, set up with
`stepup-enroll --machine` or the QR code in Settings. An agent can only
file the request; it waits for the owner under Waiting for you, and the
bastion carries it out within two minutes of the approval. Wrong codes are
slowed down after five and locked after a hundred.
- **New console pages.** Waiting for you lists requests from agents,
including agents running under other accounts, and which account asked.
Activity is one timeline of what happened on the machine (`activity`).
This machine shows scheduled jobs that start an agent, problems with tool
servers, and changes since a recorded baseline. Write report saves one
Markdown file of what the bastion knows, prompts left out (`report`).
Settings is in plain words, with the owner's acts as buttons.
- **Installed for the whole machine by default.** On Linux and macOS,
`curl -fsSL https://privatae.ai/bastion/install.sh | sh` from your own
account asks for your password once through sudo and installs the bastion
as the machine's service, so no program running as you, an AI agent
included, can stop it. `--just-me` installs it for your account alone,
with a warning; so does a machine where sudo is missing or refuses. On
Windows, `install.ps1` does the same through one administrator prompt
(`-JustMe` for your account alone). `--personal` and `--shared` are the
new names for `--local` and `--networked`, which still work; on Windows
they are `-Personal` and `-Shared`, and `-Networked` still works.
- **The console opens from the owner's own account.** On a whole-machine
install, `privatae-bastion ui` from the account that installed it opens a
limited console without sudo. It shows everything, and it does whatever
takes the owner's code or only narrows what reaches the machine.
Connecting a Host, setting up the owner's code, choosing the Host in
charge, proposing a folder, approving devices and the disk map need
`sudo -H privatae-bastion ui`, and the pages say so. Any other account is
refused.
- **`privatae-bastion uninstall`.** It removes the service and the program
and keeps the bastion's state and audit log, unless `--delete-data` is
given and confirmed at a terminal. From an ordinary account it removes
only that account's own bastion.
- **What changes for existing installs.**
- A local switch list that cannot be read now refuses everything; it used
to allow everything. `switch --reset` sets the unreadable list aside.
- Marking an agent as yours, and turning a switched-off capability back on
at the console, take the owner's code.
- The Claude Code background service is shown as a service, not counted
as a session.
- On Linux, `pair`, `run`, `status`, `switch`, `activity` and `report`
from an ordinary account beside the system service are refused with the
command to use instead, as on macOS and Windows. They used to act on
that account's own empty state.
- Reinstalling restarts the system service on the new program, and the
installer no longer puts a second bastion in an account beside the
machine's.
- **Documentation.** The README starts with the bastion on its own.
`docs/STATUS.md` says what has run on a real machine, what is tested and
what is only built, for each system; `docs/skills/bastion.md` tells an AI
agent on the machine what it may do with the bastion. The whole-machine
install has run on a fresh Linux machine
(`docs/verification/m0-gate-linux-2026-10-31.md`); the macOS and Windows
installers have not yet run on a real machine.
## 0.58.1
- **An excluded path that names more than one folder now matches.** A
shared folder's grant lists paths no Host may read, and each was compared
with one folder name at a time, so a path written with a slash never
matched. The Host's own default list includes `.config/gcloud`, so a
shared home folder served the Google Cloud command line's sign-in files
through list, stat and read_range. A path such as `.config/gcloud` now
matches that run of folders anywhere under the shared folder, with names
compared the way this machine's file system compares them, as one-folder
paths already were. Every check that reads the excluded paths uses it:
each folder op, the listing walk and both checks on a move plan.
- **The local search agent's own folder is never served.** The agent keeps
its extracted text, its sanitized text, its vectors, its catalog and its
sealed bundles in `.agent` inside the shared folder, and a Host allowed to
read the folder could list it and read the extracted text as it is. List,
stat, read_range and move plans now refuse `.agent` at any depth and in
any case, however the path is written or reached through a link, and say
why. The bastion's own plan reports still go to `.agent/plans`.
- **What flag mode replaces is said exactly.** The note a Host passes on
for a folder searched in flag mode said card, bank and ID numbers were
replaced. It now names what is replaced (e-mail addresses, phone numbers,
card and US social security numbers, IBANs, US routing numbers after a
word such as "routing", Bitcoin addresses that start with 1 or 3, IP and
MAC addresses, private keys and known token formats) and what is never
looked for (names, street addresses, dates of birth, passport, licence
and other ID numbers, other bank account numbers and other crypto
addresses).
- **The documentation says what listens and what each claim's test checks.**
The tunnel holds one UDP port, chosen by the system, which answers nothing
that is not from the paired Host's key; every other port is on loopback.
A coder run reaches nothing on this machine or your network that you did
not name with `--allow-lan`. Nine rows of `docs/claims.md` now say only
what their tests assert. The commands page lists every command, and the
install page the one-line pairing for a Cloud Host. `git-setup` no longer
says the forge can be reached only through the bastion.
## 0.58.0
- **A Host answers four common questions about a machine itself, instead of
handing the person a command to run.** Each is a read-only observe op,
granted under `observe` like the rest of the family and listed in the ops
the machine advertises, so a grant can name it. Each value is checked
against a written rule before anything is read or run, and a refusal says
which rule it broke without repeating the value. Off Linux each answers
`unsupported`.
- `observe:folders <path> [depth]`: the 25 largest folders under an
absolute path, 1 to 3 levels down (2 when not given), and the total, on
that path's own filesystem only, counted the way `du -x` counts (disk
blocks, a file with several links once). Only folders are named, never a
file. What could not be read, and filesystems mounted under the path, are
listed against the folder that holds them, with a reason and a count.
`/proc`, `/sys`, `/dev`, a relative path, a path containing `..` and a
link that leads into those are refused. A walk that runs out of the
20-second budget answers with what it measured and says every size is at
least that. The walk follows no link: a folder swapped for one while it
reads, or reached through one put above it, is listed as changed and not
counted. A read that never returns (a network mount that stopped
answering) is answered without at the budget, and while four such reads
are still waiting no new walk starts.
- `observe:journal <unit> [minutes]`: one systemd unit's journal for the
last 1 to 60 minutes (15 when not given), up to 5000 lines and 200 KB,
newest kept. A name with no type is a service, as with `systemctl`. The
name must be in systemd's unit-name alphabet and one this machine has,
loaded now or installed; otherwise it is refused, with the units whose
names come close. Until now a Host could read logs only from a Loki,
which most machines do not run, so it asked the person to run
`journalctl` instead.
- `observe:logins [hours]`: sshd's failed and accepted logins over the last
1 to 168 hours (24 when not given). Failed attempts are counted and ranked
by source address and by user name, 20 of each; the last 20 accepted
logins come with user, source, method and time. A user name the other
side sent is cut to 32 characters, and anything outside the characters
account names use reads `?`. No raw line, key fingerprint or password is
returned. Only lines written by sshd running as root are read, so another
account on the machine cannot add login lines or bury the real ones under
its own.
- `observe:cert <port> [server name]`: the certificate this machine's own
listener on a TCP port serves: subject, names, issuer, dates, days left,
and whether the chain verifies against this machine's roots for that
name. The port must be one `ss` shows listening here. The handshake goes
to loopback first and otherwise only to an address of this machine the
listener is bound to, never to one another machine could hold.
- **A journal the bastion cannot read is said, not shown as empty.**
`journalctl` run by an account outside the journal's groups shows only that
account's own lines, which would look like a quiet machine. `observe:journal`
and `observe:logins` first check that the bastion can read the system
journal (as root, which is how the networked install runs it, or as a member
of `systemd-journal`) and otherwise answer with the reason;
`observe:logins` then reports its counts as -1, never 0.
- **A grant from now on can be held to a window and a rate, by the
machine.** An op grant's bounds may now carry `_window` (days, from, to and
a zone, read on the machine's own clock; a window may wrap midnight) and
`_rate` (at most so many applies in any 24 hours, and so many seconds
between two). An apply outside them does not run, spends no use and is no
strike toward the quarantine: the answer is `not_now`, exit 75, with the
bound that held it and when it next could run. A dry run is never held, and
an apply with arguments outside the op is still refused as before. The
zone database is in the binary, so a zone reads the same on every machine.
An older bastion refuses both keys as naming no param, so a grant carrying
them fails closed there; the enforcing report says `grant_run_bounds` on a
bastion that holds them.
- **The machine keeps the runs, and who approved.** Each grant's record in
`ops.json` now holds the times of the applies that spent a use, the key
that approved it (the approval device's key, or the factor enrolled at this
console) and the machine's own seal over the record. The rate is counted
from that log, so it holds across a restart. A record edited outside the
bastion holds no grant until it is dropped and approved again, and so does
a grant installed by an older bastion (none was held when this shipped). A
grant whose approving key is no longer pinned is refused; `unpin-device`
drops every grant that key approved, so pinning it again brings none back.
- **`op_grant_drop <grant | all>` takes a grant back from the Host.** It is
a tighten: no quarantine holds it and no approval is asked. A grant not
held here is already gone and is answered as dropped. At the machine,
`ops drop --all` takes back every op grant a Host holds, beside `ops drop
<grant>`.
- **An action op may have no program.** With `interpreter: none` and no
`run` file, an action op's verbs are its whole work. Nothing the Host wrote
executes, so it needs no sandbox and runs on a machine with no overlay. Its
dry run is the verbs' own read of what each would move, and its apply the
verbs and the log checks. Such an op that ships a `run` file is refused,
as is one that names destinations, a builder, reads, or a credential no
verb uses. An op with a program is still refused where the sandbox is not.
A verb whose tool the machine lacks refuses the run as the machine's own
state, never a strike, and the enforcing report now says, for each verb,
whether this machine can run it (`verbs`).
- **On your own machine, an action op reaches the internet, never your
network.** On a machine no fleet has anchored, an action op's destination
is never a private, ULA, CGNAT or reserved address (also inside NAT64 or
6to4): one written as an address is refused when the op arrives, and a
name is refused at apply if any address it resolves to is one. Another
computer of yours is reached through a bastion on that computer. An
anchored machine keeps private destinations, since a fleet's ship steps
reach its own private control planes. A verb's fetch is held the same way
(`tree.checkout` fetching its tree's repository, `k8s.set_image` fetching
its source to check ancestry): the repository's host is checked once and
git is held to that address, so an op with no program reaches no more than
one with a program. On an anchored machine too a verb's fetch is held to
its checked address and is never this machine, its loopback, a link-local
address or a cloud's metadata service. An image `k8s.set_image` would put
live, which the machine's container runtime pulls by name, is refused on
your own machine when its registry is on your network or this machine,
both when a program reports it and when the verb would set it.
`k8s.set_image` now says it needs git as well as kubectl, so a machine
without git is told before a run. What stops working: a ship step on your
own unanchored bastion that deploys to another computer on your LAN,
fetches from a forge on it or rolls an image from a registry on it; and a
verb's fetch needs git 2.37 or newer, which holds a fetch to one address.
## 0.57.0
- **Pairing with a Cloud Host is one pasted line.** A Host's "Set up a
bastion" card now gives a pairing code, `skp_…`, that carries the token,
the Host's enroll address and the SHA-256 of the Host's CA. `pair <code>`
(or the code on standard input after `pair -`) takes the CA from the enroll
port's own TLS chain, keeps it only under that fingerprint and only when the
port's certificate verifies under it for `host.cseries.internal`, then pairs
exactly as `--redeem-url` with `--host-ca` does. There is no certificate
file to save, so the step people skipped ("open host-ca.pem: The system
cannot find the file specified") is gone. `--host-ca` still works as before.
- **The installers pair and start in one go.** `install.sh` with
`PRIVATAE_PAIR_CODE='<code>'` in its environment (the card's line is
`curl -fsSL https://privatae.ai/bastion/install.sh | PRIVATAE_PAIR_CODE='skp_…' sh`)
and `install.ps1 -Pair '<code>'` install or update the bastion as before,
hand the code to `pair -` on standard input, then start the bastion, or restart it when it
was running, and end with one plain sentence and `status`. On Windows that
is the logon task (every running copy is stopped first, so the new one gets
its control port), or the service on a networked machine; on a machine whose
bastion is already the Windows service, `-Pair` pairs that service from an
Administrator PowerShell instead of installing a second bastion. On Linux as
yourself it is a systemd user unit, with lingering asked for and the outcome
said; on macOS a LaunchAgent; as root, the system service. Without the code
both installers behave as they did.
- **The code is in no process's arguments.** On macOS and Linux it comes
only from the environment: an argument would sit in the installer shell's
command line for the whole install, where any user of the machine can read
it with `ps`, and one at the same address could redeem it first. A
process's environment is readable only by its owner and root. `install.sh`
reads the variable before it starts any program and unsets it, so nothing
it starts inherits it. An empty or partial code is refused before the
download. `install.sh` now names no argument it refuses, so a code given in
the wrong place is never printed back. On Windows the code stays a
parameter of the script, inside the person's own PowerShell.
- **On Linux, as yourself, the copy that serves is the one the installer
started.** Before the user unit starts, every copy of your bastion running
outside it (left in a terminal, or from another path) is stopped, as
install.ps1 does on Windows. Otherwise the unit's copy only waits behind the
old one's run lock, and the old copy never reads the new pairing. The
installer then checks for a few seconds that the unit is running and keeps
the same process. A unit that keeps restarting is reported as not running,
with its log command, and the install fails.
- **A local bastion can serve a second Host, when you say so at the machine.**
A local bastion used to serve one Host and refuse any other, so a person
with two Hosts of their own (a Cloud machine beside a platform Host) could
not pair the second at all. `pair` now asks on this machine's terminal,
`/dev/tty` or the Windows console, never standard input, so a code piped
in by an installer still needs a person to answer: "This computer already
serves your Host … Add … as well? [y/N]". Only y or yes adds it; the first
pairing is untouched; with no terminal it is refused. Other callers
(`claim-anchor`, the pairing op) keep the refusal. On a local machine that
serves two Hosts, each changes only the servers it built and stops only the
coder runs it started. The name in the question is the token's, so anything
in it but a plain host name is shown quoted and escaped.
- **`pair` exits 3 when the Host is already paired here.** Nothing changes, and
the installers report it as already connected. Over TCP, with a pairing
code or `--host-ca`, a Host of the same name under another CA (Cloud names
repeat) is a plain refusal, not exit 3, before the redeem and after it. A
pairing code that names a field twice is refused.
- **An enroll port that does not answer says why within 10 seconds.** A Cloud
Host opens its pairing port only to the address the browser used when the
card was opened, for 15 minutes; from anywhere else the port does not
answer, and `pair` used to wait for the system's connect timeout. It now
stops after 10 seconds with that reason and what to do.
- **The local-mode refusal names this system's way to a networked bastion**
(`install.ps1 -Networked` from an Administrator PowerShell on Windows,
`install.sh --networked` as root elsewhere) and says that the Host already
paired would have to be paired again with it. It used to name the Linux
script on Windows.
## 0.56.0
- **New: a Host with no platform can use the model servers on this
computer.** A Host running on this computer, or in a virtual machine on it,
can reach the model servers here (Ollama, a local language model server, a
personal-data filter) by name through the bastion, and is told which of
them it can use. It starts working once your Host supports it.
- **Changed: for a Host with no platform, model management reaches only this
computer.** Listing, downloading and removing models for such a Host now
reach the model server set here only when that server is on this computer.
One set to another computer is refused, and the bastion's log says which
setting is not used and what to set. Such a Host is also told only of
the model servers it can use, and no longer of the service slots, or of
coder runs when it is in a virtual machine, since neither runs for it.
- **Changed: on a local machine, the internet lane reaches only public
addresses.** A Host can no longer use a local machine's internet lane (the
egress lane) to reach devices on your home or office network at their
private addresses, such as 192.168.x.x or 10.x.x.x, or the private ranges
many VPNs use, as was already the case on an anchored machine. Your own
machines are reached through their approved lanes. A device that has a
public address, as many do over IPv6, is still reached at that address.
- **Changed: plain-HTTP requests through the bastion are checked one per
connection.** On the internet lane and a coder run's web proxy, a
plain-HTTP (not HTTPS) connection now carries one request, which is checked
before it is sent on; anything sent after it closes the connection. Before,
later requests on the same connection reached the destination unchecked. A
malformed or ambiguous request is refused, and every refusal now says why.
- **Safer: file access in a folder you shared stays inside it.** When a Host
lists, reads or moves files in a folder you shared with it, the bastion
stays inside that folder. If the folder, or any folder on its path, is later
swapped for a link to somewhere else, the bastion refuses until the folder
is shared again, and a file or folder inside it swapped for a link is never
followed out of it. Search, which goes through the folder's own search
agent, is not part of this change.
- **Safer: the bastion limits how much it holds of what a Host sends.** On
the internet lane, the terminal and root commands, coder runs, the memory
mirror (the copy of your Host's database kept here) and the bastion's
check-in with its Host, a message from the Host is read only up to a set
size and refused past it, or passed along or dropped as it arrives. A Host
can no longer make the bastion hold a message of any size in memory. A
coder run's web proxy now carries at most 1024 connections at once, and the
memory mirror at most 8.
- **Safer: asking to share a folder with a Host has limits.** Any user on the
computer can send that ask to the bastion, so each ask is now read only up
to a set size, and the number of asks open at once is capped, per user and
in total; past the cap, the ask is told the bastion is busy and to try
again.
- **For contributors: the fuzz check in CI no longer fails on a timing bug in
Go's own fuzzer.** A real failure still fails it. The program itself is
unchanged by this.
## 0.55.3 ## 0.55.3
- **A pairing change reaches every Host on the machine at once.** Each pairing - **A pairing change reaches every Host on the machine at once.** Each pairing
+4 -4
View File
@@ -38,10 +38,10 @@ The backup tests also check this code against the age command itself when
one is on PATH or named by `AGE_BIN`; CI installs a pinned age release and one is on PATH or named by `AGE_BIN`; CI installs a pinned age release and
sets `PRIVATAE_REQUIRE_AGE`, so there they fail rather than skip. sets `PRIVATAE_REQUIRE_AGE`, so there they fail rather than skip.
The test suite covers all three platforms' parsing and judgement logic from Most parsing and judgement logic is in files with no build tag and runs under
one `go test` on any OS. Platform-specific decisions live in files with no one `go test` on any OS. Some platform parsers (on Linux and macOS) and the
build tag; only the enumerators are tagged. Keep it that way: a new judgement Linux sandbox are in tagged files, and their tests run only on that OS. A new
goes in an untagged file with a table test. Check it with judgement goes in an untagged file with a table test. Check it with
`GOOS=windows go vet ./...` and `GOOS=darwin go vet ./...` as well: `go build` `GOOS=windows go vet ./...` and `GOOS=darwin go vet ./...` as well: `go build`
does not compile test files, so only vet sees a test that uses a Linux-only does not compile test files, so only vet sees a test that uses a Linux-only
name. name.
+183 -157
View File
@@ -3,56 +3,27 @@
[![License: GPL v3+](https://img.shields.io/badge/license-GPL--3.0--or--later-blue.svg)](LICENSE) [![License: GPL v3+](https://img.shields.io/badge/license-GPL--3.0--or--later-blue.svg)](LICENSE)
[![Go 1.26+](https://img.shields.io/badge/go-1.26%2B-00ADD8.svg)](client-go/go.mod) [![Go 1.26+](https://img.shields.io/badge/go-1.26%2B-00ADD8.svg)](client-go/go.mod)
[![Platforms](https://img.shields.io/badge/platforms-linux%20%7C%20macOS%20%7C%20windows-lightgrey.svg)](#supported-platforms) [![Platforms](https://img.shields.io/badge/platforms-linux%20%7C%20macOS%20%7C%20windows-lightgrey.svg)](#supported-platforms)
[![ci](https://git.privatae.ai/privatae/privatae-bastion/actions/workflows/ci.yml/badge.svg?branch=main)](https://git.privatae.ai/privatae/privatae-bastion/actions) [![ci](https://github.com/Privatae/bastion/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/Privatae/bastion/actions/workflows/ci.yml)
**One static Go binary that gives your AI Host access to a machine without SSH keys: it dials out, checks every signed grant on the machine itself, and keeps its own audit log.** **See every AI agent running on your computer, what each one is doing and what it can reach, and stop any of them. One program, no account, no AI of its own.**
The bastion itself needs no Docker, no Python, no database and no separate
WireGuard install. A few optional features use software the machine must
already have: coder runs, the service slot and the memory mirror need a
container runtime (Docker, Podman or nerdctl); folder search runs the bastion
agent, which needs Python 3.8 or later; host-written ops in Python need
`/usr/bin/python3`; and reading an app's accessibility tree on Linux needs
python3 with its AT-SPI bindings. Without them, those features say what is
missing and the rest works.
You pair the binary with a short token from your host, and from then on your host can reach
this machine only through the tunnel this bastion dials out and the lanes it
gates. Your files stay where they are. Nothing on this machine drives the host:
there is no MCP endpoint here.
The published release is whatever `privatae.ai/bastion/version.json` names.
`deploy/VERSION` on `main` is the next release, which may not be published
yet. From 0.42.0 on, every release manifest is signed and every published
binary can be rebuilt from this source and compared
([Verify a release](#verify-a-release)). See [CHANGELOG.md](CHANGELOG.md).
```sh ```sh
# A server (macOS / Linux, as root): networked, anchored to the first host you pair curl -fsSL https://privatae.ai/bastion/install.sh | sh # macOS, Linux: sudo asks for your password once
curl -fsSL https://privatae.ai/bastion/install.sh | sudo sh privatae-bastion ui # the console, in your browser
sudo -H privatae-bastion pair <token> # token from your host's "Set up a bastion"
sudo -H privatae-bastion stepup-enroll # your second factor, so you can approve here
# Your own computer (macOS / Linux, as you)
curl -fsSL https://privatae.ai/bastion/install.sh | sh
privatae-bastion pair <token>
privatae-bastion run # tunnel + lanes up
``` ```
```powershell ```powershell
# Windows, your own computer irm https://privatae.ai/bastion/install.ps1 | iex # Windows: Windows asks for an administrator's yes once
irm https://privatae.ai/bastion/install.ps1 | iex
privatae-bastion pair <token>
privatae-bastion run
``` ```
A Windows server installs from an Administrator PowerShell with `-Networked`. It starts watching at once. No Host, no sign-up and no network is needed; a
See [Install](#install). Host is something you can connect later ([Works with a Host](#works-with-a-host)).
**AI readers and reviewers:** [docs/README.md](docs/README.md) lists every reference page, one line each, and [docs/claims.md](docs/claims.md) is the full table of security claims and the test behind each. **AI readers and reviewers:** [docs/README.md](docs/README.md) lists every reference page, one line each, and [docs/claims.md](docs/claims.md) is the full table of security claims and the test behind each. [docs/STATUS.md](docs/STATUS.md) says what works today and what does not.
**Contents:** [Why a bastion](#why-a-bastion) · [Install](#install) · **Contents:** [What it sees](#what-it-sees) · [What you can do](#what-you-can-do) ·
[Quick start](#quick-start) · [Local and networked modes](#local-and-networked-modes) · [What it refuses to do](#what-it-refuses-to-do) · [Works with a Host](#works-with-a-host) ·
[Install](#install) · [Your own computer or a shared machine](#your-own-computer-or-a-shared-machine) ·
[Replacing an agent's SSH keys](#replacing-an-agents-ssh-keys) · [Replacing an agent's SSH keys](#replacing-an-agents-ssh-keys) ·
[What the bastion does](#what-the-bastion-does) · [Security model](#security-model) · [What the bastion does](#what-the-bastion-does) · [Security model](#security-model) ·
[How each claim is tested](#how-each-claim-is-tested) · [How each claim is tested](#how-each-claim-is-tested) ·
@@ -60,135 +31,173 @@ See [Install](#install).
[Supported platforms](#supported-platforms) · [Build from source](#build-from-source) · [Supported platforms](#supported-platforms) · [Build from source](#build-from-source) ·
[Verify a release](#verify-a-release) · [Contributing](#contributing) · [License](#license) [Verify a release](#verify-a-release) · [Contributing](#contributing) · [License](#license)
## Why a bastion ## What it sees
A Privatae host is an AI that works for you. To be useful it needs to see your - **Every AI agent on the machine**: Claude Code, Codex, Gemini CLI, aider,
files, use your machine's models, and sometimes act on the machine. The bastion goose, Cline, opencode, Cursor's agent, Open Interpreter, Continue, crush
is the piece that makes that possible **without handing the host your machine**. and Antigravity by their programs, and any other program holding a
connection to a model's API ([`agents.go`](client-go/agents.go)).
- **What each one is doing.** For Claude Code: the session's title, its
folder and git branch, whether permission prompts are off, and the command
it is running now ([`agentsession.go`](client-go/agentsession.go)). For the
others: the folder and the tool servers it runs.
- **Who started it**: you at a terminal here, a remote login, a scheduled job,
a service, or another agent.
- **The scheduled jobs that start agents** (cron and systemd timers, launchd,
Task Scheduler).
- **The problems in their tool-server (MCP) configs**: a key in plain text,
a package that is not pinned to a version, a remote server with no
credential, a server running that no config declares
([`mcpconfig.go`](client-go/mcpconfig.go)).
- **What changed since your baseline**: a new agent, a new schedule, a new
listening port.
The bastion dials your host; your host never dials your machine. No port is The same views are commands, each with `--json`: `agents`, `activity`,
opened on any externally reachable interface (the control ports and the local `report`. A report is one Markdown file of all of it, with no prompts in it.
console bind loopback only; the optional memory-mirror forwarder also binds
the replica container's private gateway address). The only thing your host can reach is the
inside of the tunnel this binary brought up, and what it may do there arrives
as a signed grant that this binary verifies locally. Once you enrol a second
factor on this machine, anything that would move your files, download a model,
or open a root shell waits for you to approve it **here**, with a code the host
never sees.
The result: the host gets a precise, auditable view of what you chose to share, ## What you can do
and you keep the keys. [SECURITY.md](SECURITY.md) says what you still have to
trust, and why. - **Stop an agent**, from the console or `privatae-bastion stop <pid|session>`,
with your code: a six-digit code from an authenticator app on your phone.
- **Answer what agents ask.** An agent can ask the bastion for something (to
stop another agent, say); it waits on **Waiting for you** until you answer
with your code.
- **Mark an agent as yours**, so the ones you did not start stand out.
- **Record a baseline**, and see what is new since.
- **Write a report** of what the bastion knows about this machine.
## What it refuses to do
- **An agent cannot turn it off or widen what it allows.** Installed for the
whole machine (the default), the bastion runs as the system's service, so a
program running as you, an AI agent included, cannot stop it. Your code
lives where only the machine's administrator can read it, so an agent that
drives your browser can click a button but cannot type the code.
- **It sends nothing about this machine anywhere.** With no Host connected
its only outside request is for the list of releases
(`https://privatae.ai/bastion/version.json`, every 6 hours). Session titles
and prompts never leave the machine, even with a Host
([`agentsession.go`](client-go/agentsession.go)).
- **It runs no AI.** Nothing in it calls a model.
- **Its console is this machine's only.** It listens on `127.0.0.1`, and
opens for the machine's administrator and the account recorded as its
owner, nobody else ([console](docs/console.md)).
- **Nothing on this machine drives a Host.** There is no MCP endpoint here.
## Works with a Host
A Privatae Host is an AI that works for you. Connected to one, the bastion is
what lets it see your files, use your machine's models and act on the machine
**without handing it your machine**. The bastion dials your Host; your Host
never dials your machine. The only ports it holds open on an outside interface
are its tunnels' WireGuard UDP ports, and WireGuard drops every packet there
that does not come from that Host's key. What the Host may do arrives as a
signed grant that this binary checks here, and anything that would move your
files, download a model or open a root shell waits for your code
([Security model](#security-model), [SECURITY.md](SECURITY.md)).
```sh
sudo -H privatae-bastion pair <token> # token: your Host's Network app → Set up a bastion
```
A Cloud Host's **Set up a bastion** card gives one line that installs, pairs
and starts the bastion:
`curl -fsSL https://privatae.ai/bastion/install.sh | PRIVATAE_PAIR_CODE='skp_…' sh`, or
on Windows `& ([scriptblock]::Create((irm https://privatae.ai/bastion/install.ps1))) -Pair 'skp_…'`.
The bastion itself needs no Docker, no Python, no database and no separate
WireGuard install. A few features a Host can use need software the machine
must already have: coder runs, the service slot and the memory mirror need a
container runtime (Docker, Podman or nerdctl); folder search runs the bastion
agent, which needs Python 3.8 or later; host-written ops in Python need
`/usr/bin/python3`; and reading an app's accessibility tree on Linux needs
python3 with its AT-SPI bindings. Without them, those features say what is
missing and the rest works.
## Install ## Install
There are two ways to run the bastion, and the installer picks by who runs it. **On your own computer**, run the installer as yourself:
**On a server** (run the installer as root). The bastion is installed as the
machine's system service in **networked** mode (Linux with systemd, or macOS;
on Linux without systemd a root install stays local, with no service), and
the first host you pair becomes its **anchor**. From then on, every terminal and every write on the
machine waits for your approval, and any other host that pairs waits for your
host to approve it.
```sh
curl -fsSL https://privatae.ai/bastion/install.sh | sudo sh
sudo -H privatae-bastion pair <token> # token: your host's Network app → Set up a bastion
sudo -H privatae-bastion stepup-enroll # your second factor, so you can approve here
```
On Windows, from an Administrator PowerShell:
```powershell
& ([scriptblock]::Create((irm https://privatae.ai/bastion/install.ps1))) -Networked
privatae-bastion pair <token>
privatae-bastion stepup-enroll
```
**On your own computer** (run the installer as yourself). The bastion runs
as your user in **local** mode and serves one host. The pairing's
capabilities are the authorization, and approvals work once you enrol a
second factor.
```sh ```sh
curl -fsSL https://privatae.ai/bastion/install.sh | sh curl -fsSL https://privatae.ai/bastion/install.sh | sh
privatae-bastion pair <token>
privatae-bastion run
``` ```
```powershell It installs the bastion **for the whole machine**: the systemd unit
irm https://privatae.ai/bastion/install.ps1 | iex `privatae-bastion` on Linux, the launchd daemon `ai.privatae.bastion` on macOS,
both running as root. sudo asks for your password once. Your account is
recorded as the machine's owner, so `privatae-bastion ui` opens the console
from it without sudo. Then set up your code, at a terminal:
```sh
sudo -H privatae-bastion stepup-enroll --machine
``` ```
A root install that should stay local passes `--local` On Windows, `irm https://privatae.ai/bastion/install.ps1 | iex` does the same
(`… | sudo sh -s -- --local`). Reinstalling over a machine already paired in with the Windows service `PrivataeBastion`, and Windows asks for an
local mode keeps it local unless you pass `--networked`. [Local and networked modes](#local-and-networked-modes) administrator's yes once.
sets out the difference, and [Replacing an agent's SSH keys](#replacing-an-agents-ssh-keys)
how to run a fleet of servers this way. `--just-me` installs it for your account alone, with no sudo
(`curl -fsSL https://privatae.ai/bastion/install.sh | sh -s -- --just-me`;
on Windows `-JustMe`). Any program running as you can then stop it or change
what it allows, and the installer says so. Where sudo is missing or refuses,
that is what the installer falls back to, and it says that too. An install
for your account alone that is already paired stays where it is when you
reinstall.
**On a server**, run the installer as root:
```sh
curl -fsSL https://privatae.ai/bastion/install.sh | sudo sh
sudo -H privatae-bastion pair <token>
sudo -H privatae-bastion stepup-enroll
```
Run as root, it installs the bastion for a **shared machine**: the first Host
you pair is in charge, every terminal and every write on the machine waits for
your approval, and any other Host waits for the one in charge to approve it.
`--personal` or `--shared` chooses either way explicitly.
The installer downloads the binary for your OS and architecture, checks its The installer downloads the binary for your OS and architecture, checks its
SHA-256 against the release manifest, and only then moves it into place; a SHA-256 against the release manifest, and only then moves it into place; a
failed check installs nothing. That manifest comes from the same place as the failed check installs nothing. That manifest comes from the same place as the
binary. To check its signature too, see [Verify a release](#verify-a-release). binary. To check its signature too, see [Verify a release](#verify-a-release).
How the service runs on Linux, macOS and Windows, and where the release `privatae-bastion uninstall` removes the service and the program and keeps the
binaries and the signed release manifest are served from: state, the audit log included; `--delete-data` deletes that too. How the
service runs on each system, and where the release files are served from:
[docs/install.md](docs/install.md). [docs/install.md](docs/install.md).
## Quick start ## Your own computer or a shared machine
On your own computer. For a server, see [Install](#install): the installer | | **your own computer** (`local` in the code) | **a shared machine** (`networked`) |
run as root sets it up networked, and `run` is the service's job.
```sh
privatae-bastion pair <token> # token: your host's "Set up a bastion", one use
privatae-bastion stepup-enroll # your second factor, straight away
privatae-bastion run # tunnel + lanes up; one daemon serves every host you pair
privatae-bastion status # or: privatae-bastion ui, the local console
privatae-bastion add-folder ~/projects/notes "Notes"
```
Pairing generates this machine's keys locally and pulls only its certificate
and routing from the host. Until you enrol a second factor, folder grants and
file moves are gated by the signed grant alone (the host verifies its own
factor), and model downloads and root shells are refused outright. After you
do, every one of those waits for your approval here. Each paired host gets its
own loopback control port, starting at `127.0.0.1:7878`. A shared folder's
files stay on this machine: the host keeps only an index, and you confirm the
share on the host with your code.
## Local and networked modes
| | **local** | **networked** |
|---|---|---| |---|---|---|
| Where | your own computer | a server, or a machine several people share | | Installed by | the installer run as yourself | the installer run as root, or `sudo -H privatae-bastion set-mode networked` |
| Installed by | the installer run as yourself | the installer run as root (Windows: `-Networked`), or `sudo -H privatae-bastion set-mode networked` | | Runs as | the system's service (or your account, with `--just-me`) | the system's service: root under systemd or launchd, LocalSystem on Windows |
| Runs as | your user is fine | the system's service: root under systemd or launchd, LocalSystem on Windows | | A terminal the Host opens | opens on the pairing's capabilities | waits for your approval, for that one session |
| A terminal the host opens | opens on the pairing's capabilities | waits for your approval, for that one session |
| A write (an op, a ship step) | runs on the pairing's capabilities | waits for your approval, bound to that op and its arguments | | A write (an op, a ship step) | runs on the pairing's capabilities | waits for your approval, bound to that op and its arguments |
| Second pairing | refused | waits for the **anchor** host's approval | | A second Host | asked on this computer's terminal, added only on a yes | waits for the approval of the Host in charge |
| The anchor | none | the first host paired, or `claim-anchor` | | The Host in charge | none | the first Host paired, or `claim-anchor` |
In networked mode one host is the **anchor**: the one host that approves every On a shared machine one Host is **in charge** (the code calls it the anchor):
later pairing on this machine. Claiming the anchor requires root, because there the one Host that approves every later pairing on this machine. Putting a Host
is no authority above the box to ask. On a networked machine with no anchor, in charge requires root, because there is no authority above the machine to
the first `pair` run as root anchors it to that host by itself. A machine ask. On a shared machine with none in charge, the first `pair` run as root puts
paired first and switched to networked afterwards is anchored with that Host in charge by itself. A machine paired first and switched to shared
`claim-anchor` and no token: it is a choice among pairings the box already afterwards gets its Host in charge with `claim-anchor` and no token: it is a
holds, and running it again for the same host changes nothing. A token is needed only to name a host this box choice among pairings the machine already holds. A token is needed only to name
does not serve yet (a fresh machine, or `--rotate`). The anchor can be moved to a Host this machine does not serve yet (a fresh machine, or `--rotate`). The
another host only with the current anchor's signed consent, or after 14 days of Host in charge can be changed only with its own signed consent, or after 14
silence from it. days of silence from it.
```sh ```sh
sudo -H privatae-bastion claim-anchor [--owner <name>] [--host <host>] # anchor to a host already paired here sudo -H privatae-bastion claim-anchor [--owner <name>] [--host <host>] # put a Host already paired here in charge
sudo -H privatae-bastion claim-anchor [--owner <name>] <token> # anchor a fresh machine to your host sudo -H privatae-bastion claim-anchor [--owner <name>] <token> # a fresh machine, and your Host in charge
sudo -H privatae-bastion claim-anchor --rotate <token> # move the anchor to a different host sudo -H privatae-bastion claim-anchor --rotate <token> # put a different Host in charge
sudo -H privatae-bastion claim-anchor --repin # same host, new address sudo -H privatae-bastion claim-anchor --repin # same Host, new address
sudo -H privatae-bastion claim-owner <name> # state who owns the machine sudo -H privatae-bastion claim-owner <name> # state who owns the machine
``` ```
`claim-owner` is optional. The name shows on this machine's card in every host `claim-owner` is optional. The name shows on this machine's card in every Host
it serves, and it grants nothing anywhere. it serves, and it grants nothing anywhere.
## Replacing an agent's SSH keys ## Replacing an agent's SSH keys
@@ -242,12 +251,17 @@ its own page, listed with one line each in [docs/README.md](docs/README.md):
Each point in full: [docs/security-model.md](docs/security-model.md); the link after each goes to its detail. Each point in full: [docs/security-model.md](docs/security-model.md); the link after each goes to its detail.
- **The bastion dials out.** Every lane is a reverse connection to the host; - **The bastion dials out.** Every lane is a reverse connection to the host;
no port is opened on an externally reachable interface. ([lanes](docs/lanes.md)) the only ports open on an outside interface are the tunnels' WireGuard
ports, which drop everything not from the host's key. ([lanes](docs/lanes.md))
- **Inside the tunnel, only gated listeners**: up to three inference forwards, - **Inside the tunnel, only gated listeners**: up to three inference forwards,
one port per service-slot server and one per coder run, each checked when a one port per service-slot server and one per coder run, each checked when a
connection is accepted. ([tunnel](docs/lanes.md#tunnel)) connection is accepted. ([tunnel](docs/lanes.md#tunnel))
- **A Host on this machine gets the same walls**: mutual TLS against the CA - **A Host on this machine gets the same walls**: mutual TLS against the CA
pinned at pairing, and the bearer on every lane. ([page](docs/host-on-this-machine.md)) pinned at pairing, and the bearer on every lane. ([page](docs/host-on-this-machine.md))
- **A Host with no platform reaches your model servers by name, never by
address**: it names `ollama`, `llm` or `pii`, and the bastion reaches the
server set on this machine for it, through the forwards' filter, only when
that address is this machine. ([page](docs/host-on-this-machine.md#the-model-servers-on-this-machine))
- **Scoped tunnel.** The WireGuard peer's only allowed address is the paired - **Scoped tunnel.** The WireGuard peer's only allowed address is the paired
host's single tunnel address. ([tunnel](docs/lanes.md#tunnel)) host's single tunnel address. ([tunnel](docs/lanes.md#tunnel))
- **No MCP endpoint.** Nothing on this machine drives the host. - **No MCP endpoint.** Nothing on this machine drives the host.
@@ -266,11 +280,12 @@ Each point in full: [docs/security-model.md](docs/security-model.md); the link a
and never change anything outside their declared file effects. ([ops](docs/ops.md)) and never change anything outside their declared file effects. ([ops](docs/ops.md))
- **A server in the service slot has no network.** The host's tunnel is its - **A server in the service slot has no network.** The host's tunnel is its
only way in. ([service slot](docs/service-slot.md)) only way in. ([service slot](docs/service-slot.md))
- **Egress for someone else reaches the public internet, never this - **Egress for someone else reaches the public internet, and nothing on this
machine**: a coder run's proxy and an anchored machine's egress lane refuse machine or your network that you did not name**: a coder run's proxy and an
internal addresses and this machine's own (a coder run reaches a LAN host anchored machine's egress lane refuse internal addresses and this machine's
you named). A local machine's egress lane refuses this machine and keeps own (a coder run reaches a host you named with `coders set --allow-lan`,
your LAN. An address that reaches this machine only through a 1:1 NAT is even when it is this machine or on your LAN). A local machine's egress lane refuses this machine and your
LAN too; your own machines are reached through their approved lanes. An address that reaches this machine only through a 1:1 NAT is
not covered. ([full text](docs/security-model.md)) not covered. ([full text](docs/security-model.md))
- **A terminal is checked here and logged.** On a local machine it opens when - **A terminal is checked here and logged.** On a local machine it opens when
the host asks; on an anchored one each needs an approval for that session; the host asks; on an anchored one each needs an approval for that session;
@@ -279,7 +294,7 @@ Each point in full: [docs/security-model.md](docs/security-model.md); the link a
anchor host, until the time you chose and at most 30 days; a revoke or anchor host, until the time you chose and at most 30 days; a revoke or
expiry stops a running command within 2 seconds. ([session lane](docs/lanes.md#session-lane)) expiry stops a running command within 2 seconds. ([session lane](docs/lanes.md#session-lane))
- **Root only where there is no one else to ask**: claiming ownership or the - **Root only where there is no one else to ask**: claiming ownership or the
anchor. ([modes](#local-and-networked-modes)) anchor. ([modes](#your-own-computer-or-a-shared-machine))
- **On macOS and Windows, a networked bastion is the system's service**, which - **On macOS and Windows, a networked bastion is the system's service**, which
a signed-in user who does not administer the machine cannot stop. ([install](docs/install.md)) a signed-in user who does not administer the machine cannot stop. ([install](docs/install.md))
- **Observation changes nothing on the machine.** Observe ops read and report; - **Observation changes nothing on the machine.** Observe ops read and report;
@@ -288,10 +303,15 @@ Each point in full: [docs/security-model.md](docs/security-model.md); the link a
that one backup. ([backups](docs/backups.md), [restoring a lost host](docs/backups.md#restoring-a-lost-host)) that one backup. ([backups](docs/backups.md), [restoring a lost host](docs/backups.md#restoring-a-lost-host))
- **No delete op on shared stores.** The one write lane is a move plan you - **No delete op on shared stores.** The one write lane is a move plan you
approved, and it archives. ([DCN stores](docs/context.md#distributed-context-network-dcn-stores)) approved, and it archives. ([DCN stores](docs/context.md#distributed-context-network-dcn-stores))
- **A shared folder serves only what its grant leaves in.** Every read and
move is held to the grant's excludes, `.config/gcloud` and other patterns of
several folders included, and the search agent's own folder (`.agent`) is
never read or moved. ([DCN stores](docs/context.md#distributed-context-network-dcn-stores))
- **Verified releases.** The self-updater checks the manifest's signature and - **Verified releases.** The self-updater checks the manifest's signature and
the binary's SHA-256 before swapping; the release key never reaches the the binary's SHA-256 before swapping; the release key never reaches the
build machine. The installer checks the SHA-256 ([SECURITY.md](SECURITY.md) build machine. The installer checks the SHA-256, and `install.sh` checks the
says what that proves). ([self-update](docs/updates.md)) manifest's signature where the machine's openssl can (OpenSSL 3)
([SECURITY.md](SECURITY.md) says what each proves). ([self-update](docs/updates.md))
- **No secrets cached for git.** The credential helper fetches a token on - **No secrets cached for git.** The credential helper fetches a token on
every auth and stores nothing; which other helpers are kept out depends on every auth and stores nothing; which other helpers are kept out depends on
the git version. ([git lane](docs/lanes.md#git-lane)) the git version. ([git lane](docs/lanes.md#git-lane))
@@ -314,9 +334,9 @@ Development happens in a private repository, and its history is not
published. When a release is published, each change merged since the last one published. When a release is published, each change merged since the last one
arrives on GitHub as a commit with the same files, titled as the change was arrives on GitHub as a commit with the same files, titled as the change was
and dated when it was merged; the copy at git.privatae.ai receives the release and dated when it was merged; the copy at git.privatae.ai receives the release
as one commit. In both, the release is tagged `v<version>` on a commit whose as one commit. In both, the release is tagged `v<version>` (0.55.0 to 0.55.2
tree is identical to the commit the signed release manifest names as were not) on a commit whose tree is identical to the commit the signed release
`built_from`. Every binary can be rebuilt from the tag and compared with the manifest names as `built_from`. Every binary can be rebuilt from the tag and compared with the
published one: see [Verify a release](#verify-a-release). published one: see [Verify a release](#verify-a-release).
Issues and pull requests are welcome on GitHub, at Issues and pull requests are welcome on GitHub, at
@@ -349,7 +369,11 @@ CGO_ENABLED=0 go build -o privatae-bastion .
./privatae-bastion version ./privatae-bastion version
``` ```
Every push runs the same checks in CI (`.gitea/workflows/ci.yml`). Every push to `main` and every pull request into it runs the checks
[CONTRIBUTING.md](CONTRIBUTING.md) asks for in CI: `.github/workflows/ci.yml`
on GitHub, `.gitea/workflows/ci.yml` on git.privatae.ai. On GitHub it also
runs every test [docs/claims.md](docs/claims.md) cites, as root on a machine
of its own, and fails if any of them skips.
To build a specific release rather than the latest source, check out its tag To build a specific release rather than the latest source, check out its tag
first (`git checkout v<version>`). first (`git checkout v<version>`).
@@ -372,8 +396,9 @@ It checks the release manifest's signature against the keys pinned in
`client-go/release_sign.go`, checks out the release's source, rebuilds it, and `client-go/release_sign.go`, checks out the release's source, rebuilds it, and
compares every binary's sha256 with the published one. compares every binary's sha256 with the published one.
Each published release in this repository carries the tag `v<version>` (for From 0.53.2 on, each release in this repository carries the tag `v<version>`
example `v0.54.1`). The manifest's `built_from` names the (for example `v0.54.1`), apart from 0.55.0, 0.55.1 and 0.55.2, which have no
tag. The manifest's `built_from` names the
commit in the repository the release was built in, which is not a commit here, commit in the repository the release was built in, which is not a commit here,
so the script checks out the tag `v<version>` for the version the manifest so the script checks out the tag `v<version>` for the version the manifest
names, and prints which source it used. The tag is annotated and its message names, and prints which source it used. The tag is annotated and its message
@@ -386,8 +411,9 @@ bytes.
If the published version has no tag in your clone, the script says so and If the published version has no tag in your clone, the script says so and
stops without building. If it cannot fetch tags, it says that instead. stops without building. If it cannot fetch tags, it says that instead.
Releases from 0.53.2 on can be checked this way from a clone of this Only a release tagged here can be checked this way from a clone of this
repository; the tags of earlier releases are not in it. repository. A release arrives here after it is published, so the newest one
has no tag here until then.
Each release on GitHub carries the six binaries, the signed manifest Each release on GitHub carries the six binaries, the signed manifest
`version.json`, its signature `version.json.<first 16 hex of its sha256>.sig` `version.json`, its signature `version.json.<first 16 hex of its sha256>.sig`
@@ -405,7 +431,7 @@ go run . verify bastion <dir>/version.json <dir>/version.json.<…>.sig $(go run
``` ```
`deploy/release-assets.sh v<version> <dir>` does all of it from a clone, `deploy/release-assets.sh v<version> <dir>` does all of it from a clone,
rebuild included, for any release from 0.53.2 on. rebuild included, for any release tagged here.
## Contributing ## Contributing
+24 -9
View File
@@ -74,9 +74,22 @@ it was reinstalled by hand.
**The first install.** `curl … | sudo sh` and `irm … | iex` run a script from **The first install.** `curl … | sudo sh` and `irm … | iex` run a script from
our website before any bastion exists to check anything. The installer checks our website before any bastion exists to check anything. The installer checks
the binary's digest against the manifest, but the installer and the manifest the binary's digest against the manifest. `install.sh` also checks the
come from the same place. To avoid trusting that one download, build from manifest's signature against the two pinned release keys, the ones a bastion
source (see the README) or run `deploy/verify-release.sh` before installing. checks its updates with, where the machine's openssl can check Ed25519
(OpenSSL 3: most Linux, or `openssl@3` from Homebrew on a Mac); where it
cannot, it says so and keeps the digest check alone, and it refuses a
signature that does not verify. A script piped from our website is still our
website's, so what the signature adds is for a copy of `install.sh` you read
first, from this repository, and run as root (`sudo sh install.sh`) or for
your account alone (`sh install.sh --just-me`): that copy installs only a
release we signed, whatever the download host serves, though an older release
we signed passes as well as the newest. Run without sudo and without
`--just-me`, it installs for the whole machine through a root step that
fetches the installer from our website again and runs that one, not the copy
you read. `install.ps1` does not check the signature
yet. To avoid trusting any download, build from source (see the README) or
run `deploy/verify-release.sh` before installing.
**Bastion updates.** A bastion never replaces itself on its own. Your host has **Bastion updates.** A bastion never replaces itself on its own. Your host has
to ask, and what it can ask for is limited to what we signed: the update goes to ask, and what it can ask for is limited to what we signed: the update goes
@@ -102,13 +115,15 @@ one installed.
**Checking our work.** Release builds are reproducible. **Checking our work.** Release builds are reproducible.
`deploy/verify-release.sh` fetches the published manifest, checks its `deploy/verify-release.sh` fetches the published manifest, checks its
signature, checks out the release's source, rebuilds it, and compares every signature, checks out the release's source, rebuilds it, and compares every
binary's digest. From 0.53.2 on, each published release in this repository binary's digest. From 0.53.2 on, apart from 0.55.0 to 0.55.2, each release in
carries the annotated tag `v<version>`, whose message records the release's this repository carries the annotated tag `v<version>`, whose message records
`built_from`. That field names the commit in the repository the release was the release's `built_from`. A release arrives here after it is published.
built in, which is not a commit here, so the script uses the tag and prints That field names the commit in the repository the release was built in,
which is not a commit here, so the script uses the tag and prints
which source it used. If the digests match, this source builds the binaries we which source it used. If the digests match, this source builds the binaries we
serve. Releases published before build reproducibility was added (0.40.0 and serve. Only a release tagged here can be checked this way, and releases
earlier) cannot be checked this way. published before build reproducibility was added (0.40.0 and earlier) cannot
be checked at all.
**The agent.** The bastion downloads the bastion agent, runs it, and gives it **The agent.** The bastion downloads the bastion agent, runs it, and gives it
the folder you granted. The agent is a separate program in its own repository the folder you granted. The agent is a separate program in its own repository
+303
View File
@@ -0,0 +1,303 @@
package main
// activity.go — what happened on this machine, newest first, in one list:
// the console's Activity page and `privatae-bastion activity [--since 7d]
// [--json]` (plan Addendum 4, step 3).
//
// It adds no record of its own. It reads the ones this bastion already keeps,
// each the authority for its own kind of fact:
//
// events.json stops, by the owner or a Host, and stops refused
// machine-factor/ the owner's approvals and the stops they carried
// audit.jsonl out or refused
// <pairing>/audit.jsonl what each Host did here (files, stores, op runs)
// mgmt_audit.jsonl each Host's management ops and the verdict
// pairing_audit.jsonl Hosts paired, granted, revoked
// sanctions programs marked as yours, and when
// local-deny.json capabilities switched off for a Host, and when
//
// Each file is read from its tail (activityTailMax), so a long-lived machine
// shows its recent past without reading years of log on every load.
import (
"encoding/json"
"errors"
"fmt"
"io"
"os"
"path/filepath"
"sort"
"strings"
"time"
)
const (
activityTailMax = 256 << 10
activityLimit = 300
)
type activityItem struct {
At time.Time `json:"at"`
Kind string `json:"kind"` // stop, approval, host, change
Who string `json:"who,omitempty"`
What string `json:"what"`
Refused bool `json:"refused,omitempty"`
}
// askedBy is ", asked by <who>" for a row about an agent's ask, else "".
func askedBy(row map[string]any) string {
if who := actStr(row, "who"); who != "" {
return ", asked by " + who
}
return ""
}
func collectActivity(since time.Time) []activityItem {
var out []activityItem
add := func(it activityItem) {
if !it.At.Before(since) && it.What != "" {
out = append(out, it)
}
}
// Stops, as the page and the Host were told them.
if p, err := localEventPath(); err == nil {
for _, e := range loadLocalEvents(p) {
add(activityItem{At: e.At, Kind: "stop", What: e.Text,
Refused: strings.Contains(e.Text, "refused") || strings.Contains(e.Text, "It refused")})
}
}
// The owner's approvals, and stops that did not happen (one that did is
// already an event above).
if dir := existingMachineFactorDir(); dir != "" {
for _, row := range activityRows(filepath.Join(dir, "audit.jsonl")) {
op, decision := actStr(row, "op"), actStr(row, "decision")
switch {
case op == localStopKind && strings.HasPrefix(decision, "not stopped"):
target := actStr(row, "path") // "<pid> <signature>", as localStopOnce writes it
if pid, sig, ok := strings.Cut(target, " "); ok {
target = sig + " (pid " + pid + ")"
}
add(activityItem{At: rowTime(row), Kind: "stop", Who: "You", What: "approved stopping " + target +
", but it was not stopped: " + strings.TrimPrefix(decision, "not stopped: "), Refused: true})
case op == "local_baseline":
add(activityItem{At: rowTime(row), Kind: "change", Who: "You", What: "recorded a new baseline"})
case op == "stepup_approve":
add(activityItem{At: rowTime(row), Kind: "approval", Who: "You",
What: "approved " + purposeWords(strings.TrimPrefix(decision, "approved: ")) + askedBy(row)})
case op == "stepup_deny":
add(activityItem{At: rowTime(row), Kind: "approval", Who: "You", Refused: true,
What: "denied " + purposeWords(strings.TrimPrefix(decision, "denied: ")) + askedBy(row)})
case op == localStopAskOp:
// An agent asked (agentask.go). Who is the asker in the words
// the owner read on the request.
add(activityItem{At: rowTime(row), Kind: "approval", Who: actStr(row, "who"), What: decision})
case op == askHoldOp:
who, what := "This machine", "held asks from "+actStr(row, "path")+" ("+decision+")"
if decision == "lifted by the owner" {
who, what = "You", "lifted the hold on asks from "+actStr(row, "path")
}
add(activityItem{At: rowTime(row), Kind: "approval", Who: who, What: what, Refused: who != "You"})
}
}
}
// What each Host did here.
if cfgs, err := loadPairings(); err == nil {
for _, c := range cfgs {
if !c.active() {
continue // nothing is created for a pending pairing (run.go)
}
for _, row := range activityRows(filepath.Join(c.dcnDir(), "audit.jsonl")) {
decision := actStr(row, "decision")
what := opWords(actStr(row, "op"))
if p := actStr(row, "path"); p != "" {
what += " " + p
}
if decision != "" {
what += " (" + decision + ")"
}
add(activityItem{At: rowTime(row), Kind: "host", Who: "Host " + c.HostName, What: what,
Refused: strings.HasPrefix(decision, "refused") || strings.HasPrefix(decision, "denied")})
}
}
}
if p, err := mgmtAuditPath(); err == nil {
for _, row := range activityRows(p) {
verdict := actStr(row, "verdict")
what := "ran " + actStr(row, "op")
if verdict != "" {
what += " (" + verdict
if why := actStr(row, "why"); why != "" && verdict != "ok" {
what += ": " + why
}
what += ")"
}
add(activityItem{At: rowTime(row), Kind: "host", Who: "Host " + actStr(row, "self"), What: what,
Refused: verdict != "" && verdict != "ok" && verdict != "allowed"})
}
}
if d, err := configDir(); err == nil {
for _, row := range activityRows(filepath.Join(d, auditFilePairing)) {
add(activityItem{At: rowTime(row), Kind: "change", Who: "This machine",
What: opWords(actStr(row, "op")) + " " + actStr(row, "subject") + ": " + actStr(row, "decision"),
Refused: strings.HasPrefix(actStr(row, "decision"), "refused")})
}
}
// The owner's own changes.
if recs, err := sanctionRecords(); err == nil {
for _, r := range recs {
add(activityItem{At: r.At, Kind: "change", Who: "You", What: "marked " + r.describeMark() + " as yours"})
}
}
localDenyMu.Lock()
f, err := localDenyLoad()
localDenyMu.Unlock()
if err == nil {
for key, at := range f.At {
host, fam, _ := strings.Cut(key, "/")
if t, err := time.Parse(time.RFC3339, at); err == nil {
add(activityItem{At: t, Kind: "change", Who: "You", What: "switched " + fam + " off for " + host})
}
}
}
sort.SliceStable(out, func(i, j int) bool { return out[i].At.After(out[j].At) })
if len(out) > activityLimit {
out = out[:activityLimit]
}
return out
}
// activityRows is the JSON rows in the tail of a JSONL file.
func activityRows(path string) []map[string]any {
var rows []map[string]any
for _, line := range tailLines(path, activityTailMax) {
var m map[string]any
if json.Unmarshal(line, &m) == nil {
rows = append(rows, m)
}
}
return rows
}
func actStr(m map[string]any, k string) string { s, _ := m[k].(string); return cleanText(s, 300) }
func rowTime(m map[string]any) time.Time {
t, _ := time.Parse(time.RFC3339, actStr(m, "ts"))
return t
}
// opWords names the ops a person meets most in words; anything else keeps its
// name, which is what the audit file and the Host both call it.
func opWords(op string) string {
switch op {
case "dcn_read", "read_range":
return "read"
case "dcn_list", "list":
return "listed"
case "dcn_stat", "stat":
return "looked at"
case "pair", "pairing_add":
return "Host paired"
case "pairing_grant", "pairing_grant_sync":
return "Host granted"
case "pairing_revoke", "unpair":
return "Host removed"
case "quarantine_clear":
return "Host released from quarantine"
case "claim_owner":
return "owner name set to"
case "stepup_approve":
return "approved"
}
return op
}
// purposeWords says an approval's purpose the way the request said it.
func purposeWords(purpose string) string {
if pid, sig, ok := parseLocalStopPurpose(purpose); ok {
return fmt.Sprintf("stopping %s (pid %d)", sig, pid)
}
if kind, _, _ := strings.Cut(purpose, "|"); kind != "" {
return "a request (" + kind + ")"
}
return "a request"
}
// ── the command ─────────────────────────────────────────────────────────────
const activityUsage = "usage: privatae-bastion activity [--since 7d] [--json]"
func cmdActivity(args []string) error {
sinceFlag, asJSON := "", false
for i := 0; i < len(args); i++ {
switch {
case args[i] == "--json":
asJSON = true
case args[i] == "--since" && i+1 < len(args):
if _, err := parseSince(args[i+1]); err != nil {
return err
}
sinceFlag = args[i+1]
i++
default:
return errors.New(activityUsage)
}
}
v, err := readMachine("activity", readOpts{Since: sinceFlag}, readActivity)
if err != nil {
return laneRefusalError("activity", err)
}
if asJSON {
return printJSON(os.Stdout, v)
}
printActivity(os.Stdout, v.Activity)
return nil
}
// activityRead is `activity`: what happened here, newest first.
type activityRead struct {
Activity []activityItem `json:"activity"`
}
func readActivity(o readOpts) (activityRead, error) {
since, err := o.since(7 * 24 * time.Hour)
if err != nil {
return activityRead{}, err
}
items := collectActivity(time.Now().Add(-since))
if items == nil {
items = []activityItem{}
}
return activityRead{Activity: items}, nil
}
// parseSince takes Go durations and whole days: 90m, 12h, 7d.
func parseSince(s string) (time.Duration, error) {
if d, ok := strings.CutSuffix(s, "d"); ok {
var n int
if _, err := fmt.Sscanf(d, "%d", &n); err == nil && n > 0 && n <= 3650 {
return time.Duration(n) * 24 * time.Hour, nil
}
}
if d, err := time.ParseDuration(s); err == nil && d > 0 {
return d, nil
}
return 0, fmt.Errorf("--since %q: give a duration like 12h or 7d", s)
}
func printActivity(w io.Writer, items []activityItem) {
if len(items) == 0 {
fmt.Fprintln(w, "Nothing has happened on this machine in that time.")
return
}
for _, it := range items {
who := it.Who
if who != "" {
who += " "
}
mark := ""
if it.Refused {
mark = " [refused]"
}
fmt.Fprintf(w, "%s %s%s%s\n", it.At.Local().Format("Jan 2 15:04"), who, it.What, mark)
}
}
+93
View File
@@ -0,0 +1,93 @@
package main
import (
"encoding/json"
"os"
"strings"
"testing"
"time"
)
// activityWorld writes the records the bastion keeps, one of each kind, at
// known times. Everything in them is invented.
func activityWorld(t *testing.T) {
t.Helper()
uiTestConfigDir(t)
now := time.Now().UTC()
p, err := localEventPath()
if err != nil {
t.Fatal(err)
}
ev, _ := json.Marshal([]localEvent{
{Kind: eventContain, At: now.Add(-3 * time.Hour), Text: "You stopped aider (pid 27) running on this machine."},
{Kind: eventContain, At: now.Add(-10 * 24 * time.Hour), Text: "You stopped goose (pid 9) running on this machine."},
})
if err := os.WriteFile(p, ev, 0o600); err != nil {
t.Fatal(err)
}
dir, err := machineFactorDir()
if err != nil {
t.Fatal(err)
}
dcnAudit(dir, "stepup_approve", 0, "", "approved: local_stop|27|aider")
dcnAudit(dir, localStopKind, 0, "31 claude-code", "not stopped: pid 31 is now aider, not the claude-code that was approved")
givenPairing(t, "h1.host.privatae.ai", pairingActive)
if err := localDenySet("h1.host.privatae.ai", "dcn", true); err != nil {
t.Fatal(err)
}
}
func TestActivityGathersEveryRecordNewestFirstAndWithinTheWindow(t *testing.T) {
activityWorld(t)
items := collectActivity(time.Now().Add(-7 * 24 * time.Hour))
var lines []string
for _, it := range items {
lines = append(lines, it.Who+" "+it.What)
}
all := strings.Join(lines, "\n")
for _, want := range []string{
"You stopped aider (pid 27) running on this machine.",
"You approved stopping aider (pid 27)",
"You approved stopping claude-code (pid 31), but it was not stopped: pid 31 is now aider",
"You switched dcn off for h1.host.privatae.ai",
} {
if !strings.Contains(all, want) {
t.Errorf("activity does not say %q:\n%s", want, all)
}
}
if strings.Contains(all, "goose") {
t.Error("a stop older than the window was listed")
}
for i := 1; i < len(items); i++ {
if items[i].At.After(items[i-1].At) {
t.Fatalf("not newest first: %v after %v", items[i].At, items[i-1].At)
}
}
}
func TestTheActivityPageFiltersByKind(t *testing.T) {
activityWorld(t)
u := uiTestServer(t)
h, cookie := u.handler(), uiSignedIn(t, u)
all := uiGet(t, h, "/activity", cookie).Body.String()
if !strings.Contains(all, "You stopped aider") || !strings.Contains(all, "switched dcn off") {
t.Errorf("the page:\n%s", firstLines(all))
}
stops := uiGet(t, h, "/activity?kind=stop", cookie).Body.String()
if !strings.Contains(stops, "You stopped aider") || strings.Contains(stops, "switched dcn off") {
t.Errorf("the stops filter let other kinds through")
}
}
func TestSinceTakesDaysAndDurations(t *testing.T) {
for in, want := range map[string]time.Duration{"7d": 7 * 24 * time.Hour, "12h": 12 * time.Hour, "90m": 90 * time.Minute} {
if got, err := parseSince(in); err != nil || got != want {
t.Errorf("%s = %v %v", in, got, err)
}
}
for _, bad := range []string{"0d", "-1h", "soon", "99999d"} {
if _, err := parseSince(bad); err == nil {
t.Errorf("%q was accepted", bad)
}
}
}
+1 -1
View File
@@ -33,7 +33,7 @@ func cmdAddFolder(host, path, name string) error {
return err return err
} }
if len(cfgs) == 0 { if len(cfgs) == 0 {
return fmt.Errorf("not paired yet — run `privatae-bastion pair <token>` first") return fmt.Errorf("not paired yet — connect a Host first: %s", asAdmin("pair <token>"))
} }
// Multi-homed boxes must NAME the host (0.10.0): guessing here is how a folder // Multi-homed boxes must NAME the host (0.10.0): guessing here is how a folder
// ends up proposed to the wrong entity. One pairing needs no flag. // ends up proposed to the wrong entity. One pairing needs no flag.
+290
View File
@@ -0,0 +1,290 @@
package main
// agentask.go — how something running as a person asks the machine's bastion
// to stop an agent, when the bastion is not theirs.
//
// The bastion installed for the whole machine keeps its state in its own
// account. An agent running as the person cannot write a request there, so
// `stop` run by it had nowhere to ask, and asking is the one thing an agent
// managing the bastion for the person must be able to do (2026-10-30).
// This is the context socket's mechanism (contextsock.go) for a second
// question, and on Windows the service's ask pipe (asklane_windows.go), which
// answers through the same askAnswer: any local account may connect; WHO connected comes from the
// kernel, never from the request; it may only ASK. The ask lands in the
// owner's factor as a pending request (stepup_machine.go), shown on Waiting
// for you and answered with the owner's code. Nothing here approves anything.
//
// Who asked is written into the request from the kernel's record of the
// connecting process: its account, and on Linux its pid, walked up to the
// agent it belongs to, so the owner reads "asked from Claude Code session
// notes-b2", not a sentence the asker wrote.
import (
"encoding/json"
"errors"
"io"
"net"
"os"
"path/filepath"
"runtime"
"strconv"
"sync"
"time"
)
const (
askSockName = "ask.sock"
askMaxBytes = 4 << 10
askSockInFlight = 16
askMaxPendingPer = 5 // waiting requests one account may have at once
)
type agentAskRequest struct {
Op string `json:"op"` // "stop", "status" (askstatus.go), "console" (consolelane.go), "read" (reads.go) or "act" (owneracts.go)
PID int `json:"pid"`
Request string `json:"request,omitempty"` // "status": the id `stop` printed
// "read": which one, and its flags (readOpts).
Read string `json:"read,omitempty"`
Since string `json:"since,omitempty"`
Prompts bool `json:"prompts,omitempty"`
Host string `json:"host,omitempty"`
Machine bool `json:"machine,omitempty"`
// "act": approve, deny or switch (owneracts.go), and what it acts on.
Act string `json:"act,omitempty"`
ID string `json:"id,omitempty"`
Code string `json:"code,omitempty"`
Family string `json:"family,omitempty"`
Off bool `json:"off,omitempty"`
}
type agentAskReply struct {
OK bool `json:"ok"`
Request string `json:"request,omitempty"`
Text string `json:"text,omitempty"`
Why string `json:"why,omitempty"`
User string `json:"user,omitempty"`
URL string `json:"url,omitempty"` // "console": the link that signs the owner in
// "status": where the ask is (askStatus) and, once carried out, what
// happened.
State string `json:"state,omitempty"`
Outcome string `json:"outcome,omitempty"`
}
func askSockPath() string { return filepath.Join(contextSockDir, askSockName) }
// askPeerPIDFn is the kernel's pid for the connecting process: SO_PEERCRED on
// Linux, 0 where the platform does not say (then only the account is named).
var askPeerPIDFn = askPeerPID
// askPeerIdentityFn is the kernel's account for the connecting process; a
// variable so a suite run as root can stand in for the owner's account.
var askPeerIdentityFn = contextPeerIdentity
func startAskSock(done <-chan struct{}) {
if runtime.GOOS == "windows" {
// The ask pipe (asklane_windows.go). Only the service serves it: a
// bastion run by an account is that account's, and nobody else's
// requests are its to answer.
if runningAsService {
startAskPipe(done)
}
return
}
p := askSockPath()
ln, err := contextSockListen(p)
if err != nil {
uilogf("ask socket not available (%v) — an agent running as another account cannot ask "+
"this bastion to stop anything\n", err)
return
}
go func() {
<-done
_ = ln.Close()
_ = os.Remove(p)
}()
go func() {
slots := make(chan struct{}, askSockInFlight)
for {
c, err := ln.Accept()
if err != nil {
return
}
select {
case slots <- struct{}{}:
go func() {
defer func() { <-slots }()
askSockServe(c)
}()
default:
_ = c.Close()
}
}
}()
uilogf("ask socket listening on %s\n", p)
}
var askMu sync.Mutex // one ask filed at a time: the per-account count is read then written
func askSockServe(c net.Conn) {
defer c.Close()
_ = c.SetDeadline(time.Now().Add(10 * time.Second))
uid, user, err := askPeerIdentityFn(c)
if err != nil {
_ = json.NewEncoder(c).Encode(askUnattributable(err))
return
}
var req agentAskRequest
if err := json.NewDecoder(io.LimitReader(c, askMaxBytes)).Decode(&req); err != nil {
_ = json.NewEncoder(c).Encode(agentAskReply{User: user, Why: "the request could not be read"})
return
}
extend := func(d time.Duration) { _ = c.SetDeadline(time.Now().Add(d)) }
_ = json.NewEncoder(c).Encode(askAnswer(askPeer{UID: uid, Name: user}, req, extend,
func() int { return askPeerPIDFn(c) }))
}
// askUnattributable is the answer to a connection whose account the
// operating system would not name.
func askUnattributable(err error) agentAskReply {
return agentAskReply{Why: "this machine could not establish who is asking (" + err.Error() +
"), so nothing was asked. An ask nobody can attribute is one nobody can answer."}
}
// askAnswer is the lane's answer to one request from peer, on either
// platform: ask.sock here, the ask pipe on Windows. extend gives the answer
// more time where it takes longer (a read, an act); pid is the connecting
// process, asked only for a stop.
func askAnswer(peer askPeer, req agentAskRequest, extend func(time.Duration), pid func() int) any {
switch req.Op {
case "console":
r := agentAskReply{User: peer.Name}
if link, err := consoleLaneEntryFor(peer); err != nil {
r.Why = err.Error()
} else {
r.OK, r.URL = true, link
}
return r
case "status":
return askStatus(existingMachineFactorDir(), req.Request, peer.Name, false)
case "read":
extend(readDeadline)
return serveReadFor(peer, req)
case "act":
extend(30 * time.Second)
return serveActFor(peer, req)
}
return fileAsk(req, peer.Name, pid())
}
// fileAsk turns one ask into a pending request of the machine, or says why not.
func fileAsk(req agentAskRequest, user string, peerPID int) agentAskReply {
r := agentAskReply{User: user}
if req.Op != "stop" {
r.Why = "this bastion is only asked to stop agents"
return r
}
dir := existingMachineFactorDir()
if !stepupEnrolled(dir) {
r.Why = "the owner of this machine has not set up their code, so nothing can be asked of it yet"
return r
}
now := time.Now()
if until := askHeldUntil(dir, user, now); !until.IsZero() {
r.Why = askHoldRefusal(user, until)
return r
}
// A refusal that is the asker's own doing counts toward its hold.
refuse := func(why string) agentAskReply {
askStrike(dir, user, now)
r.Why = why
return r
}
observed := observedAgentMap()
if why := stopRefusal(req.PID, observed); why != "" {
return refuse(why)
}
a := observed[req.PID]
purpose, err := purposeForLocalStop(req.PID, a.Signature)
if err != nil {
r.Why = err.Error()
return r
}
view := buildAgentViews([]agentObs{a}, processTree())[0]
details := map[string]any{"kind": localStopKind, "pid": strconv.Itoa(req.PID), "signature": a.Signature,
"agent": familyLabel(a.Signature)}
if view.Folder != "" {
details["folder"] = view.Folder
}
if view.Self != nil {
details["session"], details["title"] = view.Self.Name, view.Self.Title
}
by := "a program running as " + user
if peerPID > 1 {
if who, ok := askingAgent(peerPID, observed); ok {
by = who + ", running as " + user
}
}
details["asked_by"] = by
details["asker"], details["target"] = askParties(user, peerPID, req.PID, observed)
askMu.Lock()
defer askMu.Unlock()
// Asking again for a stop this account already has waiting is the same
// request (stepupNewRequest hands it back), not a new one over the limit.
if n, same := askPendingBy(dir, user, purpose); n >= askMaxPendingPer && !same {
return refuse("you already have " + strconv.Itoa(askMaxPendingPer) + " requests waiting for the owner; " +
"wait for them to be answered")
}
details["asked_by_account"] = user
id, err := stepupNewRequest(dir, purpose, details)
if errors.Is(err, errRefusedRecently) {
return refuse("the machine's owner refused this same stop within the last 24 hours, so it cannot be " +
"asked again yet")
}
if err != nil {
r.Why = err.Error()
return r
}
r.OK, r.Request, r.Text = true, id[:8], describeRequest(stepupRequest{Details: details})
auditLocalStopAsk(dir, req.PID, a.Signature, details)
return r
}
// auditLocalStopAsk records that an ask was filed, naming who asked for what.
func auditLocalStopAsk(dir string, pid int, signature string, details map[string]any) {
dcnAuditWith(dir, localStopAskOp, 0, strconv.Itoa(pid)+" "+signature,
"asked to stop "+describeStopTarget(details), askPartiesOf(details))
}
const localStopAskOp = "local_stop_ask"
// askPendingBy is how many requests user has waiting, and whether one of them
// is for purpose.
func askPendingBy(dir, user, purpose string) (n int, same bool) {
stepupMu.Lock()
m := requestsLoad(dir)
stepupMu.Unlock()
for _, id := range sortedPending(m) {
if a, _ := m[id].Details["asked_by_account"].(string); a == user {
n++
same = same || m[id].Purpose == purpose
}
}
return n, same
}
// askViaSock is the asking side: `stop` run where it cannot write the
// machine's state itself.
func askViaSock(req agentAskRequest) (agentAskReply, error) {
c, err := dialAskLane(askSockPath())
if err != nil {
return agentAskReply{}, err
}
defer c.Close()
_ = c.SetDeadline(time.Now().Add(15 * time.Second))
if err := json.NewEncoder(c).Encode(req); err != nil {
return agentAskReply{}, err
}
var r agentAskReply
err = json.NewDecoder(io.LimitReader(c, askMaxBytes*4)).Decode(&r)
return r, err
}
+27
View File
@@ -0,0 +1,27 @@
//go:build linux
package main
import (
"net"
"golang.org/x/sys/unix"
)
func askPeerPID(c net.Conn) int {
uc, ok := c.(*net.UnixConn)
if !ok {
return 0
}
raw, err := uc.SyscallConn()
if err != nil {
return 0
}
pid := 0
_ = raw.Control(func(fd uintptr) {
if cred, err := unix.GetsockoptUcred(int(fd), unix.SOL_SOCKET, unix.SO_PEERCRED); err == nil {
pid = int(cred.Pid)
}
})
return pid
}
+8
View File
@@ -0,0 +1,8 @@
//go:build !linux
package main
import "net"
// Off Linux only the account is named; the asking agent is not walked to.
func askPeerPID(net.Conn) int { return 0 }
+92
View File
@@ -0,0 +1,92 @@
package main
import (
"strings"
"testing"
)
func askWorld(t *testing.T, enrol bool) string {
t.Helper()
uiTestConfigDir(t)
stubStopWorld(t, []agentObs{
{PID: 101, Kind: kindAgent, Signature: "aider", User: "u"},
{PID: 102, Kind: kindAgent, Signature: "aider", User: "u"},
{PID: 103, Kind: kindAgent, Signature: "aider", User: "u"},
{PID: 104, Kind: kindAgent, Signature: "aider", User: "u"},
{PID: 105, Kind: kindAgent, Signature: "aider", User: "u"},
{PID: 106, Kind: kindAgent, Signature: "aider", User: "u"},
{PID: 300, Kind: kindAgent, Signature: "claude-code", User: "u"},
{PID: 4532, Kind: kindApp, Signature: "claude-desktop", User: "u"},
}, map[int]int{310: 300, 311: 310}) // 311: a shell the claude-code session started
prev := homeForUserFn
t.Cleanup(func() { homeForUserFn = prev })
homeForUserFn = func(string) string { return "" }
d, err := machineFactorDir()
if err != nil {
t.Fatal(err)
}
if enrol {
enrolFactorAt(t, d, machineTestSecret)
}
return d
}
// An ask from another account becomes a pending request naming the agent
// that asked, from the kernel's pid, and approves nothing.
func TestAnAskBecomesARequestNamingTheAgentThatAsked(t *testing.T) {
d := askWorld(t, true)
r := fileAsk(agentAskRequest{Op: "stop", PID: 101}, "u", 311)
if !r.OK {
t.Fatalf("refused: %s", r.Why)
}
if !strings.Contains(r.Text, "Asked from Claude Code (pid 300), running as u.") {
t.Errorf("the request reads %q", r.Text)
}
pending := sortedPending(requestsLoad(d))
if len(pending) != 1 {
t.Fatalf("pending %v", pending)
}
for _, a := range approvalsLoad(d) {
t.Fatalf("an ask produced an approval: %+v", a)
}
}
func TestAnAskIsRefusedWithoutTheOwnersCodeOrForAnApp(t *testing.T) {
askWorld(t, false)
if r := fileAsk(agentAskRequest{Op: "stop", PID: 101}, "u", 0); r.OK || !strings.Contains(r.Why, "not set up their code") {
t.Errorf("no owner code: %+v", r)
}
askWorld(t, true)
if r := fileAsk(agentAskRequest{Op: "stop", PID: 4532}, "u", 0); r.OK || !strings.Contains(r.Why, "an app you are running") {
t.Errorf("an app: %+v", r)
}
if r := fileAsk(agentAskRequest{Op: "approve", PID: 101}, "u", 0); r.OK {
t.Errorf("an op other than stop was filed: %+v", r)
}
}
// One account cannot bury the owner in requests.
func TestOneAccountHasAtMostFiveAsksWaiting(t *testing.T) {
d := askWorld(t, true)
for i := 0; i < askMaxPendingPer; i++ {
if r := fileAsk(agentAskRequest{Op: "stop", PID: 101 + i}, "u", 0); !r.OK {
t.Fatalf("ask %d refused: %s", i+1, r.Why)
}
}
if r := fileAsk(agentAskRequest{Op: "stop", PID: 106}, "u", 0); r.OK || !strings.Contains(r.Why, "already have 5") {
t.Errorf("the sixth: %+v", r)
}
if r := fileAsk(agentAskRequest{Op: "stop", PID: 106}, "other", 0); !r.OK {
t.Errorf("another account was held to the first one's count: %s", r.Why)
}
// Asking again for the same agent is the same request, not another one:
// it is handed back (so the asker can follow it), and nothing new is filed.
before := len(sortedPending(requestsLoad(d)))
if r := fileAsk(agentAskRequest{Op: "stop", PID: 101}, "u", 0); !r.OK ||
requestsLoad(d)[fullRequestID(t, d, r.Request)].Details["pid"] != "101" {
t.Errorf("a repeat ask past the cap: %+v", r)
}
if after := len(sortedPending(requestsLoad(d))); after != before {
t.Errorf("a repeat ask past the cap filed a new request: %d -> %d pending", before, after)
}
}
+68 -7
View File
@@ -512,6 +512,33 @@ func resolveLLMIPs() map[string]string {
// to the anchor host, because approving is the anchor's job. "" = no pairing // to the anchor host, because approving is the anchor's job. "" = no pairing
// identity (tests, tools): mode, anchor and unapproved attempts still travel. // identity (tests, tools): mode, anchor and unapproved attempts still travel.
func buildHeartbeatBody(self, hostname, platform, version, wgPub, fingerprint, tunnelIP, endpoint string, func buildHeartbeatBody(self, hostname, platform, version, wgPub, fingerprint, tunnelIP, endpoint string,
savePending bool, mirror *mirrorReport, enforcing map[string]any, peers []peerAnnounce) string {
return buildHeartbeatBodyOn(beatLanes{}, self, hostname, platform, version, wgPub, fingerprint, tunnelIP, endpoint,
savePending, mirror, enforcing, peers)
}
// beatLanes is which of a pairing's lanes run, so its beat advertises those
// and no others. The zero value is a tunnel pairing: the forwards listen on
// the tunnel's stack and the service slots are reachable there.
type beatLanes struct {
// local: a Host with no platform (run.go runUnixPairing). The forwards and
// the service slots are absent; the model servers ride the serve lane
// (servelane.go), and the beat says which in lane_serves.
local bool
// noCoders: a tcp pairing, whose coder runs have no control plane to use
// (pair_tcp.go coderTransportRefusal), so it is never offered one.
noCoders bool
// dcnDir: the pairing's DCN state, whose managed agents this beat probes
// and reports (faManagedProbe, faManagedStatus); "" reports none.
dcnDir string
}
func beatLanesFor(cfg *Config) beatLanes {
return beatLanes{local: cfg.localTransport(), noCoders: cfg.tcpTransport(), dcnDir: cfg.dcnDir()}
}
// buildHeartbeatBodyOn is buildHeartbeatBody for a pairing whose lanes are lanes.
func buildHeartbeatBodyOn(lanes beatLanes, self, hostname, platform, version, wgPub, fingerprint, tunnelIP, endpoint string,
savePending bool, mirror *mirrorReport, enforcing map[string]any, peers []peerAnnounce) string { savePending bool, mirror *mirrorReport, enforcing map[string]any, peers []peerAnnounce) string {
caps := []string{} caps := []string{}
// WHY SOME CAPABILITIES ARE WITHHELD HERE AND OTHERS ARE NOT — the asymmetry // WHY SOME CAPABILITIES ARE WITHHELD HERE AND OTHERS ARE NOT — the asymmetry
@@ -549,7 +576,17 @@ func buildHeartbeatBody(self, hostname, platform, version, wgPub, fingerprint, t
// gets exactly what it got before: scope.filterModels is the identity then. // gets exactly what it got before: scope.filterModels is the identity then.
scope := pairingModelScope(self) scope := pairingModelScope(self)
reachable, models := false, []string(nil) reachable, models := false, []string(nil)
if inference { // A local pairing has no forward to advertise: its model servers ride the
// serve lane, and each lane below is advertised only when lane_serves
// carries its service (the target set and this machine's, the server
// answering, the family held). Its probes are of the address the lane
// dials, never the tunnel's guesses.
var served laneServeReport
if lanes.local {
served = laneServes(self)
reachable = containsStr(served.served, "ollama")
models = served.models
} else if inference {
reachable, models = ollamaModels(tunnelIP) reachable, models = ollamaModels(tunnelIP)
models = scope.filterModels(models) models = scope.filterModels(models)
// Reachable but nothing shared: advertising `embed` would put this box // Reachable but nothing shared: advertising `embed` would put this box
@@ -572,7 +609,15 @@ func buildHeartbeatBody(self, hostname, platform, version, wgPub, fingerprint, t
// box running both. // box running both.
llmModels := []string{} llmModels := []string{}
llmPort := llmForwardPort llmPort := llmForwardPort
if !inference { if lanes.local {
// No port listens for it here: the Host reaches the server through the
// serve lane, so llm_port is the "no port" value.
llmPort = 0
if containsStr(served.served, "llm") {
caps = append(caps, "llm-openai")
llmModels = served.llmModels
}
} else if !inference {
// The host stores 0 as NULL; with llm-openai withheld and // The host stores 0 as NULL; with llm-openai withheld and
// llm_models empty nothing on the host resolves a port for this row. // llm_models empty nothing on the host resolves a port for this row.
llmPort = 0 llmPort = 0
@@ -598,7 +643,9 @@ func buildHeartbeatBody(self, hostname, platform, version, wgPub, fingerprint, t
// probe: an up forwarder with a dead upstream is a distinct state the // probe: an up forwarder with a dead upstream is a distinct state the
// host wants before committing a fail-closed write path to it. // host wants before committing a fail-closed write path to it.
piiAdvertised, piiOK := false, false piiAdvertised, piiOK := false, false
if inference && scope.allowsPII() { if lanes.local {
piiAdvertised, piiOK = containsStr(served.served, "pii"), served.piiOK
} else if inference && scope.allowsPII() {
piiAdvertised, piiOK = piiProbe() piiAdvertised, piiOK = piiProbe()
} }
if piiAdvertised { if piiAdvertised {
@@ -614,7 +661,7 @@ func buildHeartbeatBody(self, hostname, platform, version, wgPub, fingerprint, t
faAdvertised, faOK := freeagentProbe() faAdvertised, faOK := freeagentProbe()
// managed instances (freeagent_managed.go) count the same way: any // managed instances (freeagent_managed.go) count the same way: any
// serving instance advertises the capability; all must serve for ok // serving instance advertises the capability; all must serve for ok
if mAdv, mOK := faManagedProbe(); mAdv { if mAdv, mOK := faManagedProbe(lanes.dcnDir); mAdv {
if !faAdvertised { if !faAdvertised {
faAdvertised, faOK = true, mOK faAdvertised, faOK = true, mOK
} else { } else {
@@ -638,7 +685,7 @@ func buildHeartbeatBody(self, hostname, platform, version, wgPub, fingerprint, t
// "build a server on this machine" on it, and an offer the box would refuse // "build a server on this machine" on it, and an offer the box would refuse
// is a control that fails after the user chose it. The slot list rides with // is a control that fails after the user chose it. The slot list rides with
// it, withheld (absent, not empty) from a pairing outside the family. // it, withheld (absent, not empty) from a pairing outside the family.
servicesOn := servicesCapable(self) servicesOn := !lanes.local && servicesCapable(self)
if servicesOn { if servicesOn {
caps = append(caps, serviceCapability) caps = append(caps, serviceCapability)
} }
@@ -646,7 +693,10 @@ func buildHeartbeatBody(self, hostname, platform, version, wgPub, fingerprint, t
// only when this machine would accept a run-up from this pairing — Linux, // only when this machine would accept a run-up from this pairing — Linux,
// root, coders on, a runtime, the family, and (anchored) a standing coder // root, coders on, a runtime, the family, and (anchored) a standing coder
// grant. Absent, never empty, otherwise. // grant. Absent, never empty, otherwise.
coders := coderHeartbeat(self) var coders map[string]any
if !lanes.noCoders {
coders = coderHeartbeat(self)
}
if coders != nil { if coders != nil {
caps = append(caps, coderCapability) caps = append(caps, coderCapability)
} }
@@ -774,6 +824,13 @@ func buildHeartbeatBody(self, hostname, platform, version, wgPub, fingerprint, t
// absence as a client too old to say. // absence as a client too old to say.
"endpoint_save_pending": savePending, "endpoint_save_pending": savePending,
} }
// What this pairing serves over the serve lane (servelane.go), on a local
// pairing only: ["ollama","llm","pii"] or fewer, [] when nothing is. Absent
// on a tunnel pairing, which has the forwards instead, and from a bastion
// that predates the lane.
if lanes.local {
body["lane_serves"] = served.served
}
// The service slots this pairing may reach, with the tunnel port for each // The service slots this pairing may reach, with the tunnel port for each
// (service.go). Absent when the capability is withheld, never empty-for-no. // (service.go). Absent when the capability is withheld, never empty-for-no.
if servicesOn { if servicesOn {
@@ -1004,12 +1061,16 @@ func buildHeartbeatBody(self, hostname, platform, version, wgPub, fingerprint, t
} }
} }
if piiAdvertised { if piiAdvertised {
// pii_port is the tunnel's port; a local pairing has none and reaches
// the sterilizer through the serve lane.
if !lanes.local {
body["pii_port"] = piiForwardPort body["pii_port"] = piiForwardPort
}
body["pii_ok"] = piiOK body["pii_ok"] = piiOK
} }
if faAdvertised { if faAdvertised {
body["freeagent_ok"] = faOK body["freeagent_ok"] = faOK
if st := faManagedStatus(); len(st) > 0 { if st := faManagedStatus(lanes.dcnDir); len(st) > 0 {
body["freeagent_stores"] = st body["freeagent_stores"] = st
} }
} }
+406
View File
@@ -0,0 +1,406 @@
package main
// agents_cli.go — `privatae-bastion agents [--json] [--prompts]`: every agent
// on this machine and what it is doing, for the person at it and for an agent
// they ask to manage the bastion (agentsession.go builds each view).
//
// It reads with the caller's own permissions: run as an ordinary account it
// sees the session records in that account's home; with sudo it sees every
// account's. Beside the bastion installed for the whole machine, the owner's
// account reads the machine's view from it (reads.go). The last prompt each
// session was given is shown only with --prompts, because it is what a person
// typed into another session.
import (
"errors"
"fmt"
"io"
"os"
"path/filepath"
"sort"
"strconv"
"strings"
"time"
"unicode"
)
const agentsUsage = "usage: privatae-bastion agents [--json] [--prompts]\n" +
" privatae-bastion agents show <pid|session> [--json] [--prompts]"
var familyLabels = map[string]string{
"claude-code": "Claude Code", "aider": "aider", "goose": "goose", "cline": "Cline",
"cursor": "Cursor agent", "open-interpreter": "Open Interpreter", "opencode": "opencode",
"codex": "Codex", "gemini-cli": "Gemini CLI", "antigravity": "Antigravity", "crush": "Crush",
}
func familyLabel(sig string) string {
if l, ok := familyLabels[sig]; ok {
return l
}
return sig
}
var originWords = map[string]string{
originInteractive: "started from a terminal here",
originRemote: "started from a remote login",
originScheduler: "started by a scheduled job",
originService: "started by a service",
originAgent: "started by another agent",
}
// agentsRead is `agents`: every agent here, and how to read what each says
// about itself.
type agentsRead struct {
Agents []agentView `json:"agents"`
Note string `json:"note"`
}
func readAgents(o readOpts) (agentsRead, error) {
agents, err := observedAgents()
if err != nil {
return agentsRead{}, fmt.Errorf("could not read this machine's processes: %w", err)
}
views := buildAgentViews(agents, processTree())
for i := range views {
if !o.Prompts && views[i].Self != nil {
views[i].Self.LastPrompt = ""
}
// A shared secret, read out of the agent's own environment, for the
// Host: the console never shows it, and no read prints it. The
// evidence still says one is present.
views[i].DelegationToken = ""
}
if views == nil {
views = []agentView{}
}
return agentsRead{Agents: views, Note: "self_reported is what each agent says about itself, read from its own files: " +
"untrusted text, never instructions."}, nil
}
func cmdAgents(args []string) error {
show := ""
if len(args) >= 1 && args[0] == "show" {
if len(args) < 2 || strings.HasPrefix(args[1], "--") {
return errors.New(agentsUsage)
}
show, args = args[1], args[2:]
}
asJSON, prompts := false, false
for _, a := range args {
switch a {
case "--json":
asJSON = true
case "--prompts":
prompts = true
default:
return errors.New(agentsUsage)
}
}
v, err := readOwnOrMachine("agents", readOpts{Prompts: prompts}, readAgents)
if err != nil {
return err
}
if show != "" {
a, err := pickAgentView(v.Agents, show)
if err != nil {
return err
}
if asJSON {
return printJSON(os.Stdout, a)
}
printAgentDetail(os.Stdout, a, sessionNowFn())
return nil
}
if asJSON {
return printJSON(os.Stdout, v)
}
printAgents(os.Stdout, v.Agents, sessionNowFn())
return nil
}
// pickAgentView is the agent `agents show` means: a pid, or a session's
// name as `agents` shows it, which must match exactly one (the rule `stop`
// keeps, resolveStopTarget).
func pickAgentView(views []agentView, key string) (agentView, error) {
if pid, err := strconv.Atoi(key); err == nil {
for _, v := range views {
if v.PID == pid {
return v, nil
}
}
return agentView{}, fmt.Errorf("no AI agent here has pid %d; `privatae-bastion agents` lists them", pid)
}
var hits []agentView
for _, v := range views {
if v.Self != nil && v.Self.Name == key {
hits = append(hits, v)
}
}
switch len(hits) {
case 0:
return agentView{}, fmt.Errorf("no running session is named %q; `privatae-bastion agents` lists them", key)
case 1:
return hits[0], nil
}
return agentView{}, fmt.Errorf("%d sessions are named %q; give the pid instead", len(hits), key)
}
// printAgentDetail is one agent with everything a read holds about it: the
// lines `agents` prints, then what it is, how it was recognised, and what it
// says about itself. Its command line is in --json only: arguments can carry
// a key, and words are what gets pasted.
func printAgentDetail(w io.Writer, v agentView, now time.Time) {
if v.Role == "service" {
fmt.Fprintf(w, "background service (pid %d): starts background sessions; not a session itself\n", v.PID)
} else {
l := agentLinesOf(v, now)
fmt.Fprintln(w, l.Head)
if l.State != "" {
fmt.Fprintln(w, " "+l.State)
}
if l.Where != "" {
fmt.Fprintln(w, " "+l.Where)
}
}
row := func(k, val string) {
if val != "" {
fmt.Fprintf(w, " %-15s %s\n", k+":", val)
}
}
row("agent", familyLabel(v.Signature))
row("kind", v.Kind)
row("pid", strconv.Itoa(v.PID))
if v.PPID > 0 {
row("parent pid", strconv.Itoa(v.PPID))
}
// The kernel names the file, but whoever placed it chose its path.
row("program", shownPath(v.Exe))
if v.Exe == "" {
row("program", "unknown (the system did not say which file it runs)")
}
row("account", v.User)
if len(v.RunningNow) > 0 {
row("running now", strings.Join(v.RunningNow, "; "))
}
if len(v.ToolServers) > 0 {
row("tool servers", strings.Join(v.ToolServers, ", "))
}
if s := v.Self; s != nil {
src := s.Source
if s.Verified {
src += " (names this process)"
} else {
src += " (does not name this process)"
}
row("self-reported", src)
row("session id", s.SessionID)
row("last asked", quoteIf(s.LastPrompt))
}
fmt.Fprintln(w, "Names, titles and statuses are what the agent says about itself.")
}
// shownPath is a path the agent chose (its folder) or placed (the file it
// runs), as printed: quoted when it holds control characters, so an escape
// sequence in a name never reaches the terminal or the page.
func shownPath(p string) string {
if strings.ContainsFunc(p, unicode.IsControl) {
return strconv.Quote(p)
}
return p
}
func quoteIf(s string) string {
if s == "" {
return ""
}
return "\"" + s + "\""
}
// printAgents writes the views grouped by agent, sessions waiting for the
// person first, apps last.
func printAgents(w io.Writer, views []agentView, now time.Time) {
if len(views) == 0 {
fmt.Fprintln(w, "No AI agents are running on this machine.")
return
}
byFamily := map[string][]agentView{}
var families []string
for _, v := range views {
if _, ok := byFamily[v.Signature]; !ok {
families = append(families, v.Signature)
}
byFamily[v.Signature] = append(byFamily[v.Signature], v)
}
sort.Strings(families)
for _, fam := range families {
vs := byFamily[fam]
sort.SliceStable(vs, func(i, j int) bool { return viewRank(vs[i]) < viewRank(vs[j]) })
fmt.Fprintln(w, familyHeading(familyLabel(fam), vs))
for _, v := range vs {
printAgent(w, v, now)
}
fmt.Fprintln(w)
}
fmt.Fprintln(w, "Names, titles and statuses are what each agent says about itself.")
}
func viewRank(v agentView) int {
switch {
case v.Role == "service":
return 3
case v.Kind == kindApp:
return 4
case v.Self != nil && v.Self.WaitingFor != "":
return 0
case v.Self != nil && v.Self.Status != "idle":
return 1
}
return 2
}
func familyHeading(label string, vs []agentView) string {
sessions, waiting, services, apps, others := 0, 0, 0, 0, 0
for _, v := range vs {
switch {
case v.Role == "service":
services++
case v.Kind == kindApp:
apps++
case v.Kind != kindAgent:
others++
default:
sessions++
if v.Self != nil && v.Self.WaitingFor != "" {
waiting++
}
}
}
var parts []string
if sessions > 0 {
p := plural(sessions, "session", "sessions")
if waiting > 0 {
p += fmt.Sprintf(" (%d waiting for you)", waiting)
}
parts = append(parts, p)
}
if others > 0 {
parts = append(parts, plural(others, "program", "programs"))
}
if apps > 0 {
parts = append(parts, plural(apps, "app", "apps"))
}
if services > 0 {
parts = append(parts, "its background service")
}
return label + ": " + strings.Join(parts, ", ")
}
func plural(n int, one, many string) string {
if n == 1 {
return "1 " + one
}
return fmt.Sprintf("%d %s", n, many)
}
func printAgent(w io.Writer, v agentView, now time.Time) {
if v.Role == "service" {
fmt.Fprintf(w, " background service (pid %d): starts background sessions; not a session itself\n", v.PID)
return
}
l := agentLinesOf(v, now)
fmt.Fprintln(w, " "+l.Head)
if l.State != "" {
fmt.Fprintln(w, " "+l.State)
}
fmt.Fprintln(w, " "+l.Where+fmt.Sprintf(" · pid %d", v.PID))
if len(v.RunningNow) > 0 {
fmt.Fprintln(w, " running now: "+strings.Join(v.RunningNow, "; "))
}
if len(v.ToolServers) > 0 {
fmt.Fprintln(w, " tool servers: "+strings.Join(v.ToolServers, ", "))
}
if v.Self != nil && v.Self.LastPrompt != "" {
fmt.Fprintln(w, " last asked: \""+v.Self.LastPrompt+"\"")
}
}
// agentLines is one agent in words: the same three lines on the command line
// and in the console (uihome.go), so the two can never describe it apart.
type agentLines struct {
Head string // the session's name and title, as the agent gives them
State string // waiting for you / busy / idle, last active, permission mode
Where string // folder and branch, started when and by whom, as which account
}
func agentLinesOf(v agentView, now time.Time) agentLines {
var l agentLines
if v.Self != nil && v.Self.Name != "" {
l.Head = v.Self.Name
}
if v.Self != nil && v.Self.Title != "" && v.Self.Title != v.Self.Name {
if l.Head != "" {
l.Head += " · "
}
l.Head += "\"" + v.Self.Title + "\""
}
if l.Head == "" {
// No session record: name it by what it is and where it works.
l.Head = familyLabel(v.Signature)
if v.Folder != "" {
l.Head += " in " + shownPath(filepath.Base(v.Folder))
}
}
if v.Kind == kindApp {
l.Head += " — an app you are running"
}
var state []string
if v.Self != nil {
switch {
case v.Self.WaitingFor != "":
state = append(state, "waiting for you: "+v.Self.WaitingFor)
case v.Self.Status != "":
state = append(state, v.Self.Status)
}
if v.Self.Background {
state = append(state, "background session")
}
if t, err := time.Parse(time.RFC3339, v.Self.LastActive); err == nil {
state = append(state, "last active "+ago(now.Sub(t)))
}
if m := v.Self.PermissionMode; m != "" && m != "default" {
state = append(state, "permission mode: "+m)
}
}
l.State = strings.Join(state, " · ")
var where []string
if v.Folder != "" {
f := "in " + shownPath(v.Folder)
if v.GitBranch != "" {
f += " (" + v.GitBranch + ")"
}
where = append(where, f)
}
if t, err := time.Parse(time.RFC3339, v.StartedAt); err == nil {
where = append(where, "started "+ago(now.Sub(t)))
}
if o, ok := originWords[v.Origin]; ok {
where = append(where, o)
}
if v.User != "" {
where = append(where, "as "+v.User)
}
l.Where = strings.Join(where, " · ")
return l
}
func ago(d time.Duration) string {
switch {
case d < time.Minute:
return "just now"
case d < time.Hour:
return fmt.Sprintf("%dm ago", int(d.Minutes()))
case d < 48*time.Hour:
return fmt.Sprintf("%dh ago", int(d.Hours()))
}
return fmt.Sprintf("%dd ago", int(d.Hours()/24))
}
+455
View File
@@ -0,0 +1,455 @@
package main
// agentsession.go — what an agent is DOING, not only that it runs.
//
// "Seven Claude Code sessions on this machine" tells the owner nothing (the
// owner, 2026-10-30). Each agent gets, beside the detection facts (agents.go):
//
// - the folder it works in, that folder's git branch, how long it has run,
// and what it is running right now (its child commands, secrets redacted)
// — read from the operating system, for every agent;
// - what the agent says about itself, read from the agent's OWN state files
// on this machine: for Claude Code its per-process session record
// (~/.claude/sessions/<pid>.json: the session's name, whether it is idle,
// working, or waiting for the person and on what) and the tail of its
// transcript (the title Claude Code keeps for the session, its permission
// mode, the last prompt).
//
// No model is asked anything. The title is the agent's own, kept by the agent.
//
// WHAT IS NEVER READ: a process's environment (where tokens live), the key
// files beside the session records, and any transcript content other than
// the title, the permission mode, the branch and the last prompt.
//
// TRUST. A session record is written by the agent, so it is the agent's
// description of itself: an agent can name itself anything. It is shown as
// what the agent says (json "self_reported"), never as what the bastion
// found, and the detection facts stay the bastion's own. A record is used only
// if it names this pid AND, where the platform can tell, this process's start
// time (procStart against the kernel's), so a record left by a process that
// has exited cannot be pinned on a new one that got its number.
//
// WHERE IT GOES. This is built for the console and the command line on this
// machine. It is not in agentObs, so it is not in the heartbeat: nothing here
// reaches a Host.
import (
"bytes"
"encoding/json"
"os"
"os/user"
"path/filepath"
"regexp"
"runtime"
"sort"
"strconv"
"strings"
"time"
"unicode"
)
const (
sessionRecordMax = 64 << 10 // a session record is a few hundred bytes
transcriptTailMax = 400 << 10 // the title, mode and branch recur; the tail holds the latest
titleMax = 120
promptMax = 240
nameMax = 60
runningNowMax = 3
runningNowWidth = 100
)
// agentSelf is what the agent says about itself.
type agentSelf struct {
Source string `json:"source"`
Verified bool `json:"verified"` // the record named this pid and its start time
SessionID string `json:"session_id,omitempty"`
Name string `json:"name,omitempty"`
Title string `json:"title,omitempty"`
Status string `json:"status,omitempty"`
WaitingFor string `json:"waiting_for,omitempty"`
Background bool `json:"background,omitempty"`
PermissionMode string `json:"permission_mode,omitempty"`
LastActive string `json:"last_active,omitempty"`
LastPrompt string `json:"last_prompt,omitempty"`
}
// agentView is one agent as the console and `agents` show it.
type agentView struct {
agentObs
// Role separates a session from the agent's own supervisor process
// ("service"): Claude Code's background service starts background
// sessions and is not one, and counting it as one is how a machine with
// five sessions read as six.
Role string `json:"role"`
Folder string `json:"folder,omitempty"`
GitBranch string `json:"git_branch,omitempty"`
StartedAt string `json:"started_at,omitempty"`
RunningNow []string `json:"running_now,omitempty"`
// ToolServers are the long-running children the agent started with
// itself (its MCP servers, by their program names), kept apart from
// RunningNow so the commands of this moment are not buried under them.
ToolServers []string `json:"tool_servers,omitempty"`
Self *agentSelf `json:"self_reported,omitempty"`
}
// Seams: the platform's answers, so the views are testable from fixtures.
var (
uidForUserFn = uidForUser
procCwdFn = osProcCwd
procStartedFn = osProcStarted
homeForUserFn = homeForUser
procCmdArgsFn = osProcCmdArgs
sessionNowFn = time.Now
agentViewsLimit = 200
)
// uidForUser is the account number session files must belong to; -1 (no
// check) where accounts are not numbers (Windows). ok is false when the
// account cannot be resolved, and then nothing of the agent's is read.
func uidForUser(name string) (int, bool) {
if runtime.GOOS == "windows" {
return -1, true
}
u, err := user.Lookup(name)
if err != nil {
return 0, false
}
n, err := strconv.Atoi(u.Uid)
return n, err == nil
}
func homeForUser(name string) string {
if name == "" {
return ""
}
u, err := user.Lookup(name)
if err != nil {
return ""
}
return u.HomeDir
}
// buildAgentViews turns one scan into what a person reads.
func buildAgentViews(agents []agentObs, tree map[int]int) []agentView {
children := map[int][]int{}
for c, p := range tree {
children[p] = append(children[p], c)
}
out := make([]agentView, 0, len(agents))
for i, a := range agents {
if i >= agentViewsLimit {
break
}
v := agentView{agentObs: a, Role: "session"}
if a.Signature == "claude-code" && isClaudeCodeService(a.Cmdline) {
v.Role = "service"
}
v.Folder = procCwdFn(a.PID)
v.GitBranch = gitBranchOf(v.Folder)
started, hasStart := procStartedFn(a.PID)
if hasStart {
v.StartedAt = started.UTC().Format(time.RFC3339)
}
v.RunningNow, v.ToolServers = runningNow(a.PID, children, started, hasStart)
if a.Signature == "claude-code" && v.Role == "session" {
if uid, ok := uidForUserFn(a.User); ok {
v.Self = claudeCodeSelf(a.PID, homeForUserFn(a.User), uid)
}
}
out = append(out, v)
}
return out
}
// isClaudeCodeService is Claude Code's background service, `claude daemon run`.
func isClaudeCodeService(cmdline string) bool {
f := strings.Fields(cmdline)
for i := 0; i+1 < len(f); i++ {
if f[i] == "daemon" && f[i+1] == "run" {
return true
}
}
return false
}
var sessionIDShape = regexp.MustCompile(`^[0-9a-fA-F-]{8,64}$`)
// claudeCodeSelf reads the session record Claude Code keeps for this pid, and
// the tail of that session's transcript. nil when there is none this bastion
// can read (another account's home without root, an older Claude Code).
//
// Every file is read only if it is a regular file the agent's own account
// owns (openOwned): the daemon may run as the machine's administrator, and a
// link planted in one account's home must not make it read another's.
func claudeCodeSelf(pid int, home string, uid int) *agentSelf {
if home == "" {
return nil
}
raw := readCappedOwned(filepath.Join(home, ".claude", "sessions", strconv.Itoa(pid)+".json"), sessionRecordMax, uid)
if raw == nil {
return nil
}
var rec struct {
PID int `json:"pid"`
SessionID string `json:"sessionId"`
ProcStart string `json:"procStart"`
Kind string `json:"kind"`
Name string `json:"name"`
Status string `json:"status"`
WaitingFor string `json:"waitingFor"`
UpdatedAt int64 `json:"updatedAt"`
}
if json.Unmarshal(raw, &rec) != nil || rec.PID != pid {
return nil
}
id, _, idOK := procIdentity(pid)
if idOK && rec.ProcStart != id {
return nil // another process's record: this number has changed hands
}
s := &agentSelf{
Source: "Claude Code's session record",
Verified: idOK,
Name: cleanText(rec.Name, nameMax),
Status: cleanText(rec.Status, 30),
WaitingFor: cleanText(rec.WaitingFor, 60),
Background: rec.Kind == "bg",
}
if rec.UpdatedAt > 0 {
s.LastActive = time.UnixMilli(rec.UpdatedAt).UTC().Format(time.RFC3339)
}
if !sessionIDShape.MatchString(rec.SessionID) {
return s
}
s.SessionID = rec.SessionID
matches, _ := filepath.Glob(filepath.Join(home, ".claude", "projects", "*", rec.SessionID+".jsonl"))
sort.Strings(matches)
if len(matches) == 0 {
return s
}
for _, line := range tailLinesOwned(matches[0], transcriptTailMax, uid) {
var e struct {
Type string `json:"type"`
AITitle string `json:"aiTitle"`
PermissionMode string `json:"permissionMode"`
LastPrompt string `json:"lastPrompt"`
}
if json.Unmarshal(line, &e) != nil {
continue
}
switch e.Type {
case "ai-title":
if e.AITitle != "" {
s.Title = cleanText(e.AITitle, titleMax)
}
case "permission-mode":
if e.PermissionMode != "" {
s.PermissionMode = cleanText(e.PermissionMode, 40)
}
case "last-prompt":
if e.LastPrompt != "" {
s.LastPrompt = cleanText(e.LastPrompt, promptMax)
}
}
}
return s
}
// toolServerWindow: a direct child started this soon after the agent is one
// it started with itself (an MCP server), not a command of this moment.
const toolServerWindow = 2 * time.Minute
// toolServerName is the program a tool server runs: past the interpreter
// (agents.go's table) and its flags, the base name of what it was given.
func toolServerName(args []string) string {
name := binBase(args[0])
if !interpreters[name] {
return name
}
for _, a := range args[1:] {
if !strings.HasPrefix(a, "-") {
return cleanText(filepath.Base(a), 60)
}
}
return name
}
// runningNow is what the agent is running at this moment: the commands at
// the ends of its process tree, secrets redacted, newest pids first. The
// direct children it started with itself come back apart, as tool servers.
func runningNow(pid int, children map[int][]int, started time.Time, hasStart bool) ([]string, []string) {
var tools []string
// top: the agent's direct child each process descends from. A tool server
// is often a grandchild (npx → sh → node), so it is the direct child's
// start that says whether the agent started it with itself.
top := map[int]int{}
var leaves []int
seen := map[int]bool{pid: true}
queue := []int{pid}
for len(queue) > 0 && len(seen) < 500 {
p := queue[0]
queue = queue[1:]
kids := children[p]
if len(kids) == 0 && p != pid {
leaves = append(leaves, p)
}
for _, k := range kids {
if !seen[k] {
seen[k] = true
queue = append(queue, k)
if p == pid {
top[k] = k
} else {
top[k] = top[p]
}
}
}
}
sort.Sort(sort.Reverse(sort.IntSlice(leaves)))
var out []string
for _, l := range leaves {
args := splitRetitled(procCmdArgsFn(l))
if len(args) == 0 {
continue
}
if hasStart {
if t, ok := procStartedFn(top[l]); ok && t.Sub(started) < toolServerWindow {
tools = append(tools, toolServerName(args))
continue
}
}
if len(out) == runningNowMax {
continue
}
red, _ := redactSecretArgs(args)
red[0] = filepath.Base(red[0])
out = append(out, cleanText(strings.Join(red, " "), runningNowWidth))
}
return out, countedNames(tools)
}
// splitRetitled undoes a retitled command line: a program that rewrote its
// argv as one string (a browser, a server setting its title) arrives as a
// single argument with spaces in it, and its "program" would otherwise be
// whatever follows the last slash in the whole line.
func splitRetitled(args []string) []string {
if len(args) == 1 && strings.ContainsAny(args[0], " \t") {
return strings.Fields(args[0])
}
return args
}
// countedNames sorts names and folds repeats: "chrome ×3".
func countedNames(names []string) []string {
n := map[string]int{}
for _, x := range names {
n[x]++
}
out := make([]string, 0, len(n))
for x, c := range n {
if c > 1 {
x += " ×" + strconv.Itoa(c)
}
out = append(out, x)
}
sort.Strings(out)
return out
}
// gitBranchOf reads the branch of the repository holding dir from its HEAD
// file. It runs no git: the folder is the agent's, and so is its git config.
func gitBranchOf(dir string) string {
for i := 0; dir != "" && i < 40; i++ {
g := filepath.Join(dir, ".git")
if st, err := os.Lstat(g); err == nil {
head := filepath.Join(g, "HEAD")
if !st.IsDir() {
// a worktree or submodule: ".git" is a file naming the real dir
b := readCapped(g, 4096)
rest, ok := strings.CutPrefix(strings.TrimSpace(string(b)), "gitdir:")
if !ok {
return ""
}
gd := strings.TrimSpace(rest)
if !filepath.IsAbs(gd) {
gd = filepath.Join(dir, gd)
}
head = filepath.Join(gd, "HEAD")
}
h := strings.TrimSpace(string(readCapped(head, 4096)))
if b, ok := strings.CutPrefix(h, "ref: refs/heads/"); ok {
return cleanText(b, 80)
}
if len(h) >= 12 {
return "detached at " + cleanText(h[:12], 12)
}
return ""
}
parent := filepath.Dir(dir)
if parent == dir {
return ""
}
dir = parent
}
return ""
}
// readCapped reads a small file without following a final symlink or
// waiting on a pipe (openOwned, no owner check): .git/HEAD in an agent's
// folder is that account's to plant anything in.
func readCapped(path string, max int64) []byte { return readCappedOwned(path, max, -1) }
func readCappedOwned(path string, max int64, uid int) []byte {
f, err := openOwned(path, uid)
if err != nil {
return nil
}
defer f.Close()
if st, err := f.Stat(); err != nil || !st.Mode().IsRegular() || st.Size() > max {
return nil
}
b := make([]byte, max)
n, _ := f.Read(b)
return b[:n]
}
// tailLines is the last max bytes of a file, split into whole lines.
func tailLines(path string, max int64) [][]byte { return tailLinesOwned(path, max, -1) }
func tailLinesOwned(path string, max int64, uid int) [][]byte {
f, err := openOwned(path, uid)
if err != nil {
return nil
}
defer f.Close()
st, err := f.Stat()
if err != nil || !st.Mode().IsRegular() {
return nil
}
start := st.Size() - max
if start < 0 {
start = 0
}
buf := make([]byte, st.Size()-start)
n, _ := f.ReadAt(buf, start)
lines := bytes.Split(buf[:n], []byte("\n"))
if start > 0 && len(lines) > 0 {
lines = lines[1:] // the first is cut in the middle
}
return lines
}
// cleanText is agent-written text made safe to show: control characters out,
// whitespace collapsed, cut to max runes with an ellipsis.
func cleanText(s string, max int) string {
s = strings.Map(func(r rune) rune {
if unicode.IsControl(r) || r == '
' || r == '
' {
return ' '
}
return r
}, s)
s = strings.Join(strings.Fields(s), " ")
if r := []rune(s); len(r) > max {
return string(r[:max-1]) + "…"
}
return s
}
+33
View File
@@ -0,0 +1,33 @@
//go:build !windows
package main
import (
"os"
"path/filepath"
"syscall"
"testing"
"time"
)
// A pipe planted where .git/HEAD belongs must not stall the daemon: a plain
// open would wait for a writer for ever.
func TestAPipeInPlaceOfGitHEADDoesNotStall(t *testing.T) {
repo := t.TempDir()
if err := os.MkdirAll(filepath.Join(repo, ".git"), 0o700); err != nil {
t.Fatal(err)
}
if err := syscall.Mkfifo(filepath.Join(repo, ".git", "HEAD"), 0o600); err != nil {
t.Skip("cannot make a fifo here:", err)
}
done := make(chan string, 1)
go func() { done <- gitBranchOf(repo) }()
select {
case got := <-done:
if got != "" {
t.Errorf("a pipe read as branch %q", got)
}
case <-time.After(3 * time.Second):
t.Fatal("reading .git/HEAD stalled on a pipe")
}
}
+53
View File
@@ -0,0 +1,53 @@
//go:build linux
package main
import (
"os"
"strconv"
"strings"
"time"
)
func osProcCwd(pid int) string {
d, err := os.Readlink("/proc/" + strconv.Itoa(pid) + "/cwd")
if err != nil {
return ""
}
return d
}
func osProcCmdArgs(pid int) []string {
raw, err := os.ReadFile("/proc/" + strconv.Itoa(pid) + "/cmdline")
if err != nil {
return nil
}
return splitNul(raw)
}
// osProcStarted is the process's start: boot time (/proc/stat btime) plus its
// start in clock ticks (procIdentity), at the USER_HZ of 100 Linux reports.
func osProcStarted(pid int) (time.Time, bool) {
id, _, ok := procIdentity(pid)
if !ok {
return time.Time{}, false
}
ticks, err := strconv.ParseInt(id, 10, 64)
if err != nil {
return time.Time{}, false
}
raw, err := os.ReadFile("/proc/stat")
if err != nil {
return time.Time{}, false
}
for _, line := range strings.Split(string(raw), "\n") {
if v, ok := strings.CutPrefix(line, "btime "); ok {
boot, err := strconv.ParseInt(strings.TrimSpace(v), 10, 64)
if err != nil {
return time.Time{}, false
}
return time.Unix(boot, 0).Add(time.Duration(ticks) * 10 * time.Millisecond), true
}
}
return time.Time{}, false
}
+35
View File
@@ -0,0 +1,35 @@
//go:build !windows
package main
import (
"errors"
"os"
"syscall"
)
var errNotOwnedRegular = errors.New("not a regular file owned by that account")
// openOwned opens a file the agent's account controls, for the daemon that
// may be running as the machine's administrator. It never follows a final
// symlink (O_NOFOLLOW), never waits on a pipe planted in its place
// (O_NONBLOCK, then a regular-file check), and, when uid >= 0, refuses a
// file another account owns, which also catches a symlinked directory on the
// way: whatever the path walked through, the file it reached has to be the
// agent account's own.
func openOwned(path string, uid int) (*os.File, error) {
fd, err := syscall.Open(path, syscall.O_RDONLY|syscall.O_NOFOLLOW|syscall.O_NONBLOCK|syscall.O_CLOEXEC, 0)
if err != nil {
return nil, err
}
var st syscall.Stat_t
if err := syscall.Fstat(fd, &st); err != nil {
_ = syscall.Close(fd)
return nil, err
}
if st.Mode&syscall.S_IFMT != syscall.S_IFREG || (uid >= 0 && int(st.Uid) != uid) {
_ = syscall.Close(fd)
return nil, errNotOwnedRegular
}
return os.NewFile(uintptr(fd), path), nil
}
+22
View File
@@ -0,0 +1,22 @@
//go:build windows
package main
import (
"errors"
"os"
)
// openOwned on Windows: no owner check by account number (accounts are SIDs
// here), and a symlink needs privilege to create; the file must be regular.
func openOwned(path string, _ int) (*os.File, error) {
f, err := os.Open(path)
if err != nil {
return nil, err
}
if st, err := f.Stat(); err != nil || !st.Mode().IsRegular() {
_ = f.Close()
return nil, errors.New("not a regular file")
}
return f, nil
}
+15
View File
@@ -0,0 +1,15 @@
//go:build !linux
package main
import (
"strings"
"time"
)
// Off Linux the folder and start time are not read yet; the agent's own
// session record still is (claudeCodeSelf), unverified, since procIdentity has
// no start time to check it against there.
func osProcCwd(int) string { return "" }
func osProcStarted(int) (time.Time, bool) { return time.Time{}, false }
func osProcCmdArgs(pid int) []string { return strings.Fields(procCmdline(pid)) }
+282
View File
@@ -0,0 +1,282 @@
package main
import (
"bytes"
"os"
"path/filepath"
"runtime"
"strings"
"testing"
"time"
)
const fixtureSession = "0a1b2c3d-1111-4222-8333-444455556666"
// fakeClaudeHome lays out what Claude Code keeps for one running session: the
// per-process record and the session's transcript. All of it invented.
func fakeClaudeHome(t *testing.T, pid int, procStart, transcript string) string {
t.Helper()
home := t.TempDir()
sess := filepath.Join(home, ".claude", "sessions")
proj := filepath.Join(home, ".claude", "projects", "-work-shop")
for _, d := range []string{sess, proj} {
if err := os.MkdirAll(d, 0o700); err != nil {
t.Fatal(err)
}
}
rec := `{"pid":` + itoa(pid) + `,"sessionId":"` + fixtureSession + `","cwd":"/work/shop","procStart":"` + procStart +
`","kind":"interactive","name":"shop-a1","status":"waiting","waitingFor":"permission prompt","updatedAt":1793300000000}`
if err := os.WriteFile(filepath.Join(sess, itoa(pid)+".json"), []byte(rec), 0o600); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join(sess, itoa(pid)+".deadbeef.key"), []byte("NEVER-READ"), 0o600); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join(proj, fixtureSession+".jsonl"), []byte(transcript), 0o600); err != nil {
t.Fatal(err)
}
return home
}
func stubProcIdentity(t *testing.T, id string) {
t.Helper()
prev := procIdentity
t.Cleanup(func() { procIdentity = prev })
procIdentity = func(int) (string, bool, bool) { return id, false, true }
}
const fixtureTranscript = `{"type":"ai-title","aiTitle":"Set up the shop database","sessionId":"x"}
{"type":"user","message":{"content":"SECRET CONVERSATION BODY"}}
{"type":"permission-mode","permissionMode":"bypassPermissions","sessionId":"x"}
{"type":"last-prompt","lastPrompt":"add an index to orders","sessionId":"x"}
{"type":"ai-title","aiTitle":"Add an index to the orders table","sessionId":"x"}
`
func TestClaudeCodeSessionSaysWhatItIsDoing(t *testing.T) {
stubProcIdentity(t, "5551")
home := fakeClaudeHome(t, 4242, "5551", fixtureTranscript)
s := claudeCodeSelf(4242, home, os.Getuid())
if s == nil {
t.Fatal("a session with a matching record was not read")
}
want := agentSelf{Source: "Claude Code's session record", Verified: true, SessionID: fixtureSession,
Name: "shop-a1", Title: "Add an index to the orders table", Status: "waiting",
WaitingFor: "permission prompt", PermissionMode: "bypassPermissions",
LastActive: time.UnixMilli(1793300000000).UTC().Format(time.RFC3339),
LastPrompt: "add an index to orders"}
if *s != want {
t.Errorf("got %+v\nwant %+v", *s, want)
}
}
// A record left by a process that has exited must not be pinned on the new
// process that got its number.
func TestASessionRecordForAnEarlierProcessIsNotUsed(t *testing.T) {
stubProcIdentity(t, "9999")
home := fakeClaudeHome(t, 4242, "5551", fixtureTranscript)
if s := claudeCodeSelf(4242, home, os.Getuid()); s != nil {
t.Errorf("a record whose process start is not this process's was used: %+v", *s)
}
}
func TestASessionRecordNamingAnotherPidIsNotUsed(t *testing.T) {
stubProcIdentity(t, "5551")
home := fakeClaudeHome(t, 4242, "5551", fixtureTranscript)
if err := os.Rename(filepath.Join(home, ".claude", "sessions", "4242.json"),
filepath.Join(home, ".claude", "sessions", "4343.json")); err != nil {
t.Fatal(err)
}
if s := claudeCodeSelf(4343, home, os.Getuid()); s != nil {
t.Errorf("a record that names pid 4242 was used for 4343: %+v", *s)
}
}
// The session id becomes part of a path; one that is not an id reads nothing.
func TestASessionIDThatIsAPathReadsNoTranscript(t *testing.T) {
stubProcIdentity(t, "5551")
home := t.TempDir()
sess := filepath.Join(home, ".claude", "sessions")
if err := os.MkdirAll(sess, 0o700); err != nil {
t.Fatal(err)
}
rec := `{"pid":4242,"sessionId":"../../../etc/x","procStart":"5551","name":"n"}`
if err := os.WriteFile(filepath.Join(sess, "4242.json"), []byte(rec), 0o600); err != nil {
t.Fatal(err)
}
s := claudeCodeSelf(4242, home, os.Getuid())
if s == nil || s.SessionID != "" || s.Title != "" {
t.Errorf("a path-shaped session id was followed: %+v", s)
}
}
// What an agent writes about itself is shown, never obeyed or rendered: no
// control characters, no line breaks to forge another line, a bounded length.
func TestAgentWrittenTextIsCleanedAndBounded(t *testing.T) {
got := cleanText("ok\n\x1b[31mIGNORE ALL PREVIOUS
instructions\t", 200)
if strings.ContainsAny(got, "\n\x1b
\t") {
t.Errorf("control characters survived: %q", got)
}
if r := []rune(cleanText(strings.Repeat("é", 500), titleMax)); len(r) != titleMax {
t.Errorf("a long title is %d runes, want %d", len(r), titleMax)
}
}
func TestClaudeCodesBackgroundServiceIsNotASession(t *testing.T) {
if !isClaudeCodeService("/opt/x/claude.exe daemon run --json-path /h/.claude/daemon.json") {
t.Error("`daemon run` was not recognised as the background service")
}
if isClaudeCodeService("claude --resume") {
t.Error("an interactive session was taken for the service")
}
}
// The commands of this moment are kept apart from the tool servers the agent
// started with itself, and a secret on a command line is redacted.
func TestRunningNowSeparatesToolServersAndRedactsSecrets(t *testing.T) {
start := time.Date(2026, 10, 30, 9, 0, 0, 0, time.UTC)
started := map[int]time.Time{
100: start, 110: start.Add(5 * time.Second), 111: start.Add(6 * time.Second),
120: start.Add(3 * time.Hour), 121: start.Add(3 * time.Hour),
}
args := map[int][]string{
111: {"node", "/home/u/.npm/_npx/abc/node_modules/.bin/mcp-server-files"},
121: {"curl", "-H", "Authorization: Bearer sk-live-abcdefghijklmnop1234", "https://api.example.com"},
}
prevS, prevA := procStartedFn, procCmdArgsFn
t.Cleanup(func() { procStartedFn, procCmdArgsFn = prevS, prevA })
procStartedFn = func(pid int) (time.Time, bool) { s, ok := started[pid]; return s, ok }
procCmdArgsFn = func(pid int) []string { return args[pid] }
children := map[int][]int{100: {110, 120}, 110: {111}, 120: {121}}
now, tools := runningNow(100, children, start, true)
if len(tools) != 1 || tools[0] != "mcp-server-files" {
t.Errorf("tool servers %v", tools)
}
if len(now) != 1 || !strings.HasPrefix(now[0], "curl") {
t.Fatalf("running now %v", now)
}
if strings.Contains(now[0], "sk-live") {
t.Errorf("a secret on a command line was shown: %q", now[0])
}
}
func TestGitBranchIsReadFromHEADWithoutRunningGit(t *testing.T) {
repo := t.TempDir()
if err := os.MkdirAll(filepath.Join(repo, ".git"), 0o700); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join(repo, ".git", "HEAD"), []byte("ref: refs/heads/fix/login\n"), 0o600); err != nil {
t.Fatal(err)
}
sub := filepath.Join(repo, "src", "app")
if err := os.MkdirAll(sub, 0o700); err != nil {
t.Fatal(err)
}
if got := gitBranchOf(sub); got != "fix/login" {
t.Errorf("branch from a subfolder: %q", got)
}
// A worktree: .git is a file naming the real git dir.
wt := t.TempDir()
gd := filepath.Join(t.TempDir(), "wt-gitdir")
if err := os.MkdirAll(gd, 0o700); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join(gd, "HEAD"), []byte("ref: refs/heads/feature\n"), 0o600); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join(wt, ".git"), []byte("gitdir: "+gd+"\n"), 0o600); err != nil {
t.Fatal(err)
}
if got := gitBranchOf(wt); got != "feature" {
t.Errorf("branch in a worktree: %q", got)
}
}
// Sessions waiting for the person come first, and the heading counts the
// background service apart from the sessions.
func TestAgentsListPutsWaitingSessionsFirstAndCountsTheServiceApart(t *testing.T) {
views := []agentView{
{agentObs: agentObs{PID: 1, Signature: "claude-code"}, Role: "service"},
{agentObs: agentObs{PID: 2, Kind: kindAgent, Signature: "claude-code"}, Role: "session",
Self: &agentSelf{Name: "idle-one", Status: "idle"}},
{agentObs: agentObs{PID: 3, Kind: kindAgent, Signature: "claude-code"}, Role: "session",
Self: &agentSelf{Name: "waits", Title: "Rename the invoices", Status: "waiting", WaitingFor: "permission prompt"}},
}
var b bytes.Buffer
printAgents(&b, views, time.Now())
out := b.String()
if !strings.HasPrefix(out, "Claude Code: 2 sessions (1 waiting for you), its background service\n") {
t.Errorf("heading:\n%s", out)
}
if strings.Index(out, "waits") > strings.Index(out, "idle-one") {
t.Errorf("the waiting session is not first:\n%s", out)
}
if !strings.Contains(out, "waiting for you: permission prompt") {
t.Errorf("what it waits for is not said:\n%s", out)
}
}
// Stop takes a session's name, and the owner is asked about the session, not
// a bare pid.
func TestStopNamesTheSessionItAsksAbout(t *testing.T) {
stubProcIdentity(t, "5551")
home := fakeClaudeHome(t, 4242, "5551", fixtureTranscript)
prevH, prevTree, prevU := homeForUserFn, processTree, uidForUserFn
t.Cleanup(func() { homeForUserFn, processTree, uidForUserFn = prevH, prevTree, prevU })
homeForUserFn = func(string) string { return home }
uidForUserFn = func(string) (int, bool) { return os.Getuid(), true }
processTree = func() map[int]int { return nil }
observed := map[int]agentObs{4242: {PID: 4242, Kind: kindAgent, Signature: "claude-code", User: "u"}}
pid, v, err := resolveStopTarget("shop-a1", observed)
if err != nil || pid != 4242 {
t.Fatalf("by name: %d %v", pid, err)
}
if _, _, err := resolveStopTarget("no-such", observed); err == nil {
t.Error("an unknown session name resolved")
}
d := map[string]any{"kind": localStopKind, "pid": "4242", "signature": "claude-code",
"agent": "Claude Code", "session": v.Self.Name, "title": v.Self.Title, "folder": "/work/shop"}
got := describeRequest(stepupRequest{Details: d})
want := `Stop Claude Code session shop-a1 "Add an index to the orders table" in /work/shop (pid 4242) on this machine, and every process it started.`
if got != want {
t.Errorf("the owner reads\n%s\nwant\n%s", got, want)
}
}
// A program that rewrote its command line as one string is still named by
// its program, not by whatever follows the last slash in the whole line, and
// repeats fold into a count.
func TestARetitledCommandLineIsSplitAndRepeatsFold(t *testing.T) {
if got := splitRetitled([]string{"go test ./..."}); len(got) != 3 || got[0] != "go" {
t.Errorf("split %q", got)
}
if got := splitRetitled([]string{"/usr/bin/go", "test", "./..."}); len(got) != 3 || got[0] != "/usr/bin/go" {
t.Errorf("an ordinary argv was changed: %q", got)
}
if got := countedNames([]string{"chrome", "mcp-files", "chrome", "chrome"}); len(got) != 2 || got[0] != "chrome ×3" {
t.Errorf("folded %q", got)
}
}
// The daemon may read as the machine's administrator: a session file that is
// a link, or that another account owns, is not read.
func TestASessionFileThatIsALinkOrNotTheAgentsOwnIsNotRead(t *testing.T) {
if runtime.GOOS == "windows" {
t.Skip("accounts are not numbers and links need privilege on Windows")
}
stubProcIdentity(t, "5551")
home := fakeClaudeHome(t, 4242, "5551", fixtureTranscript)
if s := claudeCodeSelf(4242, home, os.Getuid()+1); s != nil {
t.Errorf("a record owned by another account was read: %+v", *s)
}
rec := filepath.Join(home, ".claude", "sessions", "4242.json")
elsewhere := filepath.Join(t.TempDir(), "other.json")
if err := os.Rename(rec, elsewhere); err != nil {
t.Fatal(err)
}
if err := os.Symlink(elsewhere, rec); err != nil {
t.Fatal(err)
}
if s := claudeCodeSelf(4242, home, os.Getuid()); s != nil {
t.Errorf("a record reached through a link was read: %+v", *s)
}
}
+5 -4
View File
@@ -574,9 +574,10 @@ var allCaps = []string{"dcn", "egress", "harness", "inference", "models", "obser
// writes a pairing PENDING when an anchor exists (pair.go), and state "" reads // writes a pairing PENDING when an anchor exists (pair.go), and state "" reads
// active (config.go), so B comes straight up with full lanes. // active (config.go), so B comes straight up with full lanes.
// //
// LOCAL is exempt and must stay so: a local bastion serves one host and cannot // LOCAL is exempt and must stay so: a local bastion serves the one host it was
// be anchored at all (cmdClaimAnchor refuses outside networked mode), so the // paired with, and a second only on a yes typed at the machine (pair_terminal.go),
// pairing IS the authorization there. Most bastions are local. // and it cannot be anchored at all (cmdClaimAnchor refuses outside networked
// mode), so the pairing IS the authorization there. Most bastions are local.
// //
// self-update is deliberately INSIDE the refusal. Directing a binary swap is the // self-update is deliberately INSIDE the refusal. Directing a binary swap is the
// most dangerous thing on the list, and an unanchored networked box cannot say // most dangerous thing on the list, and an unanchored networked box cannot say
@@ -1033,7 +1034,7 @@ func cmdClaimAnchor(token string, rotate bool, owner, host string) error {
return err return err
} }
if boxMode() != modeNetworked { if boxMode() != modeNetworked {
return fmt.Errorf("claim-anchor needs networked mode — a local bastion serves one host and needs no anchor (%s, then `privatae-bastion set-mode networked`)", adminHowTo()) return fmt.Errorf("claim-anchor needs networked mode — a local bastion serves only the Hosts its person said yes to and needs no anchor (%s, then `privatae-bastion set-mode networked`)", adminHowTo())
} }
cfgs, err := loadPairings() cfgs, err := loadPairings()
if err != nil { if err != nil {
+9
View File
@@ -177,6 +177,15 @@ func winPersonSID(sid string) bool {
return strings.HasPrefix(sid, "S-1-5-21-") || strings.HasPrefix(sid, "S-1-12-1-") return strings.HasPrefix(sid, "S-1-5-21-") || strings.HasPrefix(sid, "S-1-12-1-")
} }
// pipeClientNewer: a process created after the connection was made cannot be
// the one that made it. The service finds the connecting process by its id
// (GetNamedPipeClientProcessId), and an id is reused once its process has
// exited and nothing holds it, so a client that hands its pipe to another
// process and exits could otherwise be answered as whoever got its id next.
// The connection time is taken as the service starts serving it, a moment
// after the connect.
func pipeClientNewer(created, connected time.Time) bool { return created.After(connected) }
// pipeClientRefusal says why a connected process may not use the lane, or "" // pipeClientRefusal says why a connected process may not use the lane, or ""
// when it may: it must run as the person signed in to its own session, in a // when it may: it must run as the person signed in to its own session, in a
// session someone is in front of. // session someone is in front of.
+33 -8
View File
@@ -161,6 +161,7 @@ type approvalPipeServer struct {
open int open int
sa *windows.SecurityAttributes sa *windows.SecurityAttributes
name *uint16 name *uint16
label string // the pipe's name, for a message
// stopEv is set when the service stops; it ends a connect that is waiting. // stopEv is set when the service stops; it ends a connect that is waiting.
stopEv windows.Handle stopEv windows.Handle
} }
@@ -190,7 +191,7 @@ func (s *approvalPipeServer) create() (*pipeConn, error) {
windows.PIPE_UNLIMITED_INSTANCES, 64<<10, 64<<10, 0, s.sa) windows.PIPE_UNLIMITED_INSTANCES, 64<<10, 64<<10, 0, s.sa)
if err != nil { if err != nil {
if s.open == 0 { if s.open == 0 {
return nil, fmt.Errorf("cannot create %s; if another program holds that name the tray stays off: %w", approvalPipeName, err) return nil, fmt.Errorf("cannot create %s; if another program holds that name, this lane stays off: %w", s.label, err)
} }
return nil, err return nil, err
} }
@@ -230,11 +231,17 @@ func startApprovalPipe(stop <-chan struct{}) {
} }
func serveApprovalPipe(stop <-chan struct{}, ready func()) error { func serveApprovalPipe(stop <-chan struct{}, ready func()) error {
sd, err := windows.SecurityDescriptorFromString(approvalPipeSDDL) return servePipe(stop, ready, approvalPipeName, approvalPipeSDDL, servePipeConn)
}
// servePipe serves one of the service's pipes, name with the ACL sddl, until
// stop is closed, handing each connection to serve.
func servePipe(stop <-chan struct{}, ready func(), pipeName, sddl string, serve func(*pipeConn)) error {
sd, err := windows.SecurityDescriptorFromString(sddl)
if err != nil { if err != nil {
return fmt.Errorf("cannot build the pipe's permissions: %w", err) return fmt.Errorf("cannot build the pipe's permissions: %w", err)
} }
name, err := windows.UTF16PtrFromString(approvalPipeName) name, err := windows.UTF16PtrFromString(pipeName)
if err != nil { if err != nil {
return err return err
} }
@@ -249,11 +256,12 @@ func serveApprovalPipe(stop <-chan struct{}, ready func()) error {
s := &approvalPipeServer{ s := &approvalPipeServer{
sa: &windows.SecurityAttributes{Length: uint32(unsafe.Sizeof(windows.SecurityAttributes{})), SecurityDescriptor: sd}, sa: &windows.SecurityAttributes{Length: uint32(unsafe.Sizeof(windows.SecurityAttributes{})), SecurityDescriptor: sd},
name: name, name: name,
label: pipeName,
stopEv: stopEv, stopEv: stopEv,
} }
// The loop and its no-gap rule are in approvalpipe.go, where the suite runs them. // The loop and its no-gap rule are in approvalpipe.go, where the suite runs them.
return pipeAcceptLoop[*pipeConn](s, stop, pipeMaxClients, time.Second, return pipeAcceptLoop[*pipeConn](s, stop, pipeMaxClients, time.Second,
func(f string, a ...any) { fmt.Printf(f, a...) }, ready, servePipeConn) func(f string, a ...any) { fmt.Printf(f, a...) }, ready, serve)
} }
// servePipeConn answers one request and waits, briefly, for the client to // servePipeConn answers one request and waits, briefly, for the client to
@@ -291,7 +299,12 @@ func servePipeConn(c *pipeConn) {
// (GetNamedPipeClientProcessId), its user and session from that process's // (GetNamedPipeClientProcessId), its user and session from that process's
// token, and the person signed in to that session from the session's own token // token, and the person signed in to that session from the session's own token
// (WTSQueryUserToken, which LocalSystem may call). // (WTSQueryUserToken, which LocalSystem may call).
//
// The process is found by its id, after it connected. An id that was freed
// and given to a new process in between would name the wrong one, so a
// process created after the connection is refused (pipeClientNewer).
func pipeClientOf(h windows.Handle) (pipeClient, error) { func pipeClientOf(h windows.Handle) (pipeClient, error) {
connected := time.Now()
var c pipeClient var c pipeClient
if err := windows.GetNamedPipeClientProcessId(h, &c.PID); err != nil { if err := windows.GetNamedPipeClientProcessId(h, &c.PID); err != nil {
return c, fmt.Errorf("cannot tell which process connected: %w", err) return c, fmt.Errorf("cannot tell which process connected: %w", err)
@@ -301,6 +314,13 @@ func pipeClientOf(h windows.Handle) (pipeClient, error) {
return c, fmt.Errorf("cannot open the connecting process (pid %d): %w", c.PID, err) return c, fmt.Errorf("cannot open the connecting process (pid %d): %w", c.PID, err)
} }
defer windows.CloseHandle(p) defer windows.CloseHandle(p)
var created, exited, kernel, user windows.Filetime
if err := windows.GetProcessTimes(p, &created, &exited, &kernel, &user); err != nil {
return c, fmt.Errorf("cannot read when the connecting process started (pid %d): %w", c.PID, err)
}
if pipeClientNewer(time.Unix(0, created.Nanoseconds()), connected) {
return c, fmt.Errorf("process %d started after the connection was made, so it is not the process that connected", c.PID)
}
var tok windows.Token var tok windows.Token
if err := windows.OpenProcessToken(p, windows.TOKEN_QUERY, &tok); err != nil { if err := windows.OpenProcessToken(p, windows.TOKEN_QUERY, &tok); err != nil {
return c, fmt.Errorf("cannot read the connecting process's account (pid %d): %w", c.PID, err) return c, fmt.Errorf("cannot read the connecting process's account (pid %d): %w", c.PID, err)
@@ -381,7 +401,12 @@ func pipeCall(req pipeRequest) (pipeResponse, error) {
// (read, write data, synchronize; never FILE_APPEND_DATA, which GENERIC_WRITE // (read, write data, synchronize; never FILE_APPEND_DATA, which GENERIC_WRITE
// would ask for), and lets the server identify this process but not act as it. // would ask for), and lets the server identify this process but not act as it.
func dialApprovalPipe() (*pipeConn, error) { func dialApprovalPipe() (*pipeConn, error) {
name, err := windows.UTF16PtrFromString(approvalPipeName) return dialServicePipe(approvalPipeName)
}
// dialServicePipe opens one of the service's pipes (dialApprovalPipe).
func dialServicePipe(pipeName string) (*pipeConn, error) {
name, err := windows.UTF16PtrFromString(pipeName)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -401,7 +426,7 @@ func dialApprovalPipe() (*pipeConn, error) {
continue continue
} }
if errors.Is(err, windows.ERROR_FILE_NOT_FOUND) { if errors.Is(err, windows.ERROR_FILE_NOT_FOUND) {
return nil, errors.New("the bastion service is not running, or is older than this tray") return nil, errors.New("the bastion service is not running, or is older than this program")
} }
return nil, fmt.Errorf("cannot reach the bastion service: %w", err) return nil, fmt.Errorf("cannot reach the bastion service: %w", err)
} }
@@ -413,14 +438,14 @@ func dialApprovalPipe() (*pipeConn, error) {
func pipeServerIsService(h windows.Handle) error { func pipeServerIsService(h windows.Handle) error {
var pid uint32 var pid uint32
if err := windows.GetNamedPipeServerProcessId(h, &pid); err != nil { if err := windows.GetNamedPipeServerProcessId(h, &pid); err != nil {
return fmt.Errorf("cannot tell which process serves the approvals pipe: %w", err) return fmt.Errorf("cannot tell which process serves the pipe: %w", err)
} }
svcPID, err := bastionServicePID() svcPID, err := bastionServicePID()
if err != nil { if err != nil {
return err return err
} }
if svcPID == 0 || pid != svcPID { if svcPID == 0 || pid != svcPID {
return fmt.Errorf("the approvals pipe is served by process %d, not by the %s service; nothing was sent", pid, winServiceName) return fmt.Errorf("the pipe is served by process %d, not by the %s service; nothing was sent", pid, winServiceName)
} }
return nil return nil
} }
+39 -9
View File
@@ -41,8 +41,14 @@ import (
const approvalsOwnerFile = "approvals_owner.json" const approvalsOwnerFile = "approvals_owner.json"
// The record names the owner one way per platform: a SID on Windows, a uid
// on Linux and macOS, where the account is the one the console lane serves
// (consolelane.go). Account is that uid's name when it was recorded, for
// messages only; the uid is what is compared, since a name can be changed.
type approvalsOwnerRecord struct { type approvalsOwnerRecord struct {
SID string `json:"sid"` SID string `json:"sid,omitempty"`
UID *uint32 `json:"uid,omitempty"`
Account string `json:"account,omitempty"`
SetAt string `json:"set_at"` SetAt string `json:"set_at"`
} }
@@ -61,30 +67,54 @@ func approvalsOwnerPath() (string, error) {
return filepath.Join(d, approvalsOwnerFile), nil return filepath.Join(d, approvalsOwnerFile), nil
} }
// approvalsOwnerLoad reads the record. present is true when a record exists, // ownerRecordLoad reads the record as it is. present is true when a record
// readable or not; sid is "" unless it is readable and names a person. // exists, readable or not.
func approvalsOwnerLoad() (sid string, present bool, err error) { func ownerRecordLoad() (r approvalsOwnerRecord, present bool, err error) {
p, err := approvalsOwnerPath() p, err := approvalsOwnerPath()
if err != nil { if err != nil {
return "", false, err return r, false, err
} }
raw, err := os.ReadFile(p) raw, err := os.ReadFile(p)
if errors.Is(err, fs.ErrNotExist) { if errors.Is(err, fs.ErrNotExist) {
return "", false, nil return r, false, nil
} }
if err != nil { if err != nil {
return "", true, err return r, true, err
} }
var r approvalsOwnerRecord
if err := json.Unmarshal(raw, &r); err != nil { if err := json.Unmarshal(raw, &r); err != nil {
return "", true, fmt.Errorf("%s cannot be read: %w", p, err) return approvalsOwnerRecord{}, true, fmt.Errorf("%s cannot be read: %w", p, err)
}
return r, true, nil
}
// approvalsOwnerLoad reads the record. present is true when a record exists,
// readable or not; sid is "" unless it is readable and names a person.
func approvalsOwnerLoad() (sid string, present bool, err error) {
r, present, err := ownerRecordLoad()
if err != nil || !present {
return "", present, err
} }
if !approvalsOwnerSIDOK(r.SID) { if !approvalsOwnerSIDOK(r.SID) {
p, _ := approvalsOwnerPath()
return "", true, fmt.Errorf("%s names no person's account", p) return "", true, fmt.Errorf("%s names no person's account", p)
} }
return r.SID, true, nil return r.SID, true, nil
} }
// ownerAccountLoad is the Linux and macOS reading of the record: the owner's
// uid, never root's (root needs no lane to its own bastion).
func ownerAccountLoad() (uid uint32, account string, present bool, err error) {
r, present, err := ownerRecordLoad()
if err != nil || !present {
return 0, "", present, err
}
if r.UID == nil || *r.UID == 0 {
p, _ := approvalsOwnerPath()
return 0, "", true, fmt.Errorf("%s names no person's account on this system", p)
}
return *r.UID, r.Account, true, nil
}
// approvalsOwner is the SID the pipe serves, "" when none is recorded or the // approvalsOwner is the SID the pipe serves, "" when none is recorded or the
// record cannot be read: the pipe then serves nobody. // record cannot be read: the pipe then serves nobody.
func approvalsOwner() string { func approvalsOwner() string {
+138
View File
@@ -0,0 +1,138 @@
package main
import (
"encoding/json"
"errors"
"net"
"os"
"os/user"
"path/filepath"
"strings"
"testing"
"time"
)
// The socket answers "status" with the kernel's name for the caller, so a
// real connection reads the caller's own ask and nobody else's.
func TestTheAskSocketAnswersStatusOnlyForTheAsker(t *testing.T) {
askFlowWorld(t)
me, err := user.Current()
if err != nil {
t.Skip("no account name for this process:", err)
}
mine := fileAsk(agentAskRequest{Op: "stop", PID: 101}, me.Username, 0)
theirs := fileAsk(agentAskRequest{Op: "stop", PID: 102}, me.Username+"-other", 0)
if !mine.OK || !theirs.OK {
t.Fatalf("asks: %+v %+v", mine, theirs)
}
sock := filepath.Join(t.TempDir(), "ask.sock")
ln, err := net.Listen("unix", sock)
if err != nil {
t.Fatal(err)
}
defer ln.Close()
go func() {
for {
c, err := ln.Accept()
if err != nil {
return
}
go askSockServe(c)
}
}()
ask := func(id string) agentAskReply {
t.Helper()
c, err := net.DialTimeout("unix", sock, 3*time.Second)
if err != nil {
t.Fatal(err)
}
defer c.Close()
_ = json.NewEncoder(c).Encode(agentAskRequest{Op: "status", Request: id})
var r agentAskReply
if err := json.NewDecoder(c).Decode(&r); err != nil {
t.Fatal(err)
}
return r
}
if r := ask(mine.Request); !r.OK || r.State != askWaiting || r.User != me.Username {
t.Errorf("my own ask over the socket: %+v", r)
}
if r := ask(theirs.Request); r.OK || r.State != askUnknown {
t.Errorf("another account's ask over the socket: %+v", r)
}
}
// `stop` run by an agent (no terminal) files the ask and prints it as JSON;
// `request` follows it to the outcome, with the exit status to branch on.
func TestStopAndRequestFromAnAgent(t *testing.T) {
d := askFlowWorld(t)
prevAuth := machineAuthorityHeld
t.Cleanup(func() { machineAuthorityHeld = prevAuth })
machineAuthorityHeld = func() bool { return true } // holds the state: the direct path
r, w, err := os.Pipe()
if err != nil {
t.Fatal(err)
}
prevIn := os.Stdin
os.Stdin = r // a pipe, not a terminal: an agent
t.Cleanup(func() { os.Stdin = prevIn; _ = w.Close(); _ = r.Close() })
out := captureStdout(t)
if err := cmdStop([]string{"101", "--json"}); err != nil {
t.Fatalf("stop: %v", err)
}
var v askView
if err := json.Unmarshal([]byte(printedSince(out, 0, "}\n")), &v); err != nil || v.State != askWaiting ||
v.Request == "" {
t.Fatalf("stop --json printed %q (%v)", out(), err)
}
rows := auditRowsOf(t, d, localStopAskOp)
if len(rows) != 1 {
t.Fatalf("filing rows: %v", rows)
}
id := fullRequestID(t, d, v.Request)
if _, err := stepupApproveRequest(d, id, codeFor(t, machineTestSecret)); err != nil {
t.Fatal(err)
}
localStopOnce(d, time.Now())
before := len(out())
if err := cmdRequest([]string{v.Request}); err != nil {
t.Fatalf("request after the stop: %v", err)
}
if got := printedSince(out, before, "done."); !strings.Contains(got, "approved by the machine's owner and done") {
t.Errorf("request printed %q", got)
}
// A second ask, denied: `request` exits 1 without an error line.
second := mustAsk(t, 102)
if err := stepupDenyRequest(d, fullRequestID(t, d, second)); err != nil {
t.Fatal(err)
}
var q quietExit
if err := cmdRequest([]string{second, "--json"}); !errors.As(err, &q) || q.code != 1 {
t.Errorf("a denied ask: %v", err)
}
}
// printedSince waits (briefly) for captured output past from to hold want:
// captureStdout copies the pipe on its own goroutine.
func printedSince(out func() string, from int, want string) string {
deadline := time.Now().Add(3 * time.Second)
for {
got := out()[from:]
if strings.Contains(got, want) || time.Now().After(deadline) {
return got
}
time.Sleep(10 * time.Millisecond)
}
}
func mustAsk(t *testing.T, pid int) string {
t.Helper()
r := fileAsk(agentAskRequest{Op: "stop", PID: pid}, procUser(os.Getpid()), 0)
if !r.OK {
t.Fatal(r.Why)
}
return r.Request
}
+472
View File
@@ -0,0 +1,472 @@
package main
import (
"bufio"
"bytes"
"encoding/json"
"errors"
"os"
"path/filepath"
"strconv"
"strings"
"testing"
"time"
)
// askFlowWorld is askWorld with each agent's origin set, so the audit's
// "started by" can be checked: the asking claude-code session was started at
// a terminal, the aider job by the scheduler.
func askFlowWorld(t *testing.T) string {
t.Helper()
uiTestConfigDir(t)
stubStopWorld(t, []agentObs{
{PID: 101, Kind: kindAgent, Signature: "aider", User: "u", Origin: "scheduler"},
{PID: 102, Kind: kindAgent, Signature: "aider", User: "u", Origin: "scheduler"},
{PID: 103, Kind: kindAgent, Signature: "aider", User: "u", Origin: "scheduler"},
{PID: 104, Kind: kindAgent, Signature: "aider", User: "u", Origin: "scheduler"},
{PID: 105, Kind: kindAgent, Signature: "aider", User: "u", Origin: "scheduler"},
{PID: 106, Kind: kindAgent, Signature: "aider", User: "u", Origin: "scheduler"},
{PID: 300, Kind: kindAgent, Signature: "claude-code", User: "u", Origin: "interactive"},
{PID: 4532, Kind: kindApp, Signature: "claude-desktop", User: "u"},
}, map[int]int{310: 300, 311: 310})
prev := homeForUserFn
t.Cleanup(func() { homeForUserFn = prev })
homeForUserFn = func(string) string { return "" }
d, err := machineFactorDir()
if err != nil {
t.Fatal(err)
}
enrolFactorAt(t, d, machineTestSecret)
return d
}
func fullRequestID(t *testing.T, d, prefix string) string {
t.Helper()
for id := range requestsLoad(d) {
if strings.HasPrefix(id, prefix) {
return id
}
}
t.Fatalf("no request %s", prefix)
return ""
}
// The M1 gate's loop: an agent asks, follows the ask, and learns what the
// owner decided and what happened. Before, it got an id and nothing after.
func TestAnAgentFollowsItsAskToTheOutcome(t *testing.T) {
d := askFlowWorld(t)
r := fileAsk(agentAskRequest{Op: "stop", PID: 101}, "u", 311)
if !r.OK {
t.Fatalf("refused: %s", r.Why)
}
if s := askStatus(d, r.Request, "u", false); !s.OK || s.State != askWaiting {
t.Fatalf("before the owner answers: %+v", s)
}
id := fullRequestID(t, d, r.Request)
if _, err := stepupApproveRequest(d, id, codeFor(t, machineTestSecret)); err != nil {
t.Fatal(err)
}
if s := askStatus(d, r.Request, "u", false); s.State != askApproved {
t.Fatalf("approved, not yet carried out: %+v", s)
}
localStopOnce(d, time.Now())
s := askStatus(d, r.Request, "u", false)
if s.State != askStopped || !strings.Contains(s.Outcome, "stopped aider (pid 101)") {
t.Fatalf("after the stop: %+v", s)
}
if got := askSentence(askViewOf(s, false)); !strings.Contains(got, "The bastion stopped aider") {
t.Errorf("the agent reads %q", got)
}
}
// Another account learns nothing about an ask, not even that it exists.
func TestAnotherAccountLearnsNothingOfAnAsk(t *testing.T) {
d := askFlowWorld(t)
r := fileAsk(agentAskRequest{Op: "stop", PID: 101}, "u", 311)
if !r.OK {
t.Fatal(r.Why)
}
theirs := askStatus(d, r.Request, "other", false)
never := askStatus(d, "ffffffff", "other", false)
if theirs.OK || theirs.State != askUnknown || theirs.Text != "" {
t.Fatalf("another account read %+v", theirs)
}
if strings.ReplaceAll(theirs.Why, r.Request, "X") != strings.ReplaceAll(never.Why, "ffffffff", "X") {
t.Errorf("an existing id reads differently from one that never existed: %q vs %q", theirs.Why, never.Why)
}
if s := askStatus(d, r.Request, "", false); s.OK {
t.Errorf("an unnamed asker read an ask: %+v", s)
}
}
// A deny says so, blocks the same ask, and blocks it for a day from the
// deny, not from the ask.
func TestADeniedAskBlocksADayFromTheDeny(t *testing.T) {
d := askFlowWorld(t)
r := fileAsk(agentAskRequest{Op: "stop", PID: 101}, "u", 311)
id := fullRequestID(t, d, r.Request)
if err := stepupDenyRequest(d, id); err != nil {
t.Fatal(err)
}
if s := askStatus(d, r.Request, "u", false); s.State != askDenied {
t.Fatalf("after the deny: %+v", s)
}
again := fileAsk(agentAskRequest{Op: "stop", PID: 101}, "u", 311)
if again.OK || !strings.Contains(again.Why, "refused this same stop within the last 24 hours") {
t.Fatalf("the same ask again: %+v", again)
}
// Asked 25 h ago, denied a minute ago: still blocked.
m := requestsLoad(d)
q := m[id]
q.At = time.Now().Add(-25 * time.Hour).UTC().Format(time.RFC3339)
q.DeniedAt = time.Now().Add(-time.Minute).UTC().Format(time.RFC3339)
m[id] = q
if err := requestsSave(d, m); err != nil {
t.Fatal(err)
}
if _, ok := requestsLoad(d)[id]; !ok {
t.Fatal("a deny a minute old stopped blocking because the ask was 25 h old")
}
q.DeniedAt = time.Now().Add(-25 * time.Hour).UTC().Format(time.RFC3339)
m[id] = q
_ = requestsSave(d, m)
if _, ok := requestsLoad(d)[id]; ok {
t.Fatal("a deny 25 h old still blocks")
}
}
// Five refused asks in ten minutes hold that account's asks; another account
// is not held; the owner lifts it.
func TestRefusedAsksHoldTheAccountThatAsked(t *testing.T) {
d := askFlowWorld(t)
for i := 0; i < quarantineStrikes; i++ {
if r := fileAsk(agentAskRequest{Op: "stop", PID: 4532}, "u", 311); r.OK {
t.Fatalf("an app was asked to stop: %+v", r)
}
}
r := fileAsk(agentAskRequest{Op: "stop", PID: 101}, "u", 311)
if r.OK || !strings.Contains(r.Why, "on hold until") {
t.Fatalf("after five refusals: %+v", r)
}
if r := fileAsk(agentAskRequest{Op: "stop", PID: 101}, "other", 0); !r.OK {
t.Fatalf("another account was held: %s", r.Why)
}
if err := askQuarantineClear(d, "u"); err != nil {
t.Fatal(err)
}
if r := fileAsk(agentAskRequest{Op: "stop", PID: 102}, "u", 311); !r.OK {
t.Fatalf("after the owner lifted it: %s", r.Why)
}
}
// What the owner refuses counts too: five denies hold the account.
func TestOwnerDeniesCountTowardTheHold(t *testing.T) {
d := askFlowWorld(t)
for pid := 101; pid < 101+quarantineStrikes; pid++ {
r := fileAsk(agentAskRequest{Op: "stop", PID: pid}, "u", 311)
if !r.OK {
t.Fatalf("ask %d: %s", pid, r.Why)
}
if err := stepupDenyRequest(d, fullRequestID(t, d, r.Request)); err != nil {
t.Fatal(err)
}
}
if r := fileAsk(agentAskRequest{Op: "stop", PID: 106}, "u", 311); r.OK || !strings.Contains(r.Why, "on hold") {
t.Fatalf("after five denies: %+v", r)
}
// What the machine itself lacks is not the asker's doing.
if until := askHeldUntil(d, "nobody", time.Now()); !until.IsZero() {
t.Fatal("an account that never asked is held")
}
}
func auditRowsOf(t *testing.T, d, op string) []map[string]any {
t.Helper()
var out []map[string]any
fh, err := os.Open(filepath.Join(d, "audit.jsonl"))
if err != nil {
t.Fatal(err)
}
defer fh.Close()
sc := bufio.NewScanner(fh)
for sc.Scan() {
var m map[string]any
if json.Unmarshal(sc.Bytes(), &m) == nil && m["op"] == op {
out = append(out, m)
}
}
return out
}
// Every row about an agent's ask names the asking agent and the target, with
// how each was started: filed, approved, carried out.
func TestTheAuditNamesTheAskerAndTheTarget(t *testing.T) {
d := askFlowWorld(t)
r := fileAsk(agentAskRequest{Op: "stop", PID: 101}, "u", 311)
if _, err := stepupApproveRequest(d, fullRequestID(t, d, r.Request), codeFor(t, machineTestSecret)); err != nil {
t.Fatal(err)
}
localStopOnce(d, time.Now())
for _, op := range []string{localStopAskOp, "stepup_approve", localStopKind} {
rows := auditRowsOf(t, d, op)
if len(rows) != 1 {
t.Fatalf("%s: %d rows", op, len(rows))
}
raw, _ := json.Marshal(rows[0])
var row struct {
Asker struct {
Account string `json:"account"`
PID int `json:"pid"`
Agent struct {
Signature, Origin string
PID int
} `json:"agent"`
} `json:"asker"`
Target struct {
Signature, Origin string
PID int
} `json:"target"`
}
_ = json.Unmarshal(raw, &row)
a, g := row.Asker, row.Target
if a.Account != "u" || a.PID != 311 || a.Agent.Signature != "claude-code" || a.Agent.PID != 300 ||
a.Agent.Origin != "interactive" || g.Signature != "aider" || g.PID != 101 || g.Origin != "scheduler" {
t.Errorf("%s row: %s", op, raw)
}
}
}
// The owner sees the ask and the deny in Activity.
func TestActivityShowsAsksAndDenies(t *testing.T) {
d := askFlowWorld(t)
r := fileAsk(agentAskRequest{Op: "stop", PID: 101}, "u", 311)
if err := stepupDenyRequest(d, fullRequestID(t, d, r.Request)); err != nil {
t.Fatal(err)
}
var asked, denied bool
for _, it := range collectActivity(time.Time{}) {
if strings.Contains(it.Who, "Claude Code (pid 300)") && strings.Contains(it.What, "asked to stop aider") {
asked = true
}
if it.Who == "You" && strings.HasPrefix(it.What, "denied ") && strings.Contains(it.What, "asked by Claude Code") &&
it.Refused {
denied = true
}
}
if !asked || !denied {
t.Fatalf("asked %v denied %v in %+v", asked, denied, collectActivity(time.Time{}))
}
}
// What an agent branches on: the exit status, and JSON it can parse.
func TestAskExitStatusesAndJSON(t *testing.T) {
for _, c := range []struct {
v askView
waited bool
want int // -1: no error
}{
{askView{State: askStopped}, true, -1},
{askView{State: askWaiting, Request: "abcd1234"}, false, -1},
{askView{State: askWaiting, Request: "abcd1234"}, true, askExitWaiting},
{askView{State: askApproved}, true, askExitWaiting},
{askView{State: askDenied}, true, 1},
{askView{State: askNotStopped}, false, 1},
{askView{State: askRefused, Why: "x"}, false, 1},
{askView{State: askUnknown, Why: "x"}, false, 1},
} {
var buf bytes.Buffer
err := printAsk(&buf, c.v, true, c.waited)
var q quietExit
got := -1
if errors.As(err, &q) {
got = q.code
} else if err != nil {
t.Fatalf("%+v: %v", c.v, err)
}
if got != c.want {
t.Errorf("%s (waited %v): exit %d, want %d", c.v.State, c.waited, got, c.want)
}
var back askView
if json.Unmarshal(buf.Bytes(), &back) != nil || back.State != c.v.State {
t.Errorf("%s: --json printed %q", c.v.State, buf.String())
}
}
}
// Agents write the pid before the flags as often as after.
func TestAskFlagsTakeThePositionalAnywhere(t *testing.T) {
for _, args := range [][]string{{"101", "--wait", "5m", "--json"}, {"--json", "101", "--wait=5m"},
{"--wait", "5m", "--json", "101"}} {
key, wait, asJSON, err := askFlags("stop", args)
if err != nil || key != "101" || wait != 5*time.Minute || !asJSON {
t.Errorf("%v: %q %v %v %v", args, key, wait, asJSON, err)
}
}
for _, args := range [][]string{{}, {"101", "102"}, {"101", "--wait", "-1m"}, {"101", "--nope"}} {
if _, _, _, err := askFlags("stop", args); err == nil {
t.Errorf("%v was accepted", args)
}
}
}
// A Host's request is the Host's own words. One that names an account on
// this machine as its asker must not put that account in the owner's audit,
// and the owner denying it must not count toward that account's hold.
func TestAHostsRequestNeverStrikesALocalAccount(t *testing.T) {
d := askFlowWorld(t)
for i := 0; i < quarantineStrikes; i++ {
gd := map[string]any{"kind": "dcn_store_grant", "server": "box1", "root": "/data/" + strconv.Itoa(i),
"mask": []any{"read"}, "sweep": "hourly", "sensitive": false,
"asked_by_account": "u", "asked_by": "You", "asker": map[string]any{"account": "u"}}
gp, err := purposeFromDetails(gd)
if err != nil {
t.Fatal(err)
}
id, err := stepupNewRequest(d, gp, gd)
if err != nil {
t.Fatal(err)
}
if err := stepupDenyRequest(d, id); err != nil {
t.Fatal(err)
}
}
if until := askHeldUntil(d, "u", time.Now()); !until.IsZero() {
t.Fatalf("denying a Host's requests held a local account until %s", until)
}
for _, row := range auditRowsOf(t, d, "stepup_deny") {
if row["asker"] != nil || row["who"] != nil {
t.Fatalf("a Host's request named a local asker in the audit: %v", row)
}
}
// A critical action's own "target" is not an ask's target.
if p := askPartiesOf(map[string]any{"kind": "critical_action", "target": "prod-db"}); p != nil {
t.Fatalf("a Host's request carried ask parties: %v", p)
}
// At the Host's door: the fields only this machine writes are dropped.
ls := map[string]any{"kind": localStopKind, "pid": "101", "signature": "aider", "asked_by_account": "u",
"asker": map[string]any{}, "asked_by": "You", "target": map[string]any{}}
hostAskDetails(ls)
for _, k := range []string{"asked_by_account", "asker", "asked_by", "target"} {
if _, ok := ls[k]; ok {
t.Fatalf("a Host's local_stop kept %q: %v", k, ls)
}
}
ca := map[string]any{"kind": "critical_action", "target": "prod-db", "asked_by_account": "u"}
hostAskDetails(ca)
if ca["target"] != "prod-db" || ca["asked_by_account"] != nil {
t.Fatalf("a critical action keeps its target and loses the local asker: %v", ca)
}
}
// The holds file is keyed by kernel account names, and a user with
// subordinate ids can present thousands. An account with nothing left to
// remember (not held, no recent refusal, no hold within the forgiving day)
// is dropped at the next write; the ones that still matter stay.
func TestTheHoldsFileForgetsAccountsWithNothingToRemember(t *testing.T) {
d := askFlowWorld(t)
now := time.Now()
at := func(ago time.Duration) string { return now.Add(-ago).UTC().Format(time.RFC3339) }
m := map[string]*quarantineEntry{
"stale": {Refusals: []string{at(time.Hour)}},
"old-hold": {Strikes: 1, LastHold: at(48 * time.Hour)},
"held": {Strikes: 1, Until: now.Add(time.Hour).UTC().Format(time.RFC3339), LastHold: at(-time.Hour)},
"doubling": {Strikes: 2, LastHold: at(2 * time.Hour)},
"recent-refus": {Refusals: []string{at(time.Minute)}},
}
if err := askQuarantineSave(d, m); err != nil {
t.Fatal(err)
}
askStrike(d, "new", now)
got := askQuarantineLoad(d)
for _, k := range []string{"stale", "old-hold"} {
if _, ok := got[k]; ok {
t.Fatalf("%s has nothing left to remember and was kept: %v", k, got)
}
}
for _, k := range []string{"held", "doubling", "recent-refus", "new"} {
if _, ok := got[k]; !ok {
t.Fatalf("%s still matters and was dropped: %v", k, got)
}
}
if got["doubling"].Strikes != 2 {
t.Fatalf("the doubling was lost: %+v", got["doubling"])
}
}
// Two accounts asking for the same stop each get their own request, which
// each alone can follow: handing the second one the first's id told it that
// someone else had asked, and gave it an id it could not follow.
func TestTwoAccountsAskingTheSameStopEachGetTheirOwn(t *testing.T) {
d := askFlowWorld(t)
a := fileAsk(agentAskRequest{Op: "stop", PID: 101}, "u", 311)
b := fileAsk(agentAskRequest{Op: "stop", PID: 101}, "other", 0)
if !a.OK || !b.OK {
t.Fatalf("asks: %+v %+v", a, b)
}
if a.Request == b.Request {
t.Fatalf("the second account was handed the first account's request %s", a.Request)
}
if s := askStatus(d, b.Request, "other", false); !s.OK || s.State != askWaiting {
t.Fatalf("the second account cannot follow its own ask: %+v", s)
}
if again := fileAsk(agentAskRequest{Op: "stop", PID: 101}, "u", 311); again.Request != a.Request {
t.Errorf("the same account asking again got a new request %s, not %s", again.Request, a.Request)
}
// The owner's deny of that stop holds for everyone.
if err := stepupDenyRequest(d, fullRequestID(t, d, a.Request)); err != nil {
t.Fatal(err)
}
if r := fileAsk(agentAskRequest{Op: "stop", PID: 101}, "third", 0); r.OK {
t.Errorf("a stop the owner refused was filed again by another account: %+v", r)
}
}
// An approved stop was acted on; if it could not be done, asking again is a
// new request, not the old approved one for the rest of the day.
func TestAStopThatFailedCanBeAskedAgain(t *testing.T) {
d := askFlowWorld(t)
first := fileAsk(agentAskRequest{Op: "stop", PID: 101}, "u", 311)
if _, err := stepupApproveRequest(d, fullRequestID(t, d, first.Request), codeFor(t, machineTestSecret)); err != nil {
t.Fatal(err)
}
localStopOnce(d, time.Now().Add(localStopWindow+time.Minute)) // read too late: not stopped
if s := askStatus(d, first.Request, "u", false); s.State != askNotStopped {
t.Fatalf("the late stop: %+v", s)
}
again := fileAsk(agentAskRequest{Op: "stop", PID: 101}, "u", 311)
if !again.OK || again.Request == first.Request {
t.Fatalf("asking again after a failed stop: %+v (first %s)", again, first.Request)
}
if s := askStatus(d, again.Request, "u", false); s.State != askWaiting {
t.Errorf("the new ask: %+v", s)
}
}
// An account at its limit that asks again for a stop it already has waiting
// gets that request back: it is not a sixth ask, and it is not a refusal to
// count toward a hold.
func TestAskingAgainAtTheLimitReturnsTheWaitingRequest(t *testing.T) {
d := askFlowWorld(t)
var first string
for pid := 101; pid < 101+askMaxPendingPer; pid++ {
r := fileAsk(agentAskRequest{Op: "stop", PID: pid}, "u", 311)
if !r.OK {
t.Fatalf("ask %d: %s", pid, r.Why)
}
if first == "" {
first = r.Request
}
}
for i := 0; i < quarantineStrikes; i++ {
if r := fileAsk(agentAskRequest{Op: "stop", PID: 101}, "u", 311); !r.OK || r.Request != first {
t.Fatalf("asking again for a waiting stop at the limit: %+v (want %s)", r, first)
}
}
if until := askHeldUntil(d, "u", time.Now()); !until.IsZero() {
t.Fatalf("repeating a waiting ask held the account until %v", until)
}
if r := fileAsk(agentAskRequest{Op: "stop", PID: 106}, "u", 311); r.OK || !strings.Contains(r.Why, "already have 5") {
t.Errorf("a new sixth ask: %+v", r)
}
}
+19
View File
@@ -0,0 +1,19 @@
//go:build !windows
package main
import (
"net"
"time"
)
// dialAskLane connects to the machine's bastion's ask socket at p.
func dialAskLane(p string) (askConn, error) {
return net.DialTimeout("unix", p, 3*time.Second)
}
// askLaneAddr is where the lane is, as a message names it.
func askLaneAddr(p string) string { return p }
// startAskPipe is the Windows service's; ask.sock serves here (agentask.go).
func startAskPipe(<-chan struct{}) {}
+153
View File
@@ -0,0 +1,153 @@
//go:build windows
package main
// The ask pipe: ask.sock (agentask.go) for a bastion that runs as the Windows
// service.
//
// Installed for the whole machine, the bastion is a LocalSystem service and
// its state sits in LocalSystem's profile, where the person's own account can
// neither read nor write it. Before this pipe, that account had no way to the
// machine's bastion at all: `privatae-bastion ui` signed in with a key of its
// own and the console answered 401, the reads and owner acts were refused
// beside the service, and an agent could not ask for a stop. The pipe answers
// exactly what ask.sock answers, through the same code (askAnswer): a stop
// asked by any account, and the console, the reads and the owner's acts for
// the account recorded as the machine's owner (approvals-owner --sid), with
// the caller taken from the pipe client's token, never from the request.
//
// The pipe is the approvals pipe's machinery (approvalpipe_windows.go):
// overlapped I/O with a timeout on every call, a new instance created before
// the one it replaces is handed out, the first instance created with
// FILE_FLAG_FIRST_PIPE_INSTANCE, and the asking side checking the pipe's
// server is the service's own process before it sends anything, since an act
// carries the owner's code.
import (
"encoding/json"
"errors"
"fmt"
"io"
"time"
"golang.org/x/sys/windows"
)
// startAskPipe serves the ask pipe until done is closed, retrying with backoff
// when it cannot (pipeServeRetrying), as the approvals pipe does.
func startAskPipe(done <-chan struct{}) {
wait := func(d time.Duration) bool {
select {
case <-done:
return false
case <-time.After(d):
return true
}
}
go pipeServeRetrying(func(ready func()) error {
return servePipe(done, ready, askPipeName, askPipeSDDL, serveAskPipeConn)
}, wait, func(f string, a ...any) { fmt.Printf(f, a...) })
}
// serveAskPipeConn answers one ask, then waits briefly for the client to
// close: closing first would discard an answer it has not read yet.
func serveAskPipeConn(c *pipeConn) {
client, cerr := pipeClientOf(c.h)
raw, err := c.readLine(askMaxBytes, pipeIOTimeout)
if err != nil {
return
}
var reply any
switch {
case cerr != nil:
reply = askUnattributable(cerr)
default:
who := pipeWho(client)
var req agentAskRequest
if err := json.Unmarshal(raw, &req); err != nil {
reply = agentAskReply{User: who, Why: "the request could not be read"}
break
}
peer := askPeer{SID: client.UserSID, Name: who, PID: int(client.PID)}
reply = askAnswer(peer, req, func(time.Duration) {}, func() int { return int(client.PID) })
}
out, _ := json.Marshal(reply)
if err := c.write(append(out, '\n'), pipeIOTimeout); err != nil {
return
}
_, _ = c.read(pipeIOTimeout)
}
// dialAskLane opens the service's ask pipe; p, ask.sock's path, does not
// apply here.
func dialAskLane(string) (askConn, error) {
c, err := dialServicePipe(askPipeName)
if err != nil {
return nil, err
}
if err := pipeServerIsService(c.h); err != nil {
c.close()
return nil, err
}
return &askPipeClient{c: c}, nil
}
// askLaneAddr is where the lane is, as a message names it.
func askLaneAddr(string) string { return askPipeName }
// askPipeClient is the asking side's end of the pipe, read and written the
// way the lane's code reads and writes a socket: a deadline for the whole
// exchange, bytes in, bytes out.
type askPipeClient struct {
c *pipeConn
deadline time.Time
pending []byte
}
func (a *askPipeClient) SetDeadline(t time.Time) error {
a.deadline = t
return nil
}
// left is what remains of the deadline for one call; 0 waits as long as it
// takes, which only a caller that set no deadline gets.
func (a *askPipeClient) left() time.Duration {
if a.deadline.IsZero() {
return 0
}
if d := time.Until(a.deadline); d > 0 {
return d
}
return time.Millisecond
}
func (a *askPipeClient) Read(b []byte) (int, error) {
for len(a.pending) == 0 {
n, err := a.c.read(a.left())
a.pending = append(a.pending, a.c.buf[:n]...)
if err != nil && !errors.Is(err, windows.ERROR_MORE_DATA) {
if len(a.pending) > 0 {
break
}
if errors.Is(err, windows.ERROR_BROKEN_PIPE) || errors.Is(err, windows.ERROR_PIPE_NOT_CONNECTED) {
return 0, io.EOF
}
return 0, err
}
}
n := copy(b, a.pending)
a.pending = a.pending[n:]
return n, nil
}
func (a *askPipeClient) Write(b []byte) (int, error) {
if err := a.c.write(b, a.left()); err != nil {
return 0, err
}
return len(b), nil
}
func (a *askPipeClient) Close() error {
a.c.close()
return nil
}
+77
View File
@@ -0,0 +1,77 @@
package main
// askparties.go — who asked to stop what, in the form the audit keeps: the
// asking account (the kernel's answer), the asking process and the agent it
// descends from, and the target, each with how it was started (origin.go:
// interactive, scheduler, service, ...). They are kept on the request itself
// (Details "asker" and "target"), so every later row about that request —
// approved, denied, carried out — names both, not only the row that filed it.
// askingAgentObs is the observed agent pid descends from, and its pid.
func askingAgentObs(pid int, observed map[int]agentObs) (agentObs, int, bool) {
parents := processTree()
p := pid
for i := 0; p > 1 && i < 64; i++ {
if a, ok := observed[p]; ok && a.Kind != kindApp {
return a, p, true
}
p = parents[p]
}
return agentObs{}, 0, false
}
// askParties describes the asker and the target of one stop ask. askerPID is
// the kernel's pid for the asking process, 0 where the platform does not say.
func askParties(account string, askerPID, targetPID int, observed map[int]agentObs) (asker, target map[string]any) {
asker = map[string]any{"account": account}
if askerPID > 1 {
asker["pid"] = askerPID
if a, p, ok := askingAgentObs(askerPID, observed); ok {
asker["agent"] = agentParty(a, p)
}
}
target = agentParty(observed[targetPID], targetPID)
return asker, target
}
func agentParty(a agentObs, pid int) map[string]any {
out := map[string]any{"pid": pid, "signature": a.Signature, "name": familyLabel(a.Signature)}
if a.Origin != "" {
out["origin"] = a.Origin
}
return out
}
// askPartiesOf is what a request carries about its asker and target, for an
// audit row; nil for a request no local agent asked (a Host's).
func askPartiesOf(d map[string]any) map[string]any {
if kind, _ := d["kind"].(string); kind != localStopKind {
return nil // "target" is a critical_action's own word, not a party
}
out := map[string]any{}
for _, k := range []string{"asker", "target"} {
if v, ok := d[k]; ok && v != nil {
out[k] = v
}
}
if by, _ := d["asked_by"].(string); by != "" {
out["who"] = by
}
if len(out) == 0 {
return nil
}
return out
}
// hostAskDetails drops from a Host's request the fields only this machine
// writes about a local agent's ask. A Host's details are its own words, so
// without this it could name an account on this computer as the asker in the
// owner's audit, and have the owner's deny count against that account.
func hostAskDetails(d map[string]any) {
delete(d, "asked_by_account")
delete(d, "asker")
if kind, _ := d["kind"].(string); kind == localStopKind {
delete(d, "asked_by")
delete(d, "target")
}
}
+89
View File
@@ -0,0 +1,89 @@
package main
// askpeer.go — who is on the other end of the owner's lane, on every platform.
//
// The lane (agentask.go: ask.sock on Linux and macOS, the ask pipe on Windows,
// asklane_windows.go) learns the connecting account from the operating system,
// never from the request: a uid from the socket's peer credentials, or a SID
// from the pipe client's token. The machine's owner is recorded the same two
// ways (approvals_owner.go). Every refusal on the lane asks here, so both
// platforms answer with the same rules, and only the commands they name differ.
import (
"strconv"
"strings"
"time"
)
type askPeer struct {
UID uint32 // Linux and macOS: the connecting process's account
SID string // Windows: the pipe client's token user; "" elsewhere
Name string // the account as messages name it
PID int // the connecting process; 0 when the platform does not say
}
// windows reports whether the peer came over the Windows pipe.
func (p askPeer) windows() bool { return p.SID != "" }
// laneOwnerMatch reads the recorded owner the way peer's platform names
// accounts. present is true when a record exists, readable or not; ownerName
// is how a refusal names the owner.
func laneOwnerMatch(p askPeer) (match bool, ownerName string, present bool, err error) {
if p.windows() {
sid, present, err := approvalsOwnerLoad()
if err != nil || !present {
return false, "", present, err
}
return strings.EqualFold(sid, p.SID), sid, true, nil
}
uid, name, present, err := ownerAccountLoad()
if err != nil || !present {
return false, "", present, err
}
if name == "" {
name = "uid " + strconv.FormatUint(uint64(uid), 10)
}
return uid == p.UID, name, true, nil
}
// ownerRecordCommand is the administrator's command that records peer's
// account as the machine's owner.
func ownerRecordCommand(p askPeer) string {
if p.windows() {
return adminCommandFor(true, "approvals-owner --sid "+p.SID)
}
return "sudo -H privatae-bastion approvals-owner --account " + accountForHint(p.Name)
}
// adminCommandFor is `privatae-bastion <cmd>` as the machine's administrator
// types it: in an Administrator terminal on Windows, with `sudo -H` elsewhere.
func adminCommandFor(windows bool, cmd string) string {
if windows {
return "privatae-bastion " + cmd + " (from an Administrator terminal)"
}
return "sudo -H privatae-bastion " + cmd
}
// askConn is one connection of the lane as the asking side holds it: a unix
// socket (net.Conn), or the Windows pipe client (asklane_windows.go).
type askConn interface {
Read(b []byte) (int, error)
Write(b []byte) (int, error)
Close() error
SetDeadline(t time.Time) error
}
const (
// askPipeName is the Windows service's ask pipe, the counterpart of
// ask.sock: any account on the machine may connect and ask; who it is
// comes from the pipe client's token.
askPipeName = `\\.\pipe\privatae-bastion-ask`
// askPipeSDDL: SYSTEM and Administrators full control; Authenticated
// Users (AU) read, write and synchronize, as any local account may
// connect to ask.sock. Not FILE_CREATE_PIPE_INSTANCE (FILE_APPEND_DATA,
// 0x4, on a pipe): 0x12019b is the approvals pipe's mask for the same
// reason (approvalpipe.go), so no client can stand up its own end of this
// name. P protects the DACL from inheritance.
askPipeSDDL = "D:P(A;;GA;;;SY)(A;;GA;;;BA)(A;;0x12019b;;;AU)"
)
+248
View File
@@ -0,0 +1,248 @@
package main
import (
"encoding/json"
"os"
"path/filepath"
"strings"
"testing"
"time"
)
const (
testOwnerSID = "S-1-5-21-1111111111-2222222222-3333333333-1001"
testOtherSID = "S-1-5-21-1111111111-2222222222-3333333333-1002"
)
// writeSIDOwner records sid as the machine's owner, as `approvals-owner --sid`
// writes it on Windows.
func writeSIDOwner(t *testing.T, dir, sid string) {
t.Helper()
if err := os.MkdirAll(dir, 0o700); err != nil {
t.Fatal(err)
}
raw, _ := json.Marshal(approvalsOwnerRecord{SID: sid, SetAt: time.Now().UTC().Format(time.RFC3339)})
if err := os.WriteFile(filepath.Join(dir, approvalsOwnerFile), raw, 0o600); err != nil {
t.Fatal(err)
}
}
// The Windows ask pipe answers the owner's reads, acts and console for the
// account whose SID the installer recorded, and refuses every other one, in
// Windows' own commands: no sudo anywhere.
//
// MUTATION: compare p.UID in laneOwnerMatch for a Windows peer. RESULT: red
// (the owner's SID is refused).
func TestTheAskPipeServesTheOwnersSIDOnly(t *testing.T) {
dir := isolateConfigDir(t)
owner := askPeer{SID: testOwnerSID, Name: `DESKTOP\owner (` + testOwnerSID + `)`}
other := askPeer{SID: testOtherSID, Name: `DESKTOP\other (` + testOtherSID + `)`}
why := readLaneRefusalFor(owner)
if !strings.Contains(why, "approvals-owner --sid "+testOwnerSID) || !strings.Contains(why, "Administrator terminal") {
t.Errorf("with no owner recorded, the refusal does not give Windows' command: %q", why)
}
writeSIDOwner(t, dir, testOwnerSID)
if why := readLaneRefusalFor(owner); why != "" {
t.Errorf("the owner's SID was refused a read: %s", why)
}
if why := consoleLaneRefusalFor(owner); why != "" {
t.Errorf("the owner's SID was refused the console: %s", why)
}
// Case differs between a SID read from a token and one typed.
if why := readLaneRefusalFor(askPeer{SID: strings.ToLower(testOwnerSID), Name: "owner"}); why != "" {
t.Errorf("the owner's SID in other case was refused: %s", why)
}
for _, why := range []string{readLaneRefusalFor(other), consoleLaneRefusalFor(other)} {
if why == "" || !strings.Contains(why, testOwnerSID) || !strings.Contains(why, other.Name) {
t.Errorf("another account was not refused, naming both: %q", why)
}
if strings.Contains(why, "sudo") {
t.Errorf("a Windows refusal names sudo: %q", why)
}
}
if r := serveActFor(other, agentAskRequest{Act: "deny", ID: "abcd1234"}); r.OK || r.User != other.Name {
t.Errorf("another account's act: %+v", r)
}
// A record of the other platform's kind is no owner here.
uid := uint32(1000)
raw, _ := json.Marshal(approvalsOwnerRecord{UID: &uid, Account: "someone"})
if err := os.WriteFile(filepath.Join(dir, approvalsOwnerFile), raw, 0o600); err != nil {
t.Fatal(err)
}
if why := readLaneRefusalFor(owner); why == "" {
t.Error("a uid record let a Windows SID through")
}
}
// One dispatcher answers both lanes, so the pipe answers what the socket does.
func TestAskAnswerIsTheSocketsAnswer(t *testing.T) {
isolateConfigDir(t)
peer := askPeer{SID: testOwnerSID, Name: "owner"}
var extended []time.Duration
extend := func(d time.Duration) { extended = append(extended, d) }
if r, ok := askAnswer(peer, agentAskRequest{Op: "read", Read: "approvals"}, extend, func() int { return 0 }).(agentReadReply); !ok || r.OK {
t.Errorf("a read with no owner recorded: %+v", r)
}
if r, ok := askAnswer(peer, agentAskRequest{Op: "console"}, extend, func() int { return 0 }).(agentAskReply); !ok || r.OK || r.Why == "" {
t.Errorf("the console with no owner recorded: %+v", r)
}
pid := 0
if r, ok := askAnswer(peer, agentAskRequest{Op: "stop", PID: 4242}, extend, func() int { pid = 7; return 7 }).(agentAskReply); !ok || r.OK {
t.Errorf("a stop with no code set up: %+v", r)
}
if pid != 7 {
t.Error("a stop was filed without asking which process asked")
}
if len(extended) != 1 || extended[0] != readDeadline {
t.Errorf("deadlines given: %v", extended)
}
}
func TestAdminCommandsAreEachPlatformsOwn(t *testing.T) {
if got := adminCommandFor(true, "ui"); strings.Contains(got, "sudo") || !strings.Contains(got, "Administrator terminal") {
t.Errorf("windows: %q", got)
}
if got := adminCommandFor(false, "ui"); got != "sudo -H privatae-bastion ui" {
t.Errorf("unix: %q", got)
}
if !strings.Contains(askPipeSDDL, "0x12019b;;;AU") || strings.Contains(askPipeSDDL, "GW;;;AU") || strings.Contains(askPipeSDDL, "GA;;;AU") {
t.Errorf("the ask pipe's ACL gives every account more than read and write: %s", askPipeSDDL)
}
}
// A page with no session names the command that opens it on this machine.
// The machine's console is not opened by "privatae-bastion ui" from just any
// account, and telling a person only that sent them back to a 401.
func TestNotSignedInNamesTheCommandThatOpensThisConsole(t *testing.T) {
if got := notSignedIn("ui", "windows", true); !strings.Contains(got, "Administrator terminal") ||
!strings.Contains(got, "owns this machine") || strings.Contains(got, "sudo") {
t.Errorf("the Windows service's console: %q", got)
}
if got := notSignedIn("ui", "linux", true); !strings.Contains(got, "sudo -H privatae-bastion ui") ||
!strings.Contains(got, "owns this machine") {
t.Errorf("the root bastion's console: %q", got)
}
if got := notSignedIn("ui", "windows", false); !strings.Contains(got, "`privatae-bastion ui`") || strings.Contains(got, "Administrator") {
t.Errorf("an account's own bastion: %q", got)
}
err := uiKeyRefused("127.0.0.1:7880", "401 Unauthorized", "windows", true, false)
if s := err.Error(); !strings.Contains(s, winServiceName) || strings.Contains(s, "sudo") || strings.Contains(s, "restart it") {
t.Errorf("a 401 beside the Windows service: %q", s)
}
}
// A second start says what is running and how to reach it, and never that it
// should be ended: ending it was what the old words sent a person to do.
//
// MUTATION: drop the PID from secondRunWords. RESULT: red.
func TestASecondStartNamesTheRunningBastion(t *testing.T) {
task := runHolder{PID: 4242, Program: `C:\Users\someone\AppData\Local\Programs\privatae-bastion\privatae-bastion.exe`,
Started: "2026-11-02T18:02:00Z"}
console, dialog := secondRunWords(task, true)
for _, want := range []string{"4242", task.Program, "privatae-bastion ui", "Stop-Process -Id 4242"} {
if !strings.Contains(console, want) || !strings.Contains(dialog.Body, want) {
t.Errorf("the refusal does not say %q:\n%s\n%s", want, console, dialog.Body)
}
}
svc, _ := secondRunWords(runHolder{PID: 9, Service: true}, true)
if !strings.Contains(svc, "as the "+winServiceName+" service") || !strings.Contains(svc, "Restart-Service "+winServiceName) {
t.Errorf("the service: %s", svc)
}
old, _ := secondRunWords(runHolder{}, false)
if !strings.Contains(old, "Get-Process privatae-bastion") {
t.Errorf("an older bastion holding the lock: %s", old)
}
for _, s := range []string{console, svc, old, dialog.Body} {
if strings.Contains(s, "Task Manager") || strings.Contains(s, "believe the running one is dead") {
t.Errorf("the refusal sends the person to end the running bastion: %s", s)
}
}
dir := t.TempDir()
writeRunHolder(dir, true)
if h, ok := readRunHolder(dir); !ok || h.PID != os.Getpid() || !h.Console {
t.Errorf("the holder record: %+v, %v", h, ok)
}
}
// A bastion relaunched by its predecessor's update waits for it to exit and
// then takes the lock, where it used to refuse as a second copy and leave the
// machine with none.
func TestARelaunchedBastionWaitsForThePredecessorsLock(t *testing.T) {
clock := time.Unix(0, 0)
now := func() time.Time { return clock }
sleep := func(d time.Duration) { clock = clock.Add(d) }
held := 3
try := func() error {
if held > 0 {
held--
return os.ErrExist
}
return nil
}
waited := 0
waitExit := func(pid int, d time.Duration) { waited = pid }
if err := takeRunLock(try, 4242, waitExit, 30*time.Second, now, sleep); err != nil {
t.Fatalf("the lock was not taken once the predecessor let go: %v", err)
}
if waited != 4242 {
t.Errorf("waited on process %d", waited)
}
held = 1 << 30
if err := takeRunLock(try, 4242, waitExit, 30*time.Second, now, sleep); err == nil {
t.Fatal("a lock held for ever was taken")
}
held, waited = 1, 0
if err := takeRunLock(try, 0, waitExit, 30*time.Second, now, sleep); err == nil || waited != 0 {
t.Errorf("a start that replaces nothing waited, or retried: %v, %d", err, waited)
}
t.Setenv(relaunchOfEnv, "4242")
if got := relaunchOf(); got != 4242 {
t.Errorf("relaunchOf = %d", got)
}
if _, set := os.LookupEnv(relaunchOfEnv); set {
t.Error("the predecessor's pid would pass on to what this bastion starts")
}
}
// The Windows files wire it together: they are not built on Linux, so this
// reads them, as TestServiceModeOpensNothingOnTheDesktop does.
func TestTheWindowsFilesWireTheLaneTheCarryAndTheRelaunchWait(t *testing.T) {
for file, wants := range map[string][]string{
"relaunch_windows.go": {`relaunchOfEnv+"="+strconv.Itoa(os.Getpid())`},
"runguard_windows.go": {"takeRunLock(", "relaunchOf()", "writeRunHolder(d,", "secondRunWords("},
"sysservice_windows.go": {"carryStateInto(from, to)", "serviceCarrySource(serviceCarryFromSID)"},
"asklane_windows.go": {"askAnswer(peer, req", "pipeServerIsService(c.h)", "askPipeSDDL"},
"agentask.go": {"startAskPipe(done)"},
"../deploy/install.ps1": {"service install --from-account $owner"},
} {
src, err := os.ReadFile(file)
if err != nil {
t.Fatal(err)
}
for _, w := range wants {
if !strings.Contains(string(src), w) {
t.Errorf("%s no longer has %s", file, w)
}
}
}
// The carry runs before the service's first start, not after it.
src, _ := os.ReadFile("sysservice_windows.go")
s := string(src)
if c, st := strings.Index(s, "carryStateInto(from, to)"), strings.Index(s, "s.Start()"); c < 0 || st < 0 || c > st {
t.Error("the carry is not before the service starts, so the service would start with no pairing")
}
}
// A process that started after the connection was made is not the one that
// made it: its id was freed and reused, and answering it would answer a
// stranger as whoever holds that id now.
func TestAPipeClientStartedAfterItsConnectionIsNotTheCaller(t *testing.T) {
connected := time.Unix(1000, 0)
if !pipeClientNewer(connected.Add(time.Millisecond), connected) {
t.Error("a process created after the connection was taken for the caller")
}
if pipeClientNewer(connected.Add(-time.Hour), connected) {
t.Error("the process that connected was refused")
}
}
+170
View File
@@ -0,0 +1,170 @@
package main
// askquarantine.go — the machine holds an account whose asks keep being
// refused, the way quarantine.go holds a Host pairing: five refused asks
// inside ten minutes hold that account's asks for ten minutes, doubling on
// every repeat, forgiven after a clean day (the same arithmetic,
// quarantineEntry.strike). Asking is how an agent on this computer reaches
// the owner, so an agent that keeps asking for what is refused is the local
// form of a Host probing the management lane.
//
// Keyed by the asking account (the kernel's answer on ask.sock, not anything
// the asker says), and kept in the owner's factor directory beside the
// requests themselves, never on the heartbeat: which accounts on this
// computer asked for what is not a Host's business.
//
// What strikes: the owner denying an ask, and refusals that are the asker's
// own doing (not an agent this bastion sees, an ask the owner refused in the
// last day, too many waiting). What does not: the owner having no code set
// up, a store that could not be written — this machine's state, not the
// asker's.
import (
"encoding/json"
"errors"
"fmt"
"os"
"path/filepath"
"strconv"
"sync"
"time"
)
const askQuarantineFile = "ask_quarantine.json"
var askQuarantineMu sync.Mutex
func askQuarantinePath(dir string) string { return filepath.Join(dir, askQuarantineFile) }
func askQuarantineLoad(dir string) map[string]*quarantineEntry {
m := map[string]*quarantineEntry{}
if raw, err := os.ReadFile(askQuarantinePath(dir)); err == nil {
_ = json.Unmarshal(raw, &m)
}
return m
}
func askQuarantineSave(dir string, m map[string]*quarantineEntry) error {
raw, err := json.MarshalIndent(m, "", " ")
if err != nil {
return err
}
return atomicWrite(askQuarantinePath(dir), raw)
}
// askStrike counts one refused ask from account. The hold that starts on the
// last strike is audited, so the owner sees it in Activity.
func askStrike(dir, account string, now time.Time) {
if dir == "" || account == "" {
return
}
askQuarantineMu.Lock()
defer askQuarantineMu.Unlock()
m := askQuarantineLoad(dir)
e := m[account]
if e == nil {
e = &quarantineEntry{}
m[account] = e
}
held := e.strike(now)
askQuarantinePrune(m, now)
_ = askQuarantineSave(dir, m)
if held {
dcnAudit(dir, askHoldOp, 0, account, "held until "+e.Until+": "+strconv.Itoa(quarantineStrikes)+
" refused asks within "+askWindowWords())
}
}
const askHoldOp = "local_ask_hold"
// askQuarantinePrune drops the accounts there is nothing left to remember
// about: not held, no refusal inside the window, and no hold within the
// forgiving day (strike would reset their doubling anyway). Accounts are the
// kernel's names, and a user with subordinate ids can present thousands of
// them, so without this the file grows by one entry per id that was ever
// refused and is rewritten whole on every strike.
func askQuarantinePrune(m map[string]*quarantineEntry, now time.Time) {
for acct, e := range m {
if e == nil {
delete(m, acct)
continue
}
if quarantinedAt(e, now) {
continue
}
recent := false
for _, ts := range e.Refusals {
if t, err := time.Parse(time.RFC3339, ts); err == nil && now.Sub(t) < quarantineWindow {
recent = true
break
}
}
if recent {
continue
}
if t, err := time.Parse(time.RFC3339, e.LastHold); err == nil && now.Sub(t) <= quarantineForgive {
continue
}
delete(m, acct)
}
}
// askHeldUntil: when account may ask again, or the zero time.
func askHeldUntil(dir, account string, now time.Time) time.Time {
if dir == "" || account == "" {
return time.Time{}
}
askQuarantineMu.Lock()
defer askQuarantineMu.Unlock()
e := askQuarantineLoad(dir)[account]
if !quarantinedAt(e, now) {
return time.Time{}
}
t, _ := time.Parse(time.RFC3339, e.Until)
return t
}
// askHoldRefusal is what a held account is told.
func askHoldRefusal(account string, until time.Time) string {
return fmt.Sprintf("asks from %s are on hold until %s: %d of them were refused within %s. "+
"The machine's owner can lift the hold", account, until.Local().Format("15:04"), quarantineStrikes,
askWindowWords())
}
func askWindowWords() string { return strconv.Itoa(int(quarantineWindow.Minutes())) + " minutes" }
// askQuarantineClear — the owner lifts the hold, and the strikes with it.
func askQuarantineClear(dir, account string) error {
askQuarantineMu.Lock()
defer askQuarantineMu.Unlock()
m := askQuarantineLoad(dir)
if _, ok := m[account]; !ok {
return fmt.Errorf("asks from %s are not held, and none of theirs were refused recently", account)
}
delete(m, account)
if err := askQuarantineSave(dir, m); err != nil {
return err
}
dcnAudit(dir, askHoldOp, 0, account, "lifted by the owner")
return nil
}
// cmdQuarantineClearAsker is `quarantine clear --asker <account>`. The holds
// live in the owner's factor directory, so only the account that holds it —
// the administrator, on a whole-machine install — finds them.
func cmdQuarantineClearAsker(account string) error {
if account == "" {
return errors.New("which account? the hold names it")
}
dir := existingMachineFactorDir()
if dir == "" {
return errors.New("no holds on asks are kept for this account. On a machine the bastion is installed " +
"for as a whole, they are the administrator's: `sudo -H privatae-bastion quarantine clear --asker " +
account + "`")
}
if err := askQuarantineClear(dir, account); err != nil {
return err
}
fmt.Printf("agents running as %s may ask this machine again\n", account)
return nil
}
+272
View File
@@ -0,0 +1,272 @@
package main
// askstatus.go — the asking side follows its ask to the end. An agent that
// ran `stop` used to get a request id and nothing after it: the outcome was
// kept under the approval id, which only the owner's side ever sees, so the
// agent could not tell the person whether the stop happened.
//
// privatae-bastion stop <pid|session> [--wait 5m] [--json]
// privatae-bastion request <id> [--wait 5m] [--json]
//
// Where the bastion runs as another account (installed for the whole
// machine), both go through ask.sock (op "status"), which answers only the
// account that asked: any other account is told what it would be told for an
// id that never existed.
import (
"encoding/json"
"errors"
"flag"
"fmt"
"io"
"os"
"strings"
"time"
)
// What an ask can be, as an agent reads it.
const (
askWaiting = "waiting" // the owner has not answered
askApproved = "approved" // approved; the bastion is carrying it out
askStopped = "stopped" // approved and done
askNotStopped = "not_stopped" // approved, but it could not be done (outcome says why)
askDenied = "denied" // the owner refused it
askRefused = "refused" // nothing was asked (why says why)
askUnknown = "unknown" // no such ask from this account, or it is older than a day
)
var askPollEvery = 2 * time.Second
// askStatus is where the ask with this id prefix stands. anyAccount is for a
// reader that holds the state itself (it could read the files anyway);
// ask.sock always passes false, so an account sees only its own asks.
func askStatus(dir, prefix, user string, anyAccount bool) agentAskReply {
r := agentAskReply{User: user}
prefix = strings.TrimSpace(prefix)
if prefix == "" {
r.Why = "which request? give the id `stop` printed"
return r
}
if dir == "" || (!anyAccount && user == "") {
r.State, r.Why = askUnknown, "no request "+prefix+" was asked from your account"
return r
}
stepupMu.Lock()
m := requestsLoad(dir)
results := localStopResultsLoad(dir)
stepupMu.Unlock()
var hit string
for id, q := range m {
if !strings.HasPrefix(id, prefix) {
continue
}
if kind, _ := q.Details["kind"].(string); kind != localStopKind {
continue
}
if acct, _ := q.Details["asked_by_account"].(string); !anyAccount && acct != user {
continue
}
if hit != "" {
r.Why = "'" + prefix + "' matches more than one request; give more of the id"
return r
}
hit = id
}
if hit == "" {
r.State, r.Why = askUnknown, "no request "+prefix+" was asked from your account in the last day"
return r
}
q := m[hit]
r.OK, r.Request, r.Text = true, hit[:8], describeRequest(q)
r.State, r.Outcome = askState(q, results)
return r
}
func askState(q stepupRequest, results map[string]localStopResult) (state, outcome string) {
switch q.State {
case "pending":
return askWaiting, ""
case "denied":
return askDenied, ""
case "approved":
res, ok := results[q.Approval]
switch {
case !ok:
return askApproved, ""
case strings.HasPrefix(res.Outcome, "not stopped"):
return askNotStopped, res.Outcome
default:
return askStopped, res.Outcome
}
}
return askUnknown, ""
}
// askView is what `stop` and `request` print, and their --json.
type askView struct {
Request string `json:"request,omitempty"`
State string `json:"state"`
Text string `json:"text,omitempty"` // what the owner reads
Outcome string `json:"outcome,omitempty"` // once carried out
AskedAs string `json:"asked_as,omitempty"`
Why string `json:"why,omitempty"` // refused or unknown
}
func (v askView) settled() bool { return v.State != askWaiting && v.State != askApproved }
func askViewOf(r agentAskReply, filing bool) askView {
v := askView{Request: r.Request, State: r.State, Text: r.Text, Outcome: r.Outcome, AskedAs: r.User, Why: r.Why}
switch {
case !r.OK && filing:
v.State = askRefused
case !r.OK && v.State == "":
v.State = askUnknown
case filing:
v.State = askWaiting
}
return v
}
// asksGoThroughSock: the running bastion is not this account's (installed
// for the whole machine), so asking and following an ask go over ask.sock,
// which names the asker from the kernel.
func asksGoThroughSock() bool { return !machineAuthorityHeld() && !uiDaemonListening() }
func askStatusFor(prefix string) (askView, error) {
if asksGoThroughSock() {
r, err := askViaSock(agentAskRequest{Op: "status", Request: prefix})
if err != nil {
return askView{}, fmt.Errorf("could not reach this machine's bastion (%v); `privatae-bastion status` "+
"says whether it is running", err)
}
return askViewOf(r, false), nil
}
t, err := resolveStepupTarget("", true)
if err != nil {
return askView{}, err
}
return askViewOf(askStatus(t.dir, prefix, procUser(os.Getpid()), true), false), nil
}
// askFollow polls until the ask settles or wait runs out.
func askFollow(v askView, wait time.Duration) (askView, error) {
deadline := time.Now().Add(wait)
for !v.settled() && v.Request != "" && time.Now().Before(deadline) {
time.Sleep(askPollEvery)
nv, err := askStatusFor(v.Request)
if err != nil {
return v, err
}
v = nv
}
return v, nil
}
// quietExit ends a command with a status and nothing more printed: the
// command has already said what happened.
type quietExit struct{ code int }
func (q quietExit) Error() string { return fmt.Sprintf("exit status %d", q.code) }
// Exit statuses an agent can branch on: 0 stopped, or asked and not waited
// for; 1 refused, denied, not stopped or unknown; 3 still waiting when --wait
// ran out.
const askExitWaiting = 3
func printAsk(w io.Writer, v askView, asJSON bool, waited bool) error {
if asJSON {
enc := json.NewEncoder(w)
enc.SetIndent("", " ")
_ = enc.Encode(v)
} else {
fmt.Fprintln(w, askSentence(v))
}
switch {
case v.State == askStopped:
return nil
case !v.settled() && !waited:
return nil
case !v.settled():
return quietExit{askExitWaiting}
}
return quietExit{1}
}
func askSentence(v askView) string {
switch v.State {
case askRefused:
return "not asked: " + v.Why
case askUnknown:
return v.Why
case askWaiting:
s := "asked"
if v.AskedAs != "" {
s += ", as " + v.AskedAs
}
return s + ": " + v.Text + "\nIt waits for the machine owner's approval (request " + v.Request +
"), on Waiting for you in the bastion console. Nothing is stopped until they approve it.\n" +
"Follow it with `privatae-bastion request " + v.Request + " --wait 5m`."
case askApproved:
return "request " + v.Request + ": approved by the machine's owner; the bastion is carrying it out."
case askStopped:
return "request " + v.Request + ": approved by the machine's owner and done. " +
strings.Replace(v.Outcome, "You stopped", "The bastion stopped", 1)
case askNotStopped:
return "request " + v.Request + ": approved by the machine's owner, but " + v.Outcome
case askDenied:
return "request " + v.Request + ": the machine's owner denied it. The same stop cannot be asked " +
"again for 24 hours."
}
return "request " + v.Request + ": " + v.State
}
// askFlags parses what `stop` and `request` share. It returns the one
// positional argument.
func askFlags(name string, args []string) (string, time.Duration, bool, error) {
fs := flag.NewFlagSet(name, flag.ContinueOnError)
fs.SetOutput(io.Discard)
wait := fs.Duration("wait", 0, "")
asJSON := fs.Bool("json", false, "")
// The id or pid may come before the flags (`stop 1234 --wait 5m`), as
// agents write it.
var pos []string
rest := args
for {
if err := fs.Parse(rest); err != nil {
return "", 0, false, err
}
if fs.NArg() == 0 {
break
}
pos = append(pos, fs.Arg(0))
rest = fs.Args()[1:]
}
if len(pos) != 1 {
return "", 0, false, errors.New("give exactly one " + map[bool]string{true: "request id",
false: "pid or session name"}[name == "request"])
}
if *wait < 0 {
return "", 0, false, errors.New("--wait cannot be negative")
}
return pos[0], *wait, *asJSON, nil
}
// cmdRequest is `privatae-bastion request <id> [--wait D] [--json]`.
func cmdRequest(args []string) error {
id, wait, asJSON, err := askFlags("request", args)
if err != nil {
return fmt.Errorf("%v\nusage: %s", err, requestUsage)
}
v, err := askStatusFor(id)
if err != nil {
return err
}
if wait > 0 {
if v, err = askFollow(v, wait); err != nil {
return err
}
}
return printAsk(os.Stdout, v, asJSON, wait > 0)
}
const requestUsage = "privatae-bastion request <id> [--wait 5m] [--json]"
+89 -26
View File
@@ -9,6 +9,7 @@ import (
"encoding/json" "encoding/json"
"errors" "errors"
"fmt" "fmt"
"io"
"os" "os"
"path/filepath" "path/filepath"
"sort" "sort"
@@ -22,13 +23,13 @@ const backupUsage = `usage:
make this bastion's backup key here and print what to register on your make this bastion's backup key here and print what to register on your
host (Settings > Backup > keys: kind, label, public key). --replace makes host (Settings > Backup > keys: kind, label, public key). --replace makes
a new one and keeps the old one, which still opens the backups made with it a new one and keeps the old one, which still opens the backups made with it
privatae-bastion backup key show privatae-bastion backup key show [--json]
the key this bastion holds, its fingerprint, and any older keys it keeps the key this bastion holds, its fingerprint, and any older keys it keeps
privatae-bastion backup reseal --sidecar <file> --to <host key> [--stamp <stamp>] privatae-bastion backup reseal --sidecar <file> --to <host key> [--stamp <stamp>]
[--out <file>] [--identity <key file>] [--out <file>] [--identity <key file>]
seal one backup's key to a host's own key (age1... or base64), so that seal one backup's key to a host's own key (age1... or base64), so that
host, and only it, can open that one backup host, and only it, can open that one backup
privatae-bastion backup requests [--host <host>] privatae-bastion backup requests [--host <host>] [--json]
restore requests your host sent this machine restore requests your host sent this machine
privatae-bastion backup approve [--host <host>] <id> | deny [--host <host>] <id> privatae-bastion backup approve [--host <host>] <id> | deny [--host <host>] <id>
answer one answer one
@@ -39,7 +40,7 @@ const backupUsage = `usage:
let the host paired as <host> list and send the backups in another let the host paired as <host> list and send the backups in another
host's backup folder here (or any folder) — how a host that replaces a host's backup folder here (or any folder) — how a host that replaces a
lost one reaches the copies the lost one kept on this machine lost one reaches the copies the lost one kept on this machine
privatae-bastion backup shares --with <host> / unshare --with <host> <name> privatae-bastion backup shares --with <host> [--json] / unshare --with <host> <name>
the folders shared with a host, and taking one back` the folders shared with a host, and taking one back`
func cmdBackup(args []string) error { func cmdBackup(args []string) error {
@@ -65,7 +66,11 @@ func cmdBackup(args []string) error {
return cmdBackupKeyInit(replace, flags["--label"]) return cmdBackupKeyInit(replace, flags["--label"])
} }
if len(args) >= 2 && args[1] == "show" { if len(args) >= 2 && args[1] == "show" {
return cmdBackupKeyShow() asJSON, err := jsonOnly(backupUsage, args[2:])
if err != nil {
return err
}
return cmdBackupKeyShow(asJSON)
} }
case "reseal": case "reseal":
flags, rest := backupFlags(args[1:], "--sidecar", "--to", "--stamp", "--out", "--identity") flags, rest := backupFlags(args[1:], "--sidecar", "--to", "--stamp", "--out", "--identity")
@@ -75,10 +80,11 @@ func cmdBackup(args []string) error {
return cmdBackupReseal(flags["--sidecar"], flags["--to"], flags["--stamp"], flags["--out"], flags["--identity"]) return cmdBackupReseal(flags["--sidecar"], flags["--to"], flags["--stamp"], flags["--out"], flags["--identity"])
case "requests": case "requests":
host, rest := takeHostFlag(args[1:]) host, rest := takeHostFlag(args[1:])
if len(rest) != 0 { asJSON, err := jsonOnly(backupUsage, rest)
return errors.New(backupUsage) if err != nil {
return err
} }
return cmdBackupRequests(host) return cmdBackupRequests(host, asJSON)
case "approve", "deny": case "approve", "deny":
host, rest := takeHostFlag(args[1:]) host, rest := takeHostFlag(args[1:])
if len(rest) != 1 { if len(rest) != 1 {
@@ -93,10 +99,11 @@ func cmdBackup(args []string) error {
return cmdBackupShare(flags["--with"], flags["--from"], flags["--dir"]) return cmdBackupShare(flags["--with"], flags["--from"], flags["--dir"])
case "shares": case "shares":
flags, rest := backupFlags(args[1:], "--with") flags, rest := backupFlags(args[1:], "--with")
if len(rest) != 0 || flags["--with"] == "" { asJSON, err := jsonOnly(backupUsage, rest)
if err != nil || flags["--with"] == "" {
return errors.New(backupUsage) return errors.New(backupUsage)
} }
return cmdBackupShares(flags["--with"]) return cmdBackupShares(flags["--with"], asJSON)
case "unshare": case "unshare":
flags, rest := backupFlags(args[1:], "--with") flags, rest := backupFlags(args[1:], "--with")
if len(rest) != 1 || flags["--with"] == "" { if len(rest) != 1 || flags["--with"] == "" {
@@ -163,24 +170,53 @@ func cmdBackupKeyInit(replace bool, label string) error {
return nil return nil
} }
func cmdBackupKeyShow() error { // backupKeysRead is every backup key this bastion holds, the current one
// marked. The secret half never leaves its file (backupKeyFile.Identity).
type backupKeysRead struct {
Keys []*backupKeyFile `json:"keys"`
Current string `json:"current,omitempty"` // its fingerprint
}
func readBackupKeys(readOpts) (backupKeysRead, error) {
active, all, err := backupKeysLoad() active, all, err := backupKeysLoad()
if err != nil { if err != nil {
return err return backupKeysRead{}, err
} }
if len(all) == 0 { v := backupKeysRead{Keys: all}
fmt.Println("no backup key on this machine — make one with `privatae-bastion backup key init`") if v.Keys == nil {
v.Keys = []*backupKeyFile{}
}
if active != nil {
v.Current = active.Fingerprint
}
return v, nil
}
func cmdBackupKeyShow(asJSON bool) error {
v, err := readMachine("backup-keys", readOpts{}, readBackupKeys)
if err != nil {
return laneRefusalError("backup key show", err)
}
if asJSON {
return printJSON(os.Stdout, v)
}
printBackupKeys(os.Stdout, v)
return nil return nil
} }
for _, k := range all {
func printBackupKeys(w io.Writer, v backupKeysRead) {
if len(v.Keys) == 0 {
fmt.Fprintln(w, "no backup key on this machine — make one with `privatae-bastion backup key init`")
return
}
for _, k := range v.Keys {
state := "older key (still opens the backups made with it)" state := "older key (still opens the backups made with it)"
if active != nil && k.Fingerprint == active.Fingerprint { if k.Fingerprint == v.Current {
state = "current key" state = "current key"
} }
fmt.Printf("%s %s\n public key: %s\n age recipient: %s\n made: %s\n key file: %s\n\n", fmt.Fprintf(w, "%s %s\n public key: %s\n age recipient: %s\n made: %s\n key file: %s\n\n",
k.Fingerprint, state, k.PubB64, k.Recipient, k.CreatedAt, k.Path) k.Fingerprint, state, k.PubB64, k.Recipient, k.CreatedAt, k.Path)
} }
return nil
} }
func backupIDs(identityFile string) ([]age.Identity, error) { func backupIDs(identityFile string) ([]age.Identity, error) {
@@ -339,6 +375,9 @@ func pairingByName(name string) (*Config, error) {
if err != nil { if err != nil {
return nil, err return nil, err
} }
if cfg == nil && len(cfgs) == 0 {
return nil, fmt.Errorf("no host is paired with this bastion, so none is named '%s'", name)
}
if cfg == nil { if cfg == nil {
return nil, fmt.Errorf("no pairing matches '%s' — paired hosts:\n %s", name, strings.Join(hostNames(cfgs), "\n ")) return nil, fmt.Errorf("no pairing matches '%s' — paired hosts:\n %s", name, strings.Join(hostNames(cfgs), "\n "))
} }
@@ -379,20 +418,44 @@ func cmdBackupShare(with, from, dir string) error {
return nil return nil
} }
func cmdBackupShares(with string) error { // backupSharesRead is the folders shared with one pairing.
reader, err := pairingByName(with) type backupSharesRead struct {
With string `json:"with"`
Shares []backupShare `json:"shares"`
}
func readBackupShares(o readOpts) (backupSharesRead, error) {
reader, err := pairingByName(o.Host)
if err != nil { if err != nil {
return err return backupSharesRead{}, err
} }
list := sharesFor(reader.HostName) v := backupSharesRead{With: reader.HostName, Shares: sharesFor(reader.HostName)}
if len(list) == 0 { if v.Shares == nil {
fmt.Println("no folders are shared with", reader.HostName) v.Shares = []backupShare{}
}
return v, nil
}
func cmdBackupShares(with string, asJSON bool) error {
v, err := readMachine("backup-shares", readOpts{Host: with}, readBackupShares)
if err != nil {
return laneRefusalError("backup shares --with "+with, err)
}
if asJSON {
return printJSON(os.Stdout, v)
}
printBackupShares(os.Stdout, v)
return nil return nil
} }
for _, s := range list {
fmt.Printf("shared/%s %s (shared %s)\n", s.Slug, s.Dir, s.Added) func printBackupShares(w io.Writer, v backupSharesRead) {
if len(v.Shares) == 0 {
fmt.Fprintln(w, "no folders are shared with", v.With)
return
}
for _, s := range v.Shares {
fmt.Fprintf(w, "shared/%s %s (shared %s)\n", s.Slug, s.Dir, s.Added)
} }
return nil
} }
func cmdBackupUnshare(with, slug string) error { func cmdBackupUnshare(with, slug string) error {
+68 -17
View File
@@ -45,6 +45,7 @@ import (
"encoding/json" "encoding/json"
"errors" "errors"
"fmt" "fmt"
"io"
"net/netip" "net/netip"
"os" "os"
"path/filepath" "path/filepath"
@@ -579,28 +580,46 @@ func describeReseal(r *resealRequest) string {
// ── the person's side, on this machine ────────────────────────────────────── // ── the person's side, on this machine ──────────────────────────────────────
func cmdBackupRequests(host string) error { // backupRequestView is one restore request as a read shows it: the armored
cfg, err := stepupPairing(host) // key the host sent, and the one resealed for it, are left out (the digest of
// the one the host sent stays); both are sealed, and a read has no use for
// them.
type backupRequestView struct {
ID string `json:"id"`
State string `json:"state"`
Stamp string `json:"stamp"`
Pairing string `json:"pairing"`
HostNumber int64 `json:"host_number"`
HostLabel string `json:"host_label"`
To string `json:"to"`
ToFP string `json:"to_fp"`
SidecarSHA string `json:"sidecar_sha256"`
At string `json:"at"`
DecidedAt string `json:"decided_at,omitempty"`
Error string `json:"error,omitempty"`
Words string `json:"words"`
}
type backupRequestsRead struct {
Host string `json:"host"`
Requests []backupRequestView `json:"requests"`
// SetAside are request files found unreadable and kept, not read.
SetAside []string `json:"set_aside,omitempty"`
}
func readBackupRequests(o readOpts) (backupRequestsRead, error) {
cfg, err := stepupPairing(o.Host)
if err != nil { if err != nil {
return err return backupRequestsRead{}, err
} }
dir := cfg.dcnDir() dir := cfg.dcnDir()
v := backupRequestsRead{Host: cfg.HostName, Requests: []backupRequestView{}}
// Request files set aside as unreadable (resealLoad) are named here, so // Request files set aside as unreadable (resealLoad) are named here, so
// the person learns of them whichever process found them. // the person learns of them whichever process found them.
if aside, _ := filepath.Glob(resealPath(dir) + resealAsideSuffix + "*"); len(aside) > 0 { v.SetAside, _ = filepath.Glob(resealPath(dir) + resealAsideSuffix + "*")
fmt.Println("set aside as unreadable (kept, not read):")
for _, a := range aside {
fmt.Println(" " + a)
}
fmt.Println()
}
m, err := resealRead(dir) m, err := resealRead(dir)
if err != nil { if err != nil {
return err return v, err
}
if len(m) == 0 {
fmt.Println("no backup requests from", cfg.HostName)
return nil
} }
ids := make([]string, 0, len(m)) ids := make([]string, 0, len(m))
for id := range m { for id := range m {
@@ -608,12 +627,44 @@ func cmdBackupRequests(host string) error {
} }
sort.Slice(ids, func(i, j int) bool { return m[ids[i]].At < m[ids[j]].At }) sort.Slice(ids, func(i, j int) bool { return m[ids[i]].At < m[ids[j]].At })
for _, id := range ids { for _, id := range ids {
fmt.Println(describeReseal(m[id])) r := m[id]
fmt.Println() v.Requests = append(v.Requests, backupRequestView{ID: r.ID, State: r.State, Stamp: r.Stamp,
Pairing: r.Pairing, HostNumber: r.HostNumber, HostLabel: r.HostLabel, To: r.To, ToFP: r.ToFP,
SidecarSHA: r.SidecarSH, At: r.At, DecidedAt: r.DecidedAt, Error: r.Error, Words: describeReseal(r)})
} }
return v, nil
}
func cmdBackupRequests(host string, asJSON bool) error {
v, err := readMachine("backup-requests", readOpts{Host: host}, readBackupRequests)
if err != nil {
return laneRefusalError("backup requests", err)
}
if asJSON {
return printJSON(os.Stdout, v)
}
printBackupRequests(os.Stdout, v)
return nil return nil
} }
func printBackupRequests(w io.Writer, v backupRequestsRead) {
if len(v.SetAside) > 0 {
fmt.Fprintln(w, "set aside as unreadable (kept, not read):")
for _, a := range v.SetAside {
fmt.Fprintln(w, " "+a)
}
fmt.Fprintln(w)
}
if len(v.Requests) == 0 {
fmt.Fprintln(w, "no backup requests from", v.Host)
return
}
for _, r := range v.Requests {
fmt.Fprintln(w, r.Words)
fmt.Fprintln(w)
}
}
func cmdBackupDecide(host, prefix string, approve bool) error { func cmdBackupDecide(host, prefix string, approve bool) error {
cfg, err := stepupPairing(host) cfg, err := stepupPairing(host)
if err != nil { if err != nil {
+21 -20
View File
@@ -768,42 +768,43 @@ func cmdObserveBaseline(force bool) error {
return nil return nil
} }
// cmdObserveBaselineShow prints what this machine currently calls normal. // cmdObserveBaselineShow prints what this machine currently calls normal
func cmdObserveBaselineShow() error { // (`baseline show`, machine_cli.go).
f, ok, err := baselineLoad() func cmdObserveBaselineShow() error { return cmdBaseline([]string{"show"}) }
if errors.Is(err, os.ErrNotExist) {
return errors.New("this machine has no baseline yet — `privatae-bastion observe:baseline` " + // printBaseline is `baseline show` in words.
func printBaseline(w io.Writer, b baselineRead) error {
if !b.Has {
return errors.New("this machine has no baseline yet — `privatae-bastion baseline record` " +
"takes one (as an administrator)") "takes one (as an administrator)")
} }
if err != nil { f := b.Baseline
return err fmt.Fprintf(w, "baseline taken %s by bastion %s, mode %s\n", f.TakenAt, f.BastionVersion, f.Mode)
} if b.Integrity != "" {
fmt.Printf("baseline taken %s by bastion %s, mode %s\n", f.TakenAt, f.BastionVersion, f.Mode) fmt.Fprintf(w, "WARNING: %s\n", b.Integrity)
if note := baselineIntegrityNote(f, ok); note != "" {
fmt.Printf("WARNING: %s\n", note)
} }
// Provenance, judged the way the host judges it. Three lines a reader can // Provenance, judged the way the host judges it. Three lines a reader can
// get: verified (and by whom), signed-but-failing (and which test failed), // get: verified (and by whom), signed-but-failing (and which test failed),
// or unsigned (and the reason the file itself records). // or unsigned (and the reason the file itself records).
switch { switch {
case f.Attestation != nil: case f.Attestation != nil:
if n := baselineAttestationNote(f); n != "" { if b.Attestation != "" {
fmt.Printf("WARNING: attestation: %s\n", n) fmt.Fprintf(w, "WARNING: attestation: %s\n", b.Attestation)
} else { } else {
fmt.Printf("signed by %s's pairing key; verified against its CA and this machine's fingerprint\n", fmt.Fprintf(w, "signed by %s's pairing key; verified against its CA and this machine's fingerprint\n",
f.Attestation.SignedBy) f.Attestation.SignedBy)
} }
case f.UnsignedReason != "": case f.UnsignedReason != "":
fmt.Printf("unsigned: %s\n", f.UnsignedReason) fmt.Fprintf(w, "unsigned: %s\n", f.UnsignedReason)
default: default:
fmt.Printf("unsigned: taken by a bastion that did not sign accountings\n") fmt.Fprintf(w, "unsigned: taken by a bastion that did not sign accountings\n")
} }
fmt.Printf("%d entries", len(f.Entries)) fmt.Fprintf(w, "%d entries", len(f.Entries))
if f.Unreadable > 0 { if f.Unreadable > 0 {
fmt.Printf(", %d without a readable executable (a baseline taken without "+ fmt.Fprintf(w, ", %d without a readable executable (a baseline taken without "+
"administrator rights sees less)", f.Unreadable) "administrator rights sees less)", f.Unreadable)
} }
fmt.Println() fmt.Fprintln(w)
for _, e := range f.Entries { for _, e := range f.Entries {
who := e.Signature who := e.Signature
if who == "" { if who == "" {
@@ -821,7 +822,7 @@ func cmdObserveBaselineShow() error {
// against. Found by a test written for something else entirely. // against. Found by a test written for something else entirely.
d = shortDigest(d) d = shortDigest(d)
} }
fmt.Printf(" %s %-20s %-10s %s\n", e.FP, who, e.User, d) fmt.Fprintf(w, " %s %-20s %-10s %s\n", e.FP, who, e.User, d)
} }
return nil return nil
} }
+16 -2
View File
@@ -553,6 +553,14 @@ func TestNoRouteOpOrDependencySpeaksMCP(t *testing.T) {
"/fragments/context": "uicontext.go", "/context/scan": "uicontext.go", "/fragments/context": "uicontext.go", "/context/scan": "uicontext.go",
"/context/stop": "uicontext.go", "/context/ask": "uicontext.go", "/context/stop": "uicontext.go", "/context/ask": "uicontext.go",
"/policy": "uipolicy.go", "/fragments/policy": "uipolicy.go", "/policy": "uipolicy.go", "/fragments/policy": "uipolicy.go",
"/fragments/home": "uihome.go", "/agent": "uihome.go", "/machine": "uihome.go",
"/agent/stop": "uihome.go", "/agent/mark": "uihome.go", "/activity": "uihome.go",
"/fragments/machine/schedules": "uimachine.go", "/fragments/machine/tools": "uimachine.go",
"/fragments/machine/baseline": "uimachine.go", "/machine/compare": "uimachine.go",
"/machine/baseline": "uimachine.go",
"/machine/report": "uimachine.go",
"/setup/host/disconnect": "uisetup.go", "/setup/host/release": "uisetup.go",
"/approvals/machine/approve": "uihome.go", "/approvals/machine/deny": "uihome.go",
"/approvals": "uidevice.go|uitray.go", "/fragments/approvals": "uidevice.go|uitray.go", "/approvals": "uidevice.go|uitray.go", "/fragments/approvals": "uidevice.go|uitray.go",
"/fragments/approvals-news": "uidevice.go|uitray.go", "/device/approve": "uidevice.go", "/fragments/approvals-news": "uidevice.go|uitray.go", "/device/approve": "uidevice.go",
"/device/deny": "uidevice.go", "/device/approve-shown": "uidevice.go", "/device/deny": "uidevice.go", "/device/approve-shown": "uidevice.go",
@@ -1179,8 +1187,8 @@ func TestObserveOpsWriteNothing(t *testing.T) {
roots = append(roots, fn) roots = append(roots, fn)
} }
} }
if len(roots) != 14 { if len(roots) != 18 {
t.Fatalf("expected the 11 observe and 3 computer handlers, found %d", len(roots)) t.Fatalf("expected the 15 observe and 3 computer handlers, found %d", len(roots))
} }
stop := map[string]bool{"sendMgmt": true, "sendMgmtExit": true, "refuseMgmt": true, stop := map[string]bool{"sendMgmt": true, "sendMgmtExit": true, "refuseMgmt": true,
"storeRecordObserve": true} "storeRecordObserve": true}
@@ -1256,6 +1264,10 @@ func TestObserveOpsWriteNothing(t *testing.T) {
"dmesg -T", "dmesg -T",
"iptables -S", "iptables -S",
"journalctl -n1 -o short-unix --no-pager", "journalctl -n1 -o short-unix --no-pager",
// observe:logins: sshd's lines over a window of whole hours.
"journalctl <sinceArg> -o short-iso --no-pager -q --lines=50000 _COMM=sshd _COMM=sshd-session _COMM=sshd-auth _UID=0 + _SYSTEMD_UNIT=ssh.service _SYSTEMD_UNIT=sshd.service _UID=0",
// observe:journal: one unit this machine's own lists name, over minutes.
"journalctl <unitArg> <sinceArg> -o short-iso --no-pager -q --lines=5000",
"kubectl --kubeconfig <observeKubeconfig> get nodes -o json", "kubectl --kubeconfig <observeKubeconfig> get nodes -o json",
"kubectl --kubeconfig <observeKubeconfig> get pods -A -o json", "kubectl --kubeconfig <observeKubeconfig> get pods -A -o json",
"nft list chain inet pubwall input", "nft list chain inet pubwall input",
@@ -1270,6 +1282,8 @@ func TestObserveOpsWriteNothing(t *testing.T) {
"system_profiler SPApplicationsDataType -json", "system_profiler SPApplicationsDataType -json",
"systemctl is-active fail2ban", "systemctl is-active fail2ban",
"systemctl list-timers --all --no-legend --plain", "systemctl list-timers --all --no-legend --plain",
"systemctl list-unit-files --no-legend --plain", // observe:journal's unit check
"systemctl list-units --all --no-legend --plain",
"systemctl list-units --failed --no-legend --plain", "systemctl list-units --failed --no-legend --plain",
"ufw status", "ufw status",
"ufw status verbose", "ufw status verbose",
+62 -31
View File
@@ -23,6 +23,7 @@ package main
import ( import (
"bufio" "bufio"
"context" "context"
"io"
"net" "net"
"os" "os"
"path/filepath" "path/filepath"
@@ -150,17 +151,32 @@ func coderVettedAddrs(ctx context.Context, hostport string, allowLAN []string) (
} }
func coderRefuse(c net.Conn, why string) { func coderRefuse(c net.Conn, why string) {
_, _ = c.Write([]byte("HTTP/1.1 403 Forbidden\r\nContent-Length: 0\r\nConnection: close\r\nX-Privatae-Refused: " + writeEgressRefusal(c, "403 Forbidden", why, why)
strings.NewReplacer("\r", " ", "\n", " ").Replace(why) + "\r\n\r\n"))
} }
// handleCoderEgressConn serves one connection from a run: HTTP CONNECT or an // handleCoderEgressConn serves one connection from a run: HTTP CONNECT or an
// absolute-form plain HTTP request, the same parsing as handleEgressConn. // absolute-form plain HTTP request, the same parsing as handleEgressConn.
// Destinations are never logged; refusals are counted on the run. // Destinations are never logged; refusals are counted on the run.
// coderEgressMaxHeadBytes bounds a request's line and headers together.
const coderEgressMaxHeadBytes = 64 << 10
// coderEgressMaxConns bounds the connections one run's proxy carries at once.
// A whole Chromium profile opens at most 256 sockets at a time (its socket
// pool limit), and package managers far fewer, so four times the browser's
// figure never refuses real work; past it a connection is answered 503 and
// closed, and each one held costs this machine at most its head and two copy
// buffers.
const coderEgressMaxConns = 1024
func handleCoderEgressConn(client net.Conn, allowLAN []string, refused *int64) { func handleCoderEgressConn(client net.Conn, allowLAN []string, refused *int64) {
defer client.Close() defer client.Close()
_ = client.SetReadDeadline(time.Now().Add(30 * time.Second)) _ = client.SetReadDeadline(time.Now().Add(30 * time.Second))
br := bufio.NewReader(client) // The request line and headers are read under one bound, the head limit
// below has always named: the run's own processes send them, and a line
// that never ends must not grow in this machine's memory before that
// limit is looked at.
headLim := &io.LimitedReader{R: client, N: coderEgressMaxHeadBytes}
br := bufio.NewReader(headLim)
line, err := br.ReadString('\n') line, err := br.ReadString('\n')
if err != nil { if err != nil {
return return
@@ -172,7 +188,6 @@ func handleCoderEgressConn(client net.Conn, allowLAN []string, refused *int64) {
method, target := parts[0], parts[1] method, target := parts[0], parts[1]
var head strings.Builder var head strings.Builder
head.WriteString(line) head.WriteString(line)
hostHdr := ""
for { for {
h, err := br.ReadString('\n') h, err := br.ReadString('\n')
if err != nil { if err != nil {
@@ -182,38 +197,41 @@ func handleCoderEgressConn(client net.Conn, allowLAN []string, refused *int64) {
if h == "\r\n" || h == "\n" { if h == "\r\n" || h == "\n" {
break break
} }
if head.Len() > 64<<10 { if head.Len() > coderEgressMaxHeadBytes {
return return
} }
if len(h) >= 5 && strings.EqualFold(h[:5], "host:") {
hostHdr = strings.TrimSpace(h[5:])
}
} }
_ = client.SetReadDeadline(time.Time{}) _ = client.SetReadDeadline(time.Time{})
// The head is in; what follows is the stream itself. What the reader
// already buffered past the head stays first in line.
headLim.N = 1<<63 - 1
ctx, cancel := context.WithTimeout(context.Background(), egressDialTimeout) ctx, cancel := context.WithTimeout(context.Background(), egressDialTimeout)
defer cancel() defer cancel()
// Read the way the bastion's own egress lane reads it (egress_http.go): a
// CONNECT target through parseEgressAuthority, and plain HTTP as ONE
// request, rebuilt and sent with `Connection: close`, so the run's later
// requests on a keep-alive connection never reach the destination unvetted.
connect := strings.EqualFold(method, "CONNECT") connect := strings.EqualFold(method, "CONNECT")
hp := "" hp := ""
var req egressRequest
if connect { if connect {
hp = ensurePort(target, "443") host, port, ok := parseEgressAuthority(target, 443)
} else { if !ok {
host := hostHdr atomic.AddInt64(refused, 1)
if i := strings.Index(target, "://"); i >= 0 { writeEgressRefusal(client, "400 Bad Request", egressNoHost, egressNoHost)
rest := target[i+3:]
if s := strings.IndexAny(rest, "/?#"); s >= 0 {
host = rest[:s]
} else {
host = rest
}
if at := strings.LastIndexByte(host, '@'); at >= 0 {
host = host[at+1:]
}
}
if host == "" {
return return
} }
hp = ensurePort(host, "80") hp = egressHostPort(host, port)
} else {
r, bad := parseEgressRequest(head.String())
if bad != nil {
atomic.AddInt64(refused, 1)
writeEgressRefusal(client, bad.status, bad.body, bad.body)
return
}
req = r
hp = egressHostPort(req.host, req.port)
} }
dialAddrs, why := coderVettedAddrs(ctx, hp, allowLAN) dialAddrs, why := coderVettedAddrs(ctx, hp, allowLAN)
if why != "" { if why != "" {
@@ -223,18 +241,17 @@ func handleCoderEgressConn(client net.Conn, allowLAN []string, refused *int64) {
} }
upstream, err := dialEach(ctx, coderDialOut, dialAddrs) upstream, err := dialEach(ctx, coderDialOut, dialAddrs)
if err != nil { if err != nil {
_, _ = client.Write([]byte("HTTP/1.1 502 Bad Gateway\r\nContent-Length: 0\r\nConnection: close\r\n\r\n")) writeEgressRefusal(client, "502 Bad Gateway", egressUnreachable, "")
return
}
if !connect {
oneEgressExchange(br, client, upstream, req)
return return
} }
if connect {
if _, err := client.Write([]byte("HTTP/1.1 200 Connection established\r\n\r\n")); err != nil { if _, err := client.Write([]byte("HTTP/1.1 200 Connection established\r\n\r\n")); err != nil {
_ = upstream.Close() _ = upstream.Close()
return return
} }
} else if _, err := upstream.Write([]byte(head.String())); err != nil {
_ = upstream.Close()
return
}
splice(br, client, upstream) splice(br, client, upstream)
} }
@@ -277,6 +294,7 @@ func coderListenEgress(runID, dir string, uid int) error {
} }
run := &coderEgressRun{ln: ln} run := &coderEgressRun{ln: ln}
coderEgress[runID] = run coderEgress[runID] = run
slots := make(chan struct{}, coderEgressMaxConns)
go func() { go func() {
for { for {
c, err := ln.Accept() c, err := ln.Accept()
@@ -285,7 +303,20 @@ func coderListenEgress(runID, dir string, uid int) error {
} }
// allow_lan is read per connection: the owner's edit applies to // allow_lan is read per connection: the owner's edit applies to
// running runs at once. // running runs at once.
go handleCoderEgressConn(c, loadCoderConfig().AllowLAN, &run.refused) select {
case slots <- struct{}{}:
go func() {
defer func() { <-slots }()
handleCoderEgressConn(c, loadCoderConfig().AllowLAN, &run.refused)
}()
default:
go func() {
defer c.Close()
_ = c.SetWriteDeadline(time.Now().Add(time.Second))
why := "this run already has " + strconv.Itoa(coderEgressMaxConns) + " connections open"
writeEgressRefusal(c, "503 Service Unavailable", why, why)
}()
}
} }
}() }()
return nil return nil
+7
View File
@@ -1229,10 +1229,17 @@ func coderContainerGone(rt, cname string) bool {
// anchor pairing on an anchored box (serviceOwnerRefusal's rule). // anchor pairing on an anchored box (serviceOwnerRefusal's rule).
// An unknown owner proves nothing about self, so it gets the anchor-only rule // An unknown owner proves nothing about self, so it gets the anchor-only rule
// too: every run this bastion starts records and labels its owner. // too: every run this bastion starts records and labels its owner.
//
// A local machine has no anchor, so anchorOnly lets every pairing through
// there; once it serves several Hosts (localServesSeveralHosts), each stops
// only the runs it started, as with the servers each built.
func coderOwnerRefusal(self, owner string) string { func coderOwnerRefusal(self, owner string) string {
if owner != "" && owner == self { if owner != "" && owner == self {
return "" return ""
} }
if localServesSeveralHosts() {
return "refused: that run was started by " + orUnknown(owner) + "; on a local machine that serves several Hosts each stops only the runs it started"
}
if why := anchorOnly(self, "stopping a run another host started"); why != "" { if why := anchorOnly(self, "stopping a run another host started"); why != "" {
return "refused: that run was started by " + orUnknown(owner) + "; " + why return "refused: that run was started by " + orUnknown(owner) + "; " + why
} }
+8 -2
View File
@@ -474,8 +474,14 @@ func TestCoderEgressProxyOverTheSocket(t *testing.T) {
} { } {
head, c := ask(req) head, c := ask(req)
c.Close() c.Close()
if !strings.HasPrefix(head, "HTTP/1.1 403") || !strings.Contains(head, "X-Privatae-Refused:") { want := "HTTP/1.1 403"
t.Fatalf("must be refused with 403 + X-Privatae-Refused: %q -> %q", req, head) if strings.Contains(req, "user@") {
// Userinfo is refused outright, before any lookup, as the Host's
// egress gate refuses it (parseEgressAuthority); still counted.
want = "HTTP/1.1 400"
}
if !strings.HasPrefix(head, want) || !strings.Contains(head, "X-Privatae-Refused:") {
t.Fatalf("must be refused with %s + X-Privatae-Refused: %q -> %q", want, req, head)
} }
} }
head, c := ask("CONNECT public.example:443 HTTP/1.1\r\n\r\n") head, c := ask("CONNECT public.example:443 HTTP/1.1\r\n\r\n")
+3 -3
View File
@@ -615,7 +615,7 @@ func removeStalePairingFile(hostName string) error {
func checkPairConflict(cfgs []*Config, handle string, replace bool) (*Config, error) { func checkPairConflict(cfgs []*Config, handle string, replace bool) (*Config, error) {
existing := pairingFor(cfgs, handle) existing := pairingFor(cfgs, handle)
if existing != nil && !replace { if existing != nil && !replace {
return nil, fmt.Errorf("already paired with %s — this daemon serves multiple hosts, so pairing never overwrites; to rotate that host's credentials run `privatae-bastion pair --replace <token>`", existing.HostName) return nil, &alreadyPairedError{host: existing.HostName, msg: fmt.Sprintf("already paired with %s — this daemon serves multiple hosts, so pairing never overwrites; to rotate that host's credentials run `privatae-bastion pair --replace <token>`", existing.HostName)}
} }
if existing == nil && replace { if existing == nil && replace {
return nil, fmt.Errorf("pair --replace: no existing pairing matches '%s' — pair it normally first", handle) return nil, fmt.Errorf("pair --replace: no existing pairing matches '%s' — pair it normally first", handle)
@@ -624,8 +624,8 @@ func checkPairConflict(cfgs []*Config, handle string, replace bool) (*Config, er
} }
// nextGitProxyAddr picks the first loopback port from 7978 up that no existing // nextGitProxyAddr picks the first loopback port from 7978 up that no existing
// pairing claims: the per-host git proxy (git.privatae.ai is reachable only through // pairing claims: the per-host git proxy, through which local git reaches
// the bastion → host → platform path). Allocated lazily for pairings that predate it. // git.privatae.ai via that host (gitlane.go). Allocated lazily for pairings that predate it.
func nextGitProxyAddr(cfgs []*Config) string { func nextGitProxyAddr(cfgs []*Config) string {
used := map[string]bool{} used := map[string]bool{}
for _, c := range cfgs { for _, c := range cfgs {
+164 -44
View File
@@ -8,22 +8,32 @@ package main
import ( import (
"errors" "errors"
"fmt" "fmt"
"io"
"os" "os"
"sort"
"strconv" "strconv"
"strings" "strings"
"time" "time"
) )
// cmdStepupDrop revokes one unused approval this box issued for a pairing. // cmdStepupDrop revokes one unused approval this box issued for a pairing.
func cmdStepupDrop(host, prefix string) error { // From the owner's account beside the machine's bastion it asks that
cfg, err := stepupPairing(host) // bastion (owneracts.go): dropping only takes reach away, so no code.
if err != nil { func cmdStepupDrop(host string, machine bool, prefix string) error {
return err return printOrAct(agentAskRequest{Act: "approvals-drop", Host: host, Machine: machine, ID: prefix},
stepupCommand("approvals drop", host, machine, prefix),
func() (string, error) { return stepupDropText(host, machine, prefix) })
} }
dir := cfg.dcnDir()
func stepupDropText(host string, machine bool, prefix string) (string, error) {
t, err := resolveStepupTarget(host, machine)
if err != nil {
return "", err
}
dir := t.dir
prefix = strings.TrimSpace(prefix) prefix = strings.TrimSpace(prefix)
if prefix == "" { if prefix == "" {
return errors.New("which approval? (the id `approve` printed)") return "", errors.New("which approval? (the id `approve` printed)")
} }
stepupMu.Lock() stepupMu.Lock()
defer stepupMu.Unlock() defer stepupMu.Unlock()
@@ -36,42 +46,45 @@ func cmdStepupDrop(host, prefix string) error {
} }
switch len(hits) { switch len(hits) {
case 0: case 0:
return fmt.Errorf("no unused approval starts with %q for %s", prefix, cfg.HostName) return "", fmt.Errorf("no unused approval starts with %q %s", prefix, t.forWhom())
case 1: case 1:
default: default:
return fmt.Errorf("%d approvals start with %q — give more of the id", len(hits), prefix) return "", fmt.Errorf("%d approvals start with %q — give more of the id", len(hits), prefix)
} }
a := m[hits[0]] a := m[hits[0]]
a.Used = true // burned without ever having run: the same end state a use reaches a.Used = true // burned without ever having run: the same end state a use reaches
m[hits[0]] = a m[hits[0]] = a
if err := approvalsSave(dir, m); err != nil { if err := approvalsSave(dir, m); err != nil {
return err return "", err
} }
fmt.Printf("dropped approval %s (%s) — nothing can run on it now\n", hits[0][:8], a.Purpose) return fmt.Sprintf("dropped approval %s (%s) — nothing can run on it now", hits[0][:8], a.Purpose), nil
return nil
} }
// cmdGrantsDrop removes a held store grant from this box. // cmdGrantsDrop removes a held store grant from this box (through the
// owner's lane beside the machine's bastion, as cmdStepupDrop).
func cmdGrantsDrop(host, store string) error { func cmdGrantsDrop(host, store string) error {
return printOrAct(agentAskRequest{Act: "grants-drop", Host: host, ID: store},
"grants drop "+store+hostFlagWords(host), func() (string, error) { return grantsDropText(host, store) })
}
func grantsDropText(host, store string) (string, error) {
cfg, err := stepupPairing(host) cfg, err := stepupPairing(host)
if err != nil { if err != nil {
return err return "", err
} }
id, err := strconv.ParseInt(strings.TrimSpace(store), 10, 64) id, err := strconv.ParseInt(strings.TrimSpace(store), 10, 64)
if err != nil { if err != nil {
return errors.New("store id must be a number (the id on the host's store card)") return "", errors.New("store id must be a number (the id on the host's store card)")
} }
dir := cfg.dcnDir() dir := cfg.dcnDir()
present, err := dcnDropStore(dir, id, "dropped at this machine's console") present, err := dcnDropStore(dir, id, "dropped at this machine's console")
if err != nil { if err != nil {
return err return "", err
} }
if !present { if !present {
fmt.Printf("store %d was not held here for %s\n", id, cfg.HostName) return fmt.Sprintf("store %d was not held here for %s", id, cfg.HostName), nil
return nil
} }
fmt.Printf("store %d dropped for %s — the host's reads of it stop now and it learns on the next check-in\n", id, cfg.HostName) return fmt.Sprintf("store %d dropped for %s — the host's reads of it stop now and it learns on the next check-in", id, cfg.HostName), nil
return nil
} }
// cmdQuarantineClear lifts this box's hold on a pairing's write lanes. // cmdQuarantineClear lifts this box's hold on a pairing's write lanes.
@@ -90,58 +103,141 @@ func cmdQuarantineClear(host string) error {
} }
// cmdOpsList prints the ops and op grants a pairing holds here (ops.go). // cmdOpsList prints the ops and op grants a pairing holds here (ops.go).
func cmdOpsList(host string) error { // opRow is one op a Host holds here, verified against its signature or not.
cfg, err := stepupPairing(host) type opRow struct {
ID string `json:"id"`
Name string `json:"name,omitempty"`
Version string `json:"version,omitempty"`
Privilege string `json:"privilege,omitempty"`
Summary string `json:"summary,omitempty"`
NotVerified string `json:"not_verified,omitempty"`
}
// opGrantRow is one op grant this machine holds and has not dropped.
type opGrantRow struct {
ID string `json:"id"`
Op string `json:"op,omitempty"`
Version string `json:"version,omitempty"`
RunsLeft int `json:"runs_left"`
Until string `json:"until,omitempty"`
Within string `json:"within,omitempty"`
NotVerified string `json:"not_verified,omitempty"`
}
// opsRead is what ops and op grants one pairing holds on this machine.
type opsRead struct {
Host string `json:"host"`
Sandbox bool `json:"sandbox"`
SandboxUnavailable string `json:"sandbox_unavailable,omitempty"`
Ops []opRow `json:"ops"`
Grants []opGrantRow `json:"grants"`
}
func readOps(o readOpts) (opsRead, error) {
cfg, err := stepupPairing(o.Host)
if err != nil { if err != nil {
return err return opsRead{}, err
} }
dir := cfg.dcnDir() dir := cfg.dcnDir()
ok, why := opSandboxAvailable() v := opsRead{Host: cfg.HostName, Ops: []opRow{}, Grants: []opGrantRow{}}
if ok { v.Sandbox, v.SandboxUnavailable = opSandboxAvailable()
fmt.Println("sandbox: available")
} else {
fmt.Println("sandbox: NOT available —", why)
}
n := 0
if entries, err := os.ReadDir(opsDir(dir)); err == nil { if entries, err := os.ReadDir(opsDir(dir)); err == nil {
for _, e := range entries { for _, e := range entries {
if !e.IsDir() || e.Name() == opsRunsDirName || strings.HasSuffix(e.Name(), ".tmp") { if !e.IsDir() || e.Name() == opsRunsDirName || strings.HasSuffix(e.Name(), ".tmp") {
continue continue
} }
n++ r := opRow{ID: e.Name()[:12]}
if m, err := opLoad(dir, e.Name()); err == nil { if m, err := opLoad(dir, e.Name()); err == nil {
fmt.Printf("op %s %s as %s [%s]\n %s\n", m.Name, m.Version, m.Privilege, e.Name()[:12], m.Summary) r.Name, r.Version, r.Privilege, r.Summary = m.Name, m.Version, m.Privilege, m.Summary
} else { } else {
fmt.Printf("op [%s] NOT VERIFIED: %v\n", e.Name()[:12], err) r.NotVerified = err.Error()
} }
v.Ops = append(v.Ops, r)
} }
} }
f := opsLoad(dir) f := opsLoad(dir)
nonces := make([]string, 0, len(f.Grants))
for nonce, rec := range f.Grants { for nonce, rec := range f.Grants {
if rec.Dropped != "" { if rec.Dropped == "" {
continue nonces = append(nonces, nonce)
} }
t, err := verifyOpTerms(dir, rec.TermsCanonical, rec.Signature, opKindGrant) }
sort.Strings(nonces)
for _, nonce := range nonces {
rec := f.Grants[nonce]
r := opGrantRow{ID: nonce[:8], RunsLeft: rec.UsesLeft}
if t, err := verifyOpTerms(dir, rec.TermsCanonical, rec.Signature, opKindGrant); err != nil {
r.NotVerified = err.Error()
} else {
r.Op, r.Version, r.Until, r.Within = t.Op, t.Version, t.Expires, t.Bounds
}
v.Grants = append(v.Grants, r)
}
return v, nil
}
func cmdOpsList(host string, asJSON bool) error {
v, err := readMachine("ops", readOpts{Host: host}, readOps)
if err != nil { if err != nil {
fmt.Printf("grant [%s] NOT VERIFIED: %v\n", nonce[:8], err) return laneRefusalError("ops", err)
}
if asJSON {
return printJSON(os.Stdout, v)
}
printOps(os.Stdout, v)
return nil
}
func printOps(w io.Writer, v opsRead) {
if v.Sandbox {
fmt.Fprintln(w, "sandbox: available")
} else {
fmt.Fprintln(w, "sandbox: NOT available —", v.SandboxUnavailable)
}
for _, r := range v.Ops {
if r.NotVerified != "" {
fmt.Fprintf(w, "op [%s] NOT VERIFIED: %s\n", r.ID, r.NotVerified)
continue continue
} }
fmt.Printf("grant [%s] %s %s %d run(s) left, until %s\n within: %s\n", nonce[:8], t.Op, t.Version, rec.UsesLeft, t.Expires, t.Bounds) fmt.Fprintf(w, "op %s %s as %s [%s]\n %s\n", r.Name, r.Version, r.Privilege, r.ID, r.Summary)
} }
if n == 0 && len(f.Grants) == 0 { for _, r := range v.Grants {
fmt.Println("no ops held for", cfg.HostName) if r.NotVerified != "" {
fmt.Fprintf(w, "grant [%s] NOT VERIFIED: %s\n", r.ID, r.NotVerified)
continue
}
fmt.Fprintf(w, "grant [%s] %s %s %d run(s) left, until %s\n within: %s\n", r.ID, r.Op, r.Version, r.RunsLeft, r.Until, r.Within)
}
if len(v.Ops) == 0 && len(v.Grants) == 0 {
fmt.Fprintln(w, "no ops held for", v.Host)
} }
return nil
} }
// cmdOpsDrop takes a held op grant back at the console. // cmdOpsDrop takes a held op grant back at the console.
func cmdOpsDrop(host, prefix string) error { func cmdOpsDrop(host, prefix string) error {
return printOrAct(agentAskRequest{Act: "ops-drop", Host: host, ID: prefix},
"ops drop "+prefix+hostFlagWords(host), func() (string, error) { return opsDropText(host, prefix) })
}
func opsDropText(host, prefix string) (string, error) {
cfg, err := stepupPairing(host) cfg, err := stepupPairing(host)
if err != nil { if err != nil {
return err return "", err
} }
dir := cfg.dcnDir() dir := cfg.dcnDir()
prefix = strings.TrimSpace(prefix) prefix = strings.TrimSpace(prefix)
if prefix == "" {
// Every nonce starts with "": with one grant held, an empty id
// would drop it unnamed.
return "", errors.New("which op grant? (the id `privatae-bastion ops` lists, or --all)")
}
if prefix == "--all" {
dropped, err := opsDropWhere(dir, "dropped at this machine's console", func(string, *opGrantRec) bool { return true })
if err != nil {
return "", err
}
return fmt.Sprintf("%d op grant(s) dropped — the host cannot run under any of them again", len(dropped)), nil
}
var hits []string var hits []string
for nonce, rec := range opsLoad(dir).Grants { for nonce, rec := range opsLoad(dir).Grants {
if rec.Dropped == "" && strings.HasPrefix(nonce, prefix) { if rec.Dropped == "" && strings.HasPrefix(nonce, prefix) {
@@ -150,14 +246,38 @@ func cmdOpsDrop(host, prefix string) error {
} }
switch len(hits) { switch len(hits) {
case 0: case 0:
return fmt.Errorf("no held op grant starts with %q", prefix) return "", fmt.Errorf("no held op grant starts with %q", prefix)
case 1: case 1:
default: default:
return fmt.Errorf("%d grants start with %q — give more of the id", len(hits), prefix) return "", fmt.Errorf("%d grants start with %q — give more of the id", len(hits), prefix)
} }
if _, err := opsDropGrant(dir, hits[0], "dropped at this machine's console"); err != nil { if _, err := opsDropGrant(dir, hits[0], "dropped at this machine's console"); err != nil {
return "", err
}
return fmt.Sprintf("op grant %s dropped — the host cannot run under it again", hits[0][:8]), nil
}
// printOrAct runs a narrowing act: through the owner's lane beside the
// machine's bastion (owneracts.go), else here, printing what it did either way.
func printOrAct(req agentAskRequest, adminCmd string, here func() (string, error)) error {
var done string
var err error
if readsGoThroughLane() {
done, err = actViaSock(req)
if err != nil {
return laneRefusalError(adminCmd, err)
}
} else if done, err = here(); err != nil {
return err return err
} }
fmt.Printf("op grant %s dropped — the host cannot run under it again\n", hits[0][:8]) fmt.Println(done)
return nil return nil
} }
// hostFlagWords is " --host <host>" when one was named.
func hostFlagWords(host string) string {
if host == "" {
return ""
}
return " --host " + host
}
+194
View File
@@ -0,0 +1,194 @@
package main
// consolelane.go — the machine owner's own account opens the console of the
// bastion installed for the whole machine, without sudo on Linux and macOS
// and without an Administrator terminal on Windows.
//
// THE PROBLEM. Installed for the whole machine, the bastion runs as root and
// its console signs in with root's ui.secret. `privatae-bastion ui` run by the
// person reads their own account's state, and the console refuses that
// account's key, so the person reached their own machine's console only
// through sudo, and a browser started by sudo is root's, not theirs.
//
// THE LANE. ask.sock (agentask.go), and on Windows the service's ask pipe
// (asklane_windows.go), already tells the daemon, from the operating system,
// which account connected. Asked for "console" by the account recorded as the
// machine's owner (owner_account.go), the daemon mints a one-use ticket of a
// LIMITED kind and answers with the link; `ui` opens it in the person's own
// browser. Any other account is refused, and no request text is trusted.
//
// WHAT A LIMITED SESSION MAY DO. Everything a person can see, everything that
// only narrows reach (deny, switch off, disconnect, unmark), and everything
// that takes the owner's code, which an agent running as the person cannot
// read on this install. It is refused what widens access with no code today:
// pairing a Host, setting up or rotating the owner's code, choosing the Host
// in charge, proposing a folder, and the approval device's approvals. Those
// stay with the administrator (`sudo -H privatae-bastion ui`, or `ui` from an
// Administrator terminal on Windows). Codes typed for
// a Host's requests in a limited session are throttled as the owner's are
// (machineCodeSpend), because guessing is the only attack left there.
import (
"errors"
"fmt"
"net/http"
"net/url"
"os"
"runtime"
"sync/atomic"
)
// consoleLaneTicketsMax is how many lane links may wait unopened at once.
const consoleLaneTicketsMax = 16
// consoleLaneServer is the running console, for ask.sock to mint a ticket
// on. nil until the console listens, and again after it stops.
var consoleLaneServer atomic.Pointer[uiServer]
// consoleLaneRefusal says why account uid may not open the console through
// the lane, or "" when it may.
func consoleLaneRefusal(uid uint32, who string) string {
return consoleLaneRefusalFor(askPeer{UID: uid, Name: who})
}
// consoleLaneRefusalFor is consoleLaneRefusal for a peer of either platform.
func consoleLaneRefusalFor(p askPeer) string {
admin := adminCommandFor(p.windows(), "ui")
match, ownerName, present, err := laneOwnerMatch(p)
switch {
case err != nil:
return "this machine's owner account cannot be read (" + err.Error() + "); the administrator opens " +
"the console with: " + admin
case !present:
return "no account is recorded as this machine's owner, so the console opens only for the administrator: " +
admin + ". To open it from your own account, the administrator records it once: " + ownerRecordCommand(p)
case !match:
without := "without sudo"
if p.windows() {
without = "without an Administrator terminal"
}
return "this machine's console opens " + without + " only for its owner's account (" + ownerName + "), not " +
p.Name + ". The administrator opens it with: " + admin
}
return ""
}
func accountForHint(who string) string {
if who == "" || len(who) > 64 {
return "<your account>"
}
return who
}
// consoleLaneEntry is what the daemon answers an owner's "console" ask with:
// the link that redeems a fresh limited ticket.
func consoleLaneEntry(uid uint32, who string) (string, error) {
return consoleLaneEntryFor(askPeer{UID: uid, Name: who})
}
func consoleLaneEntryFor(p askPeer) (string, error) {
if why := consoleLaneRefusalFor(p); why != "" {
return "", errors.New(why)
}
u := consoleLaneServer.Load()
if u == nil || u.addr == "" {
return "", errors.New("the bastion's console is not listening (no free port, or it is still starting)")
}
// A cap, so asking over and over cannot grow root's memory: a link lasts a
// minute, and a person opens one at a time.
tok, ok, err := u.limitedTickets.mintCapped(consoleLaneTicketsMax)
if err != nil {
return "", errors.New("could not mint a ticket")
}
if !ok {
return "", errors.New("too many console links are waiting to be opened; open one, or wait a minute")
}
return "http://" + u.addr + "/?k=" + tok, nil
}
// limitedSession reports whether the request's session came through the lane.
func (u *uiServer) limitedSession(r *http.Request) bool {
return u.limitedSessions != nil && u.limitedSessions.valid(uiSessionFrom(r))
}
// signedIn reports whether the request carries either kind of session.
func (u *uiServer) signedIn(r *http.Request) bool {
tok := uiSessionFrom(r)
return u.sessions.valid(tok) || (u.limitedSessions != nil && u.limitedSessions.valid(tok))
}
var consoleLaneAdminOnly = "From your own account the console does not do this: it widens what reaches this machine " +
"with no code, or reads beyond your own account. The machine's administrator does it: " +
adminCommandFor(runtime.GOOS == "windows", "ui")
// adminOnly wraps a route a limited session may not use.
func (u *uiServer) adminOnly(h http.HandlerFunc) http.HandlerFunc {
return u.guarded(func(w http.ResponseWriter, r *http.Request) {
if u.limitedSession(r) {
http.Error(w, consoleLaneAdminOnly, http.StatusForbidden)
return
}
h(w, r)
})
}
// consoleEntryForThisAccount is the link `ui` opens. An account with a
// bastion of its own signs in with its own key (localUIEntryURL). An ordinary
// account beside the machine's bastion asks the lane, and is told why not
// when it is not the owner's.
func consoleEntryForThisAccount() (entry, addr string, err error) {
if runtime.GOOS == "windows" {
if systemService.installed && !machineAuthorityHeld() {
return consoleEntryThroughLane()
}
return localUIEntryURL()
}
if os.Geteuid() != 0 && !uiDaemonListening() {
p := askSockPath()
if why := contextSockDialable(p); why != "" {
return "", "", errors.New(why)
}
if _, statErr := os.Stat(p); statErr == nil {
return consoleEntryThroughLane()
}
}
return localUIEntryURL()
}
// consoleEntryThroughLane asks the machine's bastion for the owner's link.
func consoleEntryThroughLane() (entry, addr string, err error) {
p := askLaneAddr(askSockPath())
r, err := askViaSock(agentAskRequest{Op: "console"})
if err != nil {
if runtime.GOOS == "windows" {
// The service is there (systemService.installed) but its pipe is
// not: a service older than this command, or one not running.
return "", "", fmt.Errorf("this machine's bastion runs as the %s service, and it did not answer your "+
"account's request for its console on %s (%v).\n"+
" If the service is not running, start it: %s\n"+
" If it is older than this command, update it by running the installer again.\n"+
" Either way the administrator can open the console now: %s",
winServiceName, p, err, serviceRunHintFor("windows"), adminCommandFor(true, "ui"))
}
return "", "", errors.New("could not reach this machine's bastion at " + p + ": " + err.Error())
}
if !r.OK {
return "", "", errors.New(r.Why)
}
u, err := url.Parse(r.URL)
if err != nil || u.Scheme != "http" || !uiLoopbackHost(u.Host, u.Port()) {
return "", "", errors.New("this machine's bastion answered with a link that is not its own console")
}
return r.URL, u.Host, nil
}
// uiLimitedWriter marks a response as drawn for a limited session, so a page
// shows the administrator's command in place of a form the session would be
// refused (Settings, Approvals). It changes what is drawn, never what is
// allowed: adminOnly decides that, from the session itself.
type uiLimitedWriter struct{ http.ResponseWriter }
func limitedWriter(w http.ResponseWriter) bool {
_, ok := w.(uiLimitedWriter)
return ok
}
+220
View File
@@ -0,0 +1,220 @@
package main
import (
"context"
"net/http"
"net/url"
"os/user"
"strconv"
"strings"
"testing"
)
// laneOwner records uid as the machine's owner account, as the installer's
// root step does, with machine authority faked and the account looked up as
// an invented one.
func laneOwner(t *testing.T, uid uint32) {
t.Helper()
prevAuth, prevLookup, prevState := machineAuthorityHeld, lookupOwnerAccount, ownerServiceState
t.Cleanup(func() { machineAuthorityHeld, lookupOwnerAccount, ownerServiceState = prevAuth, prevLookup, prevState })
machineAuthorityHeld = func() bool { return true }
ownerServiceState = func() string { return "" }
lookupOwnerAccount = func(who string) (*user.User, error) {
return &user.User{Uid: strconv.FormatUint(uint64(uid), 10), Username: "sam"}, nil
}
if err := cmdOwnerAccount("sam", false); err != nil {
t.Fatal(err)
}
}
// laneSignedIn redeems a ticket minted for the owner's lane, the way the
// browser does, and returns the session cookie it sets.
func laneSignedIn(t *testing.T, u *uiServer, uid uint32) string {
t.Helper()
u.addr = "127.0.0.1:" + uiTestPort
prev := consoleLaneServer.Load()
consoleLaneServer.Store(u)
t.Cleanup(func() { consoleLaneServer.Store(prev) })
link, err := consoleLaneEntry(uid, "sam")
if err != nil {
t.Fatalf("the owner's lane refused its owner: %v", err)
}
p, _ := url.Parse(link)
w := uiGet(t, u.handler(), "/?"+p.RawQuery, "")
if w.Code != http.StatusSeeOther {
t.Fatalf("redeeming the lane's ticket = %d: %s", w.Code, firstLines(w.Body.String()))
}
for _, c := range w.Result().Cookies() {
if c.Name == uiCookieName {
return uiCookieName + "=" + c.Value
}
}
t.Fatal("no session cookie")
return ""
}
func TestTheLaneOpensOnlyForTheOwnersAccount(t *testing.T) {
uiTestConfigDir(t)
if why := consoleLaneRefusal(1000, "sam"); !strings.Contains(why, "approvals-owner --account sam") {
t.Errorf("with no owner recorded the refusal does not say how to record one: %q", why)
}
laneOwner(t, 1000)
if why := consoleLaneRefusal(1000, "sam"); why != "" {
t.Errorf("the owner was refused: %q", why)
}
if why := consoleLaneRefusal(1001, "lee"); !strings.Contains(why, "only for its owner's account (sam)") {
t.Errorf("another account was let in, or told the wrong thing: %q", why)
}
if _, err := consoleLaneEntry(1001, "lee"); err == nil {
t.Error("a ticket was minted for an account that is not the owner's")
}
}
func TestTheOwnerAccountIsNotQuietlyHandedToAnother(t *testing.T) {
uiTestConfigDir(t)
laneOwner(t, 1000)
if err := cmdOwnerAccount("sam", false); err != nil {
t.Errorf("the same account again: %v", err)
}
lookupOwnerAccount = func(string) (*user.User, error) { return &user.User{Uid: "1001", Username: "lee"}, nil }
if err := cmdOwnerAccount("lee", false); err == nil || !strings.Contains(err.Error(), "stays so") {
t.Errorf("another account took the console: %v", err)
}
prev := ownerConsole
t.Cleanup(func() { ownerConsole = prev })
ownerConsole = func() bool { return false }
if err := cmdOwnerAccount("lee", true); err == nil || !strings.Contains(err.Error(), "only at a terminal") {
t.Errorf("--replace was taken from a pipe: %v", err)
}
if uid, _, _, _ := ownerAccountLoad(); uid != 1000 {
t.Fatalf("the owner changed to uid %d", uid)
}
lookupOwnerAccount = func(string) (*user.User, error) { return &user.User{Uid: "0", Username: "root"}, nil }
ownerConsole = func() bool { return true }
if err := cmdOwnerAccount("root", true); err == nil || !strings.Contains(err.Error(), "root administers") {
t.Errorf("root was recorded as the owner's account: %v", err)
}
}
// A limited session sees the console and does what takes the code or narrows
// reach. What widens reach with no code is the administrator's, and the page
// says so instead of offering it.
func TestALaneSessionIsRefusedWhatWidensReachWithNoCode(t *testing.T) {
u, admin := settingsWorld(t, true)
laneOwner(t, 1000)
lane := laneSignedIn(t, u, 1000)
h := u.handler()
for _, p := range []string{"/", "/setup", "/approvals", "/activity", "/machine"} {
if w := uiGet(t, h, p, lane); w.Code != http.StatusOK {
t.Errorf("GET %s from the lane = %d", p, w.Code)
}
}
for _, p := range []string{"/setup/pair", "/setup/stepup/start", "/setup/stepup/confirm", "/setup/stepup/key",
"/setup/folder/propose", "/setup/anchor/choose", "/device/approve", "/device/approve-shown"} {
w := uiPost(t, h, p, url.Values{"target": {"machine"}, "token": {"skb_x"}}, lane)
if w.Code != http.StatusForbidden || !strings.Contains(w.Body.String(), "sudo -H privatae-bastion ui") {
t.Errorf("POST %s from the lane = %d %s", p, w.Code, firstLines(w.Body.String()))
}
}
if w := uiGet(t, h, "/setup/stepup/qr?e=x", lane); w.Code != http.StatusForbidden {
t.Errorf("the enrolment QR was served to the lane: %d", w.Code)
}
// The disk map, run as root, names files in every account's home. Its
// stand-in is installed, so a POST that got through would walk nothing:
// it blocks until the test ends.
dm := dmTestInstall(t, nil)
release := make(chan struct{})
t.Cleanup(func() { close(release) })
dm.scan = func(ctx context.Context, _ []string, _ int, _ func(dmProgress)) *dmResult {
<-release
return nil
}
for _, p := range []string{"/diskmap", "/fragments/diskmap"} {
if w := uiGet(t, h, p, lane); w.Code != http.StatusForbidden {
t.Errorf("GET %s from the lane = %d", p, w.Code)
}
}
if w := uiPost(t, h, "/diskmap/scan", url.Values{}, lane); w.Code != http.StatusForbidden {
t.Errorf("POST /diskmap/scan from the lane = %d", w.Code)
}
// Narrowing reach needs no code, from the lane too.
uiPost(t, h, "/setup/host/disconnect", url.Values{"host": {"member.host.privatae.ai"}, "confirm": {"1"}}, lane)
if cfgs, _ := loadPairings(); len(cfgs) != 0 {
t.Error("the lane could not disconnect a Host")
}
// The same routes still work for the administrator's own session.
if w := uiPost(t, h, "/setup/stepup/start", url.Values{"target": {"machine"}, "replace": {"1"}}, admin); w.Code != http.StatusOK {
t.Errorf("the administrator was refused: %d %s", w.Code, firstLines(w.Body.String()))
}
body := uiGet(t, h, "/setup", lane).Body.String()
if strings.Contains(body, `hx-post="/setup/pair"`) || strings.Contains(body, `hx-post="/setup/stepup/start"`) {
t.Error("Settings offers the lane a form it would refuse")
}
if !strings.Contains(body, "sudo -H privatae-bastion stepup-enroll --machine --rotate") {
t.Error("Settings does not tell the lane how the code is replaced")
}
if body := uiGet(t, h, "/setup", admin).Body.String(); !strings.Contains(body, `hx-post="/setup/pair"`) {
t.Error("Settings lost the pairing form for the administrator")
}
}
// The folder check stats whatever path is posted, as the daemon, which is root
// on a whole-machine install. The lane draws no folder form, so from the lane
// it could only be used to learn what exists where the person's account cannot
// look; it is the administrator's, like the proposal it serves.
func TestALaneSessionCannotProbePathsThroughTheFolderCheck(t *testing.T) {
u, admin := settingsWorld(t, true)
laneOwner(t, 1000)
lane := laneSignedIn(t, u, 1000)
h := u.handler()
dir := t.TempDir()
w := uiPost(t, h, "/setup/folder/check", url.Values{"path": {dir}}, lane)
if w.Code != http.StatusForbidden || strings.Contains(w.Body.String(), "A folder on this machine") {
t.Errorf("the lane's folder check = %d %s", w.Code, firstLines(w.Body.String()))
}
if w := uiPost(t, h, "/setup/folder/check", url.Values{"path": {dir}}, admin); w.Code != http.StatusOK ||
!strings.Contains(w.Body.String(), "A folder on this machine") {
t.Errorf("the administrator's folder check = %d %s", w.Code, firstLines(w.Body.String()))
}
}
// Through the lane the Host factor's seed is out of reach, so wrong codes
// typed for a Host's request are throttled there, and only there.
func TestALaneSessionsWrongHostCodesAreThrottled(t *testing.T) {
const host = "member.host.privatae.ai"
_, id := uiTestApprovalBox(t, host)
u := uiTestServer(t)
laneOwner(t, 1000)
lane := laneSignedIn(t, u, 1000)
h := u.handler()
var last string
for i := 0; i < pipeFreeFailures+1; i++ {
last = uiPost(t, h, "/approve", url.Values{"host": {host}, "id": {id}, "code": {"000000"}}, lane).Body.String()
}
if !strings.Contains(last, "wait") && !strings.Contains(last, "again in") {
t.Errorf("the lane typed %d wrong codes with no wait: %s", pipeFreeFailures+1, firstLines(last))
}
admin := uiSignedIn(t, u)
body := uiPost(t, h, "/approve", url.Values{"host": {host}, "id": {id}, "code": {"000000"}}, admin).Body.String()
if strings.Contains(body, "again in") {
t.Errorf("the administrator's page is throttled too: %s", firstLines(body))
}
}
// Links minted for the lane are capped, so an account asking in a loop cannot
// grow the root daemon's memory; one opened frees its place.
func TestTheLaneCapsTheLinksWaitingToBeOpened(t *testing.T) {
u := uiTestServer(t)
uiTestConfigDir(t)
laneOwner(t, 1000)
laneSignedIn(t, u, 1000) // sets the server for the lane; its link is used
for i := 0; i < consoleLaneTicketsMax; i++ {
if _, err := consoleLaneEntry(1000, "sam"); err != nil {
t.Fatalf("link %d refused: %v", i+1, err)
}
}
if _, err := consoleLaneEntry(1000, "sam"); err == nil || !strings.Contains(err.Error(), "too many") {
t.Fatalf("link %d was minted: %v", consoleLaneTicketsMax+1, err)
}
}
+24 -8
View File
@@ -136,13 +136,7 @@ func maybeContain(pairing, dcnDir string, heartbeatResponse []byte) {
// fingerprint is in the accounting (one running as a service, say) // fingerprint is in the accounting (one running as a service, say)
// would otherwise be spared in silence — killTree returns 0 for a // would otherwise be spared in silence — killTree returns 0 for a
// spared root and a zero kill is not recorded. // spared root and a zero kill is not recorded.
root := pid killed := stopAgentTree(pid, guard)
killed := killTree(pid, func(p int) bool {
if p == root {
return spareFromContain(p)
}
return guard(p)
})
if killed > 0 { if killed > 0 {
fmt.Printf("contain: terminated agent pid %d and %d child process(es) (host-directed)\n", pid, killed-1) fmt.Printf("contain: terminated agent pid %d and %d child process(es) (host-directed)\n", pid, killed-1)
// The Printf stays — under systemd it is journald, which is a real // The Printf stays — under systemd it is journald, which is a real
@@ -175,7 +169,13 @@ func hostPhrase(pairing string) string {
// here rather than in events.go because this is the only place that still holds // here rather than in events.go because this is the only place that still holds
// the host, the signature and the count together. // the host, the signature and the count together.
func containSentence(pairing, signature string, pid, children int) string { func containSentence(pairing, signature string, pid, children int) string {
s := hostPhrase(pairing) + " stopped " + signature + " (pid " + strconv.Itoa(pid) + return stopSentence(hostPhrase(pairing), signature, pid, children)
}
// stopSentence is containSentence with the one who stopped it named: a Host,
// or "You" when the machine's owner did (stop_local.go).
func stopSentence(subject, signature string, pid, children int) string {
s := subject + " stopped " + signature + " (pid " + strconv.Itoa(pid) +
") running on this machine" ") running on this machine"
switch { switch {
case children == 0: case children == 0:
@@ -208,3 +208,19 @@ func observedAgentMap() map[int]agentObs {
} }
return out return out
} }
// stopAgentTree stops one observed agent and everything beneath it, sparing
// init, this bastion and its own local agent at the root, and the protected
// set (containGuard) below it. It is the ONE stop path: a Host's order
// (maybeContain) and the machine owner's own (stop_local.go) both come
// through here, so what each may not touch cannot drift apart. It returns how
// many processes the kill reached, the agent included.
func stopAgentTree(pid int, guard func(int) bool) int {
root := pid
return killTree(pid, func(p int) bool {
if p == root {
return spareFromContain(p)
}
return guard(p)
})
}
+77 -5
View File
@@ -43,9 +43,11 @@ import (
"encoding/json" "encoding/json"
"errors" "errors"
"fmt" "fmt"
"io"
"net" "net"
"os" "os"
"path/filepath" "path/filepath"
"sync"
"time" "time"
) )
@@ -126,16 +128,79 @@ func startContextSock(done <-chan struct{}) {
_ = ln.Close() _ = ln.Close()
_ = os.Remove(p) _ = os.Remove(p)
}() }()
go func() { go contextSockAccept(ln)
uilogf("context socket listening on %s\n", p)
}
// The socket is 0666 and the daemon runs as root (or SYSTEM), so every user on
// the machine can make it read. These bound what they can make it hold: an ask
// is a folder path and a display name, far under contextAskMaxBytes, and no
// more than contextSockMaxInFlight asks are read at once. Past that a
// connection is told the daemon is busy and closed; the asker tries again.
//
// One person may hold at most contextSockMaxPerUser of those slots, keyed on
// the identity the kernel gives (never on anything the asker says): without
// it, one user opening contextSockMaxInFlight idle connections and dialling
// again as each deadline ran out kept every other user's asks "busy" for as
// long as they liked. A person adds a folder at a time; four at once is far
// past that.
const (
contextAskMaxBytes = 64 << 10
contextSockMaxInFlight = 32
)
// contextSockMaxPerUser is a var only so the test of the overall cap can lift
// it (every test connection is the same user).
var contextSockMaxPerUser = 4
var contextSockUsers = struct {
sync.Mutex
held map[string]int
}{held: map[string]int{}}
// contextSockTakeUser takes one of user's slots, or reports there is none.
func contextSockTakeUser(user string) bool {
contextSockUsers.Lock()
defer contextSockUsers.Unlock()
if contextSockUsers.held[user] >= contextSockMaxPerUser {
return false
}
contextSockUsers.held[user]++
return true
}
func contextSockReleaseUser(user string) {
contextSockUsers.Lock()
defer contextSockUsers.Unlock()
if contextSockUsers.held[user]--; contextSockUsers.held[user] <= 0 {
delete(contextSockUsers.held, user)
}
}
// contextSockAccept serves ln until it is closed, at most
// contextSockMaxInFlight connections at a time.
func contextSockAccept(ln net.Listener) {
slots := make(chan struct{}, contextSockMaxInFlight)
for { for {
c, err := ln.Accept() c, err := ln.Accept()
if err != nil { if err != nil {
return return
} }
go contextSockServe(c) select {
} case slots <- struct{}{}:
go func() {
defer func() { <-slots }()
contextSockServe(c)
}() }()
uilogf("context socket listening on %s\n", p) default:
go func() {
defer c.Close()
_ = c.SetDeadline(time.Now().Add(time.Second))
_ = json.NewEncoder(c).Encode(contextAskReply{Why: "the bastion is busy " +
"answering other asks on this machine; try again in a moment"})
}()
}
}
} }
func contextSockServe(c net.Conn) { func contextSockServe(c net.Conn) {
@@ -154,8 +219,15 @@ func contextSockServe(c net.Conn) {
return return
} }
if !contextSockTakeUser(user) {
_ = json.NewEncoder(c).Encode(contextAskReply{User: user, Why: "the bastion is busy " +
"answering other asks of yours; try again in a moment"})
return
}
defer contextSockReleaseUser(user)
var req contextAskRequest var req contextAskRequest
if err := json.NewDecoder(c).Decode(&req); err != nil { if err := json.NewDecoder(io.LimitReader(c, contextAskMaxBytes)).Decode(&req); err != nil {
_ = json.NewEncoder(c).Encode(contextAskReply{User: user, Why: "the request could not be read"}) _ = json.NewEncoder(c).Encode(contextAskReply{User: user, Why: "the request could not be read"})
return return
} }
+130
View File
@@ -0,0 +1,130 @@
package main
// The context socket is 0666: every user on the machine may connect, and the
// daemon behind it runs as root (or SYSTEM). So what one connection can make
// the daemon hold must be bounded by the daemon, not by the asker.
import (
"net"
"path/filepath"
"runtime"
"strings"
"testing"
"time"
)
// An ask is a folder path and a display name. A client that streams a request
// with no end gets the daemon to read only a bounded amount of it, then a
// reply and a close; before, the decoder kept every byte until the 30 s
// deadline, and nothing capped how many such connections were open.
func TestAContextAskWithNoEndIsReadOnlyToABound(t *testing.T) {
if runtime.GOOS == "windows" {
t.Skip("no unix-socket peer credentials on windows; contextsock_windows.go says why")
}
sock := filepath.Join(t.TempDir(), "s.sock")
ln, err := net.Listen("unix", sock)
if err != nil {
t.Fatal(err)
}
defer ln.Close()
go func() {
c, err := ln.Accept()
if err != nil {
return
}
contextSockServe(c)
}()
c, err := net.Dial("unix", sock)
if err != nil {
t.Fatal(err)
}
defer c.Close()
const total = 16 << 20
chunk := []byte(strings.Repeat("a", 64<<10))
sent := 0
if _, err := c.Write([]byte(`{"root":"`)); err != nil {
t.Fatal(err)
}
for sent < total {
_ = c.SetWriteDeadline(time.Now().Add(2 * time.Second))
n, err := c.Write(chunk)
sent += n
if err != nil {
break
}
}
// The kernel's socket buffers hold a few hundred KiB the daemon never
// read; anything near the whole stream means the daemon read it all.
if sent >= 4<<20 {
t.Fatalf("the daemon accepted %d MiB of one ask with no end; it must stop at a bound", sent>>20)
}
}
// Asks in flight are capped: a connection past the cap is closed at once, so
// many idle or endless connections cannot multiply the bound above.
func TestContextAsksInFlightAreCapped(t *testing.T) {
if runtime.GOOS == "windows" {
t.Skip("no unix-socket peer credentials on windows; contextsock_windows.go says why")
}
sock := filepath.Join(t.TempDir(), "s.sock")
ln, err := net.Listen("unix", sock)
if err != nil {
t.Fatal(err)
}
defer ln.Close()
// Every connection here is the same user; lift the per-user share so the
// overall cap is what this test meets (TestOneUserCannotHoldEveryContextSockSlot
// holds the share).
oldShare := contextSockMaxPerUser
contextSockMaxPerUser = contextSockMaxInFlight
t.Cleanup(func() { contextSockMaxPerUser = oldShare })
go contextSockAccept(ln)
var held []net.Conn
defer func() {
for _, h := range held {
_ = h.Close()
}
}()
// Each of these sends nothing and holds its slot until its deadline.
for i := 0; i < contextSockMaxInFlight; i++ {
h, err := net.Dial("unix", sock)
if err != nil {
t.Fatal(err)
}
held = append(held, h)
}
// Give the daemon's accept loop time to take every held connection.
time.Sleep(200 * time.Millisecond)
extra, err := net.Dial("unix", sock)
if err != nil {
t.Fatal(err)
}
defer extra.Close()
_ = extra.SetReadDeadline(time.Now().Add(2 * time.Second))
buf := make([]byte, 512)
n, rerr := extra.Read(buf)
if ne, ok := rerr.(net.Error); ok && ne.Timeout() {
t.Fatalf("a connection past the cap of %d was left open; it must be refused", contextSockMaxInFlight)
}
if n > 0 && !strings.Contains(string(buf[:n]), "busy") {
t.Fatalf("a connection past the cap got %q; it must be told the daemon is busy", buf[:n])
}
// Once a held connection goes, a new ask gets a slot again.
_ = held[0].Close()
held = held[1:]
time.Sleep(200 * time.Millisecond)
again, err := net.Dial("unix", sock)
if err != nil {
t.Fatal(err)
}
defer again.Close()
_ = again.SetReadDeadline(time.Now().Add(500 * time.Millisecond))
n, rerr = again.Read(buf)
if ne, ok := rerr.(net.Error); !ok || !ne.Timeout() {
t.Fatalf("after a slot was freed, a new ask was not served (read %q, %v)", buf[:n], rerr)
}
}
+86
View File
@@ -0,0 +1,86 @@
package main
import (
"net"
"path/filepath"
"runtime"
"strings"
"testing"
"time"
)
// One person cannot take every slot: past their own share they are told the
// daemon is busy at once, while slots remain for everyone else. Before, one
// user's idle connections, re-dialled as each deadline ran out, held all of
// them and every other user's ask was refused.
func TestOneUserCannotHoldEveryContextSockSlot(t *testing.T) {
if runtime.GOOS == "windows" {
t.Skip("no unix-socket peer credentials on windows; contextsock_windows.go says why")
}
const share = 4 // contextSockMaxPerUser
// A test before this one may still be releasing its slots.
if n := contextSockSlotsHeld(t, 0); n != 0 {
t.Fatalf("%d slots still held from an earlier test", n)
}
sock := filepath.Join(t.TempDir(), "s.sock")
ln, err := net.Listen("unix", sock)
if err != nil {
t.Fatal(err)
}
defer ln.Close()
go contextSockAccept(ln)
var held []net.Conn
defer func() {
for _, h := range held {
_ = h.Close()
}
}()
for i := 0; i < share; i++ {
h, err := net.Dial("unix", sock)
if err != nil {
t.Fatal(err)
}
held = append(held, h)
}
// Wait until the daemon has given those four their slots (a fixed sleep
// lost this race on a loaded machine and handed the 5th one first).
if n := contextSockSlotsHeld(t, share); n != share {
t.Fatalf("the daemon gave %d slots to %d idle connections of one user", n, share)
}
extra, err := net.Dial("unix", sock)
if err != nil {
t.Fatal(err)
}
defer extra.Close()
_ = extra.SetReadDeadline(time.Now().Add(2 * time.Second))
buf := make([]byte, 512)
n, rerr := extra.Read(buf)
if ne, ok := rerr.(net.Error); ok && ne.Timeout() {
t.Fatalf("one user held %d idle connections and a %dth was still given a slot: "+
"one user can take all %d", share, share+1, contextSockMaxInFlight)
}
if !strings.Contains(string(buf[:n]), "busy") {
t.Fatalf("past one user's share the ask got %q; it must be told the daemon is busy", buf[:n])
}
}
// contextSockSlotsHeld waits up to 10 s for the per-user slots held across
// all users to reach want, and returns the count it last saw.
func contextSockSlotsHeld(t *testing.T, want int) int {
t.Helper()
n := -1
for deadline := time.Now().Add(10 * time.Second); time.Now().Before(deadline); time.Sleep(10 * time.Millisecond) {
contextSockUsers.Lock()
n = 0
for _, k := range contextSockUsers.held {
n += k
}
contextSockUsers.Unlock()
if n == want {
break
}
}
return n
}
+12 -5
View File
@@ -62,13 +62,20 @@ func contextSockListen(path string) (net.Listener, error) {
// contextPeerUser reads the connecting process's user from the kernel. // contextPeerUser reads the connecting process's user from the kernel.
func contextPeerUser(c net.Conn) (string, error) { func contextPeerUser(c net.Conn) (string, error) {
_, who, err := contextPeerIdentity(c)
return who, err
}
// contextPeerIdentity is the connecting process's uid from the kernel, and
// the account's name for messages (or "uid N" when it has none).
func contextPeerIdentity(c net.Conn) (uint32, string, error) {
uc, ok := c.(*net.UnixConn) uc, ok := c.(*net.UnixConn)
if !ok { if !ok {
return "", errors.New("not a unix socket") return 0, "", errors.New("not a unix socket")
} }
raw, err := uc.SyscallConn() raw, err := uc.SyscallConn()
if err != nil { if err != nil {
return "", err return 0, "", err
} }
var uid uint32 var uid uint32
var serr error var serr error
@@ -76,16 +83,16 @@ func contextPeerUser(c net.Conn) (string, error) {
uid, serr = contextPeerUID(fd) uid, serr = contextPeerUID(fd)
}) })
if err != nil { if err != nil {
return "", err return 0, "", err
} }
if serr != nil { if serr != nil {
return "", serr return 0, "", serr
} }
name := "" name := ""
if u, err := user.LookupId(strconv.FormatUint(uint64(uid), 10)); err == nil { if u, err := user.LookupId(strconv.FormatUint(uint64(uid), 10)); err == nil {
name = u.Username name = u.Username
} }
return contextSockFmtUser(uid, name), nil return uid, contextSockFmtUser(uid, name), nil
} }
// contextSockDir is machine-wide and root-owned. See contextSockPath. // contextSockDir is machine-wide and root-owned. See contextSockPath.
+4
View File
@@ -40,4 +40,8 @@ func contextPeerUser(c net.Conn) (string, error) {
return "", errContextSockUnsupported return "", errContextSockUnsupported
} }
func contextPeerIdentity(c net.Conn) (uint32, string, error) {
return 0, "", errContextSockUnsupported
}
var _ = os.Remove var _ = os.Remove
+168 -23
View File
@@ -26,6 +26,7 @@ import (
"encoding/base64" "encoding/base64"
"encoding/json" "encoding/json"
"fmt" "fmt"
"io/fs"
"os" "os"
"path/filepath" "path/filepath"
"runtime" "runtime"
@@ -74,6 +75,10 @@ type dcnGrantRec struct {
// the signed bytes (a public key; the terms stay exactly what was // the signed bytes (a public key; the terms stay exactly what was
// signed). The managed local agent seals the store's catalog to it. // signed). The managed local agent seals the store's catalog to it.
SealRecipient string `json:"seal_recipient,omitempty"` SealRecipient string `json:"seal_recipient,omitempty"`
// RootReal is where the granted folder led when this box installed the
// grant: its real path, pinned here (dcn_store.go), outside the signed
// bytes. An op whose root leads anywhere else is refused.
RootReal string `json:"root_real,omitempty"`
} }
// dcnTerms is parsed FROM the verified canonical bytes — never from anything else. // dcnTerms is parsed FROM the verified canonical bytes — never from anything else.
@@ -185,10 +190,19 @@ func dcnSaveFile(dir string, f *dcnGrantFile) error {
// accounting ("every read is logged for you"). Best-effort: auditing never blocks // accounting ("every read is logged for you"). Best-effort: auditing never blocks
// a result, but a refusal is still a refusal whether or not the line lands. // a result, but a refusal is still a refusal whether or not the line lands.
func dcnAudit(dir, op string, storeID int64, path, decision string) { func dcnAudit(dir, op string, storeID int64, path, decision string) {
rec, _ := json.Marshal(map[string]any{ dcnAuditWith(dir, op, storeID, path, decision, nil)
"ts": time.Now().UTC().Format(time.RFC3339), "op": op, }
"store_id": storeID, "path": path, "decision": decision,
}) // dcnAuditWith is dcnAudit with more fields on the row (an ask's asker and
// target, askparties.go). They never replace the five every reader expects.
func dcnAuditWith(dir, op string, storeID int64, path, decision string, extra map[string]any) {
row := map[string]any{}
for k, v := range extra {
row[k] = v
}
row["ts"], row["op"] = time.Now().UTC().Format(time.RFC3339), op
row["store_id"], row["path"], row["decision"] = storeID, path, decision
rec, _ := json.Marshal(row)
auditToSystemLog(auditFilePairingD, auditPairingOfDir(dir), rec) auditToSystemLog(auditFilePairingD, auditPairingOfDir(dir), rec)
fh, err := os.OpenFile(filepath.Join(dir, "audit.jsonl"), fh, err := os.OpenFile(filepath.Join(dir, "audit.jsonl"),
os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0o600) os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0o600)
@@ -271,27 +285,82 @@ func dcnResolvePath(root, rpath string) (string, bool) {
return joined, true return joined, true
} }
// dcnExcluded reports whether rpath trips any exclude pattern. Patterns match the // dcnExcluded reports whether rpath trips any exclude pattern, or is inside a
// basename and every path segment (glob per segment: ".ssh", "*.key", ".env*"), // local search agent's folder (dcnInAgentDirOn), which no grant reaches. A
// compared the way this platform's file system compares names (dcnNameKey). // pattern of one folder name matches any segment of the path (".ssh", "*.key",
// ".env*"); a pattern with a "/" (".config/gcloud") matches that run of
// consecutive segments wherever it sits in the path, each one a glob. Names
// are compared the way this platform's file system compares them (dcnNameKey).
// rpath is a real relative path; a path a host sent goes through dcnExcludedAsSent. // rpath is a real relative path; a path a host sent goes through dcnExcludedAsSent.
func dcnExcluded(excludes []string, rpath string) bool { func dcnExcluded(excludes []string, rpath string) bool {
return dcnExcludedOn(runtime.GOOS, excludes, rpath) return dcnExcludedOn(runtime.GOOS, excludes, rpath)
} }
func dcnExcludedOn(goos string, excludes []string, rpath string) bool { func dcnExcludedOn(goos string, excludes []string, rpath string) bool {
if dcnInAgentDirOn(goos, rpath) {
return true
}
segs := strings.Split(filepath.ToSlash(rpath), "/") segs := strings.Split(filepath.ToSlash(rpath), "/")
for i, seg := range segs {
segs[i] = dcnNameKey(goos, seg)
}
for _, pat := range excludes { for _, pat := range excludes {
pat = strings.TrimSpace(pat) pat = strings.TrimSpace(pat)
if pat == "" { if pat == "" {
continue continue
} }
pat = dcnNameKey(goos, pat) var run []string
for _, seg := range segs { for _, p := range strings.Split(pat, "/") {
if ok, _ := filepath.Match(pat, dcnNameKey(goos, seg)); ok { if p != "" {
run = append(run, dcnNameKey(goos, p))
}
}
if dcnRunMatches(run, segs) {
return true return true
} }
} }
return false
}
// dcnRunMatches says whether the globs in run match len(run) consecutive
// segments of segs, starting anywhere. An empty run matches nothing.
func dcnRunMatches(run, segs []string) bool {
if len(run) == 0 {
return false
}
for i := 0; i+len(run) <= len(segs); i++ {
all := true
for j, p := range run {
if ok, _ := filepath.Match(p, segs[i+j]); !ok {
all = false
break
}
}
if all {
return true
}
}
return false
}
// dcnAgentDir is the folder the local search agent keeps everything it makes
// in, beside the files it reads: the plaintext of every file in scope, the
// sanitized text, vectors, the catalog and sealed bundles. The bastion puts
// it at <root>/.agent wherever it may write into the folder (freeagent_managed.go;
// the agent's own default too), and a folder inside a store can hold another
// store's. The agent's walker never reads one, at any depth and in any case;
// the file ops never serve one either.
const dcnAgentDir = ".agent"
// dcnInAgentDirOn reports whether any segment of rpath names an agent's
// folder, as the file system on goos names it, and in any case on every OS
// (as the agent's own walker judges it: a ".Agent" on a volume that ignores
// case is the agent's folder).
func dcnInAgentDirOn(goos, rpath string) bool {
for _, seg := range strings.Split(filepath.ToSlash(rpath), "/") {
if strings.EqualFold(dcnNameKey(goos, seg), dcnAgentDir) {
return true
}
} }
return false return false
} }
@@ -323,11 +392,25 @@ func dcnNameKey(goos, name string) string {
// //
// A path cleanRel refuses is judged as sent (the sandbox refuses it anyway). // A path cleanRel refuses is judged as sent (the sandbox refuses it anyway).
func dcnExcludedAsSent(excludes []string, root, rpath string) bool { func dcnExcludedAsSent(excludes []string, root, rpath string) bool {
return dcnJudgedAsSent(root, rpath, func(rel string) bool { return dcnExcluded(excludes, rel) })
}
// dcnAgentAsSent is whether a path a host sent opens an agent's folder (by its
// spelling or through a link), judged as dcnExcludedAsSent judges excludes.
// dcnExcluded refuses the same paths; this one exists so the refusal can say
// why.
func dcnAgentAsSent(root, rpath string) bool {
return dcnJudgedAsSent(root, rpath, func(rel string) bool { return dcnInAgentDirOn(runtime.GOOS, rel) })
}
// dcnJudgedAsSent applies judge to what a host's path opens: the cleaned path
// relative to the root, then where it leads relative to the resolved root.
func dcnJudgedAsSent(root, rpath string, judge func(rel string) bool) bool {
joined, ok := cleanRel(root, rpath) joined, ok := cleanRel(root, rpath)
if !ok { if !ok {
return dcnExcluded(excludes, rpath) return judge(rpath)
} }
if rel, err := filepath.Rel(filepath.Clean(root), joined); err != nil || dcnExcluded(excludes, rel) { if rel, err := filepath.Rel(filepath.Clean(root), joined); err != nil || judge(rel) {
return true return true
} }
resolvedRoot, err := filepath.EvalSymlinks(filepath.Clean(root)) resolvedRoot, err := filepath.EvalSymlinks(filepath.Clean(root))
@@ -338,7 +421,7 @@ func dcnExcludedAsSent(excludes []string, root, rpath string) bool {
if err != nil { if err != nil {
return true return true
} }
return dcnExcluded(excludes, rel) return judge(rel)
} }
// dcnWhereItLeads is p with its deepest existing part's links resolved and the // dcnWhereItLeads is p with its deepest existing part's links resolved and the
@@ -423,6 +506,10 @@ func dcnLoadGrantMask(ws *websocket.Conn, dir, op string, storeID int64, rpath,
dcnRefuse(ws, dir, op, storeID, rpath, "op '"+mask+"' not in the store's granted mask") dcnRefuse(ws, dir, op, storeID, rpath, "op '"+mask+"' not in the store's granted mask")
return nil return nil
} }
if rpath != "" && dcnAgentAsSent(terms.Root, rpath) {
dcnRefuse(ws, dir, op, storeID, rpath, "path is in the local search agent's own folder (.agent), which no grant reaches")
return nil
}
if rpath != "" && dcnExcludedAsSent(terms.Excludes, terms.Root, rpath) { if rpath != "" && dcnExcludedAsSent(terms.Excludes, terms.Root, rpath) {
dcnRefuse(ws, dir, op, storeID, rpath, "path is excluded by the grant") dcnRefuse(ws, dir, op, storeID, rpath, "path is excluded by the grant")
return nil return nil
@@ -524,6 +611,17 @@ func handleDcnGrantSync(ws *websocket.Conn, dir string, args []string) {
dcnRefuse(ws, dir, "grant_sync", payload.StoreID, "", "grant does not verify: "+err.Error()) dcnRefuse(ws, dir, "grant_sync", payload.StoreID, "", "grant does not verify: "+err.Error())
return return
} }
// The folder this grant names is pinned as it resolves now; a re-sync or a
// renewal of the same root keeps the pin it already has (dcn_store.go).
if prev, held := f.Stores[fmt.Sprint(payload.StoreID)]; held {
prevRoot := ""
if pt, perr := dcnVerifyRec(f.VerifyPubkey, prev); perr == nil {
prevRoot = pt.Root
}
rec.RootReal = dcnPinFor(&prev, prevRoot, terms.Root)
} else {
rec.RootReal = dcnPinFor(nil, "", terms.Root)
}
if hn, _ := os.Hostname(); hn != "" && terms.Server != "" && terms.Server != hn { if hn, _ := os.Hostname(); hn != "" && terms.Server != "" && terms.Server != hn {
dcnRefuse(ws, dir, "grant_sync", payload.StoreID, "", dcnRefuse(ws, dir, "grant_sync", payload.StoreID, "",
fmt.Sprintf("grant is for server '%s', this box is '%s'", terms.Server, hn)) fmt.Sprintf("grant is for server '%s', this box is '%s'", terms.Server, hn))
@@ -582,7 +680,7 @@ func handleDcnGrantSync(ws *websocket.Conn, dir string, args []string) {
if dcnHasMask(terms, "search") { if dcnHasMask(terms, "search") {
faEnsureStore(dir, payload.StoreID, terms, sweepFromCanonical(rec.TermsCanonical), rec.SealRecipient) faEnsureStore(dir, payload.StoreID, terms, sweepFromCanonical(rec.TermsCanonical), rec.SealRecipient)
} else { } else {
faStop(payload.StoreID) faStop(dir, payload.StoreID)
} }
dcnResult(ws, dir, "grant_sync", payload.StoreID, "", map[string]any{ dcnResult(ws, dir, "grant_sync", payload.StoreID, "", map[string]any{
"state": "ok", "root": terms.Root, "mask": terms.Mask, "state": "ok", "root": terms.Root, "mask": terms.Mask,
@@ -610,14 +708,16 @@ func dcnDropStoreLocked(dir string, storeID int64, why string) (bool, error) {
} }
key := strconv.FormatInt(storeID, 10) key := strconv.FormatInt(storeID, 10)
if _, ok := f.Stores[key]; !ok { if _, ok := f.Stores[key]; !ok {
faStop(storeID) // nothing on disk, but never leave an orphan instance running // Nothing on disk, but never leave an orphan instance running: this
// pairing's own (faKey), never another Host's for the same store id.
faStop(dir, storeID)
return false, nil return false, nil
} }
delete(f.Stores, key) delete(f.Stores, key)
if err := dcnSaveFile(dir, f); err != nil { if err := dcnSaveFile(dir, f); err != nil {
return true, err return true, err
} }
faStop(storeID) faStop(dir, storeID)
dcnAudit(dir, "grant_drop", storeID, "", why) dcnAudit(dir, "grant_drop", storeID, "", why)
return true, nil return true, nil
} }
@@ -658,15 +758,26 @@ func handleDcnList(ws *websocket.Conn, dir string, args []string) {
if terms == nil { if terms == nil {
return return
} }
base := terms.Root base := "."
if a.Prefix != "" { if a.Prefix != "" {
p, ok := dcnResolvePath(terms.Root, a.Prefix) p, ok := dcnResolvePath(terms.Root, a.Prefix)
if !ok { if !ok {
dcnRefuse(ws, dir, "list", storeID, a.Prefix, "prefix escapes the store root") dcnRefuse(ws, dir, "list", storeID, a.Prefix, "prefix escapes the store root")
return return
} }
base = p rel, err := dcnRel(terms.Root, p)
if err != nil {
dcnRefuse(ws, dir, "list", storeID, a.Prefix, "prefix escapes the store root")
return
} }
base = filepath.ToSlash(rel)
}
r, err := dcnOpenStore(dir, storeID, terms)
if err != nil {
dcnRefuse(ws, dir, "list", storeID, a.Prefix, err.Error())
return
}
defer r.Close()
limit := a.Limit limit := a.Limit
if limit <= 0 || limit > dcnMaxListEntries { if limit <= 0 || limit > dcnMaxListEntries {
limit = dcnMaxListEntries limit = dcnMaxListEntries
@@ -678,12 +789,14 @@ func handleDcnList(ws *websocket.Conn, dir string, args []string) {
} }
var files []entry var files []entry
truncated := false truncated := false
_ = filepath.WalkDir(base, func(p string, d os.DirEntry, err error) error { // Walked through the store's handle: a link that leads out of it is not
// followed, whatever the names do during the walk.
_ = fs.WalkDir(r.FS(), base, func(p string, d fs.DirEntry, err error) error {
if err != nil { if err != nil {
return nil // unreadable subtree: skip, never abort the listing return nil // unreadable subtree: skip, never abort the listing
} }
rel, rerr := filepath.Rel(terms.Root, p) rel := filepath.FromSlash(p)
if rerr != nil || rel == "." { if rel == "." {
return nil return nil
} }
if dcnExcluded(terms.Excludes, rel) { if dcnExcluded(terms.Excludes, rel) {
@@ -727,8 +840,23 @@ func handleDcnStat(ws *websocket.Conn, dir string, args []string) {
dcnRefuse(ws, dir, "stat", storeID, a.Path, "path escapes the store root") dcnRefuse(ws, dir, "stat", storeID, a.Path, "path escapes the store root")
return return
} }
info, err := os.Stat(abs) rel, err := dcnRel(terms.Root, abs)
if err != nil { if err != nil {
dcnRefuse(ws, dir, "stat", storeID, a.Path, err.Error())
return
}
r, err := dcnOpenStore(dir, storeID, terms)
if err != nil {
dcnRefuse(ws, dir, "stat", storeID, a.Path, err.Error())
return
}
defer r.Close()
info, err := r.Stat(rel)
if err != nil {
if dcnEscaped(err) {
dcnRefuse(ws, dir, "stat", storeID, a.Path, "path escapes the store root")
return
}
if os.IsNotExist(err) { if os.IsNotExist(err) {
dcnResult(ws, dir, "stat", storeID, a.Path, map[string]any{ dcnResult(ws, dir, "stat", storeID, a.Path, map[string]any{
"state": "gone", "path": a.Path}) "state": "gone", "path": a.Path})
@@ -771,8 +899,25 @@ func handleDcnReadRange(ws *websocket.Conn, dir string, args []string) {
dcnRefuse(ws, dir, "read_range", storeID, a.Path, "path escapes the store root") dcnRefuse(ws, dir, "read_range", storeID, a.Path, "path escapes the store root")
return return
} }
fh, err := os.Open(abs) rel, err := dcnRel(terms.Root, abs)
if err != nil { if err != nil {
dcnRefuse(ws, dir, "read_range", storeID, a.Path, err.Error())
return
}
r, err := dcnOpenStore(dir, storeID, terms)
if err != nil {
dcnRefuse(ws, dir, "read_range", storeID, a.Path, err.Error())
return
}
defer r.Close()
// Opened through the store's handle: a name swapped for a link to a file
// outside the store after the check above is refused, never followed.
fh, err := r.Open(rel)
if err != nil {
if dcnEscaped(err) {
dcnRefuse(ws, dir, "read_range", storeID, a.Path, "path escapes the store root")
return
}
if os.IsNotExist(err) { if os.IsNotExist(err) {
dcnResult(ws, dir, "read_range", storeID, a.Path, map[string]any{ dcnResult(ws, dir, "read_range", storeID, a.Path, map[string]any{
"state": "gone", "path": a.Path}) "state": "gone", "path": a.Path})
+60 -20
View File
@@ -142,6 +142,10 @@ func dcnCheckPlan(root string, excludes []string, moves []dcnMove) []dcnPlanProb
continue continue
} }
seenTo[pathKey(dst)], seenFrom[pathKey(src)] = i, i seenTo[pathKey(dst)], seenFrom[pathKey(src)] = i, i
if dcnAgentAsSent(root, m.From) || dcnAgentAsSent(root, m.To) {
bad(i, m, "the local search agent's own folder (.agent) is never moved from or into")
continue
}
if dcnExcludedAsSent(excludes, root, m.From) { if dcnExcludedAsSent(excludes, root, m.From) {
bad(i, m, "source is excluded by the grant") bad(i, m, "source is excluded by the grant")
continue continue
@@ -191,10 +195,28 @@ func dcnReportPath(root string, planID int64) string {
return p return p
} }
// dcnApplyPlan runs the plan: check, rename in order (each re-checked just // dcnApplyPlan is dcnApplyPlanIn on root opened where it leads now (the op
// before it runs; rolling back on the first failure), verify, report. Every // handler opens the PINNED folder instead, dcn_store.go).
// path it touches has passed dcnCheckPlan.
func dcnApplyPlan(root string, excludes []string, plan *dcnPlanTerms) map[string]any { func dcnApplyPlan(root string, excludes []string, plan *dcnPlanTerms) map[string]any {
real, err := dcnRealRoot(root)
if err != nil {
return map[string]any{"state": "refused", "mode": "apply", "plan_id": plan.PlanID,
"reason": "the store's folder cannot be opened: " + err.Error()}
}
r, err := dcnOpenRootAt(real)
if err != nil {
return map[string]any{"state": "refused", "mode": "apply", "plan_id": plan.PlanID, "reason": err.Error()}
}
defer r.Close()
return dcnApplyPlanIn(r, root, excludes, plan)
}
// dcnApplyPlanIn runs the plan: check, rename in order (each re-checked just
// before it runs; rolling back on the first failure), verify, report. Every
// path it touches has passed dcnCheckPlan, and every change is made through
// r, the store's handle, so a folder that becomes a link to somewhere else
// between the check and the rename is refused rather than followed.
func dcnApplyPlanIn(r *os.Root, root string, excludes []string, plan *dcnPlanTerms) map[string]any {
problems := dcnCheckPlan(root, excludes, plan.Moves) problems := dcnCheckPlan(root, excludes, plan.Moves)
if len(problems) > 0 { if len(problems) > 0 {
return map[string]any{"state": "refused", "mode": "apply", "plan_id": plan.PlanID, return map[string]any{"state": "refused", "mode": "apply", "plan_id": plan.PlanID,
@@ -207,11 +229,11 @@ func dcnApplyPlan(root string, excludes []string, plan *dcnPlanTerms) map[string
// and what is NOT (so the user knows exactly what is still displaced). // and what is NOT (so the user knows exactly what is still displaced).
rollback := func() (back, stuck []string) { rollback := func() (back, stuck []string) {
for i := len(applied) - 1; i >= 0; i-- { for i := len(applied) - 1; i >= 0; i-- {
if _, err := os.Lstat(applied[i].src); err == nil { if _, err := r.Lstat(applied[i].src); err == nil {
stuck = append(stuck, applied[i].from) // something now sits at the source; never replace it stuck = append(stuck, applied[i].from) // something now sits at the source; never replace it
continue continue
} }
if err := os.Rename(applied[i].dst, applied[i].src); err == nil { if err := r.Rename(applied[i].dst, applied[i].src); err == nil {
back = append(back, applied[i].from) back = append(back, applied[i].from)
} else { } else {
stuck = append(stuck, applied[i].from) stuck = append(stuck, applied[i].from)
@@ -230,24 +252,30 @@ func dcnApplyPlan(root string, excludes []string, plan *dcnPlanTerms) map[string
return rep return rep
} }
for i, m := range plan.Moves { for i, m := range plan.Moves {
src, _ := dcnResolvePath(root, m.From) srcAbs, _ := dcnResolvePath(root, m.From)
dst, _ := cleanRel(root, m.To) dstAbs, _ := cleanRel(root, m.To)
if err := os.MkdirAll(filepath.Dir(dst), 0o755); err != nil { src, serr := dcnRel(root, srcAbs)
dst, derr := dcnRel(root, dstAbs)
if serr != nil || derr != nil {
return fail(i, m, "path escapes the store root")
}
if d := filepath.Dir(dst); d != "." {
if err := r.MkdirAll(d, 0o755); err != nil {
return fail(i, m, "could not create the target folder: "+err.Error()) return fail(i, m, "could not create the target folder: "+err.Error())
} }
}
// Re-check the instant before the rename: the world may have changed since // Re-check the instant before the rename: the world may have changed since
// the pre-check (a file appeared at the target; a parent became a symlink). // the pre-check (a file appeared at the target; a parent became a symlink).
// rename(2) would replace silently — this lane never lets it. // rename(2) would replace silently — this lane never lets it.
if _, ok := dcnResolvePath(root, m.To); !ok { if _, ok := dcnResolvePath(root, m.To); !ok {
return fail(i, m, "target's parent no longer resolves inside the store root") return fail(i, m, "target's parent no longer resolves inside the store root")
} }
if _, err := os.Lstat(dst); err == nil { if _, err := r.Lstat(dst); err == nil {
return fail(i, m, "target appeared since the check (a plan never overwrites)") return fail(i, m, "target appeared since the check (a plan never overwrites)")
} }
if err := os.Rename(src, dst); err != nil { if err := r.Rename(src, dst); err != nil {
why := err.Error() why := err.Error()
var le *os.LinkError if errors.Is(err, syscall.EXDEV) {
if errors.As(err, &le) && errors.Is(le.Err, syscall.EXDEV) {
why = "target is on a different filesystem than the source (a plan only renames; it never copies and removes)" why = "target is on a different filesystem than the source (a plan only renames; it never copies and removes)"
} }
return fail(i, m, why) return fail(i, m, why)
@@ -257,14 +285,16 @@ func dcnApplyPlan(root string, excludes []string, plan *dcnPlanTerms) map[string
// Verify pass: every target present, every source gone, declared sizes hold. // Verify pass: every target present, every source gone, declared sizes hold.
var mismatches []dcnPlanProblem var mismatches []dcnPlanProblem
for i, m := range plan.Moves { for i, m := range plan.Moves {
src, _ := dcnResolvePath(root, m.From) srcAbs, _ := dcnResolvePath(root, m.From)
dst, _ := cleanRel(root, m.To) dstAbs, _ := cleanRel(root, m.To)
info, err := os.Lstat(dst) src, _ := dcnRel(root, srcAbs)
dst, _ := dcnRel(root, dstAbs)
info, err := r.Lstat(dst)
if err != nil { if err != nil {
mismatches = append(mismatches, dcnPlanProblem{i, m.From, m.To, "target missing after move"}) mismatches = append(mismatches, dcnPlanProblem{i, m.From, m.To, "target missing after move"})
continue continue
} }
if _, err := os.Lstat(src); err == nil { if _, err := r.Lstat(src); err == nil {
mismatches = append(mismatches, dcnPlanProblem{i, m.From, m.To, "source still present after move"}) mismatches = append(mismatches, dcnPlanProblem{i, m.From, m.To, "source still present after move"})
} }
if m.SizeBytes != nil && !info.IsDir() && info.Size() != *m.SizeBytes { if m.SizeBytes != nil && !info.IsDir() && info.Size() != *m.SizeBytes {
@@ -372,9 +402,19 @@ func handleDcnPlanApply(ws *websocket.Conn, dir string, args []string) {
// a retry (a lost reply, a host re-run) gets the earlier report back BEFORE // a retry (a lost reply, a host re-run) gets the earlier report back BEFORE
// any gate can turn it into a refusal. (The signed expiry is the guard that // any gate can turn it into a refusal. (The signed expiry is the guard that
// does not depend on a file the user can remove.) // does not depend on a file the user can remove.)
store, err := dcnOpenStore(dir, storeID, terms)
if err != nil {
dcnRefuse(ws, dir, op, storeID, planKey, err.Error())
return
}
defer store.Close()
repPath := dcnReportPath(terms.Root, plan.PlanID) repPath := dcnReportPath(terms.Root, plan.PlanID)
repRel := ""
if repPath != "" { if repPath != "" {
if prev, err := os.ReadFile(repPath); err == nil { repRel, _ = dcnRel(terms.Root, repPath)
}
if repRel != "" {
if prev, err := store.ReadFile(repRel); err == nil {
var old map[string]any var old map[string]any
if json.Unmarshal(prev, &old) == nil && old["state"] == "ok" { if json.Unmarshal(prev, &old) == nil && old["state"] == "ok" {
old["note"] = "already applied on this machine; this is the earlier report" old["note"] = "already applied on this machine; this is the earlier report"
@@ -398,13 +438,13 @@ func handleDcnPlanApply(ws *websocket.Conn, dir string, args []string) {
return return
} }
} }
rep := dcnApplyPlan(terms.Root, terms.Excludes, plan) rep := dcnApplyPlanIn(store, terms.Root, terms.Excludes, plan)
if rep["state"] == "ok" && plan.Approval != "" { if rep["state"] == "ok" && plan.Approval != "" {
markApprovalUsed(dir, plan.Approval) // single use: the files have moved markApprovalUsed(dir, plan.Approval) // single use: the files have moved
} }
if repPath != "" { if repRel != "" {
if raw, err := json.MarshalIndent(rep, "", " "); err == nil { if raw, err := json.MarshalIndent(rep, "", " "); err == nil {
_ = atomicWrite(repPath, raw) // the machine's own record; best-effort _ = dcnRootAtomicWrite(store, repRel, raw) // the machine's own record; best-effort
} }
} }
dcnResult(ws, dir, op, storeID, planKey, rep) dcnResult(ws, dir, op, storeID, planKey, rep)
+290
View File
@@ -0,0 +1,290 @@
package main
// Two things a host holding `read` on a folder must never reach through the
// file ops (list, stat, read_range), nor move with a plan:
// - what an exclude of several folders names. The Host's default excludes
// carry ".config/gcloud", and a pattern with a "/" was compared with one
// folder name at a time, so it matched nothing: a shared home folder
// served its gcloud credentials;
// - the local search agent's own folder, .agent, which holds the plaintext
// of every file the agent read, whatever the grant excludes.
import (
"encoding/base64"
"encoding/json"
"os"
"path/filepath"
"strings"
"testing"
"time"
"github.com/gorilla/websocket"
)
// dcnDefaultExcludes is the exclude list the Host proposes for a new folder.
var dcnDefaultExcludes = []string{
".ssh", ".gnupg", ".aws", ".azure", ".config/gcloud", ".kube",
".env", ".env.*", "*.pem", "*.key", "*.p12", "*.pfx", "*.keystore",
"id_rsa*", "id_ed25519*", "*.token", "credentials*", ".netrc",
".git-credentials", "*history",
}
// syncExcluding installs a read grant for the store with these excludes,
// through the real grant_sync op.
func (fx *dcnStoreFixture) syncExcluding(t *testing.T, excludes []string) {
t.Helper()
rec := signedRec(t, fx.priv, map[string]any{"kind": "dcn_store_grant", "class": "machine",
"root": fx.store, "mask": []string{"read"}, "excludes": excludes,
"expires": time.Now().Add(24 * time.Hour).UTC().Format(time.RFC3339)})
payload, _ := json.Marshal(map[string]any{"store_id": 1, "terms_canonical": rec.TermsCanonical,
"signature": rec.Signature, "verify_pubkey": base64.StdEncoding.EncodeToString(fx.pub)})
_, why, exit := dcnRunOp(t, func(ws *websocket.Conn) {
handleDcnGrantSync(ws, fx.dir, []string{base64.StdEncoding.EncodeToString(payload)})
})
if exit != 0 {
t.Fatalf("grant_sync: exit %d: %s", exit, why)
}
}
func (fx *dcnStoreFixture) put(t *testing.T, rel, body string) {
t.Helper()
p := filepath.Join(fx.store, filepath.FromSlash(rel))
if err := os.MkdirAll(filepath.Dir(p), 0o755); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(p, []byte(body), 0o600); err != nil {
t.Fatal(err)
}
}
// listed is what dcn_list returns under prefix, and its exit code.
func (fx *dcnStoreFixture) listed(t *testing.T, prefix string) ([]string, int) {
t.Helper()
obj, _, exit := fx.op(t, handleDcnList, map[string]any{"prefix": prefix})
var paths []string
files, _ := obj["files"].([]any)
for _, f := range files {
if m, ok := f.(map[string]any); ok {
p, _ := m["path"].(string)
paths = append(paths, p)
}
}
return paths, exit
}
// A pattern with a "/" names that run of folders, wherever it sits in the
// path, each folder compared as the file system compares names. Judged per
// platform from any OS.
func TestDcnAMultiFolderExcludeMatchesThatRunAnywhere(t *testing.T) {
for _, c := range []struct {
goos, path string
want bool
}{
{"linux", ".config/gcloud/access_tokens.db", true},
{"linux", ".config/gcloud", true},
{"linux", "home/.config/gcloud/x", true},
{"linux", "a/b/.config/gcloud/configurations/config_default", true},
{"linux", ".config/gcloudx", false},
{"linux", ".config/gcloudx/access_tokens.db", false},
{"linux", ".configx/gcloud/x", false},
{"linux", ".config/other/gcloud/x", false},
{"linux", "gcloud/.config/x", false},
{"linux", ".config", false},
{"linux", ".config/settings.ini", false},
{"linux", ".Config/gcloud/x", false}, // another folder on Linux
{"darwin", ".Config/GCloud/access_tokens.db", true},
{"darwin", "home/.CONFIG/gcloud/x", true},
{"darwin", ".config/gcloudx/x", false},
{"windows", ".CONFIG/GCLOUD/access_tokens.db", true},
{"windows", "home/.config./gcloud /x", true},
{"windows", ".config/gcloudx/x", false},
// one-folder patterns as before
{"linux", "deep/.ssh/config", true},
{"linux", "certs/server.key", true},
{"linux", "notes/ssh-notes.txt", false},
{"windows", ".SSH/id_rsa", true},
} {
if got := dcnExcludedOn(c.goos, dcnDefaultExcludes, c.path); got != c.want {
t.Errorf("%s: %q excluded=%v, want %v", c.goos, c.path, got, c.want)
}
}
// A pattern's own slashes at either end, or doubled, name the same run.
for _, pat := range []string{".config/gcloud/", "/.config/gcloud", ".config//gcloud"} {
if !dcnExcludedOn("linux", []string{pat}, "home/.config/gcloud/x") {
t.Errorf("%q must exclude home/.config/gcloud/x", pat)
}
}
}
// The default exclude of gcloud's folder holds on every op a host sends, at the
// top of a home folder and inside one, and however the path is spelled.
func TestDcnTheDefaultGcloudExcludeHoldsOnEveryOp(t *testing.T) {
fx := newDcnStoreFixture(t)
fx.put(t, ".config/gcloud/access_tokens.db", "GCLOUD-TOKEN")
fx.put(t, "home/.config/gcloud/credentials.db", "NESTED-TOKEN")
fx.put(t, ".config/gcloudx/ok.txt", "NEAR-MISS")
fx.put(t, ".config/settings.ini", "SETTINGS")
fx.syncExcluding(t, dcnDefaultExcludes)
paths, exit := fx.listed(t, "")
if exit != 0 {
t.Fatalf("list: exit %d", exit)
}
have := map[string]bool{}
for _, p := range paths {
have[p] = true
if strings.Contains(p, ".config/gcloud/") {
t.Errorf("list returned %q, under an excluded folder", p)
}
}
for _, p := range []string{".config/gcloudx/ok.txt", ".config/settings.ini", "a.txt"} {
if !have[p] {
t.Errorf("list left out %q, which no exclude names (got %v)", p, paths)
}
}
if paths, exit := fx.listed(t, "home/.config"); exit != 0 || len(paths) != 0 {
t.Errorf("list under home/.config: exit %d, %v; want nothing", exit, paths)
}
for _, prefix := range []string{".config/gcloud", "home/.config/gcloud"} {
if _, exit := fx.listed(t, prefix); exit != 126 {
t.Errorf("list of %q: exit %d, want 126", prefix, exit)
}
}
for _, p := range []string{".config/gcloud", ".config/gcloud/access_tokens.db",
"home/.config/gcloud/credentials.db", " .config/gcloud/access_tokens.db",
"docs/../.config/gcloud/access_tokens.db"} {
if obj, _, exit := fx.op(t, handleDcnStat, map[string]any{"path": p}); exit != 126 {
t.Errorf("stat %q: exit %d %v, want 126", p, exit, obj)
}
if got, _, exit := fx.read(t, p); exit != 126 || strings.Contains(got, "TOKEN") {
t.Errorf("read_range %q: exit %d %q, want 126 and nothing", p, exit, got)
}
}
if got, why, exit := fx.read(t, ".config/gcloudx/ok.txt"); exit != 0 || got != "NEAR-MISS" {
t.Errorf("a folder only named like gcloud's must read: exit %d %q %s", exit, got, why)
}
if problems := dcnCheckPlan(fx.store, dcnDefaultExcludes, []dcnMove{
{From: ".config/gcloud/access_tokens.db", To: "out.db"}}); len(problems) == 0 {
t.Error("a move out of gcloud's folder must be refused")
}
if problems := dcnCheckPlan(fx.store, dcnDefaultExcludes, []dcnMove{
{From: "a.txt", To: "home/.config/gcloud/a.txt"}}); len(problems) == 0 {
t.Error("a move into gcloud's folder must be refused")
}
if err := os.Symlink(filepath.Join(".config", "gcloud"), filepath.Join(fx.store, "gc")); err != nil {
t.Skipf("symlinks unavailable: %v", err)
}
if got, _, exit := fx.read(t, "gc/access_tokens.db"); exit != 126 || got == "GCLOUD-TOKEN" {
t.Errorf("read through a link to gcloud's folder: exit %d %q, want 126", exit, got)
}
}
// The agent's folder is refused on every op a host sends: at the store's top,
// inside a folder another grant shares (where that store's agent keeps its
// own), through a link, and however it is spelled. The grant here excludes
// nothing, so the refusal is not the grant's to give or take.
func TestDcnTheAgentsFolderIsNeverServed(t *testing.T) {
fx := newDcnStoreFixture(t)
fx.put(t, ".agent/extract/ab/report.txt", "PLAINTEXT-OF-A-FILE")
fx.put(t, ".agent/manifest.yaml", "manifest")
fx.put(t, "proj/.agent/extract/x.txt", "NESTED-PLAINTEXT")
fx.put(t, "proj/readme.md", "README")
fx.syncExcluding(t, nil)
paths, exit := fx.listed(t, "")
if exit != 0 {
t.Fatalf("list: exit %d", exit)
}
have := map[string]bool{}
for _, p := range paths {
have[p] = true
if strings.Contains("/"+p, "/.agent/") {
t.Errorf("list returned %q, inside an agent's folder", p)
}
}
if !have["a.txt"] || !have["proj/readme.md"] {
t.Errorf("list left out the folder's own files: %v", paths)
}
for _, prefix := range []string{".agent", ".agent/extract", "proj/.agent"} {
if _, exit := fx.listed(t, prefix); exit != 126 {
t.Errorf("list of %q: exit %d, want 126", prefix, exit)
}
}
for _, p := range []string{".agent", ".agent/extract/ab/report.txt", ".agent/manifest.yaml",
"proj/.agent/extract/x.txt", " .agent/manifest.yaml", "docs/../.agent/extract/ab/report.txt"} {
if obj, _, exit := fx.op(t, handleDcnStat, map[string]any{"path": p}); exit != 126 {
t.Errorf("stat %q: exit %d %v, want 126", p, exit, obj)
}
if got, _, exit := fx.read(t, p); exit != 126 || strings.Contains(got, "PLAINTEXT") {
t.Errorf("read_range %q: exit %d %q, want 126 and nothing", p, exit, got)
}
}
for _, m := range []dcnMove{{From: ".agent/extract/ab/report.txt", To: "out.txt"},
{From: "a.txt", To: ".agent/a.txt"}, {From: "a.txt", To: "proj/.agent/a.txt"}} {
if problems := dcnCheckPlan(fx.store, nil, []dcnMove{m}); len(problems) == 0 {
t.Errorf("a move %q -> %q must be refused", m.From, m.To)
}
}
// The bastion's own report of a plan it applied still goes into
// .agent/plans, through the real plan op.
hn, _ := os.Hostname()
rec := signedRec(t, fx.priv, map[string]any{"kind": "dcn_move_plan", "store_id": 1, "plan_id": 41,
"server": hn, "root": fx.store, "archive": "Archive",
"moves": []map[string]any{{"from": "a.txt", "to": "Archive/a.txt"}},
"expires": time.Now().Add(time.Hour).UTC().Format(time.RFC3339)})
payload, _ := json.Marshal(map[string]any{"terms_canonical": rec.TermsCanonical,
"signature": rec.Signature, "mode": "apply"})
out, why, exit := dcnRunOp(t, func(ws *websocket.Conn) {
handleDcnPlanApply(ws, fx.dir, []string{"1", base64.StdEncoding.EncodeToString(payload)})
})
if exit != 0 || !strings.Contains(out, `"ok"`) {
t.Fatalf("plan apply: exit %d %s %s", exit, out, why)
}
if b, err := os.ReadFile(filepath.Join(fx.store, ".agent", "plans", "41.json")); err != nil ||
!strings.Contains(string(b), `"state": "ok"`) {
t.Fatalf("the plan's report was not written into .agent/plans: %q %v", b, err)
}
if err := os.Symlink(filepath.Join(".agent", "extract", "ab", "report.txt"), filepath.Join(fx.store, "notes.txt")); err != nil {
t.Skipf("symlinks unavailable: %v", err)
}
if err := os.Symlink(".agent", filepath.Join(fx.store, "ag")); err != nil {
t.Fatal(err)
}
for _, p := range []string{"notes.txt", "ag/extract/ab/report.txt", "ag/manifest.yaml"} {
if got, _, exit := fx.read(t, p); exit != 126 || strings.Contains(got, "PLAINTEXT") {
t.Errorf("read_range %q, a link into .agent: exit %d %q, want 126", p, exit, got)
}
}
if _, exit := fx.listed(t, "ag"); exit != 126 {
t.Errorf("list of a link to .agent: exit %d, want 126", exit)
}
}
// The agent's folder is named as the file system names it, and on every OS
// regardless of case, as the agent's own walker treats it: a ".Agent" left on
// a volume that ignores case is the agent's folder.
func TestDcnTheAgentsFolderIsMatchedHoweverTheNameIsCased(t *testing.T) {
for _, c := range []struct {
goos, path string
want bool
}{
{"linux", ".agent/extract/x", true},
{"linux", ".AGENT/extract/x", true},
{"darwin", ".Agent/vectors.db", true},
{"windows", ".AGENT/extract/x", true},
{"windows", ".agent./extract/x", true},
{"windows", ".agent /extract/x", true},
{"windows", ".agent::$INDEX_ALLOCATION/x", true},
{"linux", "deep/.agent", true},
{"linux", ".agentx/x", false},
{"linux", "agent/x", false},
{"linux", "notes/.agent-old/x", false},
{"darwin", "docs/readme.md", false},
} {
if got := dcnExcludedOn(c.goos, nil, c.path); got != c.want {
t.Errorf("%s: %q refused=%v, want %v", c.goos, c.path, got, c.want)
}
}
}
+322
View File
@@ -0,0 +1,322 @@
package main
// A machine store is the folder the person granted, for as long as the grant
// lives. The bastion often runs as root and the folder belongs to someone who
// is not, so whoever can write in it, or above it, must not be able to point
// a read or a move somewhere else: by turning the granted folder into a link
// after the grant (no race needed), or by swapping a file for a link between
// the check and the open.
import (
"crypto/ed25519"
"encoding/base64"
"encoding/json"
"net/http"
"net/http/httptest"
"os"
"path/filepath"
"strconv"
"strings"
"sync/atomic"
"testing"
"time"
"github.com/gorilla/websocket"
)
// dcnRunOp runs one DCN handler on the far side of a real WebSocket and
// returns what it sent: the O payload, the R text and the exit code.
func dcnRunOp(t *testing.T, h func(ws *websocket.Conn)) (out, errText string, exit int) {
t.Helper()
up := websocket.Upgrader{}
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
ws, err := up.Upgrade(w, r, nil)
if err != nil {
return
}
defer ws.Close()
h(ws)
}))
defer srv.Close()
ws, _, err := websocket.DefaultDialer.Dial("ws"+strings.TrimPrefix(srv.URL, "http"), nil)
if err != nil {
t.Fatal(err)
}
defer ws.Close()
_ = ws.SetReadDeadline(time.Now().Add(10 * time.Second))
exit = -1
for {
_, data, err := ws.ReadMessage()
if err != nil || len(data) == 0 {
return
}
switch data[0] {
case 'O':
out += string(data[1:])
case 'R':
errText += string(data[1:])
case 'X':
exit, _ = strconv.Atoi(string(data[1:]))
return
}
}
}
type dcnStoreFixture struct {
dir string // the pairing's dcn dir
base string
store string // the granted folder
other string // a folder the grant never named
priv ed25519.PrivateKey
pub ed25519.PublicKey
}
func newDcnStoreFixture(t *testing.T) *dcnStoreFixture {
t.Helper()
fx := &dcnStoreFixture{dir: t.TempDir(), base: t.TempDir()}
fx.store = filepath.Join(fx.base, "store")
fx.other = filepath.Join(fx.base, "other")
for _, d := range []string{fx.store, fx.other, filepath.Join(fx.store, "docs")} {
if err := os.MkdirAll(d, 0o755); err != nil {
t.Fatal(err)
}
}
if err := os.WriteFile(filepath.Join(fx.store, "a.txt"), []byte("MINE"), 0o644); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join(fx.other, "a.txt"), []byte("OTHER"), 0o600); err != nil {
t.Fatal(err)
}
fx.pub, fx.priv, _ = ed25519.GenerateKey(nil)
return fx
}
// sync installs a read grant for the store through the real grant_sync op.
func (fx *dcnStoreFixture) sync(t *testing.T, mask ...string) {
t.Helper()
if len(mask) == 0 {
mask = []string{"read"}
}
rec := signedRec(t, fx.priv, map[string]any{"kind": "dcn_store_grant", "class": "machine",
"root": fx.store, "mask": mask,
"expires": time.Now().Add(24 * time.Hour).UTC().Format(time.RFC3339)})
payload, _ := json.Marshal(map[string]any{"store_id": 1, "terms_canonical": rec.TermsCanonical,
"signature": rec.Signature, "verify_pubkey": base64.StdEncoding.EncodeToString(fx.pub)})
_, why, exit := dcnRunOp(t, func(ws *websocket.Conn) {
handleDcnGrantSync(ws, fx.dir, []string{base64.StdEncoding.EncodeToString(payload)})
})
if exit != 0 {
t.Fatalf("grant_sync: exit %d: %s", exit, why)
}
}
func (fx *dcnStoreFixture) op(t *testing.T, h func(*websocket.Conn, string, []string), args map[string]any) (map[string]any, string, int) {
t.Helper()
raw, _ := json.Marshal(args)
out, why, exit := dcnRunOp(t, func(ws *websocket.Conn) {
h(ws, fx.dir, []string{"1", string(raw)})
})
var obj map[string]any
_ = json.Unmarshal([]byte(out), &obj)
return obj, why, exit
}
func (fx *dcnStoreFixture) read(t *testing.T, path string) (string, string, int) {
t.Helper()
obj, why, exit := fx.op(t, handleDcnReadRange, map[string]any{"path": path})
b, _ := base64.StdEncoding.DecodeString(func() string { s, _ := obj["content_b64"].(string); return s }())
return string(b), why, exit
}
// repoint turns the granted folder into a link to the other one.
func (fx *dcnStoreFixture) repoint(t *testing.T) {
t.Helper()
if err := os.Rename(fx.store, fx.store+".was"); err != nil {
t.Fatal(err)
}
if err := os.Symlink(fx.other, fx.store); err != nil {
t.Skipf("symlinks unavailable: %v", err)
}
}
func TestDcnStoreRepointedAfterTheGrantIsRefused(t *testing.T) {
fx := newDcnStoreFixture(t)
fx.sync(t)
if got, why, exit := fx.read(t, "a.txt"); exit != 0 || got != "MINE" {
t.Fatalf("the granted file must read: exit %d %q %s", exit, got, why)
}
fx.repoint(t)
if got, _, exit := fx.read(t, "a.txt"); exit == 0 || got == "OTHER" {
t.Fatalf("after the granted folder became a link elsewhere, read_range returned %q (exit %d); it must refuse", got, exit)
}
if obj, _, exit := fx.op(t, handleDcnStat, map[string]any{"path": "a.txt"}); exit == 0 {
t.Fatalf("stat through the repointed folder must refuse, got %v", obj)
}
if obj, _, exit := fx.op(t, handleDcnList, map[string]any{}); exit == 0 {
t.Fatalf("list through the repointed folder must refuse, got %v", obj)
}
}
// A folder inside the store that becomes a link to somewhere else after the
// grant is the same escape one level down.
func TestDcnSubfolderRepointedIsRefused(t *testing.T) {
fx := newDcnStoreFixture(t)
fx.sync(t)
if err := os.RemoveAll(filepath.Join(fx.store, "docs")); err != nil {
t.Fatal(err)
}
if err := os.Symlink(fx.other, filepath.Join(fx.store, "docs")); err != nil {
t.Skipf("symlinks unavailable: %v", err)
}
if got, _, exit := fx.read(t, "docs/a.txt"); exit == 0 || got == "OTHER" {
t.Fatalf("a link inside the store to a folder outside it read %q (exit %d)", got, exit)
}
}
// The race: a file swapped for a link to a file outside the store between the
// check and the open. Run for long enough that the old check-then-open loses.
func TestDcnReadRangeSwapRaceNeverLeavesTheStore(t *testing.T) {
fx := newDcnStoreFixture(t)
fx.sync(t)
target := filepath.Join(fx.store, "a.txt")
realTmp := filepath.Join(fx.store, ".real")
linkTmp := filepath.Join(fx.store, ".link")
var stop atomic.Bool
done := make(chan struct{})
go func() {
defer close(done)
for !stop.Load() {
_ = os.Symlink(filepath.Join(fx.other, "a.txt"), linkTmp)
_ = os.Rename(linkTmp, target)
_ = os.WriteFile(realTmp, []byte("MINE"), 0o644)
_ = os.Rename(realTmp, target)
}
}()
deadline := time.Now().Add(3 * time.Second)
n := 0
for time.Now().Before(deadline) {
n++
if got, _, _ := fx.read(t, "a.txt"); got == "OTHER" {
stop.Store(true)
<-done
t.Fatalf("read %d returned the file outside the store through a swapped link", n)
}
}
stop.Store(true)
<-done
}
// A move plan applies through the store too: a target folder that leads
// outside the store for an instant between the re-check and the rename must
// not receive the file.
func TestDcnPlanMoveRaceNeverLeavesTheStore(t *testing.T) {
fx := newDcnStoreFixture(t)
if err := os.Remove(filepath.Join(fx.other, "a.txt")); err != nil {
t.Fatal(err)
}
docs := filepath.Join(fx.store, "docs")
var stop atomic.Bool
done := make(chan struct{})
go func() {
defer close(done)
for !stop.Load() {
_ = os.Rename(docs, docs+".real")
_ = os.Symlink(fx.other, docs+".link")
_ = os.Rename(docs+".link", docs)
_ = os.Rename(docs, docs+".link")
_ = os.Remove(docs + ".link")
_ = os.Rename(docs+".real", docs)
}
}()
defer func() { stop.Store(true); <-done }()
deadline := time.Now().Add(3 * time.Second)
for i := 0; time.Now().Before(deadline); i++ {
_ = os.WriteFile(filepath.Join(fx.store, "a.txt"), []byte("MINE"), 0o644)
plan := &dcnPlanTerms{PlanID: int64(i), StoreID: 1, Root: fx.store,
Moves: []dcnMove{{From: "a.txt", To: "docs/a.txt"}}}
_ = dcnApplyPlan(fx.store, nil, plan)
if _, err := os.Lstat(filepath.Join(fx.other, "a.txt")); err == nil {
t.Fatalf("move %d landed outside the store, through a folder that was a link for an instant", i)
}
_ = os.Remove(filepath.Join(fx.store, "docs.real", "a.txt"))
_ = os.Remove(filepath.Join(docs, "a.txt"))
}
}
// The plan report is written beside its name and renamed into place. Whoever
// can write in the store could plant a link at that side name; the write must
// never follow it, or the root bastion truncates whatever file the link names
// (an excluded .ssh/authorized_keys included) and fills it with the report.
func TestDcnReportWriteNeverFollowsAPlantedSideName(t *testing.T) {
store := t.TempDir()
victim := filepath.Join(store, ".ssh", "authorized_keys")
if err := os.MkdirAll(filepath.Dir(victim), 0o700); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(victim, []byte("ssh-ed25519 AAAAexample user@example\n"), 0o600); err != nil {
t.Fatal(err)
}
plans := filepath.Join(store, ".agent", "plans")
if err := os.MkdirAll(plans, 0o700); err != nil {
t.Fatal(err)
}
rel := filepath.Join(".agent", "plans", "7.json")
// Every side name a writer could guess: this process's pid, and a spread
// of others, all pointing at the victim.
for _, pid := range []int{os.Getpid(), 1, 2, 100, 1000} {
side := filepath.Join(store, rel+".tmp-"+strconv.Itoa(pid))
if err := os.Symlink(filepath.Join("..", "..", ".ssh", "authorized_keys"), side); err != nil {
t.Fatal(err)
}
}
r, err := os.OpenRoot(store)
if err != nil {
t.Fatal(err)
}
defer r.Close()
if err := dcnRootAtomicWrite(r, rel, []byte(`{"state":"ok"}`)); err != nil {
t.Fatalf("report write: %v", err)
}
if got, _ := os.ReadFile(victim); string(got) != "ssh-ed25519 AAAAexample user@example\n" {
t.Fatalf("the report write followed a planted link: the victim now holds %q", got)
}
if got, err := os.ReadFile(filepath.Join(store, rel)); err != nil || string(got) != `{"state":"ok"}` {
t.Fatalf("report not in place: %q %v", got, err)
}
if fi, err := os.Lstat(filepath.Join(store, rel)); err != nil || fi.Mode()&os.ModeSymlink != 0 || fi.Mode().Perm() != 0o600 {
t.Fatalf("report is not a 0600 regular file: %v %v", fi, err)
}
}
// A grant installed before pins existed has no root_real. It still works,
// pins where its folder leads at first use, keeps that pin, and a repoint
// after that is refused like any other.
func TestDcnGrantFromBeforePinsPinsAtFirstUse(t *testing.T) {
fx := newDcnStoreFixture(t)
fx.sync(t)
f, err := dcnLoadFile(fx.dir)
if err != nil {
t.Fatal(err)
}
rec := f.Stores["1"]
rec.RootReal = ""
f.Stores["1"] = rec
if err := dcnSaveFile(fx.dir, f); err != nil {
t.Fatal(err)
}
if got, why, exit := fx.read(t, "a.txt"); exit != 0 || got != "MINE" {
t.Fatalf("a grant from before pins no longer reads: exit %d %q %s", exit, got, why)
}
f, err = dcnLoadFile(fx.dir)
if err != nil {
t.Fatal(err)
}
want, _ := filepath.EvalSymlinks(fx.store)
if got := f.Stores["1"].RootReal; got != want {
t.Fatalf("first use pinned %q, want %q", got, want)
}
fx.repoint(t)
if got, _, exit := fx.read(t, "a.txt"); exit == 0 || got == "OTHER" {
t.Fatalf("after the first-use pin a repointed folder was read: exit %d %q", exit, got)
}
}
+199
View File
@@ -0,0 +1,199 @@
package main
// dcn_store.go — every byte a machine-store op touches is reached through ONE
// handle on the folder the person granted.
//
// WHY. The bastion is often root (a networked install, the macOS and Windows
// system service), and the granted folder is often someone else's. Checking a
// path and then opening it by name leaves two ways out of the store for
// whoever can write in it or above it:
//
// - the granted folder itself turned into a link to another folder after the
// grant. The old check resolved the root again on every op and judged the
// path against wherever it led NOW, so no race was needed;
// - a file or folder inside the store swapped for a link between the check
// and the open (or the rename, for a move plan).
//
// So: the folder's real path is PINNED at grant sync (rec.RootReal, this box's
// own field, outside the signed bytes), an op whose root now leads elsewhere
// is refused, and the op opens the pinned folder as an os.Root, which never
// follows a link out of it, whatever happens to the names afterwards. That
// handle is then checked to be the folder at the pinned path reached with no
// link at all (dcnNoLinkStat: an open that refuses a link in every component
// on Linux and macOS), so a swap of a folder above the store between the two
// opens is refused too.
import (
"crypto/rand"
"encoding/hex"
"errors"
"fmt"
"io/fs"
"os"
"path/filepath"
"strconv"
)
// errDcnRepointed is the refusal for a granted folder that leads elsewhere now.
var errDcnRepointed = errors.New("the granted folder now leads somewhere other than the folder that was granted; " +
"a new grant for it is the repair")
// dcnRealRoot is where the grant's root leads now: its links resolved.
func dcnRealRoot(root string) (string, error) {
real, err := filepath.EvalSymlinks(filepath.Clean(root))
if err != nil {
return "", err
}
if !filepath.IsAbs(real) {
return "", errors.New("the granted folder is not an absolute path")
}
return filepath.Clean(real), nil
}
// dcnPinFor is the real root a sync records: the one already pinned for the
// same root while the store is held (a re-sync, a renewed grant), else where
// the root leads now ("" when it cannot be resolved yet; pinned at first use).
func dcnPinFor(prev *dcnGrantRec, prevRoot, root string) string {
if prev != nil && prev.RootReal != "" && filepath.Clean(prevRoot) == filepath.Clean(root) {
return prev.RootReal
}
real, err := dcnRealRoot(root)
if err != nil {
return ""
}
return real
}
// dcnStorePin is the pinned real root of a held store, pinning it now (and
// saving it) for a grant synced before pins existed.
func dcnStorePin(dir string, storeID int64, root string) (string, error) {
grantsMu.Lock()
defer grantsMu.Unlock()
f, err := dcnLoadFile(dir)
if err != nil {
return "", err
}
key := strconv.FormatInt(storeID, 10)
rec, ok := f.Stores[key]
if !ok {
return "", errors.New("no grant for this store on this box")
}
if rec.RootReal != "" {
return rec.RootReal, nil
}
real, err := dcnRealRoot(root)
if err != nil {
return "", err
}
rec.RootReal = real
f.Stores[key] = rec
if err := dcnSaveFile(dir, f); err != nil {
return "", err
}
return real, nil
}
// dcnOpenStore opens the store a verified grant names, as the folder that was
// granted, or refuses.
func dcnOpenStore(dir string, storeID int64, terms *dcnTerms) (*os.Root, error) {
pin, err := dcnStorePin(dir, storeID, terms.Root)
if err != nil {
return nil, fmt.Errorf("the granted folder cannot be opened: %w", err)
}
real, err := dcnRealRoot(terms.Root)
if err != nil {
return nil, fmt.Errorf("the granted folder cannot be opened: %w", err)
}
if real != pin {
return nil, errDcnRepointed
}
return dcnOpenRootAt(pin)
}
// dcnOpenRootAt opens real (a resolved, absolute path) as an os.Root and
// checks that the handle is the folder reached at real with no link in any
// component, so nothing above the folder was swapped while it was opened.
func dcnOpenRootAt(real string) (*os.Root, error) {
r, err := os.OpenRoot(real)
if err != nil {
return nil, fmt.Errorf("the granted folder cannot be opened: %w", err)
}
rfi, err := r.Stat(".")
if err != nil {
_ = r.Close()
return nil, fmt.Errorf("the granted folder cannot be opened: %w", err)
}
nfi, err := dcnNoLinkStat(real)
if err != nil || !nfi.IsDir() || !os.SameFile(rfi, nfi) {
_ = r.Close()
return nil, errDcnRepointed
}
return r, nil
}
// dcnRel is a path the sandbox accepted (cleanRel/dcnResolvePath's joined
// form) as a name inside the root handle.
func dcnRel(root, joined string) (string, error) {
rel, err := filepath.Rel(filepath.Clean(root), joined)
if err != nil || rel == ".." || filepath.IsAbs(rel) || len(rel) >= 3 && rel[:3] == ".."+string(os.PathSeparator) {
return "", errors.New("path escapes the store root")
}
return rel, nil
}
// dcnEscaped: the root handle refused a name because it leads out of the store.
func dcnEscaped(err error) bool {
var pe *os.PathError
return errors.As(err, &pe) && pe.Err != nil && pe.Err.Error() == "path escapes from parent"
}
// dcnRootAtomicWrite is atomicWrite inside the store's handle: folders 0700,
// the file 0600, written beside its name and renamed into place.
func dcnRootAtomicWrite(r *os.Root, rel string, data []byte) error {
if d := filepath.Dir(rel); d != "." {
if err := r.MkdirAll(d, 0o700); err != nil {
return err
}
}
// The side name is unguessable and opened O_EXCL, as atomicWrite's
// CreateTemp is: whoever can write in the store could otherwise plant a
// link at a guessable name, and an open that follows it would truncate
// and fill whatever file in the store the link names. O_EXCL refuses any
// existing name, a link included, without following it.
var f *os.File
var tmp string
for try := 0; ; try++ {
var nb [12]byte
if _, err := rand.Read(nb[:]); err != nil {
return err
}
tmp = filepath.Join(filepath.Dir(rel), ".dcn-"+hex.EncodeToString(nb[:])+".tmp")
var err error
f, err = r.OpenFile(tmp, os.O_WRONLY|os.O_CREATE|os.O_EXCL, 0o600)
if err == nil {
break
}
if !errors.Is(err, fs.ErrExist) || try >= 8 {
return err
}
}
if _, err := f.Write(data); err != nil {
_ = f.Close()
_ = r.Remove(tmp)
return err
}
if err := f.Sync(); err != nil {
_ = f.Close()
_ = r.Remove(tmp)
return err
}
if err := f.Close(); err != nil {
_ = r.Remove(tmp)
return err
}
if err := r.Rename(tmp, rel); err != nil {
_ = r.Remove(tmp)
return err
}
return nil
}
+21
View File
@@ -0,0 +1,21 @@
//go:build darwin
package main
import (
"os"
"golang.org/x/sys/unix"
)
// dcnNoLinkStat describes the directory at p opened with O_NOFOLLOW_ANY, which
// fails on a link in any component (macOS 11 and later).
func dcnNoLinkStat(p string) (os.FileInfo, error) {
fd, err := unix.Open(p, unix.O_RDONLY|unix.O_DIRECTORY|unix.O_NOFOLLOW_ANY|unix.O_CLOEXEC, 0)
if err != nil {
return nil, err
}
f := os.NewFile(uintptr(fd), p)
defer f.Close()
return f.Stat()
}
+48
View File
@@ -0,0 +1,48 @@
//go:build linux
package main
import (
"errors"
"os"
"strings"
"golang.org/x/sys/unix"
)
// dcnNoLinkStat describes the directory at p (absolute, clean) reached one
// component at a time with O_NOFOLLOW, so a link anywhere in the path fails
// instead of being followed. O_PATH: a component the bastion may traverse but
// not list (a home at 0711) still opens.
func dcnNoLinkStat(p string) (os.FileInfo, error) {
if !strings.HasPrefix(p, "/") {
return nil, errors.New("not an absolute path")
}
fd, err := unix.Open("/", unix.O_PATH|unix.O_DIRECTORY|unix.O_CLOEXEC, 0)
if err != nil {
return nil, err
}
for _, c := range strings.Split(p, "/") {
if c == "" {
continue
}
if c == "." || c == ".." {
_ = unix.Close(fd)
return nil, errors.New("not a clean path")
}
next, err := unix.Openat(fd, c, unix.O_PATH|unix.O_NOFOLLOW|unix.O_DIRECTORY|unix.O_CLOEXEC, 0)
_ = unix.Close(fd)
if err != nil {
return nil, err
}
var st unix.Stat_t
if err := unix.Fstat(next, &st); err != nil || st.Mode&unix.S_IFMT != unix.S_IFDIR {
_ = unix.Close(next)
return nil, errors.New("a component is not a directory")
}
fd = next
}
f := os.NewFile(uintptr(fd), p)
defer f.Close()
return f.Stat()
}
+14
View File
@@ -0,0 +1,14 @@
//go:build !linux && !darwin
package main
import "os"
// dcnNoLinkStat on a platform with no open that refuses a link in every
// component (Windows): the final component is judged without following it.
// The store is still reached only through its os.Root and only while its real
// path matches the pin; what this leaves is a swap of a folder above the
// store, by someone who can rename it, timed between the two opens.
func dcnNoLinkStat(p string) (os.FileInfo, error) {
return os.Lstat(p)
}
+16 -19
View File
@@ -20,9 +20,9 @@ package main
import ( import (
"context" "context"
"encoding/json"
"errors" "errors"
"fmt" "fmt"
"io"
"os" "os"
"sort" "sort"
"strings" "strings"
@@ -675,53 +675,50 @@ func runDeltaRefresh(ctx context.Context) {
// ── the operator's own eyes ───────────────────────────────────────────────── // ── the operator's own eyes ─────────────────────────────────────────────────
func cmdObserveDelta(asJSON bool) error { func cmdObserveDelta(asJSON bool) error {
if err := requireMachineAuthority("observe:delta"); err != nil { args := []string{"diff"}
return err
}
r := deltaPass(&digestCache{}, time.Now(), deltaRoleOperator)
if asJSON { if asJSON {
b, err := json.MarshalIndent(r, "", " ") args = append(args, "--json")
if err != nil {
return err
} }
fmt.Println(string(b)) return cmdBaseline(args)
return nil
} }
// printDelta is `baseline diff` in words.
func printDelta(w io.Writer, r deltaReport) error {
switch r.Baseline { switch r.Baseline {
case deltaBaselineNone: case deltaBaselineNone:
return errors.New("this machine has no accounting to compare against — " + return errors.New("this machine has no accounting to compare against — " +
"`privatae-bastion observe:baseline` takes one (as an administrator)") "`privatae-bastion observe:baseline` takes one (as an administrator)")
case deltaBaselineEdit: case deltaBaselineEdit:
fmt.Printf("WARNING: the accounting has been changed since it was taken — " + fmt.Fprintf(w, "WARNING: the accounting has been changed since it was taken — "+
"what follows is measured against an edited file\n") "what follows is measured against an edited file\n")
} }
fmt.Printf("%d findings against the accounting taken %s (%s), from %d processes in %s\n", fmt.Fprintf(w, "%d findings against the accounting taken %s (%s), from %d processes in %s\n",
len(r.Findings), r.BaselineTakenAt, r.Coverage, r.Scanned, r.Elapsed) len(r.Findings), r.BaselineTakenAt, r.Coverage, r.Scanned, r.Elapsed)
switch { switch {
case r.WalkFailed != "" && len(r.Findings) > 0: case r.WalkFailed != "" && len(r.Findings) > 0:
// The binary rung read the disk; everything else did not happen. Said // The binary rung read the disk; everything else did not happen. Said
// so that the finding below is not discounted by "nothing was compared". // so that the finding below is not discounted by "nothing was compared".
fmt.Printf("the process walk failed this pass (%s): only the bastion-binary check ran — "+ fmt.Fprintf(w, "the process walk failed this pass (%s): only the bastion-binary check ran — "+
"the finding(s) below are real; nothing else was compared\n", r.WalkFailed) "the finding(s) below are real; nothing else was compared\n", r.WalkFailed)
case r.WalkFailed != "": case r.WalkFailed != "":
// The one sentence a failed walk must never print is the all-clear. // The one sentence a failed walk must never print is the all-clear.
fmt.Printf("NOTHING WAS COMPARED: the process walk failed this pass (%s) — "+ fmt.Fprintf(w, "NOTHING WAS COMPARED: the process walk failed this pass (%s) — "+
"the zero above means nothing looked, not that nothing differs\n", r.WalkFailed) "the zero above means nothing looked, not that nothing differs\n", r.WalkFailed)
case len(r.Findings) == 0: case len(r.Findings) == 0:
fmt.Printf("nothing on this machine is outside what was accounted for\n") fmt.Fprintf(w, "nothing on this machine is outside what was accounted for\n")
} }
for _, ev := range r.Findings { for _, ev := range r.Findings {
fmt.Printf(" %-8s %-20s %s\n", ev.Level, ev.Kind, deltaOneLine(ev)) fmt.Fprintf(w, " %-8s %-20s %s\n", ev.Level, ev.Kind, deltaOneLine(ev))
for _, e := range ev.Evidence { for _, e := range ev.Evidence {
fmt.Printf(" %-12s %s\n", e.Tier, e.Signal+": "+e.Value) fmt.Fprintf(w, " %-12s %s\n", e.Tier, e.Signal+": "+e.Value)
} }
} }
if r.ShortLived > 0 || len(r.Filtered) > 0 { if r.ShortLived > 0 || len(r.Filtered) > 0 {
fmt.Printf("%d filtered as ordinary (%d came and went before they were old enough to report; %d since the accounting)\n", fmt.Fprintf(w, "%d filtered as ordinary (%d came and went before they were old enough to report; %d since the accounting)\n",
len(r.Filtered), r.ShortLived, r.ShortLivedTotal) len(r.Filtered), r.ShortLived, r.ShortLivedTotal)
} }
for _, n := range r.Notes { for _, n := range r.Notes {
fmt.Printf(" note: %s\n", n) fmt.Fprintf(w, " note: %s\n", n)
} }
return nil return nil
} }
+75 -12
View File
@@ -33,6 +33,7 @@ import (
"encoding/json" "encoding/json"
"errors" "errors"
"fmt" "fmt"
"io"
"os" "os"
"path/filepath" "path/filepath"
"sort" "sort"
@@ -847,29 +848,80 @@ func deviceShownPath() (string, error) {
return filepath.Join(d, "device_shown.json"), nil return filepath.Join(d, "device_shown.json"), nil
} }
func cmdDeviceApprovals() error { // deviceAsk is one ask waiting on this approval device.
type deviceAsk struct {
ID string `json:"id"`
Server string `json:"server"`
At string `json:"at"`
Words string `json:"words"`
}
type deviceApprovalsRead struct {
Asks []deviceAsk `json:"asks"`
}
func readDeviceApprovals(readOpts) (deviceApprovalsRead, error) {
deviceMu.Lock() deviceMu.Lock()
m := deviceRequestsLoad() m := deviceRequestsLoad()
deviceMu.Unlock() deviceMu.Unlock()
shown := []string{} v := deviceApprovalsRead{Asks: []deviceAsk{}}
for _, id := range sortedDeviceRequests(m) { for _, id := range sortedDeviceRequests(m) {
r := m[id] r := m[id]
if r.State != "pending" { if r.State != "pending" {
continue continue
} }
shown = append(shown, id) v.Asks = append(v.Asks, deviceAsk{ID: id, Server: r.Server, At: r.At, Words: r.Words})
fmt.Printf("[%s] on %s, asked %s\n%s\n\n", id[:8], r.Server, r.At, r.Words) }
return v, nil
}
// cmdDeviceApprovals lists the asks waiting here. Read in words by this
// process, it records them as shown, which is all `device-approve all` will
// sign. --json is for a program, not a person, and records nothing; nor does
// a list read through the lane, which `device-approve` from this account
// would not find.
func cmdDeviceApprovals(args []string) error {
asJSON, err := jsonOnly("usage: privatae-bastion device-approvals [--json]", args)
if err != nil {
return err
}
lane := readsGoThroughLane()
v, err := readMachine("device-approvals", readOpts{}, readDeviceApprovals)
if err != nil {
return laneRefusalError("device-approvals", err)
}
if asJSON {
return printJSON(os.Stdout, v)
}
printDeviceApprovals(os.Stdout, v, lane)
if !lane {
shown := []string{}
for _, a := range v.Asks {
shown = append(shown, a.ID)
} }
if p, err := deviceShownPath(); err == nil { if p, err := deviceShownPath(); err == nil {
raw, _ := json.Marshal(shown) raw, _ := json.Marshal(shown)
_ = atomicWrite(p, raw) _ = atomicWrite(p, raw)
} }
if len(shown) == 0 { }
fmt.Println("nothing is waiting for your approval")
return nil return nil
} }
fmt.Printf("approve one: privatae-bastion device-approve <id> all of the above: privatae-bastion device-approve all\n")
return nil // printDeviceApprovals prints the asks; lane: they were read from the
// machine's bastion, so they are answered as its administrator.
func printDeviceApprovals(w io.Writer, v deviceApprovalsRead, lane bool) {
for _, a := range v.Asks {
fmt.Fprintf(w, "[%s] on %s, asked %s\n%s\n\n", a.ID[:min(8, len(a.ID))], a.Server, a.At, a.Words)
}
switch {
case len(v.Asks) == 0:
fmt.Fprintln(w, "nothing is waiting for your approval")
case lane:
fmt.Fprintln(w, "These wait on the machine's bastion. As the administrator: sudo -H privatae-bastion device-approvals, "+
"then device-approve <id> or device-approve all")
default:
fmt.Fprintln(w, "approve one: privatae-bastion device-approve <id> all of the above: privatae-bastion device-approve all")
}
} }
func cmdDeviceApprove(prefix string) error { return cmdDeviceApproveCode(prefix, "") } func cmdDeviceApprove(prefix string) error { return cmdDeviceApproveCode(prefix, "") }
@@ -947,19 +999,25 @@ func cmdDeviceApproveCode(prefix, code string) error {
return nil return nil
} }
// cmdDeviceDeny refuses one ask waiting on this approval device (through the
// owner's lane beside the machine's bastion: denying takes nothing).
func cmdDeviceDeny(prefix string) error { func cmdDeviceDeny(prefix string) error {
return printOrAct(agentAskRequest{Act: "device-deny", ID: prefix}, "device-deny "+prefix,
func() (string, error) { return deviceDenyText(prefix) })
}
func deviceDenyText(prefix string) (string, error) {
deviceMu.Lock() deviceMu.Lock()
m := deviceRequestsLoad() m := deviceRequestsLoad()
deviceMu.Unlock() deviceMu.Unlock()
id, err := findDeviceRequest(m, prefix) id, err := findDeviceRequest(m, prefix)
if err != nil { if err != nil {
return err return "", err
} }
if err := deviceDeny(id); err != nil { if err := deviceDeny(id); err != nil {
return err return "", err
} }
fmt.Printf("denied %s\n", id) return "denied " + id, nil
return nil
} }
func findDeviceRequest(m map[string]deviceRequest, prefix string) (string, error) { func findDeviceRequest(m map[string]deviceRequest, prefix string) (string, error) {
@@ -995,6 +1053,11 @@ func cmdPinDevice(key string, unpin bool) error {
return err return err
} }
fmt.Println("device key unpinned; approvals signed by it are refused from now on") fmt.Println("device key unpinned; approvals signed by it are refused from now on")
// Every op grant it approved dies with it (ops_bounds.go), dropped
// now so pinning the key again does not bring one back.
if n := opsDropApprovedBy("device:" + strings.TrimSpace(key)); n > 0 {
fmt.Printf("%d op grant(s) it approved dropped\n", n)
}
return nil return nil
} }
if err := pinDeviceKey(key); err != nil { if err := pinDeviceKey(key); err != nil {
+360
View File
@@ -0,0 +1,360 @@
package main
// doctor.go — what is wrong with this install, and the fix for each one
// (plan Addendum 6, slice 3).
//
// privatae-bastion doctor [--json]
//
// Each check is a fact the bastion already holds, said as a problem and the
// command that fixes it. The machine's checks are built where its state is:
// in the daemon for the owner's account, through the lane (reads.go), or
// directly for the administrator and a per-account install. The one thing
// only the asking side can find out is whether the lane answers it at all,
// and that becomes the check when it does not. Exit status 1 when any check
// finds a problem, so a script can branch on it.
import (
"encoding/json"
"errors"
"fmt"
"io"
"os"
"path/filepath"
"runtime"
"sort"
"strings"
"time"
)
const doctorUsage = "usage: privatae-bastion doctor [--json]"
type doctorCheck struct {
Name string `json:"name"`
OK bool `json:"ok"`
Detail string `json:"detail,omitempty"` // what was found, when all is well
Problem string `json:"problem,omitempty"`
Fix string `json:"fix,omitempty"` // the command, or what to do
}
type doctorRead struct {
Version string `json:"version"`
Checks []doctorCheck `json:"checks"`
}
func (d doctorRead) problems() int {
n := 0
for _, c := range d.Checks {
if !c.OK {
n++
}
}
return n
}
// systemInstalled: the bastion is installed for the whole machine.
var systemInstalled = func() bool {
if runtime.GOOS == "linux" {
return linuxSystemUnitPresent()
}
return systemService.installed
}
// doctorSandbox is opSandboxAvailable, replaceable in a test: its probe
// re-executes this binary.
var doctorSandbox = opSandboxAvailable
// asAdmin is a bastion command said the way it has to be typed here: the
// machine's bastion keeps its state as the administrator when it is
// installed for the whole machine.
func asAdmin(cmd string) string {
switch {
case !systemInstalled():
return "privatae-bastion " + cmd
case runtime.GOOS == "windows":
return "privatae-bastion " + cmd + " (from an Administrator terminal)"
}
return "sudo -H privatae-bastion " + cmd
}
// installerCommand is how this platform installs the bastion, and so how a
// machine no Host updates moves to a newer version.
func installerCommand() string {
if runtime.GOOS == "windows" {
return "irm https://privatae.ai/bastion/install.ps1 | iex"
}
return "curl -fsSL https://privatae.ai/bastion/install.sh | sh"
}
// doctorLatest is the newest published version, or "" when it cannot be
// known: the daemon's last answer, else the last time doctor asked
// privatae.ai, if that was within updateCheckEvery, else one fetch that
// waits at most doctorLatestWait. A request to privatae.ai carries this
// machine's address to the platform, so doctor keeps update.go's rate
// (four a day): a run in its own process, or an agent polling it, asks again
// only once that time has passed, whether the last ask was answered or not.
// Running with no route to privatae.ai is supported (update.go), so "" is
// not a problem.
var (
doctorLatestWait = 10 * time.Second
doctorLatest = func() string {
latestMu.Lock()
v := latestPublished
latestMu.Unlock()
if v != "" {
return v
}
if r, ok := doctorAskedLoad(); ok && doctorNow().Sub(r.AskedAt) < updateCheckEvery {
return r.Version
}
got := make(chan string, 1)
go func() {
v, err := doctorFetch()
if err != nil {
v = ""
}
got <- strings.TrimSpace(v)
}()
select {
case v = <-got:
case <-time.After(doctorLatestWait):
}
if v != "" {
recordLatestPublished(v)
} else if r, ok := doctorAskedLoad(); ok {
v = r.Version // no answer this time: the last one stands, as in update.go
}
doctorAskedSave(doctorAsked{Version: v, AskedAt: doctorNow()})
return v
}
doctorNow = time.Now
doctorFetch = func() (string, error) {
m, err := fetchManifest()
if err != nil {
return "", err
}
return m.Version, nil
}
)
// doctorAsked is when doctor last asked privatae.ai, and what it knew after.
type doctorAsked struct {
Version string `json:"version"`
AskedAt time.Time `json:"asked_at"`
}
func doctorAskedPath() (string, error) {
d, err := configDir()
if err != nil {
return "", err
}
return filepath.Join(d, "doctor_latest.json"), nil
}
func doctorAskedLoad() (doctorAsked, bool) {
var r doctorAsked
p, err := doctorAskedPath()
if err != nil {
return r, false
}
raw, err := os.ReadFile(p)
if err != nil || json.Unmarshal(raw, &r) != nil || r.AskedAt.IsZero() {
return doctorAsked{}, false
}
return r, true
}
func doctorAskedSave(r doctorAsked) {
p, err := doctorAskedPath()
if err != nil {
return
}
if raw, err := json.Marshal(r); err == nil {
_ = atomicWrite(p, raw)
}
}
// logHint is where the bastion's own log is read on this platform.
func logHint() string {
switch runtime.GOOS {
case "linux":
if systemInstalled() {
return "journalctl -u privatae-bastion"
}
return "journalctl --user -u privatae-bastion"
case "windows":
return "the bastion's window, or Event Viewer when it runs as a service"
}
return "Console.app, process privatae-bastion"
}
func readDoctor(readOpts) (doctorRead, error) {
d := doctorRead{Version: clientVersion, Checks: []doctorCheck{}}
add := func(c doctorCheck) { d.Checks = append(d.Checks, c) }
s, err := readStatus(readOpts{})
if err != nil {
add(doctorCheck{Name: "pairings", Problem: sentenceCase(err.Error()) + ".",
Fix: "The bastion's log says why: " + logHint()})
return d, nil
}
paired := len(s.Pairings) > 0
start := runCommandHint()
if runtime.GOOS == "linux" && systemInstalled() {
start = "sudo " + start
}
switch {
case s.Running == "no":
add(doctorCheck{Name: "running", Problem: "The bastion is not running, so nothing on this machine is watched.",
Fix: start})
case !paired:
add(doctorCheck{Name: "running", OK: true, Detail: "Running on its own; no Host is connected."})
default:
add(doctorCheck{Name: "running", OK: true, Detail: fmt.Sprintf("Running, paired with %d Host(s).", len(s.Pairings))})
}
switch latest := doctorLatest(); {
case latest == "":
add(doctorCheck{Name: "version", OK: true, Detail: "This is " + clientVersion +
"; the latest published version could not be read from privatae.ai."})
case versionNewer(latest, clientVersion):
fix := "Run the installer again: " + installerCommand()
if paired {
fix = "Your Host can update it (Network app, Update), or run the installer again: " + installerCommand()
}
add(doctorCheck{Name: "version", Problem: "Version " + latest + " is published; this machine runs " +
clientVersion + ".", Fix: fix})
default:
add(doctorCheck{Name: "version", OK: true, Detail: clientVersion + " is the latest published version."})
}
if systemInstalled() {
_, name, present, err := ownerAccountLoad()
fix := "sudo -H privatae-bastion approvals-owner --account <your account>"
if runtime.GOOS == "windows" {
fix = "privatae-bastion approvals-owner --sid <your account's SID> (from an Administrator terminal)"
}
switch {
case err != nil:
add(doctorCheck{Name: "owner", Problem: "This machine's owner account cannot be read (" + err.Error() + ").",
Fix: strings.Replace(fix, "approvals-owner ", "approvals-owner --replace ", 1)})
case !present:
add(doctorCheck{Name: "owner", Problem: "No account is recorded as this machine's owner, so the console " +
"opens only for the administrator, and agents in your account can neither read the machine nor ask it " +
"to stop an agent.", Fix: fix})
default:
add(doctorCheck{Name: "owner", OK: true, Detail: "The machine's owner account is " + name + "."})
}
}
factor := existingMachineFactorDir()
if stepupEnrolled(factor) {
add(doctorCheck{Name: "second factor", OK: true, Detail: "The machine's owner has a second factor here."})
} else {
add(doctorCheck{Name: "second factor", Problem: "This machine has no second factor of its own, so a stop, " +
"and every ask an agent files, cannot be approved.", Fix: asAdmin("stepup-enroll --machine")})
}
now := time.Now()
var held []string
for account, e := range askQuarantineLoad(factor) {
if quarantinedAt(e, now) {
held = append(held, account)
}
}
sort.Strings(held)
for _, account := range held {
add(doctorCheck{Name: "held asker", Problem: sentenceCase(askHoldRefusal(account, askHeldUntil(factor, account, now))) + ".",
Fix: asAdmin("quarantine clear --asker " + account)})
}
for _, p := range s.Pairings {
switch {
case p.Problem != "":
add(doctorCheck{Name: "host " + p.Host, Problem: "The pairing with " + p.Host + " is not usable: " +
p.Problem + ".", Fix: "The bastion's log says more: " + logHint()})
case !p.Answering && s.Running != "no":
add(doctorCheck{Name: "host " + p.Host, Problem: "The bastion is not serving " + p.Host +
" (nothing answers on " + p.Local + ").", Fix: "The bastion's log says why: " + logHint()})
}
}
if paired {
localDenyMu.Lock()
_, derr := localDenyLoad()
localDenyMu.Unlock()
if derr != nil {
add(doctorCheck{Name: "switches", Problem: localDenyUnreadableText(derr), Fix: asAdmin("switch --reset")})
}
if ok, why := doctorSandbox(); !ok {
c := doctorCheck{Name: "sandbox", Problem: "Ops a Host sends cannot run sandboxed here: " + why + "."}
if !processIsRoot() {
c.Fix = "Install the bastion for the whole machine: run the installer again without --just-me: " +
installerCommand()
}
add(c)
}
}
return d, nil
}
func cmdDoctor(args []string) error {
asJSON, err := jsonOnly(doctorUsage, args)
if err != nil {
return err
}
d, err := readMachine("doctor", readOpts{}, readDoctor)
var le *laneError
if errors.As(err, &le) {
// The one check the machine cannot make for this account.
d = doctorRead{Version: clientVersion, Checks: []doctorCheck{laneCheck(le)}}
err = nil
}
if err != nil {
return err
}
if asJSON {
if err := printJSON(os.Stdout, d); err != nil {
return err
}
} else {
printDoctor(os.Stdout, d)
}
if d.problems() > 0 {
return quietExit{code: 1}
}
return nil
}
// laneCheck is the lane not answering this account, as a check.
func laneCheck(le *laneError) doctorCheck {
if le.down {
fix := "Start it: sudo " + runCommandHintFor(runtime.GOOS) + " (see whether it runs: systemctl status privatae-bastion)"
if runtime.GOOS != "linux" {
fix = "Start it: " + runCommandHint()
}
return doctorCheck{Name: "running", Problem: "The machine's bastion does not answer this account: " + le.why + ".",
Fix: fix}
}
return doctorCheck{Name: "reads", Problem: sentenceCase(le.why) + ".",
Fix: "As the administrator: sudo -H privatae-bastion doctor"}
}
func printDoctor(w io.Writer, d doctorRead) {
switch n := d.problems(); n {
case 0:
fmt.Fprintf(w, "privatae-bastion %s: nothing wrong found.\n", d.Version)
case 1:
fmt.Fprintf(w, "privatae-bastion %s: 1 problem.\n", d.Version)
default:
fmt.Fprintf(w, "privatae-bastion %s: %d problems.\n", d.Version, n)
}
for _, c := range d.Checks {
if c.OK {
fmt.Fprintln(w, " ok "+c.Detail)
continue
}
fmt.Fprintln(w, " PROBLEM "+c.Problem)
if c.Fix != "" {
fmt.Fprintln(w, " Fix: "+c.Fix)
}
}
}
+79 -46
View File
@@ -6,6 +6,7 @@ import (
"errors" "errors"
"io" "io"
"net" "net"
"net/http"
"strings" "strings"
"time" "time"
) )
@@ -24,94 +25,110 @@ type egressDialer func(ctx context.Context, network, addr string) (net.Conn, err
// egress is refused (403, before any dial) unless its pairing grant carries // egress is refused (403, before any dial) unless its pairing grant carries
// the "egress" cap: this lane makes requests leave THIS machine's connection // the "egress" cap: this lane makes requests leave THIS machine's connection
// under its address, and nothing in the mgmt op table gates it. // under its address, and nothing in the mgmt op table gates it.
func handleEgressConn(client net.Conn, dialOut egressDialer, self string) { //
// It reports whether it took the job: true once the request passed every check
// and was dialled out, whatever the destination then answered; false when the
// worker closed before a request, or the request was malformed or refused. The
// worker pool (runEgressWorkers) parks again at once after a job it took, and
// waits after one it did not.
func handleEgressConn(client net.Conn, dialOut egressDialer, self string) bool {
defer client.Close() defer client.Close()
br := bufio.NewReader(client) // The request line and headers are read under a bound, the one Go's own HTTP
// server uses (http.DefaultMaxHeaderBytes, 1 MiB): the host sends them, and a
// head that never ends must not grow in this machine's memory.
headLim := &io.LimitedReader{R: client, N: egressMaxHeadBytes}
br := bufio.NewReader(headLim)
line, err := br.ReadString('\n') line, err := br.ReadString('\n')
if err != nil { if err != nil {
return return false
} }
parts := strings.Fields(strings.TrimSpace(line)) parts := strings.Fields(strings.TrimSpace(line))
if len(parts) < 2 { if len(parts) < 2 {
return return false
} }
method, target := parts[0], parts[1] method, target := parts[0], parts[1]
// Buffer the head so a plain-HTTP request can be replayed verbatim; capture Host. // Buffer the head: a plain-HTTP request is parsed from it and rebuilt
// (parseEgressRequest), never replayed verbatim.
var head strings.Builder var head strings.Builder
head.WriteString(line) head.WriteString(line)
hostHdr := ""
for { for {
h, err := br.ReadString('\n') h, err := br.ReadString('\n')
if err != nil { if err != nil {
return return false
} }
head.WriteString(h) head.WriteString(h)
if h == "\r\n" || h == "\n" { if h == "\r\n" || h == "\n" {
break break
} }
if len(h) >= 5 && strings.EqualFold(h[:5], "host:") {
hostHdr = strings.TrimSpace(h[5:])
}
} }
// The head is in; what follows is the stream itself, unbounded. What the
// reader already buffered past the head stays first in line.
headLim.N = 1<<63 - 1
if why := capsAllow(self, "egress"); why != "" { if why := capsAllow(self, "egress"); why != "" {
_, _ = client.Write([]byte("HTTP/1.1 403 Forbidden\r\nContent-Length: 0\r\nX-Privatae-Refused: " + why + "\r\n\r\n")) writeEgressRefusal(client, "403 Forbidden", why, why)
return return false
} }
ctx, cancel := context.WithTimeout(context.Background(), egressDialTimeout) ctx, cancel := context.WithTimeout(context.Background(), egressDialTimeout)
defer cancel() defer cancel()
if strings.EqualFold(method, "CONNECT") { if strings.EqualFold(method, "CONNECT") {
dialAddrs, why := egressVettedAddrs(ctx, ensurePort(target, "443")) // The target is read the way the Host's egress gate reads it
// (parseEgressAuthority): userinfo, an unbracketed IPv6 literal or a
// malformed port is refused, never guessed at.
host, port, ok := parseEgressAuthority(target, 443)
if !ok {
writeEgressRefusal(client, "400 Bad Request", egressNoHost, egressNoHost)
return false
}
dialAddrs, why := egressVettedAddrs(ctx, egressHostPort(host, port))
if why != "" { if why != "" {
_, _ = client.Write([]byte("HTTP/1.1 403 Forbidden\r\nContent-Length: 0\r\nX-Privatae-Refused: " + why + "\r\n\r\n")) writeEgressRefusal(client, "403 Forbidden", why, why)
return return false
} }
upstream, err := dialEach(ctx, dialOut, dialAddrs) upstream, err := dialEach(ctx, dialOut, dialAddrs)
if err != nil { if err != nil {
_, _ = client.Write([]byte("HTTP/1.1 502 Bad Gateway\r\nContent-Length: 0\r\n\r\n")) writeEgressRefusal(client, "502 Bad Gateway", egressUnreachable, "")
return return true
} }
if _, err := client.Write([]byte("HTTP/1.1 200 Connection established\r\n\r\n")); err != nil { if _, err := client.Write([]byte("HTTP/1.1 200 Connection established\r\n\r\n")); err != nil {
_ = upstream.Close() _ = upstream.Close()
return return true
} }
splice(br, client, upstream) splice(br, client, upstream)
return return true
} }
// Plain HTTP, absolute-form: "GET http://host/path HTTP/1.1". // Plain HTTP: ONE request per connection, parsed and rebuilt so the
host := hostHdr // destination reads the host, port and body the lane vetted, sent with
if i := strings.Index(target, "://"); i >= 0 { // `Connection: close` (egress_http.go). Anything the Host sends after that
rest := target[i+3:] // request's body closes the connection unforwarded: a keep-alive connection
if s := strings.IndexByte(rest, '/'); s >= 0 { // can no longer carry later requests past the vetting.
host = rest[:s] req, refused := parseEgressRequest(head.String())
} else { if refused != nil {
host = rest writeEgressRefusal(client, refused.status, refused.body, refused.body)
return false
} }
} dialAddrs, why := egressVettedAddrs(ctx, egressHostPort(req.host, req.port))
if host == "" {
return
}
dialAddrs, why := egressVettedAddrs(ctx, ensurePort(host, "80"))
if why != "" { if why != "" {
_, _ = client.Write([]byte("HTTP/1.1 403 Forbidden\r\nContent-Length: 0\r\nX-Privatae-Refused: " + why + "\r\n\r\n")) writeEgressRefusal(client, "403 Forbidden", why, why)
return return false
} }
upstream, err := dialEach(ctx, dialOut, dialAddrs) upstream, err := dialEach(ctx, dialOut, dialAddrs)
if err != nil { if err != nil {
_, _ = client.Write([]byte("HTTP/1.1 502 Bad Gateway\r\nContent-Length: 0\r\n\r\n")) writeEgressRefusal(client, "502 Bad Gateway", egressUnreachable, "")
return return true
} }
if _, err := upstream.Write([]byte(head.String())); err != nil { oneEgressExchange(br, client, upstream, req)
_ = upstream.Close() return true
return
}
splice(br, client, upstream)
} }
// egressMaxHeadBytes bounds an egress request's line and headers together.
const egressMaxHeadBytes = http.DefaultMaxHeaderBytes
// ensurePort returns host:port, adding defPort when target has no explicit port. // ensurePort returns host:port, adding defPort when target has no explicit port.
func ensurePort(target, defPort string) string { func ensurePort(target, defPort string) string {
target = strings.TrimSpace(target) target = strings.TrimSpace(target)
@@ -157,11 +174,14 @@ func splice(clientReader io.Reader, client, upstream net.Conn) {
// included), and any address the machine takes as its own (ownaddr.go), such // included), and any address the machine takes as its own (ownaddr.go), such
// as a public one on its NIC or a range a `local` route delivers here. // as a public one on its NIC or a range a `local` route delivers here.
// //
// What differs is the network around it. On an ANCHORED box the lane reaches // The network around it is refused too, on every box: the lane reaches the
// the public internet and nothing else: private, CGNAT and reserved addresses // public internet and nothing else, so private, CGNAT and reserved addresses
// (the LAN, the mesh) are refused too. On a LOCAL box the LAN stays reachable: // (the LAN, the mesh) are refused, by address and by any address a name
// the host there is the one the person paired, and their own network is // resolves to. A LOCAL box used to keep its LAN reachable here; it no longer
// theirs to reach. // does (2026-10-26): the Host's egress gate holds every dial it makes to the
// same rule, and a person's own machines
// are reached through their approved lanes, never through egress. Only the
// wording differs between the two kinds of box.
// //
// Resolution failures refuse too: a name this box cannot resolve is not one // Resolution failures refuse too: a name this box cannot resolve is not one
// it can vouch for. // it can vouch for.
@@ -245,6 +265,19 @@ func egressVettedAddrs(ctx context.Context, hostport string) ([]string, string)
} }
return nil, "refused: egress to " + host + " — that is this machine; this lane never reaches this machine" return nil, "refused: egress to " + host + " — that is this machine; this lane never reaches this machine"
} }
// The network around this machine, on a local box as on an anchored one
// (above): any one address of the name that is not the public internet
// refuses it. Checked after this machine's own addresses, so those keep
// saying "that is this machine".
if !anchored {
for _, ip := range addrs {
if internalIP(ip) {
return nil, "refused: egress to " + host + " (" + ip.String() + ") — this lane reaches the " +
"public internet only, never this machine's network or the mesh; reach your own " +
"machines through their approved lanes"
}
}
}
out := make([]string, 0, len(addrs)) out := make([]string, 0, len(addrs))
for _, ip := range addrs { for _, ip := range addrs {
out = append(out, net.JoinHostPort(ip.String(), port)) out = append(out, net.JoinHostPort(ip.String(), port))
+420
View File
@@ -0,0 +1,420 @@
package main
import (
"bufio"
"errors"
"io"
"net"
"net/http/httputil"
"strconv"
"strings"
)
// ONE plain-HTTP request per egress connection, read the way the Host's egress
// gate reads it (its strict request parse and its authority parse: the same
// refusals, the same normalised host, the same rebuilt head).
//
// Everything the lane writes to a destination is what it checked, and nothing
// more:
// - the head is parsed strictly and REBUILT, so the destination reads the same
// host, port and body length the lane vetted: never a second reading of the
// Host's bytes (a Host header naming another site, a query or userinfo glued
// to the host, a padded Transfer-Encoding);
// - the request goes out with `Connection: close`, its body is framed by
// Content-Length or chunked encoding, and a byte the Host sends after the
// body closes the connection with nothing of it forwarded. Before this the
// lane wrote the first head and then spliced the whole connection, so every
// later request on a keep-alive connection reached the destination unread.
//
// An honest client sends its next request only after the response, which the
// destination closes behind `Connection: close`, so it opens a new connection
// and meets the vetting again.
// egressHostChars are the characters a host name may have here (lower-cased).
const egressHostChars = "abcdefghijklmnopqrstuvwxyz0123456789-._"
// egressTokenChars are RFC 9110 token characters: methods and header names.
const egressTokenChars = "!#$%&'*+-.^_`|~0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
// egressHopByHop are headers that belong to one hop. The lane speaks for itself
// on the next one, and a proxy credential never goes on to the destination.
var egressHopByHop = map[string]bool{
"connection": true, "proxy-connection": true, "keep-alive": true, "upgrade": true,
"te": true, "trailer": true, "proxy-authorization": true, "proxy-authenticate": true,
}
// egressTrailerLimit bounds the trailer section of a chunked body, which is
// read to its end and dropped (the gate's limit).
const egressTrailerLimit = 8192
// egressRefusal is a request the lane refuses before it dials anything.
type egressRefusal struct{ status, body string }
func egressBad(body string) *egressRefusal {
return &egressRefusal{"400 Bad Request", body}
}
const egressNoHost = "The bastion could not read where this request is going (no host in the " +
"request line or in a Host header), so it sent nothing."
// egressUnreachable is the body of a 502: the destination passed the vetting,
// and no address of it answered from this machine.
const egressUnreachable = "The bastion could not reach that destination from this machine's own " +
"connection, so nothing was sent."
// egressHostPort is host and port as the vetting takes them.
func egressHostPort(host string, port int) string {
return net.JoinHostPort(host, strconv.Itoa(port))
}
// writeEgressRefusal answers the Host with a status and a short plain-text
// body saying why, and closes the exchange. why, when set, also goes in
// X-Privatae-Refused, the header the Host already reads.
func writeEgressRefusal(w io.Writer, status, body, why string) {
body += "\n"
var b strings.Builder
b.WriteString("HTTP/1.1 " + status + "\r\n")
b.WriteString("Content-Type: text/plain; charset=utf-8\r\n")
b.WriteString("Content-Length: " + strconv.Itoa(len(body)) + "\r\n")
b.WriteString("Connection: close\r\n")
if why != "" {
b.WriteString("X-Privatae-Refused: " + strings.NewReplacer("\r", " ", "\n", " ").Replace(why) + "\r\n")
}
b.WriteString("\r\n")
b.WriteString(body)
_, _ = io.WriteString(w, b.String())
}
// parseEgressAuthority: (host, port, true) from "host", "host:port", "[v6]" or
// "[v6]:port", or false when the lane can't read it exactly as the destination
// would. Refused rather than guessed: userinfo ("a@b"), an unbracketed IPv6
// literal, characters no host name has, a non-numeric or out-of-range port.
// The host is lower-cased and loses one trailing dot.
func parseEgressAuthority(s string, defaultPort int) (string, int, bool) {
s = strings.TrimSpace(s)
if s == "" || strings.Contains(s, "@") {
return "", 0, false
}
var host string
port := defaultPort
digits := func(p string) bool {
if len(p) == 0 || len(p) > 5 {
return false
}
for _, c := range p {
if c < '0' || c > '9' {
return false
}
}
return true
}
if strings.HasPrefix(s, "[") {
end := strings.IndexByte(s, ']')
if end < 0 {
return "", 0, false
}
// An IPv6 literal, IPv4-mapped forms included (the vetting judges the
// address they map to); a bare IPv4 address in brackets or a zone is
// not one.
inner := s[1:end]
ip := net.ParseIP(inner)
if ip == nil || !strings.Contains(inner, ":") || strings.Contains(inner, "%") {
return "", 0, false
}
host = ip.String()
rest := s[end+1:]
switch {
case rest == "":
case strings.HasPrefix(rest, ":") && digits(rest[1:]):
port, _ = strconv.Atoi(rest[1:])
default:
return "", 0, false
}
} else {
if strings.Count(s, ":") > 1 {
return "", 0, false
}
h, p, hasPort := strings.Cut(s, ":")
if hasPort {
if !digits(p) {
return "", 0, false
}
port, _ = strconv.Atoi(p)
}
h = strings.ToLower(h)
h = strings.TrimSuffix(h, ".")
if h == "" || strings.HasPrefix(h, ".") || strings.Contains(h, "..") {
return "", 0, false
}
for _, c := range h {
if !strings.ContainsRune(egressHostChars, c) {
return "", 0, false
}
}
host = h
}
if port <= 0 || port >= 65536 {
return "", 0, false
}
return host, port, true
}
// fmtEgressAuthority writes host[:port] back, the port left out when it is the
// scheme's default.
func fmtEgressAuthority(host string, port, defaultPort int) string {
h := host
if strings.Contains(host, ":") {
h = "[" + host + "]"
}
if port == defaultPort {
return h
}
return h + ":" + strconv.Itoa(port)
}
// egressRequest is the one plain-HTTP request the lane forwards.
type egressRequest struct {
host string
port int
head []byte // rebuilt, CRLF, ends at its blank line
chunked bool
length int64
}
func egressTokenOK(s string) bool {
if s == "" {
return false
}
for _, c := range s {
if !strings.ContainsRune(egressTokenChars, c) {
return false
}
}
return true
}
// parseEgressRequest reads the one request in head (the request line and
// headers through their blank line, as handleEgressConn read them) and
// rebuilds it, or refuses it. CONNECT never comes here.
func parseEgressRequest(head string) (egressRequest, *egressRefusal) {
lines := strings.Split(head, "\n")
// The read stops at the first blank line, so the head ends "\n", blank, "\n":
// drop the empty tail after the last "\n" and the blank line itself.
if len(lines) < 3 {
return egressRequest{}, egressBad("The request ended before its headers did, so the bastion sent nothing.")
}
lines = lines[:len(lines)-2]
for i, ln := range lines {
lines[i] = strings.TrimSuffix(ln, "\r")
if strings.ContainsAny(lines[i], "\r\x00") {
return egressRequest{}, egressBad("The request's headers carry a stray carriage return or NUL, so the bastion sent nothing.")
}
}
parts := strings.Split(lines[0], " ")
if len(parts) != 3 || parts[0] == "" || parts[1] == "" || parts[2] == "" || !egressTokenOK(parts[0]) {
return egressRequest{}, egressBad("The request line is not 'METHOD target HTTP/1.x', so the bastion sent nothing.")
}
method, rawTarget, version := strings.ToUpper(parts[0]), parts[1], parts[2]
if version != "HTTP/1.1" && version != "HTTP/1.0" {
return egressRequest{}, egressBad("The bastion forwards HTTP/1.0 and HTTP/1.1 only, so it sent nothing.")
}
type header struct{ name, value string }
var headers []header
for _, ln := range lines[1:] {
if strings.HasPrefix(ln, " ") || strings.HasPrefix(ln, "\t") {
return egressRequest{}, egressBad("A header is folded onto a second line (obsolete line folding), so the bastion sent nothing.")
}
name, value, ok := strings.Cut(ln, ":")
if !ok || !egressTokenOK(name) {
return egressRequest{}, egressBad("A header line is not 'Name: value' (no space may come before the colon), so the bastion sent nothing.")
}
headers = append(headers, header{name, strings.Trim(value, " \t")})
}
values := func(n string) []string {
var out []string
for _, h := range headers {
if strings.EqualFold(h.name, n) {
out = append(out, h.value)
}
}
return out
}
hosts := values("host")
if len(hosts) > 1 {
return egressRequest{}, egressBad("The request carries more than one Host header, so the bastion sent nothing.")
}
var host, target, authority string
var port int
if scheme, after, abs := strings.Cut(rawTarget, "://"); abs {
if strings.ToLower(scheme) != "http" {
// https:// in absolute form asks the lane to make the TLS connection,
// which it does not do: it used to send the request in plain text to
// port 80. Every client sends https as a CONNECT.
return egressRequest{}, egressBad("The bastion forwards plain http:// requests only; send https as a CONNECT. Nothing was sent.")
}
cut := len(after)
for _, sep := range []string{"/", "?", "#"} {
if i := strings.Index(after, sep); i >= 0 && i < cut {
cut = i
}
}
var ok bool
if host, port, ok = parseEgressAuthority(after[:cut], 80); !ok {
return egressRequest{}, egressBad(egressNoHost)
}
path, _, _ := strings.Cut(after[cut:], "#")
if !strings.HasPrefix(path, "/") {
path = "/" + path
}
authority = fmtEgressAuthority(host, port, 80)
target = "http://" + authority + path
} else {
if !strings.HasPrefix(rawTarget, "/") && rawTarget != "*" {
return egressRequest{}, egressBad(egressNoHost)
}
hostHdr := ""
if len(hosts) == 1 {
hostHdr = hosts[0]
}
var ok bool
if host, port, ok = parseEgressAuthority(hostHdr, 80); !ok {
return egressRequest{}, egressBad(egressNoHost)
}
authority = fmtEgressAuthority(host, port, 80)
target = rawTarget
}
// Body framing (RFC 9112 section 6). Every reading two parsers could disagree
// on is refused: both length headers, an unknown or doubled coding, a coding
// on HTTP/1.0, Content-Length values that differ.
req := egressRequest{host: host, port: port}
te, cl := values("transfer-encoding"), values("content-length")
if len(te) > 0 {
var codings []string
for _, v := range te {
for _, c := range strings.Split(v, ",") {
codings = append(codings, strings.ToLower(strings.TrimSpace(c)))
}
}
if len(cl) > 0 || version == "HTTP/1.0" || len(codings) != 1 || codings[0] != "chunked" {
return egressRequest{}, egressBad("The request's body length is ambiguous (Transfer-Encoding with " +
"Content-Length, on HTTP/1.0, or a coding other than chunked), so the bastion sent nothing.")
}
req.chunked = true
} else if len(cl) > 0 {
seen := map[string]bool{}
for _, v := range cl {
for _, c := range strings.Split(v, ",") {
seen[strings.TrimSpace(c)] = true
}
}
var one string
for k := range seen {
one = k
}
n, err := strconv.ParseInt(one, 10, 64)
if len(seen) != 1 || one == "" || len(one) > 18 || err != nil || n < 0 || strings.TrimLeft(one, "0123456789") != "" {
return egressRequest{}, egressBad("The request's Content-Length is not one number, so the bastion sent nothing.")
}
req.length = n
}
named := map[string]bool{}
for _, v := range values("connection") {
for _, t := range strings.Split(v, ",") {
named[strings.ToLower(strings.TrimSpace(t))] = true
}
}
var b strings.Builder
b.WriteString(method + " " + target + " " + version + "\r\n")
b.WriteString("Host: " + authority + "\r\n")
for _, h := range headers {
lk := strings.ToLower(h.name)
if egressHopByHop[lk] || named[lk] || lk == "host" || lk == "content-length" || lk == "transfer-encoding" {
continue
}
b.WriteString(h.name + ": " + h.value + "\r\n")
}
if req.chunked {
b.WriteString("Transfer-Encoding: chunked\r\n")
} else if len(cl) > 0 {
b.WriteString("Content-Length: " + strconv.FormatInt(req.length, 10) + "\r\n")
}
b.WriteString("Connection: close\r\n\r\n")
req.head = []byte(b.String())
return req, nil
}
// forwardEgressBody copies the one request body from src to dst, framed as the
// rebuilt head says. A chunked body goes out re-encoded (plain sizes, no
// extensions, trailers read and dropped), so the destination parses exactly the
// body this parser found.
func forwardEgressBody(dst io.Writer, src *bufio.Reader, req egressRequest) error {
if !req.chunked {
if req.length == 0 {
return nil
}
_, err := io.CopyN(dst, src, req.length)
return err
}
cw := httputil.NewChunkedWriter(dst)
if _, err := io.Copy(cw, httputil.NewChunkedReader(src)); err != nil {
return err
}
// The trailer section, read to its blank line within a bound, and dropped.
read := 0
for {
line, err := src.ReadSlice('\n')
read += len(line)
if err != nil || read > egressTrailerLimit {
return errors.New("chunked body: bad trailer section")
}
if string(line) == "\r\n" || string(line) == "\n" {
break
}
}
if err := cw.Close(); err != nil {
return err
}
_, err := io.WriteString(dst, "\r\n")
return err
}
// oneEgressExchange writes the one rebuilt request and its body to upstream,
// and carries the destination's answer back until the destination closes.
// Nothing the Host sends after the body is forwarded: its first byte closes
// both sides.
func oneEgressExchange(clientReader *bufio.Reader, client, upstream net.Conn, req egressRequest) {
answered := make(chan struct{})
go func() {
_, _ = io.Copy(client, upstream)
close(answered)
_ = client.Close()
}()
defer func() {
_ = upstream.Close()
<-answered
}()
if _, err := upstream.Write(req.head); err != nil {
return
}
if err := forwardEgressBody(upstream, clientReader, req); err != nil {
return
}
// The request is complete. A further byte is a second request on this
// connection: never forwarded, and the connection closes. End of stream
// from the Host is passed on, as the splice did.
go func() {
var one [1]byte
if n, _ := clientReader.Read(one[:]); n > 0 {
_ = upstream.Close()
_ = client.Close()
return
}
if cw, ok := upstream.(interface{ CloseWrite() error }); ok {
_ = cw.CloseWrite()
}
}()
<-answered
}
+17 -16
View File
@@ -7,8 +7,10 @@ package main
// The egress lane on a local (unanchored) box. It refuses this machine and // The egress lane on a local (unanchored) box. It refuses this machine and
// its link-local addresses, so a host cannot reach this machine's services // its link-local addresses, so a host cannot reach this machine's services
// (ollama above all) around the switches that govern them, and it keeps the // (ollama above all) around the switches that govern them, and, since
// person's LAN. An anchored box is unchanged: the public internet only. // 2026-10-26, the network around it as well: the LAN and the mesh
// (egress_network_test.go). An anchored box is unchanged: the public internet
// only.
import ( import (
"bufio" "bufio"
@@ -57,13 +59,14 @@ func localEgressFixture(t *testing.T) {
"self.example.test": {"192.168.50.7"}, "self.example.test": {"192.168.50.7"},
"nas.example.test": {"192.168.50.30"}, "nas.example.test": {"192.168.50.30"},
"dual.example.test": {"2001:db8::8", "198.51.100.8"}, "dual.example.test": {"2001:db8::8", "198.51.100.8"},
"site.example.test": {"198.51.100.9"},
}) })
} }
// MUTATION: restore the early return for an unanchored box in egressVettedAddrs. // MUTATION: restore the early return for an unanchored box in egressVettedAddrs.
// RESULT: red — 127.0.0.1:11434 is handed to the dial, and a name is dialled // RESULT: red — 127.0.0.1:11434 is handed to the dial, and a name is dialled
// as a name instead of the address that was vetted. // as a name instead of the address that was vetted.
func TestLocalEgressRefusesThisMachineAndKeepsTheLAN(t *testing.T) { func TestLocalEgressRefusesThisMachineAndTheLAN(t *testing.T) {
localEgressFixture(t) localEgressFixture(t)
ctx := context.Background() ctx := context.Background()
for _, hp := range []string{ for _, hp := range []string{
@@ -75,24 +78,22 @@ func TestLocalEgressRefusesThisMachineAndKeepsTheLAN(t *testing.T) {
"203.0.113.5:80", // a range a `local` route delivers here "203.0.113.5:80", // a range a `local` route delivers here
"ollama.example.test:11434", "mixed.example.test:443", "self.example.test:11434", "ollama.example.test:11434", "mixed.example.test:443", "self.example.test:11434",
"unknown.example.test:443", "unknown.example.test:443",
// the network around this machine (egress_network_test.go has the rest)
"192.168.50.20:8080", "10.1.2.3:443", "172.16.4.4:22", "[fd12:3456::9]:80", "100.64.0.9:80",
"nas.example.test:443",
} { } {
if addr, why := egressVettedAddr(ctx, hp); why == "" || addr != "" { if addr, why := egressVettedAddr(ctx, hp); why == "" || addr != "" {
t.Errorf("%s must be refused on a local box, got dial %q", hp, addr) t.Errorf("%s must be refused on a local box, got dial %q", hp, addr)
} }
} }
for hp, want := range map[string][]string{ for hp, want := range map[string][]string{
"192.168.50.20:8080": {"192.168.50.20:8080"},
"10.1.2.3:443": {"10.1.2.3:443"},
"172.16.4.4:22": {"172.16.4.4:22"},
"[fd12:3456::9]:80": {"[fd12:3456::9]:80"},
"100.64.0.9:80": {"100.64.0.9:80"},
"198.51.100.8:443": {"198.51.100.8:443"}, "198.51.100.8:443": {"198.51.100.8:443"},
"nas.example.test:443": {"192.168.50.30:443"}, "site.example.test:443": {"198.51.100.9:443"},
"dual.example.test:443": {"[2001:db8::8]:443", "198.51.100.8:443"}, "dual.example.test:443": {"[2001:db8::8]:443", "198.51.100.8:443"},
} { } {
got, why := egressVettedAddrs(ctx, hp) got, why := egressVettedAddrs(ctx, hp)
if why != "" || !reflect.DeepEqual(got, want) { if why != "" || !reflect.DeepEqual(got, want) {
t.Errorf("%s is the LAN or the internet, so a local box dials %v: got %v %q", hp, want, got, why) t.Errorf("%s is the internet, so a local box dials %v: got %v %q", hp, want, got, why)
} }
} }
} }
@@ -114,8 +115,8 @@ func TestAnchoredEgressStillRefusesTheLAN(t *testing.T) {
} }
// Through the lane itself, with a real dialer: a request for this machine is // Through the lane itself, with a real dialer: a request for this machine is
// answered 403 and never reaches the listener; a LAN request is dialled at its // answered 403 and never reaches the listener; a public name is dialled at
// vetted address; a dual-stack name falls back to its second address. // its vetted address; a dual-stack name falls back to its second address.
func TestLocalEgressLaneNeverDialsThisMachine(t *testing.T) { func TestLocalEgressLaneNeverDialsThisMachine(t *testing.T) {
localEgressFixture(t) localEgressFixture(t)
ln, err := net.Listen("tcp", "127.0.0.1:0") ln, err := net.Listen("tcp", "127.0.0.1:0")
@@ -164,11 +165,11 @@ func TestLocalEgressLaneNeverDialsThisMachine(t *testing.T) {
asked = append(asked, addr) asked = append(asked, addr)
return nil, errors.New("stop here") return nil, errors.New("stop here")
} }
if line := ask(recording, "CONNECT nas.example.test:443 HTTP/1.1\r\n\r\n"); !strings.HasPrefix(line, "HTTP/1.1 502") { if line := ask(recording, "CONNECT site.example.test:443 HTTP/1.1\r\n\r\n"); !strings.HasPrefix(line, "HTTP/1.1 502") {
t.Fatalf("a LAN destination is dialled (and this dial fails): %q", line) t.Fatalf("a public destination is dialled (and this dial fails): %q", line)
} }
if !reflect.DeepEqual(asked, []string{"192.168.50.30:443"}) { if !reflect.DeepEqual(asked, []string{"198.51.100.9:443"}) {
t.Fatalf("the vetted LAN address, never the name: %v", asked) t.Fatalf("the vetted address, never the name: %v", asked)
} }
asked = nil asked = nil
+76
View File
@@ -0,0 +1,76 @@
//go:build !windows
// Tagged !windows: it borrows localEgressFixture and answerEgressNames
// (egress_local_test.go).
package main
// The egress lane on a local (unanchored) box refuses the network around the
// machine as well as the machine itself: the LAN, the mesh and every other
// address that is not the public internet, by address and by any address a
// name resolves to. The Host's egress gate holds every dial to the same rule;
// a person's own machines are reached through their approved lanes.
import (
"bufio"
"context"
"errors"
"io"
"net"
"reflect"
"strings"
"testing"
"time"
)
// MUTATION: drop the local-box internalIP loop at the end of egressVettedAddrs.
// RESULT: red — 192.168.50.20, nas.example.test and the rest are handed to the
// dial, and the lane dials 192.168.50.30.
func TestLocalEgressRefusesTheLANAndTheMesh(t *testing.T) {
localEgressFixture(t)
answerEgressNames(t, map[string][]string{
"nas.example.test": {"192.168.50.30"},
"half.example.test": {"198.51.100.8", "10.1.2.3"},
"mesh.example.test": {"fd12:3456::9"},
"nat.example.test": {"64:ff9b::a01:203"}, // NAT64 for 10.1.2.3
"pub.example.test": {"198.51.100.8"},
})
ctx := context.Background()
for _, hp := range []string{
"192.168.50.20:8080", "10.1.2.3:443", "172.16.4.4:22", "[fd12:3456::9]:80", "100.64.0.9:80",
"198.18.0.1:80", "[64:ff9b::a01:203]:443",
"nas.example.test:443", "half.example.test:443", "mesh.example.test:80", "nat.example.test:443",
} {
if addrs, why := egressVettedAddrs(ctx, hp); why == "" || addrs != nil || !strings.Contains(why, "approved lanes") {
t.Errorf("%s is not the public internet and must be refused on a local box, got dial %v %q", hp, addrs, why)
}
}
if got, why := egressVettedAddrs(ctx, "pub.example.test:443"); why != "" || !reflect.DeepEqual(got, []string{"198.51.100.8:443"}) {
t.Fatalf("the public internet passes at its vetted address: %v %q", got, why)
}
// Through the lane itself: 403, and nothing is dialled.
var asked []string
recording := func(_ context.Context, _, addr string) (net.Conn, error) {
asked = append(asked, addr)
return nil, errors.New("stop here")
}
for _, req := range []string{
"CONNECT nas.example.test:443 HTTP/1.1\r\n\r\n",
"GET http://10.1.2.3/ HTTP/1.1\r\nHost: 10.1.2.3\r\n\r\n",
"CONNECT half.example.test:443 HTTP/1.1\r\n\r\n",
} {
srv, cli := net.Pipe()
go handleEgressConn(srv, recording, "home.host.example")
_ = cli.SetDeadline(time.Now().Add(5 * time.Second))
_, _ = io.WriteString(cli, req)
line, _ := bufio.NewReader(cli).ReadString('\n')
cli.Close()
if !strings.HasPrefix(line, "HTTP/1.1 403") {
t.Errorf("a local box must refuse %q, answered %q", req, line)
}
}
if len(asked) != 0 {
t.Fatalf("nothing on the network around this machine is dialled: %v", asked)
}
}
+393
View File
@@ -0,0 +1,393 @@
//go:build !windows
package main
import (
"bufio"
"bytes"
"context"
"errors"
"fmt"
"io"
"net"
"net/http"
"strings"
"sync"
"testing"
"time"
)
// The bastion's egress lanes carry ONE plain-HTTP request per connection, read
// the way the Host's egress gate reads it, and every refusal says
// why in its body.
//
// MUTATIONS, each red:
// - handleEgressConn writes head.String() to upstream and splices, as before:
// TestEgressPlainHTTPCarriesOneRequestPerConnection, ...SendsTheHostItChecked;
// - oneEgressExchange's watcher forwards instead of closing: ...OneRequest...;
// - parseEgressAuthority accepts "@" or cuts the authority at "/" only:
// TestEgressPlainHTTPReadsTheHostAsTheGateDoes;
// - writeEgressRefusal writes Content-Length: 0: TestEgressRefusalsCarryABody.
// recordingOrigin stands in for a destination that keeps a connection open
// after answering (it ignores Connection: close, as a careless server may),
// and records every byte one connection carried to it.
type recordingOrigin struct {
ln net.Listener
conns chan string
// silent: never answer, so the lane never holds an unread answer when it
// closes (a close with unread data is a reset, which can cost the origin
// bytes it has not read yet).
silent bool
}
func newSilentOrigin(t *testing.T) *recordingOrigin {
o := newRecordingOrigin(t)
o.silent = true
return o
}
func newRecordingOrigin(t *testing.T) *recordingOrigin {
t.Helper()
ln, err := net.Listen("tcp", "127.0.0.1:0")
if err != nil {
t.Fatal(err)
}
o := &recordingOrigin{ln: ln, conns: make(chan string, 16)}
t.Cleanup(func() { _ = ln.Close() })
go func() {
for {
c, err := ln.Accept()
if err != nil {
return
}
go o.serve(c)
}
}()
return o
}
func (o *recordingOrigin) serve(c net.Conn) {
defer c.Close()
var mu sync.Mutex
var got bytes.Buffer
answered := false
buf := make([]byte, 4096)
for {
_ = c.SetReadDeadline(time.Now().Add(800 * time.Millisecond))
n, err := c.Read(buf)
mu.Lock()
got.Write(buf[:n])
if !o.silent && !answered && bytes.Contains(got.Bytes(), []byte("\r\n\r\n")) {
answered = true
_, _ = io.WriteString(c, "HTTP/1.1 200 OK\r\nContent-Length: 2\r\n\r\nok")
}
mu.Unlock()
if err != nil {
break
}
}
o.conns <- got.String()
}
// next is everything the origin's next connection carried, once it ended.
func (o *recordingOrigin) next(t *testing.T) string {
t.Helper()
s, ok := o.nextWithin(8 * time.Second)
if !ok {
t.Fatal("the destination never saw its connection end")
}
return s
}
func (o *recordingOrigin) nextWithin(d time.Duration) (string, bool) {
select {
case s := <-o.conns:
return s, true
case <-time.After(d):
return "", false
}
}
func (o *recordingOrigin) addr() string { return o.ln.Addr().String() }
// A keep-alive connection carries one request to the destination, never two:
// neither a request sent after the first answer (a client reusing the
// connection) nor one pipelined behind the first.
func TestEgressPlainHTTPCarriesOneRequestPerConnection(t *testing.T) {
first := "GET http://198.51.100.30/first HTTP/1.1\r\nHost: 198.51.100.30\r\n\r\n"
second := "GET http://198.51.100.30/second HTTP/1.1\r\nHost: 198.51.100.30\r\n\r\n"
t.Run("reused after the answer", func(t *testing.T) {
o := newRecordingOrigin(t)
var asked []string
cli, cleanup := dialHandler(t, redirectDial(o.addr(), &asked))
defer cleanup()
_, _ = io.WriteString(cli, first)
br := bufio.NewReader(cli)
resp, err := http.ReadResponse(br, nil)
if err != nil {
t.Fatalf("the first request got no answer: %v", err)
}
body, _ := io.ReadAll(resp.Body)
if string(body) != "ok" {
t.Fatalf("the first answer was %q", body)
}
_, _ = io.WriteString(cli, second)
got := o.next(t)
if strings.Contains(got, "/second") {
t.Fatalf("a second request on one connection reached the destination unvetted:\n%s", got)
}
if !strings.Contains(got, "\r\nConnection: close\r\n") {
t.Fatalf("the request went out without Connection: close:\n%s", got)
}
_ = cli.SetReadDeadline(time.Now().Add(3 * time.Second))
if rest, _ := io.ReadAll(br); len(rest) != 0 {
t.Fatalf("the lane answered the second request: %q", rest)
}
if len(asked) != 1 {
t.Fatalf("one connection, one dial: %v", asked)
}
})
t.Run("pipelined", func(t *testing.T) {
o := newRecordingOrigin(t)
var asked []string
cli, cleanup := dialHandler(t, redirectDial(o.addr(), &asked))
defer cleanup()
_, _ = io.WriteString(cli, first+second)
got := o.next(t)
if !strings.Contains(got, "GET http://198.51.100.30/first HTTP/1.1\r\n") {
t.Fatalf("the first request did not reach the destination:\n%s", got)
}
if strings.Contains(got, "/second") {
t.Fatalf("a pipelined second request reached the destination unvetted:\n%s", got)
}
})
}
// The destination reads the host the lane vetted, in the one Host header; hop
// headers, those Connection names and a proxy credential stay on this hop.
func TestEgressPlainHTTPSendsTheHostItChecked(t *testing.T) {
o := newRecordingOrigin(t)
var asked []string
cli, cleanup := dialHandler(t, redirectDial(o.addr(), &asked))
defer cleanup()
_, _ = io.WriteString(cli, "GET http://198.51.100.31/p?q=1 HTTP/1.1\r\n"+
"Host: inside.example.test\r\nProxy-Authorization: Basic eDp5\r\n"+
"Connection: keep-alive, X-Hop\r\nX-Hop: 1\r\nX-Keep: 2\r\n\r\n")
got := o.next(t)
head, _, _ := strings.Cut(got, "\r\n\r\n")
want := "GET http://198.51.100.31/p?q=1 HTTP/1.1\r\nHost: 198.51.100.31\r\nX-Keep: 2\r\nConnection: close"
if head != want {
t.Fatalf("the destination got\n%q\nwant\n%q", head, want)
}
if len(asked) != 1 || asked[0] != "198.51.100.31:80" {
t.Fatalf("the lane must dial the address it vetted: %v", asked)
}
}
// stubEgressNames answers names without DNS and records each name exactly as
// the lane asked for it.
func stubEgressNames(t *testing.T, m map[string]string) *[]string {
t.Helper()
var mu sync.Mutex
var asked []string
old := egressResolve
t.Cleanup(func() { egressResolve = old })
egressResolve = func(_ context.Context, host string) ([]net.IPAddr, error) {
mu.Lock()
asked = append(asked, host)
mu.Unlock()
ip, ok := m[host]
if !ok {
return nil, errors.New("no such host")
}
return []net.IPAddr{{IP: net.ParseIP(ip)}}, nil
}
return &asked
}
// The host is read as the gate reads it: the authority ends at the first "/",
// "?" or "#", is lower-cased and loses one trailing dot; userinfo, an
// unbracketed IPv6 literal, a bad port, https in absolute form, two Host
// headers and an ambiguous body length are refused with 400 and a body, before
// anything is resolved or dialled.
func TestEgressPlainHTTPReadsTheHostAsTheGateDoes(t *testing.T) {
for _, c := range []struct {
req, wantName, wantLine string
}{
{"GET http://public.example.test?@10.0.0.1/ HTTP/1.1\r\n\r\n", "public.example.test",
"GET http://public.example.test/?@10.0.0.1/ HTTP/1.1"},
{"GET http://public.example.test#@10.0.0.1/ HTTP/1.1\r\n\r\n", "public.example.test",
"GET http://public.example.test/ HTTP/1.1"},
{"GET http://Public.Example.Test./x HTTP/1.1\r\n\r\n", "public.example.test",
"GET http://public.example.test/x HTTP/1.1"},
{"GET /x HTTP/1.1\r\nHost: Public.Example.Test:8080\r\n\r\n", "public.example.test",
"GET /x HTTP/1.1"},
} {
o := newRecordingOrigin(t)
names := stubEgressNames(t, map[string]string{"public.example.test": "198.51.100.40"})
var asked []string
cli, cleanup := dialHandler(t, redirectDial(o.addr(), &asked))
_, _ = io.WriteString(cli, c.req)
got, _ := o.nextWithin(4 * time.Second)
cleanup()
if len(*names) != 1 || (*names)[0] != c.wantName {
t.Errorf("%q: the lane resolved %q; want only %q", c.req, *names, c.wantName)
}
if line, _, _ := strings.Cut(got, "\r\n"); line != c.wantLine {
t.Errorf("%q: the destination got the request line %q; want %q", c.req, line, c.wantLine)
}
}
for _, req := range []string{
"GET http://user:pw@public.example.test/ HTTP/1.1\r\n\r\n",
"GET http://198.51.100.41:80@public.example.test/ HTTP/1.1\r\n\r\n",
"GET http://2001:db8::1/ HTTP/1.1\r\n\r\n",
"GET http://public.example.test:80x/ HTTP/1.1\r\n\r\n",
"GET https://public.example.test/ HTTP/1.1\r\n\r\n",
"GET / HTTP/1.1\r\nHost: public.example.test\r\nHost: 198.51.100.41\r\n\r\n",
"GET / HTTP/1.1\r\n\r\n",
"POST http://public.example.test/ HTTP/1.1\r\nContent-Length: 3\r\nTransfer-Encoding: chunked\r\n\r\n",
"POST http://public.example.test/ HTTP/1.1\r\nContent-Length: 3\r\nContent-Length: 4\r\n\r\n",
"POST http://public.example.test/ HTTP/1.1\r\nTransfer-Encoding: gzip, chunked\r\n\r\n",
"GET http://public.example.test/ HTTP/1.1\r\n X-Folded: 1\r\n\r\n",
"CONNECT user@public.example.test:443 HTTP/1.1\r\n\r\n",
"CONNECT 2001:db8::1:443 HTTP/1.1\r\n\r\n",
"CONNECT [198.51.100.41]:443 HTTP/1.1\r\n\r\n",
} {
names := stubEgressNames(t, map[string]string{"public.example.test": "198.51.100.40"})
var asked []string
cli, cleanup := dialHandler(t, redirectDial("127.0.0.1:9", &asked))
_, _ = io.WriteString(cli, req)
resp, err := http.ReadResponse(bufio.NewReader(cli), nil)
if err != nil {
t.Errorf("%q: no answer: %v", req, err)
cleanup()
continue
}
body, _ := io.ReadAll(resp.Body)
cleanup()
if resp.StatusCode != 400 || len(body) == 0 || int64(len(body)) != resp.ContentLength {
t.Errorf("%q: answered %d with body %q; want 400 with a body saying why", req, resp.StatusCode, body)
}
if len(*names) != 0 || len(asked) != 0 {
t.Errorf("%q: refused requests resolve and dial nothing; resolved %q, dialled %q", req, *names, asked)
}
}
}
// A request body goes out framed as its head says, chunked bodies re-encoded,
// and nothing after it.
func TestEgressPlainHTTPBodyIsFramed(t *testing.T) {
for _, c := range []struct{ req, wantBody string }{
{"POST http://198.51.100.42/u HTTP/1.1\r\nHost: 198.51.100.42\r\nContent-Length: 5\r\n\r\nhello" +
"GET http://198.51.100.42/smuggled HTTP/1.1\r\n\r\n", "hello"},
{"POST http://198.51.100.42/u HTTP/1.1\r\nHost: 198.51.100.42\r\nTransfer-Encoding: chunked\r\n\r\n" +
"5;ext=1\r\nhello\r\n0\r\nX-Trailer: 1\r\n\r\nGET /smuggled HTTP/1.1\r\n\r\n", "5\r\nhello\r\n0\r\n\r\n"},
} {
o := newSilentOrigin(t)
var asked []string
cli, cleanup := dialHandler(t, redirectDial(o.addr(), &asked))
_, _ = io.WriteString(cli, c.req)
got := o.next(t)
cleanup()
_, body, _ := strings.Cut(got, "\r\n\r\n")
if body != c.wantBody {
t.Errorf("the destination got the body %q; want %q", body, c.wantBody)
}
}
}
// A refusal says why in its body, not only in a header: a 403 from the vetting
// and a 502 from a dial that found no answer, on both request forms, and the
// coder-run proxy's refusals too.
func TestEgressRefusalsCarryABody(t *testing.T) {
failDial := func(ctx context.Context, network, addr string) (net.Conn, error) {
return nil, fmt.Errorf("no route")
}
okDial := func(ctx context.Context, network, addr string) (net.Conn, error) {
return nil, fmt.Errorf("must not dial %s", addr)
}
check := func(name string, resp *http.Response, err error, want int) {
t.Helper()
if err != nil {
t.Errorf("%s: no answer: %v", name, err)
return
}
body, _ := io.ReadAll(resp.Body)
if resp.StatusCode != want || len(body) < 10 || int64(len(body)) != resp.ContentLength {
t.Errorf("%s: answered %d with body %q (Content-Length %d); want %d with a short body saying why",
name, resp.StatusCode, body, resp.ContentLength, want)
}
}
for _, c := range []struct {
name string
dial egressDialer
req string
want int
}{
{"plain HTTP to this machine", okDial, "GET http://127.0.0.1:9/ HTTP/1.1\r\n\r\n", 403},
{"CONNECT to this machine", okDial, "CONNECT 127.0.0.1:9 HTTP/1.1\r\n\r\n", 403},
{"plain HTTP, no answer", failDial, "GET http://198.51.100.43/ HTTP/1.1\r\n\r\n", 502},
{"CONNECT, no answer", failDial, "CONNECT 198.51.100.43:443 HTTP/1.1\r\n\r\n", 502},
} {
cli, cleanup := dialHandler(t, c.dial)
_, _ = io.WriteString(cli, c.req)
resp, err := http.ReadResponse(bufio.NewReader(cli), nil)
check(c.name, resp, err, c.want)
cleanup()
}
oldDial := coderDialOut
t.Cleanup(func() { coderDialOut = oldDial })
coderDialOut = failDial
for _, c := range []struct {
name, req string
want int
}{
{"coder run to a private address", "GET http://10.0.0.1/ HTTP/1.1\r\nHost: 10.0.0.1\r\n\r\n", 403},
{"coder run, no answer", "GET http://93.184.216.34/ HTTP/1.1\r\nHost: 93.184.216.34\r\n\r\n", 502},
} {
boxEnd, runEnd := net.Pipe()
var refused int64
go handleCoderEgressConn(boxEnd, nil, &refused)
_ = runEnd.SetDeadline(time.Now().Add(5 * time.Second))
_, _ = io.WriteString(runEnd, c.req)
resp, err := http.ReadResponse(bufio.NewReader(runEnd), nil)
check(c.name, resp, err, c.want)
_ = runEnd.Close()
}
}
// The coder-run proxy carries one request per connection too: the run's own
// processes are the sender there.
func TestCoderEgressCarriesOneRequestPerConnection(t *testing.T) {
o := newRecordingOrigin(t)
oldDial := coderDialOut
t.Cleanup(func() { coderDialOut = oldDial })
coderDialOut = func(ctx context.Context, network, addr string) (net.Conn, error) {
return (&net.Dialer{}).DialContext(ctx, network, o.addr())
}
boxEnd, runEnd := net.Pipe()
var refused int64
go handleCoderEgressConn(boxEnd, nil, &refused)
_ = runEnd.SetDeadline(time.Now().Add(8 * time.Second))
_, _ = io.WriteString(runEnd, "GET http://93.184.216.34/first HTTP/1.1\r\nHost: 93.184.216.34\r\n\r\n")
br := bufio.NewReader(runEnd)
resp, err := http.ReadResponse(br, nil)
if err != nil {
t.Fatalf("the first request got no answer: %v", err)
}
_, _ = io.ReadAll(resp.Body)
_, _ = io.WriteString(runEnd, "GET http://93.184.216.34/second HTTP/1.1\r\nHost: inside.example.test\r\n\r\n")
got := o.next(t)
_ = runEnd.Close()
if strings.Contains(got, "/second") || strings.Contains(got, "inside.example.test") {
t.Fatalf("a second request on one connection reached the destination unvetted:\n%s", got)
}
if !strings.Contains(got, "\r\nConnection: close\r\n") {
t.Fatalf("the request went out without Connection: close:\n%s", got)
}
}
+56 -12
View File
@@ -14,35 +14,60 @@ import (
const egressWorkerCount = 4 const egressWorkerCount = 4
// egressRefusedWait is how long a worker waits before it parks again after a
// job it did not take (malformed, refused) or after its WebSocket closed while
// parked. A job it took parks the worker again at once, so the person's own
// traffic is never slowed by it; a Host that answers every worker with a job
// this machine refuses costs it at most egressWorkerCount dials, handshakes
// and refusals a second, not as many as the Host can send. The serve lane's
// workers wait the same (serveRefusedWait).
var egressRefusedWait = time.Second
// wsConn adapts a worker WebSocket into a net.Conn so the existing handleEgressConn drives // wsConn adapts a worker WebSocket into a net.Conn so the existing handleEgressConn drives
// it unchanged. The host frames the proxied client stream as binary messages: 'D'+payload = // it unchanged. The host frames the proxied client stream as binary messages: 'D'+payload =
// data, 'E' = end-of-stream. Reads surface the host's bytes; writes go back as 'D' frames; // data, 'E' = end-of-stream. Reads surface the host's bytes; writes go back as 'D' frames;
// Close/CloseWrite send 'E'. // Close/CloseWrite send 'E'.
//
// A 'D' frame is STREAMED into the caller's buffer, never read whole: the host picks a
// frame's length, and one frame of any length must cost this machine no more memory
// than the read it is asked for.
type wsConn struct { type wsConn struct {
ws *websocket.Conn ws *websocket.Conn
rbuf []byte cur io.Reader // the rest of the 'D' frame being read, or nil
wmu sync.Mutex wmu sync.Mutex
} }
func (c *wsConn) Read(p []byte) (int, error) { func (c *wsConn) Read(p []byte) (int, error) {
for len(c.rbuf) == 0 { for {
mt, data, err := c.ws.ReadMessage() if c.cur != nil {
n, err := c.cur.Read(p)
if err == io.EOF {
c.cur = nil
err = nil
}
if n > 0 || err != nil {
return n, err
}
continue
}
mt, r, err := c.ws.NextReader()
if err != nil { if err != nil {
return 0, err return 0, err
} }
if mt != websocket.BinaryMessage || len(data) == 0 { if mt != websocket.BinaryMessage {
continue continue // NextReader discards what is left of it
} }
switch data[0] { var tag [1]byte
if _, err := io.ReadFull(r, tag[:]); err != nil {
continue // an empty frame
}
switch tag[0] {
case 'D': case 'D':
c.rbuf = data[1:] c.cur = r
case 'E': case 'E':
return 0, io.EOF return 0, io.EOF
} }
} }
n := copy(p, c.rbuf)
c.rbuf = c.rbuf[n:]
return n, nil
} }
func (c *wsConn) Write(p []byte) (int, error) { func (c *wsConn) Write(p []byte) (int, error) {
@@ -80,20 +105,30 @@ func (c *wsConn) SetWriteDeadline(t time.Time) error { return c.ws.SetWriteDeadl
// bastion's tunnel IP) and serves one egress job per worker, reconnecting after each. Each // bastion's tunnel IP) and serves one egress job per worker, reconnecting after each. Each
// worker authenticates with the bastion's bearer, then blocks until the host dispatches a // worker authenticates with the bastion's bearer, then blocks until the host dispatches a
// request; handleEgressConn then dials it out the USER's connection (dialOut) and relays. // request; handleEgressConn then dials it out the USER's connection (dialOut) and relays.
// A worker reconnects at once after a job it took, and after egressRefusedWait after one
// it refused or a close while parked. The func returned waits until every worker has
// exited, which is once pctx is done and each one's job has ended.
// //
// pctx is the pairing's context (run.go): when the anchor revokes a pairing the // pctx is the pairing's context (run.go): when the anchor revokes a pairing the
// workers must exit, not re-dial a closed tunnel every 3s for the process's life. // workers must exit, not re-dial a closed tunnel every 3s for the process's life.
func runEgressWorkers(pctx context.Context, self string, wsURL string, tlsCfg *tls.Config, func runEgressWorkers(pctx context.Context, self string, wsURL string, tlsCfg *tls.Config,
dialHost func(ctx context.Context) (net.Conn, error), bearer string, dialHost func(ctx context.Context) (net.Conn, error), bearer string,
dialOut egressDialer, n int) { dialOut egressDialer, n int) (wait func()) {
dialer := &websocket.Dialer{ dialer := &websocket.Dialer{
NetDialContext: func(ctx context.Context, network, addr string) (net.Conn, error) { return dialHost(ctx) }, NetDialContext: func(ctx context.Context, network, addr string) (net.Conn, error) { return dialHost(ctx) },
TLSClientConfig: tlsCfg, TLSClientConfig: tlsCfg,
HandshakeTimeout: 20 * time.Second, HandshakeTimeout: 20 * time.Second,
} }
var wg sync.WaitGroup
for i := 0; i < n; i++ { for i := 0; i < n; i++ {
wg.Add(1)
go func() { go func() {
defer wg.Done()
hold := laneHoldFor(self)
for pctx.Err() == nil { for pctx.Err() == nil {
if !hold.waitClear(pctx) {
return
}
ctx, cancel := context.WithTimeout(pctx, 25*time.Second) ctx, cancel := context.WithTimeout(pctx, 25*time.Second)
ws, _, err := dialer.DialContext(ctx, wsURL, http.Header{}) ws, _, err := dialer.DialContext(ctx, wsURL, http.Header{})
cancel() cancel()
@@ -106,13 +141,22 @@ func runEgressWorkers(pctx context.Context, self string, wsURL string, tlsCfg *t
sleepCtx(pctx, time.Second) sleepCtx(pctx, time.Second)
continue continue
} }
held := watchHeldClose(ws)
stopKA := armWSKeepalive(ws) // ping/read-deadline: a dead tunnel unblocks the park stopKA := armWSKeepalive(ws) // ping/read-deadline: a dead tunnel unblocks the park
unpark := context.AfterFunc(pctx, func() { _ = ws.Close() }) unpark := context.AfterFunc(pctx, func() { _ = ws.Close() })
handleEgressConn(&wsConn{ws: ws}, dialOut, self) // blocks until a job, serves it, then returns took := handleEgressConn(&wsConn{ws: ws}, dialOut, self) // blocks until a job, serves it, then returns
unpark() unpark()
stopKA() stopKA()
_ = ws.Close() _ = ws.Close()
if held() {
hold.refused(self) // the Host holds this machine (lanehold.go)
continue
}
if !took {
sleepCtx(pctx, egressRefusedWait)
}
} }
}() }()
} }
return wg.Wait
} }
+166
View File
@@ -0,0 +1,166 @@
//go:build !windows
// The egress worker pool (egress_relay.go: runEgressWorkers) against a
// stand-in Host's /bastion-egress: how fast workers park again after a job
// they took and after one they refused. Uses localEgressFixture
// (egress_local_test.go), so it carries the same build tag.
package main
import (
"context"
"io"
"log"
"net"
"net/http"
"net/http/httptest"
"strings"
"sync/atomic"
"testing"
"time"
"github.com/gorilla/websocket"
)
// egressHost is a Host's /bastion-egress as the pool meets it: every worker
// that parks is counted and handed the job job(n) (n is its place in line),
// and what the bastion answered is read to its end.
type egressHost struct {
parked atomic.Int32
ok atomic.Int32 // answers that began "HTTP/1.1 200"
}
func startEgressHost(t *testing.T, job func(n int32) string) (*egressHost, string, func(context.Context) (net.Conn, error)) {
t.Helper()
h := &egressHost{}
up := websocket.Upgrader{}
srv := httptest.NewUnstartedServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
c, err := up.Upgrade(w, r, nil)
if err != nil {
return
}
defer c.Close()
if _, _, err := c.ReadMessage(); err != nil { // BEARER
return
}
n := h.parked.Add(1)
if err := c.WriteMessage(websocket.BinaryMessage, append([]byte{'D'}, job(n)...)); err != nil {
return
}
_ = c.SetReadDeadline(time.Now().Add(5 * time.Second))
var answer strings.Builder
for {
_, m, err := c.ReadMessage()
if err != nil || len(m) == 0 || m[0] == 'E' {
break
}
answer.Write(m[1:])
}
if strings.HasPrefix(answer.String(), "HTTP/1.1 200") {
h.ok.Add(1)
}
}))
srv.Config.ErrorLog = log.New(io.Discard, "", 0)
srv.Start()
t.Cleanup(srv.Close)
addr := srv.Listener.Addr().String()
dial := func(ctx context.Context) (net.Conn, error) {
return (&net.Dialer{}).DialContext(ctx, "tcp", addr)
}
return h, "ws://" + addr + "/bastion-egress", dial
}
// runEgressPool runs egressWorkerCount workers for the test's life, and at its
// end stops them and waits until each has exited: a worker still vetting a job
// would otherwise read the fixture's stubs while the test's cleanup puts them
// back.
func runEgressPool(t *testing.T, wsURL string, dialHost func(context.Context) (net.Conn, error), dialOut egressDialer) {
t.Helper()
ctx, cancel := context.WithCancel(context.Background())
wait := runEgressWorkers(ctx, "home.host.example", wsURL, nil, dialHost, "test-bearer", dialOut, egressWorkerCount)
t.Cleanup(func() {
cancel()
done := make(chan struct{})
go func() { wait(); close(done) }()
select {
case <-done:
case <-time.After(10 * time.Second):
t.Error("the egress workers did not exit 10 s after the pool stopped")
}
})
}
// SECURITY (this machine's resources): a Host that answers every parked egress
// worker with a job this machine refuses (a request for this machine, a line
// that is no request) cannot make it dial, handshake and refuse in a loop as
// fast as the Host answers. Each worker that refused waits before it parks
// again, so the pool costs at most egressWorkerCount dials a second.
//
// MUTATION: in runEgressWorkers, park again at once whatever handleEgressConn
// reports (as the pool did).
// RESULT: red — hundreds of workers park in the 2 s window.
func TestARefusingHostCannotSpinTheEgressWorkers(t *testing.T) {
localEgressFixture(t)
var dialled atomic.Int32
dialOut := func(ctx context.Context, network, addr string) (net.Conn, error) {
dialled.Add(1)
return nil, io.EOF
}
h, wsURL, dialHost := startEgressHost(t, func(n int32) string {
if n%2 == 0 {
return "NOT-A-REQUEST\r\n"
}
return "CONNECT localhost:443 HTTP/1.1\r\nHost: localhost:443\r\n\r\n"
})
runEgressPool(t, wsURL, dialHost, dialOut)
time.Sleep(2 * time.Second)
// egressWorkerCount park at the start, then each worker once a second:
// about 12 in 2 s. A pool that parks again at once makes hundreds.
n := h.parked.Load()
t.Logf("%d workers parked in 2 s", n)
if limit := int32(egressWorkerCount * 4); n > limit {
t.Fatalf("%d egress workers parked in 2 s on a Host that refuses every job (at most %d): the pool re-dials in a loop", n, limit)
}
if n < egressWorkerCount {
t.Fatalf("only %d workers parked: the pool did not run, so the count proves nothing", n)
}
if d := dialled.Load(); d != 0 {
t.Fatalf("a refused job was dialled out %d times", d)
}
}
// The person's own traffic is not slowed: a worker that took a job parks again
// at once, so 40 jobs through 4 workers finish in a fraction of the time one
// wait per job would take (40 / 4 x egressRefusedWait = 10 s).
//
// MUTATION: in runEgressWorkers, wait egressRefusedWait after every job.
// RESULT: red — 40 jobs need about 10 s.
func TestEgressWorkersParkAgainAtOnceAfterAJobTheyTook(t *testing.T) {
localEgressFixture(t)
dialOut := func(ctx context.Context, network, addr string) (net.Conn, error) {
if addr != "198.51.100.9:443" {
t.Errorf("dialled %q, not the address the request named", addr)
}
ours, theirs := net.Pipe()
_ = theirs.Close() // the destination accepts and ends at once
return ours, nil
}
h, wsURL, dialHost := startEgressHost(t, func(int32) string {
return "CONNECT 198.51.100.9:443 HTTP/1.1\r\nHost: 198.51.100.9:443\r\n\r\n"
})
start := time.Now()
runEgressPool(t, wsURL, dialHost, dialOut)
const jobs = 40
deadline := start.Add(10 * time.Second)
for h.ok.Load() < jobs && time.Now().Before(deadline) {
time.Sleep(10 * time.Millisecond)
}
took := time.Since(start)
t.Logf("%d accepted jobs answered in %v", h.ok.Load(), took)
if got := h.ok.Load(); got < jobs {
t.Fatalf("only %d of %d accepted jobs were answered 200 in %v", got, jobs, took)
}
if limit := 3 * egressRefusedWait; took > limit {
t.Fatalf("%d accepted jobs took %v (over %v): a worker that took a job waited before it parked again", jobs, took, limit)
}
}
+1 -1
View File
@@ -174,7 +174,7 @@ func statusOutput(t *testing.T) string {
} }
stdout := os.Stdout stdout := os.Stdout
os.Stdout = w os.Stdout = w
serr := cmdStatus() serr := cmdStatus(nil)
os.Stdout = stdout os.Stdout = stdout
_ = w.Close() _ = w.Close()
out, _ := io.ReadAll(r) out, _ := io.ReadAll(r)
+9 -1
View File
@@ -117,7 +117,7 @@ func buildEnforcingReport(dir string, allowed []string) map[string]any {
b, _ := strconv.ParseInt(ids[j], 10, 64) b, _ := strconv.ParseInt(ids[j], 10, 64)
return a < b return a < b
}) })
status := faManagedStatus() status := faManagedStatus(dir)
for _, k := range ids { for _, k := range ids {
id, err := strconv.ParseInt(k, 10, 64) id, err := strconv.ParseInt(k, 10, 64)
if err != nil { if err != nil {
@@ -193,6 +193,14 @@ func buildEnforcingReport(dir string, allowed []string) map[string]any {
if !aok { if !aok {
rep["action_ops_reason"] = awhy rep["action_ops_reason"] = awhy
} }
// Each verb, and whether this machine has the tool it runs: an op
// with no program (interpreter: none) runs here when its verbs do,
// with or without the sandbox above.
rep["verbs"] = opVerbsReport()
// An op grant's bounds may hold its runs to a window and a rate
// (ops_bounds.go). Said by the box, so the host sends neither to one
// that would refuse them as naming no param.
rep["grant_run_bounds"] = true
} }
// This machine's encryption key, signed by its own key: what the host // This machine's encryption key, signed by its own key: what the host
// seals an action op's credentials to (ops_seal.go). // seals an action op's credentials to (ops_seal.go).
+20 -15
View File
@@ -68,17 +68,22 @@ type freeagentConfig struct {
// faManagedSanitizeMode is the sanitize mode the bastion writes into every // faManagedSanitizeMode is the sanitize mode the bastion writes into every
// manifest it deploys (faManifestText). Flag mode is the agent's rules pass // manifest it deploys (faManifestText). Flag mode is the agent's rules pass
// only: it replaces e-mail addresses, phone numbers, card, bank and ID // only (the agent's pii/detect.py): it replaces what a pattern can find
// numbers, IP and MAC addresses and keys, and does not find names, street // (faSanitizeNotes["flag"] names each kind), and does not look for names,
// addresses or dates of birth. // street addresses, dates of birth, ID numbers such as passport numbers, or
// bank account numbers other than IBANs.
const faManagedSanitizeMode = "flag" const faManagedSanitizeMode = "flag"
// faSanitizeNotes says, for each mode a reply can carry, what personal data // faSanitizeNotes says, for each mode a reply can carry, what personal data
// may still be in the text, in the words the host relays. A mode with no entry // may still be in the text, in the words the host relays. A mode with no entry
// here is reported as not known to remove personal data. // here is reported as not known to remove personal data.
var faSanitizeNotes = map[string]string{ var faSanitizeNotes = map[string]string{
"flag": "rules only: e-mail addresses, phone numbers, card, bank and ID numbers, IP and MAC addresses " + "flag": "rules only. Replaced: e-mail addresses, phone numbers, card numbers, US social security numbers, " +
"and keys were replaced; names, street addresses and dates of birth were not", "international bank account numbers (IBANs), US bank routing numbers written after a word like " +
"\"routing\", Bitcoin addresses that start with 1 or 3, IP and MAC addresses, private keys, and " +
"access keys and tokens of the kinds it knows. Other numbers that look like one of these can be " +
"replaced too. Not looked for, so they can still be in the text: names, street addresses, dates of " +
"birth, passport, licence and other ID numbers, other bank account numbers and other crypto addresses",
"sterilize": "", "sterilize": "",
"none": "the agent's manifest has no sanitize stage, so nothing in the text was replaced", "none": "the agent's manifest has no sanitize stage, so nothing in the text was replaced",
} }
@@ -218,8 +223,8 @@ func freeagentDo(c freeagentConfig, method, path string, body any, d time.Durati
// faConfigFor is the client config for a store: the MANAGED instance the // faConfigFor is the client config for a store: the MANAGED instance the
// bastion runs for it (freeagent_managed.go) when there is one, else the // bastion runs for it (freeagent_managed.go) when there is one, else the
// operator's PRIVATAE_BASTION_AGENT_* env for a hand-run agent. // operator's PRIVATAE_BASTION_AGENT_* env for a hand-run agent.
func faConfigFor(storeID int64) (freeagentConfig, bool) { func faConfigFor(dcnDir string, storeID int64) (freeagentConfig, bool) {
if c, ok := faManagedConfig(storeID); ok { if c, ok := faManagedConfig(dcnDir, storeID); ok {
return c, true return c, true
} }
return freeagentEnv() return freeagentEnv()
@@ -227,8 +232,8 @@ func faConfigFor(storeID int64) (freeagentConfig, bool) {
// faAbsentReason says WHY there is no local agent to ask, in the words the // faAbsentReason says WHY there is no local agent to ask, in the words the
// host should relay: a missing Python is the member's one manual step. // host should relay: a missing Python is the member's one manual step.
func faAbsentReason(storeID int64) string { func faAbsentReason(dcnDir string, storeID int64) string {
inst, ok := faSnapshot(storeID) inst, ok := faSnapshot(dcnDir, storeID)
if ok { if ok {
switch inst.State { switch inst.State {
case "missing-python": case "missing-python":
@@ -353,9 +358,9 @@ func handleDcnSearch(ws *websocket.Conn, dir string, args []string) {
if terms == nil { if terms == nil {
return return
} }
c, on := faConfigFor(storeID) c, on := faConfigFor(dir, storeID)
if !on { if !on {
dcnRefuse(ws, dir, "search", storeID, "", faAbsentReason(storeID)) dcnRefuse(ws, dir, "search", storeID, "", faAbsentReason(dir, storeID))
return return
} }
q := strings.TrimSpace(a.Query) q := strings.TrimSpace(a.Query)
@@ -414,9 +419,9 @@ func handleDcnCatalog(ws *websocket.Conn, dir string, args []string) {
"catalog needs the 'index' mask on this grant (re-approve the store with index)") "catalog needs the 'index' mask on this grant (re-approve the store with index)")
return return
} }
c, on := faConfigFor(storeID) c, on := faConfigFor(dir, storeID)
if !on { if !on {
dcnRefuse(ws, dir, "catalog", storeID, "kind:"+kind, faAbsentReason(storeID)) dcnRefuse(ws, dir, "catalog", storeID, "kind:"+kind, faAbsentReason(dir, storeID))
return return
} }
path := "/catalog" path := "/catalog"
@@ -466,9 +471,9 @@ func handleDcnReadRangeDoc(ws *websocket.Conn, dir string, storeID int64, a *dcn
if terms == nil { if terms == nil {
return return
} }
c, on := faConfigFor(storeID) c, on := faConfigFor(dir, storeID)
if !on { if !on {
dcnRefuse(ws, dir, "read_range", storeID, "doc:"+a.Doc, faAbsentReason(storeID)) dcnRefuse(ws, dir, "read_range", storeID, "doc:"+a.Doc, faAbsentReason(dir, storeID))
return return
} }
start := a.StartByte start := a.StartByte
+48 -25
View File
@@ -123,20 +123,29 @@ type faInstance struct {
} }
// faSnapshot copies the fields a reader needs, under the lock. // faSnapshot copies the fields a reader needs, under the lock.
func faSnapshot(storeID int64) (faInstance, bool) { func faSnapshot(dcnDir string, storeID int64) (faInstance, bool) {
faMgr.Lock() faMgr.Lock()
defer faMgr.Unlock() defer faMgr.Unlock()
inst, ok := faMgr.inst[storeID] inst, ok := faMgr.inst[faKey{dcnDir, storeID}]
if !ok { if !ok {
return faInstance{}, false return faInstance{}, false
} }
return *inst, true return *inst, true
} }
// faKey is one pairing's store: store ids are each Host's own, so the same id
// from two Hosts is two stores. Keyed by store id alone, a machine paired with
// two Hosts ran one agent for both, and a search from one Host for its store
// was answered by the agent over the other Host's folder.
type faKey struct {
Dir string // the pairing's DCN state dir (Config.dcnDir)
ID int64
}
var faMgr = struct { var faMgr = struct {
sync.Mutex sync.Mutex
inst map[int64]*faInstance inst map[faKey]*faInstance
}{inst: map[int64]*faInstance{}} }{inst: map[faKey]*faInstance{}}
// ── locations ─────────────────────────────────────────────────────────────── // ── locations ───────────────────────────────────────────────────────────────
@@ -664,8 +673,8 @@ func faRecipientOf(inst *faInstance) string {
// faManagedConfig is the client config for a store's managed instance, or // faManagedConfig is the client config for a store's managed instance, or
// false when none is running (port file absent). // false when none is running (port file absent).
func faManagedConfig(storeID int64) (freeagentConfig, bool) { func faManagedConfig(dcnDir string, storeID int64) (freeagentConfig, bool) {
inst, ok := faSnapshot(storeID) inst, ok := faSnapshot(dcnDir, storeID)
if !ok { if !ok {
return freeagentConfig{}, false return freeagentConfig{}, false
} }
@@ -697,10 +706,11 @@ func faEnsureStore(dcnDir string, storeID int64, terms *dcnTerms, sweep, recipie
} }
cn := "store-" + strconv.FormatInt(storeID, 10) cn := "store-" + strconv.FormatInt(storeID, 10)
faMgr.Lock() faMgr.Lock()
inst, ok := faMgr.inst[storeID] key := faKey{dcnDir, storeID}
inst, ok := faMgr.inst[key]
if !ok { if !ok {
inst = &faInstance{StoreID: storeID, Dir: dir, PrivDir: priv, PubDir: pub, CN: cn, State: "installing"} inst = &faInstance{StoreID: storeID, Dir: dir, PrivDir: priv, PubDir: pub, CN: cn, State: "installing"}
faMgr.inst[storeID] = inst faMgr.inst[key] = inst
} else if inst.State == "installing" || inst.ensuring { } else if inst.State == "installing" || inst.ensuring {
faMgr.Unlock() faMgr.Unlock()
return // one ensure at a time per store — see faInstance.ensuring return // one ensure at a time per store — see faInstance.ensuring
@@ -993,22 +1003,27 @@ func sweepFromCanonical(termsB64 string) string {
return "" return ""
} }
// faManagedProbe reports (anyManaged, allServing) and refreshes each // faManagedProbe reports (anyManaged, allServing) for ONE pairing's instances
// instance's Serving flag by probing its /health over mTLS. // and refreshes their Serving flags by probing each /health over mTLS. Another
func faManagedProbe() (bool, bool) { // pairing's agents are never counted: its health is not this Host's to hear,
// and this Host reads the capability as "my stores here are served" when its
// own freeagent_stores is empty (faManagedStatus). "" probes none.
func faManagedProbe(dcnDir string) (bool, bool) {
faMgr.Lock() faMgr.Lock()
ids := make([]int64, 0, len(faMgr.inst)) keys := make([]faKey, 0, len(faMgr.inst))
for id := range faMgr.inst { for k := range faMgr.inst {
ids = append(ids, id) if dcnDir != "" && k.Dir == dcnDir {
keys = append(keys, k)
}
} }
faMgr.Unlock() faMgr.Unlock()
if len(ids) == 0 { if len(keys) == 0 {
return false, false return false, false
} }
all := true all := true
for _, id := range ids { for _, k := range keys {
serving := false serving := false
if c, ok := faManagedConfig(id); ok { if c, ok := faManagedConfig(k.Dir, k.ID); ok {
status, body, err := freeagentCallTimeout(c, http.MethodGet, "/health", nil, freeagentProbeTimeout) status, body, err := freeagentCallTimeout(c, http.MethodGet, "/health", nil, freeagentProbeTimeout)
if err == nil && status == http.StatusOK { if err == nil && status == http.StatusOK {
var h struct { var h struct {
@@ -1019,7 +1034,7 @@ func faManagedProbe() (bool, bool) {
} }
} }
faMgr.Lock() faMgr.Lock()
if inst, ok := faMgr.inst[id]; ok { if inst, ok := faMgr.inst[k]; ok {
inst.Serving = serving inst.Serving = serving
} }
faMgr.Unlock() faMgr.Unlock()
@@ -1030,13 +1045,20 @@ func faManagedProbe() (bool, bool) {
return true, all return true, all
} }
// faManagedStatus is the heartbeat's per-store detail. // faManagedStatus is one pairing's per-store detail for its heartbeat: only
func faManagedStatus() map[string]any { // its own stores, never another Host's.
func faManagedStatus(dcnDir string) map[string]any {
faMgr.Lock() faMgr.Lock()
defer faMgr.Unlock() defer faMgr.Unlock()
out := map[string]any{} out := map[string]any{}
for id, inst := range faMgr.inst { if dcnDir == "" {
out[strconv.FormatInt(id, 10)] = map[string]any{ return out
}
for k, inst := range faMgr.inst {
if k.Dir != dcnDir {
continue
}
out[strconv.FormatInt(k.ID, 10)] = map[string]any{
"state": inst.State, "serving": inst.Serving, "version": inst.Version, "detail": inst.Detail, "state": inst.State, "serving": inst.Serving, "version": inst.Version, "detail": inst.Detail,
} }
} }
@@ -1045,14 +1067,15 @@ func faManagedStatus() map[string]any {
// faStop tears down a store's managed instance (grant revoked / re-synced // faStop tears down a store's managed instance (grant revoked / re-synced
// without search). // without search).
func faStop(storeID int64) { func faStop(dcnDir string, storeID int64) {
faMgr.Lock() faMgr.Lock()
defer faMgr.Unlock() defer faMgr.Unlock()
if inst, ok := faMgr.inst[storeID]; ok { key := faKey{dcnDir, storeID}
if inst, ok := faMgr.inst[key]; ok {
if inst.cancel != nil { if inst.cancel != nil {
inst.cancel() inst.cancel()
} }
delete(faMgr.inst, storeID) delete(faMgr.inst, key)
} }
} }
+56 -21
View File
@@ -182,29 +182,64 @@ func TestFaManifestText(t *testing.T) {
func TestFaManagedConfigFromPortFile(t *testing.T) { func TestFaManagedConfigFromPortFile(t *testing.T) {
dir := t.TempDir() dir := t.TempDir()
faMgr.Lock() faMgr.Lock()
faMgr.inst[4242] = &faInstance{StoreID: 4242, Dir: dir, Cert: "c", Key: "k"} faMgr.inst[faKey{"dcn-test", 4242}] = &faInstance{StoreID: 4242, Dir: dir, Cert: "c", Key: "k"}
faMgr.Unlock() faMgr.Unlock()
t.Cleanup(func() { faStop(4242) }) t.Cleanup(func() { faStop("dcn-test", 4242) })
if _, ok := faManagedConfig(4242); ok { if _, ok := faManagedConfig("dcn-test", 4242); ok {
t.Fatal("no port file → not configured") t.Fatal("no port file → not configured")
} }
os.WriteFile(filepath.Join(dir, "port"), []byte("18473\n"), 0o600) os.WriteFile(filepath.Join(dir, "port"), []byte("18473\n"), 0o600)
c, ok := faManagedConfig(4242) c, ok := faManagedConfig("dcn-test", 4242)
if !ok || c.Addr != "127.0.0.1:18473" || c.CA != "c" { if !ok || c.Addr != "127.0.0.1:18473" || c.CA != "c" {
t.Fatalf("port file → config, got %+v %v", c, ok) t.Fatalf("port file → config, got %+v %v", c, ok)
} }
if _, ok := faConfigFor(4242); !ok { if _, ok := faConfigFor("dcn-test", 4242); !ok {
t.Fatal("faConfigFor must prefer the managed instance") t.Fatal("faConfigFor must prefer the managed instance")
} }
t.Setenv("PRIVATAE_BASTION_AGENT_ADDR", "") t.Setenv("PRIVATAE_BASTION_AGENT_ADDR", "")
if _, ok := faConfigFor(1); ok { if _, ok := faConfigFor("dcn-test", 1); ok {
t.Fatal("unknown store with no env → absent") t.Fatal("unknown store with no env → absent")
} }
if !strings.Contains(faAbsentReason(1), "no local agent") { if !strings.Contains(faAbsentReason("dcn-test", 1), "no local agent") {
t.Fatal("absent reason for an unknown store") t.Fatal("absent reason for an unknown store")
} }
} }
// A beat's freeagent capability and freeagent_ok are its own pairing's agents
// only. Probed across every pairing, Host B's beat carried Host A's agent's
// health, and with B's freeagent_stores now empty the Host reads the
// capability alone (the Host's store-card check: `"freeagent"
// in caps and not stores`), so A's serving agent marked every one of B's
// stores on this machine as served.
func TestHeartbeatProbesOnlyItsOwnPairingsAgents(t *testing.T) {
t.Setenv("PRIVATAE_BASTION_AGENT_ADDR", "") // no hand-run agent
dcnA, dcnB := t.TempDir(), t.TempDir()
faMgr.Lock()
// no port file: A's agent is managed and not serving
faMgr.inst[faKey{dcnA, 7}] = &faInstance{StoreID: 7, Dir: t.TempDir(), Cert: "a", Key: "a"}
faMgr.Unlock()
t.Cleanup(func() { faStop(dcnA, 7) })
beat := func(dir string) map[string]any {
var body map[string]any
raw := buildHeartbeatBodyOn(beatLanes{dcnDir: dir}, "", "box", "linux", "test", "pub", "fp", "", "", false, nil, nil, nil)
if err := json.Unmarshal([]byte(raw), &body); err != nil {
t.Fatal(err)
}
return body
}
// MUTATION: probe every pairing's instances (no k.Dir filter in
// faManagedProbe). RESULT: red, B's beat carries freeagent_ok false.
if b, ok := beat(dcnB)["freeagent_ok"]; ok {
t.Errorf("Host B holds no agent here, yet its beat says freeagent_ok %v", b)
}
if b, ok := beat(dcnA)["freeagent_ok"]; !ok || b != false {
t.Errorf("Host A's beat must carry its own agent's health: %v %v", b, ok)
}
if b, ok := beat("")["freeagent_ok"]; ok {
t.Errorf("a beat with no DCN state probes no managed agent: %v", b)
}
}
// End to end with the real artifact: FREEAGENT_TEST_PYZ=/path/to/freeagent-x.pyz // End to end with the real artifact: FREEAGENT_TEST_PYZ=/path/to/freeagent-x.pyz
func TestFaManagedEndToEnd(t *testing.T) { func TestFaManagedEndToEnd(t *testing.T) {
pyzPath := os.Getenv("FREEAGENT_TEST_PYZ") pyzPath := os.Getenv("FREEAGENT_TEST_PYZ")
@@ -264,7 +299,7 @@ func TestFaManagedEndToEnd(t *testing.T) {
} }
faReconcile(dcnDir) // what the daemon does at start faReconcile(dcnDir) // what the daemon does at start
t.Cleanup(func() { faStop(1) }) t.Cleanup(func() { faStop(dcnDir, 1) })
stateDir, err := faStoreDir(dcnDir, 1) stateDir, err := faStoreDir(dcnDir, 1)
if err != nil { if err != nil {
t.Fatal(err) t.Fatal(err)
@@ -274,7 +309,7 @@ func TestFaManagedEndToEnd(t *testing.T) {
var c freeagentConfig var c freeagentConfig
for time.Now().Before(deadline) { for time.Now().Before(deadline) {
faMgr.Lock() faMgr.Lock()
inst := faMgr.inst[1] inst := faMgr.inst[faKey{dcnDir, 1}]
state, detail := "", "" state, detail := "", ""
if inst != nil { if inst != nil {
state, detail = inst.State, inst.Detail state, detail = inst.State, inst.Detail
@@ -283,7 +318,7 @@ func TestFaManagedEndToEnd(t *testing.T) {
if state == "failed" || state == "missing-python" { if state == "failed" || state == "missing-python" {
t.Fatalf("managed install %s: %s", state, detail) t.Fatalf("managed install %s: %s", state, detail)
} }
if cfg, ok := faManagedConfig(1); ok { if cfg, ok := faManagedConfig(dcnDir, 1); ok {
c = cfg c = cfg
break break
} }
@@ -395,11 +430,11 @@ func TestFaManagedEndToEnd(t *testing.T) {
} }
} }
// heartbeat sees it // heartbeat sees it
adv, allOK := faManagedProbe() adv, allOK := faManagedProbe(dcnDir)
if !adv || !allOK { if !adv || !allOK {
t.Fatalf("managed probe: %v %v", adv, allOK) t.Fatalf("managed probe: %v %v", adv, allOK)
} }
st := faManagedStatus()["1"].(map[string]any) st := faManagedStatus(dcnDir)["1"].(map[string]any)
if st["state"] != "running" || st["serving"] != true || st["version"] != "9.9.9" { if st["state"] != "running" || st["serving"] != true || st["version"] != "9.9.9" {
t.Fatalf("status: %v", st) t.Fatalf("status: %v", st)
} }
@@ -417,7 +452,7 @@ func TestFaManagedEndToEnd(t *testing.T) {
// a re-approved grant with narrower terms restarts // a re-approved grant with narrower terms restarts
// the instance under the new manifest (new excludes, new serve port) // the instance under the new manifest (new excludes, new serve port)
before, _ := faSnapshot(1) before, _ := faSnapshot(dcnDir, 1)
terms2 := map[string]any{} terms2 := map[string]any{}
for k, v := range terms { for k, v := range terms {
terms2[k] = v terms2[k] = v
@@ -432,9 +467,9 @@ func TestFaManagedEndToEnd(t *testing.T) {
deadline = time.Now().Add(60 * time.Second) deadline = time.Now().Add(60 * time.Second)
var after faInstance var after faInstance
for time.Now().Before(deadline) { for time.Now().Before(deadline) {
after, _ = faSnapshot(1) after, _ = faSnapshot(dcnDir, 1)
if after.State == "running" && after.Text != before.Text { if after.State == "running" && after.Text != before.Text {
if c2, ok := faManagedConfig(1); ok && c2.Addr != c.Addr { if c2, ok := faManagedConfig(dcnDir, 1); ok && c2.Addr != c.Addr {
break break
} }
} }
@@ -448,10 +483,10 @@ func TestFaManagedEndToEnd(t *testing.T) {
t.Fatal("re-rendered manifest must carry the new excludes and be re-signed") t.Fatal("re-rendered manifest must carry the new excludes and be re-signed")
} }
// unchanged terms on the next reconcile: no restart (same port) // unchanged terms on the next reconcile: no restart (same port)
c3, _ := faManagedConfig(1) c3, _ := faManagedConfig(dcnDir, 1)
faReconcile(dcnDir) faReconcile(dcnDir)
time.Sleep(time.Second) time.Sleep(time.Second)
c4, _ := faManagedConfig(1) c4, _ := faManagedConfig(dcnDir, 1)
if c3.Addr != c4.Addr { if c3.Addr != c4.Addr {
t.Fatal("identical terms must not restart the instance") t.Fatal("identical terms must not restart the instance")
} }
@@ -459,7 +494,7 @@ func TestFaManagedEndToEnd(t *testing.T) {
// A fresh identity with a surviving manifest (new layout, wiped base, a // A fresh identity with a surviving manifest (new layout, wiped base, a
// re-pair): the manifest must be re-signed under the new cert, or the // re-pair): the manifest must be re-signed under the new cert, or the
// gate refuses it and serve answers 503 forever. // gate refuses it and serve answers 503 forever.
faStop(1) faStop(dcnDir, 1)
_, privDir, _, _ := faStoreDirs(dcnDir, 1) _, privDir, _, _ := faStoreDirs(dcnDir, 1)
if err := os.RemoveAll(filepath.Join(privDir, "host.key")); err != nil { if err := os.RemoveAll(filepath.Join(privDir, "host.key")); err != nil {
t.Fatal(err) t.Fatal(err)
@@ -470,15 +505,15 @@ func TestFaManagedEndToEnd(t *testing.T) {
deadline = time.Now().Add(60 * time.Second) deadline = time.Now().Add(60 * time.Second)
var c9 freeagentConfig var c9 freeagentConfig
for time.Now().Before(deadline) { for time.Now().Before(deadline) {
if cfg, ok := faManagedConfig(1); ok && cfg.Addr != "" { if cfg, ok := faManagedConfig(dcnDir, 1); ok && cfg.Addr != "" {
if st, _ := faSnapshot(1); st.State == "running" && st.Cert != "" { if st, _ := faSnapshot(dcnDir, 1); st.State == "running" && st.Cert != "" {
if _, body, err := freeagentCall(cfg, http.MethodGet, "/health", nil); err == nil && strings.Contains(string(body), `"serving": true`) { if _, body, err := freeagentCall(cfg, http.MethodGet, "/health", nil); err == nil && strings.Contains(string(body), `"serving": true`) {
c9 = cfg c9 = cfg
break break
} }
} }
} }
if st, _ := faSnapshot(1); st.State == "failed" { if st, _ := faSnapshot(dcnDir, 1); st.State == "failed" {
t.Fatalf("re-identity: %s", st.Detail) t.Fatalf("re-identity: %s", st.Detail)
} }
time.Sleep(500 * time.Millisecond) time.Sleep(500 * time.Millisecond)
+10 -2
View File
@@ -330,8 +330,16 @@ func TestASanitizeStampNamesTheModeThatRan(t *testing.T) {
} }
} }
} }
if !strings.Contains(faSanitizeNotes["flag"], "names") { // The agent's rules pass (pii/detect.py) does not look for these, so the
t.Fatal("the flag note must say names are left in") // note the host relays must say they can still be there.
for _, left := range []string{"names", "street addresses", "dates of birth", "passport",
"other bank account numbers", "other crypto addresses"} {
if !strings.Contains(faSanitizeNotes["flag"], left) {
t.Errorf("the flag note must say %s can still be in the text: %q", left, faSanitizeNotes["flag"])
}
}
if strings.Contains(faSanitizeNotes["flag"], "ID numbers, IP") || strings.Contains(faSanitizeNotes["flag"], "bank and ID") {
t.Errorf("the flag note says ID or bank numbers were replaced, which the rules pass does not do: %q", faSanitizeNotes["flag"])
} }
} }
+48
View File
@@ -345,3 +345,51 @@ func FuzzADeviceApprovalIsReadOneWayOnly(f *testing.F) {
} }
}) })
} }
// FuzzAGrantsRunBoundsHoldWhateverTheHostSends: whatever bounds text a host
// sends, a run bound the machine accepts is one it can hold — a window has a
// length, a zone and a day, a rate names a limit inside the ceilings — and
// judging a run against it at any moment answers, never panics, and never
// lets a run inside an interval or past a day's count.
func FuzzAGrantsRunBoundsHoldWhateverTheHostSends(f *testing.F) {
m := &opManifest{Params: map[string]opParam{"count": {Type: "integer", Min: ptr64(1), Max: ptr64(5)}}}
for _, s := range []string{
`{"_window":{"days":["mon"],"from":"22:00","to":"06:00","tz":"Europe/Berlin"}}`,
`{"_rate":{"per_day":2,"min_interval_s":600},"count":{"max":2}}`,
`{"_window":null,"_rate":null}`, `{"_x":1}`, `{"_window":{"from":"02:00","to":"02:00"}}`,
} {
f.Add(s, int64(1761739200), int64(300))
}
f.Fuzz(func(t *testing.T, raw string, at, gap int64) {
b, err := parseGrantBounds(m, raw)
if err != nil {
return
}
if w := b.Window; w != nil {
if w.from == w.to || w.loc == nil || w.day == [7]bool{} {
t.Fatalf("accepted a window that is no window: %s", raw)
}
}
if r := b.Rate; r != nil {
if (r.PerDay == nil && r.MinInterval == nil) || (r.PerDay != nil && (*r.PerDay < 1 || *r.PerDay > opGrantUsesMax)) ||
(r.MinInterval != nil && (*r.MinInterval < 1 || *r.MinInterval > opRateMinInterval)) {
t.Fatalf("accepted a rate outside the ceilings: %s", raw)
}
}
now := time.Unix(at%(1<<40), 0)
last := now.Add(-time.Duration(gap%(1<<30)) * time.Second)
if last.After(now) {
last = now
}
why, _, _ := opNotNowWhy(b, []time.Time{last}, now)
if b.Window == nil && b.Rate != nil && b.Rate.MinInterval != nil &&
now.Sub(last) < time.Duration(*b.Rate.MinInterval)*time.Second && why == "" {
t.Fatalf("a run inside the interval was let through: %s", raw)
}
if b.Window == nil && b.Rate != nil && b.Rate.PerDay != nil && *b.Rate.PerDay == 1 && now.Sub(last) < 24*time.Hour && why == "" {
t.Fatalf("a second run in a day was let through: %s", raw)
}
})
}
func ptr64(v int64) *int64 { return &v }
+123
View File
@@ -0,0 +1,123 @@
package main
// Fuzz the walls a host's value meets in observe:folders, observe:journal,
// observe:cert and observe:logins. Whatever the input, a path that passes is
// absolute, clean and outside the kernel's trees; a unit that passes is in
// systemd's alphabet and shaped like no flag; a server name that passes is a
// DNS name; and the sshd parser names only addresses as sources and bounded
// names as users, whatever a remote side put in a user name.
import (
"net/netip"
"path"
"strings"
"testing"
)
func FuzzFolderPathIsAbsoluteCleanAndOffTheKernelTrees(f *testing.F) {
for _, s := range []string{"/", "/var/lib", "/var//lib/", "/proc", "//proc/1", "/a/../proc", "/a..b",
"rel", "/dev/shm", "/x\x00y", "/\xff", "/srv/./data", "/sys/", "/devices"} {
f.Add(s)
}
f.Fuzz(func(t *testing.T, in string) {
p, err := checkFolderPath(in)
if err != nil {
return
}
if !strings.HasPrefix(p, "/") || path.Clean(p) != p || strings.Contains(p, "..") {
t.Fatalf("%q passed as %q", in, p)
}
for _, r := range p {
if r < 0x20 || r == 0x7f {
t.Fatalf("%q passed with a control character", in)
}
}
for _, root := range folderRefusedRoots {
if p == root || strings.HasPrefix(p, root+"/") {
t.Fatalf("%q passed into %s", in, root)
}
}
})
}
func FuzzUnitNameIsSystemdsAlphabet(f *testing.F) {
for _, s := range []string{"example", "getty@tty1", `dev-disk-by\x2dlabel-data.device`, "-.mount", "--unit=x",
"worker@.service", "a@b@c", "x;id", "data.mount", ".service", "@x"} {
f.Add(s)
}
f.Fuzz(func(t *testing.T, in string) {
u, err := normalizeUnitName(in)
if err != nil {
return
}
if !unitNameRe.MatchString(u) || len(u) > unitNameMax || !hasUnitSuffix(u) {
t.Fatalf("%q passed as %q", in, u)
}
if strings.HasPrefix(u, "-") || strings.HasPrefix(u, ".") || strings.HasPrefix(u, "@") {
t.Fatalf("%q passed as a flag-shaped %q", in, u)
}
if u != in && u != in+".service" {
t.Fatalf("%q became %q: the name is kept or given .service, nothing else", in, u)
}
})
}
func FuzzCertArgsAreAPortAndADNSName(f *testing.F) {
for _, s := range [][2]string{{"443", "box-a.example"}, {"0", ""}, {"65536", "x"}, {"443", "-x"},
{"443", "a..b"}, {"8443", "192.0.2.10"}, {" 443 ", "A.EXAMPLE"}, {"443", "a_b"}} {
f.Add(s[0], s[1])
}
f.Fuzz(func(t *testing.T, port, name string) {
p, n, err := parseCertArgs([]string{port, name})
if err != nil {
return
}
if p < 1 || p > 65535 || !serverNameRe.MatchString(n) || n != strings.ToLower(n) ||
strings.HasPrefix(n, "-") || strings.HasPrefix(n, ".") || strings.Contains(n, "..") {
t.Fatalf("(%q, %q) passed as (%d, %q)", port, name, p, n)
}
})
}
func FuzzSSHLoginsNameOnlyAddressesAndBoundedNames(f *testing.F) {
f.Add(fxSSHD)
f.Add("2026-10-29T10:00:01+00:00 h sshd[1]: Invalid user a from 1.2.3.4 port 1 from 203.0.113.5 port 2\n")
f.Add("2026-10-29T10:00:01+00:00 h sshd[1]: Failed password for x from evil/host port 1 ssh2\n")
f.Add("x y z: Accepted publickey for \x00 from ::1 port 9 ssh2: K\n")
f.Fuzz(func(t *testing.T, text string) {
tally := parseSSHLogins(text)
var rep loginsReport
tally.fill(&rep)
sum := 0
for src, n := range tally.bySource {
sum += n
if _, err := netip.ParseAddr(src); err != nil && !loginHostRe.MatchString(src) {
t.Fatalf("source %q is not an address or a host name", src)
}
}
if sum != rep.FailedTotal {
t.Fatalf("sources count %d, total %d", sum, rep.FailedTotal)
}
users := 0
for name, u := range tally.byUser {
users += u.Count
if len(name) > loginNameMax || loginName(name) != name {
t.Fatalf("user %q is not a bounded name", name)
}
}
if users != rep.FailedTotal {
t.Fatalf("users count %d, total %d", users, rep.FailedTotal)
}
if len(rep.Accepted) > loginsTopN || rep.AcceptedTotal < len(rep.Accepted) {
t.Fatalf("accepted %d of %d", len(rep.Accepted), rep.AcceptedTotal)
}
for _, a := range rep.Accepted {
if _, err := netip.ParseAddr(a.Source); err != nil && !loginHostRe.MatchString(a.Source) {
t.Fatalf("accepted source %q", a.Source)
}
if loginName(a.User) != a.User || loginMethod(a.Method) != a.Method {
t.Fatalf("accepted %+v", a)
}
}
})
}
+3 -2
View File
@@ -137,13 +137,14 @@ func landsInside(root, p string) bool {
return false return false
} }
// excludedOnDisk is the fixture's excludes (".ssh", "*.key") judged // excludedOnDisk is the fixture's excludes (".ssh", "*.key"), and the local
// search agent's folder (".agent", which no grant reaches), judged
// independently of dcnExcluded: on the path relative to the root after every // independently of dcnExcluded: on the path relative to the root after every
// link is followed, and on the text of the path the sandbox opens. // link is followed, and on the text of the path the sandbox opens.
func excludedOnDisk(root, p string) bool { func excludedOnDisk(root, p string) bool {
check := func(rel string) bool { check := func(rel string) bool {
for _, seg := range strings.Split(rel, "/") { for _, seg := range strings.Split(rel, "/") {
if seg == ".ssh" || strings.HasSuffix(seg, ".key") { if seg == ".ssh" || strings.HasSuffix(seg, ".key") || strings.EqualFold(seg, ".agent") {
return true return true
} }
} }
+11 -9
View File
@@ -2,12 +2,13 @@ package main
// Git lane: Gitea through the Host. // Git lane: Gitea through the Host.
// //
// git.privatae.ai answers only platform/DMZ addresses now, so the user's LOCAL git // This bastion offers a loopback HTTP proxy for the user's LOCAL git to reach
// cannot reach it. This bastion offers a loopback HTTP proxy for git; every local // git.privatae.ai through their host; every local connection is spliced over the
// connection is spliced over the tunnel into ONE WebSocket on the host (/bastion-git, // tunnel into ONE WebSocket on the host (/bastion-git, same bearer + mTLS binding
// same bearer + mTLS binding as the other lanes) and the host relays it out the // as the other lanes) and the host relays it on to the forge. Which addresses the
// platform path to git.privatae.ai ONLY. The wire framing is the egress lane's // forge itself answers is the forge's rule; nothing here sets or checks it. The
// ('D'+bytes / 'E' end) with the roles swapped, so wsConn is reused unchanged. // wire framing is the egress lane's ('D'+bytes / 'E' end) with the roles swapped,
// so wsConn is reused unchanged.
// //
// Setup for the user (printed by `privatae-bastion git-setup`): // Setup for the user (printed by `privatae-bastion git-setup`):
// git config --global http.https://git.privatae.ai.proxy http://127.0.0.1:<port> // git config --global http.https://git.privatae.ai.proxy http://127.0.0.1:<port>
@@ -148,7 +149,7 @@ func cmdGitCredential(host string, action string) error {
case len(cfgs) == 1: case len(cfgs) == 1:
cfg = cfgs[0] cfg = cfgs[0]
case len(cfgs) == 0: case len(cfgs) == 0:
return fmt.Errorf("not paired yet — run `privatae-bastion pair <token>` first") return fmt.Errorf("not paired yet — connect a Host first: %s", asAdmin("pair <token>"))
default: default:
return fmt.Errorf("%d hosts are paired — configure the helper with --host: "+ return fmt.Errorf("%d hosts are paired — configure the helper with --host: "+
"credential.https://git.privatae.ai.helper \"!privatae-bastion git-credential --host <host>\"", len(cfgs)) "credential.https://git.privatae.ai.helper \"!privatae-bastion git-credential --host <host>\"", len(cfgs))
@@ -199,7 +200,8 @@ func gitCredentialReply(body []byte, authtype bool) []byte {
return []byte("username=" + user + "\npassword=" + pass + "\nquit=1\n") return []byte("username=" + user + "\npassword=" + pass + "\nquit=1\n")
} }
// cmdGitSetup prints the two git config lines for every pairing. // cmdGitSetup prints the three git config lines for every pairing: the proxy,
// the reset of the forge's helper chain, and the helper.
func cmdGitSetup() error { func cmdGitSetup() error {
all, err := loadPairings() all, err := loadPairings()
if err != nil { if err != nil {
@@ -208,7 +210,7 @@ func cmdGitSetup() error {
if len(all) == 0 { if len(all) == 0 {
return fmt.Errorf("no pairings — run `privatae-bastion pair <token>` first") return fmt.Errorf("no pairings — run `privatae-bastion pair <token>` first")
} }
fmt.Println("git through your bastion (git.privatae.ai is reachable only this way):") fmt.Println("git to git.privatae.ai through this bastion and your host:")
if len(all) > 1 { if len(all) > 1 {
fmt.Println("(several hosts are paired: pick ONE for git, and name it with --host in the helper line)") fmt.Println("(several hosts are paired: pick ONE for git, and name it with --host in the helper line)")
} }
+58 -11
View File
@@ -114,7 +114,11 @@ func runHarnessWorkers(pctx context.Context, self, dcnDir string, wsURL string,
} }
for i := 0; i < n; i++ { for i := 0; i < n; i++ {
go func() { go func() {
hold := laneHoldFor(self)
for pctx.Err() == nil { for pctx.Err() == nil {
if !hold.waitClear(pctx) {
return
}
ctx, cancel := context.WithTimeout(pctx, 25*time.Second) ctx, cancel := context.WithTimeout(pctx, 25*time.Second)
ws, _, err := dialer.DialContext(ctx, wsURL, http.Header{}) ws, _, err := dialer.DialContext(ctx, wsURL, http.Header{})
cancel() cancel()
@@ -127,12 +131,16 @@ func runHarnessWorkers(pctx context.Context, self, dcnDir string, wsURL string,
sleepCtx(pctx, time.Second) sleepCtx(pctx, time.Second)
continue continue
} }
held := watchHeldClose(ws)
stopKA := armWSKeepalive(ws) // ping/read-deadline: a dead tunnel unblocks the park stopKA := armWSKeepalive(ws) // ping/read-deadline: a dead tunnel unblocks the park
unpark := context.AfterFunc(pctx, func() { _ = ws.Close() }) unpark := context.AfterFunc(pctx, func() { _ = ws.Close() })
handleHarnessConn(ws, self, dcnDir) // blocks until a job, serves it, then returns handleHarnessConn(ws, self, dcnDir) // blocks until a job, serves it, then returns
unpark() unpark()
stopKA() stopKA()
_ = ws.Close() _ = ws.Close()
if held() {
hold.refused(self) // the Host holds this machine (lanehold.go)
}
} }
}() }()
} }
@@ -252,16 +260,39 @@ func harnessGate(self, dcnDir string, spec harnessSpec) string {
// `BEARER <bearer> lane=session`); a harness worker refuses it so a shell can never hold // `BEARER <bearer> lane=session`); a harness worker refuses it so a shell can never hold
// an agent worker for hours. // an agent worker for hours.
func handleHarnessConn(ws *websocket.Conn, self, dcnDir string) { func handleHarnessConn(ws *websocket.Conn, self, dcnDir string) {
mt, data, err := ws.ReadMessage() // The spec is read up to harnessSpecMaxBytes (lane_bounds.go) and refused
if err != nil || mt != websocket.BinaryMessage || len(data) == 0 { // past it; a frame of any other tag is not read at all.
tag, body, tooBig, err := readLaneJob(ws, func(t byte) int64 {
if t == 'H' {
return harnessSpecMaxBytes
}
return 0
})
if err != nil {
return return
} }
if data[0] == 'S' { if tag == 'S' {
sendHarness(ws, 'E', []byte("this is a harness worker; sessions go to a worker that said lane=session\n")) sendHarness(ws, 'E', []byte("this is a harness worker; sessions go to a worker that said lane=session\n"))
sendHarnessExit(ws, 1) sendHarnessExit(ws, 1)
return return
} }
if data[0] != 'H' { if tag != 'H' {
return
}
if tooBig {
// Gated like a spec that does not parse (below): a pairing the caps
// refuse learns nothing more from a frame that was too large.
if why := capsAllow(self, "harness:run"); why != "" {
b, _ := json.Marshal(map[string]any{"ok": false, "error": why})
sendHarness(ws, 'J', b)
sendHarnessExit(ws, 126)
return
}
b, _ := json.Marshal(map[string]any{"ok": false, "error": fmt.Sprintf(
"the harness spec is more than the %d MiB a job on this lane may be; nothing of it was read as a job",
harnessSpecMaxBytes>>20)})
sendHarness(ws, 'J', b)
sendHarnessExit(ws, 1)
return return
} }
// The gate depends on WHAT is asked: a service-slot job (service.go) is the // The gate depends on WHAT is asked: a service-slot job (service.go) is the
@@ -270,7 +301,7 @@ func handleHarnessConn(ws *websocket.Conn, self, dcnDir string) {
// before its parse error is reported, exactly as it always was, so an // before its parse error is reported, exactly as it always was, so an
// unauthorized pairing learns nothing from a malformed frame. // unauthorized pairing learns nothing from a malformed frame.
var spec harnessSpec var spec harnessSpec
perr := json.Unmarshal(data[1:], &spec) perr := json.Unmarshal(body, &spec)
gateOp := "harness:run" gateOp := "harness:run"
if perr == nil && spec.Mode == "service" { if perr == nil && spec.Mode == "service" {
gateOp = serviceGateOp(spec.ServiceOp) gateOp = serviceGateOp(spec.ServiceOp)
@@ -332,12 +363,10 @@ func handleHarnessConn(ws *websocket.Conn, self, dcnDir string) {
go func() { b, c := runHarness(spec); resCh <- harnessRes{b, c} }() go func() { b, c := runHarness(spec); resCh <- harnessRes{b, c} }()
closed := make(chan struct{}) closed := make(chan struct{})
go func() { go func() {
for { // Nothing the host sends during a run is read as anything: each frame
if _, _, err := ws.ReadMessage(); err != nil { // host close or drop // is dropped as it arrives (lane_bounds.go), never held whole.
_ = drainLane(ws) // returns on a host close or drop
close(closed) close(closed)
return
}
}
}() }()
ticker := time.NewTicker(8 * time.Second) ticker := time.NewTicker(8 * time.Second)
defer ticker.Stop() defer ticker.Stop()
@@ -951,7 +980,10 @@ func driveHarnessAgent(rt, dir string, spec harnessSpec, maxMin int) (agentRes m
return nil, fmt.Errorf("harness /run: %v", err) return nil, fmt.Errorf("harness /run: %v", err)
} }
defer resp.Body.Close() defer resp.Body.Close()
rb, _ := io.ReadAll(resp.Body) rb, err := readHarnessRunReply(resp.Body)
if err != nil {
return nil, err
}
var res map[string]interface{} var res map[string]interface{}
if err := json.Unmarshal(rb, &res); err != nil { if err := json.Unmarshal(rb, &res); err != nil {
return nil, fmt.Errorf("harness /run bad json (HTTP %d): %s", resp.StatusCode, truncate(string(rb), 200)) return nil, fmt.Errorf("harness /run bad json (HTTP %d): %s", resp.StatusCode, truncate(string(rb), 200))
@@ -959,6 +991,21 @@ func driveHarnessAgent(rt, dir string, spec harnessSpec, maxMin int) (agentRes m
return res, nil return res, nil
} }
// readHarnessRunReply reads the agent container's answer to /run. The
// container writes it, and it goes back to the host in one lane message, so it
// is read to the most that message carries (uvicornWSMaxSize) and no further:
// a reply that never ends must not grow in this machine's memory.
func readHarnessRunReply(body io.Reader) ([]byte, error) {
rb, err := io.ReadAll(io.LimitReader(body, uvicornWSMaxSize+1))
if err != nil {
return nil, fmt.Errorf("harness /run: reading the reply: %v", err)
}
if len(rb) > uvicornWSMaxSize {
return nil, fmt.Errorf("harness /run: the reply is more than the %d MiB the lane to the host carries", uvicornWSMaxSize>>20)
}
return rb, nil
}
// harnessAgentUID is the user the harness image runs its agent as, the owner // harnessAgentUID is the user the harness image runs its agent as, the owner
// of its home /home/privatae, where the credential folder is mounted. // of its home /home/privatae, where the credential folder is mounted.
const harnessAgentUID = 10005 const harnessAgentUID = 10005
+38 -5
View File
@@ -915,7 +915,7 @@ func TestDeviceApproveAllSignsOnlyWhatWasShown(t *testing.T) {
if err := cmdDeviceApprove("all"); err == nil { if err := cmdDeviceApprove("all"); err == nil {
t.Fatal("nothing shown yet: all must refuse") t.Fatal("nothing shown yet: all must refuse")
} }
if err := cmdDeviceApprovals(); err != nil { if err := cmdDeviceApprovals(nil); err != nil {
t.Fatal(err) t.Fatal(err)
} }
b := file("harness:run") // filed AFTER the person looked b := file("harness:run") // filed AFTER the person looked
@@ -1010,15 +1010,15 @@ func TestAnchoredEgressRefusesLoopbackAndPrivateDestinations(t *testing.T) {
if addr, why := egressVettedAddr(ctx, "localhost:80"); why == "" || addr != "" { if addr, why := egressVettedAddr(ctx, "localhost:80"); why == "" || addr != "" {
t.Fatalf("a refused name yields no address: %q %q", addr, why) t.Fatalf("a refused name yields no address: %q %q", addr, why)
} }
// A local box refuses this machine too, and keeps its LAN // A local box refuses this machine too, and the network around it
// (egress_local_test.go has the rest). // (egress_local_test.go and egress_network_test.go have the rest).
t.Setenv("XDG_CONFIG_HOME", t.TempDir()) t.Setenv("XDG_CONFIG_HOME", t.TempDir())
stubOwnAddrs(t, loopbackOnly, localRange()) stubOwnAddrs(t, loopbackOnly, localRange())
if why := egressInternalRefusal(ctx, "127.0.0.1:11434"); why == "" { if why := egressInternalRefusal(ctx, "127.0.0.1:11434"); why == "" {
t.Fatal("a local box must refuse its own ollama on the egress lane") t.Fatal("a local box must refuse its own ollama on the egress lane")
} }
if addr, why := egressVettedAddr(ctx, "192.168.1.1:80"); why != "" || addr != "192.168.1.1:80" { if addr, why := egressVettedAddr(ctx, "192.168.1.1:80"); why == "" || addr != "" {
t.Fatalf("a local box keeps its LAN: %q %q", addr, why) t.Fatalf("a local box refuses its LAN on the egress lane: %q %q", addr, why)
} }
} }
@@ -1083,3 +1083,36 @@ func TestTheExtractApprovalBindsStableFields(t *testing.T) {
t.Fatal("a re-minted ticket must not change the purpose") t.Fatal("a re-minted ticket must not change the purpose")
} }
} }
// The Host's door itself drops the fields only this machine writes: a
// stepup_request that names a local account as its asker is filed without
// it, so nothing downstream (the audit, a deny's strike) ever sees it.
func TestAHostsDoorDropsTheLocalAskerFields(t *testing.T) {
setupBox(t)
ctx, dcn := t.TempDir(), t.TempDir()
enrollFactor(t, dcn)
hn, _ := os.Hostname()
details := map[string]any{"kind": "mgmt_op", "op": putOp, "server": hn, "args": []any{putJob("").Args[0]},
"asked_by_account": "u", "asker": map[string]any{"account": "u"}}
purpose, err := purposeFromDetails(details)
if err != nil {
t.Fatal(err)
}
raw, _ := json.Marshal(details)
out, errOut, code := driveJob(t, tAnchor, mgmtJob{Op: "stepup_request",
Args: []string{purpose, base64.StdEncoding.EncodeToString(raw)}}, ctx, dcn)
if code != 0 {
t.Fatalf("stepup_request: %d %s %s", code, out, errOut)
}
var reply struct{ Request string }
_ = json.Unmarshal([]byte(out), &reply)
r, ok := requestsLoad(dcn)[reply.Request]
if !ok {
t.Fatalf("no request filed: %s", out)
}
for _, k := range []string{"asked_by_account", "asker"} {
if _, ok := r.Details[k]; ok {
t.Fatalf("a Host's request kept %q: %v", k, r.Details)
}
}
}
+29 -4
View File
@@ -133,18 +133,39 @@ func inferenceFilterNeeded(self string, lane inferenceLane, scope modelScope) bo
// //
// With nothing to enforce it is the original raw splice, byte for byte. // With nothing to enforce it is the original raw splice, byte for byte.
func proxyInference(in net.Conn, upstream string, lane inferenceLane, self string) { func proxyInference(in net.Conn, upstream string, lane inferenceLane, self string) {
proxyInferenceVia(in, dialUpstream(upstream), lane, self, spliceConnVia)
}
// upstreamDial opens the connection to the service behind a forward.
type upstreamDial func() (net.Conn, error)
// dialUpstream is the forwards' dial: TCP to the address, 5 s.
func dialUpstream(upstream string) upstreamDial {
return func() (net.Conn, error) { return net.DialTimeout("tcp", upstream, 5*time.Second) }
}
// proxyInferenceVia is proxyInference with the dial, and the pass-through for
// a connection with nothing to enforce, in the caller's hands. The serve lane
// (servelane.go) uses it so its connections take the same decision and the
// same filter as the tunnel's, while the dial goes to the address it vetted
// and is watched by its idle bound.
func proxyInferenceVia(in net.Conn, dial upstreamDial, lane inferenceLane, self string, pass func(net.Conn, upstreamDial)) {
if inferenceFilterNeeded(self, lane, pairingModelScope(self)) { if inferenceFilterNeeded(self, lane, pairingModelScope(self)) {
serveInferenceFiltered(in, upstream, lane, self) serveInferenceFilteredVia(in, dial, lane, self)
return return
} }
spliceConn(in, upstream) pass(in, dial)
} }
// spliceConn is what the forwards did before this file existed, unchanged and // spliceConn is what the forwards did before this file existed, unchanged and
// in one place now that three call sites share it. // in one place now that three call sites share it.
func spliceConn(in net.Conn, upstream string) { func spliceConn(in net.Conn, upstream string) {
spliceConnVia(in, dialUpstream(upstream))
}
func spliceConnVia(in net.Conn, dial upstreamDial) {
defer in.Close() defer in.Close()
out, err := net.DialTimeout("tcp", upstream, 5*time.Second) out, err := dial()
if err != nil { if err != nil {
return return
} }
@@ -163,8 +184,12 @@ func spliceConn(in net.Conn, upstream string) {
// grant on every request below, so there is nowhere for a caller — including a // grant on every request below, so there is nowhere for a caller — including a
// test — to hand it one the grant does not say. // test — to hand it one the grant does not say.
func serveInferenceFiltered(in net.Conn, upstream string, lane inferenceLane, self string) { func serveInferenceFiltered(in net.Conn, upstream string, lane inferenceLane, self string) {
serveInferenceFilteredVia(in, dialUpstream(upstream), lane, self)
}
func serveInferenceFilteredVia(in net.Conn, dial upstreamDial, lane inferenceLane, self string) {
defer in.Close() defer in.Close()
out, err := net.DialTimeout("tcp", upstream, 5*time.Second) out, err := dial()
if err != nil { if err != nil {
writeFilterError(in, nil, http.StatusBadGateway, "the service behind this lane is not answering") writeFilterError(in, nil, http.StatusBadGateway, "the service behind this lane is not answering")
return return
+76
View File
@@ -0,0 +1,76 @@
package main
import (
"os"
"os/exec"
"path/filepath"
"strings"
"testing"
)
// install.ps1 has no Windows runner here, so its -Pair shape is read from the
// file: the code is checked before anything is downloaded, reaches `pair -`
// on standard input and never an argument, exit 3 is success, and the
// install with no flag still ends the way it did.
func TestInstallPs1PairShape(t *testing.T) {
raw, err := os.ReadFile(filepath.Join("..", "deploy", "install.ps1"))
if err != nil {
t.Fatal(err)
}
s := string(raw)
for _, want := range []string{
"param([switch]$Networked, [switch]$Shared, [switch]$Personal, [switch]$JustMe, [string]$Pair,",
"$Pair | & $exe pair -",
"elseif ($rc -eq 3)",
"Start-ScheduledTask -TaskName 'PrivataeBastion'",
"Restart-Service -Name 'PrivataeBastion'",
// The whole machine by default, through one UAC prompt; the code
// reaches the elevated step in a file, and the owner by SID.
"Start-Process -FilePath 'powershell.exe' -Verb RunAs",
"[IO.File]::WriteAllText($pf, $Pair)",
"& $exe approvals-owner --sid $owner",
"if (-not $elevatedDone) {",
} {
if !strings.Contains(s, want) {
t.Errorf("install.ps1 lacks %q", want)
}
}
for _, bad := range []string{"pair $Pair", "pair -- $Pair", "-ArgumentList $Pair", "Write-Host $Pair", "$Pair\"", "'$Pair'",
"-Pair '$Pair'", "-Pair $Pair"} {
if strings.Contains(s, bad) {
t.Errorf("install.ps1 must never put the code in an argument or the output: %q", bad)
}
}
check, fetch := strings.Index(s, "StartsWith('skp_')"), strings.Index(s, `Write-Host "Fetching manifest..."`)
if check < 0 || fetch < 0 || check > fetch {
t.Error("the pairing code must be checked before the manifest is fetched")
}
}
// The -Pair block itself, run by pwsh against a stand-in bastion
// (testdata/install_ps1_pair.ps1). Skipped where pwsh is not installed.
func TestInstallPs1PairBlockRunsUnderPwsh(t *testing.T) {
pwsh, err := exec.LookPath("pwsh")
if err != nil {
t.Skip("pwsh is not installed: install.ps1's -Pair block is checked only by TestInstallPs1PairShape here")
}
out, err := exec.Command(pwsh, "-NoProfile", "-NonInteractive", "-File",
filepath.Join("testdata", "install_ps1_pair.ps1"), filepath.Join("..", "deploy", "install.ps1")).CombinedOutput()
if err != nil || !strings.HasPrefix(strings.TrimSpace(string(out)), "ok:") {
t.Fatalf("%v\n%s", err, out)
}
}
// The elevation block, run by pwsh with Windows' prompt stood in
// (testdata/install_ps1_elevate.ps1). Skipped where pwsh is not installed.
func TestInstallPs1ElevatesForTheWholeMachineUnderPwsh(t *testing.T) {
pwsh, err := exec.LookPath("pwsh")
if err != nil {
t.Skip("pwsh is not installed: install.ps1's elevation is checked only by TestInstallPs1PairShape here")
}
out, err := exec.Command(pwsh, "-NoProfile", "-NonInteractive", "-File",
filepath.Join("testdata", "install_ps1_elevate.ps1"), filepath.Join("..", "deploy", "install.ps1")).CombinedOutput()
if err != nil || !strings.HasPrefix(strings.TrimSpace(string(out)), "ok:") {
t.Fatalf("%v\n%s", err, out)
}
}
+621
View File
@@ -3,10 +3,13 @@
package main package main
import ( import (
"crypto/sha256"
"encoding/hex"
"os" "os"
"os/exec" "os/exec"
"path/filepath" "path/filepath"
"regexp" "regexp"
"strings"
"testing" "testing"
) )
@@ -74,3 +77,621 @@ func TestInstallShKeepsAPairedLocalMachineLocal(t *testing.T) {
t.Fatal("a machine with no pairing gets the networked default") t.Fatal("a machine with no pairing gets the networked default")
} }
} }
// installShPrivatePIDs is what a test that reaches install.sh's
// start_bastion runs under. start_bastion stops every copy of this user's
// bastion it can see in /proc, and on a machine that runs a real bastion as
// this user (root on a server) that would be the real one. So the test must
// see only its own processes: nil when it already runs in a PID namespace of
// its own (CI's container), the unshare prefix that makes one when it can,
// and a skip otherwise.
//
// The machine's own PID namespace is the kernel's initial one, whose number
// is fixed (PROC_PID_INIT_INO, 0xEFFFFFFC); any other is a namespace of its
// own. NSpid in /proc/self/status cannot tell: inside a container /proc is
// the container's, so it shows one level there too.
func installShPrivatePIDs(t *testing.T) []string {
t.Helper()
ns, err := os.Readlink("/proc/self/ns/pid")
if err == nil && ns != "pid:[4026531836]" {
return nil
}
if err == nil && os.Geteuid() == 0 {
if u, err := exec.LookPath("unshare"); err == nil {
wrap := []string{u, "--pid", "--fork", "--mount-proc"}
if exec.Command(wrap[0], append(wrap[1:], "true")...).Run() == nil {
return wrap
}
}
}
t.Skip("install.sh's start_bastion stops every copy of this user's bastion; run this test in a PID namespace of its own (unshare --pid --fork --mount-proc, as root)")
return nil
}
// installShHere is a copy of deploy/install.sh whose machine_install_present
// looks in dir instead of the machine running the test, which may well have
// the bastion installed for the whole machine. machine says whether the copy
// finds one there.
func installShHere(t *testing.T, dir string, machine bool) string {
t.Helper()
raw, err := os.ReadFile(filepath.Join("..", "deploy", "install.sh"))
if err != nil {
t.Fatal(err)
}
fn := installShFunc(t, "machine_install_present")
unit := filepath.Join(dir, "machine-unit")
if machine {
if err := os.WriteFile(unit, nil, 0o600); err != nil {
t.Fatal(err)
}
}
here := "machine_install_present() {\n [ -f '" + unit + "' ]\n}\n"
out := filepath.Join(dir, "install.sh")
if err := os.WriteFile(out, []byte(strings.Replace(string(raw), fn, here, 1)), 0o600); err != nil {
t.Fatal(err)
}
return out
}
// pairShSetup is a stand-in machine for install.sh: a log directory, a
// home, and a PATH directory of stand-ins for systemctl, loginctl and sleep,
// each logging what it was given. unit is how the stand-in systemd reports
// the user unit: "steady" (one process, running) or "flapping" (a new
// process on every look, auto-restarting).
type pairShSetup struct {
dir, logs, bin, path, home string
}
func newPairShSetup(t *testing.T) *pairShSetup {
t.Helper()
d := t.TempDir()
s := &pairShSetup{dir: d, logs: filepath.Join(d, "log"), bin: filepath.Join(d, "bin"), path: filepath.Join(d, "path"), home: filepath.Join(d, "home")}
for _, p := range []string{s.logs, s.bin, s.path, s.home} {
if err := os.MkdirAll(p, 0o700); err != nil {
t.Fatal(err)
}
}
s.write(t, filepath.Join(s.path, "systemctl"), `#!/bin/sh
echo "$*" >> "$LOGS/systemctl"
case "$*" in
*"show -p MainPID --value"*)
if [ "$UNIT" = flapping ]; then n=$(cat "$LOGS/n" 2>/dev/null || echo 100); n=$((n + 1)); echo "$n" > "$LOGS/n"; echo "$n"; else echo 4242; fi ;;
*"show -p ActiveState --value"*) if [ "$UNIT" = flapping ]; then echo activating; else echo active; fi ;;
*"show -p SubState --value"*) if [ "$UNIT" = flapping ]; then echo auto-restart; else echo running; fi ;;
esac
exit 0
`)
s.write(t, filepath.Join(s.path, "loginctl"), "#!/bin/sh\necho \"$*\" >> \"$LOGS/loginctl\"\nexit \"$LINGER_RC\"\n")
s.write(t, filepath.Join(s.path, "sleep"), "#!/bin/sh\nexit 0\n")
// sudo is ALWAYS a stand-in. The suite runs as root, and the installer run
// as a pretend ordinary account installs for the whole machine through
// sudo: the real one would hand the published installer to root on the
// machine running the test. This one refuses, as sudo does for an account
// that may not use it, unless a test says otherwise (sudoStandIn).
s.write(t, filepath.Join(s.path, "sudo"), sudoRefuses)
return s
}
// sudoRefuses is sudo for an account that may not use it.
const sudoRefuses = "#!/bin/sh\necho \"sudo $*\" >> \"${LOGS:-/dev/null}\"/sudo 2>/dev/null\necho \"Sorry, user tester may not run sudo.\" >&2\nexit 1\n"
func (s *pairShSetup) write(t *testing.T, p, body string) {
t.Helper()
if err := os.WriteFile(p, []byte(body), 0o700); err != nil {
t.Fatal(err)
}
}
func (s *pairShSetup) env(extra ...string) []string {
return append([]string{"PATH=" + s.path + ":/usr/bin:/bin", "HOME=" + s.home, "XDG_CONFIG_HOME=" + filepath.Join(s.home, ".config"),
"LOGS=" + s.logs, "TMPDIR=" + s.dir}, extra...)
}
// standInCopy puts a copy of this test binary at dir/privatae-bastion: run
// with installShStandInRun it is a bastion that waits to be stopped, under
// the program name install.sh looks for.
func standInCopy(t *testing.T, dir string) string {
t.Helper()
self, err := os.Executable()
if err != nil {
t.Fatal(err)
}
b, err := os.ReadFile(self)
if err != nil {
t.Fatal(err)
}
p := filepath.Join(dir, "privatae-bastion")
if err := os.WriteFile(p, b, 0o755); err != nil {
t.Fatal(err)
}
return p
}
// pairShHarness runs install.sh's pairing functions against a stand-in
// bastion, systemctl and loginctl. It returns the run's output, the log
// directory and its error. With copyRunning, a copy of the bastion from another
// path is running when the functions start, and log/copy says whether it
// still was when they ended.
func pairShHarness(t *testing.T, root, pairRC, lingerRC string) (string, string, error) {
t.Helper()
return pairShHarnessWith(t, root, pairRC, lingerRC, "steady", false)
}
func pairShHarnessWith(t *testing.T, root, pairRC, lingerRC, unit string, copyRunning bool) (string, string, error) {
t.Helper()
wrap := installShPrivatePIDs(t)
s := newPairShSetup(t)
fake := filepath.Join(s.bin, "privatae-bastion")
s.write(t, fake, `#!/bin/sh
echo "HOME=$HOME $*" >> "$LOGS/argv"
case "$1" in
pair) cat > "$LOGS/stdin"; exit "$PAIR_RC" ;;
status) echo "status: paired" ;;
esac
exit 0
`)
copyPath := ""
if copyRunning {
other := filepath.Join(s.dir, "other-install")
if err := os.MkdirAll(other, 0o700); err != nil {
t.Fatal(err)
}
copyPath = standInCopy(t, other)
}
fns := installShFunc(t, "pair_as") + installShFunc(t, "bastion_copy") + installShFunc(t, "stop_user_copies") +
installShFunc(t, "user_unit_stays_up") + installShFunc(t, "start_bastion") + installShFunc(t, "pair_and_start")
script := fns + `
if [ -n "$COPY" ]; then
"$COPY" ` + installShStandInRun + ` >/dev/null 2>&1 &
copy=$!
i=0
while ! bastion_copy "$copy" && [ "$i" -lt 100 ]; do i=$((i + 1)); /bin/sleep 0.05; done
bastion_copy "$copy" || { echo "the stand-in copy never started" >&2; exit 97; }
fi
rc=0
pair_and_start "$1" "$2" "$3" linux || rc=$?
if [ -n "$COPY" ]; then
if bastion_copy "$copy"; then echo alive > "$LOGS/copy"; kill -9 "$copy"; else echo gone > "$LOGS/copy"; fi
fi
exit "$rc"
`
args := append(append([]string{}, wrap...), "sh", "-c", script, "sh", fake, "skp_INVENTEDCODE", root)
cmd := exec.Command(args[0], args[1:]...)
cmd.Env = s.env("PAIR_RC="+pairRC, "LINGER_RC="+lingerRC, "UNIT="+unit, "COPY="+copyPath)
out, err := cmd.CombinedOutput()
return string(out), s.logs, err
}
func readPairShLog(t *testing.T, dir, name string) string {
t.Helper()
b, _ := os.ReadFile(filepath.Join(dir, name))
return string(b)
}
// The pairing functions hand the code to `pair -` on standard input, never
// as an argument, then write and start a systemd user unit, ask for
// lingering, and end with one plain sentence. Exit 3 (already paired with
// this Host) is success.
func TestInstallShPairsOverStdinAndStartsAUserUnit(t *testing.T) {
out, logs, err := pairShHarness(t, "0", "0", "0")
if err != nil {
t.Fatalf("%v\n%s", err, out)
}
argv := readPairShLog(t, logs, "argv")
if !strings.Contains(argv, " pair -\n") || strings.Contains(argv, "skp_") {
t.Fatalf("the code must reach `pair -` on stdin and never an argument: %q", argv)
}
if got := readPairShLog(t, logs, "stdin"); got != "skp_INVENTEDCODE\n" {
t.Fatalf("pair's standard input: %q", got)
}
home := strings.TrimPrefix(strings.Fields(argv)[0], "HOME=")
unit, err := os.ReadFile(filepath.Join(home, ".config", "systemd", "user", "privatae-bastion.service"))
if err != nil || !regexp.MustCompile(`(?m)^ExecStart=\S+/privatae-bastion run$`).Match(unit) || !strings.Contains(string(unit), "WantedBy=default.target") {
t.Fatalf("the user unit: %v\n%s", err, unit)
}
sc := readPairShLog(t, logs, "systemctl")
for _, want := range []string{"--user daemon-reload", "--user enable privatae-bastion", "--user restart privatae-bastion"} {
if !strings.Contains(sc, want+"\n") {
t.Fatalf("systemctl was not asked to %q: %q", want, sc)
}
}
if !strings.Contains(readPairShLog(t, logs, "loginctl"), "enable-linger ") {
t.Fatal("lingering was not asked for")
}
if !strings.Contains(out, "status: paired") || !strings.HasSuffix(strings.TrimSpace(out),
"This machine is paired. The bastion runs as your systemd user service privatae-bastion, and starts at boot.") {
t.Fatalf("the ending: %s", out)
}
out, _, err = pairShHarness(t, "0", "3", "1")
if err != nil || !strings.Contains(out, "already paired with this Host") || !strings.Contains(out, "sudo loginctl enable-linger") {
t.Fatalf("exit 3 is success, and a refused linger says how to get it: %v\n%s", err, out)
}
out, logs, err = pairShHarness(t, "0", "1", "0")
if err == nil || strings.Contains(readPairShLog(t, logs, "systemctl"), "restart") || !strings.Contains(out, "pairing did not finish") {
t.Fatalf("a failed pair must stop before starting anything: %v\n%s", err, out)
}
out, logs, err = pairShHarness(t, "1", "0", "0")
if err != nil || !strings.Contains(readPairShLog(t, logs, "argv"), "HOME=/root ") ||
readPairShLog(t, logs, "systemctl") != "restart privatae-bastion\n" || strings.Contains(out, "user service") {
t.Fatalf("as root it pairs as the service's state and restarts the system service: %v\n%s\n%s", err, out, readPairShLog(t, logs, "systemctl"))
}
}
// Linux, as yourself: a copy of the bastion already running outside the
// user unit (from a terminal, or another path) is stopped before the unit
// starts, so the unit's copy is the one that serves; and a unit that does not
// stay up is said plainly, with a failure, never reported as running.
func TestInstallShStopsAnOutsideCopyAndChecksTheUnitStaysUp(t *testing.T) {
out, logs, err := pairShHarnessWith(t, "0", "0", "0", "steady", true)
if err != nil {
t.Fatalf("%v\n%s", err, out)
}
if got := strings.TrimSpace(readPairShLog(t, logs, "copy")); got != "gone" {
t.Fatalf("the copy running outside the unit must be stopped, it is %q\n%s", got, out)
}
if !strings.Contains(out, "Stopped 1 copy(ies) of the bastion running outside its service") {
t.Fatalf("the stop is said: %s", out)
}
sc := readPairShLog(t, logs, "systemctl")
if i, j := strings.Index(sc, "--user stop privatae-bastion\n"), strings.Index(sc, "--user restart privatae-bastion\n"); i < 0 || j < i {
t.Fatalf("the unit is stopped before the copies and started after: %q", sc)
}
if !strings.HasSuffix(strings.TrimSpace(out), "This machine is paired. The bastion runs as your systemd user service privatae-bastion, and starts at boot.") {
t.Fatalf("the ending: %s", out)
}
out, _, err = pairShHarnessWith(t, "0", "0", "0", "flapping", false)
if err == nil || !strings.Contains(out, "is not staying up") || !strings.Contains(out, "activating/auto-restart") ||
!strings.Contains(out, "journalctl --user -u privatae-bastion") || strings.Contains(out, "The bastion runs as your systemd user service") {
t.Fatalf("a unit that restarts must be reported as not running, and fail: %v\n%s", err, out)
}
}
// The whole of install.sh, the card's way: the code in PRIVATAE_PAIR_CODE
// and no argument. Every program it starts (stand-ins for uname, id, curl,
// printf, systemctl, loginctl and sleep, and the downloaded bastion) records
// its own arguments, the command line of the shell that started it, and
// whether the code is in its environment. The code must reach `pair -` on
// standard input and appear in none of those. Nothing leaves this machine:
// curl is a stand-in serving a manifest and a stand-in bastion.
func TestInstallShTakesTheCodeOnlyFromTheEnvironment(t *testing.T) {
wrap := installShPrivatePIDs(t)
s := newPairShSetup(t)
const code = "skp_eyJ2IjoxLCJ0IjoiSU5WRU5URUQtRU5WLUNPREUifQ"
record := `echo "$(basename "$0") argv=[$*] parent=[$(tr '\0' ' ' < /proc/$PPID/cmdline)] env=[${PRIVATAE_PAIR_CODE+set}] envcode=[$(env | grep -c "` + code + `")]" >> "$LOGS/procs"
`
bastion := "#!/bin/sh\n" + record + `case "$1" in
pair) cat > "$LOGS/stdin" ;;
status) echo "status: paired" ;;
esac
exit 0
`
s.write(t, filepath.Join(s.dir, "bastion.bin"), bastion)
sum := sha256.Sum256([]byte(bastion))
s.write(t, filepath.Join(s.dir, "version.json"), "{\n \"linux-amd64\": {\n \"url\": \"https://dl.privatae.ai/dl/privatae-bastion-linux-amd64?v=0.0.0\",\n \"sha256\": \""+hex.EncodeToString(sum[:])+"\"\n }\n}\n")
stand := map[string]string{
"uname": `case "$1" in -s) echo Linux ;; -m) echo x86_64 ;; *) echo Linux ;; esac`,
"id": `case "$1" in -u) echo 1000 ;; -un) echo tester ;; *) echo "uid=1000(tester)" ;; esac`,
"curl": `for a; do o=$a; done; case "$2" in */version.json) cp "$STAND/version.json" "$o" ;; *) cp "$STAND/bastion.bin" "$o" ;; esac`,
"printf": `exec /usr/bin/printf "$@"`,
// No openssl that does Ed25519 here, so the release signature is
// noted as not checked (install_sig_sh_test.go tests the check): this
// stand-in manifest is signed by no release key.
"openssl": `exit 1`,
}
for name, body := range stand {
s.write(t, filepath.Join(s.path, name), "#!/bin/sh\n"+record+body+"\n")
}
for _, name := range []string{"systemctl", "loginctl", "sleep"} {
p := filepath.Join(s.path, name)
b, _ := os.ReadFile(p)
s.write(t, p, strings.Replace(string(b), "#!/bin/sh\n", "#!/bin/sh\n"+record, 1))
}
sh := installShHere(t, s.dir, false)
args := append(append([]string{}, wrap...), "sh", sh)
cmd := exec.Command(args[0], args[1:]...)
cmd.Env = s.env("PRIVATAE_PAIR_CODE="+code, "STAND="+s.dir, "LINGER_RC=0", "UNIT=steady")
out, err := cmd.CombinedOutput()
if err != nil {
t.Fatalf("%v\n%s", err, out)
}
if got := readPairShLog(t, s.logs, "stdin"); got != code+"\n" {
t.Fatalf("pair's standard input: %q\n%s", got, out)
}
procs := readPairShLog(t, s.logs, "procs")
for _, who := range []string{"uname argv=[-s]", "curl argv=[", "privatae-bastion argv=[pair -]", "privatae-bastion argv=[status]", "systemctl argv=[--user restart privatae-bastion]"} {
if !strings.Contains(procs, who) {
t.Fatalf("no record of %q: the stand-ins did not run as expected\n%s\n%s", who, procs, out)
}
}
if strings.Contains(procs, code) || strings.Contains(procs, "INVENTED-ENV-CODE") {
t.Fatalf("the code is in a program's arguments or its shell's command line:\n%s", procs)
}
if strings.Contains(procs, "env=[set]") || !strings.Contains(procs, "envcode=[0]") || strings.Contains(procs, "envcode=[1]") {
t.Fatalf("a program the installer started inherited the code in its environment:\n%s", procs)
}
if strings.Contains(string(out), code) {
t.Fatalf("the installer printed the code:\n%s", out)
}
if !strings.HasSuffix(strings.TrimSpace(string(out)), "https://privatae.ai/bastion/LICENSE.txt") || !strings.Contains(string(out), "This machine is paired.") {
t.Fatalf("the ending: %s", out)
}
// sudo refused (the stand-in), so it is installed for this account, and
// the installer says what that means.
if !strings.Contains(readPairShLog(t, s.logs, "sudo"), " true") || !strings.Contains(string(out), "installed for your account only") ||
!strings.Contains(string(out), "in a terminal, from an account that may use sudo") {
t.Fatalf("the fall back to this account is not said:\n%s", out)
}
}
// A PRIVATAE_PAIR_CODE that is empty or not a whole pairing code is refused
// before anything is downloaded, and never echoed; so is any argument, a
// code given as one (the removed --pair, or the code alone) included.
//
// The script runs with stand-ins for id (not root) and curl (records that it
// was reached, fetches nothing), so an installer whose refusal broke can
// neither reach the network nor install anything as root on the machine
// running the test: it fails here instead.
func TestInstallShRefusesABadPairCodeBeforeDownloading(t *testing.T) {
const code = "skp_eyJ2IjoxfQ"
stand := t.TempDir()
for name, body := range map[string]string{
"id": `case "$1" in -u) echo 1000 ;; -un) echo tester ;; *) echo "uid=1000(tester)" ;; esac`,
"curl": `echo "REACHED-THE-DOWNLOAD" >&2; exit 1`,
"sudo": `echo "REACHED-SUDO" >&2; exit 1`,
} {
if err := os.WriteFile(filepath.Join(stand, name), []byte("#!/bin/sh\n"+body+"\n"), 0o700); err != nil {
t.Fatal(err)
}
}
for _, c := range []struct {
env []string
args []string
}{
{[]string{"PRIVATAE_PAIR_CODE="}, nil},
{[]string{"PRIVATAE_PAIR_CODE=skp_"}, nil},
{[]string{"PRIVATAE_PAIR_CODE=skb_aG9tZS5zZWNyZXQteA"}, nil},
{[]string{"PRIVATAE_PAIR_CODE=" + code + " trailing"}, nil},
{[]string{"PRIVATAE_PAIR_CODE=" + code + "%3D"}, nil},
{nil, []string{"--pair", code}},
{nil, []string{"--pair=" + code}},
{nil, []string{code}},
{nil, []string{"--networkd"}},
} {
home := t.TempDir()
cmd := exec.Command("sh", append([]string{filepath.Join("..", "deploy", "install.sh")}, c.args...)...)
cmd.Env = append([]string{"PATH=" + stand + ":/usr/bin:/bin", "HOME=" + home, "TMPDIR=" + home}, c.env...)
out, err := cmd.CombinedOutput()
ee, ok := err.(*exec.ExitError)
if !ok || ee.ExitCode() != 2 || strings.Contains(string(out), "Fetching manifest") || strings.Contains(string(out), "REACHED-THE-DOWNLOAD") ||
strings.Contains(string(out), "REACHED-SUDO") {
t.Fatalf("%v %v: want exit 2 before the download, got %v\n%s", c.env, c.args, err, out)
}
if strings.Contains(string(out), code) || strings.Contains(string(out), "skb_") || strings.Contains(string(out), "networkd") {
t.Fatalf("%v %v: the refusal echoes what it was given: %s", c.env, c.args, out)
}
}
}
// On a person's own account the installer installs for the whole machine
// through sudo: sudo true first, then root (sudo -H) fetches the installer and
// runs it with --personal, the pairing code on its standard input. sudo's
// arguments never hold the code. What an earlier install for this account
// alone left (never paired) is removed, so it does not run a second bastion.
//
// Nothing here runs as root on the machine running the test: the installer
// root fetches is a stand-in that records what it was given, and sudo runs
// it as the test's own account, in a PID namespace of its own.
func TestInstallShInstallsForTheWholeMachineThroughSudo(t *testing.T) {
wrap := installShPrivatePIDs(t)
s := newPairShSetup(t)
const code = "skp_eyJ2IjoxLCJ0IjoiSU5WRU5URUQtV0hPTEUifQ"
s.write(t, filepath.Join(s.dir, "root-step.sh"), "echo \"$*\" > \"$LOGS/root-args\"\ncat > \"$LOGS/root-stdin\"\nexit 0\n")
s.write(t, filepath.Join(s.path, "sudo"), "#!/bin/sh\necho \"$*\" >> \"$LOGS/sudo\"\ncase \"$1\" in -p) exit 0 ;; -H) shift ;; esac\nexec \"$@\"\n")
for name, body := range map[string]string{
"uname": `case "$1" in -s) echo Linux ;; -m) echo x86_64 ;; *) echo Linux ;; esac`,
"id": `case "$1" in -u) echo 1000 ;; -un) echo tester ;; *) echo "uid=1000(tester)" ;; esac`,
"curl": `echo "$*" >> "$LOGS/curl"; for a; do o=$a; done; u=""; for a; do case "$a" in https://*) u=$a ;; esac; done
case "$u" in https://privatae.ai/bastion/install.sh) cp "$STAND/root-step.sh" "$o" ;; *) echo "REACHED-THE-DOWNLOAD" >&2; exit 1 ;; esac`,
} {
s.write(t, filepath.Join(s.path, name), "#!/bin/sh\n"+body+"\n")
}
unit := filepath.Join(s.home, ".config", "systemd", "user", "privatae-bastion.service")
own := filepath.Join(s.home, ".local", "bin", "privatae-bastion")
for _, p := range []string{unit, own} {
if err := os.MkdirAll(filepath.Dir(p), 0o700); err != nil {
t.Fatal(err)
}
s.write(t, p, "an earlier install for this account\n")
}
sh := installShHere(t, s.dir, false)
args := append(append([]string{}, wrap...), "sh", sh)
cmd := exec.Command(args[0], args[1:]...)
cmd.Env = s.env("PRIVATAE_PAIR_CODE="+code, "STAND="+s.dir)
out, err := cmd.CombinedOutput()
if err != nil {
t.Fatalf("%v\n%s", err, out)
}
if got := readPairShLog(t, s.logs, "root-args"); strings.TrimSpace(got) != "--personal --pair-code-on-stdin" {
t.Fatalf("the root step was given %q\n%s", got, out)
}
if got := readPairShLog(t, s.logs, "root-stdin"); got != code+"\n" {
t.Fatalf("the root step's standard input: %q", got)
}
sudo := readPairShLog(t, s.logs, "sudo")
if !strings.HasPrefix(sudo, "-p [bastion] sudo password for %u: true\n") || !strings.Contains(sudo, "/bin/sh -c ") {
t.Fatalf("sudo was asked: %s\n%s", sudo, out)
}
if strings.Contains(sudo, code) || strings.Contains(string(out), code) {
t.Fatalf("the code is in sudo's arguments or the output:\n%s\n%s", sudo, out)
}
// Root's step reads nothing from this account's home: sudo -H, so HOME is
// root's, and curl -q, so no ~/.curlrc can point root's fetch elsewhere.
if !strings.Contains(sudo, "\n-H /bin/sh -c ") {
t.Errorf("the root step runs with this account's HOME (no sudo -H): %s", sudo)
}
if got := readPairShLog(t, s.logs, "curl"); !strings.HasPrefix(got, "-q ") {
t.Errorf("root's fetch of the installer reads a curl config (no -q first): %q", got)
}
if strings.Contains(string(out), "Fetching manifest") || strings.Contains(string(out), "REACHED-THE-DOWNLOAD") {
t.Fatalf("the installer also installed for this account:\n%s", out)
}
for _, p := range []string{unit, own} {
if _, err := os.Stat(p); err == nil {
t.Errorf("%s is still there", p)
}
}
if !strings.Contains(readPairShLog(t, s.logs, "systemctl"), "--user disable --now privatae-bastion") {
t.Error("this account's own unit was not stopped")
}
}
// An account whose own bastion is already paired keeps it on an upgrade:
// sudo is never asked, and the installer goes on for this account.
func TestInstallShKeepsAPairedAccountInstallWhereItIs(t *testing.T) {
s := newPairShSetup(t)
for name, body := range map[string]string{
"uname": `case "$1" in -s) echo Linux ;; -m) echo x86_64 ;; *) echo Linux ;; esac`,
"id": `case "$1" in -u) echo 1000 ;; -un) echo tester ;; *) echo "uid=1000(tester)" ;; esac`,
"curl": `echo "REACHED-THE-DOWNLOAD" >&2; exit 1`,
} {
s.write(t, filepath.Join(s.path, name), "#!/bin/sh\n"+body+"\n")
}
pd := filepath.Join(s.home, ".config", "privatae-bastion", "pairings")
if err := os.MkdirAll(pd, 0o700); err != nil {
t.Fatal(err)
}
s.write(t, filepath.Join(pd, "member.host.privatae.ai.json"), "{}")
cmd := exec.Command("sh", installShHere(t, s.dir, false))
cmd.Env = s.env()
out, _ := cmd.CombinedOutput()
if got := readPairShLog(t, s.logs, "sudo"); got != "" {
t.Fatalf("sudo was asked for a paired account install: %s", got)
}
if !strings.Contains(string(out), "Fetching manifest") {
t.Fatalf("the installer did not go on for this account:\n%s", out)
}
}
// Beside a bastion installed for the whole machine, an account that cannot
// use sudo gets no second bastion of its own (the machine's would refuse it),
// asked for with --just-me or fallen back to.
func TestInstallShInstallsNoSecondBastionBesideTheMachines(t *testing.T) {
for _, args := range [][]string{nil, {"--just-me"}} {
s := newPairShSetup(t)
for name, body := range map[string]string{
"uname": `case "$1" in -s) echo Linux ;; -m) echo x86_64 ;; *) echo Linux ;; esac`,
"id": `case "$1" in -u) echo 1000 ;; -un) echo tester ;; *) echo "uid=1000(tester)" ;; esac`,
"curl": `echo "REACHED-THE-DOWNLOAD" >&2; exit 1`,
} {
s.write(t, filepath.Join(s.path, name), "#!/bin/sh\n"+body+"\n")
}
cmd := exec.Command("sh", append([]string{installShHere(t, s.dir, true)}, args...)...)
cmd.Env = s.env()
out, err := cmd.CombinedOutput()
if ee, ok := err.(*exec.ExitError); !ok || ee.ExitCode() != 1 || strings.Contains(string(out), "REACHED-THE-DOWNLOAD") ||
!strings.Contains(string(out), "installed for the whole machine") {
t.Fatalf("%v: want a refusal before the download, got %v\n%s", args, err, out)
}
}
}
// The root step takes the pairing code on standard input only when told to,
// checks it before anything is downloaded, and never echoes it. --just-me is
// refused as root and beside --shared.
//
// "Root" here is a stand-in id; curl fails every download, so nothing past
// the checks can run.
func TestInstallShRootStepTakesTheCodeOnStdin(t *testing.T) {
stand := t.TempDir()
write := func(name, body string) {
if err := os.WriteFile(filepath.Join(stand, name), []byte("#!/bin/sh\n"+body+"\n"), 0o700); err != nil {
t.Fatal(err)
}
}
write("curl", `echo "REACHED-THE-DOWNLOAD" >&2; exit 1`)
write("sudo", `echo "REACHED-SUDO" >&2; exit 1`)
write("uname", `case "$1" in -s) echo Linux ;; -m) echo x86_64 ;; *) echo Linux ;; esac`)
run := func(uid, stdin string, args ...string) (string, int) {
write("id", `case "$1" in -u) echo `+uid+` ;; -un) echo tester ;; *) echo "uid=`+uid+`" ;; esac`)
home := t.TempDir()
cmd := exec.Command("sh", append([]string{filepath.Join("..", "deploy", "install.sh")}, args...)...)
cmd.Env = []string{"PATH=" + stand + ":/usr/bin:/bin", "HOME=" + home, "TMPDIR=" + home}
cmd.Stdin = strings.NewReader(stdin)
out, err := cmd.CombinedOutput()
if ee, ok := err.(*exec.ExitError); ok {
return string(out), ee.ExitCode()
}
return string(out), 0
}
const code = "skp_eyJ2IjoxLCJ0IjoiU1RESU4ifQ"
out, rc := run("0", code+"\n", "--personal", "--pair-code-on-stdin")
if rc != 1 || !strings.Contains(out, "REACHED-THE-DOWNLOAD") || strings.Contains(out, code) {
t.Fatalf("a good code on stdin did not reach the download, or was echoed (%d):\n%s", rc, out)
}
for _, bad := range []string{"", "skp_\n", "skb_aG9tZQ\n", code + " x\n"} {
out, rc := run("0", bad, "--personal", "--pair-code-on-stdin")
if rc != 2 || strings.Contains(out, "REACHED") || (bad != "" && strings.Contains(out, strings.TrimSpace(bad))) {
t.Fatalf("stdin %q: want exit 2 before the download, unechoed (%d):\n%s", bad, rc, out)
}
}
if out, rc := run("1000", code+"\n", "--pair-code-on-stdin"); rc != 2 || strings.Contains(out, "REACHED") {
t.Fatalf("an ordinary account's --pair-code-on-stdin was taken (%d):\n%s", rc, out)
}
if out, rc := run("0", "", "--just-me"); rc != 2 || !strings.Contains(out, "without sudo") {
t.Fatalf("--just-me as root (%d):\n%s", rc, out)
}
if out, rc := run("1000", "", "--just-me", "--shared"); rc != 2 || strings.Contains(out, "REACHED") {
t.Fatalf("--just-me --shared (%d):\n%s", rc, out)
}
}
// The owner's account is recorded on a person's own computer only. On a
// shared machine the console stays the administrator's.
func TestInstallShRecordsTheOwnerOnAPersonalInstallOnly(t *testing.T) {
d := t.TempDir()
bin := filepath.Join(d, "privatae-bastion")
if err := os.WriteFile(bin, []byte("#!/bin/sh\necho \"$*\" >> \""+filepath.Join(d, "log")+"\"\n"), 0o700); err != nil {
t.Fatal(err)
}
fns := installShFunc(t, "pair_as") + installShFunc(t, "record_owner")
for _, c := range []struct {
networked, sudoUID, want string
}{{"0", "1000", "approvals-owner --account 1000\n"}, {"1", "1000", ""}, {"0", "0", ""}, {"0", "", ""}} {
os.Remove(filepath.Join(d, "log"))
cmd := exec.Command("sh", "-c", fns+`networked=$1; record_owner "$2" 1 linux`, "sh", c.networked, bin)
cmd.Env = []string{"PATH=/usr/bin:/bin", "SUDO_UID=" + c.sudoUID}
if out, err := cmd.CombinedOutput(); err != nil {
t.Fatalf("%+v: %v %s", c, err, out)
}
got, _ := os.ReadFile(filepath.Join(d, "log"))
if string(got) != c.want {
t.Errorf("networked=%s SUDO_UID=%q: recorded %q, want %q", c.networked, c.sudoUID, got, c.want)
}
}
}
// The root step's own failure, whatever its exit code, is never read as sudo
// refusing: the installer stops, and installs nothing for the account.
func TestInstallShRootStepFailureIsNotAFallBack(t *testing.T) {
s := newPairShSetup(t)
s.write(t, filepath.Join(s.dir, "root-step.sh"), "exit 3\n")
s.write(t, filepath.Join(s.path, "sudo"), "#!/bin/sh\nwhile [ \"$1\" = -H ]; do shift; done\ncase \"$1\" in -p) exit 0 ;; esac\nexec \"$@\"\n")
for name, body := range map[string]string{
"uname": `case "$1" in -s) echo Linux ;; -m) echo x86_64 ;; *) echo Linux ;; esac`,
"id": `case "$1" in -u) echo 1000 ;; -un) echo tester ;; *) echo "uid=1000(tester)" ;; esac`,
"curl": `for a; do o=$a; done; for a; do case "$a" in https://privatae.ai/bastion/install.sh) cp "$STAND/root-step.sh" "$o"; exit 0 ;; esac; done; echo "REACHED-THE-DOWNLOAD" >&2; exit 1`,
} {
s.write(t, filepath.Join(s.path, name), "#!/bin/sh\n"+body+"\n")
}
cmd := exec.Command("sh", installShHere(t, s.dir, false))
cmd.Env = s.env("STAND=" + s.dir)
out, err := cmd.CombinedOutput()
ee, ok := err.(*exec.ExitError)
if !ok || ee.ExitCode() != 1 || strings.Contains(string(out), "your account only") || strings.Contains(string(out), "REACHED-THE-DOWNLOAD") {
t.Fatalf("want exit 1 and no install for the account, got %v\n%s", err, out)
}
}
+327
View File
@@ -0,0 +1,327 @@
package main
import (
"bytes"
"crypto/ed25519"
"crypto/rand"
"crypto/sha256"
"encoding/base64"
"encoding/hex"
"net/http"
"net/http/httptest"
"os"
"os/exec"
"path/filepath"
"regexp"
"strings"
"testing"
)
// ed25519SPKIPrefix is the DER that wraps a raw Ed25519 public key in the
// SubjectPublicKeyInfo openssl reads (RFC 8410).
var ed25519SPKIPrefix = []byte{0x30, 0x2a, 0x30, 0x05, 0x06, 0x03, 0x2b, 0x65, 0x70, 0x03, 0x21, 0x00}
func installShVar(t *testing.T, name string) string {
t.Helper()
raw, err := os.ReadFile(filepath.Join("..", "deploy", "install.sh"))
if err != nil {
t.Fatal(err)
}
m := regexp.MustCompile(`(?m)^` + name + `='([^']*)'$`).FindSubmatch(raw)
if m == nil {
t.Fatalf("install.sh sets no %s", name)
}
return string(m[1])
}
func spkiToRaw(t *testing.T, b64 string) []byte {
t.Helper()
der, err := base64.StdEncoding.DecodeString(b64)
if err != nil || len(der) != len(ed25519SPKIPrefix)+ed25519.PublicKeySize || !bytes.HasPrefix(der, ed25519SPKIPrefix) {
t.Fatalf("not an Ed25519 public key: %q (%v)", b64, err)
}
return der[len(ed25519SPKIPrefix):]
}
// The installer checks a release with exactly the keys a bastion checks its
// updates with: a key rotated in release_sign.go and not here would make
// every install refuse, or accept a key the bastions no longer do.
func TestInstallShPinsTheReleaseKeysTheBastionChecks(t *testing.T) {
keys := strings.Fields(installShVar(t, "RELEASE_KEYS"))
if len(keys) != len(productionReleaseKeys) {
t.Fatalf("install.sh pins %d release keys, release_sign.go %d", len(keys), len(productionReleaseKeys))
}
for i, k := range keys {
if got := base64.StdEncoding.EncodeToString(spkiToRaw(t, k)); got != productionReleaseKeys[i] {
t.Errorf("install.sh key %d is %s, release_sign.go has %s", i, got, productionReleaseKeys[i])
}
}
}
// The probe is what tells "this openssl cannot check" from "the signature is
// wrong". A probe that did not verify would make every system read as unable,
// and every install skip the signature with a note.
func TestInstallShProbeSignatureVerifies(t *testing.T) {
pub := spkiToRaw(t, installShVar(t, "SIG_PROBE_KEY"))
sig, err := base64.StdEncoding.DecodeString(installShVar(t, "SIG_PROBE_SIG"))
if err != nil {
t.Fatal(err)
}
if !ed25519.Verify(ed25519.PublicKey(pub), []byte("privatae-installer-probe-v1\n"), sig) {
t.Fatal("the probe signature does not verify under the probe key")
}
}
// sigHarness is release_signature_check from install.sh, with the release
// keys replaced by key and the download host by base, run on manifest.
func sigHarness(t *testing.T, pub ed25519.PublicKey, base string, manifest []byte, onlyPATH ...bool) (string, error) {
t.Helper()
raw, err := os.ReadFile(filepath.Join("..", "deploy", "install.sh"))
if err != nil {
t.Fatal(err)
}
s := string(raw)
vars := regexp.MustCompile(`(?ms)^RELEASE_KEYS=.*?^SIG_PROBE_SIG='[^']*'$`).FindString(s)
fn := regexp.MustCompile(`(?ms)^release_signature_check\(\) \{.*?^\}$`).FindString(s)
if vars == "" || fn == "" {
t.Fatal("install.sh's release_signature_check or its keys moved")
}
if len(onlyPATH) > 0 && onlyPATH[0] {
// Only the openssl on PATH: a Mac with Homebrew's openssl@3 would
// otherwise find a real one at its fixed path.
loop := regexp.MustCompile(`(?m)^ for c in openssl [^;]*; do$`)
if !loop.MatchString(fn) {
t.Fatal("install.sh's openssl candidates moved")
}
fn = loop.ReplaceAllString(fn, " for c in openssl; do")
}
der := append(append([]byte{}, ed25519SPKIPrefix...), pub...)
vars = regexp.MustCompile(`(?m)^RELEASE_KEYS='[^']*'$`).ReplaceAllString(vars,
"RELEASE_KEYS='"+base64.StdEncoding.EncodeToString(der)+"'")
d := t.TempDir()
if err := os.WriteFile(filepath.Join(d, "man.json"), manifest, 0o600); err != nil {
t.Fatal(err)
}
if err := os.Mkdir(filepath.Join(d, "v"), 0o700); err != nil {
t.Fatal(err)
}
script := "die() { echo \"ERROR: $*\" >&2; exit 1; }\nSHACMD=sha256sum\nsha_of() { $SHACMD \"$1\" | cut -d' ' -f1; }\n" +
"base='" + base + "'\n" + vars + "\n" + fn + "\nrelease_signature_check \"$1\" \"$2\"\necho RETURNED\n"
sh := filepath.Join(d, "h.sh")
if err := os.WriteFile(sh, []byte(script), 0o600); err != nil {
t.Fatal(err)
}
out, err := exec.Command("sh", sh, filepath.Join(d, "man.json"), filepath.Join(d, "v")).CombinedOutput()
return string(out), err
}
func releaseSigFor(priv ed25519.PrivateKey, manifest []byte, version string) (name, b64 string) {
sum := sha256.Sum256(manifest)
stmt := releaseStatement("bastion", version, hex.EncodeToString(sum[:]))
return "/version.json." + hex.EncodeToString(sum[:8]) + ".sig",
base64.StdEncoding.EncodeToString(ed25519.Sign(priv, stmt))
}
func TestInstallShRefusesAReleaseWhoseSignatureDoesNotVerify(t *testing.T) {
requireTools(t, "sh", "openssl", "sha256sum", "curl")
pub, priv, _ := ed25519.GenerateKey(rand.Reader)
_, other, _ := ed25519.GenerateKey(rand.Reader)
manifest := []byte("{\n \"version\": \"9.9.9\",\n \"binaries\": {}\n}\n")
name, good := releaseSigFor(priv, manifest, "9.9.9")
_, wrongKey := releaseSigFor(other, manifest, "9.9.9")
_, wrongVersion := releaseSigFor(priv, manifest, "9.9.8")
serve := map[string]string{}
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
v, ok := serve[r.URL.Path]
if !ok {
http.NotFound(w, r)
return
}
_, _ = w.Write([]byte(v))
}))
defer srv.Close()
// The check needs an openssl that does Ed25519; without one it only
// notes it, which TestInstallShSaysWhenItCannotCheckTheSignature covers.
// Whether this one can is asked of openssl here, never read off the
// installer's note: a probe broken in install.sh would print that note on
// every machine, and this test would skip while every install skipped the
// signature.
// MUTATION: break the probe's pkeyutl flags in install.sh. RESULT: red here
// (it skipped before).
if !opensslChecksEd25519(t) {
skipOrFail(t, "the openssl here does not check Ed25519 signatures")
}
serve[name] = good
out, err := sigHarness(t, pub, srv.URL, manifest)
if err != nil || strings.Contains(out, "no openssl here can check") ||
!strings.Contains(out, "Release signature verified (version 9.9.9)") || !strings.Contains(out, "RETURNED") {
t.Fatalf("a good signature: %v\n%s", err, out)
}
for what, sig := range map[string]string{"another key's": wrongKey, "another version's": wrongVersion} {
serve[name] = sig
// MUTATION: return 0 after the key loop. RESULT: red, these install.
if out, err := sigHarness(t, pub, srv.URL, manifest); err == nil || strings.Contains(out, "RETURNED") ||
!strings.Contains(out, "does not verify") {
t.Errorf("%s signature: %v\n%s", what, err, out)
}
}
serve[name] = "not base64 at all !"
if out, err := sigHarness(t, pub, srv.URL, manifest); err == nil || !strings.Contains(out, "malformed") {
t.Errorf("a malformed signature: %v\n%s", err, out)
}
delete(serve, name)
if out, err := sigHarness(t, pub, srv.URL, manifest); err == nil || !strings.Contains(out, "cannot fetch the release's signature") {
t.Errorf("no signature: %v\n%s", err, out)
}
}
// opensslChecksEd25519 says, without install.sh, whether the openssl on PATH
// verifies an Ed25519 signature made here, and refuses one over another
// message.
func opensslChecksEd25519(t *testing.T) bool {
t.Helper()
if _, err := exec.LookPath("openssl"); err != nil {
return false
}
pub, priv, _ := ed25519.GenerateKey(rand.Reader)
der := append(append([]byte{}, ed25519SPKIPrefix...), pub...)
d := t.TempDir()
files := map[string][]byte{
"k.pem": []byte("-----BEGIN PUBLIC KEY-----\n" + base64.StdEncoding.EncodeToString(der) + "\n-----END PUBLIC KEY-----\n"),
"m": []byte("capability\n"),
"other": []byte("capability?\n"),
"s": ed25519.Sign(priv, []byte("capability\n")),
}
for n, b := range files {
if err := os.WriteFile(filepath.Join(d, n), b, 0o600); err != nil {
t.Fatal(err)
}
}
verify := func(msg string) bool {
return exec.Command("openssl", "pkeyutl", "-verify", "-pubin", "-inkey", filepath.Join(d, "k.pem"), "-rawin",
"-in", filepath.Join(d, msg), "-sigfile", filepath.Join(d, "s")).Run() == nil
}
return verify("m") && !verify("other")
}
// An openssl that passes every signature is no check: the installer must not
// take it for one and print "verified" over a signature no pinned key made.
// It is set aside like one that cannot check; a later candidate that can
// still checks.
func TestInstallShTakesNoOpensslThatPassesEverySignature(t *testing.T) {
requireTools(t, "sh", "openssl", "sha256sum", "curl")
systemSSL, _ := exec.LookPath("openssl")
fake := t.TempDir()
if err := os.WriteFile(filepath.Join(fake, "openssl"),
[]byte("#!/bin/sh\ncase \"$1\" in pkeyutl) exit 0 ;; esac\nexec '"+systemSSL+"' \"$@\"\n"), 0o700); err != nil {
t.Fatal(err)
}
t.Setenv("PATH", fake+string(os.PathListSeparator)+os.Getenv("PATH"))
pub, _, _ := ed25519.GenerateKey(rand.Reader)
_, other, _ := ed25519.GenerateKey(rand.Reader)
manifest := []byte("{\n \"version\": \"9.9.9\",\n \"binaries\": {}\n}\n")
name, forged := releaseSigFor(other, manifest, "9.9.9")
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.URL.Path != name {
http.NotFound(w, r)
return
}
_, _ = w.Write([]byte(forged))
}))
defer srv.Close()
// MUTATION: drop the probe's second verify (the one that must fail).
// RESULT: red, "Release signature verified" over the forged signature.
out, _ := sigHarness(t, pub, srv.URL, manifest)
if strings.Contains(out, "Release signature verified") ||
!(strings.Contains(out, "no openssl here can check") || strings.Contains(out, "does not verify")) {
t.Errorf("an openssl that passes everything was taken for a check:\n%s", out)
}
}
// SECURITY.md sends a reader who does not trust our website to a copy of
// install.sh read from this repository. Run without sudo, that copy installs
// for the whole machine through a root step that fetches the installer from
// the website again (whole_machine_script) and runs that, so the copy read
// checks nothing itself. The page has to say how the copy must be run.
func TestSecurityMdSaysHowAReadCopyOfTheInstallerMustRun(t *testing.T) {
sh, err := os.ReadFile(filepath.Join("..", "deploy", "install.sh"))
if err != nil {
t.Fatal(err)
}
if !strings.Contains(string(sh), `whole_machine_script="https://privatae.ai/bastion/install.sh"`) {
t.Fatal("install.sh's root step no longer fetches the website's installer: re-read SECURITY.md's first-install paragraph, then this test")
}
raw, err := os.ReadFile(filepath.Join("..", "SECURITY.md"))
if err != nil {
t.Fatal(err)
}
sec := strings.Join(strings.Fields(string(raw)), " ")
for _, want := range []string{
"`sudo sh install.sh`",
"`sh install.sh --just-me`",
"fetches the installer from our website again",
"an older release we signed",
} {
if !strings.Contains(sec, want) {
t.Errorf("SECURITY.md does not say %q", want)
}
}
}
// With no openssl that can check Ed25519, the check says so and returns, so
// the digest check still runs; it never reads as verified.
func TestInstallShSaysWhenItCannotCheckTheSignature(t *testing.T) {
if _, err := exec.LookPath("sh"); err != nil {
t.Skip("no sh")
}
fake := t.TempDir()
if err := os.WriteFile(filepath.Join(fake, "openssl"), []byte("#!/bin/sh\nexit 1\n"), 0o700); err != nil {
t.Fatal(err)
}
t.Setenv("PATH", fake+string(os.PathListSeparator)+os.Getenv("PATH"))
pub, _, _ := ed25519.GenerateKey(rand.Reader)
out, err := sigHarness(t, pub, "http://127.0.0.1:1", []byte("{\"version\": \"9.9.9\"}\n"), true)
if err != nil || !strings.Contains(out, "no openssl here can check") || strings.Contains(out, "verified") ||
!strings.Contains(out, "RETURNED") {
t.Errorf("no capable openssl: %v\n%s", err, out)
}
}
// The check runs on every install, after the manifest is fetched and before
// any digest is read out of it: a digest from an unchecked manifest is the
// thing the signature exists to stop.
func TestInstallShChecksTheSignatureBeforeReadingTheDigest(t *testing.T) {
raw, err := os.ReadFile(filepath.Join("..", "deploy", "install.sh"))
if err != nil {
t.Fatal(err)
}
s := string(raw)
fetch := strings.Index(s, `curl -fsSL "$base/version.json" -o "$man"`)
check := strings.Index(s, "\nrelease_signature_check \"$man\" \"$vdir\"\n")
digest := strings.Index(s, "expected=$(awk")
if fetch < 0 || check < 0 || digest < 0 || !(fetch < check && check < digest) {
t.Fatalf("install.sh must fetch the manifest, check its signature, then read its digest (at %d, %d, %d)",
fetch, check, digest)
}
}
// requireTools skips without one of these tools, unless CI says the check
// must run (PRIVATAE_REQUIRE_OPENSSL=1, .gitea/workflows/ci.yml): there a
// missing tool is a failure, so the signature check cannot quietly go untested.
func requireTools(t *testing.T, tools ...string) {
t.Helper()
for _, tool := range tools {
if _, err := exec.LookPath(tool); err != nil {
skipOrFail(t, tool+" is not installed here")
}
}
}
func skipOrFail(t *testing.T, why string) {
t.Helper()
if os.Getenv("PRIVATAE_REQUIRE_OPENSSL") == "1" {
t.Fatalf("%s, and PRIVATAE_REQUIRE_OPENSSL=1 says this check must run", why)
}
t.Skip(why)
}
+122
View File
@@ -0,0 +1,122 @@
package main
// What a paired host sends down a worker lane is read at a size this machine
// chose, never at one the host chose: the host picks a frame's length, and a
// frame of any length must not be held whole in this machine's memory. The
// egress lane (egress_relay.go) and the context socket (contextsock.go) follow
// the same rule.
//
// - A job's first frame (the H spec on a harness worker, the S spec on a
// session worker) is read up to its lane's bound and refused past it, by
// name, before any of it is parsed.
// - What a lane carries after that is streamed: terminal input into the pty
// (session.go), the replica's bytes into its socket (mirror.go). Frames that
// nothing reads (a harness run and a root command, which read nothing after
// their spec) are dropped as they arrive.
import (
"errors"
"fmt"
"io"
"net/http"
"github.com/gorilla/websocket"
)
const (
// harnessSpecMaxBytes bounds the H frame. Its bulk is the worktree tar
// (worktree_b64). The largest tree this lane hands back is
// maxReturnedTreeBytes (9 MiB, so 12 MiB in base64) inside one message of
// uvicornWSMaxSize (16 MiB), the most the host takes in (harness.go). A host
// that sends that tree into its next run needs those 12 MiB, plus the
// prompt and the run's credentials. Twice the lane's message size holds
// that with 20 MiB to spare.
harnessSpecMaxBytes = 2 * uvicornWSMaxSize
// sessionSpecMaxBytes bounds the S frame: a signed grant (op ids and the
// person's own words), ids, a public key, and for session:root:exec the
// command, itself held to rootExecCommandMax (64 KiB), which is at most
// 384 KiB even when JSON escapes every byte as \u00XX. 1 MiB is the bound
// Go's own HTTP server puts on a request head.
sessionSpecMaxBytes = http.DefaultMaxHeaderBytes
// sessionInputMaxBytes bounds one frame on an open terminal. The host relays
// what the person's browser sent it, one message each, and its own server
// takes a message up to uvicornWSMaxSize; the tag is one byte more. Input is
// streamed into the pty, so this caps a frame's length, not memory.
sessionInputMaxBytes = uvicornWSMaxSize + 1
// sessionResizeMaxBytes bounds the body of an R frame, {"cols":N,"rows":N}.
sessionResizeMaxBytes = 4 << 10
// heartbeatReplyMaxBytes bounds the host's answer to a heartbeat. It
// carries directives and the lists of grants this box should hold, each
// entry an id and a signature of about 130 bytes, so 4 MiB is tens of
// thousands of grants. Nothing in it is bulk: an update names a version,
// and the binary comes from the release manifest, not from this reply.
heartbeatReplyMaxBytes = 4 << 20
)
// errLaneNotJob is a first frame that is not a binary frame with a tag.
var errLaneNotJob = errors.New("the first frame is not a job")
// readLaneJob reads a worker's first frame: its tag, and its body up to
// maxFor(tag) bytes. A body past its bound is never kept: tooBig reports it,
// and body is nil. A tag the caller does not take should get a bound of 0;
// its body is then not read at all.
func readLaneJob(ws *websocket.Conn, maxFor func(tag byte) int64) (tag byte, body []byte, tooBig bool, err error) {
mt, r, err := ws.NextReader()
if err != nil {
return 0, nil, false, err
}
if mt != websocket.BinaryMessage {
return 0, nil, false, errLaneNotJob
}
var t [1]byte
if _, err := io.ReadFull(r, t[:]); err != nil {
return 0, nil, false, errLaneNotJob // an empty frame
}
max := maxFor(t[0])
if max <= 0 {
return t[0], nil, false, nil
}
body, err = io.ReadAll(io.LimitReader(r, max+1))
if err != nil {
return t[0], nil, false, err
}
if int64(len(body)) > max {
return t[0], nil, true, nil
}
return t[0], body, false, nil
}
// drainLane reads and drops every frame until the socket fails, holding none
// of them, and returns that failure. A lane that reads nothing after its job
// still has to read, to answer pings and to notice the host going away.
func drainLane(ws *websocket.Conn) error {
for {
_, r, err := ws.NextReader()
if err != nil {
return err
}
if _, err := io.Copy(io.Discard, r); err != nil {
return err
}
}
}
// readHeartbeatReply reads the host's answer to a heartbeat up to
// heartbeatReplyMaxBytes. ok is false for a reply past the bound or one that
// failed to arrive: such a beat is treated as unanswered, so none of its
// directives runs and it does not count as the host answering.
func readHeartbeatReply(resp *http.Response) (body []byte, ok bool) {
body, err := io.ReadAll(io.LimitReader(resp.Body, heartbeatReplyMaxBytes+1))
if err != nil {
return nil, false
}
if len(body) > heartbeatReplyMaxBytes {
fmt.Printf("heartbeat: the host's reply is more than %d MiB; ignored\n", heartbeatReplyMaxBytes>>20)
return nil, false
}
return body, true
}
+126
View File
@@ -0,0 +1,126 @@
package main
// The helpers lane_bounds.go and harness.go added for the reads that were
// inline before (the heartbeat reply in run.go, the agent's /run reply in
// driveHarnessAgent, the drains in harness.go and rootexec.go). They have no
// counterpart on main to run against.
import (
"bytes"
"io"
"net/http"
"net/http/httptest"
"runtime"
"strings"
"sync/atomic"
"testing"
"time"
"github.com/gorilla/websocket"
)
// boxLaneHost stands up the HOST side of one worker socket (host runs on the
// upgraded server end) and returns the box side, dialled.
func boxLaneHost(t *testing.T, host func(c *websocket.Conn)) *websocket.Conn {
t.Helper()
up := websocket.Upgrader{}
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
c, err := up.Upgrade(w, r, nil)
if err != nil {
return
}
defer c.Close()
host(c)
}))
t.Cleanup(srv.Close)
ws, _, err := websocket.DefaultDialer.Dial("ws"+strings.TrimPrefix(srv.URL, "http"), nil)
if err != nil {
t.Fatal(err)
}
t.Cleanup(func() { _ = ws.Close() })
return ws
}
// endless is a body that never ends; served counts what was taken from it.
type endless struct{ served *atomic.Int64 }
func (e endless) Read(p []byte) (int, error) {
for i := range p {
p[i] = 'z'
}
e.served.Add(int64(len(p)))
return len(p), nil
}
func TestHeartbeatReplyIsReadOnlyToItsBound(t *testing.T) {
var served atomic.Int64
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(200)
_, _ = io.Copy(w, io.LimitReader(endless{&served}, 64<<20))
}))
defer srv.Close()
resp, err := http.Get(srv.URL)
if err != nil {
t.Fatal(err)
}
body, ok := readHeartbeatReply(resp)
resp.Body.Close()
if ok || body != nil {
t.Fatalf("a 64 MiB heartbeat reply was taken (%d bytes)", len(body))
}
small := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
_, _ = w.Write([]byte(`{"ok":true,"dcn_grants":{"stores":[]}}`))
}))
defer small.Close()
resp, err = http.Get(small.URL)
if err != nil {
t.Fatal(err)
}
body, ok = readHeartbeatReply(resp)
resp.Body.Close()
if !ok || !strings.Contains(string(body), "dcn_grants") {
t.Fatalf("an ordinary reply was not taken: ok=%v %q", ok, body)
}
}
func TestHarnessRunReplyIsReadOnlyToItsBound(t *testing.T) {
var served atomic.Int64
if _, err := readHarnessRunReply(endless{&served}); err == nil || !strings.Contains(err.Error(), "more than the 16 MiB") {
t.Fatalf("an endless /run reply: %v", err)
}
if n := served.Load(); n > 17<<20 {
t.Fatalf("an endless /run reply was read to %d MiB", n>>20)
}
big := append([]byte(`{"ok":true,"pad":"`), bytes.Repeat([]byte{'a'}, 15<<20)...)
big = append(big, `"}`...)
if rb, err := readHarnessRunReply(bytes.NewReader(big)); err != nil || len(rb) != len(big) {
t.Fatalf("a 15 MiB reply the lane carries: %d bytes, %v", len(rb), err)
}
}
// A drained lane holds no frame whole, and ends when the host goes away.
func TestDrainLaneHoldsNoFrame(t *testing.T) {
const frame = 64 << 20
payload := bytes.Repeat([]byte{'d'}, frame)
start := make(chan struct{})
box := boxLaneHost(t, func(c *websocket.Conn) {
<-start
_ = c.WriteMessage(websocket.BinaryMessage, payload)
})
runtime.GC()
var before, after runtime.MemStats
runtime.ReadMemStats(&before)
close(start)
done := make(chan error, 1)
go func() { done <- drainLane(box) }()
select {
case <-done:
case <-time.After(20 * time.Second):
t.Fatal("drainLane did not return after the host went away")
}
runtime.ReadMemStats(&after)
if grew := after.TotalAlloc - before.TotalAlloc; grew > 8<<20 {
t.Fatalf("draining a %d MiB frame allocated %d MiB", frame>>20, grew>>20)
}
}
+481
View File
@@ -0,0 +1,481 @@
//go:build !windows
package main
// What a paired host sends down the harness, session, root-exec and mirror
// lanes, and what a coder run sends its egress proxy, is read at the size this
// machine chose (lane_bounds.go). Every test here drives only code that main
// already has, so each one also runs against main, where it fails.
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net"
"net/http"
"net/http/httptest"
"os"
"path/filepath"
"runtime"
"strings"
"sync"
"sync/atomic"
"syscall"
"testing"
"time"
"github.com/gorilla/websocket"
)
// hostSendsAJob is a host that writes one job frame while it reads the box's
// replies, and reports whether its write completed and what came back.
type hostResult struct {
werr error
frames map[byte][]byte
}
func hostSendsAJob(frame []byte, out chan<- hostResult) func(c *websocket.Conn) {
return hostSendsAJobAs(func(c *websocket.Conn) error {
return c.WriteMessage(websocket.BinaryMessage, frame)
}, out)
}
// writeInPieces writes msg as ONE message carried by many small frames: the
// writer flushes a continuation frame each time its 4 KiB buffer fills
// (gorilla's default write buffer), so a bound that counted a frame instead
// of the message would let all of it through.
func writeInPieces(msg []byte) func(c *websocket.Conn) error {
return func(c *websocket.Conn) error {
w, err := c.NextWriter(websocket.BinaryMessage)
if err != nil {
return err
}
for off := 0; off < len(msg); off += 1 << 10 {
if _, err := w.Write(msg[off:min(off+1<<10, len(msg))]); err != nil {
return err
}
}
return w.Close()
}
}
func hostSendsAJobAs(write func(c *websocket.Conn) error, out chan<- hostResult) func(c *websocket.Conn) {
return func(c *websocket.Conn) {
got := map[byte][]byte{}
readDone := make(chan struct{})
go func() {
defer close(readDone)
_ = c.SetReadDeadline(time.Now().Add(20 * time.Second))
for {
_, d, err := c.ReadMessage()
if err != nil || len(d) == 0 {
return
}
got[d[0]] = append(got[d[0]], d[1:]...)
if d[0] == 'X' {
return
}
}
}()
werr := write(c)
<-readDone
out <- hostResult{werr, got}
}
}
// jsonFrame is tag + a JSON object whose field `pad` carries n bytes of 'a'.
func jsonFrame(tag byte, head string, n int) []byte {
b := make([]byte, 0, len(head)+n+16)
b = append(b, tag)
b = append(b, head...)
b = append(b, `,"pad":"`...)
b = append(b, bytes.Repeat([]byte{'a'}, n)...)
b = append(b, `"}`...)
return b
}
// A harness spec far past the bound is not read to its end: the box answers
// that it is too large, names the bound, and closes, so the host's write of
// the rest fails. On main the box read all of it into memory, then ran it.
func TestHarnessWorkerStopsReadingASpecPastItsBound(t *testing.T) {
const frame = 96 << 20
out := make(chan hostResult, 1)
box := boxLaneHost(t, hostSendsAJob(jsonFrame('H', `{"harness_id":"big","mode":"echo","prompt":"ping"`, frame), out))
handleHarnessConn(box, "", "")
_ = box.Close()
r := <-out
if r.werr == nil {
t.Fatalf("the box read the whole %d MiB spec (it replied %.200q); it must stop at its bound", frame>>20, r.frames['J'])
}
if !strings.Contains(string(r.frames['J']), "more than the 32 MiB") || string(r.frames['X']) != "1" {
t.Fatalf("want a refusal naming the 32 MiB bound and exit 1: J=%.200q X=%q", r.frames['J'], r.frames['X'])
}
}
// The bound counts the whole message, not one frame of it: a spec past the
// bound, sent as one message in thousands of 4 KiB frames, is refused the same
// way and not read to its end. On main the box read all of it.
func TestHarnessWorkerBoundCountsEveryFrameOfTheSpec(t *testing.T) {
const frame = 40 << 20
out := make(chan hostResult, 1)
spec := jsonFrame('H', `{"harness_id":"pieces","mode":"echo","prompt":"ping"`, frame)
box := boxLaneHost(t, hostSendsAJobAs(writeInPieces(spec), out))
handleHarnessConn(box, "", "")
_ = box.Close()
r := <-out
if r.werr == nil {
t.Fatalf("the box read the whole %d MiB spec sent in small frames (it replied %.200q); it must stop at its bound", frame>>20, r.frames['J'])
}
if !strings.Contains(string(r.frames['J']), "more than the 32 MiB") || string(r.frames['X']) != "1" {
t.Fatalf("want a refusal naming the 32 MiB bound and exit 1: J=%.200q X=%q", r.frames['J'], r.frames['X'])
}
}
// The same for a session spec sent in small frames.
func TestSessionWorkerBoundCountsEveryFrameOfTheSpec(t *testing.T) {
env, _, _ := sessionTestEnv(t, []string{sessionOpOpen}, nil)
withSink(t)
const frame = 64 << 20
out := make(chan hostResult, 1)
spec := jsonFrame('S', `{"op":"session:open","session_id":"sess-pieces"`, frame)
box := boxLaneHost(t, hostSendsAJobAs(writeInPieces(spec), out))
handleSessionWorkerConn(box, "", env)
_ = box.Close()
r := <-out
if r.werr == nil {
t.Fatalf("the box read the whole %d MiB session spec sent in small frames (E=%q X=%q); it must stop at its bound",
frame>>20, r.frames['E'], r.frames['X'])
}
if !strings.Contains(string(r.frames['E']), "more than the 1024 KiB") || string(r.frames['X']) != "1" {
t.Fatalf("want a refusal naming the bound and exit 1: E=%q X=%q", r.frames['E'], r.frames['X'])
}
}
// A spec the lane can carry still runs: a tree as large as the most this lane
// hands back (12 MiB in base64), with room on top, past the 16 MiB a host
// takes in.
func TestHarnessWorkerTakesALargeSpecTheLaneCarries(t *testing.T) {
out := make(chan hostResult, 1)
box := boxLaneHost(t, hostSendsAJob(jsonFrame('H', `{"harness_id":"tree","mode":"echo","prompt":"ping","worktree_b64":"dGFy"`, 20<<20), out))
handleHarnessConn(box, "", "")
r := <-out
if r.werr != nil {
t.Fatalf("the host could not send a 20 MiB spec: %v", r.werr)
}
var res map[string]any
if err := json.Unmarshal(r.frames['J'], &res); err != nil || res["ok"] != true || res["echo"] != "ping" {
t.Fatalf("a 20 MiB spec did not run: J=%.300q X=%q", r.frames['J'], r.frames['X'])
}
}
// The same on a session worker: an S frame far past its 1 MiB bound is
// refused by name and not read to its end.
func TestSessionWorkerStopsReadingASpecPastItsBound(t *testing.T) {
env, _, _ := sessionTestEnv(t, []string{sessionOpOpen}, nil)
withSink(t) // a box that wrongly took the spec opens no real shell
const frame = 64 << 20
out := make(chan hostResult, 1)
box := boxLaneHost(t, hostSendsAJob(jsonFrame('S', `{"op":"session:open","session_id":"sess-big"`, frame), out))
handleSessionWorkerConn(box, "", env)
_ = box.Close()
r := <-out
if r.werr == nil {
t.Fatalf("the box read the whole %d MiB session spec (E=%q X=%q); it must stop at its bound",
frame>>20, r.frames['E'], r.frames['X'])
}
if !strings.Contains(string(r.frames['E']), "more than the 1024 KiB") || string(r.frames['X']) != "1" {
t.Fatalf("want a refusal naming the bound and exit 1: E=%q X=%q", r.frames['E'], r.frames['X'])
}
}
// A session spec near its bound (a grant, and room the size of a root command
// escaped six times over) still opens a terminal.
func TestSessionWorkerOpensASpecNearItsBound(t *testing.T) {
env, terms, sig := sessionTestEnv(t, []string{sessionOpOpen}, nil)
withFake(t)
// Here the test is the host: it takes the server end, and the box runs on
// the dialled end.
hostEnd := make(chan *websocket.Conn, 1)
hold := make(chan struct{})
t.Cleanup(func() { close(hold) })
boxEnd := boxLaneHost(t, func(c *websocket.Conn) { hostEnd <- c; <-hold })
b := <-hostEnd
head := fmt.Sprintf(`{"op":"session:open","session_id":"sess-near","grant_terms_b64":%q,"grant_sig_b64":%q`, terms, sig)
done := make(chan struct{})
go func() { defer close(done); handleSessionWorkerConn(boxEnd, "", env) }()
if err := b.WriteMessage(websocket.BinaryMessage, jsonFrame('S', head, 900<<10)); err != nil {
t.Fatal(err)
}
if err := b.WriteMessage(websocket.BinaryMessage, []byte("Ihello\n")); err != nil {
t.Fatal(err)
}
got := readUntil(t, b, 'O', 5*time.Second)
if string(got['O']) != "hello\n" {
t.Fatalf("a 900 KiB spec did not open a terminal: %q", got)
}
_ = b.Close()
<-done
}
// sinkProc is a terminal that counts what is typed into it and prints nothing.
type sinkProc struct {
n atomic.Int64
killed chan struct{}
once sync.Once
}
func (p *sinkProc) Read(b []byte) (int, error) { <-p.killed; return 0, io.EOF }
func (p *sinkProc) Write(b []byte) (int, error) { p.n.Add(int64(len(b))); return len(b), nil }
func (p *sinkProc) Resize(c, r int) error { return nil }
func (p *sinkProc) Wait() int { <-p.killed; return 0 }
func (p *sinkProc) Kill() { p.once.Do(func() { close(p.killed) }) }
func (p *sinkProc) User() string { return "sink" }
func (p *sinkProc) Shell() string { return "/bin/sink" }
func withSink(t *testing.T) *sinkProc {
t.Helper()
sp := &sinkProc{killed: make(chan struct{})}
old := sessionSpawn
sessionSpawn = func(op, shell string, cols, rows int) (sessionProc, error) { return sp, nil }
t.Cleanup(func() { sessionSpawn = old; sp.Kill() })
return sp
}
func waitFor(d time.Duration, cond func() bool) bool {
end := time.Now().Add(d)
for time.Now().Before(end) {
if cond() {
return true
}
time.Sleep(5 * time.Millisecond)
}
return cond()
}
// Terminal input is streamed into the pty: a 16 MiB paste, the most a host
// relays in one frame, all arrives, and the box never holds it whole.
func TestSessionInputIsStreamedIntoTheTerminal(t *testing.T) {
env, terms, sig := sessionTestEnv(t, []string{sessionOpOpen}, nil)
sp := withSink(t)
ws := sessionDial(t, env)
sendSpec(t, ws, sessionSpec{Op: sessionOpOpen, GrantB64: terms, SigB64: sig, SessionID: "sess-paste"})
const paste = 16 << 20
frame := append([]byte{'I'}, bytes.Repeat([]byte{'x'}, paste)...)
runtime.GC()
var before, after runtime.MemStats
runtime.ReadMemStats(&before)
if err := ws.WriteMessage(websocket.BinaryMessage, frame); err != nil {
t.Fatal(err)
}
if !waitFor(20*time.Second, func() bool { return sp.n.Load() >= paste }) {
t.Fatalf("the terminal got %d of %d bytes", sp.n.Load(), paste)
}
runtime.ReadMemStats(&after)
if grew := after.TotalAlloc - before.TotalAlloc; grew > 8<<20 {
t.Fatalf("typing a %d MiB paste allocated %d MiB: the frame was held whole", paste>>20, grew>>20)
}
}
// One frame of input past the most a host relays ends the session, and the
// terminal never receives all of it.
func TestSessionInputFramePastItsBoundEndsTheSession(t *testing.T) {
env, terms, sig := sessionTestEnv(t, []string{sessionOpOpen}, nil)
sp := withSink(t)
ws := sessionDial(t, env)
sendSpec(t, ws, sessionSpec{Op: sessionOpOpen, GrantB64: terms, SigB64: sig, SessionID: "sess-huge"})
const frame = 17 << 20
go func() {
_ = ws.WriteMessage(websocket.BinaryMessage, append([]byte{'I'}, bytes.Repeat([]byte{'x'}, frame)...))
}()
ended := func() bool {
select {
case <-sp.killed:
return true
default:
return false
}
}
if !waitFor(20*time.Second, ended) {
t.Fatalf("a %d MiB input frame did not end the session; the terminal got %d bytes", frame>>20, sp.n.Load())
}
if n := sp.n.Load(); n >= frame {
t.Fatalf("the terminal received all %d bytes of a frame past the bound", n)
}
}
// The mirror forwarder streams a host frame into the replica's socket: reading
// 4 KiB of a 64 MiB frame does not need the frame held whole.
func TestMirrorForwarderStreamsAHostFrame(t *testing.T) {
const frame = 64 << 20
payload := bytes.Repeat([]byte{'m'}, frame)
start := make(chan struct{})
up := websocket.Upgrader{}
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
c, err := up.Upgrade(w, r, nil)
if err != nil {
return
}
defer c.Close()
_, _, _ = c.ReadMessage() // the BEARER hello
<-start
_ = c.WriteMessage(websocket.BinaryMessage, payload)
time.Sleep(3 * time.Second)
}))
defer srv.Close()
addr := srv.Listener.Addr().String()
dialer := &websocket.Dialer{NetDialContext: func(ctx context.Context, n, a string) (net.Conn, error) {
return (&net.Dialer{}).DialContext(ctx, "tcp", addr)
}}
boxEnd, replica := net.Pipe()
defer replica.Close()
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
go pipeMirrorConn(ctx, boxEnd, dialer, "ws://"+addr+"/", "b")
buf := make([]byte, 4096)
runtime.GC()
var before, after runtime.MemStats
runtime.ReadMemStats(&before)
close(start)
_ = replica.SetReadDeadline(time.Now().Add(20 * time.Second))
if _, err := io.ReadFull(replica, buf); err != nil || buf[0] != 'm' {
t.Fatalf("the replica read: %v", err)
}
runtime.ReadMemStats(&after)
if grew := after.TotalAlloc - before.TotalAlloc; grew > 8<<20 {
t.Fatalf("passing 4 KiB of a %d MiB host frame to the replica allocated %d MiB: the frame was held whole",
frame>>20, grew>>20)
}
}
// The forwarder carries at most eight connections at once. It listens on a
// fixed port (5433), so the test needs that port free: run it in its own
// network namespace on a machine where something already holds it.
func TestMirrorForwarderCapsConnectionsInFlight(t *testing.T) {
probe, err := net.Listen("tcp", "127.0.0.1:5433")
if err != nil {
t.Skipf("127.0.0.1:5433 is in use here (%v); run this test in its own network namespace", err)
}
_ = probe.Close()
var live, most atomic.Int64
release := make(chan struct{})
up := websocket.Upgrader{}
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
c, err := up.Upgrade(w, r, nil)
if err != nil {
return
}
defer c.Close()
n := live.Add(1)
for {
m := most.Load()
if n <= m || most.CompareAndSwap(m, n) {
break
}
}
<-release
live.Add(-1)
}))
defer srv.Close()
defer close(release)
addr := srv.Listener.Addr().String()
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
go serveMirrorForward(ctx, "127.0.0.1", "127.0.0.0/8", "ws://"+addr+"/", nil,
func(ctx context.Context) (net.Conn, error) { return (&net.Dialer{}).DialContext(ctx, "tcp", addr) }, "b")
var conns []net.Conn
defer func() {
for _, c := range conns {
_ = c.Close()
}
}()
if !waitFor(5*time.Second, func() bool {
c, err := net.Dial("tcp", "127.0.0.1:5433")
if err == nil {
conns = append(conns, c)
}
return err == nil
}) {
t.Fatal("the forwarder never listened")
}
for i := 1; i < 12; i++ {
c, err := net.Dial("tcp", "127.0.0.1:5433")
if err != nil {
t.Fatal(err)
}
conns = append(conns, c)
}
waitFor(3*time.Second, func() bool { return most.Load() >= 12 })
if m := most.Load(); m != 8 {
t.Fatalf("12 local connections made %d WebSockets to the host at once; want 8", m)
}
}
// A coder run's egress proxy reads a request head under a bound: a request
// line that never ends is not read to its end.
func TestCoderEgressHeadIsBounded(t *testing.T) {
boxEnd, runEnd := net.Pipe()
var refused int64
done := make(chan struct{})
go func() { defer close(done); handleCoderEgressConn(boxEnd, nil, &refused) }()
chunk := bytes.Repeat([]byte{'a'}, 64<<10)
_, _ = runEnd.Write([]byte("GET http://example.invalid/"))
sent := 0
var werr error
for sent < 8<<20 {
_ = runEnd.SetWriteDeadline(time.Now().Add(5 * time.Second))
var n int
n, werr = runEnd.Write(chunk)
sent += n
if werr != nil {
break
}
}
_ = runEnd.Close()
<-done
if werr == nil {
t.Fatalf("the proxy read %d MiB of a request line with no end; it must stop at a bound", sent>>20)
}
}
// A coder run's proxy carries at most 1024 connections at once; the next is
// answered 503 at once, never left waiting.
func TestCoderEgressCapsConnectionsInFlight(t *testing.T) {
dir := t.TempDir()
run := "lane-bounds-test"
if err := coderListenEgress(run, dir, os.Getuid()); err != nil {
t.Fatal(err)
}
defer coderCloseEgress(run)
sock := filepath.Join(dir, coderEgressSock)
var conns []net.Conn
defer func() {
for _, c := range conns {
_ = c.Close()
}
}()
for i := 0; i < 1024; i++ {
c, err := net.Dial("unix", sock)
if err != nil {
if errors.Is(err, syscall.EMFILE) || errors.Is(err, syscall.ENFILE) {
t.Skipf("this process may not open %d sockets: %v", 2*1024, err)
}
t.Fatal(err)
}
conns = append(conns, c)
}
// Every one of them is idle in its head, so the proxy holds them all.
time.Sleep(200 * time.Millisecond)
extra, err := net.Dial("unix", sock)
if err != nil {
t.Fatal(err)
}
conns = append(conns, extra)
_ = extra.SetReadDeadline(time.Now().Add(3 * time.Second))
line, _ := io.ReadAll(io.LimitReader(extra, 256))
if !strings.HasPrefix(string(line), "HTTP/1.1 503") {
t.Fatalf("connection 1025 of one run got %q; want a 503 at once", line)
}
}
+197
View File
@@ -0,0 +1,197 @@
package main
// What the host sends down a lane is read at the size the bastion asks for,
// never at the size the host chooses: one frame of any length must not be
// held whole in this machine's memory, and an egress request head that never
// ends must not be either.
import (
"bytes"
"context"
"errors"
"io"
"net"
"net/http"
"net/http/httptest"
"runtime"
"strconv"
"strings"
"testing"
"time"
"github.com/gorilla/websocket"
)
func TestEgressLaneDoesNotHoldAWholeHostFrame(t *testing.T) {
const frame = 64 << 20
payload := make([]byte, frame+1)
payload[0] = 'D'
for i := 1; i < len(payload); i++ {
payload[i] = 'a'
}
start := make(chan struct{})
up := websocket.Upgrader{}
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
ws, err := up.Upgrade(w, r, nil)
if err != nil {
return
}
defer ws.Close()
<-start
_ = ws.WriteMessage(websocket.BinaryMessage, payload)
time.Sleep(2 * time.Second)
}))
defer srv.Close()
ws, _, err := websocket.DefaultDialer.Dial("ws"+strings.TrimPrefix(srv.URL, "http"), nil)
if err != nil {
t.Fatal(err)
}
defer ws.Close()
c := &wsConn{ws: ws}
buf := make([]byte, 4096)
runtime.GC()
var before, after runtime.MemStats
runtime.ReadMemStats(&before)
close(start)
n, err := c.Read(buf)
runtime.ReadMemStats(&after)
if err != nil || n == 0 || buf[0] != 'a' {
t.Fatalf("read: n=%d err=%v", n, err)
}
if grew := after.TotalAlloc - before.TotalAlloc; grew > 8<<20 {
t.Fatalf("reading 4 KiB of a %d MiB host frame allocated %d MiB: the frame was held whole", frame>>20, grew>>20)
}
}
func TestEgressRequestHeadIsBounded(t *testing.T) {
bastionEnd, hostEnd := net.Pipe()
done := make(chan struct{})
go func() {
defer close(done)
handleEgressConn(bastionEnd, func(ctx context.Context, network, addr string) (net.Conn, error) {
return nil, errors.New("no dial in this test")
}, "test")
}()
chunk := []byte(strings.Repeat("a", 64<<10))
_, _ = hostEnd.Write([]byte("GET http://example.invalid/"))
sent := 0
var werr error
for sent < 8<<20 {
_ = hostEnd.SetWriteDeadline(time.Now().Add(5 * time.Second))
var n int
n, werr = hostEnd.Write(chunk)
sent += n
if werr != nil {
break
}
}
_ = hostEnd.Close()
<-done
if werr == nil {
t.Fatalf("the bastion read %d MiB of a request line with no end; it must stop at a bound", sent>>20)
}
}
// Streaming a frame must not change what the reader sees: every byte of every
// 'D' frame in order, with empty frames, text frames and unknown tags skipped,
// a frame boundary never visible, and 'E' as the end, read through a buffer
// far smaller than the frames.
func TestEgressLaneFramesReadInOrderThroughASmallBuffer(t *testing.T) {
var want []byte
frames := [][]byte{{'D'}, {}, {'X', 'z', 'z'}}
for i, size := range []int{1, 7, 4096, 70000, 3} {
f := []byte{'D'}
for j := 0; j < size; j++ {
f = append(f, byte('a'+(i+j)%26))
}
want = append(want, f[1:]...)
frames = append(frames, f, []byte{'D'})
}
up := websocket.Upgrader{}
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
ws, err := up.Upgrade(w, r, nil)
if err != nil {
return
}
defer ws.Close()
_ = ws.WriteMessage(websocket.TextMessage, []byte("Dnot data"))
for _, f := range frames {
_ = ws.WriteMessage(websocket.BinaryMessage, f)
}
_ = ws.WriteMessage(websocket.BinaryMessage, []byte{'E'})
time.Sleep(time.Second)
}))
defer srv.Close()
ws, _, err := websocket.DefaultDialer.Dial("ws"+strings.TrimPrefix(srv.URL, "http"), nil)
if err != nil {
t.Fatal(err)
}
defer ws.Close()
c := &wsConn{ws: ws}
var got []byte
buf := make([]byte, 13)
for {
n, err := c.Read(buf)
if n == 0 && err == nil {
t.Fatal("Read returned 0, nil")
}
got = append(got, buf[:n]...)
if err == io.EOF {
break
}
if err != nil {
t.Fatalf("read: %v", err)
}
}
if !bytes.Equal(got, want) {
t.Fatalf("read %d bytes, want %d; equal prefix %d", len(got), len(want), commonPrefix(got, want))
}
}
func commonPrefix(a, b []byte) int {
i := 0
for i < len(a) && i < len(b) && a[i] == b[i] {
i++
}
return i
}
// A large upload through the lane still arrives whole: the head bound applies
// to the head alone, and the bytes the reader buffered past it go upstream
// first, in order.
func TestEgressLargeUploadPassesTheHeadBound(t *testing.T) {
bastionEnd, hostEnd := net.Pipe()
upBastion, upFar := net.Pipe()
done := make(chan struct{})
go func() {
defer close(done)
handleEgressConn(bastionEnd, func(ctx context.Context, network, addr string) (net.Conn, error) {
return upBastion, nil
}, "")
}()
body := make([]byte, 3*egressMaxHeadBytes)
for i := range body {
body[i] = byte(i % 251)
}
head := "POST http://198.51.100.20/upload HTTP/1.1\r\nHost: 198.51.100.20\r\nContent-Length: " +
strconv.Itoa(len(body)) + "\r\n\r\n"
// Head and body in ONE write, so the reader holds body bytes when the head ends.
go func() {
_, _ = hostEnd.Write(append([]byte(head), body...))
}()
// The lane rebuilds a plain-HTTP head (egress_http.go): this request comes
// out the same, with `Connection: close` added as its last header.
want := head[:len(head)-len("\r\n")] + "Connection: close\r\n\r\n"
got := make([]byte, len(want)+len(body))
_ = upFar.SetReadDeadline(time.Now().Add(20 * time.Second))
if _, err := io.ReadFull(upFar, got); err != nil {
t.Fatalf("upstream got %v", err)
}
if string(got[:len(want)]) != want || !bytes.Equal(got[len(want):], body) {
t.Fatalf("upstream did not receive the head (%q) and the %d-byte body intact",
got[:len(want)], len(body))
}
_ = hostEnd.Close()
_ = upFar.Close()
<-done
}
+157
View File
@@ -0,0 +1,157 @@
package main
// When a Host holds this machine (its owner quarantined it there), the Host
// refuses every worker socket of every lane with close code 4403, and says
// "quarantined": true on each beat it answers. The lane workers park a pool of
// sockets per lane and used to dial again at once (mgmt, harness, session) or
// a second after a close (egress, serve), so one held machine whose tunnel
// stayed up dialled the Host 30 to 80 times a second, each one a TLS
// handshake. A pairing's workers now share one hold:
//
// - a socket the Host closes with 4403 holds every worker of that pairing for
// laneHoldFirst, doubling with each hold up to laneHoldMax;
// - a beat that says quarantined stops them dialling until a beat no longer
// does, which is how the owner's release reaches this machine.
//
// The hold is the pairing's, so another Host this machine is paired with is
// never slowed by it.
import (
"context"
"encoding/json"
"fmt"
"math/rand/v2"
"sync"
"sync/atomic"
"time"
"github.com/gorilla/websocket"
)
// laneHeldCloseCode is the close code a Host gives a worker socket of a
// machine it holds (the Host's quarantine gate).
const laneHeldCloseCode = 4403
// The first hold, and the longest. Variables so a test can shorten them.
var (
laneHoldFirst = 5 * time.Second
laneHoldMax = 5 * time.Minute
)
type laneHold struct {
mu sync.Mutex
wait time.Duration // the last hold's length; the next one doubles it
until time.Time // no worker of the pairing dials before this
last time.Time // when the last hold began
quarantined bool // what the last beat said
wake chan struct{} // closed when the beat lifts a quarantine
}
var laneHolds sync.Map // host name -> *laneHold
func laneHoldFor(host string) *laneHold {
if h, ok := laneHolds.Load(host); ok {
return h.(*laneHold)
}
h, _ := laneHolds.LoadOrStore(host, &laneHold{wake: make(chan struct{})})
return h.(*laneHold)
}
// refused is a worker socket the Host closed with 4403. The workers of a pool
// are refused together, so a refusal while a hold is on is that hold's and
// does not lengthen it. A refusal long after the last hold starts again from
// laneHoldFirst.
func (h *laneHold) refused(host string) {
h.mu.Lock()
defer h.mu.Unlock()
now := time.Now()
if now.Before(h.until) {
return
}
switch {
case h.wait == 0 || now.Sub(h.last) > 2*laneHoldMax:
h.wait = laneHoldFirst
default:
h.wait = min(2*h.wait, laneHoldMax)
}
h.last = now
h.until = now.Add(h.wait)
fmt.Printf("[%s] the Host refused a lane: it holds this machine; its lanes dial again in %s\n", host, h.wait)
}
// fromBeat is what a beat's reply said. A release ends the hold at once and
// starts the next one from laneHoldFirst.
func (h *laneHold) fromBeat(host string, quarantined bool) {
h.mu.Lock()
defer h.mu.Unlock()
switch {
case quarantined && !h.quarantined:
h.quarantined = true
fmt.Printf("[%s] the Host holds this machine (quarantined there): its lanes wait until its owner releases it\n", host)
case !quarantined && h.quarantined:
h.quarantined = false
h.wait, h.until = 0, time.Time{}
close(h.wake)
h.wake = make(chan struct{})
fmt.Printf("[%s] the Host released this machine: its lanes are back\n", host)
}
}
// waitClear blocks a worker until it may dial: the hold is over and the last
// beat did not say quarantined. A worker waits a little past the hold's end,
// a different little for each, so a pool does not dial in one burst. False
// when ctx ends first.
func (h *laneHold) waitClear(ctx context.Context) bool {
for {
h.mu.Lock()
quarantined, until, wake := h.quarantined, h.until, h.wake
h.mu.Unlock()
if ctx.Err() != nil {
return false
}
var t *time.Timer
var timer <-chan time.Time
switch {
case quarantined:
// Only a beat lifts it.
case time.Now().Before(until):
d := time.Until(until)
t = time.NewTimer(d + rand.N(d/10+time.Millisecond))
timer = t.C
default:
return true
}
select {
case <-ctx.Done():
case <-wake:
case <-timer:
}
if t != nil {
t.Stop()
}
}
}
// watchHeldClose reports, once the socket has been read to its end, whether
// the Host closed it with laneHeldCloseCode.
func watchHeldClose(ws *websocket.Conn) (held func() bool) {
var got atomic.Bool
def := ws.CloseHandler()
ws.SetCloseHandler(func(code int, text string) error {
if code == laneHeldCloseCode {
got.Store(true)
}
return def(code, text)
})
return got.Load
}
// beatSaysQuarantined reads the "quarantined" a Host puts on the beat's reply
// for a machine it holds. A reply without it, or one that cannot be read, is
// not a hold.
func beatSaysQuarantined(body []byte) bool {
var r struct {
Quarantined bool `json:"quarantined"`
}
return json.Unmarshal(body, &r) == nil && r.Quarantined
}
+223
View File
@@ -0,0 +1,223 @@
package main
import (
"context"
"crypto/tls"
"crypto/x509"
"net"
"net/http"
"net/http/httptest"
"strings"
"sync/atomic"
"testing"
"time"
"github.com/gorilla/websocket"
)
// heldHost stands in for a Host's lane port: it counts each worker's hello,
// then either closes the socket with the code a Host gives a machine it holds,
// or parks it.
type heldHost struct {
hellos atomic.Int32
hold atomic.Bool
tls *tls.Config
dial func(ctx context.Context) (net.Conn, error)
url string
}
func startHeldHost(t *testing.T) *heldHost {
t.Helper()
h := &heldHost{}
h.hold.Store(true)
up := websocket.Upgrader{}
srv := httptest.NewUnstartedServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
c, err := up.Upgrade(w, r, nil)
if err != nil {
return
}
defer c.Close()
if _, _, err := c.ReadMessage(); err != nil {
return
}
h.hellos.Add(1)
if h.hold.Load() {
_ = c.WriteControl(websocket.CloseMessage,
websocket.FormatCloseMessage(laneHeldCloseCode, "this bastion is quarantined"), time.Now().Add(time.Second))
return
}
for {
if _, _, err := c.ReadMessage(); err != nil {
return
}
}
}))
srv.StartTLS()
t.Cleanup(srv.Close)
pool := x509.NewCertPool()
pool.AddCert(srv.Certificate())
h.tls = &tls.Config{RootCAs: pool, ServerName: "example.com"}
addr := srv.Listener.Addr().String()
h.dial = func(ctx context.Context) (net.Conn, error) {
var d net.Dialer
return d.DialContext(ctx, "tcp", addr)
}
h.url = "wss://example.com/lane"
return h
}
// shortHolds makes the holds short enough for a test. Set before any worker
// runs, and never from a parallel subtest.
func shortHolds(t *testing.T, first, max time.Duration) {
t.Helper()
f, m := laneHoldFirst, laneHoldMax
laneHoldFirst, laneHoldMax = first, max
t.Cleanup(func() { laneHoldFirst, laneHoldMax = f, m })
}
// ownHold gives a test its own pairing's hold, and forgets it after.
func ownHold(t *testing.T, host string) {
t.Helper()
laneHolds.Delete(host)
t.Cleanup(func() { laneHolds.Delete(host) })
}
// Every lane's pool, so a lane added later without the hold is caught.
func lanePools(dir string) map[string]func(ctx context.Context, host string, h *heldHost, n int) {
return map[string]func(ctx context.Context, host string, h *heldHost, n int){
"egress": func(ctx context.Context, host string, h *heldHost, n int) {
var d net.Dialer
runEgressWorkers(ctx, host, h.url, h.tls, h.dial, "b", d.DialContext, n)
},
"serve": func(ctx context.Context, host string, h *heldHost, n int) {
runServeWorkers(ctx, host, dir, h.url, h.tls, h.dial, "b", n)
},
"mgmt": func(ctx context.Context, host string, h *heldHost, n int) {
runMgmtWorkers(ctx, host, h.url, h.tls, h.dial, "b", dir, dir, dir, n)
},
"harness": func(ctx context.Context, host string, h *heldHost, n int) {
runHarnessWorkers(ctx, host, dir, h.url, h.tls, h.dial, "b", n)
},
"session": func(ctx context.Context, host string, h *heldHost, n int) {
runSessionWorkers(ctx, host, h.url, h.tls, h.dial, "b", n,
sessionEnv{CtxRoot: dir, DcnDir: dir, HostName: host, Server: "test"})
},
}
}
// A Host that holds this machine closes every worker socket with 4403. No
// worker of any lane dials it again before the hold is over: one hello per
// worker, where a pool used to dial again at once or a second later, 30 to 80
// times a second from one held machine.
func TestEveryLanePoolWaitsOutAHostThatHoldsThisMachine(t *testing.T) {
shortHolds(t, 3*time.Second, time.Minute)
for lane, run := range lanePools(t.TempDir()) {
t.Run(lane, func(t *testing.T) {
t.Parallel()
host := "held-" + lane + ".example.test"
ownHold(t, host)
h := startHeldHost(t)
ctx, cancel := context.WithCancel(context.Background())
t.Cleanup(cancel)
const n = 2
go run(ctx, host, h, n)
time.Sleep(2 * time.Second)
if got := h.hellos.Load(); got != n {
t.Fatalf("%d dials within the hold from %d workers; want one each", got, n)
}
})
}
}
// A beat whose reply says quarantined stops the lanes before any of them
// dials, and the first beat that no longer says it brings them back at once.
func TestABeatThatSaysQuarantinedStopsTheLanesUntilOneDoesNot(t *testing.T) {
host := "quarantined.example.test"
shortHolds(t, time.Hour, time.Hour)
ownHold(t, host)
h := startHeldHost(t)
h.hold.Store(false)
laneHoldFor(host).fromBeat(host, beatSaysQuarantined([]byte(`{"ok":true,"quarantined":true}`)))
ctx, cancel := context.WithCancel(context.Background())
t.Cleanup(cancel)
const n = 2
go lanePools(t.TempDir())["mgmt"](ctx, host, h, n)
time.Sleep(700 * time.Millisecond)
if got := h.hellos.Load(); got != 0 {
t.Fatalf("%d dials while the Host says it holds this machine", got)
}
laneHoldFor(host).fromBeat(host, beatSaysQuarantined([]byte(`{"ok":true}`)))
deadline := time.Now().Add(3 * time.Second)
for h.hellos.Load() < n && time.Now().Before(deadline) {
time.Sleep(20 * time.Millisecond)
}
if got := h.hellos.Load(); got != n {
t.Fatalf("after the release, %d of %d workers parked again", got, n)
}
}
// A pool's workers are refused together, so a refusal inside a hold is that
// hold's; each hold after one runs out is twice as long, up to the most; a
// refusal long after the last starts again from the first; a release ends a
// hold at once.
func TestAHoldDoublesOncePerHoldUpToItsMost(t *testing.T) {
host := "doubling.example.test"
shortHolds(t, time.Second, 4*time.Second)
ownHold(t, host)
h := laneHoldFor(host)
expire := func() {
h.mu.Lock()
h.until = time.Now().Add(-time.Millisecond)
h.mu.Unlock()
}
wait := func() time.Duration {
h.mu.Lock()
defer h.mu.Unlock()
return h.wait
}
h.refused(host)
h.refused(host)
h.refused(host)
if got := wait(); got != time.Second {
t.Fatalf("three refusals in one hold: %s, want the first hold", got)
}
var got []string
for range 3 {
expire()
h.refused(host)
got = append(got, wait().String())
}
if strings.Join(got, " ") != "2s 4s 4s" {
t.Fatalf("holds after the first: %v, want 2s 4s 4s", got)
}
expire()
h.mu.Lock()
h.last = time.Now().Add(-9 * time.Second)
h.mu.Unlock()
h.refused(host)
if got := wait(); got != time.Second {
t.Fatalf("a refusal after a long quiet: %s, want the first hold again", got)
}
h.fromBeat(host, true)
h.fromBeat(host, false)
ctx, cancel := context.WithTimeout(context.Background(), 100*time.Millisecond)
defer cancel()
if !h.waitClear(ctx) {
t.Fatal("a release must end the hold at once")
}
}
func TestBeatSaysQuarantinedReadsOnlyTheHostsTrue(t *testing.T) {
for body, want := range map[string]bool{
`{"ok":true,"quarantined":true}`: true,
`{"ok":true,"quarantined":false}`: false,
`{"ok":true}`: false,
`{"quarantined":"yes"}`: false,
`not json`: false,
``: false,
} {
if got := beatSaysQuarantined([]byte(body)); got != want {
t.Errorf("%q: %v, want %v", body, got, want)
}
}
}
+3 -2
View File
@@ -493,7 +493,7 @@ func startLaneHostOn(t *testing.T, raw net.Listener, cert tls.Certificate, clien
} }
} }
} }
for _, p := range []string{"/bastion-harness", "/bastion-mgmt", "/bastion-egress"} { for _, p := range []string{"/bastion-harness", "/bastion-mgmt", "/bastion-egress", "/bastion-serve"} {
mux.HandleFunc(p, ws) mux.HandleFunc(p, ws)
} }
srv := &http.Server{Handler: mux, ErrorLog: log.New(io.Discard, "", 0)} srv := &http.Server{Handler: mux, ErrorLog: log.New(io.Discard, "", 0)}
@@ -622,7 +622,8 @@ func TestTheUnixLaneCarriesTheBearerAndTheSameProtocol(t *testing.T) {
h.mu.Unlock() h.mu.Unlock()
if maxPark != harnessWorkerCount || count["/bastion-harness"] < harnessWorkerCount || if maxPark != harnessWorkerCount || count["/bastion-harness"] < harnessWorkerCount ||
count["/bastion-harness session"] != sessionWorkerCount || count["/bastion-harness session"] != sessionWorkerCount ||
count["/bastion-mgmt"] != mgmtWorkerCount || count["/bastion-egress"] != egressWorkerCount { count["/bastion-mgmt"] != mgmtWorkerCount || count["/bastion-egress"] != egressWorkerCount ||
count["/bastion-serve"] != serveWorkerCount {
t.Fatalf("the worker pools over the socket: %v, parked at once %d", count, maxPark) t.Fatalf("the worker pools over the socket: %v, parked at once %d", count, maxPark)
} }
select { select {
+2 -1
View File
@@ -417,7 +417,8 @@ func TestTheTCPLaneCarriesTheCertTheBearerAndTheSameProtocol(t *testing.T) {
h.mu.Unlock() h.mu.Unlock()
if maxPark != harnessWorkerCount || count["/bastion-harness"] < harnessWorkerCount || if maxPark != harnessWorkerCount || count["/bastion-harness"] < harnessWorkerCount ||
count["/bastion-harness session"] != sessionWorkerCount || count["/bastion-harness session"] != sessionWorkerCount ||
count["/bastion-mgmt"] != mgmtWorkerCount || count["/bastion-egress"] != egressWorkerCount { count["/bastion-mgmt"] != mgmtWorkerCount || count["/bastion-egress"] != egressWorkerCount ||
count["/bastion-serve"] != serveWorkerCount {
t.Fatalf("the worker pools over the port: %v, parked at once %d", count, maxPark) t.Fatalf("the worker pools over the port: %v, parked at once %d", count, maxPark)
} }
for _, n := range sni { for _, n := range sni {
+87 -21
View File
@@ -15,9 +15,10 @@ package main
// the host's signed grant remains the ceiling it was before. That distinction is // the host's signed grant remains the ceiling it was before. That distinction is
// the whole safety argument: a switch that could widen would make the machine a // the whole safety argument: a switch that could widen would make the machine a
// place to escalate FROM, which inverts the product. So the state stored here is // place to escalate FROM, which inverts the product. So the state stored here is
// a DENY LIST, never an allow list. An empty file means "nothing switched off", // a DENY LIST, never an allow list. A missing file means "nothing switched
// which is exactly the behaviour that existed before this file, and an // off", which is exactly the behaviour that existed before this file. A file
// unreadable file means the same — see localDenyLoad. // that exists but cannot be read means EVERYTHING switched off — see
// localDenied.
// //
// WHY THE MACHINE MAY DO THIS AT ALL. It already decides what it actually // WHY THE MACHINE MAY DO THIS AT ALL. It already decides what it actually
// executes: every op passes capsAllow (anchor.go) on the way in, and the box // executes: every op passes capsAllow (anchor.go) on the way in, and the box
@@ -64,12 +65,11 @@ func localDenyPath() (string, error) {
// localDenyLoad reads the deny list. // localDenyLoad reads the deny list.
// //
// EVERY FAILURE RETURNS AN EMPTY LIST, and that direction is deliberate. A // Every failure returns an empty list WITH the error, and what an error means
// deny list that cannot be read must not become a deny-everything: the machine // is decided by the caller, not here. The gate (localDenied) refuses every
// would stop serving its host because of a corrupt file, which is a far worse // family while the error stands; the page and --list say why and name
// outcome than a switch not taking effect. The page reports the read error // `switch --reset`. An empty list must never be read on its own as "nothing
// separately so the person is not left believing something is off when it is // is off": that is how a corrupt file used to switch everything back on.
// not.
func localDenyLoad() (*localDenyFile, error) { func localDenyLoad() (*localDenyFile, error) {
p, err := localDenyPath() p, err := localDenyPath()
if err != nil { if err != nil {
@@ -84,9 +84,7 @@ func localDenyLoad() (*localDenyFile, error) {
} }
var f localDenyFile var f localDenyFile
if err := json.Unmarshal(b, &f); err != nil { if err := json.Unmarshal(b, &f); err != nil {
return &localDenyFile{Off: map[string][]string{}}, fmt.Errorf( return &localDenyFile{Off: map[string][]string{}}, fmt.Errorf("%s is not valid JSON: %w", p, err)
"this machine's list of switched-off capabilities cannot be read (%w). "+
"Nothing is being blocked by it while that is true", err)
} }
if f.Off == nil { if f.Off == nil {
f.Off = map[string][]string{} f.Off = map[string][]string{}
@@ -146,13 +144,25 @@ func localSwitchFamilies() []string {
} }
// localDenied reports whether a family is switched off for a host here. // localDenied reports whether a family is switched off for a host here.
//
// A LIST THAT CANNOT BE READ SWITCHES EVERYTHING OFF. The person at the
// machine switched something off; a file that will not parse cannot say what,
// so the only answer that keeps their decision is all of it. The other
// direction (read it as "nothing is off") turned a session or files switch
// back on without anyone being told, and the host was served exactly what the
// person had refused it. Recovery is at the machine: `switch --reset` sets the
// unreadable file aside and starts an empty list.
func localDenied(host, family string) bool { func localDenied(host, family string) bool {
if host == "" || family == "" { if host == "" || family == "" {
return false return false
} }
localDenyMu.Lock() localDenyMu.Lock()
defer localDenyMu.Unlock() defer localDenyMu.Unlock()
f, _ := localDenyLoad() f, err := localDenyLoad()
if err != nil {
localDenyReportUnreadable(err)
return true
}
for _, c := range f.Off[host] { for _, c := range f.Off[host] {
if c == family { if c == family {
return true return true
@@ -165,7 +175,11 @@ func localDenied(host, family string) bool {
func localDenyFamilies(host string) []string { func localDenyFamilies(host string) []string {
localDenyMu.Lock() localDenyMu.Lock()
defer localDenyMu.Unlock() defer localDenyMu.Unlock()
f, _ := localDenyLoad() f, err := localDenyLoad()
if err != nil {
// The same answer the gate gives (localDenied): everything is off.
return localSwitchFamilies()
}
out := append([]string(nil), f.Off[host]...) out := append([]string(nil), f.Off[host]...)
sort.Strings(out) sort.Strings(out)
return out return out
@@ -257,10 +271,9 @@ func localDenyRefusal(family string) string {
// localDenyIndex is every switched-off (host, family) plus WHY the list could // localDenyIndex is every switched-off (host, family) plus WHY the list could
// not be read, when it could not. // not be read, when it could not.
// //
// It exists because the per-family localDenied() swallows that error by design // It exists because the per-family localDenied() answers only yes or no, and
// — it has to, since a gate must not fail closed on a corrupt file — and the // the PAGE has to say why every switch reads off: without the reason a person
// PAGE has the opposite obligation: it must say so, or it shows a person their // sees their machine refusing everything and no way out.
// switches as not existing rather than as not working.
func localDenyIndex() (map[string]bool, string) { func localDenyIndex() (map[string]bool, string) {
localDenyMu.Lock() localDenyMu.Lock()
defer localDenyMu.Unlock() defer localDenyMu.Unlock()
@@ -272,9 +285,62 @@ func localDenyIndex() (map[string]bool, string) {
} }
} }
if err != nil { if err != nil {
return out, "This machine's list of switched-off capabilities cannot be read (" + return out, localDenyUnreadableText(err)
err.Error() + "). NOTHING below is being blocked by it while that is true — " +
"anything you switched off is not in effect."
} }
return out, "" return out, ""
} }
// localDenyUnreadableText is the one sentence the page, --list and the
// daemon's log give for an unreadable list.
func localDenyUnreadableText(err error) string {
return "This machine's list of switched-off capabilities cannot be read (" +
err.Error() + "). Until it can, EVERY capability is refused to every host. " +
"To start a fresh list, run: sudo -H privatae-bastion switch --reset " +
"(the unreadable file is kept beside it)."
}
// localDenyUnreadableLogged is the last unreadable-list error written to the
// log, so the gate, which runs on every op, logs each distinct failure once
// instead of once per op. Guarded by localDenyMu.
var localDenyUnreadableLogged string
// localDenyReportUnreadable logs the refusal-of-everything once per distinct
// error. Caller holds localDenyMu.
func localDenyReportUnreadable(err error) {
msg := err.Error()
if msg == localDenyUnreadableLogged {
return
}
localDenyUnreadableLogged = msg
fmt.Printf("local switch: %s\n", localDenyUnreadableText(err))
}
// localDenyReset sets an unreadable deny list aside and leaves no list, so
// nothing is switched off. It refuses when the list reads fine: resetting a
// good list would silently clear what the person switched off, and that is
// done one family at a time with `switch <host> <family> on`. The old file is
// renamed, never deleted, so whatever is still legible in it can be read back.
func localDenyReset() (string, error) {
return localDenyResetAt(time.Now().UTC())
}
func localDenyResetAt(now time.Time) (string, error) {
var kept string
err := withLocalDenyLock(func() error { // holds localDenyMu and the file lock
p, err := localDenyPath()
if err != nil {
return err
}
if _, err := localDenyLoad(); err == nil {
return fmt.Errorf("the list of switched-off capabilities reads fine, so there is " +
"nothing to reset; switch a family back on with: switch <host> <family> on")
}
kept = p + ".unreadable-" + now.Format("20060102T150405Z")
if err := os.Rename(p, kept); err != nil {
return fmt.Errorf("could not set the unreadable list aside: %w", err)
}
localDenyUnreadableLogged = ""
return nil
})
return kept, err
}
+85 -8
View File
@@ -18,6 +18,7 @@ import (
"sort" "sort"
"strings" "strings"
"testing" "testing"
"time"
) )
// anchoredBox is the state capsAllow needs: a real anchor with its key pinned, // anchoredBox is the state capsAllow needs: a real anchor with its key pinned,
@@ -150,10 +151,11 @@ func TestTheSwitchAppliesToTheAnchorPairing(t *testing.T) {
// ── failure directions ────────────────────────────────────────────────────── // ── failure directions ──────────────────────────────────────────────────────
// AN UNREADABLE DENY LIST BLOCKS NOTHING. A corrupt file must not stop the // AN UNREADABLE DENY LIST SWITCHES EVERYTHING OFF. The person switched
// machine serving its host — that is a far worse outcome than a switch not // something off; a file that will not parse cannot say what, so every family
// taking effect, and the page reports the read error separately. // is refused until the person resets the list at the machine. It used to read
func TestAnUnreadableDenyListBlocksNothing(t *testing.T) { // as "nothing is off", which handed the host back exactly what was refused.
func TestAnUnreadableDenyListRefusesEverything(t *testing.T) {
const self = "h1.host.privatae.ai" const self = "h1.host.privatae.ai"
anchoredBox(t, self, allCaps) anchoredBox(t, self, allCaps)
p, err := localDenyPath() p, err := localDenyPath()
@@ -163,14 +165,64 @@ func TestAnUnreadableDenyListBlocksNothing(t *testing.T) {
if err := os.WriteFile(p, []byte("{not json"), 0o600); err != nil { if err := os.WriteFile(p, []byte("{not json"), 0o600); err != nil {
t.Fatal(err) t.Fatal(err)
} }
if why := capsAllow(self, "observe:agents"); why != "" { for _, op := range []string{"observe:agents", "session:root"} {
t.Errorf("a corrupt deny list refused an op: %q. Failing closed here means one "+ if why := capsAllow(self, op); why == "" {
"bad file stops this machine serving its host.", why) t.Errorf("a corrupt deny list let %s through: an unreadable list must "+
"refuse everything, or a switch the person turned off is back on", op)
}
} }
// And it is reported rather than swallowed. // And it is reported rather than swallowed.
if _, err := localDenyLoad(); err == nil { if _, err := localDenyLoad(); err == nil {
t.Error("the unreadable list was loaded without an error, so nothing can tell " + t.Error("the unreadable list was loaded without an error, so nothing can tell " +
"the person their switches are not in effect") "the person why everything is refused")
}
if _, note := localDenyIndex(); !strings.Contains(note, "switch --reset") {
t.Errorf("the page note does not name the way out: %q", note)
}
}
// A MISSING list is not an unreadable one: a machine nobody has switched
// anything off on serves its grant.
func TestAMissingDenyListBlocksNothing(t *testing.T) {
const self = "h1.host.privatae.ai"
anchoredBox(t, self, allCaps)
if why := capsAllow(self, "observe:agents"); why != "" {
t.Errorf("with no deny list at all an op was refused: %q", why)
}
}
// --reset sets an unreadable list aside (kept, never deleted) and serves the
// grant again; it refuses on a list that reads fine, because that would
// clear the person's switches without them choosing each one.
func TestResetSetsAnUnreadableListAsideAndRefusesAGoodOne(t *testing.T) {
const self = "h1.host.privatae.ai"
anchoredBox(t, self, allCaps)
p, err := localDenyPath()
if err != nil {
t.Fatal(err)
}
if err := localDenySet(self, "dcn", true); err != nil {
t.Fatal(err)
}
if _, err := localDenyReset(); err == nil {
t.Fatal("a list that reads fine was reset, clearing a switch nobody turned on")
}
if !localDenied(self, "dcn") {
t.Fatal("the refused reset lost the switch")
}
if err := os.WriteFile(p, []byte("{not json"), 0o600); err != nil {
t.Fatal(err)
}
now := time.Date(2026, 10, 30, 3, 0, 0, 0, time.UTC)
kept, err := localDenyResetAt(now)
if err != nil {
t.Fatal(err)
}
if b, err := os.ReadFile(kept); err != nil || string(b) != "{not json" {
t.Errorf("the unreadable file was not kept at %s: %q %v", kept, string(b), err)
}
if why := capsAllow(self, "observe:agents"); why != "" {
t.Errorf("after a reset the grant is still refused: %q", why)
} }
} }
@@ -277,3 +329,28 @@ func TestSwitchingOffAHostThisMachineNeverHeardOfIsRefused(t *testing.T) {
t.Errorf("a paired host was refused: %v", err) t.Errorf("a paired host was refused: %v", err)
} }
} }
// Every reader of an unreadable list gives the gate's answer: everything is
// off. The given page's box-wide card included, and localDenyFamilies too.
func TestEveryReaderOfAnUnreadableListSaysEverythingIsOff(t *testing.T) {
const self = "h1.host.privatae.ai"
anchoredBox(t, self, allCaps)
p, err := localDenyPath()
if err != nil {
t.Fatal(err)
}
if err := os.WriteFile(p, []byte("{not json"), 0o600); err != nil {
t.Fatal(err)
}
if got := localDenyFamilies(self); len(got) != len(localSwitchFamilies()) {
t.Errorf("localDenyFamilies on an unreadable list: %v", got)
}
g := collectGiven()
for _, h := range g.Hosts {
for _, f := range h.Families {
if !f.SwitchedOff {
t.Errorf("%s: the %s card does not read as switched off", h.Host, f.Name)
}
}
}
}
+352
View File
@@ -0,0 +1,352 @@
package main
// machine_cli.go — the console's This machine page on the command line:
// `schedules`, `tool-servers`, `posture` and `baseline show|diff|record`.
// Each read is one value (reads.go), printed in the console's words or, with
// --json, as itself.
import (
"errors"
"fmt"
"io"
"os"
"runtime"
"strings"
"time"
)
// ── scheduled jobs that start an agent ──────────────────────────────────────
const schedulesUsage = "usage: privatae-bastion schedules [--json]"
type schedulesRead struct {
Schedules []uiSchedule `json:"schedules"`
Read bool `json:"schedulers_read"` // false: this platform's schedulers are not read by this build
}
func readSchedules(readOpts) (schedulesRead, error) {
s, ok := collectSchedules()
return schedulesRead{Schedules: s, Read: ok}, nil
}
func cmdSchedules(args []string) error {
asJSON, err := jsonOnly(schedulesUsage, args)
if err != nil {
return err
}
v, err := readOwnOrMachine("schedules", readOpts{}, readSchedules)
if err != nil {
return err
}
if asJSON {
return printJSON(os.Stdout, v)
}
printSchedules(os.Stdout, v)
return nil
}
func printSchedules(w io.Writer, v schedulesRead) {
switch {
case len(v.Schedules) == 0 && v.Read:
fmt.Fprintln(w, "No scheduled job on this machine starts an AI agent.")
return
case len(v.Schedules) == 0:
fmt.Fprintln(w, "This platform's schedulers cannot be read by this build, so an empty list here means nothing looked.")
return
}
for _, s := range v.Schedules {
line := s.Agent + " "
if s.Schedule != "" {
line += "runs " + s.Schedule + " · "
}
line += s.Where
if s.User != "" {
line += " · as " + s.User
}
fmt.Fprintln(w, line)
if s.Command != "" {
fmt.Fprintln(w, " "+s.Command)
}
}
}
// ── MCP tool servers and their problems ─────────────────────────────────────
const toolServersUsage = "usage: privatae-bastion tool-servers [--json]"
type toolServersRead struct {
Clients []uiToolGroup `json:"clients"`
}
func readToolServers(readOpts) (toolServersRead, error) {
return toolServersRead{Clients: collectToolGroups()}, nil
}
func cmdToolServers(args []string) error {
asJSON, err := jsonOnly(toolServersUsage, args)
if err != nil {
return err
}
v, err := readOwnOrMachine("tool-servers", readOpts{}, readToolServers)
if err != nil {
return err
}
if asJSON {
return printJSON(os.Stdout, v)
}
printToolServers(os.Stdout, v)
return nil
}
func printToolServers(w io.Writer, v toolServersRead) {
if len(v.Clients) == 0 {
fmt.Fprintln(w, "No MCP tool server is configured in any settings file this bastion can read.")
return
}
for _, g := range v.Clients {
head := g.Client + ": " + plural(len(g.Servers), "tool server", "tool servers")
if g.Bad > 0 {
head += fmt.Sprintf(", %d with a problem", g.Bad)
}
fmt.Fprintln(w, head)
for _, s := range g.Servers {
fmt.Fprintf(w, " %s (%s)\n", s.Name, s.Where)
for _, p := range s.Problems {
fmt.Fprintln(w, " "+p)
}
}
}
}
// ── posture: the checks a Host runs on its own servers ──────────────────────
const postureUsage = "usage: privatae-bastion posture [--json]"
// postureNeedsAdmin is a firewall field read without the administrator:
// ufw, nft and iptables refuse an ordinary account, and their refusals read
// as "absent" or a stray word, so the field is not reported at all.
const postureNeedsAdmin = "needs_administrator"
type postureRead struct {
Supported bool `json:"supported"`
OS string `json:"os"`
AsAdmin bool `json:"read_as_administrator"`
Checks *hostPosture `json:"checks,omitempty"`
}
func readPosture(readOpts) (postureRead, error) {
r := postureRead{Supported: observeHostSupported, OS: runtime.GOOS, AsAdmin: machineAuthorityHeld()}
if !r.Supported {
return r, nil
}
p := readHostPosture()
if !r.AsAdmin {
p.Ufw, p.Pubwall, p.Input, p.Ssh22 = postureNeedsAdmin, postureNeedsAdmin, postureNeedsAdmin, postureNeedsAdmin
}
r.Checks = &p
return r, nil
}
func cmdPosture(args []string) error {
asJSON, err := jsonOnly(postureUsage, args)
if err != nil {
return err
}
v, err := readOwnOrMachine("posture", readOpts{}, readPosture)
if err != nil {
return err
}
if asJSON {
return printJSON(os.Stdout, v)
}
printPosture(os.Stdout, v)
return nil
}
func printPosture(w io.Writer, v postureRead) {
if !v.Supported || v.Checks == nil {
fmt.Fprintf(w, "These checks read Linux's firewall, package manager and system log; this machine runs %s, "+
"so nothing was read.\n", v.OS)
return
}
for _, l := range postureLines(*v.Checks, v.AsAdmin) {
fmt.Fprintln(w, l)
}
fmt.Fprintln(w, "These are the checks a Host runs on its own servers. A firewall other than ufw, "+
"the pubwall nftables table or iptables' INPUT policy is not read.")
}
// postureLines says each check in words, the firewall first.
func postureLines(p hostPosture, asAdmin bool) []string {
var out []string
add := func(s string) { out = append(out, s) }
unread := func(what, v string) { add(what + ": could not be read (" + v + ")") }
if !asAdmin {
add("Firewall: not read; it takes the administrator: sudo -H privatae-bastion posture")
} else {
switch p.Ufw {
case "active":
add("ufw firewall: on")
case "inactive":
add("ufw firewall: installed, off")
case "absent":
add("ufw firewall: not installed")
default:
unread("ufw firewall", p.Ufw)
}
switch p.Pubwall {
case "absent": // Privatae's own table: most machines have none, and that says nothing
case "drop+tdrop":
add("pubwall (nftables): refuses by default, and its last rule refuses too")
case "drop":
add("pubwall (nftables): refuses by default")
case "accept+tdrop":
add("pubwall (nftables): admits by default; only its last rule refuses, so losing that rule opens it")
case "accept":
add("pubwall (nftables): admits by default, with no rule that refuses at the end")
default:
unread("pubwall (nftables)", p.Pubwall)
}
switch p.Input {
case "DROP", "REJECT":
add("iptables INPUT: refuses by default (" + p.Input + ")")
case "ACCEPT":
add("iptables INPUT: admits by default")
case "absent":
add("iptables: not installed")
default:
unread("iptables INPUT", p.Input)
}
switch p.Ssh22 {
case "scoped":
add("SSH (port 22): admitted only from listed addresses")
case "unscoped":
add("SSH (port 22): admitted from any address")
case "unknown":
add("SSH (port 22): no firewall rule for it was found")
default:
unread("SSH (port 22)", p.Ssh22)
}
}
switch p.F2b {
case "active":
add("fail2ban: running")
case "inactive", "failed":
add("fail2ban: not running (" + p.F2b + ")")
case "absent":
add("fail2ban: not checked (no systemctl)")
default:
add("fail2ban: " + p.F2b)
}
switch {
case p.Sec < 0:
add("Security updates: could not be counted (the check reads apt-get)")
case p.Sec == 0:
add("Security updates: none waiting")
default:
add(fmt.Sprintf("Security updates: %d waiting", p.Sec))
}
if p.Reboot == "yes" {
add("A restart is needed to finish installing updates")
}
if p.DiskPct >= 0 {
add(fmt.Sprintf("Disk (/): %d%% used", p.DiskPct))
}
if p.Load >= 0 && p.Cpus > 0 {
add(fmt.Sprintf("Load: %.2f over the last minute, %d cores", p.Load, p.Cpus))
}
if p.Jrn >= 0 {
add("System log: last line " + (time.Duration(p.Jrn) * time.Second).String() + " ago")
} else {
add("System log: could not be read")
}
if p.Puv != "" && p.Puv != "absent" {
add("Check after the last upgrade: " + p.Puv)
}
if len(p.Timeouts) > 0 {
add("Did not finish in time: " + strings.Join(p.Timeouts, ", "))
}
return out
}
// ── the baseline: record it, show it, compare against it ────────────────────
const baselineUsage = "usage: privatae-bastion baseline [show] [--json] | baseline diff [--json] | " +
"sudo -H privatae-bastion baseline record [--force]"
type baselineRead struct {
Has bool `json:"has"`
Baseline *baselineFile `json:"baseline,omitempty"`
Integrity string `json:"integrity_note,omitempty"`
Attestation string `json:"attestation_note,omitempty"`
}
func readBaseline(readOpts) (baselineRead, error) {
f, ok, err := baselineLoad()
if errors.Is(err, os.ErrNotExist) {
return baselineRead{}, nil
}
if err != nil {
return baselineRead{}, err
}
r := baselineRead{Has: true, Baseline: f, Integrity: baselineIntegrityNote(f, ok)}
if f.Attestation != nil {
r.Attestation = baselineAttestationNote(f)
}
return r, nil
}
// readBaselineDiff compares what runs now against the baseline. The
// administrator's: a pass that cannot read what the baseline read reports
// the difference between two accounts, not a change to the machine.
func readBaselineDiff(readOpts) (deltaReport, error) {
if err := requireMachineAuthority("baseline diff"); err != nil {
return deltaReport{}, err
}
return deltaPass(&digestCache{}, time.Now(), deltaRoleOperator), nil
}
func cmdBaseline(args []string) error {
verb := "show"
if len(args) > 0 && !strings.HasPrefix(args[0], "-") {
verb, args = args[0], args[1:]
}
switch verb {
case "record":
force := false
for _, a := range args {
if a != "--force" {
return errors.New(baselineUsage)
}
force = true
}
return cmdObserveBaseline(force)
case "show":
asJSON, err := jsonOnly(baselineUsage, args)
if err != nil {
return err
}
v, err := readMachine("baseline", readOpts{}, readBaseline)
if err != nil {
return laneRefusalError("baseline show", err)
}
if asJSON {
return printJSON(os.Stdout, v)
}
return printBaseline(os.Stdout, v)
case "diff":
asJSON, err := jsonOnly(baselineUsage, args)
if err != nil {
return err
}
v, err := readMachine("baseline-diff", readOpts{}, readBaselineDiff)
if err != nil {
return laneRefusalError("baseline diff", err)
}
if asJSON {
return printJSON(os.Stdout, v)
}
return printDelta(os.Stdout, v)
}
return errors.New(baselineUsage)
}
+17 -9
View File
@@ -1018,19 +1018,27 @@ var observeArgsRecorded = map[string]int{
"observe:net": 1, // host[:port], charset-checked before use "observe:net": 1, // host[:port], charset-checked before use
"observe:metrics": 1, // a name from a fixed query table "observe:metrics": 1, // a name from a fixed query table
"observe:logs": 2, // a name, and an optional minutes window (a whole number) "observe:logs": 2, // a name, and an optional minutes window (a whole number)
"observe:folders": 2, // an absolute path, and an optional depth
"observe:journal": 2, // a unit name, and an optional minutes window
"observe:logins": 1, // an optional window in hours
"observe:cert": 2, // a local port, and an optional server name
} }
// storeObserveLine is one line of observe/<op>/<date>.jsonl. // storeObserveLine is one line of observe/<op>/<date>.jsonl.
// //
// WHAT COMES TO REST HERE. Eight of the eleven ops return fixed schemas the // WHAT COMES TO REST HERE. Most of the ops return fixed schemas the beat
// beat already summarises (posture ints, unit names, sockets, a probe's TLS // already summarises (posture ints, unit names, sockets, a probe's TLS
// subject). observe:alerts and observe:metrics carry label maps that can name // subject, a served certificate's names). observe:alerts and observe:metrics
// namespaces and tenants. observe:logs is the outlier: its result is raw // carry label maps that can name namespaces and tenants. observe:folders
// production log text, up to the line bound, persisted for 30 days — the one // carries folder paths, which can carry a person's account or project name.
// payload whose content this repo does not control, and so the one place a // observe:logins carries account names and the addresses they came from, the
// failed ones as the other side sent them (bounded by loginName).
// observe:logs and observe:journal are the outliers: their result is raw
// production log text, up to the line bound, persisted for 30 days — the
// payloads whose content this repo does not control, and so the places a
// token or a user identifier can come to rest. Files are 0600 under a 0700 // token or a user identifier can come to rest. Files are 0600 under a 0700
// tree; the reader is the machine's own OS account and the anchor's approved // tree; the reader is the machine's own OS account and the anchor's approved
// store. Named here so the next person choosing what to log through this op // store. Named here so the next person choosing what to log through these ops
// knows it stays. // knows it stays.
type storeObserveLine struct { type storeObserveLine struct {
At string `json:"at"` At string `json:"at"`
@@ -1097,8 +1105,8 @@ func storeObserveDroppedReset() {
// (`observe:k8s`, `observe-k8s` and `observe_k8s` all reduce to // (`observe:k8s`, `observe-k8s` and `observe_k8s` all reduce to
// `observe-k8s`) and, since the lowercasing below, case folding // `observe-k8s`) and, since the lowercasing below, case folding
// (`observe:K8s` and `observe:k8s`). Neither can bite today — the op reaches // (`observe:K8s` and `observe:k8s`). Neither can bite today — the op reaches
// this writer only from the eleven names registered in handlerOps, all // this writer only from the observe names registered in handlerOps, all
// lowercase, which reduce to eleven distinct directories // lowercase, which reduce to as many distinct directories
// (TestEveryRegisteredOpSanitisesToTheHostsShelfRule walks them) — but a // (TestEveryRegisteredOpSanitisesToTheHostsShelfRule walks them) — but a
// future pair like `observe:k8s-nodes` / `observe:k8s_nodes` would interleave // future pair like `observe:k8s-nodes` / `observe:k8s_nodes` would interleave
// into one day-file. Whoever adds such a pair renames one of them. // into one day-file. Whoever adds such a pair renames one of them.
+35 -3
View File
@@ -15,6 +15,7 @@ import (
"os" "os"
"path/filepath" "path/filepath"
"regexp" "regexp"
"strconv"
"strings" "strings"
"sync" "sync"
"sync/atomic" "sync/atomic"
@@ -1696,9 +1697,12 @@ func TestObserveArgsRecordedMatchesTheHandlers(t *testing.T) {
} }
// Arities, from the handlers' own checks (observe_ops.go handleObserveNet // Arities, from the handlers' own checks (observe_ops.go handleObserveNet
// len(args) != 1; observe_pull.go handleObserveMetrics len(args) != 1; // len(args) != 1; observe_pull.go handleObserveMetrics len(args) != 1;
// handleObserveLogs len(args) > 2). // handleObserveLogs len(args) > 2; observe_reads.go folders, journal and
// cert len(args) > 2, logins len(args) > 1).
if observeArgsRecorded["observe:net"] != 1 || observeArgsRecorded["observe:metrics"] != 1 || if observeArgsRecorded["observe:net"] != 1 || observeArgsRecorded["observe:metrics"] != 1 ||
observeArgsRecorded["observe:logs"] != 2 { observeArgsRecorded["observe:logs"] != 2 || observeArgsRecorded["observe:folders"] != 2 ||
observeArgsRecorded["observe:journal"] != 2 || observeArgsRecorded["observe:logins"] != 1 ||
observeArgsRecorded["observe:cert"] != 2 {
t.Fatalf("arities drifted from the handlers: %v", observeArgsRecorded) t.Fatalf("arities drifted from the handlers: %v", observeArgsRecorded)
} }
} }
@@ -1785,10 +1789,38 @@ func TestRecordedArgCountsMatchWhatTheHandlersAccept(t *testing.T) {
// And every ACCEPTED position must hold a value the handler accepts — // And every ACCEPTED position must hold a value the handler accepts —
// observe:logs's second argument is a minutes window, and "x" there is // observe:logs's second argument is a minutes window, and "x" there is
// refused for its shape, which is not an arity refusal either. // refused for its shape, which is not an arity refusal either.
//
// The four in observe_reads.go answer through their drivers on Linux, so
// what they read is put in front of them here and nothing on the box that
// runs the suite is: one unit this machine "has", one TLS listener ss
// "reports", an empty journal, and a folder of the test's own.
cert := observeTestCert(t, "box-a.example", []string{"box-a.example"}, nil, time.Now().Add(24*time.Hour))
port := strconv.Itoa(observeTLSListener(t, cert))
origExec, origHave, origAccess := observeExec, observeHave, observeJournalAccess
observeExec = func(_ context.Context, name string, args ...string) ([]byte, error) {
switch name + " " + args[0] {
case "systemctl list-units":
return []byte("example.service loaded active running Example\n"), nil
case "ss -tlnpH":
return []byte("LISTEN 0 4096 127.0.0.1:" + port + " 0.0.0.0:*\n"), nil
}
return nil, nil
}
observeHave = func(string) bool { return true }
observeJournalAccess = func() string { return "" }
defer func() { observeExec, observeHave, observeJournalAccess = origExec, origHave, origAccess }()
folder := "/"
if observeHostSupported {
folder = t.TempDir()
}
accepted := map[string][]string{ accepted := map[string][]string{
"observe:net": {"203.0.113.9:443"}, "observe:net": {"203.0.113.9:443"},
"observe:metrics": {"up"}, "observe:metrics": {"up"},
"observe:logs": {"kernel", "5"}, "observe:logs": {"kernel", "5"},
"observe:folders": {folder, "1"},
"observe:journal": {"example", "5"},
"observe:logins": {"24"},
"observe:cert": {port, "box-a.example"},
} }
for op, n := range observeArgsRecorded { for op, n := range observeArgsRecorded {
if len(accepted[op]) != n { if len(accepted[op]) != n {
@@ -1828,7 +1860,7 @@ func TestEveryRegisteredOpSanitisesToTheHostsShelfRule(t *testing.T) {
t.Fatalf("%s sanitises to %q, which the host rejects as unreadable", op, got) t.Fatalf("%s sanitises to %q, which the host rejects as unreadable", op, got)
} }
} }
if n < 11 { if n < 15 {
t.Fatalf("only %d observe ops walked — the registry moved and this test is not covering it", n) t.Fatalf("only %d observe ops walked — the registry moved and this test is not covering it", n)
} }
} }
+203 -36
View File
@@ -11,11 +11,12 @@ import (
"errors" "errors"
"fmt" "fmt"
"os" "os"
"runtime"
"strings" "strings"
) )
func usage() { func usage() {
fmt.Fprintln(os.Stderr, `privatae-bastion — your bastion into your Privatae network. fmt.Fprintln(os.Stderr, `privatae-bastion — watches the AI agents on this machine, and connects it to a Host if you run one.
Usage: Usage:
privatae-bastion pair <token> enroll this machine with a token from your host's "Set up a bastion". privatae-bastion pair <token> enroll this machine with a token from your host's "Set up a bastion".
@@ -37,6 +38,13 @@ Usage:
that CA alone (name host.cseries.internal), the lanes go to that CA alone (name host.cseries.internal), the lanes go to
the lane port the Host names, and the CA is pinned for life. the lane port the Host names, and the CA is pinned for life.
No coder runs over this pairing No coder runs over this pairing
privatae-bastion pair <pairing code skp_…>
the same pairing from the one code a Cloud Host's card gives:
it carries the enroll address and the CA's fingerprint, and
the CA is taken from the enroll port only under that
fingerprint. On a local machine that already serves a Host,
it asks here whether to add this one as well. Exit 3: already
paired with this Host, nothing changed
privatae-bastion run bring up the tunnel + lanes for EVERY paired host privatae-bastion run bring up the tunnel + lanes for EVERY paired host
(a loopback control port per host for the verbs below: (a loopback control port per host for the verbs below:
127.0.0.1:7878, then 7879, …) 127.0.0.1:7878, then 7879, …)
@@ -86,33 +94,42 @@ Usage:
paired and anchored. Needs machine authority. --host-ca is the paired and anchored. Needs machine authority. --host-ca is the
NEW Host's CA, refused when it is the one this box pinned (that NEW Host's CA, refused when it is the one this box pinned (that
Host is not gone); --force skips that check, at a terminal only Host is not gone); --force skips that check, at a terminal only
privatae-bastion approvals-owner --sid <SID> [--replace] privatae-bastion uninstall [--delete-data]
Windows, beside the system service: the one account whose tray remove the service and the program. The state stays (pairings,
may list and answer approvals. Machine authority; a different keys, the audit log) unless --delete-data, confirmed at a terminal.
SID needs --replace, at an Administrator terminal only Installed for the whole machine, it needs the administrator
privatae-bastion approvals-owner --sid <SID> [--replace] (Windows)
privatae-bastion approvals-owner --account <name> [--replace] (Linux, macOS)
beside the system service, the one person's account it serves:
on Windows the tray's approvals, on Linux and macOS the console
(privatae-bastion ui) without sudo. Machine authority; another
account needs --replace, at a terminal only
sudo -H privatae-bastion claim-anchor --repin sudo -H privatae-bastion claim-anchor --repin
same host, new name: re-sign anchor.json from the same host, new name: re-sign anchor.json from the
pairing this box already holds, after the host's pairing this box already holds, after the host's
own address changed. No token. Cannot move the own address changed. No token. Cannot move the
anchor anywhere. anchor anywhere.
privatae-bastion approvals [--host <host>] privatae-bastion approvals [--host <host> | --machine] [--json]
show what your host is asking to do on this machine, in plain words show what your host is asking to do on this machine, in plain words
privatae-bastion approve [--host <host>] <id> privatae-bastion approve [--host <host> | --machine] <id>
approve one request with a code from the authenticator enrolled here approve one request with a code from the authenticator enrolled here
privatae-bastion deny [--host <host>] <id> privatae-bastion deny [--host <host> | --machine] <id>
refuse one request refuse one request. From the machine's owner account, beside the
bastion installed for the whole machine, both act on that bastion,
and so do switch (off with nothing, on with the owner's code) and,
with nothing, approvals drop, grants drop, ops drop and device-deny
privatae-bastion approvals drop [--host <host>] <id> privatae-bastion approvals drop [--host <host>] <id>
take back an approval this machine issued and has not used yet take back an approval this machine issued and has not used yet
privatae-bastion grants drop <store id> [--host <host>] privatae-bastion grants drop <store id> [--host <host>]
remove a folder grant held on this machine; the host is told remove a folder grant held on this machine; the host is told
privatae-bastion device-init make THIS machine your approval device: from then on a write a privatae-bastion device-init make THIS machine your approval device: from then on a write a
host asks of any machine you govern is approved with a tap here host asks of any machine you govern is approved with a tap here
privatae-bastion device-approvals what your machines are asking you to approve, in their words privatae-bastion device-approvals [--json] what your machines are asking you to approve, in their words
privatae-bastion device-approve <id>|all / device-deny <id> privatae-bastion device-approve <id>|all / device-deny <id>
sudo -H privatae-bastion pin-device <key> sudo -H privatae-bastion pin-device <key>
on a machine you govern: accept approvals signed by your device on a machine you govern: accept approvals signed by your device
(the key device-init printed). unpin-device <key> withdraws it (the key device-init printed). unpin-device <key> withdraws it
privatae-bastion ops [--host <host>] the ops your host wrote that this machine holds, and the privatae-bastion ops [--host <host>] [--json] the ops your host wrote that this machine holds, and the
standing op grants; ops drop <grant> takes one back standing op grants; ops drop <grant> takes one back
sudo -H privatae-bastion root-exec grant [--host <host>] --for <30d> sudo -H privatae-bastion root-exec grant [--host <host>] --for <30d>
let the anchor host run commands AS ROOT here, one at a time, let the anchor host run commands AS ROOT here, one at a time,
@@ -124,19 +141,61 @@ Usage:
privatae-bastion quarantine clear <host> privatae-bastion quarantine clear <host>
reopen a host's write lanes this machine closed after repeated reopen a host's write lanes this machine closed after repeated
refusals (5 in 10 minutes) refusals (5 in 10 minutes)
privatae-bastion quarantine clear --asker <account>
let agents running as that account ask this machine again, after
5 of their asks were refused in 10 minutes
sudo -H privatae-bastion switch <host> <family> on|off sudo -H privatae-bastion switch <host> <family> on|off
switch one capability family off for a host on this machine, switch one capability family off for a host on this machine,
or clear that refusal (the console page's switch). Off only or clear that refusal (the console page's switch). Off only
removes reach; on grants nothing past the host's signed grant removes reach; on grants nothing past the host's signed grant
privatae-bastion switch --list every paired host's families, on or off, one per line privatae-bastion switch --list [--json]
every paired host's families, on or off, one per line
privatae-bastion agents [--json] [--prompts]
every AI agent on this machine and what it is doing: its
session name and title, whether it waits for you, its folder
and branch, what it is running now (--prompts: its last prompt)
privatae-bastion agents show <pid or session> [--json] [--prompts]
one agent with everything known about it: what it is, the file
it runs, how it was recognised, what it says about itself
privatae-bastion doctor [--json]
what is wrong with this install, and the fix for each one.
Exit 1 when something is
privatae-bastion report [--since 7d] [--json] [--out FILE | --out -]
write what this bastion knows as one Markdown file: agents,
scheduled agents, MCP tool-server problems, the baseline, activity.
--out - prints it
privatae-bastion schedules [--json]
scheduled jobs that start an AI agent with nobody at the keyboard
privatae-bastion tool-servers [--json]
the MCP tool servers configured here and what is wrong with each
privatae-bastion posture [--json]
Linux: firewall, SSH, fail2ban, security updates, disk, load
privatae-bastion activity [--since 7d] [--json]
what happened on this machine, newest first: stops, your
approvals, what each Host did, and changes made here
privatae-bastion stop <pid or session> [--wait 5m] [--json]
stop an agent this bastion sees, and every process it started,
with your code as the machine's owner (stepup-enroll --machine).
Run by an agent, it only asks: you approve under Waiting for you
in the console. --wait follows the ask until it is answered
privatae-bastion request <id> [--wait 5m] [--json]
where an ask stands: waiting, approved, stopped, not stopped or
denied. Exit 0 stopped (or asked), 1 not, 3 still waiting
From the machine's owner account, beside the bastion installed for
the whole machine, the reads (status, agents, schedules,
tool-servers, posture, baseline, activity, report, approvals,
switch --list, ops, device-approvals, backup key show,
backup requests, backup shares, doctor) ask that bastion and
show the whole machine
privatae-bastion help this text
privatae-bastion coders set [--max N] [--mem MB] [--cpus F] [--engines a,b|all] [--allow-lan h[:p],...] privatae-bastion coders set [--max N] [--mem MB] [--cpus F] [--engines a,b|all] [--allow-lan h[:p],...]
[--image-prefix <registry/path/>|default] [--image-prefix <registry/path/>|default]
privatae-bastion coders on | off | drop [--host H] | status [--json] privatae-bastion coders on | off | drop [--host H] | status [--json]
let your hosts run sealed coding runs on this machine (Linux, as let your hosts run sealed coding runs on this machine (Linux, as
root): how many at once, how big each is, which engines. Off by root): how many at once, how big each is, which engines. Off by
default; each run has no network but a proxy to the internet default; each run has no network but a proxy to the internet
privatae-bastion git-setup print the two git config lines that route git.privatae.ai privatae-bastion git-setup print the git config lines that route git.privatae.ai
through this bastion (the forge is reachable only this way) through this bastion and your host
privatae-bastion git-credential git's credential helper — fetches your forge token from your privatae-bastion git-credential git's credential helper — fetches your forge token from your
host on every git auth (git-setup resets the helper chain so no host on every git auth (git-setup resets the helper chain so no
other helper caches it) other helper caches it)
@@ -146,15 +205,20 @@ Usage:
privatae-bastion context choose what your files become on your network. Runs as privatae-bastion context choose what your files become on your network. Runs as
you, so it shows exactly what you can already open, and asks you, so it shows exactly what you can already open, and asks
your host before anything is added your host before anything is added
privatae-bastion status show every pairing + tunnel status privatae-bastion status [--json] show every pairing + tunnel status
privatae-bastion observe:baseline record what is NORMAL on this machine: every automated privatae-bastion baseline record [--force]
record what is NORMAL on this machine: every automated
program, its user and a digest of the file it runs from. program, its user and a digest of the file it runs from.
Administrator only. --force replaces an existing baseline Administrator only. --force replaces an existing baseline
privatae-bastion observe:baseline:show print the baseline this machine holds (also: observe:baseline)
privatae-bastion observe:delta what is running here that the baseline does not hold: privatae-bastion baseline [show] [--json]
print the baseline this machine holds (also: observe:baseline:show)
privatae-bastion baseline diff [--json]
what is running here that the baseline does not hold:
new programs, replaced binaries, new standing jobs, with new programs, replaced binaries, new standing jobs, with
the ordinary ones filtered out. Administrator only. the ordinary ones filtered out. Administrator only.
--json for the full record including what was filtered --json for the full record including what was filtered
(also: observe:delta)
privatae-bastion observe print what this machine would report about agents, automations privatae-bastion observe print what this machine would report about agents, automations
and scheduled jobs on its next check-in (read-only, JSON) and scheduled jobs on its next check-in (read-only, JSON)
privatae-bastion backup key init | key show | reseal | requests | approve | deny | privatae-bastion backup key init | key show | reseal | requests | approve | deny |
@@ -188,7 +252,9 @@ func takeHostFlag(args []string) (string, []string) {
} }
const pairUsage = "usage: privatae-bastion pair [--replace] [--redeem-url unix:///<socket> | --redeem-url https://<host>:<port>/<path> --host-ca <pem file>] <token> | -\n" + const pairUsage = "usage: privatae-bastion pair [--replace] [--redeem-url unix:///<socket> | --redeem-url https://<host>:<port>/<path> --host-ca <pem file>] <token> | -\n" +
" - reads the token from standard input, so it stays out of the process list and shell history" " privatae-bastion pair <pairing code skp_…> | -\n" +
" - reads the token or pairing code from standard input, so it stays out of the process list and shell history\n" +
" exit status: 0 paired, 3 already paired with this Host (nothing changed), anything else a failure"
// parsePairArgs reads `pair`'s flags in any order: --replace, --redeem-url // parsePairArgs reads `pair`'s flags in any order: --replace, --redeem-url
// for a Host with no platform (pair_unix.go, pair_tcp.go) and --host-ca for // for a Host with no platform (pair_unix.go, pair_tcp.go) and --host-ca for
@@ -258,6 +324,15 @@ func main() {
os.Exit(2) os.Exit(2)
} }
err = cmdPair(token, redeemURL, hostCA, replace) err = cmdPair(token, redeemURL, hostCA, replace)
// Already paired with this Host, nothing changed: its own exit status,
// so the installers (install.ps1 -Pair, install.sh with
// PRIVATAE_PAIR_CODE) report "already connected".
var already *alreadyPairedError
if errors.As(err, &already) {
auditFlush(auditFlushOnExit)
fmt.Fprintln(os.Stderr, already)
os.Exit(pairExitAlreadyPaired)
}
case "run": case "run":
err = cmdRun() err = cmdRun()
case "observe:baseline": case "observe:baseline":
@@ -323,12 +398,15 @@ func main() {
err = cmdBackup(os.Args[2:]) err = cmdBackup(os.Args[2:])
case "stepup-enroll": case "stepup-enroll":
args := os.Args[2:] args := os.Args[2:]
host, rotate, consoleOnly := "", false, false host, machine, rotate, consoleOnly := "", false, false, false
for len(args) > 0 { for len(args) > 0 {
switch { switch {
case args[0] == "--host" && len(args) >= 2: case args[0] == "--host" && len(args) >= 2:
host = args[1] host = args[1]
args = args[2:] args = args[2:]
case args[0] == "--machine":
machine = true
args = args[1:]
case args[0] == "--rotate": case args[0] == "--rotate":
rotate = true rotate = true
args = args[1:] args = args[1:]
@@ -336,36 +414,42 @@ func main() {
consoleOnly = true consoleOnly = true
args = args[1:] args = args[1:]
default: default:
fmt.Fprintln(os.Stderr, "usage: privatae-bastion stepup-enroll [--host <host>] [--rotate] [--console-only]") fmt.Fprintln(os.Stderr, "usage: privatae-bastion stepup-enroll [--host <host> | --machine] [--rotate] [--console-only]")
os.Exit(2) os.Exit(2)
} }
} }
err = cmdStepupEnroll(host, rotate, consoleOnly) err = cmdStepupEnroll(host, machine, rotate, consoleOnly)
case "approvals", "approve", "deny": case "approvals", "approve", "deny":
// The user confirms (or refuses) what their host asked for, ON this machine, // The user confirms (or refuses) what their host asked for, ON this machine,
// with the factor enrolled here. The host never handles the code. // with the factor enrolled here. The host never handles the code.
host, args := takeHostFlag(os.Args[2:]) host, args := takeHostFlag(os.Args[2:])
machine, args := takeMachineFlag(args)
switch os.Args[1] { switch os.Args[1] {
case "approvals": case "approvals":
// approvals drop <id>: revoke an approval this box issued and has // approvals drop <id>: revoke an approval this box issued and has
// not yet burned — the console can always take back what it gave. // not yet burned — the console can always take back what it gave.
if len(args) >= 2 && args[0] == "drop" { if len(args) >= 2 && args[0] == "drop" {
err = cmdStepupDrop(host, args[1]) err = cmdStepupDrop(host, machine, args[1])
break break
} }
err = cmdStepupApprovals(host) asJSON, jerr := jsonOnly("usage: privatae-bastion approvals [--host <host> | --machine] [--json]", args)
if jerr != nil {
fmt.Fprintln(os.Stderr, jerr)
os.Exit(2)
}
err = cmdStepupApprovals(host, machine, asJSON)
case "approve": case "approve":
if len(args) < 1 { if len(args) < 1 {
fmt.Fprintln(os.Stderr, "usage: privatae-bastion approve [--host <host>] <request id>") fmt.Fprintln(os.Stderr, "usage: privatae-bastion approve [--host <host> | --machine] <request id>")
os.Exit(2) os.Exit(2)
} }
err = cmdStepupApprove(host, args[0]) err = cmdStepupApprove(host, machine, args[0])
case "deny": case "deny":
if len(args) < 1 { if len(args) < 1 {
fmt.Fprintln(os.Stderr, "usage: privatae-bastion deny [--host <host>] <request id>") fmt.Fprintln(os.Stderr, "usage: privatae-bastion deny [--host <host> | --machine] <request id>")
os.Exit(2) os.Exit(2)
} }
err = cmdStepupDeny(host, args[0]) err = cmdStepupDeny(host, machine, args[0])
} }
case "release-anchor": case "release-anchor":
// An anchor whose Host is gone (anchor_release.go): machine authority // An anchor whose Host is gone (anchor_release.go): machine authority
@@ -392,26 +476,40 @@ func main() {
err = cmdReleaseAnchor(host, caFile, force) err = cmdReleaseAnchor(host, caFile, force)
case "approvals-owner": case "approvals-owner":
// The one account the tray's lane serves (approvals_owner.go). // The one account the tray's lane serves (approvals_owner.go).
// On Linux and macOS, the account the console lane serves
// (owner_account.go): --account.
args := os.Args[2:] args := os.Args[2:]
sid, replace := "", false sid, account, replace, bad := "", "", false, false
for len(args) > 0 { for len(args) > 0 {
switch { switch {
case args[0] == "--sid" && len(args) >= 2: case args[0] == "--sid" && len(args) >= 2:
sid = args[1] sid = args[1]
args = args[2:] args = args[2:]
case args[0] == "--account" && len(args) >= 2:
account = args[1]
args = args[2:]
case args[0] == "--replace": case args[0] == "--replace":
replace = true replace = true
args = args[1:] args = args[1:]
default: default:
sid = "" bad = true
args = nil args = nil
} }
} }
if sid == "" { windows := runtime.GOOS == "windows"
if bad || (windows && (sid == "" || account != "")) || (!windows && (account == "" || sid != "")) {
if windows {
fmt.Fprintln(os.Stderr, "usage: privatae-bastion approvals-owner --sid <account SID> [--replace] (from an Administrator terminal)") fmt.Fprintln(os.Stderr, "usage: privatae-bastion approvals-owner --sid <account SID> [--replace] (from an Administrator terminal)")
} else {
fmt.Fprintln(os.Stderr, "usage: sudo -H privatae-bastion approvals-owner --account <name> [--replace]")
}
os.Exit(2) os.Exit(2)
} }
if windows {
err = cmdApprovalsOwner(sid, replace) err = cmdApprovalsOwner(sid, replace)
} else {
err = cmdOwnerAccount(account, replace)
}
case "tray": case "tray":
// The signed-in person's icon beside a system service // The signed-in person's icon beside a system service
// (tray_pipe_windows.go), started at every sign-in. // (tray_pipe_windows.go), started at every sign-in.
@@ -504,18 +602,30 @@ func main() {
// starts a server of its own and stays in the foreground: it is not a // starts a server of its own and stays in the foreground: it is not a
// view of the daemon, it is a separate surface with a different owner. // view of the daemon, it is a separate surface with a different owner.
err = cmdContextUI() err = cmdContextUI()
case "uninstall":
// Removes the service and the program; keeps the state and the audit
// log unless --delete-data (uninstall.go).
del := false
for _, a := range os.Args[2:] {
if a != "--delete-data" {
fmt.Fprintln(os.Stderr, "usage: privatae-bastion uninstall [--delete-data]")
os.Exit(2)
}
del = true
}
err = cmdUninstall(del)
case "ui": case "ui":
// Opens a browser at the RUNNING daemon's UI (ui.go). It starts no // Opens a browser at the RUNNING daemon's UI (ui.go). It starts no
// server of its own: the UI belongs to the process that knows what is // server of its own: the UI belongs to the process that knows what is
// live, and a second one would render a machine nobody is serving. // live, and a second one would render a machine nobody is serving.
err = cmdUI() err = cmdUI()
case "status": case "status":
err = cmdStatus() err = cmdStatus(os.Args[2:])
// ── the approval device (device.go) and the write gate's console side ── // ── the approval device (device.go) and the write gate's console side ──
case "device-init": case "device-init":
err = cmdDeviceInit() err = cmdDeviceInit()
case "device-approvals": case "device-approvals":
err = cmdDeviceApprovals() err = cmdDeviceApprovals(os.Args[2:])
case "device-approve", "device-deny": case "device-approve", "device-deny":
if len(os.Args) < 3 { if len(os.Args) < 3 {
fmt.Fprintln(os.Stderr, "usage: privatae-bastion "+os.Args[1]+" <request id> [--code <code>]") fmt.Fprintln(os.Stderr, "usage: privatae-bastion "+os.Args[1]+" <request id> [--code <code>]")
@@ -587,14 +697,20 @@ func main() {
} }
os.Exit(opActionChildMain(os.Args[2])) os.Exit(opActionChildMain(os.Args[2]))
case "ops": case "ops":
// ops [--host <host>] what ops and op grants this machine holds // ops [--host <host>] [--json] what ops and op grants this machine holds
// ops drop <grant> [--host <host>] take back a held op grant (the host is told) // ops drop <grant> [--host <host>] take back a held op grant (the host is told)
// ops drop --all [--host <host>] take back every op grant the host holds here
host, args := takeHostFlag(os.Args[2:]) host, args := takeHostFlag(os.Args[2:])
if len(args) >= 2 && args[0] == "drop" { if len(args) >= 2 && args[0] == "drop" {
err = cmdOpsDrop(host, args[1]) err = cmdOpsDrop(host, args[1])
break break
} }
err = cmdOpsList(host) asJSON, jerr := jsonOnly("usage: privatae-bastion ops [--host <host>] [--json] | ops drop <grant>|--all [--host <host>]", args)
if jerr != nil {
fmt.Fprintln(os.Stderr, jerr)
os.Exit(2)
}
err = cmdOpsList(host, asJSON)
case "root-exec": case "root-exec":
// root-exec [--host <host>] [grant --for <d> | revoke] (rootexec.go): the // root-exec [--host <host>] [grant --for <d> | revoke] (rootexec.go): the
// standing grant for the anchor host's root commands, given and taken // standing grant for the anchor host's root commands, given and taken
@@ -603,15 +719,62 @@ func main() {
case "quarantine": case "quarantine":
// quarantine clear <host>: lift the box's own hold on a pairing's // quarantine clear <host>: lift the box's own hold on a pairing's
// write lanes (quarantine.go) — the person at the machine, only. // write lanes (quarantine.go) — the person at the machine, only.
// quarantine clear --asker <account>: the same for an account whose
// agents' asks were held (askquarantine.go).
if len(os.Args) < 4 || os.Args[2] != "clear" { if len(os.Args) < 4 || os.Args[2] != "clear" {
fmt.Fprintln(os.Stderr, "usage: privatae-bastion quarantine clear <host>") fmt.Fprintln(os.Stderr, "usage: privatae-bastion quarantine clear <host> | --asker <account>")
os.Exit(2) os.Exit(2)
} }
if os.Args[3] == "--asker" {
if len(os.Args) != 5 {
fmt.Fprintln(os.Stderr, "usage: privatae-bastion quarantine clear --asker <account>")
os.Exit(2)
}
err = cmdQuarantineClearAsker(os.Args[4])
break
}
err = cmdQuarantineClear(os.Args[3]) err = cmdQuarantineClear(os.Args[3])
case "coders": case "coders":
// coders set|on|off|drop|status (coders_cli.go): size this machine // coders set|on|off|drop|status (coders_cli.go): size this machine
// for coder runs. Off by default. // for coder runs. Off by default.
err = cmdCoders(os.Args[2:]) err = cmdCoders(os.Args[2:])
case "report":
// report [--since 7d] [--json] [--out FILE] (report.go).
err = cmdReport(os.Args[2:])
case "activity":
// activity [--since 7d] [--json] (activity.go): what happened here.
err = cmdActivity(os.Args[2:])
case "agents":
// agents [--json] [--prompts] (agents_cli.go): every agent here and
// what it is doing — its session, folder, branch, what it runs now.
err = cmdAgents(os.Args[2:])
case "stop":
// stop <pid> [--wait D] [--json] (stop_local.go): the machine's owner
// stops an agent, with their own second factor; run by an agent it
// only files the request.
err = cmdStop(os.Args[2:])
case "request":
// request <id> [--wait D] [--json] (askstatus.go): where an ask stands.
err = cmdRequest(os.Args[2:])
case "schedules":
// schedules [--json] (machine_cli.go): scheduled jobs that start an agent.
err = cmdSchedules(os.Args[2:])
case "tool-servers":
// tool-servers [--json] (machine_cli.go): MCP tool servers and their problems.
err = cmdToolServers(os.Args[2:])
case "posture":
// posture [--json] (machine_cli.go): the checks a Host runs on its servers.
err = cmdPosture(os.Args[2:])
case "baseline":
// baseline show|diff [--json], baseline record [--force]
// (machine_cli.go): observe:baseline* under the words people use.
err = cmdBaseline(os.Args[2:])
case "doctor":
// doctor [--json] (doctor.go): what is wrong with this install, and
// the fix for each one.
err = cmdDoctor(os.Args[2:])
case "help", "-h", "--help":
usage()
case "switch": case "switch":
// switch <host> <family> on|off, switch --list (switch_cli.go): the // switch <host> <family> on|off, switch --list (switch_cli.go): the
// local switch without the console page, for a machine nobody sits at. // local switch without the console page, for a machine nobody sits at.
@@ -629,6 +792,10 @@ func main() {
// The command's audit rows reach the system log before the process ends // The command's audit rows reach the system log before the process ends
// (auditlog.go queues them off the op's own path). // (auditlog.go queues them off the op's own path).
auditFlush(auditFlushOnExit) auditFlush(auditFlushOnExit)
var quiet quietExit
if errors.As(err, &quiet) {
os.Exit(quiet.code) // the command already said what happened
}
if err != nil { if err != nil {
fmt.Fprintln(os.Stderr, "error:", err) fmt.Fprintln(os.Stderr, "error:", err)
os.Exit(1) os.Exit(1)

Some files were not shown because too many files have changed in this diff Show More