arachne-runtime 0.1.0

Typed Rust client API for Arachne secure peer-to-peer workspaces.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
//! Native persistence owns secrets; callers exchange only candidate tokens.
use super::*;
use arachne_security::{SecurityRecords, Workspace};
use arachne_store::Store;
use std::path::Path;
use zeroize::Zeroizing;

const TOKEN: &[u8] = b"runtime/token";
const PENDING: &[u8] = b"runtime/pending";
const JOIN_LIFECYCLE: &[u8] = b"runtime/join-lifecycle";
const ACTIVITY: &[u8] = b"runtime/activity";
const RESET: &[u8] = b"runtime/reset";
const REMOVED: &[u8] = b"runtime/removed";
const PUBLISHER: &[u8] = b"delivery/publisher";
const RECEIVED: &[u8] = b"delivery/received";
const INBOX: &[u8] = b"delivery/inbox";

pub(super) struct NativeStore {
    store: Store,
    committed: Vec<u8>,
}
impl NativeStore {
    pub(super) fn require_committed(&self, token: &[u8]) -> Result<(), String> {
        if token != self.committed {
            return Err("candidate has not been committed to native storage".into());
        }
        Ok(())
    }
    fn commit(&mut self, mut records: SecurityRecords, token: &[u8]) -> Result<(), String> {
        records.insert(TOKEN.to_vec(), Zeroizing::new(token.to_vec()));
        let deleted: Vec<_> = self
            .store
            .keys(b"")
            .filter(|name| !records.contains_key(*name))
            .map(<[u8]>::to_vec)
            .collect();
        let mut changes = Vec::new();
        for (name, value) in &records {
            if self.store.get(name).map_err(|e| e.to_string())?.as_deref() != Some(value.as_ref()) {
                changes.push((name.as_slice(), Some(value.as_slice())));
            }
        }
        changes.extend(deleted.iter().map(|name| (name.as_slice(), None)));
        self.store
            .commit(self.store.revision(), &changes)
            .map_err(|e| e.to_string())?;
        self.committed = token.to_vec();
        Ok(())
    }
}

pub(super) fn candidate_token() -> Result<Vec<u8>, String> {
    let mut token = vec![0; 37];
    token[..5].copy_from_slice(b"DFRC\x01");
    getrandom::getrandom(&mut token[5..]).map_err(|e| e.to_string())?;
    Ok(token)
}

fn active_records(
    owner: &Workspace,
    publisher: Option<&arachne_delivery::PublisherLog>,
    received: Option<&arachne_delivery::receive::ReceiveJournal>,
    inbox: Option<&arachne_delivery::inbox::ObjectInbox>,
    activity: &WorkspaceActivity,
) -> Result<SecurityRecords, String> {
    let mut records = owner.export_records().map_err(str::to_owned)?;
    records.insert(
        ACTIVITY.to_vec(),
        Zeroizing::new(serde_json::to_vec(activity).map_err(|error| error.to_string())?),
    );
    if let Some(inbox) = inbox {
        records.insert(
            INBOX.to_vec(),
            Zeroizing::new(
                inbox
                    .with_legacy_receipts(received)
                    .snapshot_with_publisher(owner, publisher.ok_or("inbox requires publisher")?)
                    .map_err(str::to_owned)?,
            ),
        );
    } else {
        if let Some(publisher) = publisher {
            let snapshot = publisher.snapshot();
            // Validate the same owner binding as legacy sealed persistence.
            arachne_delivery::PublisherLog::restore(
                owner.id(),
                owner.member().ok_or("member required")?.id(),
                owner.epoch(),
                &snapshot,
            )
            .map_err(str::to_owned)?;
            records.insert(PUBLISHER.to_vec(), Zeroizing::new(snapshot));
        }
        if let Some(received) = received {
            if publisher.is_none() {
                return Err("receive journal requires publisher".into());
            }
            let snapshot = received.snapshot();
            arachne_delivery::receive::ReceiveJournal::restore(owner.id(), owner.epoch(), &snapshot)
                .map_err(str::to_owned)?;
            records.insert(RECEIVED.to_vec(), Zeroizing::new(snapshot));
        }
    }
    Ok(records)
}

