plugins/check_dns.c

   1 /******************************************************************************
   2  *
   3  * CHECK_DNS.C
   4  *
   5  * Program: DNS plugin for Nagios
   6  * License: GPL
   7  * Copyright (c) 1999 Ethan Galstad (nagios@nagios.org)
   8  *
   9  * Last Modified: $Date$
  10  *
  11  * Notes:
  12  *  - Safe popen added by Karl DeBisschop 9-11-99
  13  *  - expected-address parameter added by Alex Chaffee - 7 Oct 2002
  14  *
  15  * Command line: (see print_usage)
  16  *
  17  * Description:
  18  *
  19  * This program will use the nslookup program to obtain the IP address
  20  * for a given host name.  A optional DNS server may be specified.  If
  21  * no DNS server is specified, the default server(s) for the system
  22  * are used.
  23  *
  24  * Return Values:
  25  *  OK           The DNS query was successful (host IP address was returned).
  26  *  WARNING      The DNS server responded, but could not fulfill the request.
  27  *  CRITICAL     The DNS server is not responding or encountered an error.
  28  *
  29  * License Information:
  30  *
  31  * This program is free software; you can redistribute it and/or modify
  32  * it under the terms of the GNU General Public License as published by
  33  * the Free Software Foundation; either version 2 of the License, or
  34  * (at your option) any later version.
  35  *
  36  * This program is distributed in the hope that it will be useful,
  37  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  38  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  39  * GNU General Public License for more details.
  40  *
  41  * You should have received a copy of the GNU General Public License
  42  * along with this program; if not, write to the Free Software
  43  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  44  *
  45  *****************************************************************************/
  46
  47 #include "common.h"
  48 #include "popen.h"
  49 #include "utils.h"
  50
  51 const char *progname = "check_dns";
  52 #define REVISION "$Revision$"
  53 #define COPYRIGHT "2000-2002"
  54
  55 int process_arguments (int, char **);
  56 int validate_arguments (void);
  57 void print_usage (void);
  58 void print_help (void);
  59 int error_scan (char *);
  60
  61 #define ADDRESS_LENGTH 256
  62 char query_address[ADDRESS_LENGTH] = "";
  63 char dns_server[ADDRESS_LENGTH] = "";
  64 char ptr_server[ADDRESS_LENGTH] = "";
  65 int verbose = FALSE;
  66 char expected_address[ADDRESS_LENGTH] = "";
  67 int match_expected_address = FALSE;
  68
  69 int
  70 main (int argc, char **argv)
  71 {
  72         char *command_line = NULL;
  73         char input_buffer[MAX_INPUT_BUFFER];
  74         char *output = NULL;
  75         char *address = NULL;
  76         char *temp_buffer = NULL;
  77         int result = STATE_UNKNOWN;
  78         double elapsed_time;
  79         struct timeval tv;
  80         int multi_address;
  81
  82         /* Set signal handling and alarm */
  83         if (signal (SIGALRM, popen_timeout_alarm_handler) == SIG_ERR) {
  84                 printf ("Cannot catch SIGALRM");
  85                 return STATE_UNKNOWN;
  86         }
  87
  88         if (process_arguments (argc, argv) != OK) {
  89                 print_usage ();
  90                 return STATE_UNKNOWN;
  91         }
  92
  93         /* get the command to run */
  94         asprintf (&command_line, "%s %s %s", NSLOOKUP_COMMAND,  query_address, dns_server);
  95
  96         alarm (timeout_interval);
  97         gettimeofday (&tv, NULL);
  98
  99         if (verbose)
 100                 printf ("%s\n", command_line);
 101         /* run the command */
 102         child_process = spopen (command_line);
 103         if (child_process == NULL) {
 104                 printf ("Could not open pipe: %s\n", command_line);
 105                 return STATE_UNKNOWN;
 106         }
 107
 108         child_stderr = fdopen (child_stderr_array[fileno (child_process)], "r");
 109         if (child_stderr == NULL)
 110                 printf ("Could not open stderr for %s\n", command_line);
 111
 112         /* scan stdout */
 113         while (fgets (input_buffer, MAX_INPUT_BUFFER - 1, child_process)) {
 114
 115                 if (verbose)
 116                         printf ("%s\n", input_buffer);
 117
 118                 if (strstr (input_buffer, ".in-addr.arpa")) {
 119                         if ((temp_buffer = strstr (input_buffer, "name = ")))
 120                                 address = strscpy (address, temp_buffer + 7);
 121                         else {
 122                                 output = strscpy (output, "Unknown error (plugin)");
 123                                 result = STATE_WARNING;
 124                         }
 125                 }
 126
 127                 /* the server is responding, we just got the host name... */
 128                 if (strstr (input_buffer, "Name:")) {
 129
 130                         /* get the host address */
 131                         if (!fgets (input_buffer, MAX_INPUT_BUFFER - 1, child_process))
 132                                 break;
 133
 134                         if (verbose)
 135                                 printf ("%s\n", input_buffer);
 136
 137                         if ((temp_buffer = index (input_buffer, ':'))) {
 138                                 temp_buffer++;
 139                                 /* Strip leading spaces */
 140                                 for (; *temp_buffer != '\0' && *temp_buffer == ' '; temp_buffer++)
 141                                         /* NOOP */;
 142                                 address = strscpy (address, temp_buffer);
 143                                 strip (address);
 144                                 result = STATE_OK;
 145                         }
 146                         else {
 147                                 output = strscpy (output, "Unknown error (plugin)");
 148                                 result = STATE_WARNING;
 149                         }
 150
 151                         break;
 152                 }
 153
 154                 result = error_scan (input_buffer);
 155                 if (result != STATE_OK) {
 156                         output = strscpy (output, 1 + index (input_buffer, ':'));
 157                         strip (output);
 158                         break;
 159                 }
 160
 161         }
 162
 163         /* scan stderr */
 164         while (fgets (input_buffer, MAX_INPUT_BUFFER - 1, child_stderr)) {
 165                 if (error_scan (input_buffer) != STATE_OK) {
 166                         result = max_state (result, error_scan (input_buffer));
 167                         output = strscpy (output, 1 + index (input_buffer, ':'));
 168                         strip (output);
 169                 }
 170         }
 171
 172         /* close stderr */
 173         (void) fclose (child_stderr);
 174
 175         /* close stdout */
 176         if (spclose (child_process)) {
 177                 result = max_state (result, STATE_WARNING);
 178                 if (!strcmp (output, ""))
 179                         output = strscpy (output, "nslookup returned error status");
 180         }
 181
 182         /* compare to expected address */
 183         if (result == STATE_OK && match_expected_address && strcmp(address, expected_address)) {
 184                 result = STATE_CRITICAL;
 185                 asprintf(&output, "expected %s but got %s", expected_address, address);
 186                 }
 187
 188         elapsed_time = delta_time (tv);
 189
 190         if (result == STATE_OK) {
 191                 if (strchr (address, ',') == NULL)
 192                         multi_address = FALSE;
 193                 else
 194                         multi_address = TRUE;
 195
 196                 printf ("DNS ok - %-5.3f seconds response time, address%s %s|time=%-5.3f\n",
 197                   elapsed_time, (multi_address==TRUE ? "es are" : " is"), address, elapsed_time);
 198         }
 199         else if (result == STATE_WARNING)
 200                 printf ("DNS WARNING - %s\n",
 201                         !strcmp (output, "") ? " Probably a non-existent host/domain" : output);
 202         else if (result == STATE_CRITICAL)
 203                 printf ("DNS CRITICAL - %s\n",
 204                         !strcmp (output, "") ? " Probably a non-existent host/domain" : output);
 205         else
 206                 printf ("DNS problem - %s\n",
 207                         !strcmp (output, "") ? " Probably a non-existent host/domain" : output);
 208
 209         return result;
 210 }
 211
 212 int
 213 error_scan (char *input_buffer)
 214 {
 215
 216         /* the DNS lookup timed out */
 217         if (strstr (input_buffer,
 218              "Note:  nslookup is deprecated and may be removed from future releases.")
 219             || strstr (input_buffer,
 220              "Consider using the `dig' or `host' programs instead.  Run nslookup with")
 221             || strstr (input_buffer,
 222              "the `-sil[ent]' option to prevent this message from appearing."))
 223                 return STATE_OK;
 224
 225         /* the DNS lookup timed out */
 226         else if (strstr (input_buffer, "Timed out"))
 227                 return STATE_WARNING;
 228
 229         /* DNS server is not running... */
 230         else if (strstr (input_buffer, "No response from server"))
 231                 return STATE_CRITICAL;
 232
 233         /* Host name is valid, but server doesn't have records... */
 234         else if (strstr (input_buffer, "No records"))
 235                 return STATE_WARNING;
 236
 237         /* Host or domain name does not exist */
 238         else if (strstr (input_buffer, "Non-existent"))
 239                 return STATE_CRITICAL;
 240         else if (strstr (input_buffer, "** server can't find"))
 241                 return STATE_CRITICAL;
 242         else if(strstr(input_buffer,"NXDOMAIN")) /* 9.x */
 243                 return STATE_CRITICAL;
 244
 245         /* Connection was refused */
 246         else if (strstr (input_buffer, "Connection refused"))
 247                 return STATE_CRITICAL;
 248
 249         /* Network is unreachable */
 250         else if (strstr (input_buffer, "Network is unreachable"))
 251                 return STATE_CRITICAL;
 252
 253         /* Internal server failure */
 254         else if (strstr (input_buffer, "Server failure"))
 255                 return STATE_CRITICAL;
 256
 257         /* DNS server refused to service request */
 258         else if (strstr (input_buffer, "Refused"))
 259                 return STATE_CRITICAL;
 260
 261         /* Request error */
 262         else if (strstr (input_buffer, "Format error"))
 263                 return STATE_WARNING;
 264
 265         else
 266                 return STATE_OK;
 267
 268 }
 269
 270 /* process command-line arguments */
 271 int
 272 process_arguments (int argc, char **argv)
 273 {
 274         int c;
 275
 276         int opt_index = 0;
 277         static struct option long_opts[] = {
 278                 {"help", no_argument, 0, 'h'},
 279                 {"version", no_argument, 0, 'V'},
 280                 {"verbose", no_argument, 0, 'v'},
 281                 {"timeout", required_argument, 0, 't'},
 282                 {"hostname", required_argument, 0, 'H'},
 283                 {"server", required_argument, 0, 's'},
 284                 {"reverse-server", required_argument, 0, 'r'},
 285                 {"expected-address", required_argument, 0, 'a'},
 286                 {0, 0, 0, 0}
 287         };
 288
 289         if (argc < 2)
 290                 return ERROR;
 291
 292         for (c = 1; c < argc; c++)
 293                 if (strcmp ("-to", argv[c]) == 0)
 294                         strcpy (argv[c], "-t");
 295
 296         while (1) {
 297                 c = getopt_long (argc, argv, "hVvt:H:s:r:a:", long_opts, &opt_index);
 298
 299                 if (c == -1 || c == EOF)
 300                         break;
 301
 302                 switch (c) {
 303                 case '?': /* args not parsable */
 304                         printf ("%s: Unknown argument: %s\n\n", progname, optarg);
 305                         print_usage ();
 306                         exit (STATE_UNKNOWN);
 307                 case 'h': /* help */
 308                         print_help ();
 309                         exit (STATE_OK);
 310                 case 'V': /* version */
 311                         print_revision (progname, REVISION);
 312                         exit (STATE_OK);
 313                 case 'v': /* version */
 314                         verbose = TRUE;
 315                         break;
 316                 case 't': /* timeout period */
 317                         timeout_interval = atoi (optarg);
 318                         break;
 319                 case 'H': /* hostname */
 320                         if (strlen (optarg) >= ADDRESS_LENGTH)
 321                                 terminate (STATE_UNKNOWN, "Input buffer overflow\n");
 322                         strcpy (query_address, optarg);
 323                         break;
 324                 case 's': /* server name */
 325                         /* TODO: this is_host check is probably unnecessary. Better to confirm nslookup
 326                            response matches */
 327                         if (is_host (optarg) == FALSE) {
 328                                 printf ("Invalid server name/address\n\n");
 329                                 print_usage ();
 330                                 exit (STATE_UNKNOWN);
 331                         }
 332                         if (strlen (optarg) >= ADDRESS_LENGTH)
 333                                 terminate (STATE_UNKNOWN, "Input buffer overflow\n");
 334                         strcpy (dns_server, optarg);
 335                         break;
 336                 case 'r': /* reverse server name */
 337                         /* TODO: Is this is_host necessary? */
 338                         if (is_host (optarg) == FALSE) {
 339                                 printf ("Invalid host name/address\n\n");
 340                                 print_usage ();
 341                                 exit (STATE_UNKNOWN);
 342                         }
 343                         if (strlen (optarg) >= ADDRESS_LENGTH)
 344                                 terminate (STATE_UNKNOWN, "Input buffer overflow\n");
 345                         strcpy (ptr_server, optarg);
 346                         break;
 347                 case 'a': /* expected address */
 348                         if (strlen (optarg) >= ADDRESS_LENGTH)
 349                                 terminate (STATE_UNKNOWN, "Input buffer overflow\n");
 350                         strcpy (expected_address, optarg);
 351                         match_expected_address = TRUE;
 352                         break;
 353                 }
 354         }
 355
 356         c = optind;
 357         if (strlen(query_address)==0 && c<argc) {
 358                 if (strlen(argv[c])>=ADDRESS_LENGTH)
 359                         terminate (STATE_UNKNOWN, "Input buffer overflow\n");
 360                 strcpy (query_address, argv[c++]);
 361         }
 362
 363         if (strlen(dns_server)==0 && c<argc) {
 364                 /* TODO: See -s option */
 365                 if (is_host(argv[c]) == FALSE) {
 366                         printf ("Invalid name/address: %s\n\n", argv[c]);
 367                         return ERROR;
 368                 }
 369                 if (strlen(argv[c]) >= ADDRESS_LENGTH)
 370                         terminate (STATE_UNKNOWN, "Input buffer overflow\n");
 371                 strcpy (dns_server, argv[c++]);
 372         }
 373
 374         return validate_arguments ();
 375 }
 376
 377 int
 378 validate_arguments ()
 379 {
 380         if (query_address[0] == 0)
 381                 return ERROR;
 382         else
 383                 return OK;
 384 }
 385
 386 void
 387 print_usage (void)
 388 {
 389         printf ("Usage: %s -H host [-s server] [-a expected-address] [-t timeout]\n" "       %s --help\n"
 390                                         "       %s --version\n", progname, progname, progname);
 391 }
 392
 393 void
 394 print_help (void)
 395 {
 396         print_revision (progname, REVISION);
 397         printf ("Copyright (c) 1999 Ethan Galstad (nagios@nagios.org)\n\n");
 398         print_usage ();
 399         printf
 400                 ("\nOptions:\n"
 401                  "-H, --hostname=HOST\n"
 402                  "   The name or address you want to query\n"
 403                  "-s, --server=HOST\n"
 404                  "   Optional DNS server you want to use for the lookup\n"
 405                  "-a, --expected-address=IP-ADDRESS\n"
 406                  "   Optional IP address you expect the DNS server to return\n"
 407                  "-t, --timeout=INTEGER\n"
 408                  "   Seconds before connection times out (default: %d)\n"
 409                  "-h, --help\n"
 410                  "   Print detailed help\n"
 411                  "-V, --version\n"
 412                  "   Print version numbers and license information\n"
 413                  "\n"
 414                  "This plugin uses the nslookup program to obtain the IP address\n"
 415                  "for the given host/domain query.  A optional DNS server to use may\n"
 416                  "be specified.  If no DNS server is specified, the default server(s)\n"
 417                  "specified in /etc/resolv.conf will be used.\n", DEFAULT_SOCKET_TIMEOUT);
 418 }