src/openldap.c

   1 /**
   2  * collectd - src/openldap.c
   3  * Copyright (C) 2011       Kimo Rosenbaum
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the
   7  * Free Software Foundation; only version 2 of the License is applicable.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  17  *
  18  * Authors:
  19  *   Kimo Rosenbaum <kimor79 at yahoo.com>
  20  **/
  21
  22 #include "collectd.h"
  23 #include "common.h"
  24 #include "plugin.h"
  25 #include "configfile.h"
  26
  27 #include <lber.h>
  28 #include <ldap.h>
  29
  30 struct ldap_s /* {{{ */
  31 {
  32         char *name;
  33
  34         char *cacert;
  35         char *host;
  36         int   state;
  37         int   starttls;
  38         int   timeout;
  39         char *url;
  40         int   verifyhost;
  41         int   version;
  42
  43         LDAP *ld;
  44         char *dn;
  45 };
  46 typedef struct ldap_s ldap_t; /* }}} */
  47
  48 static int ldap_read_host (user_data_t *ud);
  49
  50 static void ldap_free (ldap_t *st) /* {{{ */
  51 {
  52         if(st == NULL)
  53                 return;
  54
  55         sfree (st->cacert);
  56         sfree (st->host);
  57         sfree (st->name);
  58         sfree (st->url);
  59         if(st->ld)
  60                 ldap_memfree(st->ld);
  61         sfree (st);
  62 } /* }}} void ldap_free */
  63
  64 /* Configuration handling functions {{{
  65  *
  66  * <Plugin ldap>
  67  *   <Instance "plugin_instance1">
  68  *     URL "ldap://localhost"
  69  *     ...
  70  *   </Instance>
  71  * </Plugin>
  72  */
  73
  74 static int config_set_string (char **ret_string, /* {{{ */
  75                                     oconfig_item_t *ci)
  76 {
  77         char *string;
  78
  79         if ((ci->values_num != 1)
  80             || (ci->values[0].type != OCONFIG_TYPE_STRING))
  81         {
  82                 WARNING ("openldap plugin: The `%s' config option "
  83                          "needs exactly one string argument.", ci->key);
  84                 return (-1);
  85         }
  86
  87         string = strdup (ci->values[0].value.string);
  88         if (string == NULL)
  89         {
  90                 ERROR ("openldap plugin: strdup failed.");
  91                 return (-1);
  92         }
  93
  94         if (*ret_string != NULL)
  95                 free (*ret_string);
  96         *ret_string = string;
  97
  98         return (0);
  99 } /* }}} int config_set_string */
 100
 101 static int config_set_int (int *ret_int, /* {{{ */
 102                                  oconfig_item_t *ci)
 103 {
 104         if ((ci->values_num != 1)
 105             || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
 106         {
 107                 WARNING ("openldap plugin: The `%s' config option "
 108                          "needs exactly one string argument.", ci->key);
 109                 return (-1);
 110         }
 111
 112         *ret_int = ci->values[0].value.number;
 113
 114         return (0);
 115 } /* }}} int config_set_int */
 116
 117 static int config_set_bool (int *ret_boolean, /* {{{ */
 118                                 oconfig_item_t *ci)
 119 {
 120         int status = 0;
 121
 122         if (ci->values_num != 1)
 123                 status = -1;
 124
 125         if (status == 0)
 126         {
 127                 if (ci->values[0].type == OCONFIG_TYPE_BOOLEAN)
 128                         *ret_boolean = ci->values[0].value.boolean;
 129                 else if (ci->values[0].type == OCONFIG_TYPE_STRING)
 130                 {
 131                         if (IS_TRUE (ci->values[0].value.string))
 132                                 *ret_boolean = 1;
 133                         else if (IS_FALSE (ci->values[0].value.string))
 134                                 *ret_boolean = 0;
 135                         else
 136                                 status = -1;
 137                 }
 138                 else
 139                         status = -1;
 140         }
 141
 142         if (status != 0)
 143         {
 144                 WARNING ("openldap plugin: The `%s' config option "
 145                         "needs exactly one boolean argument.", ci->key);
 146                 return (-1);
 147         }
 148         return (0);
 149 } /* }}} config_set_bool */
 150
 151 static int config_add (oconfig_item_t *ci) /* {{{ */
 152 {
 153         ldap_t *st;
 154         int i;
 155         int status;
 156
 157         if ((ci->values_num != 1)
 158             || (ci->values[0].type != OCONFIG_TYPE_STRING))
 159         {
 160                 WARNING ("openldap plugin: The `%s' config option "
 161                          "needs exactly one string argument.", ci->key);
 162                 return (-1);
 163         }
 164
 165         st = (ldap_t *) malloc (sizeof (*st));
 166         if (st == NULL)
 167         {
 168                 ERROR ("openldap plugin: malloc failed.");
 169                 return (-1);
 170         }
 171         memset (st, 0, sizeof (*st));
 172
 173         status = config_set_string (&st->name, ci);
 174         if (status != 0)
 175         {
 176                 sfree (st);
 177                 return (status);
 178         }
 179
 180         st->verifyhost = 1;
 181         st->version = LDAP_VERSION3;
 182
 183         for (i = 0; i < ci->children_num; i++)
 184         {
 185                 oconfig_item_t *child = ci->children + i;
 186
 187                 if (strcasecmp ("CACert", child->key) == 0)
 188                         status = config_set_string (&st->cacert, child);
 189                 else if (strcasecmp ("StartTLS", child->key) == 0)
 190                         status = config_set_bool (&st->starttls, child);
 191                 else if (strcasecmp ("Timeout", child->key) == 0)
 192                         status = config_set_int (&st->timeout, child);
 193                 else if (strcasecmp ("URL", child->key) == 0)
 194                         status = config_set_string (&st->url, child);
 195                 else if (strcasecmp ("VerifyHost", child->key) == 0)
 196                         status = config_set_bool (&st->verifyhost, child);
 197                 else if (strcasecmp ("Version", child->key) == 0)
 198                         status = config_set_int (&st->version, child);
 199                 else
 200                 {
 201                         WARNING ("openldap plugin: Option `%s' not allowed here.",
 202                                         child->key);
 203                         status = -1;
 204                 }
 205
 206                 if (status != 0)
 207                         break;
 208         }
 209
 210         /* Check if struct is complete.. */
 211         if ((status == 0) && (st->url == NULL))
 212         {
 213                 ERROR ("openldap plugin: Instance `%s': "
 214                                 "No URL has been configured.",
 215                                 st->name);
 216                 status = -1;
 217         }
 218
 219         /* Check if URL is valid */
 220         if ((status == 0) && (st->url != NULL))
 221         {
 222                 LDAPURLDesc *ludpp;
 223                 int rc;
 224
 225                 if ((rc = ldap_url_parse( st->url, &ludpp)) != 0)
 226                 {
 227                         ERROR ("openldap plugin: Instance `%s': "
 228                                 "Invalid URL: `%s'",
 229                                 st->name, st->url);
 230                         status = -1;
 231                 }
 232                 else
 233                 {
 234                         st->host = strdup (ludpp->lud_host);
 235                 }
 236
 237                 ldap_free_urldesc(ludpp);
 238         }
 239
 240         if (status == 0)
 241         {
 242                 user_data_t ud;
 243                 char callback_name[3*DATA_MAX_NAME_LEN];
 244
 245                 memset (&ud, 0, sizeof (ud));
 246                 ud.data = st;
 247                 ud.free_func = (void *) ldap_free;
 248
 249                 memset (callback_name, 0, sizeof (callback_name));
 250                 ssnprintf (callback_name, sizeof (callback_name),
 251                                 "openldap/%s/%s",
 252                                 (st->host != NULL) ? st->host : hostname_g,
 253                                 (st->name != NULL) ? st->name : "default"),
 254
 255                 status = plugin_register_complex_read (/* group = */ NULL,
 256                                 /* name      = */ callback_name,
 257                                 /* callback  = */ ldap_read_host,
 258                                 /* interval  = */ NULL,
 259                                 /* user_data = */ &ud);
 260         }
 261
 262         if (status != 0)
 263         {
 264                 ldap_free (st);
 265                 return (-1);
 266         }
 267
 268         return (0);
 269 } /* }}} int config_add */
 270
 271 static int config (oconfig_item_t *ci)
 272 {
 273         int i;
 274         int status = 0;
 275
 276         for (i = 0; i < ci->children_num; i++)
 277         {
 278                 oconfig_item_t *child = ci->children + i;
 279
 280                 if (strcasecmp ("Instance", child->key) == 0)
 281                         config_add (child);
 282                 else
 283                         WARNING ("openldap plugin: The configuration option "
 284                                         "\"%s\" is not allowed here. Did you "
 285                                         "forget to add an <Instance /> block "
 286                                         "around the configuration?",
 287                                         child->key);
 288         } /* for (ci->children) */
 289
 290         return (status);
 291 } /* int config */
 292
 293 /* }}} End of configuration handling functions */
 294
 295 /* initialize ldap for each host */
 296 static int init_host (ldap_t *st)
 297 {
 298         LDAP *ld;
 299         int rc;
 300         rc = ldap_initialize (&ld, st->url);
 301         if (rc != LDAP_SUCCESS)
 302         {
 303                 char errbuf[1024];
 304                 sstrerror (errno, errbuf, sizeof (errbuf));
 305                 ERROR ("ldap_initialize failed: %s", errbuf);
 306                 st->state = 0;
 307                 return (-1);
 308         }
 309
 310         st->ld = ld;
 311
 312         ldap_set_option (st->ld, LDAP_OPT_PROTOCOL_VERSION, &st->version);
 313
 314         if(st->cacert != NULL)
 315                 ldap_set_option (st->ld, LDAP_OPT_X_TLS_CACERTFILE, st->cacert);
 316
 317         if(st->verifyhost == 0)
 318         {
 319                 int never = LDAP_OPT_X_TLS_NEVER;
 320                 ldap_set_option (st->ld, LDAP_OPT_X_TLS_REQUIRE_CERT, &never);
 321         }
 322
 323         if(st->starttls != 0)
 324         {
 325                 rc = ldap_start_tls_s(ld, NULL, NULL);
 326                 if (rc != LDAP_SUCCESS)
 327                 {
 328                         ERROR ("openldap plugin: Failed to start tls on %s: %s",
 329                                         st->url, ldap_err2string (rc));
 330                         st->state = 0;
 331                         ldap_destroy(st->ld);
 332                         return (-1);
 333                 }
 334         }
 335
 336         struct berval cred;
 337         cred.bv_val = "";
 338         cred.bv_len = 0;
 339
 340         rc = ldap_sasl_bind_s(st->ld, NULL, NULL, &cred, NULL, NULL, NULL);
 341         if (rc != LDAP_SUCCESS)
 342         {
 343                 ERROR ("openldap plugin: Failed to bind to %s: %s",
 344                                 st->url, ldap_err2string (rc));
 345                 st->state = 0;
 346                 ldap_destroy(st->ld);
 347                 return (-1);
 348         }
 349         else
 350         {
 351                 DEBUG ("openldap plugin: Successfully connected to %s",
 352                                 st->url);
 353                 st->state = 1;
 354                 return (0);
 355         }
 356 } /* static init_host (ldap_t *st) */
 357
 358 static void submit_value (const char *type, const char *type_instance,
 359                 value_t value, ldap_t *st)
 360 {
 361         value_list_t vl = VALUE_LIST_INIT;
 362
 363         vl.values     = &value;
 364         vl.values_len = 1;
 365
 366         if ((st->host == NULL)
 367                         || (strcmp ("", st->host) == 0)
 368                         || (strcmp ("localhost", st->host) == 0))
 369         {
 370                 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
 371         }
 372         else
 373         {
 374                 sstrncpy (vl.host, st->host, sizeof (vl.host));
 375         }
 376
 377         sstrncpy (vl.plugin, "openldap", sizeof (vl.plugin));
 378         if (st->name != NULL)
 379                 sstrncpy (vl.plugin_instance, st->name,
 380                                 sizeof (vl.plugin_instance));
 381
 382         sstrncpy (vl.type, type, sizeof (vl.type));
 383         if (type_instance != NULL)
 384                 sstrncpy (vl.type_instance, type_instance,
 385                                 sizeof (vl.type_instance));
 386
 387         plugin_dispatch_values (&vl);
 388 } /* submit */
 389
 390 static void submit_derive (const char *type, const char *type_instance,
 391                 derive_t d, ldap_t *st)
 392 {
 393         value_t v;
 394         v.derive = d;
 395         submit_value (type, type_instance, v, st);
 396 } /* void submit_derive */
 397
 398 static void submit_gauge (const char *type, const char *type_instance,
 399                 gauge_t g, ldap_t *st)
 400 {
 401         value_t v;
 402         v.gauge = g;
 403         submit_value (type, type_instance, v, st);
 404 } /* void submit_gauge */
 405
 406 static int ldap_read_host (user_data_t *ud)
 407 {
 408         ldap_t *st;
 409         LDAPMessage *e, *result;
 410         char *dn;
 411         int rc;
 412         int status;
 413
 414         char *attrs[4] = { "monitorCounter",
 415                                 "monitorOpCompleted",
 416                                 "monitorOpInitiated",
 417                                 "monitoredInfo" };
 418
 419         if ((ud == NULL) || (ud->data == NULL))
 420         {
 421                 ERROR ("openldap plugin: ldap_read_host: Invalid user data.");
 422                 return (-1);
 423         }
 424
 425         st = (ldap_t *) ud->data;
 426
 427         status = init_host (st);
 428         if (status != 0)
 429                 return (-1);
 430
 431         rc = ldap_search_ext_s (st->ld, "cn=Monitor", LDAP_SCOPE_SUBTREE,
 432                 "(!(cn=* *))", attrs, 0,
 433                 NULL, NULL, NULL, 0, &result);
 434
 435         if (rc != LDAP_SUCCESS)
 436         {
 437                 ERROR ("openldap plugin: Failed to execute search: %s",
 438                                 ldap_err2string (rc));
 439                 ldap_msgfree (result);
 440                 return (-1);
 441         }
 442
 443         for (e = ldap_first_entry (st->ld, result); e != NULL;
 444                 e = ldap_next_entry (st->ld, e))
 445         {
 446                 if ((dn = ldap_get_dn (st->ld, e)) != NULL)
 447                 {
 448                         unsigned long long counter = 0;
 449                         unsigned long long opc = 0;
 450                         unsigned long long opi = 0;
 451
 452                         struct berval counter_data;
 453                         struct berval opc_data;
 454                         struct berval opi_data;
 455                         struct berval info_data;
 456
 457                         struct berval **counter_list;
 458                         struct berval **opc_list;
 459                         struct berval **opi_list;
 460                         struct berval **info_list;
 461
 462                         if ((counter_list = ldap_get_values_len (st->ld, e,
 463                                 "monitorCounter")) != NULL)
 464                         {
 465                                 counter_data = *counter_list[0];
 466                                 counter = atoll (counter_data.bv_val);
 467                         }
 468
 469                         if ((opc_list = ldap_get_values_len (st->ld, e,
 470                                 "monitorOpCompleted")) != NULL)
 471                         {
 472                                 opc_data = *opc_list[0];
 473                                 opc = atoll (opc_data.bv_val);
 474                         }
 475
 476                         if ((opi_list = ldap_get_values_len (st->ld, e,
 477                                 "monitorOpInitiated")) != NULL)
 478                         {
 479                                 opi_data = *opi_list[0];
 480                                 opi = atoll (opi_data.bv_val);
 481                         }
 482
 483                         if ((info_list = ldap_get_values_len (st->ld, e,
 484                                 "monitoredInfo")) != NULL)
 485                         {
 486                                 info_data = *info_list[0];
 487                                 // don't convert search result to long long at this point,
 488                                 // because this field is often populated with non-numerical data.
 489                         }
 490
 491                         if (strcmp (dn, "cn=Total,cn=Connections,cn=Monitor")
 492                                         == 0)
 493                         {
 494                                 submit_derive ("total_connections", NULL,
 495                                         counter, st);
 496                         }
 497                         else if (strcmp (dn,
 498                                         "cn=Current,cn=Connections,cn=Monitor")
 499                                         == 0)
 500                         {
 501                                 submit_gauge ("current_connections", NULL,
 502                                         counter, st);
 503                         }
 504                         else if (strcmp (dn,
 505                                         "cn=Operations,cn=Monitor") == 0)
 506                         {
 507                                 submit_derive ("operations",
 508                                         "completed", opc, st);
 509                                 submit_derive ("operations",
 510                                         "initiated", opi, st);
 511                         }
 512                         else if (strcmp (dn,
 513                                         "cn=Bind,cn=Operations,cn=Monitor")
 514                                         == 0)
 515                         {
 516                                 submit_derive ("operations",
 517                                         "bind-completed", opc, st);
 518                                 submit_derive ("operations",
 519                                         "bind-initiated", opi, st);
 520                         }
 521                         else if (strcmp (dn,
 522                                         "cn=UnBind,cn=Operations,cn=Monitor")
 523                                         == 0)
 524                         {
 525                                 submit_derive ("operations",
 526                                         "unbind-completed", opc, st);
 527                                 submit_derive ("operations",
 528                                         "unbind-initiated", opi, st);
 529                         }
 530                         else if (strcmp (dn,
 531                                         "cn=Search,cn=Operations,cn=Monitor")
 532                                         == 0)
 533                         {
 534                                 submit_derive ("operations",
 535                                         "search-completed", opc, st);
 536                                 submit_derive ("operations",
 537                                         "search-initiated", opi, st);
 538                         }
 539                         else if (strcmp (dn,
 540                                         "cn=Compare,cn=Operations,cn=Monitor")
 541                                         == 0)
 542                         {
 543                                 submit_derive ("operations",
 544                                         "compare-completed", opc, st);
 545                                 submit_derive ("operations",
 546                                         "compare-initiated", opi, st);
 547                         }
 548                         else if (strcmp (dn,
 549                                         "cn=Modify,cn=Operations,cn=Monitor")
 550                                         == 0)
 551                         {
 552                                 submit_derive ("operations",
 553                                         "modify-completed", opc, st);
 554                                 submit_derive ("operations",
 555                                         "modify-initiated", opi, st);
 556                         }
 557                         else if (strcmp (dn,
 558                                         "cn=Modrdn,cn=Operations,cn=Monitor")
 559                                         == 0)
 560                         {
 561                                 submit_derive ("operations",
 562                                         "modrdn-completed", opc, st);
 563                                 submit_derive ("operations",
 564                                         "modrdn-initiated", opi, st);
 565                         }
 566                         else if (strcmp (dn,
 567                                         "cn=Add,cn=Operations,cn=Monitor")
 568                                         == 0)
 569                         {
 570                                 submit_derive ("operations",
 571                                         "add-completed", opc, st);
 572                                 submit_derive ("operations",
 573                                         "add-initiated", opi, st);
 574                         }
 575                         else if (strcmp (dn,
 576                                         "cn=Delete,cn=Operations,cn=Monitor")
 577                                         == 0)
 578                         {
 579                                 submit_derive ("operations",
 580                                         "delete-completed", opc, st);
 581                                 submit_derive ("operations",
 582                                         "delete-initiated", opi, st);
 583                         }
 584                         else if (strcmp (dn,
 585                                         "cn=Abandon,cn=Operations,cn=Monitor")
 586                                         == 0)
 587                         {
 588                                 submit_derive ("operations",
 589                                         "abandon-completed", opc, st);
 590                                 submit_derive ("operations",
 591                                         "abandon-initiated", opi, st);
 592                         }
 593                         else if (strcmp (dn,
 594                                         "cn=Extended,cn=Operations,cn=Monitor")
 595                                         == 0)
 596                         {
 597                                 submit_derive ("operations",
 598                                         "extended-completed", opc, st);
 599                                 submit_derive ("operations",
 600                                         "extended-initiated", opi, st);
 601                         }
 602                         else if (strcmp (dn,
 603                                         "cn=Bytes,cn=Statistics,cn=Monitor")
 604                                         == 0)
 605                         {
 606                                 submit_derive ("derive", "statistics-bytes",
 607                                         counter, st);
 608                         }
 609                         else if (strcmp (dn,
 610                                         "cn=PDU,cn=Statistics,cn=Monitor")
 611                                         == 0)
 612                         {
 613                                 submit_derive ("derive", "statistics-pdu",
 614                                         counter, st);
 615                         }
 616                         else if (strcmp (dn,
 617                                         "cn=Entries,cn=Statistics,cn=Monitor")
 618                                         == 0)
 619                         {
 620                                 submit_derive ("derive", "statistics-entries",
 621                                         counter, st);
 622                         }
 623                         else if (strcmp (dn,
 624                                         "cn=Referrals,cn=Statistics,cn=Monitor")
 625                                         == 0)
 626                         {
 627                                 submit_derive ("derive", "statistics-referrals",
 628                                         counter, st);
 629                         }
 630                         else if (strcmp (dn,
 631                                         "cn=Open,cn=Threads,cn=Monitor")
 632                                         == 0)
 633                         {
 634                                 submit_gauge ("threads", "threads-open",
 635                                         atoll (info_data.bv_val), st);
 636                         }
 637                         else if (strcmp (dn,
 638                                         "cn=Starting,cn=Threads,cn=Monitor")
 639                                         == 0)
 640                         {
 641                                 submit_gauge ("threads", "threads-starting",
 642                                         atoll (info_data.bv_val), st);
 643                         }
 644                         else if (strcmp (dn,
 645                                         "cn=Active,cn=Threads,cn=Monitor")
 646                                         == 0)
 647                         {
 648                                 submit_gauge ("threads", "threads-active",
 649                                         atoll (info_data.bv_val), st);
 650                         }
 651                         else if (strcmp (dn,
 652                                         "cn=Pending,cn=Threads,cn=Monitor")
 653                                         == 0)
 654                         {
 655                                 submit_gauge ("threads", "threads-pending",
 656                                         atoll (info_data.bv_val), st);
 657                         }
 658                         else if (strcmp (dn,
 659                                         "cn=Backload,cn=Threads,cn=Monitor")
 660                                         == 0)
 661                         {
 662                                 submit_gauge ("threads", "threads-backload",
 663                                         atoll (info_data.bv_val), st);
 664                         }
 665                         else if (strcmp (dn,
 666                                         "cn=Read,cn=Waiters,cn=Monitor")
 667                                         == 0)
 668                         {
 669                                 submit_derive ("derive", "waiters-read",
 670                                         counter, st);
 671                         }
 672                         else if (strcmp (dn,
 673                                         "cn=Write,cn=Waiters,cn=Monitor")
 674                                         == 0)
 675                         {
 676                                 submit_derive ("derive", "waiters-write",
 677                                         counter, st);
 678                         }
 679
 680                         ldap_value_free_len (counter_list);
 681                         ldap_value_free_len (opc_list);
 682                         ldap_value_free_len (opi_list);
 683                         ldap_value_free_len (info_list);
 684                 }
 685
 686                 ldap_memfree (dn);
 687         }
 688
 689         ldap_msgfree (result);
 690         ldap_unbind_ext_s (st->ld, NULL, NULL);
 691         return (0);
 692 } /* int ldap_read_host */
 693
 694 void module_register (void)
 695 {
 696         plugin_register_complex_config ("openldap", config);
 697 } /* void module_register */