|
1 | | -# stapeln Proven Library Integration |
| 1 | +# Proven Libraries (Extracted) |
2 | 2 |
|
3 | | -**Date**: 2026-02-05 |
4 | | -**Standard**: ABI/FFI Universal (Idris2 → Zig → ReScript) |
| 3 | +The proven library workstream (Idris2 → Zig → ReScript DOM‑mounter) has been extracted. |
| 4 | +See: |
5 | 5 |
|
6 | | ---- |
7 | | - |
8 | | -## 🔐 Overview |
9 | | - |
10 | | -stapeln uses **formal verification with Idris2 dependent types** for critical system operations. This document describes the proven library architecture and guarantees. |
11 | | - |
12 | | -## ⚡ The Proven Stack |
13 | | - |
14 | | -### Architecture: Three Layers |
15 | | - |
16 | | -``` |
17 | | -┌─────────────────────────────────────┐ |
18 | | -│ Layer 3: ReScript Bindings │ Type-safe UI integration |
19 | | -│ - DomMounter.res │ - Option types |
20 | | -│ - Type-safe API │ - Result types |
21 | | -└─────────────────────────────────────┘ - Pattern matching |
22 | | - ↓ |
23 | | -┌─────────────────────────────────────┐ |
24 | | -│ Layer 2: Zig FFI (C ABI) │ Memory-safe implementation |
25 | | -│ - ffi/zig/src/dom_mounter.zig │ - Zero-cost abstractions |
26 | | -│ - C-compatible interface │ - No runtime overhead |
27 | | -└─────────────────────────────────────┘ - Cross-platform |
28 | | - ↓ |
29 | | -┌─────────────────────────────────────┐ |
30 | | -│ Layer 1: Idris2 ABI (Proofs) │ Formal guarantees |
31 | | -│ - src/abi/DomMounter.idr │ - Dependent types |
32 | | -│ - Formal verification │ - Total functions |
33 | | -└─────────────────────────────────────┘ - Compile-time proofs |
34 | | -``` |
35 | | - |
36 | | ---- |
37 | | - |
38 | | -## 📋 Proven Components |
39 | | - |
40 | | -### 1. DOM Mounter (High-Assurance Mounting) |
41 | | - |
42 | | -**Files**: |
43 | | -- **Idris2 ABI**: `frontend/src/abi/DomMounter.idr` |
44 | | -- **Zig FFI**: `frontend/ffi/zig/src/dom_mounter.zig` |
45 | | -- **ReScript**: `frontend/src/DomMounter.res` |
46 | | - |
47 | | -**Formal Proofs Provided**: |
48 | | - |
49 | | -#### Memory Safety |
50 | | -```idris |
51 | | -public export |
52 | | -data NoMemoryLeak : Type where |
53 | | - SafeMount : NoMemoryLeak |
54 | | -``` |
55 | | -**Guarantee**: Mounting operations never leak memory. Proven at compile-time. |
56 | | - |
57 | | -#### Thread Safety |
58 | | -```idris |
59 | | -public export |
60 | | -data AtomicMount : Type where |
61 | | - Atomic : AtomicMount |
62 | | -``` |
63 | | -**Guarantee**: All mount operations are atomic. No race conditions possible. |
64 | | - |
65 | | -#### Element Validation |
66 | | -```idris |
67 | | -public export |
68 | | -data ValidElementId : String -> Type where |
69 | | - MkValidId : (s : String) -> ValidElementId s |
70 | | -
|
71 | | -public export |
72 | | -data ElementExists : String -> Type where |
73 | | - ElementFound : ValidElementId id -> ElementExists id |
74 | | -``` |
75 | | -**Guarantee**: Element IDs are validated before use. Element existence checked before mounting. |
76 | | - |
77 | | -#### Totality |
78 | | -```idris |
79 | | -%default total |
80 | | -``` |
81 | | -**Guarantee**: All functions provably terminate. No infinite loops or hangs. |
82 | | - |
83 | | ---- |
84 | | - |
85 | | -## 🎯 API Usage |
86 | | - |
87 | | -### ReScript Layer (Type-Safe) |
88 | | - |
89 | | -```rescript |
90 | | -// Import the proven mounter |
91 | | -open DomMounter |
92 | | -
|
93 | | -// Safe mounting with Result type |
94 | | -let result = mount("app") |
95 | | -switch result { |
96 | | -| Ok() => Js.Console.log("✓ Mounted with formal guarantees") |
97 | | -| Error(msg) => Js.Console.error("Mount failed: " ++ msg) |
98 | | -} |
99 | | -
|
100 | | -// Convenience function for default element |
101 | | -let appMountResult = mountToApp() |
102 | | -
|
103 | | -// With callbacks |
104 | | -mountWithCallback( |
105 | | - "app", |
106 | | - () => Js.Console.log("Success!"), |
107 | | - (err) => Js.Console.error(err) |
108 | | -) |
109 | | -``` |
110 | | - |
111 | | -### Idris2 Layer (Formal Proofs) |
112 | | - |
113 | | -```idris |
114 | | --- Full proof with all guarantees |
115 | | -export |
116 | | -mountWithProof : (id : String) -> (MountResult, NoMemoryLeak, AtomicMount) |
117 | | -mountWithProof id = (MountSuccess, SafeMount, Atomic) |
118 | | -``` |
119 | | - |
120 | | -### Zig Layer (C ABI Implementation) |
121 | | - |
122 | | -```zig |
123 | | -// C-compatible export |
124 | | -export fn mount_to_element(element_id: [*:0]const u8) callconv(.C) c_int { |
125 | | - // Memory-safe Zig implementation |
126 | | - // Matches Idris2 ABI specification |
127 | | - return 0; // Success |
128 | | -} |
129 | | -``` |
130 | | - |
131 | | ---- |
132 | | - |
133 | | -## ✅ Verification Status |
134 | | - |
135 | | -### Compile-Time Guarantees |
136 | | - |
137 | | -| Property | Status | Proof Location | |
138 | | -|----------|--------|----------------| |
139 | | -| **Memory Safety** | ✅ Proven | `NoMemoryLeak` in DomMounter.idr | |
140 | | -| **Thread Safety** | ✅ Proven | `AtomicMount` in DomMounter.idr | |
141 | | -| **Type Correctness** | ✅ Proven | Idris2 type system | |
142 | | -| **Non-Empty IDs** | ✅ Proven | `ValidElementId` in DomMounter.idr | |
143 | | -| **Element Exists** | ✅ Proven | `ElementExists` in DomMounter.idr | |
144 | | -| **Termination** | ✅ Proven | `%default total` flag | |
145 | | - |
146 | | -### Runtime Guarantees |
147 | | - |
148 | | -- **Zero crashes** from mounting operations (proven impossible) |
149 | | -- **Zero memory leaks** from mounting operations (proven impossible) |
150 | | -- **Zero race conditions** in mount operations (proven impossible) |
151 | | -- **Zero infinite loops** in mount code (proven impossible) |
152 | | - |
153 | | ---- |
154 | | - |
155 | | -## 🏗️ Directory Structure |
156 | | - |
157 | | -### Correct Layout (Following ABI/FFI Standard) |
158 | | - |
159 | | -``` |
160 | | -frontend/ |
161 | | -├── src/ |
162 | | -│ ├── abi/ # Layer 1: Idris2 ONLY |
163 | | -│ │ ├── DomMounter.idr # ✅ Idris2 formal proofs |
164 | | -│ │ ├── FileIO.idr # ✅ Idris2 formal proofs |
165 | | -│ │ └── build/ # ✅ Idris2 build artifacts (.ttc, .ttm) |
166 | | -│ │ |
167 | | -│ ├── DomMounter.res # Layer 3: ReScript bindings |
168 | | -│ ├── App.res # Layer 3: Application code |
169 | | -│ └── IdrisBadge.res # Layer 3: "Idris² inside" badge |
170 | | -│ |
171 | | -├── ffi/ |
172 | | -│ └── zig/ # Layer 2: Zig FFI |
173 | | -│ ├── src/ |
174 | | -│ │ ├── dom_mounter.zig # ✅ C ABI implementation |
175 | | -│ │ ├── dom_mounter_enhanced.zig |
176 | | -│ │ └── dom_mounter_security.zig |
177 | | -│ ├── build.zig # Zig build config |
178 | | -│ └── libdom_mounter.so # Compiled shared library |
179 | | -│ |
180 | | -└── generated/ |
181 | | - └── abi/ # Auto-generated C headers (if needed) |
182 | | -``` |
183 | | - |
184 | | -### ❌ What NOT to Put in `src/abi/` |
185 | | - |
186 | | -- ❌ **NO Zig code** (belongs in `ffi/zig/`) |
187 | | -- ❌ **NO ReScript code** (belongs in `src/`) |
188 | | -- ❌ **NO C code** (belongs in `ffi/zig/` or `generated/`) |
189 | | -- ❌ **NO JavaScript** (belongs in `src/`) |
190 | | -- ❌ **NO build scripts** (belongs in `ffi/zig/`) |
191 | | - |
192 | | -### ✅ What DOES Belong in `src/abi/` |
193 | | - |
194 | | -- ✅ **Idris2 source files** (`*.idr`) |
195 | | -- ✅ **Idris2 build artifacts** (`*.ttc`, `*.ttm`) |
196 | | -- ✅ **Idris2 documentation** (if inline comments) |
197 | | - |
198 | | ---- |
199 | | - |
200 | | -## 🔬 Building the Proven Stack |
201 | | - |
202 | | -### Step 1: Compile Idris2 ABI |
203 | | - |
204 | | -```bash |
205 | | -cd frontend/src/abi |
206 | | -idris2 --build DomMounter.ipkg |
207 | | -# Generates .ttc and .ttm files |
208 | | -``` |
209 | | - |
210 | | -### Step 2: Build Zig FFI |
211 | | - |
212 | | -```bash |
213 | | -cd frontend/ffi/zig |
214 | | -zig build |
215 | | -# Generates libdom_mounter.so |
216 | | -``` |
217 | | - |
218 | | -### Step 3: Compile ReScript Bindings |
219 | | - |
220 | | -```bash |
221 | | -cd frontend |
222 | | -rescript build |
223 | | -# Compiles DomMounter.res → DomMounter.res.js |
224 | | -``` |
225 | | - |
226 | | ---- |
227 | | - |
228 | | -## 🎨 UI Integration: Idris² Badge |
229 | | - |
230 | | -The "Idris² inside" badge (`IdrisBadge.res`) appears in the UI to indicate formal verification: |
231 | | - |
232 | | -### Badge Styles |
233 | | - |
234 | | -**Compact** (inline): |
235 | | -``` |
236 | | -⚡ Idris² |
237 | | -``` |
238 | | - |
239 | | -**Standard** (standalone): |
240 | | -``` |
241 | | -┌──────────────────┐ |
242 | | -│ ⚡ Idris² inside │ |
243 | | -│ Formally Verified│ |
244 | | -└──────────────────┘ |
245 | | -``` |
246 | | - |
247 | | -**Detailed** (with proof list): |
248 | | -``` |
249 | | -┌─────────────────────────────┐ |
250 | | -│ ⚡ Idris² inside │ |
251 | | -│ Dependently-typed proofs │ |
252 | | -│ │ |
253 | | -│ 🛡️ Memory Safe ✓ PROVEN │ |
254 | | -│ 🔒 Thread Safe ✓ PROVEN │ |
255 | | -│ ✓ Type Correct ✓ PROVEN │ |
256 | | -│ 📝 Non-Empty ✓ PROVEN │ |
257 | | -│ 🔍 Element Exists ✓ PROVEN │ |
258 | | -└─────────────────────────────┘ |
259 | | -``` |
260 | | - |
261 | | -### Usage in Components |
262 | | - |
263 | | -```rescript |
264 | | -// In App.res footer |
265 | | -<IdrisBadge style=Compact /> |
266 | | -
|
267 | | -// In documentation pages |
268 | | -<IdrisBadge style=Standard /> |
269 | | -
|
270 | | -// In security inspector |
271 | | -<IdrisBadge |
272 | | - style=Detailed |
273 | | - proofs=[MemorySafety, ThreadSafety, TypeCorrectness] |
274 | | -/> |
275 | | -``` |
276 | | - |
277 | | ---- |
278 | | - |
279 | | -## 📊 Benefits of Formal Verification |
280 | | - |
281 | | -### Compared to Traditional Testing |
282 | | - |
283 | | -| Approach | Coverage | Guarantees | |
284 | | -|----------|----------|------------| |
285 | | -| **Unit Tests** | Sample inputs | No guarantees for untested cases | |
286 | | -| **Property Tests** | Random inputs | High confidence, not certainty | |
287 | | -| **Formal Proofs** | **ALL inputs** | **Mathematical certainty** | |
288 | | - |
289 | | -### Idris2 Advantages |
290 | | - |
291 | | -1. **Dependent Types**: Types can depend on values (e.g., `ValidElementId` depends on the string) |
292 | | -2. **Totality Checking**: Compiler proves all functions terminate |
293 | | -3. **Erasure**: Proofs disappear at runtime (zero overhead) |
294 | | -4. **C ABI Export**: Direct FFI to Zig/C without wrapper costs |
295 | | - |
296 | | ---- |
297 | | - |
298 | | -## 🔒 Security Implications |
299 | | - |
300 | | -### Proven Security Properties |
301 | | - |
302 | | -**Memory safety proofs prevent**: |
303 | | -- Buffer overflows |
304 | | -- Use-after-free |
305 | | -- Double-free |
306 | | -- Memory leaks |
307 | | -- Null pointer dereferences |
308 | | - |
309 | | -**Thread safety proofs prevent**: |
310 | | -- Race conditions |
311 | | -- Deadlocks (in proven sections) |
312 | | -- Data races |
313 | | -- Atomicity violations |
314 | | - |
315 | | -**Type correctness proofs prevent**: |
316 | | -- Type confusion |
317 | | -- Invalid casts |
318 | | -- Uninitialized data |
319 | | -- Type-based vulnerabilities |
320 | | - |
321 | | ---- |
322 | | - |
323 | | -## 📚 References |
324 | | - |
325 | | -### Idris2 Documentation |
326 | | -- [Idris2 Official Docs](https://idris2.readthedocs.io/) |
327 | | -- [Dependent Types Tutorial](https://docs.idris-lang.org/en/latest/tutorial/typesfuns.html) |
328 | | -- [FFI Guide](https://idris2.readthedocs.io/en/latest/ffi/ffi.html) |
329 | | - |
330 | | -### ABI/FFI Universal Standard |
331 | | -- **Location**: `~/Documents/hyperpolymath-repos/rsr-template-repo/ABI-FFI-README.md` |
332 | | -- **Established**: 2026-01-30 |
333 | | -- **Purpose**: Standardize Idris2 → Zig → Language bindings |
334 | | - |
335 | | -### Zig Documentation |
336 | | -- [Zig C ABI](https://ziglang.org/documentation/master/#C) |
337 | | -- [Zig Memory Safety](https://ziglang.org/documentation/master/#Memory) |
338 | | - |
339 | | ---- |
340 | | - |
341 | | -## 🎯 Future Proven Components |
342 | | - |
343 | | -### Planned Idris2 Proofs |
344 | | - |
345 | | -1. **Network Stack** (`frontend/src/abi/Network.idr`) |
346 | | - - Packet validation proofs |
347 | | - - Connection safety proofs |
348 | | - - Protocol correctness proofs |
349 | | - |
350 | | -2. **File I/O** (`frontend/src/abi/FileIO.idr`) |
351 | | - - Path traversal prevention proofs |
352 | | - - File descriptor safety proofs |
353 | | - - Atomic write proofs |
354 | | - |
355 | | -3. **Security Policies** (`frontend/src/abi/Security.idr`) |
356 | | - - Firewall rule correctness proofs |
357 | | - - Access control proofs |
358 | | - - Cryptographic protocol proofs |
359 | | - |
360 | | -4. **Resource Management** (`frontend/src/abi/Resources.idr`) |
361 | | - - Memory limit proofs |
362 | | - - CPU limit proofs |
363 | | - - No resource starvation proofs |
364 | | - |
365 | | ---- |
366 | | - |
367 | | -## ✨ Conclusion |
368 | | - |
369 | | -stapeln uses **formal verification with Idris2** to provide **compile-time guarantees** for critical operations. The "Idris² inside" badge indicates components backed by **mathematical proofs**, not just testing. |
370 | | - |
371 | | -**Key Takeaways**: |
372 | | -- ✅ Memory safety is **proven**, not hoped for |
373 | | -- ✅ Thread safety is **proven**, not tested |
374 | | -- ✅ Type correctness is **proven** by the compiler |
375 | | -- ✅ Zero runtime overhead (proofs erase at compile-time) |
376 | | -- ✅ Clean ABI/FFI separation (Idris2 → Zig → ReScript) |
377 | | - |
378 | | ---- |
379 | | - |
380 | | -**Last Updated**: 2026-02-05 |
381 | | -**Verification Status**: ✅ All proofs passing |
382 | | -**Build Status**: ✅ All layers compiling |
383 | | -**Integration Status**: ✅ Badge visible in UI |
| 6 | +- `/var/mnt/eclipse/repos/stapeln-dom-mounter/docs/PROVEN-LIBRARIES.md` |
0 commit comments