crafter 0.3.3

Packet-level network interaction for Rust tools and agents.
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

//! DNS wire-level constants and codepoints.

use core::net::{Ipv4Addr, Ipv6Addr};

use crate::MacAddr;

/// DNS header length in bytes.
pub const DNS_HEADER_LEN: usize = 12;

/// DNS port.
pub const DNS_PORT: u16 = 53;

/// Multicast DNS UDP port (RFC 6762).
pub const MDNS_PORT: u16 = 5353;
/// Multicast DNS IPv4 link-local multicast destination (RFC 6762).
pub const MDNS_IPV4_MULTICAST: Ipv4Addr = Ipv4Addr::new(224, 0, 0, 251);
/// Multicast DNS IPv6 link-local multicast destination (RFC 6762).
pub const MDNS_IPV6_MULTICAST: Ipv6Addr = Ipv6Addr::new(0xff02, 0, 0, 0, 0, 0, 0, 0x00fb);
/// Alias that makes the IPv6 link-local scope explicit.
pub const MDNS_IPV6_LINK_LOCAL_MULTICAST: Ipv6Addr = MDNS_IPV6_MULTICAST;
/// Ethernet multicast destination derived from [`MDNS_IPV4_MULTICAST`].
pub const MDNS_IPV4_ETHERNET_MULTICAST: MacAddr =
    MacAddr::new([0x01, 0x00, 0x5e, 0x00, 0x00, 0xfb]);
/// Ethernet multicast destination derived from [`MDNS_IPV6_MULTICAST`].
pub const MDNS_IPV6_ETHERNET_MULTICAST: MacAddr =
    MacAddr::new([0x33, 0x33, 0x00, 0x00, 0x00, 0xfb]);
/// Source-backed response IP TTL / IPv6 hop-limit default for mDNS.
pub const MDNS_RESPONSE_TTL: u8 = 255;
/// Source-backed response IPv6 hop-limit / IP TTL default for mDNS.
pub const MDNS_RESPONSE_HOP_LIMIT: u8 = MDNS_RESPONSE_TTL;
/// mDNS top-bit mask for the QU question bit and RR cache-flush bit.
pub const MDNS_CLASS_BIT: u16 = 0x8000;
/// mDNS mask for the DNS class bits after removing [`MDNS_CLASS_BIT`].
pub const MDNS_CLASS_MASK: u16 = 0x7fff;
/// mDNS goodbye records carry TTL zero (RFC 6762).
pub const MDNS_GOODBYE_TTL: u32 = 0;
/// Default DNS-SD browsing domain used with mDNS (RFC 6762/RFC 6763).
pub const DNS_SD_DEFAULT_DOMAIN: &str = "local.";
/// DNS-SD service type enumeration name for the default mDNS domain.
pub const DNS_SD_SERVICE_ENUMERATION_NAME: &str = "_services._dns-sd._udp.local.";

/// Standard Internet class (IN), IANA DNS CLASSes.
pub const DNS_CLASS_IN: u16 = 1;
/// Chaos class (CH), IANA DNS CLASSes.
pub const DNS_CLASS_CH: u16 = 3;
/// Hesiod class (HS), IANA DNS CLASSes.
pub const DNS_CLASS_HS: u16 = 4;
/// QCLASS NONE, IANA DNS CLASSes (RFC 2136).
pub const DNS_CLASS_NONE: u16 = 254;
/// QCLASS ANY (`*`), IANA DNS CLASSes.
pub const DNS_CLASS_ANY: u16 = 255;

