gwyh 0.1.0

gwyh is a sweet gossip library
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
use std::collections::HashMap;
use std::fmt::Debug;
use std::future::Future;
use std::net::SocketAddr;
use std::num::NonZeroUsize;
use std::ops::RangeInclusive;
use std::sync::Arc;

use dryoc::dryocbox::{DryocBox, KeyPair, NewByteArray, Nonce, PublicKey, VecBox};
use futures::future::join_all;
use genserver::GenServer;
use lazy_static::lazy_static;
use lru::LruCache;
use rand::rngs::StdRng;
use rand::{Rng, SeedableRng};
use tokio::net::UdpSocket;
use tokio::time::{Duration, Instant};
use tracing::error;
use uuid::Uuid;

use crate::handshake::HandshakerMessage;
use crate::interval::Interval;
use crate::message::{Body, Message};
use crate::packet::{Packet, Payload};
use crate::peer_manager::{PeerManagerRequest, PeerRequest, PeerStatus};
use crate::registry::Registry;
use crate::sequence::Seq32;
use crate::GwyhHandler;

impl Debug for dyn GwyhHandler + Send + Sync {
    fn fmt(&self, _: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        Ok(())
    }
}

lazy_static! {
    static ref PAYLOAD_LENGTH_MAX: usize = {
        // encrypt an empty message
        let sender_keypair = KeyPair::gen();
        let recipient_keypair = KeyPair::gen();
        let nonce = Nonce::gen();
        let message = b"";
        let dryocbox = DryocBox::encrypt_to_vecbox(
            message,
            &nonce,
            &recipient_keypair.public_key,
            &sender_keypair.secret_key,
        )
        .expect("unable to encrypt");

        let packet = Packet {
            s: Seq32::new(),
            id: Uuid::new_v4(),
            p: Payload::B(dryocbox, nonce)
        };
        let packet = rmp_serde::to_vec(&packet).expect("serialize failed");

        // UDP packet limit length:
        // 65,507 bytes (65,535 bytes − 8-byte UDP header − 20-byte IP header)
        65507 - packet.len()
    };
}

// we implement a congestion control algo somewhat similar to the one described
// in https://datatracker.ietf.org/doc/html/draft-gg-udt-01.

// approx. 100,000 packets per second
static RC_DEFAULT_PACKET_INTERVAL_NANOS: u64 = 10_000;
static RC_TIMER_MS: u64 = 60_000;
static RC_LOSS_RATE_THRESHOLD: f64 = 0.001; // 0.1%
static RC_DELAY_DECREASE: u64 = 100;
static RC_DELAY_INCREASE: RangeInclusive<f64> = 2.0..=8.0;

#[derive(Debug)]
pub enum PacketHandlerMessage {
    Start(Arc<UdpSocket>),
    Send(SocketAddr, Payload),
    Recv(SocketAddr, Packet),
    KeysUpdated(HashMap<Uuid, (SocketAddr, KeyPair, PublicKey)>),
    SendMessage(Uuid, Message),
    SubscribersUpdated(Vec<Uuid>),
    SendBroadcast(Vec<u8>),
    BroadcastPeerStatus(PeerStatus),
    SetBroadcastHandler(
        Option<Arc<dyn GwyhHandler + Send + Sync>>,
        Option<Arc<dyn GwyhHandler + Send + Sync>>,
    ),
    RateControl,
}

pub struct PacketHandler {
    registry: Registry,
    socket: Option<Arc<UdpSocket>>,
    tx_sequences: HashMap<SocketAddr, Seq32>,
    rx_sequences: HashMap<SocketAddr, Seq32>,
    last_tx: HashMap<SocketAddr, Instant>,
    nak_count: HashMap<SocketAddr, u32>,
    tx_delay: HashMap<SocketAddr, u64>,
    rc_sequences: HashMap<SocketAddr, Seq32>,
    keys: HashMap<Uuid, (SocketAddr, KeyPair, PublicKey)>,
    subscribers: Vec<Uuid>,
    seen: LruCache<Uuid, ()>,
    broadcast_handler_async: Option<Arc<dyn GwyhHandler + Send + Sync>>,
    broadcast_handler: Option<Arc<dyn GwyhHandler + Send + Sync>>,
    rng: StdRng,
    _rate_control: Interval,
}

