Merge pull request #382 from tox-rs/tcp_data

Use DataPayload type instead of vec

Author: Roman Proskuryakov

examples/tcp_client.rs

@@ -2,6 +2,7 @@
 extern crate log;
 
 use tox::toxcore::crypto_core::*;
+use tox::toxcore::dht::packet::CryptoData;
 use tox::toxcore::tcp::connection_id::ConnectionId;
 use tox::toxcore::tcp::packet::*;
 use tox::toxcore::tcp::handshake::make_client_handshake;
@@ -196,9 +197,15 @@ fn main() {
                                 185, 111, 33, 146, 221, 31, 77, 118]);
 
         let request = if i == 1 {
-            tx.send(Packet::RouteRequest(RouteRequest {pk: friend_pk } ))
+            tx.send(Packet::RouteRequest(RouteRequest { pk: friend_pk } ))
         } else {
-            tx.send(Packet::Data(Data { connection_id: ConnectionId::from_index(0), data: vec![42; 42] } ))
+            tx.send(Packet::Data(Data {
+                connection_id: ConnectionId::from_index(0),
+                data: DataPayload::CryptoData(CryptoData {
+                    nonce_last_bytes: 42,
+                    payload: vec![42; 123],
+                }),
+            }))
         };
 
         request

src/toxcore/tcp/client/client.rs

