contrib/unbound/util/data/msgparse.h

   1 /*
   2  * util/data/msgparse.h - parse wireformat DNS messages.
   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  * \file
  37  * Contains message parsing data structures.
  38  * These point back into the packet buffer.
  39  *
  40  * During parsing RRSIGS are put together with the rrsets they (claim to) sign.
  41  * This process works as follows:
  42  *      o if RRSIG follows the data rrset, it is added to the rrset rrsig list.
  43  *      o if no matching data rrset is found, the RRSIG becomes a new rrset.
  44  *      o If the data rrset later follows the RRSIG
  45  *              o See if the RRSIG rrset contains multiple types, and needs to
  46  *                have the rrsig(s) for that data type split off.
  47  *              o Put the data rr as data type in the rrset and rrsig in list.
  48  *      o RRSIGs are allowed to move to a different section. The section of
  49  *        the data item is used for the final rrset.
  50  *      o multiple signatures over an RRset are possible.
  51  *
  52  * For queries of qtype=RRSIG, some special handling is needed, to avoid
  53  * splitting the RRSIG in the answer section.
  54  *      o duplicate, not split, RRSIGs from the answer section, if qtype=RRSIG.
  55  *      o check for doubles in the rrsig list when adding an RRSIG to data,
  56  *        so that a data rrset is signed by RRSIGs with different rdata.
  57  *        when qtype=RRSIG.
  58  * This will move the RRSIG from the answer section to sign the data further
  59  * in the packet (if possible). If then after that, more RRSIGs are found
  60  * that sign the data as well, doubles are removed.
  61  */
  62
  63 #ifndef UTIL_DATA_MSGPARSE_H
  64 #define UTIL_DATA_MSGPARSE_H
  65 #include "util/storage/lruhash.h"
  66 #include "sldns/pkthdr.h"
  67 #include "sldns/rrdef.h"
  68 struct sldns_buffer;
  69 struct rrset_parse;
  70 struct rr_parse;
  71 struct regional;
  72 struct edns_option;
  73
  74 /** number of buckets in parse rrset hash table. Must be power of 2. */
  75 #define PARSE_TABLE_SIZE 32
  76 /** Maximum TTL that is allowed. */
  77 extern time_t MAX_TTL;
  78 /** Minimum TTL that is allowed. */
  79 extern time_t MIN_TTL;
  80 /** Maximum Negative TTL that is allowed */
  81 extern time_t MAX_NEG_TTL;
  82 /** If we serve expired entries and prefetch them */
  83 extern int SERVE_EXPIRED;
  84 /** Time to serve records after expiration */
  85 extern time_t SERVE_EXPIRED_TTL;
  86 /** TTL to use for expired records */
  87 extern time_t SERVE_EXPIRED_REPLY_TTL;
  88 /** Negative cache time (for entries without any RRs.) */
  89 #define NORR_TTL 5 /* seconds */
  90
  91 /**
  92  * Data stored in scratch pad memory during parsing.
  93  * Stores the data that will enter into the msgreply and packet result.
  94  */
  95 struct msg_parse {
  96         /** id from message, network format. */
  97         uint16_t id;
  98         /** flags from message, host format. */
  99         uint16_t flags;
 100         /** count of RRs, host format */
 101         uint16_t qdcount;
 102         /** count of RRs, host format */
 103         uint16_t ancount;
 104         /** count of RRs, host format */
 105         uint16_t nscount;
 106         /** count of RRs, host format */
 107         uint16_t arcount;
 108         /** count of RRsets per section. */
 109         size_t an_rrsets;
 110         /** count of RRsets per section. */
 111         size_t ns_rrsets;
 112         /** count of RRsets per section. */
 113         size_t ar_rrsets;
 114         /** total number of rrsets found. */
 115         size_t rrset_count;
 116
 117         /** query dname (pointer to start location in packet, NULL if none */
 118         uint8_t* qname;
 119         /** length of query dname in octets, 0 if none */
 120         size_t qname_len;
 121         /** query type, host order. 0 if qdcount=0 */
 122         uint16_t qtype;
 123         /** query class, host order. 0 if qdcount=0 */
 124         uint16_t qclass;
 125
 126         /**
 127          * Hash table array used during parsing to lookup rrset types.
 128          * Based on name, type, class.  Same hash value as in rrset cache.
 129          */
 130         struct rrset_parse* hashtable[PARSE_TABLE_SIZE];
 131
 132         /** linked list of rrsets that have been found (in order). */
 133         struct rrset_parse* rrset_first;
 134         /** last element of rrset list. */
 135         struct rrset_parse* rrset_last;
 136 };
 137
 138 /**
 139  * Data stored for an rrset during parsing.
 140  */
 141 struct rrset_parse {
 142         /** next in hash bucket */
 143         struct rrset_parse* rrset_bucket_next;
 144         /** next in list of all rrsets */
 145         struct rrset_parse* rrset_all_next;
 146         /** hash value of rrset */
 147         hashvalue_type hash;
 148         /** which section was it found in: one of
 149          * LDNS_SECTION_ANSWER, LDNS_SECTION_AUTHORITY, LDNS_SECTION_ADDITIONAL
 150          */
 151         sldns_pkt_section section;
 152         /** start of (possibly compressed) dname in packet */
 153         uint8_t* dname;
 154         /** length of the dname uncompressed wireformat */
 155         size_t dname_len;
 156         /** type, host order. */
 157         uint16_t type;
 158         /** class, network order. var name so that it is not a c++ keyword. */
 159         uint16_t rrset_class;
 160         /** the flags for the rrset, like for packedrrset */
 161         uint32_t flags;
 162         /** number of RRs in the rr list */
 163         size_t rr_count;
 164         /** sum of RR rdata sizes */
 165         size_t size;
 166         /** linked list of RRs in this rrset. */
 167         struct rr_parse* rr_first;
 168         /** last in list of RRs in this rrset. */
 169         struct rr_parse* rr_last;
 170         /** number of RRSIGs over this rrset. */
 171         size_t rrsig_count;
 172         /** linked list of RRsig RRs over this rrset. */
 173         struct rr_parse* rrsig_first;
 174         /** last in list of RRSIG RRs over this rrset. */
 175         struct rr_parse* rrsig_last;
 176 };
 177
 178 /**
 179  * Data stored for an RR during parsing.
 180  */
 181 struct rr_parse {
 182         /**
 183          * Pointer to the RR. Points to start of TTL value in the packet.
 184          * Rdata length and rdata follow it.
 185          * its dname, type and class are the same and stored for the rrset.
 186          */
 187         uint8_t* ttl_data;
 188         /** true if ttl_data is not part of the packet, but elsewhere in mem.
 189          * Set for generated CNAMEs for DNAMEs. */
 190         int outside_packet;
 191         /** the length of the rdata if allocated (with no dname compression)*/
 192         size_t size;
 193         /** next in list of RRs. */
 194         struct rr_parse* next;
 195 };
 196
 197 /** Check if label length is first octet of a compression pointer, pass u8. */
 198 #define LABEL_IS_PTR(x) ( ((x)&0xc0) == 0xc0 )
 199 /** Calculate destination offset of a compression pointer. pass first and
 200  * second octets of the compression pointer. */
 201 #define PTR_OFFSET(x, y) ( ((x)&0x3f)<<8 | (y) )
 202 /** create a compression pointer to the given offset. */
 203 #define PTR_CREATE(offset) ((uint16_t)(0xc000 | (offset)))
 204
 205 /** error codes, extended with EDNS, so > 15. */
 206 #define EDNS_RCODE_BADVERS      16      /** bad EDNS version */
 207 /** largest valid compression offset */
 208 #define PTR_MAX_OFFSET  0x3fff
 209
 210 /**
 211  * EDNS data storage
 212  * rdata is parsed in a list (has accessor functions). allocated in a
 213  * region.
 214  */
 215 struct edns_data {
 216         /** if EDNS OPT record was present */
 217         int edns_present;
 218         /** Extended RCODE */
 219         uint8_t ext_rcode;
 220         /** The EDNS version number */
 221         uint8_t edns_version;
 222         /** the EDNS bits field from ttl (host order): Z */
 223         uint16_t bits;
 224         /** UDP reassembly size. */
 225         uint16_t udp_size;
 226         /** rdata element list, or NULL if none */
 227         struct edns_option* opt_list;
 228 };
 229
 230 /**
 231  * EDNS option
 232  */
 233 struct edns_option {
 234         /** next item in list */
 235         struct edns_option* next;
 236         /** type of this edns option */
 237         uint16_t opt_code;
 238         /** length of this edns option (cannot exceed uint16 in encoding) */
 239         size_t opt_len;
 240         /** data of this edns option; allocated in region, or NULL if len=0 */
 241         uint8_t* opt_data;
 242 };
 243
 244 /**
 245  * Obtain size in the packet of an rr type, that is before dname type.
 246  * Do TYPE_DNAME, and type STR, yourself. Gives size for most regular types.
 247  * @param rdf: the rdf type from the descriptor.
 248  * @return: size in octets. 0 on failure.
 249  */
 250 size_t get_rdf_size(sldns_rdf_type rdf);
 251
 252 /**
 253  * Parse the packet.
 254  * @param pkt: packet, position at call must be at start of packet.
 255  *      at end position is after packet.
 256  * @param msg: where to store results.
 257  * @param region: how to alloc results.
 258  * @return: 0 if OK, or rcode on error.
 259  */
 260 int parse_packet(struct sldns_buffer* pkt, struct msg_parse* msg,
 261         struct regional* region);
 262
 263 /**
 264  * After parsing the packet, extract EDNS data from packet.
 265  * If not present this is noted in the data structure.
 266  * If a parse error happens, an error code is returned.
 267  *
 268  * Quirks:
 269  *      o ignores OPT rdata.
 270  *      o ignores OPT owner name.
 271  *      o ignores extra OPT records, except the last one in the packet.
 272  *
 273  * @param msg: parsed message structure. Modified on exit, if EDNS was present
 274  *      it is removed from the additional section.
 275  * @param edns: the edns data is stored here. Does not have to be initialised.
 276  * @param region: region to alloc results in (edns option contents)
 277  * @return: 0 on success. or an RCODE on an error.
 278  *      RCODE formerr if OPT in wrong section, and so on.
 279  */
 280 int parse_extract_edns(struct msg_parse* msg, struct edns_data* edns,
 281         struct regional* region);
 282
 283 /**
 284  * If EDNS data follows a query section, extract it and initialize edns struct.
 285  * @param pkt: the packet. position at start must be right after the query
 286  *      section. At end, right after EDNS data or no movement if failed.
 287  * @param edns: the edns data allocated by the caller. Does not have to be
 288  *      initialised.
 289  * @param region: region to alloc results in (edns option contents)
 290  * @return: 0 on success, or an RCODE on error.
 291  *      RCODE formerr if OPT is badly formatted and so on.
 292  */
 293 int parse_edns_from_pkt(struct sldns_buffer* pkt, struct edns_data* edns,
 294         struct regional* region);
 295
 296 /**
 297  * Calculate hash value for rrset in packet.
 298  * @param pkt: the packet.
 299  * @param dname: pointer to uncompressed dname, or compressed dname in packet.
 300  * @param type: rrset type in host order.
 301  * @param dclass: rrset class in network order.
 302  * @param rrset_flags: rrset flags (same as packed_rrset flags).
 303  * @return hash value
 304  */
 305 hashvalue_type pkt_hash_rrset(struct sldns_buffer* pkt, uint8_t* dname,
 306         uint16_t type, uint16_t dclass, uint32_t rrset_flags);
 307
 308 /**
 309  * Lookup in msg hashtable to find a rrset.
 310  * @param msg: with the hashtable.
 311  * @param pkt: packet for compressed names.
 312  * @param h: hash value
 313  * @param rrset_flags: flags of rrset sought for.
 314  * @param dname: name of rrset sought for.
 315  * @param dnamelen: len of dname.
 316  * @param type: rrset type, host order.
 317  * @param dclass: rrset class, network order.
 318  * @return NULL or the rrset_parse if found.
 319  */
 320 struct rrset_parse* msgparse_hashtable_lookup(struct msg_parse* msg,
 321         struct sldns_buffer* pkt, hashvalue_type h, uint32_t rrset_flags,
 322         uint8_t* dname, size_t dnamelen, uint16_t type, uint16_t dclass);
 323
 324 /**
 325  * Remove rrset from hash table.
 326  * @param msg: with hashtable.
 327  * @param rrset: with hash value and id info.
 328  */
 329 void msgparse_bucket_remove(struct msg_parse* msg, struct rrset_parse* rrset);
 330
 331 /**
 332  * Log the edns options in the edns option list.
 333  * @param level: the verbosity level.
 334  * @param info_str: the informational string to be printed before the options.
 335  * @param list: the edns option list.
 336  */
 337 void log_edns_opt_list(enum verbosity_value level, const char* info_str,
 338         struct edns_option* list);
 339
 340 #endif /* UTIL_DATA_MSGPARSE_H */