1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
/* * Copyright (C) 2015-2019 Benjamin Fry <benjaminfry@me.com> * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ //! record type definitions use std::cmp::Ordering; use std::convert::From; use std::fmt; use std::fmt::{Display, Formatter}; use std::str::FromStr; use crate::error::*; use crate::serialize::binary::*; #[cfg(feature = "dnssec")] use crate::rr::dnssec::rdata::DNSSECRecordType; // TODO: adopt proper restrictions on usage: https://tools.ietf.org/html/rfc6895 section 3.1 // add the data TYPEs, QTYPEs, and Meta-TYPEs // /// The type of the resource record. /// /// This specifies the type of data in the RData field of the Resource Record #[derive(Debug, PartialEq, Eq, Hash, Copy, Clone)] #[allow(dead_code)] pub enum RecordType { /// RFC 1035[1] IPv4 Address record A, /// RFC 3596[2] IPv6 address record AAAA, /// ANAME draft-ietf-dnsop-aname ANAME, // AFSDB, // 18 RFC 1183 AFS database record /// RFC 1035[1] All cached records, aka ANY ANY, // APL, // 42 RFC 3123 Address Prefix List /// RFC 1035[1] Authoritative Zone Transfer AXFR, /// RFC 6844 Certification Authority Authorization CAA, // CERT, // 37 RFC 4398 Certificate record /// RFC 1035[1] Canonical name record CNAME, // DHCID, // 49 RFC 4701 DHCP identifier // DNAME, // 39 RFC 2672 Delegation Name // HIP, // 55 RFC 5205 Host Identity Protocol // IPSECKEY, // 45 RFC 4025 IPsec Key /// RFC 1996 Incremental Zone Transfer IXFR, // KX, // 36 RFC 2230 Key eXchanger record // LOC, // 29 RFC 1876 Location record /// RFC 1035[1] Mail exchange record MX, /// RFC 3403 Naming Authority Pointer NAPTR, /// RFC 1035[1] Name server record NS, /// RFC 1035[1] Null server record, for testing NULL, /// RFC 7929 OpenPGP public key OPENPGPKEY, /// RFC 6891 Option OPT, /// RFC 1035[1] Pointer record PTR, // RP, // 17 RFC 1183 Responsible person /// RFC 1035[1] and RFC 2308[9] Start of [a zone of] authority record SOA, /// RFC 2782 Service locator SRV, /// RFC 4255 SSH Public Key Fingerprint SSHFP, // TA, // 32768 N/A DNSSEC Trust Authorities // TKEY, // 249 RFC 2930 Secret key record /// RFC 6698 TLSA certificate association TLSA, // TSIG, // 250 RFC 2845 Transaction Signature /// RFC 1035[1] Text record TXT, /// 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), /// Unknown Record type, or unsupported Unknown(u16), /// This corresponds to a record type of 0, unspecified ZERO, } impl RecordType { /// Returns true if this is an ANY #[inline] pub fn is_any(self) -> bool { self == RecordType::ANY } /// Returns true if this is a CNAME #[inline] pub fn is_cname(self) -> bool { self == RecordType::CNAME } /// Returns true if this is an SRV #[inline] pub fn is_srv(self) -> bool { self == RecordType::SRV } /// Returns true if this is an A or an AAAA record #[inline] pub fn is_ip_addr(self) -> bool { match self { RecordType::A | RecordType::AAAA => true, _ => false, } } } impl FromStr for RecordType { type Err = ProtoError; /// Convert `&str` to `RecordType` /// /// ``` /// use std::str::FromStr; /// use trust_dns_proto::rr::record_type::RecordType; /// /// let var: RecordType = RecordType::from_str("A").unwrap(); /// assert_eq!(RecordType::A, var); /// ``` fn from_str(str: &str) -> ProtoResult<Self> { // TODO missing stuff? match str { "A" => Ok(RecordType::A), "AAAA" => Ok(RecordType::AAAA), "ANAME" => Ok(RecordType::ANAME), "CAA" => Ok(RecordType::CAA), "CNAME" => Ok(RecordType::CNAME), "NULL" => Ok(RecordType::NULL), "MX" => Ok(RecordType::MX), "NAPTR" => Ok(RecordType::NAPTR), "NS" => Ok(RecordType::NS), "OPENPGPKEY" => Ok(RecordType::OPENPGPKEY), "PTR" => Ok(RecordType::PTR), "SOA" => Ok(RecordType::SOA), "SRV" => Ok(RecordType::SRV), "SSHFP" => Ok(RecordType::SSHFP), "TLSA" => Ok(RecordType::TLSA), "TXT" => Ok(RecordType::TXT), "ANY" | "*" => Ok(RecordType::ANY), "AXFR" => Ok(RecordType::AXFR), _ => Err(ProtoErrorKind::UnknownRecordTypeStr(str.to_string()).into()), } } } impl From<u16> for RecordType { /// Convert from `u16` to `RecordType` /// /// ``` /// use trust_dns_proto::rr::record_type::RecordType; /// /// let var = RecordType::from(1); /// assert_eq!(RecordType::A, var); /// ``` fn from(value: u16) -> Self { match value { 1 => RecordType::A, 28 => RecordType::AAAA, // TODO: wrong value here, see https://github.com/bluejekyll/trust-dns/issues/723 65305 => RecordType::ANAME, 255 => RecordType::ANY, 252 => RecordType::AXFR, 257 => RecordType::CAA, 5 => RecordType::CNAME, 0 => RecordType::ZERO, 15 => RecordType::MX, 35 => RecordType::NAPTR, 2 => RecordType::NS, 10 => RecordType::NULL, 61 => RecordType::OPENPGPKEY, 41 => RecordType::OPT, 12 => RecordType::PTR, 6 => RecordType::SOA, 33 => RecordType::SRV, 44 => RecordType::SSHFP, 52 => RecordType::TLSA, 16 => RecordType::TXT, #[cfg(feature = "dnssec")] 48/*DNSKEY*/ | 43/*DS*/ | 25/*KEY*/ | 47/*NSEC*/| 50/*NSEC3*/| 51/*NSEC3PARAM*/| 46/*RRSIG*/| 24/*SIG*/ => RecordType::DNSSEC(DNSSECRecordType::from(value)), // all unknown record types _ => RecordType::Unknown(value), } } } impl BinEncodable for RecordType { fn emit(&self, encoder: &mut BinEncoder) -> ProtoResult<()> { encoder.emit_u16((*self).into()) } } impl<'r> BinDecodable<'r> for RecordType { fn read(decoder: &mut BinDecoder) -> ProtoResult<Self> { decoder .read_u16() .map( Restrict::unverified, /*RecordType is safe with any u16*/ ) .map(Self::from) } } // TODO make these a macro... /// Convert from `RecordType` to `&str` /// /// ``` /// use std::convert::From; /// use trust_dns_proto::rr::record_type::RecordType; /// /// let var: &'static str = From::from(RecordType::A); /// assert_eq!("A", var); /// /// let var: &'static str = RecordType::A.into(); /// assert_eq!("A", var); /// ``` impl From<RecordType> for &'static str { fn from(rt: RecordType) -> &'static str { match rt { RecordType::A => "A", RecordType::AAAA => "AAAA", RecordType::ANAME => "ANAME", RecordType::ANY => "ANY", RecordType::AXFR => "AXFR", RecordType::CAA => "CAA", RecordType::CNAME => "CNAME", RecordType::ZERO => "", RecordType::IXFR => "IXFR", RecordType::MX => "MX", RecordType::NAPTR => "NAPTR", RecordType::NS => "NS", RecordType::NULL => "NULL", RecordType::OPENPGPKEY => "OPENPGPKEY", RecordType::OPT => "OPT", RecordType::PTR => "PTR", RecordType::SOA => "SOA", RecordType::SRV => "SRV", RecordType::SSHFP => "SSHFP", RecordType::TLSA => "TLSA", RecordType::TXT => "TXT", #[cfg(feature = "dnssec")] RecordType::DNSSEC(rt) => rt.into(), RecordType::Unknown(_) => "Unknown", } } } /// Convert from `RecordType` to `u16` /// /// ``` /// use std::convert::From; /// use trust_dns_proto::rr::record_type::RecordType; /// /// let var: u16 = RecordType::A.into(); /// assert_eq!(1, var); /// ``` impl From<RecordType> for u16 { fn from(rt: RecordType) -> Self { match rt { RecordType::A => 1, RecordType::AAAA => 28, // TODO: wrong value here, see https://github.com/bluejekyll/trust-dns/issues/723 RecordType::ANAME => 65305, RecordType::ANY => 255, RecordType::AXFR => 252, RecordType::CAA => 257, RecordType::CNAME => 5, RecordType::ZERO => 0, RecordType::IXFR => 251, RecordType::MX => 15, RecordType::NAPTR => 35, RecordType::NS => 2, RecordType::NULL => 10, RecordType::OPENPGPKEY => 61, RecordType::OPT => 41, RecordType::PTR => 12, RecordType::SOA => 6, RecordType::SRV => 33, RecordType::SSHFP => 44, RecordType::TLSA => 52, RecordType::TXT => 16, #[cfg(feature = "dnssec")] RecordType::DNSSEC(rt) => rt.into(), RecordType::Unknown(code) => code, } } } /// [Canonical DNS Name Order](https://tools.ietf.org/html/rfc4034#section-6) impl PartialOrd<RecordType> for RecordType { fn partial_cmp(&self, other: &RecordType) -> Option<Ordering> { Some(self.cmp(other)) } } /// [Canonical DNS Name Order](https://tools.ietf.org/html/rfc4034#section-6) impl Ord for RecordType { fn cmp(&self, other: &Self) -> Ordering { u16::from(*self).cmp(&u16::from(*other)) } } impl Display for RecordType { fn fmt(&self, f: &mut Formatter) -> Result<(), fmt::Error> { f.write_str(Into::<&str>::into(*self)) } } #[test] fn test_order() { let ordered = vec![ RecordType::A, RecordType::NS, RecordType::CNAME, RecordType::SOA, RecordType::NULL, RecordType::PTR, RecordType::MX, RecordType::TXT, RecordType::AAAA, RecordType::SRV, RecordType::AXFR, RecordType::ANY, ]; let mut unordered = vec![ RecordType::ANY, RecordType::NULL, RecordType::AXFR, RecordType::A, RecordType::NS, RecordType::SOA, RecordType::SRV, RecordType::PTR, RecordType::MX, RecordType::CNAME, RecordType::TXT, RecordType::AAAA, ]; unordered.sort(); for rtype in unordered.clone() { println!("u16 for {:?}: {}", rtype, u16::from(rtype)); } assert_eq!(ordered, unordered); }