xref: /freebsd/contrib/unbound/util/fptr_wlist.c (revision 0957b409)
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 	return 0;
131 }
132 
133 int
134 fptr_whitelist_comm_signal(void (*fptr)(int, void*))
135 {
136 	if(fptr == &worker_sighandler) return 1;
137 	return 0;
138 }
139 
140 int fptr_whitelist_start_accept(void (*fptr)(void*))
141 {
142 	if(fptr == &worker_start_accept) return 1;
143 	return 0;
144 }
145 
146 int fptr_whitelist_stop_accept(void (*fptr)(void*))
147 {
148 	if(fptr == &worker_stop_accept) return 1;
149 	return 0;
150 }
151 
152 int
153 fptr_whitelist_event(void (*fptr)(int, short, void *))
154 {
155 	if(fptr == &comm_point_udp_callback) return 1;
156 	else if(fptr == &comm_point_udp_ancil_callback) return 1;
157 	else if(fptr == &comm_point_tcp_accept_callback) return 1;
158 	else if(fptr == &comm_point_tcp_handle_callback) return 1;
159 	else if(fptr == &comm_timer_callback) return 1;
160 	else if(fptr == &comm_signal_callback) return 1;
161 	else if(fptr == &comm_point_local_handle_callback) return 1;
162 	else if(fptr == &comm_point_raw_handle_callback) return 1;
163 	else if(fptr == &tube_handle_signal) return 1;
164 	else if(fptr == &comm_base_handle_slow_accept) return 1;
165 	else if(fptr == &comm_point_http_handle_callback) return 1;
166 #ifdef UB_ON_WINDOWS
167 	else if(fptr == &worker_win_stop_cb) return 1;
168 #endif
169 	return 0;
170 }
171 
172 int
173 fptr_whitelist_pending_udp(comm_point_callback_type *fptr)
174 {
175 	if(fptr == &serviced_udp_callback) return 1;
176 	else if(fptr == &worker_handle_reply) return 1;
177 	else if(fptr == &libworker_handle_reply) return 1;
178 	return 0;
179 }
180 
181 int
182 fptr_whitelist_pending_tcp(comm_point_callback_type *fptr)
183 {
184 	if(fptr == &serviced_tcp_callback) return 1;
185 	else if(fptr == &worker_handle_reply) return 1;
186 	else if(fptr == &libworker_handle_reply) return 1;
187 	return 0;
188 }
189 
190 int
191 fptr_whitelist_serviced_query(comm_point_callback_type *fptr)
192 {
193 	if(fptr == &worker_handle_service_reply) return 1;
194 	else if(fptr == &libworker_handle_service_reply) return 1;
195 	return 0;
196 }
197 
198 int
199 fptr_whitelist_rbtree_cmp(int (*fptr) (const void *, const void *))
200 {
201 	if(fptr == &mesh_state_compare) return 1;
202 	else if(fptr == &mesh_state_ref_compare) return 1;
203 	else if(fptr == &addr_tree_compare) return 1;
204 	else if(fptr == &local_zone_cmp) return 1;
205 	else if(fptr == &local_data_cmp) return 1;
206 	else if(fptr == &fwd_cmp) return 1;
207 	else if(fptr == &pending_cmp) return 1;
208 	else if(fptr == &serviced_cmp) return 1;
209 	else if(fptr == &name_tree_compare) return 1;
210 	else if(fptr == &order_lock_cmp) return 1;
211 	else if(fptr == &codeline_cmp) return 1;
212 	else if(fptr == &nsec3_hash_cmp) return 1;
213 	else if(fptr == &mini_ev_cmp) return 1;
214 	else if(fptr == &anchor_cmp) return 1;
215 	else if(fptr == &canonical_tree_compare) return 1;
216 	else if(fptr == &context_query_cmp) return 1;
217 	else if(fptr == &val_neg_data_compare) return 1;
218 	else if(fptr == &val_neg_zone_compare) return 1;
219 	else if(fptr == &probetree_cmp) return 1;
220 	else if(fptr == &replay_var_compare) return 1;
221 	else if(fptr == &view_cmp) return 1;
222 	else if(fptr == &auth_zone_cmp) return 1;
223 	else if(fptr == &auth_data_cmp) return 1;
224 	else if(fptr == &auth_xfer_cmp) return 1;
225 	return 0;
226 }
227 
228 int
229 fptr_whitelist_hash_sizefunc(lruhash_sizefunc_type fptr)
230 {
231 	if(fptr == &msgreply_sizefunc) return 1;
232 	else if(fptr == &ub_rrset_sizefunc) return 1;
233 	else if(fptr == &infra_sizefunc) return 1;
234 	else if(fptr == &key_entry_sizefunc) return 1;
235 	else if(fptr == &rate_sizefunc) return 1;
236 	else if(fptr == &ip_rate_sizefunc) return 1;
237 	else if(fptr == &test_slabhash_sizefunc) return 1;
238 #ifdef CLIENT_SUBNET
239 	else if(fptr == &msg_cache_sizefunc) return 1;
240 #endif
241 #ifdef USE_DNSCRYPT
242 	else if(fptr == &dnsc_shared_secrets_sizefunc) return 1;
243 	else if(fptr == &dnsc_nonces_sizefunc) return 1;
244 #endif
245 	return 0;
246 }
247 
248 int
249 fptr_whitelist_hash_compfunc(lruhash_compfunc_type fptr)
250 {
251 	if(fptr == &query_info_compare) return 1;
252 	else if(fptr == &ub_rrset_compare) return 1;
253 	else if(fptr == &infra_compfunc) return 1;
254 	else if(fptr == &key_entry_compfunc) return 1;
255 	else if(fptr == &rate_compfunc) return 1;
256 	else if(fptr == &ip_rate_compfunc) return 1;
257 	else if(fptr == &test_slabhash_compfunc) return 1;
258 #ifdef USE_DNSCRYPT
259 	else if(fptr == &dnsc_shared_secrets_compfunc) return 1;
260 	else if(fptr == &dnsc_nonces_compfunc) return 1;
261 #endif
262 	return 0;
263 }
264 
265 int
266 fptr_whitelist_hash_delkeyfunc(lruhash_delkeyfunc_type fptr)
267 {
268 	if(fptr == &query_entry_delete) return 1;
269 	else if(fptr == &ub_rrset_key_delete) return 1;
270 	else if(fptr == &infra_delkeyfunc) return 1;
271 	else if(fptr == &key_entry_delkeyfunc) return 1;
272 	else if(fptr == &rate_delkeyfunc) return 1;
273 	else if(fptr == &ip_rate_delkeyfunc) return 1;
274 	else if(fptr == &test_slabhash_delkey) return 1;
275 #ifdef USE_DNSCRYPT
276 	else if(fptr == &dnsc_shared_secrets_delkeyfunc) return 1;
277 	else if(fptr == &dnsc_nonces_delkeyfunc) return 1;
278 #endif
279 	return 0;
280 }
281 
282 int
283 fptr_whitelist_hash_deldatafunc(lruhash_deldatafunc_type fptr)
284 {
285 	if(fptr == &reply_info_delete) return 1;
286 	else if(fptr == &rrset_data_delete) return 1;
287 	else if(fptr == &infra_deldatafunc) return 1;
288 	else if(fptr == &key_entry_deldatafunc) return 1;
289 	else if(fptr == &rate_deldatafunc) return 1;
290 	else if(fptr == &test_slabhash_deldata) return 1;
291 #ifdef CLIENT_SUBNET
292 	else if(fptr == &subnet_data_delete) return 1;
293 #endif
294 #ifdef USE_DNSCRYPT
295 	else if(fptr == &dnsc_shared_secrets_deldatafunc) return 1;
296 	else if(fptr == &dnsc_nonces_deldatafunc) return 1;
297 #endif
298 	return 0;
299 }
300 
301 int
302 fptr_whitelist_hash_markdelfunc(lruhash_markdelfunc_type fptr)
303 {
304 	if(fptr == NULL) return 1;
305 	else if(fptr == &rrset_markdel) return 1;
306 	return 0;
307 }
308 
309 /** whitelist env->send_query callbacks */
310 int
311 fptr_whitelist_modenv_send_query(struct outbound_entry* (*fptr)(
312 	struct query_info* qinfo, uint16_t flags, int dnssec, int want_dnssec,
313 	int nocaps, struct sockaddr_storage* addr, socklen_t addrlen,
314 	uint8_t* zone, size_t zonelen, int ssl_upstream, char* tls_auth_name,
315 	struct module_qstate* q))
316 {
317 	if(fptr == &worker_send_query) return 1;
318 	else if(fptr == &libworker_send_query) return 1;
319 	return 0;
320 }
321 
322 int
323 fptr_whitelist_modenv_detach_subs(void (*fptr)(
324         struct module_qstate* qstate))
325 {
326 	if(fptr == &mesh_detach_subs) return 1;
327 	return 0;
328 }
329 
330 int
331 fptr_whitelist_modenv_attach_sub(int (*fptr)(
332         struct module_qstate* qstate, struct query_info* qinfo,
333         uint16_t qflags, int prime, int valrec, struct module_qstate** newq))
334 {
335 	if(fptr == &mesh_attach_sub) return 1;
336 	return 0;
337 }
338 
339 int
340 fptr_whitelist_modenv_add_sub(int (*fptr)(
341         struct module_qstate* qstate, struct query_info* qinfo,
342         uint16_t qflags, int prime, int valrec, struct module_qstate** newq,
343 	struct mesh_state** sub))
344 {
345 	if(fptr == &mesh_add_sub) return 1;
346 	return 0;
347 }
348 
349 int
350 fptr_whitelist_modenv_kill_sub(void (*fptr)(struct module_qstate* newq))
351 {
352 	if(fptr == &mesh_state_delete) return 1;
353 	return 0;
354 }
355 
356 int
357 fptr_whitelist_modenv_detect_cycle(int (*fptr)(
358 	struct module_qstate* qstate, struct query_info* qinfo,
359 	uint16_t flags, int prime, int valrec))
360 {
361 	if(fptr == &mesh_detect_cycle) return 1;
362 	return 0;
363 }
364 
365 int
366 fptr_whitelist_mod_init(int (*fptr)(struct module_env* env, int id))
367 {
368 	if(fptr == &iter_init) return 1;
369 	else if(fptr == &val_init) return 1;
370 	else if(fptr == &dns64_init) return 1;
371 	else if(fptr == &respip_init) return 1;
372 #ifdef WITH_PYTHONMODULE
373 	else if(fptr == &pythonmod_init) return 1;
374 #endif
375 #ifdef USE_CACHEDB
376 	else if(fptr == &cachedb_init) return 1;
377 #endif
378 #ifdef USE_IPSECMOD
379 	else if(fptr == &ipsecmod_init) return 1;
380 #endif
381 #ifdef CLIENT_SUBNET
382 	else if(fptr == &subnetmod_init) return 1;
383 #endif
384 	return 0;
385 }
386 
387 int
388 fptr_whitelist_mod_deinit(void (*fptr)(struct module_env* env, int id))
389 {
390 	if(fptr == &iter_deinit) return 1;
391 	else if(fptr == &val_deinit) return 1;
392 	else if(fptr == &dns64_deinit) return 1;
393 	else if(fptr == &respip_deinit) return 1;
394 #ifdef WITH_PYTHONMODULE
395 	else if(fptr == &pythonmod_deinit) return 1;
396 #endif
397 #ifdef USE_CACHEDB
398 	else if(fptr == &cachedb_deinit) return 1;
399 #endif
400 #ifdef USE_IPSECMOD
401 	else if(fptr == &ipsecmod_deinit) return 1;
402 #endif
403 #ifdef CLIENT_SUBNET
404 	else if(fptr == &subnetmod_deinit) return 1;
405 #endif
406 	return 0;
407 }
408 
409 int
410 fptr_whitelist_mod_operate(void (*fptr)(struct module_qstate* qstate,
411         enum module_ev event, int id, struct outbound_entry* outbound))
412 {
413 	if(fptr == &iter_operate) return 1;
414 	else if(fptr == &val_operate) return 1;
415 	else if(fptr == &dns64_operate) return 1;
416 	else if(fptr == &respip_operate) return 1;
417 #ifdef WITH_PYTHONMODULE
418 	else if(fptr == &pythonmod_operate) return 1;
419 #endif
420 #ifdef USE_CACHEDB
421 	else if(fptr == &cachedb_operate) return 1;
422 #endif
423 #ifdef USE_IPSECMOD
424 	else if(fptr == &ipsecmod_operate) return 1;
425 #endif
426 #ifdef CLIENT_SUBNET
427 	else if(fptr == &subnetmod_operate) return 1;
428 #endif
429 	return 0;
430 }
431 
432 int
433 fptr_whitelist_mod_inform_super(void (*fptr)(
434         struct module_qstate* qstate, int id, struct module_qstate* super))
435 {
436 	if(fptr == &iter_inform_super) return 1;
437 	else if(fptr == &val_inform_super) return 1;
438 	else if(fptr == &dns64_inform_super) return 1;
439 	else if(fptr == &respip_inform_super) return 1;
440 #ifdef WITH_PYTHONMODULE
441 	else if(fptr == &pythonmod_inform_super) return 1;
442 #endif
443 #ifdef USE_CACHEDB
444 	else if(fptr == &cachedb_inform_super) return 1;
445 #endif
446 #ifdef USE_IPSECMOD
447 	else if(fptr == &ipsecmod_inform_super) return 1;
448 #endif
449 #ifdef CLIENT_SUBNET
450 	else if(fptr == &subnetmod_inform_super) return 1;
451 #endif
452 	return 0;
453 }
454 
455 int
456 fptr_whitelist_mod_clear(void (*fptr)(struct module_qstate* qstate,
457         int id))
458 {
459 	if(fptr == &iter_clear) return 1;
460 	else if(fptr == &val_clear) return 1;
461 	else if(fptr == &dns64_clear) return 1;
462 	else if(fptr == &respip_clear) return 1;
463 #ifdef WITH_PYTHONMODULE
464 	else if(fptr == &pythonmod_clear) return 1;
465 #endif
466 #ifdef USE_CACHEDB
467 	else if(fptr == &cachedb_clear) return 1;
468 #endif
469 #ifdef USE_IPSECMOD
470 	else if(fptr == &ipsecmod_clear) return 1;
471 #endif
472 #ifdef CLIENT_SUBNET
473 	else if(fptr == &subnetmod_clear) return 1;
474 #endif
475 	return 0;
476 }
477 
478 int
479 fptr_whitelist_mod_get_mem(size_t (*fptr)(struct module_env* env, int id))
480 {
481 	if(fptr == &iter_get_mem) return 1;
482 	else if(fptr == &val_get_mem) return 1;
483 	else if(fptr == &dns64_get_mem) return 1;
484 	else if(fptr == &respip_get_mem) return 1;
485 #ifdef WITH_PYTHONMODULE
486 	else if(fptr == &pythonmod_get_mem) return 1;
487 #endif
488 #ifdef USE_CACHEDB
489 	else if(fptr == &cachedb_get_mem) return 1;
490 #endif
491 #ifdef USE_IPSECMOD
492 	else if(fptr == &ipsecmod_get_mem) return 1;
493 #endif
494 #ifdef CLIENT_SUBNET
495 	else if(fptr == &subnetmod_get_mem) return 1;
496 #endif
497 	return 0;
498 }
499 
500 int
501 fptr_whitelist_alloc_cleanup(void (*fptr)(void*))
502 {
503 	if(fptr == &worker_alloc_cleanup) return 1;
504 	return 0;
505 }
506 
507 int fptr_whitelist_tube_listen(tube_callback_type* fptr)
508 {
509 	if(fptr == &worker_handle_control_cmd) return 1;
510 	else if(fptr == &libworker_handle_control_cmd) return 1;
511 	return 0;
512 }
513 
514 int fptr_whitelist_mesh_cb(mesh_cb_func_type fptr)
515 {
516 	if(fptr == &libworker_fg_done_cb) return 1;
517 	else if(fptr == &libworker_bg_done_cb) return 1;
518 	else if(fptr == &libworker_event_done_cb) return 1;
519 	else if(fptr == &probe_answer_cb) return 1;
520 	else if(fptr == &auth_xfer_probe_lookup_callback) return 1;
521 	else if(fptr == &auth_xfer_transfer_lookup_callback) return 1;
522 	return 0;
523 }
524 
525 int fptr_whitelist_print_func(void (*fptr)(char*,void*))
526 {
527 	if(fptr == &config_print_func) return 1;
528 	else if(fptr == &config_collate_func) return 1;
529 	else if(fptr == &remote_get_opt_ssl) return 1;
530 	return 0;
531 }
532 
533 int fptr_whitelist_inplace_cb_reply_generic(inplace_cb_reply_func_type* fptr,
534 	enum inplace_cb_list_type type)
535 {
536 #ifndef WITH_PYTHONMODULE
537 	(void)fptr;
538 #endif
539 	if(type == inplace_cb_reply) {
540 #ifdef WITH_PYTHONMODULE
541 		if(fptr == &python_inplace_cb_reply_generic) return 1;
542 #endif
543 	} else if(type == inplace_cb_reply_cache) {
544 #ifdef WITH_PYTHONMODULE
545 		if(fptr == &python_inplace_cb_reply_generic) return 1;
546 #endif
547 	} else if(type == inplace_cb_reply_local) {
548 #ifdef WITH_PYTHONMODULE
549 		if(fptr == &python_inplace_cb_reply_generic) return 1;
550 #endif
551 	} else if(type == inplace_cb_reply_servfail) {
552 #ifdef WITH_PYTHONMODULE
553 		if(fptr == &python_inplace_cb_reply_generic) return 1;
554 #endif
555 	}
556 	return 0;
557 }
558 
559 int fptr_whitelist_inplace_cb_query(inplace_cb_query_func_type* fptr)
560 {
561 #ifdef CLIENT_SUBNET
562 	if(fptr == &ecs_whitelist_check)
563 		return 1;
564 #else
565 	(void)fptr;
566 #endif
567 	return 0;
568 }
569 
570 int fptr_whitelist_inplace_cb_edns_back_parsed(
571 	inplace_cb_edns_back_parsed_func_type* fptr)
572 {
573 #ifdef CLIENT_SUBNET
574 	if(fptr == &ecs_edns_back_parsed)
575 		return 1;
576 #else
577 	(void)fptr;
578 #endif
579 	return 0;
580 }
581 
582 int fptr_whitelist_inplace_cb_query_response(
583 	inplace_cb_query_response_func_type* fptr)
584 {
585 #ifdef CLIENT_SUBNET
586 	if(fptr == &ecs_query_response)
587 		return 1;
588 #else
589 	(void)fptr;
590 #endif
591 	return 0;
592 }
593