Merge pull request #453 from tox-rs/refactor

refactor(binary_io): implement ToBytes/FromBytes for arrays

Author: kurnevsky

.github/workflows/rust.yml

@@ -14,7 +14,7 @@ jobs:
         os: [ubuntu-latest, macos-latest, windows-latest]
         rust:
           - stable
-          - 1.48.0
+          - 1.51.0
     steps:
     - uses: actions/checkout@v2
     - uses: actions-rs/toolchain@v1

README.md

@@ -30,7 +30,7 @@ issue / pull request should be filled on the reference repository.
 [CONTRIBUTING.md](/CONTRIBUTING.md).
 
 ## Building
-Fairly simple. First, install [Rust] >= 1.48.0 and a C compiler ([Build Tools
+Fairly simple. First, install [Rust] >= 1.51.0 and a C compiler ([Build Tools
 for Visual Studio][VSBuild] on Windows, GCC or Clang on other platforms).
 
 Then you can build the debug version with

tox_binary_io/src/lib.rs

@@ -2,14 +2,14 @@ pub use nom::IResult;
 pub use cookie_factory::GenError;
 
 use nom::number::streaming::{le_u8, le_u16};
-use nom::{named, map, count};
-use cookie_factory::{do_gen, gen_be_u8, gen_le_u16};
+use nom::{named, map, map_opt, take, count};
+use cookie_factory::{do_gen, gen_be_u8, gen_le_u16, gen_slice};
 
-use std::net::{
+use std::{convert::TryInto, net::{
     IpAddr,
     Ipv4Addr,
     Ipv6Addr,
-};
+}};
 
 #[cfg(feature = "sodiumoxide")]
 pub use sodium::*;
@@ -43,6 +43,16 @@ impl FromBytes for Ipv4Addr {
     ));
 }
 
