1 /*
2 * smallapp/unbound-control.c - remote control utility for unbound.
3 *
4 * Copyright (c) 2008, 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 * The remote control utility contacts the unbound server over ssl and
40 * sends the command, receives the answer, and displays the result
41 * from the commandline.
42 */
43
44 #include "config.h"
45 #ifdef HAVE_GETOPT_H
46 #include <getopt.h>
47 #endif
48 #ifdef HAVE_OPENSSL_SSL_H
49 #include <openssl/ssl.h>
50 #endif
51 #ifdef HAVE_OPENSSL_ERR_H
52 #include <openssl/err.h>
53 #endif
54 #ifdef HAVE_OPENSSL_RAND_H
55 #include <openssl/rand.h>
56 #endif
57 #include "util/log.h"
58 #include "util/config_file.h"
59 #include "util/locks.h"
60 #include "util/net_help.h"
61 #include "util/shm_side/shm_main.h"
62 #include "util/timeval_func.h"
63 #include "daemon/stats.h"
64 #include "sldns/wire2str.h"
65 #include "sldns/pkthdr.h"
66 #include "services/rpz.h"
67 #include "services/listen_dnsport.h"
68
69 #ifdef HAVE_SYS_IPC_H
70 #include "sys/ipc.h"
71 #endif
72 #ifdef HAVE_SYS_SHM_H
73 #include "sys/shm.h"
74 #endif
75 #ifdef HAVE_SYS_UN_H
76 #include <sys/un.h>
77 #endif
78
79 #ifdef HAVE_TARGETCONDITIONALS_H
80 #include <TargetConditionals.h>
81 #endif
82
83 static void usage(void) ATTR_NORETURN;
84 static void ssl_err(const char* s) ATTR_NORETURN;
85 static void ssl_path_err(const char* s, const char *path) ATTR_NORETURN;
86
87 /** timeout to wait for connection over stream, in msec */
88 #define UNBOUND_CONTROL_CONNECT_TIMEOUT 5000
89
90 /** Give unbound-control usage, and exit (1). */
91 static void
usage(void)92 usage(void)
93 {
94 printf("Usage: local-unbound-control [options] command\n");
95 printf(" Remote control utility for unbound server.\n");
96 printf("Options:\n");
97 printf(" -c file config file, default is %s\n", CONFIGFILE);
98 printf(" -s ip[@port] server address, if omitted config is used.\n");
99 printf(" -q quiet (don't print anything if it works ok).\n");
100 printf(" -h show this usage help.\n");
101 printf("Commands:\n");
102 printf(" start start server; runs unbound(8)\n");
103 printf(" stop stops the server\n");
104 printf(" reload reloads the server\n");
105 printf(" (this flushes data, stats, requestlist)\n");
106 printf(" reload_keep_cache reloads the server but tries to\n");
107 printf(" keep the RRset and message cache\n");
108 printf(" if (re)configuration allows for it.\n");
109 printf(" That means the caches sizes and\n");
110 printf(" the number of threads must not\n");
111 printf(" change between reloads.\n");
112 printf(" stats print statistics\n");
113 printf(" stats_noreset peek at statistics\n");
114 #ifdef HAVE_SHMGET
115 printf(" stats_shm print statistics using shm\n");
116 #endif
117 printf(" status display status of server\n");
118 printf(" verbosity <number> change logging detail\n");
119 printf(" log_reopen close and open the logfile\n");
120 printf(" local_zone <name> <type> add new local zone\n");
121 printf(" local_zone_remove <name> remove local zone and its contents\n");
122 printf(" local_data <RR data...> add local data, for example\n");
123 printf(" local_data www.example.com A 192.0.2.1\n");
124 printf(" local_data_remove <name> remove local RR data from name\n");
125 printf(" local_zones,\n");
126 printf(" local_zones_remove,\n");
127 printf(" local_datas,\n");
128 printf(" local_datas_remove same, but read list from stdin\n");
129 printf(" (one entry per line).\n");
130 printf(" dump_cache print cache to stdout\n");
131 printf(" (not supported in remote unbounds in\n");
132 printf(" multi-process operation)\n");
133 printf(" load_cache load cache from stdin\n");
134 printf(" (not supported in remote unbounds in\n");
135 printf(" multi-process operation)\n");
136 printf(" lookup <name> print nameservers for name\n");
137 printf(" flush [+c] <name> flushes common types for name from cache\n");
138 printf(" types: A, AAAA, MX, PTR, NS,\n");
139 printf(" SOA, CNAME, DNAME, SRV, NAPTR\n");
140 printf(" flush_type [+c] <name> <type> flush name, type from cache\n");
141 printf(" +c remove from cachedb too\n");
142 printf(" flush_zone [+c] <name> flush everything at or under name\n");
143 printf(" from rr and dnssec caches\n");
144 printf(" flush_bogus [+c] flush all bogus data\n");
145 printf(" flush_negative [+c] flush all negative data\n");
146 printf(" flush_stats flush statistics, make zero\n");
147 printf(" flush_requestlist drop queries that are worked on\n");
148 printf(" dump_requestlist show what is worked on by first thread\n");
149 printf(" flush_infra [all | ip] remove ping, edns for one IP or all\n");
150 printf(" dump_infra show ping and edns entries\n");
151 printf(" set_option opt: val set option to value, no reload\n");
152 printf(" get_option opt get option value\n");
153 printf(" list_stubs list stub-zones and root hints in use\n");
154 printf(" list_forwards list forward-zones in use\n");
155 printf(" list_insecure list domain-insecure zones\n");
156 printf(" list_local_zones list local-zones in use\n");
157 printf(" list_local_data list local-data RRs in use\n");
158 printf(" insecure_add zone add domain-insecure zone\n");
159 printf(" insecure_remove zone remove domain-insecure zone\n");
160 printf(" forward_add [+it] zone addr.. add forward-zone with servers\n");
161 printf(" forward_remove [+i] zone remove forward zone\n");
162 printf(" stub_add [+ipt] zone addr.. add stub-zone with servers\n");
163 printf(" stub_remove [+i] zone remove stub zone\n");
164 printf(" +i also do dnssec insecure point\n");
165 printf(" +p set stub to use priming\n");
166 printf(" +t set to use tls upstream\n");
167 printf(" forward [off | addr ...] without arg show forward setup\n");
168 printf(" or off to turn off root forwarding\n");
169 printf(" or give list of ip addresses\n");
170 printf(" ratelimit_list [+a] list ratelimited domains\n");
171 printf(" ip_ratelimit_list [+a] list ratelimited ip addresses\n");
172 printf(" +a list all, also not ratelimited\n");
173 printf(" list_auth_zones list auth zones (includes RPZ zones)\n");
174 printf(" auth_zone_reload zone reload auth zone (or RPZ zone) from zonefile\n");
175 printf(" auth_zone_transfer zone transfer auth zone (or RPZ zone) from master\n");
176 printf(" view_list_local_zones view list local-zones in view\n");
177 printf(" view_list_local_data view list local-data RRs in view\n");
178 printf(" view_local_zone view name type add local-zone in view\n");
179 printf(" view_local_zone_remove view name remove local-zone in view\n");
180 printf(" view_local_data view RR... add local-data in view\n");
181 printf(" view_local_datas view add list of local-data to view\n");
182 printf(" one entry per line read from stdin\n");
183 printf(" view_local_data_remove view name remove local-data in view\n");
184 printf(" view_local_datas_remove view remove list of local-data from view\n");
185 printf(" one entry per line read from stdin\n");
186 printf(" rpz_enable zone Enable the RPZ zone if it had previously\n");
187 printf(" been disabled\n");
188 printf(" rpz_disable zone Disable the RPZ zone\n");
189 printf(" add_cookie_secret <secret> add (or replace) a new cookie secret <secret>\n");
190 printf(" drop_cookie_secret drop a staging cookie secret\n");
191 printf(" activate_cookie_secret make a staging cookie secret active\n");
192 printf(" print_cookie_secrets show all cookie secrets with their status\n");
193 printf("Version %s\n", PACKAGE_VERSION);
194 printf("BSD licensed, see LICENSE in source package for details.\n");
195 printf("Report bugs to %s\n", PACKAGE_BUGREPORT);
196 exit(1);
197 }
198
199 #ifdef HAVE_SHMGET
200 /** what to put on statistics lines between var and value, ": " or "=" */
201 #define SQ "="
202 /** print unsigned long stats value */
203 #define PR_UL_NM(str, var) printf("%s."str SQ"%lu\n", nm, (unsigned long)(var));
204 #define PR_UL(str, var) printf(str SQ"%lu\n", (unsigned long)(var));
205 #define PR_UL_SUB(str, nm, var) printf(str".%s"SQ"%lu\n", nm, (unsigned long)(var));
206 #define PR_TIMEVAL(str, var) printf(str SQ ARG_LL "d.%6.6d\n", \
207 (long long)var.tv_sec, (int)var.tv_usec);
208 #define PR_STATSTIME(str, var) printf(str SQ ARG_LL "d.%6.6d\n", \
209 (long long)var ## _sec, (int)var ## _usec);
210 #define PR_LL(str, var) printf(str SQ ARG_LL"d\n", (long long)(var));
211
212 /** print stat block */
pr_stats(const char * nm,struct ub_stats_info * s)213 static void pr_stats(const char* nm, struct ub_stats_info* s)
214 {
215 struct timeval sumwait, avg;
216 PR_UL_NM("num.queries", s->svr.num_queries);
217 PR_UL_NM("num.queries_ip_ratelimited",
218 s->svr.num_queries_ip_ratelimited);
219 PR_UL_NM("num.queries_cookie_valid",
220 s->svr.num_queries_cookie_valid);
221 PR_UL_NM("num.queries_cookie_client",
222 s->svr.num_queries_cookie_client);
223 PR_UL_NM("num.queries_cookie_invalid",
224 s->svr.num_queries_cookie_invalid);
225 PR_UL_NM("num.cachehits",
226 s->svr.num_queries - s->svr.num_queries_missed_cache);
227 PR_UL_NM("num.cachemiss", s->svr.num_queries_missed_cache);
228 PR_UL_NM("num.prefetch", s->svr.num_queries_prefetch);
229 PR_UL_NM("num.queries_timed_out", s->svr.num_queries_timed_out);
230 PR_UL_NM("query.queue_time_us.max", s->svr.max_query_time_us);
231 PR_UL_NM("num.expired", s->svr.ans_expired);
232 PR_UL_NM("num.recursivereplies", s->mesh_replies_sent);
233 #ifdef USE_DNSCRYPT
234 PR_UL_NM("num.dnscrypt.crypted", s->svr.num_query_dnscrypt_crypted);
235 PR_UL_NM("num.dnscrypt.cert", s->svr.num_query_dnscrypt_cert);
236 PR_UL_NM("num.dnscrypt.cleartext", s->svr.num_query_dnscrypt_cleartext);
237 PR_UL_NM("num.dnscrypt.malformed",
238 s->svr.num_query_dnscrypt_crypted_malformed);
239 #endif /* USE_DNSCRYPT */
240 printf("%s.requestlist.avg"SQ"%g\n", nm,
241 (s->svr.num_queries_missed_cache+s->svr.num_queries_prefetch)?
242 (double)s->svr.sum_query_list_size/
243 (double)(s->svr.num_queries_missed_cache+
244 s->svr.num_queries_prefetch) : 0.0);
245 PR_UL_NM("requestlist.max", s->svr.max_query_list_size);
246 PR_UL_NM("requestlist.overwritten", s->mesh_jostled);
247 PR_UL_NM("requestlist.exceeded", s->mesh_dropped);
248 PR_UL_NM("requestlist.current.all", s->mesh_num_states);
249 PR_UL_NM("requestlist.current.user", s->mesh_num_reply_states);
250 #ifndef S_SPLINT_S
251 sumwait.tv_sec = s->mesh_replies_sum_wait_sec;
252 sumwait.tv_usec = s->mesh_replies_sum_wait_usec;
253 #endif
254 timeval_divide(&avg, &sumwait, s->mesh_replies_sent);
255 printf("%s.", nm);
256 PR_TIMEVAL("recursion.time.avg", avg);
257 printf("%s.recursion.time.median"SQ"%g\n", nm, s->mesh_time_median);
258 PR_UL_NM("tcpusage", s->svr.tcp_accept_usage);
259 }
260
261 /** print uptime */
print_uptime(struct ub_shm_stat_info * shm_stat)262 static void print_uptime(struct ub_shm_stat_info* shm_stat)
263 {
264 PR_STATSTIME("time.now", shm_stat->time.now);
265 PR_STATSTIME("time.up", shm_stat->time.up);
266 PR_STATSTIME("time.elapsed", shm_stat->time.elapsed);
267 }
268
269 /** print memory usage */
print_mem(struct ub_shm_stat_info * shm_stat,struct ub_stats_info * s)270 static void print_mem(struct ub_shm_stat_info* shm_stat,
271 struct ub_stats_info* s)
272 {
273 PR_LL("mem.cache.rrset", shm_stat->mem.rrset);
274 PR_LL("mem.cache.message", shm_stat->mem.msg);
275 PR_LL("mem.mod.iterator", shm_stat->mem.iter);
276 PR_LL("mem.mod.validator", shm_stat->mem.val);
277 PR_LL("mem.mod.respip", shm_stat->mem.respip);
278 #ifdef CLIENT_SUBNET
279 PR_LL("mem.mod.subnet", shm_stat->mem.subnet);
280 #endif
281 #ifdef USE_IPSECMOD
282 PR_LL("mem.mod.ipsecmod", shm_stat->mem.ipsecmod);
283 #endif
284 #ifdef WITH_DYNLIBMODULE
285 PR_LL("mem.mod.dynlib", shm_stat->mem.dynlib);
286 #endif
287 #ifdef USE_DNSCRYPT
288 PR_LL("mem.cache.dnscrypt_shared_secret",
289 shm_stat->mem.dnscrypt_shared_secret);
290 PR_LL("mem.cache.dnscrypt_nonce",
291 shm_stat->mem.dnscrypt_nonce);
292 #endif
293 PR_LL("mem.streamwait", s->svr.mem_stream_wait);
294 PR_LL("mem.http.query_buffer", s->svr.mem_http2_query_buffer);
295 PR_LL("mem.http.response_buffer", s->svr.mem_http2_response_buffer);
296 #ifdef HAVE_NGTCP2
297 PR_LL("mem.quic", s->svr.mem_quic);
298 #endif
299 }
300
301 /** print histogram */
print_hist(struct ub_stats_info * s)302 static void print_hist(struct ub_stats_info* s)
303 {
304 struct timehist* hist;
305 size_t i;
306 hist = timehist_setup();
307 if(!hist)
308 fatal_exit("out of memory");
309 timehist_import(hist, s->svr.hist, NUM_BUCKETS_HIST);
310 for(i=0; i<hist->num; i++) {
311 printf("histogram.%6.6d.%6.6d.to.%6.6d.%6.6d=%lu\n",
312 (int)hist->buckets[i].lower.tv_sec,
313 (int)hist->buckets[i].lower.tv_usec,
314 (int)hist->buckets[i].upper.tv_sec,
315 (int)hist->buckets[i].upper.tv_usec,
316 (unsigned long)hist->buckets[i].count);
317 }
318 timehist_delete(hist);
319 }
320
321 /** print extended */
print_extended(struct ub_stats_info * s,int inhibit_zero)322 static void print_extended(struct ub_stats_info* s, int inhibit_zero)
323 {
324 int i;
325 char nm[16];
326
327 /* TYPE */
328 for(i=0; i<UB_STATS_QTYPE_NUM; i++) {
329 if(inhibit_zero && s->svr.qtype[i] == 0)
330 continue;
331 sldns_wire2str_type_buf((uint16_t)i, nm, sizeof(nm));
332 PR_UL_SUB("num.query.type", nm, s->svr.qtype[i]);
333 }
334 if(!inhibit_zero || s->svr.qtype_big) {
335 PR_UL("num.query.type.other", s->svr.qtype_big);
336 }
337
338 /* CLASS */
339 for(i=0; i<UB_STATS_QCLASS_NUM; i++) {
340 if(inhibit_zero && s->svr.qclass[i] == 0)
341 continue;
342 sldns_wire2str_class_buf((uint16_t)i, nm, sizeof(nm));
343 PR_UL_SUB("num.query.class", nm, s->svr.qclass[i]);
344 }
345 if(!inhibit_zero || s->svr.qclass_big) {
346 PR_UL("num.query.class.other", s->svr.qclass_big);
347 }
348
349 /* OPCODE */
350 for(i=0; i<UB_STATS_OPCODE_NUM; i++) {
351 if(inhibit_zero && s->svr.qopcode[i] == 0)
352 continue;
353 sldns_wire2str_opcode_buf(i, nm, sizeof(nm));
354 PR_UL_SUB("num.query.opcode", nm, s->svr.qopcode[i]);
355 }
356
357 /* transport */
358 PR_UL("num.query.tcp", s->svr.qtcp);
359 PR_UL("num.query.tcpout", s->svr.qtcp_outgoing);
360 PR_UL("num.query.udpout", s->svr.qudp_outgoing);
361 PR_UL("num.query.tls", s->svr.qtls);
362 PR_UL("num.query.tls_resume", s->svr.qtls_resume);
363 PR_UL("num.query.ipv6", s->svr.qipv6);
364 PR_UL("num.query.https", s->svr.qhttps);
365 #ifdef HAVE_NGTCP2
366 PR_UL("num.query.quic", s->svr.qquic);
367 #endif
368
369 /* flags */
370 PR_UL("num.query.flags.QR", s->svr.qbit_QR);
371 PR_UL("num.query.flags.AA", s->svr.qbit_AA);
372 PR_UL("num.query.flags.TC", s->svr.qbit_TC);
373 PR_UL("num.query.flags.RD", s->svr.qbit_RD);
374 PR_UL("num.query.flags.RA", s->svr.qbit_RA);
375 PR_UL("num.query.flags.Z", s->svr.qbit_Z);
376 PR_UL("num.query.flags.AD", s->svr.qbit_AD);
377 PR_UL("num.query.flags.CD", s->svr.qbit_CD);
378 PR_UL("num.query.edns.present", s->svr.qEDNS);
379 PR_UL("num.query.edns.DO", s->svr.qEDNS_DO);
380
381 /* RCODE */
382 for(i=0; i<UB_STATS_RCODE_NUM; i++) {
383 /* Always include RCODEs 0-5 */
384 if(inhibit_zero && i > LDNS_RCODE_REFUSED && s->svr.ans_rcode[i] == 0)
385 continue;
386 sldns_wire2str_rcode_buf(i, nm, sizeof(nm));
387 PR_UL_SUB("num.answer.rcode", nm, s->svr.ans_rcode[i]);
388 }
389 if(!inhibit_zero || s->svr.ans_rcode_nodata) {
390 PR_UL("num.answer.rcode.nodata", s->svr.ans_rcode_nodata);
391 }
392 /* iteration */
393 PR_UL("num.query.ratelimited", s->svr.queries_ratelimited);
394 /* validation */
395 PR_UL("num.answer.secure", s->svr.ans_secure);
396 PR_UL("num.answer.bogus", s->svr.ans_bogus);
397 PR_UL("num.rrset.bogus", s->svr.rrset_bogus);
398 PR_UL("num.query.aggressive.NOERROR", s->svr.num_neg_cache_noerror);
399 PR_UL("num.query.aggressive.NXDOMAIN", s->svr.num_neg_cache_nxdomain);
400 /* threat detection */
401 PR_UL("unwanted.queries", s->svr.unwanted_queries);
402 PR_UL("unwanted.replies", s->svr.unwanted_replies);
403 /* cache counts */
404 PR_UL("msg.cache.count", s->svr.msg_cache_count);
405 PR_UL("rrset.cache.count", s->svr.rrset_cache_count);
406 PR_UL("infra.cache.count", s->svr.infra_cache_count);
407 PR_UL("key.cache.count", s->svr.key_cache_count);
408 /* max collisions */
409 PR_UL("msg.cache.max_collisions", s->svr.msg_cache_max_collisions);
410 PR_UL("rrset.cache.max_collisions", s->svr.rrset_cache_max_collisions);
411 /* applied RPZ actions */
412 for(i=0; i<UB_STATS_RPZ_ACTION_NUM; i++) {
413 if(i == RPZ_NO_OVERRIDE_ACTION)
414 continue;
415 if(inhibit_zero && s->svr.rpz_action[i] == 0)
416 continue;
417 PR_UL_SUB("num.rpz.action", rpz_action_to_string(i), s->svr.rpz_action[i]);
418 }
419 #ifdef USE_DNSCRYPT
420 PR_UL("dnscrypt_shared_secret.cache.count",
421 s->svr.shared_secret_cache_count);
422 PR_UL("num.query.dnscrypt.shared_secret.cachemiss",
423 s->svr.num_query_dnscrypt_secret_missed_cache);
424 PR_UL("dnscrypt_nonce.cache.count", s->svr.nonce_cache_count);
425 PR_UL("num.query.dnscrypt.replay",
426 s->svr.num_query_dnscrypt_replay);
427 #endif /* USE_DNSCRYPT */
428 PR_UL("num.query.authzone.up", s->svr.num_query_authzone_up);
429 PR_UL("num.query.authzone.down", s->svr.num_query_authzone_down);
430 #ifdef CLIENT_SUBNET
431 PR_UL("num.query.subnet", s->svr.num_query_subnet);
432 PR_UL("num.query.subnet_cache", s->svr.num_query_subnet_cache);
433 #endif
434 #ifdef USE_CACHEDB
435 PR_UL("num.query.cachedb", s->svr.num_query_cachedb);
436 #endif
437 }
438
439 /** print statistics out of memory structures */
do_stats_shm(struct config_file * cfg,struct ub_stats_info * stats,struct ub_shm_stat_info * shm_stat)440 static void do_stats_shm(struct config_file* cfg, struct ub_stats_info* stats,
441 struct ub_shm_stat_info* shm_stat)
442 {
443 int i;
444 char nm[32];
445 for(i=0; i<cfg->num_threads; i++) {
446 snprintf(nm, sizeof(nm), "thread%d", i);
447 pr_stats(nm, &stats[i+1]);
448 }
449 pr_stats("total", &stats[0]);
450 print_uptime(shm_stat);
451 if(cfg->stat_extended) {
452 print_mem(shm_stat, &stats[0]);
453 print_hist(stats);
454 print_extended(stats, cfg->stat_inhibit_zero);
455 }
456 }
457 #endif /* HAVE_SHMGET */
458
459 /** print statistics from shm memory segment */
print_stats_shm(const char * cfgfile,int quiet)460 static void print_stats_shm(const char* cfgfile, int quiet)
461 {
462 #ifdef HAVE_SHMGET
463 struct config_file* cfg;
464 struct ub_stats_info* stats;
465 struct ub_shm_stat_info* shm_stat;
466 int id_ctl, id_arr;
467 /* read config */
468 if(!(cfg = config_create()))
469 fatal_exit("out of memory");
470 if(!config_read(cfg, cfgfile, NULL))
471 fatal_exit("could not read config file");
472 /* get shm segments */
473 id_ctl = shmget(cfg->shm_key, sizeof(int), SHM_R);
474 if(id_ctl == -1) {
475 fatal_exit("shmget(%d): %s", cfg->shm_key, strerror(errno));
476 }
477 id_arr = shmget(cfg->shm_key+1, sizeof(int), SHM_R);
478 if(id_arr == -1) {
479 fatal_exit("shmget(%d): %s", cfg->shm_key+1, strerror(errno));
480 }
481 shm_stat = (struct ub_shm_stat_info*)shmat(id_ctl, NULL, SHM_RDONLY);
482 if(shm_stat == (void*)-1) {
483 fatal_exit("shmat(%d): %s", id_ctl, strerror(errno));
484 }
485 stats = (struct ub_stats_info*)shmat(id_arr, NULL, SHM_RDONLY);
486 if(stats == (void*)-1) {
487 fatal_exit("shmat(%d): %s", id_arr, strerror(errno));
488 }
489
490
491 if(!quiet) {
492 /* print the stats */
493 do_stats_shm(cfg, stats, shm_stat);
494 }
495
496 /* shutdown */
497 shmdt(shm_stat);
498 shmdt(stats);
499 config_delete(cfg);
500 #else
501 (void)cfgfile;
502 (void)quiet;
503 #endif /* HAVE_SHMGET */
504 }
505
506 /** exit with ssl error */
ssl_err(const char * s)507 static void ssl_err(const char* s)
508 {
509 fprintf(stderr, "error: %s\n", s);
510 ERR_print_errors_fp(stderr);
511 exit(1);
512 }
513
514 /** exit with ssl error related to a file path */
ssl_path_err(const char * s,const char * path)515 static void ssl_path_err(const char* s, const char *path)
516 {
517 unsigned long err;
518 err = ERR_peek_error();
519 if(ERR_GET_LIB(err) == ERR_LIB_SYS) {
520 fprintf(stderr, "error: %s\n%s: %s\n",
521 s, path, ERR_reason_error_string(err));
522 exit(1);
523 } else {
524 ssl_err(s);
525 }
526 }
527
528 /** setup SSL context */
529 static SSL_CTX*
setup_ctx(struct config_file * cfg)530 setup_ctx(struct config_file* cfg)
531 {
532 char* s_cert=NULL, *c_key=NULL, *c_cert=NULL;
533 SSL_CTX* ctx;
534
535 if(!(options_remote_is_address(cfg) && cfg->control_use_cert))
536 return NULL;
537 s_cert = fname_after_chroot(cfg->server_cert_file, cfg, 1);
538 c_key = fname_after_chroot(cfg->control_key_file, cfg, 1);
539 c_cert = fname_after_chroot(cfg->control_cert_file, cfg, 1);
540 if(!s_cert || !c_key || !c_cert)
541 fatal_exit("out of memory");
542 ctx = SSL_CTX_new(SSLv23_client_method());
543 if(!ctx)
544 ssl_err("could not allocate SSL_CTX pointer");
545 #if SSL_OP_NO_SSLv2 != 0
546 if((SSL_CTX_set_options(ctx, SSL_OP_NO_SSLv2) & SSL_OP_NO_SSLv2)
547 != SSL_OP_NO_SSLv2)
548 ssl_err("could not set SSL_OP_NO_SSLv2");
549 #endif
550 if((SSL_CTX_set_options(ctx, SSL_OP_NO_SSLv3) & SSL_OP_NO_SSLv3)
551 != SSL_OP_NO_SSLv3)
552 ssl_err("could not set SSL_OP_NO_SSLv3");
553 #if defined(SSL_OP_NO_RENEGOTIATION)
554 /* disable client renegotiation */
555 if((SSL_CTX_set_options(ctx, SSL_OP_NO_RENEGOTIATION) &
556 SSL_OP_NO_RENEGOTIATION) != SSL_OP_NO_RENEGOTIATION)
557 ssl_err("could not set SSL_OP_NO_RENEGOTIATION");
558 #endif
559 if(!SSL_CTX_use_certificate_chain_file(ctx,c_cert))
560 ssl_path_err("Error setting up SSL_CTX client cert", c_cert);
561 if(!SSL_CTX_use_PrivateKey_file(ctx,c_key,SSL_FILETYPE_PEM))
562 ssl_path_err("Error setting up SSL_CTX client key", c_key);
563 if(!SSL_CTX_check_private_key(ctx))
564 ssl_err("Error setting up SSL_CTX client key");
565 if(SSL_CTX_load_verify_locations(ctx, s_cert, NULL) != 1)
566 ssl_path_err("Error setting up SSL_CTX verify, server cert",
567 s_cert);
568 SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER, NULL);
569
570 free(s_cert);
571 free(c_key);
572 free(c_cert);
573 return ctx;
574 }
575
576 /** check connect error */
577 static void
checkconnecterr(int err,const char * svr,struct sockaddr_storage * addr,socklen_t addrlen,int statuscmd,int useport)578 checkconnecterr(int err, const char* svr, struct sockaddr_storage* addr,
579 socklen_t addrlen, int statuscmd, int useport)
580 {
581 #ifndef USE_WINSOCK
582 if(!useport) log_err("connect: %s for %s", strerror(err), svr);
583 else log_err_addr("connect", strerror(err), addr, addrlen);
584 if(err == ECONNREFUSED && statuscmd) {
585 printf("unbound is stopped\n");
586 exit(3);
587 }
588 #else
589 int wsaerr = err;
590 if(!useport) log_err("connect: %s for %s", wsa_strerror(wsaerr), svr);
591 else log_err_addr("connect", wsa_strerror(wsaerr), addr, addrlen);
592 if(wsaerr == WSAECONNREFUSED && statuscmd) {
593 printf("unbound is stopped\n");
594 exit(3);
595 }
596 #endif
597 exit(1);
598 }
599
600 /** contact the server with TCP connect */
601 static int
contact_server(const char * svr,struct config_file * cfg,int statuscmd)602 contact_server(const char* svr, struct config_file* cfg, int statuscmd)
603 {
604 struct sockaddr_storage addr;
605 socklen_t addrlen;
606 int addrfamily = 0, proto = IPPROTO_TCP;
607 int fd, useport = 1;
608 char** rcif = NULL;
609 int num_rcif = 0;
610 /* use svr or the first config entry */
611 if(!svr) {
612 if(cfg->control_ifs.first) {
613 struct sockaddr_storage addr2;
614 socklen_t addrlen2;
615 if(extstrtoaddr(cfg->control_ifs.first->str, &addr2,
616 &addrlen2, UNBOUND_DNS_PORT)) {
617 svr = cfg->control_ifs.first->str;
618 } else {
619 if(!resolve_interface_names(NULL, 0,
620 cfg->control_ifs.first, &rcif,
621 &num_rcif)) {
622 fatal_exit("could not resolve interface names");
623 }
624 if(rcif == NULL || num_rcif == 0) {
625 fatal_exit("no control interfaces");
626 }
627 svr = rcif[0];
628 }
629 } else if(cfg->do_ip4) {
630 svr = "127.0.0.1";
631 } else {
632 svr = "::1";
633 }
634 /* config 0 addr (everything), means ask localhost */
635 if(strcmp(svr, "0.0.0.0") == 0)
636 svr = "127.0.0.1";
637 else if(strcmp(svr, "::0") == 0 ||
638 strcmp(svr, "0::0") == 0 ||
639 strcmp(svr, "0::") == 0 ||
640 strcmp(svr, "::") == 0)
641 svr = "::1";
642 }
643 if(strchr(svr, '@')) {
644 if(!extstrtoaddr(svr, &addr, &addrlen, UNBOUND_DNS_PORT))
645 fatal_exit("could not parse IP@port: %s", svr);
646 #ifdef HAVE_SYS_UN_H
647 } else if(svr[0] == '/') {
648 struct sockaddr_un* usock = (struct sockaddr_un *) &addr;
649 usock->sun_family = AF_LOCAL;
650 #ifdef HAVE_STRUCT_SOCKADDR_UN_SUN_LEN
651 usock->sun_len = (unsigned)sizeof(usock);
652 #endif
653 (void)strlcpy(usock->sun_path, svr, sizeof(usock->sun_path));
654 addrlen = (socklen_t)sizeof(struct sockaddr_un);
655 addrfamily = AF_LOCAL;
656 useport = 0;
657 proto = 0;
658 #endif
659 } else {
660 if(!ipstrtoaddr(svr, cfg->control_port, &addr, &addrlen))
661 fatal_exit("could not parse IP: %s", svr);
662 }
663
664 if(addrfamily == 0)
665 addrfamily = addr_is_ip6(&addr, addrlen)?PF_INET6:PF_INET;
666 fd = socket(addrfamily, SOCK_STREAM, proto);
667 if(fd == -1) {
668 fatal_exit("socket: %s", sock_strerror(errno));
669 }
670 fd_set_nonblock(fd);
671 if(connect(fd, (struct sockaddr*)&addr, addrlen) < 0) {
672 #ifndef USE_WINSOCK
673 #ifdef EINPROGRESS
674 if(errno != EINPROGRESS) {
675 checkconnecterr(errno, svr, &addr,
676 addrlen, statuscmd, useport);
677 }
678 #endif
679 #else
680 if(WSAGetLastError() != WSAEINPROGRESS &&
681 WSAGetLastError() != WSAEWOULDBLOCK) {
682 checkconnecterr(WSAGetLastError(), svr, &addr,
683 addrlen, statuscmd, useport);
684 }
685 #endif
686 }
687 while(1) {
688 fd_set rset, wset, eset;
689 struct timeval tv;
690 FD_ZERO(&rset);
691 FD_SET(FD_SET_T fd, &rset);
692 FD_ZERO(&wset);
693 FD_SET(FD_SET_T fd, &wset);
694 FD_ZERO(&eset);
695 FD_SET(FD_SET_T fd, &eset);
696 tv.tv_sec = UNBOUND_CONTROL_CONNECT_TIMEOUT/1000;
697 tv.tv_usec= (UNBOUND_CONTROL_CONNECT_TIMEOUT%1000)*1000;
698 if(select(fd+1, &rset, &wset, &eset, &tv) == -1) {
699 fatal_exit("select: %s", sock_strerror(errno));
700 }
701 if(!FD_ISSET(fd, &rset) && !FD_ISSET(fd, &wset) &&
702 !FD_ISSET(fd, &eset)) {
703 fatal_exit("timeout: could not connect to server");
704 } else {
705 /* check nonblocking connect error */
706 int error = 0;
707 socklen_t len = (socklen_t)sizeof(error);
708 if(getsockopt(fd, SOL_SOCKET, SO_ERROR, (void*)&error,
709 &len) < 0) {
710 #ifndef USE_WINSOCK
711 error = errno; /* on solaris errno is error */
712 #else
713 error = WSAGetLastError();
714 #endif
715 }
716 if(error != 0) {
717 #ifndef USE_WINSOCK
718 #ifdef EINPROGRESS
719 if(error == EINPROGRESS)
720 continue; /* try again later */
721 #endif
722 #ifdef EWOULDBLOCK
723 if(error == EWOULDBLOCK)
724 continue; /* try again later */
725 #endif
726 #else
727 if(error == WSAEINPROGRESS)
728 continue; /* try again later */
729 if(error == WSAEWOULDBLOCK)
730 continue; /* try again later */
731 #endif
732 checkconnecterr(error, svr, &addr, addrlen,
733 statuscmd, useport);
734 }
735 }
736 break;
737 }
738 fd_set_block(fd);
739 config_del_strarray(rcif, num_rcif);
740 return fd;
741 }
742
743 /** setup SSL on the connection */
744 static SSL*
setup_ssl(SSL_CTX * ctx,int fd)745 setup_ssl(SSL_CTX* ctx, int fd)
746 {
747 SSL* ssl;
748 X509* x;
749 int r;
750
751 if(!ctx) return NULL;
752 ssl = SSL_new(ctx);
753 if(!ssl)
754 ssl_err("could not SSL_new");
755 SSL_set_connect_state(ssl);
756 (void)SSL_set_mode(ssl, (long)SSL_MODE_AUTO_RETRY);
757 if(!SSL_set_fd(ssl, fd))
758 ssl_err("could not SSL_set_fd");
759 while(1) {
760 ERR_clear_error();
761 if( (r=SSL_do_handshake(ssl)) == 1)
762 break;
763 r = SSL_get_error(ssl, r);
764 if(r != SSL_ERROR_WANT_READ && r != SSL_ERROR_WANT_WRITE)
765 ssl_err("SSL handshake failed");
766 /* wants to be called again */
767 }
768
769 /* check authenticity of server */
770 if(SSL_get_verify_result(ssl) != X509_V_OK)
771 ssl_err("SSL verification failed");
772 #ifdef HAVE_SSL_GET1_PEER_CERTIFICATE
773 x = SSL_get1_peer_certificate(ssl);
774 #else
775 x = SSL_get_peer_certificate(ssl);
776 #endif
777 if(!x)
778 ssl_err("Server presented no peer certificate");
779 X509_free(x);
780
781 return ssl;
782 }
783
784 /** read from ssl or fd, fatalexit on error, 0 EOF, 1 success */
785 static int
remote_read(SSL * ssl,int fd,char * buf,size_t len)786 remote_read(SSL* ssl, int fd, char* buf, size_t len)
787 {
788 if(ssl) {
789 int r;
790 ERR_clear_error();
791 if((r = SSL_read(ssl, buf, (int)len-1)) <= 0) {
792 if(SSL_get_error(ssl, r) == SSL_ERROR_ZERO_RETURN) {
793 /* EOF */
794 return 0;
795 }
796 ssl_err("could not SSL_read");
797 }
798 buf[r] = 0;
799 } else {
800 ssize_t rr = recv(fd, buf, len-1, 0);
801 if(rr <= 0) {
802 if(rr == 0) {
803 /* EOF */
804 return 0;
805 }
806 fatal_exit("could not recv: %s", sock_strerror(errno));
807 }
808 buf[rr] = 0;
809 }
810 return 1;
811 }
812
813 /** write to ssl or fd, fatalexit on error */
814 static void
remote_write(SSL * ssl,int fd,const char * buf,size_t len)815 remote_write(SSL* ssl, int fd, const char* buf, size_t len)
816 {
817 if(ssl) {
818 if(SSL_write(ssl, buf, (int)len) <= 0)
819 ssl_err("could not SSL_write");
820 } else {
821 if(send(fd, buf, len, 0) < (ssize_t)len) {
822 fatal_exit("could not send: %s", sock_strerror(errno));
823 }
824 }
825 }
826
827 /** check args, to see if too many args. Because when a file is sent it
828 * would wait for the terminal, and we can check for too many arguments,
829 * eg. user put arguments on the commandline. */
830 static void
check_args_for_listcmd(int argc,char * argv[])831 check_args_for_listcmd(int argc, char* argv[])
832 {
833 if(argc >= 1 && (strcmp(argv[0], "local_zones") == 0 ||
834 strcmp(argv[0], "local_zones_remove") == 0 ||
835 strcmp(argv[0], "local_datas") == 0 ||
836 strcmp(argv[0], "local_datas_remove") == 0) &&
837 argc >= 2) {
838 fatal_exit("too many arguments for command '%s', "
839 "content is piped in from stdin", argv[0]);
840 }
841 if(argc >= 1 && (strcmp(argv[0], "view_local_datas") == 0 ||
842 strcmp(argv[0], "view_local_datas_remove") == 0) &&
843 argc >= 3) {
844 fatal_exit("too many arguments for command '%s', "
845 "content is piped in from stdin", argv[0]);
846 }
847 }
848
849 /** send stdin to server */
850 static void
send_file(SSL * ssl,int fd,FILE * in,char * buf,size_t sz)851 send_file(SSL* ssl, int fd, FILE* in, char* buf, size_t sz)
852 {
853 while(fgets(buf, (int)sz, in)) {
854 remote_write(ssl, fd, buf, strlen(buf));
855 }
856 }
857
858 /** send end-of-file marker to server */
859 static void
send_eof(SSL * ssl,int fd)860 send_eof(SSL* ssl, int fd)
861 {
862 char e[] = {0x04, 0x0a};
863 remote_write(ssl, fd, e, sizeof(e));
864 }
865
866 /** send command and display result */
867 static int
go_cmd(SSL * ssl,int fd,int quiet,int argc,char * argv[])868 go_cmd(SSL* ssl, int fd, int quiet, int argc, char* argv[])
869 {
870 char pre[10];
871 const char* space=" ";
872 const char* newline="\n";
873 int was_error = 0, first_line = 1;
874 int i;
875 char buf[1024];
876 snprintf(pre, sizeof(pre), "UBCT%d ", UNBOUND_CONTROL_VERSION);
877 remote_write(ssl, fd, pre, strlen(pre));
878 for(i=0; i<argc; i++) {
879 remote_write(ssl, fd, space, strlen(space));
880 remote_write(ssl, fd, argv[i], strlen(argv[i]));
881 }
882 remote_write(ssl, fd, newline, strlen(newline));
883
884 if(argc == 1 && strcmp(argv[0], "load_cache") == 0) {
885 send_file(ssl, fd, stdin, buf, sizeof(buf));
886 }
887 else if(argc >= 1 && (strcmp(argv[0], "local_zones") == 0 ||
888 strcmp(argv[0], "local_zones_remove") == 0 ||
889 strcmp(argv[0], "local_datas") == 0 ||
890 strcmp(argv[0], "view_local_datas") == 0 ||
891 strcmp(argv[0], "local_datas_remove") == 0 ||
892 strcmp(argv[0], "view_local_datas_remove") == 0)) {
893 send_file(ssl, fd, stdin, buf, sizeof(buf));
894 send_eof(ssl, fd);
895 }
896
897 while(1) {
898 if(remote_read(ssl, fd, buf, sizeof(buf)) == 0) {
899 break; /* EOF */
900 }
901 if(first_line && strncmp(buf, "error", 5) == 0) {
902 printf("%s", buf);
903 was_error = 1;
904 } else if(!quiet) {
905 printf("%s", buf);
906 }
907
908 first_line = 0;
909 }
910 return was_error;
911 }
912
913 /** go ahead and read config, contact server and perform command and display */
914 static int
go(const char * cfgfile,char * svr,int quiet,int argc,char * argv[])915 go(const char* cfgfile, char* svr, int quiet, int argc, char* argv[])
916 {
917 struct config_file* cfg;
918 int fd, ret;
919 SSL_CTX* ctx;
920 SSL* ssl;
921
922 /* read config */
923 if(!(cfg = config_create()))
924 fatal_exit("out of memory");
925 if(!config_read(cfg, cfgfile, NULL))
926 fatal_exit("could not read config file");
927 if(!cfg->remote_control_enable)
928 log_warn("control-enable is 'no' in the config file.");
929 #ifdef UB_ON_WINDOWS
930 w_config_adjust_directory(cfg);
931 #endif
932 ctx = setup_ctx(cfg);
933
934 /* contact server */
935 fd = contact_server(svr, cfg, argc>0&&strcmp(argv[0],"status")==0);
936 ssl = setup_ssl(ctx, fd);
937
938 /* send command */
939 ret = go_cmd(ssl, fd, quiet, argc, argv);
940
941 if(ssl) SSL_free(ssl);
942 sock_close(fd);
943 if(ctx) SSL_CTX_free(ctx);
944 config_delete(cfg);
945 return ret;
946 }
947
948 /** getopt global, in case header files fail to declare it. */
949 extern int optind;
950 /** getopt global, in case header files fail to declare it. */
951 extern char* optarg;
952
953 /** Main routine for unbound-control */
main(int argc,char * argv[])954 int main(int argc, char* argv[])
955 {
956 int c, ret;
957 int quiet = 0;
958 const char* cfgfile = CONFIGFILE;
959 char* svr = NULL;
960 #ifdef USE_WINSOCK
961 int r;
962 WSADATA wsa_data;
963 #endif
964 #ifdef USE_THREAD_DEBUG
965 /* stop the file output from unbound-control, overwrites the servers */
966 extern int check_locking_order;
967 check_locking_order = 0;
968 #endif /* USE_THREAD_DEBUG */
969 checklock_start();
970 log_ident_set("unbound-control");
971 log_init(NULL, 0, NULL);
972 #ifdef USE_WINSOCK
973 /* use registry config file in preference to compiletime location */
974 if(!(cfgfile=w_lookup_reg_str("Software\\Unbound", "ConfigFile")))
975 cfgfile = CONFIGFILE;
976 #endif
977 /* parse the options */
978 while( (c=getopt(argc, argv, "c:s:qh")) != -1) {
979 switch(c) {
980 case 'c':
981 cfgfile = optarg;
982 break;
983 case 's':
984 svr = optarg;
985 break;
986 case 'q':
987 quiet = 1;
988 break;
989 case '?':
990 case 'h':
991 default:
992 usage();
993 }
994 }
995 argc -= optind;
996 argv += optind;
997 if(argc == 0)
998 usage();
999 if(argc >= 1 && strcmp(argv[0], "start")==0) {
1000 #if (defined(TARGET_OS_TV) && TARGET_OS_TV) || (defined(TARGET_OS_WATCH) && TARGET_OS_WATCH)
1001 fatal_exit("could not exec unbound: %s",
1002 strerror(ENOSYS));
1003 #else
1004 if(execlp("unbound", "unbound", "-c", cfgfile,
1005 (char*)NULL) < 0) {
1006 fatal_exit("could not exec unbound: %s",
1007 strerror(errno));
1008 }
1009 #endif
1010 }
1011 if(argc >= 1 && strcmp(argv[0], "stats_shm")==0) {
1012 print_stats_shm(cfgfile, quiet);
1013 return 0;
1014 }
1015 check_args_for_listcmd(argc, argv);
1016
1017 #ifdef USE_WINSOCK
1018 if((r = WSAStartup(MAKEWORD(2,2), &wsa_data)) != 0)
1019 fatal_exit("WSAStartup failed: %s", wsa_strerror(r));
1020 #endif
1021
1022 #ifdef HAVE_ERR_LOAD_CRYPTO_STRINGS
1023 ERR_load_crypto_strings();
1024 #endif
1025 #if OPENSSL_VERSION_NUMBER < 0x10100000 || !defined(HAVE_OPENSSL_INIT_SSL)
1026 ERR_load_SSL_strings();
1027 #endif
1028 #if OPENSSL_VERSION_NUMBER < 0x10100000 || !defined(HAVE_OPENSSL_INIT_CRYPTO)
1029 # ifndef S_SPLINT_S
1030 OpenSSL_add_all_algorithms();
1031 # endif
1032 #else
1033 OPENSSL_init_crypto(OPENSSL_INIT_ADD_ALL_CIPHERS
1034 | OPENSSL_INIT_ADD_ALL_DIGESTS
1035 | OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL);
1036 #endif
1037 #if OPENSSL_VERSION_NUMBER < 0x10100000 || !defined(HAVE_OPENSSL_INIT_SSL)
1038 (void)SSL_library_init();
1039 #else
1040 (void)OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS, NULL);
1041 #endif
1042
1043 if(!RAND_status()) {
1044 /* try to seed it */
1045 unsigned char buf[256];
1046 unsigned int seed=(unsigned)time(NULL) ^ (unsigned)getpid();
1047 unsigned int v = seed;
1048 size_t i;
1049 for(i=0; i<256/sizeof(v); i++) {
1050 memmove(buf+i*sizeof(v), &v, sizeof(v));
1051 v = v*seed + (unsigned int)i;
1052 }
1053 RAND_seed(buf, 256);
1054 log_warn("no entropy, seeding openssl PRNG with time\n");
1055 }
1056
1057 ret = go(cfgfile, svr, quiet, argc, argv);
1058
1059 #ifdef USE_WINSOCK
1060 WSACleanup();
1061 #endif
1062 checklock_stop();
1063 return ret;
1064 }
1065