forgedns-proto 0.1.1

DNS message model and wire codec primitives used by ForgeDNS
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
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
/*
 * SPDX-FileCopyrightText: 2025 Sven Shi
 * SPDX-License-Identifier: GPL-3.0-or-later
 */

//! Owned DNS name model.

use crate::core::error::{DnsError, Result};
use smallvec::SmallVec;
use std::fmt::{Display, Formatter};
use std::hash::{Hash, Hasher};
use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
use std::str::FromStr;
use std::sync::Arc;

const MAX_NAME_WIRE_OCTETS: usize = 255;
const MAX_COMPRESSION_POINTERS: usize = (MAX_NAME_WIRE_OCTETS + 1).div_ceil(2) - 2;

type WireBuf = SmallVec<[u8; 96]>;
type CanonicalFqdnBuf = SmallVec<[u8; 128]>;
type FqdnLabelOffsets = SmallVec<[u16; 8]>;
type WireLabelOffsets = SmallVec<[u8; 8]>;

const fn build_special_table() -> [bool; 256] {
    let mut table = [false; 256];
    table[b'.' as usize] = true;
    table[b' ' as usize] = true;
    table[b'\'' as usize] = true;
    table[b'@' as usize] = true;
    table[b';' as usize] = true;
    table[b'(' as usize] = true;
    table[b')' as usize] = true;
    table[b'"' as usize] = true;
    table[b'\\' as usize] = true;
    table
}

const fn build_decimal_escape_table() -> [[u8; 4]; 256] {
    let mut table = [[0u8; 4]; 256];
    let mut i = 0usize;
    while i < 256 {
        let b = i as u8;
        table[i] = [
            b'\\',
            b'0' + (b / 100),
            b'0' + ((b / 10) % 10),
            b'0' + (b % 10),
        ];
        i += 1;
    }
    table
}

const fn build_ascii_lowercase_table() -> [u8; 256] {
    let mut table = [0u8; 256];
    let mut i = 0usize;
    while i < 256 {
        let b = i as u8;
        table[i] = if b >= b'A' && b <= b'Z' { b + 32 } else { b };
        i += 1;
    }
    table
}

const SPECIAL_TABLE: [bool; 256] = build_special_table();
const DECIMAL_ESCAPE_TABLE: [[u8; 4]; 256] = build_decimal_escape_table();
const ASCII_LOWERCASE_TABLE: [u8; 256] = build_ascii_lowercase_table();

/// Owned DNS domain name.
///
/// Layout:
/// - `wire`: expanded wire name preserving original input/packet case
/// - `wire_label_offsets`: start offset of each label length octet in `wire`
/// - `presentation`: eagerly built canonical lowercased escaped fqdn with offsets
#[derive(Debug, Clone)]
pub struct Name {
    inner: Arc<NameInner>,
}

#[derive(Debug, Clone)]
struct NameInner {
    wire: WireBuf,
    wire_label_offsets: WireLabelOffsets,
    presentation: PresentationData,
}

#[derive(Debug, Clone)]
struct PresentationData {
    fqdn: CanonicalFqdnBuf,
    fqdn_label_offsets: FqdnLabelOffsets,
}