/// DNS A record type.
pub const DNS_TYPE_A: u16 = 1;
/// DNS NS record type.
pub const DNS_TYPE_NS: u16 = 2;
/// DNS CNAME record type.
pub const DNS_TYPE_CNAME: u16 = 5;
/// DNS SOA record type.
pub const DNS_TYPE_SOA: u16 = 6;
/// DNS PTR record type.
pub const DNS_TYPE_PTR: u16 = 12;
/// DNS MX record type.
pub const DNS_TYPE_MX: u16 = 15;
/// DNS TXT record type.
pub const DNS_TYPE_TXT: u16 = 16;
/// DNS AAAA record type.
pub const DNS_TYPE_AAAA: u16 = 28;
/// DNS SRV record type (RFC 2782).
pub const DNS_TYPE_SRV: u16 = 33;
/// DNS OPT pseudo-record type for EDNS(0) (RFC 6891).
pub const DNS_TYPE_OPT: u16 = 41;
/// DNS DS record type (RFC 4034).
pub const DNS_TYPE_DS: u16 = 43;
/// DNS RRSIG record type (RFC 4034).
pub const DNS_TYPE_RRSIG: u16 = 46;
/// DNS NSEC record type (RFC 4034).
pub const DNS_TYPE_NSEC: u16 = 47;
/// DNS DNSKEY record type (RFC 4034).
pub const DNS_TYPE_DNSKEY: u16 = 48;
/// DNS NSEC3 record type (RFC 5155).
pub const DNS_TYPE_NSEC3: u16 = 50;
/// DNS NSEC3PARAM record type (RFC 5155).
pub const DNS_TYPE_NSEC3PARAM: u16 = 51;
/// DNS TLSA record type (RFC 6698).
pub const DNS_TYPE_TLSA: u16 = 52;
/// DNS SVCB service-binding record type (RFC 9460).
pub const DNS_TYPE_SVCB: u16 = 64;
/// DNS HTTPS service-binding record type (RFC 9460).
pub const DNS_TYPE_HTTPS: u16 = 65;

/// DNS QUERY opcode, IANA DNS OpCodes.
pub const DNS_OPCODE_QUERY: u8 = 0;
/// DNS IQUERY (inverse query) opcode, obsolete, IANA DNS OpCodes.
pub const DNS_OPCODE_IQUERY: u8 = 1;
/// DNS STATUS opcode, IANA DNS OpCodes.
pub const DNS_OPCODE_STATUS: u8 = 2;
/// DNS NOTIFY opcode, IANA DNS OpCodes (RFC 1996).
pub const DNS_OPCODE_NOTIFY: u8 = 4;
/// DNS UPDATE opcode, IANA DNS OpCodes (RFC 2136).
pub const DNS_OPCODE_UPDATE: u8 = 5;
/// DNS Stateful Operations (DSO) opcode, IANA DNS OpCodes (RFC 8490).
pub const DNS_OPCODE_DSO: u8 = 6;

/// DNS NOERROR response code, IANA DNS RCODEs.
pub const DNS_RCODE_NOERROR: u8 = 0;
/// DNS FORMERR (format error) response code, IANA DNS RCODEs.
pub const DNS_RCODE_FORMERR: u8 = 1;
/// DNS SERVFAIL (server failure) response code, IANA DNS RCODEs.
pub const DNS_RCODE_SERVFAIL: u8 = 2;
/// DNS NXDOMAIN (non-existent domain) response code, IANA DNS RCODEs.
pub const DNS_RCODE_NXDOMAIN: u8 = 3;
/// DNS NOTIMP (not implemented) response code, IANA DNS RCODEs.
pub const DNS_RCODE_NOTIMP: u8 = 4;
/// DNS REFUSED response code, IANA DNS RCODEs.
pub const DNS_RCODE_REFUSED: u8 = 5;
/// DNS YXDOMAIN (name exists when it should not) response code (RFC 2136).
pub const DNS_RCODE_YXDOMAIN: u8 = 6;
/// DNS YXRRSET (RR set exists when it should not) response code (RFC 2136).
pub const DNS_RCODE_YXRRSET: u8 = 7;
/// DNS NXRRSET (RR set that should exist does not) response code (RFC 2136).
pub const DNS_RCODE_NXRRSET: u8 = 8;
/// DNS NOTAUTH (server not authoritative / not authorized) response code
/// (RFC 2136, RFC 8945).
pub const DNS_RCODE_NOTAUTH: u8 = 9;
/// DNS NOTZONE (name not contained in zone) response code (RFC 2136).
pub const DNS_RCODE_NOTZONE: u8 = 10;
/// DNS DSOTYPENI (DSO-TYPE not implemented) response code (RFC 8490).
pub const DNS_RCODE_DSOTYPENI: u8 = 11;

