tox 0.0.5

Implementation of toxcore in pure Rust - P2P, distributed, encrypted, easy to use DHT-based network.
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

/*! The implementation of TCP Relay client connection
*/

use toxcore::tcp::packet::*;
use toxcore::io_tokio::*;

use futures::sync::mpsc;
use futures::future;

use std::io::{Error, ErrorKind};

/** A packet received from server.
    May be handled by user in callbacks
*/
#[derive(Debug, PartialEq, Clone)]
pub enum IncomingPacket {
    /// response to RouteRequest
    RouteResponse(RouteResponse),
    /// notification from server when both clients sent RouteRequest
    ConnectNotification(ConnectNotification),
    /// when other client was disconnected
    DisconnectNotification(DisconnectNotification),
    /// oob from other client with sender pk
    OobReceive(OobReceive),
    /// data from connected client
    Data(Data)
}

/** A packet should be sent to server.
    Used by user to send packet to server
*/
#[derive(Debug, PartialEq, Clone)]
pub enum OutgoingPacket {
    /// ask server to connect to other client
    RouteRequest(RouteRequest),
    /// force server to drop the connection by id
    DisconnectNotification(DisconnectNotification),
    /// send oob by pk
    OobSend(OobSend),
    /// send data to connected client by id
    Data(Data)
}

/** Connection between server and client
*/
#[derive(Debug, Clone)]
pub struct Connection {
    /// The channel side to send packets to server
    server_tx: mpsc::UnboundedSender<Packet>,
    /// The channel side to send packets to client to handle them in callbacks
    callback_tx: mpsc::UnboundedSender<IncomingPacket>,
}

impl Connection {
    /** Create a new connection
        Client-side code must call this function to send the packet to server
    */
    pub fn new(server_tx: mpsc::UnboundedSender<Packet>,
            callback_tx: mpsc::UnboundedSender<IncomingPacket>) -> Connection {
        Connection { server_tx, callback_tx }
    }
    pub(super) fn handle_from_server(&self, packet: Packet) -> IoFuture<()> {
        match packet {
            Packet::RouteRequest(_packet) => {
                Box::new( future::err(
                    Error::new(ErrorKind::Other,
                        "Server must not send RouteRequest to client"
                )))
            },
            Packet::RouteResponse(packet) => {
                self.send_to_client( IncomingPacket::RouteResponse(packet) )
            },
            Packet::ConnectNotification(packet) => {
                self.send_to_client( IncomingPacket::ConnectNotification(packet) )
            },
            Packet::DisconnectNotification(packet) => {
                self.send_to_client( IncomingPacket::DisconnectNotification(packet) )
            },
            Packet::PingRequest(packet) => {
                self.send_to_server(Packet::PongResponse(
                    PongResponse { ping_id: packet.ping_id }
                ))
            },
            Packet::PongResponse(_packet) => {
                // TODO check ping_id
                Box::new( future::ok(()) )
            },
            Packet::OobSend(_packet) => {
                Box::new( future::err(
                    Error::new(ErrorKind::Other,
                        "Server must not send OobSend to client"
                )))
            },
            Packet::OobReceive(packet) => {
                self.send_to_client( IncomingPacket::OobReceive(packet) )
            },
            Packet::Data(packet) => {
                self.send_to_client( IncomingPacket::Data(packet) )
            },
            _ => unimplemented!() // TODO onion
        }
    }
    /** Handle packet from client
        Client-side code must call this function to send the packet to server
    */
    pub(super) fn handle_from_client(&self, packet: OutgoingPacket) -> IoFuture<()> {
        match packet {
            OutgoingPacket::RouteRequest(packet) => {
                self.send_to_server( Packet::RouteRequest(packet) )
            },
            OutgoingPacket::DisconnectNotification(packet) => {
                self.send_to_server( Packet::DisconnectNotification(packet) )
            },
            OutgoingPacket::OobSend(packet) => {
                self.send_to_server( Packet::OobSend(packet) )
            },
            OutgoingPacket::Data(packet) => {
                self.send_to_server( Packet::Data(packet) )
            },
        }
    }
    /// Send packet to server
    fn send_to_server(&self, packet: Packet) -> IoFuture<()> {
        send_to(&self.server_tx, packet)
    }
    /// Send packet back to client (to be handled as a callback)
    fn send_to_client(&self, packet: IncomingPacket) -> IoFuture<()> {
        send_to(&self.callback_tx, packet)
    }
}

#[cfg(test)]
mod tests {
    use toxcore::crypto_core::*;
    use toxcore::tcp::client::connection::*;
    use futures::prelude::*;
    use futures::sync::mpsc;

