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 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
// Copyright (C) 2015 - 2016 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. use std::cell::{RefCell, RefMut}; use std::io; use futures::Stream; use tokio_core::reactor::Core; use client::{ClientHandle, BasicClientHandle, ClientConnection, ClientFuture, SecureClientHandle}; use ::error::*; use rr::{domain, DNSClass, IntoRecordSet, RecordType, Record}; use rr::dnssec::Signer; #[cfg(any(feature = "openssl", feature = "ring"))] use rr::dnssec::TrustAnchor; use op::Message; /// Client trait which implements basic DNS Client operations. /// /// As of 0.9.4, the Client is now a wrapper around the `ClientFuture`, which is a futures-rs /// and tokio-rs based implementation. This trait implements syncronous functions for ease of use. /// /// There was a strong attempt to make it backwards compatible, but making it a drop in replacement /// for the old Client was not possible. This trait has two implentations, the `SyncClient` which /// is a standard DNS Client, and the `SecureSyncClient` which is a wrapper on `SecureClientHandle` /// providing DNSSec validation. /// /// *note* When upgrading from previous usage, both `SyncClient` and `SecureSyncClient` have an /// signer which can be optionally associated to the Client. This replaces the previous per-function /// parameter, and it will sign all update requests (this matches the `ClientFuture` API). pub trait Client<C: ClientHandle> { fn get_io_loop(&self) -> RefMut<Core>; fn get_client_handle(&self) -> RefMut<C>; /// A *classic* DNS query, i.e. does not perform and DNSSec operations /// /// *Note* As of now, this will not recurse on PTR or CNAME record responses, that is up to /// the caller. /// /// # Arguments /// /// * `name` - the label to lookup /// * `query_class` - most likely this should always be DNSClass::IN /// * `query_type` - record type to lookup fn query(&self, name: &domain::Name, query_class: DNSClass, query_type: RecordType) -> ClientResult<Message> { self.get_io_loop() .run(self.get_client_handle().query(name.clone(), query_class, query_type)) } /// Sends a NOTIFY message to the remote system /// /// # Arguments /// /// * `name` - the label which is being notified /// * `query_class` - most likely this should always be DNSClass::IN /// * `query_type` - record type which has been updated /// * `rrset` - the new version of the record(s) being notified fn notify<R>(&mut self, name: domain::Name, query_class: DNSClass, query_type: RecordType, rrset: Option<R>) -> ClientResult<Message> where R: IntoRecordSet { self.get_io_loop() .run(self.get_client_handle().notify(name, query_class, query_type, rrset)) } /// Sends a record to create on the server, this will fail if the record exists (atomicity /// depends on the server) /// /// [RFC 2136](https://tools.ietf.org/html/rfc2136), DNS Update, April 1997 /// /// ```text /// 2.4.3 - RRset Does Not Exist /// /// No RRs with a specified NAME and TYPE (in the zone and class denoted /// by the Zone Section) can exist. /// /// For this prerequisite, a requestor adds to the section a single RR /// whose NAME and TYPE are equal to that of the RRset whose nonexistence /// is required. The RDLENGTH of this record is zero (0), and RDATA /// field is therefore empty. CLASS must be specified as NONE in order /// to distinguish this condition from a valid RR whose RDLENGTH is /// naturally zero (0) (for example, the NULL RR). TTL must be specified /// as zero (0). /// /// 2.5.1 - Add To An RRset /// /// RRs are added to the Update Section whose NAME, TYPE, TTL, RDLENGTH /// and RDATA are those being added, and CLASS is the same as the zone /// class. Any duplicate RRs will be silently ignored by the primary /// master. /// ``` /// /// # Arguments /// /// * `rrset` - the record(s) to create /// * `zone_origin` - the zone name to update, i.e. SOA name /// /// The update must go to a zone authority (i.e. the server used in the ClientConnection) fn create<R>(&self, rrset: R, zone_origin: domain::Name) -> ClientResult<Message> where R: IntoRecordSet { self.get_io_loop().run(self.get_client_handle().create(rrset, zone_origin)) } /// Appends a record to an existing rrset, optionally require the rrset to exis (atomicity /// depends on the server) /// /// [RFC 2136](https://tools.ietf.org/html/rfc2136), DNS Update, April 1997 /// /// ```text /// 2.4.1 - RRset Exists (Value Independent) /// /// At least one RR with a specified NAME and TYPE (in the zone and class /// specified in the Zone Section) must exist. /// /// For this prerequisite, a requestor adds to the section a single RR /// whose NAME and TYPE are equal to that of the zone RRset whose /// existence is required. RDLENGTH is zero and RDATA is therefore /// empty. CLASS must be specified as ANY to differentiate this /// condition from that of an actual RR whose RDLENGTH is naturally zero /// (0) (e.g., NULL). TTL is specified as zero (0). /// /// 2.5.1 - Add To An RRset /// /// RRs are added to the Update Section whose NAME, TYPE, TTL, RDLENGTH /// and RDATA are those being added, and CLASS is the same as the zone /// class. Any duplicate RRs will be silently ignored by the primary /// master. /// ``` /// /// # Arguments /// /// * `rrset` - the record(s) to append to an RRSet /// * `zone_origin` - the zone name to update, i.e. SOA name /// * `must_exist` - if true, the request will fail if the record does not exist /// /// The update must go to a zone authority (i.e. the server used in the ClientConnection). If /// the rrset does not exist and must_exist is false, then the RRSet will be created. fn append<R>(&self, rrset: R, zone_origin: domain::Name, must_exist: bool) -> ClientResult<Message> where R: IntoRecordSet { self.get_io_loop().run(self.get_client_handle().append(rrset, zone_origin, must_exist)) } /// Compares and if it matches, swaps it for the new value (atomicity depends on the server) /// /// ```text /// 2.4.2 - RRset Exists (Value Dependent) /// /// A set of RRs with a specified NAME and TYPE exists and has the same /// members with the same RDATAs as the RRset specified here in this /// section. While RRset ordering is undefined and therefore not /// significant to this comparison, the sets be identical in their /// extent. /// /// For this prerequisite, a requestor adds to the section an entire /// RRset whose preexistence is required. NAME and TYPE are that of the /// RRset being denoted. CLASS is that of the zone. TTL must be /// specified as zero (0) and is ignored when comparing RRsets for /// identity. /// /// 2.5.4 - Delete An RR From An RRset /// /// RRs to be deleted are added to the Update Section. The NAME, TYPE, /// RDLENGTH and RDATA must match the RR being deleted. TTL must be /// specified as zero (0) and will otherwise be ignored by the primary /// master. CLASS must be specified as NONE to distinguish this from an /// RR addition. If no such RRs exist, then this Update RR will be /// silently ignored by the primary master. /// /// 2.5.1 - Add To An RRset /// /// RRs are added to the Update Section whose NAME, TYPE, TTL, RDLENGTH /// and RDATA are those being added, and CLASS is the same as the zone /// class. Any duplicate RRs will be silently ignored by the primary /// master. /// ``` /// /// # Arguements /// /// * `current` - the current rrset which must exist for the swap to complete /// * `new` - the new rrset with which to replace the current rrset /// * `zone_origin` - the zone name to update, i.e. SOA name /// /// The update must go to a zone authority (i.e. the server used in the ClientConnection). fn compare_and_swap<CR, NR>(&self, current: CR, new: NR, zone_origin: domain::Name) -> ClientResult<Message> where CR: IntoRecordSet, NR: IntoRecordSet { self.get_io_loop().run(self.get_client_handle().compare_and_swap(current, new, zone_origin)) } /// Deletes a record (by rdata) from an rrset, optionally require the rrset to exist. /// /// [RFC 2136](https://tools.ietf.org/html/rfc2136), DNS Update, April 1997 /// /// ```text /// 2.4.1 - RRset Exists (Value Independent) /// /// At least one RR with a specified NAME and TYPE (in the zone and class /// specified in the Zone Section) must exist. /// /// For this prerequisite, a requestor adds to the section a single RR /// whose NAME and TYPE are equal to that of the zone RRset whose /// existence is required. RDLENGTH is zero and RDATA is therefore /// empty. CLASS must be specified as ANY to differentiate this /// condition from that of an actual RR whose RDLENGTH is naturally zero /// (0) (e.g., NULL). TTL is specified as zero (0). /// /// 2.5.4 - Delete An RR From An RRset /// /// RRs to be deleted are added to the Update Section. The NAME, TYPE, /// RDLENGTH and RDATA must match the RR being deleted. TTL must be /// specified as zero (0) and will otherwise be ignored by the primary /// master. CLASS must be specified as NONE to distinguish this from an /// RR addition. If no such RRs exist, then this Update RR will be /// silently ignored by the primary master. /// ``` /// /// # Arguments /// /// * `rrset` - the record(s) to delete from a RRSet, the name, type and rdata must match the /// record to delete /// * `zone_origin` - the zone name to update, i.e. SOA name /// /// The update must go to a zone authority (i.e. the server used in the ClientConnection). If /// the rrset does not exist and must_exist is false, then the RRSet will be deleted. fn delete_by_rdata<R>(&self, record: R, zone_origin: domain::Name) -> ClientResult<Message> where R: IntoRecordSet { self.get_io_loop().run(self.get_client_handle().delete_by_rdata(record, zone_origin)) } /// Deletes an entire rrset, optionally require the rrset to exist. /// /// [RFC 2136](https://tools.ietf.org/html/rfc2136), DNS Update, April 1997 /// /// ```text /// 2.4.1 - RRset Exists (Value Independent) /// /// At least one RR with a specified NAME and TYPE (in the zone and class /// specified in the Zone Section) must exist. /// /// For this prerequisite, a requestor adds to the section a single RR /// whose NAME and TYPE are equal to that of the zone RRset whose /// existence is required. RDLENGTH is zero and RDATA is therefore /// empty. CLASS must be specified as ANY to differentiate this /// condition from that of an actual RR whose RDLENGTH is naturally zero /// (0) (e.g., NULL). TTL is specified as zero (0). /// /// 2.5.2 - Delete An RRset /// /// One RR is added to the Update Section whose NAME and TYPE are those /// of the RRset to be deleted. TTL must be specified as zero (0) and is /// otherwise not used by the primary master. CLASS must be specified as /// ANY. RDLENGTH must be zero (0) and RDATA must therefore be empty. /// If no such RRset exists, then this Update RR will be silently ignored /// by the primary master. /// ``` /// /// # Arguments /// /// * `record` - the record to delete from a RRSet, the name, and type must match the /// record set to delete /// * `zone_origin` - the zone name to update, i.e. SOA name /// /// The update must go to a zone authority (i.e. the server used in the ClientConnection). If /// the rrset does not exist and must_exist is false, then the RRSet will be deleted. fn delete_rrset(&self, record: Record, zone_origin: domain::Name) -> ClientResult<Message> { self.get_io_loop().run(self.get_client_handle().delete_rrset(record, zone_origin)) } /// Deletes all records at the specified name /// /// [RFC 2136](https://tools.ietf.org/html/rfc2136), DNS Update, April 1997 /// /// ```text /// 2.5.3 - Delete All RRsets From A Name /// /// One RR is added to the Update Section whose NAME is that of the name /// to be cleansed of RRsets. TYPE must be specified as ANY. TTL must /// be specified as zero (0) and is otherwise not used by the primary /// master. CLASS must be specified as ANY. RDLENGTH must be zero (0) /// and RDATA must therefore be empty. If no such RRsets exist, then /// this Update RR will be silently ignored by the primary master. /// ``` /// /// # Arguments /// /// * `name_of_records` - the name of all the record sets to delete /// * `zone_origin` - the zone name to update, i.e. SOA name /// * `dns_class` - the class of the SOA /// /// The update must go to a zone authority (i.e. the server used in the ClientConnection). This /// operation attempts to delete all resource record sets the the specified name reguardless of /// the record type. fn delete_all(&self, name_of_records: domain::Name, zone_origin: domain::Name, dns_class: DNSClass) -> ClientResult<Message> { self.get_io_loop() .run(self.get_client_handle().delete_all(name_of_records, zone_origin, dns_class)) } } /// The Client is abstracted over either trust_dns::tcp::TcpClientConnection or /// trust_dns::udp::UdpClientConnection. /// /// Usage of TCP or UDP is up to the user. Some DNS servers /// disallow TCP in some cases, so if TCP double check if UDP works. pub struct SyncClient { client_handle: RefCell<BasicClientHandle>, io_loop: RefCell<Core>, } impl SyncClient { /// Creates a new DNS client with the specified connection type /// /// # Arguments /// /// * `client_connection` - the client_connection to use for all communication pub fn new<CC: ClientConnection>(client_connection: CC) -> SyncClient where <CC as ClientConnection>::MessageStream: Stream<Item=Vec<u8>, Error=io::Error> + 'static { let (io_loop, stream, stream_handle) = client_connection.unwrap(); let client = ClientFuture::new(stream, stream_handle, io_loop.handle(), None); SyncClient { client_handle: RefCell::new(client), io_loop: RefCell::new(io_loop), } } /// Creates a new DNS client with the specified connection type and a SIG0 signer. /// /// This is necessary for signed udpate requests to update trust-dns-server entries. /// /// # Arguments /// /// * `client_connection` - the client_connection to use for all communication /// * `signer` - signer to use, this needs an associated private key pub fn with_signer<CC: ClientConnection>(client_connection: CC, signer: Signer) -> SyncClient where <CC as ClientConnection>::MessageStream: Stream<Item=Vec<u8>, Error=io::Error> + 'static { let (io_loop, stream, stream_handle) = client_connection.unwrap(); let client = ClientFuture::new(stream, stream_handle, io_loop.handle(), Some(signer)); SyncClient { client_handle: RefCell::new(client), io_loop: RefCell::new(io_loop), } } } impl Client<BasicClientHandle> for SyncClient { fn get_io_loop(&self) -> RefMut<Core> { self.io_loop.borrow_mut() } fn get_client_handle(&self) -> RefMut<BasicClientHandle> { self.client_handle.borrow_mut() } } #[cfg(any(feature = "openssl", feature = "ring"))] pub struct SecureSyncClient { client_handle: RefCell<SecureClientHandle<BasicClientHandle>>, io_loop: RefCell<Core>, } #[cfg(any(feature = "openssl", feature = "ring"))] impl SecureSyncClient { /// Creates a new DNS client with the specified connection type /// /// # Arguments /// /// * `client_connection` - the client_connection to use for all communication pub fn new<CC>(client_connection: CC) -> SecureSyncClientBuilder<CC> where CC: ClientConnection, <CC as ClientConnection>::MessageStream: Stream<Item=Vec<u8>, Error=io::Error> + 'static { SecureSyncClientBuilder { client_connection: client_connection, trust_anchor: None, signer: None, } } /// DNSSec validating query, this will return an error if the requested records can not be /// validated against the trust_anchor. /// /// When the resolver receives an answer via the normal DNS lookup process, it then checks to /// make sure that the answer is correct. Then starts /// with verifying the DS and DNSKEY records at the DNS root. Then use the DS /// records for the top level domain found at the root, e.g. 'com', to verify the DNSKEY /// records in the 'com' zone. From there see if there is a DS record for the /// subdomain, e.g. 'example.com', in the 'com' zone, and if there is use the /// DS record to verify a DNSKEY record found in the 'example.com' zone. Finally, /// verify the RRSIG record found in the answer for the rrset, e.g. 'www.example.com'. /// /// *Note* As of now, this will not recurse on PTR or CNAME record responses, that is up to /// the caller. /// /// # Arguments /// /// * `query_name` - the label to lookup /// * `query_class` - most likely this should always be DNSClass::IN /// * `query_type` - record type to lookup #[deprecated = "just use query(...) from `Client`"] pub fn secure_query(&self, query_name: &domain::Name, query_class: DNSClass, query_type: RecordType) -> ClientResult<Message> { self.get_io_loop() .run(self.get_client_handle().query(query_name.clone(), query_class, query_type)) } } #[cfg(any(feature = "openssl", feature = "ring"))] impl Client<SecureClientHandle<BasicClientHandle>> for SecureSyncClient { fn get_io_loop(&self) -> RefMut<Core> { self.io_loop.borrow_mut() } fn get_client_handle(&self) -> RefMut<SecureClientHandle<BasicClientHandle>> { self.client_handle.borrow_mut() } } #[cfg(any(feature = "openssl", feature = "ring"))] pub struct SecureSyncClientBuilder<CC> where CC: ClientConnection, <CC as ClientConnection>::MessageStream: Stream<Item=Vec<u8>, Error=io::Error> + 'static { client_connection: CC, trust_anchor: Option<TrustAnchor>, signer: Option<Signer>, } #[cfg(any(feature = "openssl", feature = "ring"))] impl<CC> SecureSyncClientBuilder<CC> where CC: ClientConnection, <CC as ClientConnection>::MessageStream: Stream<Item=Vec<u8>, Error=io::Error> + 'static { /// This variant allows for the trust_anchor to be replaced /// /// # Arguments /// /// * `trust_anchor` - the set of trusted DNSKEY public_keys, by default this only contains the /// root public_key. pub fn trust_anchor(mut self, trust_anchor: TrustAnchor) -> Self { self.trust_anchor = Some(trust_anchor); self } /// Associate a signer to produce a SIG0 for all udpate requests /// /// This is necessary for signed update requests to update trust-dns-server entries /// /// # Arguments /// /// * `signer` - signer to use, this needs an associated private key pub fn signer(mut self, signer: Signer) -> Self { self.signer = Some(signer); self } pub fn build(self) -> SecureSyncClient { let (io_loop, stream, stream_handle) = self.client_connection.unwrap(); let client = ClientFuture::new( stream, stream_handle, io_loop.handle(), self.signer); let client = SecureClientHandle::with_trust_anchor(client, self.trust_anchor.unwrap_or(Default::default())); SecureSyncClient{ client_handle: RefCell::new(client), io_loop: RefCell::new(io_loop) } } }