net-parser-rs 0.3.0

Basic network parser leveraging Rust and nom for safe and efficient packet parsing. Design influenced by pktparse-rs.
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
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

use crate::flow::Flow;
use crate::flow::errors::Error;
use crate::flow::info::layer2::{Id, Info};
use crate::flow::layer2::FlowExtraction;
use crate::flow::layer2::errors::{Error as L2Error};
use crate::flow::layer3::{FlowExtraction as Layer3Extraction};
use crate::layer2::ethernet::{Ethernet, EthernetTypeId, Layer3Id};
use crate::layer3::{IPv4, IPv6, Arp};

use log::*;

pub mod errors {
    use crate::layer2::ethernet::EthernetTypeId;
    use crate::errors::Error as NetParserError;
    use thiserror::{Error as ThisError};

    #[derive(Debug, ThisError)]
    pub enum Error {
        #[error("Failed parse of {:?}: {}", l3, err)]
        NetParser {
            l3: EthernetTypeId,
            err: NetParserError
        },
        #[error("Incomplete parse of {:?}: {}", l3, size)]
        Incomplete {
            l3: EthernetTypeId,
            size: usize
        },
        #[error("Unknown Ethernet Type: {:?}", etype)]
        EthernetType {
            etype: EthernetTypeId
        },
    }

    unsafe impl Sync for Error {}
    unsafe impl Send for Error {}
}

impl<'a> FlowExtraction for Ethernet<'a> {
    fn extract_flow(&self) -> Result<Flow, Error> {
        let l2 = Info {
            id: Id::Ethernet,
            src_mac: self.src_mac.clone(),
            dst_mac: self.dst_mac.clone(),
            vlan: self.vlan(),
        };

        let ether_type = self.ether_type.clone();
        debug!(
            "Creating from layer 3 type {:?} using payload of {}B",
            ether_type,
            self.payload.len()
        );

        match ether_type {
            EthernetTypeId::L3(Layer3Id::IPv4) => {
                IPv4::parse(&self.payload)
                    .map_err(|e| {
                        error!("Error parsing ipv4 {:?}", e);
                        let e: L2Error = errors::Error::NetParser {
                            l3: ether_type.clone(),
                            err: e
                        }.into();
                        e.into()
                    })
                    .and_then(|r| {
                        let (rem, l3) = r;
                        if rem.is_empty() {
                            l3.extract_flow(l2)
                        } else {
                            let e: L2Error = errors::Error::Incomplete {
                                l3: ether_type.clone(),
                                size: rem.len()
                            }.into();
                            Err(e.into())
                        }
                    })
            }
            EthernetTypeId::L3(Layer3Id::IPv6) => {
                IPv6::parse(&self.payload)
                    .map_err(|e| {
                        error!("Error parsing ipv6 {:?}", e);
                        let e: L2Error = errors::Error::NetParser {
                            l3: ether_type.clone(),
                            err: e
                        }.into();
                        e.into()
                    })
                    .and_then(|r| {
                        let (rem, l3) = r;
                        if rem.is_empty() {
                            l3.extract_flow(l2)
                        } else {
                            let e: L2Error = errors::Error::Incomplete {
                                l3: ether_type.clone(),
                                size: rem.len()
                            }.into();
                            Err(e.into())
                        }
                    })
            }
            EthernetTypeId::L3(Layer3Id::Arp) => {
                Arp::parse(&self.payload)
                    .map_err(|e| {
                        error!("Error parsing arp {:?}", e);
                        let e: L2Error = errors::Error::NetParser {
                            l3: ether_type.clone(),
                            err: e
                        }.into();
                        e.into()
                    })
                    .and_then(|r| {
                        let (rem, l3) = r;
                        if rem.is_empty() {
                            l3.extract_flow(l2)
                        } else {
                            let e: L2Error = errors::Error::Incomplete {
                                l3: ether_type.clone(),
                                size: rem.len()
                            }.into();
                            Err(e.into())
                        }
                    })
            }
            _ => {
                let e: L2Error = errors::Error::EthernetType {
                    etype: ether_type
                }.into();
                Err(e.into())
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    use crate::flow::info::layer2::{Id as L2Id};
    use crate::layer2::ethernet::Ethernet;
    use crate::layer2::ethernet::tests::TCP_RAW_DATA;

    #[test]
    fn convert_ethernet_tcp() {
        let _ = env_logger::try_init();

        let (rem, l2) = Ethernet::parse(TCP_RAW_DATA).expect("Could not parse");

        assert!(rem.is_empty());

        let info = l2.extract_flow().expect("Could not convert to layer 2 stream info");

        assert_eq!(info.layer2, L2Id::Ethernet);
        assert_eq!(info.source.port, 50871);
        assert_eq!(info.destination.port, 80);
    }
}