Skip to content

Commit 3e9fbf8

Browse files
Add CakeML SHA-256 spike (B2 L0): feasibility gate passed
Ported sml-codec SHA-256 to the CakeML subset. Compiles with the verified CakeML compiler (v3400, cake-arm8-64) and reproduces all three test vectors (empty, "abc", 56-char long message) byte-for-byte against the Poly/ML oracle. Documents the dialect gaps (no Word32, no multi-clause fun, no infix/op, etc.) - all mechanical, none cryptographic. Full crypto-tower port is feasible. Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 511137f commit 3e9fbf8

5 files changed

Lines changed: 391 additions & 144 deletions

File tree

cakeml/CAKEML_VERSION

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
CakeML v3400 (prebuilt bootstrapped compiler, cake-arm8-64.tar.gz)
2+
- GitHub release: https://github.com/CakeML/cakeml/releases/tag/v3400
3+
- Release date: 2026-06-19
4+
- Repo commit at spike time: e0e4e28e48d2d8c593c9404ee5ad141ba414a837 (2026-06-21)
5+
- Binary used: cake-arm8-64 (ARM64, native on Apple Silicon)
6+
- Compiler target flag for spike binaries: --target=arm8
7+
- Built compiler verified via hello.cml end-to-end before porting.

cakeml/HOL4_VERSION

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
HOL4 "Trindemossen 2"
2+
- Repo: https://github.com/HOL-Theorem-Prover/HOL
3+
- Commit at spike time: b3aa119cceaeed18a4de28fab271e33945fbdd9c (2026-06-22)
4+
- Built at: /Users/asarkisyan/Documents/HOL (bin/Holmake, bin/hol)
5+
- Smoke-tested: `hol` REPL starts and prints "HOL4 OK".
6+
- Not required for the SHA-256 spike itself: the spike used the
7+
prebuilt bootstrapped CakeML compiler (see CAKEML_VERSION), which
8+
does not require a live HOL4 build. HOL4 is required for the later
9+
refinement-proof phase (J4) and for rebuilding the CakeML compiler
10+
from source.
11+
- A full `Holmake` of the CakeML tree from HOL4 was started and
12+
confirmed to progress past theory compilation (~20 hour build);
13+
it was stopped once the prebuilt compiler proved sufficient for the
14+
spike. See SPIKE_REPORT.md.

cakeml/SPIKE_REPORT.md

