Code

return of process_arguments() is TRUE not OK !
[nagiosplug.git] / plugins / check_by_ssh.c
index de106f229269a339766c2004f116c0bcfed86b3c..20ae62833a53e88ffc85baddbcad38d36861120d 100644 (file)
@@ -1,25 +1,21 @@
 /******************************************************************************
- *
- * This file is part of the Nagios Plugins.
- *
- * Copyright (c) 1999, 2000, 2001 Karl DeBisschop <karl@debisschop.net>
- *
- * The Nagios Plugins are free software; you can redistribute them
- * and/or modify them under the terms of the GNU General Public
- * License as published by the Free Software Foundation; either
- * version 2 of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id$
- *
+
+ The Nagios Plugins are free software; you can redistribute them
+ and/or modify them under the terms of the GNU General Public
+ License as published by the Free Software Foundation; either
+ version 2 of the License, or (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+ $Id$
  *****************************************************************************/
  
 const char *progname = "check_by_ssh";
@@ -27,7 +23,6 @@ const char *revision = "$Revision$";
 const char *copyright = "2000-2003";
 const char *email = "nagiosplug-devel@lists.sourceforge.net";
 
-#include "config.h"
 #include "common.h"
 #include "netutils.h"
 #include "utils.h"
@@ -38,81 +33,11 @@ int validate_arguments (void);
 void print_help (void);
 void print_usage (void);
 
-void
-print_help (void)
-{
-       print_revision (progname, revision);
-
-       printf (_(COPYRIGHT), copyright, email);
-
-       printf (_("This plugin uses SSH to execute commands on a remote host\n\n"));
-
-       print_usage ();
-
-       printf (_(HELP_VRSN));
-
-       printf (_(HOST_PORT), 'p', "none");
-
-       printf (_(IPv46));
-
-       printf (_("\
- -1, --proto1\n\
-    tell ssh to use Protocol 1\n\
- -2, --proto2\n\
-    tell ssh to use Protocol 2\n\
- -f\n\
-    tells ssh to fork rather than create a tty\n"));
-
-       printf (_("\
- -C, --command='COMMAND STRING'\n\
-    command to execute on the remote machine\n\
- -l, --logname=USERNAME\n\
-    SSH user name on remote host [optional]\n\
- -i, --identity=KEYFILE\n\
-    identity of an authorized key [optional]\n\
- -O, --output=FILE\n\
-    external command file for nagios [optional]\n\
- -s, --services=LIST\n\
-    list of nagios service names, separated by ':' [optional]\n\
- -n, --name=NAME\n\
-    short name of host in nagios configuration [optional]\n"));
-
-       printf (_(WARN_CRIT_TO), DEFAULT_SOCKET_TIMEOUT);
-
-       printf (_("\n\
-The most common mode of use is to refer to a local identity file with\n\
-the '-i' option. In this mode, the identity pair should have a null\n\
-passphrase and the public key should be listed in the authorized_keys\n\
-file of the remote host. Usually the key will be restricted to running\n\
-only one command on the remote server. If the remote SSH server tracks\n\
-invocation agruments, the one remote program may be an agent that can\n\
-execute additional commands as proxy\n"));
-
-       printf (_("\n\
-To use passive mode, provide multiple '-C' options, and provide\n\
-all of -O, -s, and -n options (servicelist order must match '-C'\n\
-options)\n"));
-}
-
-
-
-
-
-void
-print_usage (void)
-{
-       printf (_("Usage:\n\
-check_by_ssh [-f46] [-t timeout] [-i identity] [-l user] -H <host> -C <command>\n\
-             [-n name] [-s servicelist] [-O outputfile] [-p port]\n\
-check_by_ssh  -V prints version info\n\
-check_by_ssh  -h prints more detailed help\n"));
-}
-\f
-
 int commands = 0;
 int services = 0;
-char *remotecmd = "";
-char *comm = SSH_COMMAND;
+int skip_lines = 0;
+char *remotecmd = NULL;
+char *comm = NULL;
 char *hostname = NULL;
 char *outputfile = NULL;
 char *host_shortname = NULL;
@@ -120,30 +45,36 @@ char **service;
 int passive = FALSE;
 int verbose = FALSE;
 
