pistol 4.0.18

A Rust Library about Cybersecurity
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
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
use pnet::packet::Packet;
use pnet::packet::icmpv6::Icmpv6Packet;
use pnet::packet::ipv6::Ipv6Packet;
use pnet::packet::tcp::TcpOptionNumbers;
use pnet::packet::tcp::TcpPacket;
use std::iter::zip;
use tracing::debug;
use tracing::warn;

use crate::error::PistolError;
use crate::os::rr::AllPacketRR6;
use crate::utils::PistolHex;

const CWR_MASK: u8 = 0b10000000;
const ECE_MASK: u8 = 0b01000000;
const URG_MASK: u8 = 0b00100000;
const ACK_MASK: u8 = 0b00010000;
const PSH_MASK: u8 = 0b00001000;
const RST_MASK: u8 = 0b00000100;
const SYN_MASK: u8 = 0b00000010;
const FIN_MASK: u8 = 0b00000001;

fn get_response_by_name(ap: &AllPacketRR6, name: &str) -> Vec<u8> {
    match name {
        "S1" => ap.seq.seq1.response.to_vec(),
        "S2" => ap.seq.seq2.response.to_vec(),
        "S3" => ap.seq.seq3.response.to_vec(),
        "S4" => ap.seq.seq4.response.to_vec(),
        "S5" => ap.seq.seq5.response.to_vec(),
        "S6" => ap.seq.seq6.response.to_vec(),
        "IE1" => ap.ie.ie1.response.to_vec(),
        "IE2" => ap.ie.ie2.response.to_vec(),
        "NI" => ap.nx.ni.response.to_vec(),
        "NS" => ap.nx.ns.response.to_vec(),
        "U1" => ap.u1.u1.response.to_vec(),
        "TECN" => ap.tecn.tecn.response.to_vec(),
        "T2" => ap.tx.t2.response.to_vec(),
        "T3" => ap.tx.t3.response.to_vec(),
        "T4" => ap.tx.t4.response.to_vec(),
        "T5" => ap.tx.t5.response.to_vec(),
        "T6" => ap.tx.t6.response.to_vec(),
        "T7" => ap.tx.t7.response.to_vec(),
        _ => vec![],
    }
}

fn build_ipv6_packet<'a>(
    ipv6_buff: &'a [u8],
    probe_name: &str,
) -> Result<Ipv6Packet<'a>, PistolError> {
    // println!("{}", ipv6_buff.len());
    if ipv6_buff.len() > 0 {
        match Ipv6Packet::new(ipv6_buff) {
            Some(p) => return Ok(p),
            None => (),
        }
    }
    Err(PistolError::BuildIpv6PacketFailed {
        probe_name: probe_name.to_string(),
    })
}

fn build_icmpv6_packet<'a>(
    icmpv6_buff: &'a [u8],
    probe_name: &str,
) -> Result<Icmpv6Packet<'a>, PistolError> {
    if icmpv6_buff.len() > 0 {
        match Icmpv6Packet::new(icmpv6_buff) {
            Some(p) => return Ok(p),
            None => (),
        }
    }
    Err(PistolError::BuildIcmpv6PacketFailed {
        probe_name: probe_name.to_string(),
    })
}

fn build_tcp_packet<'a>(
    tcp_buff: &'a [u8],
    probe_name: &str,
) -> Result<TcpPacket<'a>, PistolError> {
    if tcp_buff.len() > 0 {
        match TcpPacket::new(tcp_buff) {
            Some(p) => return Ok(p),
            None => (),
        }
    }
    Err(PistolError::BuildTcpPacketFailed {
        probe_name: probe_name.to_string(),
    })
}

