Include the resolver-provided TTL in the response
[dnssec-prover] / src / rr.rs
index 881adc672182650b2f8f7c1786cdb6a6e5c7485a..002ea7e7a60b0317f5ebb84ca3c590ad5a161804 100644 (file)
--- a/src/rr.rs
+++ b/src/rr.rs
@@ -50,6 +50,12 @@ impl TryFrom<&str> for Name {
 /// Note that we only currently support a handful of RR types as needed to generate and validate
 /// TXT or TLSA record proofs.
 pub enum RR {
+       /// An IPv4 resource record
+       A(A),
+       /// An IPv6 resource record
+       AAAA(AAAA),
+       /// A name server resource record
+       NS(NS),
        /// A text resource record
        Txt(Txt),
        /// A TLS Certificate Association resource record
@@ -67,6 +73,9 @@ impl RR {
        /// Gets the name this record refers to.
        pub fn name(&self) -> &Name {
                match self {
+                       RR::A(rr) => &rr.name,
+                       RR::AAAA(rr) => &rr.name,
+                       RR::NS(rr) => &rr.name,
                        RR::Txt(rr) => &rr.name,
                        RR::CName(rr) => &rr.name,
                        RR::TLSA(rr) => &rr.name,
@@ -77,6 +86,9 @@ impl RR {
        }
        fn ty(&self) -> u16 {
                match self {
+                       RR::A(_) => A::TYPE,
+                       RR::AAAA(_) => AAAA::TYPE,
+                       RR::NS(_) => NS::TYPE,
                        RR::Txt(_) => Txt::TYPE,
                        RR::CName(_) => CName::TYPE,
                        RR::TLSA(_) => TLSA::TYPE,
@@ -87,6 +99,9 @@ impl RR {
        }
        fn write_u16_len_prefixed_data(&self, out: &mut Vec<u8>) {
                match self {
+                       RR::A(rr) => StaticRecord::write_u16_len_prefixed_data(rr, out),
+                       RR::AAAA(rr) => StaticRecord::write_u16_len_prefixed_data(rr, out),
+                       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::TLSA(rr) => StaticRecord::write_u16_len_prefixed_data(rr, out),
@@ -96,6 +111,9 @@ impl RR {
                }
        }
 }
+impl From<A> for RR { fn from(a: A) -> RR { RR::A(a) } }
+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<TLSA> for RR { fn from(tlsa: TLSA) -> RR { RR::TLSA(tlsa) } }
@@ -108,7 +126,7 @@ pub(crate) trait StaticRecord : Ord + Sized {
        const TYPE: u16;
        fn name(&self) -> &Name;
        fn write_u16_len_prefixed_data(&self, out: &mut Vec<u8>);
-       fn read_from_data(name: Name, data: &[u8]) -> Result<Self, ()>;
+       fn read_from_data(name: Name, data: &[u8], wire_packet: &[u8]) -> Result<Self, ()>;
 }
 /// A trait describing a resource record (including the [`RR`] enum).
 pub trait Record : Ord {
@@ -151,7 +169,7 @@ pub struct Txt {
 impl StaticRecord for Txt {
        const TYPE: u16 = 16;
        fn name(&self) -> &Name { &self.name }
-       fn read_from_data(name: Name, mut data: &[u8]) -> Result<Self, ()> {
+       fn read_from_data(name: Name, mut data: &[u8], _wire_packet: &[u8]) -> Result<Self, ()> {
                let mut parsed_data = Vec::with_capacity(data.len() - 1);
                while !data.is_empty() {
                        let len = read_u8(&mut data)? as usize;
@@ -200,7 +218,7 @@ pub struct TLSA {
 impl StaticRecord for TLSA {
        const TYPE: u16 = 52;
        fn name(&self) -> &Name { &self.name }
-       fn read_from_data(name: Name, mut data: &[u8]) -> Result<Self, ()> {
+       fn read_from_data(name: Name, mut data: &[u8], _wire_packet: &[u8]) -> Result<Self, ()> {
                Ok(TLSA {
                        name, cert_usage: read_u8(&mut data)?, selector: read_u8(&mut data)?,
                        data_ty: read_u8(&mut data)?, data: data.to_vec(),
@@ -227,8 +245,8 @@ pub struct CName {
 impl StaticRecord for CName {
        const TYPE: u16 = 5;
        fn name(&self) -> &Name { &self.name }
-       fn read_from_data(name: Name, mut data: &[u8]) -> Result<Self, ()> {
-               Ok(CName { name, canonical_name: read_name(&mut data)? })
+       fn read_from_data(name: Name, mut data: &[u8], wire_packet: &[u8]) -> Result<Self, ()> {
+               Ok(CName { name, canonical_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.canonical_name);
@@ -254,7 +272,7 @@ pub struct DnsKey {
 impl StaticRecord for DnsKey {
        const TYPE: u16 = 48;
        fn name(&self) -> &Name { &self.name }
-       fn read_from_data(name: Name, mut data: &[u8]) -> Result<Self, ()> {
+       fn read_from_data(name: Name, mut data: &[u8], _wire_packet: &[u8]) -> Result<Self, ()> {
                Ok(DnsKey {
                        name, flags: read_u16(&mut data)?, protocol: read_u8(&mut data)?,
                        alg: read_u8(&mut data)?, pubkey: data.to_vec(),
@@ -312,7 +330,7 @@ pub struct DS {
 impl StaticRecord for DS {
        const TYPE: u16 = 43;
        fn name(&self) -> &Name { &self.name }
-       fn read_from_data(name: Name, mut data: &[u8]) -> Result<Self, ()> {
+       fn read_from_data(name: Name, mut data: &[u8], _wire_packet: &[u8]) -> Result<Self, ()> {
                Ok(DS {
                        name, key_tag: read_u16(&mut data)?, alg: read_u8(&mut data)?,
                        digest_type: read_u8(&mut data)?, digest: data.to_vec(),
@@ -346,7 +364,9 @@ pub struct RRSig {
        /// This must match the [`DnsKey::alg`] field in the [`DnsKey`] being used to sign.
        pub alg: u8,
        /// The number of labels in the name of the records that this signature is signing.
-       // TODO: Describe this better in terms of wildcards
+       ///
+       /// 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.
        pub orig_ttl: u32,
@@ -368,12 +388,13 @@ pub struct RRSig {
 impl StaticRecord for RRSig {
        const TYPE: u16 = 46;
        fn name(&self) -> &Name { &self.name }
-       fn read_from_data(name: Name, mut data: &[u8]) -> Result<Self, ()> {
+       fn read_from_data(name: Name, mut data: &[u8], wire_packet: &[u8]) -> Result<Self, ()> {
                Ok(RRSig {
                        name, ty: read_u16(&mut data)?, alg: read_u8(&mut data)?,
                        labels: read_u8(&mut data)?, orig_ttl: read_u32(&mut data)?,
                        expiration: read_u32(&mut data)?, inception: read_u32(&mut data)?,
-                       key_tag: read_u16(&mut data)?, key_name: read_name(&mut data)?,
+                       key_tag: read_u16(&mut data)?,
+                       key_name: read_wire_packet_name(&mut data, wire_packet)?,
                        signature: data.to_vec(),
                })
        }
@@ -391,3 +412,74 @@ impl StaticRecord for RRSig {
                out.extend_from_slice(&self.signature);
        }
 }
+
+#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
+/// An IPv4 Address resource record
+pub struct A {
+       /// The name this record is at.
+       pub name: Name,
+       /// The bytes of the IPv4 address.
+       pub address: [u8; 4],
+}
+impl StaticRecord for A {
+       const TYPE: u16 = 1;
+       fn name(&self) -> &Name { &self.name }
+       fn read_from_data(name: Name, data: &[u8], _wire_packet: &[u8]) -> Result<Self, ()> {
+               if data.len() != 4 { return Err(()); }
+               let mut address = [0; 4];
+               address.copy_from_slice(&data);
+               Ok(A { name, address })
+       }
+       fn write_u16_len_prefixed_data(&self, out: &mut Vec<u8>) {
+               out.extend_from_slice(&4u16.to_be_bytes());
+               out.extend_from_slice(&self.address);
+       }
+}
+
+#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
+/// An IPv6 Address resource record
+pub struct AAAA {
+       /// The name this record is at.
+       pub name: Name,
+       /// The bytes of the IPv6 address.
+       pub address: [u8; 16],
+}
+impl StaticRecord for AAAA {
+       const TYPE: u16 = 28;
+       fn name(&self) -> &Name { &self.name }
+       fn read_from_data(name: Name, data: &[u8], _wire_packet: &[u8]) -> Result<Self, ()> {
+               if data.len() != 16 { return Err(()); }
+               let mut address = [0; 16];
+               address.copy_from_slice(&data);
+               Ok(AAAA { name, address })
+       }
+       fn write_u16_len_prefixed_data(&self, out: &mut Vec<u8>) {
+               out.extend_from_slice(&16u16.to_be_bytes());
+               out.extend_from_slice(&self.address);
+       }
+}
+
+#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
+/// A Name Server resource record, which indicates the server responsible for handling queries for
+/// a zone.
+pub struct NS {
+       /// The name this record is at.
+       ///
+       /// 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`]
+       /// zone.
+       pub name_server: Name,
+}
+impl StaticRecord for NS {
+       const TYPE: u16 = 2;
+       fn name(&self) -> &Name { &self.name }
+       fn read_from_data(name: Name, mut data: &[u8], wire_packet: &[u8]) -> Result<Self, ()> {
+               Ok(NS { name, name_server: read_wire_packet_name(&mut data, wire_packet)? })
+       }
+       fn write_u16_len_prefixed_data(&self, out: &mut Vec<u8>) {
+               out.extend_from_slice(&name_len(&self.name_server).to_be_bytes());
+               write_name(out, &self.name_server);
+       }
+}