feat: add the module configuration and secrets contract
Modules had no way to be told anything. Announcements — the first real product Ekklesia will absorb — has zero environment variables and compiles a LAN IP address into its source, so this is the contract standing between it and the module system. - A module declares what it needs in its manifest, using six bounded types (string, integer, boolean, enum, url, secret) with no nesting and no regular expressions. Static declaration is what lets the platform validate configuration *before* deciding whether a module may start: an enabled module missing a required value is reported `blocked · configuration_missing · <key>` rather than taking startup down from inside its own `start` hook, and Doctor reports the same while still importing no module code. That forces `manifestVersion: 5`, a hard cutover. - Ordinary values persist in one Core table (migration 0005), one row per (module_id, key), stored as text until validated against the declaring module's current manifest. Nothing is coerced; an invalid stored value blocks the module rather than falling back to the default. A key the manifest no longer declares is retained and ignored. - Secrets are never persisted. There is no encryption at rest in this repository, so a `secret` key is deployment-supplied and mapped in by the host under a name the module never sees. A secret declaration has no `default` field, the write API refuses secret material, and the HTTP view has no `value` field for one — absent by construction, not filtered. - Modules receive a frozen `context.config` on the registration, runtime, and HTTP handler contexts: the same object identity, per module, beside `services` rather than inside it (services is deliberately one shared instance). No environment access, no database reference, no way to reach another module's values. - Configuration decides eligibility through ADR 0028's existing resolver: three new blocked reasons, each with a distinct operator fix, propagating to required dependents through the same mechanism as a disabled module. - Changes take effect at the next restart; both resources report restartRequired. New restricted permission `core.modules.configuration.manage`, separate from lifecycle, at the sibling prefix `/api/v1/module-configuration`. - Migration participation stays independent of configuration validity. Endpoints and credentials for shared infrastructure stay platform concerns; a module declares which bucket it needs, not an S3 endpoint. See ADR 0029. Co-Authored-By: Claude Opus 5 <[email protected]>
This commit is contained in:
co-authored by
Claude Opus 5
parent
fdaad58848
commit
baa689b2a7
@@ -174,6 +174,25 @@ demonstrably keeps serving, and is applied only by the next start; and a disable
|
||||
are still discovered, because deployed schema ownership is not runtime enabled state. See
|
||||
[ADR 0028](../architecture/decisions/0028-module-operational-lifecycle.md).
|
||||
|
||||
A sixth dedicated suite (`core/tests/module-configuration-store.integration.ts`, included in the same
|
||||
`pnpm test:migrations:integration` run) proves the module configuration store against real
|
||||
PostgreSQL: that migration `0005` really creates `ekklesia_core_module_configuration` with the
|
||||
composite `(module_id, key)` primary key, the declared CHECK constraints, and **no column that could
|
||||
hold secret material**; that a replace is transactional, whole-document, and scoped to one module so
|
||||
another module's rows are untouched; that stored values survive a completely new connection; that an
|
||||
oversized value is refused by the application *and* by the database; that a store error never carries
|
||||
the offending value; and — the security-relevant one — that a module id or key is only ever data in a
|
||||
parameterized column, so an injection attempt is a validation error and the table still exists
|
||||
afterwards.
|
||||
|
||||
The API suite additionally proves the configuration boundary end to end: a secret's value never
|
||||
appears in any response (including when a row for that key is planted directly in storage), a
|
||||
declared-but-undeclared key, a wrong JSON type, a constraint violation, and a `secret` key each fail
|
||||
with a distinct sanitized code and store nothing, a reserved property name such as `__proto__` is
|
||||
rejected without touching `Object.prototype`, and a module blocked by its own configuration is absent
|
||||
from the mountable UI inventory exactly like a disabled one. See
|
||||
[ADR 0029](../architecture/decisions/0029-module-configuration-and-secrets.md).
|
||||
|
||||
### Which kind of timing proof lives where
|
||||
|
||||
Pass 4 introduced several deadlines, and their tests deliberately differ in kind:
|
||||
|
||||
Reference in New Issue
Block a user