/// IPv6 Payload Length field.
/// IPv6 Traffic Class field.
fn ipv6_plen_tc(ipv6_buff: &[u8], probe_name: &str) -> Result<(f64, f64), PistolError> {
    let (plen, tc) = match build_ipv6_packet(ipv6_buff, probe_name) {
        Ok(ipv6_packet) => (
            ipv6_packet.get_payload_length() as f64,
            ipv6_packet.get_traffic_class() as f64,
        ),
        Err(_) => {
            warn!("plen tc get ipv6 packet failed");
            (-1.0, -1.0)
        }
    };
    Ok((plen, tc))
}

/// Get tcp sequence number.
fn tcp_seq(ipv6_buff: &[u8], probe_name: &str) -> Result<u32, PistolError> {
    let ipv6_packet = build_ipv6_packet(ipv6_buff, probe_name)?;
    let tcp_packet = build_tcp_packet(ipv6_packet.payload(), probe_name)?;
    Ok(tcp_packet.get_sequence())
}

/// TCP ISN counter rate. This is derived from the S1–S6 sequence probes, which are sent 100 ms apart.
/// The differences between consecutive sequence responses are added up, then this sum is divided by the time elapsed between the first and last probe.
fn tcp_isr(ap: &AllPacketRR6) -> Result<f64, PistolError> {
    let mut seq_vec = Vec::new();
    let s1 = tcp_seq(&ap.seq.seq1.response, "seq1")?;
    let s2 = tcp_seq(&ap.seq.seq2.response, "seq2")?;
    let s3 = tcp_seq(&ap.seq.seq3.response, "seq3")?;
    let s4 = tcp_seq(&ap.seq.seq4.response, "seq4")?;
    let s5 = tcp_seq(&ap.seq.seq5.response, "seq5")?;
    let s6 = tcp_seq(&ap.seq.seq6.response, "seq6")?;
    seq_vec.push(s1);
    seq_vec.push(s2);
    seq_vec.push(s3);
    seq_vec.push(s4);
    seq_vec.push(s5);
    seq_vec.push(s6);

    let mut diff = Vec::new();
    if seq_vec.len() >= 2 {
        for i in 0..(seq_vec.len() - 1) {
            let a = seq_vec[i];
            let b = seq_vec[i + 1];
            let x = if a <= b { b - a } else { !(a - b) };
            // println!("{} {} {}", a, b, x);
            diff.push(x);
        }
    }

    let mut sum: u64 = 0; // avoid overflow
    for d in diff {
        sum += d as u64;
    }

    let e = (ap.seq.elapsed / 6.0) * 5.0;
    // println!("sum: {}", sum);
    // println!("e: {}", e);
    Ok(sum as f64 / e as f64)
}

/// A guess at the original value of the IPv6 Hop Limit field.
fn ipv6_hlim(ipv6_response: &[u8], probe_name: &str) -> Result<f64, PistolError> {
    let hlim = match build_ipv6_packet(ipv6_response, probe_name) {
        Ok(ipv6_response_packet) => ipv6_response_packet.get_hop_limit() as f64,
        Err(_) => {
            warn!("ipv6 hlim build ipv6 packet failed");
            0.0
        }
    };

    let er_lim = 5.0;
    let regual_hlim_vec = vec![32.0, 64.0, 128.0, 255.0];
    let mut fin_hlim = 0.0;
    for r in regual_hlim_vec {
        if hlim > r {
            if hlim - r <= er_lim {
                fin_hlim = r;
            }
        } else {
            if r - hlim <= er_lim {
                fin_hlim = r;
            }
        }
    }

    if fin_hlim != 0.0 {
        Ok(fin_hlim)
    } else {
        // default value of machine learning alg
        Ok(-1.0)
    }
}

/// TCP window size.
fn tcp_window(ipv6_buff: &[u8], probe_name: &str) -> Result<f64, PistolError> {
    match build_ipv6_packet(ipv6_buff, probe_name) {
        Ok(ipv6_packet) => {
            let tcp_packet = build_tcp_packet(ipv6_packet.payload(), probe_name)?;
            Ok(tcp_packet.get_window() as f64)
        }
        Err(_) => {
            warn!("tcp windows build ipv6 packet failed");
            Ok(-1.0)
        }
    }
}

