12 releases

0.2.0 May 21, 2024
0.1.11 Nov 11, 2022
0.1.10 Sep 17, 2022
0.1.9 Jul 31, 2022
0.1.6 Jan 30, 2022

#487 in Network programming

Download history 46/week @ 2024-02-22 77/week @ 2024-02-29 5/week @ 2024-03-28 2/week @ 2024-04-04 130/week @ 2024-05-16 28/week @ 2024-05-23

158 downloads per month

MIT license

345KB
10K SLoC

resynth: A Network Packet Synthesis Language

Latest Version Documentation

About

Resynth is a packet synthesis language. It produces network traffic (in the form of pcap files) from textual descriptions of traffic. It enables version-controlled packets-as-code workflows which can be useful for various packet processing, or security research applications such as DPI engines, or network intrusion detection systems.

Examples

Here is how you might represent an HTTP request and response in resynth:

import ipv4;
import dns;
import text;

let cl = 192.168.0.1;
let sv = 109.197.38.8;

dns::host(cl, "www.scaramanga.co.uk", ns: 8.8.8.8, sv);

let http = ipv4::tcp::flow(
  cl/32768,
  sv/80,
);

http.open();

http.client_message(
  text::crlflines(
    "GET / HTTP/1.1",
    "Host: www.scaramanga.co.uk",
    text::CRLF,
  )
);

http.server_message(
  text::crlflines(
    "HTTP/1.1 301 Moved Permanently",
    "Date: Sat, 17 Jul 2021 02:55:05 GMT",
    "Server: Apache/2.4.29 (Ubuntu)",
    "Location: https://www.scaramanga.co.uk/",
    "Content-Type: text/html; charset=iso-8859-1",
    text::CRLF,
  ),
);

http.server_close();

You can compile this to a pcap file with the command resynth http.rsyn - a file called http.pcap will be created.

Currently Supported Protocols

Not only can you write arbitrary TCP, UDP, ICMP packets, raw IP packets, and IP fragments, but there are also library modules to help with crafting packets for the following protocols:

  • VXLAN, ERSPAN Types I & II
  • DHCP
  • DNS
  • Netbios name service (NBNS)
  • TLS (early stages, still need support for SSL2 and common extensions, although you can craft arbitrary TLS frames)
  • I/O: packets can be crafted which include the contents of external files

Why not use $OTHER_TOOL?

  • Scapy and python-based packet generation frameworks: they are incredibly slow for my intended use-cases (fuzz-testing, live high-speed packet-generation), even by the standards of what is possible in a pure python program. For very high-rate applications, I don't think it would be possible to automatically and transparently optimize scapy programs without adding some other layer designed specifically to speed things up.
  • flowsynth: Flowsynth is really nice, and a big source of inspiration for this. But it lacks support for higher-level protocols and that little bit of extensibility which I really need.

Future Directions

I plan to combine this with a DPDK-based packet generator in order to build a network performance-testing suite (think T-Rex). The idea would be to add a multi-instancing feature to the language to scale up the number of flows. The resynth programs would be compiled in to a set of pre-canned packet templates which could just be copied in to the tx ring-buffer with fields (eg. IP addresses and port numbers) modulated. This would move all of the expensive work out of the packet transmit mainloop and allow us to generate traffic at upwards of 20Gbps per CPU.

The language is pretty bare-bones right now but I plan to add:

  • More builtin types: eg. signed integers, booleans, integers of various widths
  • Arithmetic and logical operators so that complex expressions can be built
  • The ability to coerce any type in to bytes
  • Syntax for concatenating buffers

I plan to add support for the following protocols to the standard library:

  • Support for PMTU and segmentization of TCP messages
  • More direct support for HTTP
  • SMB2
  • ARP
  • DCE-RPC
  • More exotic TCP/IP interactions and better ICMP support

Dependencies

~4–12MB
~138K SLoC