src/slip.rs

   1 // Copyright 2021 Ian Jackson and contributors to Hippotat
   2 // SPDX-License-Identifier: GPL-3.0-or-later
   3 // There is NO WARRANTY.
   4
   5 use crate::prelude::*;
   6
   7 pub static SLIP_END_SLICE: &[u8] = &[SLIP_END];
   8
   9 #[derive(Error,Debug,Copy,Clone,Eq,PartialEq)]
  10 pub enum PacketError {
  11   #[error("empty packet")]                 Empty,
  12   #[error("MTU exceeded ({len} > {mtu})")] MTU { len: usize, mtu: u32 },
  13   #[error("Invalid SLIP escape sequence")] SLIP,
  14   #[error("unexpected src addr {0:?}")]    Src(IpAddr),
  15   #[error("unexpected dst addr {0:?}")]    Dst(IpAddr),
  16   #[error("bad, IPv{vsn}, len={len}")]     Bad { len: usize, vsn: u8 },
  17 }
  18
  19 pub trait SlipMime { const CONV_TO: Option<bool>; }
  20 #[derive(Copy,Clone,Debug)] pub struct Slip2Mime;
  21 #[derive(Copy,Clone,Debug)] pub struct Mime2Slip;
  22 #[derive(Copy,Clone,Debug)] pub struct SlipNoConv;
  23 impl SlipMime for Slip2Mime { const CONV_TO: Option<bool> = Some(true); }
  24 impl SlipMime for Mime2Slip { const CONV_TO: Option<bool> = Some(false); }
  25 impl SlipMime for SlipNoConv { const CONV_TO: Option<bool> = None; }
  26
  27 pub fn checkn<AC, EH, OUT, M: SlipMime+Copy>(
  28   mime: M,
  29   mtu: u32,
  30   data: &[u8],
  31   out: &mut OUT,
  32   addr_chk: AC,
  33   mut error_handler: EH
  34 ) where OUT: Extend<Box<[u8]>>,
  35         AC: Fn(&[u8]) -> Result<(), PacketError> + Copy,
  36         EH: FnMut(PacketError),
  37 {
  38   //  eprintln!("before: {:?}", DumpHex(data));
  39   if data.is_empty() { return }
  40   for packet in data.split(|&c| c == SLIP_END) {
  41     match check1(mime, mtu, packet, addr_chk) {
  42       Err(e) => error_handler(e),
  43       Ok(packet) => out.extend(iter::once(packet)),
  44     }
  45   }
  46 //  eprintln!(" after: {:?}", DumpHex(data));
  47 }
  48
  49 #[throws(PacketError)]
  50 pub fn check1<AC, M: SlipMime>(
  51   _mime: M,
  52   mtu: u32,
  53   packet: &[u8],
  54   addr_chk: AC,
  55 ) -> Box<[u8]>
  56 where AC: Fn(&[u8]) -> Result<(), PacketError>,
  57 {
  58   if packet.len() == 0 {
  59     throw!(PacketError::Empty)
  60   }
  61   if packet.len() > mtu.sat() {
  62     throw!(PacketError::MTU { len: packet.len(), mtu });
  63   }
  64
  65   let mut packet: Box<[u8]> = packet.to_owned().into();
  66   let mut walk: &mut [u8] = &mut packet;
  67   let mut header = [0u8; HEADER_FOR_ADDR];
  68   let mut wheader = &mut header[..];
  69
  70   while let Some((i, was_mime)) = walk.iter().enumerate().find_map(
  71     |(i,&c)| match c {
  72       SLIP_ESC                               => Some((i,false)),
  73       SLIP_MIME_ESC if M::CONV_TO.is_some()  => Some((i,true)),
  74       _ => None,
  75     }
  76   ) {
  77     let _ = wheader.write(&walk[0..i]);
  78     if M::CONV_TO.is_some() {
  79       walk[i] = if was_mime { SLIP_ESC } else { SLIP_MIME_ESC };
  80     }
  81     if Some(was_mime) != M::CONV_TO {
  82       let c = match walk.get(i+1) {
  83         Some(&SLIP_ESC_ESC) => SLIP_ESC,
  84         Some(&SLIP_ESC_END) => SLIP_END,
  85         _ => throw!(PacketError::SLIP),
  86       };
  87       let _ = wheader.write(&[c]);
  88       walk = &mut walk[i+2 ..];
  89     } else {
  90       let _ = wheader.write(&[SLIP_MIME_ESC]);
  91       walk = &mut walk[i+1 ..];
  92     }
  93   }
  94   let _ = wheader.write(walk);
  95
  96   addr_chk(&header)?;
  97
  98   packet
  99 }
 100
 101 pub type Frame = Vec<u8>;
 102 pub type FramesData = Vec<Vec<u8>>;
 103 // todo: https://github.com/tokio-rs/bytes/pull/504
 104 //   pub type Frame = Box<[u8]>;
 105 //   pub type FramesData = Vec<Frame>;
 106 //       `From<Box<[u8]>>` is not implemented for `Bytes`
 107 // when this is fixed, there are two `into`s in client.rs which
 108 // become redundant (search for todo:504)
 109
 110
 111 #[derive(Default)]
 112 pub struct Frames {
 113   frames: FramesData,
 114   total_len: usize,
 115   tried_full: bool,
 116 }
 117
 118 impl Debug for Frames {
 119   #[throws(fmt::Error)]
 120   fn fmt(&self, f: &mut fmt::Formatter) {
 121     write!(f, "Frames{{n={},len={}}}", &self.frames.len(), &self.total_len)?;
 122   }
 123 }
 124
 125 impl Frames {
 126   #[throws(Frame)]
 127   pub fn add(&mut self, max: u32, frame: Frame) {
 128     if frame.len() == 0 { return }
 129     let new_total = self.total_len + frame.len() + 1;
 130     if new_total > max.sat() { self.tried_full = true; throw!(frame); }
 131     self.total_len = new_total;
 132     self.frames.push(frame);
 133   }
 134
 135   #[inline] pub fn tried_full(&self) -> bool { self.tried_full }
 136   #[inline] pub fn is_empty(&self) -> bool { self.frames.is_empty() }
 137 }
 138
 139 impl From<Frames> for FramesData {
 140   fn from(frames: Frames) -> FramesData { frames.frames }
 141 }
 142
 143 const HEADER_FOR_ADDR: usize = 40;
 144
 145 #[throws(PacketError)]
 146 pub fn ip_packet_addr<const DST: bool>(packet: &[u8]) -> IpAddr {
 147   let vsn = (packet.get(0).ok_or_else(|| PE::Empty)? & 0xf0) >> 4;
 148   match vsn {
 149     4 if packet.len() >= 20 => {
 150       let slice = &packet[if DST { 16 } else { 12 }..][0..4];
 151       Ipv4Addr::from(*<&[u8;4]>::try_from(slice).unwrap()).into()
 152     },
 153
 154     6 if packet.len() >= 40 => {
 155       let slice = &packet[if DST { 24 } else { 8 }..][0..16];
 156       Ipv6Addr::from(*<&[u8;16]>::try_from(slice).unwrap()).into()
 157     },
 158
 159     _ => throw!(PE::Bad{ vsn, len: packet.len() }),
 160   }
 161 }
 162
 163 #[derive(Copy,Clone,Eq,PartialEq,Ord,PartialOrd,Hash)]
 164 pub struct DumpHex<'b>(pub &'b [u8]);
 165 impl Debug for DumpHex<'_> {
 166   #[throws(fmt::Error)]
 167   fn fmt(&self, f: &mut fmt::Formatter) {
 168     for v in self.0 { write!(f, "{:02x}", v)?; }
 169   }
 170 }
 171
 172 #[test]
 173 fn mime_slip_to_mime() {
 174   use PacketError as PE;
 175   const MTU: u32 = 10;
 176
 177   fn chk<M: SlipMime>(i: &[u8], exp_p: &[&[u8]], exp_e: &[PacketError]) {
 178     dbg!(M::CONV_TO, DumpHex(i));
 179     let mut got_e = vec![];
 180     let mut got_p = vec![];
 181     check::<_,_,_,M>(MTU, i, &mut got_p, |_|Ok(()), |e| got_e.push(e));
 182     assert_eq!( got_p.iter().map(|b| DumpHex(b)).collect_vec(),
 183                 exp_p.iter().map(|b| DumpHex(b)).collect_vec() );
 184     assert_eq!( got_e,
 185                 exp_e );
 186   }
 187
 188   chk::<Slip2Mime>
 189      ( &[ SLIP_END, SLIP_ESC, SLIP_ESC_END, b'-',     b'X' ],
 190     &[           &[ b'-',     SLIP_ESC_END, SLIP_ESC, b'X' ] ],
 191     &[ PE::Empty ]);
 192
 193   chk::<Slip2Mime>
 194      ( &[ SLIP_END, SLIP_ESC, b'y' ], &[],
 195     &[ PE::Empty,   PE::SLIP ]);
 196
 197   chk::<Slip2Mime>
 198      ( &[ SLIP_END, b'-',     b'y' ],
 199     &[           &[ SLIP_ESC, b'y' ] ],
 200     &[ PE::Empty ]);
 201
 202   chk::<Slip2Mime>
 203      ( &[b'x'; 20],
 204     &[             ],
 205     &[ PE::MTU { len: 20, mtu: MTU } ]);
 206
 207   chk::<SlipNoConv>
 208      ( &[ SLIP_END, SLIP_ESC, SLIP_ESC_END, b'-',     b'X' ],
 209     &[           &[ SLIP_ESC, SLIP_ESC_END, b'-',     b'X' ] ],
 210     &[ PE::Empty, ]);
 211 }
 212
 213