/// TCP flags. Each flag becomes a feature with the value 0 or 1.
/// TCP_FLAG_F, TCP_FLAG_S, TCP_FLAG_R, TCP_FLAG_P, TCP_FLAG_A, TCP_FLAG_U, TCP_FLAG_E, TCP_FLAG_C.
fn tcp_flags(ipv6_buff: &[u8], probe_name: &str) -> Result<Vec<f64>, PistolError> {
    match build_ipv6_packet(ipv6_buff, probe_name) {
        Ok(ipv6_packet) => {
            let tcp_packet = build_tcp_packet(ipv6_packet.payload(), probe_name)?;
            let flags = tcp_packet.get_flags();
            let cwr = ((flags & CWR_MASK) >> 7) as f64;
            let ece = ((flags & ECE_MASK) >> 6) as f64;
            let urg = ((flags & URG_MASK) >> 5) as f64;
            let ack = ((flags & ACK_MASK) >> 4) as f64;
            let psh = ((flags & PSH_MASK) >> 3) as f64;
            let rst = ((flags & RST_MASK) >> 2) as f64;
            let syn = ((flags & SYN_MASK) >> 1) as f64;
            let fin = ((flags & FIN_MASK) >> 0) as f64;
            let ret = vec![fin, syn, rst, psh, ack, urg, ece, cwr];
            Ok(ret)
        }
        Err(_) => {
            warn!("tcp flags get ipv6 packet failed");
            Ok(vec![-1.0; 8])
        }
    }
}

/// These are the four bits of the reserved part of the TCP header.
/// RFC 3540 defines TCP_FLAG_RES8 as the nonce sum (NS) bit.
/// TCP_FLAG_RES8, TCP_FLAG_RES9, TCP_FLAG_RES10, TCP_FLAG_RES11.
fn tcp_reserved(ipv6_buff: &[u8], probe_name: &str) -> Result<Vec<f64>, PistolError> {
    match build_ipv6_packet(ipv6_buff, probe_name) {
        Ok(ipv6_packet) => {
            let tcp_packet = build_tcp_packet(ipv6_packet.payload(), probe_name)?;
            let mask_1: u8 = 0b1000;
            let mask_2: u8 = 0b0100;
            let mask_3: u8 = 0b0010;
            let mask_4: u8 = 0b0001;
            let reserved = tcp_packet.get_reserved();
            let v1 = ((reserved & mask_1) >> 3) as f64;
            let v2 = ((reserved & mask_2) >> 2) as f64;
            let v3 = ((reserved & mask_3) >> 1) as f64;
            let v4 = ((reserved & mask_4) >> 0) as f64;
            let ret = vec![v4, v3, v2, v1];
            Ok(ret)
        }
        Err(_) => {
            warn!("tcp reserved get ipv6 packet failed");
            Ok(vec![-1.0; 4])
        }
    }
}

/// Type codes for the first 16 TCP options.
fn tcp_option_code(ipv6_buff: &[u8], probe_name: &str) -> Result<Vec<f64>, PistolError> {
    match build_ipv6_packet(ipv6_buff, probe_name) {
        Ok(ipv6_packet) => {
            let tcp_packet = build_tcp_packet(ipv6_packet.payload(), probe_name)?;
            let options = tcp_packet.get_options();
            let mut ret = Vec::new();
            for option in options {
                ret.push(option.number.0 as f64);
            }
            if ret.len() < 16 {
                for _ in 0..(16 - ret.len()) {
                    ret.push(-1.0);
                }
            }
            if ret.len() > 16 {
                ret = ret[0..16].to_vec();
            }
            Ok(ret)
        }
        Err(_) => {
            warn!("tcp option code get ipv6 packet failed");
            Ok(vec![-1.0; 16])
        }
    }
}