#[allow(dead_code)]
impl Name {
    /// Parse an ASCII domain name and normalize it into canonical form.
    #[inline]
    pub fn from_ascii(raw: &str) -> Result<Self> {
        let trimmed = raw.trim();
        if trimmed.is_empty() || trimmed == "." {
            return Ok(Self::root());
        }
        if !trimmed.is_ascii() {
            return Err(DnsError::protocol(
                "non-ascii dns names are not supported in presentation form",
            ));
        }

        let bytes = trimmed.as_bytes();
        let len = bytes.len();

        let mut wire = WireBuf::new();
        let mut wire_label_offsets = WireLabelOffsets::new();

        let mut idx = 0usize;
        let mut label_len = 0usize;
        let mut saw_any_label = false;
        let mut saw_trailing_root = false;

        // 当前 label 的长度字节所在位置
        let mut label_len_pos = wire.len();
        wire_label_offsets.push(0);
        wire.push(0);

        while idx < len {
            let b = bytes[idx];

            match b {
                b'.' => {
                    if label_len == 0 {
                        return Err(DnsError::protocol("dns name contains empty label"));
                    }

                    wire[label_len_pos] = label_len as u8;
                    saw_any_label = true;

                    idx += 1;
                    label_len = 0;

                    if idx == len {
                        saw_trailing_root = true;
                        break;
                    }

                    if wire.len() > u8::MAX as usize {
                        return Err(DnsError::protocol("dns name exceeds 255 bytes"));
                    }

                    label_len_pos = wire.len();
                    wire_label_offsets.push(label_len_pos as u8);
                    wire.push(0);
                }

                b'\\' => {
                    idx += 1;
                    if idx >= len {
                        return Err(DnsError::protocol("dns name ends with incomplete escape"));
                    }

                    let b0 = bytes[idx];
                    let d0 = b0.wrapping_sub(b'0');

                    let octet = if d0 <= 9 && idx + 2 < len {
                        let b1 = bytes[idx + 1];
                        let b2 = bytes[idx + 2];
                        let d1 = b1.wrapping_sub(b'0');
                        let d2 = b2.wrapping_sub(b'0');

                        if d1 <= 9 && d2 <= 9 {
                            let value = d0 as u32 * 100 + d1 as u32 * 10 + d2 as u32;
                            if value > 255 {
                                return Err(DnsError::protocol(format!(
                                    "dns name decimal escape exceeds 255: \\{value:03}"
                                )));
                            }
                            idx += 3;
                            value as u8
                        } else {
                            idx += 1;
                            b0
                        }
                    } else {
                        idx += 1;
                        b0
                    };

                    if label_len >= 63 {
                        return Err(DnsError::protocol("dns label exceeds 63 bytes"));
                    }

                    wire.push(octet);
                    label_len += 1;
                }

                _ => {
                    if label_len >= 63 {
                        return Err(DnsError::protocol("dns label exceeds 63 bytes"));
                    }

                    wire.push(b);
                    label_len += 1;
                    idx += 1;
                }
            }
        }

        if label_len != 0 {
            wire[label_len_pos] = label_len as u8;
            saw_any_label = true;
        }

        if !saw_any_label {
            if saw_trailing_root {
                return Ok(Self::root());
            }
            return Err(DnsError::protocol("dns name contains no labels"));
        }

        wire.push(0);

        if wire.len() > MAX_NAME_WIRE_OCTETS {
            return Err(DnsError::protocol("dns name exceeds 255 bytes"));
        }

        Ok(Self::from_wire_parts(wire, wire_label_offsets))
    }

    /// Return the DNS root name.
    pub fn root() -> Self {
        let mut wire = WireBuf::new();
        wire.push(0);

        Self::from_wire_parts(wire, WireLabelOffsets::new())
    }

    /// Borrow the canonical fqdn presentation without a trailing dot.
    #[inline]
    pub fn as_str(&self) -> &str {
        unsafe { std::str::from_utf8_unchecked(&self.presentation().fqdn) }
    }

    /// Return the canonical fqdn presentation with a trailing dot.
    #[inline]
    pub fn to_fqdn(&self) -> String {
        if self.is_root() {
            ".".to_string()
        } else {
            let mut fqdn = String::with_capacity(self.as_str().len() + 1);
            fqdn.push_str(self.as_str());
            fqdn.push('.');
            fqdn
        }
    }

    /// Report whether the name is the DNS root.
    #[inline]
    pub fn is_root(&self) -> bool {
        self.inner.wire_label_offsets.is_empty()
    }

    /// Return the matcher-friendly normalized form without a trailing dot.
    #[inline]
    pub fn normalized(&self) -> &str {
        self.as_str()
    }

