OXYGENHUB
# 069e16fba3bd oxygenflow / docs / spec.md
43.8 KiB · Markdown · last changed flow runner drain: drain the running runner by a request file 10 days ago renderedsource blame history raw
a083cc80 Andy McCall ↶ 1
# OxygenFlow (flow) — Deterministic Execution & Provenance Pipeline Specification
2
3
| | |
4
|---|---|
5
| **Format version** | 1 |
6
| **Date** | 2026-09-28 |
7
| **Status** | Draft 0.1 |
8
| **Target VCS** | Oxygen (oxy) Draft 0.8i |
9
| **Audience** | Implementers, Security Architects, and Systems Engineers |
10
11
12
The key words MUST, MUST NOT, SHOULD, SHOULD NOT, and MAY are to be
13
interpreted as described in RFC 2119.
14
15
## 1. Overview and Core Invariants
16
17
OxygenFlow (flow) is a content-addressed, hermetic execution engine, runner system,
18
and pipeline language designed natively for the Oxygen (oxy) version control
19
system.
20
21
Existing runner engines (GitHub Actions, GitLab CI, Forgejo Runner) suffer from
22
structural flaws:
23
1. Workspace Bloat: Full clones, index unpacks, and checkout scans dominate I/O.
24
2. String Injection: Shell interpolation within untyped YAML files produces
25
   expression injection and command execution exploits.
26
3. Decoupled Supply Chain: Attestations (SLSA, in-toto, Cosign) exist outside
27
   the VCS, relying on external registries rather than native repository trust.
28
4. Coarse Caching: Opaque tarballs keyed by arbitrary string hashes fail to
29
   leverage commutative history or granular dependency graphs.
30
31
OxygenFlow solves these liabilities through direct integration with Oxygen:
32
- Zero-Copy Workspaces: Jobs mount workspaces directly from Oxygen's FastCDC-
33
  chunked, BLAKE3-addressed Content-Addressable Store (CAS) using Copy-on-Write
34
  (COW) overlays.
35
- Commutative History & Impact Trees: Pipelines evaluate over change closures
36
  rather than linear snapshot sequences. Commuting changes automatically reuse
37
  cached execution receipts without redundant re-execution.
38
- Micro-Engine Sandboxing: Jobs run inside isolated environments (WASM, gVisor,
39
  or MicroVMs) with strict, deny-by-default capabilities and no ambient
40
  network egress.
41
- Native Cryptographic Provenance: Provenance and execution receipts are
42
  generated outside the untrusted guest, encoded as deterministic CBOR, and
43
  signed using composite Ed25519 + ML-DSA-65 keys as native Oxygen Attest
44
  objects governed by in-repository Policy rules.
45
46
## 2. Threat Model and Security Architecture
47
48
### 2.1 Adversaries
49
- Untrusted Proposal Author: Submits code to an open repository containing
50
  malicious build configurations intended to escape the runner, exfiltrate
51
  secrets, or corrupt shared worker caches.
52
- Malicious Dependency / Upstream: Third-party dependencies invoked during
53
  build time attempting out-of-band network calls or host file modification.
54
- Compromised Runner / Malicious Worker: An execution node attempting to
55
  forge successful build receipts or inject backdoors into published artifacts.
56
57
### 2.2 Security Invariants
58
- I1 Deny-by-Default Execution: Sandboxes possess no network interfaces
59
  (excluding loopback when requested) and no host filesystem access unless
60
  explicitly granted in policy-signed configuration.
61
- I2 Injection-Free Invocation: Configuration parsing directly yields an argv
62
  string vector executed via execve(). Shell interpretation (/bin/sh -c) does
63
  not exist.
64
- I3 Host-Enforced Provenance: The running payload cannot author, inspect, or
65
  alter its own provenance statement. Provenance is emitted solely by the
66
  isolation hypervisor boundary.
67
- I4 Cryptographic Identity & Authorization: Runners execute using an Oxygen
68
  Identity whose KeyId is enrolled as a delegate in the repository's Policy.
69
  Unenrolled runners cannot publish recognized attestations or advance gates.
70
71
## 3. The OxygenFlow Configuration Language (.flow)
72
73
Pipelines are declared in KDL syntax within .flow/pipeline.kdl at the
74
repository root. KDL provides strict typing, structured nesting, and rejects
75
arbitrary text macro expansion.
76
b647ab72 Andy McCall ↶ 77
Strings follow KDL 2.0, which has no `\033`, `\e` or `\x` escapes: ESC,
78
for ANSI colours in a job's output, is `\u{1b}` (`"\u{1b}[32mok\u{1b}[0m"`),
79
and `flow check` says so when it meets one of the others. Inside the
80
guest, `/dev/fd` and `/dev/stdin|stdout|stderr` link to `/proc/self/fd`
81
as on any Linux system, so bash process substitution works.
82
a083cc80 Andy McCall ↶ 83
### 3.1 Pipeline Specification Schema
84
85
```kdl
86
schema-version 1
87
88
// Define the hermetic execution boundary
89
sandbox "rust-builder" {
90
    runtime "microvm"       // Options: "wasm" | "gvisor" | "microvm"
91
    rootfs "cas://blob/9b5c2a1e8f3d4e7a6b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a"
92
    memory-limit "4GiB"
93
    cpu-limit 4
ea81796b Andy McCall ↶ 94
    network "isolated"      // Options: "isolated" | "loopback" | "egress" { allow "host"... } (§4.3.1)
a083cc80 Andy McCall ↶ 95
}
96
97
// Job evaluated based on Oxygen change closure
98
job "compile-core" {
99
    sandbox "rust-builder"
100
101
    // Commutation boundary: runs only if change closure touches these paths
102
    scope "crates/oxy-core/**" "crates/oxy-server/**" "Cargo.*"
103
104
    // Zero-copy workspace mount backed by Oxygen CAS
105
    mount {
106
        source "oxy://workspace"
107
        target "/src"
108
        include "crates/oxy-core" "crates/oxy-server" "Cargo.toml" "Cargo.lock"
109
        readonly #true
110
    }
111
112
    // Ephemeral scratch space
113
    mount {
114
        source "ephemeral://tmpfs"
115
        target "/src/target"
116
        size "8GiB"
117
    }
118
119
    env {
120
        RUSTFLAGS "-Dwarnings"
121
        CARGO_INCREMENTAL "0"
122
    }
123
124
    // Direct argv execution vector (no subshell)
125
    exec "cargo" "build" "--release" "--package" "oxy-core"
126
127
    output {
128
        artifact "oxy-core-lib" {
129
            path "/src/target/release/liboxy_core.rlib"
130
            format "blob"
131
        }
132
    }
133
}
134
135
job "unit-tests" {
136
    sandbox "rust-builder"
137
    depends-on "compile-core"
138
139
    mount {
140
        source "oxy://workspace"
141
        target "/src"
142
        readonly #true
143
    }
144
145
    mount {
146
        source "artifact://compile-core/oxy-core-lib"
147
        target "/src/target/release/liboxy_core.rlib"
148
    }
149
150
    exec "cargo" "test" "--release" "--package" "oxy-core"
151
}
152
153
publish "release-provenance" {
154
    depends-on "unit-tests"
155
156
    attest {
157
        kind "provenance"
158
        bind-ref "bookmarks/main"
159
        include-artifacts "compile-core/oxy-core-lib"
160
    }
161
}
162
163
bf7bb1b8 Andy McCall ↶ 164
**What starts a job.** An `on` block, at the top of the pipeline or in a job (the job's wins), names the events that run it: `push` with bookmark globs (none: any bookmark), `tag` with tag globs (none: any tag), `manual` ("Run pipeline", `oh run start`) and `schedule` with five-field cron lines on the hub's clock (UTC), run on the default bookmark. Without `on`, a job runs on every push and by hand, as before. A run has only the jobs its event starts (and what they depend on); an event that starts no job starts no run. A rerun repeats its run's event.
165
166
```kdl
167
on {
168
    push "main" "feature/*"
169
    manual
170
}
171
job "dist" {
172
    on {
173
        tag "v*"
174
        manual
175
    }
176
    …
177
}
178
```
179
02b127d2 Andy McCall ↶ 180
**Time limits.** A job may say how long it may run with `timeout "90m"` (hours, minutes and seconds, as `"2h"`, `"1h30m"` or `"45s"`, from a minute to a day); a sandbox's `timeout` is the default for its jobs. Without one, the hub's default applies, and the hub caps every job at the site's maximum (both set by an administrator on Admin → Runners). The runner stops a job at its limit, and the hub ends one its runner stopped reporting a few minutes after it. A timeout is part of the compiled job, so a job without one compiles as before.
181
e87c1c13 Andy McCall ↶ 182
**Priority.** A pipeline may lower its jobs' place in the hub's queue, never raise it (oxygenhub#244): `priority "low"` (or `"normal"`) on a job, or at the top of the file for every job that does not say. A job's level is then the lower of its own and its repository's (the repository's, organisation's or site's, set on the hub), so nightly or bulk jobs can stand back for everyday ones; `high` and `urgent` are refused here, being the hub's to give, and a run a person expedites stays urgent whatever its jobs say. A priority is part of the compiled job; a job without one compiles as before.
183
e576e086 Andy McCall ↶ 184
**Runner labels.** A sandbox or a job may say `runs-on "LABEL" ...`: lower-case letters, digits, `-`, `_` and `.`, at most 64 bytes each, given on one or more lines. A job needs a runner that has every label its sandbox and it name. A runner reports its labels and architecture when it registers and on each claim (`flow runner register --label`). The hub hands a job only to a runner with all of them, within the runner's scope (OxygenHub spec 13.2), and a job no runner can take waits, saying so on the queue. Labels are part of the compiled job, so a job that asks for none compiles as before.
185
a083cc80 Andy McCall ↶ 186
### 3.2 Canonical Compilation
187
Upon commit, .flow/pipeline.kdl is validated and compiled into a deterministic
188
CBOR job-graph blob. Runners evaluate the canonical CBOR to prevent syntax or
189
parser ambiguities across varying client platforms.
190
191
## 4. Sandbox Execution Engine
192
193
OxygenFlow implements three distinct isolation tiers depending on the workload:
194
195
### 4.1 Level 0: WASM Component Sandbox
28cc603f Andy McCall ↶ 196
- Intended for static linters, formatters, doc generators, policy checks, and
197
  test suites built for `wasm32-wasip1`; the tier phones and browsers run
198
  (docs/handover.md).
199
- Built (oxygenflow#75): wasmtime 49 runs WASI preview 1 modules, each in a
200
  fresh instance, compiled by Cranelift (tens of milliseconds a module).
201
  Preview 2 components later.
202
- `runtime "wasm"`; no `rootfs` and no network (`network` absent or
203
  `"isolated"`); `memory-limit` holds the module's linear memory.
204
- `exec` names the module, a path among the job's files (its scope or an
205
  earlier job's artifact), optionally under `/src/`, or a glob with `*` in
206
  its file name: each match runs in turn, and the job's exit code is the
207
  first non-zero one after all have run. The rest of `exec` are the
208
  module's arguments. A module that traps exits 134.
209
- The job's files are the only host files it sees, preopened as `/src` (and
210
  as the current directory, for relative paths); each `mount` is preopened at
211
  its target. Secrets and identities are not offered yet.
212
- The receipt's environment names `wasmtime` and its version, the runner
213
  binary, the memory, and every module run with its BLAKE3.
a083cc80 Andy McCall ↶ 214
215
### 4.2 Level 1: Intercepted Syscall Isolation (gVisor / Landlock + seccomp-bpf)
216
- Intended for standard compilation and hermetic test suites.
217
- Emulates or filters Linux system call interfaces in user space.
218
- Blocks access to raw network sockets, real-time hardware clocks, and device
219
  nodes.
220
- Memory and execution CPU quotas are strictly bounded via cgroups v2.
221
222
### 4.3 Level 2: MicroVM Isolation (Firecracker / Cloud-Hypervisor)
223
- Intended for kernel tests, multi-container integration, and untrusted code.
224
- Ephemeral Linux microVM booting in < 80 ms.
225
- The root filesystem is presented as a read-only virtio-block device mapped
226
  directly to FastCDC chunks stored in Oxygen's CAS.
227
- Guest VM memory is cleared upon termination.
228
ea81796b Andy McCall ↶ 229
#### 4.3.1 Allow-listed egress (oxygenflow#55)
230
231
A sandbox reaches the network only by naming its hosts:
232
233
```kdl
234
sandbox "deploy" {
235
    runtime "microvm"
236
    network "egress" { allow "*.googleapis.com" "registry.opentofu.org" }
237
}
238
```
239
240
The VM still has no network device. `flow-init` serves a proxy on the
241
guest's `127.0.0.1:3128` (the job gets `HTTPS_PROXY`, `HTTP_PROXY` and
242
their lower-case forms, unless it sets them) and relays each connection,
243
unread, over Firecracker's vsock to the runner. The runner accepts only
244
`CONNECT host:443` for a host the list allows (a name exactly, or any
245
name under a `*.` domain, never the domain itself; never an address),
246
resolves it itself (the guest does not resolve), refuses any name that
247
resolves to an address that is not public, and relays the bytes without
248
opening the TLS. Every decision, allowed or refused, is a `flow` line in
249
the job's log. Patterns are lower-case host names of two or more labels,
250
at most 32 per sandbox, and part of the sandbox's hash.
251
252
Egress is off unless a runner turns it on (`egress = true` under
253
`[runner]` in `flow.toml`); such a runner offers the `egress` label, and
254
an egress sandbox needs it, so the hub hands its jobs only to runners
255
that allow it, and a runner without it refuses one anyway. The syscall
256
runtime has no egress yet.
257
35f7a849 Andy McCall ↶ 258
**Keyless receipts** (oxygenhub#241). With `keyless = true` under
259
`[runner]` (or in `runner.toml`), a runner signs each job's receipt with a
260
fresh key instead of its own: just before signing, it asks the hub to
261
certify the key (`POST /api/v1/keyless/certify` with the job's token and
262
the key's proof of possession, scope `seal`), checks the certificate is
263
for that key and signed by the key the hub publishes at
264
`/.well-known/oxyhub-key`, signs, attaches the certificate and the hub's
265
identity to the receipt (Oxygen spec §14.6), and drops the key. When the
266
hub cannot certify, the runner's own key signs and the job's log says
267
why. The runner's key then only authenticates it to the hub.
268
4be5e4cd Andy McCall ↶ 269
**Metrics** (oxygenflow#35). With `metrics = "127.0.0.1:9464"` under
270
`[runner]` (off unless set), a runner serves Prometheus text at
271
`/metrics` on that address, from a thread of its own: its version and
272
uptime, jobs claimed and declined, finished jobs by result (`passed`,
273
`failed`, `error`, `cancelled`), the seconds they ran together, and the
274
jobs running now, each labelled with the runner's name. With
275
`metrics_token`, a scrape must send it as a bearer token; without one,
276
bind it to an address only the scraper reaches. The hub's own `/metrics`
277
has the queue and run times of every runner's jobs.
278
a083cc80 Andy McCall ↶ 279
## 5. Content-Addressable Storage (CAS) & Zero-Copy Mounting
280
281
OxygenFlow runners bypass traditional clone operations. Repositories are accessed
282
directly via the local object store (.oxy/objects/) or streamed on demand
283
using Oxygen's wire protocol.
284
285
### 5.1 FUSE Overlay Mounting (flow-casfs)
286
1. The runner receives a task targeting an Oxygen State ObjectRef (a sorted
287
   list of maximal heads).
288
2. The nearest Checkpoint is resolved. Uncommitted changes between the
289
   checkpoint and heads are replayed into a virtual tree in-memory.
290
3. The virtual tree is exposed to the sandbox via flow-casfs:
291
   - File reads resolve chunks using the FastCDC gear table (32 KiB to 256 KiB,
292
     mean 64 KiB) pinned in Oxygen Spec Section 13.2.
293
   - Missing chunks are fetched lazily using the POST /objects protocol.
294
   - To prevent FUSE context-switch bottlenecks on many small reads, flow-casfs aggressively mmaps chunk data and utilizes host page caching.
295
   - All guest mutations are diverted to a scratch tmpfs layer; base objects
296
     remain immutable.
297
298
### 5.2 Artifact Capture
299
1. At task completion, flow-casfs scans the paths declared in the output block.
300
2. Modified outputs are chunked with FastCDC, hashed via BLAKE3-256, and
301
   written as canonical Blob and Chunk objects.
302
3. Output ObjectRefs are stored directly in the Oxygen repository.
9a6fac2b Andy McCall ↶ 303
4. Outputs are read when the job passes. An artifact with `when "always"`
304
   (default `when "passed"`) is also read when the job fails or is stopped
305
   at its time limit, so a test report survives the failure it describes.
306
   From a job that did not pass it is kept and shown, but its receipt never
307
   names it, and one that cannot be read is only noted in the log.
a083cc80 Andy McCall ↶ 308
9a6fac2b Andy McCall ↶ 309
```kdl
310
output {
311
    artifact "junit" {
312
        path "/src/target/junit.xml"
313
        when "always"
314
    }
315
}
316
```
317
6d53fb7d Andy McCall ↶ 318
5. A `report` output (OxygenHub `docs/reports.md`) names a directory
319
   holding `report.toml` at its top. The runner reads its regular files
320
   (links and anything else are left out, never followed; file names hold
321
   letters, digits, `.`, `_`, `-` and `+`; at most 2000 files and 512 MiB),
322
   uploads each to `POST /api/v1/flow/jobs/{job}/reports/{name}/files` with
323
   its path in `X-Flow-Report-Path`, then uploads a manifest,
324
   `{"version":1,"files":[{"path","blob","size"}]}`, as the output under
325
   the report's name, checking every blob the hub answers. The receipt
326
   names the manifest. Reports and artifacts share names; a report's kind
327
   is part of the job's hash (`[name, path, "report"]`).
328
329
```kdl
330
output {
331
    report "frame-timing" {
332
        path "/src/out/report"
333
        when "always"
334
    }
335
}
336
```
337
46fe2c81 Andy McCall ↶ 338
### 5.3.1 Artifacts between jobs (oxygenflow#58)
339
340
A job takes an artifact of a job it depends on:
341
342
```kdl
343
job "apply" {
344
    depends-on "plan"
345
    input {
346
        artifact "tfplan" from "plan"
347
        path "/src/tfplan"
348
    }
349
}
350
```
351
352
The producer must be named in `depends-on` and declare that name as an
353
artifact (not a report); paths are clean absolute paths under `/src`, at
354
most 8 inputs, and they are part of the job's hash (`[artifact, from,
355
path]`, field 10). Since the producer has passed when the job is handed
356
out, the hub puts each input in the claim with the blob the producer's
357
receipt names (a passing job's receipt names exactly the artifacts it
358
uploaded). Before the job starts, the runner fetches each from
359
`GET /api/v1/flow/jobs/{job}/inputs/{index}`, checks its Oxygen blob
360
reference against that blob, refuses the job if they differ, and writes it
361
at its path in the workspace (not part of the scope hash: it belongs to the
362
run, not the repository). The job's receipt lists the blobs as its
363
`inputs`, so an apply job's receipt proves which plan it applied.
364
e2089721 Andy McCall ↶ 365
### 5.3.2 Approval gates (oxygenflow#57)
366
367
A job can wait for a person:
368
369
```kdl
370
job "apply" {
371
    depends-on "plan"
372
    approval {
373
        by "maintain"        // the least role: "write", "maintain" (default) or "admin"
374
        others-only #true    // not the person whose push started the run
375
        expires "24h"        // from when the jobs it depends on are done; up to 720h
2be1fe4a Andy McCall ↶ 376
        sealed #true         // signed with the approver's key; default: on with an environment
e2089721 Andy McCall ↶ 377
    }
378
}
379
```
380
381
The hub hands such a job to no runner until someone with that role on the
382
repository approves it, on the run page or through the API; others-only
383
leaves out whoever pushed. Approving or rejecting is recorded on the job
384
(who, when) and in the audit log. A rejected or expired job ends as
385
cancelled and the jobs after it are skipped; a newer push to the
386
bookmark cancels the run as before, so a stale plan is never applied. The
387
approval is part of the job's hash (field 11).
388
2be1fe4a Andy McCall ↶ 389
**Sealed approvals (oxygenhub#235).** With `sealed` (the default for a job
390
that names an environment, §5.3.3), pressing Approve is not enough: the
391
approver signs an Oxygen `approval` attestation with their own key
392
(`oxy seal --flow URL --job NAME`; Oxygen spec §14.4) covering the run, the
393
job's hash, the state, the input blobs (the reviewed plan) and the
394
environment. The hub starts the job only once it verifies, the key is
395
linked to an account with the role, and it is not a delegated key; it keeps
396
the approval in the repository, and the job's identity tokens name the
397
approver and the approval's hash. Rejecting needs no seal.
398
f4e51e63 Andy McCall ↶ 399
### 5.3.3 Environments (oxygenflow#59)
400
401
`environment "prod"` on a job says where it deploys (1 to 32 of `a-z`,
402
`0-9`, `-`; part of the job's hash, field 12). The hub keeps what each
403
environment of a repository runs, from the jobs that passed for it (state,
404
run, when, who approved), on the repository's Deployments page. The job's
405
identity tokens carry an `environment` claim only when the job was
406
approved (§5.3.2): a job with no approval block, or one not approved, gets
407
tokens without it. So a cloud's trust condition can require
408
`environment == "prod"`, and nothing unapproved deploys there, even from
409
the deploy bookmark. The approval block is the environment's protection
410
rule for now.
411
d60aac6c Andy McCall ↶ 412
### 5.4 The Build Cache (oxygenflow#28)
413
414
An `ephemeral://disk` mount may name a `cache`, and the files that key it:
415
416
```kdl
417
mount {
418
    source "ephemeral://disk"
419
    target "/src/target"
420
    size "24GiB"
421
    cache "target"
422
    key "Cargo.lock" "rust-toolchain.toml"
423
}
424
```
425
426
Such a disk is not always empty at the start. Each runner keeps a pool of
427
the disks of passing jobs, by repository, job, cache name and bookmark,
428
named by the **key**: the BLAKE3 of the sandbox image, the job's name, the
429
cache name, and each key file's content in the job's state. A job's disk
430
starts as, in order: its bookmark's disk with the same key (moved), its
431
bookmark's newest disk (moved), another bookmark's with the same key and
432
then another's newest (copied, so a proposal never takes the default
2594278f Andy McCall ↶ 433
bookmark's), and otherwise an empty disk. A microVM's disk must be the
434
size the mount asks for.
d60aac6c Andy McCall ↶ 435
436
- **Only passing jobs keep a disk.** When the job and its outputs pass,
437
  its cached disks go back into the pool under their key; otherwise they
438
  are discarded with the scratch directory, so nothing a failing job wrote
439
  reaches a later one.
440
- **The receipt says so.** The job's environment gains `cache TARGET` with
441
  the key and what the disk started from, so the receipt's environment
442
  hash differs from a cold build's.
443
- **Bounded.** The pool keeps under `cache_gb` in the runner's config
444
  (default 64 GiB) by dropping the disks used longest ago.
077a6524 Andy McCall ↶ 445
- **Pruned before it is kept** (oxygenflow#72). A kept disk would
446
  otherwise carry every build's files (each crate under every hash a
447
  lockfile or feature set gave it) until the job's disk is full. When a
448
  passing job's cache holds more than `cache_prune_percent` of its
449
  mount's `size` (runner config, default 60), the files the job did not
450
  use are removed, used longest ago first, until it is under that cap; one
451
  still over it is not kept, so the next run starts empty. A file was
452
  used if it was read, written or changed since the job started, or it
453
  shares a unit hash with one that was (a 16-digit hex word after a `-`
454
  in its path, as cargo names a unit's fingerprint, rlibs, binaries and
455
  build-script output: a crate cargo found fresh is only looked at, but
456
  its fingerprint is read), or is another link of one, or lies under one
457
  of the job's outputs. A microVM's guest (`flow-init`) prunes its disks
458
  before it powers off, having mounted them `strictatime` so every read
459
  is seen, and tells the runner what it kept (`\x1eC` frames); without
460
  word from it the runner only measures the image (`dumpe2fs`) and keeps
461
  it if it is under the cap. The syscall tier's runner prunes a directory
462
  itself, having set each file's atime to the epoch when the job took it,
463
  so even a `relatime` file system records the job's first read of each;
464
  on a `noatime` one nothing is pruned and only the size decides. The
465
  job's log says what happened: `cache target: kept 12.3 GiB of 23.1 GiB
466
  (pruned 10.8 GiB in 4113 files this run did not use; the cap is 60% of
467
  its 24.0 GiB disk)`, or `not kept:` and why.
82cf6e91 Andy McCall ↶ 468
- **Unchanged sources keep their times** (oxygenflow#52). Beside each kept
469
  disk the pool keeps its sources: each workspace file's content hash and
470
  the mtime it had, in whole seconds (what the workspace image keeps). A
471
  job that takes the disk gives each file whose content is unchanged that
472
  mtime back before the workspace is imaged; a changed or new file keeps
473
  the time of its checkout, newer than anything on the disk. A build tool
474
  that judges freshness by time, such as cargo, then rebuilds exactly the
475
  crates whose sources changed, where a fresh checkout would make every
476
  path crate look changed. The log says how many files kept their times.
477
- **Jobs go where their cache is** (oxygenflow#51). Each claim lists the
478
  caches the runner holds a disk of (`caches`, each
479
  `flow_core::api::cache_slot(repo, job)`), and the hub ranks a runner
480
  holding a job's cache above one holding its image (§11.4): a job another
481
  free runner holds the cache for is held for it for up to 15 seconds, and
1e6b9fb1 Andy McCall ↶ 482
  `placed` says "holds its build cache". When several hold it, the
483
  freshest copy wins (oxygenflow#54): claims also say when each slot last
484
  kept a disk (`cache_times`, Unix ms), and a copy kept at least a minute
485
  later ranks above an older one, before the image and speed are
486
  weighed; `placed` says how old the copy is.
2594278f Andy McCall ↶ 487
- **The syscall tier keeps directories** (oxygenflow#70). Its
488
  `ephemeral://disk` mount is a host directory bound at the target, so
489
  its pool holds directories (`<key>.tree`) beside the microVM's images
490
  (`<key>.ext4`), taken and kept the same way: moved out of the pool for a
491
  job of the same bookmark (so two jobs of one slot running at once never
492
  take the same one), copied with their modes and times from another
493
  bookmark's, kept only when the job and its outputs pass and otherwise
494
  thrown away, and counted by the blocks of everything in them toward
495
  `cache_gb`. A directory has no size, so `size` does not choose between
496
  them. Each tier takes only its own form: a syscall job never starts from
497
  a microVM's image, nor a microVM from a directory. The job runs as the
498
  runner's user, so what it wrote is the runner's; before a directory goes
499
  into the pool nothing in it is left writable by group or others, or
500
  set-id, and the pool is readable by the runner alone. Claims report the
501
  slots of both forms in `caches` and `cache_times`, so jobs go where
502
  their cache is whichever tier they run in.
d60aac6c Andy McCall ↶ 503
- A cache is a speed-up, never a source of truth: jobs must build
504
  correctly from an empty disk, which a key change or an eviction gives
505
  them at any time.
506
a083cc80 Andy McCall ↶ 507
## 6. Commutative Execution & Change Caching
508
509
In Oxygen, changes that do not share scopes (referenced atoms, placements, or
510
nodes) commute. OxygenFlow exploits this invariant to provide granular caching.
511
512
### 6.1 Execution Receipt Object
513
Every successful or failed job run emits an immutable Receipt:
514
515
```cbor
516
Receipt {
517
  version        [0]: 1
518
  job_name       [1]: text
519
  pipeline_hash  [2]: ObjectRef
520
  scope_tree_hash [3]: ObjectRef     // BLAKE3 tree hash of the materialized scope
521
  inputs         [4]: [ObjectRef]   // Artifacts and input files consumed
522
  environment    [5]: ObjectRef     // Hash of rootfs, compiler flags, and argv
523
  outputs        [6]: [ObjectRef]   // Produced artifact blobs
524
  exit_code      [7]: u32
525
  duration_ms    [8]: u64
526
}
527
```
528
529
A Receipt is hashed as an Oxygen object with type name "receipt":
530
ObjectRef = BLAKE3-256("oxy1 receipt " || decimal(len) || 0x00 || body)
531
532
### 6.2 Cache Re-use Invariant
533
Let Scope(J) be the file paths and tree nodes declared by job J.
534
Because changes that do not share scopes commute, we do not need to track lists of ChangeHashes. Instead, we hash the materialized tree of Scope(J).
535
536
If an existing Receipt R exists such that:
537
  R.job_name == J.name &&
538
  R.pipeline_hash == Hash(J) &&
539
  R.scope_tree_hash == TreeHash(Scope(J)) &&
540
  R.environment == CurrentEnvironmentHash
541
542
Then the job execution is bypassed. R.outputs are mapped into downstream
543
dependents immediately as a cached-commuted hit.
544
545
## 7. Native Provenance Specification
546
547
OxygenFlow formalizes build provenance as a native, tamper-evident Oxygen Attest
548
object (kind: "attest"). Provenance is generated exclusively by the runner
549
hypervisor, not the guest payload.
550
551
### 7.1 Provenance Object Schema
552
553
```json
554
Attest {
555
  version [0]: 1
556
  kind    [1]: "attest"
557
  repo    [2]: bytes(16)               // Oxygen Repository ID
558
  hlc     [3]: HLC                     // Hybrid Logical Clock
559
  body    [4]: {
560
    "type": "flow/provenance/v1",
561
    
562
    // Subject artifacts produced by the build
563
    "subjects": [
564
      {
565
        "name": text,
566
        "ref": ObjectRef,              // BLAKE3 hash of output blob
567
        "media_type": text
568
      }
569
    ],
570
571
    // Builder platform and execution identity
572
    "builder": {
573
      "runner_id": KeyId,              // ObjectRef of runner's Oxygen Identity
574
      "isolation_level": text,         // "wasm" | "gvisor" | "microvm"
575
      "hypervisor_image": ObjectRef    // Rootfs blob digest
576
    },
577
578
    // Exact input materials
579
    "materials": {
580
      "state_heads": [ChangeHash],     // Oxygen heads of the state built
581
      "scope_tree_hash": ObjectRef,        // Captures exact state without O(N) array bloat
582
      "inputs": [
583
        {
584
          "name": text,
585
          "ref": ObjectRef             // Content hash of locked dependencies
586
        }
587
      ]
588
    },
589
590
    // Structured execution arguments
591
    "invocation": {
592
      "job": text,
593
      "pipeline_spec": ObjectRef,      // ObjectRef of .flow/pipeline.kdl
594
      "argv": [text],                  // Unmodified execution vector
595
      "env": map<text, text>           // Explicitly whitelisted environment
596
    },
597
598
    // Environment observations
599
    "metadata": {
600
      "started_on": u64,               // Wallclock milliseconds
601
      "finished_on": u64,
602
      "hermetic": bool,                // Verified zero outbound network access
603
      "reproducible": bool
604
    }
605
  }
606
}
607
```
608
609
### 7.2 Composite Signatures
610
All provenance attestations are signed using Oxygen's composite signature
611
construction (Ed25519 and ML-DSA-65):
612
613
```cbor
614
Signature {
615
  key [0]: KeyId
616
  alg [1]: 1                           // 1 = Ed25519 + ML-DSA-65
617
  ed  [2]: bytes(64)                   // Classical signature
618
  ml  [3]: bytes(3309)                 // Post-quantum signature
619
}
620
```
621
622
Both signatures are computed over:
623
  "oxy1 sig attest\0" || KeyId || ObjectRef
624
625
## 8. Policy Integration & Bookmark Gates
626
627
Oxygen repositories enforce branch and bookmark protections via signed Policy
628
objects (Oxygen Spec Section 14.5). OxygenFlow integrates provenance directly into
629
policy evaluation during push validation.
630
631
### 8.1 Policy Gate Definition
632
A Policy rule governing a bookmark MAY demand valid OxygenFlow attestations. To mitigate a compromised authorized worker, high-security repositories can require **Consensus Builds** by setting the threshold > 1. This requires multiple independent runner identities to arrive at the exact same output hashes and both sign it.
633
634
```json
635
PolicyRule {
636
  pattern: "bookmarks/production"
637
  keys: [ KeyId ]
638
  threshold: 1
639
  require: "signed"
640
  allow_conflicts: false
641
  require_attestations: [
642
    {
643
      type: "flow/provenance/v1",
644
      job: "release-provenance",
645
      require_hermetic: true,
646
      signer_roles: [ "official-worker" ]
647
    }
648
  ]
649
}
650
651
### 8.2 Push Verification Sequence (VCS Engine Enforcement)
652
When a push request arrives at an Oxygen server attempting to update a
653
protected bookmark:
654
1. Object Integrity: Validate that all changes, chunks, and blobs exist and match
655
   their BLAKE3 hashes.
656
2. Attestation Resolution: Verify that an Attest object of type
657
   "flow/provenance/v1" is present, referencing the exact heads of the new
658
   State.
659
3. Identity Verification: Validate that the attestation's composite signature
660
   resolves to a KeyId listed as an authorized delegate of the repository
661
   policy roots.
662
4. Invariant Checking: Confirm that the provenance statement records
663
   "hermetic: true" and exit code 0.
664
5. Atomic Update: If validation fails at any point, the entire push is refused
665
   with ok = false.
666
667
## 9. Zero-Environment Secret Brokering
668
669
OxygenFlow forbids the injection of raw secret strings into process environment
670
tables to eliminate accidental leaking via child process dumping, procfs
671
reads, and verbose compiler logging.
672
673
### 9.1 Ephemeral Secret Broker
674
1. If a job requires a credential (e.g., signing key, cloud deployment token),
675
   it declares a secret mount:
676
     secret "deploy-token" {
677
         vault-ref "infra/tokens/prod"
678
         mount-path "/run/secrets/token"
679
     }
680
2. The runner negotiates a short-lived token lease from the configured vault.
681
3. The secret is mounted onto an ephemeral, in-memory ramfs location inside
682
   the sandbox with access mode 0400, owned exclusively by the worker process.
683
4. Upon process termination, the memory pages are zeroized and the token is
684
   marked for immediate revocation at the vault.
685
686
## 10. Conformance and Verification Requirements
687
688
A conforming OxygenFlow implementation MUST pass the following tests:
689
690
1. Injection Immunity: Attempting to supply unescaped shell metacharacters
691
   (; && | ` $() \n) in any job field MUST pass those characters as literal
692
   bytes to argv; subshells MUST NOT be spawned.
693
2. FastCDC Determinism: Chunks produced by artifact extraction MUST match
694
   the gear table cuts and BLAKE3 hashes generated by Oxygen's core chunker.
695
3. Commutation Hit Invariance: For any two commuting changes A and B, running
696
   a pipeline on State(A, B) MUST reuse cached receipts generated on State(A)
697
   for any job whose scope does not intersect the touched paths of B.
698
4. Non-Downgrade Attestation: An attestation missing the ML-DSA-65 component
699
   MUST be rejected by policy verification.
700
5. Hermetic Network Isolation: Jobs configured with network "isolated" MUST
fd2d4822 Andy McCall ↶ 701
   have outgoing TCP SYN and UDP packets dropped at the hypervisor boundary.
630ee660 Andy McCall ↶ 702
## 11. Runner Capabilities and Placement (proposed 2026-10-04; §11.2 and `arch` of §11.3 done the same day; tiers of §11.1, §11.5 and the waiting reasons of §11.4 done 2026-10-05, oxygenflow#36)
fd2d4822 Andy McCall ↶ 703
704
A runner MUST never take a job it cannot run or cannot finish well: the
705
wrong architecture, no hardware virtualisation for the MicroVM tier, too
706
little memory, an image it does not hold, or a machine too slow for the
707
job's time limit. Today a runner reports its architecture, OS, labels,
708
job slots, memory and vCPUs when it registers and on each claim, and a
709
claim carries the tiers it can run, the memory and vCPUs free now, and
710
the images it holds; the hub matches tier, room, labels, scope and image.
711
What is missing: architecture is reported but never matched (an image's
712
architecture is implicit in its bytes), a pipeline cannot say which
713
architecture it needs or offer a rootfs per architecture, speed and load
714
play no part, and a runner cannot decline a job it was handed.
715
716
### 11.1 Capability Profile
717
718
At registration and on every claim a runner sends its profile:
719
720
| Field | Meaning |
721
|---|---|
722
| `arch`, `os`, `kernel` | `x86_64`, `aarch64`, `riscv64`, …; the kernel release |
723
| `tiers` | The sandbox tiers it can honour: `microvm` only with `/dev/kvm` usable (a board without KVM, such as an OrangePi RV2, offers `syscall`, §4.2, and `wasm`) |
724
| `memory_mib`, `cpus`, `max_jobs` | What its jobs share |
725
| `images` | The rootfs images it holds, each with the architecture its manifest records (§11.2) |
726
| `labels` | As §3.1 |
62829d15 Andy McCall ↶ 727
| `speed` | A score and a class from 1 (slow) to 5 (fast), measured by the runner at start, again every 15 minutes while it runs no job, and by `flow runner bench`: a fixed one-thread workload (BLAKE3 over 256 MiB, and a sort of 4 Mi words, where a C compiler cannot be assumed) whose time on the reference machine (Earth, about 225 ms) scores 100; class 3 is 70–139, each class a factor of two (done 2026-10-11, `facts` on the claim) |
728
| `load` | The 1-minute load average (×100), and the free disk where jobs' disks are made, sent with every claim (`facts`); memory free and jobs running as before |
fd2d4822 Andy McCall ↶ 729
730
### 11.2 Image Manifests Carry the Architecture
731
732
`flow rootfs import` reads the ELF header of the image's `/bin/sh` and
733
records its architecture in the CAS manifest beside the hash. A runner
734
refuses to import an image for another architecture (there is no
735
emulation tier). An image imported before this section has no recorded
736
architecture and is treated as the importing runner's.
737
738
### 11.3 Job Requirements
739
740
Hard requirements, all of which a runner MUST satisfy to be offered the
741
job: the sandbox's tier, its rootfs (hence the image's architecture),
742
`memory-limit`, `cpus`, every `runs-on` label of the job and its sandbox,
743
and the runner's scope (OxygenHub spec §13.2). Two additions to the
744
language:
745
746
- `arch "riscv64"` on a sandbox pins the architecture; without it the
747
  architecture is the rootfs image's.
748
- A rootfs per architecture: `rootfs { x86_64 "cas://blob/…"; riscv64 "cas://blob/…" }`.
749
  The job runs on whichever architecture takes it; the receipt and the
750
  provenance record the architecture and image used, and a check's
751
  description names them.
752
753
Soft requirements guide placement but never block it: a job's `timeout`
754
against the runner's speed class. The hub keeps, per job hash and speed
755
class, the median duration of past runs; a runner whose class predicts a
756
duration over the limit is offered the job only when no better runner
757
is free.
758
759
### 11.4 Placement
760
761
The hub filters by the hard requirements, then ranks the runners that
762
remain: idle before busy (`load`), a higher speed class first, a runner
763
already holding the image before one that must fetch it (§5), fewer jobs
764
waiting on it first. A job no runner can satisfy waits and the queue
765
says what it waits for: tier, architecture, image, memory, labels or
766
scope, so the gap is visible rather than a silent stall.
767
768
### 11.5 Declining
769
770
A runner double-checks a claim before it starts: the architecture, that
771
`/dev/kvm` opens for the MicroVM tier, that the image's blob is present
772
and verifies, that the memory is free. If any check fails it answers the
773
hub with `declined` and a reason instead of running and failing; the hub
774
re-queues the job, never offers it to that runner again until its
775
profile changes, records the decline on the runner's page, and after
776
three declines by different runners marks the job `unplaceable` with the
777
reasons. A decline is never a failed check on the state.
778
630ee660 Andy McCall ↶ 779
As built: the runner sends `POST /api/v1/flow/jobs/{id}/decline` with
780
`{"reason": …}` before it fetches anything. The profile is a hash of the
781
tiers, images, architecture, labels and capacity a runner claims with.
782
A decline also lapses after ten minutes, so a passing reason such as
783
memory in use does not bar a runner for good. An unplaceable job ends
784
with status `error` and an error beginning `unplaceable:`. The hub
785
works out why each ready job waits every 15 seconds, and the run page and
786
the API (`waiting`) show it.
787
89171fca Andy McCall ↶ 788
### 11.5.1 Restarts (oxygenflow#49, #50)
789
790
Neither a hub restart nor a runner restart costs a job anything.
791
792
- **The hub away.** A job's uploads (artifacts, report files) and declines
793
  are tried again through refused connections and server errors (5xx,
794
  as a proxy answers while the hub restarts) for three minutes, waiting
795
  1, 2, 4, 8 and then 15 seconds; a refusal (4xx) is final. Log lines
796
  the hub could not take are kept and sent with the next batch, 200 lines
797
  at a time, up to 50,000 (beyond that the oldest go, and the log says how
798
  many). A job's result is kept on disk and offered for two hours, as
799
  before. Claims are not retried through a lost connection, so a job is
800
  never claimed twice; the runner simply asks again.
801
- **The runner restarted.** The first SIGTERM or SIGINT drains the runner:
802
  it claims nothing more and stops once every job it holds has ended and
803
  been reported. A second signal stops it at once. Its systemd unit says
804
  `KillMode=mixed`, so only the runner is signalled and its microVMs run
805
  on, and `TimeoutStopSec` longer than the longest job, after which
806
  systemd kills what is left. A new binary is installed by replacing it
807
  and restarting the unit (`systemctl restart --no-block`): the old runner
808
  finishes its job, and `Restart=always` starts the new one.
4dd392d1 Andy McCall ↶ 809
  `flow runner drain` asks the same by a `drain.request` file in the
810
  runner's home, which its loop reads: the way on Windows, which has no