fn pending_records(session: &Session, pending: &arachne_security::PendingJoin) -> Result<SecurityRecords, String> {
    let bytes = pending
        .seal(session.storage_key.as_ref().ok_or("protected root required")?)
        .map_err(str::to_owned)?;
    let mut records = BTreeMap::from([(PENDING.to_vec(), Zeroizing::new(bytes))]);
    if let Some(lifecycle) = &session.join_lifecycle {
        records.insert(
            JOIN_LIFECYCLE.to_vec(),
            Zeroizing::new(serde_json::to_vec(lifecycle).map_err(|error| error.to_string())?),
        );
    }
    records.insert(
        ACTIVITY.to_vec(),
        Zeroizing::new(serde_json::to_vec(&session.activity).map_err(|error| error.to_string())?),
    );
    Ok(records)
}

fn idle(session: &Session) -> Result<(), String> {
    if session.records.is_some()
        || session.staged_workspace.is_some()
        || session.staged_removal.is_some()
        || session.inbound_admission.is_some()
        || session.membership_update.is_some()
        || session.cutoff.is_some()
        || session.current_view.is_some()
        || session.ready_current_view.is_some()
        || session.range.is_some()
        || session.ready_range.is_some()
        || !session.recovered.is_empty()
    {
        return Err("record storage requires an idle session".into());
    }
    Ok(())
}

/// Atomically migrate the current accepted owner and delivery state into an empty
/// record store. The host supplies a private path and protected storage root and
/// must retain its endpoint credential lock. Existing stores require restore;
/// never overwrite one with an older legacy snapshot or fall back on open failure.
/// A pending join may migrate too; admission atomically replaces its records.
/// Host route/unknown-outcome metadata remains separate and must be preserved.
pub fn enable_record_storage(handle: i64, path: &Path, root: &[u8; 32]) -> Result<(), String> {
    let shared = session(handle)?;
    let mut guard = shared.lock().map_err(|_| "node session unavailable")?;
    let session = guard.as_mut().ok_or("node is closed")?;
    idle(session)?;
    if session.storage_key.is_none() {
        return Err("protected endpoint root required".into());
    }
    let (workspace, records) = if let Some(owner) = &session.workspace {
        (
            owner.id(),
            active_records(
                owner,
                session.publisher.as_ref(),
                session.received.as_ref(),
                session.inbox.as_ref(),
                &session.activity,
            )?,
        )
    } else if let Some(pending) = &session.pending_join {
        (pending.workspace_id(), pending_records(session, pending)?)
    } else {
        return Err("session has no workspace or pending join".into());
    };
    let store = Store::open(path, root, workspace).map_err(|e| e.to_string())?;
    if store.revision() != 0 {
        return Err("record store already initialized; restore it".into());
    }
    let mut native = NativeStore {
        store,
        committed: Vec::new(),
    };
    native.commit(records, &candidate_token()?)?;
    session.records = Some(native);
    Ok(())
}

/// Commit the exact staged candidate, including counters and delivery state.
/// This does not adopt, send, reply or release application data. Retry after a
/// successful commit is idempotent; callers still invoke the matching adoption.
pub fn save_candidate(handle: i64, token: &[u8]) -> Result<(), String> {
    let shared = session(handle)?;
    let mut guard = shared.lock().map_err(|_| "node session unavailable")?;
    let session = guard.as_mut().ok_or("node is closed")?;
    commit_candidate(session, token)
}

/// Commit the exact staged candidate using the native store already attached to
/// this session. The lifecycle driver calls this before adoption, so Android
/// never becomes the authority for the save/adopt ordering.
pub(super) fn commit_candidate(session: &mut Session, token: &[u8]) -> Result<(), String> {
    let records = if let Some(staged) = &session.staged_workspace {
        if token != staged.snapshot {
            return Err("token does not match candidate".into());
        }
        let activity = if matches!(staged.transition, WorkspaceTransition::Join) {
            WorkspaceActivity {
                phase: WorkspacePhase::Active,
                reason: None,
            }
        } else {
            session.activity.clone()
        };
        active_records(
            &staged.workspace,
            staged.publisher.as_ref(),
            staged.received.as_ref(),
            staged.inbox.as_ref(),
            &activity,
        )?
    } else if let Some((removed, expected)) = &session.staged_removal {
        if token != expected {
            return Err("token does not match removal".into());
        }
        let bytes = removed
            .seal(
                session
                    .storage_key
                    .as_ref()
                    .ok_or("protected root required")?,
            )
            .map_err(str::to_owned)?;
        BTreeMap::from([(REMOVED.to_vec(), Zeroizing::new(bytes))])
    } else {
        return Err("session has no candidate".into());
    };
    let store = session
        .records
        .as_mut()
        .ok_or("native record storage not enabled")?;
    if store.require_committed(token).is_ok() {
        return Ok(());
    }
    store.commit(records, token)
}