impl GenServer for PacketHandler {
    type Message = PacketHandlerMessage;
    type Registry = Registry;
    type Response = ();

    type CallResponse<'a> = impl Future<Output = Self::Response> + 'a;
    type CastResponse<'a> = impl Future<Output = ()> + 'a;

    fn new(registry: Self::Registry) -> Self {
        let rc_registry = registry.clone();
        let rate_control = Interval::new(Duration::from_millis(RC_TIMER_MS), move || {
            let rc_registry = rc_registry.clone();
            async move {
                rc_registry
                    .cast_packet_handler(PacketHandlerMessage::RateControl)
                    .await
                    .ok();
            }
        });
        Self {
            registry,
            socket: None,
            tx_sequences: HashMap::new(),
            rx_sequences: HashMap::new(),
            last_tx: HashMap::new(),
            nak_count: HashMap::new(),
            tx_delay: HashMap::new(),
            rc_sequences: HashMap::new(),
            keys: HashMap::new(),
            subscribers: vec![],
            seen: LruCache::new(NonZeroUsize::new(10_000).expect("bad usize")),
            broadcast_handler_async: None,
            broadcast_handler: None,
            rng: SeedableRng::from_entropy(),
            _rate_control: rate_control,
        }
    }

    fn handle_call(&mut self, message: Self::Message) -> Self::CallResponse<'_> {
        async {
            self.handle_message(message).await;
        }
    }

    fn handle_cast(&mut self, message: Self::Message) -> Self::CastResponse<'_> {
        async {
            self.handle_message(message).await;
        }
    }
}

impl PacketHandler {
    #[tracing::instrument(skip(self))]
    async fn handle_message(&mut self, message: PacketHandlerMessage) {
        match message {
            PacketHandlerMessage::SetBroadcastHandler(async_handler, handler) => {
                self.broadcast_handler_async = async_handler;
                self.broadcast_handler = handler;
            }
            PacketHandlerMessage::Start(socket) => self.start_recv_loop(socket).await,
            PacketHandlerMessage::Send(sockaddr, payload) => self.send(payload, sockaddr).await,
            PacketHandlerMessage::Recv(sockaddr, packet) => self.recv(packet, sockaddr).await,
            PacketHandlerMessage::SendMessage(target_id, message) => {
                self.encrypt_and_send_message(target_id, message).await;
            }
            PacketHandlerMessage::SendBroadcast(data) => {
                self.send_broadcast(data).await;
            }
            PacketHandlerMessage::BroadcastPeerStatus(peer_status) => {
                self.send_peer_status(peer_status).await;
            }
            PacketHandlerMessage::KeysUpdated(keys) => self.keys = keys,
            PacketHandlerMessage::SubscribersUpdated(subscribers) => {
                self.subscribers = subscribers;
            }
            PacketHandlerMessage::RateControl => self.update_rate_control(),
        }
    }

    fn update_rate_control(&mut self) {
        let current_seqs = self.tx_sequences.clone();

        // calculate loss rate for this interval
        current_seqs
            .iter()
            .map(|(sock, seq)| {
                (
                    sock,
                    **seq - **self.rc_sequences.get(sock).unwrap_or(&Seq32::new()),
                )
            })
            .map(|(sock, count)| {
                (
                    sock,
                    if count > 0 {
                        *self.nak_count.get(sock).unwrap_or(&0) as f64 / count as f64
                    } else {
                        0.0
                    },
                )
            })
            .filter(|(_, loss_rate)| *loss_rate < RC_LOSS_RATE_THRESHOLD)
            .for_each(|(sock, _)| {
                // if the loss rate is below 0.1% for this interval,
                self.tx_delay
                    .entry(*sock)
                    .and_modify(|delay| {
                        *delay = if *delay > RC_DELAY_DECREASE {
                            *delay - RC_DELAY_DECREASE
                        } else {
                            0
                        }
                    })
                    .or_insert(RC_DEFAULT_PACKET_INTERVAL_NANOS);
            });
    }

