zudp 0.4.2

Zero-overhead UDP protocol with optional reliability, fragmentation, and relay support
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
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
//! Noise XX handshake driver.
//!
//! Message flow (`step` byte on the wire):
//!
//! ```text
//! 1  initiator → responder   e                 payload: initiator session index
//! 2  responder → initiator   e, ee, s, es      payload: responder session index
//! 3  initiator → responder   s, se             (no payload)
//! ```
//!
//! Recovery rules, because any of these datagrams can be lost or the remote can restart:
//!
//! - The initiator retransmits msg1 with back-off until msg2 arrives or the handshake times
//!   out.  A responder that sees the same msg1 twice resends its cached msg2.
//! - A msg1 that does not match the responder's half-open state replaces it: the remote
//!   restarted mid-handshake, and its old state can never complete.
//! - The initiator is done after writing msg3, so [`initiate`] keeps resending msg3 and an
//!   encrypted Ping until something authenticated comes back from the responder.
//! - Half-open states expire after the handshake timeout.

use std::{
    collections::HashMap,
    sync::Weak,
    time::{Duration, Instant},
};

use bytes::Bytes;
use tokio::sync::oneshot;

use crate::{
    Error, PeerAddr,
    engine::EngineInner,
    frame::{Frame, WIRE_VERSION},
    peer::random_u64,
    security::{SecureChannel, build_initiator, build_responder},
};

const STEP_INIT: u8 = 1;
const STEP_RESPONSE: u8 = 2;
const STEP_FINISH: u8 = 3;

/// First retransmit delay; doubles up to [`RETRY_MAX`].
const RETRY_MIN: Duration = Duration::from_millis(200);
const RETRY_MAX: Duration = Duration::from_secs(1);

/// Largest Noise XX message (msg2: 32 e + 48 s + 16 tag + 8 payload + 16 tag), with headroom.
const MSG_BUF: usize = 256;

/// Session index length carried in msg1 / msg2 payloads.
const INDEX_LEN: usize = 8;

#[derive(Clone, Copy, PartialEq, Eq, Debug)]
enum Role {
    Initiator,
    Responder,
}

/// How a handshake that someone is waiting on ended.
#[derive(Debug)]
pub(crate) enum Outcome {
    /// Installed as the peer state with this generation.
    Ready {
        generation: u64,
    },
    KeyMismatch,
    /// The relay could not deliver to the target.
    Unreachable,
}

/// A handshake in progress with one remote address.
pub(crate) struct Pending {
    hs: snow::HandshakeState,
    role: Role,
    /// Session index we told the remote to put on Secure frames addressed to us.
    pub(crate) local_index: u64,
    /// Remote's session index, learned from msg1 (responder) or msg2 (initiator).
    remote_index: u64,
    started: Instant,
    /// Wire bytes of the last message we sent, resent on retransmit.
    last_sent: Bytes,
    /// The remote message that produced `last_sent`; a byte-identical copy is a retransmit.
    last_received: Option<Bytes>,
    /// Our msg1 ephemeral key, used to break the tie when both sides initiate at once.
    our_ephemeral: Option<[u8; 32]>,
    waiter: Option<oneshot::Sender<Outcome>>,
}

pub(crate) type PendingMap = HashMap<PeerAddr, Pending>;

/// A finished handshake and whoever is waiting for it.
pub(crate) type Done = (Established, Option<oneshot::Sender<Outcome>>);

/// What one handshake message produced: a reply to send, and a finished session.
pub(crate) type StepResult = (Option<Bytes>, Option<Done>);

/// Material for a freshly established session, handed to the engine to install.
pub(crate) struct Established {
    pub channel: SecureChannel,
    pub remote_static: Option<[u8; 32]>,
    pub initiator: bool,
    /// msg3 wire bytes; the initiator resends them until the responder answers.
    pub finish_wire: Option<Bytes>,
}

fn wire(step: u8, payload: Vec<u8>) -> Bytes {
    Frame::Handshake {
        step,
        version: WIRE_VERSION,
        payload: Bytes::from(payload),
    }
    .encode()
}