/// Lengths of the first 16 TCP options.
fn tcp_option_len(ipv6_buff: &[u8], probe_name: &str) -> Result<Vec<f64>, PistolError> {
    match build_ipv6_packet(ipv6_buff, probe_name) {
        Ok(ipv6_packet) => {
            let tcp_packet = build_tcp_packet(ipv6_packet.payload(), probe_name)?;
            let options = tcp_packet.get_options();
            let mut ret = Vec::new();
            for option in options {
                let t = &option.length;
                // println!("{:?}", t);
                if t.len() != 0 {
                    ret.push(t[0] as f64);
                } else {
                    ret.push(1.0); // only header
                }
            }
            if ret.len() < 16 {
                for _ in 0..(16 - ret.len()) {
                    ret.push(-1.0);
                }
            }
            // println!("{}", ret.len());
            if ret.len() > 16 {
                ret = ret[0..16].to_vec();
            }
            Ok(ret)
        }
        Err(_) => {
            warn!("tcp option len get ipv6 packet failed");
            Ok(vec![-1.0; 16])
        }
    }
}

/// Value of the first MSS option, if present.
fn tcp_option_mss(ipv6_buff: &[u8], probe_name: &str) -> Result<f64, PistolError> {
    match build_ipv6_packet(ipv6_buff, probe_name) {
        Ok(ipv6_packet) => {
            let tcp_packet = build_tcp_packet(ipv6_packet.payload(), probe_name)?;
            let options = tcp_packet.get_options();
            for option in options {
                match option.number {
                    TcpOptionNumbers::MSS => {
                        let data = if option.data.len() > 4 {
                            &option.data[0..4]
                        } else {
                            &option.data
                        };
                        let mss = PistolHex::be_vec_to_u32(data)?;
                        return Ok(mss as f64);
                    }
                    _ => (),
                }
            }
            Ok(-1.0)
        }
        Err(_) => {
            warn!("tcp option mss get ipv6 packet failed");
            Ok(-1.0)
        }
    }
}

/// 1 if the SACK-permitted option is present, 0 otherwise.
fn tcp_option_sackok(ipv6_buff: &[u8], probe_name: &str) -> Result<f64, PistolError> {
    match build_ipv6_packet(ipv6_buff, probe_name) {
        Ok(ipv6_packet) => {
            let tcp_packet = build_tcp_packet(ipv6_packet.payload(), probe_name)?;
            let options = tcp_packet.get_options();
            for option in options {
                match option.number {
                    TcpOptionNumbers::SACK_PERMITTED => {
                        return Ok(1.0);
                    }
                    _ => (),
                }
            }
            Ok(-1.0)
        }
        Err(_) => {
            warn!("tcp option sackok get ipv6 packet failed");
            Ok(-1.0)
        }
    }
}

fn tcp_option_wscale(ipv6_buff: &[u8], probe_name: &str) -> Result<f64, PistolError> {
    match build_ipv6_packet(ipv6_buff, probe_name) {
        Ok(ipv6_packet) => {
            let tcp_packet = build_tcp_packet(ipv6_packet.payload(), probe_name)?;
            let options = tcp_packet.get_options();
            for option in options {
                match option.number {
                    TcpOptionNumbers::WSCALE => {
                        if option.data.len() > 0 {
                            return Ok(option.data[0] as f64);
                        }
                    }
                    _ => (),
                }
            }
            Ok(-1.0)
        }
        Err(_) => {
            warn!("tcp option wscale get ipv6 packet failed");
            Ok(-1.0)
        }
    }
}

fn icmpv6_type_code(ipv6_buff: &[u8], probe_name: &str) -> Result<(f64, f64), PistolError> {
    match build_ipv6_packet(ipv6_buff, probe_name) {
        Ok(ipv6_packet) => {
            let icmpv6_packet = build_icmpv6_packet(ipv6_packet.payload(), probe_name)?;
            Ok((
                icmpv6_packet.get_icmpv6_type().0 as f64,
                icmpv6_packet.get_icmpv6_code().0 as f64,
            ))
        }
        Err(_) => {
            warn!("icmpv6 type code get ipv6 packet failed");
            Ok((-1.0, -1.0))
        }
    }
}

