use core::fmt; use byteorder::{ByteOrder, NetworkEndian}; use Error; pub use super::EthernetProtocol as Protocol; enum_with_unknown! { /// ARP hardware type. pub enum Hardware(u16) { Ethernet = 1 } } enum_with_unknown! { /// ARP operation type. pub enum Operation(u16) { Request = 1, Reply = 2 } } /// A read/write wrapper around an Address Resolution Protocol packet buffer. #[derive(Debug)] pub struct Packet> { buffer: T } mod field { #![allow(non_snake_case)] use wire::field::*; pub const HTYPE: Field = 0..2; pub const PTYPE: Field = 2..4; pub const HLEN: usize = 4; pub const PLEN: usize = 5; pub const OPER: Field = 6..8; #[inline] pub fn SHA(hardware_len: u8, _protocol_len: u8) -> Field { let start = OPER.end; start..(start + hardware_len as usize) } #[inline] pub fn SPA(hardware_len: u8, protocol_len: u8) -> Field { let start = SHA(hardware_len, protocol_len).end; start..(start + protocol_len as usize) } #[inline] pub fn THA(hardware_len: u8, protocol_len: u8) -> Field { let start = SPA(hardware_len, protocol_len).end; start..(start + hardware_len as usize) } #[inline] pub fn TPA(hardware_len: u8, protocol_len: u8) -> Field { let start = THA(hardware_len, protocol_len).end; start..(start + protocol_len as usize) } } impl> Packet { /// Wrap a buffer with an ARP packet. Returns an error if the buffer /// is too small to contain one. pub fn new(buffer: T) -> Result, Error> { let len = buffer.as_ref().len(); if len < field::OPER.end { Err(Error::Truncated) } else { let packet = Packet { buffer: buffer }; if len < field::TPA(packet.hardware_len(), packet.protocol_len()).end { Err(Error::Truncated) } else { Ok(packet) } } } /// Consumes the packet, returning the underlying buffer. pub fn into_inner(self) -> T { self.buffer } /// Return the hardware type field. #[inline] pub fn hardware_type(&self) -> Hardware { let data = self.buffer.as_ref(); let raw = NetworkEndian::read_u16(&data[field::HTYPE]); Hardware::from(raw) } /// Return the protocol type field. #[inline] pub fn protocol_type(&self) -> Protocol { let data = self.buffer.as_ref(); let raw = NetworkEndian::read_u16(&data[field::PTYPE]); Protocol::from(raw) } /// Return the hardware length field. #[inline] pub fn hardware_len(&self) -> u8 { let data = self.buffer.as_ref(); data[field::HLEN] } /// Return the protocol length field. #[inline] pub fn protocol_len(&self) -> u8 { let data = self.buffer.as_ref(); data[field::PLEN] } /// Return the operation field. #[inline] pub fn operation(&self) -> Operation { let data = self.buffer.as_ref(); let raw = NetworkEndian::read_u16(&data[field::OPER]); Operation::from(raw) } /// Return the source hardware address field. pub fn source_hardware_addr(&self) -> &[u8] { let data = self.buffer.as_ref(); &data[field::SHA(self.hardware_len(), self.protocol_len())] } /// Return the source protocol address field. pub fn source_protocol_addr(&self) -> &[u8] { let data = self.buffer.as_ref(); &data[field::SPA(self.hardware_len(), self.protocol_len())] } /// Return the target hardware address field. pub fn target_hardware_addr(&self) -> &[u8] { let data = self.buffer.as_ref(); &data[field::THA(self.hardware_len(), self.protocol_len())] } /// Return the target protocol address field. pub fn target_protocol_addr(&self) -> &[u8] { let data = self.buffer.as_ref(); &data[field::TPA(self.hardware_len(), self.protocol_len())] } } impl + AsMut<[u8]>> Packet { /// Set the hardware type field. #[inline] pub fn set_hardware_type(&mut self, value: Hardware) { let data = self.buffer.as_mut(); NetworkEndian::write_u16(&mut data[field::HTYPE], value.into()) } /// Set the protocol type field. #[inline] pub fn set_protocol_type(&mut self, value: Protocol) { let data = self.buffer.as_mut(); NetworkEndian::write_u16(&mut data[field::PTYPE], value.into()) } /// Set the hardware length field. #[inline] pub fn set_hardware_len(&mut self, value: u8) { let data = self.buffer.as_mut(); data[field::HLEN] = value } /// Set the protocol length field. #[inline] pub fn set_protocol_len(&mut self, value: u8) { let data = self.buffer.as_mut(); data[field::PLEN] = value } /// Set the operation field. #[inline] pub fn set_operation(&mut self, value: Operation) { let data = self.buffer.as_mut(); NetworkEndian::write_u16(&mut data[field::OPER], value.into()) } /// Set the source hardware address field. /// /// # Panics /// The function panics if `value` is not `self.hardware_len()` long. pub fn set_source_hardware_addr(&mut self, value: &[u8]) { let (hardware_len, protocol_len) = (self.hardware_len(), self.protocol_len()); let data = self.buffer.as_mut(); data[field::SHA(hardware_len, protocol_len)].copy_from_slice(value) } /// Set the source protocol address field. /// /// # Panics /// The function panics if `value` is not `self.protocol_len()` long. pub fn set_source_protocol_addr(&mut self, value: &[u8]) { let (hardware_len, protocol_len) = (self.hardware_len(), self.protocol_len()); let data = self.buffer.as_mut(); data[field::SPA(hardware_len, protocol_len)].copy_from_slice(value) } /// Set the target hardware address field. /// /// # Panics /// The function panics if `value` is not `self.hardware_len()` long. pub fn set_target_hardware_addr(&mut self, value: &[u8]) { let (hardware_len, protocol_len) = (self.hardware_len(), self.protocol_len()); let data = self.buffer.as_mut(); data[field::THA(hardware_len, protocol_len)].copy_from_slice(value) } /// Set the target protocol address field. /// /// # Panics /// The function panics if `value` is not `self.protocol_len()` long. pub fn set_target_protocol_addr(&mut self, value: &[u8]) { let (hardware_len, protocol_len) = (self.hardware_len(), self.protocol_len()); let data = self.buffer.as_mut(); data[field::TPA(hardware_len, protocol_len)].copy_from_slice(value) } } use super::{EthernetAddress, Ipv4Address}; /// A high-level representation of an Address Resolution Protocol packet. #[derive(Debug, PartialEq, Eq, Clone, Copy)] pub enum Repr { /// An Ethernet and IPv4 Address Resolution Protocol packet. EthernetIpv4 { operation: Operation, source_hardware_addr: EthernetAddress, source_protocol_addr: Ipv4Address, target_hardware_addr: EthernetAddress, target_protocol_addr: Ipv4Address }, #[doc(hidden)] __Nonexhaustive } impl Repr { /// Parse an Address Resolution Protocol packet and return a high-level representation, /// or return `Err(())` if the packet is not recognized. pub fn parse>(packet: &Packet) -> Result { match (packet.hardware_type(), packet.protocol_type(), packet.hardware_len(), packet.protocol_len()) { (Hardware::Ethernet, Protocol::Ipv4, 6, 4) => { Ok(Repr::EthernetIpv4 { operation: packet.operation(), source_hardware_addr: EthernetAddress::from_bytes(packet.source_hardware_addr()), source_protocol_addr: Ipv4Address::from_bytes(packet.source_protocol_addr()), target_hardware_addr: EthernetAddress::from_bytes(packet.target_hardware_addr()), target_protocol_addr: Ipv4Address::from_bytes(packet.target_protocol_addr()) }) }, _ => Err(Error::Unrecognized) } } /// Return the length of a packet that will be emitted from this high-level representation. pub fn buffer_len(&self) -> usize { match self { &Repr::EthernetIpv4 { .. } => field::TPA(6, 4).end, &Repr::__Nonexhaustive => unreachable!() } } /// Emit a high-level representation into an Address Resolution Protocol packet. pub fn emit + AsMut<[u8]>>(&self, packet: &mut Packet) { match self { &Repr::EthernetIpv4 { operation, source_hardware_addr, source_protocol_addr, target_hardware_addr, target_protocol_addr } => { packet.set_hardware_type(Hardware::Ethernet); packet.set_protocol_type(Protocol::Ipv4); packet.set_hardware_len(6); packet.set_protocol_len(4); packet.set_operation(operation); packet.set_source_hardware_addr(source_hardware_addr.as_bytes()); packet.set_source_protocol_addr(source_protocol_addr.as_bytes()); packet.set_target_hardware_addr(target_hardware_addr.as_bytes()); packet.set_target_protocol_addr(target_protocol_addr.as_bytes()); }, &Repr::__Nonexhaustive => unreachable!() } } } impl> fmt::Display for Packet { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match Repr::parse(self) { Ok(repr) => write!(f, "{}", repr), _ => { try!(write!(f, "ARP (unrecognized)")); try!(write!(f, " htype={:?} ptype={:?} hlen={:?} plen={:?} op={:?}", self.hardware_type(), self.protocol_type(), self.hardware_len(), self.protocol_len(), self.operation())); try!(write!(f, " sha={:?} spa={:?} tha={:?} tpa={:?}", self.source_hardware_addr(), self.source_protocol_addr(), self.target_hardware_addr(), self.target_protocol_addr())); Ok(()) } } } } impl fmt::Display for Repr { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { match self { &Repr::EthernetIpv4 { operation, source_hardware_addr, source_protocol_addr, target_hardware_addr, target_protocol_addr } => { write!(f, "ARP type=Ethernet+IPv4 src={}/{} tgt={}/{} op={:?}", source_hardware_addr, source_protocol_addr, target_hardware_addr, target_protocol_addr, operation) }, &Repr::__Nonexhaustive => unreachable!() } } } use super::pretty_print::{PrettyPrint, PrettyIndent}; impl> PrettyPrint for Packet { fn pretty_print(buffer: &AsRef<[u8]>, f: &mut fmt::Formatter, indent: &mut PrettyIndent) -> fmt::Result { match Packet::new(buffer) { Err(err) => write!(f, "{}({})\n", indent, err), Ok(frame) => write!(f, "{}{}\n", indent, frame) } } } #[cfg(test)] mod test { use super::*; static PACKET_BYTES: [u8; 28] = [0x00, 0x01, 0x08, 0x00, 0x06, 0x04, 0x00, 0x01, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x21, 0x22, 0x23, 0x24, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x41, 0x42, 0x43, 0x44]; #[test] fn test_deconstruct() { let packet = Packet::new(&PACKET_BYTES[..]).unwrap(); assert_eq!(packet.hardware_type(), Hardware::Ethernet); assert_eq!(packet.protocol_type(), Protocol::Ipv4); assert_eq!(packet.hardware_len(), 6); assert_eq!(packet.protocol_len(), 4); assert_eq!(packet.operation(), Operation::Request); assert_eq!(packet.source_hardware_addr(), &[0x11, 0x12, 0x13, 0x14, 0x15, 0x16]); assert_eq!(packet.source_protocol_addr(), &[0x21, 0x22, 0x23, 0x24]); assert_eq!(packet.target_hardware_addr(), &[0x31, 0x32, 0x33, 0x34, 0x35, 0x36]); assert_eq!(packet.target_protocol_addr(), &[0x41, 0x42, 0x43, 0x44]); } #[test] fn test_construct() { let mut bytes = vec![0; 28]; let mut packet = Packet::new(&mut bytes).unwrap(); packet.set_hardware_type(Hardware::Ethernet); packet.set_protocol_type(Protocol::Ipv4); packet.set_hardware_len(6); packet.set_protocol_len(4); packet.set_operation(Operation::Request); packet.set_source_hardware_addr(&[0x11, 0x12, 0x13, 0x14, 0x15, 0x16]); packet.set_source_protocol_addr(&[0x21, 0x22, 0x23, 0x24]); packet.set_target_hardware_addr(&[0x31, 0x32, 0x33, 0x34, 0x35, 0x36]); packet.set_target_protocol_addr(&[0x41, 0x42, 0x43, 0x44]); assert_eq!(&packet.into_inner()[..], &PACKET_BYTES[..]); } fn packet_repr() -> Repr { Repr::EthernetIpv4 { operation: Operation::Request, source_hardware_addr: EthernetAddress::from_bytes(&[0x11, 0x12, 0x13, 0x14, 0x15, 0x16]), source_protocol_addr: Ipv4Address::from_bytes(&[0x21, 0x22, 0x23, 0x24]), target_hardware_addr: EthernetAddress::from_bytes(&[0x31, 0x32, 0x33, 0x34, 0x35, 0x36]), target_protocol_addr: Ipv4Address::from_bytes(&[0x41, 0x42, 0x43, 0x44]) } } #[test] fn test_parse() { let packet = Packet::new(&PACKET_BYTES[..]).unwrap(); let repr = Repr::parse(&packet).unwrap(); assert_eq!(repr, packet_repr()); } #[test] fn test_emit() { let mut bytes = vec![0; 28]; let mut packet = Packet::new(&mut bytes).unwrap(); packet_repr().emit(&mut packet); assert_eq!(&packet.into_inner()[..], &PACKET_BYTES[..]); } }