chiark / gitweb /
make route_packet async
[hippotat.git] / src / slip.rs
index ab9005455b10ceb030972a3868827a71e0aad4b0..f5980cc3b72f5d559f8170fc7bd50cce503ea57a 100644 (file)
@@ -1,5 +1,5 @@
 // Copyright 2021 Ian Jackson and contributors to Hippotat
-// SPDX-License-Identifier: AGPL-3.0-or-later
+// SPDX-License-Identifier: GPL-3.0-or-later
 // There is NO WARRANTY.
 
 use crate::prelude::*;
@@ -13,7 +13,7 @@ pub enum PacketError {
   #[error("Invalid SLIP escape sequence")] SLIP,
   #[error("unexpected src addr {0:?}")]    Src(IpAddr),
   #[error("unexpected dst addr {0:?}")]    Dst(IpAddr),
-  #[error("bad, IPv{vsn}, len={len}")]     Bad { len: usize, vsn: u8 },
+  #[error("truncated, IPv{vsn}, len={len}")] Truncated { len: usize, vsn: u8 },
 }
 
 pub trait SlipMime { const CONV_TO: Option<bool>; }
@@ -24,73 +24,112 @@ impl SlipMime for Slip2Mime { const CONV_TO: Option<bool> = Some(true); }
 impl SlipMime for Mime2Slip { const CONV_TO: Option<bool> = Some(false); }
 impl SlipMime for SlipNoConv { const CONV_TO: Option<bool> = None; }
 