fn read_index(payload: &[u8]) -> Option<u64> {
    let bytes: [u8; INDEX_LEN] = payload.get(..INDEX_LEN)?.try_into().ok()?;
    Some(u64::from_be_bytes(bytes))
}

fn remote_static(hs: &snow::HandshakeState) -> Option<[u8; 32]> {
    hs.get_remote_static()?.try_into().ok()
}

fn pinned_key_ok(inner: &EngineInner, hs: &snow::HandshakeState) -> bool {
    let pinned = &inner.config.pinned_keys;
    pinned.is_empty() || remote_static(hs).is_some_and(|key| pinned.contains(&key))
}

/// A relayed handshake must authenticate the very key it is addressed by: the relay's
/// sender claim (responder) or the target we asked for (initiator).
fn claimed_key_ok(from: PeerAddr, hs: &snow::HandshakeState) -> bool {
    match from {
        PeerAddr::Direct(_) => true,
        PeerAddr::Relayed { key, .. } => remote_static(hs) == Some(key),
    }
}

fn into_established(pending: Pending, finish_wire: Option<Bytes>) -> Result<Done, snow::Error> {
    let remote_static = remote_static(&pending.hs);
    let transport = pending.hs.into_stateless_transport_mode()?;
    Ok((
        Established {
            channel: SecureChannel::new(transport, pending.local_index, pending.remote_index),
            remote_static,
            initiator: pending.role == Role::Initiator,
            finish_wire,
        },
        pending.waiter,
    ))
}

/// Process one handshake frame from `from`.
///
/// Returns a datagram to send back and, when the handshake completed, the session to
/// install.  The caller installs the session before notifying any waiter.
pub(crate) fn on_message(
    inner: &EngineInner,
    from: PeerAddr,
    step: u8,
    version: u8,
    payload: &Bytes,
) -> StepResult {
    let Some(kp) = inner.keypair.as_ref() else {
        tracing::debug!(target: "zudp::handshake", peer = %from, "ignored — security not configured");
        return (None, None);
    };
    if version != WIRE_VERSION {
        tracing::warn!(target: "zudp::handshake", peer = %from, version, ours = WIRE_VERSION, "ignored — wire version mismatch");
        return (None, None);
    }
    let mut pending = inner.pending.lock();
    match step {
        STEP_INIT => respond(inner, kp, &mut pending, from, payload),
        STEP_RESPONSE => finish_as_initiator(inner, &mut pending, from, payload),
        STEP_FINISH => finish_as_responder(inner, &mut pending, from, payload),
        _ => (None, None),
    }
}

fn respond(
    inner: &EngineInner,
    kp: &crate::security::Keypair,
    pending: &mut PendingMap,
    from: PeerAddr,
    payload: &Bytes,
) -> StepResult {
    let mut waiter = None;
    if let Some(existing) = pending.get_mut(&from) {
        match existing.role {
            Role::Responder if existing.last_received.as_ref() == Some(payload) => {
                return (Some(existing.last_sent.clone()), None);
            }
            Role::Initiator => {
                // Both sides initiated: the larger msg1 ephemeral key stays initiator.
                let theirs: Option<[u8; 32]> = payload.get(..32).and_then(|e| e.try_into().ok());
                if existing.our_ephemeral > theirs {
                    return (None, None);
                }
                waiter = existing.waiter.take();
            }
            Role::Responder => {}
        }
    }
    if !pending.contains_key(&from) && !pending_budget(inner, pending, from) {
        tracing::warn!(target: "zudp::handshake", peer = %from, "too many handshakes in progress — dropping msg1");
        return (None, None);
    }

    let mut hs = match build_responder(kp) {
        Ok(hs) => hs,
        Err(e) => {
            tracing::error!(target: "zudp::handshake", peer = %from, "build_responder: {e}");
            return (None, None);
        }
    };
    let mut buf = [0u8; MSG_BUF];
    let Some(remote_index) = hs
        .read_message(payload, &mut buf)
        .ok()
        .and_then(|n| read_index(&buf[..n]))
    else {
        tracing::debug!(target: "zudp::handshake", peer = %from, "invalid msg1");
        return (None, None);
    };
    let local_index = random_u64();
    let mut out = vec![0u8; MSG_BUF];
    let n = match hs.write_message(&local_index.to_be_bytes(), &mut out) {
        Ok(n) => n,
        Err(e) => {
            tracing::warn!(target: "zudp::handshake", peer = %from, "write msg2: {e}");
            return (None, None);
        }
    };
    out.truncate(n);
    let reply = wire(STEP_RESPONSE, out);
    pending.insert(
        from,
        Pending {
            hs,
            role: Role::Responder,
            local_index,
            remote_index,
            started: Instant::now(),
            last_sent: reply.clone(),
            last_received: Some(payload.clone()),
            our_ephemeral: None,
            waiter,
        },
    );
    (Some(reply), None)
}

