feat(openzaak): real secrets + TLS for the production OpenZaak harness (WP-55)
CI / changes (push) Successful in 8s
CI / lint (push) Successful in 12s
CI / frontend (push) Successful in 14s
CI / storybook-a11y (push) Successful in 17s
CI / backend (push) Successful in 1m51s
CI / semgrep (push) Successful in 1m13s
CI / e2e (push) Successful in 2m56s
CI / api-client-drift (push) Successful in 1m41s
CI / changes (push) Successful in 8s
CI / lint (push) Successful in 12s
CI / frontend (push) Successful in 14s
CI / storybook-a11y (push) Successful in 17s
CI / backend (push) Successful in 1m51s
CI / semgrep (push) Successful in 1m13s
CI / e2e (push) Successful in 2m56s
CI / api-client-drift (push) Successful in 1m41s
docker-compose.openzaak.prod.yml layers real SECRET_KEY/DB password/site
domain/allowed-hosts (all required, fail-fast via ${VAR:?...}) on top of the
WP-54 dev harness, switches Postgres off trust auth, and sets IS_HTTPS for a
front-facing reverse-proxy TLS setup. The ZGW client secret lives inside a
file setup_configuration reads rather than a compose env var, so it's
templated (data.prod.yaml.template, no secret) and rendered host-side via
render-prod-secrets.sh into a gitignored data.prod.yaml, mounted over the
container's dev data.yaml. ZgwOptions.cs already binds from IConfiguration,
so the BFF side needed no code change.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
@@ -50,6 +50,40 @@ up, so it never runs where the harness doesn't exist.
|
||||
docker compose -f docker-compose.openzaak.yml down -v
|
||||
```
|
||||
|
||||
## Production (WP-55)
|
||||
|
||||
This dev harness stays dev-only: hardcoded `SECRET_KEY`, `POSTGRES_HOST_AUTH_METHOD=trust`,
|
||||
`IS_HTTPS: 'no'`, a client secret checked into `setup_configuration/data.yaml`. A real
|
||||
deployment layers `docker-compose.openzaak.prod.yml` on top instead of replacing anything:
|
||||
|
||||
```bash
|
||||
export OPENZAAK_SECRET_KEY=... # Django SECRET_KEY — generate, don't reuse the dev value
|
||||
export OPENZAAK_DB_PASSWORD=... # postgres password (switches auth off `trust`)
|
||||
export OPENZAAK_SITE_DOMAIN=... # e.g. open-zaak.example.org — no scheme/port
|
||||
export OPENZAAK_ALLOWED_HOSTS=... # Django ALLOWED_HOSTS, usually the same domain
|
||||
export OPENZAAK_CLIENT_ID=... # the BFF's OpenZaak client id (ZgwOptions:ClientId)
|
||||
export OPENZAAK_CLIENT_SECRET=... # the BFF's JWT signing secret (ZgwOptions:Secret)
|
||||
export OPENZAAK_APPLICATIE_UUID=$(uuidgen)
|
||||
|
||||
./render-prod-secrets.sh # writes the gitignored setup_configuration/data.prod.yaml
|
||||
docker compose -f docker-compose.openzaak.yml -f docker-compose.openzaak.prod.yml up -d
|
||||
```
|
||||
|
||||
Every one of those env vars is `${VAR:?...}`-checked — compose (and `render-prod-secrets.sh`
|
||||
for the client secret) refuses to start rather than silently falling back to a dev-looking
|
||||
default. There is no env var that "means insecure default"; if it's unset, it's a hard error.
|
||||
|
||||
**TLS**: OpenZaak itself does no certificate handling. Put a reverse proxy/ingress (the same
|
||||
one fronting the BFF) in front of `web`'s `:8000`, terminate TLS there, and forward to
|
||||
`http://web:8000` over the compose network. `IS_HTTPS: 'yes'` in the prod override only tells
|
||||
Django it's being served over HTTPS (secure cookies, `SECURE_*` redirects) — it does not open
|
||||
a TLS listener itself.
|
||||
|
||||
The BFF side needs no code change: `ZgwOptions` already binds `ClientId`/`Secret`/the base
|
||||
URLs from `IConfiguration`, so pointing it at a production OpenZaak is a config change
|
||||
(`Zgw:ClientId`/`Zgw:Secret`/`Zgw:ZrcBaseUrl` etc. via env vars or a secrets manager), not an
|
||||
app change.
|
||||
|
||||
## What's in here / what isn't
|
||||
|
||||
- `docker-compose.openzaak.yml` — postgres (postgis), redis, a one-shot `web-init` (runs
|
||||
@@ -72,3 +106,11 @@ docker compose -f docker-compose.openzaak.yml down -v
|
||||
`procesType` on the public VNG selectielijst API).
|
||||
- **Not here**: Documenten (DRC) / Notificaties (NRC) content — add if a later WP needs to prove
|
||||
those round-trips against a live instance too (WP-51/52 are fixture-tested today).
|
||||
- `docker-compose.openzaak.prod.yml` (WP-55) — production overrides layered on top of
|
||||
`docker-compose.openzaak.yml`: real `SECRET_KEY`/DB password/site domain/allowed-hosts from
|
||||
required env vars (fails fast if unset), password DB auth instead of `trust`, `IS_HTTPS: 'yes'`.
|
||||
Adds no image/service of its own — see "Production" above for the full flow.
|
||||
- `setup_configuration/data.prod.yaml.template` (WP-55) — the prod counterpart of `data.yaml`
|
||||
with no secret in it (`${OPENZAAK_CLIENT_SECRET}` etc. as placeholders); `render-prod-secrets.sh`
|
||||
fills it in to the gitignored `data.prod.yaml`, which the prod compose override mounts over
|
||||
the container's `data.yaml`.
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
# WP-55 — production overrides for docker-compose.openzaak.yml: real secrets, real DB auth,
|
||||
# HTTPS-aware settings. Use ON TOP of the base file, never alone (it has no image/ports of its
|
||||
# own to add — see backend/openzaak/README.md for the required env vars and full flow):
|
||||
#
|
||||
# ./render-prod-secrets.sh # renders setup_configuration/data.prod.yaml (gitignored)
|
||||
# docker compose -f docker-compose.openzaak.yml -f docker-compose.openzaak.prod.yml up -d
|
||||
#
|
||||
# TLS is NOT terminated here — OpenZaak sits behind a reverse proxy/ingress that owns the
|
||||
# certificate; this file only tells OpenZaak (via IS_HTTPS) that it's being served over HTTPS
|
||||
# so it sets secure cookies / redirects correctly.
|
||||
services:
|
||||
db:
|
||||
environment:
|
||||
- POSTGRES_HOST_AUTH_METHOD=md5
|
||||
- POSTGRES_PASSWORD=${OPENZAAK_DB_PASSWORD:?OPENZAAK_DB_PASSWORD must be set}
|
||||
|
||||
web-init:
|
||||
environment:
|
||||
SECRET_KEY: ${OPENZAAK_SECRET_KEY:?OPENZAAK_SECRET_KEY must be set}
|
||||
DB_PASSWORD: ${OPENZAAK_DB_PASSWORD:?OPENZAAK_DB_PASSWORD must be set}
|
||||
IS_HTTPS: 'yes'
|
||||
SITE_DOMAIN: ${OPENZAAK_SITE_DOMAIN:?OPENZAAK_SITE_DOMAIN must be set}
|
||||
ALLOWED_HOSTS: ${OPENZAAK_ALLOWED_HOSTS:?OPENZAAK_ALLOWED_HOSTS must be set}
|
||||
DISABLE_2FA: 'false'
|
||||
volumes:
|
||||
# Shadows the dev data.yaml (still mounted read-only from the base file) with the
|
||||
# secret-free template rendered by render-prod-secrets.sh.
|
||||
- ./setup_configuration/data.prod.yaml:/app/setup_configuration/data.yaml:ro
|
||||
|
||||
web:
|
||||
environment:
|
||||
SECRET_KEY: ${OPENZAAK_SECRET_KEY:?OPENZAAK_SECRET_KEY must be set}
|
||||
DB_PASSWORD: ${OPENZAAK_DB_PASSWORD:?OPENZAAK_DB_PASSWORD must be set}
|
||||
IS_HTTPS: 'yes'
|
||||
SITE_DOMAIN: ${OPENZAAK_SITE_DOMAIN:?OPENZAAK_SITE_DOMAIN must be set}
|
||||
ALLOWED_HOSTS: ${OPENZAAK_ALLOWED_HOSTS:?OPENZAAK_ALLOWED_HOSTS must be set}
|
||||
DISABLE_2FA: 'false'
|
||||
Executable
+16
@@ -0,0 +1,16 @@
|
||||
#!/usr/bin/env bash
|
||||
# WP-55 — renders setup_configuration/data.prod.yaml.template into the gitignored
|
||||
# data.prod.yaml docker-compose.openzaak.prod.yml mounts over the container's data.yaml.
|
||||
# Run this once before `docker compose ... up` in a production deploy; re-run whenever the
|
||||
# secrets rotate. Fails fast (no output file) if a required env var is missing — never
|
||||
# silently falls back to a real-looking default.
|
||||
set -euo pipefail
|
||||
cd "$(dirname "${BASH_SOURCE[0]}")"
|
||||
|
||||
: "${OPENZAAK_SITE_DOMAIN:?OPENZAAK_SITE_DOMAIN must be set (e.g. open-zaak.example.org)}"
|
||||
: "${OPENZAAK_CLIENT_ID:?OPENZAAK_CLIENT_ID must be set}"
|
||||
: "${OPENZAAK_CLIENT_SECRET:?OPENZAAK_CLIENT_SECRET must be set}"
|
||||
: "${OPENZAAK_APPLICATIE_UUID:?OPENZAAK_APPLICATIE_UUID must be set (a fresh UUID, e.g. \$(uuidgen))}"
|
||||
|
||||
envsubst < setup_configuration/data.prod.yaml.template > setup_configuration/data.prod.yaml
|
||||
echo "Wrote setup_configuration/data.prod.yaml"
|
||||
@@ -0,0 +1,28 @@
|
||||
# Prod counterpart of data.yaml (WP-54's dev-only version, kept as-is for local iteration —
|
||||
# see docker-compose.openzaak.yml's own comment on why it hardcodes a client secret). This
|
||||
# template has no secret in it; render-prod-secrets.sh substitutes OPENZAAK_CLIENT_SECRET
|
||||
# into it to produce the gitignored data.prod.yaml that docker-compose.openzaak.prod.yml
|
||||
# mounts over the container's data.yaml.
|
||||
#
|
||||
# Least-privilege client scopes (heeft_alle_autorisaties: true below) are WP-57's job, not
|
||||
# this WP's — left matching the dev harness on purpose.
|
||||
sites_config_enable: true
|
||||
sites_config:
|
||||
items:
|
||||
- domain: ${OPENZAAK_SITE_DOMAIN}
|
||||
name: OpenZaak (production)
|
||||
|
||||
vng_api_common_credentials_config_enable: true
|
||||
vng_api_common_credentials:
|
||||
items:
|
||||
- identifier: ${OPENZAAK_CLIENT_ID}
|
||||
secret: ${OPENZAAK_CLIENT_SECRET}
|
||||
|
||||
vng_api_common_applicaties_config_enable: true
|
||||
vng_api_common_applicaties:
|
||||
items:
|
||||
- uuid: ${OPENZAAK_APPLICATIE_UUID}
|
||||
client_ids:
|
||||
- ${OPENZAAK_CLIENT_ID}
|
||||
label: BIG-register BFF (production)
|
||||
heeft_alle_autorisaties: true
|
||||
Reference in New Issue
Block a user