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
440
//! Workspace reachability over authenticated control, independent of application topics.
use super::*;
use std::time::Instant;

const PREFIX: &[u8; 5] = b"DFPR\x01";
const REQUEST_TIMEOUT: Duration = Duration::from_secs(5);
const REFRESH_INTERVAL: Duration = Duration::from_secs(30);
const FRESH: Duration = Duration::from_secs(70);
const MAX_HEADS: usize = 8;

struct Seen {
    at: Instant,
    epoch: u64,
    fingerprint: [u8; 32],
    name_head: [u8; 32],
    instance: [u8; 16],
}

pub(super) struct Presence {
    seen: BTreeMap<[u8; 32], Seen>,
    pending: Vec<PendingControl<()>>,
    queued: VecDeque<[u8; 32]>,
    head_cursor: BTreeMap<[u8; 32], usize>,
    next: Option<Instant>,
    epoch: Option<u64>,
    instance: [u8; 16],
    announce: bool,
}

impl Presence {
    pub fn new() -> Result<Self, String> {
        let mut instance = [0; 16];
        getrandom::getrandom(&mut instance).map_err(|error| error.to_string())?;
        Ok(Self {
            seen: BTreeMap::new(),
            pending: Vec::new(),
            queued: VecDeque::new(),
            head_cursor: BTreeMap::new(),
            next: None,
            epoch: None,
            instance,
            announce: false,
        })
    }

    pub fn cancel(&mut self) {
        self.pending.clear();
        self.queued.clear();
    }

    pub(super) fn announce_next(&mut self) {
        self.announce = true;
        self.next = None;
    }
}

fn base_packet(
    owner: &arachne_security::Workspace,
    instance: [u8; 16],
    announce: bool,
) -> Result<Vec<u8>, String> {
    let mut bytes = PREFIX.to_vec();
    bytes.push(u8::from(announce));
    bytes.extend(instance);
    bytes.extend(owner.id());
    bytes.extend(owner.epoch().to_be_bytes());
    bytes.extend(owner.epoch_fingerprint());
    bytes.extend(owner.workspace_name_head().map_err(str::to_owned)?);
    Ok(bytes)
}

/// Harness-seam presence packet with zero delivery heads (see `crate::harness`).
/// A joiner with no publications legitimately advertises no heads; receivers
/// treat a zero head count as an ordinary presence refresh. Grants no authority.
#[doc(hidden)]
pub fn harness_presence_packet(
    owner: &arachne_security::Workspace,
    instance: [u8; 16],
    announce: bool,
) -> Vec<u8> {
    let mut bytes = base_packet(owner, instance, announce).expect("workspace name head");
    bytes.push(0);
    bytes
}

fn packet(session: &mut Session, peer: [u8; 32], announce: bool) -> Result<Vec<u8>, String> {
    let owner = session.workspace.as_ref().ok_or("no workspace")?;
    let recipient = owner.member_id_for_endpoint(peer).map_err(str::to_owned)?;
    let mut heads = match session.inbox.as_ref() {
        Some(inbox) => inbox
            .direct_heads_for(owner, recipient)
            .map_err(str::to_owned)?,
        None => Vec::new(),
    };
    let local = session.node.id();
    heads.retain(|head| {
        session
            .runtime
            .block_on(session.node.with_routing_policy(|policy| {
                policy
                    .subscribed(head.workspace, head.policy_revision, peer, &head.topic)
                    .unwrap_or(false)
                    && (head.author == owner.member().unwrap().id()
                        || head.recipients.contains(&owner.member().unwrap().id()))
                    && local != peer
            }))
    });
    let mut bytes = base_packet(owner, session.presence.instance, announce)?;
    let start = session
        .presence
        .head_cursor
        .get(&peer)
        .copied()
        .unwrap_or(0)
        .min(heads.len());
    let count = heads.len().min(MAX_HEADS);
    bytes.push(count as u8);
    for offset in 0..count {
        let encoded = heads[(start + offset) % heads.len()]
            .to_wire()
            .map_err(str::to_owned)?;
        bytes.extend((encoded.len() as u16).to_be_bytes());
        bytes.extend(encoded);
    }
    if heads.len() > MAX_HEADS {
        session
            .presence
            .head_cursor
            .insert(peer, (start + count) % heads.len());
    } else {
        session.presence.head_cursor.remove(&peer);
    }
    Ok(bytes)
}

