frameassembly 1.5.1

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
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

//! OpenFlow Switch Protocol (ONF OpenFlow v1.0–v1.5) AST definitions.
//!
//! Defines Software-Defined Networking (SDN) Southbound control channel messages exchanged between an
//! OpenFlow controller and an OpenFlow-enabled switch over TCP port `6653` (IANA standard) or `6633`.
//! Every OpenFlow message starts with an 8-byte `ofp_header` comprising an 8-bit `version` (`VERSION`,
//! default `4` for OpenFlow 1.3), an 8-bit `type` code (`HELLO` `0`, `ECHO_REQ` `2`, `ECHO_REPLY` `3`,
//! `FEATURES_REQ` `5`, `FEATURES_REPLY` `6`, `PACKET_IN` `10`, `PACKET_OUT` `13`, `FLOW_MOD` `14`), a
//! 16-bit total message `length`, and a 32-bit transaction identifier `xid` (`XID`), optionally
//! accompanied by Datapath ID (`DPID`), flow `TABLE_ID`, and flow rule `PRIORITY` attributes.
//!
//! Canonical `.fasm` syntax:
//! `a -> b OPENFLOW [HELLO | ECHO_REQ | ECHO_REPLY | FEATURES_REQ | FEATURES_REPLY | PACKET_IN | PACKET_OUT | FLOW_MOD] [VERSION <u8>] [XID <u32>] [DPID <u64>] [TABLE_ID <u8>] [PRIORITY <u16>]`

use core::marker::PhantomData;

/// ONF OpenFlow Switch Protocol `ofp_type` message classification.
#[doc(alias = "OfpType")]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum OpenflowType {
    /// `OFPT_HELLO` (`0`): Symmetric connection startup version negotiation message.
    Hello,
    /// `OFPT_ECHO_REQUEST` (`2`): Symmetric control channel liveness probe request.
    EchoReq,
    /// `OFPT_ECHO_REPLY` (`3`): Symmetric control channel liveness probe response.
    EchoReply,
    /// `OFPT_FEATURES_REQUEST` (`5`): Controller request querying switch datapath capabilities (`DPID`).
    FeaturesReq,
    /// `OFPT_FEATURES_REPLY` (`6`): Switch response advertising `datapath_id` and supported tables/ports.
    FeaturesReply,
    /// `OFPT_PACKET_IN` (`10`): Asynchronous switch-to-controller punt of a table-miss or controller-action packet.
    PacketIn,
    /// `OFPT_FLOW_MOD` (`14`): Controller-to-switch command installing, modifying, or deleting a flow table entry.
    FlowMod,
    /// `OFPT_PACKET_OUT` (`13`): Controller-to-switch command injecting a raw frame out a switch port.
    PacketOut,
}

/// OpenFlow Switch Protocol (ONF v1.3+) specification over TCP port `6653`.
///
/// Syntax mapping: `OPENFLOW [HELLO | ECHO_REQ | ECHO_REPLY | FEATURES_REQ | FEATURES_REPLY | PACKET_IN | PACKET_OUT | FLOW_MOD] [VERSION <u8>] [XID <u32>] [DPID <u64>] [TABLE_ID <u8>] [PRIORITY <u16>]`
#[doc(alias = "OPENFLOW")]
#[doc(alias = "OpenFlow")]
#[doc(alias = "SDN")]
#[doc(alias = "6653")]
#[doc(alias = "ofp_header")]
#[doc(alias = "HELLO")]
#[doc(alias = "ECHO_REQ")]
#[doc(alias = "ECHO_REPLY")]
#[doc(alias = "FEATURES_REQ")]
#[doc(alias = "FEATURES_REPLY")]
#[doc(alias = "PACKET_IN")]
#[doc(alias = "PACKET_OUT")]
#[doc(alias = "FLOW_MOD")]
#[doc(alias = "VERSION")]
#[doc(alias = "XID")]
#[doc(alias = "DPID")]
#[doc(alias = "TABLE_ID")]
#[doc(alias = "PRIORITY")]
#[derive(Debug, Clone, PartialEq, Eq, Default)]
pub struct OpenflowSpec<'a> {
    /// OpenFlow wire protocol version (`VERSION <u8>`, e.g. `1` = OF 1.0, `4` = OF 1.3, `5` = OF 1.4; default `4`).
    pub version: Option<u8>,
    /// OpenFlow message type (`HELLO`, `ECHO_REQ`, `ECHO_REPLY`, `FEATURES_REQ`, `FEATURES_REPLY`, `PACKET_IN`, `FLOW_MOD`, `PACKET_OUT`; default `HELLO`).
    pub of_type: Option<OpenflowType>,
    /// 32-bit Transaction ID correlating requests and replies (`XID <u32>`, default `1`).
    pub xid: Option<u32>,
    /// 64-bit switch Datapath Identifier (`DPID <u64>`).
    pub dpid: Option<u64>,
    /// 8-bit pipeline Flow Table Identifier (`TABLE_ID <u8>`).
    pub table_id: Option<u8>,
    /// 16-bit flow entry matching Priority (`PRIORITY <u16>`).
    pub priority: Option<u16>,
    /// Optional lifetime phantom marker for AST uniformity.
    pub _marker: PhantomData<&'a ()>,
}