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