2 * util/data/msgparse.c - parse wireformat DNS messages.
4 * Copyright (c) 2007, NLnet Labs. All rights reserved.
6 * This software is open source.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
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.
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.
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.
37 * Routines for message parsing a packet buffer to a descriptive structure.
40 #include "util/config_file.h"
41 #include "util/data/msgparse.h"
42 #include "util/data/msgreply.h"
43 #include "util/data/dname.h"
44 #include "util/data/packed_rrset.h"
45 #include "util/netevent.h"
46 #include "util/storage/lookup3.h"
47 #include "util/regional.h"
48 #include "util/rfc_1982.h"
49 #include "util/edns.h"
50 #include "sldns/rrdef.h"
51 #include "sldns/sbuffer.h"
52 #include "sldns/parseutil.h"
53 #include "sldns/wire2str.h"
55 /** smart comparison of (compressed, valid) dnames from packet */
57 smart_compare(sldns_buffer* pkt, uint8_t* dnow,
58 uint8_t* dprfirst, uint8_t* dprlast)
60 if(LABEL_IS_PTR(*dnow)) {
61 /* ptr points to a previous dname */
63 if((size_t)PTR_OFFSET(dnow[0], dnow[1])
64 >= sldns_buffer_limit(pkt))
66 p = sldns_buffer_at(pkt, PTR_OFFSET(dnow[0], dnow[1]));
67 if( p == dprfirst || p == dprlast )
69 /* prev dname is also a ptr, both ptrs are the same. */
70 if(LABEL_IS_PTR(*dprlast) &&
71 dprlast[0] == dnow[0] && dprlast[1] == dnow[1])
74 return dname_pkt_compare(pkt, dnow, dprlast);
78 * Allocate new rrset in region, fill with data.
80 static struct rrset_parse*
81 new_rrset(struct msg_parse* msg, uint8_t* dname, size_t dnamelen,
82 uint16_t type, uint16_t dclass, hashvalue_type hash,
83 uint32_t rrset_flags, sldns_pkt_section section,
84 struct regional* region)
86 struct rrset_parse* p = regional_alloc(region, sizeof(*p));
88 p->rrset_bucket_next = msg->hashtable[hash & (PARSE_TABLE_SIZE-1)];
89 msg->hashtable[hash & (PARSE_TABLE_SIZE-1)] = p;
90 p->rrset_all_next = 0;
92 msg->rrset_last->rrset_all_next = p;
93 else msg->rrset_first = p;
98 p->dname_len = dnamelen;
100 p->rrset_class = dclass;
101 p->flags = rrset_flags;
112 /** See if next rrset is nsec at zone apex */
114 nsec_at_apex(sldns_buffer* pkt)
116 /* we are at ttl position in packet. */
117 size_t pos = sldns_buffer_position(pkt);
119 if(sldns_buffer_remaining(pkt) < 7) /* ttl+len+root */
121 sldns_buffer_skip(pkt, 4); /* ttl */;
122 rdatalen = sldns_buffer_read_u16(pkt);
123 if(sldns_buffer_remaining(pkt) < rdatalen) {
124 sldns_buffer_set_position(pkt, pos);
125 return 0; /* parse error happens later */
127 /* must validate the nsec next domain name format */
128 if(pkt_dname_len(pkt) == 0) {
129 sldns_buffer_set_position(pkt, pos);
130 return 0; /* parse error */
133 /* see if SOA bit is set. */
134 if(sldns_buffer_position(pkt) < pos+4+rdatalen) {
135 /* nsec type bitmap contains items */
136 uint8_t win, blen, bits;
137 /* need: windownum, bitmap len, firstbyte */
138 if(sldns_buffer_position(pkt)+3 > pos+4+rdatalen) {
139 sldns_buffer_set_position(pkt, pos);
140 return 0; /* malformed nsec */
142 win = sldns_buffer_read_u8(pkt);
143 blen = sldns_buffer_read_u8(pkt);
144 bits = sldns_buffer_read_u8(pkt);
145 /* 0window always first window. bitlen >=1 or parse
146 error really. bit 0x2 is SOA. */
147 if(win == 0 && blen >= 1 && (bits & 0x02)) {
148 sldns_buffer_set_position(pkt, pos);
153 sldns_buffer_set_position(pkt, pos);
157 /** Calculate rrset flags */
159 pkt_rrset_flags(sldns_buffer* pkt, uint16_t type, sldns_pkt_section sec)
162 if(type == LDNS_RR_TYPE_NSEC && nsec_at_apex(pkt)) {
163 f |= PACKED_RRSET_NSEC_AT_APEX;
164 } else if(type == LDNS_RR_TYPE_SOA && sec == LDNS_SECTION_AUTHORITY) {
165 f |= PACKED_RRSET_SOA_NEG;
171 pkt_hash_rrset(sldns_buffer* pkt, uint8_t* dname, uint16_t type,
172 uint16_t dclass, uint32_t rrset_flags)
174 /* note this MUST be identical to rrset_key_hash in packed_rrset.c */
175 /* this routine handles compressed names */
176 hashvalue_type h = 0xab;
177 h = dname_pkt_hash(pkt, dname, h);
178 h = hashlittle(&type, sizeof(type), h); /* host order */
179 h = hashlittle(&dclass, sizeof(dclass), h); /* netw order */
180 h = hashlittle(&rrset_flags, sizeof(uint32_t), h);
184 /** create partial dname hash for rrset hash */
185 static hashvalue_type
186 pkt_hash_rrset_first(sldns_buffer* pkt, uint8_t* dname)
188 /* works together with pkt_hash_rrset_rest */
189 /* note this MUST be identical to rrset_key_hash in packed_rrset.c */
190 /* this routine handles compressed names */
191 hashvalue_type h = 0xab;
192 h = dname_pkt_hash(pkt, dname, h);
196 /** create a rrset hash from a partial dname hash */
197 static hashvalue_type
198 pkt_hash_rrset_rest(hashvalue_type dname_h, uint16_t type, uint16_t dclass,
199 uint32_t rrset_flags)
201 /* works together with pkt_hash_rrset_first */
202 /* note this MUST be identical to rrset_key_hash in packed_rrset.c */
204 h = hashlittle(&type, sizeof(type), dname_h); /* host order */
205 h = hashlittle(&dclass, sizeof(dclass), h); /* netw order */
206 h = hashlittle(&rrset_flags, sizeof(uint32_t), h);
210 /** compare rrset_parse with data */
212 rrset_parse_equals(struct rrset_parse* p, sldns_buffer* pkt, hashvalue_type h,
213 uint32_t rrset_flags, uint8_t* dname, size_t dnamelen,
214 uint16_t type, uint16_t dclass)
216 if(p->hash == h && p->dname_len == dnamelen && p->type == type &&
217 p->rrset_class == dclass && p->flags == rrset_flags &&
218 dname_pkt_compare(pkt, dname, p->dname) == 0)
225 msgparse_hashtable_lookup(struct msg_parse* msg, sldns_buffer* pkt,
226 hashvalue_type h, uint32_t rrset_flags, uint8_t* dname,
227 size_t dnamelen, uint16_t type, uint16_t dclass)
229 struct rrset_parse* p = msg->hashtable[h & (PARSE_TABLE_SIZE-1)];
231 if(rrset_parse_equals(p, pkt, h, rrset_flags, dname, dnamelen,
234 p = p->rrset_bucket_next;
239 /** return type networkformat that rrsig in packet covers */
241 pkt_rrsig_covered(sldns_buffer* pkt, uint8_t* here, uint16_t* type)
243 size_t pos = sldns_buffer_position(pkt);
244 sldns_buffer_set_position(pkt, (size_t)(here-sldns_buffer_begin(pkt)));
245 /* ttl + len + size of small rrsig(rootlabel, no signature) */
246 if(sldns_buffer_remaining(pkt) < 4+2+19)
248 sldns_buffer_skip(pkt, 4); /* ttl */
249 if(sldns_buffer_read_u16(pkt) < 19) /* too short */ {
250 sldns_buffer_set_position(pkt, pos);
253 *type = sldns_buffer_read_u16(pkt);
254 sldns_buffer_set_position(pkt, pos);
258 /** true if covered type equals prevtype */
260 pkt_rrsig_covered_equals(sldns_buffer* pkt, uint8_t* here, uint16_t type)
263 if(pkt_rrsig_covered(pkt, here, &t) && t == type)
269 msgparse_bucket_remove(struct msg_parse* msg, struct rrset_parse* rrset)
271 struct rrset_parse** p;
272 p = &msg->hashtable[ rrset->hash & (PARSE_TABLE_SIZE-1) ];
275 *p = rrset->rrset_bucket_next;
278 p = &( (*p)->rrset_bucket_next );
282 /** change section of rrset from previous to current section */
284 change_section(struct msg_parse* msg, struct rrset_parse* rrset,
285 sldns_pkt_section section)
287 struct rrset_parse *p, *prev;
288 /* remove from list */
289 if(section == rrset->section)
291 p = msg->rrset_first;
295 if(prev) prev->rrset_all_next = p->rrset_all_next;
296 else msg->rrset_first = p->rrset_all_next;
297 if(msg->rrset_last == rrset)
298 msg->rrset_last = prev;
302 p = p->rrset_all_next;
304 /* remove from count */
305 switch(rrset->section) {
306 case LDNS_SECTION_ANSWER: msg->an_rrsets--; break;
307 case LDNS_SECTION_AUTHORITY: msg->ns_rrsets--; break;
308 case LDNS_SECTION_ADDITIONAL: msg->ar_rrsets--; break;
309 default: log_assert(0);
311 /* insert at end of list */
312 rrset->rrset_all_next = 0;
314 msg->rrset_last->rrset_all_next = rrset;
315 else msg->rrset_first = rrset;
316 msg->rrset_last = rrset;
317 /* up count of new section */
319 case LDNS_SECTION_AUTHORITY: msg->ns_rrsets++; break;
320 case LDNS_SECTION_ADDITIONAL: msg->ar_rrsets++; break;
321 default: log_assert(0);
323 rrset->section = section;
326 /** see if rrset of type RRSIG contains sig over given type */
328 rrset_has_sigover(sldns_buffer* pkt, struct rrset_parse* rrset, uint16_t type,
332 struct rr_parse* rr = rrset->rr_first;
333 log_assert( rrset->type == LDNS_RR_TYPE_RRSIG );
335 if(pkt_rrsig_covered_equals(pkt, rr->ttl_data, type))
343 /** move rrsigs from sigset to dataset */
345 moveover_rrsigs(sldns_buffer* pkt, struct regional* region,
346 struct rrset_parse* sigset, struct rrset_parse* dataset, int duplicate)
348 struct rr_parse* sig = sigset->rr_first;
349 struct rr_parse* prev = NULL;
350 struct rr_parse* insert;
351 struct rr_parse* nextsig;
354 if(pkt_rrsig_covered_equals(pkt, sig->ttl_data,
358 insert = (struct rr_parse*)regional_alloc(
359 region, sizeof(struct rr_parse));
360 if(!insert) return 0;
361 insert->outside_packet = 0;
362 insert->ttl_data = sig->ttl_data;
363 insert->size = sig->size;
366 /* remove from sigset */
367 if(prev) prev->next = sig->next;
368 else sigset->rr_first = sig->next;
369 if(sigset->rr_last == sig)
370 sigset->rr_last = prev;
372 sigset->size -= sig->size;
374 /* prev not changed */
377 dataset->rrsig_count++;
379 if(dataset->rrsig_last)
380 dataset->rrsig_last->next = insert;
381 else dataset->rrsig_first = insert;
382 dataset->rrsig_last = insert;
383 dataset->size += insert->size;
392 /** change an rrsig rrset for use as data rrset */
393 static struct rrset_parse*
394 change_rrsig_rrset(struct rrset_parse* sigset, struct msg_parse* msg,
395 sldns_buffer* pkt, uint16_t datatype, uint32_t rrset_flags,
396 int hasother, sldns_pkt_section section, struct regional* region)
398 struct rrset_parse* dataset = sigset;
399 hashvalue_type hash = pkt_hash_rrset(pkt, sigset->dname, datatype,
400 sigset->rrset_class, rrset_flags);
401 log_assert( sigset->type == LDNS_RR_TYPE_RRSIG );
402 log_assert( datatype != LDNS_RR_TYPE_RRSIG );
404 /* need to make new rrset to hold data type */
405 dataset = new_rrset(msg, sigset->dname, sigset->dname_len,
406 datatype, sigset->rrset_class, hash, rrset_flags,
411 case LDNS_SECTION_ANSWER: msg->an_rrsets++; break;
412 case LDNS_SECTION_AUTHORITY: msg->ns_rrsets++; break;
413 case LDNS_SECTION_ADDITIONAL: msg->ar_rrsets++; break;
414 default: log_assert(0);
416 if(!moveover_rrsigs(pkt, region, sigset, dataset,
417 msg->qtype == LDNS_RR_TYPE_RRSIG ||
418 (msg->qtype == LDNS_RR_TYPE_ANY &&
419 section != LDNS_SECTION_ANSWER) ))
423 /* changeover the type of the rrset to data set */
424 msgparse_bucket_remove(msg, dataset);
425 /* insert into new hash bucket */
426 dataset->rrset_bucket_next = msg->hashtable[hash&(PARSE_TABLE_SIZE-1)];
427 msg->hashtable[hash&(PARSE_TABLE_SIZE-1)] = dataset;
428 dataset->hash = hash;
429 /* use section of data item for result */
430 change_section(msg, dataset, section);
431 dataset->type = datatype;
432 dataset->flags = rrset_flags;
433 dataset->rrsig_count += dataset->rr_count;
434 dataset->rr_count = 0;
435 /* move sigs to end of siglist */
436 if(dataset->rrsig_last)
437 dataset->rrsig_last->next = dataset->rr_first;
438 else dataset->rrsig_first = dataset->rr_first;
439 dataset->rrsig_last = dataset->rr_last;
440 dataset->rr_first = 0;
441 dataset->rr_last = 0;
445 /** Find rrset. If equal to previous it is fast. hash if not so.
446 * @param msg: the message with hash table.
447 * @param pkt: the packet in wireformat (needed for compression ptrs).
448 * @param dname: pointer to start of dname (compressed) in packet.
449 * @param dnamelen: uncompressed wirefmt length of dname.
450 * @param type: type of current rr.
451 * @param dclass: class of current rr.
452 * @param hash: hash value is returned if the rrset could not be found.
453 * @param rrset_flags: is returned if the rrset could not be found.
454 * @param prev_dname_first: dname of last seen RR. First seen dname.
455 * @param prev_dname_last: dname of last seen RR. Last seen dname.
456 * @param prev_dnamelen: dname len of last seen RR.
457 * @param prev_type: type of last seen RR.
458 * @param prev_dclass: class of last seen RR.
459 * @param rrset_prev: last seen RRset.
460 * @param section: the current section in the packet.
461 * @param region: used to allocate temporary parsing data.
462 * @return 0 on out of memory.
465 find_rrset(struct msg_parse* msg, sldns_buffer* pkt, uint8_t* dname,
466 size_t dnamelen, uint16_t type, uint16_t dclass, hashvalue_type* hash,
467 uint32_t* rrset_flags,
468 uint8_t** prev_dname_first, uint8_t** prev_dname_last,
469 size_t* prev_dnamelen, uint16_t* prev_type,
470 uint16_t* prev_dclass, struct rrset_parse** rrset_prev,
471 sldns_pkt_section section, struct regional* region)
473 hashvalue_type dname_h = pkt_hash_rrset_first(pkt, dname);
476 /* check if equal to previous item */
477 if(type == *prev_type && dclass == *prev_dclass &&
478 dnamelen == *prev_dnamelen &&
479 smart_compare(pkt, dname, *prev_dname_first,
480 *prev_dname_last) == 0 &&
481 type != LDNS_RR_TYPE_RRSIG) {
482 /* same as previous */
483 *prev_dname_last = dname;
486 /* check if rrsig over previous item */
487 if(type == LDNS_RR_TYPE_RRSIG && dclass == *prev_dclass &&
488 pkt_rrsig_covered_equals(pkt, sldns_buffer_current(pkt),
490 smart_compare(pkt, dname, *prev_dname_first,
491 *prev_dname_last) == 0) {
492 /* covers previous */
493 *prev_dname_last = dname;
497 /* find by hashing and lookup in hashtable */
498 *rrset_flags = pkt_rrset_flags(pkt, type, section);
500 /* if rrsig - try to lookup matching data set first */
501 if(type == LDNS_RR_TYPE_RRSIG && pkt_rrsig_covered(pkt,
502 sldns_buffer_current(pkt), &covtype)) {
503 *hash = pkt_hash_rrset_rest(dname_h, covtype, dclass,
505 *rrset_prev = msgparse_hashtable_lookup(msg, pkt, *hash,
506 *rrset_flags, dname, dnamelen, covtype, dclass);
507 if(!*rrset_prev && covtype == LDNS_RR_TYPE_NSEC) {
508 /* if NSEC try with NSEC apex bit twiddled */
509 *rrset_flags ^= PACKED_RRSET_NSEC_AT_APEX;
510 *hash = pkt_hash_rrset_rest(dname_h, covtype, dclass,
512 *rrset_prev = msgparse_hashtable_lookup(msg, pkt,
513 *hash, *rrset_flags, dname, dnamelen, covtype,
515 if(!*rrset_prev) /* untwiddle if not found */
516 *rrset_flags ^= PACKED_RRSET_NSEC_AT_APEX;
518 if(!*rrset_prev && covtype == LDNS_RR_TYPE_SOA) {
519 /* if SOA try with SOA neg flag twiddled */
520 *rrset_flags ^= PACKED_RRSET_SOA_NEG;
521 *hash = pkt_hash_rrset_rest(dname_h, covtype, dclass,
523 *rrset_prev = msgparse_hashtable_lookup(msg, pkt,
524 *hash, *rrset_flags, dname, dnamelen, covtype,
526 if(!*rrset_prev) /* untwiddle if not found */
527 *rrset_flags ^= PACKED_RRSET_SOA_NEG;
530 *prev_dname_first = (*rrset_prev)->dname;
531 *prev_dname_last = dname;
532 *prev_dnamelen = dnamelen;
533 *prev_type = covtype;
534 *prev_dclass = dclass;
538 if(type != LDNS_RR_TYPE_RRSIG) {
540 /* find matching rrsig */
541 *hash = pkt_hash_rrset_rest(dname_h, LDNS_RR_TYPE_RRSIG,
543 *rrset_prev = msgparse_hashtable_lookup(msg, pkt, *hash,
544 0, dname, dnamelen, LDNS_RR_TYPE_RRSIG,
546 if(*rrset_prev && rrset_has_sigover(pkt, *rrset_prev, type,
549 *prev_dname_first = (*rrset_prev)->dname;
550 *prev_dname_last = dname;
551 *prev_dnamelen = dnamelen;
553 *prev_dclass = dclass;
554 *rrset_prev = change_rrsig_rrset(*rrset_prev, msg,
555 pkt, type, *rrset_flags, hasother, section,
557 if(!*rrset_prev) return 0;
562 *hash = pkt_hash_rrset_rest(dname_h, type, dclass, *rrset_flags);
563 *rrset_prev = msgparse_hashtable_lookup(msg, pkt, *hash, *rrset_flags,
564 dname, dnamelen, type, dclass);
566 *prev_dname_first = (*rrset_prev)->dname;
567 else *prev_dname_first = dname;
568 *prev_dname_last = dname;
569 *prev_dnamelen = dnamelen;
571 *prev_dclass = dclass;
576 * Parse query section.
577 * @param pkt: packet, position at call must be at start of query section.
578 * at end position is after query section.
579 * @param msg: store results here.
580 * @return: 0 if OK, or rcode on error.
583 parse_query_section(sldns_buffer* pkt, struct msg_parse* msg)
585 if(msg->qdcount == 0)
588 return LDNS_RCODE_FORMERR;
589 log_assert(msg->qdcount == 1);
590 if(sldns_buffer_remaining(pkt) <= 0)
591 return LDNS_RCODE_FORMERR;
592 msg->qname = sldns_buffer_current(pkt);
593 if((msg->qname_len = pkt_dname_len(pkt)) == 0)
594 return LDNS_RCODE_FORMERR;
595 if(sldns_buffer_remaining(pkt) < sizeof(uint16_t)*2)
596 return LDNS_RCODE_FORMERR;
597 msg->qtype = sldns_buffer_read_u16(pkt);
598 msg->qclass = sldns_buffer_read_u16(pkt);
603 get_rdf_size(sldns_rdf_type rdf)
606 case LDNS_RDF_TYPE_CLASS:
607 case LDNS_RDF_TYPE_ALG:
608 case LDNS_RDF_TYPE_INT8:
611 case LDNS_RDF_TYPE_INT16:
612 case LDNS_RDF_TYPE_TYPE:
613 case LDNS_RDF_TYPE_CERT_ALG:
616 case LDNS_RDF_TYPE_INT32:
617 case LDNS_RDF_TYPE_TIME:
618 case LDNS_RDF_TYPE_A:
619 case LDNS_RDF_TYPE_PERIOD:
622 case LDNS_RDF_TYPE_TSIGTIME:
625 case LDNS_RDF_TYPE_AAAA:
629 log_assert(0); /* add type above */
630 /* only types that appear before a domain *
631 * name are needed. rest is simply copied. */
636 /** calculate the size of one rr */
638 calc_size(sldns_buffer* pkt, uint16_t type, struct rr_parse* rr)
640 const sldns_rr_descriptor* desc;
641 uint16_t pkt_len; /* length of rr inside the packet */
642 rr->size = sizeof(uint16_t); /* the rdatalen */
643 sldns_buffer_skip(pkt, 4); /* skip ttl */
644 pkt_len = sldns_buffer_read_u16(pkt);
645 if(sldns_buffer_remaining(pkt) < pkt_len)
647 desc = sldns_rr_descript(type);
648 if(pkt_len > 0 && desc && desc->_dname_count > 0) {
649 int count = (int)desc->_dname_count;
653 /* skip first part. */
654 while(pkt_len > 0 && count) {
655 switch(desc->_wireformat[rdf]) {
656 case LDNS_RDF_TYPE_DNAME:
657 /* decompress every domain name */
658 oldpos = sldns_buffer_position(pkt);
659 if((len = pkt_dname_len(pkt)) == 0)
660 return 0; /* malformed dname */
661 if(sldns_buffer_position(pkt)-oldpos > pkt_len)
662 return 0; /* dname exceeds rdata */
663 pkt_len -= sldns_buffer_position(pkt)-oldpos;
668 case LDNS_RDF_TYPE_STR:
670 /* NOTREACHED, due to 'while(>0)' */
671 return 0; /* len byte exceeds rdata */
673 len = sldns_buffer_current(pkt)[0] + 1;
676 len = get_rdf_size(desc->_wireformat[rdf]);
680 return 0; /* exceeds rdata */
682 sldns_buffer_skip(pkt, (ssize_t)len);
688 /* remaining rdata */
690 sldns_buffer_skip(pkt, (ssize_t)pkt_len);
694 /** skip rr ttl and rdata */
696 skip_ttl_rdata(sldns_buffer* pkt)
699 if(sldns_buffer_remaining(pkt) < 6) /* ttl + rdatalen */
701 sldns_buffer_skip(pkt, 4); /* ttl */
702 rdatalen = sldns_buffer_read_u16(pkt);
703 if(sldns_buffer_remaining(pkt) < rdatalen)
705 sldns_buffer_skip(pkt, (ssize_t)rdatalen);
709 /** see if RRSIG is a duplicate of another */
711 sig_is_double(sldns_buffer* pkt, struct rrset_parse* rrset, uint8_t* ttldata)
713 uint16_t rlen, siglen;
714 size_t pos = sldns_buffer_position(pkt);
715 struct rr_parse* sig;
716 if(sldns_buffer_remaining(pkt) < 6)
718 sldns_buffer_skip(pkt, 4); /* ttl */
719 rlen = sldns_buffer_read_u16(pkt);
720 if(sldns_buffer_remaining(pkt) < rlen) {
721 sldns_buffer_set_position(pkt, pos);
724 sldns_buffer_set_position(pkt, pos);
726 sig = rrset->rrsig_first;
728 /* check if rdatalen is same */
729 memmove(&siglen, sig->ttl_data+4, sizeof(siglen));
730 siglen = ntohs(siglen);
731 /* checks if data in packet is exactly the same, this means
732 * also dname in rdata is the same, but rrsig is not allowed
733 * to have compressed dnames anyway. If it is compressed anyway
734 * it will lead to duplicate rrs for qtype=RRSIG. (or ANY).
736 * Cannot use sig->size because size of the other one is not
740 if(siglen>0 && memcmp(sig->ttl_data+6, ttldata+6,
751 /** Add rr (from packet here) to rrset, skips rr */
753 add_rr_to_rrset(struct rrset_parse* rrset, sldns_buffer* pkt,
754 struct msg_parse* msg, struct regional* region,
755 sldns_pkt_section section, uint16_t type)
758 /* check section of rrset. */
759 if(rrset->section != section && type != LDNS_RR_TYPE_RRSIG &&
760 rrset->type != LDNS_RR_TYPE_RRSIG) {
761 /* silently drop it - we drop the last part, since
762 * trust in rr data depends on the section it is in.
763 * the less trustworthy part is discarded.
764 * also the last part is more likely to be incomplete.
765 * RFC 2181: must put RRset only once in response. */
767 verbose(VERB_QUERY, "Packet contains rrset data in "
768 "multiple sections, dropped last part.");
769 log_buf(VERB_QUERY, "packet was", pkt);
772 if(!skip_ttl_rdata(pkt))
773 return LDNS_RCODE_FORMERR;
777 if( (msg->qtype == LDNS_RR_TYPE_RRSIG ||
778 msg->qtype == LDNS_RR_TYPE_ANY)
779 && sig_is_double(pkt, rrset, sldns_buffer_current(pkt))) {
780 if(!skip_ttl_rdata(pkt))
781 return LDNS_RCODE_FORMERR;
786 if(!(rr = (struct rr_parse*)regional_alloc(region, sizeof(*rr))))
787 return LDNS_RCODE_SERVFAIL;
788 rr->outside_packet = 0;
789 rr->ttl_data = sldns_buffer_current(pkt);
791 if(type == LDNS_RR_TYPE_RRSIG && rrset->type != LDNS_RR_TYPE_RRSIG) {
792 if(rrset->rrsig_last)
793 rrset->rrsig_last->next = rr;
794 else rrset->rrsig_first = rr;
795 rrset->rrsig_last = rr;
796 rrset->rrsig_count++;
799 rrset->rr_last->next = rr;
800 else rrset->rr_first = rr;
805 /* calc decompressed size */
806 if(!calc_size(pkt, type, rr))
807 return LDNS_RCODE_FORMERR;
808 rrset->size += rr->size;
814 * Parse packet RR section, for answer, authority and additional sections.
815 * @param pkt: packet, position at call must be at start of section.
816 * at end position is after section.
817 * @param msg: store results here.
818 * @param region: how to alloc results.
819 * @param section: section enum.
820 * @param num_rrs: how many rrs are in the section.
821 * @param num_rrsets: returns number of rrsets in the section.
822 * @return: 0 if OK, or rcode on error.
825 parse_section(sldns_buffer* pkt, struct msg_parse* msg,
826 struct regional* region, sldns_pkt_section section,
827 uint16_t num_rrs, size_t* num_rrsets)
830 uint8_t* dname, *prev_dname_f = NULL, *prev_dname_l = NULL;
831 size_t dnamelen, prev_dnamelen = 0;
832 uint16_t type, prev_type = 0;
833 uint16_t dclass, prev_dclass = 0;
834 uint32_t rrset_flags = 0;
835 hashvalue_type hash = 0;
836 struct rrset_parse* rrset = NULL;
841 if(sldns_buffer_remaining(pkt) <= 0)
842 return LDNS_RCODE_FORMERR;
843 for(i=0; i<num_rrs; i++) {
845 dname = sldns_buffer_current(pkt);
846 if((dnamelen = pkt_dname_len(pkt)) == 0)
847 return LDNS_RCODE_FORMERR;
848 if(sldns_buffer_remaining(pkt) < 10) /* type, class, ttl, len */
849 return LDNS_RCODE_FORMERR;
850 type = sldns_buffer_read_u16(pkt);
851 sldns_buffer_read(pkt, &dclass, sizeof(dclass));
853 if(0) { /* debug show what is being parsed. */
854 if(type == LDNS_RR_TYPE_RRSIG) {
856 if(pkt_rrsig_covered(pkt,
857 sldns_buffer_current(pkt), &t))
858 fprintf(stderr, "parse of %s(%d) [%s(%d)]",
859 sldns_rr_descript(type)?
860 sldns_rr_descript(type)->_name: "??",
862 sldns_rr_descript(t)?
863 sldns_rr_descript(t)->_name: "??",
866 fprintf(stderr, "parse of %s(%d)",
867 sldns_rr_descript(type)?
868 sldns_rr_descript(type)->_name: "??",
870 fprintf(stderr, " %s(%d) ",
871 sldns_lookup_by_id(sldns_rr_classes,
872 (int)ntohs(dclass))?sldns_lookup_by_id(
873 sldns_rr_classes, (int)ntohs(dclass))->name:
874 "??", (int)ntohs(dclass));
875 dname_print(stderr, pkt, dname);
876 fprintf(stderr, "\n");
879 /* see if it is part of an existing RR set */
880 if(!find_rrset(msg, pkt, dname, dnamelen, type, dclass, &hash,
881 &rrset_flags, &prev_dname_f, &prev_dname_l,
882 &prev_dnamelen, &prev_type, &prev_dclass, &rrset,
884 return LDNS_RCODE_SERVFAIL;
886 /* it is a new RR set. hash&flags already calculated.*/
888 rrset = new_rrset(msg, dname, dnamelen, type, dclass,
889 hash, rrset_flags, section, region);
891 return LDNS_RCODE_SERVFAIL;
894 fprintf(stderr, "is part of existing: ");
895 dname_print(stderr, pkt, rrset->dname);
896 fprintf(stderr, " type %s(%d)\n",
897 sldns_rr_descript(rrset->type)?
898 sldns_rr_descript(rrset->type)->_name: "??",
902 if((r=add_rr_to_rrset(rrset, pkt, msg, region, section,
910 parse_packet(sldns_buffer* pkt, struct msg_parse* msg, struct regional* region)
913 if(sldns_buffer_remaining(pkt) < LDNS_HEADER_SIZE)
914 return LDNS_RCODE_FORMERR;
915 /* read the header */
916 sldns_buffer_read(pkt, &msg->id, sizeof(uint16_t));
917 msg->flags = sldns_buffer_read_u16(pkt);
918 msg->qdcount = sldns_buffer_read_u16(pkt);
919 msg->ancount = sldns_buffer_read_u16(pkt);
920 msg->nscount = sldns_buffer_read_u16(pkt);
921 msg->arcount = sldns_buffer_read_u16(pkt);
923 return LDNS_RCODE_FORMERR;
924 if((ret = parse_query_section(pkt, msg)) != 0)
926 if((ret = parse_section(pkt, msg, region, LDNS_SECTION_ANSWER,
927 msg->ancount, &msg->an_rrsets)) != 0)
929 if((ret = parse_section(pkt, msg, region, LDNS_SECTION_AUTHORITY,
930 msg->nscount, &msg->ns_rrsets)) != 0)
932 if(sldns_buffer_remaining(pkt) == 0 && msg->arcount == 1) {
933 /* BIND accepts leniently that an EDNS record is missing.
935 } else if((ret = parse_section(pkt, msg, region,
936 LDNS_SECTION_ADDITIONAL, msg->arcount, &msg->ar_rrsets)) != 0)
938 /* if(sldns_buffer_remaining(pkt) > 0) { */
939 /* there is spurious data at end of packet. ignore */
941 msg->rrset_count = msg->an_rrsets + msg->ns_rrsets + msg->ar_rrsets;
945 /** parse EDNS options from EDNS wireformat rdata */
947 parse_edns_options_from_query(uint8_t* rdata_ptr, size_t rdata_len,
948 struct edns_data* edns, struct config_file* cfg, struct comm_point* c,
949 struct comm_reply* repinfo, uint32_t now, struct regional* region)
951 /* To respond with a Keepalive option, the client connection must have
952 * received one message with a TCP Keepalive EDNS option, and that
953 * option must have 0 length data. Subsequent messages sent on that
954 * connection will have a TCP Keepalive option.
956 * In the if-statement below, the option is added unsolicited. This
957 * means that the client has sent an KEEPALIVE option earlier. We know
958 * here this is true, because c->tcp_keepalive is set.
960 if (cfg && cfg->do_tcp_keepalive && c && c->type != comm_udp && c->tcp_keepalive) {
961 if(!edns_opt_list_append_keepalive(&edns->opt_list_out,
962 c->tcp_timeout_msec / 100, region)) {
963 log_err("out of memory");
964 return LDNS_RCODE_SERVFAIL;
968 /* while still more options, and have code+len to read */
969 /* ignores partial content (i.e. rdata len 3) */
970 while(rdata_len >= 4) {
971 uint16_t opt_code = sldns_read_uint16(rdata_ptr);
972 uint16_t opt_len = sldns_read_uint16(rdata_ptr+2);
973 uint8_t server_cookie[40];
974 enum edns_cookie_val_status cookie_val_status;
975 int cookie_is_v4 = 1;
979 if(opt_len > rdata_len)
980 break; /* option code partial */
982 /* handle parse time edns options here */
985 if (!cfg || !cfg->nsid)
987 if(!edns_opt_list_append(&edns->opt_list_out,
988 LDNS_EDNS_NSID, cfg->nsid_len,
989 cfg->nsid, region)) {
990 log_err("out of memory");
991 return LDNS_RCODE_SERVFAIL;
995 case LDNS_EDNS_KEEPALIVE:
996 /* To respond with a Keepalive option, the client
997 * connection must have received one message with a TCP
998 * Keepalive EDNS option, and that option must have 0
999 * length data. Subsequent messages sent on that
1000 * connection will have a TCP Keepalive option.
1002 * This should be the first time the client sends this
1003 * option, so c->tcp_keepalive is not set.
1004 * Besides adding the reply KEEPALIVE option,
1005 * c->tcp_keepalive will be set so that the
1006 * option will be added unsolicited in subsequent
1007 * responses (see the comment above the if-statement
1008 * at the start of this function).
1010 if (!cfg || !cfg->do_tcp_keepalive || !c ||
1011 c->type == comm_udp || c->tcp_keepalive)
1014 verbose(VERB_ALGO, "query with bad edns keepalive.");
1015 return LDNS_RCODE_FORMERR;
1017 if(!edns_opt_list_append_keepalive(&edns->opt_list_out,
1018 c->tcp_timeout_msec / 100,
1020 log_err("out of memory");
1021 return LDNS_RCODE_SERVFAIL;
1023 c->tcp_keepalive = 1;
1026 case LDNS_EDNS_PADDING:
1027 if(!cfg || !cfg->pad_responses ||
1028 !c || c->type != comm_tcp ||!c->ssl)
1030 if(!edns_opt_list_append(&edns->opt_list_out,
1033 log_err("out of memory");
1034 return LDNS_RCODE_SERVFAIL;
1036 edns->padding_block_size = cfg->pad_responses_block_size;
1039 case LDNS_EDNS_COOKIE:
1040 if(!cfg || !cfg->do_answer_cookie || !repinfo)
1042 if(opt_len != 8 && (opt_len < 16 || opt_len > 40)) {
1043 verbose(VERB_ALGO, "worker request: "
1044 "badly formatted cookie");
1045 return LDNS_RCODE_FORMERR;
1047 edns->cookie_present = 1;
1049 /* Copy client cookie, version and timestamp for
1050 * validation and creation purposes.
1053 memmove(server_cookie, rdata_ptr, 16);
1055 memset(server_cookie, 0, 16);
1056 memmove(server_cookie, rdata_ptr, opt_len);
1059 /* Copy client ip for validation and creation
1060 * purposes. It will be overwritten if (re)creation
1063 if(repinfo->remote_addr.ss_family == AF_INET) {
1064 memcpy(server_cookie + 16,
1065 &((struct sockaddr_in*)&repinfo->remote_addr)->sin_addr, 4);
1068 memcpy(server_cookie + 16,
1069 &((struct sockaddr_in6*)&repinfo->remote_addr)->sin6_addr, 16);
1072 cookie_val_status = edns_cookie_server_validate(
1073 rdata_ptr, opt_len, cfg->cookie_secret,
1074 cfg->cookie_secret_len, cookie_is_v4,
1075 server_cookie, now);
1076 switch(cookie_val_status) {
1077 case COOKIE_STATUS_VALID:
1078 case COOKIE_STATUS_VALID_RENEW:
1079 edns->cookie_valid = 1;
1081 if(!edns_opt_list_append(
1082 &edns->opt_list_out, LDNS_EDNS_COOKIE,
1083 opt_len, rdata_ptr, region)) {
1084 log_err("out of memory");
1085 return LDNS_RCODE_SERVFAIL;
1087 /* Cookie to be reused added to outgoing
1091 case COOKIE_STATUS_CLIENT_ONLY:
1092 edns->cookie_client = 1;
1094 case COOKIE_STATUS_FUTURE:
1095 case COOKIE_STATUS_EXPIRED:
1096 case COOKIE_STATUS_INVALID:
1098 edns_cookie_server_write(server_cookie,
1099 cfg->cookie_secret, cookie_is_v4, now);
1100 if(!edns_opt_list_append(&edns->opt_list_out,
1101 LDNS_EDNS_COOKIE, 24, server_cookie,
1103 log_err("out of memory");
1104 return LDNS_RCODE_SERVFAIL;
1112 if(!edns_opt_list_append(&edns->opt_list_in,
1113 opt_code, opt_len, rdata_ptr, region)) {
1114 log_err("out of memory");
1115 return LDNS_RCODE_SERVFAIL;
1117 rdata_ptr += opt_len;
1118 rdata_len -= opt_len;
1120 return LDNS_RCODE_NOERROR;
1124 parse_extract_edns_from_response_msg(struct msg_parse* msg,
1125 struct edns_data* edns, struct regional* region)
1127 struct rrset_parse* rrset = msg->rrset_first;
1128 struct rrset_parse* prev = 0;
1129 struct rrset_parse* found = 0;
1130 struct rrset_parse* found_prev = 0;
1133 /* since the class encodes the UDP size, we cannot use hash table to
1134 * find the EDNS OPT record. Scan the packet. */
1136 if(rrset->type == LDNS_RR_TYPE_OPT) {
1137 /* only one OPT RR allowed. */
1138 if(found) return LDNS_RCODE_FORMERR;
1144 rrset = rrset->rrset_all_next;
1147 memset(edns, 0, sizeof(*edns));
1148 edns->udp_size = 512;
1151 /* check the found RRset */
1152 /* most lenient check possible. ignore dname, use last opt */
1153 if(found->section != LDNS_SECTION_ADDITIONAL)
1154 return LDNS_RCODE_FORMERR;
1155 if(found->rr_count == 0)
1156 return LDNS_RCODE_FORMERR;
1157 if(0) { /* strict checking of dname and RRcount */
1158 if(found->dname_len != 1 || !found->dname
1159 || found->dname[0] != 0) return LDNS_RCODE_FORMERR;
1160 if(found->rr_count != 1) return LDNS_RCODE_FORMERR;
1162 log_assert(found->rr_first && found->rr_last);
1164 /* remove from packet */
1165 if(found_prev) found_prev->rrset_all_next = found->rrset_all_next;
1166 else msg->rrset_first = found->rrset_all_next;
1167 if(found == msg->rrset_last)
1168 msg->rrset_last = found_prev;
1171 msg->rrset_count --;
1173 /* take the data ! */
1174 edns->edns_present = 1;
1175 edns->ext_rcode = found->rr_last->ttl_data[0];
1176 edns->edns_version = found->rr_last->ttl_data[1];
1177 edns->bits = sldns_read_uint16(&found->rr_last->ttl_data[2]);
1178 edns->udp_size = ntohs(found->rrset_class);
1179 edns->opt_list_in = NULL;
1180 edns->opt_list_out = NULL;
1181 edns->opt_list_inplace_cb_out = NULL;
1182 edns->padding_block_size = 0;
1183 edns->cookie_present = 0;
1184 edns->cookie_valid = 0;
1186 /* take the options */
1187 rdata_len = found->rr_first->size-2;
1188 rdata_ptr = found->rr_first->ttl_data+6;
1190 /* while still more options, and have code+len to read */
1191 /* ignores partial content (i.e. rdata len 3) */
1192 while(rdata_len >= 4) {
1193 uint16_t opt_code = sldns_read_uint16(rdata_ptr);
1194 uint16_t opt_len = sldns_read_uint16(rdata_ptr+2);
1197 if(opt_len > rdata_len)
1198 break; /* option code partial */
1200 if(!edns_opt_list_append(&edns->opt_list_in,
1201 opt_code, opt_len, rdata_ptr, region)) {
1202 log_err("out of memory");
1205 rdata_ptr += opt_len;
1206 rdata_len -= opt_len;
1209 return LDNS_RCODE_NOERROR;
1212 /** skip RR in packet */
1214 skip_pkt_rr(sldns_buffer* pkt)
1216 if(sldns_buffer_remaining(pkt) < 1) return 0;
1217 if(!pkt_dname_len(pkt))
1219 if(sldns_buffer_remaining(pkt) < 4) return 0;
1220 sldns_buffer_skip(pkt, 4); /* type and class */
1221 if(!skip_ttl_rdata(pkt))
1226 /** skip RRs from packet */
1228 skip_pkt_rrs(sldns_buffer* pkt, int num)
1231 for(i=0; i<num; i++) {
1232 if(!skip_pkt_rr(pkt))
1239 parse_edns_from_query_pkt(sldns_buffer* pkt, struct edns_data* edns,
1240 struct config_file* cfg, struct comm_point* c,
1241 struct comm_reply* repinfo, time_t now, struct regional* region)
1245 log_assert(LDNS_QDCOUNT(sldns_buffer_begin(pkt)) == 1);
1246 memset(edns, 0, sizeof(*edns));
1247 if(LDNS_ANCOUNT(sldns_buffer_begin(pkt)) != 0 ||
1248 LDNS_NSCOUNT(sldns_buffer_begin(pkt)) != 0) {
1249 if(!skip_pkt_rrs(pkt, ((int)LDNS_ANCOUNT(sldns_buffer_begin(pkt)))+
1250 ((int)LDNS_NSCOUNT(sldns_buffer_begin(pkt)))))
1251 return LDNS_RCODE_FORMERR;
1253 /* check edns section is present */
1254 if(LDNS_ARCOUNT(sldns_buffer_begin(pkt)) > 1) {
1255 return LDNS_RCODE_FORMERR;
1257 if(LDNS_ARCOUNT(sldns_buffer_begin(pkt)) == 0) {
1258 edns->udp_size = 512;
1261 /* domain name must be the root of length 1. */
1262 if(pkt_dname_len(pkt) != 1)
1263 return LDNS_RCODE_FORMERR;
1264 if(sldns_buffer_remaining(pkt) < 10) /* type, class, ttl, rdatalen */
1265 return LDNS_RCODE_FORMERR;
1266 if(sldns_buffer_read_u16(pkt) != LDNS_RR_TYPE_OPT)
1267 return LDNS_RCODE_FORMERR;
1268 edns->edns_present = 1;
1269 edns->udp_size = sldns_buffer_read_u16(pkt); /* class is udp size */
1270 edns->ext_rcode = sldns_buffer_read_u8(pkt); /* ttl used for bits */
1271 edns->edns_version = sldns_buffer_read_u8(pkt);
1272 edns->bits = sldns_buffer_read_u16(pkt);
1273 edns->opt_list_in = NULL;
1274 edns->opt_list_out = NULL;
1275 edns->opt_list_inplace_cb_out = NULL;
1276 edns->padding_block_size = 0;
1277 edns->cookie_present = 0;
1278 edns->cookie_valid = 0;
1280 /* take the options */
1281 rdata_len = sldns_buffer_read_u16(pkt);
1282 if(sldns_buffer_remaining(pkt) < rdata_len)
1283 return LDNS_RCODE_FORMERR;
1284 rdata_ptr = sldns_buffer_current(pkt);
1286 return parse_edns_options_from_query(rdata_ptr, rdata_len, edns, cfg,
1287 c, repinfo, now, region);
1291 log_edns_opt_list(enum verbosity_value level, const char* info_str,
1292 struct edns_option* list)
1294 if(verbosity >= level && list) {
1297 verbose(level, "%s", info_str);
1301 (void)sldns_wire2str_edns_option_print(&s, &slen, list->opt_code,
1302 list->opt_data, list->opt_len);
1303 verbose(level, " %s", str);