X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=plugins%2Fcheck_by_ssh.c;h=793c03d347365c4febb4405af8f3ba046b3aba02;hb=9c1aa029c088d6d52c7978198136731925c5f385;hp=b777b072f65d9d325b8ef873bb93f0a4d55c22fc;hpb=ceebd58040b1688749d58dd76963af639cf8c803;p=nagiosplug.git diff --git a/plugins/check_by_ssh.c b/plugins/check_by_ssh.c index b777b07..793c03d 100644 --- a/plugins/check_by_ssh.c +++ b/plugins/check_by_ssh.c @@ -1,43 +1,57 @@ -/****************************************************************************** - - 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$ - - *****************************************************************************/ - +/***************************************************************************** +* +* Nagios check_by_ssh plugin +* +* License: GPL +* Copyright (c) 2000-2008 Nagios Plugins Development Team +* +* Description: +* +* This file contains the check_by_ssh plugin +* +* +* This program is free software: you can redistribute it and/or modify +* it under the terms of the GNU General Public License as published by +* the Free Software Foundation, either version 3 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, see . +* +* +*****************************************************************************/ + const char *progname = "check_by_ssh"; -const char *revision = "$Revision$"; -const char *copyright = "2000-2004"; +const char *copyright = "2000-2008"; const char *email = "nagiosplug-devel@lists.sourceforge.net"; #include "common.h" -#include "netutils.h" #include "utils.h" -#include "runcmd.h" +#include "netutils.h" +#include "utils_cmd.h" + +#ifndef NP_MAXARGS +#define NP_MAXARGS 1024 +#endif int process_arguments (int, char **); int validate_arguments (void); +void comm_append (const char *); void print_help (void); void print_usage (void); -int commands = 0; -int services = 0; -int skip = 0; +unsigned int commands = 0; +unsigned int services = 0; +int skip_stdout = 0; +int skip_stderr = 0; char *remotecmd = NULL; -char *comm = NULL; +char **commargv = NULL; +int commargc = 0; char *hostname = NULL; char *outputfile = NULL; char *host_shortname = NULL; @@ -55,41 +69,58 @@ main (int argc, char **argv) int i; time_t local_time; FILE *fp = NULL; - struct output chld_out, chld_err; + output chld_out, chld_err; remotecmd = ""; - comm = strdup (SSH_COMMAND); + comm_append(SSH_COMMAND); setlocale (LC_ALL, ""); bindtextdomain (PACKAGE, LOCALEDIR); textdomain (PACKAGE); + /* Parse extra opts if any */ + argv=np_extra_opts (&argc, argv, progname); + /* process arguments */ if (process_arguments (argc, argv) == ERROR) usage_va(_("Could not parse arguments")); /* Set signal handling and alarm timeout */ - if (signal (SIGALRM, popen_timeout_alarm_handler) == SIG_ERR) { + if (signal (SIGALRM, timeout_alarm_handler) == SIG_ERR) { usage_va(_("Cannot catch SIGALRM")); } alarm (timeout_interval); /* run the command */ - if (verbose) - printf ("%s\n", comm); - - result = np_runcmd(comm, &chld_out, &chld_err, 0); - /* UNKNOWN if output found on stderr */ - if(chld_err.buflen) { - printf(_("Remote command execution failed: %s\n"), - chld_err.buflen ? chld_err.buf : _("Unknown error")); - return STATE_UNKNOWN; + if (verbose) { + printf ("Command: %s\n", commargv[0]); + for (i=1; i skip_stderr) { + printf (_("Remote command execution failed: %s\n"), + chld_err.line[skip_stderr]); + return max_state_alt(result, STATE_UNKNOWN); } /* this is simple if we're not supposed to be passive. * Wrap up quickly and keep the tricks below */ if(!passive) { - printf ("%s\n", skip < chld_out.lines ? chld_out.line[skip] : chld_out.buf); + if (chld_out.lines > skip_stdout) + for (i = skip_stdout; i < chld_out.lines; i++) + puts (chld_out.line[i]); + else + printf (_("%s - check_by_ssh: Remote command '%s' returned status %d\n"), + state_text(result), remotecmd, result); return result; /* return error status from remote command */ } @@ -106,22 +137,21 @@ main (int argc, char **argv) local_time = time (NULL); commands = 0; - for(i = skip; chld_out.line[i]; i++) { - status_text = strstr (chld_out.line[i], "STATUS CODE: "); - if (status_text == NULL) { - printf ("%s", chld_out.line[i]); - return result; - } + for(i = skip_stdout; i < chld_out.lines; i++) { + status_text = chld_out.line[i++]; + if (i == chld_out.lines || strstr (chld_out.line[i], "STATUS CODE: ") == NULL) + die (STATE_UNKNOWN, _("%s: Error parsing output\n"), progname); + if (service[commands] && status_text - && sscanf (status_text, "STATUS CODE: %d", &cresult) == 1) + && sscanf (chld_out.line[i], "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, chld_out.line[i]); + cresult, status_text); } } - /* force an OK state */ + /* Multiple commands and passive checking should always return OK */ return result; } @@ -148,11 +178,15 @@ 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'}, + {"skip", optional_argument, 0, 'S'}, /* backwards compatibility */ + {"skip-stdout", optional_argument, 0, 'S'}, + {"skip-stderr", optional_argument, 0, 'E'}, {"proto1", no_argument, 0, '1'}, {"proto2", no_argument, 0, '2'}, {"use-ipv4", no_argument, 0, '4'}, {"use-ipv6", no_argument, 0, '6'}, + {"ssh-option", required_argument, 0, 'o'}, + {"quiet", no_argument, 0, 'q'}, {0, 0, 0, 0} }; @@ -164,7 +198,7 @@ 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:S:n:s:", longopts, + c = getopt_long (argc, argv, "Vvh1246fqt:H:O:p:i:u:l:C:S::E::n:s:o:", longopts, &option); if (c == -1 || c == EOF) @@ -172,7 +206,7 @@ process_arguments (int argc, char **argv) switch (c) { case 'V': /* version */ - print_revision (progname, revision); + print_revision (progname, NP_VERSION); exit (STATE_OK); case 'h': /* help */ print_help (); @@ -193,7 +227,8 @@ process_arguments (int argc, char **argv) case 'p': /* port number */ if (!is_integer (optarg)) usage_va(_("Port must be a positive integer")); - asprintf (&comm,"%s -p %s", comm, optarg); + comm_append("-p"); + comm_append(optarg); break; case 'O': /* output file */ outputfile = optarg; @@ -215,18 +250,32 @@ process_arguments (int argc, char **argv) break; case 'u': - c = 'l'; + comm_append("-l"); + comm_append(optarg); + break; case 'l': /* login name */ + comm_append("-l"); + comm_append(optarg); + break; case 'i': /* identity */ - asprintf (&comm, "%s -%c %s", comm, c, optarg); + comm_append("-i"); + comm_append(optarg); break; case '1': /* Pass these switches directly to ssh */ + comm_append("-1"); + break; case '2': /* 1 to force version 1, 2 to force version 2 */ + comm_append("-2"); + break; case '4': /* -4 for IPv4 */ + comm_append("-4"); + break; case '6': /* -6 for IPv6 */ + comm_append("-6"); + break; case 'f': /* fork to background */ - asprintf (&comm, "%s -%c", comm, c); + comm_append("-f"); break; case 'C': /* Command for remote machine */ commands++; @@ -234,14 +283,31 @@ process_arguments (int argc, char **argv) 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)) - usage_va(_("skip lines must be an integer")); + case 'S': /* skip n (or all) lines on stdout */ + if (optarg == NULL) + skip_stdout = -1; /* skip all output on stdout */ + else if (!is_integer (optarg)) + usage_va(_("skip-stdout argument must be an integer")); + else + skip_stdout = atoi (optarg); + break; + case 'E': /* skip n (or all) lines on stderr */ + if (optarg == NULL) + skip_stderr = -1; /* skip all output on stderr */ + else if (!is_integer (optarg)) + usage_va(_("skip-stderr argument must be an integer")); else - skip = atoi (optarg); + skip_stderr = atoi (optarg); + break; + case 'o': /* Extra options for the ssh command */ + comm_append("-o"); + comm_append(optarg); + break; + case 'q': /* Tell the ssh command to be quiet */ + comm_append("-q"); break; default: /* help */ - usage_va(_("Unknown argument - %s"), optarg); + usage5(); } } @@ -262,18 +328,33 @@ process_arguments (int argc, char **argv) asprintf (&remotecmd, "%s", argv[c]); } - if (commands > 1) + if (commands > 1 || passive) asprintf (&remotecmd, "%s;echo STATUS CODE: $?;", remotecmd); if (remotecmd == NULL || strlen (remotecmd) <= 1) usage_va(_("No remotecmd")); - asprintf (&comm, "%s %s '%s'", comm, hostname, remotecmd); + comm_append(hostname); + comm_append(remotecmd); return validate_arguments (); } +void +comm_append (const char *str) +{ + + if (++commargc > NP_MAXARGS) + die(STATE_UNKNOWN, _("%s: Argument limit of %d exceeded\n"), progname, NP_MAXARGS); + + if ((commargv = (char **)realloc(commargv, (commargc+1) * sizeof(char *))) == NULL) + die(STATE_UNKNOWN, _("Can not (re)allocate 'commargv' buffer\n")); + + commargv[commargc-1] = strdup(str); + commargv[commargc] = NULL; + +} int validate_arguments (void) @@ -294,72 +375,80 @@ validate_arguments (void) void print_help (void) { - print_revision (progname, revision); + print_revision (progname, NP_VERSION); printf ("Copyright (c) 1999 Karl DeBisschop \n"); printf (COPYRIGHT, copyright, email); - printf (_("This plugin uses SSH to execute commands on a remote host\n\n")); + printf (_("This plugin uses SSH to execute commands on a remote host")); + + printf ("\n\n"); print_usage (); printf (_(UT_HELP_VRSN)); + printf (_(UT_EXTRA_OPTS)); + 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 (" %s\n", "-1, --proto1"); + printf (" %s\n", _("tell ssh to use Protocol 1 [optional]")); + printf (" %s\n", "-2, --proto2"); + printf (" %s\n", _("tell ssh to use Protocol 2 [optional]")); + printf (" %s\n", "-S, --skip-stdout[=n]"); + printf (" %s\n", _("Ignore all or (if specified) first n lines on STDOUT [optional]")); + printf (" %s\n", "-E, --skip-stderr[=n]"); + printf (" %s\n", _("Ignore all or (if specified) first n lines on STDERR [optional]")); + printf (" %s\n", "-f"); + printf (" %s\n", _("tells ssh to fork rather than create a tty [optional]. This will always return OK if ssh is executed")); + printf (" %s\n","-C, --command='COMMAND STRING'"); + printf (" %s\n", _("command to execute on the remote machine")); + printf (" %s\n","-l, --logname=USERNAME"); + printf (" %s\n", _("SSH user name on remote host [optional]")); + printf (" %s\n","-i, --identity=KEYFILE"); + printf (" %s\n", _("identity of an authorized key [optional]")); + printf (" %s\n","-O, --output=FILE"); + printf (" %s\n", _("external command file for nagios [optional]")); + printf (" %s\n","-s, --services=LIST"); + printf (" %s\n", _("list of nagios service names, separated by ':' [optional]")); + printf (" %s\n","-n, --name=NAME"); + printf (" %s\n", _("short name of host in nagios configuration [optional]")); + printf (" %s\n","-o, --ssh-option=OPTION"); + printf (" %s\n", _("Call ssh with '-o OPTION' (may be used multiple times) [optional]")); + printf (" %s\n","-q, --quiet"); + printf (" %s\n", _("Tell ssh to suppress warning and diagnostic messages [optional]")); 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)); + printf (_(UT_VERBOSE)); + printf("\n"); + printf (" %s\n", _("The most common mode of use is to refer to a local identity file with")); + printf (" %s\n", _("the '-i' option. In this mode, the identity pair should have a null")); + printf (" %s\n", _("passphrase and the public key should be listed in the authorized_keys")); + printf (" %s\n", _("file of the remote host. Usually the key will be restricted to running")); + printf (" %s\n", _("only one command on the remote server. If the remote SSH server tracks")); + printf (" %s\n", _("invocation arguments, the one remote program may be an agent that can")); + printf (" %s\n", _("execute additional commands as proxy")); + printf("\n"); + printf (" %s\n", _("To use passive mode, provide multiple '-C' options, and provide")); + printf (" %s\n", _("all of -O, -s, and -n options (servicelist order must match '-C'options)")); + printf ("\n"); + printf ("%s\n", _("Examples:")); + printf (" %s\n", "$ check_by_ssh -H localhost -n lh -s c1:c2:c3 -C uptime -C uptime -C uptime -O /tmp/foo"); + printf (" %s\n", "$ cat /tmp/foo"); + printf (" %s\n", "[1080933700] PROCESS_SERVICE_CHECK_RESULT;flint;c1;0; up 2 days"); + printf (" %s\n", "[1080933700] PROCESS_SERVICE_CHECK_RESULT;flint;c2;0; up 2 days"); + printf (" %s\n", "[1080933700] PROCESS_SERVICE_CHECK_RESULT;flint;c3;0; up 2 days"); + +#ifdef NP_EXTRA_OPTS + printf("\n"); + printf("%s\n", _("Notes:")); + printf(_(UT_EXTRA_OPTS_NOTES)); +#endif + + printf(_(UT_SUPPORT)); } @@ -367,7 +456,10 @@ $ cat /tmp/foo\n\ void print_usage (void) { - printf ("\n\ -Usage: %s [-f46] [-t timeout] [-i identity] [-l user] -H -C \n\ - [-n name] [-s servicelist] [-O outputfile] [-p port]\n", progname); + printf (_("Usage:")); + printf (" %s -H -C [-fqv] [-1|-2] [-4|-6]\n" + " [-S [lines]] [-E [lines]] [-t timeout] [-i identity]\n" + " [-l user] [-n name] [-s servicelist] [-O outputfile]\n" + " [-p port] [-o ssh-option]\n", + progname); }