2 * libunbound/context.c - validating context for unbound internal use
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.
39 * This file contains the validator context structure.
42 #include "libunbound/context.h"
43 #include "util/module.h"
44 #include "util/config_file.h"
45 #include "util/net_help.h"
46 #include "services/modstack.h"
47 #include "services/localzone.h"
48 #include "services/cache/rrset.h"
49 #include "services/cache/infra.h"
50 #include "services/authzone.h"
51 #include "util/data/msgreply.h"
52 #include "util/storage/slabhash.h"
53 #include "util/edns.h"
54 #include "sldns/sbuffer.h"
57 context_finalize(struct ub_ctx* ctx)
60 struct config_file* cfg = ctx->env->cfg;
61 verbosity = cfg->verbosity;
62 if(ctx_logfile_overridden && !ctx->logfile_override) {
63 log_file(NULL); /* clear that override */
64 ctx_logfile_overridden = 0;
66 if(ctx->logfile_override) {
67 ctx_logfile_overridden = 1;
68 log_file(ctx->log_out);
70 log_init(cfg->logfile, cfg->use_syslog, NULL);
73 if(!modstack_setup(&ctx->mods, cfg->module_conf, ctx->env))
75 log_edns_known_options(VERB_ALGO, ctx->env);
76 ctx->local_zones = local_zones_create();
79 if(!local_zones_apply_cfg(ctx->local_zones, cfg))
81 if(!auth_zones_apply_cfg(ctx->env->auth_zones, cfg, 1, &is_rpz))
83 if(!edns_tags_apply_cfg(ctx->env->edns_tags, cfg))
85 if(!slabhash_is_size(ctx->env->msg_cache, cfg->msg_cache_size,
86 cfg->msg_cache_slabs)) {
87 slabhash_delete(ctx->env->msg_cache);
88 ctx->env->msg_cache = slabhash_create(cfg->msg_cache_slabs,
89 HASH_DEFAULT_STARTARRAY, cfg->msg_cache_size,
90 msgreply_sizefunc, query_info_compare,
91 query_entry_delete, reply_info_delete, NULL);
92 if(!ctx->env->msg_cache)
95 ctx->env->rrset_cache = rrset_cache_adjust(ctx->env->rrset_cache,
96 ctx->env->cfg, ctx->env->alloc);
97 if(!ctx->env->rrset_cache)
99 ctx->env->infra_cache = infra_adjust(ctx->env->infra_cache, cfg);
100 if(!ctx->env->infra_cache)
106 int context_query_cmp(const void* a, const void* b)
108 if( *(int*)a < *(int*)b )
110 if( *(int*)a > *(int*)b )
116 context_query_delete(struct ctx_query* q)
119 ub_resolve_free(q->res);
124 /** How many times to try to find an unused query-id-number for async */
125 #define NUM_ID_TRIES 100000
126 /** find next useful id number of 0 on error */
128 find_id(struct ub_ctx* ctx, int* id)
131 ctx->next_querynum++;
132 while(rbtree_search(&ctx->queries, &ctx->next_querynum)) {
133 ctx->next_querynum++; /* numerical wraparound is fine */
134 if(tries++ > NUM_ID_TRIES)
137 *id = ctx->next_querynum;
142 context_new(struct ub_ctx* ctx, const char* name, int rrtype, int rrclass,
143 ub_callback_type cb, ub_event_callback_type cb_event, void* cbarg)
145 struct ctx_query* q = (struct ctx_query*)calloc(1, sizeof(*q));
147 lock_basic_lock(&ctx->cfglock);
148 if(!find_id(ctx, &q->querynum)) {
149 lock_basic_unlock(&ctx->cfglock);
153 lock_basic_unlock(&ctx->cfglock);
154 q->node.key = &q->querynum;
155 q->async = (cb != NULL || cb_event != NULL);
157 q->cb_event = cb_event;
159 q->res = (struct ub_result*)calloc(1, sizeof(*q->res));
164 q->res->qname = strdup(name);
170 q->res->qtype = rrtype;
171 q->res->qclass = rrclass;
173 /* add to query list */
174 lock_basic_lock(&ctx->cfglock);
177 (void)rbtree_insert(&ctx->queries, &q->node);
178 lock_basic_unlock(&ctx->cfglock);
183 context_obtain_alloc(struct ub_ctx* ctx, int locking)
185 struct alloc_cache* a;
188 lock_basic_lock(&ctx->cfglock);
192 ctx->alloc_list = a->super; /* snip off list */
193 else tnum = ctx->thr_next_num++;
195 lock_basic_unlock(&ctx->cfglock);
198 a->super = &ctx->superalloc;
201 a = (struct alloc_cache*)calloc(1, sizeof(*a));
204 alloc_init(a, &ctx->superalloc, tnum);
209 context_release_alloc(struct ub_ctx* ctx, struct alloc_cache* alloc,
215 lock_basic_lock(&ctx->cfglock);
217 alloc->super = ctx->alloc_list;
218 ctx->alloc_list = alloc;
220 lock_basic_unlock(&ctx->cfglock);
225 context_serialize_new_query(struct ctx_query* q, uint32_t* len)
227 /* format for new query is
232 * o rest queryname (string)
235 size_t slen = strlen(q->res->qname) + 1/*end of string*/;
236 *len = sizeof(uint32_t)*4 + slen;
237 p = (uint8_t*)malloc(*len);
239 sldns_write_uint32(p, UB_LIBCMD_NEWQUERY);
240 sldns_write_uint32(p+sizeof(uint32_t), (uint32_t)q->querynum);
241 sldns_write_uint32(p+2*sizeof(uint32_t), (uint32_t)q->res->qtype);
242 sldns_write_uint32(p+3*sizeof(uint32_t), (uint32_t)q->res->qclass);
243 memmove(p+4*sizeof(uint32_t), q->res->qname, slen);
248 context_deserialize_new_query(struct ub_ctx* ctx, uint8_t* p, uint32_t len)
250 struct ctx_query* q = (struct ctx_query*)calloc(1, sizeof(*q));
252 if(len < 4*sizeof(uint32_t)+1) {
256 log_assert( sldns_read_uint32(p) == UB_LIBCMD_NEWQUERY);
257 q->querynum = (int)sldns_read_uint32(p+sizeof(uint32_t));
258 q->node.key = &q->querynum;
260 q->res = (struct ub_result*)calloc(1, sizeof(*q->res));
265 q->res->qtype = (int)sldns_read_uint32(p+2*sizeof(uint32_t));
266 q->res->qclass = (int)sldns_read_uint32(p+3*sizeof(uint32_t));
267 q->res->qname = strdup((char*)(p+4*sizeof(uint32_t)));
274 /** add to query list */
276 (void)rbtree_insert(&ctx->queries, &q->node);
281 context_lookup_new_query(struct ub_ctx* ctx, uint8_t* p, uint32_t len)
285 if(len < 4*sizeof(uint32_t)+1) {
288 log_assert( sldns_read_uint32(p) == UB_LIBCMD_NEWQUERY);
289 querynum = (int)sldns_read_uint32(p+sizeof(uint32_t));
290 q = (struct ctx_query*)rbtree_search(&ctx->queries, &querynum);
294 log_assert(q->async);
299 context_serialize_answer(struct ctx_query* q, int err, sldns_buffer* pkt,
305 * o uint32 error_code
306 * o uint32 msg_security
307 * o uint32 was_ratelimited
308 * o uint32 length of why_bogus string (+1 for eos); 0 absent.
310 * o the remainder is the answer msg from resolver lookup.
311 * remainder can be length 0.
313 size_t size_of_uint32s = 6 * sizeof(uint32_t);
314 size_t pkt_len = pkt?sldns_buffer_remaining(pkt):0;
315 size_t wlen = (pkt&&q->res->why_bogus)?strlen(q->res->why_bogus)+1:0;
317 *len = size_of_uint32s + pkt_len + wlen;
318 p = (uint8_t*)malloc(*len);
320 sldns_write_uint32(p, UB_LIBCMD_ANSWER);
321 sldns_write_uint32(p+sizeof(uint32_t), (uint32_t)q->querynum);
322 sldns_write_uint32(p+2*sizeof(uint32_t), (uint32_t)err);
323 sldns_write_uint32(p+3*sizeof(uint32_t), (uint32_t)q->msg_security);
324 sldns_write_uint32(p+4*sizeof(uint32_t), (uint32_t)q->res->was_ratelimited);
325 sldns_write_uint32(p+5*sizeof(uint32_t), (uint32_t)wlen);
327 memmove(p+size_of_uint32s, q->res->why_bogus, wlen);
329 memmove(p+size_of_uint32s+wlen,
330 sldns_buffer_begin(pkt), pkt_len);
335 context_deserialize_answer(struct ub_ctx* ctx,
336 uint8_t* p, uint32_t len, int* err)
338 size_t size_of_uint32s = 6 * sizeof(uint32_t);
339 struct ctx_query* q = NULL ;
342 if(len < size_of_uint32s) return NULL;
343 log_assert( sldns_read_uint32(p) == UB_LIBCMD_ANSWER);
344 id = (int)sldns_read_uint32(p+sizeof(uint32_t));
345 q = (struct ctx_query*)rbtree_search(&ctx->queries, &id);
347 *err = (int)sldns_read_uint32(p+2*sizeof(uint32_t));
348 q->msg_security = sldns_read_uint32(p+3*sizeof(uint32_t));
349 q->res->was_ratelimited = (int)sldns_read_uint32(p+4*sizeof(uint32_t));
350 wlen = (size_t)sldns_read_uint32(p+5*sizeof(uint32_t));
351 if(len > size_of_uint32s && wlen > 0) {
352 if(len >= size_of_uint32s+wlen)
353 q->res->why_bogus = (char*)memdup(
354 p+size_of_uint32s, wlen);
355 if(!q->res->why_bogus) {
356 /* pass malloc failure to the user callback */
361 q->res->why_bogus[wlen-1] = 0; /* zero terminated for sure */
363 if(len > size_of_uint32s+wlen) {
364 q->msg_len = len - size_of_uint32s - wlen;
365 q->msg = (uint8_t*)memdup(p+size_of_uint32s+wlen,
368 /* pass malloc failure to the user callback */
378 context_serialize_cancel(struct ctx_query* q, uint32_t* len)
382 * o uint32 async-id */
383 uint8_t* p = (uint8_t*)reallocarray(NULL, sizeof(uint32_t), 2);
385 *len = 2*sizeof(uint32_t);
386 sldns_write_uint32(p, UB_LIBCMD_CANCEL);
387 sldns_write_uint32(p+sizeof(uint32_t), (uint32_t)q->querynum);
391 struct ctx_query* context_deserialize_cancel(struct ub_ctx* ctx,
392 uint8_t* p, uint32_t len)
396 if(len != 2*sizeof(uint32_t)) return NULL;
397 log_assert( sldns_read_uint32(p) == UB_LIBCMD_CANCEL);
398 id = (int)sldns_read_uint32(p+sizeof(uint32_t));
399 q = (struct ctx_query*)rbtree_search(&ctx->queries, &id);
404 context_serialize_quit(uint32_t* len)
406 uint32_t* p = (uint32_t*)malloc(sizeof(uint32_t));
409 *len = sizeof(uint32_t);
410 sldns_write_uint32(p, UB_LIBCMD_QUIT);
414 enum ub_ctx_cmd context_serial_getcmd(uint8_t* p, uint32_t len)
417 if((size_t)len < sizeof(v))
418 return UB_LIBCMD_QUIT;
419 v = sldns_read_uint32(p);