Files
ReactorcoremeltdownandClaude Opus 5.5 4ffc434b1b Keep server data in an encrypted database, and harden every part
Storage. The server keeps its data in SQLite (a file in the data
directory, the default) or PostgreSQL (database, KEEPORG_DATABASE_URL or
-database). Every row, the KDBX versions included, is sealed with
AES-256-GCM under a key derived from the master key and named by an HMAC.
The master key is required to start and a different one is refused. A data
directory from 0.10 or earlier is imported on first start. Several servers
may share one PostgreSQL database. Go goes to 1.26 for the pure-Go
drivers (modernc.org/sqlite, jackc/pgx).

Hardening, after an audit of the server, both clients and the deployment:
- Single sign-on approves a device only after an explicit Approve in the
  browser that started it, bound by a cookie and PKCE; identities are never
  linked by username, by verified email only when allowed, never to admins.
- Sign-in attempts are limited per address and per account, passwords are
  checked outside the store lock with uniform timing, one-time codes work
  once, and starting two-factor needs the password.
- Merge vaults bound KDF parameters, payload size and XML shape, check
  pushes before storing them, and run at most two merges at once. A version
  is written in the same transaction as its metadata.
- Tokens in URLs only on the event stream, which ends on revocation; CSP,
  frame-ancestors, no-store and HSTS; sign-in CSRF; 404 for databases
  without access; new trusted_proxies.
- Clients open only the server's approval page, keep case-variant and
  retired file names apart, never overwrite a save made during a pull,
  require https except locally, send the stream token in a header, bound
  their reads and escape notifications and terminal output.
- The .deb creates the master key, systemd is sandboxed further, nginx sets
  modern TLS and HSTS, and CI deploys from main only.

Server 0.12.0, desktop 0.6.0, Android 0.4.0 (versionCode 4).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-02 15:38:32 +01:00

66 lines
2.5 KiB
YAML

# A deployment of the KeepOrg server, showing the thing that is easiest to
# get wrong: where the master key comes from, and that it does not live in
# the data volume.
#
# head -c 32 /dev/urandom | base64 > master.key # once; keep a copy safe
# chmod 600 master.key
# podman-compose up -d # or docker compose up -d
#
# The key is provisioned as a secret and named to the server with
# KEEPORG_MASTER_KEY_FILE, so it is never in the process environment and
# never on a disk the container can write. Everything the server stores is
# encrypted under that key, so it does not start without it.
#
# The data goes to a SQLite file on the keeporg-data volume. For PostgreSQL,
# set KEEPORG_DATABASE_URL below instead; the volume then only matters for
# importing a data directory from 0.10 or earlier.
services:
keeporgd:
# `make docker` tags both the version from versions.mk and :latest.
# Pin with KEEPORG_VERSION in production.
image: keeporgd:${KEEPORG_VERSION:-latest}
build:
context: ../..
args:
# Only used when compose builds the image itself; `make docker`
# stamps the real version.
VERSION: "${KEEPORG_VERSION:-dev}"
restart: unless-stopped
# Terminate TLS in front of this, and set external_url to the address a
# browser sees: invite links, device approval and the OIDC redirect are
# built from it.
command:
- "-addr=:8765"
- "-data=/var/lib/keeporg"
- "-url=https://keeporg.example.com"
ports:
- "127.0.0.1:8765:8765"
secrets:
- keeporg_master_key
environment:
KEEPORG_MASTER_KEY_FILE: /run/secrets/keeporg_master_key
# PostgreSQL instead of the SQLite file. The URL carries a password,
# so in production put it in a secret too.
# KEEPORG_DATABASE_URL: "postgres://keeporg:change-me@postgres:5432/keeporg?sslmode=disable"
# The alternative, when the key comes from a store that injects
# variables rather than files. One or the other, not both.
# KEEPORG_MASTER_KEY: "${KEEPORG_MASTER_KEY:-}"
#
# Only read on the very first start, when no accounts exist yet.
KEEPORG_ADMIN_PASSWORD: "${KEEPORG_ADMIN_PASSWORD:-}"
volumes:
- keeporg-data:/var/lib/keeporg
# The server writes one directory and needs no privileges at all.
read_only: true
cap_drop: ["ALL"]
security_opt: ["no-new-privileges:true"]
user: "65532:65532"
secrets:
keeporg_master_key:
file: ./master.key
volumes:
keeporg-data: