OXYGENHUB
◆ v0.2.0 oxygenflow / docs / spec.md
37.9 KiB · Markdown · last changed Build caches for the syscall tier 16 days ago renderedsource blame history raw
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
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
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
94
    network "isolated"      // Options: "isolated" | "loopback" | "egress" { allow "host"... } (§4.3.1)
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
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
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
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
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
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
196
- Intended for static linters, formatters, doc generators, and policy checks.
197
- Runs on a standard WebAssembly System Interface (WASI) runtime.
198
- Startup latency: < 5 ms.
199
- Zero host I/O; virtualized file system presented in-memory.
200
201
### 4.2 Level 1: Intercepted Syscall Isolation (gVisor / Landlock + seccomp-bpf)
202
- Intended for standard compilation and hermetic test suites.
203
- Emulates or filters Linux system call interfaces in user space.
204
- Blocks access to raw network sockets, real-time hardware clocks, and device
205
  nodes.
206
- Memory and execution CPU quotas are strictly bounded via cgroups v2.
207
208
### 4.3 Level 2: MicroVM Isolation (Firecracker / Cloud-Hypervisor)
209
- Intended for kernel tests, multi-container integration, and untrusted code.
210
- Ephemeral Linux microVM booting in < 80 ms.
211
- The root filesystem is presented as a read-only virtio-block device mapped
212
  directly to FastCDC chunks stored in Oxygen's CAS.