    #[tracing::instrument(skip(self))]
    async fn start_recv_loop(&mut self, socket: Arc<UdpSocket>) {
        self.socket = Some(socket.clone());
        let registry = self.registry.clone();
        tokio::spawn(async move {
            let mut buf = [0; 65536];
            loop {
                match socket.recv_from(&mut buf).await {
                    Ok((_len, addr)) => {
                        if let Ok(packet) = rmp_serde::from_slice::<Packet>(&buf) {
                            registry
                                .cast_packet_handler(PacketHandlerMessage::Recv(addr, packet))
                                .await
                                .ok();
                        }
                    }
                    Err(err) => error!("{:?}", err),
                }
            }
        });
    }

    #[tracing::instrument(skip(self))]
    pub async fn recv(&mut self, packet: Packet, from_sockaddr: SocketAddr) {
        let prev_rx_seq = self.rx_sequences.insert(from_sockaddr, packet.s);
        match packet.p {
            Payload::H(handshake) => self
                .registry
                .cast_handshaker(HandshakerMessage::Packet(
                    from_sockaddr,
                    handshake,
                    packet.id,
                ))
                .await
                .expect("send failed"),
            Payload::B(vecbox, nonce) => {
                if let Ok(message) = self.decrypt(packet.id, vecbox, nonce) {
                    if !self.seen.contains(&message.id) {
                        match message.body {
                            Body::Broadcast(data) => {
                                self.recv_broadcast(message.id, data).await;
                                self.seen.put(message.id, ());
                            }
                            Body::PeerRequest(request) => {
                                self.recv_peer_request(message.id, packet.id, request).await;
                                self.seen.put(message.id, ());
                            }
                            Body::Frame(_frame) => (),
                            Body::Nak(seq) => {
                                self.nak_count
                                    .entry(from_sockaddr)
                                    .and_modify(|c| *c += seq.end - seq.start)
                                    .or_insert(seq.end - seq.start);
                                // increase the TX delay
                                self.tx_delay
                                    .entry(from_sockaddr)
                                    .and_modify(|d| {
                                        *d = (*d as f64
                                            * self.rng.gen_range(RC_DELAY_INCREASE.clone()))
                                            as u64
                                    })
                                    .or_insert(RC_DEFAULT_PACKET_INTERVAL_NANOS);
                            }
                        }
                    }
                    // handle NAKs if we skipped any sequences
                    if let Some(prev_rx_seq) = prev_rx_seq {
                        let missed_range = *prev_rx_seq + 1..*packet.s;
                        let body = Body::Nak(missed_range);
                        let message = Message {
                            id: Uuid::new_v4(),
                            body,
                        };
                        self.encrypt_and_send_message(packet.id, message).await;
                    }
                } else {
                    error!(
                        "decrypt failed on {} from {}",
                        self.registry.nodeinfo().id(),
                        packet.id,
                    );
                }
            }
        }
    }

    #[tracing::instrument(skip(self))]
    pub async fn send(&mut self, payload: Payload, to_sockaddr: SocketAddr) {
        if let Some(socket) = self.socket.clone() {
            let seq = self.tx_sequences.entry(to_sockaddr).or_default();
            seq.inc();

            let packet = Packet {
                s: *seq,
                id: *self.registry.nodeinfo().id(),
                p: payload,
            };

            let prev_tx = self.last_tx.insert(to_sockaddr, Instant::now());
            let tx_delay = self
                .tx_delay
                .get(&to_sockaddr)
                .cloned()
                .unwrap_or(RC_DEFAULT_PACKET_INTERVAL_NANOS);

            let next_window = prev_tx.map(|p| p + Duration::from_nanos(tx_delay));
            tokio::spawn(async move {
                if let Some(next_window) = next_window {
                    tokio::time::sleep_until(next_window).await;
                }
                let packet = rmp_serde::to_vec(&packet).unwrap();
                socket
                    .send_to(&packet, &to_sockaddr)
                    .await
                    .expect("send failed"); // should never fail
            });
        }
    }

    #[tracing::instrument(skip(self))]
    pub async fn multisend(&mut self, payloads: Vec<(Payload, SocketAddr)>) {
        if let Some(socket) = &self.socket {
            join_all(payloads.into_iter().map(|(payload, to_sockaddr)| {
                let seq = self.tx_sequences.entry(to_sockaddr).or_default();
                seq.inc();

                let packet = Packet {
                    s: *seq,
                    id: *self.registry.nodeinfo().id(),
                    p: payload,
                };
                let packet = rmp_serde::to_vec(&packet).unwrap();
                async move { socket.send_to(&packet, &to_sockaddr).await }
            }))
            .await;
        }
    }

