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 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
use crate::{err::ValueTooBigError, *};
use arrayvec::ArrayVec;
/// The statically sized data at the start of an ICMPv6 packet (at least the first 8 bytes of an ICMPv6 packet).
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct Icmpv6Header {
/// Type & type specific values & code.
pub icmp_type: Icmpv6Type,
/// Checksum in the ICMPv6 header.
pub checksum: u16,
}
impl Icmpv6Header {
/// Minimum number of bytes an ICMP header needs to have.
///
/// Note that minimum size can be larger depending on
/// the type and code.
pub const MIN_LEN: usize = 8;
/// Deprecated, use [`Icmpv6Header::MIN_LEN`] instead.
#[deprecated(since = "0.14.0", note = "Please use Icmpv6Header::MIN_LEN instead")]
pub const MIN_SERIALIZED_SIZE: usize = Icmpv6Header::MIN_LEN;
/// Maximum number of bytes/octets an Icmpv6Header takes up
/// in serialized form.
///
/// Currently this number is determined by the biggest
/// planned ICMPv6 header type, which is currently the
/// "Neighbor Discovery Protocol" "Redirect" message.
pub const MAX_LEN: usize = 8 + 16 + 16;
/// Deprecated, use [`Icmpv6Header::MAX_LEN`] instead.
#[deprecated(since = "0.14.0", note = "Please use Icmpv6Header::MAX_LEN instead")]
pub const MAX_SERIALIZED_SIZE: usize = Icmpv6Header::MAX_LEN;
/// Setups a new header with the checksum being set to 0.
#[inline]
pub fn new(icmp_type: Icmpv6Type) -> Icmpv6Header {
Icmpv6Header {
icmp_type,
checksum: 0, // will be filled in later
}
}
/// Creates a [`Icmpv6Header`] with a checksum calculated based
/// on the given payload & ip addresses from the IPv6 header.
pub fn with_checksum(
icmp_type: Icmpv6Type,
source_ip: [u8; 16],
destination_ip: [u8; 16],
payload: &[u8],
) -> Result<Icmpv6Header, ValueTooBigError<usize>> {
let checksum = icmp_type.calc_checksum(source_ip, destination_ip, payload)?;
Ok(Icmpv6Header {
icmp_type,
checksum,
})
}
/// Reads an icmp6 header from a slice directly and returns a tuple
/// containing the resulting header & unused part of the slice.
#[inline]
pub fn from_slice(slice: &[u8]) -> Result<(Icmpv6Header, &[u8]), err::LenError> {
let header = Icmpv6Slice::from_slice(slice)?.header();
let len = header.header_len();
Ok((header, &slice[len..]))
}
/// Read a ICMPv6 header from the given reader
#[cfg(feature = "std")]
#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
pub fn read<T: std::io::Read + Sized>(reader: &mut T) -> Result<Icmpv6Header, std::io::Error> {
// read the initial 8 bytes
let mut start = [0u8; 8];
reader.read_exact(&mut start)?;
Ok(Icmpv6Slice { slice: &start }.header())
}
/// Write the ICMPv6 header to the given writer.
#[cfg(feature = "std")]
#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
pub fn write<T: std::io::Write + Sized>(&self, writer: &mut T) -> Result<(), std::io::Error> {
writer.write_all(&self.to_bytes())
}
/// Serialized length of the header in bytes/octets.
///
/// Note that this size is not the size of the entire
/// ICMPv6 packet but only the header.
#[inline]
pub fn header_len(&self) -> usize {
self.icmp_type.header_len()
}
/// If the ICMP type has a fixed size returns the number of
/// bytes that should be present after the header of this type.
#[inline]
pub fn fixed_payload_size(&self) -> Option<usize> {
self.icmp_type.fixed_payload_size()
}
/// Updates the checksum of the header.
pub fn update_checksum(
&mut self,
source_ip: [u8; 16],
destination_ip: [u8; 16],
payload: &[u8],
) -> Result<(), ValueTooBigError<usize>> {
self.checksum = self
.icmp_type
.calc_checksum(source_ip, destination_ip, payload)?;
Ok(())
}
/// Returns the header on the wire bytes.
#[inline]
pub fn to_bytes(&self) -> ArrayVec<u8, { Icmpv6Header::MAX_LEN }> {
let checksum_be = self.checksum.to_be_bytes();
let return_trivial =
|type_u8: u8, code_u8: u8| -> ArrayVec<u8, { Icmpv6Header::MAX_LEN }> {
#[rustfmt::skip]
let mut re = ArrayVec::from([
type_u8, code_u8, checksum_be[0], checksum_be[1],
0, 0, 0, 0,
0, 0, 0, 0,
0, 0, 0, 0,
0, 0, 0, 0,
0, 0, 0, 0,
0, 0, 0, 0,
0, 0, 0, 0,
0, 0, 0, 0,
0, 0, 0, 0,
]);
// SAFETY: Safe as u8 has no destruction behavior and as 8 is smaller then 20.
unsafe {
re.set_len(8);
}
re
};
let return_4u8 = |type_u8: u8,
code_u8: u8,
bytes5to8: [u8; 4]|
-> ArrayVec<u8, { Icmpv6Header::MAX_LEN }> {
#[rustfmt::skip]
let mut re = ArrayVec::from([
type_u8, code_u8, checksum_be[0], checksum_be[1],
bytes5to8[0], bytes5to8[1], bytes5to8[2], bytes5to8[3],
0, 0, 0, 0,
0, 0, 0, 0,
0, 0, 0, 0,
0, 0, 0, 0,
0, 0, 0, 0,
0, 0, 0, 0,
0, 0, 0, 0,
0, 0, 0, 0,
]);
// SAFETY: Safe as u8 has no destruction behavior and as 8 is smaller then 20.
unsafe {
re.set_len(8);
}
re
};
use crate::{icmpv6::*, Icmpv6Type::*};
match self.icmp_type {
Unknown {
type_u8,
code_u8,
bytes5to8,
} => return_4u8(type_u8, code_u8, bytes5to8),
DestinationUnreachable(header) => return_trivial(TYPE_DST_UNREACH, header.code_u8()),
PacketTooBig { mtu } => return_4u8(TYPE_PACKET_TOO_BIG, 0, mtu.to_be_bytes()),
TimeExceeded(code) => return_trivial(TYPE_TIME_EXCEEDED, code.code_u8()),
ParameterProblem(header) => return_4u8(
TYPE_PARAMETER_PROBLEM,
header.code.code_u8(),
header.pointer.to_be_bytes(),
),
EchoRequest(echo) => return_4u8(TYPE_ECHO_REQUEST, 0, echo.to_bytes()),
EchoReply(echo) => return_4u8(TYPE_ECHO_REPLY, 0, echo.to_bytes()),
}
}
}
#[cfg(test)]
mod test {
use crate::{
err::{ValueTooBigError, ValueType},
icmpv6::*,
test_gens::*,
*,
};
use alloc::{format, vec::Vec};
use arrayvec::ArrayVec;
use proptest::prelude::*;
proptest! {
#[test]
fn new(icmp_type in icmpv6_type_any()) {
assert_eq!(
Icmpv6Header::new(icmp_type.clone()),
Icmpv6Header {
icmp_type,
checksum: 0,
}
);
}
}
proptest! {
#[cfg(not(any(target_pointer_width = "16", target_pointer_width = "32")))]
#[test]
fn with_checksum(
ip_header in ipv6_any(),
icmp_type in icmpv6_type_any(),
// max length is u32::MAX - header_len (7)
bad_len in (core::u32::MAX - 7) as usize..=(core::isize::MAX as usize),
payload in proptest::collection::vec(any::<u8>(), 0..1024)
) {
// error case
{
// SAFETY: In case the error is not triggered
// a segmentation fault will be triggered.
let too_big_slice = unsafe {
//NOTE: The pointer must be initialized with a non null value
// otherwise a key constraint of slices is not fulfilled
// which can lead to crashes in release mode.
use core::ptr::NonNull;
core::slice::from_raw_parts(
NonNull::<u8>::dangling().as_ptr(),
bad_len
)
};
assert_eq!(
Icmpv6Header::with_checksum(icmp_type.clone(), ip_header.source, ip_header.destination, too_big_slice),
Err(ValueTooBigError{
actual: bad_len,
max_allowed: (core::u32::MAX - 8) as usize,
value_type: ValueType::Icmpv6PayloadLength,
})
);
}
// non error case
assert_eq!(
Icmpv6Header::with_checksum(icmp_type.clone(), ip_header.source, ip_header.destination, &payload).unwrap(),
Icmpv6Header {
icmp_type,
checksum: icmp_type.calc_checksum(ip_header.source, ip_header.destination, &payload).unwrap(),
}
);
}
}
proptest! {
#[test]
fn from_slice(
icmp_type in icmpv6_type_any(),
checksum in any::<u16>(),
) {
let bytes = {
Icmpv6Header {
icmp_type: icmp_type.clone(),
checksum,
}.to_bytes()
};
// ok case
{
let result = Icmpv6Header::from_slice(&bytes).unwrap();
assert_eq!(
Icmpv6Header{
icmp_type,
checksum,
},
result.0,
);
assert_eq!(&bytes[8..], result.1);
}
// size error case
for length in 0..8 {
assert_eq!(
Icmpv6Header::from_slice(&bytes[..length]).unwrap_err(),
err::LenError{
required_len: bytes.len(),
len: length,
len_source: LenSource::Slice,
layer: err::Layer::Icmpv6,
layer_start_offset: 0
}
);
}
}
}
proptest! {
#[test]
fn read(
icmp_type in icmpv6_type_any(),
checksum in any::<u16>(),
) {
let header = Icmpv6Header {
icmp_type: icmp_type.clone(),
checksum,
};
let bytes = header.to_bytes();
// ok case
{
let mut cursor = std::io::Cursor::new(&bytes);
let result = Icmpv6Header::read(&mut cursor).unwrap();
assert_eq!(header, result,);
assert_eq!(header.header_len() as u64, cursor.position());
}
// size error case
for length in 0..header.header_len() {
let mut cursor = std::io::Cursor::new(&bytes[..length]);
assert!(Icmpv6Header::read(&mut cursor).is_err());
}
}
}
proptest! {
#[test]
fn write(
icmp_type in icmpv6_type_any(),
checksum in any::<u16>(),
bad_len in 0..8usize
) {
// normal case
{
let mut buffer = Vec::with_capacity(icmp_type.header_len());
let header = Icmpv6Header {
icmp_type,
checksum,
};
header.write(&mut buffer).unwrap();
assert_eq!(
&header.to_bytes(),
&buffer[..]
);
}
// error case
{
let mut buffer = [0u8;Icmpv6Header::MAX_LEN];
let mut writer = std::io::Cursor::new(&mut buffer[..bad_len]);
Icmpv6Header {
icmp_type,
checksum,
}.write(&mut writer).unwrap_err();
}
}
}
proptest! {
#[test]
fn header_len(icmp_type in icmpv6_type_any(), checksum in any::<u16>()) {
assert_eq!(
icmp_type.header_len(),
Icmpv6Header{
icmp_type,
checksum
}.header_len()
);
}
}
proptest! {
#[test]
fn fixed_payload_size(icmp_type in icmpv6_type_any(), checksum in any::<u16>()) {
assert_eq!(
icmp_type.fixed_payload_size(),
Icmpv6Header{
icmp_type,
checksum
}.fixed_payload_size()
);
}
}
proptest! {
#[test]
#[cfg(not(any(target_pointer_width = "16", target_pointer_width = "32")))]
fn update_checksum(
ip_header in ipv6_any(),
icmp_type in icmpv6_type_any(),
start_checksum in any::<u16>(),
// max length is u32::MAX - header_len (7)
bad_len in (core::u32::MAX - 7) as usize..=(core::isize::MAX as usize),
payload in proptest::collection::vec(any::<u8>(), 0..1024)
) {
// error case
{
// SAFETY: In case the error is not triggered
// a segmentation fault will be triggered.
let too_big_slice = unsafe {
//NOTE: The pointer must be initialized with a non null value
// otherwise a key constraint of slices is not fulfilled
// which can lead to crashes in release mode.
use core::ptr::NonNull;
core::slice::from_raw_parts(
NonNull::<u8>::dangling().as_ptr(),
bad_len
)
};
assert_eq!(
Icmpv6Header{
icmp_type,
checksum: 0
}.update_checksum(ip_header.source, ip_header.destination, too_big_slice),
Err(ValueTooBigError{
actual: bad_len,
max_allowed: (u32::MAX - 8) as usize,
value_type: ValueType::Icmpv6PayloadLength
})
);
}
// normal case
assert_eq!(
{
let mut header = Icmpv6Header{
icmp_type,
checksum: start_checksum,
};
header.update_checksum(ip_header.source, ip_header.destination, &payload).unwrap();
header
},
Icmpv6Header{
icmp_type,
checksum: icmp_type.calc_checksum(ip_header.source, ip_header.destination, &payload).unwrap(),
}
);
}
}
proptest! {
#[test]
fn to_bytes(
checksum in any::<u16>(),
rand_u32 in any::<u32>(),
rand_4bytes in any::<[u8;4]>(),
) {
use Icmpv6Type::*;
let with_5to8_bytes = |type_u8: u8, code_u8: u8, bytes5to8: [u8;4]| -> ArrayVec<u8, { Icmpv6Header::MAX_LEN }> {
let mut bytes = ArrayVec::<u8, { Icmpv6Header::MAX_LEN }>::new();
bytes.push(type_u8);
bytes.push(code_u8);
bytes.try_extend_from_slice(&checksum.to_be_bytes()).unwrap();
bytes.try_extend_from_slice(&bytes5to8).unwrap();
bytes
};
let simple_bytes = |type_u8: u8, code_u8: u8| -> ArrayVec<u8, { Icmpv6Header::MAX_LEN }> {
with_5to8_bytes(type_u8, code_u8, [0;4])
};
// destination unreachable
for (code, code_u8) in dest_unreachable_code_test_consts::VALID_VALUES {
assert_eq!(
Icmpv6Header{
icmp_type: DestinationUnreachable(code),
checksum
}.to_bytes(),
simple_bytes(TYPE_DST_UNREACH, code_u8)
);
}
// packet too big
assert_eq!(
Icmpv6Header{
icmp_type: PacketTooBig{ mtu: rand_u32 },
checksum
}.to_bytes(),
with_5to8_bytes(TYPE_PACKET_TOO_BIG, 0, rand_u32.to_be_bytes())
);
// time exceeded
for (code, code_u8) in time_exceeded_code_test_consts::VALID_VALUES {
assert_eq!(
Icmpv6Header{
icmp_type: TimeExceeded(code),
checksum
}.to_bytes(),
simple_bytes(TYPE_TIME_EXCEEDED, code_u8)
);
}
// parameter problem
for (code, code_u8) in parameter_problem_code_test_consts::VALID_VALUES {
assert_eq!(
Icmpv6Header{
icmp_type: ParameterProblem(
ParameterProblemHeader{
code,
pointer: rand_u32,
}
),
checksum
}.to_bytes(),
with_5to8_bytes(TYPE_PARAMETER_PROBLEM, code_u8, rand_u32.to_be_bytes())
);
}
// echo request
assert_eq!(
Icmpv6Header{
icmp_type: EchoRequest(IcmpEchoHeader {
id: u16::from_be_bytes([rand_4bytes[0], rand_4bytes[1]]),
seq: u16::from_be_bytes([rand_4bytes[2], rand_4bytes[3]]),
}),
checksum
}.to_bytes(),
with_5to8_bytes(TYPE_ECHO_REQUEST, 0, rand_4bytes)
);
// echo reply
assert_eq!(
Icmpv6Header{
icmp_type: EchoReply(IcmpEchoHeader {
id: u16::from_be_bytes([rand_4bytes[0], rand_4bytes[1]]),
seq: u16::from_be_bytes([rand_4bytes[2], rand_4bytes[3]]),
}),
checksum
}.to_bytes(),
with_5to8_bytes(TYPE_ECHO_REPLY, 0, rand_4bytes)
);
// unknown
for type_u8 in 0..=u8::MAX {
for code_u8 in 0..=u8::MAX {
assert_eq!(
Icmpv6Header{
icmp_type: Unknown {
type_u8,
code_u8,
bytes5to8: rand_4bytes,
},
checksum
}.to_bytes(),
with_5to8_bytes(type_u8, code_u8, rand_4bytes)
);
}
}
}
}
#[test]
fn debug() {
let t = Icmpv6Type::Unknown {
type_u8: 0,
code_u8: 1,
bytes5to8: [2, 3, 4, 5],
};
assert_eq!(
format!(
"{:?}",
Icmpv6Header {
icmp_type: t.clone(),
checksum: 7
}
),
format!("Icmpv6Header {{ icmp_type: {:?}, checksum: {:?} }}", t, 7)
);
}
proptest! {
#[test]
fn clone_eq(icmp_type in icmpv6_type_any(), checksum in any::<u16>()) {
let header = Icmpv6Header{ icmp_type, checksum };
assert_eq!(header, header.clone());
}
}
}