Add some clarifying comments about separation of DNSSEC and SIG(0) ty…

…pes.
hickory-dns · Oct 26, 2017 · d439fa6 · d439fa6
1 parent 98151fe
commit d439fa6
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 3 deletions.
diff --git a/proto/src/rr/dnssec/rdata/mod.rs b/proto/src/rr/dnssec/rdata/mod.rs
@@ -58,7 +58,11 @@ pub enum DNSSECRecordType {
     NSEC3PARAM,
     /// RFC 4034	DNSSEC signature: RSASHA256 and RSASHA512, RFC5702
     RRSIG,
-    /// RFC 2535 (2931)	Signature, to support 2137 Update
+    /// RFC 2535 (2931)	Signature, to support 2137 Update.
+    ///
+    /// This isn't really a DNSSEC record type, but it is here because, at least
+    /// for now, we enable/disable SIG(0) in exactly the same circumstances that
+    /// we enable/disable DNSSEC. This may change in the future.
     SIG,
 }
 

diff --git a/proto/src/rr/record_data.rs b/proto/src/rr/record_data.rs
@@ -333,7 +333,10 @@ pub enum RData {
     /// ```
     TXT(TXT),
 
-    /// A DNSSEC-specific record. See `DNSSECRData` for details.
+    /// A DNSSEC- or SIG(0)- specific record. See `DNSSECRData` for details.
+    ///
+    /// These types are in `DNSSECRData` to make them easy to disable when
+    /// crypto functionality isn't needed.
     #[cfg(feature = "dnssec")]
     DNSSEC(DNSSECRData),
 }

diff --git a/proto/src/rr/record_type.rs b/proto/src/rr/record_type.rs
@@ -79,7 +79,10 @@ pub enum RecordType {
     /// RFC 1035[1]	Text record
     TXT,
 
-    /// DNSSEC-specific record types.
+    /// A DNSSEC- or SIG(0)- specific record type.
+    ///
+    /// These types are in `DNSSECRecordType` to make them easy to disable when
+    /// crypto functionality isn't needed.
     #[cfg(feature = "dnssec")]
     DNSSEC(DNSSECRecordType),
 }