811
  SIGTERM (oxygenflow#83).
89171fca Andy McCall ↶ 812
06a4c472 Andy McCall ↶ 813
### 11.5.2 Handing back (oxygenflow#76)
814
815
A runner that leaves while it holds a job, with no time to finish it,
816
hands the job back: `POST /api/v1/flow/jobs/{id}/release` with
817
`{"reason": …}` (a phone off its allowed network, docs/handover.md §6).
818
The hub queues the job again **ahead of new work**, whatever its
819
priority, adds a line to its log saying who handed it back and why, and
820
lets the next attempt's log follow on. It is not a decline: the runner is
821
not held from the job and it does not count towards unplaceable.
822
823
**Leases.** Holding a job is a lease the runner keeps by being heard from:
824
claims, a heartbeat every 30 seconds while it claims nothing, its jobs'
825
logs. When the hub has not heard from a runner for 3 minutes, its jobs
826
are handed back the same way, so a runner that vanishes (out of every
827
network, crashed) costs a restart of its job, not the job. A job handed
828
back more than 5 times ends as an error saying so.
829
1b160d37 Andy McCall ↶ 830
**Notice.** A departure may come with notice (a phone taken off charge
831
has a minute; a spot reclaim 30 seconds to 2 minutes). A claim carries
832
`expected_ms`, how long the job is expected to take, when the hub has
833
learned it: the median of the job's last five passing runs in that
834
repository (reused passes left out). A leaving runner finishes and
835
reports a job whose expected rest fits within the notice, and hands back
836
the others at once, and any job still running when the notice is up. A
837
job with no expected time is handed back at once.
838
f201e1bc Andy McCall ↶ 839
**Checkpoints (#77).** A job may name directories that hold its progress:
840
`checkpoint "/src/target"` (one or more, under /src, not /src itself).
841
When its runner hands it back, the runner packs them (files with their
842
modes and modification times, which cargo's fingerprints read; at most
843
512 MiB) and keeps them with `POST /api/v1/flow/jobs/{id}/checkpoint`
844
before the release; the claim of the next attempt names the blob
845
(`checkpoint`), and that runner fetches it (`GET` on the same path),
846
checks it, and restores it over the job's cache before running the same
847
exec, so a tool that skips finished work carries on. The receipt lists
848
the checkpoint among the job's inputs. As built: the WASM and syscall
849
tiers save and restore checkpoints, under a disk mount or in the tree;
850
the MicroVM tier, whose files are in an image, starts again for now.
851
1b160d37 Andy McCall ↶ 852
As built (flow 0.3.2, OxygenHub 0.9.4): the runner as a library has
853
`runner::leave(reason)` (no notice) and `runner::leave_within(reason,
854
notice)` beside `runner::stop()`: each claims nothing more and stops the
855
jobs it does not finish (their logs sent first), releasing them; if the
06a4c472 Andy McCall ↶ 856
release cannot be sent, the lease does it. A host's SIGTERM still drains
1b160d37 Andy McCall ↶ 857
by finishing what it holds. Checkpoints (#77), so the next attempt
858
resumes rather than restarts, come next.
06a4c472 Andy McCall ↶ 859
85275e1e Andy McCall ↶ 860
### 11.5.3 Updating a runner (oxygenflow#85)
861
862
`flow runner update --from FILE` installs a new `flow` build in place of
863
the one it runs as (`--exe` names another), the runner's side of
864
self-updating runners (docs/jetstream.md §8.2):
865
866
1. **Refused** when the home's `flow.toml` says `[runner.update] allow =
867
   false`, when an earlier update is not yet proven, or when the build is
868
   older than the installed one (unless `--allow-older`).
869
2. **Checked:** a 64-bit little-endian ELF for this machine; it names
870
   itself (`--version`, `flow X.Y.Z …`) and finds a tier it can run here
871
   (`tiers` against the runner's home), each within 30 seconds.
872
3. **Staged and swapped:** copied beside the installed binary as
873
   `flow.new` and checked there; the installed one is kept as
874
   `flow.prev` (a hard link, else a copy), then `flow.new` replaces it in
875
   one rename, so `flow` is never missing. `--dry-run` stops before the
876
   swap and changes nothing.
877
4. **The running runner leaves:** a runner writes its pid to
878
   `runner.pid` in its home, and the update sends it SIGUSR1 (after
879
   checking that pid is still a `flow … runner`). It then leaves with
880
   `--notice` (default 600 s, §11.5.2): jobs expected to finish in time
881
   finish, the rest are handed back with their checkpoints, and it exits
882
   0, so its unit's `Restart=always` starts the new build. A runner from
883
   before #85 is not told; restarting its unit drains it as before.
884
5. **Proven or rolled back:** the update waits in `update.json` until the
885
   new build's first claim gets an answer from the hub. Each start counts;
886
   on the fourth start without that answer, or after ten minutes running
887
   without it, `flow.prev` is put back (and on a start, run in its place).
888
   `updates.log` in the home records every install, proof and rollback.
494a1b9a Andy McCall ↶ 889
6. **On Windows** (oxygenflow#83) the same steps run with Windows' means:
890
   the build is checked as a PE executable for this machine; `flow.exe`
891
   is renamed to `flow.prev.exe` and `flow.new.exe` into its place (a
892
   running program can be renamed but not replaced, and cannot rename
893
   its own file, so a copy of it, `flow __rename`, does that); the runner
894
   is told by an `update.request` file in its home, which it reads in its
895
   loop, there being no SIGUSR1; and having left, it exits 75, so a Task
896
   Scheduler task set to restart on failure starts the new build. A
897
   rollback runs the restored build in its place and ends with it.
85275e1e Andy McCall ↶ 898
fd2d4822 Andy McCall ↶ 899
### 11.6 Conformance
900
901
1. Architecture Safety: a job whose image is `x86_64` MUST never be
902
   offered to a `riscv64` runner, with or without the image copied there.
903
2. Tier Safety: a runner without `/dev/kvm` MUST NOT be offered a
904
   MicroVM job, and MUST decline one if handed it.
905
3. Room: a job whose `memory-limit` exceeds the runner's free memory
906
   MUST wait, not be killed.
907
4. Visibility: a job nobody can take MUST say why on the queue within
908
   one scheduling pass.
909
5. Preference: with two idle runners that both satisfy a job, the hub
910
   MUST offer it to the higher speed class, and to the one holding the
911
   image when classes tie.