-
 int
 main (int argc, char **argv)
 {
 
        char input_buffer[MAX_INPUT_BUFFER];
-       char *result_text = "";
+       char *result_text;
        char *status_text;
-       char *output = "";
+       char *output;
        char *eol = NULL;
        int cresult;
        int result = STATE_UNKNOWN;
        time_t local_time;
        FILE *fp = NULL;
 
+       remotecmd = strdup ("");
+       comm = strdup (SSH_COMMAND);
+       result_text = strdup ("");
+
+       setlocale (LC_ALL, "");
+       bindtextdomain (PACKAGE, LOCALEDIR);
+       textdomain (PACKAGE);
 
        /* process arguments */
-       if (process_arguments (argc, argv) == ERROR)
-               usage (_("Could not parse arguments\n"));
+       if (process_arguments (argc, argv) != TRUE)
+               usage (_("check_by_ssh: could not parse arguments\n"));
 
 
        /* Set signal handling and alarm timeout */
        if (signal (SIGALRM, popen_timeout_alarm_handler) == SIG_ERR) {
-               printf ("Cannot catch SIGALRM");
+               printf (_("Cannot catch SIGALRM"));
                return STATE_UNKNOWN;
        }
        alarm (timeout_interval);
@@ -157,7 +88,7 @@ main (int argc, char **argv)
        child_process = spopen (comm);
 
        if (child_process == NULL) {
-               printf (_("Unable to open pipe: %s"), comm);
+               printf (_("Could not open pipe: %s\n"), comm);
                return STATE_UNKNOWN;
        }
 
@@ -169,17 +100,24 @@ main (int argc, char **argv)
        }
 
 
-       /* get results from remote command */
+       /* build up results from remote command in result_text */
        while (fgets (input_buffer, MAX_INPUT_BUFFER - 1, child_process))
                asprintf (&result_text, "%s%s", result_text, input_buffer);
 
-
        /* WARNING if output found on stderr */
-       if (fgets (input_buffer, MAX_INPUT_BUFFER - 1, child_stderr)) {
-               printf ("%s\n", input_buffer);
-               return STATE_WARNING;
+       while (fgets (input_buffer, MAX_INPUT_BUFFER - 1, child_stderr)) {
+               if (skip_lines > 0) {
+                       if (input_buffer[strlen(input_buffer)-1] == '\n') {
+                               skip_lines--;
+                       }
+               } else {
+                       printf ("%s", input_buffer);
+                       result = STATE_WARNING;
+               }
        }
        (void) fclose (child_stderr);
+       if (result == STATE_WARNING)
+               return result;
 
 
        /* close the pipe */
@@ -194,10 +132,10 @@ main (int argc, char **argv)
                        exit (STATE_UNKNOWN);
                }
 
