From 97131650ea6bf9f16b775743e9931a91ea441887 Mon Sep 17 00:00:00 2001 From: Thomas Guyot-Sionnest <dermoth@users.sourceforge.net> Date: Fri, 23 Nov 2007 21:47:04 +0000 Subject: Rename check_ntp* and merge change in Trunk git-svn-id: https://nagiosplug.svn.sourceforge.net/svnroot/nagiosplug/nagiosplug/branches/dermoth_ntp_rework@1832 f882894a-f735-0410-b71e-b25c423dba1c --- plugins/check_ntpd.c | 618 --------------------------------------------------- 1 file changed, 618 deletions(-) delete mode 100644 plugins/check_ntpd.c (limited to 'plugins/check_ntpd.c') diff --git a/plugins/check_ntpd.c b/plugins/check_ntpd.c deleted file mode 100644 index 840fe0ac..00000000 --- a/plugins/check_ntpd.c +++ /dev/null @@ -1,618 +0,0 @@ -/****************************************************************************** -* -* Nagios check_ntp_peer plugin -* -* License: GPL -* Copyright (c) 2006 sean finney <seanius@seanius.net> -* Copyright (c) 2007 nagios-plugins team -* -* Last Modified: $Date$ -* -* Description: -* -* This file contains the check_ntp_peer plugin -* -* This plugin to check ntp servers independant of any commandline -* programs or external libraries. -* -* -* License Information: -* -* 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 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_ntp_peer"; -const char *revision = "$Revision$"; -const char *copyright = "2007"; -const char *email = "nagiosplug-devel@lists.sourceforge.net"; - -#include "common.h" -#include "netutils.h" -#include "utils.h" - -static char *server_address=NULL; -static int verbose=0; -static short do_offset=0; -static char *owarn="60"; -static char *ocrit="120"; -static short do_stratum=0; -static char *swarn="16"; -static char *scrit="16"; -static short do_jitter=0; -static char *jwarn="5000"; -static char *jcrit="10000"; -static int syncsource_found=0; - -int process_arguments (int, char **); -thresholds *offset_thresholds = NULL; -thresholds *jitter_thresholds = NULL; -thresholds *stratum_thresholds = NULL; -void print_help (void); -void print_usage (void); - -/* max size of control message data */ -#define MAX_CM_SIZE 468 - -/* this structure holds everything in an ntp control message as per rfc1305 */ -typedef struct { - uint8_t flags; /* byte with leapindicator,vers,mode. see macros */ - uint8_t op; /* R,E,M bits and Opcode */ - uint16_t seq; /* Packet sequence */ - uint16_t status; /* Clock status */ - uint16_t assoc; /* Association */ - uint16_t offset; /* Similar to TCP sequence # */ - uint16_t count; /* # bytes of data */ - char data[MAX_CM_SIZE]; /* ASCII data of the request */ - /* NB: not necessarily NULL terminated! */ -} ntp_control_message; - -/* this is an association/status-word pair found in control packet reponses */ -typedef struct { - uint16_t assoc; - uint16_t status; -} ntp_assoc_status_pair; - -/* bits 1,2 are the leap indicator */ -#define LI_MASK 0xc0 -#define LI(x) ((x&LI_MASK)>>6) -#define LI_SET(x,y) do{ x |= ((y<<6)&LI_MASK); }while(0) -/* and these are the values of the leap indicator */ -#define LI_NOWARNING 0x00 -#define LI_EXTRASEC 0x01 -#define LI_MISSINGSEC 0x02 -#define LI_ALARM 0x03 -/* bits 3,4,5 are the ntp version */ -#define VN_MASK 0x38 -#define VN(x) ((x&VN_MASK)>>3) -#define VN_SET(x,y) do{ x |= ((y<<3)&VN_MASK); }while(0) -#define VN_RESERVED 0x02 -/* bits 6,7,8 are the ntp mode */ -#define MODE_MASK 0x07 -#define MODE(x) (x&MODE_MASK) -#define MODE_SET(x,y) do{ x |= (y&MODE_MASK); }while(0) -/* here are some values */ -#define MODE_CLIENT 0x03 -#define MODE_CONTROLMSG 0x06 -/* In control message, bits 8-10 are R,E,M bits */ -#define REM_MASK 0xe0 -#define REM_RESP 0x80 -#define REM_ERROR 0x40 -#define REM_MORE 0x20 -/* In control message, bits 11 - 15 are opcode */ -#define OP_MASK 0x1f -#define OP_SET(x,y) do{ x |= (y&OP_MASK); }while(0) -#define OP_READSTAT 0x01 -#define OP_READVAR 0x02 -/* In peer status bytes, bits 6,7,8 determine clock selection status */ -#define PEER_SEL(x) ((ntohs(x)>>8)&0x07) -#define PEER_INCLUDED 0x04 -#define PEER_SYNCSOURCE 0x06 - -/* NTP control message header is 12 bytes, plus any data in the data - * field, plus null padding to the nearest 32-bit boundary per rfc. - */ -#define SIZEOF_NTPCM(m) (12+ntohs(m.count)+((m.count)?4-(ntohs(m.count)%4):0)) - -/* finally, a little helper or two for debugging: */ -#define DBG(x) do{if(verbose>1){ x; }}while(0); -#define PRINTSOCKADDR(x) \ - do{ \ - printf("%u.%u.%u.%u", (x>>24)&0xff, (x>>16)&0xff, (x>>8)&0xff, x&0xff);\ - }while(0); - -void print_ntp_control_message(const ntp_control_message *p){ - int i=0, numpeers=0; - const ntp_assoc_status_pair *peer=NULL; - - printf("control packet contents:\n"); - printf("\tflags: 0x%.2x , 0x%.2x\n", p->flags, p->op); - printf("\t li=%d (0x%.2x)\n", LI(p->flags), p->flags&LI_MASK); - printf("\t vn=%d (0x%.2x)\n", VN(p->flags), p->flags&VN_MASK); - printf("\t mode=%d (0x%.2x)\n", MODE(p->flags), p->flags&MODE_MASK); - printf("\t response=%d (0x%.2x)\n", (p->op&REM_RESP)>0, p->op&REM_RESP); - printf("\t more=%d (0x%.2x)\n", (p->op&REM_MORE)>0, p->op&REM_MORE); - printf("\t error=%d (0x%.2x)\n", (p->op&REM_ERROR)>0, p->op&REM_ERROR); - printf("\t op=%d (0x%.2x)\n", p->op&OP_MASK, p->op&OP_MASK); - printf("\tsequence: %d (0x%.2x)\n", ntohs(p->seq), ntohs(p->seq)); - printf("\tstatus: %d (0x%.2x)\n", ntohs(p->status), ntohs(p->status)); - printf("\tassoc: %d (0x%.2x)\n", ntohs(p->assoc), ntohs(p->assoc)); - printf("\toffset: %d (0x%.2x)\n", ntohs(p->offset), ntohs(p->offset)); - printf("\tcount: %d (0x%.2x)\n", ntohs(p->count), ntohs(p->count)); - numpeers=ntohs(p->count)/(sizeof(ntp_assoc_status_pair)); - if(p->op&REM_RESP && p->op&OP_READSTAT){ - peer=(ntp_assoc_status_pair*)p->data; - for(i=0;i<numpeers;i++){ - printf("\tpeer id %.2x status %.2x", - ntohs(peer[i].assoc), ntohs(peer[i].status)); - if (PEER_SEL(peer[i].status) >= PEER_INCLUDED){ - if(PEER_SEL(peer[i].status) >= PEER_SYNCSOURCE){ - printf(" <-- current sync source"); - } else { - printf(" <-- current sync candidate"); - } - } - printf("\n"); - } - } -} - -char *extract_value(const char *varlist, const char *name){ - char *tmpvarlist=NULL, *tmpkey=NULL, *value=NULL; - int last=0; - - tmpvarlist = strdup(varlist); - tmpkey = strtok(tmpvarlist, "="); - - do { - if(strstr(tmpkey, name) != NULL) { - value = strtok(NULL, ","); - last = 1; - } - } while (last == 0 && (tmpkey = strtok(NULL, "="))); - - return value; -} - -void -setup_control_request(ntp_control_message *p, uint8_t opcode, uint16_t seq){ - memset(p, 0, sizeof(ntp_control_message)); - LI_SET(p->flags, LI_NOWARNING); - VN_SET(p->flags, VN_RESERVED); - MODE_SET(p->flags, MODE_CONTROLMSG); - OP_SET(p->op, opcode); - p->seq = htons(seq); - /* Remaining fields are zero for requests */ -} - -/* XXX handle responses with the error bit set */ -int ntp_request(const char *host, double *offset, int *offset_result, double *jitter, int *stratum){ - int conn=-1, i, npeers=0, num_candidates=0; - int min_peer_sel=PEER_INCLUDED; - int peers_size=0, peer_offset=0; - int status; - ntp_assoc_status_pair *peers=NULL; - ntp_control_message req; - const char *getvar = "stratum,offset,jitter"; - char *value=NULL, *nptr=NULL; - void *tmp; - - status = STATE_OK; - *offset_result = STATE_UNKNOWN; - *jitter = *stratum = -1; - - /* Long-winded explanation: - * Getting the sync peer offset, jitter and stratum requires a number of - * steps: - * 1) Send a READSTAT request. - * 2) Interpret the READSTAT reply - * a) The data section contains a list of peer identifiers (16 bits) - * and associated status words (16 bits) - * b) We want the value of 0x06 in the SEL (peer selection) value, - * which means "current synchronizatin source". If that's missing, - * we take anything better than 0x04 (see the rfc for details) but - * set a minimum of warning. - * 3) Send a READVAR request for information on each peer identified - * in 2b greater than the minimum selection value. - * 4) Extract the offset, jitter and stratum value from the data[] - * (it's ASCII) - */ - my_udp_connect(server_address, 123, &conn); - - /* keep sending requests until the server stops setting the - * REM_MORE bit, though usually this is only 1 packet. */ - do{ - setup_control_request(&req, OP_READSTAT, 1); - DBG(printf("sending READSTAT request")); - write(conn, &req, SIZEOF_NTPCM(req)); - DBG(print_ntp_control_message(&req)); - /* Attempt to read the largest size packet possible */ - req.count=htons(MAX_CM_SIZE); - DBG(printf("recieving READSTAT response")) - read(conn, &req, SIZEOF_NTPCM(req)); - DBG(print_ntp_control_message(&req)); - /* Each peer identifier is 4 bytes in the data section, which - * we represent as a ntp_assoc_status_pair datatype. - */ - peers_size+=ntohs(req.count); - if((tmp=realloc(peers, peers_size)) == NULL) - free(peers), die(STATE_UNKNOWN, "can not (re)allocate 'peers' buffer\n"); - peers=tmp; - memcpy((void*)((ptrdiff_t)peers+peer_offset), (void*)req.data, ntohs(req.count)); - npeers=peers_size/sizeof(ntp_assoc_status_pair); - peer_offset+=ntohs(req.count); - } while(req.op&REM_MORE); - - /* first, let's find out if we have a sync source, or if there are - * at least some candidates. in the case of the latter we'll issue - * a warning but go ahead with the check on them. */ - for (i = 0; i < npeers; i++){ - if (PEER_SEL(peers[i].status) >= PEER_INCLUDED){ - num_candidates++; - if(PEER_SEL(peers[i].status) >= PEER_SYNCSOURCE){ - syncsource_found=1; - min_peer_sel=PEER_SYNCSOURCE; - } - } - } - if(verbose) printf("%d candiate peers available\n", num_candidates); - if(verbose && syncsource_found) printf("synchronization source found\n"); - if(! syncsource_found){ - status = STATE_WARNING; - if(verbose) printf("warning: no synchronization source found\n"); - } - - - for (i = 0; i < npeers; i++){ - /* Only query this server if it is the current sync source */ - if (PEER_SEL(peers[i].status) >= min_peer_sel){ - if(verbose) printf("Getting offset, jitter and stratum for peer %.2x\n", ntohs(peers[i].assoc)); - setup_control_request(&req, OP_READVAR, 2); - req.assoc = peers[i].assoc; - /* Putting the wanted variable names in the request - * cause the server to provide _only_ the requested values. - * thus reducing net traffic, guaranteeing us only a single - * datagram in reply, and making intepretation much simpler - */ - /* Older servers doesn't know what jitter is, so if we get an - * error on the first pass we redo it with "dispersion" */ - strncpy(req.data, getvar, MAX_CM_SIZE-1); - req.count = htons(strlen(getvar)); - DBG(printf("sending READVAR request...\n")); - write(conn, &req, SIZEOF_NTPCM(req)); - DBG(print_ntp_control_message(&req)); - - req.count = htons(MAX_CM_SIZE); - DBG(printf("recieving READVAR response...\n")); - read(conn, &req, SIZEOF_NTPCM(req)); - DBG(print_ntp_control_message(&req)); - - if(req.op&REM_ERROR && strstr(getvar, "jitter")) { - if(verbose) printf("The 'jitter' command failed (old ntp server?)\nRestarting with 'dispersion'...\n"); - getvar = "stratum,offset,dispersion"; - i--; - continue; - } - - if(verbose > 1) - printf("Server responded: >>>%s<<<\n", req.data); - - /* get the offset */ - if(verbose) - printf("parsing offset from peer %.2x: ", ntohs(peers[i].assoc)); - - value = extract_value(req.data, "offset"); - /* Convert the value if we have one */ - if(value != NULL) - *offset = strtod(value, &nptr) / 1000; - /* If value is null or no conversion was performed */ - if(value == NULL || value==nptr) { - printf("warning: unable to read server offset response.\n"); - status = max_state_alt(status, STATE_CRITICAL); - } else { - *offset_result = STATE_OK; - if(verbose) printf("%g\n", *offset); - } - - if(do_jitter) { - /* first reset the pointers */ - value = NULL, nptr=NULL; - /* get the jitter */ - if(verbose) { - printf("parsing jitter from peer %.2x: ", ntohs(peers[i].assoc)); - } - value = extract_value(req.data, strstr(getvar, "dispersion") != NULL ? "dispersion" : "jitter"); - /* Convert the value if we have one */ - if(value != NULL) - *jitter = strtod(value, &nptr); - /* If value is null or no conversion was performed */ - if(value == NULL || value==nptr){ - printf("warning: unable to read server jitter response.\n"); - status = max_state_alt(status, STATE_UNKNOWN); - } else { - if(verbose) printf("%g\n", *jitter); - } - } - - if(do_stratum) { - value = NULL; - /* get the stratum */ - if(verbose) { - printf("parsing stratum from peer %.2x: ", ntohs(peers[i].assoc)); - } - value = extract_value(req.data, "stratum"); - if(value == NULL){ - printf("warning: unable to read server stratum response.\n"); - status = max_state_alt(status, STATE_UNKNOWN); - } else { - *stratum = atoi(value); - if(verbose) printf("%i\n", *stratum); - } - } - } /* if (PEER_SEL(peers[i].status) >= min_peer_sel) */ - } /* for (i = 0; i < npeers; i++) */ - - close(conn); - if(peers!=NULL) free(peers); - - return status; -} - -int process_arguments(int argc, char **argv){ - int c; - int option=0; - static struct option longopts[] = { - {"version", no_argument, 0, 'V'}, - {"help", no_argument, 0, 'h'}, - {"verbose", no_argument, 0, 'v'}, - {"use-ipv4", no_argument, 0, '4'}, - {"use-ipv6", no_argument, 0, '6'}, - {"warning", required_argument, 0, 'w'}, - {"critical", required_argument, 0, 'c'}, - {"swarn", required_argument, 0, 'W'}, - {"scrit", required_argument, 0, 'C'}, - {"jwarn", required_argument, 0, 'j'}, - {"jcrit", required_argument, 0, 'k'}, - {"timeout", required_argument, 0, 't'}, - {"hostname", required_argument, 0, 'H'}, - {0, 0, 0, 0} - }; - - - if (argc < 2) - usage ("\n"); - - while (1) { - c = getopt_long (argc, argv, "Vhv46w:c:W:C:j:k:t:H:", longopts, &option); - if (c == -1 || c == EOF || c == 1) - break; - - switch (c) { - case 'h': - print_help(); - exit(STATE_OK); - break; - case 'V': - print_revision(progname, revision); - exit(STATE_OK); - break; - case 'v': - verbose++; - break; - case 'w': - do_offset=1; - owarn = optarg; - break; - case 'c': - do_offset=1; - ocrit = optarg; - break; - case 'W': - do_stratum=1; - swarn = optarg; - break; - case 'C': - do_stratum=1; - scrit = optarg; - break; - case 'j': - do_jitter=1; - jwarn = optarg; - break; - case 'k': - do_jitter=1; - jcrit = optarg; - break; - case 'H': - if(is_host(optarg) == FALSE) - usage2(_("Invalid hostname/address"), optarg); - server_address = strdup(optarg); - break; - case 't': - socket_timeout=atoi(optarg); - break; - case '4': - address_family = AF_INET; - break; - case '6': -#ifdef USE_IPV6 - address_family = AF_INET6; -#else - usage4 (_("IPv6 support not available")); -#endif - break; - case '?': - /* print short usage statement if args not parsable */ - usage5 (); - break; - } - } - - if(server_address == NULL){ - usage4(_("Hostname was not supplied")); - } - - return 0; -} - -char *perfd_offset (double offset) -{ - return fperfdata ("offset", offset, "s", - TRUE, offset_thresholds->warning->end, - TRUE, offset_thresholds->critical->end, - FALSE, 0, FALSE, 0); -} - -char *perfd_jitter (double jitter) -{ - return fperfdata ("jitter", jitter, "s", - do_jitter, jitter_thresholds->warning->end, - do_jitter, jitter_thresholds->critical->end, - TRUE, 0, FALSE, 0); -} - -char *perfd_stratum (int stratum) -{ - return perfdata ("stratum", stratum, "", - do_stratum, (int)stratum_thresholds->warning->end, - do_stratum, (int)stratum_thresholds->critical->end, - TRUE, 0, TRUE, 16); -} - -int main(int argc, char *argv[]){ - int result, offset_result, stratum; - double offset=0, jitter=0; - char *result_line, *perfdata_line; - - result = offset_result = STATE_OK; - - if (process_arguments (argc, argv) == ERROR) - usage4 (_("Could not parse arguments")); - - set_thresholds(&offset_thresholds, owarn, ocrit); - set_thresholds(&jitter_thresholds, jwarn, jcrit); - set_thresholds(&stratum_thresholds, swarn, scrit); - - /* initialize alarm signal handling */ - signal (SIGALRM, socket_timeout_alarm_handler); - - /* set socket timeout */ - alarm (socket_timeout); - - result = ntp_request(server_address, &offset, &offset_result, &jitter, &stratum); - result = max_state_alt(result, get_status(fabs(offset), offset_thresholds)); - - if(do_stratum) - result = max_state_alt(result, get_status(stratum, stratum_thresholds)); - - if(do_jitter) - result = max_state_alt(result, get_status(jitter, jitter_thresholds)); - - switch (result) { - case STATE_CRITICAL : - asprintf(&result_line, "NTP CRITICAL:"); - break; - case STATE_WARNING : - asprintf(&result_line, "NTP WARNING:"); - break; - case STATE_OK : - asprintf(&result_line, "NTP OK:"); - break; - default : - asprintf(&result_line, "NTP UNKNOWN:"); - break; - } - if(!syncsource_found) - asprintf(&result_line, "%s %s, ", result_line, _("Server not synchronized")); - - if(offset_result == STATE_UNKNOWN){ - asprintf(&result_line, "%s %s", result_line, _("Offset unknown")); - asprintf(&perfdata_line, ""); - } else { - asprintf(&result_line, "%s Offset %.10g secs", result_line, offset); - asprintf(&perfdata_line, "%s", perfd_offset(offset)); - } - if (do_jitter) { - asprintf(&result_line, "%s, jitter=%f", result_line, jitter); - asprintf(&perfdata_line, "%s %s", perfdata_line, perfd_jitter(jitter)); - } - if (do_stratum) { - asprintf(&result_line, "%s, stratum=%i", result_line, stratum); - asprintf(&perfdata_line, "%s %s", perfdata_line, perfd_stratum(stratum)); - } - printf("%s|%s\n", result_line, perfdata_line); - - if(server_address!=NULL) free(server_address); - return result; -} - - - -void print_help(void){ - print_revision(progname, revision); - - printf ("Copyright (c) 2006 Sean Finney\n"); - printf (COPYRIGHT, copyright, email); - - printf ("%s\n", _("This plugin checks the selected ntp server")); - - printf ("\n\n"); - - print_usage(); - printf (_(UT_HELP_VRSN)); - printf (_(UT_HOST_PORT), 'p', "123"); - printf (" %s\n", "-w, --warning=THRESHOLD"); - printf (" %s\n", _("Offset to result in warning status (seconds)")); - printf (" %s\n", "-c, --critical=THRESHOLD"); - printf (" %s\n", _("Offset to result in critical status (seconds)")); - printf (" %s\n", "-W, --warning=THRESHOLD"); - printf (" %s\n", _("Warning threshold for stratum")); - printf (" %s\n", "-W, --critical=THRESHOLD"); - printf (" %s\n", _("Critical threshold for stratum")); - printf (" %s\n", "-j, --warning=THRESHOLD"); - printf (" %s\n", _("Warning threshold for jitter")); - printf (" %s\n", "-k, --critical=THRESHOLD"); - printf (" %s\n", _("Critical threshold for jitter")); - printf (_(UT_TIMEOUT), DEFAULT_SOCKET_TIMEOUT); - printf (_(UT_VERBOSE)); - - printf("\n"); - printf("%s\n", _("Notes:")); - printf(" %s\n", _("See:")); - printf(" %s\n", ("http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT")); - printf(" %s\n", _("for THRESHOLD format and examples.")); - - printf("\n"); - printf("%s\n", _("Examples:")); - printf(" %s\n", _("Normal offset check:")); - printf(" %s\n", ("./check_ntp_peer -H ntpserv -w 0.5 -c 1")); - printf(" %s\n", _("Check jitter too, avoiding critical notifications if jitter isn't available")); - printf(" %s\n", _("(See Notes above for more details on thresholds formats):")); - printf(" %s\n", ("./check_ntp_peer -H ntpserv -w 0.5 -c 1 -j -1:100 -k -1:200")); - printf(" %s\n", _("Check only stratum:")); - printf(" %s\n", ("./check_ntp_peer -H ntpserv -W 4 -C 6")); - - printf (_(UT_SUPPORT)); -} - -void -print_usage(void) -{ - printf (_("Usage:")); - printf(" %s -H <host> [-w <warn>] [-c <crit>] [-W <warn>] [-C <crit>]\n", progname); - printf(" [-j <warn>] [-k <crit>] [-v verbose]\n"); -} -- cgit v1.2.3-74-g34f1