Refuse to include \s in the JSON output of a TXT record
[dnssec-prover] / src / rr.rs
index c80bfbbc985c5e56b15d22c510f80c74a8486892..86f5a807e12accf5504243fb1e145871b5775aa7 100644 (file)
--- a/src/rr.rs
+++ b/src/rr.rs
@@ -9,6 +9,7 @@ use alloc::borrow::ToOwned;
 use alloc::format;
 
 use core::cmp::{self, Ordering};
+use core::fmt;
 use core::fmt::Write;
 
 use crate::ser::*;
@@ -22,23 +23,49 @@ pub struct Name(String);
 impl Name {
        /// Gets the underlying human-readable domain name
        pub fn as_str(&self) -> &str { &self.0 }
+       /// Gets the number of labels in this name
+       pub fn labels(&self) -> u8 {
+               if self.as_str() == "." {
+                       0
+               } else {
+                       self.as_str().chars().filter(|c| *c == '.').count() as u8
+               }
+       }
+       /// Gets a string containing the last `n` labels in this [`Name`] (which is also a valid name).
+       pub fn trailing_n_labels(&self, n: u8) -> Option<&str> {
+               let labels = self.labels();
+               if n > labels {
+                       None
+               } else if n == labels {
+                       Some(self.as_str())
+               } else if n == 0 {
+                       Some(".")
+               } else {
+                       self.as_str().splitn(labels as usize - n as usize + 1, ".").last()
+               }
+       }
 }
 impl core::ops::Deref for Name {
        type Target = str;
        fn deref(&self) -> &str { &self.0 }
 }