-               time (&local_time);
+               local_time = time (NULL);
                commands = 0;
                while (result_text && strlen(result_text) > 0) {
-                       status_text = strstr (result_text, _("STATUS CODE: "));
+                       status_text = strstr (result_text, "STATUS CODE: ");
                        if (status_text == NULL) {
                                printf ("%s", result_text);
                                return result;
@@ -208,8 +146,8 @@ main (int argc, char **argv)
                        if (eol != NULL)
                                eol[0] = 0;
                        if (service[commands] && status_text
-                                       && sscanf (status_text, _("STATUS CODE: %d"), &cresult) == 1) {
-                               fprintf (fp, _("[%d] PROCESS_SERVICE_CHECK_RESULT;%s;%s;%d;%s\n"),
+                                       && sscanf (status_text, "STATUS CODE: %d", &cresult) == 1) {
+                               fprintf (fp, "[%d] PROCESS_SERVICE_CHECK_RESULT;%s;%s;%d;%s\n",
                                                                 (int) local_time, host_shortname, service[commands++], cresult,
                                                                 output);
                        }
@@ -217,6 +155,7 @@ main (int argc, char **argv)
 
        }
 
+
        /* print the first line from the remote command */
        else {
                eol = strpbrk (result_text, "\r\n");
@@ -225,14 +164,11 @@ main (int argc, char **argv)
                printf ("%s\n", result_text);
        }
 
-       /* return error status from remote command */
+
+       /* return error status from remote command */   
        return result;
 }
 
-
-
-
-
 /* process command-line arguments */
 int
 process_arguments (int argc, char **argv)
@@ -240,8 +176,8 @@ process_arguments (int argc, char **argv)
        int c;
        char *p1, *p2;
 
-       int option_index = 0;
-       static struct option long_options[] = {
+       int option = 0;
+       static struct option longopts[] = {
                {"version", no_argument, 0, 'V'},
                {"help", no_argument, 0, 'h'},
                {"verbose", no_argument, 0, 'v'},
@@ -256,6 +192,7 @@ process_arguments (int argc, char **argv)
                {"user", required_argument, 0, 'u'},
                {"logname", required_argument, 0, 'l'},
                {"command", required_argument, 0, 'C'},
+               {"skip", required_argument, 0, 'S'},
                {"proto1", no_argument, 0, '1'},
                {"proto2", no_argument, 0, '2'},
                {"use-ipv4", no_argument, 0, '4'},
@@ -271,18 +208,19 @@ process_arguments (int argc, char **argv)
                        strcpy (argv[c], "-t");
 
        while (1) {
-               c = getopt_long (argc, argv, "Vvh1246ft:H:O:p:i:u:l:C:n:s:", long_options,
-                                                                        &option_index);
+               c = getopt_long (argc, argv, "Vvh1246ft:H:O:p:i:u:l:C:S:n:s:", longopts,
+                                                                        &option);
 
                if (c == -1 || c == EOF)
                        break;
 
                switch (c) {
                case '?':                                                                       /* help */
+                       printf (_("%s: Unknown argument: %s\n\n"), progname, optarg);
                        print_usage ();
                        exit (STATE_UNKNOWN);
                case 'V':                                                                       /* version */
-                       print_revision (progname, "$Revision$");
+                       print_revision (progname, revision);
                        exit (STATE_OK);
                case 'h':                                                                       /* help */
                        print_help ();
@@ -292,17 +230,18 @@ process_arguments (int argc, char **argv)
                        break;
                case 't':                                                                       /* timeout period */
                        if (!is_integer (optarg))
-                               usage2 (_("timeout interval must be an integer"), optarg);
-                       timeout_interval = atoi (optarg);
+                               usage2 (_("Timeout interval must be a positive integer"), optarg);
+                       else
+                               timeout_interval = atoi (optarg);
                        break;
                case 'H':                                                                       /* host */
                        if (!is_host (optarg))
-                               usage2 (_("invalid host name"), optarg);
+                               usage2 (_("Invalid hostname/address"), optarg);
                        hostname = optarg;
                        break;
                case 'p': /* port number */
                        if (!is_integer (optarg))
-                               usage2 (_("port must be an integer"), optarg);
+                               usage2 (_("Port must be a positive integer"), optarg);
                        asprintf (&comm,"%s -p %s", comm, optarg);
                        break;
                case 'O':                                                                       /* output file */
@@ -341,15 +280,22 @@ process_arguments (int argc, char **argv)
                        if (commands > 1)
                                asprintf (&remotecmd, "%s;echo STATUS CODE: $?;", remotecmd);
                        asprintf (&remotecmd, "%s%s", remotecmd, optarg);
+                       break;
+               case 'S':                                                                       /* Skip n lines in the output to ignore system banner */
+                       if (!is_integer (optarg))
+                               usage2 (_("skip lines must be an integer"), optarg);
+                       else
+                               skip_lines = atoi (optarg);
+                       break;
                }
        }
 
        c = optind;
        if (hostname == NULL) {
                if (c <= argc) {
-                       terminate (STATE_UNKNOWN, _("%s: You must provide a host name\n"), progname);
+                       die (STATE_UNKNOWN, _("%s: You must provide a host name\n"), progname);
                } else if (!is_host (argv[c]))
-                       terminate (STATE_UNKNOWN, _("%s: Invalid host name %s\n"), progname, argv[c]);
+                       die (STATE_UNKNOWN, "%s: %s %s\n", progname, _("Invalid hostname/address"), argv[c]);
                hostname = argv[c++];
        }
 
@@ -362,7 +308,7 @@ process_arguments (int argc, char **argv)
        }
 
        if (commands > 1)
-               remotecmd = strscat (remotecmd, ";echo STATUS CODE: $?;");
+               asprintf (&remotecmd, "%s;echo STATUS CODE: $?;", remotecmd);
 
        if (remotecmd == NULL || strlen (remotecmd) <= 1)
                usage (_("No remotecmd\n"));
@@ -374,8 +320,6 @@ process_arguments (int argc, char **argv)
 
 
 
-
-
 int
 validate_arguments (void)
 {
@@ -383,10 +327,94 @@ validate_arguments (void)
                return ERROR;
 
        if (passive && commands != services)
-               terminate (STATE_UNKNOWN, _("%s: In passive mode, you must provide a service name for each command.\n"), progname);
+               die (STATE_UNKNOWN, _("%s: In passive mode, you must provide a service name for each command.\n"), progname);
 
        if (passive && host_shortname == NULL)
-               terminate (STATE_UNKNOWN, _("%s: In passive mode, you must provide the host short name from the nagios configs.\n"), progname);
+               die (STATE_UNKNOWN, _("%s: In passive mode, you must provide the host short name from the nagios configs.\n"), progname);
 
        return OK;
 }
+
+
+void
+print_help (void)
+{
+       print_revision (progname, revision);
+
+       printf (_("Copyright (c) 1999 Karl DeBisschop <kdebisschop@users.sourceforge.net>\n"));
+       printf (_(COPYRIGHT), copyright, email);
+
+       printf (_("This plugin uses SSH to execute commands on a remote host\n\n"));
+
+       print_usage ();
+
+       printf (_(UT_HELP_VRSN));
+
+       printf (_(UT_HOST_PORT), 'p', "none");
+
+       printf (_(UT_IPv46));
+
+       printf (_("\
+ -1, --proto1\n\
+    tell ssh to use Protocol 1\n\
+ -2, --proto2\n\
+    tell ssh to use Protocol 2\n\
+ -S, --skiplines=n\n\
+    Ignore first n lines on STDERR (to suppress a logon banner)\n\
+ -f\n\
+    tells ssh to fork rather than create a tty\n"));
+
+       printf (_("\
+ -C, --command='COMMAND STRING'\n\
+    command to execute on the remote machine\n\
+ -l, --logname=USERNAME\n\
+    SSH user name on remote host [optional]\n\
+ -i, --identity=KEYFILE\n\
+    identity of an authorized key [optional]\n\
+ -O, --output=FILE\n\
+    external command file for nagios [optional]\n\
+ -s, --services=LIST\n\
+    list of nagios service names, separated by ':' [optional]\n\
+ -n, --name=NAME\n\
+    short name of host in nagios configuration [optional]\n"));
+
+       printf (_(UT_WARN_CRIT));
+
+       printf (_(UT_TIMEOUT), DEFAULT_SOCKET_TIMEOUT);
+
+       printf (_("\n\
+The most common mode of use is to refer to a local identity file with\n\
+the '-i' option. In this mode, the identity pair should have a null\n\
+passphrase and the public key should be listed in the authorized_keys\n\
+file of the remote host. Usually the key will be restricted to running\n\
+only one command on the remote server. If the remote SSH server tracks\n\
+invocation agruments, the one remote program may be an agent that can\n\
+execute additional commands as proxy\n"));
+
+       printf (_("\n\
+To use passive mode, provide multiple '-C' options, and provide\n\
+all of -O, -s, and -n options (servicelist order must match '-C'\n\
+options)\n"));
+
+       printf (_("\n\
+$ check_by_ssh -H localhost -n lh -s c1:c2:c3 \\\n\
+    -C uptime -C uptime -C uptime -O /tmp/foo\n\
+$ cat /tmp/foo\n\
+[1080933700] PROCESS_SERVICE_CHECK_RESULT;flint;c1;0; up 2 days...\n\
+[1080933700] PROCESS_SERVICE_CHECK_RESULT;flint;c2;0; up 2 days...\n\
+[1080933700] PROCESS_SERVICE_CHECK_RESULT;flint;c3;0; up 2 days...\n"));
+
+       printf (_(UT_SUPPORT));
+}
+
+
+
+void
+print_usage (void)
+{
+       printf (_("\n\
+Usage: %s [-f46] [-t timeout] [-i identity] [-l user] -H <host> \n\
+  -C <command> [-n name] [-s servicelist] [-O outputfile] [-p port]\n"),
+               progname);
+       printf (_(UT_HLP_VRS), progname, progname);
+}