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