frameassembly 0.9.2

A Domain-Specific Language (DSL) for writing deterministic network traffic to .pcap files.
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
use crate::ast::*;
use crate::packet::{build_tcp_packet, build_udp_packet};
use crate::pcap::PcapWriter;
use alloc::string::String;
use std::collections::HashMap;

/// Resolves a host definition for a given argument in a flow invocation.
///
/// # Examples
/// ```no_run
/// // Internal backend resolution of an endpoint reference from the environment.
/// ```
///
/// # Errors
/// Returns a `String` error if the variable name is not defined in the environment.
fn resolve_endpoint<'a>(
    arg: &Argument<'a>,
    env: &HashMap<&'a str, HostDef<'a>>,
) -> Result<HostDef<'a>, String> {
    match arg {
        Argument::Variable(var_name) => {
            if let Some(val) = env.get(var_name) {
                Ok(val.clone())
            } else {
                Err(alloc::format!("Undefined variable: '{}'", var_name))
            }
        }
    }
}

/// Evaluates the AST and generates the PCAP file.
///
/// This walks the `Program` AST, builds each packet, and writes it to the specified PCAP file path.
///
/// # Examples
/// ```no_run
/// use frameassembly::ast::Program;
/// use frameassembly::backend::generate_pcap;
/// 
/// let program = Program { hosts: vec![], flows: vec![], compile_block: vec![] };
/// generate_pcap(&program, "output.pcap").unwrap();
/// ```
///
/// # Errors
/// Returns a `String` containing the error message if:
/// * Network endpoints cannot be resolved.
/// * PCAP writing fails.
/// * Unrecognized protocol combinations occur.
///
/// # Panics
/// Panics if a flow definition requested in the compile block is not found.
pub fn generate_pcap(program: &Program, output_path: &str) -> Result<(), String> {
    let statements = &program.compile_block;

    let mut env = HashMap::new();
    for host in &program.hosts {
        env.insert(host.name, host.clone());
    }

    let mut flows = HashMap::new();
    for f in &program.flows {
        flows.insert(f.name, f);
    }

    let mut pcap = PcapWriter::create(output_path)
        .map_err(|e| alloc::format!("Failed to create PCAP file: {}", e))?;

    let mut current_time_ns: u64 = 1_700_000_000_000_000_000;

    #[allow(dead_code)]
    #[derive(Clone)]
    struct TcpConnectionState {
        pub ip1: std::net::IpAddr,
        pub port1: u16,
        pub seq1: u32,
        pub ip2: std::net::IpAddr,
        pub port2: u16,
        pub seq2: u32,
    }
    let mut tcp_connections: HashMap<(std::net::IpAddr, std::net::IpAddr), TcpConnectionState> = HashMap::new();

    let mut execute_invocation = |invocation: &TemplateInvocation| -> Result<(), String> {
        let flow = flows
            .get(&invocation.name)
            .ok_or_else(|| alloc::format!("Undefined flow: '{}'", invocation.name))?;

        if flow.params.len() != invocation.args.len() {
            return Err(alloc::format!(
                "Flow '{}' expects {} arguments, got {}",
                flow.name,
                flow.params.len(),
                invocation.args.len()
            ));
        }

        let mut param_map = HashMap::new();
        for (i, param_name) in flow.params.iter().enumerate() {
            let endpoint = resolve_endpoint(&invocation.args[i], &env)?;
            param_map.insert(*param_name, endpoint);
        }

        for stmt in &flow.statements {
            let caller_ep = param_map
                .get(&stmt.caller)
                .ok_or_else(|| alloc::format!("Unknown caller '{}' in flow", stmt.caller))?;
            let callee_ep = param_map
                .get(&stmt.callee)
                .ok_or_else(|| alloc::format!("Unknown callee '{}' in flow", stmt.callee))?;

            // Resolve Source and Destination based on Direction
            let (src_host, dst_host) = match stmt.dir {
                Direction::LeftToRight => (caller_ep, callee_ep),
                Direction::RightToLeft => (callee_ep, caller_ep),
            };

            let src_ip = src_host.ip;
            let dst_ip = dst_host.ip;
            let src_mac = src_host.mac.unwrap_or([0, 0, 0, 0, 0, 0]);
            let dst_mac = dst_host.mac.unwrap_or([0, 0, 0, 0, 0, 0]);

            let mut src_port = stmt.src_port;
            let mut dst_port = stmt.dst_port;
            let mut final_seq = stmt.seq;
            let mut final_ack_num = stmt.ack_num;

            if stmt.protocol == Protocol::Tcp {
                let key = if src_ip < dst_ip { (src_ip, dst_ip) } else { (dst_ip, src_ip) };
                
                let state = tcp_connections.entry(key).or_insert_with(|| {
                    TcpConnectionState {
                        ip1: key.0,
                        port1: if src_ip == key.0 { src_port.unwrap_or(12345) } else { dst_port.unwrap_or(80) },
                        seq1: 1000,
                        ip2: key.1,
                        port2: if src_ip == key.1 { src_port.unwrap_or(12345) } else { dst_port.unwrap_or(80) },
                        seq2: 1000,
                    }
                });

                if src_port.is_none() {
                    src_port = Some(if src_ip == state.ip1 { state.port1 } else { state.port2 });
                }
                if dst_port.is_none() {
                    dst_port = Some(if dst_ip == state.ip1 { state.port1 } else { state.port2 });
                }

                let (sender_seq, receiver_seq) = if src_ip == state.ip1 {
                    (&mut state.seq1, &mut state.seq2)
                } else {
                    (&mut state.seq2, &mut state.seq1)
                };

                if final_seq.is_none() {
                    final_seq = Some(*sender_seq);
                }
                if final_ack_num.is_none() && stmt.flags.contains(&TcpFlag::Ack) {
                    final_ack_num = Some(*receiver_seq);
                }

                let payload_len = stmt.payload.map(|s| s.len() as u32).unwrap_or(0);
                let advance = (if stmt.flags.contains(&TcpFlag::Syn) { 1 } else { 0 }) + payload_len;
                
                *sender_seq = final_seq.unwrap_or(*sender_seq) + advance;
            }

            let src_port = src_port.unwrap_or(12345);
            let dst_port = dst_port.unwrap_or(match stmt.protocol {
                Protocol::Snmp1 | Protocol::Snmp2 | Protocol::Snmp3 => 162,
                _ => 80,
            });

            let wait_time = stmt.wait.unwrap_or(10_000_000); // 10ms default
            current_time_ns += wait_time;

            let syn = stmt.flags.contains(&TcpFlag::Syn);
            let ack = stmt.flags.contains(&TcpFlag::Ack);

            let packet_data = match stmt.protocol {
                Protocol::Tcp => build_tcp_packet(
                    src_ip,
                    src_port,
                    dst_ip,
                    dst_port,
                    syn,
                    ack,
                    final_seq,
                    final_ack_num,
                    stmt.win,
                    stmt.payload.map(|s| s.as_bytes()),
                    src_mac,
                    dst_mac,
                )
                .map_err(|e| alloc::format!("{:?}", e))?,
                Protocol::Udp => build_udp_packet(
                    src_ip,
                    src_port,
                    dst_ip,
                    dst_port,
                    stmt.payload.map(|s| s.as_bytes()),
                    src_mac,
                    dst_mac,
                )
                .map_err(|e| alloc::format!("{:?}", e))?,
                Protocol::Snmp1 => {
                    use rasn::types::{Integer, ObjectIdentifier, OctetString};
                    use rasn_snmp::v1::{Message, Pdus, Trap};
                    let community_str = stmt.community.unwrap_or("public");
                    let community = OctetString::from(community_str.as_bytes().to_vec());
                    let oid_str = stmt.oid.unwrap_or("1.3.6.1.4.1");
                    let mut oid_vec = alloc::vec::Vec::new();
                    for s in oid_str.trim_start_matches('.').split('.') {
                        match s.parse::<u32>() {
                            Ok(val) => oid_vec.push(val),
                            Err(_) => {
                                return Err(alloc::format!(
                                    "Invalid OID segment: '{}' in '{}'",
                                    s,
                                    oid_str
                                ));
                            }
                        }
                    }
                    let trap_oid = ObjectIdentifier::new(oid_vec)
                        .unwrap_or_else(|| ObjectIdentifier::new(vec![1, 3, 6, 1, 4, 1]).unwrap());

                    let agent_ip = match src_ip {
                        core::net::IpAddr::V4(addr) => addr.octets(),
                        _ => {
                            return Err(
                                "SNMPv1 Trap requires IPv4 address, got IPv6".to_string()
                            );
                        }
                    };

                    let trap = Trap {
                        enterprise: trap_oid,
                        agent_addr: rasn_smi::v1::NetworkAddress::Internet(
                            rasn_smi::v1::IpAddress(agent_ip.into()),
                        ),
                        generic_trap: Integer::from(6), // EnterpriseSpecific
                        specific_trap: Integer::from(1),
                        time_stamp: rasn_smi::v1::TimeTicks(stmt.sys_up_time.unwrap_or(0)),
                        variable_bindings: vec![],
                    };

                    let message = Message {
                        version: Integer::from(0),
                        community,
                        data: Pdus::Trap(trap),
                    };

                    let snmp_payload = rasn::ber::encode(&message)
                        .map_err(|e| alloc::format!("SNMP1 encode error: {:?}", e))?;
                    build_udp_packet(
                        src_ip,
                        src_port,
                        dst_ip,
                        dst_port,
                        Some(snmp_payload.as_slice()),
                        src_mac,
                        dst_mac,
                    )
                    .map_err(|e| alloc::format!("{:?}", e))?
                }
                Protocol::Snmp2 => {
                    use rasn::types::{Integer, ObjectIdentifier, OctetString};
                    use rasn_snmp::v2::Pdus;
                    use rasn_snmp::v2::{Pdu, VarBind, VarBindValue};
                    use rasn_snmp::v2c::Message;

                    let community_str = stmt.community.unwrap_or("public");
                    let community = OctetString::from(community_str.as_bytes().to_vec());

                    let sys_up_time_oid =
                        ObjectIdentifier::new(vec![1, 3, 6, 1, 2, 1, 1, 3, 0]).unwrap();
                    let snmp_trap_oid_name =
                        ObjectIdentifier::new(vec![1, 3, 6, 1, 6, 3, 1, 1, 4, 1, 0]).unwrap();

                    let oid_str = stmt.oid.unwrap_or("1.3.6.1.6.3.1.1.5.3");
                    let mut oid_vec = alloc::vec::Vec::new();
                    for s in oid_str.trim_start_matches('.').split('.') {
                        match s.parse::<u32>() {
                            Ok(val) => oid_vec.push(val),
                            Err(_) => {
                                return Err(alloc::format!(
                                    "Invalid OID segment: '{}' in '{}'",
                                    s,
                                    oid_str
                                ));
                            }
                        }
                    }
                    let requested_trap_oid = ObjectIdentifier::new(oid_vec).unwrap_or_else(|| {
                        ObjectIdentifier::new(vec![1, 3, 6, 1, 6, 3, 1, 1, 5, 3]).unwrap()
                    });

                    // Use rasn_smi types that rasn_snmp depends on. If rasn_smi is not explicitly in dependencies,
                    // we'll need to add it or use re-exports. We will try rasn_smi first.
                    let varbinds = vec![
                        VarBind {
                            name: sys_up_time_oid,
                            value: VarBindValue::Value(
                                rasn_smi::v2::ObjectSyntax::ApplicationWide(
                                    rasn_smi::v2::ApplicationSyntax::Ticks(
                                        rasn_smi::v1::TimeTicks(stmt.sys_up_time.unwrap_or(0)),
                                    ),
                                ),
                            ),
                        },
                        VarBind {
                            name: snmp_trap_oid_name,
                            value: VarBindValue::Value(rasn_smi::v2::ObjectSyntax::Simple(
                                rasn_smi::v2::SimpleSyntax::ObjectId(requested_trap_oid),
                            )),
                        },
                    ];

                    let pdu = Pdu {
                        request_id: 1,
                        error_status: 0,
                        error_index: 0,
                        variable_bindings: varbinds,
                    };

                    let message = Message {
                        version: Integer::from(1),
                        community,
                        data: Pdus::Trap(rasn_snmp::v2::Trap(pdu)),
                    };

                    let snmp_payload = rasn::ber::encode(&message)
                        .map_err(|e| alloc::format!("SNMP2 encode error: {:?}", e))?;
                    build_udp_packet(
                        src_ip,
                        src_port,
                        dst_ip,
                        dst_port,
                        Some(snmp_payload.as_slice()),
                        src_mac,
                        dst_mac,
                    )
                    .map_err(|e| alloc::format!("{:?}", e))?
                }
                Protocol::Snmp3 => {
                    use rasn::types::{Integer, ObjectIdentifier, OctetString};
                    use rasn_snmp::v2::{Pdu, Pdus, VarBind, VarBindValue};
                    use rasn_snmp::v3::{
                        HeaderData, Message, ScopedPdu, ScopedPduData, USMSecurityParameters,
                    };

                    let user_str = stmt.user.unwrap_or("admin");
                    let user = OctetString::from(user_str.as_bytes().to_vec());

                    let sys_up_time_oid =
                        ObjectIdentifier::new(vec![1, 3, 6, 1, 2, 1, 1, 3, 0]).unwrap();
                    let snmp_trap_oid_name =
                        ObjectIdentifier::new(vec![1, 3, 6, 1, 6, 3, 1, 1, 4, 1, 0]).unwrap();

                    let oid_str = stmt.oid.unwrap_or("1.3.6.1.6.3.1.1.5.3");
                    let mut oid_vec = alloc::vec::Vec::new();
                    for s in oid_str.trim_start_matches('.').split('.') {
                        match s.parse::<u32>() {
                            Ok(val) => oid_vec.push(val),
                            Err(_) => {
                                return Err(alloc::format!(
                                    "Invalid OID segment: '{}' in '{}'",
                                    s,
                                    oid_str
                                ));
                            }
                        }
                    }
                    let requested_trap_oid = ObjectIdentifier::new(oid_vec).unwrap_or_else(|| {
                        ObjectIdentifier::new(vec![1, 3, 6, 1, 6, 3, 1, 1, 5, 3]).unwrap()
                    });

                    let varbinds = vec![
                        VarBind {
                            name: sys_up_time_oid,
                            value: VarBindValue::Value(
                                rasn_smi::v2::ObjectSyntax::ApplicationWide(
                                    rasn_smi::v2::ApplicationSyntax::Ticks(
                                        rasn_smi::v1::TimeTicks(stmt.sys_up_time.unwrap_or(0)),
                                    ),
                                ),
                            ),
                        },
                        VarBind {
                            name: snmp_trap_oid_name,
                            value: VarBindValue::Value(rasn_smi::v2::ObjectSyntax::Simple(
                                rasn_smi::v2::SimpleSyntax::ObjectId(requested_trap_oid),
                            )),
                        },
                    ];

                    let pdu = Pdu {
                        request_id: 1,
                        error_status: 0,
                        error_index: 0,
                        variable_bindings: varbinds,
                    };

                    let scoped_pdu = ScopedPdu {
                        engine_id: OctetString::from(vec![0x80, 0x00, 0x00, 0x00, 0x01]),
                        name: OctetString::from(vec![]),
                        data: Pdus::Trap(rasn_snmp::v2::Trap(pdu)),
                    };

                    let usm_params = USMSecurityParameters {
                        authoritative_engine_id: OctetString::from(vec![
                            0x80, 0x00, 0x00, 0x00, 0x01,
                        ]),
                        authoritative_engine_boots: Integer::from(0),
                        authoritative_engine_time: Integer::from(0),
                        user_name: user,
                        authentication_parameters: OctetString::from(vec![]),
                        privacy_parameters: OctetString::from(vec![]),
                    };

                    let usm_bytes = rasn::ber::encode(&usm_params)
                        .map_err(|e| alloc::format!("USM encode error: {:?}", e))?;

                    let message = Message {
                        version: Integer::from(3), // SNMPv3
                        global_data: HeaderData {
                            message_id: Integer::from(1),
                            max_size: Integer::from(65507),
                            flags: OctetString::from(vec![0]), // NoAuthNoPriv
                            security_model: Integer::from(3),  // USM is 3
                        },
                        security_parameters: OctetString::from(usm_bytes),
                        scoped_data: ScopedPduData::CleartextPdu(scoped_pdu),
                    };

                    let snmp_payload = rasn::ber::encode(&message)
                        .map_err(|e| alloc::format!("SNMP3 encode error: {:?}", e))?;
                    build_udp_packet(
                        src_ip,
                        src_port,
                        dst_ip,
                        dst_port,
                        Some(snmp_payload.as_slice()),
                        src_mac,
                        dst_mac,
                    )
                    .map_err(|e| alloc::format!("{:?}", e))?
                }
            };

            pcap.write_packet(&packet_data, current_time_ns)
                .map_err(|e| alloc::format!("Failed to write packet: {}", e))?;
        }
        Ok(())
    };

    for stmt in statements {
        match stmt {
            RunStatement::Invocation(inv) => execute_invocation(inv)?,
            RunStatement::Loop(count, invocations) => {
                for _ in 0..*count {
                    for inv in invocations {
                        execute_invocation(inv)?;
                    }
                }
            }
        }
    }

    Ok(())
}