fn observe(session: &mut Session, peer: [u8; 32], bytes: &[u8]) -> Result<bool, String> {
    let owner = session.workspace.as_ref().ok_or("no workspace")?;
    if bytes.len() < 127
        || !bytes.starts_with(PREFIX)
        || bytes[5] > 1
        || bytes[22..54] != owner.id()
        || peer == session.node.id()
        || owner.member_id_for_endpoint(peer).is_err()
    {
        return Err("invalid workspace presence".into());
    }
    let instance = bytes[6..22].try_into().unwrap();
    let announce = bytes[5] == 1;
    let mut heads = Vec::new();
    let count = bytes[126] as usize;
    if count > MAX_HEADS {
        return Err("invalid workspace presence".into());
    }
    let mut cursor = 127_usize;
    for _ in 0..count {
        let end = cursor.checked_add(2).ok_or("invalid workspace presence")?;
        let length = u16::from_be_bytes(
            bytes
                .get(cursor..end)
                .ok_or("invalid workspace presence")?
                .try_into()
                .unwrap(),
        ) as usize;
        cursor = end;
        let end = cursor
            .checked_add(length)
            .ok_or("invalid workspace presence")?;
        heads.push(
            arachne_delivery::wire::DirectHead::from_wire(
                bytes.get(cursor..end).ok_or("invalid workspace presence")?,
            )
            .map_err(str::to_owned)?,
        );
        cursor = end;
    }
    if cursor != bytes.len() {
        return Err("invalid workspace presence".into());
    }
    let next_inbox = session.inbox.clone().map(|mut next| {
        // Heads are advisory gap triggers. A peer can still have an older
        // subscription view, so a stale or revoked head must not poison the
        // authenticated presence/name response.
        for head in &heads {
            let subscribed = session
                .runtime
                .block_on(session.node.with_routing_policy(|policy| {
                    policy
                        .subscribed(
                            head.workspace,
                            head.policy_revision,
                            session.node.id(),
                            &head.topic,
                        )
                        .unwrap_or(false)
                }));
            if !subscribed {
                continue;
            }
            if let Ok(Some(candidate)) = next.stage_direct_head(owner, peer, head) {
                next = candidate;
            }
        }
        next
    });
    if let Some(next) = next_inbox {
        session.inbox = Some(next);
    }
    let restarted = announce
        || session
            .presence
            .seen
            .get(&peer)
            .is_some_and(|seen| seen.instance != instance);
    session.presence.seen.insert(
        peer,
        Seen {
            at: Instant::now(),
            epoch: u64::from_be_bytes(bytes[54..62].try_into().unwrap()),
            fingerprint: bytes[62..94].try_into().unwrap(),
            name_head: bytes[94..126].try_into().unwrap(),
            instance,
        },
    );
    Ok(restarted)
}

pub(super) fn receive(
    session: &mut Session,
    peer: [u8; 32],
    bytes: &[u8],
) -> Result<Vec<u8>, String> {
    if observe(session, peer, bytes)? {
        session.interests.repair();
        // A committed/restarted peer announces before its first steady
        // presence. Use that event to exchange signed member profiles too;
        // epoch/name heads can stay identical after a join, so waiting for a
        // head difference leaves the joiner's display name unknown forever.
        let _ = super::membership::start_query_if_needed(session, peer);
    }
    // The authenticated presence response must not fail because an optional
    // native reconciliation query could not be started. The sender needs our
    // current head to initiate that query itself.
    let response = packet(session, peer, false)?;
    let _ = reconcile_seen(session);
    Ok(response)
}

pub(super) fn status(presence: &Presence, peer: [u8; 32], now: Instant) -> &'static str {
    match presence.seen.get(&peer) {
        None => "unknown",
        Some(seen) if now.saturating_duration_since(seen.at) < FRESH => "reachable",
        Some(_) => "stale",
    }
}

/// Local monotonic observation age; neither membership nor delivery evidence.
pub(super) fn contact_age(presence: &Presence, peer: [u8; 32], now: Instant) -> Option<Duration> {
    presence
        .seen
        .get(&peer)
        .map(|seen| now.saturating_duration_since(seen.at))
}

pub(super) fn fresh_for(age: Duration) -> Duration {
    FRESH.saturating_sub(age)
}

/// Presence is processed by the native control drain.  Use that authenticated
/// observation directly to start reconciliation; the host's display refresh
/// must not be the membership trigger.
fn reconcile_seen(session: &mut Session) -> Result<Option<[u8; 32]>, String> {
    let owner = session.workspace.as_ref().ok_or("no workspace")?;
    let epoch = owner.epoch();
    let fingerprint = owner.epoch_fingerprint();
    let name_head = owner.workspace_name_head().map_err(str::to_owned)?;
    let now = Instant::now();
    let ahead: Vec<(u64, [u8; 32])> = session
        .presence
        .seen
        .iter()
        .filter(|(_, seen)| now.saturating_duration_since(seen.at) < FRESH && seen.epoch > epoch)
        .map(|(peer, seen)| (seen.epoch, *peer))
        .collect();
    let before = session.membership_head.clone();
    for (head, peer) in ahead {
        super::membership::note_head(session, head, peer);
    }
    if session.membership_head != before {
        session.node.control_signal().notify_one();
    }
    let sync_peer = session
        .presence
        .seen
        .iter()
        .find(|(_, seen)| {
            now.saturating_duration_since(seen.at) < FRESH
                && ((seen.epoch > epoch && session.membership_head.is_none())
                    || (seen.epoch == epoch
                        && (seen.fingerprint != fingerprint || seen.name_head != name_head)))
        })
        .map(|(peer, _)| *peer);
    if let Some(peer) = sync_peer {
        super::membership::start_query_if_needed(session, peer)?;
    }
    Ok(sync_peer)
}

