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