/**
* collectd - src/openldap.c
* Copyright (C) 2011 Kimo Rosenbaum
+ * Copyright (C) 2014 Marc Fournier
*
- * This program is free software; you can redistribute it and/or modify it
- * under the terms of the GNU General Public License as published by the
- * Free Software Foundation; only version 2 of the License is applicable.
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
*
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * General Public License for more details.
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
*
- * You should have received a copy of the GNU General Public License along
- * with this program; if not, write to the Free Software Foundation, Inc.,
- * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
*
* Authors:
* Kimo Rosenbaum <kimor79 at yahoo.com>
+ * Marc Fournier <marc.fournier at camptocamp.com>
**/
#include "collectd.h"
#include <lber.h>
#include <ldap.h>
-struct ldap_s /* {{{ */
+struct cldap_s /* {{{ */
{
char *name;
char *cacert;
char *host;
int state;
- int starttls;
+ _Bool starttls;
int timeout;
char *url;
- int verifyhost;
+ _Bool verifyhost;
int version;
LDAP *ld;
- char *dn;
};
-typedef struct ldap_s ldap_t; /* }}} */
+typedef struct cldap_s cldap_t; /* }}} */
-static void ldap_free (ldap_t *st) /* {{{ */
+static void cldap_free (cldap_t *st) /* {{{ */
{
- if(st == NULL)
+ if (st == NULL)
return;
sfree (st->cacert);
sfree (st->host);
sfree (st->name);
sfree (st->url);
- if(st->ld)
- ldap_memfree(st->ld);
+ if (st->ld)
+ ldap_memfree (st->ld);
sfree (st);
-} /* }}} void ldap_free */
+} /* }}} void cldap_free */
+
/* initialize ldap for each host */
-static int ldap_init_host (ldap_t *st) /* {{{ */
+static int cldap_init_host (cldap_t *st) /* {{{ */
{
LDAP *ld;
int rc;
rc = ldap_initialize (&ld, st->url);
if (rc != LDAP_SUCCESS)
{
- char errbuf[1024];
- sstrerror (errno, errbuf, sizeof (errbuf));
- ERROR ("ldap_initialize failed: %s", errbuf);
+ ERROR ("openldap plugin: ldap_initialize failed: %s",
+ ldap_err2string (rc));
st->state = 0;
+ ldap_unbind_ext_s (ld, NULL, NULL);
return (-1);
}
ldap_set_option (st->ld, LDAP_OPT_PROTOCOL_VERSION, &st->version);
- if(st->cacert != NULL)
+ ldap_set_option (st->ld, LDAP_OPT_TIMEOUT,
+ &(const struct timeval){st->timeout, 0});
+
+ if (st->cacert != NULL)
ldap_set_option (st->ld, LDAP_OPT_X_TLS_CACERTFILE, st->cacert);
- if(st->verifyhost == 0)
+ if (st->verifyhost == 0)
{
int never = LDAP_OPT_X_TLS_NEVER;
ldap_set_option (st->ld, LDAP_OPT_X_TLS_REQUIRE_CERT, &never);
}
- if(st->starttls != 0)
+ if (st->starttls != 0)
{
- rc = ldap_start_tls_s(ld, NULL, NULL);
+ rc = ldap_start_tls_s (ld, NULL, NULL);
if (rc != LDAP_SUCCESS)
{
ERROR ("openldap plugin: Failed to start tls on %s: %s",
st->url, ldap_err2string (rc));
st->state = 0;
- ldap_unbind_ext_s(st->ld, NULL, NULL);
+ ldap_unbind_ext_s (st->ld, NULL, NULL);
return (-1);
}
}
cred.bv_val = "";
cred.bv_len = 0;
- rc = ldap_sasl_bind_s(st->ld, NULL, NULL, &cred, NULL, NULL, NULL);
+ rc = ldap_sasl_bind_s (st->ld, NULL, NULL, &cred, NULL, NULL, NULL);
if (rc != LDAP_SUCCESS)
{
ERROR ("openldap plugin: Failed to bind to %s: %s",
st->url, ldap_err2string (rc));
st->state = 0;
- ldap_unbind_ext_s(st->ld, NULL, NULL);
+ ldap_unbind_ext_s (st->ld, NULL, NULL);
return (-1);
}
else
st->state = 1;
return (0);
}
-} /* }}} static ldap_init_host */
+} /* }}} static cldap_init_host */
-static void ldap_submit_value (const char *type, const char *type_instance, /* {{{ */
- value_t value, ldap_t *st)
+static void cldap_submit_value (const char *type, const char *type_instance, /* {{{ */
+ value_t value, cldap_t *st)
{
value_list_t vl = VALUE_LIST_INIT;
sizeof (vl.type_instance));
plugin_dispatch_values (&vl);
-} /* }}} void ldap_submit_value */
+} /* }}} void cldap_submit_value */
-static void ldap_submit_derive (const char *type, const char *type_instance, /* {{{ */
- derive_t d, ldap_t *st)
+static void cldap_submit_derive (const char *type, const char *type_instance, /* {{{ */
+ derive_t d, cldap_t *st)
{
value_t v;
v.derive = d;
- ldap_submit_value (type, type_instance, v, st);
-} /* }}} void ldap_submit_derive */
+ cldap_submit_value (type, type_instance, v, st);
+} /* }}} void cldap_submit_derive */
-static void ldap_submit_gauge (const char *type, const char *type_instance, /* {{{ */
- gauge_t g, ldap_t *st)
+static void cldap_submit_gauge (const char *type, const char *type_instance, /* {{{ */
+ gauge_t g, cldap_t *st)
{
value_t v;
v.gauge = g;
- ldap_submit_value (type, type_instance, v, st);
-} /* }}} void ldap_submit_gauge */
+ cldap_submit_value (type, type_instance, v, st);
+} /* }}} void cldap_submit_gauge */
-static int ldap_read_host (user_data_t *ud) /* {{{ */
+static int cldap_read_host (user_data_t *ud) /* {{{ */
{
- ldap_t *st;
+ cldap_t *st;
LDAPMessage *e, *result;
char *dn;
int rc;
if ((ud == NULL) || (ud->data == NULL))
{
- ERROR ("openldap plugin: ldap_read_host: Invalid user data.");
+ ERROR ("openldap plugin: cldap_read_host: Invalid user data.");
return (-1);
}
- st = (ldap_t *) ud->data;
+ st = (cldap_t *) ud->data;
- status = ldap_init_host (st);
+ status = cldap_init_host (st);
if (status != 0)
return (-1);
ERROR ("openldap plugin: Failed to execute search: %s",
ldap_err2string (rc));
ldap_msgfree (result);
+ ldap_unbind_ext_s (st->ld, NULL, NULL);
return (-1);
}
if (strcmp (dn, "cn=Total,cn=Connections,cn=Monitor")
== 0)
{
- ldap_submit_derive ("total_connections", NULL,
+ cldap_submit_derive ("total_connections", NULL,
counter, st);
}
else if (strcmp (dn,
"cn=Current,cn=Connections,cn=Monitor")
== 0)
{
- ldap_submit_gauge ("current_connections", NULL,
+ cldap_submit_gauge ("current_connections", NULL,
counter, st);
}
else if (strcmp (dn,
"cn=Operations,cn=Monitor") == 0)
{
- ldap_submit_derive ("operations",
+ cldap_submit_derive ("operations",
"completed", opc, st);
- ldap_submit_derive ("operations",
+ cldap_submit_derive ("operations",
"initiated", opi, st);
}
else if (strcmp (dn,
"cn=Bind,cn=Operations,cn=Monitor")
== 0)
{
- ldap_submit_derive ("operations",
+ cldap_submit_derive ("operations",
"bind-completed", opc, st);
- ldap_submit_derive ("operations",
+ cldap_submit_derive ("operations",
"bind-initiated", opi, st);
}
else if (strcmp (dn,
"cn=UnBind,cn=Operations,cn=Monitor")
== 0)
{
- ldap_submit_derive ("operations",
+ cldap_submit_derive ("operations",
"unbind-completed", opc, st);
- ldap_submit_derive ("operations",
+ cldap_submit_derive ("operations",
"unbind-initiated", opi, st);
}
else if (strcmp (dn,
"cn=Search,cn=Operations,cn=Monitor")
== 0)
{
- ldap_submit_derive ("operations",
+ cldap_submit_derive ("operations",
"search-completed", opc, st);
- ldap_submit_derive ("operations",
+ cldap_submit_derive ("operations",
"search-initiated", opi, st);
}
else if (strcmp (dn,
"cn=Compare,cn=Operations,cn=Monitor")
== 0)
{
- ldap_submit_derive ("operations",
+ cldap_submit_derive ("operations",
"compare-completed", opc, st);
- ldap_submit_derive ("operations",
+ cldap_submit_derive ("operations",
"compare-initiated", opi, st);
}
else if (strcmp (dn,
"cn=Modify,cn=Operations,cn=Monitor")
== 0)
{
- ldap_submit_derive ("operations",
+ cldap_submit_derive ("operations",
"modify-completed", opc, st);
- ldap_submit_derive ("operations",
+ cldap_submit_derive ("operations",
"modify-initiated", opi, st);
}
else if (strcmp (dn,
"cn=Modrdn,cn=Operations,cn=Monitor")
== 0)
{
- ldap_submit_derive ("operations",
+ cldap_submit_derive ("operations",
"modrdn-completed", opc, st);
- ldap_submit_derive ("operations",
+ cldap_submit_derive ("operations",
"modrdn-initiated", opi, st);
}
else if (strcmp (dn,
"cn=Add,cn=Operations,cn=Monitor")
== 0)
{
- ldap_submit_derive ("operations",
+ cldap_submit_derive ("operations",
"add-completed", opc, st);
- ldap_submit_derive ("operations",
+ cldap_submit_derive ("operations",
"add-initiated", opi, st);
}
else if (strcmp (dn,
"cn=Delete,cn=Operations,cn=Monitor")
== 0)
{
- ldap_submit_derive ("operations",
+ cldap_submit_derive ("operations",
"delete-completed", opc, st);
- ldap_submit_derive ("operations",
+ cldap_submit_derive ("operations",
"delete-initiated", opi, st);
}
else if (strcmp (dn,
"cn=Abandon,cn=Operations,cn=Monitor")
== 0)
{
- ldap_submit_derive ("operations",
+ cldap_submit_derive ("operations",
"abandon-completed", opc, st);
- ldap_submit_derive ("operations",
+ cldap_submit_derive ("operations",
"abandon-initiated", opi, st);
}
else if (strcmp (dn,
"cn=Extended,cn=Operations,cn=Monitor")
== 0)
{
- ldap_submit_derive ("operations",
+ cldap_submit_derive ("operations",
"extended-completed", opc, st);
- ldap_submit_derive ("operations",
+ cldap_submit_derive ("operations",
"extended-initiated", opi, st);
}
else if ((strncmp (dn, "cn=Database", 11) == 0)
olmbdb_data = *olmbdb_list[0];
ssnprintf (typeinst, sizeof (typeinst),
"bdbentrycache-%s", nc_data.bv_val);
- ldap_submit_gauge ("cache_size", typeinst,
+ cldap_submit_gauge ("cache_size", typeinst,
atoll (olmbdb_data.bv_val), st);
ldap_value_free_len (olmbdb_list);
}
olmbdb_data = *olmbdb_list[0];
ssnprintf (typeinst, sizeof (typeinst),
"bdbdncache-%s", nc_data.bv_val);
- ldap_submit_gauge ("cache_size", typeinst,
+ cldap_submit_gauge ("cache_size", typeinst,
atoll (olmbdb_data.bv_val), st);
ldap_value_free_len (olmbdb_list);
}
olmbdb_data = *olmbdb_list[0];
ssnprintf (typeinst, sizeof (typeinst),
"bdbidlcache-%s", nc_data.bv_val);
- ldap_submit_gauge ("cache_size", typeinst,
+ cldap_submit_gauge ("cache_size", typeinst,
atoll (olmbdb_data.bv_val), st);
ldap_value_free_len (olmbdb_list);
}
"cn=Bytes,cn=Statistics,cn=Monitor")
== 0)
{
- ldap_submit_derive ("derive", "statistics-bytes",
+ cldap_submit_derive ("derive", "statistics-bytes",
counter, st);
}
else if (strcmp (dn,
"cn=PDU,cn=Statistics,cn=Monitor")
== 0)
{
- ldap_submit_derive ("derive", "statistics-pdu",
+ cldap_submit_derive ("derive", "statistics-pdu",
counter, st);
}
else if (strcmp (dn,
"cn=Entries,cn=Statistics,cn=Monitor")
== 0)
{
- ldap_submit_derive ("derive", "statistics-entries",
+ cldap_submit_derive ("derive", "statistics-entries",
counter, st);
}
else if (strcmp (dn,
"cn=Referrals,cn=Statistics,cn=Monitor")
== 0)
{
- ldap_submit_derive ("derive", "statistics-referrals",
+ cldap_submit_derive ("derive", "statistics-referrals",
counter, st);
}
else if (strcmp (dn,
"cn=Open,cn=Threads,cn=Monitor")
== 0)
{
- ldap_submit_gauge ("threads", "threads-open",
+ cldap_submit_gauge ("threads", "threads-open",
info, st);
}
else if (strcmp (dn,
"cn=Starting,cn=Threads,cn=Monitor")
== 0)
{
- ldap_submit_gauge ("threads", "threads-starting",
+ cldap_submit_gauge ("threads", "threads-starting",
info, st);
}
else if (strcmp (dn,
"cn=Active,cn=Threads,cn=Monitor")
== 0)
{
- ldap_submit_gauge ("threads", "threads-active",
+ cldap_submit_gauge ("threads", "threads-active",
info, st);
}
else if (strcmp (dn,
"cn=Pending,cn=Threads,cn=Monitor")
== 0)
{
- ldap_submit_gauge ("threads", "threads-pending",
+ cldap_submit_gauge ("threads", "threads-pending",
info, st);
}
else if (strcmp (dn,
"cn=Backload,cn=Threads,cn=Monitor")
== 0)
{
- ldap_submit_gauge ("threads", "threads-backload",
+ cldap_submit_gauge ("threads", "threads-backload",
info, st);
}
else if (strcmp (dn,
"cn=Read,cn=Waiters,cn=Monitor")
== 0)
{
- ldap_submit_derive ("derive", "waiters-read",
+ cldap_submit_derive ("derive", "waiters-read",
counter, st);
}
else if (strcmp (dn,
"cn=Write,cn=Waiters,cn=Monitor")
== 0)
{
- ldap_submit_derive ("derive", "waiters-write",
+ cldap_submit_derive ("derive", "waiters-write",
counter, st);
}
ldap_msgfree (result);
ldap_unbind_ext_s (st->ld, NULL, NULL);
return (0);
-} /* }}} int ldap_read_host */
+} /* }}} int cldap_read_host */
/* Configuration handling functions {{{
*
* </Plugin>
*/
-static int ldap_config_set_string (char **ret_string, /* {{{ */
- oconfig_item_t *ci)
+static int cldap_config_add (oconfig_item_t *ci) /* {{{ */
{
- char *string;
-
- if ((ci->values_num != 1)
- || (ci->values[0].type != OCONFIG_TYPE_STRING))
- {
- WARNING ("openldap plugin: The `%s' config option "
- "needs exactly one string argument.", ci->key);
- return (-1);
- }
-
- string = strdup (ci->values[0].value.string);
- if (string == NULL)
- {
- ERROR ("openldap plugin: strdup failed.");
- return (-1);
- }
-
- if (*ret_string != NULL)
- free (*ret_string);
- *ret_string = string;
-
- return (0);
-} /* }}} int ldap_config_set_string */
-
-static int ldap_config_set_int (int *ret_int, /* {{{ */
- oconfig_item_t *ci)
-{
- if ((ci->values_num != 1)
- || (ci->values[0].type != OCONFIG_TYPE_NUMBER))
- {
- WARNING ("openldap plugin: The `%s' config option "
- "needs exactly one string argument.", ci->key);
- return (-1);
- }
-
- *ret_int = ci->values[0].value.number;
-
- return (0);
-} /* }}} int ldap_config_set_int */
-
-static int ldap_config_set_bool (int *ret_boolean, /* {{{ */
- oconfig_item_t *ci)
-{
- int status = 0;
-
- if (ci->values_num != 1)
- status = -1;
-
- if (status == 0)
- {
- if (ci->values[0].type == OCONFIG_TYPE_BOOLEAN)
- *ret_boolean = ci->values[0].value.boolean;
- else if (ci->values[0].type == OCONFIG_TYPE_STRING)
- {
- if (IS_TRUE (ci->values[0].value.string))
- *ret_boolean = 1;
- else if (IS_FALSE (ci->values[0].value.string))
- *ret_boolean = 0;
- else
- status = -1;
- }
- else
- status = -1;
- }
-
- if (status != 0)
- {
- WARNING ("openldap plugin: The `%s' config option "
- "needs exactly one boolean argument.", ci->key);
- return (-1);
- }
- return (0);
-} /* }}} int ldap_config_set_bool */
-
-static int ldap_config_add (oconfig_item_t *ci) /* {{{ */
-{
- ldap_t *st;
+ cldap_t *st;
int i;
int status;
- if ((ci->values_num != 1)
- || (ci->values[0].type != OCONFIG_TYPE_STRING))
- {
- WARNING ("openldap plugin: The `%s' config option "
- "needs exactly one string argument.", ci->key);
- return (-1);
- }
-
- st = (ldap_t *) malloc (sizeof (*st));
+ st = malloc (sizeof (*st));
if (st == NULL)
{
ERROR ("openldap plugin: malloc failed.");
}
memset (st, 0, sizeof (*st));
- status = ldap_config_set_string (&st->name, ci);
+ status = cf_util_get_string (ci, &st->name);
if (status != 0)
{
sfree (st);
return (status);
}
+ st->starttls = 0;
+ st->timeout = -1;
st->verifyhost = 1;
st->version = LDAP_VERSION3;
oconfig_item_t *child = ci->children + i;
if (strcasecmp ("CACert", child->key) == 0)
- status = ldap_config_set_string (&st->cacert, child);
+ status = cf_util_get_string (child, &st->cacert);
else if (strcasecmp ("StartTLS", child->key) == 0)
- status = ldap_config_set_bool (&st->starttls, child);
+ status = cf_util_get_boolean (child, &st->starttls);
else if (strcasecmp ("Timeout", child->key) == 0)
- status = ldap_config_set_int (&st->timeout, child);
+ status = cf_util_get_int (child, &st->timeout);
else if (strcasecmp ("URL", child->key) == 0)
- status = ldap_config_set_string (&st->url, child);
+ status = cf_util_get_string (child, &st->url);
else if (strcasecmp ("VerifyHost", child->key) == 0)
- status = ldap_config_set_bool (&st->verifyhost, child);
+ status = cf_util_get_boolean (child, &st->verifyhost);
else if (strcasecmp ("Version", child->key) == 0)
- status = ldap_config_set_int (&st->version, child);
+ status = cf_util_get_int (child, &st->version);
else
{
WARNING ("openldap plugin: Option `%s' not allowed here.",
LDAPURLDesc *ludpp;
int rc;
- if ((rc = ldap_url_parse( st->url, &ludpp)) != 0)
+ if ((rc = ldap_url_parse (st->url, &ludpp)) != 0)
{
ERROR ("openldap plugin: Instance `%s': "
"Invalid URL: `%s'",
st->name, st->url);
status = -1;
}
- else
+
+ if ((status == 0) && (ludpp->lud_host != NULL))
{
st->host = strdup (ludpp->lud_host);
}
- ldap_free_urldesc(ludpp);
+ ldap_free_urldesc (ludpp);
}
if (status == 0)
status = plugin_register_complex_read (/* group = */ NULL,
/* name = */ callback_name,
- /* callback = */ ldap_read_host,
+ /* callback = */ cldap_read_host,
/* interval = */ NULL,
/* user_data = */ &ud);
}
if (status != 0)
{
- ldap_free (st);
+ cldap_free (st);
return (-1);
}
return (0);
-} /* }}} int ldap_config_add */
+} /* }}} int cldap_config_add */
-static int ldap_config (oconfig_item_t *ci) /* {{{ */
+static int cldap_config (oconfig_item_t *ci) /* {{{ */
{
int i;
int status = 0;
oconfig_item_t *child = ci->children + i;
if (strcasecmp ("Instance", child->key) == 0)
- ldap_config_add (child);
+ cldap_config_add (child);
else
WARNING ("openldap plugin: The configuration option "
"\"%s\" is not allowed here. Did you "
} /* for (ci->children) */
return (status);
-} /* }}} int ldap_config */
+} /* }}} int cldap_config */
/* }}} End of configuration handling functions */
+static int cldap_init (void) /* {{{ */
+{
+ /* Initialize LDAP library while still single-threaded as recommended in
+ * ldap_initialize(3) */
+ int debug_level;
+ ldap_get_option (NULL, LDAP_OPT_DEBUG_LEVEL, &debug_level);
+ return (0);
+} /* }}} int cldap_init */
+
void module_register (void) /* {{{ */
{
- plugin_register_complex_config ("openldap", ldap_config);
+ plugin_register_complex_config ("openldap", cldap_config);
+ plugin_register_init ("openldap", cldap_init);
} /* }}} void module_register */