contrib/unbound/iterator/iter_utils.h

   1 /*
   2  * iterator/iter_utils.h - iterative resolver module utility functions.
   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 LIMITED
  25  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  26  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE
  27  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  28  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  29  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  30  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  31  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  32  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  33  * POSSIBILITY OF SUCH DAMAGE.
  34  */
  35
  36 /**
  37  * \file
  38  *
  39  * This file contains functions to assist the iterator module.
  40  * Configuration options. Forward zones.
  41  */
  42
  43 #ifndef ITERATOR_ITER_UTILS_H
  44 #define ITERATOR_ITER_UTILS_H
  45 #include "iterator/iter_resptype.h"
  46 #include <ldns/buffer.h>
  47 struct iter_env;
  48 struct iter_hints;
  49 struct iter_forwards;
  50 struct config_file;
  51 struct module_env;
  52 struct delegpt_addr;
  53 struct delegpt;
  54 struct regional;
  55 struct msg_parse;
  56 struct ub_randstate;
  57 struct query_info;
  58 struct reply_info;
  59 struct module_qstate;
  60 struct sock_list;
  61 struct ub_packed_rrset_key;
  62
  63 /**
  64  * Process config options and set iterator module state.
  65  * Sets default values if no config is found.
  66  * @param iter_env: iterator module state.
  67  * @param cfg: config options.
  68  * @return 0 on error.
  69  */
  70 int iter_apply_cfg(struct iter_env* iter_env, struct config_file* cfg);
  71
  72 /**
  73  * Select a valid, nice target to send query to.
  74  * Sorting and removing unsuitable targets is combined.
  75  *
  76  * @param iter_env: iterator module global state, with ip6 enabled and
  77  *      do-not-query-addresses.
  78  * @param env: environment with infra cache (lameness, rtt info).
  79  * @param dp: delegation point with result list.
  80  * @param name: zone name (for lameness check).
  81  * @param namelen: length of name.
  82  * @param qtype: query type that we want to send.
  83  * @param dnssec_lame: set to 1, if a known dnssec-lame server is selected
  84  *      these are not preferred, but are used as a last resort.
  85  * @param chase_to_rd: set to 1 if a known recursion lame server is selected
  86  *      these are not preferred, but are used as a last resort.
  87  * @param open_target: number of currently outstanding target queries.
  88  *      If we wait for these, perhaps more server addresses become available.
  89  * @param blacklist: the IP blacklist to use.
  90  * @return best target or NULL if no target.
  91  *      if not null, that target is removed from the result list in the dp.
  92  */
  93 struct delegpt_addr* iter_server_selection(struct iter_env* iter_env,
  94         struct module_env* env, struct delegpt* dp, uint8_t* name,
  95         size_t namelen, uint16_t qtype, int* dnssec_lame,
  96         int* chase_to_rd, int open_target, struct sock_list* blacklist);
  97
  98 /**
  99  * Allocate dns_msg from parsed msg, in regional.
 100  * @param pkt: packet.
 101  * @param msg: parsed message (cleaned and ready for regional allocation).
 102  * @param regional: regional to use for allocation.
 103  * @return newly allocated dns_msg, or NULL on memory error.
 104  */
 105 struct dns_msg* dns_alloc_msg(ldns_buffer* pkt, struct msg_parse* msg,
 106         struct regional* regional);
 107
 108 /**
 109  * Copy a dns_msg to this regional.
 110  * @param from: dns message, also in regional.
 111  * @param regional: regional to use for allocation.
 112  * @return newly allocated dns_msg, or NULL on memory error.
 113  */
 114 struct dns_msg* dns_copy_msg(struct dns_msg* from, struct regional* regional);
 115
 116 /**
 117  * Allocate a dns_msg with malloc/alloc structure and store in dns cache.
 118  * @param env: environment, with alloc structure and dns cache.
 119  * @param qinf: query info, the query for which answer is stored.
 120  * @param rep: reply in dns_msg from dns_alloc_msg for example.
 121  * @param is_referral: If true, then the given message to be stored is a
 122  *      referral. The cache implementation may use this as a hint.
 123  * @param leeway: prefetch TTL leeway to expire old rrsets quicker.
 124  * @param pside: true if dp is parentside, thus message is 'fresh' and NS
 125  *      can be prefetch-updates.
 126  * @param region: to copy modified (cache is better) rrs back to.
 127  * @return void, because we are not interested in alloc errors,
 128  *      the iterator and validator can operate on the results in their
 129  *      scratch space (the qstate.region) and are not dependent on the cache.
 130  *      It is useful to log the alloc failure (for the server operator),
 131  *      but the query resolution can continue without cache storage.
 132  */
 133 void iter_dns_store(struct module_env* env, struct query_info* qinf,
 134         struct reply_info* rep, int is_referral, uint32_t leeway, int pside,
 135         struct regional* region);
 136
 137 /**
 138  * Select randomly with n/m probability.
 139  * For shuffle NS records for address fetching.
 140  * @param rnd: random table
 141  * @param n: probability.
 142  * @param m: divisor for probability.
 143  * @return true with n/m probability.
 144  */
 145 int iter_ns_probability(struct ub_randstate* rnd, int n, int m);
 146
 147 /**
 148  * Mark targets that result in a dependency cycle as done, so they
 149  * will not get selected as targets.
 150  * @param qstate: query state.
 151  * @param dp: delegpt to mark ns in.
 152  */
 153 void iter_mark_cycle_targets(struct module_qstate* qstate, struct delegpt* dp);
 154
 155 /**
 156  * Mark targets that result in a dependency cycle as done, so they
 157  * will not get selected as targets.  For the parent-side lookups.
 158  * @param qstate: query state.
 159  * @param dp: delegpt to mark ns in.
 160  */
 161 void iter_mark_pside_cycle_targets(struct module_qstate* qstate,
 162         struct delegpt* dp);
 163
 164 /**
 165  * See if delegation is useful or offers immediately no targets for
 166  * further recursion.
 167  * @param qinfo: query name and type
 168  * @param qflags: query flags with RD flag
 169  * @param dp: delegpt to check.
 170  * @return true if dp is useless.
 171  */
 172 int iter_dp_is_useless(struct query_info* qinfo, uint16_t qflags,
 173         struct delegpt* dp);
 174
 175 /**
 176  * See if delegation is expected to have DNSSEC information (RRSIGs) in
 177  * its answers, or not. Inspects delegation point (name), trust anchors,
 178  * and delegation message (DS RRset) to determine this.
 179  * @param env: module env with trust anchors.
 180  * @param dp: delegation point.
 181  * @param msg: delegation message, with DS if a secure referral.
 182  * @param dclass: class of query.
 183  * @return 1 if dnssec is expected, 0 if not.
 184  */
 185 int iter_indicates_dnssec(struct module_env* env, struct delegpt* dp,
 186         struct dns_msg* msg, uint16_t dclass);
 187
 188 /**
 189  * See if a message contains DNSSEC.
 190  * This is examined by looking for RRSIGs. With DNSSEC a valid answer,
 191  * nxdomain, nodata, referral or cname reply has RRSIGs in answer or auth
 192  * sections, sigs on answer data, SOA, DS, or NSEC/NSEC3 records.
 193  * @param msg: message to examine.
 194  * @return true if DNSSEC information was found.
 195  */
 196 int iter_msg_has_dnssec(struct dns_msg* msg);
 197
 198 /**
 199  * See if a message is known to be from a certain zone.
 200  * This looks for SOA or NS rrsets, for answers.
 201  * For referrals, when one label is delegated, the zone is detected.
 202  * Does not look at signatures.
 203  * @param msg: the message to inspect.
 204  * @param dp: delegation point with zone name to look for.
 205  * @param type: type of message.
 206  * @param dclass: class of query.
 207  * @return true if message is certain to be from zone in dp->name.
 208  *      false if not sure (empty msg), or not from the zone.
 209  */
 210 int iter_msg_from_zone(struct dns_msg* msg, struct delegpt* dp,
 211         enum response_type type, uint16_t dclass);
 212
 213 /**
 214  * Check if two replies are equal
 215  * For fallback procedures
 216  * @param p: reply one. The reply has rrset data pointers in region.
 217  *      Does not check rrset-IDs
 218  * @param q: reply two
 219  * @param buf: scratch buffer.
 220  * @return if one and two are equal.
 221  */
 222 int reply_equal(struct reply_info* p, struct reply_info* q, ldns_buffer* buf);
 223
 224 /**
 225  * Store parent-side rrset in seperate rrset cache entries for later
 226  * last-resort * lookups in case the child-side versions of this information
 227  * fails.
 228  * @param env: environment with cache, time, ...
 229  * @param rrset: the rrset to store (copied).
 230  * Failure to store is logged, but otherwise ignored.
 231  */
 232 void iter_store_parentside_rrset(struct module_env* env,
 233         struct ub_packed_rrset_key* rrset);
 234
 235 /**
 236  * Store parent-side NS records from a referral message
 237  * @param env: environment with cache, time, ...
 238  * @param rep: response with NS rrset.
 239  * Failure to store is logged, but otherwise ignored.
 240  */
 241 void iter_store_parentside_NS(struct module_env* env, struct reply_info* rep);
 242
 243 /**
 244  * Store parent-side negative element, the parentside rrset does not exist,
 245  * creates an rrset with empty rdata in the rrset cache with PARENTSIDE flag.
 246  * @param env: environment with cache, time, ...
 247  * @param qinfo: the identity of the rrset that is missing.
 248  * @param rep: delegation response or answer response, to glean TTL from.
 249  * (malloc) failure is logged but otherwise ignored.
 250  */
 251 void iter_store_parentside_neg(struct module_env* env,
 252         struct query_info* qinfo, struct reply_info* rep);
 253
 254 /**
 255  * Add parent NS record if that exists in the cache.  This is both new
 256  * information and acts like a timeout throttle on retries.
 257  * @param env: query env with rrset cache and time.
 258  * @param dp: delegation point to store result in.  Also this dp is used to
 259  *      see which NS name is needed.
 260  * @param region: region to alloc result in.
 261  * @param qinfo: pertinent information, the qclass.
 262  * @return false on malloc failure.
 263  *      if true, the routine worked and if such cached information
 264  *      existed dp->has_parent_side_NS is set true.
 265  */
 266 int iter_lookup_parent_NS_from_cache(struct module_env* env,
 267         struct delegpt* dp, struct regional* region, struct query_info* qinfo);
 268
 269 /**
 270  * Add parent-side glue if that exists in the cache.  This is both new
 271  * information and acts like a timeout throttle on retries to fetch them.
 272  * @param env: query env with rrset cache and time.
 273  * @param dp: delegation point to store result in.  Also this dp is used to
 274  *      see which NS name is needed.
 275  * @param region: region to alloc result in.
 276  * @param qinfo: pertinent information, the qclass.
 277  * @return: true, it worked, no malloc failures, and new addresses (lame)
 278  *      have been added, giving extra options as query targets.
 279  */
 280 int iter_lookup_parent_glue_from_cache(struct module_env* env,
 281         struct delegpt* dp, struct regional* region, struct query_info* qinfo);
 282
 283 /**
 284  * Lookup next root-hint or root-forward entry.
 285  * @param hints: the hints.
 286  * @param fwd: the forwards.
 287  * @param c: the class to start searching at. 0 means find first one.
 288  * @return false if no classes found, true if found and returned in c.
 289  */
 290 int iter_get_next_root(struct iter_hints* hints, struct iter_forwards* fwd,
 291         uint16_t* c);
 292
 293 /**
 294  * Remove DS records that are inappropriate before they are cached.
 295  * @param msg: the response to scrub.
 296  * @param ns: RRSET that is the NS record for the referral.
 297  *      if NULL, then all DS records are removed from the authority section.
 298  * @param z: zone name that the response is from.
 299  */
 300 void iter_scrub_ds(struct dns_msg* msg, struct ub_packed_rrset_key* ns,
 301         uint8_t* z);
 302
 303 /**
 304  * Remove query attempts from all available ips. For 0x20.
 305  * @param dp: delegpt.
 306  * @param d: decrease.
 307  */
 308 void iter_dec_attempts(struct delegpt* dp, int d);
 309
 310 /**
 311  * Add retry counts from older delegpt to newer delegpt.
 312  * Does not waste time on timeout'd (or other failing) addresses.
 313  * @param dp: new delegationpoint.
 314  * @param old: old delegationpoint.
 315  */
 316 void iter_merge_retry_counts(struct delegpt* dp, struct delegpt* old);
 317
 318 /**
 319  * See if a DS response (type ANSWER) is too low: a nodata answer with
 320  * a SOA record in the authority section at-or-below the qchase.qname.
 321  * Also returns true if we are not sure (i.e. empty message, CNAME nosig).
 322  * @param msg: the response.
 323  * @param dp: the dp name is used to check if the RRSIG gives a clue that
 324  *      it was originated from the correct nameserver.
 325  * @return true if too low.
 326  */
 327 int iter_ds_toolow(struct dns_msg* msg, struct delegpt* dp);
 328
 329 /**
 330  * See if delegpt can go down a step to the qname or not
 331  * @param qinfo: the query name looked up.
 332  * @param dp: checked if the name can go lower to the qname
 333  * @return true if can go down, false if that would not be possible.
 334  * the current response seems to be the one and only, best possible, response.
 335  */
 336 int iter_dp_cangodown(struct query_info* qinfo, struct delegpt* dp);
 337
 338 #endif /* ITERATOR_ITER_UTILS_H */