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