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