contrib/bind9/lib/dns/include/dns/resolver.h

   1 /*
   2  * Copyright (C) 2004-2012  Internet Systems Consortium, Inc. ("ISC")
   3  * Copyright (C) 1999-2001, 2003  Internet Software Consortium.
   4  *
   5  * Permission to use, copy, modify, and/or distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  10  * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  11  * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  12  * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  13  * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  14  * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  15  * PERFORMANCE OF THIS SOFTWARE.
  16  */
  17
  18 /* $Id: resolver.h,v 1.72 2011/12/05 17:10:51 each Exp $ */
  19
  20 #ifndef DNS_RESOLVER_H
  21 #define DNS_RESOLVER_H 1
  22
  23 /*****
  24  ***** Module Info
  25  *****/
  26
  27 /*! \file dns/resolver.h
  28  *
  29  * \brief
  30  * This is the BIND 9 resolver, the module responsible for resolving DNS
  31  * requests by iteratively querying authoritative servers and following
  32  * referrals.  This is a "full resolver", not to be confused with
  33  * the stub resolvers most people associate with the word "resolver".
  34  * The full resolver is part of the caching name server or resolver
  35  * daemon the stub resolver talks to.
  36  *
  37  * MP:
  38  *\li   The module ensures appropriate synchronization of data structures it
  39  *      creates and manipulates.
  40  *
  41  * Reliability:
  42  *\li   No anticipated impact.
  43  *
  44  * Resources:
  45  *\li   TBS
  46  *
  47  * Security:
  48  *\li   No anticipated impact.
  49  *
  50  * Standards:
  51  *\li   RFCs:   1034, 1035, 2181, TBS
  52  *\li   Drafts: TBS
  53  */
  54
  55 #include <isc/lang.h>
  56 #include <isc/socket.h>
  57
  58 #include <dns/types.h>
  59 #include <dns/fixedname.h>
  60
  61 ISC_LANG_BEGINDECLS
  62
  63 /*%
  64  * A dns_fetchevent_t is sent when a 'fetch' completes.  Any of 'db',
  65  * 'node', 'rdataset', and 'sigrdataset' may be bound.  It is the
  66  * receiver's responsibility to detach before freeing the event.
  67  * \brief
  68  * 'rdataset', 'sigrdataset', 'client' and 'id' are the values that were
  69  * supplied when dns_resolver_createfetch() was called.  They are returned
  70  *  to the caller so that they may be freed.
  71  */
  72 typedef struct dns_fetchevent {
  73         ISC_EVENT_COMMON(struct dns_fetchevent);
  74         dns_fetch_t *                   fetch;
  75         isc_result_t                    result;
  76         dns_rdatatype_t                 qtype;
  77         dns_db_t *                      db;
  78         dns_dbnode_t *                  node;
  79         dns_rdataset_t *                rdataset;
  80         dns_rdataset_t *                sigrdataset;
  81         dns_fixedname_t                 foundname;
  82         isc_sockaddr_t *                client;
  83         dns_messageid_t                 id;
  84         isc_result_t                    vresult;
  85 } dns_fetchevent_t;
  86
  87 /*
  88  * Options that modify how a 'fetch' is done.
  89  */
  90 #define DNS_FETCHOPT_TCP                0x01         /*%< Use TCP. */
  91 #define DNS_FETCHOPT_UNSHARED           0x02         /*%< See below. */
  92 #define DNS_FETCHOPT_RECURSIVE          0x04         /*%< Set RD? */
  93 #define DNS_FETCHOPT_NOEDNS0            0x08         /*%< Do not use EDNS. */
  94 #define DNS_FETCHOPT_FORWARDONLY        0x10         /*%< Only use forwarders. */
  95 #define DNS_FETCHOPT_NOVALIDATE         0x20         /*%< Disable validation. */
  96 #define DNS_FETCHOPT_EDNS512            0x40         /*%< Advertise a 512 byte
  97                                                           UDP buffer. */
  98 #define DNS_FETCHOPT_WANTNSID           0x80         /*%< Request NSID */
  99
 100 #define DNS_FETCHOPT_EDNSVERSIONSET     0x00800000
 101 #define DNS_FETCHOPT_EDNSVERSIONMASK    0xff000000
 102 #define DNS_FETCHOPT_EDNSVERSIONSHIFT   24
 103
 104 /*
 105  * Upper bounds of class of query RTT (ms).  Corresponds to
 106  * dns_resstatscounter_queryrttX statistics counters.
 107  */
 108 #define DNS_RESOLVER_QRYRTTCLASS0       10
 109 #define DNS_RESOLVER_QRYRTTCLASS0STR    "10"
 110 #define DNS_RESOLVER_QRYRTTCLASS1       100
 111 #define DNS_RESOLVER_QRYRTTCLASS1STR    "100"
 112 #define DNS_RESOLVER_QRYRTTCLASS2       500
 113 #define DNS_RESOLVER_QRYRTTCLASS2STR    "500"
 114 #define DNS_RESOLVER_QRYRTTCLASS3       800
 115 #define DNS_RESOLVER_QRYRTTCLASS3STR    "800"
 116 #define DNS_RESOLVER_QRYRTTCLASS4       1600
 117 #define DNS_RESOLVER_QRYRTTCLASS4STR    "1600"
 118
 119 /*
 120  * XXXRTH  Should this API be made semi-private?  (I.e.
 121  * _dns_resolver_create()).
 122  */
 123
 124 #define DNS_RESOLVER_CHECKNAMES         0x01
 125 #define DNS_RESOLVER_CHECKNAMESFAIL     0x02
 126
 127 isc_result_t
 128 dns_resolver_create(dns_view_t *view,
 129                     isc_taskmgr_t *taskmgr,
 130                     unsigned int ntasks, unsigned int ndisp,
 131                     isc_socketmgr_t *socketmgr,
 132                     isc_timermgr_t *timermgr,
 133                     unsigned int options,
 134                     dns_dispatchmgr_t *dispatchmgr,
 135                     dns_dispatch_t *dispatchv4,
 136                     dns_dispatch_t *dispatchv6,
 137                     dns_resolver_t **resp);
 138
 139 /*%<
 140  * Create a resolver.
 141  *
 142  * Notes:
 143  *
 144  *\li   Generally, applications should not create a resolver directly, but
 145  *      should instead call dns_view_createresolver().
 146  *
 147  * Requires:
 148  *
 149  *\li   'view' is a valid view.
 150  *
 151  *\li   'taskmgr' is a valid task manager.
 152  *
 153  *\li   'ntasks' > 0.
 154  *
 155  *\li   'socketmgr' is a valid socket manager.
 156  *
 157  *\li   'timermgr' is a valid timer manager.
 158  *
 159  *\li   'dispatchv4' is a dispatch with an IPv4 UDP socket, or is NULL.
 160  *      If not NULL, 'ndisp' clones of it will be created by the resolver.
 161  *
 162  *\li   'dispatchv6' is a dispatch with an IPv6 UDP socket, or is NULL.
 163  *      If not NULL, 'ndisp' clones of it will be created by the resolver.
 164  *
 165  *\li   resp != NULL && *resp == NULL.
 166  *
 167  * Returns:
 168  *
 169  *\li   #ISC_R_SUCCESS                          On success.
 170  *
 171  *\li   Anything else                           Failure.
 172  */
 173
 174 void
 175 dns_resolver_freeze(dns_resolver_t *res);
 176 /*%<
 177  * Freeze resolver.
 178  *
 179  * Notes:
 180  *
 181  *\li   Certain configuration changes cannot be made after the resolver
 182  *      is frozen.  Fetches cannot be created until the resolver is frozen.
 183  *
 184  * Requires:
 185  *
 186  *\li   'res' is a valid resolver.
 187  *
 188  * Ensures:
 189  *
 190  *\li   'res' is frozen.
 191  */
 192
 193 void
 194 dns_resolver_prime(dns_resolver_t *res);
 195 /*%<
 196  * Prime resolver.
 197  *
 198  * Notes:
 199  *
 200  *\li   Resolvers which have a forwarding policy other than dns_fwdpolicy_only
 201  *      need to be primed with the root nameservers, otherwise the root
 202  *      nameserver hints data may be used indefinitely.  This function requests
 203  *      that the resolver start a priming fetch, if it isn't already priming.
 204  *
 205  * Requires:
 206  *
 207  *\li   'res' is a valid, frozen resolver.
 208  */
 209
 210
 211 void
 212 dns_resolver_whenshutdown(dns_resolver_t *res, isc_task_t *task,
 213                           isc_event_t **eventp);
 214 /*%<
 215  * Send '*eventp' to 'task' when 'res' has completed shutdown.
 216  *
 217  * Notes:
 218  *
 219  *\li   It is not safe to detach the last reference to 'res' until
 220  *      shutdown is complete.
 221  *
 222  * Requires:
 223  *
 224  *\li   'res' is a valid resolver.
 225  *
 226  *\li   'task' is a valid task.
 227  *
 228  *\li   *eventp is a valid event.
 229  *
 230  * Ensures:
 231  *
 232  *\li   *eventp == NULL.
 233  */
 234
 235 void
 236 dns_resolver_shutdown(dns_resolver_t *res);
 237 /*%<
 238  * Start the shutdown process for 'res'.
 239  *
 240  * Notes:
 241  *
 242  *\li   This call has no effect if the resolver is already shutting down.
 243  *
 244  * Requires:
 245  *
 246  *\li   'res' is a valid resolver.
 247  */
 248
 249 void
 250 dns_resolver_attach(dns_resolver_t *source, dns_resolver_t **targetp);
 251
 252 void
 253 dns_resolver_detach(dns_resolver_t **resp);
 254
 255 isc_result_t
 256 dns_resolver_createfetch(dns_resolver_t *res, dns_name_t *name,
 257                          dns_rdatatype_t type,
 258                          dns_name_t *domain, dns_rdataset_t *nameservers,
 259                          dns_forwarders_t *forwarders,
 260                          unsigned int options, isc_task_t *task,
 261                          isc_taskaction_t action, void *arg,
 262                          dns_rdataset_t *rdataset,
 263                          dns_rdataset_t *sigrdataset,
 264                          dns_fetch_t **fetchp);
 265
 266 isc_result_t
 267 dns_resolver_createfetch2(dns_resolver_t *res, dns_name_t *name,
 268                           dns_rdatatype_t type,
 269                           dns_name_t *domain, dns_rdataset_t *nameservers,
 270                           dns_forwarders_t *forwarders,
 271                           isc_sockaddr_t *client, isc_uint16_t id,
 272                           unsigned int options, isc_task_t *task,
 273                           isc_taskaction_t action, void *arg,
 274                           dns_rdataset_t *rdataset,
 275                           dns_rdataset_t *sigrdataset,
 276                           dns_fetch_t **fetchp);
 277 /*%<
 278  * Recurse to answer a question.
 279  *
 280  * Notes:
 281  *
 282  *\li   This call starts a query for 'name', type 'type'.
 283  *
 284  *\li   The 'domain' is a parent domain of 'name' for which
 285  *      a set of name servers 'nameservers' is known.  If no
 286  *      such name server information is available, set
 287  *      'domain' and 'nameservers' to NULL.
 288  *
 289  *\li   'forwarders' is unimplemented, and subject to change when
 290  *      we figure out how selective forwarding will work.
 291  *
 292  *\li   When the fetch completes (successfully or otherwise), a
 293  *      #DNS_EVENT_FETCHDONE event with action 'action' and arg 'arg' will be
 294  *      posted to 'task'.
 295  *
 296  *\li   The values of 'rdataset' and 'sigrdataset' will be returned in
 297  *      the FETCHDONE event.
 298  *
 299  *\li   'client' and 'id' are used for duplicate query detection.  '*client'
 300  *      must remain stable until after 'action' has been called or
 301  *      dns_resolver_cancelfetch() is called.
 302  *
 303  * Requires:
 304  *
 305  *\li   'res' is a valid resolver that has been frozen.
 306  *
 307  *\li   'name' is a valid name.
 308  *
 309  *\li   'type' is not a meta type other than ANY.
 310  *
 311  *\li   'domain' is a valid name or NULL.
 312  *
 313  *\li   'nameservers' is a valid NS rdataset (whose owner name is 'domain')
 314  *      iff. 'domain' is not NULL.
 315  *
 316  *\li   'forwarders' is NULL.
 317  *
 318  *\li   'client' is a valid sockaddr or NULL.
 319  *
 320  *\li   'options' contains valid options.
 321  *
 322  *\li   'rdataset' is a valid, disassociated rdataset.
 323  *
 324  *\li   'sigrdataset' is NULL, or is a valid, disassociated rdataset.
 325  *
 326  *\li   fetchp != NULL && *fetchp == NULL.
 327  *
 328  * Returns:
 329  *
 330  *\li   #ISC_R_SUCCESS                                  Success
 331  *\li   #DNS_R_DUPLICATE
 332  *\li   #DNS_R_DROP
 333  *
 334  *\li   Many other values are possible, all of which indicate failure.
 335  */
 336
 337 void
 338 dns_resolver_cancelfetch(dns_fetch_t *fetch);
 339 /*%<
 340  * Cancel 'fetch'.
 341  *
 342  * Notes:
 343  *
 344  *\li   If 'fetch' has not completed, post its FETCHDONE event with a
 345  *      result code of #ISC_R_CANCELED.
 346  *
 347  * Requires:
 348  *
 349  *\li   'fetch' is a valid fetch.
 350  */
 351
 352 void
 353 dns_resolver_destroyfetch(dns_fetch_t **fetchp);
 354 /*%<
 355  * Destroy 'fetch'.
 356  *
 357  * Requires:
 358  *
 359  *\li   '*fetchp' is a valid fetch.
 360  *
 361  *\li   The caller has received the FETCHDONE event (either because the
 362  *      fetch completed or because dns_resolver_cancelfetch() was called).
 363  *
 364  * Ensures:
 365  *
 366  *\li   *fetchp == NULL.
 367  */
 368
 369 void
 370 dns_resolver_logfetch(dns_fetch_t *fetch, isc_log_t *lctx,
 371                       isc_logcategory_t *category, isc_logmodule_t *module,
 372                       int level, isc_boolean_t duplicateok);
 373 /*%<
 374  * Dump a log message on internal state at the completion of given 'fetch'.
 375  * 'lctx', 'category', 'module', and 'level' are used to write the log message.
 376  * By default, only one log message is written even if the corresponding fetch
 377  * context serves multiple clients; if 'duplicateok' is true the suppression
 378  * is disabled and the message can be written every time this function is
 379  * called.
 380  *
 381  * Requires:
 382  *
 383  *\li   'fetch' is a valid fetch, and has completed.
 384  */
 385
 386 dns_dispatchmgr_t *
 387 dns_resolver_dispatchmgr(dns_resolver_t *resolver);
 388
 389 dns_dispatch_t *
 390 dns_resolver_dispatchv4(dns_resolver_t *resolver);
 391
 392 dns_dispatch_t *
 393 dns_resolver_dispatchv6(dns_resolver_t *resolver);
 394
 395 isc_socketmgr_t *
 396 dns_resolver_socketmgr(dns_resolver_t *resolver);
 397
 398 isc_taskmgr_t *
 399 dns_resolver_taskmgr(dns_resolver_t *resolver);
 400
 401 isc_uint32_t
 402 dns_resolver_getlamettl(dns_resolver_t *resolver);
 403 /*%<
 404  * Get the resolver's lame-ttl.  zero => no lame processing.
 405  *
 406  * Requires:
 407  *\li   'resolver' to be valid.
 408  */
 409
 410 void
 411 dns_resolver_setlamettl(dns_resolver_t *resolver, isc_uint32_t lame_ttl);
 412 /*%<
 413  * Set the resolver's lame-ttl.  zero => no lame processing.
 414  *
 415  * Requires:
 416  *\li   'resolver' to be valid.
 417  */
 418
 419 unsigned int
 420 dns_resolver_nrunning(dns_resolver_t *resolver);
 421 /*%<
 422  * Return the number of currently running resolutions in this
 423  * resolver.  This is may be less than the number of outstanding
 424  * fetches due to multiple identical fetches, or more than the
 425  * number of of outstanding fetches due to the fact that resolution
 426  * can continue even though a fetch has been canceled.
 427  */
 428
 429 isc_result_t
 430 dns_resolver_addalternate(dns_resolver_t *resolver, isc_sockaddr_t *alt,
 431                           dns_name_t *name, in_port_t port);
 432 /*%<
 433  * Add alternate addresses to be tried in the event that the nameservers
 434  * for a zone are not available in the address families supported by the
 435  * operating system.
 436  *
 437  * Require:
 438  * \li  only one of 'name' or 'alt' to be valid.
 439  */
 440
 441 void
 442 dns_resolver_setudpsize(dns_resolver_t *resolver, isc_uint16_t udpsize);
 443 /*%<
 444  * Set the EDNS UDP buffer size advertised by the server.
 445  */
 446
 447 isc_uint16_t
 448 dns_resolver_getudpsize(dns_resolver_t *resolver);
 449 /*%<
 450  * Get the current EDNS UDP buffer size.
 451  */
 452
 453 void
 454 dns_resolver_reset_algorithms(dns_resolver_t *resolver);
 455 /*%<
 456  * Clear the disabled DNSSEC algorithms.
 457  */
 458
 459 isc_result_t
 460 dns_resolver_disable_algorithm(dns_resolver_t *resolver, dns_name_t *name,
 461                                unsigned int alg);
 462 /*%<
 463  * Mark the give DNSSEC algorithm as disabled and below 'name'.
 464  * Valid algorithms are less than 256.
 465  *
 466  * Returns:
 467  *\li   #ISC_R_SUCCESS
 468  *\li   #ISC_R_RANGE
 469  *\li   #ISC_R_NOMEMORY
 470  */
 471
 472 isc_boolean_t
 473 dns_resolver_algorithm_supported(dns_resolver_t *resolver, dns_name_t *name,
 474                                  unsigned int alg);
 475 /*%<
 476  * Check if the given algorithm is supported by this resolver.
 477  * This checks if the algorithm has been disabled via
 478  * dns_resolver_disable_algorithm() then the underlying
 479  * crypto libraries if not specifically disabled.
 480  */
 481
 482 isc_boolean_t
 483 dns_resolver_digest_supported(dns_resolver_t *resolver, unsigned int digest_type);
 484 /*%<
 485  * Is this digest type supported.
 486  */
 487
 488 void
 489 dns_resolver_resetmustbesecure(dns_resolver_t *resolver);
 490
 491 isc_result_t
 492 dns_resolver_setmustbesecure(dns_resolver_t *resolver, dns_name_t *name,
 493                              isc_boolean_t value);
 494
 495 isc_boolean_t
 496 dns_resolver_getmustbesecure(dns_resolver_t *resolver, dns_name_t *name);
 497
 498
 499 void
 500 dns_resolver_settimeout(dns_resolver_t *resolver, unsigned int seconds);
 501 /*%<
 502  * Set the length of time the resolver will work on a query, in seconds.
 503  *
 504  * If timeout is 0, the default timeout will be applied.
 505  *
 506  * Requires:
 507  * \li  resolver to be valid.
 508  */
 509
 510 unsigned int
 511 dns_resolver_gettimeout(dns_resolver_t *resolver);
 512 /*%<
 513  * Get the current length of time the resolver will work on a query, in seconds.
 514  *
 515  * Requires:
 516  * \li  resolver to be valid.
 517  */
 518
 519 void
 520 dns_resolver_setclientsperquery(dns_resolver_t *resolver,
 521                                 isc_uint32_t min, isc_uint32_t max);
 522
 523 void
 524 dns_resolver_getclientsperquery(dns_resolver_t *resolver, isc_uint32_t *cur,
 525                                 isc_uint32_t *min, isc_uint32_t *max);
 526
 527 isc_boolean_t
 528 dns_resolver_getzeronosoattl(dns_resolver_t *resolver);
 529
 530 void
 531 dns_resolver_setzeronosoattl(dns_resolver_t *resolver, isc_boolean_t state);
 532
 533 unsigned int
 534 dns_resolver_getoptions(dns_resolver_t *resolver);
 535
 536 void
 537 dns_resolver_addbadcache(dns_resolver_t *resolver, dns_name_t *name,
 538                          dns_rdatatype_t type, isc_time_t *expire);
 539 /*%<
 540  * Add a entry to the bad cache for <name,type> that will expire at 'expire'.
 541  *
 542  * Requires:
 543  * \li  resolver to be valid.
 544  * \li  name to be valid.
 545  */
 546
 547 isc_boolean_t
 548 dns_resolver_getbadcache(dns_resolver_t *resolver, dns_name_t *name,
 549                          dns_rdatatype_t type, isc_time_t *now);
 550 /*%<
 551  * Check to see if there is a unexpired entry in the bad cache for
 552  * <name,type>.
 553  *
 554  * Requires:
 555  * \li  resolver to be valid.
 556  * \li  name to be valid.
 557  */
 558
 559 void
 560 dns_resolver_flushbadcache(dns_resolver_t *resolver, dns_name_t *name);
 561 /*%<
 562  * Flush the bad cache of all entries at 'name' if 'name' is non NULL.
 563  * Flush the entire bad cache if 'name' is NULL.
 564  *
 565  * Requires:
 566  * \li  resolver to be valid.
 567  */
 568
 569 void
 570 dns_resolver_printbadcache(dns_resolver_t *resolver, FILE *fp);
 571 /*%
 572  * Print out the contents of the bad cache to 'fp'.
 573  *
 574  * Requires:
 575  * \li  resolver to be valid.
 576  */
 577
 578 ISC_LANG_ENDDECLS
 579
 580 #endif /* DNS_RESOLVER_H */