resynth 0.6.0

A packet synthesis language
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

 # Internet Protocol Version 4

 IPv4 packet construction — TCP, UDP, ICMP flows and IP-level fragmentation.
## Index


### Modules

| Module | Description |
| ------ | ----------- |
| [icmp](icmp/README.md) | Internet Control Message Protocol (ICMP) |
| [proto](proto/README.md) | IP Protocols |
| [tcp](tcp/README.md) | Transmission Control Protocol (TCP) |
| [udp](udp/README.md) | User Datagram Protocol (UDP) |

### Classes

| Class | Description |
| ----- | ----------- |
| [IpFrag](IpFrag.md) | IP Packet Fragment Builder |

### Functions

| Function | Returns | Description |
| -------- | ------- | ----------- |
| [datagram](#datagram) | `Pkt` | Create a raw IPv4 header or datagram |
| [frag](#frag) | [IpFrag](../ipv4/IpFrag.md) | Create a context for a packet which can be arbitrarily fragmented |



## datagram
```resynth
resynth fn datagram (
    src: Ip4,
    dst: Ip4,
    id: u16 = 0x0000,
    evil: bool = false,
    df: bool = false,
    mf: bool = false,
    ttl: u8 = 0x40,
    frag_off: u16 = 0x0000,
    proto: u8 = 0x11,
    =>
    *collect_args: bytes,
) -> Pkt;
```
Create a raw IPv4 header or datagram

### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| `src` | `Ip4` | Source IPv4 address |
| `dst` | `Ip4` | Destination IPv4 address |
| `id` | `u16` | IP identification field _(default: `0x0000`)_ |
| `evil` | `bool` | Set the evil bit (RFC 3514) _(default: `false`)_ |
| `df` | `bool` | Set the Don't Fragment (DF) flag _(default: `false`)_ |
| `mf` | `bool` | Set the More Fragments (MF) flag _(default: `false`)_ |
| `ttl` | `u8` | IP Time-To-Live value _(default: `0x40`)_ |
| `frag_off` | `u16` | Fragment offset field (in 8-byte units) _(default: `0x0000`)_ |
| `proto` | `u8` | IP protocol number _(default: `0x11`)_ |
| `…` | `bytes` | Zero or more additional values |

### Returns

| Type |
| ---- |
| `Pkt` |

## frag
```resynth
resynth fn frag (
    src: Ip4,
    dst: Ip4,
    id: u16 = 0x0000,
    evil: bool = false,
    df: bool = false,
    ttl: u8 = 0x40,
    proto: u8 = 0x11,
    =>
    *collect_args: bytes,
) -> IpFrag;
```
Create a context for a packet which can be arbitrarily fragmented

### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| `src` | `Ip4` | Source IPv4 address |
| `dst` | `Ip4` | Destination IPv4 address |
| `id` | `u16` | IP identification field _(default: `0x0000`)_ |
| `evil` | `bool` | Set the evil bit (RFC 3514) _(default: `false`)_ |
| `df` | `bool` | Set the Don't Fragment (DF) flag _(default: `false`)_ |
| `ttl` | `u8` | IP Time-To-Live value _(default: `0x40`)_ |
| `proto` | `u8` | IP protocol number _(default: `0x11`)_ |
| `…` | `bytes` | Zero or more additional values |

### Returns

| Type |
| ---- |
| [IpFrag](../ipv4/IpFrag.md) |