    fn create_connection_channels()
        -> (Connection, mpsc::UnboundedReceiver<Packet>, mpsc::UnboundedReceiver<IncomingPacket>) {
        let (server_tx, server_rx) = mpsc::unbounded();
        let (callback_tx, callback_rx) = mpsc::unbounded();
        let connection = Connection::new(server_tx, callback_tx);
        (connection.clone(), server_rx, callback_rx)
    }

    // client tests
    #[test]
    fn client_route_request() {
        let (connection, server_rx, _callback_rx) = create_connection_channels();

        let friend_pk = PublicKey([15, 107, 126, 130, 81, 55, 154, 157,
                                192, 117, 0, 225, 119, 43, 48, 117,
                                84, 109, 112, 57, 243, 216, 4, 171,
                                185, 111, 33, 146, 221, 31, 77, 118]);

        let outgoing_packet = OutgoingPacket::RouteRequest(
            RouteRequest { pk: friend_pk }
        );
        connection.handle_from_client(outgoing_packet.clone()).wait().unwrap();

        let (incoming_packet, _tail) = server_rx.into_future().wait().unwrap();
        assert_eq!(incoming_packet.unwrap(), Packet::RouteRequest(RouteRequest {
            pk: friend_pk
        }));
    }
    #[test]
    fn client_disconnect_notification() {
        let (connection, server_rx, _callback_rx) = create_connection_channels();

        let outgoing_packet = OutgoingPacket::DisconnectNotification(
            DisconnectNotification { connection_id: 42 }
        );
        connection.handle_from_client(outgoing_packet.clone()).wait().unwrap();

        let (incoming_packet, _tail) = server_rx.into_future().wait().unwrap();
        assert_eq!(incoming_packet.unwrap(), Packet::DisconnectNotification(
            DisconnectNotification { connection_id: 42 }
        ));
    }
    #[test]
    fn client_oob_send() {
        let (connection, server_rx, _callback_rx) = create_connection_channels();

        let friend_pk = PublicKey([15, 107, 126, 130, 81, 55, 154, 157,
                                192, 117, 0, 225, 119, 43, 48, 117,
                                84, 109, 112, 57, 243, 216, 4, 171,
                                185, 111, 33, 146, 221, 31, 77, 118]);

        let outgoing_packet = OutgoingPacket::OobSend(
            OobSend { destination_pk: friend_pk, data: vec![13; 42] }
        );
        connection.handle_from_client(outgoing_packet.clone()).wait().unwrap();

        let (incoming_packet, _tail) = server_rx.into_future().wait().unwrap();
        assert_eq!(incoming_packet.unwrap(), Packet::OobSend(
            OobSend { destination_pk: friend_pk, data: vec![13; 42] }
        ));
    }
    #[test]
    fn client_data() {
        let (connection, server_rx, _callback_rx) = create_connection_channels();

        let outgoing_packet = OutgoingPacket::Data(
            Data { connection_id: 42, data: vec![13; 42] }
        );
        connection.handle_from_client(outgoing_packet.clone()).wait().unwrap();

        let (incoming_packet, _tail) = server_rx.into_future().wait().unwrap();
        assert_eq!(incoming_packet.unwrap(), Packet::Data(
            Data { connection_id: 42, data: vec![13; 42] }
        ));
    }

