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
  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 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 struct sldns_buffer;
  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(struct sldns_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  * @param flags: with BIT_CD for dns64 AAAA translated queries.
 128  * @return void, because we are not interested in alloc errors,
 129  *      the iterator and validator can operate on the results in their
 130  *      scratch space (the qstate.region) and are not dependent on the cache.
 131  *      It is useful to log the alloc failure (for the server operator),
 132  *      but the query resolution can continue without cache storage.
 133  */
 134 void iter_dns_store(struct module_env* env, struct query_info* qinf,
 135         struct reply_info* rep, int is_referral, time_t leeway, int pside,
 136         struct regional* region, uint16_t flags);
 137
 138 /**
 139  * Select randomly with n/m probability.
 140  * For shuffle NS records for address fetching.
 141  * @param rnd: random table
 142  * @param n: probability.
 143  * @param m: divisor for probability.
 144  * @return true with n/m probability.
 145  */
 146 int iter_ns_probability(struct ub_randstate* rnd, int n, int m);
 147
 148 /**
 149  * Mark targets that result in a dependency cycle as done, so they
 150  * will not get selected as targets.
 151  * @param qstate: query state.
 152  * @param dp: delegpt to mark ns in.
 153  */
 154 void iter_mark_cycle_targets(struct module_qstate* qstate, struct delegpt* dp);
 155
 156 /**
 157  * Mark targets that result in a dependency cycle as done, so they
 158  * will not get selected as targets.  For the parent-side lookups.
 159  * @param qstate: query state.
 160  * @param dp: delegpt to mark ns in.
 161  */
 162 void iter_mark_pside_cycle_targets(struct module_qstate* qstate,
 163         struct delegpt* dp);
 164
 165 /**
 166  * See if delegation is useful or offers immediately no targets for
 167  * further recursion.
 168  * @param qinfo: query name and type
 169  * @param qflags: query flags with RD flag
 170  * @param dp: delegpt to check.
 171  * @return true if dp is useless.
 172  */
 173 int iter_dp_is_useless(struct query_info* qinfo, uint16_t qflags,
 174         struct delegpt* dp);
 175
 176 /**
 177  * See if qname has DNSSEC needs in the forwarding case.  This is true if
 178  * there is a trust anchor above it.  Whether there is an insecure delegation
 179  * to the data is unknown, but CD-retry is needed.
 180  * @param env: environment with anchors.
 181  * @param qinfo: query name and class.
 182  * @return true if trust anchor above qname, false if no anchor or insecure
 183  * point above qname.
 184  */
 185 int iter_indicates_dnssec_fwd(struct module_env* env,
 186         struct query_info *qinfo);
 187
 188 /**
 189  * See if delegation is expected to have DNSSEC information (RRSIGs) in
 190  * its answers, or not. Inspects delegation point (name), trust anchors,
 191  * and delegation message (DS RRset) to determine this.
 192  * @param env: module env with trust anchors.
 193  * @param dp: delegation point.
 194  * @param msg: delegation message, with DS if a secure referral.
 195  * @param dclass: class of query.
 196  * @return 1 if dnssec is expected, 0 if not or insecure point above qname.
 197  */
 198 int iter_indicates_dnssec(struct module_env* env, struct delegpt* dp,
 199         struct dns_msg* msg, uint16_t dclass);
 200
 201 /**
 202  * See if a message contains DNSSEC.
 203  * This is examined by looking for RRSIGs. With DNSSEC a valid answer,
 204  * nxdomain, nodata, referral or cname reply has RRSIGs in answer or auth
 205  * sections, sigs on answer data, SOA, DS, or NSEC/NSEC3 records.
 206  * @param msg: message to examine.
 207  * @return true if DNSSEC information was found.
 208  */
 209 int iter_msg_has_dnssec(struct dns_msg* msg);
 210
 211 /**
 212  * See if a message is known to be from a certain zone.
 213  * This looks for SOA or NS rrsets, for answers.
 214  * For referrals, when one label is delegated, the zone is detected.
 215  * Does not look at signatures.
 216  * @param msg: the message to inspect.
 217  * @param dp: delegation point with zone name to look for.
 218  * @param type: type of message.
 219  * @param dclass: class of query.
 220  * @return true if message is certain to be from zone in dp->name.
 221  *      false if not sure (empty msg), or not from the zone.
 222  */
 223 int iter_msg_from_zone(struct dns_msg* msg, struct delegpt* dp,
 224         enum response_type type, uint16_t dclass);
 225
 226 /**
 227  * Check if two replies are equal
 228  * For fallback procedures
 229  * @param p: reply one. The reply has rrset data pointers in region.
 230  *      Does not check rrset-IDs
 231  * @param q: reply two
 232  * @param region: scratch buffer.
 233  * @return if one and two are equal.
 234  */
 235 int reply_equal(struct reply_info* p, struct reply_info* q, struct regional* region);
 236
 237 /**
 238  * Remove unused bits from the reply if possible.
 239  * So that caps-for-id (0x20) fallback is more likely to be successful.
 240  * This removes like, the additional section, and NS record in the authority
 241  * section if those records are gratuitous (not for a referral).
 242  * @param rep: the reply to strip stuff out of.
 243  */
 244 void caps_strip_reply(struct reply_info* rep);
 245
 246 /**
 247  * see if reply has a 'useful' rcode for capsforid comparison, so
 248  * not SERVFAIL or REFUSED, and thus NOERROR or NXDOMAIN.
 249  * @param rep: reply to check.
 250  * @return true if the rcode is a bad type of message.
 251  */
 252 int caps_failed_rcode(struct reply_info* rep);
 253
 254 /**
 255  * Store parent-side rrset in separate rrset cache entries for later
 256  * last-resort * lookups in case the child-side versions of this information
 257  * fails.
 258  * @param env: environment with cache, time, ...
 259  * @param rrset: the rrset to store (copied).
 260  * Failure to store is logged, but otherwise ignored.
 261  */
 262 void iter_store_parentside_rrset(struct module_env* env,
 263         struct ub_packed_rrset_key* rrset);
 264
 265 /**
 266  * Store parent-side NS records from a referral message
 267  * @param env: environment with cache, time, ...
 268  * @param rep: response with NS rrset.
 269  * Failure to store is logged, but otherwise ignored.
 270  */
 271 void iter_store_parentside_NS(struct module_env* env, struct reply_info* rep);
 272
 273 /**
 274  * Store parent-side negative element, the parentside rrset does not exist,
 275  * creates an rrset with empty rdata in the rrset cache with PARENTSIDE flag.
 276  * @param env: environment with cache, time, ...
 277  * @param qinfo: the identity of the rrset that is missing.
 278  * @param rep: delegation response or answer response, to glean TTL from.
 279  * (malloc) failure is logged but otherwise ignored.
 280  */
 281 void iter_store_parentside_neg(struct module_env* env,
 282         struct query_info* qinfo, struct reply_info* rep);
 283
 284 /**
 285  * Add parent NS record if that exists in the cache.  This is both new
 286  * information and acts like a timeout throttle on retries.
 287  * @param env: query env with rrset cache and time.
 288  * @param dp: delegation point to store result in.  Also this dp is used to
 289  *      see which NS name is needed.
 290  * @param region: region to alloc result in.
 291  * @param qinfo: pertinent information, the qclass.
 292  * @return false on malloc failure.
 293  *      if true, the routine worked and if such cached information
 294  *      existed dp->has_parent_side_NS is set true.
 295  */
 296 int iter_lookup_parent_NS_from_cache(struct module_env* env,
 297         struct delegpt* dp, struct regional* region, struct query_info* qinfo);
 298
 299 /**
 300  * Add parent-side glue if that exists in the cache.  This is both new
 301  * information and acts like a timeout throttle on retries to fetch them.
 302  * @param env: query env with rrset cache and time.
 303  * @param dp: delegation point to store result in.  Also this dp is used to
 304  *      see which NS name is needed.
 305  * @param region: region to alloc result in.
 306  * @param qinfo: pertinent information, the qclass.
 307  * @return: true, it worked, no malloc failures, and new addresses (lame)
 308  *      have been added, giving extra options as query targets.
 309  */
 310 int iter_lookup_parent_glue_from_cache(struct module_env* env,
 311         struct delegpt* dp, struct regional* region, struct query_info* qinfo);
 312
 313 /**
 314  * Lookup next root-hint or root-forward entry.
 315  * @param hints: the hints.
 316  * @param fwd: the forwards.
 317  * @param c: the class to start searching at. 0 means find first one.
 318  * @return false if no classes found, true if found and returned in c.
 319  */
 320 int iter_get_next_root(struct iter_hints* hints, struct iter_forwards* fwd,
 321         uint16_t* c);
 322
 323 /**
 324  * Remove DS records that are inappropriate before they are cached.
 325  * @param msg: the response to scrub.
 326  * @param ns: RRSET that is the NS record for the referral.
 327  *      if NULL, then all DS records are removed from the authority section.
 328  * @param z: zone name that the response is from.
 329  */
 330 void iter_scrub_ds(struct dns_msg* msg, struct ub_packed_rrset_key* ns,
 331         uint8_t* z);
 332
 333 /**
 334  * Remove query attempts from all available ips. For 0x20.
 335  * @param dp: delegpt.
 336  * @param d: decrease.
 337  */
 338 void iter_dec_attempts(struct delegpt* dp, int d);
 339
 340 /**
 341  * Add retry counts from older delegpt to newer delegpt.
 342  * Does not waste time on timeout'd (or other failing) addresses.
 343  * @param dp: new delegationpoint.
 344  * @param old: old delegationpoint.
 345  */
 346 void iter_merge_retry_counts(struct delegpt* dp, struct delegpt* old);
 347
 348 /**
 349  * See if a DS response (type ANSWER) is too low: a nodata answer with
 350  * a SOA record in the authority section at-or-below the qchase.qname.
 351  * Also returns true if we are not sure (i.e. empty message, CNAME nosig).
 352  * @param msg: the response.
 353  * @param dp: the dp name is used to check if the RRSIG gives a clue that
 354  *      it was originated from the correct nameserver.
 355  * @return true if too low.
 356  */
 357 int iter_ds_toolow(struct dns_msg* msg, struct delegpt* dp);
 358
 359 /**
 360  * See if delegpt can go down a step to the qname or not
 361  * @param qinfo: the query name looked up.
 362  * @param dp: checked if the name can go lower to the qname
 363  * @return true if can go down, false if that would not be possible.
 364  * the current response seems to be the one and only, best possible, response.
 365  */
 366 int iter_dp_cangodown(struct query_info* qinfo, struct delegpt* dp);
 367
 368 #endif /* ITERATOR_ITER_UTILS_H */