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
#[macro_use]
extern crate nom;

mod formaters;
mod templates;

use serde::Serialize;
use std::collections::HashMap;

#[derive(Debug)]
struct NetflowHeader {
    version: u16,
    count: u16,
    sys_uptime: u32,
    timestamp: u32,
    sequence: u32,
    source_id: u32,
}

#[derive(Debug, Clone, Copy, Serialize)]
struct TypeLenHeader {
    flowset_id: u16,
    length: u16,
}

#[derive(Debug, Clone)]
struct TemplateHeader {
    template_id: u16,
    field_count: u16,
}

#[derive(Debug, Clone)]
struct TemplateField {
    field: u16,
    len: u16,
}

#[derive(Debug, Clone)]
struct TemplateFlowset {
    tl_header: TypeLenHeader,
    template_header: TemplateHeader,
    payload: Vec<TemplateField>,
}

#[derive(Debug, Clone)]
struct OptionTemplateHeader {
    template_id: u16,
    scope_len: u16,
    option_len: u16,
}

#[derive(Debug, Clone)]
struct OptionTemplate {
    tl_header: TypeLenHeader,
    options_template_header: OptionTemplateHeader,
    payload: Vec<TemplateField>,
}

#[derive(Debug, Clone, Serialize)]
pub struct DataFlowset<'a> {
    source_ip: Option<&'a std::net::IpAddr>,
    #[serde(rename = "header")]
    tl_header: TypeLenHeader,
    #[serde(with = "resolve_hashmap")]
    records: HashMap<u16, &'a [u8]>,
}

mod resolve_hashmap {
    use crate::templates::TemplateFieldType;
    use serde::ser::{self, SerializeMap};
    use std::collections::HashMap;

    pub fn serialize<'a, S>(
        hash_map: &HashMap<u16, &'a [u8]>,
        serializer: S,
    ) -> Result<S::Ok, S::Error>
    where
        S: ser::Serializer,
    {
        let mut map = serializer.serialize_map(Some(hash_map.len()))?;
        for (k, v) in hash_map {
            let record = TemplateFieldType::from(*k);
            let parser = record.get_parser();
            let p = parser(v);
            map.serialize_entry(&record.to_string(), &p)?;
        }
        map.end()
    }
}

impl<'a> DataFlowset<'a> {
    pub fn to_json(&self) -> String {
        serde_json::to_string(&self).unwrap()
    }

    fn set_source_ip(&mut self, addr: &'a std::net::IpAddr) {
        self.source_ip = Some(addr)
    }
}

#[derive(Clone)]
pub struct Parser {
    template_cache: HashMap<u16, TemplateFlowset>,
    options_cache: HashMap<u16, OptionTemplate>,
}

impl Parser {
    pub fn new() -> Self {
        Parser {
            template_cache: HashMap::new(),
            options_cache: HashMap::new(),
        }
    }

    pub fn parse_netflow_packet<'a, 'b>(
        &'a mut self,
        packet: &'b [u8],
        addr: &'b std::net::IpAddr,
    ) -> Result<Vec<DataFlowset<'b>>, &'static str> {
        //20 bytes Netflow packet header
        let mut data = packet;

        if let Ok((buffer, header)) = parse_netflow_header(data) {
            match header.version {
                9 => {}
                _ => return Err("Unrecognized version"),
            }

            data = buffer;

            let mut flowset_count = header.count;
            let mut data_flowsets = Vec::<DataFlowset>::new();
            loop {
                if let Ok((buffer, tl_header)) = parse_tl_header(data) {
                    data = buffer;

                    match tl_header.flowset_id {
                        // We have a template
                        0 => {
                            if let Ok((buffer, template_flowset)) =
                                parse_template(data, tl_header)
                            {
                                data = buffer;
                                self.template_cache.insert(
                                    template_flowset
                                        .template_header
                                        .template_id,
                                    template_flowset,
                                );
                            } else {
                                return Err("Failed to parse the template");
                            }
                        }

                        // Option template
                        1 => {
                            if let Ok((buffer, template_flowset)) =
                                parse_options_template(data, tl_header)
                            {
                                data = buffer;
                                self.options_cache.insert(
                                    template_flowset
                                        .options_template_header
                                        .template_id,
                                    template_flowset,
                                );
                            } else {
                                return Err(
                                    "Failed to parse the options template",
                                );
                            }
                        }

                        // A dataset
                        _ => {
                            if tl_header.flowset_id < 255 {
                                return Err("Flowset ID out of range");
                            }
                            // Get the template fromthe cache
                            if self
                                .template_cache
                                .contains_key(&tl_header.flowset_id)
                            {
                                let template = {
                                    self.template_cache
                                        .get(&tl_header.flowset_id)
                                        .unwrap()
                                };
                                if let Ok((buffer, flowsets)) =
                                    parse_dataset(data, tl_header, &template)
                                {
                                    data = buffer;
                                    for mut f in flowsets {
                                        f.set_source_ip(addr);
                                        data_flowsets.push(f);
                                    }
                                } else {
                                    return Err("Failed to parse the dataset");
                                }
                            } else if self
                                .options_cache
                                .contains_key(&tl_header.flowset_id)
                            {
                                data = &data[(tl_header.length - 4) as usize..];
                            } else {
                                data = &data[(tl_header.length - 4) as usize..];
                            }
                        }
                    }
                }
                // we failed to parse it so just try another one
                flowset_count -= 1;

                if flowset_count == 0 {
                    return Ok(data_flowsets);
                }
            }
        }
        Err("Failed to parse header")
    }
}

