xref: /freebsd/contrib/unbound/util/fptr_wlist.c (revision 0bd5d367989b3d2de0e8d8ceaa2e31d3f0d96536)
1 /*
2  * util/fptr_wlist.c - function pointer whitelists.
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 that check function pointers.
40  * The functions contain a whitelist of known good callback values.
41  * Any other values lead to an error.
42  *
43  * Due to the listing nature, this file violates all the modularization
44  * boundaries in the program.
45  */
46 #include "config.h"
47 #include "util/fptr_wlist.h"
48 #include "util/mini_event.h"
49 #include "services/outside_network.h"
50 #include "services/mesh.h"
51 #include "services/localzone.h"
52 #include "services/authzone.h"
53 #include "services/cache/infra.h"
54 #include "services/cache/rrset.h"
55 #include "services/view.h"
56 #include "dns64/dns64.h"
57 #include "iterator/iterator.h"
58 #include "iterator/iter_fwd.h"
59 #include "validator/validator.h"
60 #include "validator/val_anchor.h"
61 #include "validator/val_nsec3.h"
62 #include "validator/val_sigcrypt.h"
63 #include "validator/val_kentry.h"
64 #include "validator/val_neg.h"
65 #include "validator/autotrust.h"
66 #include "util/data/msgreply.h"
67 #include "util/data/packed_rrset.h"
68 #include "util/storage/slabhash.h"
69 #include "util/storage/dnstree.h"
70 #include "util/locks.h"
71 #include "libunbound/libworker.h"
72 #include "libunbound/context.h"
73 #include "libunbound/worker.h"
74 #include "util/tube.h"
75 #include "util/config_file.h"
76 #ifdef UB_ON_WINDOWS
77 #include "winrc/win_svc.h"
78 #endif
79 #include "respip/respip.h"
80 
81 #ifdef WITH_PYTHONMODULE
82 #include "pythonmod/pythonmod.h"
83 #endif
84 #ifdef USE_CACHEDB
85 #include "cachedb/cachedb.h"
86 #endif
87 #ifdef USE_IPSECMOD
88 #include "ipsecmod/ipsecmod.h"
89 #endif
90 #ifdef CLIENT_SUBNET
91 #include "edns-subnet/subnetmod.h"
92 #endif
93 
94 int
95 fptr_whitelist_comm_point(comm_point_callback_type *fptr)
96 {
97 	if(fptr == &worker_handle_request) return 1;
98 	else if(fptr == &outnet_udp_cb) return 1;
99 	else if(fptr == &outnet_tcp_cb) return 1;
100 	else if(fptr == &tube_handle_listen) return 1;
101 	else if(fptr == &auth_xfer_probe_udp_callback) return 1;
102 	else if(fptr == &auth_xfer_transfer_tcp_callback) return 1;
103 	else if(fptr == &auth_xfer_transfer_http_callback) return 1;
104 	return 0;
105 }
106 
107 int
108 fptr_whitelist_comm_point_raw(comm_point_callback_type *fptr)
109 {
110 	if(fptr == &tube_handle_listen) return 1;
111 	else if(fptr == &tube_handle_write) return 1;
112 	else if(fptr == &remote_accept_callback) return 1;
113 	else if(fptr == &remote_control_callback) return 1;
114 	return 0;
115 }
116 
117 int
118 fptr_whitelist_comm_timer(void (*fptr)(void*))
119 {
120 	if(fptr == &pending_udp_timer_cb) return 1;
121 	else if(fptr == &outnet_tcptimer) return 1;
122 	else if(fptr == &pending_udp_timer_delay_cb) return 1;
123 	else if(fptr == &worker_stat_timer_cb) return 1;
124 	else if(fptr == &worker_probe_timer_cb) return 1;
125 #ifdef UB_ON_WINDOWS
126 	else if(fptr == &wsvc_cron_cb) return 1;
127 #endif
128 	else if(fptr == &auth_xfer_timer) return 1;
129 	else if(fptr == &auth_xfer_probe_timer_callback) return 1;
130 	else if(fptr == &auth_xfer_transfer_timer_callback) return 1;
131 	return 0;
132 }
133 
134 int
135 fptr_whitelist_comm_signal(void (*fptr)(int, void*))
136 {
137 	if(fptr == &worker_sighandler) return 1;
138 	return 0;
139 }
140 
141 int fptr_whitelist_start_accept(void (*fptr)(void*))
142 {
143 	if(fptr == &worker_start_accept) return 1;
144 	return 0;
145 }
146 
147 int fptr_whitelist_stop_accept(void (*fptr)(void*))
148 {
149 	if(fptr == &worker_stop_accept) return 1;
150 	return 0;
151 }
152 
153 int
154 fptr_whitelist_event(void (*fptr)(int, short, void *))
155 {
156 	if(fptr == &comm_point_udp_callback) return 1;
157 	else if(fptr == &comm_point_udp_ancil_callback) return 1;
158 	else if(fptr == &comm_point_tcp_accept_callback) return 1;
159 	else if(fptr == &comm_point_tcp_handle_callback) return 1;
160 	else if(fptr == &comm_timer_callback) return 1;
161 	else if(fptr == &comm_signal_callback) return 1;
162 	else if(fptr == &comm_point_local_handle_callback) return 1;
163 	else if(fptr == &comm_point_raw_handle_callback) return 1;
164 	else if(fptr == &tube_handle_signal) return 1;
165 	else if(fptr == &comm_base_handle_slow_accept) return 1;
166 	else if(fptr == &comm_point_http_handle_callback) return 1;
167 #ifdef UB_ON_WINDOWS
168 	else if(fptr == &worker_win_stop_cb) return 1;
169 #endif
170 	return 0;
171 }
172 
173 int
174 fptr_whitelist_pending_udp(comm_point_callback_type *fptr)
175 {
176 	if(fptr == &serviced_udp_callback) return 1;
177 	else if(fptr == &worker_handle_reply) return 1;
178 	else if(fptr == &libworker_handle_reply) return 1;
179 	return 0;
180 }
181 
182 int
183 fptr_whitelist_pending_tcp(comm_point_callback_type *fptr)
184 {
185 	if(fptr == &serviced_tcp_callback) return 1;
186 	else if(fptr == &worker_handle_reply) return 1;
187 	else if(fptr == &libworker_handle_reply) return 1;
188 	return 0;
189 }
190 
191 int
192 fptr_whitelist_serviced_query(comm_point_callback_type *fptr)
193 {
194 	if(fptr == &worker_handle_service_reply) return 1;
195 	else if(fptr == &libworker_handle_service_reply) return 1;
196 	return 0;
197 }
198 
199 int
200 fptr_whitelist_rbtree_cmp(int (*fptr) (const void *, const void *))
201 {
202 	if(fptr == &mesh_state_compare) return 1;
203 	else if(fptr == &mesh_state_ref_compare) return 1;
204 	else if(fptr == &addr_tree_compare) return 1;
205 	else if(fptr == &local_zone_cmp) return 1;
206 	else if(fptr == &local_data_cmp) return 1;
207 	else if(fptr == &fwd_cmp) return 1;
208 	else if(fptr == &pending_cmp) return 1;
209 	else if(fptr == &serviced_cmp) return 1;
210 	else if(fptr == &name_tree_compare) return 1;
211 	else if(fptr == &order_lock_cmp) return 1;
212 	else if(fptr == &codeline_cmp) return 1;
213 	else if(fptr == &nsec3_hash_cmp) return 1;
214 	else if(fptr == &mini_ev_cmp) return 1;
215 	else if(fptr == &anchor_cmp) return 1;
216 	else if(fptr == &canonical_tree_compare) return 1;
217 	else if(fptr == &context_query_cmp) return 1;
218 	else if(fptr == &val_neg_data_compare) return 1;
219 	else if(fptr == &val_neg_zone_compare) return 1;
220 	else if(fptr == &probetree_cmp) return 1;
221 	else if(fptr == &replay_var_compare) return 1;
222 	else if(fptr == &view_cmp) return 1;
223 	else if(fptr == &auth_zone_cmp) return 1;
224 	else if(fptr == &auth_data_cmp) return 1;
225 	else if(fptr == &auth_xfer_cmp) return 1;
226 	return 0;
227 }
228 
229 int
230 fptr_whitelist_hash_sizefunc(lruhash_sizefunc_type fptr)
231 {
232 	if(fptr == &msgreply_sizefunc) return 1;
233 	else if(fptr == &ub_rrset_sizefunc) return 1;
234 	else if(fptr == &infra_sizefunc) return 1;
235 	else if(fptr == &key_entry_sizefunc) return 1;
236 	else if(fptr == &rate_sizefunc) return 1;
237 	else if(fptr == &ip_rate_sizefunc) return 1;
238 	else if(fptr == &test_slabhash_sizefunc) return 1;
239 #ifdef CLIENT_SUBNET
240 	else if(fptr == &msg_cache_sizefunc) return 1;
241 #endif
242 #ifdef USE_DNSCRYPT
243 	else if(fptr == &dnsc_shared_secrets_sizefunc) return 1;
244 	else if(fptr == &dnsc_nonces_sizefunc) return 1;
245 #endif
246 	return 0;
247 }
248 
249 int
250 fptr_whitelist_hash_compfunc(lruhash_compfunc_type fptr)
251 {
252 	if(fptr == &query_info_compare) return 1;
253 	else if(fptr == &ub_rrset_compare) return 1;
254 	else if(fptr == &infra_compfunc) return 1;
255 	else if(fptr == &key_entry_compfunc) return 1;
256 	else if(fptr == &rate_compfunc) return 1;
257 	else if(fptr == &ip_rate_compfunc) return 1;
258 	else if(fptr == &test_slabhash_compfunc) return 1;
259 #ifdef USE_DNSCRYPT
260 	else if(fptr == &dnsc_shared_secrets_compfunc) return 1;
261 	else if(fptr == &dnsc_nonces_compfunc) return 1;
262 #endif
263 	return 0;
264 }
265 
266 int
267 fptr_whitelist_hash_delkeyfunc(lruhash_delkeyfunc_type fptr)
268 {
269 	if(fptr == &query_entry_delete) return 1;
270 	else if(fptr == &ub_rrset_key_delete) return 1;
271 	else if(fptr == &infra_delkeyfunc) return 1;
272 	else if(fptr == &key_entry_delkeyfunc) return 1;
273 	else if(fptr == &rate_delkeyfunc) return 1;
274 	else if(fptr == &ip_rate_delkeyfunc) return 1;
275 	else if(fptr == &test_slabhash_delkey) return 1;
276 #ifdef USE_DNSCRYPT
277 	else if(fptr == &dnsc_shared_secrets_delkeyfunc) return 1;
278 	else if(fptr == &dnsc_nonces_delkeyfunc) return 1;
279 #endif
280 	return 0;
281 }
282 
283 int
284 fptr_whitelist_hash_deldatafunc(lruhash_deldatafunc_type fptr)
285 {
286 	if(fptr == &reply_info_delete) return 1;
287 	else if(fptr == &rrset_data_delete) return 1;
288 	else if(fptr == &infra_deldatafunc) return 1;
289 	else if(fptr == &key_entry_deldatafunc) return 1;
290 	else if(fptr == &rate_deldatafunc) return 1;
291 	else if(fptr == &test_slabhash_deldata) return 1;
292 #ifdef CLIENT_SUBNET
293 	else if(fptr == &subnet_data_delete) return 1;
294 #endif
295 #ifdef USE_DNSCRYPT
296 	else if(fptr == &dnsc_shared_secrets_deldatafunc) return 1;
297 	else if(fptr == &dnsc_nonces_deldatafunc) return 1;
298 #endif
299 	return 0;
300 }
301 
302 int
303 fptr_whitelist_hash_markdelfunc(lruhash_markdelfunc_type fptr)
304 {
305 	if(fptr == NULL) return 1;
306 	else if(fptr == &rrset_markdel) return 1;
307 #ifdef CLIENT_SUBNET
308 	else if(fptr == &subnet_markdel) return 1;
309 #endif
310 	return 0;
311 }
312 
313 /** whitelist env->send_query callbacks */
314 int
315 fptr_whitelist_modenv_send_query(struct outbound_entry* (*fptr)(
316 	struct query_info* qinfo, uint16_t flags, int dnssec, int want_dnssec,
317 	int nocaps, struct sockaddr_storage* addr, socklen_t addrlen,
318 	uint8_t* zone, size_t zonelen, int ssl_upstream, char* tls_auth_name,
319 	struct module_qstate* q))
320 {
321 	if(fptr == &worker_send_query) return 1;
322 	else if(fptr == &libworker_send_query) return 1;
323 	return 0;
324 }
325 
326 int
327 fptr_whitelist_modenv_detach_subs(void (*fptr)(
328         struct module_qstate* qstate))
329 {
330 	if(fptr == &mesh_detach_subs) return 1;
331 	return 0;
332 }
333 
334 int
335 fptr_whitelist_modenv_attach_sub(int (*fptr)(
336         struct module_qstate* qstate, struct query_info* qinfo,
337         uint16_t qflags, int prime, int valrec, struct module_qstate** newq))
338 {
339 	if(fptr == &mesh_attach_sub) return 1;
340 	return 0;
341 }
342 
343 int
344 fptr_whitelist_modenv_add_sub(int (*fptr)(
345         struct module_qstate* qstate, struct query_info* qinfo,
346         uint16_t qflags, int prime, int valrec, struct module_qstate** newq,
347 	struct mesh_state** sub))
348 {
349 	if(fptr == &mesh_add_sub) return 1;
350 	return 0;
351 }
352 
353 int
354 fptr_whitelist_modenv_kill_sub(void (*fptr)(struct module_qstate* newq))
355 {
356 	if(fptr == &mesh_state_delete) return 1;
357 	return 0;
358 }
359 
360 int
361 fptr_whitelist_modenv_detect_cycle(int (*fptr)(
362 	struct module_qstate* qstate, struct query_info* qinfo,
363 	uint16_t flags, int prime, int valrec))
364 {
365 	if(fptr == &mesh_detect_cycle) return 1;
366 	return 0;
367 }
368 
369 int
370 fptr_whitelist_mod_init(int (*fptr)(struct module_env* env, int id))
371 {
372 	if(fptr == &iter_init) return 1;
373 	else if(fptr == &val_init) return 1;
374 	else if(fptr == &dns64_init) return 1;
375 	else if(fptr == &respip_init) return 1;
376 #ifdef WITH_PYTHONMODULE
377 	else if(fptr == &pythonmod_init) return 1;
378 #endif
379 #ifdef USE_CACHEDB
380 	else if(fptr == &cachedb_init) return 1;
381 #endif
382 #ifdef USE_IPSECMOD
383 	else if(fptr == &ipsecmod_init) return 1;
384 #endif
385 #ifdef CLIENT_SUBNET
386 	else if(fptr == &subnetmod_init) return 1;
387 #endif
388 	return 0;
389 }
390 
391 int
392 fptr_whitelist_mod_deinit(void (*fptr)(struct module_env* env, int id))
393 {
394 	if(fptr == &iter_deinit) return 1;
395 	else if(fptr == &val_deinit) return 1;
396 	else if(fptr == &dns64_deinit) return 1;
397 	else if(fptr == &respip_deinit) return 1;
398 #ifdef WITH_PYTHONMODULE
399 	else if(fptr == &pythonmod_deinit) return 1;
400 #endif
401 #ifdef USE_CACHEDB
402 	else if(fptr == &cachedb_deinit) return 1;
403 #endif
404 #ifdef USE_IPSECMOD
405 	else if(fptr == &ipsecmod_deinit) return 1;
406 #endif
407 #ifdef CLIENT_SUBNET
408 	else if(fptr == &subnetmod_deinit) return 1;
409 #endif
410 	return 0;
411 }
412 
413 int
414 fptr_whitelist_mod_operate(void (*fptr)(struct module_qstate* qstate,
415         enum module_ev event, int id, struct outbound_entry* outbound))
416 {
417 	if(fptr == &iter_operate) return 1;
418 	else if(fptr == &val_operate) return 1;
419 	else if(fptr == &dns64_operate) return 1;
420 	else if(fptr == &respip_operate) return 1;
421 #ifdef WITH_PYTHONMODULE
422 	else if(fptr == &pythonmod_operate) return 1;
423 #endif
424 #ifdef USE_CACHEDB
425 	else if(fptr == &cachedb_operate) return 1;
426 #endif
427 #ifdef USE_IPSECMOD
428 	else if(fptr == &ipsecmod_operate) return 1;
429 #endif
430 #ifdef CLIENT_SUBNET
431 	else if(fptr == &subnetmod_operate) return 1;
432 #endif
433 	return 0;
434 }
435 
436 int
437 fptr_whitelist_mod_inform_super(void (*fptr)(
438         struct module_qstate* qstate, int id, struct module_qstate* super))
439 {
440 	if(fptr == &iter_inform_super) return 1;
441 	else if(fptr == &val_inform_super) return 1;
442 	else if(fptr == &dns64_inform_super) return 1;
443 	else if(fptr == &respip_inform_super) return 1;
444 #ifdef WITH_PYTHONMODULE
445 	else if(fptr == &pythonmod_inform_super) return 1;
446 #endif
447 #ifdef USE_CACHEDB
448 	else if(fptr == &cachedb_inform_super) return 1;
449 #endif
450 #ifdef USE_IPSECMOD
451 	else if(fptr == &ipsecmod_inform_super) return 1;
452 #endif
453 #ifdef CLIENT_SUBNET
454 	else if(fptr == &subnetmod_inform_super) return 1;
455 #endif
456 	return 0;
457 }
458 
459 int
460 fptr_whitelist_mod_clear(void (*fptr)(struct module_qstate* qstate,
461         int id))
462 {
463 	if(fptr == &iter_clear) return 1;
464 	else if(fptr == &val_clear) return 1;
465 	else if(fptr == &dns64_clear) return 1;
466 	else if(fptr == &respip_clear) return 1;
467 #ifdef WITH_PYTHONMODULE
468 	else if(fptr == &pythonmod_clear) return 1;
469 #endif
470 #ifdef USE_CACHEDB
471 	else if(fptr == &cachedb_clear) return 1;
472 #endif
473 #ifdef USE_IPSECMOD
474 	else if(fptr == &ipsecmod_clear) return 1;
475 #endif
476 #ifdef CLIENT_SUBNET
477 	else if(fptr == &subnetmod_clear) return 1;
478 #endif
479 	return 0;
480 }
481 
482 int
483 fptr_whitelist_mod_get_mem(size_t (*fptr)(struct module_env* env, int id))
484 {
485 	if(fptr == &iter_get_mem) return 1;
486 	else if(fptr == &val_get_mem) return 1;
487 	else if(fptr == &dns64_get_mem) return 1;
488 	else if(fptr == &respip_get_mem) return 1;
489 #ifdef WITH_PYTHONMODULE
490 	else if(fptr == &pythonmod_get_mem) return 1;
491 #endif
492 #ifdef USE_CACHEDB
493 	else if(fptr == &cachedb_get_mem) return 1;
494 #endif
495 #ifdef USE_IPSECMOD
496 	else if(fptr == &ipsecmod_get_mem) return 1;
497 #endif
498 #ifdef CLIENT_SUBNET
499 	else if(fptr == &subnetmod_get_mem) return 1;
500 #endif
501 	return 0;
502 }
503 
504 int
505 fptr_whitelist_alloc_cleanup(void (*fptr)(void*))
506 {
507 	if(fptr == &worker_alloc_cleanup) return 1;
508 	return 0;
509 }
510 
511 int fptr_whitelist_tube_listen(tube_callback_type* fptr)
512 {
513 	if(fptr == &worker_handle_control_cmd) return 1;
514 	else if(fptr == &libworker_handle_control_cmd) return 1;
515 	return 0;
516 }
517 
518 int fptr_whitelist_mesh_cb(mesh_cb_func_type fptr)
519 {
520 	if(fptr == &libworker_fg_done_cb) return 1;
521 	else if(fptr == &libworker_bg_done_cb) return 1;
522 	else if(fptr == &libworker_event_done_cb) return 1;
523 	else if(fptr == &probe_answer_cb) return 1;
524 	else if(fptr == &auth_xfer_probe_lookup_callback) return 1;
525 	else if(fptr == &auth_xfer_transfer_lookup_callback) return 1;
526 	return 0;
527 }
528 
529 int fptr_whitelist_print_func(void (*fptr)(char*,void*))
530 {
531 	if(fptr == &config_print_func) return 1;
532 	else if(fptr == &config_collate_func) return 1;
533 	else if(fptr == &remote_get_opt_ssl) return 1;
534 	return 0;
535 }
536 
537 int fptr_whitelist_inplace_cb_reply_generic(inplace_cb_reply_func_type* fptr,
538 	enum inplace_cb_list_type type)
539 {
540 #ifndef WITH_PYTHONMODULE
541 	(void)fptr;
542 #endif
543 	if(type == inplace_cb_reply) {
544 #ifdef WITH_PYTHONMODULE
545 		if(fptr == &python_inplace_cb_reply_generic) return 1;
546 #endif
547 	} else if(type == inplace_cb_reply_cache) {
548 #ifdef WITH_PYTHONMODULE
549 		if(fptr == &python_inplace_cb_reply_generic) return 1;
550 #endif
551 	} else if(type == inplace_cb_reply_local) {
552 #ifdef WITH_PYTHONMODULE
553 		if(fptr == &python_inplace_cb_reply_generic) return 1;
554 #endif
555 	} else if(type == inplace_cb_reply_servfail) {
556 #ifdef WITH_PYTHONMODULE
557 		if(fptr == &python_inplace_cb_reply_generic) return 1;
558 #endif
559 	}
560 	return 0;
561 }
562 
563 int fptr_whitelist_inplace_cb_query(inplace_cb_query_func_type* fptr)
564 {
565 #ifdef CLIENT_SUBNET
566 	if(fptr == &ecs_whitelist_check)
567 		return 1;
568 #endif
569 #ifdef WITH_PYTHONMODULE
570         if(fptr == &python_inplace_cb_query_generic)
571                 return 1;
572 #endif
573 	(void)fptr;
574 	return 0;
575 }
576 
577 int fptr_whitelist_inplace_cb_edns_back_parsed(
578 	inplace_cb_edns_back_parsed_func_type* fptr)
579 {
580 #ifdef CLIENT_SUBNET
581 	if(fptr == &ecs_edns_back_parsed)
582 		return 1;
583 #else
584 	(void)fptr;
585 #endif
586 	return 0;
587 }
588 
589 int fptr_whitelist_inplace_cb_query_response(
590 	inplace_cb_query_response_func_type* fptr)
591 {
592 #ifdef CLIENT_SUBNET
593 	if(fptr == &ecs_query_response)
594 		return 1;
595 #else
596 	(void)fptr;
597 #endif
598 	return 0;
599 }
600