    /// Iterate labels in presentation order.
    pub fn labels(&self) -> NameLabels<'_> {
        NameLabels {
            name: self,
            index: 0,
            len: self.label_count(),
        }
    }

    /// Iterate labels from right to left without allocation.
    pub fn iter_labels_rev(&self) -> NameLabelsRev<'_> {
        NameLabelsRev {
            name: self,
            index: self.label_count(),
        }
    }

    /// Iterate wire label bytes in presentation order.
    pub(crate) fn iter_wire_labels(&self) -> WireLabels<'_> {
        WireLabels {
            name: self,
            index: 0,
            len: self.label_count(),
        }
    }

    #[inline]
    pub(crate) fn wire_label_meta_at(&self, index: usize) -> (u8, &[u8], &[u8]) {
        let len_pos = self.inner.wire_label_offsets[index] as usize;
        let len = self.inner.wire[len_pos];
        let start = len_pos + 1;
        let end = start + len as usize;
        (
            len,
            &self.inner.wire[start..end],
            &self.inner.wire[len_pos..],
        )
    }

    #[inline]
    pub(crate) fn wire_label_len_and_suffix_at(&self, index: usize) -> (u8, &[u8]) {
        let len_pos = self.inner.wire_label_offsets[index] as usize;
        let len = self.inner.wire[len_pos];
        (len, &self.inner.wire[len_pos..])
    }

    /// Number of labels in this name.
    #[inline]
    pub(crate) fn label_count(&self) -> usize {
        self.inner.wire_label_offsets.len()
    }

    /// Borrow one label from the canonical fqdn representation.
    #[inline]
    pub(crate) fn fqdn_label_at(&self, index: usize) -> &[u8] {
        let presentation = self.presentation();
        let start = presentation.fqdn_label_offsets[index] as usize;
        let end = presentation
            .fqdn_label_offsets
            .get(index + 1)
            .copied()
            .map(|v| v as usize - 1)
            .unwrap_or(presentation.fqdn.len());
        &presentation.fqdn[start..end]
    }

    /// Borrow one label from the expanded wire representation.
    #[inline]
    pub(crate) fn wire_label_at(&self, index: usize) -> &[u8] {
        let len_pos = self.inner.wire_label_offsets[index] as usize;
        let len = self.inner.wire[len_pos] as usize;
        let start = len_pos + 1;
        let end = start + len;
        &self.inner.wire[start..end]
    }

    /// Borrow the canonical suffix from label index `index` to the end, without a trailing dot.
    #[inline]
    pub(crate) fn suffix_from(&self, index: usize) -> &str {
        let start = self.presentation().fqdn_label_offsets[index] as usize;
        &self.as_str()[start..]
    }

    /// Borrow the original-case wire suffix from `wire`, including the terminating root label.
    #[inline]
    pub(crate) fn wire_suffix_from(&self, index: usize) -> &[u8] {
        if index == self.label_count() {
            &self.inner.wire[self.inner.wire.len() - 1..]
        } else {
            let start = self.inner.wire_label_offsets[index] as usize;
            &self.inner.wire[start..]
        }
    }

    /// Borrow the expanded wire name.
    #[inline]
    pub(crate) fn wire(&self) -> &[u8] {
        &self.inner.wire
    }

    /// Return the DNS wire length without compression.
    #[inline]
    pub fn bytes_len(&self) -> usize {
        self.inner.wire.len()
    }

    /// Return encoded byte length at offset `off` with optional compression.
    #[inline]
    pub(crate) fn bytes_len_at<'a>(
        &'a self,
        compress: bool,
        compression: &mut crate::proto::codec::LenCompressionMap<'a>,
    ) -> usize {
        crate::proto::codec::domain_name_len(self, compression, compress)
    }

    /// Parse `in-addr.arpa` and `ip6.arpa` names into concrete IP addresses.
    pub fn parse_arpa_name(&self) -> Result<ParsedArpaName> {
        let raw = self.normalized();

        if let Some(prefix) = raw.strip_suffix(".in-addr.arpa") {
            let mut parts = prefix
                .split('.')
                .filter(|part| !part.is_empty())
                .collect::<Vec<_>>();
            if parts.len() != 4 {
                return Err(DnsError::protocol("invalid in-addr.arpa name"));
            }
            parts.reverse();
            let mut octets = [0u8; 4];
            for (idx, part) in parts.into_iter().enumerate() {
                octets[idx] = part
                    .parse::<u8>()
                    .map_err(|_| DnsError::protocol("invalid in-addr.arpa octet"))?;
            }
            return Ok(ParsedArpaName {
                addr: IpAddr::V4(Ipv4Addr::from(octets)),
            });
        }

        if let Some(prefix) = raw.strip_suffix(".ip6.arpa") {
            let nibbles = prefix
                .split('.')
                .filter(|part| !part.is_empty())
                .collect::<Vec<_>>();
            if nibbles.len() != 32 {
                return Err(DnsError::protocol("invalid ip6.arpa name"));
            }

            let mut hex = String::with_capacity(32);
            for nibble in nibbles.iter().rev() {
                if nibble.len() != 1 || !nibble.as_bytes()[0].is_ascii_hexdigit() {
                    return Err(DnsError::protocol("invalid ip6.arpa nibble"));
                }
                hex.push_str(nibble);
            }

            let mut bytes = [0u8; 16];
            for idx in 0..16 {
                bytes[idx] = u8::from_str_radix(&hex[idx * 2..idx * 2 + 2], 16)
                    .map_err(|_| DnsError::protocol("invalid ip6.arpa nibble"))?;
            }
            return Ok(ParsedArpaName {
                addr: IpAddr::V6(Ipv6Addr::from(bytes)),
            });
        }

        Err(DnsError::protocol("name is not a supported arpa name"))
    }

    pub(crate) fn parse(packet: &[u8], start: usize) -> Result<(Self, usize)> {
        if start >= packet.len() {
            return Err(DnsError::protocol("dns name offset exceeds packet length"));
        }

        let mut cursor = start;
        let mut next_offset = None;
        let mut wire = WireBuf::new();
        let mut wire_label_offsets = WireLabelOffsets::new();
        let mut visited = SmallVec::<[u16; 16]>::new();
        let mut pointer_count = 0usize;
        let mut wire_budget = MAX_NAME_WIRE_OCTETS;

        loop {
            if cursor >= packet.len() {
                return Err(DnsError::protocol("dns name exceeds packet length"));
            }
            let len = unsafe { *packet.get_unchecked(cursor) };

            match len & 0xC0 {
                0x00 => {
                    // root
                    if len == 0 {
                        let end = next_offset.unwrap_or(cursor + 1);

                        if wire_label_offsets.is_empty() {
                            return Ok((Self::root(), end));
                        }
                        wire.push(0);

                        if wire.len() > MAX_NAME_WIRE_OCTETS {
                            return Err(DnsError::protocol("dns name exceeds 255 bytes"));
                        }

                        return Ok((Self::from_wire_parts(wire, wire_label_offsets), end));
                    }

                    if len > 63 {
                        return Err(DnsError::protocol("dns label length exceeds 63 bytes"));
                    }

                    // label
                    let label_start = cursor + 1;
                    let label_end = label_start + len as usize;
                    if label_end > packet.len() {
                        return Err(DnsError::protocol("dns label exceeds packet length"));
                    }

                    wire_budget = wire_budget
                        .checked_sub(len as usize + 1)
                        .ok_or_else(|| DnsError::protocol("dns name exceeds 255 bytes"))?;

                    wire_label_offsets.push(
                        u8::try_from(wire.len())
                            .map_err(|_| DnsError::protocol("dns name exceeds 255 bytes"))?,
                    );

                    wire.push(len);
                    if label_end > packet.len() {
                        return Err(DnsError::protocol("dns name label exceeds packet length"));
                    }
                    let label = unsafe { packet.get_unchecked(label_start..label_end) };
                    wire.extend_from_slice(label);

                    cursor = label_end;
                }
                // pointer
                0xC0 => {
                    let low = *packet
                        .get(cursor + 1)
                        .ok_or_else(|| DnsError::protocol("truncated dns compression pointer"))?;
                    let ptr = (((len as u16 & 0x3F) << 8) | low as u16) as usize;

                    if ptr >= packet.len() {
                        return Err(DnsError::protocol(
                            "dns compression pointer exceeds packet length",
                        ));
                    }
                    if visited.contains(&(ptr as u16)) {
                        return Err(DnsError::protocol(
                            "dns name compression pointer loop detected",
                        ));
                    }

                    pointer_count += 1;
                    if pointer_count > MAX_COMPRESSION_POINTERS {
                        return Err(DnsError::protocol("too many dns compression pointers"));
                    }

                    if next_offset.is_none() {
                        next_offset = Some(cursor + 2);
                    }
                    visited.push(ptr as u16);
                    cursor = ptr;
                }
                _ => return Err(DnsError::protocol("invalid dns label type")),
            }
        }
    }
}

