1 /*****************************************************************************
3 * Nagios check_tcp plugin
6 * Copyright (c) 1999-2008 Nagios Plugins Development Team
8 * Last Modified: $Date$
12 * This file contains the check_tcp plugin
15 * This program is free software: you can redistribute it and/or modify
16 * it under the terms of the GNU General Public License as published by
17 * the Free Software Foundation, either version 3 of the License, or
18 * (at your option) any later version.
20 * This program is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
25 * You should have received a copy of the GNU General Public License
26 * along with this program. If not, see <http://www.gnu.org/licenses/>.
30 *****************************************************************************/
32 /* progname "check_tcp" changes depending on symlink called */
34 const char *revision
= "$Revision$";
35 const char *copyright
= "1999-2008";
36 const char *email
= "nagiosplug-devel@lists.sourceforge.net";
41 #include "utils_tcp.h"
44 static int check_cert
= FALSE
;
45 static int days_till_exp
;
46 # define my_recv(buf, len) ((flags & FLAG_SSL) ? np_net_ssl_read(buf, len) : read(sd, buf, len))
47 # define my_send(buf, len) ((flags & FLAG_SSL) ? np_net_ssl_write(buf, len) : send(sd, buf, len, 0))
49 # define my_recv(buf, len) read(sd, buf, len)
50 # define my_send(buf, len) send(sd, buf, len, 0)
53 /* int my_recv(char *, size_t); */
54 static int process_arguments (int, char **);
55 void print_help (void);
56 void print_usage (void);
58 #define EXPECT server_expect[0]
59 static char *SERVICE
= "TCP";
60 static char *SEND
= NULL
;
61 static char *QUIT
= NULL
;
62 static int PROTOCOL
= IPPROTO_TCP
; /* most common is default */
65 static int server_port
= 0;
66 static char *server_address
= NULL
;
67 static char *server_send
= NULL
;
68 static char *server_quit
= NULL
;
69 static char **server_expect
;
70 static size_t server_expect_count
= 0;
71 static size_t maxbytes
= 0;
72 static char **warn_codes
= NULL
;
73 static size_t warn_codes_count
= 0;
74 static char **crit_codes
= NULL
;
75 static size_t crit_codes_count
= 0;
76 static unsigned int delay
= 0;
77 static double warning_time
= 0;
78 static double critical_time
= 0;
79 static double elapsed_time
= 0;
83 static char buffer
[MAXBUF
];
84 static int expect_mismatch_state
= STATE_WARNING
;
87 #define FLAG_VERBOSE 0x02
88 #define FLAG_EXACT_MATCH 0x04
89 #define FLAG_TIME_WARN 0x08
90 #define FLAG_TIME_CRIT 0x10
91 #define FLAG_HIDE_OUTPUT 0x20
92 #define FLAG_MATCH_ALL 0x40
93 static size_t flags
= FLAG_EXACT_MATCH
;
96 main (int argc
, char **argv
)
98 int result
= STATE_UNKNOWN
;
105 setlocale (LC_ALL
, "");
106 bindtextdomain (PACKAGE
, LOCALEDIR
);
107 textdomain (PACKAGE
);
109 /* determine program- and service-name quickly */
110 progname
= strrchr(argv
[0], '/');
111 if(progname
!= NULL
) progname
++;
112 else progname
= argv
[0];
114 len
= strlen(progname
);
115 if(len
> 6 && !memcmp(progname
, "check_", 6)) {
116 SERVICE
= strdup(progname
+ 6);
117 for(i
= 0; i
< len
- 6; i
++)
118 SERVICE
[i
] = toupper(SERVICE
[i
]);
121 /* set up a resonable buffer at first (will be realloc()'ed if
122 * user specifies other options) */
123 server_expect
= calloc(sizeof(char *), 2);
125 /* determine defaults for this service's protocol */
126 if (!strncmp(SERVICE
, "UDP", 3)) {
127 PROTOCOL
= IPPROTO_UDP
;
129 else if (!strncmp(SERVICE
, "FTP", 3)) {
134 else if (!strncmp(SERVICE
, "POP", 3) || !strncmp(SERVICE
, "POP3", 4)) {
139 else if (!strncmp(SERVICE
, "SMTP", 4)) {
144 else if (!strncmp(SERVICE
, "IMAP", 4)) {
146 QUIT
= "a1 LOGOUT\r\n";
150 else if (!strncmp(SERVICE
, "SIMAP", 5)) {
152 QUIT
= "a1 LOGOUT\r\n";
156 else if (!strncmp(SERVICE
, "SPOP", 4)) {
162 else if (!strncmp(SERVICE
, "SSMTP", 5)) {
168 else if (!strncmp(SERVICE
, "JABBER", 6)) {
169 SEND
= "<stream:stream to=\'host\' xmlns=\'jabber:client\' xmlns:stream=\'http://etherx.jabber.org/streams\'>\n";
170 EXPECT
= "<?xml version=\'1.0\'?><stream:stream xmlns=\'jabber:client\' xmlns:stream=\'http://etherx.jabber.org/streams\'";
171 QUIT
= "</stream:stream>\n";
172 flags
|= FLAG_HIDE_OUTPUT
;
175 else if (!strncmp (SERVICE
, "NNTPS", 5)) {
176 server_expect_count
= 2;
177 server_expect
[0] = "200";
178 server_expect
[1] = "201";
184 else if (!strncmp (SERVICE
, "NNTP", 4)) {
185 server_expect_count
= 2;
186 server_expect
= malloc(sizeof(char *) * server_expect_count
);
187 server_expect
[0] = strdup("200");
188 server_expect
[1] = strdup("201");
192 else if (!strncmp(SERVICE
, "CLAMD", 5)) {
198 /* fallthrough check, so it's supposed to use reverse matching */
199 else if (strcmp (SERVICE
, "TCP"))
200 usage (_("CRITICAL - Generic check_tcp called with unknown service\n"));
202 server_address
= "127.0.0.1";
208 /* Parse extra opts if any */
209 argv
=np_extra_opts (&argc
, argv
, progname
);
211 if (process_arguments (argc
, argv
) == ERROR
)
212 usage4 (_("Could not parse arguments"));
214 if(flags
& FLAG_VERBOSE
) {
215 printf("Using service %s\n", SERVICE
);
216 printf("Port: %d\n", server_port
);
217 printf("flags: 0x%x\n", (int)flags
);
220 if(EXPECT
&& !server_expect_count
)
221 server_expect_count
++;
223 if(PROTOCOL
==IPPROTO_UDP
&& !(server_expect_count
&& server_send
)){
224 usage(_("With UDP checks, a send/expect string must be specified."));
227 /* set up the timer */
228 signal (SIGALRM
, socket_timeout_alarm_handler
);
229 alarm (socket_timeout
);
231 /* try to connect to the host at the given port number */
232 gettimeofday (&tv
, NULL
);
234 result
= np_net_connect (server_address
, server_port
, &sd
, PROTOCOL
);
235 if (result
== STATE_CRITICAL
) return STATE_CRITICAL
;
238 if (flags
& FLAG_SSL
){
239 result
= np_net_ssl_init(sd
);
240 if (result
== STATE_OK
&& check_cert
== TRUE
) {
241 result
= np_net_ssl_check_cert(days_till_exp
);
242 if(result
!= STATE_OK
) {
243 printf(_("CRITICAL - Cannot retrieve server certificate.\n"));
247 if(result
!= STATE_OK
){
248 np_net_ssl_cleanup();
252 #endif /* HAVE_SSL */
254 if (server_send
!= NULL
) { /* Something to send? */
255 my_send(server_send
, strlen(server_send
));
263 if(flags
& FLAG_VERBOSE
) {
265 printf("Send string: %s\n", server_send
);
268 printf("Quit string: %s\n", server_quit
);
270 printf("server_expect_count: %d\n", (int)server_expect_count
);
271 for(i
= 0; i
< server_expect_count
; i
++)
272 printf("\t%d: %s\n", i
, server_expect
[i
]);
275 /* if(len) later on, we know we have a non-NULL response */
277 if (server_expect_count
) {
279 /* watch for the expect string */
280 while ((i
= my_recv(buffer
, sizeof(buffer
))) > 0) {
281 status
= realloc(status
, len
+ i
+ 1);
282 memcpy(&status
[len
], buffer
, i
);
285 /* stop reading if user-forced or data-starved */
286 if(i
< sizeof(buffer
) || (maxbytes
&& len
>= maxbytes
))
289 if (maxbytes
&& len
>= maxbytes
)
293 /* no data when expected, so return critical */
295 die (STATE_CRITICAL
, _("No data received from host\n"));
297 /* force null-termination and strip whitespace from end of output */
298 status
[len
--] = '\0';
299 /* print raw output if we're debugging */
300 if(flags
& FLAG_VERBOSE
)
301 printf("received %d bytes from host\n#-raw-recv-------#\n%s\n#-raw-recv-------#\n",
302 (int)len
+ 1, status
);
303 while(isspace(status
[len
])) status
[len
--] = '\0';
305 match
= np_expect_match(status
,
308 (flags
& FLAG_MATCH_ALL
? TRUE
: FALSE
),
309 (flags
& FLAG_EXACT_MATCH
? TRUE
: FALSE
),
310 (flags
& FLAG_VERBOSE
? TRUE
: FALSE
));
313 if (server_quit
!= NULL
) {
314 my_send(server_quit
, strlen(server_quit
));
317 np_net_ssl_cleanup();
321 microsec
= deltime (tv
);
322 elapsed_time
= (double)microsec
/ 1.0e6
;
324 if (flags
& FLAG_TIME_CRIT
&& elapsed_time
> critical_time
)
325 result
= STATE_CRITICAL
;
326 else if (flags
& FLAG_TIME_WARN
&& elapsed_time
> warning_time
)
327 result
= STATE_WARNING
;
329 /* did we get the response we hoped? */
330 if(match
== FALSE
&& result
!= STATE_CRITICAL
)
331 result
= expect_mismatch_state
;
333 /* reset the alarm */
336 /* this is a bit stupid, because we don't want to print the
337 * response time (which can look ok to the user) if we didn't get
338 * the response we were looking for. if-else */
339 printf("%s %s - ", SERVICE
, state_text(result
));
341 if(match
== FALSE
&& len
&& !(flags
& FLAG_HIDE_OUTPUT
))
342 printf("Unexpected response from host/socket: %s", status
);
345 printf("Unexpected response from host/socket on ");
347 printf("%.3f second response time on ", elapsed_time
);
348 if(server_address
[0] != '/')
349 printf("port %d", server_port
);
351 printf("socket %s", server_address
);
354 if (match
!= FALSE
&& !(flags
& FLAG_HIDE_OUTPUT
) && len
)
355 printf (" [%s]", status
);
357 /* perf-data doesn't apply when server doesn't talk properly,
358 * so print all zeroes on warn and crit. Use fperfdata since
359 * localisation settings can make different outputs */
362 fperfdata ("time", elapsed_time
, "s",
363 (flags
& FLAG_TIME_WARN
? TRUE
: FALSE
), 0,
364 (flags
& FLAG_TIME_CRIT
? TRUE
: FALSE
), 0,
366 TRUE
, socket_timeout
)
370 fperfdata ("time", elapsed_time
, "s",
371 (flags
& FLAG_TIME_WARN
? TRUE
: FALSE
), warning_time
,
372 (flags
& FLAG_TIME_CRIT
? TRUE
: FALSE
), critical_time
,
374 TRUE
, socket_timeout
)
383 /* process command-line arguments */
385 process_arguments (int argc
, char **argv
)
391 static struct option longopts
[] = {
392 {"hostname", required_argument
, 0, 'H'},
393 {"critical", required_argument
, 0, 'c'},
394 {"warning", required_argument
, 0, 'w'},
395 {"critical-codes", required_argument
, 0, 'C'},
396 {"warning-codes", required_argument
, 0, 'W'},
397 {"timeout", required_argument
, 0, 't'},
398 {"protocol", required_argument
, 0, 'P'},
399 {"port", required_argument
, 0, 'p'},
400 {"escape", required_argument
, 0, 'E'},
401 {"all", required_argument
, 0, 'A'},
402 {"send", required_argument
, 0, 's'},
403 {"expect", required_argument
, 0, 'e'},
404 {"maxbytes", required_argument
, 0, 'm'},
405 {"quit", required_argument
, 0, 'q'},
406 {"jail", no_argument
, 0, 'j'},
407 {"delay", required_argument
, 0, 'd'},
408 {"refuse", required_argument
, 0, 'r'},
409 {"mismatch", required_argument
, 0, 'M'},
410 {"use-ipv4", no_argument
, 0, '4'},
411 {"use-ipv6", no_argument
, 0, '6'},
412 {"verbose", no_argument
, 0, 'v'},
413 {"version", no_argument
, 0, 'V'},
414 {"help", no_argument
, 0, 'h'},
416 {"ssl", no_argument
, 0, 'S'},
417 {"certificate", required_argument
, 0, 'D'},
423 usage4 (_("No arguments found"));
425 /* backwards compatibility */
426 for (c
= 1; c
< argc
; c
++) {
427 if (strcmp ("-to", argv
[c
]) == 0)
428 strcpy (argv
[c
], "-t");
429 else if (strcmp ("-wt", argv
[c
]) == 0)
430 strcpy (argv
[c
], "-w");
431 else if (strcmp ("-ct", argv
[c
]) == 0)
432 strcpy (argv
[c
], "-c");
435 if (!is_option (argv
[1])) {
436 server_address
= argv
[1];
443 c
= getopt_long (argc
, argv
, "+hVv46EAH:s:e:q:m:c:w:t:p:C:W:d:Sr:jD:M:",
446 if (c
== -1 || c
== EOF
|| c
== 1)
450 case '?': /* print short usage statement if args not parsable */
455 case 'V': /* version */
456 print_revision (progname
, revision
);
458 case 'v': /* verbose mode */
459 flags
|= FLAG_VERBOSE
;
462 address_family
= AF_INET
;
466 address_family
= AF_INET6
;
468 usage4 (_("IPv6 support not available"));
471 case 'H': /* hostname */
472 server_address
= optarg
;
474 case 'c': /* critical */
475 critical_time
= strtod (optarg
, NULL
);
476 flags
|= FLAG_TIME_CRIT
;
478 case 'j': /* hide output */
479 flags
|= FLAG_HIDE_OUTPUT
;
481 case 'w': /* warning */
482 warning_time
= strtod (optarg
, NULL
);
483 flags
|= FLAG_TIME_WARN
;
486 crit_codes
= realloc (crit_codes
, ++crit_codes_count
);
487 crit_codes
[crit_codes_count
- 1] = optarg
;
490 warn_codes
= realloc (warn_codes
, ++warn_codes_count
);
491 warn_codes
[warn_codes_count
- 1] = optarg
;
493 case 't': /* timeout */
494 if (!is_intpos (optarg
))
495 usage4 (_("Timeout interval must be a positive integer"));
497 socket_timeout
= atoi (optarg
);
500 if (!is_intpos (optarg
))
501 usage4 (_("Port must be a positive integer"));
503 server_port
= atoi (optarg
);
510 server_send
= np_escaped_string(optarg
);
512 asprintf(&server_send
, "%s", optarg
);
514 case 'e': /* expect string (may be repeated) */
515 flags
&= ~FLAG_EXACT_MATCH
;
516 if (server_expect_count
== 0)
517 server_expect
= malloc (sizeof (char *) * (++server_expect_count
));
519 server_expect
= realloc (server_expect
, sizeof (char *) * (++server_expect_count
));
520 server_expect
[server_expect_count
- 1] = optarg
;
523 if (!is_intpos (optarg
))
524 usage4 (_("Maxbytes must be a positive integer"));
526 maxbytes
= strtol (optarg
, NULL
, 0);
530 server_quit
= np_escaped_string(optarg
);
532 asprintf(&server_quit
, "%s\r\n", optarg
);
535 if (!strncmp(optarg
,"ok",2))
536 econn_refuse_state
= STATE_OK
;
537 else if (!strncmp(optarg
,"warn",4))
538 econn_refuse_state
= STATE_WARNING
;
539 else if (!strncmp(optarg
,"crit",4))
540 econn_refuse_state
= STATE_CRITICAL
;
542 usage4 (_("Refuse must be one of ok, warn, crit"));
545 if (!strncmp(optarg
,"ok",2))
546 expect_mismatch_state
= STATE_OK
;
547 else if (!strncmp(optarg
,"warn",4))
548 expect_mismatch_state
= STATE_WARNING
;
549 else if (!strncmp(optarg
,"crit",4))
550 expect_mismatch_state
= STATE_CRITICAL
;
552 usage4 (_("Mismatch must be one of ok, warn, crit"));
555 if (is_intpos (optarg
))
556 delay
= atoi (optarg
);
558 usage4 (_("Delay must be a positive integer"));
560 case 'D': /* Check SSL cert validity - days 'til certificate expiration */
562 # ifdef USE_OPENSSL /* XXX */
563 if (!is_intnonneg (optarg
))
564 usage2 (_("Invalid certificate expiration period"), optarg
);
565 days_till_exp
= atoi (optarg
);
569 # endif /* USE_OPENSSL */
571 /* fallthrough if we don't have ssl */
576 die (STATE_UNKNOWN
, _("Invalid option - SSL is not available"));
580 flags
|= FLAG_MATCH_ALL
;
585 if (server_address
== NULL
)
586 usage4 (_("You must provide a server address"));
587 else if (server_address
[0] != '/' && is_host (server_address
) == FALSE
)
588 die (STATE_CRITICAL
, "%s %s - %s: %s\n", SERVICE
, state_text(STATE_CRITICAL
), _("Invalid hostname, address or socket"), server_address
);
597 print_revision (progname
, revision
);
599 printf ("Copyright (c) 1999 Ethan Galstad <nagios@nagios.org>\n");
600 printf (COPYRIGHT
, copyright
, email
);
602 printf (_("This plugin tests %s connections with the specified host (or unix socket).\n\n"),
607 printf (_(UT_HELP_VRSN
));
608 printf (_(UT_EXTRA_OPTS
));
610 printf (_(UT_HOST_PORT
), 'p', "none");
612 printf (_(UT_IPv46
));
614 printf (" %s\n", "-E, --escape");
615 printf (" %s\n", _("Can use \\n, \\r, \\t or \\ in send or quit string. Must come before send or quit option"));
616 printf (" %s\n", _("Default: nothing added to send, \\r\\n added to end of quit"));
617 printf (" %s\n", "-s, --send=STRING");
618 printf (" %s\n", _("String to send to the server"));
619 printf (" %s\n", "-e, --expect=STRING");
620 printf (" %s %s\n", _("String to expect in server response"), _("(may be repeated)"));
621 printf (" %s\n", "-A, --all");
622 printf (" %s\n", _("All expect strings need to occur in server response. Default is any"));
623 printf (" %s\n", "-q, --quit=STRING");
624 printf (" %s\n", _("String to send server to initiate a clean close of the connection"));
625 printf (" %s\n", "-r, --refuse=ok|warn|crit");
626 printf (" %s\n", _("Accept tcp refusals with states ok, warn, crit (default: crit)"));
627 printf (" %s\n", "-M, --mismatch=ok|warn|crit");
628 printf (" %s\n", _("Accept expected string mismatches with states ok, warn, crit (default: warn)"));
629 printf (" %s\n", "-j, --jail");
630 printf (" %s\n", _("Hide output from TCP socket"));
631 printf (" %s\n", "-m, --maxbytes=INTEGER");
632 printf (" %s\n", _("Close connection once more than this number of bytes are received"));
633 printf (" %s\n", "-d, --delay=INTEGER");
634 printf (" %s\n", _("Seconds to wait between sending string and polling for response"));
637 printf (" %s\n", "-D, --certificate=INTEGER");
638 printf (" %s\n", _("Minimum number of days a certificate has to be valid."));
639 printf (" %s\n", "-S, --ssl");
640 printf (" %s\n", _("Use SSL for the connection."));
643 printf (_(UT_WARN_CRIT
));
645 printf (_(UT_TIMEOUT
), DEFAULT_SOCKET_TIMEOUT
);
647 printf (_(UT_VERBOSE
));
651 printf ("%s\n", _("Notes:"));
652 printf (_(UT_EXTRA_OPTS_NOTES
));
655 printf (_(UT_SUPPORT
));
662 printf (_("Usage:"));
663 printf ("%s -H host -p port [-w <warning time>] [-c <critical time>] [-s <send string>]\n",progname
);
664 printf ("[-e <expect string>] [-q <quit string>][-m <maximum bytes>] [-d <delay>]\n");
665 printf ("[-t <timeout seconds>] [-r <refuse state>] [-M <mismatch state>] [-v] [-4|-6] [-j]\n");
666 printf ("[-D <days to cert expiry>] [-S <use SSL>] [-E]\n");