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