impl Name {
    #[inline]
    fn from_wire_parts(wire: WireBuf, wire_label_offsets: WireLabelOffsets) -> Self {
        let presentation = build_presentation_from_wire(&wire, &wire_label_offsets);
        Self {
            inner: Arc::new(NameInner {
                wire,
                wire_label_offsets,
                presentation,
            }),
        }
    }

    #[inline]
    fn presentation(&self) -> &PresentationData {
        &self.inner.presentation
    }
}

fn build_presentation_from_wire(
    wire: &[u8],
    wire_label_offsets: &WireLabelOffsets,
) -> PresentationData {
    if wire_label_offsets.is_empty() {
        let fqdn = CanonicalFqdnBuf::new();
        return PresentationData {
            fqdn,
            fqdn_label_offsets: FqdnLabelOffsets::new(),
        };
    }

    let mut fqdn = CanonicalFqdnBuf::new();
    let mut fqdn_label_offsets = FqdnLabelOffsets::with_capacity(wire_label_offsets.len());

    for (index, len_pos) in wire_label_offsets.iter().copied().enumerate() {
        if index > 0 {
            fqdn.push(b'.');
        }
        fqdn_label_offsets.push(fqdn.len() as u16);

        let len_pos = len_pos as usize;
        let len = wire[len_pos] as usize;
        let start = len_pos + 1;
        let end = start + len;
        let mut i = start;
        while i < end {
            let byte = unsafe { *wire.get_unchecked(i) };
            let lower = unsafe { *ASCII_LOWERCASE_TABLE.get_unchecked(byte as usize) };
            append_presentation_octet_unchecked(&mut fqdn, lower);
            i += 1;
        }
    }
    PresentationData {
        fqdn,
        fqdn_label_offsets,
    }
}