    // server tests
    #[test]
    fn server_route_request() {
        let (connection, _server_rx, _callback_rx) = create_connection_channels();

        let friend_pk = PublicKey([15, 107, 126, 130, 81, 55, 154, 157,
                                192, 117, 0, 225, 119, 43, 48, 117,
                                84, 109, 112, 57, 243, 216, 4, 171,
                                185, 111, 33, 146, 221, 31, 77, 118]);

        let packet = Packet::RouteRequest(
            RouteRequest { pk: friend_pk }
        );
        let handle_res = connection.handle_from_server(packet).wait();
        assert!(handle_res.is_err());
    }
    #[test]
    fn server_route_response() {
        let (connection, _server_rx, callback_rx) = create_connection_channels();

        let friend_pk = PublicKey([15, 107, 126, 130, 81, 55, 154, 157,
                                192, 117, 0, 225, 119, 43, 48, 117,
                                84, 109, 112, 57, 243, 216, 4, 171,
                                185, 111, 33, 146, 221, 31, 77, 118]);

        let packet = Packet::RouteResponse(
            RouteResponse { pk: friend_pk, connection_id: 42 }
        );
        connection.handle_from_server(packet).wait().unwrap();
        let (incoming_packet, _tail) = callback_rx.into_future().wait().unwrap();
        assert_eq!(incoming_packet.unwrap(), IncomingPacket::RouteResponse(
            RouteResponse { pk: friend_pk, connection_id: 42 }
        ));
    }
    #[test]
    fn server_connect_notification() {
        let (connection, _server_rx, callback_rx) = create_connection_channels();

        let packet = Packet::ConnectNotification(
            ConnectNotification { connection_id: 42 }
        );
        connection.handle_from_server(packet).wait().unwrap();
        let (incoming_packet, _tail) = callback_rx.into_future().wait().unwrap();
        assert_eq!(incoming_packet.unwrap(), IncomingPacket::ConnectNotification(
            ConnectNotification { connection_id: 42 }
        ));
    }
    #[test]
    fn server_disconnect_notification() {
        let (connection, _server_rx, callback_rx) = create_connection_channels();

        let packet = Packet::DisconnectNotification(
            DisconnectNotification { connection_id: 42 }
        );
        connection.handle_from_server(packet).wait().unwrap();
        let (incoming_packet, _tail) = callback_rx.into_future().wait().unwrap();
        assert_eq!(incoming_packet.unwrap(), IncomingPacket::DisconnectNotification(
            DisconnectNotification { connection_id: 42 }
        ));
    }
    #[test]
    fn server_ping_request() {
        let (connection, server_rx, _callback_rx) = create_connection_channels();

        let packet = Packet::PingRequest(
            PingRequest { ping_id: 42 }
        );
        connection.handle_from_server(packet).wait().unwrap();
        let (incoming_packet, _tail) = server_rx.into_future().wait().unwrap();
        assert_eq!(incoming_packet.unwrap(), Packet::PongResponse(
            PongResponse { ping_id: 42 }
        ));
    }
    #[test]
    fn server_oob_send() {
        let (connection, _server_rx, _callback_rx) = create_connection_channels();

        let friend_pk = PublicKey([15, 107, 126, 130, 81, 55, 154, 157,
                                192, 117, 0, 225, 119, 43, 48, 117,
                                84, 109, 112, 57, 243, 216, 4, 171,
                                185, 111, 33, 146, 221, 31, 77, 118]);

        let packet = Packet::OobSend(
            OobSend { destination_pk: friend_pk, data: vec![13; 42] }
        );
        let handle_res = connection.handle_from_server(packet).wait();
        assert!(handle_res.is_err());
    }
    #[test]
    fn server_oob_receive() {
        let (connection, _server_rx, callback_rx) = create_connection_channels();

        let friend_pk = PublicKey([15, 107, 126, 130, 81, 55, 154, 157,
                                192, 117, 0, 225, 119, 43, 48, 117,
                                84, 109, 112, 57, 243, 216, 4, 171,
                                185, 111, 33, 146, 221, 31, 77, 118]);

        let packet = Packet::OobReceive(
            OobReceive { sender_pk: friend_pk, data: vec![13; 42] }
        );
        connection.handle_from_server(packet).wait().unwrap();
        let (incoming_packet, _tail) = callback_rx.into_future().wait().unwrap();
        assert_eq!(incoming_packet.unwrap(), IncomingPacket::OobReceive(
            OobReceive { sender_pk: friend_pk, data: vec![13; 42] }
        ));
    }
    #[test]
    fn server_data() {
        let (connection, _server_rx, callback_rx) = create_connection_channels();

        let packet = Packet::Data(
            Data { connection_id: 42, data: vec![13; 42] }
        );
        connection.handle_from_server(packet).wait().unwrap();
        let (incoming_packet, _tail) = callback_rx.into_future().wait().unwrap();
        assert_eq!(incoming_packet.unwrap(), IncomingPacket::Data(
            Data { connection_id: 42, data: vec![13; 42] }
        ));
    }

    // test lost rx parts
    #[test]
    fn server_disconnected() {
        let (connection, server_rx, _callback_rx) = create_connection_channels();
        drop(server_rx);

        let packet = OutgoingPacket::DisconnectNotification(
            DisconnectNotification { connection_id: 42 }
        );
        let handle_res = connection.handle_from_client(packet).wait();
        assert!(handle_res.is_err());
    }
    #[test]
    fn client_disconnected() {
        let (connection, _server_rx, callback_rx) = create_connection_channels();
        drop(callback_rx);

        let packet = Packet::DisconnectNotification(
            DisconnectNotification { connection_id: 42 }
        );
        let handle_res = connection.handle_from_server(packet).wait();
        assert!(handle_res.is_err());
    }
}