boatramp_node/config.rs
1//! Local configuration files (RON).
2//!
3//! Two distinct files, split by audience:
4//!
5//! - **`project.cfg`** — one per project folder, read by the client commands
6//! (`sync`, `build`, `bundle`, `validate`): where/how to publish, the optional
7//! build/bundle steps, and the deploy-scoped `routing` config that is folded
8//! into the immutable deployment manifest. See [`ProjectConfig`].
9//! - **`boatramp.cfg`** — the server daemon config, read by `serve`:
10//! `serve` / `handlers` / `cluster`. See [`ServerConfig`].
11//!
12//! Both are RON; a missing file yields the default config.
13
14use std::collections::BTreeMap;
15use std::net::SocketAddr;
16use std::path::{Path, PathBuf};
17
18use boatramp_core::config::DeployConfig;
19use serde::Deserialize;
20
21/// RON parse options shared by both loaders: `implicit_some` lets optional fields
22/// be written as bare values (`server: "..."`, not `Some("...")`). `pub` so the
23/// binary (which re-exports this module) can parse a manifest with the same
24/// options after the module moved into this crate.
25pub fn ron_options() -> ron::Options {
26 ron::Options::default().with_default_extension(ron::extensions::Extensions::IMPLICIT_SOME)
27}
28
29/// The wire format an operator-authored config file is decoded as (v0.6.5).
30///
31/// Config files are historically RON. JSON was added as a second **input** format
32/// purely for interop — so a config can be generated from Nickel (`nickel export` →
33/// JSON) and fed to boatramp unchanged. It is an alternative *decoder* into the
34/// **same** typed structs (they all derive serde `Deserialize` with externally-tagged
35/// enums + `deny_unknown_fields`), so JSON preserves every variant name and the same
36/// strictness — no type changes, and the same downstream validation runs either way.
37#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
38#[cfg_attr(feature = "clap", derive(clap::ValueEnum))]
39pub enum ConfigFormat {
40 /// RON (the historical, default format). Selected for every non-`.json`
41 /// extension (`.cfg` / `.ron` / none).
42 #[default]
43 Ron,
44 /// JSON — for configs generated from Nickel (`nickel export`) or any JSON
45 /// pipeline. Selected for a `.json` (case-insensitive) extension.
46 Json,
47}
48
49/// Resolve the [`ConfigFormat`] for a config path.
50///
51/// The rule is explicit and predictable (config is the operator trust boundary, so
52/// there is **no content-sniffing** — a sniff could silently RON-parse a JSON file
53/// into a wrong-but-valid config, and vice versa):
54///
55/// 1. an explicit `override_` (the CLI `--format ron|json`) always wins; else
56/// 2. auto by extension — a `.json` (case-insensitive) extension ⇒ [`ConfigFormat::Json`];
57/// everything else (`.cfg` / `.ron` / no extension) ⇒ [`ConfigFormat::Ron`].
58pub fn resolve_format(path: &Path, override_: Option<ConfigFormat>) -> ConfigFormat {
59 if let Some(fmt) = override_ {
60 return fmt;
61 }
62 match path.extension().and_then(|e| e.to_str()) {
63 Some(ext) if ext.eq_ignore_ascii_case("json") => ConfigFormat::Json,
64 _ => ConfigFormat::Ron,
65 }
66}
67
68/// A failure loading or parsing a local config file (`project.cfg` / `boatramp.cfg`).
69#[derive(Debug, thiserror::Error)]
70pub enum ConfigError {
71 /// Wraps an underlying error with the file path it came from.
72 #[error("{path}: {source}")]
73 File {
74 path: String,
75 #[source]
76 source: Box<Self>,
77 },
78 /// The RON document failed to parse.
79 #[error("invalid config syntax: {0}")]
80 Ron(#[from] ron::error::SpannedError),
81 /// The JSON document failed to parse (JSON config input — e.g. from
82 /// `nickel export`). Same strictness as RON: `deny_unknown_fields` on the
83 /// structs makes a typo'd/unknown key a hard error here, not a silent drop.
84 #[error("invalid JSON config: {0}")]
85 Json(#[from] serde_json::Error),
86 /// The `routing` section failed its compile-check.
87 #[error("routing: {0}")]
88 Routing(#[from] boatramp_core::ConfigError),
89 /// Reading the file failed (other than not-found, which yields defaults).
90 #[error(transparent)]
91 Io(#[from] std::io::Error),
92 /// An environment-variable override could not be parsed (bad number/bool).
93 #[error("environment variable {var}: {reason}")]
94 Env {
95 /// The offending `BOATRAMP_*` variable. Owned because some names are built
96 /// dynamically (the keyed `databases` map, whose members aren't known at
97 /// compile time).
98 var: String,
99 /// Why the value was rejected.
100 reason: String,
101 },
102 /// A `handlers.bindings.sql.databases` binding name is not a safe URL path
103 /// segment — it is threaded verbatim into `/api/sql/{db}/…` and `--db`, so an
104 /// empty/`//`-collapsing or path-separator-bearing name is refused at load
105 /// (fail-closed) rather than emitting a malformed control-plane path.
106 #[error("SQL database binding {name:?}: {reason}{cure}")]
107 InvalidDbName {
108 /// The offending binding name (the `databases` map key).
109 name: String,
110 /// Why it was rejected (from the canonical validator).
111 reason: &'static str,
112 /// A trailing remediation hint (empty unless this is the legacy empty-name
113 /// default case, where it points at the `default` cure).
114 cure: &'static str,
115 },
116}
117
118/// Project configuration, loaded from `project.cfg` (RON) in the project folder.
119///
120/// Read by the client commands (`sync`, `build`, `bundle`, `validate`).
121/// Everything is optional; a missing file is the default.
122#[derive(Debug, Default, Deserialize)]
123#[serde(default)]
124pub struct ProjectConfig {
125 /// Where and how to publish this project.
126 pub publish: PublishConfig,
127 /// Optional build step run before `sync`.
128 pub build: Option<BuildConfig>,
129 /// Optional embedded-bundler step (`bundler` feature).
130 pub bundle: Option<BundleConfig>,
131 /// Deploy-scoped routing/handlers config. Folded into the deployment
132 /// manifest at `sync` (so it is atomic with the content and rolls back with
133 /// it). The bulk of a project's config — redirects, rewrites, headers,
134 /// handlers, consumers, crons, streams.
135 pub routing: DeployConfig,
136}
137
138impl ProjectConfig {
139 /// Parse a `project.cfg` document as **RON** (the default). Kept for the existing
140 /// callers/tests; [`Self::parse_with_format`] is the format-aware entry point.
141 pub fn parse(text: &str) -> Result<Self, ConfigError> {
142 Self::parse_with_format(text, ConfigFormat::Ron)
143 }
144
145 /// Parse a `project.cfg` document in `fmt` (RON or JSON). The deserializer is
146 /// selected by format (RON ⇒ [`ron_options`], JSON ⇒ `serde_json`) into the SAME
147 /// typed struct; the `routing` section is then compile-checked (route patterns,
148 /// cron schedules, imports) regardless of format so a bad config fails fast.
149 pub fn parse_with_format(text: &str, fmt: ConfigFormat) -> Result<Self, ConfigError> {
150 let config: Self = match fmt {
151 ConfigFormat::Ron => ron_options().from_str(text)?,
152 ConfigFormat::Json => serde_json::from_str(text)?,
153 };
154 config.routing.compile_check()?;
155 Ok(config)
156 }
157
158 /// Load from `path`, decoding as RON or JSON per [`resolve_format`] (`override_`
159 /// wins; else `.json` ⇒ JSON, everything else ⇒ RON). A missing file yields the
160 /// default config (unlike an apply manifest).
161 pub fn load(path: &Path, override_: Option<ConfigFormat>) -> Result<Self, ConfigError> {
162 let fmt = resolve_format(path, override_);
163 match std::fs::read_to_string(path) {
164 Ok(contents) => {
165 Self::parse_with_format(&contents, fmt).map_err(|err| ConfigError::File {
166 path: path.display().to_string(),
167 source: Box::new(err),
168 })
169 }
170 Err(err) if err.kind() == std::io::ErrorKind::NotFound => Ok(Self::default()),
171 Err(err) => Err(err.into()),
172 }
173 }
174}
175
176/// Server daemon configuration, loaded from `boatramp.cfg` (RON). Read by
177/// `boatramp serve`; flags/env override the `serve` values.
178#[derive(Debug, Default, Deserialize)]
179#[serde(default)]
180pub struct ServerConfig {
181 /// Server defaults for `serve` (flag/env override these).
182 pub serve: Option<ServeConfig>,
183 /// Server-side handler runtime config (which backend serves each binding),
184 /// consumed only with the `handlers` feature.
185 pub handlers: Option<HandlersConfig>,
186 /// Self-hosted cluster mode (consumed only with the `cluster` feature).
187 pub cluster: Option<ClusterConfig>,
188 /// Opt-in **compute** backends. Present ⇒ this node
189 /// runs compute workloads via the backends it can offer; absent ⇒ no compute
190 /// (the reconcile loop stays a no-op).
191 pub compute: Option<ComputeConfig>,
192 /// Operator security posture (the hardening knobs): a profile
193 /// preset + overrides, resolved at startup. Absent ⇒ the strict
194 /// `multi-tenant` default. Operator-only — never part of site config.
195 pub security: Option<boatramp_core::security::SecurityConfig>,
196 /// Secrets-at-rest envelope. Absent ⇒ private
197 /// keys stored cleartext in the (replicated) control plane.
198 pub secrets: Option<SecretsConfig>,
199}
200
201/// `secrets` section — envelope encryption for private keys at rest.
202#[cfg_attr(not(feature = "cluster"), allow(dead_code))]
203#[derive(Debug, Clone, Default, Deserialize)]
204#[serde(default, deny_unknown_fields)]
205pub struct SecretsConfig {
206 /// Backend: `"local"` (machine-local AES-256-GCM KEK) or `"vault"` (Vault
207 /// Transit). Empty/other ⇒ no wrapping. In a cluster a local KEK must be the
208 /// **same file on every node** (wrapped certs replicate); Vault avoids that.
209 pub envelope: String,
210 /// Local-KEK key file (`envelope = "local"`). Default
211 /// `<data-dir>/secrets/kek`. Auto-generated `0600` if absent.
212 pub kek_file: Option<PathBuf>,
213 /// Vault Transit config (`envelope = "vault"`).
214 pub vault: Option<VaultSecretsConfig>,
215}
216
217/// Vault Transit settings for `envelope = "vault"`. The token is read from the
218/// environment (`token_env`), never stored in the config file.
219#[cfg_attr(not(all(feature = "cluster", feature = "acme-dns")), allow(dead_code))]
220#[derive(Debug, Clone, Deserialize)]
221#[serde(deny_unknown_fields)]
222pub struct VaultSecretsConfig {
223 /// Vault address, e.g. `https://vault:8200`.
224 pub addr: String,
225 /// Transit key name to wrap under.
226 pub key: String,
227 /// Environment variable holding the Vault token (default `VAULT_TOKEN`).
228 #[serde(default = "default_vault_token_env")]
229 pub token_env: String,
230}
231
232fn default_vault_token_env() -> String {
233 "VAULT_TOKEN".to_string()
234}
235
236impl Default for VaultSecretsConfig {
237 fn default() -> Self {
238 Self {
239 addr: String::new(),
240 key: String::new(),
241 token_env: default_vault_token_env(),
242 }
243 }
244}
245
246/// The RESERVED compute-workload name prefix (#501 Stage B LOW-2). boatramp DERIVES the
247/// per-project managed-database server workloads with this prefix
248/// (`boatramp_storage::tenant_provision::DERIVED_MANAGED_DB_PREFIX`), so an operator must
249/// NOT name a static `[handlers].bindings.sql.databases.*.compute` workload with it — a
250/// collision could shadow / alias a derived managed server. Screened fail-closed at
251/// config load ([`ServerConfig::validate_sql_db_names`]). Kept as a literal here (not the
252/// `boatramp-storage` const) so the screen holds on a build without the sql engine
253/// features; the two must stay in sync (a single source of truth would couple config
254/// loading to the optional storage dep).
255const RESERVED_MANAGED_DB_COMPUTE_PREFIX: &str = "bramp-db-";
256
257impl ServerConfig {
258 /// Parse a `boatramp.cfg` document as **RON** (the default). Kept for the existing
259 /// callers/tests; [`Self::parse_with_format`] is the format-aware entry point.
260 pub fn parse(text: &str) -> Result<Self, ConfigError> {
261 Self::parse_with_format(text, ConfigFormat::Ron)
262 }
263
264 /// Parse a `boatramp.cfg` document in `fmt` (RON or JSON). The deserializer is
265 /// selected by format (RON ⇒ [`ron_options`], JSON ⇒ `serde_json`) into the SAME
266 /// typed struct. Db-binding names declared in the file are validated here (the same
267 /// fail-closed check `load` re-runs after the env merge) **regardless of format**, so
268 /// a file-only config path — e.g. `boatramp cloudflare` rendering, or the
269 /// operator-resources loader — is guarded even without going through `load`.
270 pub fn parse_with_format(text: &str, fmt: ConfigFormat) -> Result<Self, ConfigError> {
271 let config: Self = match fmt {
272 ConfigFormat::Ron => ron_options().from_str(text)?,
273 ConfigFormat::Json => serde_json::from_str(text)?,
274 };
275 config.validate_sql_db_names()?;
276 Ok(config)
277 }
278
279 /// Load from `path`, decoding as RON or JSON per [`resolve_format`] (`override_`
280 /// wins; else `.json` ⇒ JSON, everything else ⇒ RON), then layer `BOATRAMP_*`
281 /// environment overrides on top. A missing file yields the default config, so
282 /// `serve` can be configured entirely from the environment (12-factor deployments
283 /// where dropping a `boatramp.cfg` is awkward — fly.io / Cloudflare / containers).
284 ///
285 /// The env-override merge runs AFTER the parse for either format — JSON is only an
286 /// alternative decoder into the same typed struct; it does not change the
287 /// file < env precedence.
288 pub fn load(path: &Path, override_: Option<ConfigFormat>) -> Result<Self, ConfigError> {
289 let fmt = resolve_format(path, override_);
290 let mut config = match std::fs::read_to_string(path) {
291 Ok(contents) => {
292 Self::parse_with_format(&contents, fmt).map_err(|err| ConfigError::File {
293 path: path.display().to_string(),
294 source: Box::new(err),
295 })?
296 }
297 Err(err) if err.kind() == std::io::ErrorKind::NotFound => Self::default(),
298 Err(err) => return Err(err.into()),
299 };
300 config.apply_env_overrides(&EnvSource::Process)?;
301 Ok(config)
302 }
303
304 /// Layer `BOATRAMP_*` environment overrides onto the loaded config for the
305 /// `compute`, `security`, and handler-`sql` sections — the operational knobs
306 /// that were previously reachable only through the `boatramp.cfg` file.
307 ///
308 /// **Precedence: env overrides file.** This matches the existing `serve`
309 /// section (its `#[arg(long, env = …)]` flags already let an env var win over
310 /// the file value), keeping the resolution rule uniform. A set variable
311 /// updates the field even when the file also set it; an unset variable leaves
312 /// the file (or built-in default) untouched. When a section is absent from the
313 /// file but any of its variables are set, the section is materialised from its
314 /// defaults first — so no config file is required to configure it.
315 ///
316 /// `source` supplies the variables (the process environment in production; an
317 /// explicit map in tests), so this stays a pure function of its inputs.
318 fn apply_env_overrides(&mut self, source: &EnvSource) -> Result<(), ConfigError> {
319 // --- compute ---------------------------------------------------------
320 // Materialise `[compute]` only if at least one of its variables is set, so
321 // an unset environment leaves an absent section absent (⇒ no compute).
322 if source.any(COMPUTE_ENV_VARS) {
323 let compute = self.compute.get_or_insert_with(ComputeConfig::default);
324 if let Some(v) = source.get("BOATRAMP_COMPUTE_BRIDGE") {
325 compute.bridge = v;
326 }
327 if let Some(v) = source.get("BOATRAMP_COMPUTE_SUBNET") {
328 compute.subnet = v;
329 }
330 if let Some(v) = source.parse("BOATRAMP_COMPUTE_VCPUS")? {
331 compute.vcpus = v;
332 }
333 if let Some(v) = source.parse("BOATRAMP_COMPUTE_MEM_MIB")? {
334 compute.mem_mib = v;
335 }
336 if let Some(v) = source.get("BOATRAMP_COMPUTE_REGION") {
337 compute.region = Some(v);
338 }
339 if let Some(v) = source.get("BOATRAMP_COMPUTE_SQL_SHIM_URL") {
340 compute.sql_shim_url = Some(v);
341 }
342 // The two shared-kernel enums have no `FromStr`, only a serde
343 // `rename_all = "lowercase"`; map their variants by that same spelling.
344 if let Some(v) = source.parse_enum(
345 "BOATRAMP_COMPUTE_MANAGED_DB_PRIVILEGE",
346 &[
347 ("rootless", ManagedDbPrivilege::Rootless),
348 ("caps", ManagedDbPrivilege::Caps),
349 ],
350 )? {
351 compute.managed_db_privilege = v;
352 }
353 if let Some(v) = source.parse_enum(
354 "BOATRAMP_COMPUTE_DOCKER_ENDPOINT",
355 &[
356 ("published", boatramp_docker::DockerEndpoint::Published),
357 ("bridge", boatramp_docker::DockerEndpoint::Bridge),
358 ],
359 )? {
360 compute.docker_endpoint = v;
361 }
362 if let Some(v) = source.parse_enum(
363 "BOATRAMP_COMPUTE_DOCKER_VOLUME_MODE",
364 &[
365 ("named", boatramp_docker::DockerVolumeMode::Named),
366 ("bind", boatramp_docker::DockerVolumeMode::Bind),
367 ],
368 )? {
369 compute.docker_volume_mode = v;
370 }
371 // Kernel trust anchors — comma-separated lists. These are
372 // security-critical: they are the trust anchor for the posture-scaled
373 // kernel bar, so a value here decides which kernels a `multi-tenant`
374 // node will boot. In a 12-factor deployment the environment IS the
375 // operator's trusted config source (a fly.toml `[env]` is committed the
376 // same as a file), so they are exposed here — but an operator should
377 // know the environment is *more* visible than a file (it leaks through
378 // `/proc/<pid>/environ` and is inherited by every subprocess), so a
379 // file remains the better home for them when one is available.
380 if let Some(v) = source.parse_list("BOATRAMP_COMPUTE_KERNEL_SIGNING_PUBKEYS") {
381 compute.kernel_signing_pubkeys = v;
382 }
383 if let Some(v) = source.parse_list("BOATRAMP_COMPUTE_KERNEL_ALLOWED_HASHES") {
384 compute.kernel_allowed_hashes = v;
385 }
386 // Internal DNS (per-project service discovery on the bridge gateway).
387 if let Some(v) = source.parse_bool("BOATRAMP_COMPUTE_INTERNAL_DNS")? {
388 compute.internal_dns = v;
389 }
390 if let Some(v) = source.get("BOATRAMP_COMPUTE_DNS_UPSTREAM") {
391 compute.dns_upstream = v;
392 }
393 if let Some(v) = source.get("BOATRAMP_COMPUTE_DNS_DOMAIN") {
394 compute.dns_domain = v;
395 }
396 }
397
398 // --- security --------------------------------------------------------
399 // Always materialise `[security]` when any knob is set: an absent section
400 // resolves to the strict `multi-tenant` default, and an env override then
401 // layers over that exactly as a file `overrides` block would.
402 if source.any(SECURITY_ENV_VARS) {
403 let security = self
404 .security
405 .get_or_insert_with(boatramp_core::security::SecurityConfig::default);
406 if let Some(v) = source.get("BOATRAMP_SECURITY_PROFILE") {
407 security.profile = Some(v);
408 }
409 let o = &mut security.overrides;
410 if let Some(v) =
411 source.parse_bool("BOATRAMP_SECURITY_ALLOW_UNAUTHENTICATED_PUBLIC_BIND")?
412 {
413 o.allow_unauthenticated_public_bind = Some(v);
414 }
415 if let Some(v) = source.parse("BOATRAMP_SECURITY_MAX_UPLOAD_BYTES")? {
416 o.max_upload_bytes = Some(v);
417 }
418 if let Some(v) = source.parse_bool("BOATRAMP_SECURITY_ALLOW_SITE_UNIX_UPSTREAMS")? {
419 o.allow_site_unix_upstreams = Some(v);
420 }
421 if let Some(v) = source.parse_bool("BOATRAMP_SECURITY_ALLOW_SITE_PRIVATE_UPSTREAMS")? {
422 o.allow_site_private_upstreams = Some(v);
423 }
424 if let Some(v) = source.parse_bool("BOATRAMP_SECURITY_ALLOW_GUEST_PRIVATE_EGRESS")? {
425 o.allow_guest_private_egress = Some(v);
426 }
427 if let Some(v) = source.parse_bool("BOATRAMP_SECURITY_ALLOW_GUEST_SELF_EGRESS")? {
428 o.allow_guest_self_egress = Some(v);
429 }
430 if let Some(v) = source.parse_bool("BOATRAMP_SECURITY_ALLOW_GUEST_EGRESS_EXTRA_CA")? {
431 o.allow_guest_egress_extra_ca = Some(v);
432 }
433 if let Some(v) = source.parse("BOATRAMP_SECURITY_MAX_HANDLER_BLOB_BYTES")? {
434 o.max_handler_blob_bytes = Some(v);
435 }
436 if let Some(v) = source.parse("BOATRAMP_SECURITY_MAX_COMPONENT_BYTES")? {
437 o.max_component_bytes = Some(v);
438 }
439 if let Some(v) = source.parse_bool("BOATRAMP_SECURITY_OIDC_REQUIRE_AUDIENCE")? {
440 o.oidc_require_audience = Some(v);
441 }
442 if let Some(v) = source.parse_bool("BOATRAMP_SECURITY_DOMAIN_VERIFY_ALLOW_PRIVATE")? {
443 o.domain_verify_allow_private = Some(v);
444 }
445 if let Some(v) = source.parse_bool("BOATRAMP_SECURITY_DOMAIN_VERIFY_SELF_SERVE")? {
446 o.domain_verify_self_serve = Some(v);
447 }
448 if let Some(v) = source.parse_bool("BOATRAMP_SECURITY_ALLOW_SHARED_KERNEL_COMPUTE")? {
449 o.allow_shared_kernel_compute = Some(v);
450 }
451 if let Some(v) = source.parse_bool("BOATRAMP_SECURITY_ALLOW_COMPUTE_EXEC")? {
452 o.allow_compute_exec = Some(v);
453 }
454 if let Some(v) = source.parse_bool("BOATRAMP_SECURITY_RATELIMIT_FAIL_OPEN")? {
455 o.ratelimit_fail_open = Some(v);
456 }
457 if let Some(v) = source.parse_bool("BOATRAMP_SECURITY_ALLOW_IMPLICIT_ROUTING")? {
458 o.allow_implicit_routing = Some(v);
459 }
460 if let Some(v) = source.parse_bool("BOATRAMP_SECURITY_REQUIRE_POP")? {
461 o.require_pop = Some(v);
462 }
463 if let Some(v) = source.parse_bool("BOATRAMP_SECURITY_REQUIRE_DOMAIN_VERIFICATION")? {
464 o.require_domain_verification = Some(v);
465 }
466 if let Some(v) = source.parse_bool("BOATRAMP_SECURITY_ALLOW_ENV_SECRET_REFS")? {
467 o.allow_env_secret_refs = Some(v);
468 }
469 // The multi-tenant sub-knobs (Gap 4b): previously file-only, now env-settable so a
470 // 12-factor deployment can tune tenancy isolation + guest capability minting without a
471 // `boatramp.cfg`. Fleet-scoped (a per-project override still lives in the config file).
472 if let Some(v) = source.parse_bool("BOATRAMP_SECURITY_REQUIRE_TENANCY_DECLARATION")? {
473 o.require_tenancy_declaration = Some(v);
474 }
475 if let Some(v) = source.parse_bool("BOATRAMP_SECURITY_ALLOW_CROSS_TENANT_DB")? {
476 o.allow_cross_tenant_db = Some(v);
477 }
478 if let Some(v) = source.parse_bool("BOATRAMP_SECURITY_ALLOW_GUEST_MINT_CAPABILITY")? {
479 o.allow_guest_mint_capability = Some(v);
480 }
481 if let Some(v) = source.parse("BOATRAMP_SECURITY_MAX_GUEST_CAPABILITY_TTL_SECS")? {
482 o.max_guest_capability_ttl_secs = Some(v);
483 }
484 // Remaining guest-feature knobs — env parity for a 12-factor fleet that runs env-only
485 // (no `boatramp.cfg`). Each preset defaults these OFF under `multi-tenant`, so an
486 // env-only multi-tenant deployment had no lever to opt a guest feature back on. The
487 // override field + `apply()` + `explain()` already exist for every one; only the env
488 // mapping was missing (`allow_guest_email` regressed prod SMTP on the P48 cutover).
489 if let Some(v) = source.parse_bool("BOATRAMP_SECURITY_ALLOW_GUEST_EMAIL")? {
490 o.allow_guest_email = Some(v);
491 }
492 if let Some(v) = source.parse_bool("BOATRAMP_SECURITY_ALLOW_GUEST_ADMIN_DOMAINS")? {
493 o.allow_guest_admin_domains = Some(v);
494 }
495 if let Some(v) = source.parse_bool("BOATRAMP_SECURITY_ALLOW_GUEST_ADMIN_EMAIL")? {
496 o.allow_guest_admin_email = Some(v);
497 }
498 if let Some(v) = source.parse_bool("BOATRAMP_SECURITY_ALLOW_GUEST_ADMIN_SITE")? {
499 o.allow_guest_admin_site = Some(v);
500 }
501 if let Some(v) = source.parse_bool("BOATRAMP_SECURITY_ALLOW_GUEST_ADMIN_SECRETS")? {
502 o.allow_guest_admin_secrets = Some(v);
503 }
504 }
505
506 // --- handler sql (`handlers.bindings.sql`) ---------------------------
507 // Materialise the nested `handlers.bindings.sql` chain only when a `sql`
508 // variable is set, so an unset environment doesn't conjure an empty
509 // handlers section. The variables mirror the config path
510 // (`BOATRAMP_HANDLERS_SQL_*`) and cover the cluster-vs-single-node knobs;
511 // secrets stay indirected via `*_TOKEN_ENV` names, never the token itself.
512 if source.any(SQL_ENV_VARS) {
513 let handlers = self.handlers.get_or_insert_with(HandlersConfig::default);
514 let sql = handlers
515 .bindings
516 .sql
517 .get_or_insert_with(SqlBindingConfig::default);
518 if let Some(v) = source.get("BOATRAMP_HANDLERS_SQL_DIR") {
519 sql.dir = Some(PathBuf::from(v));
520 }
521 if let Some(v) = source.get("BOATRAMP_HANDLERS_SQL_URL") {
522 sql.url = Some(v);
523 }
524 if let Some(v) = source.get("BOATRAMP_HANDLERS_SQL_ADMIN_URL") {
525 sql.admin_url = Some(v);
526 }
527 if let Some(v) = source.get("BOATRAMP_HANDLERS_SQL_REPLICA_URL") {
528 sql.replica_url = Some(v);
529 }
530 if let Some(v) = source.get("BOATRAMP_HANDLERS_SQL_TOKEN_ENV") {
531 sql.token_env = Some(v);
532 }
533 if let Some(v) = source.get("BOATRAMP_HANDLERS_SQL_ADMIN_TOKEN_ENV") {
534 sql.admin_token_env = Some(v);
535 }
536 if let Some(v) = source.get("BOATRAMP_HANDLERS_SQL_PREVIEW_MODE") {
537 sql.preview_mode = Some(v);
538 }
539 if let Some(v) = source.get("BOATRAMP_HANDLERS_SQL_PREVIEW_INIT") {
540 sql.preview_init = Some(PathBuf::from(v));
541 }
542 if let Some(v) = source.parse("BOATRAMP_HANDLERS_SQL_DEPROVISION_GRACE_SECS")? {
543 sql.deprovision_grace_secs = Some(v);
544 }
545 }
546
547 // --- handler sql external databases (`handlers.bindings.sql.databases`) ---
548 // The bring-your-own / managed-compute DB map, keyed by name. There is no
549 // config file to enumerate the members, so the member names are discovered
550 // from the environment: any `BOATRAMP_HANDLERS_SQL_DB_<NAME>_<FIELD>`
551 // variable declares database `<NAME>`. Each env-declared DB is merged into
552 // (overriding, per field, by key) whatever the file already declared under
553 // that name — the same env-over-file precedence as the scalars.
554 //
555 // The default database (the binding a handler opens as `sql.open("")`) is
556 // addressed by the reserved `DEFAULT` token, which can't appear as a literal
557 // in a variable name: `BOATRAMP_HANDLERS_SQL_DB_DEFAULT_KIND` populates the
558 // reserved [`DEFAULT_DB_NAME`](boatramp_core::project::DEFAULT_DB_NAME) key
559 // (`"default"`). As of v0.5.0 this is a real, path-segment-safe name (never the
560 // empty string), so the binding is addressable as `--db default` and every
561 // db-name ingress carries a valid URL path segment. The guest-facing
562 // `sql.open("")` contract is preserved by aliasing `"" ⇄ "default"` at the
563 // backend-resolution boundary — external bindings are a pure label over their
564 // connection params, so the renamed binding points at the SAME physical DB.
565 if source.any_with_prefix(SQL_DB_ENV_PREFIX) {
566 let handlers = self.handlers.get_or_insert_with(HandlersConfig::default);
567 let sql = handlers
568 .bindings
569 .sql
570 .get_or_insert_with(SqlBindingConfig::default);
571 for name in source.sql_database_names() {
572 // `DEFAULT` is the reserved token for the default database; it maps to
573 // the reserved real name `"default"` (v0.5.0; was the empty string).
574 let key = if name == "DEFAULT" {
575 boatramp_core::project::DEFAULT_DB_NAME.to_string()
576 } else {
577 name.clone()
578 };
579 let db = sql.databases.entry(key).or_default();
580 let prefix = format!("{SQL_DB_ENV_PREFIX}{name}_");
581 if let Some(v) = source.get(&format!("{prefix}KIND")) {
582 db.kind = v;
583 }
584 if let Some(v) = source.get(&format!("{prefix}URL_ENV")) {
585 db.url_env = v;
586 }
587 if let Some(v) = source.get(&format!("{prefix}READ_URL_ENV")) {
588 db.read_url_env = Some(v);
589 }
590 if let Some(v) = source.get(&format!("{prefix}COMPUTE")) {
591 db.compute = Some(v);
592 }
593 if let Some(v) = source.get(&format!("{prefix}DATABASE")) {
594 db.database = Some(v);
595 }
596 if let Some(v) = source.get(&format!("{prefix}USER")) {
597 db.user = Some(v);
598 }
599 if let Some(v) = source.get(&format!("{prefix}PASSWORD_ENV")) {
600 db.password_env = Some(v);
601 }
602 if let Some(v) = source.parse(&format!("{prefix}POOL_MAX"))? {
603 db.pool_max = Some(v);
604 }
605 if let Some(v) = source.parse_bool(&format!("{prefix}READ_ONLY"))? {
606 db.read_only = v;
607 }
608 if let Some(v) = source.parse_bool(&format!("{prefix}ALLOW_PREVIEW"))? {
609 db.allow_preview = v;
610 }
611 if let Some(v) = source.parse(&format!("{prefix}CONNECT_TIMEOUT_SECS"))? {
612 db.connect_timeout_secs = Some(v);
613 }
614 if let Some(v) = source.get(&format!("{prefix}IMAGE")) {
615 db.image = Some(v);
616 }
617 if let Some(v) = source.parse(&format!("{prefix}VOLUME_SIZE_MIB"))? {
618 db.volume_size_mib = Some(v);
619 }
620 if let Some(v) = source.parse(&format!("{prefix}STARTUP_GRACE_SECS"))? {
621 db.startup_grace_secs = Some(v);
622 }
623 if let Some(v) = source.parse_enum(
624 &format!("{prefix}TENANT"),
625 &[
626 ("single", TenantIsolation::Single),
627 ("shared", TenantIsolation::Shared),
628 ],
629 )? {
630 db.tenant = v;
631 }
632 if let Some(v) = source.parse_enum(
633 &format!("{prefix}TENANT_SCOPE"),
634 &[
635 ("project", TenantScope::Project),
636 ("site", TenantScope::Site),
637 ],
638 )? {
639 db.tenant_scope = v;
640 }
641 if let Some(v) = source.parse_bool(&format!("{prefix}RLS_SESSION"))? {
642 db.rls_session = v;
643 }
644 if let Some(v) = source.get(&format!("{prefix}TENANT_GUC")) {
645 db.tenant_guc = Some(v);
646 }
647 if let Some(v) = source.get(&format!("{prefix}SESSION_GUC")) {
648 db.session_guc = Some(v);
649 }
650 if let Some(v) = source.get(&format!("{prefix}TENANT_ALL_MARKER")) {
651 db.tenant_all_marker = Some(v);
652 }
653 }
654 }
655
656 // --- secrets (`[secrets]`) -------------------------------------------
657 // Envelope encryption for private keys at rest. `kek_file` holds a *path*
658 // (never key material) and the Vault token stays indirected via
659 // `token_env` (a variable name, not the token). Materialise the nested
660 // `vault` sub-config only when a vault variable is set.
661 if source.any(SECRETS_ENV_VARS) {
662 let secrets = self.secrets.get_or_insert_with(SecretsConfig::default);
663 if let Some(v) = source.get("BOATRAMP_SECRETS_ENVELOPE") {
664 secrets.envelope = v;
665 }
666 if let Some(v) = source.get("BOATRAMP_SECRETS_KEK_FILE") {
667 secrets.kek_file = Some(PathBuf::from(v));
668 }
669 if source.any(SECRETS_VAULT_ENV_VARS) {
670 let vault = secrets
671 .vault
672 .get_or_insert_with(VaultSecretsConfig::default);
673 if let Some(v) = source.get("BOATRAMP_SECRETS_VAULT_ADDR") {
674 vault.addr = v;
675 }
676 if let Some(v) = source.get("BOATRAMP_SECRETS_VAULT_KEY") {
677 vault.key = v;
678 }
679 if let Some(v) = source.get("BOATRAMP_SECRETS_VAULT_TOKEN_ENV") {
680 vault.token_env = v;
681 }
682 }
683 }
684
685 // --- cluster (`[cluster]`) -------------------------------------------
686 // The self-hosted cluster section's own fields. The founding/joining
687 // *actions* already have their own `serve` flags with env
688 // (`BOATRAMP_CLUSTER_INIT` / `_JOIN` / `_ADVERTISE_ADDR`); those are
689 // distinct from — and not duplicated by — the `[cluster]` section fields
690 // exposed here. `join_token` keeps a secret out of plain sight via the
691 // usual `env:VAR` / `path:/file` prefix, so the env holds the *reference*,
692 // not the token. `ClusterConfig` has no `Default` (a founder needs at least
693 // a `listen`), so a `BOATRAMP_CLUSTER_LISTEN` is required to materialise an
694 // absent section from the environment.
695 if source.any(CLUSTER_ENV_VARS) {
696 // Materialise an absent section only if a bind address is supplied;
697 // otherwise there is no valid `ClusterConfig` to build (it has no
698 // `Default` — a node must know where to bind its mesh). When the file
699 // already declared `[cluster]`, its `listen` stands and the other env
700 // fields layer over it even without `BOATRAMP_CLUSTER_LISTEN`.
701 let listen = source.parse::<SocketAddr>("BOATRAMP_CLUSTER_LISTEN")?;
702 if self.cluster.is_none()
703 && let Some(listen) = listen
704 {
705 self.cluster = Some(ClusterConfig {
706 listen,
707 root_pubkeys: Vec::new(),
708 seeds: Vec::new(),
709 join_token: None,
710 store_dir: None,
711 mesh: None,
712 });
713 }
714 if let Some(cluster) = self.cluster.as_mut() {
715 // A `listen` override applies to an already-present section too (a
716 // freshly materialised one already carries it).
717 if let Some(v) = listen {
718 cluster.listen = v;
719 }
720 if let Some(v) = source.parse_list("BOATRAMP_CLUSTER_ROOT_PUBKEYS") {
721 cluster.root_pubkeys = v;
722 }
723 if let Some(v) = source.parse_list("BOATRAMP_CLUSTER_SEEDS") {
724 cluster.seeds = v;
725 }
726 if let Some(v) = source.get("BOATRAMP_CLUSTER_JOIN_TOKEN") {
727 cluster.join_token = Some(v);
728 }
729 if let Some(v) = source.get("BOATRAMP_CLUSTER_STORE_DIR") {
730 cluster.store_dir = Some(PathBuf::from(v));
731 }
732 if source.any(CLUSTER_MESH_ENV_VARS) {
733 let mesh = cluster.mesh.get_or_insert_with(MeshConfig::default);
734 if let Some(v) = source.get("BOATRAMP_CLUSTER_MESH_KEY_FILE") {
735 mesh.key_file = Some(PathBuf::from(v));
736 }
737 if let Some(v) = source.get("BOATRAMP_CLUSTER_MESH_KEY_ROTATION") {
738 mesh.key_rotation = Some(v);
739 }
740 if let Some(v) = source.get("BOATRAMP_CLUSTER_MESH_JOIN_TOKEN_TTL") {
741 mesh.join_token_ttl = Some(v);
742 }
743 if let Some(v) =
744 source.parse_bool("BOATRAMP_CLUSTER_MESH_GATE_CLIENT_WRITES")?
745 {
746 mesh.gate_client_writes = Some(v);
747 }
748 }
749 }
750 }
751
752 // Fail closed on any db-binding name that is not a safe URL path segment.
753 // Runs on the fully merged (file + env) `databases` map, so it catches a name
754 // from either source — and (crucially) the legacy empty-string default key,
755 // which is no longer produced by the `DEFAULT` token but could still be
756 // written literally in a `boatramp.cfg` file.
757 self.validate_sql_db_names()?;
758 Ok(())
759 }
760
761 /// Validate every configured `handlers.bindings.sql.databases` binding name
762 /// through the one canonical [`validate_resource_name`](boatramp_core::project::validate_resource_name)
763 /// (`kind = "database"`). A db-binding name is threaded verbatim into the
764 /// control-plane URL (`/api/sql/{db}/…`, `/api/migrate/{db}/…`) and the CLI
765 /// `--db`, so it must be a non-empty, path-segment-safe identifier — the same rule
766 /// project/site/function names already pass. The empty-string legacy default key
767 /// gets a targeted cure pointing at the reserved `default` name.
768 ///
769 /// Also screens each binding's `compute` field against the
770 /// [`RESERVED_MANAGED_DB_COMPUTE_PREFIX`] (#501 Stage B LOW-2): the `bramp-db-`
771 /// prefix is reserved for the derived per-project managed-DB server workloads, so an
772 /// operator may not point a static BYO binding at a `bramp-db-…` workload.
773 fn validate_sql_db_names(&self) -> Result<(), ConfigError> {
774 let Some(databases) = self
775 .handlers
776 .as_ref()
777 .and_then(|h| h.bindings.sql.as_ref())
778 .map(|s| &s.databases)
779 else {
780 return Ok(());
781 };
782 for (name, db) in databases {
783 if let Err(err) = boatramp_core::project::validate_resource_name("database", name) {
784 // The empty-string case is the pre-v0.5.0 default binding key: point
785 // at the cure (name it `default`, or set nothing and let the reserved
786 // `DEFAULT` token map to `default` automatically). Any other
787 // non-conforming name gets the v0.7.0 slug cure pointing at
788 // `project doctor`. This is a boot-LOUD refusal — an operator learns of
789 // a bad name at `serve` boot, not at the first request.
790 let cure = if name.is_empty() {
791 " — name your default binding `default` (or set \
792 BOATRAMP_HANDLERS_SQL_DB_DEFAULT_*, which now maps to `default` \
793 automatically); see the v0.5.0 CHANGELOG"
794 } else {
795 boatramp_core::project::INVALID_NAME_CURE
796 };
797 return Err(ConfigError::InvalidDbName {
798 name: err.value,
799 reason: err.reason,
800 cure,
801 });
802 }
803 // #501 Stage B LOW-2: the `bramp-db-` compute-workload prefix is RESERVED for
804 // the derived per-project managed-DB server workloads
805 // (`boatramp_storage::tenant_provision::DERIVED_MANAGED_DB_PREFIX`). An operator
806 // must not point a static BYO binding at a `compute` workload with that prefix —
807 // it could shadow / alias a derived managed server. Screen it fail-closed at
808 // config load (cheap: a `starts_with` on an already-parsed field).
809 if let Some(compute) = db.compute.as_deref()
810 && compute.starts_with(RESERVED_MANAGED_DB_COMPUTE_PREFIX)
811 {
812 return Err(ConfigError::InvalidDbName {
813 name: compute.to_string(),
814 reason: "the `bramp-db-` compute-workload prefix is reserved for \
815 boatramp-derived managed-database servers",
816 cure: " — rename the `compute` workload to not start with `bramp-db-`",
817 });
818 }
819 }
820 Ok(())
821 }
822}
823
824/// The `BOATRAMP_*` variables that populate the `[compute]` section. Kept as one
825/// list so [`ServerConfig::apply_env_overrides`] can decide whether to materialise
826/// an absent section without repeating the names.
827const COMPUTE_ENV_VARS: &[&str] = &[
828 "BOATRAMP_COMPUTE_BRIDGE",
829 "BOATRAMP_COMPUTE_SUBNET",
830 "BOATRAMP_COMPUTE_VCPUS",
831 "BOATRAMP_COMPUTE_MEM_MIB",
832 "BOATRAMP_COMPUTE_REGION",
833 "BOATRAMP_COMPUTE_SQL_SHIM_URL",
834 "BOATRAMP_COMPUTE_MANAGED_DB_PRIVILEGE",
835 "BOATRAMP_COMPUTE_DOCKER_ENDPOINT",
836 "BOATRAMP_COMPUTE_DOCKER_VOLUME_MODE",
837 "BOATRAMP_COMPUTE_KERNEL_SIGNING_PUBKEYS",
838 "BOATRAMP_COMPUTE_KERNEL_ALLOWED_HASHES",
839 "BOATRAMP_COMPUTE_INTERNAL_DNS",
840 "BOATRAMP_COMPUTE_DNS_UPSTREAM",
841 "BOATRAMP_COMPUTE_DNS_DOMAIN",
842];
843
844/// The `BOATRAMP_*` variables that populate the `[security]` section.
845const SECURITY_ENV_VARS: &[&str] = &[
846 "BOATRAMP_SECURITY_PROFILE",
847 "BOATRAMP_SECURITY_ALLOW_UNAUTHENTICATED_PUBLIC_BIND",
848 "BOATRAMP_SECURITY_MAX_UPLOAD_BYTES",
849 "BOATRAMP_SECURITY_ALLOW_SITE_UNIX_UPSTREAMS",
850 "BOATRAMP_SECURITY_ALLOW_SITE_PRIVATE_UPSTREAMS",
851 "BOATRAMP_SECURITY_ALLOW_GUEST_PRIVATE_EGRESS",
852 "BOATRAMP_SECURITY_ALLOW_GUEST_SELF_EGRESS",
853 "BOATRAMP_SECURITY_ALLOW_GUEST_EGRESS_EXTRA_CA",
854 "BOATRAMP_SECURITY_MAX_HANDLER_BLOB_BYTES",
855 "BOATRAMP_SECURITY_MAX_COMPONENT_BYTES",
856 "BOATRAMP_SECURITY_OIDC_REQUIRE_AUDIENCE",
857 "BOATRAMP_SECURITY_DOMAIN_VERIFY_ALLOW_PRIVATE",
858 "BOATRAMP_SECURITY_DOMAIN_VERIFY_SELF_SERVE",
859 "BOATRAMP_SECURITY_ALLOW_SHARED_KERNEL_COMPUTE",
860 "BOATRAMP_SECURITY_ALLOW_COMPUTE_EXEC",
861 "BOATRAMP_SECURITY_RATELIMIT_FAIL_OPEN",
862 "BOATRAMP_SECURITY_ALLOW_IMPLICIT_ROUTING",
863 "BOATRAMP_SECURITY_REQUIRE_POP",
864 "BOATRAMP_SECURITY_REQUIRE_DOMAIN_VERIFICATION",
865 "BOATRAMP_SECURITY_ALLOW_ENV_SECRET_REFS",
866 "BOATRAMP_SECURITY_REQUIRE_TENANCY_DECLARATION",
867 "BOATRAMP_SECURITY_ALLOW_CROSS_TENANT_DB",
868 "BOATRAMP_SECURITY_ALLOW_GUEST_MINT_CAPABILITY",
869 "BOATRAMP_SECURITY_MAX_GUEST_CAPABILITY_TTL_SECS",
870 "BOATRAMP_SECURITY_ALLOW_GUEST_EMAIL",
871 "BOATRAMP_SECURITY_ALLOW_GUEST_ADMIN_DOMAINS",
872 "BOATRAMP_SECURITY_ALLOW_GUEST_ADMIN_EMAIL",
873 "BOATRAMP_SECURITY_ALLOW_GUEST_ADMIN_SITE",
874 "BOATRAMP_SECURITY_ALLOW_GUEST_ADMIN_SECRETS",
875];
876
877/// The `BOATRAMP_*` variables that populate `handlers.bindings.sql`.
878const SQL_ENV_VARS: &[&str] = &[
879 "BOATRAMP_HANDLERS_SQL_DIR",
880 "BOATRAMP_HANDLERS_SQL_URL",
881 "BOATRAMP_HANDLERS_SQL_ADMIN_URL",
882 "BOATRAMP_HANDLERS_SQL_REPLICA_URL",
883 "BOATRAMP_HANDLERS_SQL_TOKEN_ENV",
884 "BOATRAMP_HANDLERS_SQL_ADMIN_TOKEN_ENV",
885 "BOATRAMP_HANDLERS_SQL_PREVIEW_MODE",
886 "BOATRAMP_HANDLERS_SQL_PREVIEW_INIT",
887 "BOATRAMP_HANDLERS_SQL_DEPROVISION_GRACE_SECS",
888];
889
890/// The fixed prefix of a keyed `handlers.bindings.sql.databases` variable —
891/// `BOATRAMP_HANDLERS_SQL_DB_<NAME>_<FIELD>`. Member names aren't known ahead of
892/// time (there is no config file to enumerate them), so they are discovered by
893/// scanning the environment for this prefix.
894const SQL_DB_ENV_PREFIX: &str = "BOATRAMP_HANDLERS_SQL_DB_";
895
896/// The recognised `_<FIELD>` suffixes of a `databases` variable, ordered so a
897/// name-isolating strip matches the **longest** suffix first (`_READ_URL_ENV`
898/// before `_URL_ENV`). Each mirrors a field of [`ExternalDatabaseConfig`].
899const SQL_DB_FIELD_SUFFIXES: &[&str] = &[
900 "_STARTUP_GRACE_SECS",
901 "_CONNECT_TIMEOUT_SECS",
902 // `_SESSION_GUC` / `_TENANT_GUC` / `_TENANT_ALL_MARKER` before `_TENANT`/`_TENANT_SCOPE`
903 // (longest-first name isolation).
904 "_SESSION_GUC",
905 "_TENANT_ALL_MARKER",
906 "_TENANT_GUC",
907 "_VOLUME_SIZE_MIB",
908 "_READ_URL_ENV",
909 "_PASSWORD_ENV",
910 "_ALLOW_PREVIEW",
911 "_URL_ENV",
912 "_DATABASE",
913 "_READ_ONLY",
914 "_POOL_MAX",
915 "_RLS_SESSION",
916 "_TENANT_SCOPE",
917 "_COMPUTE",
918 "_TENANT",
919 "_IMAGE",
920 "_KIND",
921 "_USER",
922];
923
924/// The `BOATRAMP_*` variables that populate the `[secrets]` section (excluding the
925/// nested `vault` sub-config, gated separately by [`SECRETS_VAULT_ENV_VARS`]).
926const SECRETS_ENV_VARS: &[&str] = &[
927 "BOATRAMP_SECRETS_ENVELOPE",
928 "BOATRAMP_SECRETS_KEK_FILE",
929 "BOATRAMP_SECRETS_VAULT_ADDR",
930 "BOATRAMP_SECRETS_VAULT_KEY",
931 "BOATRAMP_SECRETS_VAULT_TOKEN_ENV",
932];
933
934/// The `BOATRAMP_*` variables that populate the nested `[secrets.vault]` sub-config.
935const SECRETS_VAULT_ENV_VARS: &[&str] = &[
936 "BOATRAMP_SECRETS_VAULT_ADDR",
937 "BOATRAMP_SECRETS_VAULT_KEY",
938 "BOATRAMP_SECRETS_VAULT_TOKEN_ENV",
939];
940
941/// The `BOATRAMP_*` variables that populate the `[cluster]` section fields (the
942/// section's own config, distinct from the founding/joining *action* flags
943/// `BOATRAMP_CLUSTER_INIT` / `_JOIN` / `_ADVERTISE_ADDR`, which are `serve` clap
944/// args and are deliberately not listed here).
945const CLUSTER_ENV_VARS: &[&str] = &[
946 "BOATRAMP_CLUSTER_LISTEN",
947 "BOATRAMP_CLUSTER_ROOT_PUBKEYS",
948 "BOATRAMP_CLUSTER_SEEDS",
949 "BOATRAMP_CLUSTER_JOIN_TOKEN",
950 "BOATRAMP_CLUSTER_STORE_DIR",
951 "BOATRAMP_CLUSTER_MESH_KEY_FILE",
952 "BOATRAMP_CLUSTER_MESH_KEY_ROTATION",
953 "BOATRAMP_CLUSTER_MESH_JOIN_TOKEN_TTL",
954 "BOATRAMP_CLUSTER_MESH_GATE_CLIENT_WRITES",
955];
956
957/// The `BOATRAMP_*` variables that populate the nested `[cluster.mesh]` sub-config.
958const CLUSTER_MESH_ENV_VARS: &[&str] = &[
959 "BOATRAMP_CLUSTER_MESH_KEY_FILE",
960 "BOATRAMP_CLUSTER_MESH_KEY_ROTATION",
961 "BOATRAMP_CLUSTER_MESH_JOIN_TOKEN_TTL",
962 "BOATRAMP_CLUSTER_MESH_GATE_CLIENT_WRITES",
963];
964
965/// Where env-override values come from: the real process environment, or an
966/// explicit map for a deterministic unit test. Keeping the lookup behind this enum
967/// lets [`ServerConfig::apply_env_overrides`] be tested without touching (racy,
968/// process-global) `std::env`.
969enum EnvSource {
970 /// The live process environment (`std::env::var`).
971 Process,
972 /// A fixed name→value map (tests only).
973 #[cfg(test)]
974 Map(BTreeMap<String, String>),
975}
976
977impl EnvSource {
978 /// The value of `var`, if set to a non-empty string. An empty value is treated
979 /// as unset so an accidental `VAR=` doesn't clobber a file value with `""`.
980 fn get(&self, var: &str) -> Option<String> {
981 let raw = match self {
982 Self::Process => std::env::var(var).ok(),
983 #[cfg(test)]
984 Self::Map(m) => m.get(var).cloned(),
985 };
986 raw.filter(|v| !v.is_empty())
987 }
988
989 /// Whether any of `vars` is set (to a non-empty value).
990 fn any(&self, vars: &[&str]) -> bool {
991 vars.iter().any(|v| self.get(v).is_some())
992 }
993
994 /// Whether any variable whose name starts with `prefix` is set (to a
995 /// non-empty value). Used to decide whether to materialise a keyed map (the
996 /// `databases` env scheme) whose member names aren't known ahead of time.
997 fn any_with_prefix(&self, prefix: &str) -> bool {
998 self.names()
999 .any(|name| name.starts_with(prefix) && self.get(&name).is_some())
1000 }
1001
1002 /// The full set of variable names visible to this source. Used to discover the
1003 /// keyed-map member names from the environment (there is no config file to
1004 /// enumerate them). Returned owned so it doesn't borrow the process env.
1005 fn names(&self) -> Box<dyn Iterator<Item = String> + '_> {
1006 match self {
1007 Self::Process => Box::new(std::env::vars().map(|(k, _)| k)),
1008 #[cfg(test)]
1009 Self::Map(m) => Box::new(m.keys().cloned()),
1010 }
1011 }
1012
1013 /// Parse `var` as one of a fixed set of string-mapped variants, mapping an
1014 /// unknown value to a clear [`ConfigError::Env`] that names the variable and
1015 /// the accepted values. Used for the config enums that have no `FromStr`
1016 /// (their only string mapping is a serde `rename_all`). `Ok(None)` when unset.
1017 fn parse_enum<T: Copy>(
1018 &self,
1019 var: &str,
1020 variants: &[(&str, T)],
1021 ) -> Result<Option<T>, ConfigError> {
1022 match self.get(var) {
1023 Some(raw) => {
1024 let lower = raw.trim().to_ascii_lowercase();
1025 variants
1026 .iter()
1027 .find(|(name, _)| *name == lower)
1028 .map(|(_, v)| Some(*v))
1029 .ok_or_else(|| ConfigError::Env {
1030 var: var.to_string(),
1031 reason: format!(
1032 "expected one of {}, got {raw:?}",
1033 variants
1034 .iter()
1035 .map(|(n, _)| *n)
1036 .collect::<Vec<_>>()
1037 .join("/")
1038 ),
1039 })
1040 }
1041 None => Ok(None),
1042 }
1043 }
1044
1045 /// The distinct `<NAME>` tokens of every `BOATRAMP_HANDLERS_SQL_DB_<NAME>_<FIELD>`
1046 /// variable that is set. The name is everything between the fixed prefix and the
1047 /// *last* `_<FIELD>` segment, so a database name may itself contain underscores
1048 /// (the field suffix is one of a known set). Returned sorted + de-duplicated so
1049 /// the map is built deterministically.
1050 fn sql_database_names(&self) -> Vec<String> {
1051 let mut names: Vec<String> = self
1052 .names()
1053 .filter(|n| n.starts_with(SQL_DB_ENV_PREFIX) && self.get(n).is_some())
1054 .filter_map(|n| {
1055 let rest = n.strip_prefix(SQL_DB_ENV_PREFIX)?;
1056 // Strip the recognised field suffix to isolate `<NAME>`. The suffixes
1057 // are matched longest-first so `READ_URL_ENV` wins over `URL_ENV`.
1058 SQL_DB_FIELD_SUFFIXES
1059 .iter()
1060 .find_map(|suffix| rest.strip_suffix(suffix))
1061 .filter(|name| !name.is_empty())
1062 .map(str::to_string)
1063 })
1064 .collect();
1065 names.sort();
1066 names.dedup();
1067 names
1068 }
1069
1070 /// Parse `var` as a **comma-separated** list of non-empty trimmed items, e.g.
1071 /// the kernel trust anchors. A single value (no comma) yields a one-element
1072 /// list. Empty items are dropped so a trailing comma or doubled separator is
1073 /// tolerated. `Ok(None)` when unset; `Some(Vec::new())` never happens (an
1074 /// all-empty value is treated as unset by [`Self::get`]).
1075 fn parse_list(&self, var: &str) -> Option<Vec<String>> {
1076 self.get(var).map(|raw| {
1077 raw.split(',')
1078 .map(str::trim)
1079 .filter(|s| !s.is_empty())
1080 .map(str::to_string)
1081 .collect()
1082 })
1083 }
1084
1085 /// Parse `var` as any [`FromStr`](std::str::FromStr) type (numbers), mapping a
1086 /// parse failure to a clear [`ConfigError::Env`]. `Ok(None)` when the variable
1087 /// is unset.
1088 fn parse<T>(&self, var: &str) -> Result<Option<T>, ConfigError>
1089 where
1090 T: std::str::FromStr,
1091 T::Err: std::fmt::Display,
1092 {
1093 match self.get(var) {
1094 Some(raw) => raw.parse::<T>().map(Some).map_err(|e| ConfigError::Env {
1095 var: var.to_string(),
1096 reason: e.to_string(),
1097 }),
1098 None => Ok(None),
1099 }
1100 }
1101
1102 /// Parse `var` as a boolean, accepting the common truthy/falsey spellings
1103 /// (`true`/`false`, `1`/`0`, `yes`/`no`, `on`/`off`) case-insensitively so an
1104 /// operator isn't surprised by a strict `true`-only parse. `Ok(None)` when
1105 /// unset.
1106 fn parse_bool(&self, var: &str) -> Result<Option<bool>, ConfigError> {
1107 match self.get(var) {
1108 Some(raw) => match raw.trim().to_ascii_lowercase().as_str() {
1109 "true" | "1" | "yes" | "on" => Ok(Some(true)),
1110 "false" | "0" | "no" | "off" => Ok(Some(false)),
1111 other => Err(ConfigError::Env {
1112 var: var.to_string(),
1113 reason: format!("expected a boolean (true/false), got {other:?}"),
1114 }),
1115 },
1116 None => Ok(None),
1117 }
1118 }
1119}
1120
1121/// How a **managed database** (PLAN-managed-compute-sql) runs its stock image on a
1122/// shared-kernel backend, whose entrypoint would otherwise fail under the dropped-`ALL`
1123/// hardening. `rootless` (the default) needs no capabilities and works under any
1124/// posture; `caps` is the fallback for an image that won't run rootless.
1125#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Deserialize)]
1126#[serde(rename_all = "lowercase")]
1127pub enum ManagedDbPrivilege {
1128 /// Run the DB as its image's user (`999:999` for the official postgres/mysql
1129 /// images) against a pre-owned volume — no added capabilities, any posture.
1130 #[default]
1131 Rootless,
1132 /// Add the minimal capability set the entrypoint needs (`CHOWN`, `DAC_OVERRIDE`,
1133 /// `FOWNER`, `SETUID`, `SETGID`). Honored only under the single-tenant posture.
1134 Caps,
1135}
1136
1137/// `compute` section — opt-in compute backends. Present
1138/// ⇒ `serve` registers the backends this node can offer and advertises them to
1139/// the scheduler; backends are capability-detected (container on Linux, remote
1140/// docker when a daemon is reachable, VMM when `/dev/kvm` exists).
1141#[derive(Debug, Clone, Deserialize)]
1142#[serde(default, deny_unknown_fields)]
1143pub struct ComputeConfig {
1144 /// Bridge the container veths / VM taps attach to (default `br-boatramp`).
1145 pub bridge: String,
1146 /// Guest IP subnet (default `10.0.0.0/24`).
1147 pub subnet: String,
1148 /// vCPUs this node advertises as schedulable (`0` ⇒ detect from the host).
1149 pub vcpus: u32,
1150 /// Memory (MiB) this node advertises as schedulable (`0` ⇒ a 1 GiB default).
1151 pub mem_mib: u32,
1152 /// **Static** kernel-signing public keys (`"<alg>:<hex>"`) — the trust anchor
1153 /// for the posture-scaled kernel bar. Under `multi-tenant`, a dynamically-
1154 /// selected default kernel must carry a signature verifying against one of
1155 /// these. Host-access-gated (never in the KV tier); changing it needs a
1156 /// restart. Empty ⇒ no kernel may be signed-verified (strict posture then
1157 /// accepts none).
1158 pub kernel_signing_pubkeys: Vec<String>,
1159 /// **Static** allow-list of kernel content hashes (sha256 hex) a dynamic
1160 /// default may select under `multi-tenant`. Host-access-gated. Empty ⇒ no
1161 /// kernel is allow-listed.
1162 pub kernel_allowed_hashes: Vec<String>,
1163 /// This node's **region** tag (FA-8). Advertised on the compute `Node` so a
1164 /// gateway routing to a `compute:`-backed workload with `--lb nearest` sends
1165 /// each request to the nearest replica by its node's region — no manual
1166 /// `--region` map. `None` ⇒ region-agnostic.
1167 pub region: Option<String>,
1168 /// How the remote-Docker backend reports a workload's reachable endpoint.
1169 /// `published` (default) publishes the container port on `127.0.0.1:<ephemeral>`
1170 /// so a host-native `serve` reaches it on any daemon (incl. Docker Desktop /
1171 /// macOS, where the bridge IP is not host-routable); `bridge` routes to the
1172 /// container bridge IP directly (only when `serve` shares the daemon's network).
1173 pub docker_endpoint: boatramp_docker::DockerEndpoint,
1174 /// How the remote-Docker backend backs a workload's persistent volumes.
1175 /// `named` (default) attaches a daemon-managed `docker volume` by name (portable
1176 /// across daemons + Docker Desktop / macOS); `bind` bind-mounts a host directory
1177 /// under `<data_dir>/compute/volumes/<name>` (local daemon only).
1178 pub docker_volume_mode: boatramp_docker::DockerVolumeMode,
1179 /// Guest-reachable base URL of the compute **sql-shim** (PLAN-compute-bindings) —
1180 /// e.g. `http://10.0.0.1:8081` (the compute bridge gateway) or the docker bridge
1181 /// gateway. Set ⇒ a workload's `--bind sql` reaches the managed database through a
1182 /// listener bound on `0.0.0.0:<port>`. `None` (default) ⇒ compute sql bindings off.
1183 #[serde(default, skip_serializing_if = "Option::is_none")]
1184 #[cfg_attr(not(feature = "handlers"), allow(dead_code))]
1185 pub sql_shim_url: Option<String>,
1186 /// Privilege strategy for a managed database's stock image on a shared-kernel
1187 /// backend (see [`ManagedDbPrivilege`]). `rootless` by default.
1188 #[serde(default)]
1189 #[cfg_attr(not(feature = "handlers"), allow(dead_code))]
1190 pub managed_db_privilege: ManagedDbPrivilege,
1191 /// Per-project **internal DNS** (service discovery): run a lightweight resolver
1192 /// on the bridge gateway so a guest can reach peers by name (`<workload>` /
1193 /// `<workload>.<project>.<dns_domain>`) instead of a numeric IP, scoped to its
1194 /// own project. Default **on** — it activates only when the container backend +
1195 /// bridge come up, so a node without them is unaffected. `false` disables it and
1196 /// leaves each image's own `/etc/resolv.conf`.
1197 #[serde(default = "default_internal_dns")]
1198 pub internal_dns: bool,
1199 /// The upstream resolver the internal DNS forwards non-internal queries to
1200 /// (external names + non-`A`/`AAAA` types), so the resolver is the guest's single
1201 /// nameserver. `"host:port"`; default `1.1.1.1:53`.
1202 #[serde(default = "default_dns_upstream")]
1203 pub dns_upstream: String,
1204 /// The internal DNS suffix names live under (`<workload>.<project>.<dns_domain>`);
1205 /// also the `search` domain written into each container's resolv.conf. Default
1206 /// `boatramp.internal`.
1207 #[serde(default = "default_dns_domain")]
1208 pub dns_domain: String,
1209}
1210
1211/// Default for [`ComputeConfig::internal_dns`] — on (activates only with the
1212/// container backend + bridge).
1213fn default_internal_dns() -> bool {
1214 true
1215}
1216
1217/// Default upstream resolver for [`ComputeConfig::dns_upstream`].
1218fn default_dns_upstream() -> String {
1219 "1.1.1.1:53".to_string()
1220}
1221
1222/// Default internal DNS suffix for [`ComputeConfig::dns_domain`].
1223fn default_dns_domain() -> String {
1224 boatramp_container::dns::DEFAULT_INTERNAL_DOMAIN.to_string()
1225}
1226
1227/// The built-in **boatramp kernel-signing public key** (`es256:…`), whose private
1228/// half lives as the `KERNEL_SIGNING_KEY` Actions secret in
1229/// [`BoatRamp/boatramp-vmlinux`](https://github.com/BoatRamp/boatramp-vmlinux).
1230/// Shipped as a default trust anchor so the first-party signed `boatramp-vmlinux`
1231/// verifies out of the box under the strict posture. An operator can replace
1232/// `kernel_signing_pubkeys` to trust only their own keys.
1233pub const BOATRAMP_KERNEL_SIGNING_PUBKEY: &str =
1234 "es256:02c4e4af2e9cba6ba6745c513f193622e6674a8b2d0187ebea5612f5b46a7eade4";
1235
1236/// The first-party signed-kernel content hashes trusted under the **strict**
1237/// posture, for this build's **guest arch**. The guest arch mirrors the host: an
1238/// x86_64 host boots x86_64 KVM guests (the embedded VMM); an Apple-silicon host
1239/// boots aarch64 guests (the Virtualization.framework `vmm-vz` backend). An x86_64
1240/// kernel can't boot an aarch64 VM (and vice versa), so each arch trusts only its
1241/// own signed `boatramp-vmlinux-<arch>` releases. Bump on each new signed release.
1242///
1243/// The **relaxed** (single-tenant) posture ignores this list — it verifies only the
1244/// content-hash pin — so an operator-supplied kernel boots there regardless of arch.
1245fn default_allowed_kernel_hashes() -> Vec<String> {
1246 #[cfg(target_arch = "x86_64")]
1247 {
1248 vec![
1249 // v0.2.0 minimal Firecracker 6.1-config kernel: boots under the
1250 // firecracker-*binary* backend (ACPI device discovery) but NOT the
1251 // in-process embedded VMM. Kept trusted so operators on the currently
1252 // published release don't fail strict verification.
1253 "cf1e590a9e642be3667131ca35fbf390378a457d8908169d2a169608e299d974".to_string(),
1254 // Same kernel + CONFIG_VIRTIO_MMIO_CMDLINE_DEVICES=y (flake `#vmlinux`),
1255 // so the embedded VMM binds its virtio-block root over the cmdline
1256 // transport. Reproducible build output (deterministic nix build,
1257 // verified on KVM); the next signed boatramp-vmlinux release — which
1258 // reuses this flake — publishes + signs it, gated by
1259 // `vmlinux-release-boot.yml`.
1260 "d0dc2098ab2a2a3c1bc72ab61dc85d9e464d798d7e55b6b80525db5ca2f00c5a".to_string(),
1261 ]
1262 }
1263 #[cfg(target_arch = "aarch64")]
1264 {
1265 vec![
1266 // `boatramp-vmlinux-aarch64` v0.2.3 (the Virtualization.framework guest
1267 // kernel, flake `#vmlinux` on aarch64-linux — a raw arm64 `Image`). This
1268 // release enables the generic PCIe host + virtio-pci so the guest actually
1269 // discovers VZ's virtio disk/net/console (the earlier v0.2.2 `be95fb0d…`
1270 // built with `CONFIG_PCI` off never booted under VZ and is dropped). This
1271 // is the hash of the **published, ES256-signed** release asset (signed by
1272 // BOATRAMP_KERNEL_SIGNING_PUBKEY), so a selected `compute.default_kernel`
1273 // clears the strict bar out of the box; the boot + scale-to-zero round-trip
1274 // was validated against this exact published kernel. NOTE: unlike x86_64,
1275 // the aarch64 build is not currently bit-reproducible across build hosts
1276 // (same config + size, different build metadata), so pin/verify against the
1277 // published `.sha256`/`.sig`, not a local rebuild. Bump on each new release.
1278 "d785a48d754e65a4630443301f1fb84cb69cf882336d3cf37055e437b3d8e21f".to_string(),
1279 ]
1280 }
1281 #[cfg(not(any(target_arch = "x86_64", target_arch = "aarch64")))]
1282 {
1283 Vec::new()
1284 }
1285}
1286
1287impl Default for ComputeConfig {
1288 fn default() -> Self {
1289 Self {
1290 bridge: "br-boatramp".to_string(),
1291 subnet: "10.0.0.0/24".to_string(),
1292 vcpus: 0,
1293 mem_mib: 0,
1294 kernel_signing_pubkeys: vec![BOATRAMP_KERNEL_SIGNING_PUBKEY.to_string()],
1295 kernel_allowed_hashes: default_allowed_kernel_hashes(),
1296 region: None,
1297 docker_endpoint: boatramp_docker::DockerEndpoint::default(),
1298 docker_volume_mode: boatramp_docker::DockerVolumeMode::default(),
1299 sql_shim_url: None,
1300 managed_db_privilege: ManagedDbPrivilege::default(),
1301 internal_dns: default_internal_dns(),
1302 dns_upstream: default_dns_upstream(),
1303 dns_domain: default_dns_domain(),
1304 }
1305 }
1306}
1307
1308/// `cluster` section — self-hosted **cluster mode**. Parsed in
1309/// every build so config files stay portable; only *consumed* when the `cluster`
1310/// feature is compiled in (`boatramp serve --mode cluster`).
1311#[cfg_attr(not(feature = "cluster"), allow(dead_code))]
1312#[derive(Debug, Clone, Deserialize)]
1313pub struct ClusterConfig {
1314 /// Address to bind this node's Raft **peer mesh** on (the `/raft/*` +
1315 /// `/stream/*` endpoints) — distinct from the public `serve.addr`.
1316 pub listen: SocketAddr,
1317 /// The cluster **root anchor set** — the `es256:`/`ed25519:`-tagged public
1318 /// keys that define this cluster's identity (a cluster *is* its root key).
1319 /// Every join/trust decision verifies against this set. Empty ⇒ falls back to
1320 /// `serve.auth_root_public_key` (the single-anchor default). A *set* enables
1321 /// make-before-break root rotation.
1322 #[serde(default)]
1323 pub root_pubkeys: Vec<String>,
1324 /// **Seeds** — control-plane addresses of existing cluster members
1325 /// (`host:port`), any of which can admit this node. Present ⇒ this node
1326 /// **joins** (redeems its `join_token`); absent + no durable state + explicit
1327 /// `--cluster-init` ⇒ it **founds**. There is no peer map: members are learned
1328 /// from the root-signed join response.
1329 #[serde(default)]
1330 pub seeds: Vec<String>,
1331 /// The single-use bearer **join token** used when `seeds` are set. Keeps the
1332 /// secret out of the file via a prefix: `env:VAR`, `path:/file`, or an inline
1333 /// literal. Usually supplied via `serve --cluster-join <ticket>` instead.
1334 #[serde(default)]
1335 pub join_token: Option<String>,
1336 /// Directory for this node's **durable** Raft log/state store (node-local;
1337 /// distinct from the replicated control plane). Default
1338 /// `<data-dir>/raft`.
1339 #[serde(default)]
1340 pub store_dir: Option<PathBuf>,
1341 /// Mesh identity + TLS settings. Absent ⇒ defaults (identity key
1342 /// auto-generated under `<data-dir>/mesh/identity.key`).
1343 #[serde(default)]
1344 pub mesh: Option<MeshConfig>,
1345}
1346
1347/// `[cluster.mesh]` — mesh identity + TLS knobs.
1348#[cfg_attr(not(feature = "cluster"), allow(dead_code))]
1349#[derive(Debug, Clone, Default, Deserialize)]
1350#[serde(default, deny_unknown_fields)]
1351pub struct MeshConfig {
1352 /// Path to this node's Ed25519 identity key (PKCS#8 DER, `0600`,
1353 /// auto-generated). Default `<data-dir>/mesh/identity.key`.
1354 pub key_file: Option<PathBuf>,
1355 /// Automatic key-rotation cadence (e.g. `"30d"`); `None` = manual only.
1356 /// Consumed by the rotation loop.
1357 pub key_rotation: Option<String>,
1358 /// TTL for a single-use join token (e.g. `"1h"`).
1359 pub join_token_ttl: Option<String>,
1360 /// Gate mesh `client-write`s behind a control-plane **cluster-write
1361 /// capability**, so a trusted peer can't inject arbitrary
1362 /// control-plane writes on mesh trust alone. Requires the token root
1363 /// **private** key on every node (each mints + presents its own capability);
1364 /// default `false`.
1365 pub gate_client_writes: Option<bool>,
1366}
1367
1368/// `handlers` section — server-side handler runtime config (read by `serve`).
1369/// Parsed in every build (so config files stay portable), but only *consumed*
1370/// when the `handlers` feature is compiled in.
1371#[cfg_attr(not(feature = "handlers"), allow(dead_code))]
1372#[derive(Debug, Clone, Default, Deserialize)]
1373#[serde(default)]
1374pub struct HandlersConfig {
1375 /// `handlers.bindings` — which backend serves each handler binding.
1376 pub bindings: BindingsConfig,
1377 /// Use the wasmtime **pooling** instance allocator: faster
1378 /// instantiation at the cost of a large up-front virtual-memory reservation.
1379 /// Off by default — opt in and benchmark for your workload.
1380 pub pooling: bool,
1381 /// Engine-wide **safety max** on a *connection-bearing* invocation (a site
1382 /// handler or a synchronous function/webhook invoke), milliseconds. A route
1383 /// or function may declare a *lower* timeout, never a higher one. Kept tight
1384 /// on purpose: a client, proxy, and the shared request pool are all blocked
1385 /// while a sync handler runs. Absent ⇒ 10s (the historical default). This is
1386 /// a node safety ceiling, not a per-invocation budget, and is distinct from
1387 /// a per-site `max_timeout_ms`.
1388 pub sync_max_timeout_ms: Option<u64>,
1389 /// Engine-wide safety max on a *durable async* invocation — the drain that
1390 /// runs `?mode=async` calls, workflow steps, cron/queue/blob triggers, and
1391 /// `wasi:messaging` consumers, milliseconds. No client is connected and the
1392 /// work is retried + dead-lettered, so this can be far larger than the sync
1393 /// ceiling: it is what lets a legitimately long background job (e.g. an LLM
1394 /// generation) declare and actually get minutes of runtime. Absent ⇒ 15
1395 /// minutes. Runs on its own concurrency budget (`async_max_concurrency`), so
1396 /// a long job never starves live traffic.
1397 pub async_max_timeout_ms: Option<u64>,
1398 /// Max concurrent in-flight *async-lane* invocations, kept separate from the
1399 /// (larger) request pool so a burst of long background jobs can't exhaust the
1400 /// slots live site traffic needs. Absent ⇒ 8.
1401 pub async_max_concurrency: Option<usize>,
1402 /// Optional CPU **fuel** ceiling for an async-lane invocation. A large async
1403 /// timeout bounds only wall-clock; without a fuel bound a CPU-bound guest can
1404 /// spin for the whole window. Absent ⇒ unmetered (same as the sync default).
1405 pub async_max_fuel: Option<u64>,
1406 /// **Relaxed messaging-publish durability** — the max number of published
1407 /// messages that may be acknowledged from the in-memory buffer BEFORE a durable
1408 /// checkpoint is forced. **Absent / `0` ⇒ strong durability (the default):**
1409 /// every `publish()` returns only after the message is crash-durable — a
1410 /// *stronger* guarantee than NATS JetStream's default sync publish. Set `N > 0`
1411 /// to opt a node into fast-ack (publish returns on the buffer insert, ~10µs
1412 /// instead of ~one flush interval), at the cost of a **bounded loss window: up
1413 /// to `N` acknowledged-but-unflushed messages are lost on a process crash / OOM
1414 /// / SIGKILL / power loss** before the next flush. Affects ONLY the messaging
1415 /// bus publish path — control-plane, auth, and consumer ack/redelivery
1416 /// durability are unaffected. Single-node only (cluster durability is
1417 /// replication). A node with `N > 0` logs a warning at startup.
1418 pub messaging_max_unflushed_msgs: Option<usize>,
1419 /// **Event-driven delivery — safety-net reconcile cadence** (ms). The coarse timer the delivery
1420 /// drainer falls back to when no fast-path wake fires: it drains the durable ready-set and fires
1421 /// lease-expiry redelivery via the per-message due-heap, so a dropped wake or a time-based
1422 /// visibility never stalls delivery beyond this interval. It never scans idle topics (an idle
1423 /// fleet costs ~0). Absent ⇒ ~2 s. Lower for tighter redelivery latency at more wakeups; raise to
1424 /// quiet a large idle fleet further.
1425 pub messaging_safetynet_interval_ms: Option<u64>,
1426 /// **Event-driven delivery — ready-set rebuild cadence** (ms). The long-cadence self-heal that
1427 /// re-derives the ready-set from the authoritative message index — recovering a marker lost to a
1428 /// crash between the index write and the ready write, pruning a stale marker, and self-populating
1429 /// a fresh/upgraded node's ready-set. This is the one full-ish scan, so it runs rarely. Absent ⇒
1430 /// ~30 s. The correctness backstop for the ready-set (a lost marker costs at most one rebuild
1431 /// interval of latency, never a lost message).
1432 pub messaging_readyset_rebuild_interval_ms: Option<u64>,
1433 /// Max wall-clock for a *streaming-lane* response (a `#[handler(stream)]`
1434 /// route — SSE, chunked, agent token streaming), milliseconds. A client is
1435 /// connected but the body is written incrementally over seconds-to-minutes,
1436 /// so this is far larger than the sync ceiling. Runs on its own concurrency
1437 /// budget (`streaming_max_concurrency`), isolated from both the fast request
1438 /// pool and the async drain. Absent ⇒ 15 minutes.
1439 pub streaming_max_timeout_ms: Option<u64>,
1440 /// Max concurrent in-flight *streaming-lane* responses, kept separate from the
1441 /// request pool and the async drain so a burst of long-lived streams starves
1442 /// neither. Absent ⇒ 64.
1443 pub streaming_max_concurrency: Option<usize>,
1444 /// Optional CPU **fuel** ceiling for a streaming-lane response. Absent ⇒
1445 /// unmetered (a stream is I/O-bound on the client, not CPU-bound).
1446 pub streaming_max_fuel: Option<u64>,
1447 /// Optional ceiling on a guest's **outbound** `wasi:http` call — the connect
1448 /// and time-to-first-byte wait — milliseconds, independent of the invocation
1449 /// timeout, so a hung upstream is bounded on its own terms. The streaming
1450 /// (between-bytes) timeout is left at wasmtime's default so a slow token
1451 /// stream is not cut mid-flight. Absent ⇒ wasmtime's default.
1452 pub outbound_timeout_ms: Option<u64>,
1453}
1454
1455/// `handlers.bindings` — per-binding backend configuration. kv/blob reuse the
1456/// server's own KV/Storage backends (per-site prefixed); `sql` is the single
1457/// libsql backend, whose single-node-vs-cluster split is the only choice.
1458#[cfg_attr(not(feature = "handlers"), allow(dead_code))]
1459#[derive(Debug, Clone, Default, Deserialize)]
1460#[serde(default)]
1461pub struct BindingsConfig {
1462 /// `handlers.bindings.sql` — libsql settings. Absent ⇒ single-node,
1463 /// per-site embedded files under `<data-dir>/handlers-sql`.
1464 pub sql: Option<SqlBindingConfig>,
1465}
1466
1467/// libsql settings for the handler `sql` binding — the single SQL backend. Each
1468/// site gets a real database boundary (an embedded file per site, or a sqld
1469/// namespace per site), never schema separation (which arbitrary guest SQL
1470/// escapes). Setting `url` switches from single-node to a shared sqld cluster;
1471/// everything else stays identical.
1472#[cfg_attr(not(feature = "handlers"), allow(dead_code))]
1473#[derive(Debug, Clone, Default, Deserialize)]
1474#[serde(default)]
1475pub struct SqlBindingConfig {
1476 /// Single-node: root directory for the per-site embedded database files
1477 /// (default `<data-dir>/handlers-sql`). Ignored when `url` is set.
1478 pub dir: Option<PathBuf>,
1479 /// Cluster: base sqld data URL (e.g. `http://sqld:8080`). When set, each
1480 /// site is a sqld namespace addressed as a subdomain of this URL; `admin_url`
1481 /// is then required.
1482 pub url: Option<String>,
1483 /// Cluster: sqld admin API base URL (e.g. `http://sqld:9090`) for creating
1484 /// per-site namespaces. Required when `url` is set.
1485 pub admin_url: Option<String>,
1486 /// Cluster: optional sqld **read-replica** data URL. When set, handlers'
1487 /// read-only `sql` transactions (`open-read-only`) route to this endpoint
1488 /// while writes stay on `url` (reads → replicas, writes → primary).
1489 /// Reads may lag (eventually consistent). Ignored in
1490 /// single-node mode (no `url`).
1491 pub replica_url: Option<String>,
1492 /// Name of the env var holding the sqld data auth token (optional; never
1493 /// the token itself in-file).
1494 pub token_env: Option<String>,
1495 /// Name of the env var holding the sqld admin API auth key (optional).
1496 pub admin_token_env: Option<String>,
1497 /// How preview deployments get their SQL database: `empty` (default — a
1498 /// fresh isolated db), `branch` (a consistent copy of the site's live db;
1499 /// single-node only), or `shared` (the site's live db). See
1500 /// `boatramp_core::sql::PreviewSqlMode`.
1501 pub preview_mode: Option<String>,
1502 /// Path to an idempotent SQL script run when an `empty` preview database is
1503 /// first opened (e.g. schema/seed). Ignored in `branch`/`shared` modes.
1504 pub preview_init: Option<PathBuf>,
1505 /// `handlers.bindings.sql.databases` — external **bring-your-own** databases,
1506 /// each opened by name via `sql.open("<name>")`. An operator-configured
1507 /// Postgres/MySQL whose *isolation is the operator's* (it's their database),
1508 /// so these bypass the per-site libsql boundary and are reachable by any
1509 /// handler/function granted the `sql` binding. Needs the `sql-postgres` /
1510 /// `sql-mysql` build feature for the engine. A name here shadows the same
1511 /// name on the managed libsql default.
1512 pub databases: BTreeMap<String, ExternalDatabaseConfig>,
1513 /// **Soft-delete grace window** for a per-tenant managed database, in seconds
1514 /// (env `BOATRAMP_HANDLERS_SQL_DEPROVISION_GRACE_SECS`). When a project/site is
1515 /// deleted, a **Shared + Postgres** tenant is *soft*-deleted (its database is
1516 /// renamed aside and its role disabled) and stays recoverable for this long
1517 /// before a reaper hard-drops it — see
1518 /// [`tenant_sql`](crate::tenant_sql). `None` ⇒ the 7-day default
1519 /// (`DEFAULT_DEPROVISION_GRACE_SECS`); `0` ⇒ disable the soft path (immediate,
1520 /// irreversible hard drop everywhere). MySQL and all `Single` tenants always
1521 /// hard-drop immediately (the engine/cell can't be renamed aside safely), so this
1522 /// knob only affects the Shared-Postgres cell.
1523 pub deprovision_grace_secs: Option<u64>,
1524 /// **Trusted-extension allowlist** for the owner-gated schema-migration surface — the ONLY
1525 /// Postgres extensions a migration `Extension` step may enable (a name not here is refused
1526 /// fail-closed). A raw `sql` migration step may not `CREATE EXTENSION` at all, so this list is
1527 /// the single, operator-controlled gate on which extensions a project can install via
1528 /// migrations. Empty / `None` ⇒ no extension may be enabled through a migration (the safest
1529 /// default). Keep it tight (e.g. `["pgcrypto", "uuid-ossp", "citext"]`); an entry like
1530 /// `dblink`/`postgres_fdw` deliberately widens cross-database reach, so add those only knowingly.
1531 pub migrate_trusted_extensions: Option<Vec<String>>,
1532 /// **Per-project declared-database COUNT ceiling** (#501 Stage B MEDIUM-1 — the
1533 /// disk-exhaustion / errno-28 guard). The maximum number of `databases:` entries a
1534 /// single project may declare; a declare that would exceed it is refused fail-closed
1535 /// (a 422-class error). Each declared DB eagerly provisions a 10–200 GiB volume, so
1536 /// without this a `Project·Admin` could declare an unbounded number and exhaust the
1537 /// node's disk. `None` ⇒ the built-in default
1538 /// (`apply_db_caps::DEFAULT_MAX_DECLARED_DATABASES_PER_PROJECT`, 16); `0` ⇒ declaring
1539 /// any managed database is disabled on this node.
1540 pub max_declared_databases: Option<usize>,
1541 /// **Per-project aggregate declared-VOLUME ceiling**, in MiB (#501 Stage B
1542 /// MEDIUM-1). The maximum SUM of `volume_size_mib` across all of a project's declared
1543 /// databases; a declare whose incoming volume would push the project's total past
1544 /// this is refused fail-closed. `None` ⇒ the built-in default
1545 /// (`apply_db_caps::DEFAULT_MAX_DECLARED_VOLUME_MIB`, 512 GiB); `0` ⇒ disable managed
1546 /// declarations on this node (the aggregate can never fit a non-zero volume).
1547 pub max_declared_volume_mib: Option<u64>,
1548}
1549
1550/// One external SQL database for the handler `sql` binding. Its **source** is one
1551/// of two mutually-exclusive forms:
1552/// - `url_env` — a **bring-your-own** database: the connection URL is a secret,
1553/// named indirectly by an env var (never written in the config file).
1554/// - `compute` — a database **boatramp runs** as a compute workload: boatramp
1555/// derives the connection from the workload's live endpoint (host\:port) plus
1556/// the `database`/`user`/`password_env` here, so there is no URL to hand-map and
1557/// it follows the workload across restarts (PLAN-managed-compute-sql).
1558#[cfg_attr(not(feature = "handlers"), allow(dead_code))]
1559#[derive(Debug, Clone, Default, Deserialize)]
1560#[serde(default)]
1561pub struct ExternalDatabaseConfig {
1562 /// Engine: `postgres` (aliases `postgresql`/`pg`), `mysql` (alias
1563 /// `mariadb`), or `libsql` (aliases `sqlite`/`sqlite3`) — the embedded
1564 /// SQLite-compatible engine (single-node file, or a remote sqld primary via
1565 /// `url_env`). A `libsql` entry needs neither `compute` nor an external URL for
1566 /// the single-node case: it names an on-disk file via [`path`](Self::path).
1567 pub kind: String,
1568 /// Name of the env var holding the connection URL (e.g.
1569 /// `postgres://user:pw@host/db`). Required unless `compute` is set — or, for a
1570 /// single-node `libsql` database, unless `path` is set (an embedded file needs
1571 /// no URL/secret).
1572 pub url_env: String,
1573 /// Optional env var holding a **read-replica** connection URL. When set,
1574 /// `open-read-only` transactions route there; writes stay on `url_env`.
1575 pub read_url_env: Option<String>,
1576 /// Optional env var holding a **DDL/migration** connection URL for the
1577 /// **owner-role analog** of the schema-migration surface — a login that is
1578 /// DDL-capable *and distinct from the runtime binding user* (`user` /
1579 /// `url_env`). Its whole purpose is to keep migration DDL off the runtime
1580 /// tenant identity, mirroring the Postgres owner-role split (Postgres mints a
1581 /// per-tenant non-superuser owner role automatically; MySQL has no such role
1582 /// model, so the DDL identity must be supplied explicitly).
1583 ///
1584 /// **MySQL:** required to run schema migrations. Point it at an admin/DDL
1585 /// login (e.g. `mysql://root:…@host/db` or a purpose-made `_migrate` grant
1586 /// with `CREATE, ALTER, DROP, INDEX, REFERENCES` on the schema) that is **not**
1587 /// the runtime `user`. If it is unset (or resolves to the same identity as the
1588 /// runtime binding), migrate **refuses** fail-closed rather than run owner-DDL
1589 /// as the runtime tenant user — there is no owner/runtime split to fall back
1590 /// on. Ignored by the normal handler `sql` path; read only by the migration
1591 /// runner.
1592 ///
1593 /// **Postgres:** ignored — the per-project non-superuser owner role +
1594 /// its sealed credential are minted automatically at provision, so no
1595 /// operator-supplied DDL URL is needed (a set value is harmless and unused).
1596 pub migration_url_env: Option<String>,
1597 /// The name of a **compute workload** (a Postgres/MySQL server boatramp runs)
1598 /// to source this database from, instead of `url_env`. boatramp resolves the
1599 /// workload's live endpoint and builds the connection. Mutually exclusive with
1600 /// `url_env`.
1601 ///
1602 /// **Reserved prefix (#501 Stage B LOW-2):** do NOT name a static workload with the
1603 /// `bramp-db-` prefix — it is reserved for the per-project managed-database servers
1604 /// boatramp derives for declarative `databases:` entries
1605 /// (`boatramp_storage::tenant_provision::DERIVED_MANAGED_DB_PREFIX`). A `bramp-db-…`
1606 /// value here is refused fail-closed at config load
1607 /// ([`ConfigError::InvalidDbName`](crate::config::ConfigError::InvalidDbName)).
1608 pub compute: Option<String>,
1609 /// The database name inside the compute-backed server (non-secret).
1610 pub database: Option<String>,
1611 /// The connecting user for the compute-backed server (non-secret).
1612 pub user: Option<String>,
1613 /// Env var holding the password for `user` on the compute-backed server.
1614 /// **Omit to let boatramp fully manage the credential** (PLAN-managed-compute-sql
1615 /// Phase 2): it generates a strong password once, seals it with the `[secrets]`
1616 /// envelope, injects it into the DB workload's server-init env at launch, and
1617 /// connects the handler with it — the operator sets no DB secret at all. Set it
1618 /// only to bring your own password for the compute-backed server.
1619 pub password_env: Option<String>,
1620 /// Maximum pooled connections (default 8).
1621 pub pool_max: Option<u32>,
1622 /// Open every transaction `READ ONLY` (the engine rejects writes) — for a
1623 /// database functions should only read.
1624 pub read_only: bool,
1625 /// Permit **preview** deployments to reach this database. Default `false`: a
1626 /// preview is refused, so it can never touch the operator's live external DB.
1627 pub allow_preview: bool,
1628 /// Connection/acquire timeout in seconds (default 10).
1629 pub connect_timeout_secs: Option<u64>,
1630 /// The stock OCI image for a **managed co-located** database (`compute` set, no
1631 /// `password_env`). When omitted, boatramp auto-registers the workload from the
1632 /// engine's default image (`pgvector/pgvector:pg16` for postgres, `mysql:8.0`
1633 /// for mysql). Ignored for a bring-your-own (`url_env`) database.
1634 pub image: Option<String>,
1635 /// The persistent data-volume size in MiB for a **managed co-located** database
1636 /// (default 10240 = 10 GiB). Ignored for a bring-your-own database.
1637 pub volume_size_mib: Option<u32>,
1638 /// Startup grace (seconds) for a **managed co-located** database: how long a
1639 /// freshly launched server has to finish its first `initdb` before the reconcile
1640 /// loop treats a still-unhealthy replica as a broken launch to stop + relaunch.
1641 /// When set it overrides the engine default the synthesizer picks (Postgres 60,
1642 /// MySQL 120). Omit to use that default. Ignored for a bring-your-own database.
1643 pub startup_grace_secs: Option<u32>,
1644 /// **Isolation mechanism** for a compute-backed managed database (2×2 axis 1).
1645 /// `single` (default) — a *dedicated* database server (its own container) per
1646 /// tenant; `shared` — *one* server hosting a permission-separated database + role
1647 /// per tenant. Ignored for a bring-your-own (`url_env`) database.
1648 pub tenant: TenantIsolation,
1649 /// **Tenant grain** for a compute-backed managed database (2×2 axis 2). `project`
1650 /// (default) — a tenant is a project; `site` — a tenant is a site. A tenant may
1651 /// hold several databases (one per binding that names it); it gets one login role
1652 /// and sealed credential per (tenant, server), granted on all its own databases
1653 /// and none of another tenant's. The reserved `default` project uses the plain
1654 /// configured name, so a single-tenant install is just one ordinary database.
1655 pub tenant_scope: TenantScope,
1656 /// **Opt-in** (default `false`): inject the request's `boatramp.project` /
1657 /// `boatramp.site` into the SQL session at each transaction start (Postgres
1658 /// `set_config` GUC, MySQL session var), so hand-written **native RLS** policies
1659 /// can key on them per-request. The GraphQL data connector's row-level policy is
1660 /// claim-sourced and needs nothing here; this is for hand-rolled RLS on the plain
1661 /// `sql.open` path (Postgres — the engine with native row-level security).
1662 ///
1663 /// # Trust model — read before relying on this for isolation
1664 ///
1665 /// `rls_session` **provides** the request's tenant to the SQL session for an app's
1666 /// RLS to key on. It is **not** a general hostile-guest boundary:
1667 ///
1668 /// - The reserved keys (`boatramp.*` / `@boatramp_*`) are **protected** from guest
1669 /// override — a handler statement that tries to `set_config('boatramp.…', …)` /
1670 /// `SET boatramp.… ` / `SET @boatramp_… ` (or `RESET`/`DISCARD` them) is refused,
1671 /// so a guest cannot spoof its injected tenant.
1672 /// - But the **real tenant-isolation boundary** is the **per-tenant database +
1673 /// role** (`tenant = single` / `shared`), which a compromised handler cannot
1674 /// cross regardless of what it does in-session. `rls_session` is a convenience
1675 /// for app-authored RLS *within* a tenant's own database, layered on top of that
1676 /// boundary — not a substitute for it.
1677 /// - For untrusted data, prefer **claim-sourced** enforcement (the GraphQL data
1678 /// connector's row-level policy), which derives the tenant from the verified
1679 /// request, not from anything the handler's SQL can influence.
1680 pub rls_session: bool,
1681 /// The Postgres session GUC name an app's RLS policies read for the host-resolved **tenant**
1682 /// (e.g. `app.tenant_id`), set per request/write on the `rls_session` path so RLS mirrors
1683 /// boatramp's injected predicate as a defense-in-depth backstop (v0.4.20). Only honored when
1684 /// `rls_session` is on and the backend is Postgres. `None` ⇒ not exposed (today's behavior).
1685 /// The guest can never set this GUC itself (its namespace becomes reserved).
1686 #[serde(default)]
1687 pub tenant_guc: Option<String>,
1688 /// The session GUC name for the anonymous **session** axis (e.g. `app.session_id`), the
1689 /// disjoint-column sibling of `tenant_guc` for `TenantOrSession` tables. `None` ⇒ not exposed.
1690 #[serde(default)]
1691 pub session_guc: Option<String>,
1692 /// A reserved sentinel value written to `tenant_guc` on an **`all`-scoped READ** (v0.4.21), so a
1693 /// table that opts in with `USING (… OR current_setting(tenant_guc, true) = '<marker>')` opens
1694 /// cross-tenant for the audited `all` twins. Pick a value that can **never** be a real tenant id
1695 /// (e.g. `*` or `__all__`). Only honored with `tenant_guc` set + `rls_session` on + Postgres.
1696 /// `None`/empty ⇒ `all` reads leave the GUC untouched (v0.4.20 fail-closed behavior). The guest
1697 /// can never set it — the `tenant_guc` namespace is already reserved against guest writes.
1698 #[serde(default)]
1699 pub tenant_all_marker: Option<String>,
1700 /// The on-disk file path for a single-node **`libsql`** database (`kind: "libsql"`), e.g.
1701 /// `/data/app.db`. The parent directory is created if absent. Used only by the embedded engine;
1702 /// ignored for `postgres`/`mysql` and for a remote-sqld `libsql` binding (which uses `url_env`).
1703 /// A `libsql` entry sets exactly one of `path` (single-node file) or `url_env` (remote sqld).
1704 #[serde(default)]
1705 pub path: Option<PathBuf>,
1706}
1707
1708/// How a managed compute-backed database is physically isolated per tenant (2×2 axis
1709/// 1). `Single` = a dedicated server (container) per tenant (isolation by separate
1710/// process); `Shared` = one server with a per-tenant database + login role (isolation
1711/// by grants — Postgres `REVOKE CONNECT FROM PUBLIC` + owner grant; MySQL per-schema
1712/// grant), so a tenant's role cannot connect to another tenant's database.
1713#[cfg_attr(not(feature = "handlers"), allow(dead_code))]
1714#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Deserialize)]
1715#[serde(rename_all = "lowercase")]
1716pub enum TenantIsolation {
1717 /// A dedicated database server (its own container) per tenant. The default.
1718 #[default]
1719 Single,
1720 /// One shared server hosting a per-tenant database + role (grant-isolated).
1721 Shared,
1722}
1723
1724/// The grain of a tenant for a managed compute-backed database (2×2 axis 2) —
1725/// `Project` (default) or `Site`. The two grains are parallel; the isolation
1726/// mechanism is [`TenantIsolation`].
1727#[cfg_attr(not(feature = "handlers"), allow(dead_code))]
1728#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Deserialize)]
1729#[serde(rename_all = "lowercase")]
1730pub enum TenantScope {
1731 /// A tenant is a **project** (the default).
1732 #[default]
1733 Project,
1734 /// A tenant is a **site** (finer than project).
1735 Site,
1736}
1737
1738impl ExternalDatabaseConfig {
1739 /// Validate the source is well-formed: **exactly one** of `url_env` /
1740 /// `compute`, and a `compute`-backed database has the connection details
1741 /// boatramp can't infer (`database` + `user`). `password_env` is **optional** —
1742 /// omit it to let boatramp manage the credential (Phase 2). `name` is the
1743 /// binding name, for the error message.
1744 #[cfg_attr(not(feature = "handlers"), allow(dead_code))]
1745 pub fn validate(&self, name: &str) -> Result<(), String> {
1746 let has_url = !self.url_env.is_empty();
1747 let has_compute = self.compute.as_deref().is_some_and(|c| !c.is_empty());
1748 let has_path = self
1749 .path
1750 .as_deref()
1751 .is_some_and(|p| !p.as_os_str().is_empty());
1752
1753 // A `libsql`/`sqlite` entry is the embedded engine: single-node via `path`, or remote sqld
1754 // via `url_env` — never `compute` (boatramp doesn't run a libsql server workload). Validate
1755 // it on its own axis (exactly one of `path` / `url_env`), and reject `path` on the external
1756 // engines (a Postgres/MySQL binding has no on-disk file).
1757 let is_libsql = matches!(
1758 self.kind.trim().to_ascii_lowercase().as_str(),
1759 "libsql" | "sqlite" | "sqlite3"
1760 );
1761 if is_libsql {
1762 if has_compute {
1763 return Err(format!(
1764 "sql database {name:?}: a `libsql` database is the embedded engine — set `path` \
1765 (single-node file) or `url_env` (remote sqld), not `compute`"
1766 ));
1767 }
1768 return match (has_path, has_url) {
1769 (true, true) => Err(format!(
1770 "sql database {name:?}: a `libsql` database sets exactly one of `path` \
1771 (single-node file) or `url_env` (remote sqld), not both"
1772 )),
1773 (false, false) => Err(format!(
1774 "sql database {name:?}: a `libsql` database needs a source — set `path` \
1775 (single-node file) or `url_env` (remote sqld)"
1776 )),
1777 _ => Ok(()),
1778 };
1779 }
1780 if has_path {
1781 return Err(format!(
1782 "sql database {name:?}: `path` is only valid for a `libsql` database (the embedded \
1783 engine); a {} binding uses `url_env` or `compute`",
1784 self.kind
1785 ));
1786 }
1787
1788 match (has_url, has_compute) {
1789 (true, true) => Err(format!(
1790 "sql database {name:?}: set exactly one of `url_env` or `compute`, not both"
1791 )),
1792 (false, false) => Err(format!(
1793 "sql database {name:?}: needs a source — set `url_env` (bring-your-own) or \
1794 `compute` (a database boatramp runs)"
1795 )),
1796 (false, true) => {
1797 // `database` + `user` are non-secret and can't be inferred; a missing
1798 // `password_env` is *not* an error — it selects the managed credential.
1799 for (field, val) in [("database", &self.database), ("user", &self.user)] {
1800 if val.as_deref().is_none_or(str::is_empty) {
1801 return Err(format!(
1802 "sql database {name:?}: a `compute`-backed database requires `{field}`"
1803 ));
1804 }
1805 }
1806 Ok(())
1807 }
1808 (true, false) => Ok(()),
1809 }
1810 }
1811
1812 /// Whether this compute-backed database uses a **boatramp-managed** credential
1813 /// (Phase 2): `compute` is set and no `password_env` was supplied.
1814 #[cfg_attr(not(feature = "handlers"), allow(dead_code))]
1815 pub fn is_managed_credential(&self) -> bool {
1816 self.compute.as_deref().is_some_and(|c| !c.is_empty())
1817 && self.password_env.as_deref().is_none_or(str::is_empty)
1818 }
1819}
1820
1821/// The signing algorithm for a signer that can choose one (`Local`, `Vault`,
1822/// `Pkcs11`). ES256 is the portable default; the cloud KMS backends are ES256-only
1823/// and ignore this. Written as a RON enum: `alg: Es256` / `alg: Ed25519`.
1824#[derive(Debug, Clone, Copy, Default, Deserialize)]
1825pub enum SignerAlg {
1826 /// ECDSA P-256 (COSE ES256) — the default.
1827 #[default]
1828 Es256,
1829 /// Ed25519 (COSE EdDSA).
1830 Ed25519,
1831}
1832
1833impl SignerAlg {
1834 fn to_token_alg(self) -> boatramp_core::cose::TokenAlg {
1835 match self {
1836 Self::Es256 => boatramp_core::cose::TokenAlg::Es256,
1837 Self::Ed25519 => boatramp_core::cose::TokenAlg::Ed25519,
1838 }
1839 }
1840}
1841
1842/// External token signer selector (`serve.signer`). Maps to
1843/// [`boatramp_server::signer::SignerConfig`]; secrets (tokens/PINs) are resolved
1844/// from the named env vars at startup, never stored in config. Written as a RON
1845/// enum — `signer: Vault(...)`, `signer: AwsKms(...)`, `signer: Pkcs11(...)`, ….
1846#[derive(Debug, Clone, Deserialize)]
1847#[serde(deny_unknown_fields)]
1848pub enum AuthSignerConfig {
1849 /// In-process key (`"<alg>:<hex>"`).
1850 Local {
1851 /// The private key spec, `"<alg>:<hex>"`.
1852 private_key: String,
1853 },
1854 /// HashiCorp Vault Transit key.
1855 Vault {
1856 /// Vault base address.
1857 address: String,
1858 /// The Transit key name.
1859 key: String,
1860 /// Env var holding the Vault token.
1861 token_env: String,
1862 /// The key algorithm.
1863 #[serde(default)]
1864 alg: SignerAlg,
1865 },
1866 /// AWS KMS asymmetric key (ES256).
1867 AwsKms {
1868 /// The KMS key id or ARN.
1869 key_id: String,
1870 /// Optional region override.
1871 #[serde(default)]
1872 region: Option<String>,
1873 },
1874 /// GCP Cloud KMS key version (ES256).
1875 GcpKms {
1876 /// The key-version resource name.
1877 key_version: String,
1878 /// Env var holding a GCP OAuth2 access token.
1879 access_token_env: String,
1880 },
1881 /// Azure Key Vault key (ES256).
1882 AzureKv {
1883 /// The vault base URL.
1884 vault_url: String,
1885 /// The key name.
1886 key: String,
1887 /// The key version.
1888 key_version: String,
1889 /// Env var holding an Azure AD access token.
1890 access_token_env: String,
1891 },
1892 /// PKCS#11 HSM key.
1893 Pkcs11 {
1894 /// Path to the PKCS#11 module.
1895 module: String,
1896 /// The token label.
1897 token_label: String,
1898 /// The key's `CKA_LABEL`.
1899 key_label: String,
1900 /// Env var holding the user PIN.
1901 pin_env: String,
1902 /// The key algorithm.
1903 #[serde(default)]
1904 alg: SignerAlg,
1905 },
1906}
1907
1908impl AuthSignerConfig {
1909 /// Map the config-file form to the server's runtime [`SignerConfig`].
1910 pub fn to_signer_config(&self) -> boatramp_server::signer::SignerConfig {
1911 use boatramp_server::signer::SignerConfig;
1912 match self {
1913 Self::Local { private_key } => SignerConfig::Local {
1914 private_key: private_key.clone(),
1915 },
1916 Self::Vault {
1917 address,
1918 key,
1919 token_env,
1920 alg,
1921 } => SignerConfig::Vault {
1922 address: address.clone(),
1923 key: key.clone(),
1924 token_env: token_env.clone(),
1925 alg: alg.to_token_alg(),
1926 },
1927 Self::AwsKms { key_id, region } => SignerConfig::AwsKms {
1928 key_id: key_id.clone(),
1929 region: region.clone(),
1930 },
1931 Self::GcpKms {
1932 key_version,
1933 access_token_env,
1934 } => SignerConfig::GcpKms {
1935 key_version: key_version.clone(),
1936 access_token_env: access_token_env.clone(),
1937 },
1938 Self::AzureKv {
1939 vault_url,
1940 key,
1941 key_version,
1942 access_token_env,
1943 } => SignerConfig::AzureKv {
1944 vault_url: vault_url.clone(),
1945 key: key.clone(),
1946 key_version: key_version.clone(),
1947 access_token_env: access_token_env.clone(),
1948 },
1949 Self::Pkcs11 {
1950 module,
1951 token_label,
1952 key_label,
1953 pin_env,
1954 alg,
1955 } => SignerConfig::Pkcs11 {
1956 module: module.clone(),
1957 token_label: token_label.clone(),
1958 key_label: key_label.clone(),
1959 pin_env: pin_env.clone(),
1960 alg: alg.to_token_alg(),
1961 },
1962 }
1963 }
1964}
1965
1966/// `serve` section — server defaults, overridden by flags/env.
1967#[derive(Debug, Clone, Default, Deserialize)]
1968#[serde(default)]
1969pub struct ServeConfig {
1970 /// Bind address (e.g. `0.0.0.0:8080`).
1971 pub addr: Option<SocketAddr>,
1972 /// Data directory for filesystem backends.
1973 pub data_dir: Option<PathBuf>,
1974 /// Blob object-store backend (`fs`/`s3`/`gcs`/`azure`) — the config-level analog of the
1975 /// `--blobs` flag. Absent ⇒ the flag/env decides (`--blobs`/`BOATRAMP_BLOBS`, default `fs`).
1976 /// The flag/env still wins over this (uniform `serve` precedence). Read primarily by `boatramp
1977 /// blob migrate`, which builds a source/destination backend from a config file alone; `serve`
1978 /// also honours it as the config-level fallback under the flag.
1979 pub blobs: Option<crate::backends::BlobBackend>,
1980 /// S3 bucket (`--blobs s3`). Config-level fallback for `--s3-bucket`/`BOATRAMP_S3_BUCKET`.
1981 pub s3_bucket: Option<String>,
1982 /// S3 endpoint URL (e.g. a MinIO/R2/Tigris endpoint). Fallback for `--s3-endpoint`.
1983 pub s3_endpoint: Option<String>,
1984 /// S3 region. Fallback for `--s3-region`.
1985 pub s3_region: Option<String>,
1986 /// Use S3 path-style addressing (required by MinIO). Fallback for `--s3-path-style`.
1987 pub s3_path_style: bool,
1988 /// GCS bucket (`--blobs gcs`). Fallback for `--gcs-bucket`.
1989 pub gcs_bucket: Option<String>,
1990 /// GCS storage endpoint URL (e.g. a `fake-gcs-server` emulator). Fallback for `--gcs-endpoint`.
1991 pub gcs_endpoint: Option<String>,
1992 /// Skip GCS credential resolution (anonymous — the emulator). Fallback for `--gcs-anonymous`.
1993 pub gcs_anonymous: bool,
1994 /// Azure storage account name (`--blobs azure`). Fallback for `--azure-account`.
1995 pub azure_account: Option<String>,
1996 /// Azure container name (`--blobs azure`). Fallback for `--azure-container`.
1997 pub azure_container: Option<String>,
1998 /// Azure storage account access key (shared-key auth). Fallback for `--azure-access-key`.
1999 /// Prefer the env/flag over persisting a key in the config file.
2000 pub azure_access_key: Option<String>,
2001 /// Use the Azurite emulator (well-known dev credentials + local endpoint). Fallback for
2002 /// `--azure-emulator`.
2003 pub azure_emulator: bool,
2004 /// `[serve.blob_fallback]` — a **read-only SECONDARY blob backend** for a zero-downtime
2005 /// backend switch (blob-backend migration Part 2). When set, serving reads the PRIMARY (the
2006 /// `blobs`/`s3_*`/`gcs_*`/`azure_*` fields above) first and, on a definitive miss for a
2007 /// boatramp-owned key, falls through to this secondary — so a `--blobs` switch (fs→cloud,
2008 /// provider→provider, region→region) has no serving gap while `boatramp blob migrate` drains
2009 /// the secondary into the primary. **Writes are primary-only**; the secondary is never written
2010 /// or deleted. This is a **bounded transition aid**: drain, verify, then remove this block and
2011 /// restart (the node logs a prominent startup WARNING while it is active, and GC prune is
2012 /// refused). Absent ⇒ no fallback (unchanged). See [`BlobFallbackConfig`].
2013 pub blob_fallback: Option<BlobFallbackConfig>,
2014 /// Token root **private** key (hex) — issuing node: verifies *and* mints
2015 /// tokens / OIDC exchanges.
2016 pub auth_root_private_key: Option<String>,
2017 /// Token root **public** key (hex) — verify-only node.
2018 pub auth_root_public_key: Option<String>,
2019 /// Single-use bootstrap secret enabling `POST /api/tokens/bootstrap` (mint the
2020 /// first token without an admin bearer). Prefer the `BOATRAMP_BOOTSTRAP_SECRET`
2021 /// env / `--bootstrap-secret` flag so it isn't persisted in the config file.
2022 pub bootstrap_secret: Option<String>,
2023 /// External token signer (`[serve.signer]`): mint with a
2024 /// KMS/HSM/Vault-held root key instead of an in-process `auth_root_private_key`.
2025 /// Absent ⇒ the in-process key. When set, its public half is the trust anchor.
2026 pub signer: Option<AuthSignerConfig>,
2027 /// Reject blob uploads larger than this many bytes.
2028 pub max_upload_bytes: Option<u64>,
2029 /// Abort an upload that stalls for longer than this many seconds.
2030 pub upload_idle_timeout_secs: Option<u64>,
2031 /// Cap on simultaneous blob uploads.
2032 pub max_concurrent_uploads: Option<usize>,
2033 /// In a TLS mode, bind this plain-HTTP address on a second listener that
2034 /// redirects to HTTPS (dual-listener). Only read in `tls` builds.
2035 #[cfg_attr(not(feature = "tls"), allow(dead_code))]
2036 pub http_redirect_addr: Option<SocketAddr>,
2037 /// Site to serve for a `Host` matching no domain, instead of 404.
2038 pub default_site: Option<String>,
2039 /// The fleet's canonical public origin (e.g. `https://cp.example.com`) that a
2040 /// per-request proof-of-possession must bind to (`aud`). Required for
2041 /// holder-bound (`cnf`/PoP) tokens to be usable — a proof's origin is compared
2042 /// against this value, never against a `Host`/`X-Forwarded-*` header.
2043 pub pop_origin: Option<String>,
2044 /// Require a valid control-plane token to view deployment previews.
2045 pub protect_previews: bool,
2046 /// Rate-limit cluster-wide via the control-plane KV instead of per node.
2047 pub cluster_rate_limit: bool,
2048 /// Keep the config cache coherent across processes sharing one KV via the
2049 /// changelog.
2050 pub shared_cache_coherence: bool,
2051 /// Cloud blob-change notification provisioning tier (FA-5b2): how boatramp
2052 /// obtains the native event pipeline (S3→SQS) that backs a `blob` trigger —
2053 /// `dry-run` (print the recipe), `provision` (create + retract), `verify-only`
2054 /// (operator pre-wired), or `refuse` (fail closed). Absent ⇒ no provisioning:
2055 /// `blob` triggers then work only on a self-watching backend (fs). Only wired
2056 /// for the S3 backend (`--features s3`).
2057 pub blob_notify_tier: Option<boatramp_core::blob_notify::ProvisionTier>,
2058 /// The AWS account id used to scope the provisioned SQS queue's `SendMessage`
2059 /// policy (`aws:SourceAccount`). Required when `blob_notify_tier` provisions.
2060 pub blob_notify_account_id: Option<String>,
2061 /// `[serve.console]` — the embedded web management console. Absent (or
2062 /// `enabled: false`) ⇒ not served. This is the **baseline** for the dynamic
2063 /// `console.*` daemon-config override, which can enable/move it at runtime
2064 /// (`boatramp config set console.enabled true`) without a restart.
2065 pub console: Option<ConsoleConfig>,
2066 /// Bind address for the **dedicated local S3-ingress listener** (PLAN-blob-s3-ingress,
2067 /// Architect HIGH-4). Absent ⇒ the local S3 face is NOT served (it is opt-in — a deployment that
2068 /// only mints cloud-brokered credentials never needs it). This is a SEPARATE listener from the
2069 /// control-plane `addr`: it has its own SigV4 auth surface and never reaches `serve_by_host` or
2070 /// the `/api` router.
2071 pub s3_ingress_addr: Option<SocketAddr>,
2072 /// Path to the **dedicated S3-ingress root secret** file (raw 32 bytes) — the independently-
2073 /// rotatable HKDF root for `secret_access_key` derivation (hard domain separation from the
2074 /// `[secrets]` KEK + the COSE signing key). Like `[secrets].kek_file`, this holds a *path*, never
2075 /// key material in the config text, and (in a cluster) the **same file must be present on every
2076 /// node** so every node derives the same `secret_access_key`. Absent on a single node ⇒ an
2077 /// ephemeral per-process root is auto-generated; absent on a **multi-node** deployment ⇒ the S3
2078 /// face is refused to enable (fail-closed — credentials would otherwise be un-verifiable across
2079 /// nodes). Prefer the `BOATRAMP_S3_INGRESS_SECRET_FILE` env / flag so the path stays out of the
2080 /// committed config where that matters operationally.
2081 pub s3_ingress_secret_file: Option<PathBuf>,
2082 /// The publicly-reachable base URL an external client targets for the local S3 face — what a
2083 /// **minted** upload credential (`boatramp:handlers/blob-upload` guest mint / `boatramp blob
2084 /// mint-upload` operator) embeds as its endpoint (a presigned-put URL prefix, or the SDK endpoint
2085 /// for temp-credentials). Absent ⇒ derived from `s3_ingress_addr` as `http://<addr>` (fine for a
2086 /// same-host dev/test loop; set it explicitly to the TLS-terminated public URL in production).
2087 /// Only consulted when guest/operator upload minting is wired (`blob-upload` feature + the face
2088 /// enabled).
2089 pub s3_ingress_public_url: Option<String>,
2090 /// Operator ceiling (seconds) on a minted upload credential's TTL — a guest/operator can only
2091 /// request a SHORTER lifetime (the mint clamps to this). Absent ⇒ a conservative default
2092 /// ([`DEFAULT_S3_INGRESS_MINT_MAX_TTL_SECS`]). A `0` disables minting entirely (the binding is
2093 /// never attached).
2094 pub s3_ingress_mint_max_ttl_secs: Option<u64>,
2095 /// Operator ceiling (bytes) on a minted credential's `max_bytes` constraint — a guest can only
2096 /// request a SMALLER cap (clamped to this). Absent ⇒ no host-side max-bytes clamp (the per-container
2097 /// ceiling at the face still applies).
2098 pub s3_ingress_mint_max_bytes: Option<u64>,
2099 /// **Cloud brokering** (M4): when the node's blob backend is a cloud object store (S3/GCS/Azure)
2100 /// and this is set, minting brokers a NATIVE scoped credential (STS session policy / signed URL +
2101 /// CAB / user-delegation SAS) so the client uploads DIRECTLY to the real store (bytes never transit
2102 /// the node) — INSTEAD of the local S3 face. Absent ⇒ the local face is used (an fs/in-memory
2103 /// backend, or a cloud backend that re-transits through the local face). See [`S3IngressCloud`].
2104 pub s3_ingress_cloud: Option<S3IngressCloud>,
2105 /// **Node-level base S3 credential source** (`[serve.s3_credential]`, task #505). When set, BOTH the
2106 /// S3 blob **object backend** (`--blobs s3`) and the AWS blob-upload **cloud minter**
2107 /// (`[serve.s3_ingress_cloud]`) source their base AWS credential from boatramp's `[secrets]` sealed
2108 /// store instead of the ambient `AWS_ACCESS_KEY_ID`/`AWS_SECRET_ACCESS_KEY` env chain. ONE shared
2109 /// source (both consumers read the SAME bucket key). Absent ⇒ the ambient AWS env chain (current
2110 /// behavior, non-breaking). Requires a `[secrets]` envelope when the `secret_access_key` is a sealed
2111 /// `boatramp:`/`env:` ref — a configured ref with no envelope is a **startup error** (fail-closed, no
2112 /// silent env fallback). See [`S3CredentialConfig`].
2113 pub s3_credential: Option<S3CredentialConfig>,
2114 /// `[serve.kv]` — control-plane SlateDB KV durability cadence + shutdown budget (v0.9.0
2115 /// KV-recovery). Absent ⇒ the defaults (periodic checkpoint ON at
2116 /// [`DEFAULT_KV_CHECKPOINT_INTERVAL_SECS`], close budget [`DEFAULT_KV_CLOSE_DEADLINE_SECS`]).
2117 /// See [`KvConfig`].
2118 pub kv: Option<KvConfig>,
2119}
2120
2121/// `[serve.s3_credential]` — a **node-level base S3 credential source** (#505) sourcing the base AWS
2122/// credential from boatramp's `[secrets]` sealed store rather than the ambient env chain. Consumed by
2123/// BOTH the S3 blob object backend and the AWS blob-upload cloud minter (one shared source, since it is
2124/// the same bucket key). Additive/non-breaking: absent ⇒ the ambient AWS env chain (unchanged).
2125///
2126/// The `access_key_id` is a public identifier (plain config). The `secret_access_key` is a **secret
2127/// reference** in the same scheme the guest `secrets` map uses: `boatramp:<name>` (the project-scoped
2128/// sealed store, resolved under the reserved default project — multi-tenant-safe, never the host env),
2129/// `env:<VAR>` / a bare `<VAR>` (the operator's own environment — honored only when the posture's
2130/// `allow_env_secret_refs` is set), unsealed at serve startup via the `[secrets]` [`KeyEnvelope`]. The
2131/// resolved plaintext is held **in memory only** (never env/argv/git/logs); see the redacted
2132/// `SealedS3Credential` the resolver produces.
2133#[derive(Debug, Clone, Default, serde::Serialize, serde::Deserialize)]
2134#[serde(deny_unknown_fields)]
2135pub struct S3CredentialConfig {
2136 /// The AWS **access key id** — a public identifier, not a secret, so it is plain config (mirrors
2137 /// how an `access_key_id` is a public value in the S3-ingress credential model). Empty is refused
2138 /// at resolution.
2139 pub access_key_id: String,
2140 /// The **secret access key**, expressed as a secret **reference** (never the raw secret in the
2141 /// config text): `boatramp:<name>` (the project-scoped sealed store), `env:<VAR>` or a bare `<VAR>`
2142 /// (the operator env, posture-gated by `allow_env_secret_refs`). Unsealed at startup via the
2143 /// `[secrets]` envelope; the resolved value is redacted from `Debug`/logs. A `boatramp:`/`env:`
2144 /// ref configured with NO `[secrets]` envelope is a fail-closed startup error.
2145 pub secret_access_key: String,
2146}
2147
2148/// `[serve.blob_fallback]` — a **read-only SECONDARY blob backend** for a zero-downtime backend switch
2149/// (blob-backend migration Part 2). Same backend-descriptor shape as the PRIMARY (`[serve]`'s
2150/// `blobs`/`s3_*`/`gcs_*`/`azure_*` fields) so a source/dest is fully described by config, plus its OWN
2151/// optional `s3_credential` (the secondary can source its base S3 credential from the sealed `[secrets]`
2152/// store via its own `boatramp:`/`env:` ref, #505). Constructed exactly like the primary but with NO
2153/// watcher provisioning (a read-only drain source never watches). Serving wraps
2154/// `FallbackStorage::new(primary, secondary, …)` so a primary miss on a boatramp-owned key falls through
2155/// to this secondary; writes/deletes are primary-only.
2156///
2157/// The secondary is **never** handed to the blob-upload/STS minter — external ingress mints against the
2158/// PRIMARY only (the new backend the client should upload to), so this credential never reaches the
2159/// minter path.
2160#[derive(Debug, Clone, Default, Deserialize)]
2161#[serde(deny_unknown_fields)]
2162pub struct BlobFallbackConfig {
2163 /// The secondary blob backend (`fs`/`s3`/`gcs`/`azure`) — the OLD backend to fall back to on a
2164 /// primary miss. Absent ⇒ `fs` (the default, matching the primary's `blobs` default).
2165 pub blobs: Option<crate::backends::BlobBackend>,
2166 /// S3 bucket (secondary `blobs = s3`).
2167 pub s3_bucket: Option<String>,
2168 /// S3 endpoint URL (a MinIO/R2/Tigris endpoint) for the secondary.
2169 pub s3_endpoint: Option<String>,
2170 /// S3 region for the secondary.
2171 pub s3_region: Option<String>,
2172 /// Use S3 path-style addressing (MinIO) for the secondary.
2173 #[serde(default)]
2174 pub s3_path_style: bool,
2175 /// The secondary's OWN node-level sealed base S3 credential source (#505) — resolved through the
2176 /// SAME `resolve_s3_credential` path as the primary (same fail-closed posture, no second parser).
2177 /// Absent ⇒ the ambient AWS env chain (unchanged).
2178 pub s3_credential: Option<S3CredentialConfig>,
2179 /// GCS bucket (secondary `blobs = gcs`).
2180 pub gcs_bucket: Option<String>,
2181 /// GCS storage endpoint URL (a `fake-gcs-server` emulator) for the secondary.
2182 pub gcs_endpoint: Option<String>,
2183 /// Skip GCS credential resolution (anonymous — the emulator) for the secondary.
2184 #[serde(default)]
2185 pub gcs_anonymous: bool,
2186 /// Azure storage account name (secondary `blobs = azure`).
2187 pub azure_account: Option<String>,
2188 /// Azure container name for the secondary.
2189 pub azure_container: Option<String>,
2190 /// Azure storage account access key (shared-key auth) for the secondary.
2191 pub azure_access_key: Option<String>,
2192 /// Use the Azurite emulator for the secondary.
2193 #[serde(default)]
2194 pub azure_emulator: bool,
2195 /// Bound (seconds) on each secondary read so a wedged secondary degrades a primary miss to
2196 /// `NotFound` instead of hanging the serve path. Absent ⇒ [`DEFAULT_BLOB_FALLBACK_TIMEOUT_SECS`].
2197 pub secondary_timeout_secs: Option<u64>,
2198}
2199
2200/// Default bound (seconds) on a `[serve.blob_fallback]` secondary read when
2201/// `secondary_timeout_secs` is unset: 5s — long enough for a cloud round-trip, short enough that a
2202/// wedged secondary degrades a primary miss to `NotFound` promptly rather than hanging serving.
2203pub const DEFAULT_BLOB_FALLBACK_TIMEOUT_SECS: u64 = 5;
2204
2205/// Default control-plane KV **periodic checkpoint** cadence (seconds) when `[serve.kv]
2206/// checkpoint_interval` is unset (v0.9.0 KV-recovery, C1). The cadence advances the durable frontier
2207/// (WAL→L0 MemTable freeze) so the self-heal-on-open trailing-tail loss window is bounded to at most
2208/// this interval for anything NOT already frontier-synced by a crown-jewel write. 10s balances a tiny
2209/// loss window against manifest-PUT churn; an idle store's checkpoint is a dirty-gated no-op regardless.
2210pub const DEFAULT_KV_CHECKPOINT_INTERVAL_SECS: u64 = 10;
2211
2212/// Default **graceful-close budget** (seconds) when `[serve.kv] close_deadline` is unset (v0.9.0
2213/// KV-recovery, C12). The shutdown drain+close is abandoned only after this budget — GENEROUS (not the
2214/// old hardcoded 3s, which self-exited BEFORE fly's SIGKILL grace and left the frontier un-advanced =
2215/// the exact torn tail we prevent). With continuous checkpointing (C1/C2) the close is cheap, so this
2216/// budget rarely bites; operators should still raise fly `kill_timeout` to ≥ their measured drain+close.
2217pub const DEFAULT_KV_CLOSE_DEADLINE_SECS: u64 = 20;
2218
2219/// `[serve.kv]` — control-plane KV configuration. The backend itself is selected by `--kv` /
2220/// `BOATRAMP_KV` (`slatedb` default, `sql`, `memory`, `cloudflare`); this block holds the
2221/// backend-specific settings, nested so a knob can never silently mislead under the wrong backend
2222/// (UX-C3): the SlateDB durability knobs live under [`slatedb`](Self::slatedb), and the SQL
2223/// connection under [`sql`](Self::sql). Absent block ⇒ the SlateDB defaults apply.
2224#[derive(Debug, Clone, Default, Deserialize)]
2225#[serde(default, deny_unknown_fields)]
2226pub struct KvConfig {
2227 /// `[serve.kv.slatedb]` — SlateDB-specific durability knobs (checkpoint cadence + close budget).
2228 /// Nested under `slatedb` (UX-C3) so they don't appear to apply under `--kv sql` / `--kv memory`.
2229 /// Absent ⇒ both defaults (checkpoint cadence ON, generous close budget).
2230 pub slatedb: Option<SlatedbKvConfig>,
2231 /// `[serve.kv.sql]` — the SQL KV backend's connection (`--kv sql`). Absent under `--kv sql` ⇒ the
2232 /// backend is configured entirely by the `BOATRAMP_KV_SQL_*` env (resolved at serve wiring).
2233 pub sql: Option<SqlKvConfig>,
2234}
2235
2236impl KvConfig {
2237 /// The resolved periodic-checkpoint interval (SlateDB): `None` ⇒ cadence DISABLED (explicit `0`);
2238 /// else the configured seconds, or [`DEFAULT_KV_CHECKPOINT_INTERVAL_SECS`] when unset/absent.
2239 pub fn checkpoint_interval(&self) -> Option<std::time::Duration> {
2240 match self.slatedb.as_ref().and_then(|s| s.checkpoint_interval) {
2241 Some(0) => None,
2242 Some(secs) => Some(std::time::Duration::from_secs(secs)),
2243 None => Some(std::time::Duration::from_secs(
2244 DEFAULT_KV_CHECKPOINT_INTERVAL_SECS,
2245 )),
2246 }
2247 }
2248
2249 /// The resolved graceful-close budget (SlateDB). A configured `0` (or unset/absent) falls back to
2250 /// [`DEFAULT_KV_CLOSE_DEADLINE_SECS`] — the budget must be positive so a genuinely-wedged close
2251 /// still cannot hang shutdown forever, while never being the too-tight 3s that caused the incident.
2252 pub fn close_deadline(&self) -> std::time::Duration {
2253 match self.slatedb.as_ref().and_then(|s| s.close_deadline) {
2254 Some(secs) if secs > 0 => std::time::Duration::from_secs(secs),
2255 _ => std::time::Duration::from_secs(DEFAULT_KV_CLOSE_DEADLINE_SECS),
2256 }
2257 }
2258}
2259
2260/// `[serve.kv.slatedb]` — control-plane SlateDB KV durability knobs (v0.9.0 KV-recovery). Both are
2261/// backstops/tuning: the crown-jewel per-write frontier-sync (C2) is unconditional and independent of
2262/// these. Absent ⇒ both defaults apply (checkpoint cadence ON, generous close budget). (v0.12.0 UX-C3:
2263/// MOVED here from the `[serve.kv]` top level so they do not appear to apply under a non-SlateDB
2264/// backend; with `deny_unknown_fields` a pre-v0.12.0 top-level knob now fails loud rather than
2265/// silently misleading.)
2266#[derive(Debug, Clone, Default, Deserialize)]
2267#[serde(default, deny_unknown_fields)]
2268pub struct SlatedbKvConfig {
2269 /// Periodic checkpoint cadence, seconds. Unset ⇒ [`DEFAULT_KV_CHECKPOINT_INTERVAL_SECS`] (ON).
2270 /// `0` DISABLES the cadence (the crown-jewel per-write frontier-sync still runs; only the
2271 /// backstop that bounds the loss window for derived/relaxed writes is off).
2272 pub checkpoint_interval: Option<u64>,
2273 /// Graceful drain+close budget, seconds. Unset ⇒ [`DEFAULT_KV_CLOSE_DEADLINE_SECS`]. `0` is
2274 /// rejected up to the default (a zero budget would abandon every close, guaranteeing a torn tail).
2275 pub close_deadline: Option<u64>,
2276}
2277
2278/// `[serve.kv.sql]` — the **SQL control-plane KV** backend connection (`--kv sql`). The connection
2279/// URL is NEVER written in the config (UX-C2): a bring-your-own / remote engine names the env var
2280/// holding it via [`url_env`](Self::url_env) (mirroring `ExternalDatabaseConfig`), while an embedded
2281/// single-node SQLite database names an on-disk file via [`path`](Self::path). Every field is also
2282/// settable by `BOATRAMP_KV_SQL_*` env (resolved at serve wiring). **This workstream (build-order
2283/// step 1) wires `sqlite` (libsql-local) only**; `postgres`/`mysql` are later workstreams.
2284#[derive(Debug, Clone, Default, Deserialize)]
2285#[serde(default, deny_unknown_fields)]
2286pub struct SqlKvConfig {
2287 /// Engine: `sqlite` (aliases `sqlite3`/`libsql`) — the embedded single-node file; `postgres`
2288 /// (aliases `postgresql`/`pg`) or `mysql` (alias `mariadb`) — the multi-writer engines (later
2289 /// workstreams), the same alias set as the `databases:` block. Empty ⇒ `sqlite`.
2290 pub kind: String,
2291 /// Name of the env var holding the connection URL (e.g. `postgres://…`, or a remote sqld URL) —
2292 /// NEVER a raw URL in the config. Unused for an embedded single-node `sqlite` database (which
2293 /// uses [`path`](Self::path)).
2294 pub url_env: Option<String>,
2295 /// On-disk file path for an embedded single-node `sqlite` KV (e.g. `/data/kv.db`). The parent
2296 /// directory is created if absent. Ignored for `postgres`/`mysql` and for a remote-sqld URL.
2297 pub path: Option<String>,
2298 /// Maximum pooled connections for a `postgres`/`mysql` KV (later workstreams). Ignored for the
2299 /// embedded `sqlite` path (one `Database` handle, connections opened per op).
2300 pub pool_max: Option<u32>,
2301}
2302
2303/// `[serve.s3_ingress_cloud]` — the cloud-brokering knobs for the M4 blob-upload minter (which native
2304/// credential the mint brokers when the node's blob backend is a cloud object store). Only the fields
2305/// for the active blob backend are consulted; a `None` here ⇒ the local S3 face mints.
2306#[derive(Debug, Clone, Default, serde::Serialize, serde::Deserialize)]
2307pub struct S3IngressCloud {
2308 /// **AWS**: the IAM role ARN the base credential assumes to broker the scoped session-policy
2309 /// credential (`sts:AssumeRole`, the default). Absent AND `aws_use_federation_token = true` ⇒
2310 /// `sts:GetFederationToken` is used instead (for an IAM-user base credential).
2311 pub aws_role_arn: Option<String>,
2312 /// **AWS**: use `sts:GetFederationToken` instead of `AssumeRole` (IAM-user deployments). Requires
2313 /// the base credential to be a real IAM user, not itself a session.
2314 #[serde(default)]
2315 pub aws_use_federation_token: bool,
2316 /// **AWS**: the S3-compatible backend has NO STS (Tigris/R2/MinIO): mint single-object presigned PUTs
2317 /// only. Prefix/multipart mints are refused (they require STS). Mutually exclusive with
2318 /// `aws_role_arn`/`aws_use_federation_token` (a misconfiguration that set both fails loud at wiring,
2319 /// never silently picks one). The presigned PUT is signed from the node's base S3 credential — the
2320 /// SAME source the S3 blob backend uses — so no new credential is needed. Default `false`.
2321 #[serde(default)]
2322 pub aws_presigned_only: bool,
2323 /// **GCS**: the service-account client email whose V4 signed URLs / IAM-signed uploads the minter
2324 /// produces (used in the signing scope). Absent ⇒ resolved from ADC.
2325 pub gcs_client_email: Option<String>,
2326 /// **Azure**: the storage account name (for the SAS signature + the blob URL). Absent ⇒ taken from
2327 /// the `azure_account` blob-backend arg.
2328 pub azure_account: Option<String>,
2329 /// **Azure**: the blob service URL (`https://{account}.blob.core.windows.net/`). Absent ⇒ derived
2330 /// from the account name.
2331 pub azure_service_url: Option<String>,
2332 /// **Azure**: declare the storage account has a **hierarchical namespace** (HNS/ADLS-Gen2). A
2333 /// directory-scoped SAS only actually confines to a sub-prefix on an HNS account; on a flat account
2334 /// it silently degrades to container-wide (Security LOW-1). So a PREFIX mint is refused unless this
2335 /// is `true`. Default `false` (fail-closed). A single-key mint is unaffected.
2336 #[serde(default)]
2337 pub azure_hns: bool,
2338}
2339
2340/// The default operator ceiling on a minted S3 upload credential's TTL when
2341/// `[serve].s3_ingress_mint_max_ttl_secs` is unset: 1 hour — long enough for a browser UGC upload or a
2342/// bulk-agent burst, short enough to bound a leaked short-lived credential.
2343pub const DEFAULT_S3_INGRESS_MINT_MAX_TTL_SECS: u64 = 3600;
2344
2345/// `[serve.console]` — the embedded web console (a Wasm SPA baked into the
2346/// binary with the `console` build feature). Opt-in: the static shell holds no
2347/// secrets and the `/api` it drives is token-gated, so it is served
2348/// **unauthenticated** at a deliberately obscure path (a bearer token can't gate
2349/// a top-level browser navigation anyway — the path is the obscurity, the token
2350/// is the real gate).
2351#[cfg_attr(not(feature = "console"), allow(dead_code))]
2352#[derive(Debug, Clone, Default, Deserialize)]
2353#[serde(default, deny_unknown_fields)]
2354pub struct ConsoleConfig {
2355 /// Serve the embedded console (default `false`). Requires the `console` build
2356 /// feature; enabling it in a build without that feature is a logged no-op.
2357 pub enabled: bool,
2358 /// Host(s) the console answers on: `*` (any host, the default), an exact host
2359 /// (`console.example.com`), or a leading-wildcard (`*.example.com`).
2360 pub host: Option<String>,
2361 /// URL path prefix the console mounts at (default `/_console`). Kept under the
2362 /// reserved `/_` namespace so it never collides with a published site path.
2363 pub path: Option<String>,
2364}
2365
2366/// `publish` section — where and what to deploy (the `sync` target).
2367#[derive(Debug, Default, Deserialize)]
2368#[serde(default)]
2369pub struct PublishConfig {
2370 /// Base URL of the boatramp server (e.g. `https://pad.example.com`).
2371 pub server: Option<String>,
2372 /// Site name to publish to.
2373 pub site: Option<String>,
2374 /// API token for the control plane (or set `BOATRAMP_TOKEN`).
2375 pub token: Option<String>,
2376 /// Project this site belongs to (overrides with `--project` / `BOATRAMP_PROJECT`).
2377 pub project: Option<String>,
2378}
2379
2380/// `build` section.
2381#[derive(Debug, Clone, Deserialize, serde::Serialize)]
2382pub struct BuildConfig {
2383 /// Shell command to run (e.g. `npm run build`).
2384 pub command: String,
2385 /// Directory the build emits, published by `sync` (e.g. `dist`).
2386 #[serde(default, skip_serializing_if = "Option::is_none")]
2387 pub output: Option<String>,
2388}
2389
2390/// `bundle` section — the in-process Rust bundler (`bundler` feature).
2391#[derive(Debug, Clone, Default, Deserialize)]
2392#[serde(default)]
2393pub struct BundleConfig {
2394 /// Output directory for bundled assets (e.g. `dist`).
2395 #[serde(default = "default_bundle_outdir")]
2396 pub outdir: String,
2397 /// JS/TS entry points bundled by Rolldown (tree-shaken, code-split).
2398 pub js: Vec<String>,
2399 /// CSS entry points bundled by lightningcss (`@import` inlined).
2400 pub css: Vec<String>,
2401 /// Minify output (default true).
2402 #[serde(default = "default_true")]
2403 pub minify: bool,
2404}
2405
2406fn default_bundle_outdir() -> String {
2407 "dist".to_string()
2408}
2409
2410fn default_true() -> bool {
2411 true
2412}
2413
2414#[cfg(test)]
2415mod tests {
2416 use super::*;
2417
2418 fn project(text: &str) -> ProjectConfig {
2419 ron_options().from_str(text).unwrap()
2420 }
2421
2422 fn server(text: &str) -> ServerConfig {
2423 ron_options().from_str(text).unwrap()
2424 }
2425
2426 /// Build an [`EnvSource::Map`] from `(name, value)` pairs for deterministic
2427 /// override tests (no process-global `std::env` mutation).
2428 fn env(pairs: &[(&str, &str)]) -> EnvSource {
2429 EnvSource::Map(
2430 pairs
2431 .iter()
2432 .map(|(k, v)| (k.to_string(), v.to_string()))
2433 .collect(),
2434 )
2435 }
2436
2437 #[test]
2438 fn env_overrides_configure_all_three_sections_with_no_file() {
2439 // The crux of the ask: with NO `boatramp.cfg` at all (the default config),
2440 // env vars alone materialise + populate the compute, security, and handler
2441 // `sql` sections. `ServerConfig::default()` has all three absent.
2442 let mut cfg = ServerConfig::default();
2443 assert!(cfg.compute.is_none() && cfg.security.is_none() && cfg.handlers.is_none());
2444
2445 cfg.apply_env_overrides(&env(&[
2446 ("BOATRAMP_COMPUTE_VCPUS", "8"),
2447 ("BOATRAMP_COMPUTE_MEM_MIB", "4096"),
2448 ("BOATRAMP_COMPUTE_REGION", "eu-central"),
2449 ("BOATRAMP_SECURITY_PROFILE", "single-tenant"),
2450 ("BOATRAMP_SECURITY_ALLOW_SITE_PRIVATE_UPSTREAMS", "true"),
2451 ("BOATRAMP_SECURITY_MAX_UPLOAD_BYTES", "1048576"),
2452 ("BOATRAMP_HANDLERS_SQL_URL", "http://sqld:8080"),
2453 ("BOATRAMP_HANDLERS_SQL_ADMIN_URL", "http://sqld:9090"),
2454 ]))
2455 .expect("valid env overrides apply");
2456
2457 // compute: the section now exists with the env values (and defaults elsewhere).
2458 let compute = cfg.compute.expect("compute materialised from env");
2459 assert_eq!(compute.vcpus, 8);
2460 assert_eq!(compute.mem_mib, 4096);
2461 assert_eq!(compute.region.as_deref(), Some("eu-central"));
2462 assert_eq!(compute.bridge, "br-boatramp"); // untouched default
2463
2464 // security: profile + an override both took, and the posture resolves.
2465 let security = cfg.security.expect("security materialised from env");
2466 assert_eq!(security.profile.as_deref(), Some("single-tenant"));
2467 let posture = security.resolve().expect("resolves");
2468 assert!(posture.allow_site_private_upstreams);
2469 assert_eq!(posture.max_upload_bytes, 1_048_576);
2470
2471 // handler sql: the nested handlers.bindings.sql chain was created.
2472 let sql = cfg
2473 .handlers
2474 .expect("handlers materialised from env")
2475 .bindings
2476 .sql
2477 .expect("sql binding materialised from env");
2478 assert_eq!(sql.url.as_deref(), Some("http://sqld:8080"));
2479 assert_eq!(sql.admin_url.as_deref(), Some("http://sqld:9090"));
2480 }
2481
2482 #[test]
2483 fn internal_dns_defaults_on_with_the_standard_upstream_and_domain() {
2484 // The `[compute]` defaults: internal DNS on, forwarding to 1.1.1.1:53, names
2485 // under `boatramp.internal`.
2486 let compute = ComputeConfig::default();
2487 assert!(compute.internal_dns, "internal DNS is on by default");
2488 assert_eq!(compute.dns_upstream, "1.1.1.1:53");
2489 assert_eq!(compute.dns_domain, "boatramp.internal");
2490 }
2491
2492 #[test]
2493 fn internal_dns_knobs_parse_from_a_file() {
2494 // A file can turn it off and override the upstream + domain.
2495 let cfg = server(
2496 r#"(
2497 compute: ( internal_dns: false, dns_upstream: "10.0.0.53:53", dns_domain: "svc.internal" ),
2498 )"#,
2499 );
2500 let compute = cfg.compute.expect("compute section");
2501 assert!(!compute.internal_dns);
2502 assert_eq!(compute.dns_upstream, "10.0.0.53:53");
2503 assert_eq!(compute.dns_domain, "svc.internal");
2504 }
2505
2506 #[test]
2507 fn internal_dns_knobs_are_env_settable() {
2508 // Env alone materialises `[compute]` and sets each internal-DNS knob (and an
2509 // unrecognised bool spelling is a clear error, exercised by parse_bool).
2510 let mut cfg = ServerConfig::default();
2511 cfg.apply_env_overrides(&env(&[
2512 ("BOATRAMP_COMPUTE_INTERNAL_DNS", "off"),
2513 ("BOATRAMP_COMPUTE_DNS_UPSTREAM", "9.9.9.9:53"),
2514 ("BOATRAMP_COMPUTE_DNS_DOMAIN", "corp.internal"),
2515 ]))
2516 .expect("valid env overrides apply");
2517 let compute = cfg.compute.expect("compute materialised from env");
2518 assert!(!compute.internal_dns, "env `off` disables internal DNS");
2519 assert_eq!(compute.dns_upstream, "9.9.9.9:53");
2520 assert_eq!(compute.dns_domain, "corp.internal");
2521 }
2522
2523 #[test]
2524 fn env_override_wins_over_file_value_but_unset_defers() {
2525 // A file that set each section; env then overrides one field per section
2526 // and leaves the rest of the file value in place (precedence: env > file).
2527 let mut cfg = server(
2528 r#"(
2529 compute: ( vcpus: 2, mem_mib: 512, region: "us-east" ),
2530 security: ( profile: "multi-tenant" ),
2531 handlers: ( bindings: ( sql: ( url: "http://file:8080", admin_url: "http://file:9090" ) ) ),
2532 )"#,
2533 );
2534
2535 cfg.apply_env_overrides(&env(&[
2536 ("BOATRAMP_COMPUTE_VCPUS", "16"),
2537 ("BOATRAMP_SECURITY_PROFILE", "dev"),
2538 ("BOATRAMP_HANDLERS_SQL_URL", "http://env:8080"),
2539 ]))
2540 .expect("valid env overrides apply");
2541
2542 let compute = cfg.compute.unwrap();
2543 assert_eq!(compute.vcpus, 16, "env wins over the file vcpus");
2544 assert_eq!(compute.mem_mib, 512, "unset env defers to the file mem_mib");
2545 assert_eq!(
2546 compute.region.as_deref(),
2547 Some("us-east"),
2548 "unset env defers to the file region"
2549 );
2550
2551 assert_eq!(
2552 cfg.security.unwrap().profile.as_deref(),
2553 Some("dev"),
2554 "env profile wins over the file profile"
2555 );
2556
2557 let sql = cfg.handlers.unwrap().bindings.sql.unwrap();
2558 assert_eq!(
2559 sql.url.as_deref(),
2560 Some("http://env:8080"),
2561 "env wins over the file sql url"
2562 );
2563 assert_eq!(
2564 sql.admin_url.as_deref(),
2565 Some("http://file:9090"),
2566 "unset env defers to the file sql admin_url"
2567 );
2568 }
2569
2570 #[test]
2571 fn env_overrides_leave_unmentioned_sections_absent() {
2572 // With no relevant env vars set, an empty config stays empty — the sections
2573 // are materialised only on demand, so an unset environment adds nothing.
2574 let mut cfg = ServerConfig::default();
2575 cfg.apply_env_overrides(&env(&[("SOME_UNRELATED_VAR", "x")]))
2576 .expect("no-op env applies");
2577 assert!(cfg.compute.is_none());
2578 assert!(cfg.security.is_none());
2579 assert!(cfg.handlers.is_none());
2580 assert!(cfg.secrets.is_none());
2581 assert!(cfg.cluster.is_none());
2582 }
2583
2584 #[test]
2585 fn env_bool_accepts_common_spellings_and_rejects_garbage() {
2586 // Truthy/falsey spellings all parse.
2587 for (raw, want) in [
2588 ("true", true),
2589 ("1", true),
2590 ("YES", true),
2591 ("On", true),
2592 ("false", false),
2593 ("0", false),
2594 ("no", false),
2595 ("OFF", false),
2596 ] {
2597 let mut cfg = ServerConfig::default();
2598 cfg.apply_env_overrides(&env(&[("BOATRAMP_SECURITY_REQUIRE_POP", raw)]))
2599 .expect("boolean parses");
2600 assert_eq!(
2601 cfg.security.unwrap().overrides.require_pop,
2602 Some(want),
2603 "{raw:?} ⇒ {want}"
2604 );
2605 }
2606 // A non-boolean value is a clear error, not a silent default.
2607 let mut cfg = ServerConfig::default();
2608 let err = cfg
2609 .apply_env_overrides(&env(&[("BOATRAMP_SECURITY_REQUIRE_POP", "maybe")]))
2610 .expect_err("garbage boolean is rejected");
2611 match err {
2612 ConfigError::Env { var, .. } => assert_eq!(var, "BOATRAMP_SECURITY_REQUIRE_POP"),
2613 other => panic!("expected ConfigError::Env, got {other:?}"),
2614 }
2615 }
2616
2617 #[test]
2618 fn env_number_parse_error_names_the_variable() {
2619 // A non-numeric numeric var is rejected with the variable named.
2620 let mut cfg = ServerConfig::default();
2621 let err = cfg
2622 .apply_env_overrides(&env(&[("BOATRAMP_COMPUTE_VCPUS", "lots")]))
2623 .expect_err("garbage number is rejected");
2624 match err {
2625 ConfigError::Env { var, .. } => assert_eq!(var, "BOATRAMP_COMPUTE_VCPUS"),
2626 other => panic!("expected ConfigError::Env, got {other:?}"),
2627 }
2628 }
2629
2630 #[test]
2631 fn empty_env_value_is_treated_as_unset() {
2632 // `VAR=` (empty) must not clobber a file value with an empty string.
2633 let mut cfg = server(r#"( compute: ( region: "us-east" ) )"#);
2634 cfg.apply_env_overrides(&env(&[("BOATRAMP_COMPUTE_REGION", "")]))
2635 .expect("empty env applies as a no-op");
2636 assert_eq!(
2637 cfg.compute.unwrap().region.as_deref(),
2638 Some("us-east"),
2639 "an empty env value leaves the file value in place"
2640 );
2641 }
2642
2643 #[test]
2644 fn env_configures_managed_postgres_secrets_and_privilege_with_no_file() {
2645 // The construens acceptance case: with NO `boatramp.cfg` at all, the
2646 // environment alone stands up a managed co-located Postgres. It configures
2647 // the default (`"default"`-named, v0.5.0) database in
2648 // `handlers.bindings.sql.databases` (kind=postgres, compute=pg, database+user
2649 // set), the `[secrets]` envelope (local + a kek path so the managed credential
2650 // can be sealed), and `compute.managed_db_privilege = rootless`. All three
2651 // sections start absent.
2652 let mut cfg = ServerConfig::default();
2653 assert!(cfg.handlers.is_none() && cfg.secrets.is_none() && cfg.compute.is_none());
2654
2655 cfg.apply_env_overrides(&env(&[
2656 // The default database is addressed by the reserved `DEFAULT` token,
2657 // which maps to the reserved real name `"default"` (v0.5.0).
2658 ("BOATRAMP_HANDLERS_SQL_DB_DEFAULT_KIND", "postgres"),
2659 ("BOATRAMP_HANDLERS_SQL_DB_DEFAULT_COMPUTE", "pg"),
2660 ("BOATRAMP_HANDLERS_SQL_DB_DEFAULT_DATABASE", "appdb"),
2661 ("BOATRAMP_HANDLERS_SQL_DB_DEFAULT_USER", "app"),
2662 // Secrets: the local envelope + a KEK path (never key material).
2663 ("BOATRAMP_SECRETS_ENVELOPE", "local"),
2664 ("BOATRAMP_SECRETS_KEK_FILE", "/var/lib/boatramp/secrets/kek"),
2665 // The shared-kernel DB privilege strategy.
2666 ("BOATRAMP_COMPUTE_MANAGED_DB_PRIVILEGE", "rootless"),
2667 ]))
2668 .expect("valid env overrides apply");
2669
2670 // The default (`"default"`-keyed) managed database exists with the right source.
2671 let sql = cfg
2672 .handlers
2673 .expect("handlers materialised from env")
2674 .bindings
2675 .sql
2676 .expect("sql binding materialised from env");
2677 let db = sql
2678 .databases
2679 .get(boatramp_core::project::DEFAULT_DB_NAME)
2680 .expect("the default `default`-named database was created from DEFAULT");
2681 assert!(
2682 !sql.databases.contains_key(""),
2683 "the empty-string key is never produced (v0.5.0)"
2684 );
2685 assert_eq!(db.kind, "postgres");
2686 assert_eq!(db.compute.as_deref(), Some("pg"));
2687 assert_eq!(db.database.as_deref(), Some("appdb"));
2688 assert_eq!(db.user.as_deref(), Some("app"));
2689 // No `password_env` ⇒ boatramp manages the credential (Phase 2), and the
2690 // compute-backed source validates.
2691 assert!(db.password_env.is_none());
2692 assert!(db.is_managed_credential());
2693 assert!(db.validate("").is_ok());
2694
2695 // The secrets envelope + KEK path took (the path is a location, not a key).
2696 let secrets = cfg.secrets.expect("secrets materialised from env");
2697 assert_eq!(secrets.envelope, "local");
2698 assert_eq!(
2699 secrets.kek_file.as_deref(),
2700 Some(Path::new("/var/lib/boatramp/secrets/kek"))
2701 );
2702 assert!(
2703 secrets.vault.is_none(),
2704 "no vault vars ⇒ no vault sub-config"
2705 );
2706
2707 // The managed-DB privilege strategy resolved from its lowercase variant.
2708 let compute = cfg.compute.expect("compute materialised from env");
2709 assert_eq!(compute.managed_db_privilege, ManagedDbPrivilege::Rootless);
2710 }
2711
2712 #[test]
2713 fn env_declares_named_databases_and_merges_over_the_file() {
2714 // A file declares one database; the env overrides one of its fields and
2715 // ADDS a second, discovering both member names from the environment.
2716 let mut cfg = server(
2717 r#"(
2718 handlers: ( bindings: ( sql: (
2719 databases: {
2720 "analytics": ( kind: "postgres", url_env: "FILE_PG_URL", pool_max: 4 ),
2721 },
2722 ) ) ),
2723 )"#,
2724 );
2725 cfg.apply_env_overrides(&env(&[
2726 // Override the file database's pool size (merge by key, per field).
2727 ("BOATRAMP_HANDLERS_SQL_DB_analytics_POOL_MAX", "32"),
2728 // Add a brand-new database whose name has an underscore, exercising the
2729 // longest-suffix name isolation (`_READ_URL_ENV`, not `_URL_ENV`).
2730 ("BOATRAMP_HANDLERS_SQL_DB_events_log_KIND", "mysql"),
2731 ("BOATRAMP_HANDLERS_SQL_DB_events_log_URL_ENV", "EVENTS_URL"),
2732 (
2733 "BOATRAMP_HANDLERS_SQL_DB_events_log_READ_URL_ENV",
2734 "EVENTS_RO_URL",
2735 ),
2736 ("BOATRAMP_HANDLERS_SQL_DB_events_log_READ_ONLY", "true"),
2737 ]))
2738 .expect("valid env overrides apply");
2739
2740 let sql = cfg.handlers.unwrap().bindings.sql.unwrap();
2741 assert_eq!(sql.databases.len(), 2);
2742
2743 let analytics = &sql.databases["analytics"];
2744 assert_eq!(
2745 analytics.pool_max,
2746 Some(32),
2747 "env pool_max wins over the file"
2748 );
2749 assert_eq!(
2750 analytics.url_env, "FILE_PG_URL",
2751 "the file's url_env survives (env didn't touch it)"
2752 );
2753
2754 let events = &sql.databases["events_log"];
2755 assert_eq!(events.kind, "mysql");
2756 assert_eq!(events.url_env, "EVENTS_URL");
2757 assert_eq!(events.read_url_env.as_deref(), Some("EVENTS_RO_URL"));
2758 assert!(events.read_only);
2759 }
2760
2761 #[test]
2762 fn default_token_maps_to_the_reserved_default_name_not_empty() {
2763 // v0.5.0 breaking change: the reserved `DEFAULT` env token maps to the real
2764 // name `"default"` (a valid URL path segment), never the empty string. This is
2765 // what makes the default binding addressable as `--db default` and keeps every
2766 // db-name ingress path-segment-safe.
2767 let mut cfg = ServerConfig::default();
2768 cfg.apply_env_overrides(&env(&[
2769 ("BOATRAMP_HANDLERS_SQL_DB_DEFAULT_KIND", "postgres"),
2770 ("BOATRAMP_HANDLERS_SQL_DB_DEFAULT_URL_ENV", "PG_URL"),
2771 ]))
2772 .expect("valid env overrides apply");
2773 let databases = cfg.handlers.unwrap().bindings.sql.unwrap().databases;
2774 assert!(
2775 databases.contains_key(boatramp_core::project::DEFAULT_DB_NAME),
2776 "DEFAULT → the reserved `default` key"
2777 );
2778 assert!(
2779 !databases.contains_key(""),
2780 "the empty-string key is never produced"
2781 );
2782 }
2783
2784 #[test]
2785 fn empty_string_db_binding_name_is_rejected_with_a_cure() {
2786 // A `boatramp.cfg` that literally writes the legacy empty-string default key
2787 // fails closed on load (it would emit a `//` control-plane path), and the
2788 // error points at the cure (`default`).
2789 let err = ServerConfig::parse(
2790 r#"(
2791 handlers: ( bindings: ( sql: (
2792 databases: {
2793 "": ( kind: "postgres", url_env: "PG_URL" ),
2794 },
2795 ) ) ),
2796 )"#,
2797 )
2798 .expect_err("an empty-string db binding name is refused");
2799 match err {
2800 ConfigError::InvalidDbName { name, reason, cure } => {
2801 assert_eq!(name, "");
2802 assert!(reason.contains("empty"), "reason names the emptiness");
2803 assert!(
2804 cure.contains("default") && cure.contains("CHANGELOG"),
2805 "the cure points at `default` + the CHANGELOG"
2806 );
2807 }
2808 other => panic!("expected ConfigError::InvalidDbName, got {other:?}"),
2809 }
2810 }
2811
2812 #[test]
2813 fn path_separator_db_binding_name_is_rejected() {
2814 // A non-slug name (contains `/`) is refused with the v0.7.0 slug reason and the
2815 // slug cure (pointing at `project doctor`) — NOT the empty-default cure (the fix
2816 // is to rename it to a valid slug, not adopt `default`). Boot-LOUD.
2817 let err = ServerConfig::parse(
2818 r#"(
2819 handlers: ( bindings: ( sql: (
2820 databases: {
2821 "a/b": ( kind: "postgres", url_env: "PG_URL" ),
2822 },
2823 ) ) ),
2824 )"#,
2825 )
2826 .expect_err("a `/`-bearing db binding name is refused");
2827 match err {
2828 ConfigError::InvalidDbName { name, reason, cure } => {
2829 assert_eq!(name, "a/b");
2830 // The v0.7.0 slug reason (a positive statement of the allowlist).
2831 assert!(
2832 reason.contains("valid slug"),
2833 "reason states the slug rule, got {reason:?}"
2834 );
2835 // The slug cure points at `project doctor`, not the empty-default cure.
2836 assert_eq!(cure, boatramp_core::project::INVALID_NAME_CURE);
2837 assert!(!cure.contains("CHANGELOG"), "not the empty-default cure");
2838 }
2839 other => panic!("expected ConfigError::InvalidDbName, got {other:?}"),
2840 }
2841 }
2842
2843 #[test]
2844 fn reserved_bramp_db_compute_prefix_is_rejected() {
2845 // #501 Stage B LOW-2: a static BYO binding may not point `compute` at a
2846 // `bramp-db-…` workload (reserved for derived managed-DB servers) — refused
2847 // fail-closed at config load.
2848 let err = ServerConfig::parse(
2849 r#"(
2850 handlers: ( bindings: ( sql: (
2851 databases: {
2852 "byo": ( kind: "postgres", compute: "bramp-db-acme-app", database: "d", user: "u" ),
2853 },
2854 ) ) ),
2855 )"#,
2856 )
2857 .expect_err("a `bramp-db-` compute workload is refused");
2858 match err {
2859 ConfigError::InvalidDbName { name, reason, cure } => {
2860 assert_eq!(name, "bramp-db-acme-app");
2861 assert!(reason.contains("reserved"), "reason names the reservation");
2862 assert!(cure.contains("bramp-db-"), "the cure names the prefix");
2863 }
2864 other => panic!("expected ConfigError::InvalidDbName, got {other:?}"),
2865 }
2866 // A NON-reserved compute workload for a BYO binding still loads fine.
2867 ServerConfig::parse(
2868 r#"(
2869 handlers: ( bindings: ( sql: (
2870 databases: {
2871 "byo": ( kind: "postgres", compute: "my-pg", database: "d", user: "u" ),
2872 },
2873 ) ) ),
2874 )"#,
2875 )
2876 .expect("a non-reserved compute workload loads");
2877 }
2878
2879 #[test]
2880 fn env_sets_managed_db_startup_grace() {
2881 // The per-binding startup-grace override is env-settable like the other
2882 // managed scalars, discovered by the `_STARTUP_GRACE_SECS` suffix.
2883 let mut cfg = ServerConfig::default();
2884 cfg.apply_env_overrides(&env(&[
2885 ("BOATRAMP_HANDLERS_SQL_DB_DEFAULT_KIND", "postgres"),
2886 ("BOATRAMP_HANDLERS_SQL_DB_DEFAULT_COMPUTE", "pg"),
2887 ("BOATRAMP_HANDLERS_SQL_DB_DEFAULT_DATABASE", "appdb"),
2888 ("BOATRAMP_HANDLERS_SQL_DB_DEFAULT_USER", "app"),
2889 ("BOATRAMP_HANDLERS_SQL_DB_DEFAULT_STARTUP_GRACE_SECS", "90"),
2890 ]))
2891 .expect("valid env overrides apply");
2892 let db = &cfg.handlers.unwrap().bindings.sql.unwrap().databases
2893 [boatramp_core::project::DEFAULT_DB_NAME];
2894 assert_eq!(db.startup_grace_secs, Some(90));
2895 }
2896
2897 #[test]
2898 fn env_sets_rls_gucs_and_all_marker_without_suffix_collision() {
2899 // The RLS GUC names + the v0.4.21 all-read marker are env-settable. `_TENANT_ALL_MARKER`
2900 // and `_TENANT_GUC` must NOT be shadowed by the shorter `_TENANT` suffix (longest-first
2901 // isolation) — a `_TENANT` value would otherwise swallow the DB-name split.
2902 let mut cfg = ServerConfig::default();
2903 cfg.apply_env_overrides(&env(&[
2904 ("BOATRAMP_HANDLERS_SQL_DB_DEFAULT_KIND", "postgres"),
2905 ("BOATRAMP_HANDLERS_SQL_DB_DEFAULT_DATABASE", "appdb"),
2906 (
2907 "BOATRAMP_HANDLERS_SQL_DB_DEFAULT_TENANT_GUC",
2908 "app.tenant_id",
2909 ),
2910 (
2911 "BOATRAMP_HANDLERS_SQL_DB_DEFAULT_SESSION_GUC",
2912 "app.session_id",
2913 ),
2914 ("BOATRAMP_HANDLERS_SQL_DB_DEFAULT_TENANT_ALL_MARKER", "*"),
2915 ]))
2916 .expect("valid env overrides apply");
2917 let db = &cfg.handlers.unwrap().bindings.sql.unwrap().databases
2918 [boatramp_core::project::DEFAULT_DB_NAME];
2919 assert_eq!(db.tenant_guc.as_deref(), Some("app.tenant_id"));
2920 assert_eq!(db.session_guc.as_deref(), Some("app.session_id"));
2921 assert_eq!(db.tenant_all_marker.as_deref(), Some("*"));
2922 }
2923
2924 #[test]
2925 fn env_enum_parse_error_names_the_variable_and_variants() {
2926 // An unknown enum value is a clear error that names the offending variable.
2927 let mut cfg = ServerConfig::default();
2928 let err = cfg
2929 .apply_env_overrides(&env(&[(
2930 "BOATRAMP_COMPUTE_MANAGED_DB_PRIVILEGE",
2931 "superuser",
2932 )]))
2933 .expect_err("unknown enum variant is rejected");
2934 match err {
2935 ConfigError::Env { var, reason } => {
2936 assert_eq!(var, "BOATRAMP_COMPUTE_MANAGED_DB_PRIVILEGE");
2937 assert!(reason.contains("rootless") && reason.contains("caps"));
2938 }
2939 other => panic!("expected ConfigError::Env, got {other:?}"),
2940 }
2941 // The docker enums map their lowercase serde variants too.
2942 let mut cfg = ServerConfig::default();
2943 cfg.apply_env_overrides(&env(&[
2944 ("BOATRAMP_COMPUTE_DOCKER_ENDPOINT", "bridge"),
2945 ("BOATRAMP_COMPUTE_DOCKER_VOLUME_MODE", "bind"),
2946 ]))
2947 .expect("known enum variants parse");
2948 let compute = cfg.compute.unwrap();
2949 assert_eq!(
2950 compute.docker_endpoint,
2951 boatramp_docker::DockerEndpoint::Bridge
2952 );
2953 assert_eq!(
2954 compute.docker_volume_mode,
2955 boatramp_docker::DockerVolumeMode::Bind
2956 );
2957 }
2958
2959 #[test]
2960 fn env_trust_anchors_parse_as_a_comma_separated_list() {
2961 // The kernel trust anchors are comma-separated (whitespace trimmed, empty
2962 // items dropped so a trailing comma is tolerated). A file default is
2963 // fully replaced, not appended to.
2964 let mut cfg = ServerConfig::default();
2965 cfg.apply_env_overrides(&env(&[
2966 (
2967 "BOATRAMP_COMPUTE_KERNEL_SIGNING_PUBKEYS",
2968 " es256:aa , es256:bb ,",
2969 ),
2970 ("BOATRAMP_COMPUTE_KERNEL_ALLOWED_HASHES", "deadbeef"),
2971 ]))
2972 .expect("valid list env applies");
2973 let compute = cfg.compute.unwrap();
2974 assert_eq!(
2975 compute.kernel_signing_pubkeys,
2976 vec!["es256:aa".to_string(), "es256:bb".to_string()],
2977 "trimmed, comma-split, trailing-empty dropped, defaults replaced"
2978 );
2979 assert_eq!(
2980 compute.kernel_allowed_hashes,
2981 vec!["deadbeef".to_string()],
2982 "a single value is a one-element list"
2983 );
2984 }
2985
2986 #[test]
2987 fn env_configures_secrets_vault_subconfig() {
2988 // The vault sub-config materialises only when a vault var is set, and the
2989 // token stays indirected via a variable NAME (`token_env`), never inline.
2990 let mut cfg = ServerConfig::default();
2991 cfg.apply_env_overrides(&env(&[
2992 ("BOATRAMP_SECRETS_ENVELOPE", "vault"),
2993 ("BOATRAMP_SECRETS_VAULT_ADDR", "https://vault:8200"),
2994 ("BOATRAMP_SECRETS_VAULT_KEY", "certs"),
2995 ]))
2996 .expect("valid env overrides apply");
2997 let secrets = cfg.secrets.unwrap();
2998 assert_eq!(secrets.envelope, "vault");
2999 let vault = secrets.vault.expect("vault sub-config materialised");
3000 assert_eq!(vault.addr, "https://vault:8200");
3001 assert_eq!(vault.key, "certs");
3002 // token_env defaults to VAULT_TOKEN when not overridden.
3003 assert_eq!(vault.token_env, "VAULT_TOKEN");
3004 }
3005
3006 #[test]
3007 fn env_materialises_and_overrides_the_cluster_section() {
3008 // With no file, a `BOATRAMP_CLUSTER_LISTEN` materialises the section; the
3009 // remaining fields (lists, join token, mesh) layer on. The founding/joining
3010 // action flags (`BOATRAMP_CLUSTER_INIT`/`_JOIN`) are separate `serve` args
3011 // and are not part of this section.
3012 let mut cfg = ServerConfig::default();
3013 cfg.apply_env_overrides(&env(&[
3014 ("BOATRAMP_CLUSTER_LISTEN", "10.0.0.2:7000"),
3015 ("BOATRAMP_CLUSTER_ROOT_PUBKEYS", "es256:aa,es256:bb"),
3016 ("BOATRAMP_CLUSTER_SEEDS", "https://10.0.0.1:8080"),
3017 ("BOATRAMP_CLUSTER_JOIN_TOKEN", "env:BOATRAMP_JOIN_TOKEN"),
3018 ("BOATRAMP_CLUSTER_STORE_DIR", "/var/lib/boatramp/raft"),
3019 ("BOATRAMP_CLUSTER_MESH_GATE_CLIENT_WRITES", "true"),
3020 ]))
3021 .expect("valid env overrides apply");
3022 let cluster = cfg.cluster.expect("cluster materialised from env");
3023 assert_eq!(
3024 cluster.listen,
3025 "10.0.0.2:7000".parse::<std::net::SocketAddr>().unwrap()
3026 );
3027 assert_eq!(
3028 cluster.root_pubkeys,
3029 vec!["es256:aa".to_string(), "es256:bb".to_string()]
3030 );
3031 assert_eq!(cluster.seeds, vec!["https://10.0.0.1:8080".to_string()]);
3032 assert_eq!(
3033 cluster.join_token.as_deref(),
3034 Some("env:BOATRAMP_JOIN_TOKEN")
3035 );
3036 assert_eq!(
3037 cluster.store_dir.as_deref(),
3038 Some(Path::new("/var/lib/boatramp/raft"))
3039 );
3040 assert_eq!(
3041 cluster.mesh.expect("mesh sub-config").gate_client_writes,
3042 Some(true)
3043 );
3044
3045 // Without a listen (and no file section) there is nothing to materialise:
3046 // a non-listen cluster var alone leaves the section absent.
3047 let mut cfg = ServerConfig::default();
3048 cfg.apply_env_overrides(&env(&[("BOATRAMP_CLUSTER_SEEDS", "https://10.0.0.1:8080")]))
3049 .expect("applies");
3050 assert!(
3051 cfg.cluster.is_none(),
3052 "no listen + no file section ⇒ no cluster"
3053 );
3054 }
3055
3056 #[test]
3057 fn env_cluster_listen_overrides_a_file_section() {
3058 // A file `[cluster]` section: env overrides `listen` and adds seeds.
3059 let mut cfg = server(r#"( cluster: ( listen: "0.0.0.0:7000" ) )"#);
3060 cfg.apply_env_overrides(&env(&[
3061 ("BOATRAMP_CLUSTER_LISTEN", "10.0.0.9:7000"),
3062 ("BOATRAMP_CLUSTER_SEEDS", "https://seed:8080"),
3063 ]))
3064 .expect("applies");
3065 let cluster = cfg.cluster.unwrap();
3066 assert_eq!(
3067 cluster.listen,
3068 "10.0.0.9:7000".parse::<std::net::SocketAddr>().unwrap(),
3069 "env listen wins over the file"
3070 );
3071 assert_eq!(cluster.seeds, vec!["https://seed:8080".to_string()]);
3072 }
3073
3074 #[test]
3075 fn empty_project_config_is_default() {
3076 let cfg = project("()");
3077 assert!(cfg.publish.server.is_none());
3078 assert!(cfg.publish.site.is_none());
3079 assert!(cfg.build.is_none());
3080 assert!(cfg.bundle.is_none());
3081 // Routing defaults: schema v1, the single default index candidate.
3082 assert_eq!(cfg.routing.version, 1);
3083 assert_eq!(cfg.routing.index, vec!["index.html".to_string()]);
3084 }
3085
3086 #[test]
3087 fn serve_signer_config_parses_and_maps_each_backend() {
3088 use boatramp_core::cose::TokenAlg;
3089 use boatramp_server::signer::SignerConfig;
3090
3091 // RON-native enum tagging (`Vault(...)`); `IMPLICIT_SOME` lets the optional
3092 // fields (region) take a bare value or be omitted (→ None). This is the
3093 // exact RON documented in the Authentication guide.
3094 let vault = server(
3095 r#"( serve: ( signer: Vault(
3096 address: "https://vault.example:8200",
3097 key: "boatramp-root",
3098 token_env: "VAULT_TOKEN",
3099 alg: Ed25519,
3100 ) ) )"#,
3101 );
3102 match vault.serve.unwrap().signer.unwrap().to_signer_config() {
3103 SignerConfig::Vault {
3104 address,
3105 key,
3106 token_env,
3107 alg,
3108 } => {
3109 assert_eq!(address, "https://vault.example:8200");
3110 assert_eq!(key, "boatramp-root");
3111 assert_eq!(token_env, "VAULT_TOKEN");
3112 assert_eq!(alg, TokenAlg::Ed25519);
3113 }
3114 other => panic!("expected Vault, got {other:?}"),
3115 }
3116
3117 // AWS KMS: region omitted → None; PKCS#11: alg omitted → the ES256 default.
3118 let aws =
3119 server(r#"( serve: ( signer: AwsKms(key_id: "arn:aws:kms:eu-west-1:1:key/abc") ) )"#);
3120 assert!(matches!(
3121 aws.serve.unwrap().signer.unwrap().to_signer_config(),
3122 SignerConfig::AwsKms { region: None, .. }
3123 ));
3124
3125 let hsm = server(
3126 r#"( serve: ( signer: Pkcs11(
3127 module: "/usr/lib/softhsm/libsofthsm2.so",
3128 token_label: "boatramp",
3129 key_label: "root",
3130 pin_env: "HSM_PIN",
3131 ) ) )"#,
3132 );
3133 match hsm.serve.unwrap().signer.unwrap().to_signer_config() {
3134 SignerConfig::Pkcs11 { alg, .. } => assert_eq!(alg, TokenAlg::Es256),
3135 other => panic!("expected Pkcs11, got {other:?}"),
3136 }
3137 }
3138
3139 #[test]
3140 fn project_config_parses_publish_build_and_routing() {
3141 let cfg = project(
3142 r#"(
3143 publish: ( server: "http://127.0.0.1:8080", site: "demo" ),
3144 build: ( command: "npm run build", output: "dist" ),
3145 routing: (
3146 clean_urls: true,
3147 redirects: [ (from: "/old/:slug", to: "/new/:slug", status: 301) ],
3148 ),
3149 )"#,
3150 );
3151 assert_eq!(cfg.publish.server.as_deref(), Some("http://127.0.0.1:8080"));
3152 assert_eq!(cfg.publish.site.as_deref(), Some("demo"));
3153 let build = cfg.build.unwrap();
3154 assert_eq!(build.command, "npm run build");
3155 assert_eq!(build.output.as_deref(), Some("dist"));
3156 assert!(cfg.routing.clean_urls);
3157 assert_eq!(cfg.routing.redirects.len(), 1);
3158 assert_eq!(cfg.routing.redirects[0].status, 301);
3159 }
3160
3161 #[test]
3162 fn project_config_rejects_bad_routing_pattern() {
3163 // The same compile-check `load` runs: a bad route pattern is an error.
3164 let cfg = project(r#"( routing: ( redirects: [ (from: "/a/**/b/**", to: "/x") ] ) )"#);
3165 assert!(cfg.routing.compile_check().is_err());
3166 }
3167
3168 #[test]
3169 fn empty_server_config_has_no_sections() {
3170 let cfg = server("()");
3171 assert!(cfg.serve.is_none());
3172 assert!(cfg.handlers.is_none());
3173 assert!(cfg.cluster.is_none());
3174 assert!(cfg.security.is_none());
3175 }
3176
3177 #[test]
3178 fn security_section_parses_and_resolves() {
3179 // A profile plus an override that wins over it.
3180 let cfg = server(
3181 r#"(
3182 security: (
3183 profile: "dev",
3184 overrides: (
3185 oidc_require_audience: true,
3186 max_upload_bytes: 0,
3187 ),
3188 )
3189 )"#,
3190 );
3191 let posture = cfg.security.unwrap().resolve().expect("resolves");
3192 // `dev` is loose...
3193 assert!(posture.allow_unauthenticated_public_bind);
3194 // ...but the explicit override wins over the profile.
3195 assert!(posture.oidc_require_audience);
3196 assert_eq!(posture.max_upload_bytes, 0); // unlimited
3197 }
3198
3199 #[test]
3200 fn env_wires_allow_env_secret_refs_over_the_multi_tenant_default() {
3201 // With no file, the multi-tenant default leaves host-env secret refs off;
3202 // the env knob re-enables them (env > default), same as the other posture bools.
3203 let mut cfg = ServerConfig::default();
3204 cfg.apply_env_overrides(&env(&[("BOATRAMP_SECURITY_ALLOW_ENV_SECRET_REFS", "true")]))
3205 .expect("valid env override applies");
3206 let posture = cfg
3207 .security
3208 .expect("security materialised from env")
3209 .resolve()
3210 .expect("resolves");
3211 assert!(posture.allow_env_secret_refs);
3212 }
3213
3214 #[test]
3215 fn env_wires_the_multi_tenant_subknobs_over_the_default() {
3216 // Gap 4b: the four multi-tenant sub-knobs were file-only; env now sets them (env > the
3217 // multi-tenant preset default), so a 12-factor deploy can tune tenancy isolation + guest
3218 // capability minting with no `boatramp.cfg`. Verified: strict declaration stays on while
3219 // cross-tenant `all` twins + guest cap-mint are permitted (they compose — Gap 4.3).
3220 let mut cfg = ServerConfig::default();
3221 cfg.apply_env_overrides(&env(&[
3222 ("BOATRAMP_SECURITY_PROFILE", "multi-tenant"),
3223 ("BOATRAMP_SECURITY_REQUIRE_TENANCY_DECLARATION", "true"),
3224 ("BOATRAMP_SECURITY_ALLOW_CROSS_TENANT_DB", "true"),
3225 ("BOATRAMP_SECURITY_ALLOW_GUEST_MINT_CAPABILITY", "true"),
3226 ("BOATRAMP_SECURITY_MAX_GUEST_CAPABILITY_TTL_SECS", "1800"),
3227 ]))
3228 .expect("valid env overrides apply");
3229 let posture = cfg
3230 .security
3231 .expect("security materialised from env")
3232 .resolve()
3233 .expect("resolves");
3234 assert!(posture.require_tenancy_declaration);
3235 assert!(posture.allow_cross_tenant_db);
3236 assert!(posture.allow_guest_mint_capability);
3237 assert_eq!(posture.max_guest_capability_ttl_secs, 1800);
3238 }
3239
3240 #[test]
3241 fn env_wires_the_remaining_guest_feature_knobs_over_the_multi_tenant_default() {
3242 // v0.4.18 env parity: `allow_guest_email` (which regressed prod SMTP on the P48 cutover —
3243 // multi-tenant defaults it OFF and there was no env lever), its egress sibling
3244 // `allow_guest_egress_extra_ca` (shipped config-only in v0.4.17), and the four
3245 // `allow_guest_admin_*` self-config knobs were all missing from the env map. Each preset
3246 // defaults them OFF under `multi-tenant`; the env knob must now flip each back on for a
3247 // 12-factor env-only fleet, exactly like `allow_guest_mint_capability`.
3248 let mut cfg = ServerConfig::default();
3249 cfg.apply_env_overrides(&env(&[
3250 ("BOATRAMP_SECURITY_PROFILE", "multi-tenant"),
3251 ("BOATRAMP_SECURITY_ALLOW_GUEST_EMAIL", "true"),
3252 ("BOATRAMP_SECURITY_ALLOW_GUEST_EGRESS_EXTRA_CA", "true"),
3253 ("BOATRAMP_SECURITY_ALLOW_GUEST_ADMIN_DOMAINS", "true"),
3254 ("BOATRAMP_SECURITY_ALLOW_GUEST_ADMIN_EMAIL", "true"),
3255 ("BOATRAMP_SECURITY_ALLOW_GUEST_ADMIN_SITE", "true"),
3256 ("BOATRAMP_SECURITY_ALLOW_GUEST_ADMIN_SECRETS", "true"),
3257 ]))
3258 .expect("valid env overrides apply");
3259 let security = cfg.security.expect("security materialised from env");
3260 let posture = security.resolve().expect("resolves");
3261 // Every one flips on over the multi-tenant preset default (which is `false` for all six).
3262 assert!(posture.allow_guest_email, "guest email re-enabled via env");
3263 assert!(posture.allow_guest_egress_extra_ca);
3264 assert!(posture.allow_guest_admin_domains);
3265 assert!(posture.allow_guest_admin_email);
3266 assert!(posture.allow_guest_admin_site);
3267 assert!(posture.allow_guest_admin_secrets);
3268 // `security explain` attributes each to the override/env source (not the profile preset).
3269 let explained = security.explain().expect("explains");
3270 for knob in [
3271 "allow_guest_email",
3272 "allow_guest_egress_extra_ca",
3273 "allow_guest_admin_domains",
3274 "allow_guest_admin_email",
3275 "allow_guest_admin_site",
3276 "allow_guest_admin_secrets",
3277 ] {
3278 assert!(
3279 explained
3280 .lines()
3281 .any(|l| l.contains(knob) && l.contains("true") && l.contains("(override)")),
3282 "explain shows {knob} = true (override): \n{explained}"
3283 );
3284 }
3285 }
3286
3287 #[test]
3288 fn each_guest_feature_env_var_moves_its_own_posture_field() {
3289 // Cross-wiring guard: set each of the six guest-feature vars ALONE over the multi-tenant
3290 // default and assert THAT var's own resolved field flips — so a copy-paste arm mapping a var
3291 // to the wrong field (or an unregistered var that never materialises the section) fails here.
3292 // Complements `every_posture_override_field_has_an_env_mapping` below (which proves coverage
3293 // by field name but not that each arm targets the right field).
3294 for (var, check) in [
3295 (
3296 "BOATRAMP_SECURITY_ALLOW_GUEST_EMAIL",
3297 (|p: &boatramp_core::security::SecurityPosture| p.allow_guest_email)
3298 as fn(&boatramp_core::security::SecurityPosture) -> bool,
3299 ),
3300 ("BOATRAMP_SECURITY_ALLOW_GUEST_EGRESS_EXTRA_CA", |p| {
3301 p.allow_guest_egress_extra_ca
3302 }),
3303 ("BOATRAMP_SECURITY_ALLOW_GUEST_ADMIN_DOMAINS", |p| {
3304 p.allow_guest_admin_domains
3305 }),
3306 ("BOATRAMP_SECURITY_ALLOW_GUEST_ADMIN_EMAIL", |p| {
3307 p.allow_guest_admin_email
3308 }),
3309 ("BOATRAMP_SECURITY_ALLOW_GUEST_ADMIN_SITE", |p| {
3310 p.allow_guest_admin_site
3311 }),
3312 ("BOATRAMP_SECURITY_ALLOW_GUEST_ADMIN_SECRETS", |p| {
3313 p.allow_guest_admin_secrets
3314 }),
3315 ] {
3316 let mut cfg = ServerConfig::default();
3317 cfg.apply_env_overrides(&env(&[
3318 ("BOATRAMP_SECURITY_PROFILE", "multi-tenant"),
3319 (var, "true"),
3320 ]))
3321 .unwrap_or_else(|e| panic!("{var} applies: {e}"));
3322 let posture = cfg
3323 .security
3324 .unwrap_or_else(|| panic!("{var} materialises the security section"))
3325 .resolve()
3326 .expect("resolves");
3327 assert!(check(&posture), "{var} did not flip the resolved posture");
3328 }
3329 }
3330
3331 #[test]
3332 fn every_posture_override_field_has_an_env_mapping() {
3333 // Exhaustive guard against the EXACT class of gap v0.4.18 closes — a `PostureOverrides`
3334 // field a 12-factor fleet can set in `[security.overrides]` but NOT via env — for EVERY
3335 // field, now and in the future. Enumerate the struct's fields structurally (serialize a
3336 // default instance; every field renders as a key) and assert each maps to a registered
3337 // `BOATRAMP_SECURITY_<UPPER(field)>` in `SECURITY_ENV_VARS`. A new override field added
3338 // without an env var (or a var left out of the registry) fails here — so the omission that
3339 // regressed `allow_guest_email` can't silently recur. The registry entry is load-bearing:
3340 // `apply_env_overrides` only materialises the section when `source.any(SECURITY_ENV_VARS)`.
3341 let all = serde_json::to_value(boatramp_core::security::PostureOverrides::default())
3342 .expect("PostureOverrides serializes");
3343 let fields = all.as_object().expect("a struct is a JSON object");
3344 assert!(!fields.is_empty(), "expected some override fields");
3345 for field in fields.keys() {
3346 let var = format!("BOATRAMP_SECURITY_{}", field.to_uppercase());
3347 assert!(
3348 SECURITY_ENV_VARS.contains(&var.as_str()),
3349 "PostureOverrides field `{field}` has no env mapping — add `{var}` to \
3350 SECURITY_ENV_VARS + an arm in apply_env_overrides (the v0.4.18 forgot-a-knob guard)"
3351 );
3352 }
3353 }
3354
3355 #[test]
3356 fn cluster_section_parses_the_dynamic_join_shape() {
3357 let cfg = server(
3358 r#"(
3359 cluster: (
3360 listen: "10.0.0.2:7000",
3361 root_pubkeys: ["es256:03a1"],
3362 seeds: ["https://10.0.0.1:8080"],
3363 join_token: "env:BOATRAMP_JOIN_TOKEN",
3364 ),
3365 )"#,
3366 );
3367 let cluster = cfg.cluster.unwrap();
3368 assert_eq!(
3369 cluster.listen,
3370 "10.0.0.2:7000".parse::<std::net::SocketAddr>().unwrap()
3371 );
3372 assert_eq!(cluster.root_pubkeys, vec!["es256:03a1".to_string()]);
3373 assert_eq!(cluster.seeds, vec!["https://10.0.0.1:8080".to_string()]);
3374 assert_eq!(
3375 cluster.join_token.as_deref(),
3376 Some("env:BOATRAMP_JOIN_TOKEN")
3377 );
3378 // store_dir defaults to None (→ <data-dir>/raft at serve time).
3379 assert!(cluster.store_dir.is_none());
3380 }
3381
3382 #[test]
3383 fn cluster_section_founds_with_just_a_listen_addr() {
3384 // A founder needs no seeds/token — just where to bind the mesh.
3385 let cfg = server(r#"( cluster: ( listen: "0.0.0.0:7000" ) )"#);
3386 let cluster = cfg.cluster.unwrap();
3387 assert!(cluster.seeds.is_empty());
3388 assert!(cluster.root_pubkeys.is_empty());
3389 assert!(cluster.join_token.is_none());
3390 }
3391
3392 #[test]
3393 fn sql_binding_single_node_defaults() {
3394 // A bare section (or none) means single-node: no url, default dir.
3395 let cfg = server(r#"( handlers: ( bindings: ( sql: () ) ) )"#);
3396 let sql = cfg.handlers.unwrap().bindings.sql.unwrap();
3397 assert!(sql.url.is_none());
3398 assert!(sql.dir.is_none());
3399 }
3400
3401 #[test]
3402 fn sql_binding_single_node_custom_dir() {
3403 let cfg =
3404 server(r#"( handlers: ( bindings: ( sql: ( dir: "/var/lib/boatramp/sql" ) ) ) )"#);
3405 let sql = cfg.handlers.unwrap().bindings.sql.unwrap();
3406 assert_eq!(sql.dir.as_deref(), Some(Path::new("/var/lib/boatramp/sql")));
3407 assert!(sql.url.is_none());
3408 }
3409
3410 #[test]
3411 fn sql_binding_cluster() {
3412 let cfg = server(
3413 r#"(
3414 handlers: ( bindings: ( sql: (
3415 url: "http://sqld:8080",
3416 admin_url: "http://sqld:9090",
3417 token_env: "BOATRAMP_SQL_TOKEN",
3418 ) ) ),
3419 )"#,
3420 );
3421 let sql = cfg.handlers.unwrap().bindings.sql.unwrap();
3422 assert_eq!(sql.url.as_deref(), Some("http://sqld:8080"));
3423 assert_eq!(sql.admin_url.as_deref(), Some("http://sqld:9090"));
3424 assert_eq!(sql.token_env.as_deref(), Some("BOATRAMP_SQL_TOKEN"));
3425 assert_eq!(sql.admin_token_env, None);
3426 }
3427
3428 #[test]
3429 fn sql_binding_preview_policy() {
3430 let cfg = server(
3431 r#"(
3432 handlers: ( bindings: ( sql: (
3433 preview_mode: "branch",
3434 preview_init: "/etc/boatramp/seed.sql",
3435 ) ) ),
3436 )"#,
3437 );
3438 let sql = cfg.handlers.unwrap().bindings.sql.unwrap();
3439 assert_eq!(sql.preview_mode.as_deref(), Some("branch"));
3440 assert_eq!(
3441 sql.preview_init.as_deref(),
3442 Some(Path::new("/etc/boatramp/seed.sql"))
3443 );
3444 }
3445
3446 #[test]
3447 fn sql_binding_external_databases() {
3448 let cfg = server(
3449 r#"(
3450 handlers: ( bindings: ( sql: (
3451 databases: {
3452 "analytics": (
3453 kind: "postgres",
3454 url_env: "ANALYTICS_PG_URL",
3455 pool_max: 16,
3456 read_only: true,
3457 ),
3458 "events": (
3459 kind: "mysql",
3460 url_env: "EVENTS_MYSQL_URL",
3461 read_url_env: "EVENTS_MYSQL_REPLICA_URL",
3462 allow_preview: true,
3463 ),
3464 },
3465 ) ) ),
3466 )"#,
3467 );
3468 let sql = cfg.handlers.unwrap().bindings.sql.unwrap();
3469 assert_eq!(sql.databases.len(), 2);
3470
3471 let analytics = &sql.databases["analytics"];
3472 assert_eq!(analytics.kind, "postgres");
3473 assert_eq!(analytics.url_env, "ANALYTICS_PG_URL");
3474 assert_eq!(analytics.pool_max, Some(16));
3475 assert!(analytics.read_only);
3476 assert!(!analytics.allow_preview);
3477 assert!(analytics.read_url_env.is_none());
3478
3479 let events = &sql.databases["events"];
3480 assert_eq!(events.kind, "mysql");
3481 assert_eq!(
3482 events.read_url_env.as_deref(),
3483 Some("EVENTS_MYSQL_REPLICA_URL")
3484 );
3485 assert!(events.allow_preview);
3486 assert!(!events.read_only);
3487 }
3488
3489 #[test]
3490 fn sql_binding_compute_backed_database() {
3491 let cfg = server(
3492 r#"(
3493 handlers: ( bindings: ( sql: (
3494 databases: {
3495 "analytics": (
3496 kind: "postgres",
3497 compute: "pg",
3498 database: "analytics",
3499 user: "app",
3500 password_env: "PG_APP_PW",
3501 ),
3502 },
3503 ) ) ),
3504 )"#,
3505 );
3506 let db = &cfg.handlers.unwrap().bindings.sql.unwrap().databases["analytics"];
3507 assert_eq!(db.kind, "postgres");
3508 assert_eq!(db.compute.as_deref(), Some("pg"));
3509 assert_eq!(db.database.as_deref(), Some("analytics"));
3510 assert_eq!(db.user.as_deref(), Some("app"));
3511 assert_eq!(db.password_env.as_deref(), Some("PG_APP_PW"));
3512 assert!(db.url_env.is_empty(), "compute-backed has no url_env");
3513 assert!(db.validate("analytics").is_ok());
3514 }
3515
3516 #[test]
3517 fn sql_binding_source_is_exactly_one_of_url_or_compute() {
3518 // Neither source → error.
3519 assert!(ExternalDatabaseConfig::default().validate("db").is_err());
3520 // Both sources → error.
3521 let both = ExternalDatabaseConfig {
3522 kind: "postgres".into(),
3523 url_env: "PG_URL".into(),
3524 compute: Some("pg".into()),
3525 ..Default::default()
3526 };
3527 assert!(both.validate("db").is_err());
3528 // `url_env` only → ok.
3529 let url = ExternalDatabaseConfig {
3530 kind: "postgres".into(),
3531 url_env: "PG_URL".into(),
3532 ..Default::default()
3533 };
3534 assert!(url.validate("db").is_ok());
3535 // `compute` without the connection details boatramp can't infer → error.
3536 let bare = ExternalDatabaseConfig {
3537 kind: "postgres".into(),
3538 compute: Some("pg".into()),
3539 ..Default::default()
3540 };
3541 assert!(bare.validate("db").is_err());
3542 // `compute` with database/user + a bring-your-own `password_env` → ok, and
3543 // is *not* a managed credential.
3544 let byo = ExternalDatabaseConfig {
3545 kind: "postgres".into(),
3546 compute: Some("pg".into()),
3547 database: Some("analytics".into()),
3548 user: Some("app".into()),
3549 password_env: Some("PG_APP_PW".into()),
3550 ..Default::default()
3551 };
3552 assert!(byo.validate("db").is_ok());
3553 assert!(!byo.is_managed_credential());
3554 // `compute` with database/user but NO `password_env` → ok, and boatramp
3555 // manages the credential (Phase 2).
3556 let managed = ExternalDatabaseConfig {
3557 kind: "postgres".into(),
3558 compute: Some("pg".into()),
3559 database: Some("analytics".into()),
3560 user: Some("app".into()),
3561 ..Default::default()
3562 };
3563 assert!(managed.validate("db").is_ok());
3564 assert!(managed.is_managed_credential());
3565 }
3566
3567 #[test]
3568 fn libsql_source_is_exactly_one_of_path_or_url() {
3569 // A single-node `libsql` file (path only) → ok.
3570 let file = ExternalDatabaseConfig {
3571 kind: "libsql".into(),
3572 path: Some("/data/app.db".into()),
3573 ..Default::default()
3574 };
3575 assert!(file.validate("app").is_ok());
3576 // `sqlite` alias works the same.
3577 let sqlite = ExternalDatabaseConfig {
3578 kind: "sqlite".into(),
3579 path: Some("/data/app.db".into()),
3580 ..Default::default()
3581 };
3582 assert!(sqlite.validate("app").is_ok());
3583 // A remote-sqld `libsql` (url_env only) → ok.
3584 let remote = ExternalDatabaseConfig {
3585 kind: "libsql".into(),
3586 url_env: "LIBSQL_URL".into(),
3587 ..Default::default()
3588 };
3589 assert!(remote.validate("app").is_ok());
3590 // Neither `path` nor `url_env` → error.
3591 let neither = ExternalDatabaseConfig {
3592 kind: "libsql".into(),
3593 ..Default::default()
3594 };
3595 assert!(neither.validate("app").is_err());
3596 // Both `path` and `url_env` → error (exactly one).
3597 let both = ExternalDatabaseConfig {
3598 kind: "libsql".into(),
3599 path: Some("/data/app.db".into()),
3600 url_env: "LIBSQL_URL".into(),
3601 ..Default::default()
3602 };
3603 assert!(both.validate("app").is_err());
3604 // `compute` on a `libsql` binding → error (boatramp doesn't run a libsql server workload).
3605 let compute = ExternalDatabaseConfig {
3606 kind: "libsql".into(),
3607 compute: Some("x".into()),
3608 path: Some("/data/app.db".into()),
3609 ..Default::default()
3610 };
3611 assert!(compute.validate("app").is_err());
3612 // `path` on a NON-libsql (postgres) binding → error (only libsql has an on-disk file).
3613 let pg_path = ExternalDatabaseConfig {
3614 kind: "postgres".into(),
3615 url_env: "PG_URL".into(),
3616 path: Some("/data/app.db".into()),
3617 ..Default::default()
3618 };
3619 assert!(pg_path.validate("db").is_err());
3620 }
3621
3622 /// Path to a file at the repo root (two levels up from this crate).
3623 fn repo_root_file(name: &str) -> PathBuf {
3624 Path::new(env!("CARGO_MANIFEST_DIR"))
3625 .join("../..")
3626 .join(name)
3627 }
3628
3629 #[test]
3630 fn shipped_project_example_parses() {
3631 // The example we ship must always parse + compile-check, so it can't drift
3632 // from the schema.
3633 let text = std::fs::read_to_string(repo_root_file("examples/site/project.cfg.example"))
3634 .expect("example project config is present");
3635 let cfg = ProjectConfig::parse(&text).expect("example project config parses");
3636 assert_eq!(cfg.publish.server.as_deref(), Some("http://127.0.0.1:8080"));
3637 assert_eq!(cfg.build.as_ref().unwrap().command, "npm run build");
3638 assert_eq!(
3639 cfg.routing.error_documents.get(&404).map(String::as_str),
3640 Some("/404.html")
3641 );
3642 }
3643
3644 #[test]
3645 fn shipped_server_example_parses() {
3646 let text = std::fs::read_to_string(repo_root_file("boatramp.cfg.example"))
3647 .expect("example server config is present");
3648 let cfg = ServerConfig::parse(&text).expect("example server config parses");
3649 let serve = cfg.serve.expect("example sets a serve section");
3650 assert_eq!(
3651 serve.addr,
3652 Some("0.0.0.0:8080".parse::<std::net::SocketAddr>().unwrap())
3653 );
3654 }
3655
3656 #[test]
3657 fn secrets_section_parses_local_and_vault() {
3658 let local = server(r#"( secrets: ( envelope: "local", kek_file: "/k/kek" ) )"#)
3659 .secrets
3660 .expect("secrets section");
3661 assert_eq!(local.envelope, "local");
3662 assert_eq!(
3663 local.kek_file.as_deref(),
3664 Some(std::path::Path::new("/k/kek"))
3665 );
3666
3667 let vault = server(
3668 r#"( secrets: ( envelope: "vault", vault: ( addr: "https://vault:8200", key: "certs" ) ) )"#,
3669 )
3670 .secrets
3671 .expect("secrets section");
3672 let v = vault.vault.expect("vault subsection");
3673 assert_eq!(v.addr, "https://vault:8200");
3674 assert_eq!(v.key, "certs");
3675 // The token env defaults to VAULT_TOKEN and is never in the file.
3676 assert_eq!(v.token_env, "VAULT_TOKEN");
3677 }
3678
3679 #[test]
3680 fn serve_section_partial_parses() {
3681 // A partial `serve` section parses — unset fields take their defaults.
3682 let cfg = server(r#"( serve: ( addr: "0.0.0.0:8080", protect_previews: true ) )"#);
3683 let serve = cfg.serve.unwrap();
3684 assert_eq!(
3685 serve.addr,
3686 Some("0.0.0.0:8080".parse::<std::net::SocketAddr>().unwrap())
3687 );
3688 assert!(serve.protect_previews);
3689 assert!(!serve.cluster_rate_limit);
3690 assert!(serve.data_dir.is_none());
3691 }
3692
3693 #[test]
3694 fn serve_console_config_parses() {
3695 // Absent ⇒ no console.
3696 let cfg = server(r#"( serve: ( addr: "0.0.0.0:8080" ) )"#);
3697 assert!(cfg.serve.unwrap().console.is_none());
3698 // Explicit console block with host + path.
3699 let cfg = server(
3700 r#"( serve: ( console: (
3701 enabled: true,
3702 host: "console.example.com",
3703 path: "/_console",
3704 ) ) )"#,
3705 );
3706 let console = cfg.serve.unwrap().console.unwrap();
3707 assert!(console.enabled);
3708 assert_eq!(console.host.as_deref(), Some("console.example.com"));
3709 assert_eq!(console.path.as_deref(), Some("/_console"));
3710 // Bare `enabled` ⇒ host/path take their (server-side) defaults.
3711 let cfg = server(r#"( serve: ( console: ( enabled: true ) ) )"#);
3712 let console = cfg.serve.unwrap().console.unwrap();
3713 assert!(console.enabled);
3714 assert!(console.host.is_none() && console.path.is_none());
3715 }
3716
3717 #[test]
3718 fn serve_s3_credential_config_parses() {
3719 // #505: absent ⇒ no sealed source (the ambient AWS env chain).
3720 let cfg = server(r#"( serve: ( addr: "0.0.0.0:8080" ) )"#);
3721 assert!(cfg.serve.unwrap().s3_credential.is_none());
3722 // An explicit `[serve.s3_credential]`: a plain `access_key_id` + a `boatramp:` sealed
3723 // `secret_access_key` ref (the config text carries only the REFERENCE, never the secret).
3724 let cfg = server(
3725 r#"( serve: ( s3_credential: (
3726 access_key_id: "tid_public_akid",
3727 secret_access_key: "boatramp:tigris-secret",
3728 ) ) )"#,
3729 );
3730 let cred = cfg.serve.unwrap().s3_credential.unwrap();
3731 assert_eq!(cred.access_key_id, "tid_public_akid");
3732 assert_eq!(cred.secret_access_key, "boatramp:tigris-secret");
3733 // An unknown field is rejected (`deny_unknown_fields`) — a fat-fingered key fails fast.
3734 let err: Result<ServerConfig, _> = ron_options().from_str(
3735 r#"( serve: ( s3_credential: ( access_key_id: "x", secret_access_key: "boatramp:y", bogus: 1 ) ) )"#,
3736 );
3737 assert!(
3738 err.is_err(),
3739 "unknown [serve.s3_credential] field must be rejected"
3740 );
3741 }
3742
3743 #[test]
3744 fn serve_blob_fallback_config_parses() {
3745 // Blob-backend migration Part 2: absent ⇒ no fallback (the read-through composite is not wired).
3746 let cfg = server(r#"( serve: ( addr: "0.0.0.0:8080" ) )"#);
3747 assert!(cfg.serve.unwrap().blob_fallback.is_none());
3748 // A `[serve.blob_fallback]` secondary: the OLD fs backend to drain while the primary is s3,
3749 // with its own sealed S3 credential ref and a custom secondary timeout.
3750 let cfg = server(
3751 r#"( serve: (
3752 blobs: s3,
3753 s3_bucket: "new-bucket",
3754 blob_fallback: (
3755 blobs: fs,
3756 secondary_timeout_secs: 3,
3757 s3_credential: (
3758 access_key_id: "old_akid",
3759 secret_access_key: "boatramp:old-secret",
3760 ),
3761 ),
3762 ) )"#,
3763 );
3764 let serve = cfg.serve.unwrap();
3765 let fb = serve.blob_fallback.unwrap();
3766 assert_eq!(fb.blobs, Some(crate::backends::BlobBackend::Fs));
3767 assert_eq!(fb.secondary_timeout_secs, Some(3));
3768 let cred = fb.s3_credential.unwrap();
3769 assert_eq!(cred.access_key_id, "old_akid");
3770 assert_eq!(cred.secret_access_key, "boatramp:old-secret");
3771 // An unknown field is rejected (`deny_unknown_fields`).
3772 let err: Result<ServerConfig, _> =
3773 ron_options().from_str(r#"( serve: ( blob_fallback: ( blobs: fs, bogus: 1 ) ) )"#);
3774 assert!(
3775 err.is_err(),
3776 "unknown [serve.blob_fallback] field must be rejected"
3777 );
3778 }
3779
3780 #[test]
3781 fn serve_kv_config_parses_and_defaults() {
3782 // Absent `[serve.kv]` ⇒ the defaults: periodic checkpoint ON at the default cadence, and the
3783 // generous default close budget (NOT the old 3s).
3784 let cfg = server(r#"( serve: ( addr: "0.0.0.0:8080" ) )"#);
3785 assert!(cfg.serve.unwrap().kv.is_none());
3786 let default_kv = super::KvConfig::default();
3787 assert_eq!(
3788 default_kv.checkpoint_interval(),
3789 Some(std::time::Duration::from_secs(
3790 super::DEFAULT_KV_CHECKPOINT_INTERVAL_SECS
3791 )),
3792 "an absent/unset checkpoint_interval defaults to the ON cadence"
3793 );
3794 assert_eq!(
3795 default_kv.close_deadline(),
3796 std::time::Duration::from_secs(super::DEFAULT_KV_CLOSE_DEADLINE_SECS),
3797 "an absent/unset close_deadline defaults to the generous budget"
3798 );
3799
3800 // An explicit block: a tuned cadence + a tuned close budget, now nested under `slatedb`
3801 // (UX-C3) so they never appear to apply under a non-SlateDB backend.
3802 let cfg = server(
3803 r#"( serve: ( kv: ( slatedb: ( checkpoint_interval: 5, close_deadline: 30 ) ) ) )"#,
3804 );
3805 let kv = cfg.serve.unwrap().kv.unwrap();
3806 assert_eq!(
3807 kv.checkpoint_interval(),
3808 Some(std::time::Duration::from_secs(5))
3809 );
3810 assert_eq!(kv.close_deadline(), std::time::Duration::from_secs(30));
3811
3812 // checkpoint_interval = 0 DISABLES the cadence; a 0 close_deadline falls back to the default
3813 // (a zero close budget would abandon every close, guaranteeing a torn tail — never allowed).
3814 let cfg = server(
3815 r#"( serve: ( kv: ( slatedb: ( checkpoint_interval: 0, close_deadline: 0 ) ) ) )"#,
3816 );
3817 let kv = cfg.serve.unwrap().kv.unwrap();
3818 assert_eq!(kv.checkpoint_interval(), None, "0 disables the cadence");
3819 assert_eq!(
3820 kv.close_deadline(),
3821 std::time::Duration::from_secs(super::DEFAULT_KV_CLOSE_DEADLINE_SECS),
3822 "a 0 close_deadline is clamped up to the default, never zero"
3823 );
3824
3825 // The SQL KV backend connection parses under `sql` (UX-C2: `url_env`, never a raw URL).
3826 let cfg = server(r#"( serve: ( kv: ( sql: ( kind: "sqlite", path: "/data/kv.db" ) ) ) )"#);
3827 let sql = cfg.serve.unwrap().kv.unwrap().sql.unwrap();
3828 assert_eq!(sql.kind, "sqlite");
3829 assert_eq!(sql.path.as_deref(), Some("/data/kv.db"));
3830
3831 // UX-C3: a pre-v0.12.0 TOP-LEVEL durability knob now fails loud (it moved under `slatedb`),
3832 // never silently mislead — `deny_unknown_fields` rejects it at the `[serve.kv]` level.
3833 let err: Result<ServerConfig, _> =
3834 ron_options().from_str(r#"( serve: ( kv: ( checkpoint_interval: 5 ) ) )"#);
3835 assert!(
3836 err.is_err(),
3837 "a top-level checkpoint_interval must be rejected (moved under [serve.kv.slatedb])"
3838 );
3839
3840 // An unknown field inside the `slatedb` sub-block is rejected (`deny_unknown_fields`).
3841 let err: Result<ServerConfig, _> = ron_options()
3842 .from_str(r#"( serve: ( kv: ( slatedb: ( checkpoint_interval: 5, bogus: 1 ) ) ) )"#);
3843 assert!(
3844 err.is_err(),
3845 "unknown [serve.kv.slatedb] field must be rejected"
3846 );
3847 }
3848
3849 // =======================================================================
3850 // JSON config input gate (v0.6.5) — serve/project config + detection half.
3851 //
3852 // ROBUST-successor gate (continuing the v0.6.4 blob-purge style): a `#[test]`
3853 // battery whose sole CI contract is the ordinary `cargo test` exit code — NO
3854 // grepped uppercase marker, NO bash env-var mutation loop. Every test is prefixed
3855 // `config_json_gate_` so the CI lane filters with `cargo test … config_json`. The
3856 // apply-manifest half (version current-schema-only, bad-route compile-check) lives
3857 // in `boatramp::apply`'s test module under the same prefix.
3858 // =======================================================================
3859
3860 /// Detection: `resolve_format` follows the explicit-override-wins, else
3861 /// `.json`⇒Json / everything-else⇒Ron rule (no content-sniffing).
3862 #[test]
3863 fn config_json_gate_resolve_format_table() {
3864 use std::path::Path;
3865 // Auto by extension.
3866 assert_eq!(
3867 resolve_format(Path::new("boatramp.json"), None),
3868 ConfigFormat::Json
3869 );
3870 assert_eq!(
3871 resolve_format(Path::new("apply.cfg"), None),
3872 ConfigFormat::Ron
3873 );
3874 assert_eq!(
3875 resolve_format(Path::new("apply.ron"), None),
3876 ConfigFormat::Ron
3877 );
3878 // No extension ⇒ Ron.
3879 assert_eq!(resolve_format(Path::new("apply"), None), ConfigFormat::Ron);
3880 // Case-insensitive `.json`.
3881 assert_eq!(
3882 resolve_format(Path::new("x.JSON"), None),
3883 ConfigFormat::Json
3884 );
3885 // Explicit override wins BOTH ways.
3886 assert_eq!(
3887 resolve_format(Path::new("x.json"), Some(ConfigFormat::Ron)),
3888 ConfigFormat::Ron
3889 );
3890 assert_eq!(
3891 resolve_format(Path::new("x.cfg"), Some(ConfigFormat::Json)),
3892 ConfigFormat::Json
3893 );
3894 }
3895
3896 /// Equivalence: a representative serve config authored in RON and in equivalent
3897 /// JSON parses to the SAME field values — including the externally-tagged
3898 /// enum-variant field `[serve].blobs` (`BlobBackend::S3`; RON `s3` ≡ JSON `"s3"`),
3899 /// proving variant-name fidelity through the JSON decoder.
3900 #[test]
3901 fn config_json_gate_serve_ron_and_json_are_equivalent() {
3902 let ron = r#"( serve: ( addr: "0.0.0.0:8080", blobs: s3, s3_bucket: "b" ) )"#;
3903 let json = r#"{ "serve": { "addr": "0.0.0.0:8080", "blobs": "s3", "s3_bucket": "b" } }"#;
3904 let from_ron = ServerConfig::parse_with_format(ron, ConfigFormat::Ron).unwrap();
3905 let from_json = ServerConfig::parse_with_format(json, ConfigFormat::Json).unwrap();
3906 let s_ron = from_ron.serve.unwrap();
3907 let s_json = from_json.serve.unwrap();
3908 assert_eq!(s_ron.blobs, Some(crate::backends::BlobBackend::S3));
3909 assert_eq!(s_json.blobs, Some(crate::backends::BlobBackend::S3));
3910 assert_eq!(s_ron.blobs, s_json.blobs, "the enum variant survives JSON");
3911 assert_eq!(s_ron.addr, s_json.addr);
3912 assert_eq!(s_ron.s3_bucket, s_json.s3_bucket);
3913 assert_eq!(s_json.s3_bucket.as_deref(), Some("b"));
3914 }
3915
3916 /// Equivalence (project): a `project.cfg` authored in RON and in equivalent JSON
3917 /// parses to the same publish target.
3918 #[test]
3919 fn config_json_gate_project_ron_and_json_are_equivalent() {
3920 let ron = r#"( publish: ( project: "team-x" ) )"#;
3921 let json = r#"{ "publish": { "project": "team-x" } }"#;
3922 let from_ron = ProjectConfig::parse_with_format(ron, ConfigFormat::Ron).unwrap();
3923 let from_json = ProjectConfig::parse_with_format(json, ConfigFormat::Json).unwrap();
3924 assert_eq!(from_ron.publish.project.as_deref(), Some("team-x"));
3925 assert_eq!(from_ron.publish.project, from_json.publish.project);
3926 }
3927
3928 /// `deny_unknown_fields` parity: a JSON serve config with an extra/typo'd field is
3929 /// a hard parse error, not a silent drop (the `[serve.blob_fallback]`
3930 /// `deny_unknown_fields` struct is the RON parity partner tested above).
3931 #[test]
3932 fn config_json_gate_serve_json_denies_unknown_fields() {
3933 let json = r#"{ "serve": { "blob_fallback": { "blobs": "fs", "bogus": 1 } } }"#;
3934 assert!(
3935 ServerConfig::parse_with_format(json, ConfigFormat::Json).is_err(),
3936 "an unknown JSON field must be rejected (deny_unknown_fields), same as RON"
3937 );
3938 }
3939
3940 /// No-bypass: post-parse validation runs regardless of format. A JSON serve config
3941 /// with an invalid `handlers.bindings.sql.databases` db-name (a `/`-bearing,
3942 /// non-URL-path-safe name) is rejected identically to RON — the SAME
3943 /// `ConfigError::InvalidDbName`, from the SAME `validate_sql_db_names` choke point.
3944 #[test]
3945 fn config_json_gate_json_bad_db_name_is_rejected_like_ron() {
3946 // The invalid binding name `a/b` (a path separator) fails the canonical
3947 // resource-name validator that `validate_sql_db_names` runs after the parse.
3948 let json = r#"{ "handlers": { "bindings": { "sql": {
3949 "databases": { "a/b": { "kind": "postgres", "url_env": "DB_URL" } }
3950 } } } }"#;
3951 let ron = r#"( handlers: ( bindings: ( sql: (
3952 databases: { "a/b": ( kind: "postgres", url_env: "DB_URL" ) }
3953 ) ) ) )"#;
3954 let json_err = ServerConfig::parse_with_format(json, ConfigFormat::Json)
3955 .expect_err("a bad db-name in a JSON config must be rejected");
3956 let ron_err = ServerConfig::parse_with_format(ron, ConfigFormat::Ron)
3957 .expect_err("a bad db-name in a RON config must be rejected");
3958 assert!(
3959 matches!(json_err, ConfigError::InvalidDbName { .. }),
3960 "JSON bad db-name is InvalidDbName, got {json_err:?}"
3961 );
3962 assert!(
3963 matches!(ron_err, ConfigError::InvalidDbName { .. }),
3964 "RON bad db-name is InvalidDbName, got {ron_err:?}"
3965 );
3966 }
3967
3968 /// Anti-hollow (typed, in-process): a document valid as JSON but NOT as RON MUST
3969 /// parse under `Json` and FAIL under `Ron`. If `parse_with_format` ignored `fmt`
3970 /// and always decoded RON, the JSON leg would fail — so the format selection is
3971 /// proven load-bearing, with no env var and no marker.
3972 #[test]
3973 fn config_json_gate_serve_format_selection_is_load_bearing() {
3974 // A bare JSON object is valid JSON for `ServerConfig`, not valid RON for it
3975 // (RON structs use `( … )`, not a brace map).
3976 let doc = r#"{ "serve": { "s3_bucket": "only-json" } }"#;
3977 let as_json = ServerConfig::parse_with_format(doc, ConfigFormat::Json).unwrap();
3978 assert_eq!(
3979 as_json.serve.unwrap().s3_bucket.as_deref(),
3980 Some("only-json")
3981 );
3982 assert!(
3983 ServerConfig::parse_with_format(doc, ConfigFormat::Ron).is_err(),
3984 "the same document must FAIL under Ron — else the fmt selection is hollow"
3985 );
3986 }
3987}