hyperdht 0.1.1

Rust implementation of hyperdht, peer announcements and connections on top of dht-rpc
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

use std::{
    mem::replace,
    net::SocketAddr,
    pin::Pin,
    sync::{Arc, RwLock},
    task::{Context, Poll},
};

use async_compat::Compat;
use dht_rpc::Rpc;
use futures::{Sink, Stream};
use hypercore_handshake::{Cipher, CipherEvent, CipherIo, CipherTrait};
use udx::HalfOpenStreamHandle;
use uint24le_framing::Uint24LELengthPrefixedFraming;

use crate::Error;

#[derive(Debug)]
pub enum ConnStep {
    /// Initial State
    Start(HalfOpenStreamHandle),
    /// Handshake Ready
    Ready,
    // Handshake failed
    Failed,
}

pub struct ConnectionInner {
    pub handshake: Cipher,
    pub udx_local_id: u32,
    pub step: ConnStep,
    /// Optional RPC to poll for flushing responses (used by server-side connections)
    pub rpc: Option<Rpc>,
}

impl std::fmt::Debug for ConnectionInner {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("ConnectionInner")
            .field("handshake", &self.handshake)
            .field("udx_local_id", &self.udx_local_id)
            .field("step", &self.step)
            //.field("rpc", &self.rpc)
            .finish()
    }
}

impl ConnectionInner {
    pub fn new(handshake: Cipher, udx_local_id: u32, half_stream: HalfOpenStreamHandle) -> Self {
        Self {
            handshake,
            udx_local_id,
            step: ConnStep::Start(half_stream),
            rpc: None,
        }
    }

    pub fn new_with_rpc(
        handshake: Cipher,
        udx_local_id: u32,
        half_stream: HalfOpenStreamHandle,
        rpc: Rpc,
    ) -> Self {
        Self {
            handshake,
            udx_local_id,
            step: ConnStep::Start(half_stream),
            rpc: Some(rpc),
        }
    }
    pub fn receive_next(&mut self, noise: Vec<u8>) -> Result<CipherEvent, Error> {
        self.handshake.receive_next(noise);
        Ok(self
            .handshake
            .next_decrypted_message()?
            .expect("recieved msg above"))
    }
    pub fn handshake_ready(&self) -> bool {
        self.handshake.ready()
    }
    pub fn udx_local_id(&self) -> u32 {
        self.udx_local_id
    }
    pub fn handshake_set_io(&mut self, io: Box<dyn CipherIo<Error = std::io::Error>>) {
        self.handshake.set_io(io)
    }
    pub fn set_step(&mut self, step: ConnStep) {
        self.step = step;
    }

    fn connect(&mut self, addr: SocketAddr, remote_id: u32) -> Result<(), Error> {
        let ConnStep::Start(half_stream) = replace(&mut self.step, ConnStep::Failed) else {
            todo!()
        };
        let stream = half_stream.connect(addr, remote_id)?;

        let framed_udx_stream = Uint24LELengthPrefixedFraming::new(Compat::new(stream.clone()));
        self.handshake_set_io(Box::new(framed_udx_stream));
        self.step = ConnStep::Ready;
        Ok(())
    }
}

impl Stream for ConnectionInner {
    type Item = CipherEvent;
    fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
        if let Some(ref mut rpc) = self.rpc {
            while Pin::new(&mut *rpc).poll_next(cx).is_ready() {
                // Keep polling to flush responses
            }
        }
        Pin::new(&mut self.handshake).poll_next(cx)
    }
}
impl Sink<Vec<u8>> for ConnectionInner {
    type Error = std::io::Error;

    fn poll_ready(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
        Pin::new(&mut self.handshake).poll_ready(cx)
    }

    fn start_send(mut self: Pin<&mut Self>, item: Vec<u8>) -> Result<(), Self::Error> {
        Pin::new(&mut self.handshake).start_send(item)
    }

    fn poll_flush(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
        Pin::new(&mut self.handshake).poll_flush(cx)
    }

    fn poll_close(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
        Pin::new(&mut self.handshake).poll_close(cx)
    }
}
#[derive(Clone)]
pub struct Connection {
    pub inner: Arc<RwLock<ConnectionInner>>,
}

impl std::fmt::Debug for Connection {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self.inner.try_read() {
            Ok(x) => f.debug_struct("Connection").field("inner", &x).finish(),
            Err(_) => f.debug_struct("Connection").field("inner", &()).finish(),
        }
    }
}