#[inline(always)]
fn append_presentation_octet_unchecked(out: &mut CanonicalFqdnBuf, byte: u8) {
    if (b' '..=b'~').contains(&byte) {
        let special = unsafe { *SPECIAL_TABLE.get_unchecked(byte as usize) };
        if special {
            out.push(b'\\');
            out.push(byte);
        } else {
            out.push(byte);
        }
    } else {
        let escaped = unsafe { DECIMAL_ESCAPE_TABLE.get_unchecked(byte as usize) };
        out.extend_from_slice(escaped);
    }
}

impl PartialEq for Name {
    fn eq(&self, other: &Self) -> bool {
        self.as_str() == other.as_str()
    }
}

impl Eq for Name {}

impl Hash for Name {
    fn hash<H: Hasher>(&self, state: &mut H) {
        self.as_str().hash(state);
    }
}

impl Display for Name {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        f.write_str(self.as_str())
    }
}

impl FromStr for Name {
    type Err = DnsError;

    fn from_str(s: &str) -> Result<Self> {
        Self::from_ascii(s)
    }
}

/// Iterator over labels in presentation order.
pub struct NameLabels<'a> {
    name: &'a Name,
    index: usize,
    len: usize,
}

impl<'a> Iterator for NameLabels<'a> {
    type Item = &'a str;

    fn next(&mut self) -> Option<Self::Item> {
        let index = self.index;
        if index >= self.len {
            return None;
        }
        self.index += 1;
        let label = self.name.fqdn_label_at(index);
        Some(unsafe { std::str::from_utf8_unchecked(label) })
    }
}

/// Iterator over wire label bytes from owned names.
pub(crate) struct WireLabels<'a> {
    name: &'a Name,
    index: usize,
    len: usize,
}

impl<'a> Iterator for WireLabels<'a> {
    type Item = &'a [u8];

    fn next(&mut self) -> Option<Self::Item> {
        let index = self.index;
        if index >= self.len {
            return None;
        }
        self.index += 1;
        Some(self.name.wire_label_at(index))
    }
}

/// Iterator over normalized labels from right to left.
pub struct NameLabelsRev<'a> {
    name: &'a Name,
    index: usize,
}

impl<'a> Iterator for NameLabelsRev<'a> {
    type Item = &'a str;

    fn next(&mut self) -> Option<Self::Item> {
        if self.index == 0 {
            return None;
        }
        self.index -= 1;
        let label = self.name.fqdn_label_at(self.index);
        Some(unsafe { std::str::from_utf8_unchecked(label) })
    }
}