/// EDNS(0) option code NSID (RFC 5001), IANA DNS EDNS0 Option Codes.
pub const DNS_EDNS_OPTION_NSID: u16 = 3;
/// EDNS(0) option code DAU (RFC 6975), IANA DNS EDNS0 Option Codes.
pub const DNS_EDNS_OPTION_DAU: u16 = 5;
/// EDNS(0) option code DHU (RFC 6975), IANA DNS EDNS0 Option Codes.
pub const DNS_EDNS_OPTION_DHU: u16 = 6;
/// EDNS(0) option code N3U (RFC 6975), IANA DNS EDNS0 Option Codes.
pub const DNS_EDNS_OPTION_N3U: u16 = 7;
/// EDNS(0) option code edns-client-subnet (RFC 7871), IANA DNS EDNS0 Option
/// Codes.
pub const DNS_EDNS_OPTION_CLIENT_SUBNET: u16 = 8;
/// EDNS(0) option code EDNS EXPIRE (RFC 7314), IANA DNS EDNS0 Option Codes.
pub const DNS_EDNS_OPTION_EXPIRE: u16 = 9;
/// EDNS(0) option code COOKIE (RFC 7873), IANA DNS EDNS0 Option Codes.
pub const DNS_EDNS_OPTION_COOKIE: u16 = 10;
/// EDNS(0) option code edns-tcp-keepalive (RFC 7828), IANA DNS EDNS0 Option
/// Codes.
pub const DNS_EDNS_OPTION_TCP_KEEPALIVE: u16 = 11;
/// EDNS(0) option code Padding (RFC 7830), IANA DNS EDNS0 Option Codes.
pub const DNS_EDNS_OPTION_PADDING: u16 = 12;
/// EDNS(0) option code Extended DNS Error (RFC 8914), IANA DNS EDNS0 Option
/// Codes.
pub const DNS_EDNS_OPTION_EXTENDED_ERROR: u16 = 15;

/// Default EDNS(0) requestor UDP payload size carried in the OPT CLASS field
/// (RFC 6891 Section 6.2.5 recommends 4096 as a sensible default).
pub const DNS_EDNS_DEFAULT_UDP_PAYLOAD_SIZE: u16 = 4096;

/// SVCB/HTTPS SvcParamKey "mandatory" (RFC 9460 Section 8), IANA DNS SVCB
/// Service Parameter Keys (SvcParamKeys).
pub const DNS_SVCB_KEY_MANDATORY: u16 = 0;
/// SVCB/HTTPS SvcParamKey "alpn" (RFC 9460 Section 7.1), IANA DNS SVCB
/// SvcParamKeys.
pub const DNS_SVCB_KEY_ALPN: u16 = 1;
/// SVCB/HTTPS SvcParamKey "no-default-alpn" (RFC 9460 Section 7.1), IANA DNS
/// SVCB SvcParamKeys.
pub const DNS_SVCB_KEY_NO_DEFAULT_ALPN: u16 = 2;
/// SVCB/HTTPS SvcParamKey "port" (RFC 9460 Section 7.2), IANA DNS SVCB
/// SvcParamKeys.
pub const DNS_SVCB_KEY_PORT: u16 = 3;
/// SVCB/HTTPS SvcParamKey "ipv4hint" (RFC 9460 Section 7.3), IANA DNS SVCB
/// SvcParamKeys.
pub const DNS_SVCB_KEY_IPV4HINT: u16 = 4;
/// SVCB/HTTPS SvcParamKey "ech" (TLS Encrypted ClientHello Config), IANA DNS
/// SVCB SvcParamKeys.
pub const DNS_SVCB_KEY_ECH: u16 = 5;
/// SVCB/HTTPS SvcParamKey "ipv6hint" (RFC 9460 Section 7.3), IANA DNS SVCB
/// SvcParamKeys.
pub const DNS_SVCB_KEY_IPV6HINT: u16 = 6;
/// SVCB/HTTPS SvcParamKey "dohpath" (RFC 9461), IANA DNS SVCB SvcParamKeys.
pub const DNS_SVCB_KEY_DOHPATH: u16 = 7;

/// EDNS(0) DO ("DNSSEC OK") flag bit within the lower 16 bits of the OPT TTL
/// field (RFC 6891 Section 6.1.3; IANA EDNS Header Flags bit 0). In the full
/// 32-bit TTL word this is mask `0x0000_8000`.
pub const DNS_EDNS_FLAG_DO: u16 = 0x8000;