macro_rules! w {
    ($self:expr) => {
        $self.inner.write().unwrap()
    };
}
macro_rules! r {
    ($self:expr) => {
        $self.inner.read().unwrap()
    };
}

impl Connection {
    pub fn new(handshake: Cipher, udx_local_id: u32, half_stream: HalfOpenStreamHandle) -> Self {
        Self {
            inner: Arc::new(RwLock::new(ConnectionInner {
                handshake,
                udx_local_id,
                step: ConnStep::Start(half_stream),
                rpc: None,
            })),
        }
    }

    pub fn new_with_rpc(
        handshake: Cipher,
        udx_local_id: u32,
        half_stream: HalfOpenStreamHandle,
        rpc: Rpc,
    ) -> Self {
        Self {
            inner: Arc::new(RwLock::new(ConnectionInner {
                handshake,
                udx_local_id,
                step: ConnStep::Start(half_stream),
                rpc: Some(rpc),
            })),
        }
    }
    pub fn receive_next(&self, noise: Vec<u8>) -> Result<CipherEvent, Error> {
        w!(self).handshake.receive_next(noise);
        Ok(w!(self)
            .handshake
            .next_decrypted_message()?
            .expect("recieved msg above"))
    }
    pub fn step_ready(&self) -> bool {
        matches!(r!(self).step, ConnStep::Ready)
    }
    pub fn handshake_ready(&self) -> bool {
        r!(self).handshake.ready()
    }
    pub fn udx_local_id(&self) -> u32 {
        r!(self).udx_local_id
    }
    pub fn handshake_set_io(&self, io: Box<dyn CipherIo<Error = std::io::Error>>) {
        w!(self).handshake.set_io(io)
    }
    pub fn set_step(&self, step: ConnStep) {
        w!(self).step = step;
    }
    pub fn connect(&self, addr: SocketAddr, remote_id: u32) -> Result<(), Error> {
        w!(self).connect(addr, remote_id)
    }

    /// Get the remote peer's static public key (from Noise handshake).
    ///
    /// For server-side connections (responder), this returns the initiator's public key.
    /// For client-side connections (initiator), returns None (client already knows the server key).
    pub fn get_remote_static(&self) -> Option<[u8; 32]> {
        r!(self).handshake.get_remote_static()
    }

    /// Get the handshake hash.
    ///
    /// This is a unique identifier for this encrypted session, the same on both sides.
    /// Used for capability verification in hypercore replication.
    ///
    /// Returns `None` until the handshake is complete.
    pub fn handshake_hash(&self) -> Option<Vec<u8>> {
        r!(self).handshake.handshake_hash().map(|h| h.to_vec())
    }
}

impl Stream for Connection {
    type Item = CipherEvent;
    fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
        let mut inner = self.inner.write().unwrap();
        // Poll the RPC to flush any pending responses
        if let Some(ref mut rpc) = inner.rpc {
            while Pin::new(&mut *rpc).poll_next(cx).is_ready() {
                // Keep polling to flush responses
            }
        }
        Pin::new(&mut inner.handshake).poll_next(cx)
    }
}
impl Sink<Vec<u8>> for Connection {
    type Error = std::io::Error;

    fn poll_ready(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
        Pin::new(&mut self.inner.write().unwrap().handshake).poll_ready(cx)
    }

    fn start_send(self: Pin<&mut Self>, item: Vec<u8>) -> Result<(), Self::Error> {
        Pin::new(&mut self.inner.write().unwrap().handshake).start_send(item)
    }

    fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
        Pin::new(&mut self.inner.write().unwrap().handshake).poll_flush(cx)
    }

    fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
        Pin::new(&mut self.inner.write().unwrap().handshake).poll_close(cx)
    }
}

impl CipherTrait for Connection {
    fn remote_public_key(&self) -> Option<[u8; hypercore_handshake::state_machine::PUBLIC_KEYLEN]> {
        self.inner.read().unwrap().handshake.get_remote_static()
    }

    fn local_public_key(&self) -> [u8; hypercore_handshake::state_machine::PUBLIC_KEYLEN] {
        self.inner.read().unwrap().handshake.get_local_public_key()
    }

    fn handshake_hash(&self) -> Option<Vec<u8>> {
        self.inner
            .read()
            .unwrap()
            .handshake
            .handshake_hash()
            .map(|h| h.to_vec())
    }
    fn is_initiator(&self) -> bool {
        self.inner.read().unwrap().handshake.is_initiator()
    }
}