/// Room for one more half-open handshake with `from`?  Each relay gets its own budget, a
/// quarter of `max_peers`, so a relay feeding fake msg1s cannot crowd out direct handshakes
/// or another relay's; direct handshakes share the full `max_peers`.
fn pending_budget(inner: &EngineInner, pending: &PendingMap, from: PeerAddr) -> bool {
    let max = inner.config.max_peers;
    match from {
        PeerAddr::Direct(_) => pending.keys().filter(|k| !k.is_relayed()).count() < max,
        PeerAddr::Relayed { relay, .. } => {
            let same_relay =
                |k: &&PeerAddr| matches!(k, PeerAddr::Relayed { relay: r, .. } if *r == relay);
            pending.keys().filter(same_relay).count() < (max / 4).max(8)
        }
    }
}

fn finish_as_initiator(
    inner: &EngineInner,
    pending: &mut PendingMap,
    from: PeerAddr,
    payload: &Bytes,
) -> StepResult {
    let Some(state) = pending.get_mut(&from).filter(|p| p.role == Role::Initiator) else {
        return (None, None);
    };
    let mut buf = [0u8; MSG_BUF];
    let Some(remote_index) = state
        .hs
        .read_message(payload, &mut buf)
        .ok()
        .and_then(|n| read_index(&buf[..n]))
    else {
        // A forged or corrupted msg2 leaves our state unusable; start over on retransmit.
        tracing::debug!(target: "zudp::handshake", peer = %from, "invalid msg2");
        if let Some(stale) = pending.remove(&from) {
            restart_initiator(inner, pending, from, stale);
        }
        return (None, None);
    };
    if !pinned_key_ok(inner, &state.hs) || !claimed_key_ok(from, &state.hs) {
        tracing::warn!(target: "zudp::security", peer = %from, "handshake aborted — remote key does not match pinned key");
        if let Some(mut aborted) = pending.remove(&from)
            && let Some(waiter) = aborted.waiter.take()
        {
            let _ = waiter.send(Outcome::KeyMismatch);
        }
        return (None, None);
    }
    state.remote_index = remote_index;
    let mut out = vec![0u8; MSG_BUF];
    let n = match state.hs.write_message(&[], &mut out) {
        Ok(n) => n,
        Err(e) => {
            tracing::warn!(target: "zudp::handshake", peer = %from, "write msg3: {e}");
            return (None, None);
        }
    };
    out.truncate(n);
    let finish = wire(STEP_FINISH, out);
    let Some(state) = pending.remove(&from) else {
        return (None, None);
    };
    match into_established(state, Some(finish.clone())) {
        Ok(done) => (Some(finish), Some(done)),
        Err(e) => {
            tracing::error!(target: "zudp::handshake", peer = %from, "into_transport_mode: {e}");
            (None, None)
        }
    }
}

/// Replace a broken initiator state with a fresh one that keeps the same waiter.
fn restart_initiator(
    inner: &EngineInner,
    pending: &mut PendingMap,
    from: PeerAddr,
    stale: Pending,
) {
    let Some(kp) = inner.keypair.as_ref() else {
        return;
    };
    if let Ok(mut fresh) = new_initiator(kp) {
        fresh.waiter = stale.waiter;
        fresh.started = stale.started;
        pending.insert(from, fresh);
    }
}