/// DNS response flag bit.
pub const DNS_FLAG_QR_RESPONSE: u16 = 0x8000;
/// DNS authoritative-answer flag bit.
pub const DNS_FLAG_AUTHORITATIVE: u16 = 0x0400;
/// DNS truncated flag bit.
pub const DNS_FLAG_TRUNCATED: u16 = 0x0200;
/// DNS recursion-desired flag bit.
pub const DNS_FLAG_RECURSION_DESIRED: u16 = 0x0100;
/// DNS recursion-available flag bit.
pub const DNS_FLAG_RECURSION_AVAILABLE: u16 = 0x0080;
/// DNS authentic-data flag bit.
pub const DNS_FLAG_AUTHENTIC_DATA: u16 = 0x0020;
/// DNS checking-disabled flag bit.
pub const DNS_FLAG_CHECKING_DISABLED: u16 = 0x0010;

#[cfg(test)]
mod mdns_constants_tests {
    use super::*;

    mod prelude_mdns_constants {
        use core::net::{Ipv4Addr, Ipv6Addr};

        use crate::prelude::*;

        pub(super) const PORT: u16 = MDNS_PORT;
        pub(super) const IPV4_MULTICAST: Ipv4Addr = MDNS_IPV4_MULTICAST;
        pub(super) const IPV6_MULTICAST: Ipv6Addr = MDNS_IPV6_MULTICAST;
        pub(super) const CLASS_BIT: u16 = MDNS_CLASS_BIT;
        pub(super) const SERVICE_ENUMERATION_NAME: &str = DNS_SD_SERVICE_ENUMERATION_NAME;
    }

    #[test]
    fn mdns_constants_match_source_backed_transport_and_multicast_values() {
        assert_eq!(MDNS_PORT, 5353);
        assert_eq!(MDNS_IPV4_MULTICAST, Ipv4Addr::new(224, 0, 0, 251));
        assert_eq!(
            MDNS_IPV6_MULTICAST,
            Ipv6Addr::new(0xff02, 0, 0, 0, 0, 0, 0, 0x00fb)
        );
        assert_eq!(MDNS_IPV6_LINK_LOCAL_MULTICAST, MDNS_IPV6_MULTICAST);
        assert!(MDNS_IPV4_MULTICAST.is_multicast());
        assert!(MDNS_IPV6_MULTICAST.is_multicast());
        assert_eq!(
            MDNS_IPV4_ETHERNET_MULTICAST,
            MacAddr::new([0x01, 0x00, 0x5e, 0x00, 0x00, 0xfb])
        );
        assert_eq!(
            MDNS_IPV6_ETHERNET_MULTICAST,
            MacAddr::new([0x33, 0x33, 0x00, 0x00, 0x00, 0xfb])
        );
        assert!(MDNS_IPV4_ETHERNET_MULTICAST.is_multicast());
        assert!(MDNS_IPV6_ETHERNET_MULTICAST.is_multicast());
    }

    #[test]
    fn mdns_constants_match_source_backed_class_ttl_and_dns_sd_values() {
        assert_eq!(MDNS_RESPONSE_TTL, 255);
        assert_eq!(MDNS_RESPONSE_HOP_LIMIT, 255);
        assert_eq!(MDNS_CLASS_BIT, 0x8000);
        assert_eq!(MDNS_CLASS_MASK, 0x7fff);
        assert_eq!(MDNS_CLASS_BIT | DNS_CLASS_IN, 0x8001);
        assert_eq!(
            (MDNS_CLASS_BIT | DNS_CLASS_IN) & MDNS_CLASS_MASK,
            DNS_CLASS_IN
        );
        assert_eq!(MDNS_GOODBYE_TTL, 0);
        assert_eq!(DNS_SD_DEFAULT_DOMAIN, "local.");
        assert_eq!(
            DNS_SD_SERVICE_ENUMERATION_NAME,
            "_services._dns-sd._udp.local."
        );
    }

    #[test]
    fn mdns_constants_are_exported_through_prelude() {
        assert_eq!(prelude_mdns_constants::PORT, 5353);
        assert_eq!(
            prelude_mdns_constants::IPV4_MULTICAST,
            Ipv4Addr::new(224, 0, 0, 251)
        );
        assert_eq!(
            prelude_mdns_constants::IPV6_MULTICAST,
            Ipv6Addr::new(0xff02, 0, 0, 0, 0, 0, 0, 0x00fb)
        );
        assert_eq!(prelude_mdns_constants::CLASS_BIT, 0x8000);
        assert_eq!(
            prelude_mdns_constants::SERVICE_ENUMERATION_NAME,
            "_services._dns-sd._udp.local."
        );
    }
}