+impl<const N: usize> ToBytes for [u8; N] {
+    fn to_bytes<'a>(&self, buf: (&'a mut [u8], usize)) -> Result<(&'a mut [u8], usize), GenError> {
+        gen_slice!(buf, &self[..])
+    }
+}
+
+impl <const N: usize> FromBytes for [u8; N] {
+    named!(from_bytes<[u8; N]>, map_opt!(take!(N), |bytes: &[u8]| bytes.try_into().ok()));
+}
+
 impl ToBytes for Ipv4Addr {
     fn to_bytes<'a>(&self, buf: (&'a mut [u8], usize)) -> Result<(&'a mut [u8], usize), GenError> {
         let o = self.octets();

tox_core/src/onion/client/mod.rs

@@ -27,7 +27,7 @@ use tox_packet::ip_port::*;
 use crate::onion::client::errors::*;
 use crate::onion::client::onion_path::*;
 use crate::onion::client::paths_pool::*;
-use crate::onion::onion_announce::{PingId, INITIAL_PING_ID};
+use crate::onion::onion_announce::INITIAL_PING_ID;
 use tox_packet::onion::*;
 use tox_packet::packed_node::*;
 use crate::relay::client::Connections as TcpConnections;

tox_core/src/onion/onion_announce.rs

@@ -14,9 +14,6 @@ use crate::time::*;
 use tox_packet::onion::*;
 use crate::dht::kbucket::Distance;
 
-/// The type of onion ping ID which is SHA256 hash.
-pub type PingId = [u8; <Sha256 as Digest>::OutputSize::USIZE];
-
 /// Number of secret random bytes to make onion ping id unique for each node.
 pub const SECRET_BYTES_SIZE: usize = 32;
 

tox_packet/src/dht/cookie.rs

@@ -2,7 +2,7 @@
 */
 
 use super::*;
-use nom::{AsBytes, map_opt, number::complete::be_u64};
+use nom::number::complete::be_u64;
 use sha2::{Digest, Sha512};
 use sha2::digest::generic_array::typenum::marker_traits::Unsigned;
 use xsalsa20poly1305::{XSalsa20Poly1305, aead::{Aead, Error as AeadError}};
@@ -114,7 +114,7 @@ pub struct EncryptedCookie {
 
 impl FromBytes for EncryptedCookie {
     named!(from_bytes<EncryptedCookie>, do_parse!(
-        nonce: map_opt!(take!(xsalsa20poly1305::NONCE_SIZE), |bytes: &[u8]| bytes.try_into().ok()) >>
+        nonce: call!(<[u8; xsalsa20poly1305::NONCE_SIZE]>::from_bytes) >>
         payload: take!(88) >>
         (EncryptedCookie { nonce, payload: payload.to_vec() })
     ));
@@ -150,7 +150,7 @@ impl EncryptedCookie {
     - fails to parse `Cookie`
     */
     pub fn get_payload(&self, symmetric_key: &XSalsa20Poly1305) -> Result<Cookie, GetPayloadError> {
-        let decrypted = symmetric_key.decrypt(&self.nonce.into(), self.payload.as_bytes())
+        let decrypted = symmetric_key.decrypt(&self.nonce.into(), self.payload.as_slice())
             .map_err(|AeadError| {
                 GetPayloadError::decrypt()
             })?;

tox_packet/src/dht/crypto_handshake.rs

@@ -3,8 +3,6 @@
 
 use super::*;
 
-use std::convert::TryInto;
-use nom::map_opt;
 use sha2::{Digest, Sha512};
 use sha2::digest::generic_array::typenum::marker_traits::Unsigned;
 use tox_binary_io::*;
@@ -141,7 +139,7 @@ impl FromBytes for CryptoHandshakePayload {
     named!(from_bytes<CryptoHandshakePayload>, do_parse!(
         base_nonce: call!(Nonce::from_bytes) >>
         session_pk: call!(PublicKey::from_bytes) >>
-        cookie_hash: map_opt!(take!(<Sha512 as Digest>::OutputSize::USIZE), |bytes: &[u8]| bytes.try_into().ok()) >>
+        cookie_hash: call!(<[u8; <Sha512 as Digest>::OutputSize::USIZE]>::from_bytes) >>
         cookie: call!(EncryptedCookie::from_bytes) >>
         eof!() >>
         (CryptoHandshakePayload {

tox_packet/src/onion/mod.rs

@@ -29,15 +29,14 @@ pub use self::onion_response_2::*;
 pub use self::onion_response_3::*;
 pub use self::friend_request::*;
 
-use std::convert::TryInto;
 use tox_binary_io::*;
 use tox_crypto::*;
 use xsalsa20poly1305::{XSalsa20Poly1305, aead::{Aead, Error as AeadError}};
 use crate::dht::packed_node::PackedNode;
 use crate::ip_port::*;
 
 use rand::{Rng, thread_rng};
-use nom::{AsBytes, alt, call, cond, do_parse, eof, flat_map, map, map_opt, map_res, named, switch, tag, take, value, verify};
+use nom::{alt, call, cond, do_parse, eof, flat_map, map, map_res, named, switch, tag, take, value, verify};
 
 use cookie_factory::{
     do_gen,
@@ -107,7 +106,7 @@ pub struct OnionReturn {
 
 impl FromBytes for OnionReturn {
     named!(from_bytes<OnionReturn>, do_parse!(
-        nonce: map_opt!(take!(xsalsa20poly1305::NONCE_SIZE), |bytes: &[u8]| bytes.try_into().ok()) >>
+        nonce: call!(<[u8; xsalsa20poly1305::NONCE_SIZE]>::from_bytes) >>
         payload: rest >>
         (OnionReturn { nonce, payload: payload.to_vec() })
     ));
@@ -162,7 +161,7 @@ impl OnionReturn {
     - fails to parse as `IpPort` with possibly inner `OnionReturn`
     */
     pub fn get_payload(&self, symmetric_key: &XSalsa20Poly1305) -> Result<(IpPort, Option<OnionReturn>), Error> {
-        let decrypted = symmetric_key.decrypt(&self.nonce.into(), self.payload.as_bytes())
+        let decrypted = symmetric_key.decrypt(&self.nonce.into(), self.payload.as_slice())
             .map_err(|AeadError| {
                 Error::new(ErrorKind::Other, "OnionReturn decrypt error.")
             })?;

tox_packet/src/onion/onion_announce_request.rs

@@ -3,18 +3,21 @@
 
 use super::*;
 
-use std::convert::TryInto;
 use tox_binary_io::*;
 use tox_crypto::*;
 use crate::dht::*;
 
 use nom::{
     flat_map,
-    map_opt,
     number::complete::le_u64,
     combinator::{rest, rest_len},
     bytes::complete::take
 };
+use sha2::{Digest, Sha256};
+use sha2::digest::generic_array::typenum::marker_traits::Unsigned;
+
+/// The type of onion ping ID which is SHA256 hash.
+pub type PingId = [u8; <Sha256 as Digest>::OutputSize::USIZE];
 
 /** It's used for announcing ourselves to onion node and for looking for other
 announced nodes.
@@ -172,7 +175,7 @@ Length   | Content
 #[derive(Clone, Debug, Eq, PartialEq)]
 pub struct OnionAnnounceRequestPayload {
     /// Onion ping id
-    pub ping_id: [u8; 32],
+    pub ping_id: PingId,
     /// `PublicKey` we are searching for
     pub search_pk: PublicKey,
     /// `PublicKey` that should be used for sending data packets
@@ -183,7 +186,7 @@ pub struct OnionAnnounceRequestPayload {
 
 impl FromBytes for OnionAnnounceRequestPayload {
     named!(from_bytes<OnionAnnounceRequestPayload>, do_parse!(
-        ping_id: map_opt!(take!(32), |bytes: &[u8]| bytes.try_into().ok()) >>
+        ping_id: call!(PingId::from_bytes) >>
         search_pk: call!(PublicKey::from_bytes) >>
         data_pk: call!(PublicKey::from_bytes) >>
         sendback_data: le_u64 >>
@@ -239,7 +242,7 @@ mod tests {
         tox_crypto::crypto_init().unwrap(),
         onion_announce_request_payload_encode_decode,
         OnionAnnounceRequestPayload {
-            ping_id: [42; 32],
+            ping_id: [42; <Sha256 as Digest>::OutputSize::USIZE],
             search_pk: gen_keypair().0,
             data_pk: gen_keypair().0,
             sendback_data: 12345
@@ -253,7 +256,7 @@ mod tests {
         let (bob_pk, _bob_sk) = gen_keypair();
         let shared_secret = encrypt_precompute(&bob_pk, &alice_sk);
         let payload = OnionAnnounceRequestPayload {
-            ping_id: [42; 32],
+            ping_id: [42; <Sha256 as Digest>::OutputSize::USIZE],
             search_pk: gen_keypair().0,
             data_pk: gen_keypair().0,
             sendback_data: 12345
@@ -274,7 +277,7 @@ mod tests {
         let (_eve_pk, eve_sk) = gen_keypair();
         let shared_secret = encrypt_precompute(&bob_pk, &alice_sk);
         let payload = OnionAnnounceRequestPayload {
-            ping_id: [42; 32],
+            ping_id: [42; <Sha256 as Digest>::OutputSize::USIZE],
             search_pk: gen_keypair().0,
             data_pk: gen_keypair().0,
             sendback_data: 12345

tox_packet/src/onion/onion_announce_response.rs

@@ -7,10 +7,8 @@ use tox_binary_io::*;
 use tox_crypto::*;
 use crate::dht::*;
 
-use std::convert::TryInto;
 use nom::{
     many0,
-    map_opt,
     number::complete::le_u64,
     combinator::{rest, rest_len},
 };
@@ -140,7 +138,7 @@ pub struct OnionAnnounceResponsePayload {
 impl FromBytes for OnionAnnounceResponsePayload {
     named!(from_bytes<OnionAnnounceResponsePayload>, do_parse!(
         announce_status: call!(AnnounceStatus::from_bytes) >>
-        ping_id_or_pk: map_opt!(take!(32), |bytes: &[u8]| bytes.try_into().ok()) >>
+        ping_id_or_pk: call!(<[u8; 32]>::from_bytes) >>
         nodes: many0!(PackedNode::from_bytes) >>
         _len: verify!(value!(nodes.len()), |len| *len <= 4_usize) >>
         eof!() >>