packet_rs is a Rust based Scapy alternative
Introduction
============
packet_rs is a rust based alternative to the popular python Scapy packet library. It tries to provide a scapy like API interface to define new headers and construct packets.
packet_rs has the most common networking headers already pre-defined.
make_header
===========
The core of the library is the *make_header* macro which provides a flexible way to create new headers.
Describe a new header in the below format with defaults as a vector.
```
make_header! {
(
- ,
- ,
)
};
```
Define a header
---------------
Add a new header by using the *make_header* macro. This automatically creates a set_*field*() and a *field*() helper methods for each field.
```rust
#[macro_use]
extern crate packet_rs;
use packet_rs::headers::*;
use packet_rs::Packet;
make_header!(
MyHeader 4
(
field_1: 0-2,
field_2: 3-3,
field_3: 4-15,
field_4: 16-31
)
vec![0x0, 0xa, 0x8, 0x0] // <= optional default data
);
```
2 ways to create a header
-------------------------
```rust
// Call new on the *MyHeader* header
let hdr = MyHeader::new();
// Pass a data buffer as an argument
let hdr = MyHeader([0x00, 0x0a, 0x08, 0x10]);
```
make_header! generates helper methods and associated functions for each header and fields
```rust
hdr.octets(); // get the vlan header as a byte array
println!("{}", hdr.field_2()); // fetch the cfi field value
hdr.set_field_2(1); // set the cfi field value
let hdr_new = hdr.clone(); // clone the packet
hdr.show(); // display the vlan header
Output of show():
Raw: 00 0a 08 00
#### MyHeader Size Data
-------------------------------------------
field_1 : 3 : 02
field_2 : 1 : 01
field_3 : 12 : 00 10
field_4 : 16 : 08 00
```
Create a Packet
---------------
A packet is an ordered list of headers. Push headers as required into a packet.
```rust
let mut pkt = Packet::new(100);
pkt.push(Ether::new()));
pkt.push(IPv4::new());
pkt.show()
#### Ether Size Data
-------------------------------------------
dst : 48 : 00 01 02 03 04 05
src : 48 : 00 06 07 08 09 0a
etype : 16 : 08 00
#### IPv4 Size Data
-------------------------------------------
version : 4 : 04
ihl : 4 : 05
diffserv : 8 : 00
total_len : 16 : 00 14
identification : 16 : 00 33
flags : 3 : 02
frag_startset : 13 : 06 29
ttl : 8 : 64
protocol : 8 : 06
header_checksum : 16 : fa ec
src : 32 : c0 a8 00 01
dst : 32 : c0 a8 00 02
// access ethernet header immutable
let x: &Ether> = (&pkt["Ether"]).into();
println!("{}", x.etype());
// access ethernet header mutable
let x: &mut Ether> = (&mut pkt["Ether"]).into();
x.set_etype(0x1111);
```