pub(super) fn poll(session: &mut Session, announce: bool) -> Result<Value, String> {
    let owner = session.workspace.as_ref().ok_or("no workspace")?;
    let epoch = owner.epoch();
    let peers: BTreeSet<_> = owner
        .member_endpoints()
        .map_err(str::to_owned)?
        .into_iter()
        .filter(|peer| *peer != session.node.id())
        .collect();
    session.presence.seen.retain(|peer, _| peers.contains(peer));
    session
        .presence
        .head_cursor
        .retain(|peer, _| peers.contains(peer));
    let now = Instant::now();
    let mut response_errors = 0_u32;
    let mut response_error = None;
    if announce || session.presence.epoch != Some(epoch) {
        // A newly accepted epoch or reconnect supersedes in-flight old observations.
        session.presence.pending.clear();
        session.presence.queued.clear();
        session.presence.head_cursor.clear();
        session.presence.next = None;
        session.presence.epoch = Some(epoch);
        session.presence.announce = true;
        session.interests.repair();
    }
    let mut i = 0;
    while i < session.presence.pending.len() {
        if !session.presence.pending[i].task.is_finished() {
            i += 1;
            continue;
        }
        let mut done = session.presence.pending.swap_remove(i);
        match session.runtime.block_on(&mut done.task) {
            Ok(Ok(bytes)) => match observe(session, done.peer, &bytes) {
                Ok(true) => session.interests.repair(),
                Ok(false) => (),
                Err(error) => {
                    response_errors = response_errors.saturating_add(1);
                    response_error.get_or_insert(error);
                }
            },
            Ok(Err(error)) => {
                response_errors = response_errors.saturating_add(1);
                response_error.get_or_insert(error.to_string());
            }
            Err(error) => {
                response_errors = response_errors.saturating_add(1);
                response_error.get_or_insert(error.to_string());
            }
        }
    }
    if session.presence.pending.is_empty()
        && session.presence.queued.is_empty()
        && session.presence.next.is_none_or(|next| now >= next)
    {
        session.presence.queued.extend(peers);
        session.presence.next = Some(now + REFRESH_INTERVAL);
    }
    // ponytail: bounded direct-peer fanout; a measured gossip overlay replaces
    // all-peer refresh rounds before claiming large-workspace convergence.
    while session.presence.pending.len() < 16 {
        let Some(peer) = session.presence.queued.pop_front() else {
            break;
        };
        let bytes = packet(session, peer, session.presence.announce)?;
        let request = session.node.request_control(peer, &bytes);
        let task = session.runtime.spawn(async move {
            tokio::time::timeout(REQUEST_TIMEOUT, request)
                .await
                .map_err(|_| arachne_node::Error::Timeout("presence response"))?
        });
        session.presence.pending.push(PendingControl {
            query: (),
            peer,
            task,
        });
    }
    if session.presence.queued.is_empty() {
        session.presence.announce = false;
    }
    // A fresh peer at a newer epoch has the steps: pull the range from it
    // (ADR 0009). Same-epoch name/profile changes start an authenticated query
    // from this Rust-side observation, not from a host refresh timer.
    let sync_peer = reconcile_seen(session)?;
    Ok(json!({"state":"workspace_presence", "sync_peer":sync_peer,
        "response_errors":response_errors, "response_error":response_error}))
}

#[cfg(test)]
mod tests {
    use super::*;
    #[test]
    fn presence_expires_on_monotonic_deadline() {
        let mut presence = Presence::new().unwrap();
        let now = Instant::now();
        assert_eq!(status(&presence, [92; 32], now), "unknown");
        assert_eq!(contact_age(&presence, [92; 32], now), None);
        presence.seen.insert(
            [92; 32],
            Seen {
                at: now,
                epoch: 0,
                fingerprint: [0; 32],
                name_head: [0; 32],
                instance: [0; 16],
            },
        );
        assert_eq!(status(&presence, [92; 32], now), "reachable");
        assert_eq!(status(&presence, [92; 32], now + FRESH), "stale");
        assert_eq!(contact_age(&presence, [92; 32], now), Some(Duration::ZERO));
        let age = contact_age(&presence, [92; 32], now + FRESH + Duration::from_secs(5)).unwrap();
        assert_eq!(age, FRESH + Duration::from_secs(5));
        assert_eq!(fresh_for(age), Duration::ZERO);
        assert_eq!(
            fresh_for(Duration::from_secs(5)),
            FRESH - Duration::from_secs(5)
        );
    }

    #[test]
    fn announced_peer_starts_profile_reconcile() {
        let (owner, _, endpoints) = super::membership::admit_members(221, "Member", 1);
        let peer = endpoints[0];
        let packet = harness_presence_packet(&owner, [7; 16], true);
        let mut session = super::membership::bare_test_session(owner);

        receive(&mut session, peer, &packet).unwrap();

        assert!(session.membership_update.is_some());
    }
}