frameassembly 1.4.1

Offline, rootless PCAP generator & Packets-as-Code DSL: generate deterministic .pcap/.pcapng from text across 81 protocols for Wireshark, tcpreplay & IDS.
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

//! Layer 3 Network, Routing, Tunneling, and Security protocols and modifiers for FrameAssembly AST.
//!
//! This module defines the abstract syntax tree structures for IPv4 (RFC 791) and IPv6 (RFC 8200)
//! packet header modifiers alongside twenty Layer 3 control, routing, overlay tunneling, redundancy,
//! and cryptographic security protocols:
//! - **AH** (RFC 4302 IPsec Authentication Header, IP protocol `51`)
//! - **BFD** (RFC 5880 Bidirectional Forwarding Detection over UDP port `3784`)
//! - **BGP** (RFC 4271 Border Gateway Protocol v4 over TCP port `179`)
//! - **ESP / IPsec** (RFC 4303 IPsec Encapsulating Security Payload, IP protocol `50`)
//! - **GENEVE** (RFC 8926 Generic Network Virtualization Encapsulation over UDP port `6081`)
//! - **GRE** (RFC 2784 / RFC 2890 Generic Routing Encapsulation, IP protocol `47`)
//! - **HSRP** (RFC 2281 Cisco Hot Standby Router Protocol over UDP port `1985` / `2029`)
//! - **ICMP / ICMPv6** (RFC 792 / RFC 4443 Internet Control Message Protocol, IP protocol `1` / `58`)
//! - **IGMP** (RFC 2236 / RFC 3376 Internet Group Management Protocol, IP protocol `2`)
//! - **IKEv2** (RFC 7296 Internet Key Exchange Protocol Version 2 over UDP port `500`)
//! - **MLD** (RFC 2710 / RFC 3810 Multicast Listener Discovery for IPv6 over ICMPv6 `58`)
//! - **NDP** (RFC 4861 IPv6 Neighbor Discovery Protocol over ICMPv6 `58`)
//! - **OpenFlow** (ONF OpenFlow Switch Protocol v1.3+ over TCP port `6653`)
//! - **OSPF** (RFC 2328 OSPFv2 / RFC 5340 OSPFv3 over IP protocol `89`)
//! - **PIM** (RFC 7761 Protocol Independent Multicast Sparse Mode, IP protocol `103`)
//! - **RIP** (RFC 2453 RIPv2 over UDP `520` / RFC 2080 RIPng over UDP `521`)
//! - **VRRP** (RFC 5798 Virtual Router Redundancy Protocol v3, IP protocol `112`)
//! - **VXLAN** (RFC 7348 Virtual eXtensible Local Area Network over UDP port `4789`)
//! - **WireGuard** (Noise_IK cryptographic VPN tunnel over UDP port `51820`)

pub mod ah;
pub mod bfd;
pub mod bgp;
pub mod esp;
pub mod geneve;
pub mod gre;
pub mod hsrp;
pub mod icmp;
pub mod igmp;
pub mod ikev2;
pub mod ipsec;
pub mod mld;
pub mod ndp;
pub mod openflow;
pub mod ospf;
pub mod pim;
pub mod rip;
pub mod vrrp;
pub mod vxlan;
pub mod wireguard;

#[doc(inline)]
pub use ah::*;
#[doc(inline)]
pub use bfd::*;
#[doc(inline)]
pub use bgp::*;
#[doc(inline)]
pub use esp::*;
#[doc(inline)]
pub use geneve::*;
#[doc(inline)]
pub use gre::*;
#[doc(inline)]
pub use hsrp::*;
#[doc(inline)]
pub use icmp::*;
#[doc(inline)]
pub use igmp::*;
#[doc(inline)]
pub use ikev2::*;
#[doc(inline)]
pub use ipsec::*;
#[doc(inline)]
pub use mld::*;
#[doc(inline)]
pub use ndp::*;
#[doc(inline)]
pub use openflow::*;
#[doc(inline)]
pub use ospf::*;
#[doc(inline)]
pub use pim::*;
#[doc(inline)]
pub use rip::*;
#[doc(inline)]
pub use vrrp::*;
#[doc(inline)]
pub use vxlan::*;
#[doc(inline)]
pub use wireguard::*;

/// Re-export MPLS specification from L2 for backwards compatibility.
#[doc(inline)]
pub use crate::ast::l2::mpls::MplsSpec;

/// Layer 3 IPv4 (RFC 791) and IPv6 (RFC 8200) packet header modifiers applied to any frame statement.
///
/// Syntax mapping: `[TTL <0..255>] [DSCP <0..63>] [ECN <0..3>] [FLOWLABEL <0..1048575>] [IPID <u16>] [DF] [MF] [FRAGOFFSET <u16>]`
#[doc(alias = "IPv4")]
#[doc(alias = "IPv6")]
#[doc(alias = "DSCP")]
#[doc(alias = "TTL")]
#[derive(Debug, Clone, PartialEq, Eq, Default)]
pub struct L3Modifiers {
    /// IPv4 Time-to-Live or IPv6 Hop Limit (`TTL <0..=255>`, default `64`).
    pub ttl: Option<u8>,
    /// 6-bit Differentiated Services Code Point (`DSCP <0..=63>`, RFC 2474, default `0`).
    pub dscp: Option<u8>,
    /// 2-bit Explicit Congestion Notification (`ECN <0..=3>`, RFC 3168, default `0`).
    pub ecn: Option<u8>,
    /// 20-bit IPv6 Flow Label (`FLOWLABEL <0..=0xFFFFF>`, RFC 6437, default `0`).
    pub flowlabel: Option<u32>,
    /// 16-bit IPv4 Identification field (`IPID <u16>`, default `0x1234`).
    pub ipid: Option<u16>,
    /// IPv4 Don't Fragment flag (`DF`, bit 1 of the IPv4 Flags field).
    pub df: bool,
    /// IPv4 More Fragments flag (`MF`, bit 2 of the IPv4 Flags field).
    pub mf: bool,
    /// 13-bit IPv4 Fragment Offset in 8-octet units (`FRAGOFFSET <0..=8191>`).
    pub frag_offset: Option<u16>,
}