xref: /freebsd/contrib/unbound/util/fptr_wlist.c (revision a0ee8cc636cd5c2374ec44ca71226564ea0bca95)
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/cache/infra.h"
53 #include "services/cache/rrset.h"
54 #include "dns64/dns64.h"
55 #include "iterator/iterator.h"
56 #include "iterator/iter_fwd.h"
57 #include "validator/validator.h"
58 #include "validator/val_anchor.h"
59 #include "validator/val_nsec3.h"
60 #include "validator/val_sigcrypt.h"
61 #include "validator/val_kentry.h"
62 #include "validator/val_neg.h"
63 #include "validator/autotrust.h"
64 #include "util/data/msgreply.h"
65 #include "util/data/packed_rrset.h"
66 #include "util/storage/slabhash.h"
67 #include "util/storage/dnstree.h"
68 #include "util/locks.h"
69 #include "libunbound/libworker.h"
70 #include "libunbound/context.h"
71 #include "libunbound/worker.h"
72 #include "util/tube.h"
73 #include "util/config_file.h"
74 #ifdef UB_ON_WINDOWS
75 #include "winrc/win_svc.h"
76 #endif
77 
78 #ifdef WITH_PYTHONMODULE
79 #include "pythonmod/pythonmod.h"
80 #endif
81 
82 int
83 fptr_whitelist_comm_point(comm_point_callback_t *fptr)
84 {
85 	if(fptr == &worker_handle_request) return 1;
86 	else if(fptr == &outnet_udp_cb) return 1;
87 	else if(fptr == &outnet_tcp_cb) return 1;
88 	else if(fptr == &tube_handle_listen) return 1;
89 	return 0;
90 }
91 
92 int
93 fptr_whitelist_comm_point_raw(comm_point_callback_t *fptr)
94 {
95 	if(fptr == &tube_handle_listen) return 1;
96 	else if(fptr == &tube_handle_write) return 1;
97 	else if(fptr == &remote_accept_callback) return 1;
98 	else if(fptr == &remote_control_callback) return 1;
99 	return 0;
100 }
101 
102 int
103 fptr_whitelist_comm_timer(void (*fptr)(void*))
104 {
105 	if(fptr == &pending_udp_timer_cb) return 1;
106 	else if(fptr == &outnet_tcptimer) return 1;
107 	else if(fptr == &pending_udp_timer_delay_cb) return 1;
108 	else if(fptr == &worker_stat_timer_cb) return 1;
109 	else if(fptr == &worker_probe_timer_cb) return 1;
110 #ifdef UB_ON_WINDOWS
111 	else if(fptr == &wsvc_cron_cb) return 1;
112 #endif
113 	return 0;
114 }
115 
116 int
117 fptr_whitelist_comm_signal(void (*fptr)(int, void*))
118 {
119 	if(fptr == &worker_sighandler) return 1;
120 	return 0;
121 }
122 
123 int fptr_whitelist_start_accept(void (*fptr)(void*))
124 {
125 	if(fptr == &worker_start_accept) return 1;
126 	return 0;
127 }
128 
129 int fptr_whitelist_stop_accept(void (*fptr)(void*))
130 {
131 	if(fptr == &worker_stop_accept) return 1;
132 	return 0;
133 }
134 
135 int
136 fptr_whitelist_event(void (*fptr)(int, short, void *))
137 {
138 	if(fptr == &comm_point_udp_callback) return 1;
139 	else if(fptr == &comm_point_udp_ancil_callback) return 1;
140 	else if(fptr == &comm_point_tcp_accept_callback) return 1;
141 	else if(fptr == &comm_point_tcp_handle_callback) return 1;
142 	else if(fptr == &comm_timer_callback) return 1;
143 	else if(fptr == &comm_signal_callback) return 1;
144 	else if(fptr == &comm_point_local_handle_callback) return 1;
145 	else if(fptr == &comm_point_raw_handle_callback) return 1;
146 	else if(fptr == &tube_handle_signal) return 1;
147 	else if(fptr == &comm_base_handle_slow_accept) return 1;
148 #ifdef UB_ON_WINDOWS
149 	else if(fptr == &worker_win_stop_cb) return 1;
150 #endif
151 	return 0;
152 }
153 
154 int
155 fptr_whitelist_pending_udp(comm_point_callback_t *fptr)
156 {
157 	if(fptr == &serviced_udp_callback) return 1;
158 	else if(fptr == &worker_handle_reply) return 1;
159 	else if(fptr == &libworker_handle_reply) return 1;
160 	return 0;
161 }
162 
163 int
164 fptr_whitelist_pending_tcp(comm_point_callback_t *fptr)
165 {
166 	if(fptr == &serviced_tcp_callback) return 1;
167 	else if(fptr == &worker_handle_reply) return 1;
168 	else if(fptr == &libworker_handle_reply) return 1;
169 	return 0;
170 }
171 
172 int
173 fptr_whitelist_serviced_query(comm_point_callback_t *fptr)
174 {
175 	if(fptr == &worker_handle_service_reply) return 1;
176 	else if(fptr == &libworker_handle_service_reply) return 1;
177 	return 0;
178 }
179 
180 int
181 fptr_whitelist_rbtree_cmp(int (*fptr) (const void *, const void *))
182 {
183 	if(fptr == &mesh_state_compare) return 1;
184 	else if(fptr == &mesh_state_ref_compare) return 1;
185 	else if(fptr == &addr_tree_compare) return 1;
186 	else if(fptr == &local_zone_cmp) return 1;
187 	else if(fptr == &local_data_cmp) return 1;
188 	else if(fptr == &fwd_cmp) return 1;
189 	else if(fptr == &pending_cmp) return 1;
190 	else if(fptr == &serviced_cmp) return 1;
191 	else if(fptr == &name_tree_compare) return 1;
192 	else if(fptr == &order_lock_cmp) return 1;
193 	else if(fptr == &codeline_cmp) return 1;
194 	else if(fptr == &nsec3_hash_cmp) return 1;
195 	else if(fptr == &mini_ev_cmp) return 1;
196 	else if(fptr == &anchor_cmp) return 1;
197 	else if(fptr == &canonical_tree_compare) return 1;
198 	else if(fptr == &context_query_cmp) return 1;
199 	else if(fptr == &val_neg_data_compare) return 1;
200 	else if(fptr == &val_neg_zone_compare) return 1;
201 	else if(fptr == &probetree_cmp) return 1;
202 	else if(fptr == &replay_var_compare) return 1;
203 	return 0;
204 }
205 
206 int
207 fptr_whitelist_hash_sizefunc(lruhash_sizefunc_t fptr)
208 {
209 	if(fptr == &msgreply_sizefunc) return 1;
210 	else if(fptr == &ub_rrset_sizefunc) return 1;
211 	else if(fptr == &infra_sizefunc) return 1;
212 	else if(fptr == &key_entry_sizefunc) return 1;
213 	else if(fptr == &rate_sizefunc) return 1;
214 	else if(fptr == &test_slabhash_sizefunc) return 1;
215 	return 0;
216 }
217 
218 int
219 fptr_whitelist_hash_compfunc(lruhash_compfunc_t fptr)
220 {
221 	if(fptr == &query_info_compare) return 1;
222 	else if(fptr == &ub_rrset_compare) return 1;
223 	else if(fptr == &infra_compfunc) return 1;
224 	else if(fptr == &key_entry_compfunc) return 1;
225 	else if(fptr == &rate_compfunc) return 1;
226 	else if(fptr == &test_slabhash_compfunc) return 1;
227 	return 0;
228 }
229 
230 int
231 fptr_whitelist_hash_delkeyfunc(lruhash_delkeyfunc_t fptr)
232 {
233 	if(fptr == &query_entry_delete) return 1;
234 	else if(fptr == &ub_rrset_key_delete) return 1;
235 	else if(fptr == &infra_delkeyfunc) return 1;
236 	else if(fptr == &key_entry_delkeyfunc) return 1;
237 	else if(fptr == &rate_delkeyfunc) return 1;
238 	else if(fptr == &test_slabhash_delkey) return 1;
239 	return 0;
240 }
241 
242 int
243 fptr_whitelist_hash_deldatafunc(lruhash_deldatafunc_t fptr)
244 {
245 	if(fptr == &reply_info_delete) return 1;
246 	else if(fptr == &rrset_data_delete) return 1;
247 	else if(fptr == &infra_deldatafunc) return 1;
248 	else if(fptr == &key_entry_deldatafunc) return 1;
249 	else if(fptr == &rate_deldatafunc) return 1;
250 	else if(fptr == &test_slabhash_deldata) return 1;
251 	return 0;
252 }
253 
254 int
255 fptr_whitelist_hash_markdelfunc(lruhash_markdelfunc_t fptr)
256 {
257 	if(fptr == NULL) return 1;
258 	else if(fptr == &rrset_markdel) return 1;
259 	return 0;
260 }
261 
262 /** whitelist env->send_query callbacks */
263 int
264 fptr_whitelist_modenv_send_query(struct outbound_entry* (*fptr)(
265         uint8_t* qname, size_t qnamelen, uint16_t qtype, uint16_t qclass,
266         uint16_t flags, int dnssec, int want_dnssec, int nocaps,
267 	struct sockaddr_storage* addr, socklen_t addrlen,
268 	uint8_t* zone, size_t zonelen,
269 	struct module_qstate* q))
270 {
271 	if(fptr == &worker_send_query) return 1;
272 	else if(fptr == &libworker_send_query) return 1;
273 	return 0;
274 }
275 
276 int
277 fptr_whitelist_modenv_detach_subs(void (*fptr)(
278         struct module_qstate* qstate))
279 {
280 	if(fptr == &mesh_detach_subs) return 1;
281 	return 0;
282 }
283 
284 int
285 fptr_whitelist_modenv_attach_sub(int (*fptr)(
286         struct module_qstate* qstate, struct query_info* qinfo,
287         uint16_t qflags, int prime, int valrec, struct module_qstate** newq))
288 {
289 	if(fptr == &mesh_attach_sub) return 1;
290 	return 0;
291 }
292 
293 int
294 fptr_whitelist_modenv_kill_sub(void (*fptr)(struct module_qstate* newq))
295 {
296 	if(fptr == &mesh_state_delete) return 1;
297 	return 0;
298 }
299 
300 int
301 fptr_whitelist_modenv_detect_cycle(int (*fptr)(
302 	struct module_qstate* qstate, struct query_info* qinfo,
303 	uint16_t flags, int prime, int valrec))
304 {
305 	if(fptr == &mesh_detect_cycle) return 1;
306 	return 0;
307 }
308 
309 int
310 fptr_whitelist_mod_init(int (*fptr)(struct module_env* env, int id))
311 {
312 	if(fptr == &iter_init) return 1;
313 	else if(fptr == &val_init) return 1;
314 	else if(fptr == &dns64_init) return 1;
315 #ifdef WITH_PYTHONMODULE
316 	else if(fptr == &pythonmod_init) return 1;
317 #endif
318 	return 0;
319 }
320 
321 int
322 fptr_whitelist_mod_deinit(void (*fptr)(struct module_env* env, int id))
323 {
324 	if(fptr == &iter_deinit) return 1;
325 	else if(fptr == &val_deinit) return 1;
326 	else if(fptr == &dns64_deinit) return 1;
327 #ifdef WITH_PYTHONMODULE
328 	else if(fptr == &pythonmod_deinit) return 1;
329 #endif
330 	return 0;
331 }
332 
333 int
334 fptr_whitelist_mod_operate(void (*fptr)(struct module_qstate* qstate,
335         enum module_ev event, int id, struct outbound_entry* outbound))
336 {
337 	if(fptr == &iter_operate) return 1;
338 	else if(fptr == &val_operate) return 1;
339 	else if(fptr == &dns64_operate) return 1;
340 #ifdef WITH_PYTHONMODULE
341 	else if(fptr == &pythonmod_operate) return 1;
342 #endif
343 	return 0;
344 }
345 
346 int
347 fptr_whitelist_mod_inform_super(void (*fptr)(
348         struct module_qstate* qstate, int id, struct module_qstate* super))
349 {
350 	if(fptr == &iter_inform_super) return 1;
351 	else if(fptr == &val_inform_super) return 1;
352 	else if(fptr == &dns64_inform_super) return 1;
353 #ifdef WITH_PYTHONMODULE
354 	else if(fptr == &pythonmod_inform_super) return 1;
355 #endif
356 	return 0;
357 }
358 
359 int
360 fptr_whitelist_mod_clear(void (*fptr)(struct module_qstate* qstate,
361         int id))
362 {
363 	if(fptr == &iter_clear) return 1;
364 	else if(fptr == &val_clear) return 1;
365 	else if(fptr == &dns64_clear) return 1;
366 #ifdef WITH_PYTHONMODULE
367 	else if(fptr == &pythonmod_clear) return 1;
368 #endif
369 	return 0;
370 }
371 
372 int
373 fptr_whitelist_mod_get_mem(size_t (*fptr)(struct module_env* env, int id))
374 {
375 	if(fptr == &iter_get_mem) return 1;
376 	else if(fptr == &val_get_mem) return 1;
377 	else if(fptr == &dns64_get_mem) return 1;
378 #ifdef WITH_PYTHONMODULE
379 	else if(fptr == &pythonmod_get_mem) return 1;
380 #endif
381 	return 0;
382 }
383 
384 int
385 fptr_whitelist_alloc_cleanup(void (*fptr)(void*))
386 {
387 	if(fptr == &worker_alloc_cleanup) return 1;
388 	return 0;
389 }
390 
391 int fptr_whitelist_tube_listen(tube_callback_t* fptr)
392 {
393 	if(fptr == &worker_handle_control_cmd) return 1;
394 	else if(fptr == &libworker_handle_control_cmd) return 1;
395 	return 0;
396 }
397 
398 int fptr_whitelist_mesh_cb(mesh_cb_func_t fptr)
399 {
400 	if(fptr == &libworker_fg_done_cb) return 1;
401 	else if(fptr == &libworker_bg_done_cb) return 1;
402 	else if(fptr == &libworker_event_done_cb) return 1;
403 	else if(fptr == &probe_answer_cb) return 1;
404 	return 0;
405 }
406 
407 int fptr_whitelist_print_func(void (*fptr)(char*,void*))
408 {
409 	if(fptr == &config_print_func) return 1;
410 	else if(fptr == &config_collate_func) return 1;
411 	else if(fptr == &remote_get_opt_ssl) return 1;
412 	return 0;
413 }
414