contrib/bind9/bin/named/control.c

   1 /*
   2  * Copyright (C) 2004-2007, 2009, 2010  Internet Systems Consortium, Inc. ("ISC")
   3  * Copyright (C) 2001-2003  Internet Software Consortium.
   4  *
   5  * Permission to use, copy, modify, and/or distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  10  * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  11  * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  12  * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  13  * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  14  * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  15  * PERFORMANCE OF THIS SOFTWARE.
  16  */
  17
  18 /* $Id: control.c,v 1.41 2010/12/03 22:05:19 each Exp $ */
  19
  20 /*! \file */
  21
  22 #include <config.h>
  23
  24
  25 #include <isc/app.h>
  26 #include <isc/event.h>
  27 #include <isc/mem.h>
  28 #include <isc/string.h>
  29 #include <isc/timer.h>
  30 #include <isc/util.h>
  31
  32 #include <dns/result.h>
  33
  34 #include <isccc/alist.h>
  35 #include <isccc/cc.h>
  36 #include <isccc/result.h>
  37
  38 #include <named/control.h>
  39 #include <named/log.h>
  40 #include <named/os.h>
  41 #include <named/server.h>
  42 #ifdef HAVE_LIBSCF
  43 #include <named/ns_smf_globals.h>
  44 #endif
  45
  46 static isc_boolean_t
  47 command_compare(const char *text, const char *command) {
  48         unsigned int commandlen = strlen(command);
  49         if (strncasecmp(text, command, commandlen) == 0 &&
  50             (text[commandlen] == '\0' ||
  51              text[commandlen] == ' ' ||
  52              text[commandlen] == '\t'))
  53                 return (ISC_TRUE);
  54         return (ISC_FALSE);
  55 }
  56
  57 /*%
  58  * This function is called to process the incoming command
  59  * when a control channel message is received.
  60  */
  61 isc_result_t
  62 ns_control_docommand(isccc_sexpr_t *message, isc_buffer_t *text) {
  63         isccc_sexpr_t *data;
  64         char *command;
  65         isc_result_t result;
  66         int log_level;
  67 #ifdef HAVE_LIBSCF
  68         ns_smf_want_disable = 0;
  69 #endif
  70
  71         data = isccc_alist_lookup(message, "_data");
  72         if (data == NULL) {
  73                 /*
  74                  * No data section.
  75                  */
  76                 return (ISC_R_FAILURE);
  77         }
  78
  79         result = isccc_cc_lookupstring(data, "type", &command);
  80         if (result != ISC_R_SUCCESS) {
  81                 /*
  82                  * We have no idea what this is.
  83                  */
  84                 return (result);
  85         }
  86
  87         /*
  88          * Compare the 'command' parameter against all known control commands.
  89          */
  90         if (command_compare(command, NS_COMMAND_NULL) ||
  91             command_compare(command, NS_COMMAND_STATUS)) {
  92                 log_level = ISC_LOG_DEBUG(1);
  93         } else {
  94                 log_level = ISC_LOG_INFO;
  95         }
  96         isc_log_write(ns_g_lctx, NS_LOGCATEGORY_GENERAL,
  97                       NS_LOGMODULE_CONTROL, log_level,
  98                       "received control channel command '%s'",
  99                       command);
 100
 101         if (command_compare(command, NS_COMMAND_RELOAD)) {
 102                 result = ns_server_reloadcommand(ns_g_server, command, text);
 103         } else if (command_compare(command, NS_COMMAND_RECONFIG)) {
 104                 result = ns_server_reconfigcommand(ns_g_server, command);
 105         } else if (command_compare(command, NS_COMMAND_REFRESH)) {
 106                 result = ns_server_refreshcommand(ns_g_server, command, text);
 107         } else if (command_compare(command, NS_COMMAND_RETRANSFER)) {
 108                 result = ns_server_retransfercommand(ns_g_server, command);
 109         } else if (command_compare(command, NS_COMMAND_HALT)) {
 110 #ifdef HAVE_LIBSCF
 111                 /*
 112                  * If we are managed by smf(5), AND in chroot, then
 113                  * we cannot connect to the smf repository, so just
 114                  * return with an appropriate message back to rndc.
 115                  */
 116                 if (ns_smf_got_instance == 1 && ns_smf_chroot == 1) {
 117                         result = ns_smf_add_message(text);
 118                         return (result);
 119                 }
 120                 /*
 121                  * If we are managed by smf(5) but not in chroot,
 122                  * try to disable ourselves the smf way.
 123                  */
 124                 if (ns_smf_got_instance == 1 && ns_smf_chroot == 0)
 125                         ns_smf_want_disable = 1;
 126                 /*
 127                  * If ns_smf_got_instance = 0, ns_smf_chroot
 128                  * is not relevant and we fall through to
 129                  * isc_app_shutdown below.
 130                  */
 131 #endif
 132                 /* Do not flush master files */
 133                 ns_server_flushonshutdown(ns_g_server, ISC_FALSE);
 134                 ns_os_shutdownmsg(command, text);
 135                 isc_app_shutdown();
 136                 result = ISC_R_SUCCESS;
 137         } else if (command_compare(command, NS_COMMAND_STOP)) {
 138                 /*
 139                  * "stop" is the same as "halt" except it does
 140                  * flush master files.
 141                  */
 142 #ifdef HAVE_LIBSCF
 143                 if (ns_smf_got_instance == 1 && ns_smf_chroot == 1) {
 144                         result = ns_smf_add_message(text);
 145                         return (result);
 146                 }
 147                 if (ns_smf_got_instance == 1 && ns_smf_chroot == 0)
 148                         ns_smf_want_disable = 1;
 149 #endif
 150                 ns_server_flushonshutdown(ns_g_server, ISC_TRUE);
 151                 ns_os_shutdownmsg(command, text);
 152                 isc_app_shutdown();
 153                 result = ISC_R_SUCCESS;
 154         } else if (command_compare(command, NS_COMMAND_DUMPSTATS)) {
 155                 result = ns_server_dumpstats(ns_g_server);
 156         } else if (command_compare(command, NS_COMMAND_QUERYLOG)) {
 157                 result = ns_server_togglequerylog(ns_g_server);
 158         } else if (command_compare(command, NS_COMMAND_DUMPDB)) {
 159                 ns_server_dumpdb(ns_g_server, command);
 160                 result = ISC_R_SUCCESS;
 161         } else if (command_compare(command, NS_COMMAND_SECROOTS)) {
 162                 result = ns_server_dumpsecroots(ns_g_server, command);
 163         } else if (command_compare(command, NS_COMMAND_TRACE)) {
 164                 result = ns_server_setdebuglevel(ns_g_server, command);
 165         } else if (command_compare(command, NS_COMMAND_NOTRACE)) {
 166                 ns_g_debuglevel = 0;
 167                 isc_log_setdebuglevel(ns_g_lctx, ns_g_debuglevel);
 168                 result = ISC_R_SUCCESS;
 169         } else if (command_compare(command, NS_COMMAND_FLUSH)) {
 170                 result = ns_server_flushcache(ns_g_server, command);
 171         } else if (command_compare(command, NS_COMMAND_FLUSHNAME)) {
 172                 result = ns_server_flushname(ns_g_server, command);
 173         } else if (command_compare(command, NS_COMMAND_STATUS)) {
 174                 result = ns_server_status(ns_g_server, text);
 175         } else if (command_compare(command, NS_COMMAND_TSIGLIST)) {
 176                 result = ns_server_tsiglist(ns_g_server, text);
 177         } else if (command_compare(command, NS_COMMAND_TSIGDELETE)) {
 178                 result = ns_server_tsigdelete(ns_g_server, command, text);
 179         } else if (command_compare(command, NS_COMMAND_FREEZE)) {
 180                 result = ns_server_freeze(ns_g_server, ISC_TRUE, command,
 181                                           text);
 182         } else if (command_compare(command, NS_COMMAND_UNFREEZE) ||
 183                    command_compare(command, NS_COMMAND_THAW)) {
 184                 result = ns_server_freeze(ns_g_server, ISC_FALSE, command,
 185                                           text);
 186         } else if (command_compare(command, NS_COMMAND_RECURSING)) {
 187                 result = ns_server_dumprecursing(ns_g_server);
 188         } else if (command_compare(command, NS_COMMAND_TIMERPOKE)) {
 189                 result = ISC_R_SUCCESS;
 190                 isc_timermgr_poke(ns_g_timermgr);
 191         } else if (command_compare(command, NS_COMMAND_NULL)) {
 192                 result = ISC_R_SUCCESS;
 193         } else if (command_compare(command, NS_COMMAND_NOTIFY)) {
 194                 result = ns_server_notifycommand(ns_g_server, command, text);
 195         } else if (command_compare(command, NS_COMMAND_VALIDATION)) {
 196                 result = ns_server_validation(ns_g_server, command);
 197         } else if (command_compare(command, NS_COMMAND_SIGN) ||
 198                    command_compare(command, NS_COMMAND_LOADKEYS)) {
 199                 result = ns_server_rekey(ns_g_server, command);
 200         } else if (command_compare(command, NS_COMMAND_ADDZONE)) {
 201                 result = ns_server_add_zone(ns_g_server, command);
 202         } else if (command_compare(command, NS_COMMAND_DELZONE)) {
 203                 result = ns_server_del_zone(ns_g_server, command);
 204         } else {
 205                 isc_log_write(ns_g_lctx, NS_LOGCATEGORY_GENERAL,
 206                               NS_LOGMODULE_CONTROL, ISC_LOG_WARNING,
 207                               "unknown control channel command '%s'",
 208                               command);
 209                 result = DNS_R_UNKNOWNCOMMAND;
 210         }
 211
 212         return (result);
 213 }