pub fn vectorize(ap: &AllPacketRR6) -> Result<Vec<f64>, PistolError> {
    let ipv6_probe_names: Vec<&str> = vec![
        "S1", "S2", "S3", "S4", "S5", "S6", "IE1", "IE2", "NS", "U1", "TECN", "T2", "T3", "T4",
        "T5", "T6", "T7",
    ]; // 17 * 3 + 1 => 51 + 1 => 52 features
    let tcp_probe_names: Vec<&str> = vec![
        "S1", "S2", "S3", "S4", "S5", "S6", "TECN", "T2", "T3", "T4", "T5", "T6", "T7",
    ]; // 637 features
    let icmpv6_probe_names: Vec<&str> = vec!["IE1", "IE2", "NS"]; // 6 features

    let mut features: Vec<f64> = Vec::new();
    for probe_name in ipv6_probe_names {
        let ipv6_response = get_response_by_name(ap, probe_name);
        let (plen, tc) = ipv6_plen_tc(&ipv6_response, &probe_name.to_lowercase())?;
        features.push(plen);
        features.push(tc);
        let hlim = ipv6_hlim(&ipv6_response, &probe_name.to_lowercase())?;
        features.push(hlim);
        debug!(
            "probe name: {}, plen: {}, tc: {}, hlim: {}",
            probe_name, plen, tc, hlim
        );
    }
    let isr = tcp_isr(ap)?;
    debug!("ISR: {}", isr);
    features.push(isr);

    for name in tcp_probe_names {
        // Each round will add 49 features.
        let ipv6_response = get_response_by_name(ap, name);
        let window = tcp_window(&ipv6_response, &name.to_lowercase())?;
        features.push(window);

        let flags = tcp_flags(&ipv6_response, &name.to_lowercase())?;
        assert_eq!(flags.len(), 8);

        features.extend(flags);

        let reserved = tcp_reserved(&ipv6_response, &name.to_lowercase())?;
        assert_eq!(reserved.len(), 4);
        features.extend(reserved);

        let opt_code = tcp_option_code(&ipv6_response, &name.to_lowercase())?;
        assert_eq!(opt_code.len(), 16);
        // println!("{:?}", opt_code);
        features.extend(opt_code);

        let opt_len = tcp_option_len(&ipv6_response, &name.to_lowercase())?;
        assert_eq!(opt_len.len(), 16);
        // println!("{:?}", opt_len);
        features.extend(opt_len);

        let mss = tcp_option_mss(&ipv6_response, &name.to_lowercase())?;
        features.push(mss);

        let sackok = tcp_option_sackok(&ipv6_response, &name.to_lowercase())?;
        features.push(sackok);

        let wscale = tcp_option_wscale(&ipv6_response, &name.to_lowercase())?;
        features.push(wscale);

        if mss != 0.0 && mss != -1.0 {
            features.push(window / mss);
        } else {
            features.push(-1.0);
        }
    }

    for name in icmpv6_probe_names {
        let ipv6_response = get_response_by_name(ap, name);
        let (t, c) = icmpv6_type_code(&ipv6_response, &name.to_lowercase())?;
        features.push(t);
        features.push(c);
    }

    assert_eq!(features.len(), 695);
    Ok(features)
}

pub fn apply_scale(features: &[f64], scale: &[Vec<f64>]) -> Vec<f64> {
    let mut new_features = Vec::new();
    for (f, ab) in zip(features, scale) {
        if *f < 0.0 {
            new_features.push(*f);
        } else {
            let new_f = (f + ab[0]) * ab[1];
            new_features.push(new_f);
        }
    }
    new_features
}