/// Persist pending join routing before an Iroh admission exchange can leave the
/// endpoint. This makes an interrupted send retry the same attempt/peer.
pub(super) fn commit_pending_join(session: &mut Session) -> Result<(), String> {
    let pending = session.pending_join.as_ref().ok_or("session has no pending join")?;
    let records = pending_records(session, pending)?;
    let token = candidate_token()?;
    session
        .records
        .as_mut()
        .ok_or("native record storage not enabled")?
        .commit(records, &token)
}

/// Replace the native record set with an invalidation marker. The marker is
/// deliberately not restorable as a workspace; an adapter may then remove the
/// directory, but a crash between reset and cleanup cannot resurrect old state.
pub(super) fn reset_records(
    session: &mut Session,
    activity: &WorkspaceActivity,
) -> Result<(), String> {
    let records = BTreeMap::from([
        (
            RESET.to_vec(),
            Zeroizing::new(vec![b'D', b'F', b'R', b'S', 1]),
        ),
        (
            ACTIVITY.to_vec(),
            Zeroizing::new(serde_json::to_vec(activity).map_err(|error| error.to_string())?),
        ),
    ]);
    let token = candidate_token()?;
    session
        .records
        .as_mut()
        .ok_or("native record storage not enabled")?
        .commit(records, &token)
}

