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 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
use core::slice::from_raw_parts;
#[cfg(feature = "std")]
use std::net::Ipv4Addr;
use crate::*;
/// A slice containing an ipv4 header of a network package.
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
pub struct Ipv4HeaderSlice<'a> {
slice: &'a [u8],
}
impl<'a> Ipv4HeaderSlice<'a> {
/// Creates a slice containing an ipv4 header (including header options).
///
/// If you also want to have the payload & ip extension headers correctly
/// seperated you can use
///
/// * [`crate::Ipv4Slice::from_slice`] (just identifies slice ranges)
/// * [`crate::IpHeaders::from_ipv4_slice`] (unpacks all fields)
///
/// or
///
/// * [`crate::IpHeaders::from_ipv4_slice_lax`]
/// * [`crate::LaxIpv4Slice::from_slice`]
///
/// for a laxer version which falls back to slice length only when the total_length
/// field in the header is inconsistent.
pub fn from_slice(slice: &'a [u8]) -> Result<Ipv4HeaderSlice<'a>, err::ipv4::HeaderSliceError> {
use err::ipv4::HeaderError::*;
use err::ipv4::HeaderSliceError::*;
// check length
if slice.len() < Ipv4Header::MIN_LEN {
return Err(Len(err::LenError {
required_len: Ipv4Header::MIN_LEN,
len: slice.len(),
len_source: LenSource::Slice,
layer: err::Layer::Ipv4Header,
layer_start_offset: 0,
}));
}
// read version & ihl
let (version_number, ihl) = unsafe {
let value = slice.get_unchecked(0);
(value >> 4, value & 0xf)
};
// check version
if 4 != version_number {
return Err(Content(UnexpectedVersion { version_number }));
}
// check that the ihl is correct
if ihl < 5 {
return Err(Content(HeaderLengthSmallerThanHeader { ihl }));
}
// check that the slice contains enough data for the entire header + options
let header_length = (usize::from(ihl)) * 4;
if slice.len() < header_length {
return Err(Len(err::LenError {
required_len: header_length,
len: slice.len(),
len_source: LenSource::Slice,
layer: err::Layer::Ipv4Header,
layer_start_offset: 0,
}));
}
//all good
Ok(Ipv4HeaderSlice {
// SAFETY:
// Safe as the slice length is checked to be at least
// header_length or greater above.
slice: unsafe { from_raw_parts(slice.as_ptr(), header_length) },
})
}
/// Converts the given slice into a ipv4 header slice WITHOUT any
/// checks to ensure that the data present is an ipv4 header or that the
/// slice length is matching the header length.
///
/// If you are not sure what this means, use [`Ipv4HeaderSlice::from_slice`]
/// instead.
///
/// # Safety
///
/// It must ensured that the slice exactly contains the IPv4 header
/// and the ihl (intra header length) & total length must be consistent.
#[inline]
pub(crate) unsafe fn from_slice_unchecked(slice: &[u8]) -> Ipv4HeaderSlice {
Ipv4HeaderSlice { slice }
}
/// Returns the slice containing the ipv4 header
#[inline]
pub fn slice(&self) -> &'a [u8] {
self.slice
}
/// Read the "version" field of the IPv4 header (should be 4).
#[inline]
pub fn version(&self) -> u8 {
// SAFETY:
// Safe as the slice length is checked to be at least
// Ipv4Header::MIN_LEN (20) in the constructor.
unsafe { *self.slice.get_unchecked(0) >> 4 }
}
/// Read the "ip header length" (length of the ipv4 header + options in multiples of 4 bytes).
#[inline]
pub fn ihl(&self) -> u8 {
// SAFETY:
// Safe as the slice length is checked to be at least
// Ipv4Header::MIN_LEN (20) in the constructor.
unsafe { *self.slice.get_unchecked(0) & 0xf }
}
/// Read the "differentiated_services_code_point" from the slice.
#[inline]
pub fn dcp(&self) -> Ipv4Dscp {
// SAFETY:
// get_unchecked: Safe as the slice length is checked to be at least
// Ipv4Header::MIN_LEN (20) in the constructor.
// new_unchecked: Safe as the bitshift by 2 guarantees that the passed
// value is not bigger then 6 bits.
unsafe { Ipv4Dscp::new_unchecked(*self.slice.get_unchecked(1) >> 2) }
}
/// Read the "explicit_congestion_notification" from the slice.
#[inline]
pub fn ecn(&self) -> Ipv4Ecn {
// SAFETY:
// get_unchecked: Safe as the slice length is checked to be at least
// Ipv4Header::MIN_LEN (20) in the constructor.
// new_unchecked: Safe as value has been bitmasked to two bits.
unsafe { Ipv4Ecn::new_unchecked(*self.slice.get_unchecked(1) & 0b0000_0011) }
}
/// Read the "total length" from the slice (total length of ip header + payload).
#[inline]
pub fn total_len(&self) -> u16 {
// SAFETY:
// Safe as the slice length is checked to be at least
// Ipv4Header::MIN_LEN (20) in the constructor.
unsafe { get_unchecked_be_u16(self.slice.as_ptr().add(2)) }
}
/// Determine the payload length based on the ihl & total_length
/// field of the header.
///
/// # Example Usage
///
/// ```
/// use etherparse::{Ipv4Header, Ipv4HeaderSlice};
///
/// let bytes = Ipv4Header{
/// // the payload len will be calculated by subtracting the
/// // header length from the total length
/// total_len: Ipv4Header::MIN_LEN as u16 + 100,
/// ..Default::default()
/// }.to_bytes();
///
/// let slice = Ipv4HeaderSlice::from_slice(&bytes).unwrap();
/// assert_eq!(Ok(100), slice.payload_len());
///
/// // error case
/// let bad_bytes = Ipv4Header {
/// // total len should also include the header, in case it does
/// // not it is not possible to calculate the payload length
/// total_len: Ipv4Header::MIN_LEN as u16 - 1,
/// ..Default::default()
/// }.to_bytes();
///
/// let bad_slice = Ipv4HeaderSlice::from_slice(&bad_bytes).unwrap();
/// // in case the total_len is smaller then the header itself an
/// // error is returned
/// use etherparse::{err::{LenError, Layer}, LenSource};
/// assert_eq!(
/// bad_slice.payload_len(),
/// Err(LenError {
/// required_len: Ipv4Header::MIN_LEN,
/// len: Ipv4Header::MIN_LEN - 1,
/// len_source: LenSource::Ipv4HeaderTotalLen,
/// layer: Layer::Ipv4Packet,
/// layer_start_offset: 0,
/// })
/// );
/// ```
#[inline]
pub fn payload_len(&self) -> Result<u16, err::LenError> {
let total_len = self.total_len();
// SAFETY: slice.len() can be at most be 60 (verified in from_slice) so a
// cast to u16 is safe.
let header_len = self.slice.len() as u16;
if header_len <= total_len {
Ok(total_len - header_len)
} else {
use err::{Layer, LenError};
Err(LenError {
required_len: header_len.into(),
len: total_len.into(),
len_source: LenSource::Ipv4HeaderTotalLen,
layer: Layer::Ipv4Packet,
layer_start_offset: 0,
})
}
}
/// Read the "identification" field from the slice.
#[inline]
pub fn identification(&self) -> u16 {
// SAFETY:
// Safe as the slice length is checked to be at least
// Ipv4Header::MIN_LEN (20) in the constructor.
unsafe { get_unchecked_be_u16(self.slice.as_ptr().add(4)) }
}
/// Read the "dont fragment" flag from the slice.
#[inline]
pub fn dont_fragment(&self) -> bool {
// SAFETY:
// Safe as the slice length is checked to be at least
// Ipv4Header::MIN_LEN (20) in the constructor.
unsafe { 0 != (*self.slice.get_unchecked(6) & 0x40) }
}
/// Read the "more fragments" flag from the slice.
#[inline]
pub fn more_fragments(&self) -> bool {
// SAFETY:
// Safe as the slice length is checked to be at least
// Ipv4Header::MIN_LEN (20) in the constructor.
unsafe { 0 != (*self.slice.get_unchecked(6) & 0x20) }
}
/// Read the "fragment_offset" field from the slice.
#[inline]
pub fn fragments_offset(&self) -> IpFragOffset {
unsafe {
// SAFETY:
// Safe as the value is limited to be 13 bits long bellow.
IpFragOffset::new_unchecked(u16::from_be_bytes([
// SAFETY:
// Safe as the slice length is checked to be at least
// Ipv4Header::MIN_LEN (20) in the constructor.
*self.slice.get_unchecked(6) & 0x1f,
*self.slice.get_unchecked(7),
]))
}
}
/// Read the "time_to_live" field from the slice.
#[inline]
pub fn ttl(&self) -> u8 {
// SAFETY:
// Safe as the slice length is checked to be at least
// Ipv4Header::MIN_LEN (20) in the constructor.
unsafe { *self.slice.get_unchecked(8) }
}
/// Read the "protocol" field from the slice.
#[inline]
pub fn protocol(&self) -> IpNumber {
// SAFETY:
// Safe as the slice length is checked to be at least
// Ipv4Header::MIN_LEN (20) in the constructor.
IpNumber(unsafe { *self.slice.get_unchecked(9) })
}
/// Read the "header checksum" field from the slice.
#[inline]
pub fn header_checksum(&self) -> u16 {
// SAFETY:
// Safe as the slice length is checked to be at least
// Ipv4Header::MIN_LEN (20) in the constructor.
unsafe { get_unchecked_be_u16(self.slice.as_ptr().add(10)) }
}
/// Returns a slice containing the ipv4 source address.
#[inline]
pub fn source(&self) -> [u8; 4] {
// SAFETY:
// Safe as the slice length is checked to be at least
// Ipv4Header::MIN_LEN (20) in the constructor.
unsafe { get_unchecked_4_byte_array(self.slice.as_ptr().add(12)) }
}
/// Return the ipv4 source address as an std::net::Ipv4Addr
#[cfg(feature = "std")]
#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
#[inline]
pub fn source_addr(&self) -> Ipv4Addr {
Ipv4Addr::from(self.source())
}
/// Returns a slice containing the ipv4 source address.
#[inline]
pub fn destination(&self) -> [u8; 4] {
// SAFETY:
// Safe as the slice length is checked to be at least
// Ipv4Header::MIN_LEN (20) in the constructor.
unsafe { get_unchecked_4_byte_array(self.slice.as_ptr().add(16)) }
}
/// Return the ipv4 destination address as an std::net::Ipv4Addr
#[cfg(feature = "std")]
#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
#[inline]
pub fn destination_addr(&self) -> Ipv4Addr {
Ipv4Addr::from(self.destination())
}
/// Returns a slice containing the ipv4 header options (empty when there are no options).
#[inline]
pub fn options(&self) -> &'a [u8] {
// SAFETY:
// Safe as the slice length is checked to be at least
// Ipv4Header::MIN_LEN (20) in the constructor.
unsafe { from_raw_parts(self.slice.as_ptr().add(20), self.slice.len() - 20) }
}
/// Returns true if the payload is fragmented.
///
/// Either data is missing (more_fragments set) or there is
/// an fragment offset.
#[inline]
pub fn is_fragmenting_payload(&self) -> bool {
self.more_fragments() || (0 != self.fragments_offset().value())
}
/// Decode all the fields and copy the results to a Ipv4Header struct
#[inline]
pub fn to_header(&self) -> Ipv4Header {
Ipv4Header {
dscp: self.dcp(),
ecn: self.ecn(),
total_len: self.total_len(),
identification: self.identification(),
dont_fragment: self.dont_fragment(),
more_fragments: self.more_fragments(),
fragment_offset: self.fragments_offset(),
time_to_live: self.ttl(),
protocol: self.protocol(),
header_checksum: self.header_checksum(),
source: self.source(),
destination: self.destination(),
options: {
let options_slice = self.options();
let mut options = Ipv4Options::new();
options.len = options_slice.len() as u8;
let target_slice: &mut [u8] = options.as_mut();
target_slice.copy_from_slice(options_slice);
options
},
}
}
}
#[cfg(test)]
mod test {
use crate::{test_gens::*, *};
use alloc::{format, vec::Vec};
use arrayvec::ArrayVec;
use proptest::prelude::*;
#[test]
fn debug() {
let buffer = {
let header: Ipv4Header = Default::default();
header.to_bytes()
};
let slice = Ipv4HeaderSlice::from_slice(&buffer).unwrap();
assert_eq!(
format!("{:?}", slice),
format!("Ipv4HeaderSlice {{ slice: {:?} }}", slice.slice())
);
}
proptest! {
#[test]
fn clone_eq(header in ipv4_any()) {
let buffer = header.to_bytes();
let slice = Ipv4HeaderSlice::from_slice(&buffer).unwrap();
assert_eq!(slice.clone(), slice);
}
}
proptest! {
#[test]
fn from_slice(header in ipv4_any()) {
use err::ipv4::HeaderError::*;
use err::ipv4::HeaderSliceError::*;
// ok
{
let mut buffer = ArrayVec::<u8, { Ipv4Header::MAX_LEN + 1 }>::new();
buffer.try_extend_from_slice(&header.to_bytes()).unwrap();
buffer.try_extend_from_slice(&[1]).unwrap();
let actual_slice = Ipv4HeaderSlice::from_slice(&buffer).unwrap();
assert_eq!(actual_slice.to_header(), header);
assert_eq!(actual_slice.slice(), &buffer[..header.header_len()]);
}
// unexpected end of slice
{
let buffer = header.to_bytes();
for len in 0..header.header_len() {
assert_eq!(
Ipv4HeaderSlice::from_slice(&buffer[..len]),
Err(Len(err::LenError{
required_len: if len < Ipv4Header::MIN_LEN {
Ipv4Header::MIN_LEN
} else {
header.header_len()
},
len: len,
len_source: LenSource::Slice,
layer: err::Layer::Ipv4Header,
layer_start_offset: 0,
}))
);
}
}
// version error
for version_number in 0u8..0b1111u8 {
if 4 != version_number {
let mut buffer = header.to_bytes();
// inject the bad ihl
buffer[0] = (version_number << 4) | (buffer[0] & 0b1111);
// expect an error
assert_eq!(
Ipv4HeaderSlice::from_slice(&buffer).unwrap_err(),
Content(UnexpectedVersion{
version_number,
})
);
}
}
// ihl too small error
for ihl in 0u8..5u8 {
let mut buffer = header.to_bytes();
// inject the bad ihl
buffer[0] = (4 << 4) | ihl;
// expect an error
assert_eq!(
Ipv4HeaderSlice::from_slice(&buffer).unwrap_err(),
Content(HeaderLengthSmallerThanHeader{
ihl,
})
);
}
}
}
#[test]
fn from_slice_unchecked() {
let buffer = [0u8; 4];
let slice = unsafe { Ipv4HeaderSlice::from_slice_unchecked(&buffer) };
assert_eq!(slice.slice(), &buffer);
}
proptest! {
#[test]
fn getters(header in ipv4_any()) {
let buffer = header.to_bytes();
let slice = Ipv4HeaderSlice::from_slice(&buffer).unwrap();
assert_eq!(slice.slice(), &buffer[..]);
assert_eq!(slice.version(), 4);
assert_eq!(slice.ihl(), header.ihl());
assert_eq!(slice.dcp(), header.dscp);
assert_eq!(slice.ecn(), header.ecn);
assert_eq!(slice.total_len(), header.total_len);
assert_eq!(slice.payload_len(), header.payload_len());
assert_eq!(slice.identification(), header.identification);
assert_eq!(slice.dont_fragment(), header.dont_fragment);
assert_eq!(slice.more_fragments(), header.more_fragments);
assert_eq!(slice.fragments_offset(), header.fragment_offset);
assert_eq!(slice.ttl(), header.time_to_live);
assert_eq!(slice.protocol(), header.protocol);
assert_eq!(slice.header_checksum(), header.header_checksum);
assert_eq!(slice.source(), header.source);
assert_eq!(slice.destination(), header.destination);
assert_eq!(slice.options(), &header.options[..]);
}
}
#[cfg(feature = "std")]
proptest! {
#[test]
fn getters_std(header in ipv4_any()) {
use std::net::Ipv4Addr;
let buffer = header.to_bytes();
let slice = Ipv4HeaderSlice::from_slice(&buffer).unwrap();
assert_eq!(slice.source_addr(), Ipv4Addr::from(header.source));
assert_eq!(slice.destination_addr(), Ipv4Addr::from(header.destination));
}
}
#[test]
fn is_fragmenting_payload() {
// not fragmenting
{
let buffer = {
let mut header: Ipv4Header = Default::default();
header.fragment_offset = 0.try_into().unwrap();
header.more_fragments = false;
let mut buffer = Vec::with_capacity(header.header_len());
header.write(&mut buffer).unwrap();
buffer
};
let slice = Ipv4HeaderSlice::from_slice(&buffer).unwrap();
assert_eq!(false, slice.is_fragmenting_payload());
}
// fragmenting based on offset
{
let buffer = {
let mut header: Ipv4Header = Default::default();
header.fragment_offset = 1.try_into().unwrap();
header.more_fragments = false;
let mut buffer = Vec::with_capacity(header.header_len());
header.write(&mut buffer).unwrap();
buffer
};
let slice = Ipv4HeaderSlice::from_slice(&buffer).unwrap();
assert!(slice.is_fragmenting_payload());
}
// fragmenting based on more_fragments
{
let buffer = {
let mut header: Ipv4Header = Default::default();
header.fragment_offset = 0.try_into().unwrap();
header.more_fragments = true;
let mut buffer = Vec::with_capacity(header.header_len());
header.write(&mut buffer).unwrap();
buffer
};
let slice = Ipv4HeaderSlice::from_slice(&buffer).unwrap();
assert!(slice.is_fragmenting_payload());
}
}
proptest! {
#[test]
fn to_header(header in ipv4_any()) {
let buffer = header.to_bytes();
let slice = Ipv4HeaderSlice::from_slice(&buffer).unwrap();
assert_eq!(slice.to_header(), header);
}
}
}