frameassembly 1.5.0

A DSL for creating custom .pcap/.pcapng captures and decompiling captures to .fasm for testing firewalls, IDS rules, SNMP traps, and pentesting.
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

//! Spanning Tree Protocol (STP / RSTP, IEEE 802.1D / 802.1w) Layer 2 PCAP-to-`.fasm` decompiler.
//!
//! This module implements the fuzz-safe PCAP and PCAPNG decompiler for IEEE 802.1D Spanning Tree
//! Protocol (`STP`) and IEEE 802.1w Rapid Spanning Tree Protocol (`RSTP`) Bridge Protocol Data
//! Units (BPDUs) encapsulated in IEEE 802.3 LLC (`DSAP=0x42, SSAP=0x42, Control=0x03`). It decodes
//! BPDU version (`rstp`), topology flags (`flags`), root and bridge identifiers (`root_id`,
//! `bridge_id`), root path cost (`cost`), port identifier (`port_id`), and timer fields (`max_age`,
//! `hello_time`, `forward_delay`).

use alloc::format;
use alloc::string::String;
use core::fmt::Write as _;

use crate::ast::Protocol;
use crate::reverse::{
    ProtocolDissection, be_u16, be_u32, format_mac_lower, mac_at, push_hex, push_if, sd,
};

/// Formats an 8-byte IEEE 802.1D Bridge Identifier (`<prio>:<mac>`).
fn format_stp_bridge_id(bytes: &[u8]) -> (u16, [u8; 6], String) {
    let (prio, mac) = (be_u16(bytes, 0), mac_at(bytes, 2));
    (prio, mac, format!("{prio}:{}", format_mac_lower(mac)))
}

/// Decompiles an IEEE 802.1D / 802.1w `STP` / `RSTP` BPDU over 802.3 LLC (`0x424203`).
pub(crate) fn dissect_stp(bpdu: &[u8], src_mac: [u8; 6]) -> ProtocolDissection {
    let (is_rstp, flags) = (bpdu[2] >= 2, bpdu[4]);
    let (r_prio, r_mac, r_str) = format_stp_bridge_id(&bpdu[5..13]);
    let (b_prio, b_mac, b_str) = format_stp_bridge_id(&bpdu[17..25]);
    let mut t = String::from(if is_rstp { "stp rstp" } else { "stp" });
    push_hex(&mut t, "flags", u64::from(flags), 0x00, 2);
    if r_prio != 32768 || r_mac != src_mac {
        let _ = write!(t, " root_id \"{r_str}\"");
    }
    push_if(&mut t, "cost", be_u32(bpdu, 13), 0);
    if b_prio != 32768 || b_mac != src_mac {
        let _ = write!(t, " bridge_id \"{b_str}\"");
    }
    push_hex(&mut t, "port_id", u64::from(be_u16(bpdu, 25)), 0x8001, 4);
    push_if(&mut t, "max_age", be_u16(bpdu, 29) >> 8, 20);
    push_if(&mut t, "hello_time", be_u16(bpdu, 31) >> 8, 2);
    push_if(&mut t, "forward_delay", be_u16(bpdu, 33) >> 8, 15);
    let hdr_len = if is_rstp && bpdu.len() >= 36 { 36 } else { 35 };
    sd(
        Protocol::Stp,
        t,
        bpdu.get(hdr_len..).unwrap_or(&[]).to_vec(),
    )
}