fix(openbao): never put the vault token on a command line
`BAO_TOKEN=<root> bash update.sh update` -- which the previous commit and the pre-existing DR runbook both recommended -- leaks the token twice over. It goes into the shell history, and `docker compose exec -e BAO_TOKEN=<value>` puts it in the docker process's argv, where /proc/<pid>/cmdline makes it readable by every user on the host. The second is the worse one and is not fixed by anything the operator does at their prompt. The token now reaches the container over STDIN and is never an argument to anything: the container's own shell reads one line, exports it, and execs bao. Verified locally that the child process sees the exact value -- including &, | and a backslash -- while its argv contains zero occurrences of it. How a token is supplied, in order: an already-exported BAO_TOKEN; a 0600 file named by the new BAO_TOKEN_FILE; otherwise an echo-off prompt. With no token and no terminal it dies telling the operator to use BAO_TOKEN_FILE rather than an inline assignment, and says why. Added a `snapshot` subcommand so the DR runbook no longer needs an inline pipeline at all. That runbook and the deploy banner both carried the -e form before this deployment had an updater, so both are corrected: taking a backup is now `bash update.sh snapshot`, and restore keeps the stdin shape rather than -e. The Kanrisha bootstrap lines say to export the token first instead of passing it inline. The conf file still refuses to hold a token, but now points at BAO_TOKEN_FILE as the unattended answer -- and suggests a snapshot-policy token rather than the root token for it. Not verified without a live host: that `docker compose exec -T` forwards stdin as expected. If it does not, the snapshot fails loudly with a permission error and the upgrade aborts before touching anything, which is the safe direction. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
1 parent
2d3d322b0e
commit
0eb7f26663
3 files changed
+311
-217
No files matched your search
@@ -120,7 +120,7 @@ Docker. Copy `tls.crt` to that host first and pass it as `BAO_CACERT`:
|
||||
|
||||
```bash
|
||||
BAO_ADDR=https://$OPENBAO_ADDR:8200 BAO_CACERT=/path/to/openbao-ca.crt \
|
||||
BAO_TOKEN=<root> bash bootstrap.sh
|
||||
bash bootstrap.sh # export BAO_TOKEN beforehand rather than passing it inline
|
||||
```
|
||||
|
||||
It enables the `kanrisha-tape` KV-v2 mount (with **effectively-unlimited**
|
||||
@@ -178,7 +178,7 @@ deploy step.
|
||||
```bash
|
||||
cd /srv/openbao
|
||||
bash update.sh check # declared / running / latest + seal state
|
||||
BAO_TOKEN=<token> bash update.sh update # snapshot, then upgrade
|
||||
bash update.sh update # snapshot, then upgrade (prompts)
|
||||
```
|
||||
|
||||
Unlike the copyparty and ergo updaters in this repo, this one **will not update
|
||||
@@ -191,8 +191,11 @@ configured — only auto-unseal makes the vault come back on its own.
|
||||
|
||||
Before it changes anything, `update` requires that the container is running, the
|
||||
vault is **unsealed** (a sealed vault cannot produce a snapshot, so there would
|
||||
be no rollback plan), and a `BAO_TOKEN` with `sys/storage/raft/snapshot` — the
|
||||
root token works. It writes the snapshot to `/var/backups/openbao` at `0600`,
|
||||
be no rollback plan), and a token with `sys/storage/raft/snapshot` — the root
|
||||
token works. It **prompts** for that token with echo off; never pass it as
|
||||
`BAO_TOKEN=... bash update.sh`, which puts it in your shell history and in
|
||||
`/proc/<pid>/cmdline`, where every user on the box can read it. For unattended
|
||||
use set `BAO_TOKEN_FILE` to a `0600` file. It writes the snapshot to `/var/backups/openbao` at `0600`,
|
||||
verifies it is a valid non-empty gzip archive, and refuses to continue if it is
|
||||
not. **Copy it off the host**: it is the rollback plan, and OpenBao's upgrade
|
||||
guide is explicit that reverting the image alone does not roll back the data
|
||||
@@ -211,19 +214,26 @@ the external `plugin "kms" "pkcs11"` first.
|
||||
The vault is the sole recovery path for encrypted tapes — back it up:
|
||||
|
||||
Snapshot save/restore are **token-gated** (`sys/storage/raft/snapshot` is
|
||||
sudo-capable) — pass a token that has that path (the root token works, or mint a
|
||||
dedicated snapshot-policy token). The container has no ambient token, so supply
|
||||
it via `-e BAO_TOKEN`.
|
||||
sudo-capable) — they need a token that has that path (the root token works, or
|
||||
mint a dedicated snapshot-policy token). The container has no ambient token.
|
||||
|
||||
**Do not put the token on a command line.** `docker ... -e BAO_TOKEN=<value>`
|
||||
places it in the docker process's argv, and `/proc/<pid>/cmdline` is readable by
|
||||
every user on the host — so it leaks further than your shell history does. Use
|
||||
`update.sh snapshot`, which prompts with echo off and passes the token to the
|
||||
container over stdin:
|
||||
|
||||
```bash
|
||||
# Consistent raft snapshot (safe while running); write it to a scratch path, NOT
|
||||
# into the live raft dir:
|
||||
docker compose exec -T -e BAO_TOKEN=<token> openbao \
|
||||
bao operator raft snapshot save -address=https://127.0.0.1:8200 -tls-skip-verify /tmp/openbao.snap
|
||||
# then stream the RAW file off-box, age-encrypted. Use `exec -T ... cat`, not
|
||||
# `compose cp openbao:… -` (which emits a TAR wrapper that won't restore):
|
||||
docker compose exec -T openbao cat /tmp/openbao.snap | \
|
||||
age -r "$(cat /path/to/globals/age-pubkey.txt)" > "openbao-$(date +%F).snap.age"
|
||||
cd /srv/openbao
|
||||
bash update.sh snapshot # prompts; writes to /var/backups/openbao, 0600
|
||||
```
|
||||
|
||||
Then age-encrypt it and move it off-box:
|
||||
|
||||
```bash
|
||||
age -r "$(cat /path/to/globals/age-pubkey.txt)" \
|
||||
< /var/backups/openbao/openbao-pre-manual-*.snap \
|
||||
> "openbao-$(date +%F).snap.age"
|
||||
```
|
||||
|
||||
Restore (into a fresh, unsealed vault): decrypt, copy the raw `.snap` in, and
|
||||
@@ -232,8 +242,12 @@ apply it (also token-gated):
|
||||
```bash
|
||||
age -d -i ~/.age/key.txt openbao-DATE.snap.age > openbao.snap
|
||||
docker compose cp openbao.snap openbao:/tmp/openbao.snap
|
||||
docker compose exec -T -e BAO_TOKEN=<token> openbao \
|
||||
bao operator raft snapshot restore -address=https://127.0.0.1:8200 -tls-skip-verify /tmp/openbao.snap
|
||||
# Same argv problem as above, so hand the token over stdin rather than -e:
|
||||
read -rs -p "token: " T; echo
|
||||
printf '%s\n' "$T" | docker compose exec -T openbao sh -c \
|
||||
'read -r t; BAO_TOKEN="$t" exec bao operator raft snapshot restore \
|
||||
-address=https://127.0.0.1:8200 -tls-skip-verify /tmp/openbao.snap'
|
||||
unset T
|
||||
```
|
||||
|
||||
Snapshots do **not** contain the unseal keys or root token — you still need
|
||||
|
||||
Reference in new issue
Block a user