fn finish_as_responder(
    inner: &EngineInner,
    pending: &mut PendingMap,
    from: PeerAddr,
    payload: &Bytes,
) -> StepResult {
    let Some(state) = pending.get_mut(&from).filter(|p| p.role == Role::Responder) else {
        return (None, None);
    };
    let mut buf = [0u8; MSG_BUF];
    if let Err(e) = state.hs.read_message(payload, &mut buf) {
        tracing::debug!(target: "zudp::handshake", peer = %from, "invalid msg3: {e}");
        return (None, None);
    }
    if !claimed_key_ok(from, &state.hs) {
        tracing::warn!(target: "zudp::security", peer = %from, "relayed handshake aborted — the relay's sender claim does not match the authenticated key");
        inner
            .dropped_forged
            .fetch_add(1, std::sync::atomic::Ordering::Relaxed);
        pending.remove(&from);
        return (None, None);
    }
    if !pinned_key_ok(inner, &state.hs) {
        tracing::warn!(target: "zudp::security", peer = %from, "handshake aborted — remote key does not match pinned key");
        pending.remove(&from);
        return (None, None);
    }
    let Some(state) = pending.remove(&from) else {
        return (None, None);
    };
    match into_established(state, None) {
        Ok(done) => (None, Some(done)),
        Err(e) => {
            tracing::error!(target: "zudp::handshake", peer = %from, "into_transport_mode: {e}");
            (None, None)
        }
    }
}

fn new_initiator(kp: &crate::security::Keypair) -> Result<Pending, Error> {
    let mut hs = build_initiator(kp)?;
    let local_index = random_u64();
    let mut out = vec![0u8; MSG_BUF];
    let n = hs.write_message(&local_index.to_be_bytes(), &mut out)?;
    out.truncate(n);
    let our_ephemeral = out.get(..32).and_then(|e| e.try_into().ok());
    Ok(Pending {
        hs,
        role: Role::Initiator,
        local_index,
        remote_index: 0,
        started: Instant::now(),
        last_sent: wire(STEP_INIT, out),
        last_received: None,
        our_ephemeral,
        waiter: None,
    })
}

/// Drop half-open handshakes older than the handshake timeout.
pub(crate) fn expire(inner: &EngineInner) {
    let timeout = inner.config.handshake_timeout;
    inner.pending.lock().retain(|addr, p| {
        let keep = p.started.elapsed() < timeout;
        if !keep {
            tracing::debug!(target: "zudp::handshake", peer = %addr, role = ?p.role, "half-open handshake expired");
        }
        keep
    });
}

/// The relay says `peer` is unreachable: end the handshake with it, failing whoever waits.
/// Returns `false` when no handshake with `peer` was in progress.
pub(crate) fn fail_unreachable(inner: &EngineInner, peer: PeerAddr) -> bool {
    let Some(mut pending) = inner.pending.lock().remove(&peer) else {
        return false;
    };
    tracing::debug!(target: "zudp::handshake", %peer, "relay reports the target unreachable");
    if let Some(waiter) = pending.waiter.take() {
        let _ = waiter.send(Outcome::Unreachable);
    }
    true
}

/// `true` when `index` belongs to a handshake that has not finished on our side yet.
pub(crate) fn is_pending_index(inner: &EngineInner, index: u64) -> bool {
    inner
        .pending
        .lock()
        .values()
        .any(|p| p.local_index == index)
}