213
- Guest VM memory is cleared upon termination.
214
215
#### 4.3.1 Allow-listed egress (oxygenflow#55)
216
217
A sandbox reaches the network only by naming its hosts:
218
219
```kdl
220
sandbox "deploy" {
221
    runtime "microvm"
222
    network "egress" { allow "*.googleapis.com" "registry.opentofu.org" }
223
}
224
```
225
226
The VM still has no network device. `flow-init` serves a proxy on the
227
guest's `127.0.0.1:3128` (the job gets `HTTPS_PROXY`, `HTTP_PROXY` and
228
their lower-case forms, unless it sets them) and relays each connection,
229
unread, over Firecracker's vsock to the runner. The runner accepts only
230
`CONNECT host:443` for a host the list allows (a name exactly, or any
231
name under a `*.` domain, never the domain itself; never an address),
232
resolves it itself (the guest does not resolve), refuses any name that
233
resolves to an address that is not public, and relays the bytes without
234
opening the TLS. Every decision, allowed or refused, is a `flow` line in
235
the job's log. Patterns are lower-case host names of two or more labels,
236
at most 32 per sandbox, and part of the sandbox's hash.
237
238
Egress is off unless a runner turns it on (`egress = true` under
239
`[runner]` in `flow.toml`); such a runner offers the `egress` label, and
240
an egress sandbox needs it, so the hub hands its jobs only to runners
241
that allow it, and a runner without it refuses one anyway. The syscall
242
runtime has no egress yet.
243
244
**Keyless receipts** (oxygenhub#241). With `keyless = true` under
245
`[runner]` (or in `runner.toml`), a runner signs each job's receipt with a
246
fresh key instead of its own: just before signing, it asks the hub to
247
certify the key (`POST /api/v1/keyless/certify` with the job's token and
248
the key's proof of possession, scope `seal`), checks the certificate is
249
for that key and signed by the key the hub publishes at
250
`/.well-known/oxyhub-key`, signs, attaches the certificate and the hub's
251
identity to the receipt (Oxygen spec §14.6), and drops the key. When the
252
hub cannot certify, the runner's own key signs and the job's log says
253
why. The runner's key then only authenticates it to the hub.
254
255
## 5. Content-Addressable Storage (CAS) & Zero-Copy Mounting
256
257
OxygenFlow runners bypass traditional clone operations. Repositories are accessed
258
directly via the local object store (.oxy/objects/) or streamed on demand
259
using Oxygen's wire protocol.
260
261
### 5.1 FUSE Overlay Mounting (flow-casfs)
262
1. The runner receives a task targeting an Oxygen State ObjectRef (a sorted
263
   list of maximal heads).
264
2. The state's tree is read from a state index (Oxygen's flat, checksummed
265
   description of a history-only state: its changes, tree view and each
266
   file's deferred history with its graph key), built once from the
267
   nearest checkpoint plus the changes after it and kept beside the store.
268
   Listing a directory needs nothing else.
269
3. The tree is exposed to the sandbox read-only through flow-casfs (FUSE):
270
   - An opaque file's bytes are its stored blob, whose chunks (FastCDC,
271
     32 KiB to 256 KiB, mean 64 KiB, Oxygen spec Section 13.2) are read as
272
     they are needed.
273
   - A text file's bytes are a rendering of its history, not a stored blob.
274
     Renderings are cached by **graph key** (equal keys mean equal
275
     renderings) as ordinary Blob and Chunk objects: a file is rendered on
276
     first read or stat, and every later state in which it has the same
277
     history finds it at once. A file added once and never edited is its
278
     own text blob and needs no rendering at all.
279
   - Missing objects are fetched lazily using the POST /objects protocol.
280
   - To prevent FUSE context-switch bottlenecks on many small reads,
281
     flow-casfs caches whole small files and mmaps chunk data, relying on
282
     the host page cache.
283
   - All guest mutations are diverted to an overlay on the job's ephemeral
284
     disk (or a tmpfs); base objects remain immutable.
285
4. The same mount backs web workspaces (OxygenHub spec 13.3): a
286
   `workspace` job keeps it for as long as its editor is open.
287
5. Targets, measured on the Linux tip: mount under 100 ms, a first read of
288
   a file in milliseconds, and a full read of the tree no slower than a
289
   checkout writing it.
290
291
### 5.2 Artifact Capture
292
1. At task completion, flow-casfs scans the paths declared in the output block.
293
2. Modified outputs are chunked with FastCDC, hashed via BLAKE3-256, and
294
   written as canonical Blob and Chunk objects.
295
3. Output ObjectRefs are stored directly in the Oxygen repository.
296
4. Outputs are read when the job passes. An artifact with `when "always"`
297
   (default `when "passed"`) is also read when the job fails or is stopped
298
   at its time limit, so a test report survives the failure it describes.
299
   From a job that did not pass it is kept and shown, but its receipt never
300
   names it, and one that cannot be read is only noted in the log.
301
302
```kdl
303
output {
304
    artifact "junit" {
305
        path "/src/target/junit.xml"
306
        when "always"
307
    }
308
}
309
```
310
311
5. A `report` output (OxygenHub `docs/reports.md`) names a directory
312
   holding `report.toml` at its top. The runner reads its regular files
313
   (links and anything else are left out, never followed; file names hold
314
   letters, digits, `.`, `_`, `-` and `+`; at most 2000 files and 512 MiB),
315
   uploads each to `POST /api/v1/flow/jobs/{job}/reports/{name}/files` with
316
   its path in `X-Flow-Report-Path`, then uploads a manifest,
317
   `{"version":1,"files":[{"path","blob","size"}]}`, as the output under
318
   the report's name, checking every blob the hub answers. The receipt
319
   names the manifest. Reports and artifacts share names; a report's kind
320
   is part of the job's hash (`[name, path, "report"]`).
321
322
```kdl
323
output {
324
    report "frame-timing" {
325
        path "/src/out/report"
326
        when "always"
327
    }
328
}
329
```
330
331
### 5.3.1 Artifacts between jobs (oxygenflow#58)
332
333
A job takes an artifact of a job it depends on:
334
335
```kdl
336
job "apply" {
337
    depends-on "plan"
338
    input {
339
        artifact "tfplan" from "plan"
340
        path "/src/tfplan"
341
    }
342
}
343
```
344
345
The producer must be named in `depends-on` and declare that name as an
346
artifact (not a report); paths are clean absolute paths under `/src`, at
347
most 8 inputs, and they are part of the job's hash (`[artifact, from,
348
path]`, field 10). Since the producer has passed when the job is handed
349
out, the hub puts each input in the claim with the blob the producer's
350
receipt names (a passing job's receipt names exactly the artifacts it
351
uploaded). Before the job starts, the runner fetches each from
352
`GET /api/v1/flow/jobs/{job}/inputs/{index}`, checks its Oxygen blob
353
reference against that blob, refuses the job if they differ, and writes it
354
at its path in the workspace (not part of the scope hash: it belongs to the
355
run, not the repository). The job's receipt lists the blobs as its
356
`inputs`, so an apply job's receipt proves which plan it applied.
357
358
### 5.3.2 Approval gates (oxygenflow#57)
359
360
A job can wait for a person:
361
362
```kdl
363
job "apply" {
364
    depends-on "plan"
365
    approval {
366
        by "maintain"        // the least role: "write", "maintain" (default) or "admin"
367
        others-only #true    // not the person whose push started the run
368
        expires "24h"        // from when the jobs it depends on are done; up to 720h
369
        sealed #true         // signed with the approver's key; default: on with an environment
370
    }
371
}
372
```
373
374
The hub hands such a job to no runner until someone with that role on the
375
repository approves it, on the run page or through the API; others-only
376
leaves out whoever pushed. Approving or rejecting is recorded on the job
377
(who, when) and in the audit log. A rejected or expired job ends as
378
cancelled and the jobs after it are skipped; a newer push to the
379
bookmark cancels the run as before, so a stale plan is never applied. The
380
approval is part of the job's hash (field 11).
381
382
**Sealed approvals (oxygenhub#235).** With `sealed` (the default for a job
383
that names an environment, §5.3.3), pressing Approve is not enough: the
384
approver signs an Oxygen `approval` attestation with their own key
385
(`oxy seal --flow URL --job NAME`; Oxygen spec §14.4) covering the run, the
386
job's hash, the state, the input blobs (the reviewed plan) and the
387
environment. The hub starts the job only once it verifies, the key is
388
linked to an account with the role, and it is not a delegated key; it keeps
389
the approval in the repository, and the job's identity tokens name the
390
approver and the approval's hash. Rejecting needs no seal.
391
392
**Agents (oxygenhub#229, #258).** A gate is there so a person decides. A
393
decision made through an agent's token (an agent-marked token, or a keyless
394
agent's grant) is refused unless the repository lets agents decide its
395
gates (its Settings › OxygenFlow, for maintainers; off by default, audited
396
when changed). Where allowed, it says so on the job, the run and the audit
397
log ("approved by carol via claude-code"). A sealed approval is a person's
398
own key, whatever carried it, and is not affected.
399
400
### 5.3.3 Environments (oxygenflow#59)
401
402
`environment "prod"` on a job says where it deploys (1 to 32 of `a-z`,
403
`0-9`, `-`; part of the job's hash, field 12). The hub keeps what each
404
environment of a repository runs, from the jobs that passed for it (state,
405
run, when, who approved), on the repository's Deployments page. The job's
406
identity tokens carry an `environment` claim only when the job was
407
approved (§5.3.2): a job with no approval block, or one not approved, gets
408
tokens without it. So a cloud's trust condition can require
409
`environment == "prod"`, and nothing unapproved deploys there, even from
410
the deploy bookmark. The approval block is the environment's protection
411
rule for now.
412
413
### 5.4 The Build Cache (oxygenflow#28)
414
415
An `ephemeral://disk` mount may name a `cache`, and the files that key it:
416
417
```kdl
418
mount {
419
    source "ephemeral://disk"
420
    target "/src/target"
421
    size "24GiB"
422
    cache "target"
423
    key "Cargo.lock" "rust-toolchain.toml"
424
}
425
```
426
427
Such a disk is not always empty at the start. Each runner keeps a pool of
428
the disks of passing jobs, by repository, job, cache name and bookmark,
429
named by the **key**: the BLAKE3 of the sandbox image, the job's name, the
430
cache name, and each key file's content in the job's state. A job's disk
431
starts as, in order: its bookmark's disk with the same key (moved), its
432
bookmark's newest disk (moved), another bookmark's with the same key and
433
then another's newest (copied, so a proposal never takes the default
434
bookmark's), and otherwise an empty disk. A microVM's disk must be the
435
size the mount asks for.
436
437
- **Only passing jobs keep a disk.** When the job and its outputs pass,
438
  its cached disks go back into the pool under their key; otherwise they
