plugins/check_ldap.c

   1 /*****************************************************************************
   2 *
   3 * Nagios check_ldap plugin
   4 *
   5 * License: GPL
   6 * Copyright (c) 2000-2008 Nagios Plugins Development Team
   7 *
   8 * Description:
   9 *
  10 * This file contains the check_ldap plugin
  11 *
  12 *
  13 * This program is free software: you can redistribute it and/or modify
  14 * it under the terms of the GNU General Public License as published by
  15 * the Free Software Foundation, either version 3 of the License, or
  16 * (at your option) any later version.
  17 *
  18 * This program is distributed in the hope that it will be useful,
  19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21 * GNU General Public License for more details.
  22 *
  23 * You should have received a copy of the GNU General Public License
  24 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  25 *
  26 *
  27 *****************************************************************************/
  28
  29 /* progname may be check_ldaps */
  30 char *progname = "check_ldap";
  31 const char *copyright = "2000-2008";
  32 const char *email = "nagiosplug-devel@lists.sourceforge.net";
  33
  34 #include "common.h"
  35 #include "netutils.h"
  36 #include "utils.h"
  37
  38 #include <lber.h>
  39 #include <ldap.h>
  40
  41 enum {
  42         UNDEFINED = 0,
  43 #ifdef HAVE_LDAP_SET_OPTION
  44         DEFAULT_PROTOCOL = 2,
  45 #endif
  46         DEFAULT_PORT = 389
  47 };
  48
  49 int process_arguments (int, char **);
  50 int validate_arguments (void);
  51 void print_help (void);
  52 void print_usage (void);
  53
  54 char ld_defattr[] = "(objectclass=*)";
  55 char *ld_attr = ld_defattr;
  56 char *ld_host = NULL;
  57 char *ld_base = NULL;
  58 char *ld_passwd = NULL;
  59 char *ld_binddn = NULL;
  60 int ld_port = DEFAULT_PORT;
  61 #ifdef HAVE_LDAP_SET_OPTION
  62 int ld_protocol = DEFAULT_PROTOCOL;
  63 #endif
  64 #ifndef LDAP_OPT_SUCCESS
  65 # define LDAP_OPT_SUCCESS LDAP_SUCCESS
  66 #endif
  67 double warn_time = UNDEFINED;
  68 double crit_time = UNDEFINED;
  69 struct timeval tv;
  70 int starttls = FALSE;
  71 int ssl_on_connect = FALSE;
  72 int verbose = 0;
  73
  74 /* for ldap tls */
  75
  76 char *SERVICE = "LDAP";
  77
  78 int
  79 main (int argc, char *argv[])
  80 {
  81
  82         LDAP *ld;
  83         LDAPMessage *result;
  84
  85         /* should be    int result = STATE_UNKNOWN; */
  86
  87         int status = STATE_UNKNOWN;
  88         long microsec;
  89         double elapsed_time;
  90
  91         /* for ldap tls */
  92
  93         int tls;
  94         int version=3;
  95
  96         setlocale (LC_ALL, "");
  97         bindtextdomain (PACKAGE, LOCALEDIR);
  98         textdomain (PACKAGE);
  99
 100         if (strstr(argv[0],"check_ldaps")) {
 101                 asprintf (&progname, "check_ldaps");
 102         }
 103
 104         /* Parse extra opts if any */
 105         argv=np_extra_opts (&argc, argv, progname);
 106
 107         if (process_arguments (argc, argv) == ERROR)
 108                 usage4 (_("Could not parse arguments"));
 109
 110         if (strstr(argv[0],"check_ldaps") && ! starttls && ! ssl_on_connect)
 111                 starttls = TRUE;
 112
 113         /* initialize alarm signal handling */
 114         signal (SIGALRM, socket_timeout_alarm_handler);
 115
 116         /* set socket timeout */
 117         alarm (socket_timeout);
 118
 119         /* get the start time */
 120         gettimeofday (&tv, NULL);
 121
 122         /* initialize ldap */
 123 #ifdef HAVE_LDAP_INIT
 124         if (!(ld = ldap_init (ld_host, ld_port))) {
 125                 printf ("Could not connect to the server at port %i\n", ld_port);
 126                 return STATE_CRITICAL;
 127         }
 128 #else
 129         if (!(ld = ldap_open (ld_host, ld_port))) {
 130                 if (verbose)
 131                         ldap_perror(ld, "ldap_open");
 132                 printf (_("Could not connect to the server at port %i\n"), ld_port);
 133                 return STATE_CRITICAL;
 134         }
 135 #endif /* HAVE_LDAP_INIT */
 136
 137 #ifdef HAVE_LDAP_SET_OPTION
 138         /* set ldap options */
 139         if (ldap_set_option (ld, LDAP_OPT_PROTOCOL_VERSION, &ld_protocol) !=
 140                         LDAP_OPT_SUCCESS ) {
 141                 printf(_("Could not set protocol version %d\n"), ld_protocol);
 142                 return STATE_CRITICAL;
 143         }
 144 #endif
 145
 146         if (ld_port == LDAPS_PORT || ssl_on_connect) {
 147                 asprintf (&SERVICE, "LDAPS");
 148 #if defined(HAVE_LDAP_SET_OPTION) && defined(LDAP_OPT_X_TLS)
 149                 /* ldaps: set option tls */
 150                 tls = LDAP_OPT_X_TLS_HARD;
 151
 152                 if (ldap_set_option (ld, LDAP_OPT_X_TLS, &tls) != LDAP_SUCCESS)
 153                 {
 154                         if (verbose)
 155                                 ldap_perror(ld, "ldaps_option");
 156                         printf (_("Could not init TLS at port %i!\n"), ld_port);
 157                         return STATE_CRITICAL;
 158                 }
 159 #else
 160                 printf (_("TLS not supported by the libraries!\n"));
 161                 return STATE_CRITICAL;
 162 #endif /* LDAP_OPT_X_TLS */
 163         } else if (starttls) {
 164                 asprintf (&SERVICE, "LDAP-TLS");
 165 #if defined(HAVE_LDAP_SET_OPTION) && defined(HAVE_LDAP_START_TLS_S)
 166                 /* ldap with startTLS: set option version */
 167                 if (ldap_get_option(ld,LDAP_OPT_PROTOCOL_VERSION, &version) == LDAP_OPT_SUCCESS )
 168                 {
 169                         if (version < LDAP_VERSION3)
 170                         {
 171                                 version = LDAP_VERSION3;
 172                                 ldap_set_option(ld, LDAP_OPT_PROTOCOL_VERSION, &version);
 173                         }
 174                 }
 175                 /* call start_tls */
 176                 if (ldap_start_tls_s(ld, NULL, NULL) != LDAP_SUCCESS)
 177                 {
 178                         if (verbose)
 179                                 ldap_perror(ld, "ldap_start_tls");
 180                         printf (_("Could not init startTLS at port %i!\n"), ld_port);
 181                         return STATE_CRITICAL;
 182                 }
 183 #else
 184                 printf (_("startTLS not supported by the library, needs LDAPv3!\n"));
 185                 return STATE_CRITICAL;
 186 #endif /* HAVE_LDAP_START_TLS_S */
 187         }
 188
 189         /* bind to the ldap server */
 190         if (ldap_bind_s (ld, ld_binddn, ld_passwd, LDAP_AUTH_SIMPLE) !=
 191                         LDAP_SUCCESS) {
 192                 if (verbose)
 193                         ldap_perror(ld, "ldap_bind");
 194                 printf (_("Could not bind to the LDAP server\n"));
 195                 return STATE_CRITICAL;
 196         }
 197
 198         /* do a search of all objectclasses in the base dn */
 199         if (ldap_search_s (ld, ld_base, LDAP_SCOPE_BASE, ld_attr, NULL, 0, &result)
 200                         != LDAP_SUCCESS) {
 201                 if (verbose)
 202                         ldap_perror(ld, "ldap_search");
 203                 printf (_("Could not search/find objectclasses in %s\n"), ld_base);
 204                 return STATE_CRITICAL;
 205         }
 206
 207         /* unbind from the ldap server */
 208         ldap_unbind (ld);
 209
 210         /* reset the alarm handler */
 211         alarm (0);
 212
 213         /* calcutate the elapsed time and compare to thresholds */
 214
 215         microsec = deltime (tv);
 216         elapsed_time = (double)microsec / 1.0e6;
 217
 218         if (crit_time!=UNDEFINED && elapsed_time>crit_time)
 219                 status = STATE_CRITICAL;
 220         else if (warn_time!=UNDEFINED && elapsed_time>warn_time)
 221                 status = STATE_WARNING;
 222         else
 223                 status = STATE_OK;
 224
 225         /* print out the result */
 226         printf (_("LDAP %s - %.3f seconds response time|%s\n"),
 227                 state_text (status),
 228                 elapsed_time,
 229                 fperfdata ("time", elapsed_time, "s",
 230                           (int)warn_time, warn_time,
 231                           (int)crit_time, crit_time,
 232                           TRUE, 0, FALSE, 0));
 233
 234         return status;
 235 }
 236
 237 /* process command-line arguments */
 238 int
 239 process_arguments (int argc, char **argv)
 240 {
 241         int c;
 242
 243         int option = 0;
 244         /* initialize the long option struct */
 245         static struct option longopts[] = {
 246                 {"help", no_argument, 0, 'h'},
 247                 {"version", no_argument, 0, 'V'},
 248                 {"timeout", required_argument, 0, 't'},
 249                 {"host", required_argument, 0, 'H'},
 250                 {"base", required_argument, 0, 'b'},
 251                 {"attr", required_argument, 0, 'a'},
 252                 {"bind", required_argument, 0, 'D'},
 253                 {"pass", required_argument, 0, 'P'},
 254 #ifdef HAVE_LDAP_SET_OPTION
 255                 {"ver2", no_argument, 0, '2'},
 256                 {"ver3", no_argument, 0, '3'},
 257 #endif
 258                 {"starttls", no_argument, 0, 'T'},
 259                 {"ssl", no_argument, 0, 'S'},
 260                 {"use-ipv4", no_argument, 0, '4'},
 261                 {"use-ipv6", no_argument, 0, '6'},
 262                 {"port", required_argument, 0, 'p'},
 263                 {"warn", required_argument, 0, 'w'},
 264                 {"crit", required_argument, 0, 'c'},
 265                 {"verbose", no_argument, 0, 'v'},
 266                 {0, 0, 0, 0}
 267         };
 268
 269         if (argc < 2)
 270                 return ERROR;
 271
 272         for (c = 1; c < argc; c++) {
 273                 if (strcmp ("-to", argv[c]) == 0)
 274                         strcpy (argv[c], "-t");
 275         }
 276
 277         while (1) {
 278                 c = getopt_long (argc, argv, "hvV234TS6t:c:w:H:b:p:a:D:P:", longopts, &option);
 279
 280                 if (c == -1 || c == EOF)
 281                         break;
 282
 283                 switch (c) {
 284                 case 'h':                                                                       /* help */
 285                         print_help ();
 286                         exit (STATE_OK);
 287                 case 'V':                                                                       /* version */
 288                         print_revision (progname, NP_VERSION);
 289                         exit (STATE_OK);
 290                 case 't':                                                                       /* timeout period */
 291                         if (!is_intnonneg (optarg))
 292                                 usage2 (_("Timeout interval must be a positive integer"), optarg);
 293                         else
 294                                 socket_timeout = atoi (optarg);
 295                         break;
 296                 case 'H':
 297                         ld_host = optarg;
 298                         break;
 299                 case 'b':
 300                         ld_base = optarg;
 301                         break;
 302                 case 'p':
 303                         ld_port = atoi (optarg);
 304                         break;
 305                 case 'a':
 306                         ld_attr = optarg;
 307                         break;
 308                 case 'D':
 309                         ld_binddn = optarg;
 310                         break;
 311                 case 'P':
 312                         ld_passwd = optarg;
 313                         break;
 314                 case 'w':
 315                         warn_time = strtod (optarg, NULL);
 316                         break;
 317                 case 'c':
 318                         crit_time = strtod (optarg, NULL);
 319                         break;
 320 #ifdef HAVE_LDAP_SET_OPTION
 321                 case '2':
 322                         ld_protocol = 2;
 323                         break;
 324                 case '3':
 325                         ld_protocol = 3;
 326                         break;
 327 #endif
 328                 case '4':
 329                         address_family = AF_INET;
 330                         break;
 331                 case 'v':
 332                         verbose++;
 333                         break;
 334                 case 'T':
 335                         if (! ssl_on_connect)
 336                                 starttls = TRUE;
 337                         else
 338                                 usage_va(_("%s cannot be combined with %s"), "-T/--starttls", "-S/--ssl");
 339                         break;
 340                 case 'S':
 341                         if (! starttls) {
 342                                 ssl_on_connect = TRUE;
 343                                 ld_port = LDAPS_PORT;
 344                         } else
 345                                 usage_va(_("%s cannot be combined with %s"), "-S/--ssl", "-T/--starttls");
 346                         break;
 347                 case '6':
 348 #ifdef USE_IPV6
 349                         address_family = AF_INET6;
 350 #else
 351                         usage (_("IPv6 support not available\n"));
 352 #endif
 353                         break;
 354                 default:
 355                         usage5 ();
 356                 }
 357         }
 358
 359         c = optind;
 360         if (ld_host == NULL && is_host(argv[c]))
 361                 ld_host = strdup (argv[c++]);
 362
 363         if (ld_base == NULL && argv[c])
 364                 ld_base = strdup (argv[c++]);
 365
 366         return validate_arguments ();
 367 }
 368
 369
 370 int
 371 validate_arguments ()
 372 {
 373         if (ld_host==NULL || strlen(ld_host)==0)
 374                 usage4 (_("Please specify the host name\n"));
 375
 376         if (ld_base==NULL || strlen(ld_base)==0)
 377                 usage4 (_("Please specify the LDAP base\n"));
 378
 379         return OK;
 380 }
 381
 382
 383 void
 384 print_help (void)
 385 {
 386         char *myport;
 387         asprintf (&myport, "%d", DEFAULT_PORT);
 388
 389         print_revision (progname, NP_VERSION);
 390
 391         printf ("Copyright (c) 1999 Didi Rieder (adrieder@sbox.tu-graz.ac.at)\n");
 392         printf (COPYRIGHT, copyright, email);
 393
 394         printf ("\n\n");
 395
 396         print_usage ();
 397
 398         printf (_(UT_HELP_VRSN));
 399         printf (_(UT_EXTRA_OPTS));
 400
 401         printf (_(UT_HOST_PORT), 'p', myport);
 402
 403         printf (_(UT_IPv46));
 404
 405         printf (" %s\n", "-a [--attr]");
 406   printf ("    %s\n", _("ldap attribute to search (default: \"(objectclass=*)\""));
 407   printf (" %s\n", "-b [--base]");
 408   printf ("    %s\n", _("ldap base (eg. ou=my unit, o=my org, c=at"));
 409   printf (" %s\n", "-D [--bind]");
 410   printf ("    %s\n", _("ldap bind DN (if required)"));
 411   printf (" %s\n", "-P [--pass]");
 412   printf ("    %s\n", _("ldap password (if required)"));
 413   printf (" %s\n", "-T [--starttls]");
 414   printf ("    %s\n", _("use starttls mechanism introduced in protocol version 3"));
 415   printf (" %s\n", "-S [--ssl]");
 416   printf ("    %s %i\n", _("use ldaps (ldap v2 ssl method). this also sets the default port to"), LDAPS_PORT);
 417
 418 #ifdef HAVE_LDAP_SET_OPTION
 419         printf (" %s\n", "-2 [--ver2]");
 420   printf ("    %s\n", _("use ldap protocol version 2"));
 421   printf (" %s\n", "-3 [--ver3]");
 422   printf ("    %s\n", _("use ldap protocol version 3"));
 423   printf ("    (%s %d)\n", _("default protocol version:"), DEFAULT_PROTOCOL);
 424 #endif
 425
 426         printf (_(UT_WARN_CRIT));
 427
 428         printf (_(UT_TIMEOUT), DEFAULT_SOCKET_TIMEOUT);
 429
 430         printf (_(UT_VERBOSE));
 431
 432         printf ("\n");
 433         printf ("%s\n", _("Notes:"));
 434         printf (" %s\n", _("If this plugin is called via 'check_ldaps', method 'STARTTLS' will be"));
 435         printf (_(" implied (using default port %i) unless --port=636 is specified. In that case\n"), DEFAULT_PORT);
 436         printf (" %s\n", _("'SSL on connect' will be used no matter how the plugin was called."));
 437         printf (" %s\n", _("This detection is deprecated, please use 'check_ldap' with the '--starttls' or '--ssl' flags"));
 438         printf (" %s\n", _("to define the behaviour explicitly instead."));
 439 #ifdef NP_EXTRA_OPTS
 440         printf ("\n");
 441         printf (_(UT_EXTRA_OPTS_NOTES));
 442 #endif
 443
 444         printf (_(UT_SUPPORT));
 445 }
 446
 447 /* todo
 448 * add option -4 and -6 to the long manual
 449 *
 450 */
 451
 452 void
 453 print_usage (void)
 454 {
 455   printf (_("Usage:"));
 456         printf (" %s -H <host> -b <base_dn> [-p <port>] [-a <attr>] [-D <binddn>]",progname);
 457   printf ("\n       [-P <password>] [-w <warn_time>] [-c <crit_time>] [-t timeout]%s\n",
 458 #ifdef HAVE_LDAP_SET_OPTION
 459                         "\n       [-2|-3] [-4|-6]"
 460 #else
 461                         ""
 462 #endif
 463                         );
 464 }