plugins/check_ntp_peer.c

   1 /*****************************************************************************
   2 *
   3 * Nagios check_ntp_peer plugin
   4 *
   5 * License: GPL
   6 * Copyright (c) 2006 Sean Finney <seanius@seanius.net>
   7 * Copyright (c) 2006-2008 Nagios Plugins Development Team
   8 *
   9 * Last Modified: $Date$
  10 *
  11 * Description:
  12 *
  13 * This file contains the check_ntp_peer plugin
  14 *
  15 * This plugin checks an NTP server independent of any commandline
  16 * programs or external libraries.
  17 *
  18 * Use this plugin to check the health of an NTP server. It supports
  19 * checking the offset with the sync peer, the jitter and stratum. This
  20 * plugin will not check the clock offset between the local host and NTP
  21 * server; please use check_ntp_time for that purpose.
  22 *
  23 *
  24 * This program is free software: you can redistribute it and/or modify
  25 * it under the terms of the GNU General Public License as published by
  26 * the Free Software Foundation, either version 3 of the License, or
  27 * (at your option) any later version.
  28 *
  29 * This program is distributed in the hope that it will be useful,
  30 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  32 * GNU General Public License for more details.
  33 *
  34 * You should have received a copy of the GNU General Public License
  35 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  36 *
  37 * $Id$
  38 *
  39 *****************************************************************************/
  40
  41 const char *progname = "check_ntp_peer";
  42 const char *revision = "$Revision$";
  43 const char *copyright = "2006-2008";
  44 const char *email = "nagiosplug-devel@lists.sourceforge.net";
  45
  46 #include "common.h"
  47 #include "netutils.h"
  48 #include "utils.h"
  49
  50 static char *server_address=NULL;
  51 static int verbose=0;
  52 static int quiet=0;
  53 static short do_offset=0;
  54 static char *owarn="60";
  55 static char *ocrit="120";
  56 static short do_stratum=0;
  57 static char *swarn="-1:16";
  58 static char *scrit="-1:16";
  59 static short do_jitter=0;
  60 static char *jwarn="-1:5000";
  61 static char *jcrit="-1:10000";
  62 static int syncsource_found=0;
  63 static int li_alarm=0;
  64
  65 int process_arguments (int, char **);
  66 thresholds *offset_thresholds = NULL;
  67 thresholds *jitter_thresholds = NULL;
  68 thresholds *stratum_thresholds = NULL;
  69 void print_help (void);
  70 void print_usage (void);
  71
  72 /* max size of control message data */
  73 #define MAX_CM_SIZE 468
  74
  75 /* this structure holds everything in an ntp control message as per rfc1305 */
  76 typedef struct {
  77         uint8_t flags;       /* byte with leapindicator,vers,mode. see macros */
  78         uint8_t op;          /* R,E,M bits and Opcode */
  79         uint16_t seq;        /* Packet sequence */
  80         uint16_t status;     /* Clock status */
  81         uint16_t assoc;      /* Association */
  82         uint16_t offset;     /* Similar to TCP sequence # */
  83         uint16_t count;      /* # bytes of data */
  84         char data[MAX_CM_SIZE]; /* ASCII data of the request */
  85                                 /* NB: not necessarily NULL terminated! */
  86 } ntp_control_message;
  87
  88 /* this is an association/status-word pair found in control packet reponses */
  89 typedef struct {
  90         uint16_t assoc;
  91         uint16_t status;
  92 } ntp_assoc_status_pair;
  93
  94 /* bits 1,2 are the leap indicator */
  95 #define LI_MASK 0xc0
  96 #define LI(x) ((x&LI_MASK)>>6)
  97 #define LI_SET(x,y) do{ x |= ((y<<6)&LI_MASK); }while(0)
  98 /* and these are the values of the leap indicator */
  99 #define LI_NOWARNING 0x00
 100 #define LI_EXTRASEC 0x01
 101 #define LI_MISSINGSEC 0x02
 102 #define LI_ALARM 0x03
 103 /* bits 3,4,5 are the ntp version */
 104 #define VN_MASK 0x38
 105 #define VN(x)   ((x&VN_MASK)>>3)
 106 #define VN_SET(x,y)     do{ x |= ((y<<3)&VN_MASK); }while(0)
 107 #define VN_RESERVED 0x02
 108 /* bits 6,7,8 are the ntp mode */
 109 #define MODE_MASK 0x07
 110 #define MODE(x) (x&MODE_MASK)
 111 #define MODE_SET(x,y)   do{ x |= (y&MODE_MASK); }while(0)
 112 /* here are some values */
 113 #define MODE_CLIENT 0x03
 114 #define MODE_CONTROLMSG 0x06
 115 /* In control message, bits 8-10 are R,E,M bits */
 116 #define REM_MASK 0xe0
 117 #define REM_RESP 0x80
 118 #define REM_ERROR 0x40
 119 #define REM_MORE 0x20
 120 /* In control message, bits 11 - 15 are opcode */
 121 #define OP_MASK 0x1f
 122 #define OP_SET(x,y)   do{ x |= (y&OP_MASK); }while(0)
 123 #define OP_READSTAT 0x01
 124 #define OP_READVAR  0x02
 125 /* In peer status bytes, bits 6,7,8 determine clock selection status */
 126 #define PEER_SEL(x) ((ntohs(x)>>8)&0x07)
 127 #define PEER_INCLUDED 0x04
 128 #define PEER_SYNCSOURCE 0x06
 129
 130 /* NTP control message header is 12 bytes, plus any data in the data
 131  * field, plus null padding to the nearest 32-bit boundary per rfc.
 132  */
 133 #define SIZEOF_NTPCM(m) (12+ntohs(m.count)+((m.count)?4-(ntohs(m.count)%4):0))
 134
 135 /* finally, a little helper or two for debugging: */
 136 #define DBG(x) do{if(verbose>1){ x; }}while(0);
 137 #define PRINTSOCKADDR(x) \
 138         do{ \
 139                 printf("%u.%u.%u.%u", (x>>24)&0xff, (x>>16)&0xff, (x>>8)&0xff, x&0xff);\
 140         }while(0);
 141
 142 void print_ntp_control_message(const ntp_control_message *p){
 143         int i=0, numpeers=0;
 144         const ntp_assoc_status_pair *peer=NULL;
 145
 146         printf("control packet contents:\n");
 147         printf("\tflags: 0x%.2x , 0x%.2x\n", p->flags, p->op);
 148         printf("\t  li=%d (0x%.2x)\n", LI(p->flags), p->flags&LI_MASK);
 149         printf("\t  vn=%d (0x%.2x)\n", VN(p->flags), p->flags&VN_MASK);
 150         printf("\t  mode=%d (0x%.2x)\n", MODE(p->flags), p->flags&MODE_MASK);
 151         printf("\t  response=%d (0x%.2x)\n", (p->op&REM_RESP)>0, p->op&REM_RESP);
 152         printf("\t  more=%d (0x%.2x)\n", (p->op&REM_MORE)>0, p->op&REM_MORE);
 153         printf("\t  error=%d (0x%.2x)\n", (p->op&REM_ERROR)>0, p->op&REM_ERROR);
 154         printf("\t  op=%d (0x%.2x)\n", p->op&OP_MASK, p->op&OP_MASK);
 155         printf("\tsequence: %d (0x%.2x)\n", ntohs(p->seq), ntohs(p->seq));
 156         printf("\tstatus: %d (0x%.2x)\n", ntohs(p->status), ntohs(p->status));
 157         printf("\tassoc: %d (0x%.2x)\n", ntohs(p->assoc), ntohs(p->assoc));
 158         printf("\toffset: %d (0x%.2x)\n", ntohs(p->offset), ntohs(p->offset));
 159         printf("\tcount: %d (0x%.2x)\n", ntohs(p->count), ntohs(p->count));
 160         numpeers=ntohs(p->count)/(sizeof(ntp_assoc_status_pair));
 161         if(p->op&REM_RESP && p->op&OP_READSTAT){
 162                 peer=(ntp_assoc_status_pair*)p->data;
 163                 for(i=0;i<numpeers;i++){
 164                         printf("\tpeer id %.2x status %.2x",
 165                                ntohs(peer[i].assoc), ntohs(peer[i].status));
 166                         if (PEER_SEL(peer[i].status) >= PEER_INCLUDED){
 167                                 if(PEER_SEL(peer[i].status) >= PEER_SYNCSOURCE){
 168                                         printf(" <-- current sync source");
 169                                 } else {
 170                                         printf(" <-- current sync candidate");
 171                                 }
 172                         }
 173                         printf("\n");
 174                 }
 175         }
 176 }
 177
 178 /*
 179  * Extract the value from NTP key/value pairs, or return NULL.
 180  * The value returned can be free()ed.
 181  */
 182 char *extract_value(const char *varlist, const char *name){
 183         char *tmp=NULL, *value=NULL;
 184         int i;
 185
 186         while (1) {
 187           /* Strip any leading space */
 188                 for (varlist; isspace(varlist[0]); varlist++);
 189
 190                 if (strncmp(name, varlist, strlen(name)) == 0) {
 191                         varlist += strlen(name);
 192                         /* strip trailing spaces */
 193                         for (varlist; isspace(varlist[0]); varlist++);
 194
 195                         if (varlist[0] == '=') {
 196                                 /* We matched the key, go past the = sign */
 197                                 varlist++;
 198                                 /* strip leading spaces */
 199                                 for (varlist; isspace(varlist[0]); varlist++);
 200
 201                                 if (tmp = index(varlist, ',')) {
 202                                         /* Value is delimited by a comma */
 203                                         if (tmp-varlist == 0) continue;
 204                                         value = (char *)malloc(tmp-varlist+1);
 205                                         strncpy(value, varlist, tmp-varlist);
 206                                         value[tmp-varlist] = '\0';
 207                                 } else {
 208                                         /* Value is delimited by a \0 */
 209                                         if (strlen(varlist) == 0) continue;
 210                                         value = (char *)malloc(strlen(varlist) + 1);
 211                                         strncpy(value, varlist, strlen(varlist));
 212                                         value[strlen(varlist)] = '\0';
 213                                 }
 214                                 break;
 215                         }
 216                 }
 217                 if (tmp = index(varlist, ',')) {
 218                         /* More keys, keep going... */
 219                         varlist = tmp + 1;
 220                 } else {
 221                         /* We're done */
 222                         break;
 223                 }
 224         }
 225
 226         /* Clean-up trailing spaces/newlines */
 227         if (value) for (i=strlen(value)-1; isspace(value[i]); i--) value[i] = '\0';
 228
 229         return value;
 230 }
 231
 232 void
 233 setup_control_request(ntp_control_message *p, uint8_t opcode, uint16_t seq){
 234         memset(p, 0, sizeof(ntp_control_message));
 235         LI_SET(p->flags, LI_NOWARNING);
 236         VN_SET(p->flags, VN_RESERVED);
 237         MODE_SET(p->flags, MODE_CONTROLMSG);
 238         OP_SET(p->op, opcode);
 239         p->seq = htons(seq);
 240         /* Remaining fields are zero for requests */
 241 }
 242
 243 /* This function does all the actual work; roughly here's what it does
 244  * beside setting the offest, jitter and stratum passed as argument:
 245  *  - offset can be negative, so if it cannot get the offset, offset_result
 246  *    is set to UNKNOWN, otherwise OK.
 247  *  - jitter and stratum are set to -1 if they cannot be retrieved so any
 248  *    positive value means a success retrieving the value.
 249  *  - status is set to WARNING if there's no sync.peer (otherwise OK) and is
 250  *    the return value of the function.
 251  *  status is pretty much useless as syncsource_found is a global variable
 252  *  used later in main to check is the server was synchronized. It works
 253  *  so I left it alone */
 254 int ntp_request(const char *host, double *offset, int *offset_result, double *jitter, int *stratum){
 255         int conn=-1, i, npeers=0, num_candidates=0;
 256         double tmp_offset = 0;
 257         int min_peer_sel=PEER_INCLUDED;
 258         int peers_size=0, peer_offset=0;
 259         int status;
 260         ntp_assoc_status_pair *peers=NULL;
 261         ntp_control_message req;
 262         const char *getvar = "stratum,offset,jitter";
 263         char *data, *value, *nptr;
 264         void *tmp;
 265
 266         status = STATE_OK;
 267         *offset_result = STATE_UNKNOWN;
 268         *jitter = *stratum = -1;
 269
 270         /* Long-winded explanation:
 271          * Getting the sync peer offset, jitter and stratum requires a number of
 272          * steps:
 273          * 1) Send a READSTAT request.
 274          * 2) Interpret the READSTAT reply
 275          *  a) The data section contains a list of peer identifiers (16 bits)
 276          *     and associated status words (16 bits)
 277          *  b) We want the value of 0x06 in the SEL (peer selection) value,
 278          *     which means "current synchronizatin source".  If that's missing,
 279          *     we take anything better than 0x04 (see the rfc for details) but
 280          *     set a minimum of warning.
 281          * 3) Send a READVAR request for information on each peer identified
 282          *    in 2b greater than the minimum selection value.
 283          * 4) Extract the offset, jitter and stratum value from the data[]
 284          *    (it's ASCII)
 285          */
 286         my_udp_connect(server_address, 123, &conn);
 287
 288         /* keep sending requests until the server stops setting the
 289          * REM_MORE bit, though usually this is only 1 packet. */
 290         do{
 291                 setup_control_request(&req, OP_READSTAT, 1);
 292                 DBG(printf("sending READSTAT request"));
 293                 write(conn, &req, SIZEOF_NTPCM(req));
 294                 DBG(print_ntp_control_message(&req));
 295                 /* Attempt to read the largest size packet possible */
 296                 req.count=htons(MAX_CM_SIZE);
 297                 DBG(printf("recieving READSTAT response"))
 298                 if(read(conn, &req, SIZEOF_NTPCM(req)) == -1)
 299                         die(STATE_CRITICAL, "NTP CRITICAL: No response from NTP server\n");
 300                 DBG(print_ntp_control_message(&req));
 301                 if (LI(req.flags) == LI_ALARM) li_alarm = 1;
 302                 /* Each peer identifier is 4 bytes in the data section, which
 303                  * we represent as a ntp_assoc_status_pair datatype.
 304                  */
 305                 peers_size+=ntohs(req.count);
 306                 if((tmp=realloc(peers, peers_size)) == NULL)
 307                         free(peers), die(STATE_UNKNOWN, "can not (re)allocate 'peers' buffer\n");
 308                 peers=tmp;
 309                 memcpy((void*)((ptrdiff_t)peers+peer_offset), (void*)req.data, ntohs(req.count));
 310                 npeers=peers_size/sizeof(ntp_assoc_status_pair);
 311                 peer_offset+=ntohs(req.count);
 312         } while(req.op&REM_MORE);
 313
 314         /* first, let's find out if we have a sync source, or if there are
 315          * at least some candidates. In the latter case we'll issue
 316          * a warning but go ahead with the check on them. */
 317         for (i = 0; i < npeers; i++){
 318                 if (PEER_SEL(peers[i].status) >= PEER_INCLUDED){
 319                         num_candidates++;
 320                         if(PEER_SEL(peers[i].status) >= PEER_SYNCSOURCE){
 321                                 syncsource_found=1;
 322                                 min_peer_sel=PEER_SYNCSOURCE;
 323                         }
 324                 }
 325         }
 326         if(verbose) printf("%d candiate peers available\n", num_candidates);
 327         if(verbose && syncsource_found) printf("synchronization source found\n");
 328         if(! syncsource_found){
 329                 status = STATE_WARNING;
 330                 if(verbose) printf("warning: no synchronization source found\n");
 331         }
 332         if(li_alarm){
 333                 status = STATE_WARNING;
 334                 if(verbose) printf("warning: LI_ALARM bit is set\n");
 335         }
 336
 337
 338         for (i = 0; i < npeers; i++){
 339                 /* Only query this server if it is the current sync source */
 340                 /* If there's no sync.peer, query all candidates and use the best one */
 341                 if (PEER_SEL(peers[i].status) >= min_peer_sel){
 342                         if(verbose) printf("Getting offset, jitter and stratum for peer %.2x\n", ntohs(peers[i].assoc));
 343                         asprintf(&data, "");
 344                         do{
 345                                 setup_control_request(&req, OP_READVAR, 2);
 346                                 req.assoc = peers[i].assoc;
 347                                 /* Putting the wanted variable names in the request
 348                                  * cause the server to provide _only_ the requested values.
 349                                  * thus reducing net traffic, guaranteeing us only a single
 350                                  * datagram in reply, and making intepretation much simpler
 351                                  */
 352                                 /* Older servers doesn't know what jitter is, so if we get an
 353                                  * error on the first pass we redo it with "dispersion" */
 354                                 strncpy(req.data, getvar, MAX_CM_SIZE-1);
 355                                 req.count = htons(strlen(getvar));
 356                                 DBG(printf("sending READVAR request...\n"));
 357                                 write(conn, &req, SIZEOF_NTPCM(req));
 358                                 DBG(print_ntp_control_message(&req));
 359
 360                                 req.count = htons(MAX_CM_SIZE);
 361                                 DBG(printf("receiving READVAR response...\n"));
 362                                 read(conn, &req, SIZEOF_NTPCM(req));
 363                                 DBG(print_ntp_control_message(&req));
 364
 365                                 if(!(req.op&REM_ERROR))
 366                                         asprintf(&data, "%s%s", data, req.data);
 367                         } while(req.op&REM_MORE);
 368
 369                         if(req.op&REM_ERROR) {
 370                                 if(strstr(getvar, "jitter")) {
 371                                         if(verbose) printf("The command failed. This is usually caused by servers refusing the 'jitter'\nvariable. Restarting with 'dispersion'...\n");
 372                                         getvar = "stratum,offset,dispersion";
 373                                         i--;
 374                                         continue;
 375                                 } else if(strlen(getvar)) {
 376                                         if(verbose) printf("Server didn't like dispersion either; will retrieve everything\n");
 377                                         getvar = "";
 378                                         i--;
 379                                         continue;
 380                                 }
 381                         }
 382
 383                         if(verbose > 1)
 384                                 printf("Server responded: >>>%s<<<\n", data);
 385
 386                         /* get the offset */
 387                         if(verbose)
 388                                 printf("parsing offset from peer %.2x: ", ntohs(peers[i].assoc));
 389
 390                         value = extract_value(data, "offset");
 391                         nptr=NULL;
 392                         /* Convert the value if we have one */
 393                         if(value != NULL)
 394                                 tmp_offset = strtod(value, &nptr) / 1000;
 395                         /* If value is null or no conversion was performed */
 396                         if(value == NULL || value==nptr) {
 397                                 if(verbose) printf("error: unable to read server offset response.\n");
 398                         } else {
 399                                 if(verbose) printf("%.10g\n", tmp_offset);
 400                                 if(*offset_result == STATE_UNKNOWN || fabs(tmp_offset) < fabs(*offset)) {
 401                                         *offset = tmp_offset;
 402                                         *offset_result = STATE_OK;
 403                                 } else {
 404                                         /* Skip this one; move to the next */
 405                                         continue;
 406                                 }
 407                         }
 408
 409                         if(do_jitter) {
 410                                 /* get the jitter */
 411                                 if(verbose) {
 412                                         printf("parsing %s from peer %.2x: ", strstr(getvar, "dispersion") != NULL ? "dispersion" : "jitter", ntohs(peers[i].assoc));
 413                                 }
 414                                 value = extract_value(data, strstr(getvar, "dispersion") != NULL ? "dispersion" : "jitter");
 415                                 nptr=NULL;
 416                                 /* Convert the value if we have one */
 417                                 if(value != NULL)
 418                                         *jitter = strtod(value, &nptr);
 419                                 /* If value is null or no conversion was performed */
 420                                 if(value == NULL || value==nptr) {
 421                                         if(verbose) printf("error: unable to read server jitter/dispersion response.\n");
 422                                         *jitter = -1;
 423                                 } else if(verbose) {
 424                                         printf("%.10g\n", *jitter);
 425                                 }
 426                         }
 427
 428                         if(do_stratum) {
 429                                 /* get the stratum */
 430                                 if(verbose) {
 431                                         printf("parsing stratum from peer %.2x: ", ntohs(peers[i].assoc));
 432                                 }
 433                                 value = extract_value(data, "stratum");
 434                                 nptr=NULL;
 435                                 /* Convert the value if we have one */
 436                                 if(value != NULL)
 437                                         *stratum = strtol(value, &nptr, 10);
 438                                 if(value == NULL || value==nptr) {
 439                                         if(verbose) printf("error: unable to read server stratum response.\n");
 440                                         *stratum = -1;
 441                                 } else {
 442                                         if(verbose) printf("%i\n", *stratum);
 443                                 }
 444                         }
 445                 } /* if (PEER_SEL(peers[i].status) >= min_peer_sel) */
 446         } /* for (i = 0; i < npeers; i++) */
 447
 448         close(conn);
 449         if(peers!=NULL) free(peers);
 450
 451         return status;
 452 }
 453
 454 int process_arguments(int argc, char **argv){
 455         int c;
 456         int option=0;
 457         static struct option longopts[] = {
 458                 {"version", no_argument, 0, 'V'},
 459                 {"help", no_argument, 0, 'h'},
 460                 {"verbose", no_argument, 0, 'v'},
 461                 {"use-ipv4", no_argument, 0, '4'},
 462                 {"use-ipv6", no_argument, 0, '6'},
 463                 {"quiet", no_argument, 0, 'q'},
 464                 {"warning", required_argument, 0, 'w'},
 465                 {"critical", required_argument, 0, 'c'},
 466                 {"swarn", required_argument, 0, 'W'},
 467                 {"scrit", required_argument, 0, 'C'},
 468                 {"jwarn", required_argument, 0, 'j'},
 469                 {"jcrit", required_argument, 0, 'k'},
 470                 {"timeout", required_argument, 0, 't'},
 471                 {"hostname", required_argument, 0, 'H'},
 472                 {0, 0, 0, 0}
 473         };
 474
 475
 476         if (argc < 2)
 477                 usage ("\n");
 478
 479         while (1) {
 480                 c = getopt_long (argc, argv, "Vhv46qw:c:W:C:j:k:t:H:", longopts, &option);
 481                 if (c == -1 || c == EOF || c == 1)
 482                         break;
 483
 484                 switch (c) {
 485                 case 'h':
 486                         print_help();
 487                         exit(STATE_OK);
 488                         break;
 489                 case 'V':
 490                         print_revision(progname, revision);
 491                         exit(STATE_OK);
 492                         break;
 493                 case 'v':
 494                         verbose++;
 495                         break;
 496                 case 'q':
 497                         quiet = 1;
 498                         break;
 499                 case 'w':
 500                         do_offset=1;
 501                         owarn = optarg;
 502                         break;
 503                 case 'c':
 504                         do_offset=1;
 505                         ocrit = optarg;
 506                         break;
 507                 case 'W':
 508                         do_stratum=1;
 509                         swarn = optarg;
 510                         break;
 511                 case 'C':
 512                         do_stratum=1;
 513                         scrit = optarg;
 514                         break;
 515                 case 'j':
 516                         do_jitter=1;
 517                         jwarn = optarg;
 518                         break;
 519                 case 'k':
 520                         do_jitter=1;
 521                         jcrit = optarg;
 522                         break;
 523                 case 'H':
 524                         if(is_host(optarg) == FALSE)
 525                                 usage2(_("Invalid hostname/address"), optarg);
 526                         server_address = strdup(optarg);
 527                         break;
 528                 case 't':
 529                         socket_timeout=atoi(optarg);
 530                         break;
 531                 case '4':
 532                         address_family = AF_INET;
 533                         break;
 534                 case '6':
 535 #ifdef USE_IPV6
 536                         address_family = AF_INET6;
 537 #else
 538                         usage4 (_("IPv6 support not available"));
 539 #endif
 540                         break;
 541                 case '?':
 542                         /* print short usage statement if args not parsable */
 543                         usage5 ();
 544                         break;
 545                 }
 546         }
 547
 548         if(server_address == NULL){
 549                 usage4(_("Hostname was not supplied"));
 550         }
 551
 552         return 0;
 553 }
 554
 555 char *perfd_offset (double offset)
 556 {
 557         return fperfdata ("offset", offset, "s",
 558                 TRUE, offset_thresholds->warning->end,
 559                 TRUE, offset_thresholds->critical->end,
 560                 FALSE, 0, FALSE, 0);
 561 }
 562
 563 char *perfd_jitter (double jitter)
 564 {
 565         return fperfdata ("jitter", jitter, "",
 566                 do_jitter, jitter_thresholds->warning->end,
 567                 do_jitter, jitter_thresholds->critical->end,
 568                 TRUE, 0, FALSE, 0);
 569 }
 570
 571 char *perfd_stratum (int stratum)
 572 {
 573         return perfdata ("stratum", stratum, "",
 574                 do_stratum, (int)stratum_thresholds->warning->end,
 575                 do_stratum, (int)stratum_thresholds->critical->end,
 576                 TRUE, 0, TRUE, 16);
 577 }
 578
 579 int main(int argc, char *argv[]){
 580         int result, offset_result, stratum;
 581         double offset=0, jitter=0;
 582         char *result_line, *perfdata_line;
 583
 584         setlocale (LC_ALL, "");
 585         bindtextdomain (PACKAGE, LOCALEDIR);
 586         textdomain (PACKAGE);
 587
 588         /* Parse extra opts if any */
 589         argv=np_extra_opts (&argc, argv, progname);
 590
 591         if (process_arguments (argc, argv) == ERROR)
 592                 usage4 (_("Could not parse arguments"));
 593
 594         set_thresholds(&offset_thresholds, owarn, ocrit);
 595         set_thresholds(&jitter_thresholds, jwarn, jcrit);
 596         set_thresholds(&stratum_thresholds, swarn, scrit);
 597
 598         /* initialize alarm signal handling */
 599         signal (SIGALRM, socket_timeout_alarm_handler);
 600
 601         /* set socket timeout */
 602         alarm (socket_timeout);
 603
 604         /* This returns either OK or WARNING (See comment preceeding ntp_request) */
 605         result = ntp_request(server_address, &offset, &offset_result, &jitter, &stratum);
 606
 607         if(offset_result == STATE_UNKNOWN) {
 608                 /* if there's no sync peer (this overrides ntp_request output): */
 609                 result = (quiet == 1 ? STATE_UNKNOWN : STATE_CRITICAL);
 610         } else {
 611                 /* Be quiet if there's no candidates either */
 612                 if (quiet == 1 && result == STATE_WARNING)
 613                         result = STATE_UNKNOWN;
 614                 result = max_state_alt(result, get_status(fabs(offset), offset_thresholds));
 615         }
 616
 617         if(do_stratum)
 618                 result = max_state_alt(result, get_status(stratum, stratum_thresholds));
 619
 620         if(do_jitter)
 621                 result = max_state_alt(result, get_status(jitter, jitter_thresholds));
 622
 623         switch (result) {
 624                 case STATE_CRITICAL :
 625                         asprintf(&result_line, _("NTP CRITICAL:"));
 626                         break;
 627                 case STATE_WARNING :
 628                         asprintf(&result_line, _("NTP WARNING:"));
 629                         break;
 630                 case STATE_OK :
 631                         asprintf(&result_line, _("NTP OK:"));
 632                         break;
 633                 default :
 634                         asprintf(&result_line, _("NTP UNKNOWN:"));
 635                         break;
 636         }
 637         if(!syncsource_found)
 638                 asprintf(&result_line, "%s %s,", result_line, _("Server not synchronized"));
 639         else if(li_alarm)
 640                 asprintf(&result_line, "%s %s,", result_line, _("Server has the LI_ALARM bit set"));
 641
 642         if(offset_result == STATE_UNKNOWN){
 643                 asprintf(&result_line, "%s %s", result_line, _("Offset unknown"));
 644                 asprintf(&perfdata_line, "");
 645         } else {
 646                 asprintf(&result_line, "%s %s %.10g secs", result_line, _("Offset"), offset);
 647                 asprintf(&perfdata_line, "%s", perfd_offset(offset));
 648         }
 649         if (do_jitter) {
 650                 asprintf(&result_line, "%s, jitter=%f", result_line, jitter);
 651                 asprintf(&perfdata_line, "%s %s", perfdata_line, perfd_jitter(jitter));
 652         }
 653         if (do_stratum) {
 654                 asprintf(&result_line, "%s, stratum=%i", result_line, stratum);
 655                 asprintf(&perfdata_line, "%s %s", perfdata_line, perfd_stratum(stratum));
 656         }
 657         printf("%s|%s\n", result_line, perfdata_line);
 658
 659         if(server_address!=NULL) free(server_address);
 660         return result;
 661 }
 662
 663
 664
 665 void print_help(void){
 666         print_revision(progname, revision);
 667
 668         printf ("Copyright (c) 2006 Sean Finney\n");
 669         printf (COPYRIGHT, copyright, email);
 670
 671         printf ("%s\n", _("This plugin checks the selected ntp server"));
 672
 673         printf ("\n\n");
 674
 675         print_usage();
 676         printf (_(UT_HELP_VRSN));
 677         printf (_(UT_EXTRA_OPTS));
 678         printf (_(UT_HOST_PORT), 'p', "123");
 679         printf (" %s\n", "-q, --quiet");
 680         printf ("    %s\n", _("Returns UNKNOWN instead of CRITICAL or WARNING if server isn't synchronized"));
 681         printf (" %s\n", "-w, --warning=THRESHOLD");
 682         printf ("    %s\n", _("Offset to result in warning status (seconds)"));
 683         printf (" %s\n", "-c, --critical=THRESHOLD");
 684         printf ("    %s\n", _("Offset to result in critical status (seconds)"));
 685         printf (" %s\n", "-W, --swarn=THRESHOLD");
 686         printf ("    %s\n", _("Warning threshold for stratum"));
 687         printf (" %s\n", "-C, --scrit=THRESHOLD");
 688         printf ("    %s\n", _("Critical threshold for stratum"));
 689         printf (" %s\n", "-j, --jwarn=THRESHOLD");
 690         printf ("    %s\n", _("Warning threshold for jitter"));
 691         printf (" %s\n", "-k, --jcrit=THRESHOLD");
 692         printf ("    %s\n", _("Critical threshold for jitter"));
 693         printf (_(UT_TIMEOUT), DEFAULT_SOCKET_TIMEOUT);
 694         printf (_(UT_VERBOSE));
 695
 696         printf("\n");
 697         printf("%s\n", _("This plugin checks an NTP server independent of any commandline"));
 698         printf("%s\n\n", _("programs or external libraries."));
 699
 700         printf("%s\n", _("Notes:"));
 701         printf(" %s\n", _("Use this plugin to check the health of an NTP server. It supports"));
 702         printf(" %s\n", _("checking the offset with the sync peer, the jitter and stratum. This"));
 703         printf(" %s\n", _("plugin will not check the clock offset between the local host and NTP"));
 704         printf(" %s\n", _("server; please use check_ntp_time for that purpose."));
 705         printf("\n");
 706         printf(_(UT_THRESHOLDS_NOTES));
 707 #ifdef NP_EXTRA_OPTS
 708         printf("\n");
 709         printf(_(UT_EXTRA_OPTS_NOTES));
 710 #endif
 711
 712         printf("\n");
 713         printf("%s\n", _("Examples:"));
 714         printf(" %s\n", _("Simple NTP server check:"));
 715         printf("  %s\n", ("./check_ntp_peer -H ntpserv -w 0.5 -c 1"));
 716         printf("\n");
 717         printf(" %s\n", _("Check jitter too, avoiding critical notifications if jitter isn't available"));
 718         printf(" %s\n", _("(See Notes above for more details on thresholds formats):"));
 719         printf("  %s\n", ("./check_ntp_peer -H ntpserv -w 0.5 -c 1 -j -1:100 -k -1:200"));
 720         printf("\n");
 721         printf(" %s\n", _("Check only stratum:"));
 722         printf("  %s\n", ("./check_ntp_peer -H ntpserv -W 4 -C 6"));
 723
 724         printf (_(UT_SUPPORT));
 725 }
 726
 727 void
 728 print_usage(void)
 729 {
 730         printf (_("Usage:"));
 731         printf(" %s -H <host> [-w <warn>] [-c <crit>] [-W <warn>] [-C <crit>]\n", progname);
 732         printf("       [-j <warn>] [-k <crit>] [-v verbose]\n");
 733 }