439
  are discarded with the scratch directory, so nothing a failing job wrote
440
  reaches a later one.
441
- **The receipt says so.** The job's environment gains `cache TARGET` with
442
  the key and what the disk started from, so the receipt's environment
443
  hash differs from a cold build's.
444
- **Bounded.** The pool keeps under `cache_gb` in the runner's config
445
  (default 64 GiB) by dropping the disks used longest ago.
446
- **Unchanged sources keep their times** (oxygenflow#52). Beside each kept
447
  disk the pool keeps its sources: each workspace file's content hash and
448
  the mtime it had, in whole seconds (what the workspace image keeps). A
449
  job that takes the disk gives each file whose content is unchanged that
450
  mtime back before the workspace is imaged; a changed or new file keeps
451
  the time of its checkout, newer than anything on the disk. A build tool
452
  that judges freshness by time, such as cargo, then rebuilds exactly the
453
  crates whose sources changed, where a fresh checkout would make every
454
  path crate look changed. Directories are kept the same way, by their
455
  listing (the names in them): an unchanged one gets its old time back,
456
  one that gained or lost an entry keeps its new time, so a build
457
  script's `rerun-if-changed` on a directory sees exactly what changed.
458
  The log says how many files and directories kept their times. A build
459
  script that reads a per-state value (the Oxygen crates' `FLOW_HEADS`)
460
  reruns on every state; those crates read it only when `OXY_BUILD` is
461
  unset, so a pipeline that sets `OXY_BUILD` keeps them fresh.
462
- **Jobs go where their cache is** (oxygenflow#51). Each claim lists the
463
  caches the runner holds a disk of (`caches`, each
464
  `flow_core::api::cache_slot(repo, job)`), and the hub ranks a runner
465
  holding a job's cache above one holding its image (§11.4): a job another
466
  free runner holds the cache for is held for it for up to 15 seconds, and
467
  `placed` says "holds its build cache". When several hold it, the
468
  freshest copy wins (oxygenflow#54): claims also say when each slot last
469
  kept a disk (`cache_times`, Unix ms), and a copy kept at least a minute
470
  later ranks above an older one, before the image and speed are
471
  weighed; `placed` says how old the copy is.
472
- **The syscall tier keeps directories** (oxygenflow#70). Its
473
  `ephemeral://disk` mount is a host directory bound at the target, so
474
  its pool holds directories (`<key>.tree`) beside the microVM's images
475
  (`<key>.ext4`), taken and kept the same way: moved out of the pool for a
476
  job of the same bookmark (so two jobs of one slot running at once never
477
  take the same one), copied with their modes and times from another
478
  bookmark's, kept only when the job and its outputs pass and otherwise
479
  thrown away, and counted by the blocks of everything in them toward
480
  `cache_gb`. A directory has no size, so `size` does not choose between
481
  them. Each tier takes only its own form: a syscall job never starts from
482
  a microVM's image, nor a microVM from a directory. The job runs as the
483
  runner's user, so what it wrote is the runner's; before a directory goes
484
  into the pool nothing in it is left writable by group or others, or
485
  set-id, and the pool is readable by the runner alone. Claims report the
486
  slots of both forms in `caches` and `cache_times`, so jobs go where
487
  their cache is whichever tier they run in.
488
- A cache is a speed-up, never a source of truth: jobs must build
489
  correctly from an empty disk, which a key change or an eviction gives
490
  them at any time.
491
492
## 6. Commutative Execution & Change Caching
493
494
In Oxygen, changes that do not share scopes (referenced atoms, placements, or
495
nodes) commute. OxygenFlow exploits this invariant to provide granular caching.
496
497
### 6.1 Execution Receipt Object
498
Every successful or failed job run emits an immutable Receipt:
499
500
```cbor
501
Receipt {
502
  version        [0]: 1
503
  job_name       [1]: text
504
  pipeline_hash  [2]: ObjectRef
505
  scope_tree_hash [3]: ObjectRef     // BLAKE3 tree hash of the materialized scope
506
  inputs         [4]: [ObjectRef]   // Artifacts and input files consumed
507
  environment    [5]: ObjectRef     // Hash of rootfs, compiler flags, and argv
508
  outputs        [6]: [ObjectRef]   // Produced artifact blobs
509
  exit_code      [7]: u32
510
  duration_ms    [8]: u64
511
}
512
```
513
514
A Receipt is hashed as an Oxygen object with type name "receipt":
515
ObjectRef = BLAKE3-256("oxy1 receipt " || decimal(len) || 0x00 || body)
516
517
### 6.2 Cache Re-use Invariant
518
Let Scope(J) be the file paths and tree nodes declared by job J.
519
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).
520
521
If an existing Receipt R exists such that:
522
  R.job_name == J.name &&
523
  R.pipeline_hash == Hash(J) &&
524
  R.scope_tree_hash == TreeHash(Scope(J)) &&
525
  R.environment == CurrentEnvironmentHash
526
527
Then the job execution is bypassed. R.outputs are mapped into downstream
528
dependents immediately as a cached-commuted hit.
529
530
## 7. Native Provenance Specification
531
532
OxygenFlow formalizes build provenance as a native, tamper-evident Oxygen Attest
533
object (kind: "attest"). Provenance is generated exclusively by the runner
534
hypervisor, not the guest payload.
535
536
### 7.1 Provenance Object Schema
537
538
```json
539
Attest {
540
  version [0]: 1
541
  kind    [1]: "attest"
542
  repo    [2]: bytes(16)               // Oxygen Repository ID
543
  hlc     [3]: HLC                     // Hybrid Logical Clock
544
  body    [4]: {
545
    "type": "flow/provenance/v1",
546
    
547
    // Subject artifacts produced by the build
548
    "subjects": [
549
      {
550
        "name": text,
551
        "ref": ObjectRef,              // BLAKE3 hash of output blob
552
        "media_type": text
553
      }
554
    ],
555
556
    // Builder platform and execution identity
557
    "builder": {
558
      "runner_id": KeyId,              // ObjectRef of runner's Oxygen Identity
559
      "isolation_level": text,         // "wasm" | "gvisor" | "microvm"
560
      "hypervisor_image": ObjectRef    // Rootfs blob digest
561
    },
562
563
    // Exact input materials
564
    "materials": {
565
      "state_heads": [ChangeHash],     // Oxygen heads of the state built
566
      "scope_tree_hash": ObjectRef,        // Captures exact state without O(N) array bloat
567
      "inputs": [
568
        {
569
          "name": text,
570
          "ref": ObjectRef             // Content hash of locked dependencies
571
        }
572
      ]
573
    },
574
575
    // Structured execution arguments
576
    "invocation": {
577
      "job": text,
578
      "pipeline_spec": ObjectRef,      // ObjectRef of .flow/pipeline.kdl
579
      "argv": [text],                  // Unmodified execution vector
580
      "env": map<text, text>           // Explicitly whitelisted environment
581
    },
582
583
    // Environment observations
584
    "metadata": {
585
      "started_on": u64,               // Wallclock milliseconds
586
      "finished_on": u64,
587
      "hermetic": bool,                // Verified zero outbound network access
588
      "reproducible": bool
589
    }
590
  }
591
}
592
```
593
594
### 7.2 Composite Signatures
595
All provenance attestations are signed using Oxygen's composite signature
596
construction (Ed25519 and ML-DSA-65):
597
598
```cbor
599
Signature {
600
  key [0]: KeyId
601
  alg [1]: 1                           // 1 = Ed25519 + ML-DSA-65
602
  ed  [2]: bytes(64)                   // Classical signature
603
  ml  [3]: bytes(3309)                 // Post-quantum signature
604
}
605
```
606
607
Both signatures are computed over:
608
  "oxy1 sig attest\0" || KeyId || ObjectRef
609
610
## 8. Policy Integration & Bookmark Gates
611
612
Oxygen repositories enforce branch and bookmark protections via signed Policy
613
objects (Oxygen Spec Section 14.5). OxygenFlow integrates provenance directly into
614
policy evaluation during push validation.
615
616
### 8.1 Policy Gate Definition
617
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.
618
619
```json
620
PolicyRule {
621
  pattern: "bookmarks/production"
622
  keys: [ KeyId ]
623
  threshold: 1
624
  require: "signed"
625
  allow_conflicts: false
626
  require_attestations: [
627
    {
628
      type: "flow/provenance/v1",
629
      job: "release-provenance",
630
      require_hermetic: true,
631
      signer_roles: [ "official-worker" ]
632
    }
633
  ]
634
}
635
636
### 8.2 Push Verification Sequence (VCS Engine Enforcement)
637
When a push request arrives at an Oxygen server attempting to update a
638
protected bookmark:
639
1. Object Integrity: Validate that all changes, chunks, and blobs exist and match
640
   their BLAKE3 hashes.
641
2. Attestation Resolution: Verify that an Attest object of type
642
   "flow/provenance/v1" is present, referencing the exact heads of the new
643
   State.
644
3. Identity Verification: Validate that the attestation's composite signature
645
   resolves to a KeyId listed as an authorized delegate of the repository
646
   policy roots.
647
4. Invariant Checking: Confirm that the provenance statement records
648
   "hermetic: true" and exit code 0.
649
5. Atomic Update: If validation fails at any point, the entire push is refused
650
   with ok = false.
651
652
## 9. Zero-Environment Secret Brokering
653
654
OxygenFlow forbids the injection of raw secret strings into process environment
655
tables to eliminate accidental leaking via child process dumping, procfs
656
reads, and verbose compiler logging.
657
658
### 9.1 Ephemeral Secret Broker
659
1. If a job requires a credential (e.g., signing key, cloud deployment token),
660
   it declares a secret mount:
661
     secret "deploy-token" {
662
         vault-ref "infra/tokens/prod"
663
         mount-path "/run/secrets/token"
664
     }
665
2. The runner negotiates a short-lived token lease from the configured vault.
666
3. The secret is mounted onto an ephemeral, in-memory ramfs location inside
667
   the sandbox with access mode 0400, owned exclusively by the worker process.
668
4. Upon process termination, the memory pages are zeroized and the token is
669
   marked for immediate revocation at the vault.
670
671
## 10. Conformance and Verification Requirements
672
673
A conforming OxygenFlow implementation MUST pass the following tests:
674
675
1. Injection Immunity: Attempting to supply unescaped shell metacharacters
676
   (; && | ` $() \n) in any job field MUST pass those characters as literal
677
   bytes to argv; subshells MUST NOT be spawned.
678
2. FastCDC Determinism: Chunks produced by artifact extraction MUST match
679
   the gear table cuts and BLAKE3 hashes generated by Oxygen's core chunker.
680
3. Commutation Hit Invariance: For any two commuting changes A and B, running
681
   a pipeline on State(A, B) MUST reuse cached receipts generated on State(A)
682
   for any job whose scope does not intersect the touched paths of B.
683
4. Non-Downgrade Attestation: An attestation missing the ML-DSA-65 component
684
   MUST be rejected by policy verification.
685
5. Hermetic Network Isolation: Jobs configured with network "isolated" MUST
686
   have outgoing TCP SYN and UDP packets dropped at the hypervisor boundary.
687
## 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)
688
689
A runner MUST never take a job it cannot run or cannot finish well: the
690
wrong architecture, no hardware virtualisation for the MicroVM tier, too
691
little memory, an image it does not hold, or a machine too slow for the
692
job's time limit. Today a runner reports its architecture, OS, labels,
693
job slots, memory and vCPUs when it registers and on each claim, and a
694
claim carries the tiers it can run, the memory and vCPUs free now, and
695
the images it holds; the hub matches tier, room, labels, scope and image.
696
What is missing: architecture is reported but never matched (an image's
697
architecture is implicit in its bytes), a pipeline cannot say which
698
architecture it needs or offer a rootfs per architecture, speed and load
699
play no part, and a runner cannot decline a job it was handed.
700
701
### 11.1 Capability Profile
702
703
At registration and on every claim a runner sends its profile:
704
705
| Field | Meaning |
706
|---|---|
707
| `arch`, `os`, `kernel` | `x86_64`, `aarch64`, `riscv64`, …; the kernel release |
708
| `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`) |
709
| `memory_mib`, `cpus`, `max_jobs` | What its jobs share |
710
| `images` | The rootfs images it holds, each with the architecture its manifest records (§11.2) |
711
| `labels` | As §3.1 |
712
| `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) |
713
| `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 |
714
715
### 11.2 Image Manifests Carry the Architecture
716
717
`flow rootfs import` reads the ELF header of the image's `/bin/sh` and
718
records its architecture in the CAS manifest beside the hash. A runner
719
refuses to import an image for another architecture (there is no
720
emulation tier).
721
722
An image whose manifest records no architecture (imported before this
723
section, or fetched from a hub that did not know it) is read, not
724
guessed: `jet::rootfs` follows `/bin/sh` (else busybox, env or bash)
725
through the image's ext4, symlinks included, to its ELF header, with no
726
mount and no privileges. The runner records the answer in the manifest,
727
so each image is read once, reports it with its claims, and declines a
728
job whose image is for another architecture instead of running it and
729
failing (§11.5). The hub reads the images it keeps the same way
730
(OxygenHub, oxygenhub#173), and an image nobody can read is offered only
731
to the architecture its jobs have passed on before.
732
733
### 11.3 Job Requirements
734
735
Hard requirements, all of which a runner MUST satisfy to be offered the
736
job: the sandbox's tier, its rootfs (hence the image's architecture),
737
`memory-limit`, `cpus`, every `runs-on` label of the job and its sandbox,
738
and the runner's scope (OxygenHub spec §13.2). Two additions to the
739
language:
740
741
- `arch "riscv64"` on a sandbox pins the architecture; without it the
742
  architecture is the rootfs image's.
743
- A rootfs per architecture: `rootfs { x86_64 "cas://blob/…"; riscv64 "cas://blob/…" }`.
744
  The job runs on whichever architecture takes it; the receipt and the
745
  provenance record the architecture and image used, and a check's
746
  description names them.
747
748
Soft requirements guide placement but never block it: a job's `timeout`
749
against the runner's speed class. The hub keeps, per job hash and speed
750
class, the median duration of past runs; a runner whose class predicts a
751
duration over the limit is offered the job only when no better runner
752
is free.
753
754
### 11.4 Placement
755
756
The hub filters by the hard requirements, then ranks the runners that
757
remain: idle before busy (`load`), a higher speed class first, a runner
758
already holding the image before one that must fetch it (§5), fewer jobs
759
waiting on it first. A job no runner can satisfy waits and the queue
760
says what it waits for: tier, architecture, image, memory, labels or
761
scope, so the gap is visible rather than a silent stall.
762
763
### 11.5 Declining
764
765
A runner double-checks a claim before it starts: the architecture, that
766
`/dev/kvm` opens for the MicroVM tier, that the image's blob is present
767
and verifies, that the memory is free. If any check fails it answers the
768
hub with `declined` and a reason instead of running and failing; the hub
769
re-queues the job, never offers it to that runner again until its
770
profile changes, records the decline on the runner's page, and after
771
three declines by different runners marks the job `unplaceable` with the
772
reasons. A decline is never a failed check on the state.
773
774
As built: the runner sends `POST /api/v1/flow/jobs/{id}/decline` with
775
`{"reason": …}` before it fetches anything. The profile is a hash of the
776
tiers, images, architecture, labels and capacity a runner claims with.
777
A decline also lapses after ten minutes, so a passing reason such as
778
memory in use does not bar a runner for good. An unplaceable job ends
779
with status `error` and an error beginning `unplaceable:`. The hub
780
works out why each ready job waits every 15 seconds, and the run page and
781
the API (`waiting`) show it.
782
783
### 11.5.1 Restarts (oxygenflow#49, #50)
784
785
Neither a hub restart nor a runner restart costs a job anything.
786
787
- **The hub away.** A job's uploads (artifacts, report files) and declines
788
  are tried again through refused connections and server errors (5xx,
789
  as a proxy answers while the hub restarts) for three minutes, waiting
790
  1, 2, 4, 8 and then 15 seconds; a refusal (4xx) is final. Log lines
791
  the hub could not take are kept and sent with the next batch, 200 lines
792
  at a time, up to 50,000 (beyond that the oldest go, and the log says how
793
  many). A job's result is kept on disk and offered for two hours, as
794
  before. Claims are not retried through a lost connection, so a job is
795
  never claimed twice; the runner simply asks again.
796
- **The runner restarted.** The first SIGTERM or SIGINT drains the runner:
797
  it claims nothing more and stops once every job it holds has ended and
798
  been reported. A second signal stops it at once. Its systemd unit says
799
  `KillMode=mixed`, so only the runner is signalled and its microVMs run
800
  on, and `TimeoutStopSec` longer than the longest job, after which
801
  systemd kills what is left. A new binary is installed by replacing it
802
  and restarting the unit (`systemctl restart --no-block`): the old runner
803
  finishes its job, and `Restart=always` starts the new one.
804
805
### 11.6 Conformance
806
807
1. Architecture Safety: a job whose image is `x86_64` MUST never be
808
   offered to a `riscv64` runner, with or without the image copied there.
809
2. Tier Safety: a runner without `/dev/kvm` MUST NOT be offered a
810
   MicroVM job, and MUST decline one if handed it.
811
3. Room: a job whose `memory-limit` exceeds the runner's free memory
812
   MUST wait, not be killed.
813
4. Visibility: a job nobody can take MUST say why on the queue within
814
   one scheduling pass.
815
5. Preference: with two idle runners that both satisfy a job, the hub
816
   MUST offer it to the higher speed class, and to the one holding the
817
   image when classes tie.