    fn encrypt(
        message: Message,
        keypair: &KeyPair,
        public_key: &PublicKey,
    ) -> Result<(VecBox, Nonce), dryoc::Error> {
        let serialized = rmp_serde::to_vec(&message).unwrap();
        let nonce = Nonce::gen();

        // Encrypt the message into a Vec<u8>-based box.
        DryocBox::encrypt_to_vecbox(&serialized, &nonce, public_key, &keypair.secret_key)
            .map(|enc| (enc, nonce))
    }

    fn decrypt(&self, id: Uuid, vecbox: VecBox, nonce: Nonce) -> Result<Message, ()> {
        if let Some((_, keypair, public_key)) = self.keys.get(&id) {
            if let Ok(serialized) = vecbox.decrypt_to_vec(&nonce, public_key, &keypair.secret_key) {
                if let Ok(message) = rmp_serde::from_slice(&serialized) {
                    return Ok(message);
                }
            } else {
                error!("invalid keys");
            }
        } else {
            error!("keys not found");
        }
        Err(())
    }

    #[tracing::instrument(skip(self))]
    pub async fn encrypt_and_send_message(&mut self, target: Uuid, message: Message) {
        self.encrypt_and_send_messages(vec![target], message).await
    }

    #[tracing::instrument(skip(self))]
    pub async fn encrypt_and_send_messages(&mut self, targets: Vec<Uuid>, message: Message) {
        self.seen.put(message.id, ());
        // need keypairs & PK for targets
        let keys = targets
            .into_iter()
            .flat_map(|target| self.keys.get(&target))
            .cloned();
        // perform encryption off the async thread
        let boxes: Vec<_> = join_all(keys.map(|(sockaddr, keypair, public_key)| {
            let message = message.clone();
            tokio::task::spawn_blocking(move || {
                Self::encrypt(message, &keypair, &public_key)
                    .map(|(vecbox, nonce)| (vecbox, nonce, sockaddr))
            })
        }))
        .await;
        // collect into payloads
        let payloads: Vec<_> = boxes
            .into_iter()
            .flatten()
            .flatten()
            .map(|(vecbox, nonce, sockaddr)| (Payload::B(vecbox, nonce), sockaddr))
            .collect();
        // do a concurrent send
        self.multisend(payloads).await;
    }

    #[tracing::instrument(skip(self))]
    pub async fn send_broadcast(&mut self, data: Vec<u8>) {
        self.send_broadcast_to_subscribers(Message {
            id: Uuid::new_v4(),
            body: Body::Broadcast(data),
        })
        .await;
    }

    #[tracing::instrument(skip(self))]
    pub async fn send_peer_status(&mut self, peer_status: PeerStatus) {
        self.send_broadcast_to_subscribers(Message {
            id: Uuid::new_v4(),
            body: Body::PeerRequest(Box::new(PeerRequest::PeerStatus(peer_status))),
        })
        .await;
    }

    #[tracing::instrument(skip(self))]
    pub async fn recv_broadcast(&mut self, id: Uuid, data: Vec<u8>) {
        if let Some(handler) = &self.broadcast_handler_async {
            handler.handle_broadcast(data.clone()).await.ok();
        }
        self.send_broadcast_to_subscribers(Message {
            id,
            body: Body::Broadcast(data),
        })
        .await;
    }

    #[tracing::instrument(skip(self))]
    pub async fn recv_peer_request(
        &mut self,
        message_id: Uuid,
        from_id: Uuid,
        request: Box<PeerRequest>,
    ) {
        // forward the status we just received to subscribers
        self.send_broadcast_to_subscribers(Message {
            id: message_id,
            body: Body::PeerRequest(request.clone()),
        })
        .await;
        self.registry
            .cast_peer_manager(PeerManagerRequest::Request { from_id, request })
            .await
            .ok();
    }

    #[tracing::instrument(skip(self))]
    pub async fn send_broadcast_to_subscribers(&mut self, message: Message) {
        let sub_ids = self.subscribers.to_vec();
        self.encrypt_and_send_messages(sub_ids, message).await;
    }
}