/// Run a full handshake with `peer` as initiator.
///
/// Returns once the session is established on both ends: something authenticated has come
/// back from the remote.  Fails with [`Error::HandshakeTimeout`] or [`Error::KeyMismatch`].
pub(crate) async fn initiate(engine: &Weak<EngineInner>, peer: PeerAddr) -> Result<(), Error> {
    let (deadline, rx) = {
        let inner = engine.upgrade().ok_or_else(stopped)?;
        let Some(kp) = inner.keypair.as_ref() else {
            return Ok(());
        };
        let mut state = new_initiator(kp)?;
        let (tx, rx) = oneshot::channel();
        state.waiter = Some(tx);
        // Registered before the first send so a fast msg2 always finds the initiator state.
        inner.pending.lock().insert(peer, state);
        (Instant::now() + inner.config.handshake_timeout, rx)
    };

    let outcome = retransmit_until(engine, peer, deadline, rx, |inner| {
        inner
            .pending
            .lock()
            .get(&peer)
            .filter(|p| p.role == Role::Initiator)
            .map(|p| p.last_sent.clone())
    })
    .await;
    match outcome {
        Some(Outcome::Ready { generation }) => confirm(engine, peer, deadline, generation).await,
        Some(Outcome::KeyMismatch) => Err(Error::KeyMismatch),
        Some(Outcome::Unreachable) => Err(Error::Unreachable {
            key: peer.key().unwrap_or_default(),
        }),
        None => {
            if let Some(inner) = engine.upgrade() {
                inner.pending.lock().remove(&peer);
            }
            Err(Error::HandshakeTimeout { peer })
        }
    }
}

/// Resend whatever `next_wire` yields with back-off until `rx` resolves or `deadline`.
async fn retransmit_until<F>(
    engine: &Weak<EngineInner>,
    peer: PeerAddr,
    deadline: Instant,
    mut rx: oneshot::Receiver<Outcome>,
    next_wire: F,
) -> Option<Outcome>
where
    F: Fn(&EngineInner) -> Option<Bytes>,
{
    let mut delay = RETRY_MIN;
    loop {
        let wire = {
            let inner = engine.upgrade()?;
            let sock = inner.get_socket();
            next_wire(&inner)
                .and_then(|w| inner.outbound_to(peer, w))
                .map(|w| (w, sock))
        };
        if let Some(((wire, dest), sock)) = wire
            && let Err(e) = sock.send_to(&wire, dest).await
        {
            tracing::debug!(target: "zudp::handshake", %peer, "send: {e}");
        }
        let now = Instant::now();
        if now >= deadline {
            return None;
        }
        match tokio::time::timeout(delay.min(deadline - now), &mut rx).await {
            Ok(Ok(outcome)) => return Some(outcome),
            Ok(Err(_)) => return None,
            Err(_) => delay = (delay * 2).min(RETRY_MAX),
        }
    }
}

/// Wait for the first authenticated frame from `peer`, resending msg3 and a Ping meanwhile.
async fn confirm(
    engine: &Weak<EngineInner>,
    peer: PeerAddr,
    deadline: Instant,
    generation: u64,
) -> Result<(), Error> {
    let mut delay = RETRY_MIN;
    loop {
        let (session, inner) = {
            let inner = engine.upgrade().ok_or_else(stopped)?;
            let session = inner
                .peers
                .get(&peer)
                .map(|r| r.value().clone())
                .filter(|p| p.generation == generation)
                .ok_or(Error::HandshakeTimeout { peer })?;
            (session, inner)
        };
        let wait = session.confirmed_notify.notified();
        tokio::pin!(wait);
        wait.as_mut().enable();
        if session.is_confirmed() {
            session.clear_finish_wire();
            return Ok(());
        }
        let sock = inner.get_socket();
        let ping =
            crate::engine::ping_for(&inner, &session).and_then(|p| inner.outbound(&session, p));
        let finish = session
            .finish_wire()
            .and_then(|f| inner.outbound_to(peer, f));
        drop(inner);
        for (wire, dest) in [finish, ping].into_iter().flatten() {
            let _ = sock.send_to(&wire, dest).await;
        }
        let now = Instant::now();
        if now >= deadline {
            return Err(Error::HandshakeTimeout { peer });
        }
        let _ = tokio::time::timeout(delay.min(deadline - now), wait).await;
        delay = (delay * 2).min(RETRY_MAX);
    }
}

fn stopped() -> Error {
    Error::EngineStopped {
        reason: "engine stopped during handshake".into(),
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn index_payload_roundtrip() {
        assert_eq!(read_index(&42u64.to_be_bytes()), Some(42));
        assert_eq!(read_index(&[1, 2, 3]), None);
    }
}