simple_dns/dns/rdata/
soa.rs

1use std::collections::HashMap;
2
3use crate::{
4    bytes_buffer::BytesBuffer,
5    dns::{name::Label, Name, WireFormat},
6};
7
8use super::RR;
9
10/// SOA records are used to mark the start of a zone of authority
11#[derive(Debug, PartialEq, Eq, Hash, Clone)]
12pub struct SOA<'a> {
13    /// The [Name](`Name`) of the name server that was the original or primary source of data for this zone.
14    pub mname: Name<'a>,
15    /// A [Name](`Name`) which specifies the mailbox of the person responsible for this zone.
16    pub rname: Name<'a>,
17    /// The unsigned 32 bit version number of the original copy of the zone.  Zone transfers preserve this value.  
18    /// This value wraps and should be compared using sequence space arithmetic.
19    pub serial: u32,
20    /// A 32 bit time interval before the zone should be refreshed.
21    pub refresh: i32,
22    /// A 32 bit time interval that should elapse before a failed refresh should be retried.
23    pub retry: i32,
24    /// A 32 bit time value that specifies the upper limit on the time interval that can elapse before the zone is no longer authoritative.
25    pub expire: i32,
26    /// The unsigned 32 bit minimum TTL field that should be exported with any RR from this zone.
27    pub minimum: u32,
28}
29
30impl RR for SOA<'_> {
31    const TYPE_CODE: u16 = 6;
32}
33
34impl SOA<'_> {
35    /// Transforms the inner data into its owned type
36    pub fn into_owned<'b>(self) -> SOA<'b> {
37        SOA {
38            mname: self.mname.into_owned(),
39            rname: self.rname.into_owned(),
40            serial: self.serial,
41            refresh: self.refresh,
42            retry: self.retry,
43            expire: self.expire,
44            minimum: self.minimum,
45        }
46    }
47
48    fn write_common<T: std::io::Write>(&self, out: &mut T) -> crate::Result<()> {
49        out.write_all(&self.serial.to_be_bytes())?;
50        out.write_all(&self.refresh.to_be_bytes())?;
51        out.write_all(&self.retry.to_be_bytes())?;
52        out.write_all(&self.expire.to_be_bytes())?;
53        out.write_all(&self.minimum.to_be_bytes())?;
54
55        Ok(())
56    }
57}
58
59impl<'a> WireFormat<'a> for SOA<'a> {
60    const MINIMUM_LEN: usize = 20;
61
62    fn parse(data: &mut BytesBuffer<'a>) -> crate::Result<Self>
63    where
64        Self: Sized,
65    {
66        let mname = Name::parse(data)?;
67        let rname = Name::parse(data)?;
68
69        let serial = data.get_u32()?;
70        let refresh = data.get_i32()?;
71        let retry = data.get_i32()?;
72        let expire = data.get_i32()?;
73        let minimum = data.get_u32()?;
74
75        Ok(Self {
76            mname,
77            rname,
78            serial,
79            refresh,
80            retry,
81            expire,
82            minimum,
83        })
84    }
85
86    fn write_to<T: std::io::Write>(&self, out: &mut T) -> crate::Result<()> {
87        self.mname.write_to(out)?;
88        self.rname.write_to(out)?;
89        self.write_common(out)
90    }
91
92    fn write_compressed_to<T: std::io::Write + std::io::Seek>(
93        &'a self,
94        out: &mut T,
95        name_refs: &mut HashMap<&'a [Label<'a>], usize>,
96    ) -> crate::Result<()> {
97        self.mname.write_compressed_to(out, name_refs)?;
98        self.rname.write_compressed_to(out, name_refs)?;
99        self.write_common(out)
100    }
101
102    fn len(&self) -> usize {
103        self.mname.len() + self.rname.len() + Self::MINIMUM_LEN
104    }
105}
106
107#[cfg(test)]
108mod tests {
109    use crate::{rdata::RData, ResourceRecord};
110
111    use super::*;
112    #[test]
113    fn parse_and_write_soa() {
114        let soa = SOA {
115            mname: Name::new("mname.soa.com").unwrap(),
116            rname: Name::new("rname.soa.com").unwrap(),
117            serial: 1,
118            refresh: 2,
119            retry: 3,
120            expire: 4,
121            minimum: 5,
122        };
123
124        let mut data = Vec::new();
125        assert!(soa.write_to(&mut data).is_ok());
126
127        let soa = SOA::parse(&mut data[..].into());
128        assert!(soa.is_ok());
129        let soa = soa.unwrap();
130
131        assert_eq!(data.len(), soa.len());
132    }
133
134    #[test]
135    fn parse_soa_sample() -> Result<(), Box<dyn std::error::Error>> {
136        let sample_file = std::fs::read("samples/zonefile/SOA.sample")?;
137
138        let sample_rdata = match ResourceRecord::parse(&mut sample_file[..].into())?.rdata {
139            RData::SOA(rdata) => rdata,
140            _ => unreachable!(),
141        };
142
143        assert_eq!(sample_rdata.mname, "VENERA.sample".try_into()?);
144        assert_eq!(
145            sample_rdata.rname,
146            [
147                Label::new_unchecked(b"Action.domains"),
148                Label::new_unchecked(b"sample")
149            ]
150            .into()
151        );
152        assert_eq!(sample_rdata.serial, 20);
153        assert_eq!(sample_rdata.refresh, 7200);
154        assert_eq!(sample_rdata.retry, 600);
155        assert_eq!(sample_rdata.expire, 3600000);
156        assert_eq!(sample_rdata.minimum, 60);
157
158        Ok(())
159    }
160}
simple_dns/dns/rdata/soa.rs

simple_dns/dns/rdata/
soa.rs
