1/* 2 * checkconf/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 62#ifdef HAVE_SYS_UN_H 63#include <sys/un.h> 64#endif 65 66/** Give unbound-control usage, and exit (1). */ 67static void 68usage() 69{ 70 printf("Usage: unbound-control [options] command\n"); 71 printf(" Remote control utility for unbound server.\n"); 72 printf("Options:\n"); 73 printf(" -c file config file, default is %s\n", CONFIGFILE); 74 printf(" -s ip[@port] server address, if omitted config is used.\n"); 75 printf(" -q quiet (don't print anything if it works ok).\n"); 76 printf(" -h show this usage help.\n"); 77 printf("Commands:\n"); 78 printf(" start start server; runs unbound(8)\n"); 79 printf(" stop stops the server\n"); 80 printf(" reload reloads the server\n"); 81 printf(" (this flushes data, stats, requestlist)\n"); 82 printf(" stats print statistics\n"); 83 printf(" stats_noreset peek at statistics\n"); 84 printf(" status display status of server\n"); 85 printf(" verbosity <number> change logging detail\n"); 86 printf(" log_reopen close and open the logfile\n"); 87 printf(" local_zone <name> <type> add new local zone\n"); 88 printf(" local_zone_remove <name> remove local zone and its contents\n"); 89 printf(" local_data <RR data...> add local data, for example\n"); 90 printf(" local_data www.example.com A 192.0.2.1\n"); 91 printf(" local_data_remove <name> remove local RR data from name\n"); 92 printf(" dump_cache print cache to stdout\n"); 93 printf(" load_cache load cache from stdin\n"); 94 printf(" lookup <name> print nameservers for name\n"); 95 printf(" flush <name> flushes common types for name from cache\n"); 96 printf(" types: A, AAAA, MX, PTR, NS,\n"); 97 printf(" SOA, CNAME, DNAME, SRV, NAPTR\n"); 98 printf(" flush_type <name> <type> flush name, type from cache\n"); 99 printf(" flush_zone <name> flush everything at or under name\n"); 100 printf(" from rr and dnssec caches\n"); 101 printf(" flush_bogus flush all bogus data\n"); 102 printf(" flush_negative flush all negative data\n"); 103 printf(" flush_stats flush statistics, make zero\n"); 104 printf(" flush_requestlist drop queries that are worked on\n"); 105 printf(" dump_requestlist show what is worked on\n"); 106 printf(" flush_infra [all | ip] remove ping, edns for one IP or all\n"); 107 printf(" dump_infra show ping and edns entries\n"); 108 printf(" set_option opt: val set option to value, no reload\n"); 109 printf(" get_option opt get option value\n"); 110 printf(" list_stubs list stub-zones and root hints in use\n"); 111 printf(" list_forwards list forward-zones in use\n"); 112 printf(" list_insecure list domain-insecure zones\n"); 113 printf(" list_local_zones list local-zones in use\n"); 114 printf(" list_local_data list local-data RRs in use\n"); 115 printf(" insecure_add zone add domain-insecure zone\n"); 116 printf(" insecure_remove zone remove domain-insecure zone\n"); 117 printf(" forward_add [+i] zone addr.. add forward-zone with servers\n"); 118 printf(" forward_remove [+i] zone remove forward zone\n"); 119 printf(" stub_add [+ip] zone addr.. add stub-zone with servers\n"); 120 printf(" stub_remove [+i] zone remove stub zone\n"); 121 printf(" +i also do dnssec insecure point\n"); 122 printf(" +p set stub to use priming\n"); 123 printf(" forward [off | addr ...] without arg show forward setup\n"); 124 printf(" or off to turn off root forwarding\n"); 125 printf(" or give list of ip addresses\n"); 126 printf(" ratelimit_list [+a] list ratelimited domains\n"); 127 printf(" +a list all, also not ratelimited\n"); 128 printf("Version %s\n", PACKAGE_VERSION); 129 printf("BSD licensed, see LICENSE in source package for details.\n"); 130 printf("Report bugs to %s\n", PACKAGE_BUGREPORT); 131 exit(1); 132} 133 134/** exit with ssl error */ 135static void ssl_err(const char* s) 136{ 137 fprintf(stderr, "error: %s\n", s); 138 ERR_print_errors_fp(stderr); 139 exit(1); 140} 141 142/** setup SSL context */ 143static SSL_CTX* 144setup_ctx(struct config_file* cfg) 145{ 146 char* s_cert=NULL, *c_key=NULL, *c_cert=NULL; 147 SSL_CTX* ctx; 148 149 if(cfg->remote_control_use_cert) { 150 s_cert = fname_after_chroot(cfg->server_cert_file, cfg, 1); 151 c_key = fname_after_chroot(cfg->control_key_file, cfg, 1); 152 c_cert = fname_after_chroot(cfg->control_cert_file, cfg, 1); 153 if(!s_cert || !c_key || !c_cert) 154 fatal_exit("out of memory"); 155 } 156 ctx = SSL_CTX_new(SSLv23_client_method()); 157 if(!ctx) 158 ssl_err("could not allocate SSL_CTX pointer"); 159 if((SSL_CTX_set_options(ctx, SSL_OP_NO_SSLv2) & SSL_OP_NO_SSLv2) 160 != SSL_OP_NO_SSLv2) 161 ssl_err("could not set SSL_OP_NO_SSLv2"); 162 if(cfg->remote_control_use_cert) { 163 if((SSL_CTX_set_options(ctx, SSL_OP_NO_SSLv3) & SSL_OP_NO_SSLv3) 164 != SSL_OP_NO_SSLv3) 165 ssl_err("could not set SSL_OP_NO_SSLv3"); 166 if(!SSL_CTX_use_certificate_chain_file(ctx,c_cert) || 167 !SSL_CTX_use_PrivateKey_file(ctx,c_key,SSL_FILETYPE_PEM) 168 || !SSL_CTX_check_private_key(ctx)) 169 ssl_err("Error setting up SSL_CTX client key and cert"); 170 if (SSL_CTX_load_verify_locations(ctx, s_cert, NULL) != 1) 171 ssl_err("Error setting up SSL_CTX verify, server cert"); 172 SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER, NULL); 173 174 free(s_cert); 175 free(c_key); 176 free(c_cert); 177 } else { 178 /* Use ciphers that don't require authentication */ 179 if(!SSL_CTX_set_cipher_list(ctx, "aNULL")) 180 ssl_err("Error setting NULL cipher!"); 181 } 182 return ctx; 183} 184 185/** contact the server with TCP connect */ 186static int 187contact_server(const char* svr, struct config_file* cfg, int statuscmd) 188{ 189 struct sockaddr_storage addr; 190 socklen_t addrlen; 191 int addrfamily = 0; 192 int fd; 193 /* use svr or the first config entry */ 194 if(!svr) { 195 if(cfg->control_ifs) 196 svr = cfg->control_ifs->str; 197 else svr = "127.0.0.1"; 198 /* config 0 addr (everything), means ask localhost */ 199 if(strcmp(svr, "0.0.0.0") == 0) 200 svr = "127.0.0.1"; 201 else if(strcmp(svr, "::0") == 0 || 202 strcmp(svr, "0::0") == 0 || 203 strcmp(svr, "0::") == 0 || 204 strcmp(svr, "::") == 0) 205 svr = "::1"; 206 } 207 if(strchr(svr, '@')) { 208 if(!extstrtoaddr(svr, &addr, &addrlen)) 209 fatal_exit("could not parse IP@port: %s", svr); 210#ifdef HAVE_SYS_UN_H 211 } else if(svr[0] == '/') { 212 struct sockaddr_un* usock = (struct sockaddr_un *) &addr; 213 usock->sun_family = AF_LOCAL; 214#ifdef HAVE_STRUCT_SOCKADDR_UN_SUN_LEN 215 usock->sun_len = (socklen_t)sizeof(usock); 216#endif 217 (void)strlcpy(usock->sun_path, svr, sizeof(usock->sun_path)); 218 addrlen = (socklen_t)sizeof(struct sockaddr_un); 219 addrfamily = AF_LOCAL; 220#endif 221 } else { 222 if(!ipstrtoaddr(svr, cfg->control_port, &addr, &addrlen)) 223 fatal_exit("could not parse IP: %s", svr); 224 } 225 226 if(addrfamily == 0) 227 addrfamily = addr_is_ip6(&addr, addrlen)?AF_INET6:AF_INET; 228 fd = socket(addrfamily, SOCK_STREAM, 0); 229 if(fd == -1) { 230#ifndef USE_WINSOCK 231 fatal_exit("socket: %s", strerror(errno)); 232#else 233 fatal_exit("socket: %s", wsa_strerror(WSAGetLastError())); 234#endif 235 } 236 if(connect(fd, (struct sockaddr*)&addr, addrlen) < 0) { 237#ifndef USE_WINSOCK 238 log_err_addr("connect", strerror(errno), &addr, addrlen); 239 if(errno == ECONNREFUSED && statuscmd) { 240 printf("unbound is stopped\n"); 241 exit(3); 242 } 243#else 244 log_err_addr("connect", wsa_strerror(WSAGetLastError()), &addr, addrlen); 245 if(WSAGetLastError() == WSAECONNREFUSED && statuscmd) { 246 printf("unbound is stopped\n"); 247 exit(3); 248 } 249#endif 250 exit(1); 251 } 252 return fd; 253} 254 255/** setup SSL on the connection */ 256static SSL* 257setup_ssl(SSL_CTX* ctx, int fd, struct config_file* cfg) 258{ 259 SSL* ssl; 260 X509* x; 261 int r; 262 263 ssl = SSL_new(ctx); 264 if(!ssl) 265 ssl_err("could not SSL_new"); 266 SSL_set_connect_state(ssl); 267 (void)SSL_set_mode(ssl, SSL_MODE_AUTO_RETRY); 268 if(!SSL_set_fd(ssl, fd)) 269 ssl_err("could not SSL_set_fd"); 270 while(1) { 271 ERR_clear_error(); 272 if( (r=SSL_do_handshake(ssl)) == 1) 273 break; 274 r = SSL_get_error(ssl, r); 275 if(r != SSL_ERROR_WANT_READ && r != SSL_ERROR_WANT_WRITE) 276 ssl_err("SSL handshake failed"); 277 /* wants to be called again */ 278 } 279 280 /* check authenticity of server */ 281 if(SSL_get_verify_result(ssl) != X509_V_OK) 282 ssl_err("SSL verification failed"); 283 if(cfg->remote_control_use_cert) { 284 x = SSL_get_peer_certificate(ssl); 285 if(!x) 286 ssl_err("Server presented no peer certificate"); 287 X509_free(x); 288 } 289 290 return ssl; 291} 292 293/** send stdin to server */ 294static void 295send_file(SSL* ssl, FILE* in, char* buf, size_t sz) 296{ 297 while(fgets(buf, (int)sz, in)) { 298 if(SSL_write(ssl, buf, (int)strlen(buf)) <= 0) 299 ssl_err("could not SSL_write contents"); 300 } 301} 302 303/** send command and display result */ 304static int 305go_cmd(SSL* ssl, int quiet, int argc, char* argv[]) 306{ 307 char pre[10]; 308 const char* space=" "; 309 const char* newline="\n"; 310 int was_error = 0, first_line = 1; 311 int r, i; 312 char buf[1024]; 313 snprintf(pre, sizeof(pre), "UBCT%d ", UNBOUND_CONTROL_VERSION); 314 if(SSL_write(ssl, pre, (int)strlen(pre)) <= 0) 315 ssl_err("could not SSL_write"); 316 for(i=0; i<argc; i++) { 317 if(SSL_write(ssl, space, (int)strlen(space)) <= 0) 318 ssl_err("could not SSL_write"); 319 if(SSL_write(ssl, argv[i], (int)strlen(argv[i])) <= 0) 320 ssl_err("could not SSL_write"); 321 } 322 if(SSL_write(ssl, newline, (int)strlen(newline)) <= 0) 323 ssl_err("could not SSL_write"); 324 325 if(argc == 1 && strcmp(argv[0], "load_cache") == 0) { 326 send_file(ssl, stdin, buf, sizeof(buf)); 327 } 328 329 while(1) { 330 ERR_clear_error(); 331 if((r = SSL_read(ssl, buf, (int)sizeof(buf)-1)) <= 0) { 332 if(SSL_get_error(ssl, r) == SSL_ERROR_ZERO_RETURN) { 333 /* EOF */ 334 break; 335 } 336 ssl_err("could not SSL_read"); 337 } 338 buf[r] = 0; 339 if(first_line && strncmp(buf, "error", 5) == 0) { 340 printf("%s", buf); 341 was_error = 1; 342 } else if (!quiet) 343 printf("%s", buf); 344 345 first_line = 0; 346 } 347 return was_error; 348} 349 350/** go ahead and read config, contact server and perform command and display */ 351static int 352go(const char* cfgfile, char* svr, int quiet, int argc, char* argv[]) 353{ 354 struct config_file* cfg; 355 int fd, ret; 356 SSL_CTX* ctx; 357 SSL* ssl; 358 359 /* read config */ 360 if(!(cfg = config_create())) 361 fatal_exit("out of memory"); 362 if(!config_read(cfg, cfgfile, NULL)) 363 fatal_exit("could not read config file"); 364 if(!cfg->remote_control_enable) 365 log_warn("control-enable is 'no' in the config file."); 366#ifdef UB_ON_WINDOWS 367 w_config_adjust_directory(cfg); 368#endif 369 ctx = setup_ctx(cfg); 370 371 /* contact server */ 372 fd = contact_server(svr, cfg, argc>0&&strcmp(argv[0],"status")==0); 373 ssl = setup_ssl(ctx, fd, cfg); 374 375 /* send command */ 376 ret = go_cmd(ssl, quiet, argc, argv); 377 378 SSL_free(ssl); 379#ifndef USE_WINSOCK 380 close(fd); 381#else 382 closesocket(fd); 383#endif 384 SSL_CTX_free(ctx); 385 config_delete(cfg); 386 return ret; 387} 388 389/** getopt global, in case header files fail to declare it. */ 390extern int optind; 391/** getopt global, in case header files fail to declare it. */ 392extern char* optarg; 393 394/** Main routine for unbound-control */ 395int main(int argc, char* argv[]) 396{ 397 int c, ret; 398 int quiet = 0; 399 const char* cfgfile = CONFIGFILE; 400 char* svr = NULL; 401#ifdef USE_WINSOCK 402 int r; 403 WSADATA wsa_data; 404#endif 405#ifdef USE_THREAD_DEBUG 406 /* stop the file output from unbound-control, overwites the servers */ 407 extern int check_locking_order; 408 check_locking_order = 0; 409#endif /* USE_THREAD_DEBUG */ 410 log_ident_set("unbound-control"); 411 log_init(NULL, 0, NULL); 412 checklock_start(); 413#ifdef USE_WINSOCK 414 if((r = WSAStartup(MAKEWORD(2,2), &wsa_data)) != 0) 415 fatal_exit("WSAStartup failed: %s", wsa_strerror(r)); 416 /* use registry config file in preference to compiletime location */ 417 if(!(cfgfile=w_lookup_reg_str("Software\\Unbound", "ConfigFile"))) 418 cfgfile = CONFIGFILE; 419#endif 420 421 ERR_load_crypto_strings(); 422 ERR_load_SSL_strings(); 423 OpenSSL_add_all_algorithms(); 424 (void)SSL_library_init(); 425 426 if(!RAND_status()) { 427 /* try to seed it */ 428 unsigned char buf[256]; 429 unsigned int seed=(unsigned)time(NULL) ^ (unsigned)getpid(); 430 unsigned int v = seed; 431 size_t i; 432 for(i=0; i<256/sizeof(v); i++) { 433 memmove(buf+i*sizeof(v), &v, sizeof(v)); 434 v = v*seed + (unsigned int)i; 435 } 436 RAND_seed(buf, 256); 437 log_warn("no entropy, seeding openssl PRNG with time\n"); 438 } 439 440 /* parse the options */ 441 while( (c=getopt(argc, argv, "c:s:qh")) != -1) { 442 switch(c) { 443 case 'c': 444 cfgfile = optarg; 445 break; 446 case 's': 447 svr = optarg; 448 break; 449 case 'q': 450 quiet = 1; 451 break; 452 case '?': 453 case 'h': 454 default: 455 usage(); 456 } 457 } 458 argc -= optind; 459 argv += optind; 460 if(argc == 0) 461 usage(); 462 if(argc >= 1 && strcmp(argv[0], "start")==0) { 463 if(execlp("unbound", "unbound", "-c", cfgfile, 464 (char*)NULL) < 0) { 465 fatal_exit("could not exec unbound: %s", 466 strerror(errno)); 467 } 468 } 469 470 ret = go(cfgfile, svr, quiet, argc, argv); 471 472#ifdef USE_WINSOCK 473 WSACleanup(); 474#endif 475 checklock_stop(); 476 return ret; 477} 478