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 "sldns/sbuffer.h"
56 context_finalize(struct ub_ctx* ctx)
58 struct config_file* cfg = ctx->env->cfg;
59 verbosity = cfg->verbosity;
60 if(ctx->logfile_override)
61 log_file(ctx->log_out);
62 else log_init(cfg->logfile, cfg->use_syslog, NULL);
64 if(!modstack_setup(&ctx->mods, cfg->module_conf, ctx->env))
66 log_edns_known_options(VERB_ALGO, ctx->env);
67 ctx->local_zones = local_zones_create();
70 if(!local_zones_apply_cfg(ctx->local_zones, cfg))
72 if(!auth_zones_apply_cfg(ctx->env->auth_zones, cfg, 1))
74 if(!slabhash_is_size(ctx->env->msg_cache, cfg->msg_cache_size,
75 cfg->msg_cache_slabs)) {
76 slabhash_delete(ctx->env->msg_cache);
77 ctx->env->msg_cache = slabhash_create(cfg->msg_cache_slabs,
78 HASH_DEFAULT_STARTARRAY, cfg->msg_cache_size,
79 msgreply_sizefunc, query_info_compare,
80 query_entry_delete, reply_info_delete, NULL);
81 if(!ctx->env->msg_cache)
84 ctx->env->rrset_cache = rrset_cache_adjust(ctx->env->rrset_cache,
85 ctx->env->cfg, ctx->env->alloc);
86 if(!ctx->env->rrset_cache)
88 ctx->env->infra_cache = infra_adjust(ctx->env->infra_cache, cfg);
89 if(!ctx->env->infra_cache)
95 int context_query_cmp(const void* a, const void* b)
97 if( *(int*)a < *(int*)b )
99 if( *(int*)a > *(int*)b )
105 context_query_delete(struct ctx_query* q)
108 ub_resolve_free(q->res);
113 /** How many times to try to find an unused query-id-number for async */
114 #define NUM_ID_TRIES 100000
115 /** find next useful id number of 0 on error */
117 find_id(struct ub_ctx* ctx, int* id)
120 ctx->next_querynum++;
121 while(rbtree_search(&ctx->queries, &ctx->next_querynum)) {
122 ctx->next_querynum++; /* numerical wraparound is fine */
123 if(tries++ > NUM_ID_TRIES)
126 *id = ctx->next_querynum;
131 context_new(struct ub_ctx* ctx, const char* name, int rrtype, int rrclass,
132 ub_callback_type cb, ub_event_callback_type cb_event, void* cbarg)
134 struct ctx_query* q = (struct ctx_query*)calloc(1, sizeof(*q));
136 lock_basic_lock(&ctx->cfglock);
137 if(!find_id(ctx, &q->querynum)) {
138 lock_basic_unlock(&ctx->cfglock);
142 lock_basic_unlock(&ctx->cfglock);
143 q->node.key = &q->querynum;
144 q->async = (cb != NULL || cb_event != NULL);
146 q->cb_event = cb_event;
148 q->res = (struct ub_result*)calloc(1, sizeof(*q->res));
153 q->res->qname = strdup(name);
159 q->res->qtype = rrtype;
160 q->res->qclass = rrclass;
162 /* add to query list */
163 lock_basic_lock(&ctx->cfglock);
166 (void)rbtree_insert(&ctx->queries, &q->node);
167 lock_basic_unlock(&ctx->cfglock);
172 context_obtain_alloc(struct ub_ctx* ctx, int locking)
174 struct alloc_cache* a;
177 lock_basic_lock(&ctx->cfglock);
181 ctx->alloc_list = a->super; /* snip off list */
182 else tnum = ctx->thr_next_num++;
184 lock_basic_unlock(&ctx->cfglock);
187 a->super = &ctx->superalloc;
190 a = (struct alloc_cache*)calloc(1, sizeof(*a));
193 alloc_init(a, &ctx->superalloc, tnum);
198 context_release_alloc(struct ub_ctx* ctx, struct alloc_cache* alloc,
204 lock_basic_lock(&ctx->cfglock);
206 alloc->super = ctx->alloc_list;
207 ctx->alloc_list = alloc;
209 lock_basic_unlock(&ctx->cfglock);
214 context_serialize_new_query(struct ctx_query* q, uint32_t* len)
216 /* format for new query is
221 * o rest queryname (string)
224 size_t slen = strlen(q->res->qname) + 1/*end of string*/;
225 *len = sizeof(uint32_t)*4 + slen;
226 p = (uint8_t*)malloc(*len);
228 sldns_write_uint32(p, UB_LIBCMD_NEWQUERY);
229 sldns_write_uint32(p+sizeof(uint32_t), (uint32_t)q->querynum);
230 sldns_write_uint32(p+2*sizeof(uint32_t), (uint32_t)q->res->qtype);
231 sldns_write_uint32(p+3*sizeof(uint32_t), (uint32_t)q->res->qclass);
232 memmove(p+4*sizeof(uint32_t), q->res->qname, slen);
237 context_deserialize_new_query(struct ub_ctx* ctx, uint8_t* p, uint32_t len)
239 struct ctx_query* q = (struct ctx_query*)calloc(1, sizeof(*q));
241 if(len < 4*sizeof(uint32_t)+1) {
245 log_assert( sldns_read_uint32(p) == UB_LIBCMD_NEWQUERY);
246 q->querynum = (int)sldns_read_uint32(p+sizeof(uint32_t));
247 q->node.key = &q->querynum;
249 q->res = (struct ub_result*)calloc(1, sizeof(*q->res));
254 q->res->qtype = (int)sldns_read_uint32(p+2*sizeof(uint32_t));
255 q->res->qclass = (int)sldns_read_uint32(p+3*sizeof(uint32_t));
256 q->res->qname = strdup((char*)(p+4*sizeof(uint32_t)));
263 /** add to query list */
265 (void)rbtree_insert(&ctx->queries, &q->node);
270 context_lookup_new_query(struct ub_ctx* ctx, uint8_t* p, uint32_t len)
274 if(len < 4*sizeof(uint32_t)+1) {
277 log_assert( sldns_read_uint32(p) == UB_LIBCMD_NEWQUERY);
278 querynum = (int)sldns_read_uint32(p+sizeof(uint32_t));
279 q = (struct ctx_query*)rbtree_search(&ctx->queries, &querynum);
283 log_assert(q->async);
288 context_serialize_answer(struct ctx_query* q, int err, sldns_buffer* pkt,
294 * o uint32 error_code
295 * o uint32 msg_security
296 * o uint32 was_ratelimited
297 * o uint32 length of why_bogus string (+1 for eos); 0 absent.
299 * o the remainder is the answer msg from resolver lookup.
300 * remainder can be length 0.
302 size_t size_of_uint32s = 6 * sizeof(uint32_t);
303 size_t pkt_len = pkt?sldns_buffer_remaining(pkt):0;
304 size_t wlen = (pkt&&q->res->why_bogus)?strlen(q->res->why_bogus)+1:0;
306 *len = size_of_uint32s + pkt_len + wlen;
307 p = (uint8_t*)malloc(*len);
309 sldns_write_uint32(p, UB_LIBCMD_ANSWER);
310 sldns_write_uint32(p+sizeof(uint32_t), (uint32_t)q->querynum);
311 sldns_write_uint32(p+2*sizeof(uint32_t), (uint32_t)err);
312 sldns_write_uint32(p+3*sizeof(uint32_t), (uint32_t)q->msg_security);
313 sldns_write_uint32(p+4*sizeof(uint32_t), (uint32_t)q->res->was_ratelimited);
314 sldns_write_uint32(p+5*sizeof(uint32_t), (uint32_t)wlen);
316 memmove(p+size_of_uint32s, q->res->why_bogus, wlen);
318 memmove(p+size_of_uint32s+wlen,
319 sldns_buffer_begin(pkt), pkt_len);
324 context_deserialize_answer(struct ub_ctx* ctx,
325 uint8_t* p, uint32_t len, int* err)
327 size_t size_of_uint32s = 6 * sizeof(uint32_t);
328 struct ctx_query* q = NULL ;
331 if(len < size_of_uint32s) return NULL;
332 log_assert( sldns_read_uint32(p) == UB_LIBCMD_ANSWER);
333 id = (int)sldns_read_uint32(p+sizeof(uint32_t));
334 q = (struct ctx_query*)rbtree_search(&ctx->queries, &id);
336 *err = (int)sldns_read_uint32(p+2*sizeof(uint32_t));
337 q->msg_security = sldns_read_uint32(p+3*sizeof(uint32_t));
338 q->res->was_ratelimited = (int)sldns_read_uint32(p+4*sizeof(uint32_t));
339 wlen = (size_t)sldns_read_uint32(p+5*sizeof(uint32_t));
340 if(len > size_of_uint32s && wlen > 0) {
341 if(len >= size_of_uint32s+wlen)
342 q->res->why_bogus = (char*)memdup(
343 p+size_of_uint32s, wlen);
344 if(!q->res->why_bogus) {
345 /* pass malloc failure to the user callback */
350 q->res->why_bogus[wlen-1] = 0; /* zero terminated for sure */
352 if(len > size_of_uint32s+wlen) {
353 q->msg_len = len - size_of_uint32s - wlen;
354 q->msg = (uint8_t*)memdup(p+size_of_uint32s+wlen,
357 /* pass malloc failure to the user callback */
367 context_serialize_cancel(struct ctx_query* q, uint32_t* len)
371 * o uint32 async-id */
372 uint8_t* p = (uint8_t*)reallocarray(NULL, sizeof(uint32_t), 2);
374 *len = 2*sizeof(uint32_t);
375 sldns_write_uint32(p, UB_LIBCMD_CANCEL);
376 sldns_write_uint32(p+sizeof(uint32_t), (uint32_t)q->querynum);
380 struct ctx_query* context_deserialize_cancel(struct ub_ctx* ctx,
381 uint8_t* p, uint32_t len)
385 if(len != 2*sizeof(uint32_t)) return NULL;
386 log_assert( sldns_read_uint32(p) == UB_LIBCMD_CANCEL);
387 id = (int)sldns_read_uint32(p+sizeof(uint32_t));
388 q = (struct ctx_query*)rbtree_search(&ctx->queries, &id);
393 context_serialize_quit(uint32_t* len)
395 uint32_t* p = (uint32_t*)malloc(sizeof(uint32_t));
398 *len = sizeof(uint32_t);
399 sldns_write_uint32(p, UB_LIBCMD_QUIT);
403 enum ub_ctx_cmd context_serial_getcmd(uint8_t* p, uint32_t len)
406 if((size_t)len < sizeof(v))
407 return UB_LIBCMD_QUIT;
408 v = sldns_read_uint32(p);