1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
use super::*;
/// Decoded packet headers (data link layer and lower).
///
/// You can use
///
/// * [`PacketHeaders::from_ethernet_slice`]
/// * [`PacketHeaders::from_ether_type`]
/// * [`PacketHeaders::from_ip_slice`]
///
/// depending on your starting header to parse the headers in a slice and get this
/// struct as a result.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct PacketHeaders<'a> {
/// Ethernet II header if present.
pub link: Option<Ethernet2Header>,
/// Single or double vlan headers if present.
pub vlan: Option<VlanHeader>,
/// IPv4 or IPv6 header and IP extension headers if present.
pub ip: Option<IpHeader>,
/// TCP or UDP header if present.
pub transport: Option<TransportHeader>,
/// Rest of the packet that could not be decoded as a header (usually the payload).
pub payload: &'a [u8]
}
impl<'a> PacketHeaders<'a> {
/// Decodes a network packet into different headers from a slice that starts with an Ethernet II header.
///
/// The result is returned as a [`PacketHeaders`] struct.
///
/// # Example
///
/// Basic usage:
///
///```
/// # use etherparse::{Ethernet2Header, SerializedSize, PacketBuilder};
/// # let builder = PacketBuilder::
/// # ethernet2([1,2,3,4,5,6], //source mac
/// # [7,8,9,10,11,12]) //destionation mac
/// # .ipv4([192,168,1,1], //source ip
/// # [192,168,1,2], //desitionation ip
/// # 20) //time to life
/// # .udp(21, //source port
/// # 1234); //desitnation port
/// # // payload of the udp packet
/// # let payload = [1,2,3,4,5,6,7,8];
/// # // get some memory to store the serialized data
/// # let mut complete_packet = Vec::<u8>::with_capacity(
/// # builder.size(payload.len())
/// # );
/// # builder.write(&mut complete_packet, &payload).unwrap();
/// #
/// # // skip ethernet 2 header so we can parse from there downwards
/// # let packet = &complete_packet[Ethernet2Header::SERIALIZED_SIZE..];
/// #
/// use etherparse::{ether_type, PacketHeaders};
///
/// match PacketHeaders::from_ether_type(ether_type::IPV4, packet) {
/// Err(value) => println!("Err {:?}", value),
/// Ok(value) => {
/// println!("link: {:?}", value.link);
/// println!("vlan: {:?}", value.vlan);
/// println!("ip: {:?}", value.ip);
/// println!("transport: {:?}", value.transport);
/// }
/// }
/// ```
pub fn from_ethernet_slice(packet: &[u8]) -> Result<PacketHeaders, ReadError> {
let (ethernet, mut rest) = Ethernet2Header::from_slice(packet)?;
let mut ether_type = ethernet.ether_type;
let mut result = PacketHeaders{
link: Some(ethernet),
vlan: None,
ip: None,
transport: None,
payload: &[]
};
//parse vlan header(s)
use ether_type::*;
result.vlan = match ether_type {
VLAN_TAGGED_FRAME | PROVIDER_BRIDGING | VLAN_DOUBLE_TAGGED_FRAME => {
use crate::VlanHeader::*;
let (outer, outer_rest) = SingleVlanHeader::from_slice(rest)?;
//set the rest & ether_type for the following operations
rest = outer_rest;
ether_type = outer.ether_type;
//parse second vlan header if present
match ether_type {
//second vlan tagging header
VLAN_TAGGED_FRAME | PROVIDER_BRIDGING | VLAN_DOUBLE_TAGGED_FRAME => {
let (inner, inner_rest) = SingleVlanHeader::from_slice(rest)?;
//set the rest & ether_type for the following operations
rest = inner_rest;
ether_type = inner.ether_type;
Some(Double(DoubleVlanHeader{
outer,
inner
}))
},
//no second vlan header detected -> single vlan header
_ => Some(Single(outer))
}
},
//no vlan header
_ => None
};
//parse ip (if present)
match ether_type {
IPV4 => {
let (ip, ip_rest) = Ipv4Header::from_slice(rest)?;
let fragmented = ip.is_fragmenting_payload();
let (ip_ext, ip_protocol, ip_ext_rest) = Ipv4Extensions::from_slice(ip.protocol, ip_rest)?;
//set the ip result & rest
rest = ip_ext_rest;
result.ip = Some(IpHeader::Version4(ip, ip_ext));
// only try to decode the transport layer if the payload
// is not fragmented
if false == fragmented {
//parse the transport layer
let (transport, transport_rest) = read_transport(ip_protocol, rest)?;
//assign to the output
rest = transport_rest;
result.transport = transport;
}
},
IPV6 => {
let (ip, ip_rest) = Ipv6Header::from_slice(rest)?;
let (ip_ext, next_header, ip_ext_rest) = Ipv6Extensions::from_slice(ip.next_header, ip_rest)?;
let fragmented = ip_ext.is_fragmenting_payload();
//set the ip result & rest
rest = ip_ext_rest;
result.ip = Some(IpHeader::Version6(ip, ip_ext));
// only try to decode the transport layer if the payload
// is not fragmented
if false == fragmented {
//parse the transport layer
let (transport, transport_rest) = read_transport(next_header, rest)?;
rest = transport_rest;
result.transport = transport;
}
},
_ => {}
}
//finally update the rest slice based on the cursor position
result.payload = rest;
Ok(result)
}
/// Tries to decode a network packet into different headers using the
/// given `ether_type` number to identify the first header.
///
/// The result is returned as a [`PacketHeaders`] struct. Currently supported
/// ether type numbers are:
///
/// * `ether_type::IPV4`
/// * `ether_type::IPV6`
/// * `ether_type::VLAN_TAGGED_FRAME`
/// * `ether_type::PROVIDER_BRIDGING`
/// * `ether_type::VLAN_DOUBLE_TAGGED_FRAME`
///
/// If an unsupported ether type is given the given slice will be set as payload
/// and all other fields will be set to `None`.
///
/// # Example
///
/// Basic usage:
///
///```
/// # use etherparse::{Ethernet2Header, SerializedSize, PacketBuilder};
/// # let builder = PacketBuilder::
/// # ethernet2([1,2,3,4,5,6], //source mac
/// # [7,8,9,10,11,12]) //destionation mac
/// # .ipv4([192,168,1,1], //source ip
/// # [192,168,1,2], //desitionation ip
/// # 20) //time to life
/// # .udp(21, //source port
/// # 1234); //desitnation port
/// # // payload of the udp packet
/// # let payload = [1,2,3,4,5,6,7,8];
/// # // get some memory to store the serialized data
/// # let mut complete_packet = Vec::<u8>::with_capacity(
/// # builder.size(payload.len())
/// # );
/// # builder.write(&mut complete_packet, &payload).unwrap();
/// #
/// # // skip ethernet 2 header so we can parse from there downwards
/// # let packet = &complete_packet[Ethernet2Header::SERIALIZED_SIZE..];
/// #
/// use etherparse::{ether_type, PacketHeaders};
///
/// match PacketHeaders::from_ether_type(ether_type::IPV4, packet) {
/// Err(value) => println!("Err {:?}", value),
/// Ok(value) => {
/// println!("link: {:?}", value.link);
/// println!("vlan: {:?}", value.vlan);
/// println!("ip: {:?}", value.ip);
/// println!("transport: {:?}", value.transport);
/// }
/// }
/// ```
pub fn from_ether_type(mut ether_type: u16, data: &'a [u8]) -> Result<PacketHeaders, ReadError> {
let mut rest = data;
let mut result = PacketHeaders{
link: None,
vlan: None,
ip: None,
transport: None,
payload: &[]
};
//parse vlan header(s)
use ether_type::*;
result.vlan = match ether_type {
VLAN_TAGGED_FRAME | PROVIDER_BRIDGING | VLAN_DOUBLE_TAGGED_FRAME => {
use crate::VlanHeader::*;
let (outer, outer_rest) = SingleVlanHeader::from_slice(rest)?;
//set the rest & ether_type for the following operations
rest = outer_rest;
ether_type = outer.ether_type;
//parse second vlan header if present
match ether_type {
//second vlan tagging header
VLAN_TAGGED_FRAME | PROVIDER_BRIDGING | VLAN_DOUBLE_TAGGED_FRAME => {
let (inner, inner_rest) = SingleVlanHeader::from_slice(rest)?;
//set the rest & ether_type for the following operations
rest = inner_rest;
ether_type = inner.ether_type;
Some(Double(DoubleVlanHeader{
outer,
inner
}))
},
//no second vlan header detected -> single vlan header
_ => Some(Single(outer))
}
},
//no vlan header
_ => None
};
//parse ip (if present)
match ether_type {
IPV4 => {
let (ip, ip_rest) = Ipv4Header::from_slice(rest)?;
let fragmented = ip.is_fragmenting_payload();
let (ip_ext, ip_protocol, ip_ext_rest) = Ipv4Extensions::from_slice(ip.protocol, ip_rest)?;
//set the ip result & rest
rest = ip_ext_rest;
result.ip = Some(IpHeader::Version4(ip, ip_ext));
// only try to decode the transport layer if the payload
// is not fragmented
if false == fragmented {
//parse the transport layer
let (transport, transport_rest) = read_transport(ip_protocol, rest)?;
//assign to the output
rest = transport_rest;
result.transport = transport;
}
},
IPV6 => {
let (ip, ip_rest) = Ipv6Header::from_slice(rest)?;
let (ip_ext, next_header, ip_ext_rest) = Ipv6Extensions::from_slice(ip.next_header, ip_rest)?;
let fragmented = ip_ext.is_fragmenting_payload();
//set the ip result & rest
rest = ip_ext_rest;
result.ip = Some(IpHeader::Version6(ip, ip_ext));
// only try to decode the transport layer if the payload
// is not fragmented
if false == fragmented {
//parse the transport layer
let (transport, transport_rest) = read_transport(next_header, rest)?;
rest = transport_rest;
result.transport = transport;
}
},
_ => {}
}
//finally update the rest slice based on the cursor position
result.payload = rest;
Ok(result)
}
/// Tries to decode an ip packet and its transport headers.
///
/// Assumes the given slice starts with the first byte of the IP header.
///
/// # Example
///
/// Basic usage:
///
/// ```
/// # use etherparse::PacketBuilder;
/// # // build a UDP packet
/// # let payload = [0u8;18];
/// # let builder = PacketBuilder::
/// # ipv4([192,168,1,1], //source ip
/// # [192,168,1,2], //desitionation ip
/// # 20) //time to life
/// # .udp(21, //source port
/// # 1234); //desitnation port
/// #
/// # // serialize the packet
/// # let packet = {
/// # let mut packet = Vec::<u8>::with_capacity(
/// # builder.size(payload.len())
/// # );
/// # builder.write(&mut packet, &payload).unwrap();
/// # packet
/// # };
/// use etherparse::PacketHeaders;
///
/// match PacketHeaders::from_ip_slice(&packet) {
/// Err(value) => println!("Err {:?}", value),
/// Ok(value) => {
/// println!("link: {:?}", value.link);
/// println!("vlan: {:?}", value.vlan);
/// println!("ip: {:?}", value.ip);
/// println!("transport: {:?}", value.transport);
/// }
/// }
/// ```
pub fn from_ip_slice(packet: &[u8]) -> Result<PacketHeaders, ReadError> {
let mut result = PacketHeaders {
link: None,
vlan: None,
ip: None,
transport: None,
payload: &[],
};
let (transport_proto, rest) = {
let (ip, transport_proto, rest) = IpHeader::from_slice(packet)?;
// update output
result.ip = Some(ip);
(transport_proto, rest)
};
// try to parse the transport header
let (transport, rest) = read_transport(transport_proto, rest)?;
// update output
result.transport = transport;
result.payload = rest;
Ok(result)
}
/// If the slice in the `payload` field contains an ethernet payload
/// this method returns the ether type number describing the payload type.
///
/// The ether type number can come from an ethernet II header or a
/// VLAN header depending on which headers are present.
///
/// In case that `ip` and/or `transport` fields are the filled None
/// is returned, as the payload contents then are defined by a
/// lower layer protocol described in these fields.
pub fn payload_ether_type(&self) -> Option<u16> {
if self.ip.is_some() || self.transport.is_some() {
None
} else {
if let Some(vlan) = &self.vlan {
use VlanHeader::*;
match vlan {
Single(s) => {
Some(s.ether_type)
},
Double(d) => {
Some(d.inner.ether_type)
}
}
} else {
if let Some(link) = &self.link {
Some(link.ether_type)
} else {
None
}
}
}
}
}
/// helper function to process transport headers
fn read_transport(
protocol: u8,
rest: &[u8],
) -> Result<(Option<TransportHeader>, &[u8]), ReadError> {
use crate::ip_number::*;
match protocol {
ICMP => {
Ok(Icmpv4Header::from_slice(rest)?)
.map( |value| (Some(TransportHeader::Icmpv4(value.0)), value.1))
},
IPV6_ICMP => {
Ok(Icmpv6Header::from_slice(rest)?)
.map( |value| (Some(TransportHeader::Icmpv6(value.0)), value.1))
},
UDP => Ok(UdpHeader::from_slice(rest)
.map(|value| (Some(TransportHeader::Udp(value.0)), value.1))?),
TCP => Ok(TcpHeader::from_slice(rest)
.map(|value| (Some(TransportHeader::Tcp(value.0)), value.1))?),
_ => Ok((None, rest)),
}
}