2 * collectd - src/openldap.c
3 * Copyright (C) 2011 Kimo Rosenbaum
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.
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.
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
19 * Kimo Rosenbaum <kimor79 at yahoo.com>
25 #include "configfile.h"
30 struct ldap_s /* {{{ */
46 typedef struct ldap_s ldap_t; /* }}} */
48 static int ldap_read_host (user_data_t *ud);
50 static void ldap_free (ldap_t *st) /* {{{ */
62 } /* }}} void ldap_free */
64 /* Configuration handling functions {{{
67 * <Instance "plugin_instance1">
68 * URL "ldap://localhost"
74 static int config_set_string (char **ret_string, /* {{{ */
79 if ((ci->values_num != 1)
80 || (ci->values[0].type != OCONFIG_TYPE_STRING))
82 WARNING ("openldap plugin: The `%s' config option "
83 "needs exactly one string argument.", ci->key);
87 string = strdup (ci->values[0].value.string);
90 ERROR ("openldap plugin: strdup failed.");
94 if (*ret_string != NULL)
99 } /* }}} int config_set_string */
101 static int config_set_int (int *ret_int, /* {{{ */
104 if ((ci->values_num != 1)
105 || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
107 WARNING ("openldap plugin: The `%s' config option "
108 "needs exactly one string argument.", ci->key);
112 *ret_int = ci->values[0].value.number;
115 } /* }}} int config_set_int */
117 static int config_set_bool (int *ret_boolean, /* {{{ */
122 if (ci->values_num != 1)
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)
131 if (IS_TRUE (ci->values[0].value.string))
133 else if (IS_FALSE (ci->values[0].value.string))
144 WARNING ("openldap plugin: The `%s' config option "
145 "needs exactly one boolean argument.", ci->key);
149 } /* }}} config_set_bool */
151 static int config_add (oconfig_item_t *ci) /* {{{ */
157 if ((ci->values_num != 1)
158 || (ci->values[0].type != OCONFIG_TYPE_STRING))
160 WARNING ("openldap plugin: The `%s' config option "
161 "needs exactly one string argument.", ci->key);
165 st = (ldap_t *) malloc (sizeof (*st));
168 ERROR ("openldap plugin: malloc failed.");
171 memset (st, 0, sizeof (*st));
173 status = config_set_string (&st->name, ci);
181 st->version = LDAP_VERSION3;
183 for (i = 0; i < ci->children_num; i++)
185 oconfig_item_t *child = ci->children + i;
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);
201 WARNING ("openldap plugin: Option `%s' not allowed here.",
210 /* Check if struct is complete.. */
211 if ((status == 0) && (st->url == NULL))
213 ERROR ("openldap plugin: Instance `%s': "
214 "No URL has been configured.",
219 /* Check if URL is valid */
220 if ((status == 0) && (st->url != NULL))
225 if ((rc = ldap_url_parse( st->url, &ludpp)) != 0)
227 ERROR ("openldap plugin: Instance `%s': "
234 st->host = strdup (ludpp->lud_host);
237 ldap_free_urldesc(ludpp);
243 char callback_name[3*DATA_MAX_NAME_LEN];
245 memset (&ud, 0, sizeof (ud));
247 ud.free_func = (void *) ldap_free;
249 memset (callback_name, 0, sizeof (callback_name));
250 ssnprintf (callback_name, sizeof (callback_name),
252 (st->host != NULL) ? st->host : hostname_g,
253 (st->name != NULL) ? st->name : "default"),
255 status = plugin_register_complex_read (/* group = */ NULL,
256 /* name = */ callback_name,
257 /* callback = */ ldap_read_host,
258 /* interval = */ NULL,
259 /* user_data = */ &ud);
269 } /* }}} int config_add */
271 static int config (oconfig_item_t *ci)
276 for (i = 0; i < ci->children_num; i++)
278 oconfig_item_t *child = ci->children + i;
280 if (strcasecmp ("Instance", child->key) == 0)
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?",
288 } /* for (ci->children) */
293 /* }}} End of configuration handling functions */
295 /* initialize ldap for each host */
296 static int init_host (ldap_t *st)
300 rc = ldap_initialize (&ld, st->url);
301 if (rc != LDAP_SUCCESS)
304 sstrerror (errno, errbuf, sizeof (errbuf));
305 ERROR ("ldap_initialize failed: %s", errbuf);
312 ldap_set_option (st->ld, LDAP_OPT_PROTOCOL_VERSION, &st->version);
314 if(st->cacert != NULL)
315 ldap_set_option (st->ld, LDAP_OPT_X_TLS_CACERTFILE, st->cacert);
317 if(st->verifyhost == 0)
319 int never = LDAP_OPT_X_TLS_NEVER;
320 ldap_set_option (st->ld, LDAP_OPT_X_TLS_REQUIRE_CERT, &never);
323 if(st->starttls != 0)
325 rc = ldap_start_tls_s(ld, NULL, NULL);
326 if (rc != LDAP_SUCCESS)
328 ERROR ("openldap plugin: Failed to start tls on %s: %s",
329 st->url, ldap_err2string (rc));
339 rc = ldap_sasl_bind_s(st->ld, NULL, NULL, &cred, NULL, NULL, NULL);
340 if (rc != LDAP_SUCCESS)
342 ERROR ("openldap plugin: Failed to bind to %s: %s",
343 st->url, ldap_err2string (rc));
349 DEBUG ("openldap plugin: Successfully connected to %s",
354 } /* static init_host (ldap_t *st) */
356 static void submit_value (const char *type, const char *type_instance,
357 value_t value, ldap_t *st)
359 value_list_t vl = VALUE_LIST_INIT;
364 if ((st->host == NULL)
365 || (strcmp ("", st->host) == 0)
366 || (strcmp ("localhost", st->host) == 0))
368 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
372 sstrncpy (vl.host, st->host, sizeof (vl.host));
375 sstrncpy (vl.plugin, "openldap", sizeof (vl.plugin));
376 if (st->name != NULL)
377 sstrncpy (vl.plugin_instance, st->name,
378 sizeof (vl.plugin_instance));
380 sstrncpy (vl.type, type, sizeof (vl.type));
381 if (type_instance != NULL)
382 sstrncpy (vl.type_instance, type_instance,
383 sizeof (vl.type_instance));
385 plugin_dispatch_values (&vl);
388 static void submit_derive (const char *type, const char *type_instance,
389 derive_t d, ldap_t *st)
393 submit_value (type, type_instance, v, st);
394 } /* void submit_derive */
396 static void submit_gauge (const char *type, const char *type_instance,
397 gauge_t g, ldap_t *st)
401 submit_value (type, type_instance, v, st);
402 } /* void submit_gauge */
404 static int ldap_read_host (user_data_t *ud)
407 LDAPMessage *e, *result;
412 char *attrs[3] = { "monitorCounter",
413 "monitorOpCompleted",
414 "monitorOpInitiated" };
416 if ((ud == NULL) || (ud->data == NULL))
418 ERROR ("openldap plugin: ldap_read_host: Invalid user data.");
422 st = (ldap_t *) ud->data;
424 status = init_host (st);
428 rc = ldap_search_ext_s (st->ld, "cn=Monitor", LDAP_SCOPE_SUBTREE,
429 "(!(cn=* *))", attrs, 0,
430 NULL, NULL, NULL, 0, &result);
432 if (rc != LDAP_SUCCESS)
434 ERROR ("openldap plugin: Failed to execute search: %s",
435 ldap_err2string (rc));
436 ldap_msgfree (result);
440 for (e = ldap_first_entry (st->ld, result); e != NULL;
441 e = ldap_next_entry (st->ld, e))
443 if ((dn = ldap_get_dn (st->ld, e)) != NULL)
445 unsigned long long counter = 0;
446 unsigned long long opc = 0;
447 unsigned long long opi = 0;
449 struct berval counter_data;
450 struct berval opc_data;
451 struct berval opi_data;
453 struct berval **counter_list;
454 struct berval **opc_list;
455 struct berval **opi_list;
457 if ((counter_list = ldap_get_values_len (st->ld, e,
458 "monitorCounter")) != NULL)
460 counter_data = *counter_list[0];
461 counter = atoll (counter_data.bv_val);
464 if ((opc_list = ldap_get_values_len (st->ld, e,
465 "monitorOpCompleted")) != NULL)
467 opc_data = *opc_list[0];
468 opc = atoll (opc_data.bv_val);
471 if ((opi_list = ldap_get_values_len (st->ld, e,
472 "monitorOpInitiated")) != NULL)
474 opi_data = *opi_list[0];
475 opi = atoll (opi_data.bv_val);
478 if (strcmp (dn, "cn=Total,cn=Connections,cn=Monitor")
481 submit_derive ("total_connections", NULL,
485 "cn=Current,cn=Connections,cn=Monitor")
488 submit_gauge ("current_connections", NULL,
492 "cn=Operations,cn=Monitor") == 0)
494 submit_derive ("operations",
495 "completed", opc, st);
496 submit_derive ("operations",
497 "initiated", opi, st);
500 "cn=Bind,cn=Operations,cn=Monitor")
503 submit_derive ("operations",
504 "bind-completed", opc, st);
505 submit_derive ("operations",
506 "bind-initiated", opi, st);
509 "cn=UnBind,cn=Operations,cn=Monitor")
512 submit_derive ("operations",
513 "unbind-completed", opc, st);
514 submit_derive ("operations",
515 "unbind-initiated", opi, st);
518 "cn=Search,cn=Operations,cn=Monitor")
521 submit_derive ("operations",
522 "search-completed", opc, st);
523 submit_derive ("operations",
524 "search-initiated", opi, st);
527 "cn=Compare,cn=Operations,cn=Monitor")
530 submit_derive ("operations",
531 "compare-completed", opc, st);
532 submit_derive ("operations",
533 "compare-initiated", opi, st);
536 "cn=Modify,cn=Operations,cn=Monitor")
539 submit_derive ("operations",
540 "modify-completed", opc, st);
541 submit_derive ("operations",
542 "modify-initiated", opi, st);
545 "cn=Modrdn,cn=Operations,cn=Monitor")
548 submit_derive ("operations",
549 "modrdn-completed", opc, st);
550 submit_derive ("operations",
551 "modrdn-initiated", opi, st);
554 "cn=Add,cn=Operations,cn=Monitor")
557 submit_derive ("operations",
558 "add-completed", opc, st);
559 submit_derive ("operations",
560 "add-initiated", opi, st);
563 "cn=Delete,cn=Operations,cn=Monitor")
566 submit_derive ("operations",
567 "delete-completed", opc, st);
568 submit_derive ("operations",
569 "delete-initiated", opi, st);
572 "cn=Abandon,cn=Operations,cn=Monitor")
575 submit_derive ("operations",
576 "abandon-completed", opc, st);
577 submit_derive ("operations",
578 "abandon-initiated", opi, st);
581 "cn=Extended,cn=Operations,cn=Monitor")
584 submit_derive ("operations",
585 "extended-completed", opc, st);
586 submit_derive ("operations",
587 "extended-initiated", opi, st);
590 "cn=Bytes,cn=Statistics,cn=Monitor")
593 submit_derive ("derive", "statistics-bytes",
597 "cn=PUD,cn=Statistics,cn=Monitor")
600 submit_derive ("derive", "statistics-pdu",
604 "cn=Entries,cn=Statistics,cn=Monitor")
607 submit_derive ("derive", "statistics-entries",
611 "cn=Referrals,cn=Statistics,cn=Monitor")
614 submit_derive ("derive", "statistics-referrals",
618 "cn=Read,cn=Waiters,cn=Monitor")
621 submit_derive ("derive", "waiters-read",
625 "cn=Write,cn=Waiters,cn=Monitor")
628 submit_derive ("derive", "waiters-write",
632 ldap_value_free_len (counter_list);
633 ldap_value_free_len (opc_list);
634 ldap_value_free_len (opi_list);
640 ldap_msgfree (result);
641 ldap_unbind_ext_s (st->ld, NULL, NULL);
643 } /* int ldap_read_host */
645 void module_register (void)
647 plugin_register_complex_config ("openldap", config);
648 } /* void module_register */