simple_dns/dns/rdata/
soa.rs

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

simple_dns/dns/rdata/
soa.rs
