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 struct module_stack;
  63 struct outside_network;
  64
  65 /* max number of lookups in the cache for target nameserver names.
  66  * This stops, for large delegations, N*N lookups in the cache. */
  67 #define ITERATOR_NAME_CACHELOOKUP_MAX   3
  68 /* max number of lookups in the cache for parentside glue for nameserver names
  69  * This stops, for larger delegations, N*N lookups in the cache.
  70  * It is a little larger than the nonpside max, so it allows a couple extra
  71  * lookups of parent side glue. */
  72 #define ITERATOR_NAME_CACHELOOKUP_MAX_PSIDE     5
  73
  74 /**
  75  * Process config options and set iterator module state.
  76  * Sets default values if no config is found.
  77  * @param iter_env: iterator module state.
  78  * @param cfg: config options.
  79  * @return 0 on error.
  80  */
  81 int iter_apply_cfg(struct iter_env* iter_env, struct config_file* cfg);
  82
  83 /**
  84  * Select a valid, nice target to send query to.
  85  * Sorting and removing unsuitable targets is combined.
  86  *
  87  * @param iter_env: iterator module global state, with ip6 enabled and
  88  *      do-not-query-addresses.
  89  * @param env: environment with infra cache (lameness, rtt info).
  90  * @param dp: delegation point with result list.
  91  * @param name: zone name (for lameness check).
  92  * @param namelen: length of name.
  93  * @param qtype: query type that we want to send.
  94  * @param dnssec_lame: set to 1, if a known dnssec-lame server is selected
  95  *      these are not preferred, but are used as a last resort.
  96  * @param chase_to_rd: set to 1 if a known recursion lame server is selected
  97  *      these are not preferred, but are used as a last resort.
  98  * @param open_target: number of currently outstanding target queries.
  99  *      If we wait for these, perhaps more server addresses become available.
 100  * @param blacklist: the IP blacklist to use.
 101  * @param prefetch: if not 0, prefetch is in use for this query.
 102  *      This means the query can have different timing, because prefetch is
 103  *      not waited upon by the downstream client, and thus a good time to
 104  *      perform exploration of other targets.
 105  * @return best target or NULL if no target.
 106  *      if not null, that target is removed from the result list in the dp.
 107  */
 108 struct delegpt_addr* iter_server_selection(struct iter_env* iter_env,
 109         struct module_env* env, struct delegpt* dp, uint8_t* name,
 110         size_t namelen, uint16_t qtype, int* dnssec_lame,
 111         int* chase_to_rd, int open_target, struct sock_list* blacklist,
 112         time_t prefetch);
 113
 114 /**
 115  * Allocate dns_msg from parsed msg, in regional.
 116  * @param pkt: packet.
 117  * @param msg: parsed message (cleaned and ready for regional allocation).
 118  * @param regional: regional to use for allocation.
 119  * @return newly allocated dns_msg, or NULL on memory error.
 120  */
 121 struct dns_msg* dns_alloc_msg(struct sldns_buffer* pkt, struct msg_parse* msg,
 122         struct regional* regional);
 123
 124 /**
 125  * Copy a dns_msg to this regional.
 126  * @param from: dns message, also in regional.
 127  * @param regional: regional to use for allocation.
 128  * @return newly allocated dns_msg, or NULL on memory error.
 129  */
 130 struct dns_msg* dns_copy_msg(struct dns_msg* from, struct regional* regional);
 131
 132 /**
 133  * Allocate a dns_msg with malloc/alloc structure and store in dns cache.
 134  * @param env: environment, with alloc structure and dns cache.
 135  * @param qinf: query info, the query for which answer is stored.
 136  * @param rep: reply in dns_msg from dns_alloc_msg for example.
 137  * @param is_referral: If true, then the given message to be stored is a
 138  *      referral. The cache implementation may use this as a hint.
 139  * @param leeway: prefetch TTL leeway to expire old rrsets quicker.
 140  * @param pside: true if dp is parentside, thus message is 'fresh' and NS
 141  *      can be prefetch-updates.
 142  * @param region: to copy modified (cache is better) rrs back to.
 143  * @param flags: with BIT_CD for dns64 AAAA translated queries.
 144  * @param qstarttime: time of query start.
 145  * return void, because we are not interested in alloc errors,
 146  *      the iterator and validator can operate on the results in their
 147  *      scratch space (the qstate.region) and are not dependent on the cache.
 148  *      It is useful to log the alloc failure (for the server operator),
 149  *      but the query resolution can continue without cache storage.
 150  */
 151 void iter_dns_store(struct module_env* env, struct query_info* qinf,
 152         struct reply_info* rep, int is_referral, time_t leeway, int pside,
 153         struct regional* region, uint16_t flags, time_t qstarttime);
 154
 155 /**
 156  * Select randomly with n/m probability.
 157  * For shuffle NS records for address fetching.
 158  * @param rnd: random table
 159  * @param n: probability.
 160  * @param m: divisor for probability.
 161  * @return true with n/m probability.
 162  */
 163 int iter_ns_probability(struct ub_randstate* rnd, int n, int m);
 164
 165 /**
 166  * Mark targets that result in a dependency cycle as done, so they
 167  * will not get selected as targets.
 168  * @param qstate: query state.
 169  * @param dp: delegpt to mark ns in.
 170  */
 171 void iter_mark_cycle_targets(struct module_qstate* qstate, struct delegpt* dp);
 172
 173 /**
 174  * Mark targets that result in a dependency cycle as done, so they
 175  * will not get selected as targets.  For the parent-side lookups.
 176  * @param qstate: query state.
 177  * @param dp: delegpt to mark ns in.
 178  */
 179 void iter_mark_pside_cycle_targets(struct module_qstate* qstate,
 180         struct delegpt* dp);
 181
 182 /**
 183  * See if delegation is useful or offers immediately no targets for
 184  * further recursion.
 185  * @param qinfo: query name and type
 186  * @param qflags: query flags with RD flag
 187  * @param dp: delegpt to check.
 188  * @param supports_ipv4: if we support ipv4 for lookups to the target.
 189  *      if not, then the IPv4 addresses are useless.
 190  * @param supports_ipv6: if we support ipv6 for lookups to the target.
 191  *      if not, then the IPv6 addresses are useless.
 192  * @param use_nat64: if we support NAT64 for lookups to the target.
 193  *      if yes, IPv4 addresses are useful even if we don't support IPv4.
 194  * @return true if dp is useless.
 195  */
 196 int iter_dp_is_useless(struct query_info* qinfo, uint16_t qflags,
 197         struct delegpt* dp, int supports_ipv4, int supports_ipv6,
 198         int use_nat64);
 199
 200 /**
 201  * See if qname has DNSSEC needs.  This is true if there is a trust anchor above
 202  * it.  Whether there is an insecure delegation to the data is unknown.
 203  * @param env: environment with anchors.
 204  * @param qinfo: query name and class.
 205  * @return true if trust anchor above qname, false if no anchor or insecure
 206  * point above qname.
 207  */
 208 int iter_qname_indicates_dnssec(struct module_env* env,
 209         struct query_info *qinfo);
 210
 211 /**
 212  * See if delegation is expected to have DNSSEC information (RRSIGs) in
 213  * its answers, or not. Inspects delegation point (name), trust anchors,
 214  * and delegation message (DS RRset) to determine this.
 215  * @param env: module env with trust anchors.
 216  * @param dp: delegation point.
 217  * @param msg: delegation message, with DS if a secure referral.
 218  * @param dclass: class of query.
 219  * @return 1 if dnssec is expected, 0 if not or insecure point above qname.
 220  */
 221 int iter_indicates_dnssec(struct module_env* env, struct delegpt* dp,
 222         struct dns_msg* msg, uint16_t dclass);
 223
 224 /**
 225  * See if a message contains DNSSEC.
 226  * This is examined by looking for RRSIGs. With DNSSEC a valid answer,
 227  * nxdomain, nodata, referral or cname reply has RRSIGs in answer or auth
 228  * sections, sigs on answer data, SOA, DS, or NSEC/NSEC3 records.
 229  * @param msg: message to examine.
 230  * @return true if DNSSEC information was found.
 231  */
 232 int iter_msg_has_dnssec(struct dns_msg* msg);
 233
 234 /**
 235  * See if a message is known to be from a certain zone.
 236  * This looks for SOA or NS rrsets, for answers.
 237  * For referrals, when one label is delegated, the zone is detected.
 238  * Does not look at signatures.
 239  * @param msg: the message to inspect.
 240  * @param dp: delegation point with zone name to look for.
 241  * @param type: type of message.
 242  * @param dclass: class of query.
 243  * @return true if message is certain to be from zone in dp->name.
 244  *      false if not sure (empty msg), or not from the zone.
 245  */
 246 int iter_msg_from_zone(struct dns_msg* msg, struct delegpt* dp,
 247         enum response_type type, uint16_t dclass);
 248
 249 /**
 250  * Check if two replies are equal
 251  * For fallback procedures
 252  * @param p: reply one. The reply has rrset data pointers in region.
 253  *      Does not check rrset-IDs
 254  * @param q: reply two
 255  * @param region: scratch buffer.
 256  * @return if one and two are equal.
 257  */
 258 int reply_equal(struct reply_info* p, struct reply_info* q, struct regional* region);
 259
 260 /**
 261  * Remove unused bits from the reply if possible.
 262  * So that caps-for-id (0x20) fallback is more likely to be successful.
 263  * This removes like, the additional section, and NS record in the authority
 264  * section if those records are gratuitous (not for a referral).
 265  * @param rep: the reply to strip stuff out of.
 266  */
 267 void caps_strip_reply(struct reply_info* rep);
 268
 269 /**
 270  * see if reply has a 'useful' rcode for capsforid comparison, so
 271  * not SERVFAIL or REFUSED, and thus NOERROR or NXDOMAIN.
 272  * @param rep: reply to check.
 273  * @return true if the rcode is a bad type of message.
 274  */
 275 int caps_failed_rcode(struct reply_info* rep);
 276
 277 /**
 278  * Store parent-side rrset in separate rrset cache entries for later
 279  * last-resort * lookups in case the child-side versions of this information
 280  * fails.
 281  * @param env: environment with cache, time, ...
 282  * @param rrset: the rrset to store (copied).
 283  * Failure to store is logged, but otherwise ignored.
 284  */
 285 void iter_store_parentside_rrset(struct module_env* env,
 286         struct ub_packed_rrset_key* rrset);
 287
 288 /**
 289  * Store parent-side NS records from a referral message
 290  * @param env: environment with cache, time, ...
 291  * @param rep: response with NS rrset.
 292  * Failure to store is logged, but otherwise ignored.
 293  */
 294 void iter_store_parentside_NS(struct module_env* env, struct reply_info* rep);
 295
 296 /**
 297  * Store parent-side negative element, the parentside rrset does not exist,
 298  * creates an rrset with empty rdata in the rrset cache with PARENTSIDE flag.
 299  * @param env: environment with cache, time, ...
 300  * @param qinfo: the identity of the rrset that is missing.
 301  * @param rep: delegation response or answer response, to glean TTL from.
 302  * (malloc) failure is logged but otherwise ignored.
 303  */
 304 void iter_store_parentside_neg(struct module_env* env,
 305         struct query_info* qinfo, struct reply_info* rep);
 306
 307 /**
 308  * Add parent NS record if that exists in the cache.  This is both new
 309  * information and acts like a timeout throttle on retries.
 310  * @param env: query env with rrset cache and time.
 311  * @param dp: delegation point to store result in.  Also this dp is used to
 312  *      see which NS name is needed.
 313  * @param region: region to alloc result in.
 314  * @param qinfo: pertinent information, the qclass.
 315  * @return false on malloc failure.
 316  *      if true, the routine worked and if such cached information
 317  *      existed dp->has_parent_side_NS is set true.
 318  */
 319 int iter_lookup_parent_NS_from_cache(struct module_env* env,
 320         struct delegpt* dp, struct regional* region, struct query_info* qinfo);
 321
 322 /**
 323  * Add parent-side glue if that exists in the cache.  This is both new
 324  * information and acts like a timeout throttle on retries to fetch them.
 325  * @param env: query env with rrset cache and time.
 326  * @param dp: delegation point to store result in.  Also this dp is used to
 327  *      see which NS name is needed.
 328  * @param region: region to alloc result in.
 329  * @param qinfo: pertinent information, the qclass.
 330  * @return: true, it worked, no malloc failures, and new addresses (lame)
 331  *      have been added, giving extra options as query targets.
 332  */
 333 int iter_lookup_parent_glue_from_cache(struct module_env* env,
 334         struct delegpt* dp, struct regional* region, struct query_info* qinfo);
 335
 336 /**
 337  * Lookup next root-hint or root-forward entry.
 338  * @param hints: the hints.
 339  * @param fwd: the forwards.
 340  * @param c: the class to start searching at. 0 means find first one.
 341  * @return false if no classes found, true if found and returned in c.
 342  */
 343 int iter_get_next_root(struct iter_hints* hints, struct iter_forwards* fwd,
 344         uint16_t* c);
 345
 346 /**
 347  * Remove DS records that are inappropriate before they are cached.
 348  * @param msg: the response to scrub.
 349  * @param ns: RRSET that is the NS record for the referral.
 350  *      if NULL, then all DS records are removed from the authority section.
 351  * @param z: zone name that the response is from.
 352  */
 353 void iter_scrub_ds(struct dns_msg* msg, struct ub_packed_rrset_key* ns,
 354         uint8_t* z);
 355
 356 /**
 357  * Prepare an NXDOMAIN message to be used for a subdomain answer by removing all
 358  * RRs from the ANSWER section.
 359  * @param msg: the response to scrub.
 360  */
 361 void iter_scrub_nxdomain(struct dns_msg* msg);
 362
 363 /**
 364  * Remove query attempts from all available ips. For 0x20.
 365  * @param dp: delegpt.
 366  * @param d: decrease.
 367  * @param outbound_msg_retry: number of retries of outgoing queries
 368  */
 369 void iter_dec_attempts(struct delegpt* dp, int d, int outbound_msg_retry);
 370
 371 /**
 372  * Add retry counts from older delegpt to newer delegpt.
 373  * Does not waste time on timeout'd (or other failing) addresses.
 374  * @param dp: new delegationpoint.
 375  * @param old: old delegationpoint.
 376  * @param outbound_msg_retry: number of retries of outgoing queries
 377  */
 378 void iter_merge_retry_counts(struct delegpt* dp, struct delegpt* old,
 379         int outbound_msg_retry);
 380
 381 /**
 382  * See if a DS response (type ANSWER) is too low: a nodata answer with
 383  * a SOA record in the authority section at-or-below the qchase.qname.
 384  * Also returns true if we are not sure (i.e. empty message, CNAME nosig).
 385  * @param msg: the response.
 386  * @param dp: the dp name is used to check if the RRSIG gives a clue that
 387  *      it was originated from the correct nameserver.
 388  * @return true if too low.
 389  */
 390 int iter_ds_toolow(struct dns_msg* msg, struct delegpt* dp);
 391
 392 /**
 393  * See if delegpt can go down a step to the qname or not
 394  * @param qinfo: the query name looked up.
 395  * @param dp: checked if the name can go lower to the qname
 396  * @return true if can go down, false if that would not be possible.
 397  * the current response seems to be the one and only, best possible, response.
 398  */
 399 int iter_dp_cangodown(struct query_info* qinfo, struct delegpt* dp);
 400
 401 /**
 402  * Lookup if no_cache is set in stub or fwd.
 403  * @param qstate: query state with env with hints and fwds.
 404  * @param qinf: query name to lookup for.
 405  * @param retdpname: returns NULL or the deepest enclosing name of fwd or stub.
 406  *      This is the name under which the closest lookup is going to happen.
 407  *      Used for NXDOMAIN checks, above that it is an nxdomain from a
 408  *      different server and zone. You can pass NULL to not get it.
 409  * @param retdpnamelen: returns the length of the dpname.
 410  * @return true if no_cache is set in stub or fwd.
 411  */
 412 int iter_stub_fwd_no_cache(struct module_qstate *qstate,
 413         struct query_info *qinf, uint8_t** retdpname, size_t* retdpnamelen);
 414
 415 /**
 416  * Set support for IP4 and IP6 depending on outgoing interfaces
 417  * in the outside network.  If none, no support, so no use to lookup
 418  * the AAAA and then attempt to use it if there is no outgoing-interface
 419  * for it.
 420  * @param mods: modstack to find iterator module in.
 421  * @param env: module env, find iterator module (if one) in there.
 422  * @param outnet: outside network structure.
 423  */
 424 void iterator_set_ip46_support(struct module_stack* mods,
 425         struct module_env* env, struct outside_network* outnet);
 426
 427 #endif /* ITERATOR_ITER_UTILS_H */