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
//! Domain name-related traits. //! /// This is a private module. Its public traits are re-exported by the parent. use std::cmp; use bytes::BytesMut; use ::bits::compose::{Compose, Compress}; use super::chain::{Chain, LongChainError}; use super::dname::Dname; use super::label::Label; use super::relative::RelativeDname; //------------ ToLabelIter --------------------------------------------------- /// A type that can produce an iterator over its labels. /// /// This trait is used as a trait bound for both [`ToDname`] and /// [`ToRelativeDname`]. It is separate since it has to be generic over the /// lifetime of the label reference but we don’t want to have this lifetime /// parameter pollute those traits. /// /// [`ToDname`]: trait.ToDname.html /// [`ToRelativeDname`]: trait ToRelativeDname.html pub trait ToLabelIter<'a> { /// The type of the iterator over the labels. /// /// This iterator types needs to be double ended so that we can deal with /// name suffixes. type LabelIter: Iterator<Item=&'a Label> + DoubleEndedIterator; /// Returns an iterator over the labels. fn iter_labels(&'a self) -> Self::LabelIter; /// Determines whether `base` is a prefix of `self`. fn starts_with<N: ToLabelIter<'a>>(&'a self, base: &'a N) -> bool { let mut self_iter = self.iter_labels(); let mut base_iter = base.iter_labels(); loop { match (self_iter.next(), base_iter.next()) { (Some(sl), Some(bl)) => { if sl != bl { return false } } (_, None) => return true, (None, Some(_)) => return false, } } } /// Determines whether `base` is a suffix of `self`. fn ends_with<N: ToLabelIter<'a>>(&'a self, base: &'a N) -> bool { let mut self_iter = self.iter_labels(); let mut base_iter = base.iter_labels(); loop { match (self_iter.next_back(), base_iter.next_back()) { (Some(sl), Some(bl)) => { if sl != bl { return false } } (_, None) => return true, (None, Some(_)) => return false } } } } impl<'a, 'b, N: ToLabelIter<'b>> ToLabelIter<'b> for &'a N { type LabelIter = N::LabelIter; fn iter_labels(&'b self) -> Self::LabelIter { (*self).iter_labels() } } //------------ ToDname ------------------------------------------------------- /// A type that represents an absolute domain name. /// /// An absolute domain name is a sequence of labels where the last label is /// the root label and where the wire-format representation is not longer than /// 255 characters. Implementers of this trait need to provide access to the /// label sequence via an iterator and know how to compose the wire-format /// representation into a buffer. /// /// The most common types implementing this trait are [`Dname`], /// [`ParsedDname`], and [`Chain<L, R>`] where `R` is `ToDname` itself. /// /// [`Chain<L, R>`]: struct.Chain.html /// [`Dname`]: struct.Dname.html /// [`ParsedDname`]: struct.ParsedDname.html pub trait ToDname: Compose + Compress + for<'a> ToLabelIter<'a> { /// Creates an uncompressed value of the domain name. /// /// The method has a default implementation that composes the name into /// a new buffer and returns this buffer. If the implementing type can /// create a `Dname` more efficiently, then it should provide its /// own implementation. fn to_name(&self) -> Dname { let mut bytes = BytesMut::with_capacity(self.compose_len()); self.compose(&mut bytes); unsafe { Dname::from_bytes_unchecked(bytes.freeze()) } } /// Returns a byte slice of the content if possible. /// /// If a value stores the domain name as one single byte sequence, it /// should return a reference to this sequence here. If the name is /// composed from multiple such sequences, it should return `None`. /// /// This method is used to optimize comparision operations between /// two values that are indeed flat names. fn as_flat_slice(&self) -> Option<&[u8]> { None } /// Tests whether `self` and `other` are equal. /// /// This method can be used to implement `PartialEq` on types implementing /// `ToDname` since a blanket implementation for all pairs of `ToDname` /// is currently impossible. /// /// Domain names are compared ignoring ASCII case. fn name_eq<N: ToDname>(&self, other: &N) -> bool { if let (Some(left), Some(right)) = (self.as_flat_slice(), other.as_flat_slice()) { left.eq_ignore_ascii_case(right) } else { self.iter_labels().eq(other.iter_labels()) } } /// Returns the ordering between `self` and `other`. /// /// This method can be used to implement both `PartialOrd` and `Ord` on /// types implementing `ToDname` since a blanket implementation for all /// pairs of `ToDname`s is currently not possible. /// /// Domain name order is determined according to the ‘canonical DNS /// name order’ as defined in [section 6.1 of RFC 4034][RFC4034-6.1]. /// /// [RFC4034-6.1]: https://tools.ietf.org/html/rfc4034#section-6.1 fn name_cmp<N: ToDname>(&self, other: &N) -> cmp::Ordering { let mut self_iter = self.iter_labels(); let mut other_iter = other.iter_labels(); loop { match (self_iter.next_back(), other_iter.next_back()) { (Some(left), Some(right)) => { match left.cmp(right) { cmp::Ordering::Equal => {} res => return res } } (None, Some(_)) => return cmp::Ordering::Less, (Some(_), None) => return cmp::Ordering::Greater, (None, None) => return cmp::Ordering::Equal } } } } impl<'a, N: ToDname + 'a> ToDname for &'a N { } //------------ ToRelativeDname ----------------------------------------------- /// A type that represents a relative domain name. /// /// In order to be a relative domain name, a type needs to be able to /// provide a sequence of labels via an iterator where the last label is not /// the root label. The type also needs to be able to compose the wire-format /// representation of the domain name it represents which must not be longer /// than 254 characters. This limit has been chosen so that by attaching the /// one character long root label, a valid absolute name can be constructed /// from the relative name. /// /// The most important types implementing this trait are [`RelativeDname`] /// and [`Chain<L,R>`] where `R` is a `ToRelativeDname` itself. /// /// [`Chain<L, R>`]: struct.Chain.html /// [`RelativeDname`]: struct.RelativeDname.html pub trait ToRelativeDname: Compose + for<'a> ToLabelIter<'a> { /// Creates an uncompressed value of the domain name. /// /// The method has a default implementation that composes the name into /// a new buffer and returns this buffer. If the implementing type can /// create a `RelativeDname` more efficiently, then it should provide its /// own implementation. fn to_name(&self) -> RelativeDname { let mut bytes = BytesMut::with_capacity(self.compose_len()); self.compose(&mut bytes); unsafe { RelativeDname::from_bytes_unchecked(bytes.freeze()) } } /// Returns a byte slice of the content if possible. /// /// This method can is used to optimize comparision operations between /// two values that are indeed flat names. fn as_flat_slice(&self) -> Option<&[u8]> { None } /// Returns a chain of this name and the provided absolute name. fn chain<N: Compose>( self, suffix: N ) -> Result<Chain<Self, N>, LongChainError> where Self: Sized { Chain::new(self, suffix) } /// Returns the absolute name by chaining it with the root label. fn chain_root(self) -> Chain<Self, Dname> where Self: Sized { // Appending the root label will always work. Chain::new(self, Dname::root()).unwrap() } /// Tests whether `self` and `other` are equal. /// /// This method can be used to implement `PartialEq` on types implementing /// `ToDname` since a blanket implementation for all pairs of `ToDname` /// is currently impossible. /// /// Domain names are compared ignoring ASCII case. fn name_eq<N: ToRelativeDname>(&self, other: &N) -> bool { if let (Some(left), Some(right)) = (self.as_flat_slice(), other.as_flat_slice()) { left.eq_ignore_ascii_case(right) } else { self.iter_labels().eq(other.iter_labels()) } } /// Returns the ordering between `self` and `other`. /// /// This method can be used to implement both `PartialOrd` and `Ord` on /// types implementing `ToDname` since a blanket implementation for all /// pairs of `ToDname`s is currently not possible. /// /// Domain name order is determined according to the ‘canonical DNS /// name order’ as defined in [section 6.1 of RFC 4034][RFC4034-6.1]. /// This section describes how absolute domain names are ordered only. /// We will order relative domain names according to these rules as if /// they had the same origin, i.e., as if they were relative to the /// same name. /// /// [RFC4034-6.1]: https://tools.ietf.org/html/rfc4034#section-6.1 fn name_cmp<N: ToRelativeDname>(&self, other: &N) -> cmp::Ordering { let mut self_iter = self.iter_labels(); let mut other_iter = other.iter_labels(); loop { match (self_iter.next_back(), other_iter.next_back()) { (Some(left), Some(right)) => { match left.cmp(right) { cmp::Ordering::Equal => {} res => return res } } (None, Some(_)) => return cmp::Ordering::Less, (Some(_), None) => return cmp::Ordering::Greater, (None, None) => return cmp::Ordering::Equal } } } } impl<'a, N: ToRelativeDname + 'a> ToRelativeDname for &'a N { }