named!(parse_netflow_header<&[u8], NetflowHeader>, do_parse!(
    version_and_count: bits!(tuple!(take_bits!(16u16), take_bits!(16u16))) >>
        uptime: bits!(take_bits!(32u32)) >>
        timestamp: bits!(take_bits!(32u32)) >>
        seq: bits!(take_bits!(32u32)) >>
        source_id: bits!(take_bits!(32u32)) >>
        (NetflowHeader {
            version: version_and_count.0,
            count: version_and_count.1,
            sys_uptime: uptime,
            timestamp: timestamp,
            sequence: seq,
            source_id: source_id
        })
));

named!(parse_tl_header<&[u8], TypeLenHeader>, do_parse!(
    flowset_id: bits!(take_bits!(16u16)) >>
        length: bits!(take_bits!(16u16)) >>
        (TypeLenHeader {
            flowset_id: flowset_id,
            length: length
        })
));

named!(parse_template_header<&[u8], TemplateHeader>, do_parse!(
    template_id: bits!(take_bits!(16u16)) >>
       field_count: bits!(take_bits!(16u16)) >>
        (TemplateHeader {
            template_id: template_id,
            field_count: field_count
        })
));

named!(parse_template_fields<&[u8], TemplateField>, do_parse!(
    field: bits!(take_bits!(16u16)) >>
        len: bits!(take_bits!(16u16)) >>
        (TemplateField {
            field: field,
            len: len
        })
));

named!(parse_option_template_header<&[u8], OptionTemplateHeader>, do_parse!(
    template_id: bits!(take_bits!(16u16)) >>
        scope_len: bits!(take_bits!(16u16)) >>
        option_len: bits!(take_bits!(16u16)) >>
        (OptionTemplateHeader {
            template_id: template_id,
            scope_len: scope_len,
            option_len: option_len
        })
));

fn parse_template<'a>(
    mut buffer: &'a [u8],
    tl_header: TypeLenHeader,
) -> nom::IResult<&'a [u8], TemplateFlowset, ()> {
    // Adjust for TypeLenHeader size already parsed
    let mut byte_count = tl_header.length as usize - 4;
    // Keep parsed templates fields locally
    let mut template_fields: Vec<TemplateField> = Vec::new();

    if let Ok((bytes, template_header)) = parse_template_header(buffer) {
        // Keep a track of bytes to parse but the
        // "field_count" should be enough to parse it correctly
        byte_count -= buffer.len() - bytes.len();
        // Ensure the correct buffer is parsed
        buffer = bytes;
        let field_count = template_header.field_count;

        for _ in 0..field_count {
            if let Ok((bytes, template_field)) = parse_template_fields(buffer) {
                byte_count -= buffer.len() - bytes.len();
                buffer = bytes;
                template_fields.push(template_field);
            } else {
                return Err(nom::Err::Failure(()));
            }
        }
        if byte_count == 0 {
            // Looks like we parsed all fields so add the template if we dont have it already
            return Ok((
                buffer,
                TemplateFlowset {
                    tl_header,
                    template_header,
                    payload: template_fields,
                },
            ));
        }
    }
    Err(nom::Err::Error(()))
}

fn parse_options_template<'a>(
    mut buffer: &'a [u8],
    tl_header: TypeLenHeader,
) -> nom::IResult<&'a [u8], OptionTemplate, ()> {
    let mut template_fields: Vec<TemplateField> = Vec::new();
    let mut byte_count = 4; //Adjust for header length
    if let Ok((bytes, template_header)) = parse_option_template_header(buffer) {
        byte_count += buffer.len() - bytes.len();
        // Ensure the correct buffer is parsed
        buffer = bytes;

        // Parse first the scope fields
        let scope_len = template_header.scope_len / 4; // len is in bytes we're parsing 2 x u16
        for _ in 0..scope_len {
            if let Ok((bytes, template_field)) = parse_template_fields(buffer) {
                byte_count += buffer.len() - bytes.len();
                buffer = bytes;
                template_fields.push(template_field);
            } else {
                return Err(nom::Err::Failure(()));
            }
        }

        // ...then the option fields
        let option_len = template_header.option_len / 4;
        for _ in 0..option_len {
            if let Ok((bytes, template_field)) = parse_template_fields(buffer) {
                byte_count += buffer.len() - bytes.len();
                buffer = bytes;
                template_fields.push(template_field);
            } else {
                return Err(nom::Err::Failure(()));
            }
        }

        // Adjust for any remaining padding
        return Ok((
            &buffer[tl_header.length as usize - byte_count..],
            OptionTemplate {
                tl_header,
                options_template_header: template_header,
                payload: template_fields,
            },
        ));
    }
    Err(nom::Err::Error(()))
}

fn parse_dataset<'a>(
    buffer: &'a [u8],
    tl_header: TypeLenHeader,
    template: &TemplateFlowset,
) -> nom::IResult<&'a [u8], Vec<DataFlowset<'a>>, ()> {
    let mut dataflows = Vec::new();
    let mut idx: usize = 0;
    let fields = &template.payload;
    let length = tl_header.length as usize - 4;
    while idx < length {
        let mut records = HashMap::new();
        for f in fields {
            let value = &buffer[idx..idx + f.len as usize];
            records.insert(f.field, value);
            idx += f.len as usize;
        }
        dataflows.push(DataFlowset {
            source_ip: None,
            tl_header,
            records,
        })
    }
    // Adjust for possible remaining padding
    Ok((&buffer[length..], dataflows))
}