/// Parsed reverse-lookup name converted back into an IP address.
#[derive(Debug, Clone, Copy, Eq, PartialEq)]
pub struct ParsedArpaName {
    addr: IpAddr,
}

impl ParsedArpaName {
    /// Return the parsed IP address.
    pub fn addr(&self) -> IpAddr {
        self.addr
    }
}

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

    #[test]
    // Basic byte-for-byte name roundtrips, including root and an escaped dot label.
    fn parse_wire_name_roundtrip_cases() {
        let cases: &[(&[u8], &str)] = &[
            (&[0], "."),
            (
                &[
                    7, b'e', b'x', b'a', b'm', b'p', b'l', b'e', 3, b'c', b'o', b'm', 0,
                ],
                "example.com.",
            ),
            (
                &[5, b'a', b'a', b'.', b'b', b'b', 2, b'n', b'l', 0],
                "aa\\.bb.nl.",
            ),
        ];

        for (packet, fqdn) in cases {
            let (name, next) = Name::parse(packet, 0).unwrap();
            assert_eq!(next, packet.len());
            assert_eq!(name.wire(), *packet);
            assert_eq!(name.to_fqdn(), *fqdn);
        }
    }

    #[test]
    // Reserved label type prefixes 01xxxxxx and 10xxxxxx are forbidden by RFC 1035.
    fn parse_wire_name_rejects_reserved_label_types() {
        for packet in [
            [7, b'e', b'x', b'a', b'm', b'p', b'l', b'e', 0x80],
            [7, b'e', b'x', b'a', b'm', b'p', b'l', b'e', 0x40],
        ] {
            let err = Name::parse(&packet, 0).expect_err("reserved label type must fail");
            assert!(err.to_string().contains("invalid dns label type"));
        }
    }

    #[test]
    // Reverse-lookup helpers are used by matchers and should stay stable for both IPv4
    // and IPv6 nibble-style names.
    fn parse_arpa_name_roundtrip_examples() {
        let v4 = Name::from_ascii("4.3.2.1.in-addr.arpa.").unwrap();
        assert_eq!(
            v4.parse_arpa_name().unwrap().addr(),
            IpAddr::V4(Ipv4Addr::new(1, 2, 3, 4))
        );

        let v6 = Name::from_ascii(
            "1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.8.b.d.0.1.0.0.2.ip6.arpa.",
        )
        .unwrap();
        assert_eq!(
            v6.parse_arpa_name().unwrap().addr(),
            IpAddr::V6("2001:db8::1".parse().unwrap())
        );
    }

    #[test]
    // Covers one valid compressed suffix case plus the most valuable malformed
    // pointer variants.
    fn parse_wire_name_pointer_matrix() {
        let cases: Vec<(&str, Vec<u8>, bool)> = vec![
            (
                "compressed suffix",
                vec![
                    7, b'e', b'x', b'a', b'm', b'p', b'l', b'e', 3, b'c', b'o', b'm', 0, 3, b'w',
                    b'w', b'w', 0xc0, 0x00,
                ],
                true,
            ),
            ("pointer loop", vec![0xc0, 0x00], false),
            ("truncated pointer", vec![0xc0], false),
            ("pointer past end", vec![0xc0, 0x10], false),
            ("label exceeds packet", vec![3, b'w'], false),
        ];

        for (name, packet, ok) in cases {
            let start = if ok { 13 } else { 0 };
            let result = Name::parse(&packet, start);
            assert_eq!(result.is_ok(), ok, "{name}");
            if let Ok((parsed, _)) = result {
                assert_eq!(parsed.to_fqdn(), "www.example.com.");
            }
        }
    }

    #[test]
    fn from_ascii_accepts_decimal_escape_upper_bound() {
        let name = Name::from_ascii("bad\\255char.example.").expect("255 escape should parse");

        assert_eq!(name.wire_label_at(0), b"bad\xffchar");
        assert_eq!(name.to_fqdn(), "bad\\255char.example.");
    }

    #[test]
    fn from_ascii_rejects_decimal_escape_above_u8_range() {
        for raw in ["bad\\256char.example.", "bad\\999char.example."] {
            let err = Name::from_ascii(raw).expect_err("overflowing decimal escape must fail");
            assert!(err.to_string().contains("decimal escape exceeds 255"));
        }
    }
}