+impl fmt::Display for Name {
+       fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
+               self.0.fmt(f)
+       }
+}
 impl TryFrom<String> for Name {
        type Error = ();
        fn try_from(s: String) -> Result<Name, ()> {
                if s.is_empty() { return Err(()); }
                if *s.as_bytes().last().unwrap_or(&0) != b"."[0] { return Err(()); }
                if s.len() > 255 { return Err(()); }
-               if s.chars().any(|c| !c.is_ascii_graphic() && c != '.' && c != '-') { return Err(()); }
+               if s.chars().any(|c| !c.is_ascii_graphic() || c == '"') { return Err(()); }
                for label in s.split(".") {
                        if label.len() > 63 { return Err(()); }
                }
 
-               Ok(Name(s))
+               Ok(Name(s.to_ascii_lowercase()))
        }
 }
 impl TryFrom<&str> for Name {
@@ -66,6 +93,8 @@ pub enum RR {
        TLSA(TLSA),
        /// A Canonical Name record
        CName(CName),
+       /// A Delegation Name record
+       DName(DName),
        /// A DNS (Public) Key resource record
        DnsKey(DnsKey),
        /// A Delegated Signer resource record
@@ -82,6 +111,7 @@ impl RR {
                        RR::NS(rr) => &rr.name,
                        RR::Txt(rr) => &rr.name,
                        RR::CName(rr) => &rr.name,
+                       RR::DName(rr) => &rr.name,
                        RR::TLSA(rr) => &rr.name,
                        RR::DnsKey(rr) => &rr.name,
                        RR::DS(rr) => &rr.name,
@@ -96,6 +126,7 @@ impl RR {
                        RR::NS(rr) => StaticRecord::json(rr),
                        RR::Txt(rr) => StaticRecord::json(rr),
                        RR::CName(rr) => StaticRecord::json(rr),
+                       RR::DName(rr) => StaticRecord::json(rr),
                        RR::TLSA(rr) => StaticRecord::json(rr),
                        RR::DnsKey(rr) => StaticRecord::json(rr),
                        RR::DS(rr) => StaticRecord::json(rr),
@@ -109,6 +140,7 @@ impl RR {
                        RR::NS(_) => NS::TYPE,
                        RR::Txt(_) => Txt::TYPE,
                        RR::CName(_) => CName::TYPE,
+                       RR::DName(_) => DName::TYPE,
                        RR::TLSA(_) => TLSA::TYPE,
                        RR::DnsKey(_) => DnsKey::TYPE,
                        RR::DS(_) => DS::TYPE,
@@ -122,6 +154,7 @@ impl RR {
                        RR::NS(rr) => StaticRecord::write_u16_len_prefixed_data(rr, out),
                        RR::Txt(rr) => StaticRecord::write_u16_len_prefixed_data(rr, out),
                        RR::CName(rr) => StaticRecord::write_u16_len_prefixed_data(rr, out),
+                       RR::DName(rr) => StaticRecord::write_u16_len_prefixed_data(rr, out),
                        RR::TLSA(rr) => StaticRecord::write_u16_len_prefixed_data(rr, out),
                        RR::DnsKey(rr) => StaticRecord::write_u16_len_prefixed_data(rr, out),
                        RR::DS(rr) => StaticRecord::write_u16_len_prefixed_data(rr, out),
@@ -134,6 +167,7 @@ impl From<AAAA> for RR { fn from(aaaa: AAAA) -> RR { RR::AAAA(aaaa) } }
 impl From<NS> for RR { fn from(ns: NS) -> RR { RR::NS(ns) } }
 impl From<Txt> for RR { fn from(txt: Txt) -> RR { RR::Txt(txt) } }
 impl From<CName> for RR { fn from(cname: CName) -> RR { RR::CName(cname) } }
+impl From<DName> for RR { fn from(cname: DName) -> RR { RR::DName(cname) } }
 impl From<TLSA> for RR { fn from(tlsa: TLSA) -> RR { RR::TLSA(tlsa) } }
 impl From<DnsKey> for RR { fn from(dnskey: DnsKey) -> RR { RR::DnsKey(dnskey) } }
 impl From<DS> for RR { fn from(ds: DS) -> RR { RR::DS(ds) } }
@@ -189,6 +223,8 @@ pub struct Txt {
        /// is an arbitrary series of bytes here.
        pub data: Vec<u8>,
 }
+/// The wire type for TXT records
+pub const TXT_TYPE: u16 = 16;
 impl PartialOrd for Txt {
        fn partial_cmp(&self, o: &Txt) -> Option<Ordering> {
                Some(self.name.cmp(&o.name)
@@ -207,18 +243,18 @@ impl PartialOrd for Txt {
        }
 }
 impl StaticRecord for Txt {
-       const TYPE: u16 = 16;
+       const TYPE: u16 = TXT_TYPE;
        fn name(&self) -> &Name { &self.name }
        fn json(&self) -> String {
                if let Ok(s) = core::str::from_utf8(&self.data) {
-                       if s.chars().all(|c| !c.is_control() && c != '"') {
+                       if s.chars().all(|c| !c.is_control() && c != '"' && c != '\\') {
                                return format!("{{\"type\":\"txt\",\"name\":\"{}\",\"contents\":\"{}\"}}", self.name.0, s);
                        }
                }
                format!("{{\"type\":\"txt\",\"name\":\"{}\",\"contents\":{:?}}}", self.name.0, &self.data[..])
        }
        fn read_from_data(name: Name, mut data: &[u8], _wire_packet: &[u8]) -> Result<Self, ()> {
-               let mut parsed_data = Vec::with_capacity(data.len() - 1);
+               let mut parsed_data = Vec::with_capacity(data.len().saturating_sub(1));
                while !data.is_empty() {
                        let len = read_u8(&mut data)? as usize;
                        if data.len() < len { return Err(()); }
@@ -263,8 +299,10 @@ pub struct TLSA {
        /// The certificate data or hash of the certificate data itself.
        pub data: Vec<u8>,
 }
+/// The wire type for TLSA records
+pub const TLSA_TYPE: u16 = 52;
 impl StaticRecord for TLSA {
-       const TYPE: u16 = 52;
+       const TYPE: u16 = TLSA_TYPE;
        fn name(&self) -> &Name { &self.name }
        fn json(&self) -> String {
                let mut out = String::with_capacity(128+self.data.len()*2);
@@ -300,7 +338,7 @@ pub struct CName {
        pub name: Name,
        /// The canonical name.
        ///
-       /// A resolver should use this name when looking up any further records for [`Self::name`].
+       /// A resolver should use this name when looking up any further records for [`self.name`].
        pub canonical_name: Name,
 }
 impl StaticRecord for CName {
@@ -320,6 +358,36 @@ impl StaticRecord for CName {
        }
 }
 
+#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
+/// A Delegation Name resource record, referring all queries for subdomains of this name to another
+/// subtree of the DNS.
+pub struct DName {
+       /// The name this record is at.
+       pub name: Name,
+       /// The delegation name.
+       ///
+       /// A resolver should use this domain name tree when looking up any further records for
+       /// subdomains of [`self.name`].
+       pub delegation_name: Name,
+}
+impl StaticRecord for DName {
+       const TYPE: u16 = 39;
+       fn name(&self) -> &Name { &self.name }
+       fn json(&self) -> String {
+               format!("{{\"type\":\"dname\",\"name\":\"{}\",\"delegation_name\":\"{}\"}}",
+                       self.name.0, self.delegation_name.0)
+       }
+       fn read_from_data(name: Name, mut data: &[u8], wire_packet: &[u8]) -> Result<Self, ()> {
+               Ok(DName { name, delegation_name: read_wire_packet_name(&mut data, wire_packet)? })
+       }
+       fn write_u16_len_prefixed_data(&self, out: &mut Vec<u8>) {
+               let len: u16 = name_len(&self.delegation_name);
+               out.extend_from_slice(&len.to_be_bytes());
+               write_name(out, &self.delegation_name);
+       }
+}
+
+
 #[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
 /// A public key resource record which can be used to validate [`RRSig`]s.
 pub struct DnsKey {
@@ -385,7 +453,7 @@ impl DnsKey {
 
 #[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
 /// A Delegation Signer resource record which indicates that some alternative [`DnsKey`] can sign
-/// for records in the zone which matches [`DS::name`].
+/// for records in the zone which matches [`self.name`].
 pub struct DS {
        /// The name this record is at.
        ///
@@ -447,7 +515,7 @@ pub struct RRSig {
        pub name: Name,
        /// The resource record type which this [`RRSig`] is signing.
        ///
-       /// All resources records of this type at the same name as [`Self::name`] must be signed by
+       /// All resources records of this type at the same name as [`self.name`] must be signed by
        /// this [`RRSig`].
        pub ty: u16,
        /// The algorithm which is being used to sign.
@@ -456,7 +524,7 @@ pub struct RRSig {
        pub alg: u8,
        /// The number of labels in the name of the records that this signature is signing.
        ///
-       /// If this is less than the number of labels in [`Self::name`], this signature is covering a
+       /// If this is less than the number of labels in [`self.name`], this signature is covering a
        /// wildcard entry.
        pub labels: u8,
        /// The TTL of the records which this [`RRSig`] is signing.
@@ -471,7 +539,11 @@ pub struct RRSig {
        pub key_tag: u16,
        /// The [`DnsKey::name`] in the [`DnsKey`] which created this signature.
        ///
-       /// This must be a parent of the [`Self::name`].
+       /// This must be a parent of [`self.name`].
+       ///
+       /// [`DnsKey::name`]: Record::name
+       // We'd like to just link to the `DnsKey` member variable called `name`, but there doesn't
+       // appear to be a way to actually do that, so instead we have to link to the trait method.
        pub key_name: Name,
        /// The signature itself.
        pub signature: Vec<u8>,
@@ -525,8 +597,10 @@ pub struct A {
        /// The bytes of the IPv4 address.
        pub address: [u8; 4],
 }
+/// The wire type for A records
+pub const A_TYPE: u16 = 1;
 impl StaticRecord for A {
-       const TYPE: u16 = 1;
+       const TYPE: u16 = A_TYPE;
        fn name(&self) -> &Name { &self.name }
        fn json(&self) -> String {
                format!("{{\"type\":\"a\",\"name\":\"{}\",\"address\":{:?}}}", self.name.0, self.address)
@@ -551,8 +625,10 @@ pub struct AAAA {
        /// The bytes of the IPv6 address.
        pub address: [u8; 16],
 }
+/// The wire type for AAAA records
+pub const AAAA_TYPE: u16 = 28;
 impl StaticRecord for AAAA {
-       const TYPE: u16 = 28;
+       const TYPE: u16 = AAAA_TYPE;
        fn name(&self) -> &Name { &self.name }
        fn json(&self) -> String {
                format!("{{\"type\":\"aaaa\",\"name\":\"{}\",\"address\":{:?}}}", self.name.0, self.address)
@@ -578,7 +654,7 @@ pub struct NS {
        /// This is also the zone which the server at [`Self::name_server`] is responsible for handling
        /// queries for.
        pub name: Name,
-       /// The name of the server which is responsible for handling queries for the [`Self::name`]
+       /// The name of the server which is responsible for handling queries for the [`self.name`]
        /// zone.
        pub name_server: Name,
 }