/// Restore only the authoritative native store into an empty endpoint session.
/// Failure must not trigger legacy fallback. Removal consumes the session.
pub fn restore_record_storage(
    handle: i64,
    path: &Path,
    root: &[u8; 32],
    workspace: [u8; 32],
) -> Result<Value, String> {
    let shared = session(handle)?;
    let mut guard = shared.lock().map_err(|_| "node session unavailable")?;
    let session = guard.as_mut().ok_or("node is closed")?;
    idle(session)?;
    if session.workspace.is_some() || session.pending_join.is_some() {
        return Err("session already owns a workspace".into());
    }
    // An absent authoritative store must never become a new empty database.
    std::fs::metadata(path).map_err(|e| e.to_string())?;
    let store = Store::open(path, root, workspace).map_err(|e| e.to_string())?;
    let get = |name: &[u8]| store.get(name).map_err(|e| e.to_string());
    let committed = get(TOKEN)?.ok_or("missing native commit token")?.to_vec();
    if committed.len() != 37 || !committed.starts_with(b"DFRC\x01") {
        return Err("invalid native commit token".into());
    }
    if get(RESET)?.is_some() {
        return Err("native record store was reset".into());
    }
    if let Some(bytes) = get(PENDING)? {
        if store.keys(b"").any(|name| {
            name != PENDING && name != TOKEN && name != JOIN_LIFECYCLE && name != ACTIVITY
        }) {
            return Err("pending store contains other lifecycle state".into());
        }
        let pending = arachne_security::PendingJoin::restore(
            session
                .storage_key
                .as_ref()
                .ok_or("protected root required")?,
            session.node.id(),
            workspace,
            &bytes,
        )
        .map_err(str::to_owned)?;
        let mut value = pending_metadata(&pending, session.node.id())?;
        value["durable"] = json!(true);
        let activity = get(ACTIVITY)?
            .map(|bytes| serde_json::from_slice::<WorkspaceActivity>(&bytes).map_err(|error| error.to_string()))
            .transpose()?
            .unwrap_or(WorkspaceActivity {
                phase: WorkspacePhase::Joining,
                reason: None,
            });
        if activity.phase != WorkspacePhase::Joining {
            return Err("pending store has invalid workspace activity".into());
        }
        value["activity"] = activity.projection();
        session.activity = activity;
        session.join_lifecycle = get(JOIN_LIFECYCLE)?
            .map(|bytes| {
                let lifecycle: JoinLifecycle =
                    serde_json::from_slice(&bytes).map_err(|error| error.to_string())?;
                lifecycle.validate()?;
                Ok::<JoinLifecycle, String>(lifecycle)
            })
            .transpose()?;
        session.pending_join = Some(pending);
        session.records = Some(NativeStore { store, committed });
        return Ok(value);
    }
    if let Some(bytes) = get(REMOVED)? {
        if store.keys(b"").count() != 2 {
            return Err("removed store contains active state".into());
        }
        let removed = arachne_security::RemovedMembership::restore(
            session
                .storage_key
                .as_ref()
                .ok_or("protected root required")?,
            session.node.id(),
            workspace,
            &bytes,
        )
        .map_err(str::to_owned)?;
        let value = json!({"workspace": workspace, "state":"removed", "epoch":removed.epoch(),
            "member":{"id":removed.member().id(),"display_name":removed.member().display_name()},
            "commit_digest":removed.commit_digest(), "workspace_ready":false,"durable":true});
        let ended = guard.take().ok_or("node is closed")?;
        drop(guard);
        shutdown_session(ended)?;
        return Ok(value);
    }
    for name in store.keys(b"") {
        if !name.starts_with(b"security/")
            && ![TOKEN, PUBLISHER, RECEIVED, INBOX, ACTIVITY].contains(&name)
        {
            return Err("unknown native runtime record".into());
        }
    }
    let security: SecurityRecords = store
        .keys(b"security/")
        .map(|name| Ok((name.to_vec(), get(name)?.ok_or("missing security record")?)))
        .collect::<Result<_, String>>()?;
    let owner = Workspace::restore_records(session.node.id(), workspace, &security)
        .map_err(str::to_owned)?;
    let (publisher, received, inbox) = if let Some(bytes) = get(INBOX)? {
        if get(PUBLISHER)?.is_some() || get(RECEIVED)?.is_some() {
            return Err("mixed delivery records".into());
        }
        let (publisher, inbox) =
            arachne_delivery::inbox::ObjectInbox::restore_snapshot(&owner, &bytes)
                .map_err(str::to_owned)?;
        let received = inbox.legacy_receipts().map_err(str::to_owned)?;
        (Some(publisher), received, Some(inbox))
    } else {
        let publisher = get(PUBLISHER)?
            .map(|bytes| {
                arachne_delivery::PublisherLog::restore(
                    workspace,
                    owner.member().ok_or("member required")?.id(),
                    owner.epoch(),
                    &bytes,
                )
            })
            .transpose()
            .map_err(str::to_owned)?;
        let received = get(RECEIVED)?
            .map(|bytes| {
                arachne_delivery::receive::ReceiveJournal::restore(workspace, owner.epoch(), &bytes)
            })
            .transpose()
            .map_err(str::to_owned)?;
        if received.is_some() && publisher.is_none() {
            return Err("receive journal requires publisher".into());
        }
        (publisher, received, None)
    };
    let value = json!({"workspace":workspace,"workspace_name":owner.workspace_name().map_err(str::to_owned)?,"epoch":owner.epoch(),"members":owner.member_count(),
        "member":member_metadata(&owner),"durable":true});
    let activity = get(ACTIVITY)?
        .map(|bytes| serde_json::from_slice::<WorkspaceActivity>(&bytes).map_err(|error| error.to_string()))
        .transpose()?
        .unwrap_or(WorkspaceActivity {
            phase: WorkspacePhase::Active,
            reason: None,
        });
    if !matches!(activity.phase, WorkspacePhase::Active | WorkspacePhase::Recovering) {
        return Err("active store has invalid workspace activity".into());
    }
    let mut value = value;
    value["activity"] = activity.projection();
    session.activity = activity;
    session.publisher = publisher;
    session.received = received;
    session.inbox = inbox;
    commit_workspace(session, owner);
    session.records = Some(NativeStore { store, committed });
    Ok(value)
}