-pub fn check<AC, EH, OUT, M: SlipMime>(
+#[derive(Debug,Error)]
+pub enum SlipFramesError<E> where E: std::error::Error + 'static {
+  #[error("only bad IP datagrams")] ErrorOnlyBad,
+  #[error("{0}")] Other(#[from] E),
+}
+  
+#[throws(SlipFramesError<EHE>)]
+pub async fn checkn<AC, EH, EHE, OUT, FOUT, ACR, M: SlipMime+Copy>(
+  mime: M,
   mtu: u32,
   data: &[u8],
-  out: &mut OUT,
-  mut addr_chk: AC,
+  addr_chk: AC,
+  mut out: OUT,
   mut error_handler: EH
-) where OUT: Extend<Box<[u8]>>,
-        AC: FnMut(&[u8]) -> Result<(), PacketError>,
-        EH: FnMut(PacketError),
+) where AC: Fn(&[u8]) -> Result<ACR, PacketError> + Copy + Send,
+        OUT: FnMut((Box<[u8]>, ACR)) -> FOUT + Send,
+        FOUT: Future<Output=Result<(), PacketError>> + Send,
+        EH: FnMut(PacketError) -> Result<(), SlipFramesError<EHE>> + Send,
+        EHE: std::error::Error + Send + 'static,
 {
-//  eprintln!("before: {:?}", DumpHex(data));
+  //  eprintln!("before: {:?}", DumpHex(data));
+  if data.is_empty() { return }
+  let mut ok = false;
+  let mut err = false;
   for packet in data.split(|&c| c == SLIP_END) {
-    match (||{
-      if packet.len() == 0 {
-        throw!(PacketError::Empty)
-      }
-      if packet.len() > mtu.sat() {
-        throw!(PacketError::MTU { len: packet.len(), mtu });
-      }
-
-      let mut packet: Box<[u8]> = packet.to_owned().into();
-      let mut walk: &mut [u8] = &mut packet;
-      let mut header = [0u8; HEADER_FOR_ADDR];
-      let mut wheader = &mut header[..];
-
-      while let Some((i, was_mime)) = walk.iter().enumerate().find_map(
-        |(i,&c)| match c {
-          SLIP_ESC                               => Some((i,false)),
-          SLIP_MIME_ESC if M::CONV_TO.is_some()  => Some((i,true)),
-          _ => None,
-        }
-      ) {
-        let _ = wheader.write(&walk[0..i]);
-        if M::CONV_TO.is_some() {
-          walk[i] = if was_mime { SLIP_ESC } else { SLIP_MIME_ESC };
-        }
-        if Some(was_mime) != M::CONV_TO {
-          let c = match walk.get(i+1) {
-            Some(&SLIP_ESC_ESC) => SLIP_ESC,
-            Some(&SLIP_ESC_END) => SLIP_END,
-            _ => throw!(PacketError::SLIP),
-          };
-          let _ = wheader.write(&[c]);
-          walk = &mut walk[i+2 ..];
-        } else {
-          let _ = wheader.write(&[SLIP_MIME_ESC]);
-          walk = &mut walk[i+1 ..];
-        }
-      }
-      let _ = wheader.write(walk);
-
-      addr_chk(&header)?;
-
-      Ok(packet)
-    })() {
-      Err(e) => error_handler(e),
-      Ok(packet) => out.extend(iter::once(packet)),
+    match async {
+      let checked = check1(mime, mtu, packet, addr_chk);
+      if matches!(checked, Err(PacketError::Empty)) { return Ok::<_,PE>(()) }
+      out(checked?).await?;
+      ok = true;
+      Ok::<_,PE>(())
+    }.await {
+      Ok(()) => { },
+      Err(e) => { err=true; error_handler(e)?; },
     }
   }
 //  eprintln!(" after: {:?}", DumpHex(data));
+  if err && !ok { throw!(SlipFramesError::ErrorOnlyBad) }
+}
+
+#[throws(PacketError)]
+pub fn check1<AC, M: SlipMime, ACR>(
+  _mime: M,
+  mtu: u32,
+  packet: &[u8],
+  addr_chk: AC,
+) -> (Box<[u8]>, ACR)
+where AC: Fn(&[u8]) -> Result<ACR, PacketError>,
+{
+  if packet.len() == 0 {
+    throw!(PacketError::Empty)
+  }
+
+  let mut packet: Box<[u8]> = packet.to_owned().into();
+  let mut walk: &mut [u8] = &mut packet;
+  let mut header = [0u8; HEADER_FOR_ADDR];
+  let mut wheader = &mut header[..];
+  let mut escapes = 0;
+
+  while let Some((i, was_mime)) = walk.iter().enumerate().find_map(
+    |(i,&c)| match c {
+      SLIP_ESC                               => Some((i,false)),
+      SLIP_MIME_ESC if M::CONV_TO.is_some()  => Some((i,true)),
+      _ => None,
+    }
+  ) {
+    let _ = wheader.write(&walk[0..i]);
+    if M::CONV_TO.is_some() {
+      walk[i] = if was_mime { SLIP_ESC } else { SLIP_MIME_ESC };
+    }
+    if Some(was_mime) != M::CONV_TO {
+      let c = match walk.get(i+1) {
+        Some(&SLIP_ESC_ESC) => SLIP_ESC,
+        Some(&SLIP_ESC_END) => SLIP_END,
+        _ => throw!(PacketError::SLIP),
+      };
+      let _ = wheader.write(&[c]);
+      walk = &mut walk[i+2 ..];
+      escapes += 1;
+    } else {
+      let _ = wheader.write(&[SLIP_MIME_ESC]);
+      walk = &mut walk[i+1 ..];
+    }
+  }
+  let _ = wheader.write(walk);
+  let wheader_len = wheader.len();
+  let header = &header[0.. header.len() - wheader_len];
+
+  let decoded_len = packet.len() - escapes;
+  if decoded_len > mtu.sat() {
+    throw!(PacketError::MTU { len: decoded_len, mtu });
+  }
+
+  let acr = addr_chk(&header)?;
+
+  (packet, acr)
 }
 
 pub type Frame = Vec<u8>;
 pub type FramesData = Vec<Vec<u8>>;
-//pub type Frame = Box<[u8]>;
-//pub type FramesData = Vec<Frame>;
-//  `From<Box<[u8]>>` is not implemented for `Bytes`
+// todo: https://github.com/tokio-rs/bytes/pull/504
+//   pub type Frame = Box<[u8]>;
+//   pub type FramesData = Vec<Frame>;
+//       `From<Box<[u8]>>` is not implemented for `Bytes`
+// when this is fixed, there are two `into`s in client.rs which 
+// become redundant (search for todo:504)
 
 
 #[derive(Default)]
@@ -141,7 +180,7 @@ pub fn ip_packet_addr<const DST: bool>(packet: &[u8]) -> IpAddr {
       Ipv6Addr::from(*<&[u8;16]>::try_from(slice).unwrap()).into()
     },
 
-    _ => throw!(PE::Bad{ vsn, len: packet.len() }),
+    _ => throw!(PE::Truncated{ vsn, len: packet.len() }),
   }
 }
 
@@ -151,6 +190,12 @@ impl Debug for DumpHex<'_> {
   #[throws(fmt::Error)]
   fn fmt(&self, f: &mut fmt::Formatter) {
     for v in self.0 { write!(f, "{:02x}", v)?; }
+    match str::from_utf8(self.0) {
+      Ok(s) => write!(f, "={:?}", s)?,
+      Err(x) => write!(f, "={:?}..",
+                       str::from_utf8(&self.0[0..x.valid_up_to()]).unwrap()
+      )?,
+    }
   }
 }