contrib/unbound/iterator/iterator.h

   1 /*
   2  * iterator/iterator.h - iterative resolver DNS query response module
   3  *
   4  * Copyright (c) 2007, NLnet Labs. All rights reserved.
   5  *
   6  * This software is open source.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  * Redistributions of source code must retain the above copyright notice,
  13  * this list of conditions and the following disclaimer.
  14  *
  15  * Redistributions in binary form must reproduce the above copyright notice,
  16  * this list of conditions and the following disclaimer in the documentation
  17  * and/or other materials provided with the distribution.
  18  *
  19  * Neither the name of the NLNET LABS nor the names of its contributors may
  20  * be used to endorse or promote products derived from this software without
  21  * specific prior written permission.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  24  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  25  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  26  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  27  * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  28  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
  29  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  30  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  31  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  32  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  33  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34  */
  35
  36 /**
  37  * \file
  38  *
  39  * This file contains a module that performs recusive iterative DNS query
  40  * processing.
  41  */
  42
  43 #ifndef ITERATOR_ITERATOR_H
  44 #define ITERATOR_ITERATOR_H
  45 #include "services/outbound_list.h"
  46 #include "util/data/msgreply.h"
  47 #include "util/module.h"
  48 struct delegpt;
  49 struct iter_hints;
  50 struct iter_forwards;
  51 struct iter_donotq;
  52 struct iter_prep_list;
  53 struct iter_priv;
  54 struct rbtree_t;
  55
  56 /** max number of targets spawned for a query and its subqueries */
  57 #define MAX_TARGET_COUNT        64
  58 /** max number of query restarts. Determines max number of CNAME chain. */
  59 #define MAX_RESTART_COUNT       8
  60 /** max number of referrals. Makes sure resolver does not run away */
  61 #define MAX_REFERRAL_COUNT      130
  62 /** max number of queries-sent-out.  Make sure large NS set does not loop */
  63 #define MAX_SENT_COUNT          32
  64 /** at what query-sent-count to stop target fetch policy */
  65 #define TARGET_FETCH_STOP       3
  66 /** how nice is a server without further information, in msec
  67  * Equals rtt initial timeout value.
  68  */
  69 #define UNKNOWN_SERVER_NICENESS 376
  70 /** maximum timeout before a host is deemed unsuitable, in msec.
  71  * After host_ttl this will be timed out and the host will be tried again.
  72  * Equals RTT_MAX_TIMEOUT
  73  */
  74 #define USEFUL_SERVER_TOP_TIMEOUT       120000
  75 /** number of retries on outgoing queries */
  76 #define OUTBOUND_MSG_RETRY 5
  77 /** RTT band, within this amount from the best, servers are chosen randomly.
  78  * Chosen so that the UNKNOWN_SERVER_NICENESS falls within the band of a
  79  * fast server, this causes server exploration as a side benefit. msec. */
  80 #define RTT_BAND 400
  81 /** Start value for blacklisting a host, 2*USEFUL_SERVER_TOP_TIMEOUT in sec */
  82 #define INFRA_BACKOFF_INITIAL 240
  83
  84 /**
  85  * Global state for the iterator.
  86  */
  87 struct iter_env {
  88         /** A flag to indicate whether or not we have an IPv6 route */
  89         int supports_ipv6;
  90
  91         /** A flag to indicate whether or not we have an IPv4 route */
  92         int supports_ipv4;
  93
  94         /** A set of inetaddrs that should never be queried. */
  95         struct iter_donotq* donotq;
  96
  97         /** private address space and private domains */
  98         struct iter_priv* priv;
  99
 100         /** whitelist for capsforid names */
 101         struct rbtree_t* caps_white;
 102
 103         /** The maximum dependency depth that this resolver will pursue. */
 104         int max_dependency_depth;
 105
 106         /**
 107          * The target fetch policy for each dependency level. This is
 108          * described as a simple number (per dependency level):
 109          *      negative numbers (usually just -1) mean fetch-all,
 110          *      0 means only fetch on demand, and
 111          *      positive numbers mean to fetch at most that many targets.
 112          * array of max_dependency_depth+1 size.
 113          */
 114         int* target_fetch_policy;
 115 };
 116
 117 /**
 118  * State of the iterator for a query.
 119  */
 120 enum iter_state {
 121         /**
 122          * Externally generated queries start at this state. Query restarts are
 123          * reset to this state.
 124          */
 125         INIT_REQUEST_STATE = 0,
 126
 127         /**
 128          * Root priming events reactivate here, most other events pass
 129          * through this naturally as the 2nd part of the INIT_REQUEST_STATE.
 130          */
 131         INIT_REQUEST_2_STATE,
 132
 133         /**
 134          * Stub priming events reactivate here, most other events pass
 135          * through this naturally as the 3rd part of the INIT_REQUEST_STATE.
 136          */
 137         INIT_REQUEST_3_STATE,
 138
 139         /**
 140          * Each time a delegation point changes for a given query or a
 141          * query times out and/or wakes up, this state is (re)visited.
 142          * This state is reponsible for iterating through a list of
 143          * nameserver targets.
 144          */
 145         QUERYTARGETS_STATE,
 146
 147         /**
 148          * Responses to queries start at this state. This state handles
 149          * the decision tree associated with handling responses.
 150          */
 151         QUERY_RESP_STATE,
 152
 153         /** Responses to priming queries finish at this state. */
 154         PRIME_RESP_STATE,
 155
 156         /** Collecting query class information, for qclass=ANY, when
 157          * it spawns off queries for every class, it returns here. */
 158         COLLECT_CLASS_STATE,
 159
 160         /** Find NS record to resolve DS record from, walking to the right
 161          * NS spot until we find it */
 162         DSNS_FIND_STATE,
 163
 164         /** Responses that are to be returned upstream end at this state.
 165          * As well as responses to target queries. */
 166         FINISHED_STATE
 167 };
 168
 169 /**
 170  * Per query state for the iterator module.
 171  */
 172 struct iter_qstate {
 173         /**
 174          * State of the iterator module.
 175          * This is the state that event is in or should sent to -- all
 176          * requests should start with the INIT_REQUEST_STATE. All
 177          * responses should start with QUERY_RESP_STATE. Subsequent
 178          * processing of the event will change this state.
 179          */
 180         enum iter_state state;
 181
 182         /**
 183          * Final state for the iterator module.
 184          * This is the state that responses should be routed to once the
 185          * response is final. For externally initiated queries, this
 186          * will be FINISHED_STATE, locally initiated queries will have
 187          * different final states.
 188          */
 189         enum iter_state final_state;
 190
 191         /**
 192          * The depth of this query, this means the depth of recursion.
 193          * This address is needed for another query, which is an address
 194          * needed for another query, etc. Original client query has depth 0.
 195          */
 196         int depth;
 197
 198         /**
 199          * The response
 200          */
 201         struct dns_msg* response;
 202
 203         /**
 204          * This is a list of RRsets that must be prepended to the
 205          * ANSWER section of a response before being sent upstream.
 206          */
 207         struct iter_prep_list* an_prepend_list;
 208         /** Last element of the prepend list */
 209         struct iter_prep_list* an_prepend_last;
 210
 211         /**
 212          * This is the list of RRsets that must be prepended to the
 213          * AUTHORITY section of the response before being sent upstream.
 214          */
 215         struct iter_prep_list* ns_prepend_list;
 216         /** Last element of the authority prepend list */
 217         struct iter_prep_list* ns_prepend_last;
 218
 219         /** query name used for chasing the results. Initially the same as
 220          * the state qinfo, but after CNAMEs this will be different.
 221          * The query info used to elicit the results needed. */
 222         struct query_info qchase;
 223         /** query flags to use when chasing the answer (i.e. RD flag) */
 224         uint16_t chase_flags;
 225         /** true if we set RD bit because of last resort recursion lame query*/
 226         int chase_to_rd;
 227
 228         /**
 229          * This is the current delegation point for an in-progress query. This
 230          * object retains state as to which delegation targets need to be
 231          * (sub)queried for vs which ones have already been visited.
 232          */
 233         struct delegpt* dp;
 234
 235         /** state for 0x20 fallback when capsfail happens, 0 not a fallback */
 236         int caps_fallback;
 237         /** state for capsfail: current server number to try */
 238         size_t caps_server;
 239         /** state for capsfail: stored query for comparisons. Can be NULL if
 240          * no response had been seen prior to starting the fallback. */
 241         struct reply_info* caps_reply;
 242         struct dns_msg* caps_response;
 243
 244         /** Current delegation message - returned for non-RD queries */
 245         struct dns_msg* deleg_msg;
 246
 247         /** number of outstanding target sub queries */
 248         int num_target_queries;
 249
 250         /** outstanding direct queries */
 251         int num_current_queries;
 252
 253         /** the number of times this query has been restarted. */
 254         int query_restart_count;
 255
 256         /** the number of times this query as followed a referral. */
 257         int referral_count;
 258
 259         /** number of queries fired off */
 260         int sent_count;
 261
 262         /** number of target queries spawned in [1], for this query and its
 263          * subqueries, the malloced-array is shared, [0] refcount. */
 264         int* target_count;
 265
 266         /** if true, already tested for ratelimiting and passed the test */
 267         int ratelimit_ok;
 268
 269         /**
 270          * The query must store NS records from referrals as parentside RRs
 271          * Enabled once it hits resolution problems, to throttle retries.
 272          * If enabled it is the pointer to the old delegation point with
 273          * the old retry counts for bad-nameserver-addresses.
 274          */
 275         struct delegpt* store_parent_NS;
 276
 277         /**
 278          * The query is for parent-side glue(A or AAAA) for a nameserver.
 279          * If the item is seen as glue in a referral, and pside_glue is NULL,
 280          * then it is stored in pside_glue for later.
 281          * If it was never seen, at the end, then a negative caching element
 282          * must be created.
 283          * The (data or negative) RR cache element then throttles retries.
 284          */
 285         int query_for_pside_glue;
 286         /** the parent-side-glue element (NULL if none, its first match) */
 287         struct ub_packed_rrset_key* pside_glue;
 288
 289         /** If nonNULL we are walking upwards from DS query to find NS */
 290         uint8_t* dsns_point;
 291         /** length of the dname in dsns_point */
 292         size_t dsns_point_len;
 293
 294         /**
 295          * expected dnssec information for this iteration step.
 296          * If dnssec rrsigs are expected and not given, the server is marked
 297          * lame (dnssec-lame).
 298          */
 299         int dnssec_expected;
 300
 301         /**
 302          * We are expecting dnssec information, but we also know the server
 303          * is DNSSEC lame.  The response need not be marked dnssec-lame again.
 304          */
 305         int dnssec_lame_query;
 306
 307         /**
 308          * This is flag that, if true, means that this event is
 309          * waiting for a stub priming query.
 310          */
 311         int wait_priming_stub;
 312
 313         /**
 314          * This is a flag that, if true, means that this query is
 315          * for (re)fetching glue from a zone. Since the address should
 316          * have been glue, query again to the servers that should have
 317          * been returning it as glue.
 318          * The delegation point must be set to the one that should *not*
 319          * be used when creating the state. A higher one will be attempted.
 320          */
 321         int refetch_glue;
 322
 323         /** list of pending queries to authoritative servers. */
 324         struct outbound_list outlist;
 325 };
 326
 327 /**
 328  * List of prepend items
 329  */
 330 struct iter_prep_list {
 331         /** next in list */
 332         struct iter_prep_list* next;
 333         /** rrset */
 334         struct ub_packed_rrset_key* rrset;
 335 };
 336
 337 /**
 338  * Get the iterator function block.
 339  * @return: function block with function pointers to iterator methods.
 340  */
 341 struct module_func_block* iter_get_funcblock(void);
 342
 343 /**
 344  * Get iterator state as a string
 345  * @param state: to convert
 346  * @return constant string that is printable.
 347  */
 348 const char* iter_state_to_string(enum iter_state state);
 349
 350 /**
 351  * See if iterator state is a response state
 352  * @param s: to inspect
 353  * @return true if response state.
 354  */
 355 int iter_state_is_responsestate(enum iter_state s);
 356
 357 /** iterator init */
 358 int iter_init(struct module_env* env, int id);
 359
 360 /** iterator deinit */
 361 void iter_deinit(struct module_env* env, int id);
 362
 363 /** iterator operate on a query */
 364 void iter_operate(struct module_qstate* qstate, enum module_ev event, int id,
 365         struct outbound_entry* outbound);
 366
 367 /**
 368  * Return priming query results to interestes super querystates.
 369  *
 370  * Sets the delegation point and delegation message (not nonRD queries).
 371  * This is a callback from walk_supers.
 372  *
 373  * @param qstate: query state that finished.
 374  * @param id: module id.
 375  * @param super: the qstate to inform.
 376  */
 377 void iter_inform_super(struct module_qstate* qstate, int id,
 378         struct module_qstate* super);
 379
 380 /** iterator cleanup query state */
 381 void iter_clear(struct module_qstate* qstate, int id);
 382
 383 /** iterator alloc size routine */
 384 size_t iter_get_mem(struct module_env* env, int id);
 385
 386 #endif /* ITERATOR_ITERATOR_H */