simple_dns/dns/rdata/
hinfo.rs

1use crate::{
2    bytes_buffer::BytesBuffer,
3    dns::{CharacterString, WireFormat},
4    lib::{Seek, Write},
5};
6
7use super::RR;
8
9/// HINFO records are used to acquire general information about a host.  
10/// The main use is for protocols such as FTP that can use special procedures
11/// when talking between machines or operating systems of the same type.
12#[derive(Debug, PartialEq, Eq, Hash, Clone)]
13pub struct HINFO<'a> {
14    /// A [CharacterString](`CharacterString`) which specifies the CPU type.
15    pub cpu: CharacterString<'a>,
16    /// A [CharacterString](`CharacterString`) which specifies the operating system type.
17    pub os: CharacterString<'a>,
18}
19
20impl RR for HINFO<'_> {
21    const TYPE_CODE: u16 = 13;
22}
23
24impl HINFO<'_> {
25    /// Transforms the inner data into its owned type
26    pub fn into_owned<'b>(self) -> HINFO<'b> {
27        HINFO {
28            cpu: self.cpu.into_owned(),
29            os: self.os.into_owned(),
30        }
31    }
32}
33
34impl<'a> WireFormat<'a> for HINFO<'a> {
35    const MINIMUM_LEN: usize = 0;
36
37    fn parse(data: &mut BytesBuffer<'a>) -> crate::Result<Self>
38    where
39        Self: Sized,
40    {
41        let cpu = CharacterString::parse(data)?;
42        let os = CharacterString::parse(data)?;
43
44        Ok(Self { cpu, os })
45    }
46
47    fn write_to<T: Write>(&self, out: &mut T) -> crate::Result<()> {
48        self.cpu.write_to(out)?;
49        self.os.write_to(out)
50    }
51
52    fn write_compressed_to<T: Write + Seek>(
53        &'a self,
54        out: &mut T,
55        name_refs: &mut crate::lib::BTreeMap<&[crate::Label<'a>], u16>,
56    ) -> crate::Result<()> {
57        self.cpu.write_compressed_to(out, name_refs)?;
58        self.os.write_compressed_to(out, name_refs)
59    }
60
61    fn len(&self) -> usize {
62        self.cpu.len() + self.os.len()
63    }
64}
65
66#[cfg(test)]
67mod tests {
68    use super::*;
69    use crate::lib::{ToString, Vec};
70
71    #[test]
72    fn parse_and_write_hinfo() {
73        let hinfo = HINFO {
74            cpu: CharacterString::new(b"\"some cpu").unwrap(),
75            os: CharacterString::new(b"\"some os").unwrap(),
76        };
77
78        let mut data = Vec::new();
79        assert!(hinfo.write_to(&mut data).is_ok());
80
81        let hinfo = HINFO::parse(&mut (&data[..]).into());
82        assert!(hinfo.is_ok());
83        let hinfo = hinfo.unwrap();
84
85        assert_eq!(data.len(), hinfo.len());
86        assert_eq!("\"some cpu", hinfo.cpu.to_string());
87        assert_eq!("\"some os", hinfo.os.to_string());
88    }
89
90    #[test]
91    #[cfg(feature = "std")]
92    fn parse_sample() -> Result<(), Box<dyn std::error::Error>> {
93        use crate::{rdata::RData, ResourceRecord};
94        let sample_file = std::fs::read("samples/zonefile/HINFO.sample")?;
95
96        let sample_rdata = match ResourceRecord::parse(&mut (&sample_file[..]).into())?.rdata {
97            RData::HINFO(rdata) => rdata,
98            _ => unreachable!(),
99        };
100
101        assert_eq!(sample_rdata.cpu, "Generic PC clone".try_into()?);
102        assert_eq!(sample_rdata.os, "NetBSD-1.4".try_into()?);
103        Ok(())
104    }
105}