crafter 0.3.1

Packet-level network interaction for Rust tools and agents.
Documentation 
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

//! IPv4 fragmentation metadata and helpers.

use crate::error::{CrafterError, Result};

use super::constants::{
    IPV4_FLAG_DONT_FRAGMENT, IPV4_FLAG_MORE_FRAGMENTS, IPV4_FLAG_RESERVED, IPV4_MAX_FLAGS,
    IPV4_MAX_FRAGMENT_OFFSET,
};

/// Snapshot of IPv4 fragmentation-related header fields.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct Ipv4FragmentInfo {
    identification: u16,
    flags: u8,
    fragment_offset: u16,
}

impl Ipv4FragmentInfo {
    pub(super) const fn new(identification: u16, flags: u8, fragment_offset: u16) -> Self {
        Self {
            identification,
            flags,
            fragment_offset,
        }
    }

    /// Identification field carried by the IPv4 header.
    pub const fn identification(self) -> u16 {
        self.identification
    }

    /// Raw three-bit IPv4 flags field.
    pub const fn flags(self) -> u8 {
        self.flags
    }

    /// Return true when the reserved IPv4 flag bit is set.
    pub const fn is_reserved_flag_set(self) -> bool {
        self.flags & IPV4_FLAG_RESERVED != 0
    }

    /// Return true when the "don't fragment" flag is set.
    pub const fn is_dont_fragment(self) -> bool {
        self.flags & IPV4_FLAG_DONT_FRAGMENT != 0
    }

    /// Return true when the "more fragments" flag is set.
    pub const fn has_more_fragments(self) -> bool {
        self.flags & IPV4_FLAG_MORE_FRAGMENTS != 0
    }

    /// Fragment offset in 8-byte units.
    pub const fn fragment_offset(self) -> u16 {
        self.fragment_offset
    }

    /// Return true when this header marks a fragmented datagram.
    pub const fn is_fragmented(self) -> bool {
        self.has_more_fragments() || self.fragment_offset != 0
    }
}

pub(super) const fn compose_flags_fragment(flags: u8, fragment_offset: u16) -> u16 {
    ((flags as u16) << 13) | fragment_offset
}

pub(super) const fn flags_from_flags_fragment(flags_fragment: u16) -> u8 {
    (flags_fragment >> 13) as u8
}

pub(super) const fn fragment_offset_from_flags_fragment(flags_fragment: u16) -> u16 {
    flags_fragment & IPV4_MAX_FRAGMENT_OFFSET
}

pub(super) fn validate_fragment_fields(flags: u8, fragment_offset: u16) -> Result<()> {
    if flags > IPV4_MAX_FLAGS {
        return Err(CrafterError::invalid_field_value(
            "ipv4.flags",
            "IPv4 flags must fit in three bits",
        ));
    }
    if fragment_offset > IPV4_MAX_FRAGMENT_OFFSET {
        return Err(CrafterError::invalid_field_value(
            "ipv4.fragment_offset",
            "fragment offset must fit in 13 bits",
        ));
    }
    Ok(())
}

pub(super) fn flags_summary(flags: u8) -> String {
    let mut names = Vec::new();
    if flags & IPV4_FLAG_RESERVED != 0 {
        names.push("reserved");
    }
    if flags & IPV4_FLAG_DONT_FRAGMENT != 0 {
        names.push("DF");
    }
    if flags & IPV4_FLAG_MORE_FRAGMENTS != 0 {
        names.push("MF");
    }
    if names.is_empty() {
        "none".to_string()
    } else {
        names.join("|")
    }
}