Lines changed: 240 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,240 @@
1+
# B2 SHA-256 Spike Report
2+
3+
**Track:** B2 (CakeML crypto-tower port)
4+
**Spike:** L0 SHA-256 (go/no-go gate for the CakeML dialect)
5+
**Status:****GO** — SHA-256 ports to the CakeML subset, compiles with the
6+
verified CakeML compiler, and reproduces all test vectors byte-for-byte.
7+
8+
## Outcome
9+
10+
| Criterion | Result |
11+
|---|---|
12+
| CakeML compiler built and working | ✅ v3400 prebuilt `cake-arm8-64`, verified end-to-end |
13+
| SHA-256 ported to CakeML subset |`cakeml/sha256.sml` (canonical), `cakeml/sha256_test.cml` (harness) |
14+
| Compiles with the CakeML compiler |`cake --target=arm8``.S` → linked binary |
15+
| Correct output for test vectors | ✅ all three PASS, byte-identical to Poly/ML oracle |
16+
| Feasibility assessment recorded |**GO** for the full crypto-tower port |
17+
18+
### Test vectors (all PASS)
19+
20+
| Input | Expected | CakeML output | Match |
21+
|---|---|---|---|
22+
| `""` | `e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855` | `e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855` ||
23+
| `"abc"` | `ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad` | `ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad` ||
24+
| `"abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq"` (56 chars, 2 blocks) | `248d6a61d20638b8e5c026930c3e6039a33ce45964ff2167f6ecedd419db06c1` | `248d6a61d20638b8e5c026930c3e6039a33ce45964ff2167f6ecedd419db06c1` ||
25+
26+
The CakeML-compiled binary's output is **byte-identical** to the original
27+
sml-codec SHA-256 run under Poly/ML (the oracle) and to the published RFC
28+
6234 / FIPS 180-4 vectors.
29+
30+
## Toolchain
31+
32+
- **CakeML:** v3400 release (2026-06-19). Used the prebuilt bootstrapped
33+
compiler `cake-arm8-64.tar.gz` (ARM64, native on the Apple M2 Pro spike
34+
host). The compiler is itself a verified CakeML program; the prebuilt
35+
`.S` is the bootstrapped output of the CakeML compiler compiled by
36+
itself. Pinned in `CAKEML_VERSION`.
37+
- **HOL4:** "Trindemossen 2", commit `b3aa119c…` (2026-06-22). Not required
38+
for the spike itself — the prebuilt compiler suffices — but a full
39+
`Holmake` of the CakeML tree was started from HOL4 and confirmed to
40+
progress past theory compilation. It was stopped once the prebuilt
41+
compiler proved sufficient (the full build is ~20 hours / ~16 GB RAM
42+
per `build-instructions.sh`). HOL4 is required for the later
43+
refinement-proof phase (J4). Pinned in `HOL4_VERSION`.
44+
- **Oracle:** MLton + Poly/ML on the original `sml-codec/sha256.{sig,sml}`,
45+
run via `/tmp/oracle_check.sml`. Both agree with the CakeML port.
46+
47+
### Reproduction
48+
49+
From a directory containing the v3400 `cake` binary and `basis_ffi.c`:
50+
51+
```sh
52+
# 1. Compile the port (canonical source + driver) to machine code
53+
cake --target=arm8 <combined.cml >combined.cake.S
54+
# 2. Link with the CakeML FFI runtime
55+
cc combined.cake.S basis_ffi.c -lm -o combined.cake
56+
# 3. Run
57+
./combined.cake
58+
```
59+
60+
Where `combined.cml` is `cakeml/sha256.sml` concatenated with a driver that
61+
calls `Sha256.hexDigest` and prints the result. The self-contained harness
62+
`cakeml/sha256_test.cml` inlines the structure and runs all three vectors
63+
with PASS/FAIL output.
64+
65+
## Dialect gaps found
66+
67+
The sml-codec SHA-256 is plain SML and almost clean CakeML. The port
68+
required the following changes, all mechanical and bounded. None are
69+
crypto-algorithmic; they are all surface syntax / basis-library gaps.
70+
71+
### 1. No `Word32` module (the big one)
72+
73+
**CakeML basis has `Word8` and `Word64` only — no `Word32`.** SHA-256 is
74+
built entirely on 32-bit word arithmetic.
75+
76+
**Fix:** emulate `Word32` using `Word64` plus a `0wxFFFFFFFF` mask applied
77+
after every `+` and `<<` (the two ops that can exceed 32 bits). XOR/AND/OR
78+
are width-preserving so no mask is needed there. A helper `add32 a b =
79+
Word64.andb (Word64.+ a b) mask32` wraps the addition; `lsl32` masks the
80+
left shift. `rotr` masks the left half of the rotation.
81+
82+
**Impact on the rest of the tower:** every crypto primitive that uses
83+
`Word32` (SHA-256, SHA-512's 32-bit cousin, HMAC, AES, ChaCha20, etc.)
84+
needs the same `add32`/`lsl32`/`mask32` shim. This is a one-time,
85+
copy-pasteable pattern — **not a blocker**. For 64-bit-word primitives
86+
(SHA-512, Poly1305) `Word64` is used directly.
87+
88+
### 2. No `IntInf` — but CakeML `int` is already arbitrary precision
89+
90+
The original uses `IntInf` for the message bit-length (to handle >2GB
91+
messages). CakeML's `int` is unbounded, so `IntInf` is unnecessary — plain
92+
`int` works. The `IntInf.~>>`/`IntInf.andb`/`IntInf.toInt` calls become
93+
ordinary `div`/`mod` (CakeML has no `>>` on `int` either — see gap 3).
94+
95+
### 3. No `>>` / `<<` on `int`
96+
97+
CakeML's `Word64.<<` / `Word64.>>` exist (and take an `int` shift count),
98+
but there is no shift on `int` itself. The padding code's
99+
`bitLen >> (i*8)` becomes `bitLen div (shiftFactor i) mod 256`, where
100+
`shiftFactor` is a small lookup table for `256^i`, `i ∈ [0,7]`.
101+
102+
### 4. No `StringCvt` / `Word32.fmt` / `StringCvt.padLeft`
103+
104+
The original formats hex via `Word32.fmt StringCvt.HEX` and zero-pads with
105+
`StringCvt.padLeft`. CakeML has neither. **Fix:** hand-rolled `hexDigit`,
106+
`hexByte`, and `hexWord` functions that walk the 4 nibbles of each byte
107+
and emit lowercase hex. ~12 lines, fully self-contained.
108+
109+
### 5. No `Char.toLower`
110+
111+
Not needed for the spike (we emit lowercase directly), but noted for the
112+
PEM/ASN.1 ports later. Hand-rolling is trivial.
113+
114+
### 6. No `infix` declarations (at all)
115+
116+
CakeML does not accept `infix` declarations, neither at top level nor
117+
inside `struct`. The original declares `infix andb orb xorb`, `infix << >>`,
118+
`infix 6 ++`. **Fix:** drop all `infix`/`op` and use plain curried function
119+
calls: `add32 a b`, `andb a b`, `xorb a b`, etc. This makes the call sites
120+
more verbose but is purely syntactic.
121+
122+
### 7. No `fun ... | ...` multi-clause function definitions
123+
124+
CakeML does not support SML's multi-clause `fun f pat1 = ... | f pat2 = ...`.
125+
The original `chunk16`'s `take` helper uses this. **Fix:** rewrite as a
126+
single `fun take j xs acc = if j = 0 then ... else case xs of ...`.
127+
Pattern-matching on constructors in `case` works fine; only the
128+
`fun`-with-`|` form is rejected.
129+
130+
### 8. No curried `fn x y => ...` lambdas
131+
132+
CakeML `fn` accepts **exactly one** argument. `fn blk st => ...` is a
133+
parse error. **Fix:** `fn blk => fn st => ...`. This affects the one
134+
`List.foldl` lambda in `digestWords`.
135+
136+
### 9. No return-type annotations on `fun`
137+
138+
`fun f (x : ty) : ret_ty = ...` is rejected — the `: ret_ty` after the
139+
argument list is a parse error. Argument-type annotations
140+
(`fun f (x : ty) = ...`) and `val` annotations (`val x : ty = ...`) are
141+
both accepted. **Fix:** drop the return-type annotation on `padded` (the
142+
only function that had one).
143+
144+
### 10. No `#1` / `#2` tuple selectors
145+
146+
CakeML has no `#n` tuple-field selector. The original doesn't use it, but
147+
the test harness's first draft did. **Fix:** `case r of (a, b) => ...`.
148+
149+
### 11. No `op` keyword
150+
151+
Not needed once `infix` is dropped (see gap 6). `op +` etc. are not used.
152+
153+
### 12. Signature ascription dropped
154+
155+
The original is `structure Sha256 :> SHA256 = struct ... end`. CakeML has
156+
no signatures at present (per `how-to.md`). **Fix:** `structure Sha256 =
157+
struct ... end`. No information loss — the signature was purely
158+
documentary.
159+
160+
### Things that worked without change
161+
162+
- `structure ... = struct ... end`
163+
- `val` with type annotations ✅
164+
- `fun` with argument type annotations ✅
165+
- `Vector.fromList`, `Vector.sub`
166+
- `Array.array`, `Array.sub`, `Array.update`, `Array.length`
167+
- `Word64.fromInt`, `Word64.toInt`, `Word64.andb/orb/xorb/</</>>`
168+
- `Word64.` literal syntax `0wx...`
169+
- `String.sub`, `String.implode`, `String.concat`, `String.size`, `^`
170+
- `Char.ord`, `Char.chr`
171+
- `List.foldl`, `List.map`, `List.rev`, `List.tabulate`
172+
- `case ... of ... => ... | ... => ...`
173+
- `let ... in ... end` with `;` sequencing ✅
174+
- Hex integer literals `0wx...`
175+
- Nested `let`, curried `fun`, recursion ✅
176+
177+
## Algorithmic correctness note
178+
179+
One non-dialect bug was caught during testing: the first port used
180+
`64 - n` in `rotr` (rotating within the full 64-bit word) instead of
181+
`32 - n` (rotating within the emulated 32-bit window). Because the
182+
32-bit value lives in the low 32 bits of a Word64 with the high 32 bits
183+
zero, `<< w (64 - n)` shifts bits into the wrong window. The fix is
184+
`<< w (32 - n)` followed by the 32-bit mask. This produced visibly wrong
185+
digests (the binary ran and printed, just incorrect output), confirming
186+
that the test vectors are an effective gate. This is exactly the class
187+
of error the spike is designed to surface before fanning out the tower.
188+
189+
## Feasibility assessment for the full crypto-tower port
190+
191+
**Verdict: GO.** The SHA-256 spike clears the go/no-go gate. The dialect
192+
gaps are all surface-level and fall into a small, repeatable set of
193+
patterns (Word32 emulation, no `infix`, single-arg `fn`, no multi-clause
194+
`fun`, hand-rolled hex/formatting). None touch the cryptographic
195+
algorithm. The port is ~150 lines of clean CakeML and was completed in
196+
one session.
197+
198+
### What carries over to the rest of L0
199+
200+
| Library | Word width | Expected effort | Notes |
201+
|---|---|---|---|
202+
| `sml-codec` (SHA-256) | 32-bit | **done** | this spike |
203+
| `sml-bigint` | arbitrary | low | CakeML `int` is already bignum; mostly syntax |
204+
| `sml-aes` | 32-bit (columns) | medium | same `add32` shim; heavy tabular lookups, but `Array`/`Vector` work |
205+
| `sml-chacha20` | 32-bit | low | pure Word32 arithmetic, same shim |
206+
| `sml-x25519` | 256-bit | medium | bignum via CakeML `int` with mod, or emulate; no `Word32`/`Word64` field math issues |
207+
208+
### Risks for later layers
209+
210+
1. **Mutable state / arrays:** SHA-256 uses one `Array.array(64, ...)` per
211+
block. CakeML arrays work fine. AES and the bigint libraries use more
212+
array-heavy patterns; the basis `Array` and `Word8Array` APIs are
213+
complete enough.
214+
2. **FFI / I/O:** the spike uses only `print`. PEM parsing, X.509, and the
215+
TLS socket layer will need `TextIO` and possibly `Word8Array` I/O,
216+
which are in the basis but untested here. L1+ should add an I/O smoke
217+
test.
218+
3. **Multi-file programs:** the simple `cake` invocation compiles a
219+
single source file. The canonical `sha256.sml` is kept separate from
220+
the test harness; combining them is a `cat`. For the full tower, a
221+
small build script that concatenates the dependency-ordered `.sml`
222+
files into one `.cml` is the path of least resistance (CakeML's REPL
223+
and `--types` also operate on a single compilation unit).
224+
4. **Performance:** not measured in this spike. The Word32-via-Word64
225+
emulation adds a mask per arithmetic op; ChaCha20/AES may want a
226+
perf check, but correctness is unaffected.
227+
5. **Verified compiler vs. verified program:** the CakeML *compiler* is
228+
verified; the SHA-256 *program* is not yet proven. Moving to a proven
229+
program (via `ml_translatorLib` / `cv` tooling) is the J4 phase and
230+
requires the HOL4 build (already confirmed working). The spike
231+
deliberately stays at "compiles and runs correctly" — the bar the
232+
plan sets for B2/L0.
233+
234+
### Recommendation
235+
236+
Fan out the rest of L0 (`sml-bigint`, `sml-aes`, `sml-chacha20`,
237+
`sml-x25519`) in parallel using the patterns established here. Each port
238+
should ship with the same three-vector-style test harness against the
239+
MLton/Poly oracle. Pin CakeML v3400 and HOL "Trindemossen 2" (done in
240+
`CAKEML_VERSION` / `HOL4_VERSION`).

0 commit comments

Comments
 (0)