@@ -35,7 +35,7 @@ const CLIENT_CHANNEL_SIZE: usize = 2;
 #[derive(Debug, PartialEq, Clone)]
 pub enum IncomingPacket {
     /// Data packet with sender's `PublicKey`.
-    Data(PublicKey, Vec<u8>),
+    Data(PublicKey, DataPayload),
     /// Oob packet with sender's `PublicKey`.
     Oob(PublicKey, Vec<u8>),
     /// Onion response packet.
@@ -370,7 +370,7 @@ impl Client {
     }
 
     /// Send `Data` packet to a node via relay.
-    pub fn send_data(&self, destination_pk: PublicKey, data: Vec<u8>) -> impl Future<Item = (), Error = Error> + Send {
+    pub fn send_data(&self, destination_pk: PublicKey, data: DataPayload) -> impl Future<Item = (), Error = Error> + Send {
         // it is important that the result future succeeds only if packet is
         // sent since we take only one successful future from several relays
         // when send data packet
@@ -529,6 +529,7 @@ pub mod tests {
     use tokio::net::TcpListener;
     use tokio::timer::Interval;
 
+    use crate::toxcore::dht::packet::CryptoData;
     use crate::toxcore::ip_port::*;
     use crate::toxcore::onion::packet::*;
     use crate::toxcore::tcp::server::{Server, ServerExt};
@@ -797,7 +798,10 @@ pub mod tests {
         client.links.write().insert_by_id(&sender_pk, index);
         client.links.write().upgrade(index);
 
-        let data = vec![42; 123];
+        let data = DataPayload::CryptoData(CryptoData {
+            nonce_last_bytes: 42,
+            payload: vec![42; 123],
+        });
         let data_packet = Packet::Data(Data {
             connection_id: ConnectionId::from_index(index),
             data: data.clone(),
@@ -819,7 +823,10 @@ pub mod tests {
 
         let data_packet = Packet::Data(Data {
             connection_id: ConnectionId::from_index(42),
-            data: vec![42; 123],
+            data: DataPayload::CryptoData(CryptoData {
+                nonce_last_bytes: 42,
+                payload: vec![42; 123],
+            }),
         });
 
         assert!(client.handle_packet(data_packet).wait().is_err());
@@ -836,7 +843,10 @@ pub mod tests {
 
         let data_packet = Packet::Data(Data {
             connection_id: ConnectionId::zero(),
-            data: vec![42; 123],
+            data: DataPayload::CryptoData(CryptoData {
+                nonce_last_bytes: 42,
+                payload: vec![42; 123],
+            }),
         });
 
         assert!(client.handle_packet(data_packet).wait().is_err());
@@ -892,7 +902,10 @@ pub mod tests {
         let (_incoming_rx, outgoing_rx, client) = create_client();
 
         let (destination_pk, _destination_sk) = gen_keypair();
-        let data = vec![42; 123];
+        let data = DataPayload::CryptoData(CryptoData {
+            nonce_last_bytes: 42,
+            payload: vec![42; 123],
+        });
 
         let index = 42;
         client.links.write().insert_by_id(&destination_pk, index);
@@ -911,7 +924,10 @@ pub mod tests {
         let (_incoming_rx, outgoing_rx, client) = create_client();
 
         let (destination_pk, _destination_sk) = gen_keypair();
-        let data = vec![42; 123];
+        let data = DataPayload::CryptoData(CryptoData {
+            nonce_last_bytes: 42,
+            payload: vec![42; 123],
+        });
 
         assert!(client.send_data(destination_pk, data.clone()).wait().is_err());
 
@@ -926,7 +942,10 @@ pub mod tests {
         let (_incoming_rx, outgoing_rx, client) = create_client();
 
         let (destination_pk, _destination_sk) = gen_keypair();
-        let data = vec![42; 123];
+        let data = DataPayload::CryptoData(CryptoData {
+            nonce_last_bytes: 42,
+            payload: vec![42; 123],
+        });
 
         let connection_id = 42;
         client.links.write().insert_by_id(&destination_pk, connection_id - 16);
@@ -1185,8 +1204,14 @@ pub mod tests {
             client_1_c.add_connection(client_pk_2)
         });
 
-        let data_1 = vec![42; 123];
-        let data_2 = vec![43; 123];
+        let data_1 = DataPayload::CryptoData(CryptoData {
+            nonce_last_bytes: 42,
+            payload: vec![42; 123],
+        });
+        let data_2 = DataPayload::CryptoData(CryptoData {
+            nonce_last_bytes: 42,
+            payload: vec![43; 123],
+        });
 
         // wait until links become online
         let client_1_c = client_1.clone();

src/toxcore/tcp/client/connections.rs

@@ -207,7 +207,7 @@ impl Connections {
     }
 
     /// Send `Data` packet to a node via one of the relays.
-    pub fn send_data(&self, node_pk: PublicKey, data: Vec<u8>) -> impl Future<Item = (), Error = Error> + Send {
+    pub fn send_data(&self, node_pk: PublicKey, data: DataPayload) -> impl Future<Item = (), Error = Error> + Send {
         let connections = self.connections.read();
         if let Some(connection) = connections.get(&node_pk) {
             let clients = self.clients.read();
@@ -386,6 +386,7 @@ mod tests {
     use tokio_executor;
     use tokio_timer::clock::*;
 
+    use crate::toxcore::dht::packet::CryptoData;
     use crate::toxcore::ip_port::*;
     use crate::toxcore::tcp::client::client::tests::*;
     use crate::toxcore::tcp::connection_id::ConnectionId;
@@ -625,7 +626,10 @@ mod tests {
         connections.clients.write().insert(relay_1.pk, relay_1);
         connections.clients.write().insert(relay_2.pk, relay_2);
 
-        let data = vec![42; 123];
+        let data = DataPayload::CryptoData(CryptoData {
+            nonce_last_bytes: 42,
+            payload: vec![42; 123],
+        });
 
         connections.send_data(destination_pk, data.clone()).wait().unwrap();
 
@@ -649,7 +653,11 @@ mod tests {
 
         let (destination_pk, _destination_sk) = gen_keypair();
 
-        connections.send_data(destination_pk, vec![42; 123]).wait().unwrap();
+        let data = DataPayload::CryptoData(CryptoData {
+            nonce_last_bytes: 42,
+            payload: vec![42; 123],
+        });
+        connections.send_data(destination_pk, data).wait().unwrap();
     }
 
     #[test]

src/toxcore/tcp/codec.rs

@@ -176,6 +176,7 @@ impl Encoder for Codec {
 #[cfg(test)]
 mod tests {
     use crate::toxcore::crypto_core::*;
+    use crate::toxcore::dht::packet::CryptoData;
     use crate::toxcore::onion::packet::*;
     use crate::toxcore::ip_port::*;
     use crate::toxcore::tcp::codec::*;
@@ -304,7 +305,13 @@ mod tests {
                     payload: vec![42; 123]
                 })
             } ),
-            Packet::Data( Data { connection_id: ConnectionId::from_index(42), data: vec![13; 2031] } )
+            Packet::Data( Data {
+                connection_id: ConnectionId::from_index(42),
+                data: DataPayload::CryptoData(CryptoData {
+                    nonce_last_bytes: 42,
+                    payload: vec![42; 123],
+                }),
+            } )
         ];
         for packet in test_packets {
             alice_codec.encode(packet.clone(), &mut buf).expect("Alice should encode");
@@ -408,7 +415,13 @@ mod tests {
         let mut buf = BytesMut::new();
         let stats = Stats::new();
         let mut alice_codec = Codec::new(alice_channel, stats);
-        let packet = Packet::Data( Data { connection_id: ConnectionId::from_index(42), data: vec![13; 2032] } );
+        let packet = Packet::Data( Data {
+            connection_id: ConnectionId::from_index(42),
+            data: DataPayload::CryptoData(CryptoData {
+                nonce_last_bytes: 42,
+                payload: vec![42; 2030],
+            })
+        } );
 
         // Alice cannot serialize Packet because it is too long
         assert!(alice_codec.encode(packet, &mut buf).is_err());

src/toxcore/tcp/packet/data.rs

@@ -2,10 +2,9 @@
 */
 
 use crate::toxcore::binary_io::*;
+use crate::toxcore::dht::packet::{CookieRequest, CookieResponse, CryptoHandshake, CryptoData};
 use crate::toxcore::tcp::connection_id::ConnectionId;
 
-use nom::rest;
-
 /** Sent by client to server.
 The client sends data with `connection_id` and the server
 relays it to the given connection
@@ -22,27 +21,60 @@ variable | Data
 pub struct Data {
     /// The id of the connection of the client
     pub connection_id: ConnectionId,
-    /// Data packet
-    pub data: Vec<u8>
+    /// Data payload
+    pub data: DataPayload,
 }
 
 impl FromBytes for Data {
     named!(from_bytes<Data>, do_parse!(
         connection_id: call!(ConnectionId::from_bytes) >>
-        data: rest >>
-        (Data { connection_id, data: data.to_vec() })
+        data: call!(DataPayload::from_bytes) >>
+        (Data { connection_id, data })
     ));
 }
 
 impl ToBytes for Data {
     fn to_bytes<'a>(&self, buf: (&'a mut [u8], usize)) -> Result<(&'a mut [u8], usize), GenError> {
         do_gen!(buf,
             gen_call!(|buf, connection_id| ConnectionId::to_bytes(connection_id, buf), &self.connection_id) >>
-            gen_slice!(self.data)
+            gen_call!(|buf, packet| DataPayload::to_bytes(packet, buf), &self.data)
         )
     }
 }
 
+/// Data payload enum.
+#[derive(Debug, PartialEq, Clone)]
+pub enum DataPayload {
+    /// [`CookieRequest`](../../dht/packet/struct.CookieRequest.html) structure.
+    CookieRequest(CookieRequest),
+    /// [`CookieResponse`](../../dht/packet/struct.CookieResponse.html) structure.
+    CookieResponse(CookieResponse),
+    /// [`CryptoHandshake`](../../dht/packet/struct.CryptoHandshake.html) structure.
+    CryptoHandshake(CryptoHandshake),
+    /// [`CryptoData`](../../dht/packet/struct.CryptoData.html) structure.
+    CryptoData(CryptoData),
+}
+
+impl ToBytes for DataPayload {
+    fn to_bytes<'a>(&self, buf: (&'a mut [u8], usize)) -> Result<(&'a mut [u8], usize), GenError> {
+        match *self {
+            DataPayload::CookieRequest(ref p) => p.to_bytes(buf),
+            DataPayload::CookieResponse(ref p) => p.to_bytes(buf),
+            DataPayload::CryptoHandshake(ref p) => p.to_bytes(buf),
+            DataPayload::CryptoData(ref p) => p.to_bytes(buf),
+        }
+    }
+}
+
+impl FromBytes for DataPayload {
+    named!(from_bytes<DataPayload>, alt!(
+        map!(CookieRequest::from_bytes, DataPayload::CookieRequest) |
+        map!(CookieResponse::from_bytes, DataPayload::CookieResponse) |
+        map!(CryptoHandshake::from_bytes, DataPayload::CryptoHandshake) |
+        map!(CryptoData::from_bytes, DataPayload::CryptoData)
+    ));
+}
+
 #[cfg(test)]
 mod test {
     use super::*;
@@ -51,7 +83,10 @@ mod test {
         data_encode_decode,
         Data {
             connection_id: ConnectionId::from_index(1),
-            data: vec![42; 123]
+            data: DataPayload::CryptoData(CryptoData {
+                nonce_last_bytes: 42,
+                payload: vec![42; 123],
+            }),
         }
     );
 }

src/toxcore/tcp/packet/mod.rs

@@ -24,7 +24,7 @@ pub use self::oob_send::OobSend;
 pub use self::oob_receive::OobReceive;
 pub use self::onion_request::OnionRequest;
 pub use self::onion_response::OnionResponse;
-pub use self::data::Data;
+pub use self::data::{Data, DataPayload};
 
 use crate::toxcore::binary_io::*;
 

src/toxcore/tcp/server/client.rs

@@ -184,7 +184,7 @@ impl Client {
     }
     /** Construct Data and send it to Client
     */
-    pub fn send_data(&self, connection_id: ConnectionId, data: Vec<u8>) -> impl Future<Item = (), Error = Error> + Send {
+    pub fn send_data(&self, connection_id: ConnectionId, data: DataPayload) -> impl Future<Item = (), Error = Error> + Send {
         self.send(
             Packet::Data(Data { connection_id, data })
         )