contrib/unbound/smallapp/unbound-control.c

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