domain 0.12.0

A DNS library for Rust.
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

//! Parsing DNS messages.

use core::iter::FusedIterator;

use crate::new::{
    base::{
        name::{NameBuf, RevNameBuf},
        Header, Message, MessageItem,
    },
    rdata::{Opt, RecordData},
};

use super::{ParseBytesZC, ParseError, SplitMessageBytes};

//----------- MessageParser --------------------------------------------------

/// A DNS message parser.
///
/// This offers a mid-level API for parsing the contents of a [`Message`].
#[derive(Clone)]
pub struct MessageParser<'a> {
    /// The message being parsed.
    message: &'a Message,

    /// The current offset into the message contents.
    offset: usize,

    /// The current section number.
    section: u8,

    /// The number of remaining items in this section.
    remaining_items: u16,
}

/// A parsed message item.
///
/// This is the concrete type of items parsed by [`MessageParser`].
pub type ParsedMessageItem<'a> =
    MessageItem<RevNameBuf, RecordData<'a, NameBuf>, &'a Opt>;

//--- Construction

impl<'a> MessageParser<'a> {
    /// Create a new [`MessageParser`].
    ///
    /// # Errors
    ///
    /// Fails if the byte sequence is less than 12 bytes long (as this can
    /// never constitute a valid DNS message).
    pub fn new(bytes: &'a [u8]) -> Result<Self, ParseError> {
        Message::parse_bytes_by_ref(bytes).map(Self::for_message)
    }

    /// Prepare a parser for the given message.
    pub const fn for_message(message: &'a Message) -> Self {
        Self {
            message,
            offset: 0,
            section: 0,
            remaining_items: message.header.counts.questions.get(),
        }
    }
}

//--- Inspection

impl<'a> MessageParser<'a> {
    /// The overall message being parsed.
    pub const fn message(&self) -> &'a Message {
        self.message
    }

    /// The message header.
    pub const fn header(&self) -> &'a Header {
        &self.message.header
    }

    /// The current offset into the message contents.
    pub const fn offset(&self) -> usize {
        self.offset
    }
}

//--- Iteration

impl<'a> Iterator for MessageParser<'a> {
    type Item = Result<ParsedMessageItem<'a>, ParseError>;

    fn next(&mut self) -> Option<Self::Item> {
        // Check for a remaining item.
        while self.remaining_items == 0 {
            if self.section < 3 {
                self.section += 1;
                let counts = self.message.header.counts;
                let count = counts.as_array()[self.section as usize];
                self.remaining_items = count.get();
            } else {
                // We're out of items.
                return None;
            }
        }

        /// Parse a specific variont of [`MessageItem`].
        fn parse_variant<'a, T: SplitMessageBytes<'a>>(
            parser: &mut MessageParser<'a>,
            f: impl FnOnce(T) -> ParsedMessageItem<'a>,
        ) -> Result<ParsedMessageItem<'a>, ParseError> {
            T::split_message_bytes(&parser.message.contents, parser.offset)
                .map(|(data, offset)| {
                    parser.offset = offset;
                    (f)(data)
                })
        }

        // Parse the item.
        self.remaining_items -= 1;
        let remaining = &self.message.contents[self.offset..];
        let item = match self.section {
            0 => parse_variant(self, MessageItem::Question),
            1 => parse_variant(self, MessageItem::Answer),
            2 => parse_variant(self, MessageItem::Authority),

            // An EDNS record starts with '0 0 41': the root record name and
            // the OPT record type.
            3 if remaining.starts_with(&[0, 0, 41]) => {
                parse_variant(self, MessageItem::Edns)
            }

            3 => parse_variant(self, MessageItem::Additional),
            _ => unreachable!(),
        };

        // If parsing failed, fuse the iterator.
        if item.is_err() {
            self.section = 3;
            self.remaining_items = 0;
        }

        Some(item)
    }
}

impl FusedIterator for MessageParser<'_> {}