src/snmp.c

   1 /**
   2  * collectd - src/snmp.c
   3  * Copyright (C) 2007-2012  Florian octo Forster
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the "Software"),
   7  * to deal in the Software without restriction, including without limitation
   8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9  * and/or sell copies of the Software, and to permit persons to whom the
  10  * Software is furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included in
  13  * all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21  * DEALINGS IN THE SOFTWARE.
  22  *
  23  * Authors:
  24  *   Florian octo Forster <octo at collectd.org>
  25  **/
  26
  27 #include "collectd.h"
  28
  29 #include "common.h"
  30 #include "plugin.h"
  31 #include "utils_complain.h"
  32
  33 #include <net-snmp/net-snmp-config.h>
  34 #include <net-snmp/net-snmp-includes.h>
  35
  36 #include <fnmatch.h>
  37
  38 /*
  39  * Private data structes
  40  */
  41 struct oid_s {
  42   oid oid[MAX_OID_LEN];
  43   size_t oid_len;
  44 };
  45 typedef struct oid_s oid_t;
  46
  47 union instance_u {
  48   char string[DATA_MAX_NAME_LEN];
  49   oid_t oid;
  50 };
  51 typedef union instance_u instance_t;
  52
  53 struct data_definition_s {
  54   char *name; /* used to reference this from the `Collect' option */
  55   char *type; /* used to find the data_set */
  56   _Bool is_table;
  57   instance_t instance;
  58   char *instance_prefix;
  59   oid_t *values;
  60   size_t values_len;
  61   double scale;
  62   double shift;
  63   struct data_definition_s *next;
  64   char **ignores;
  65   size_t ignores_len;
  66   _Bool invert_match;
  67 };
  68 typedef struct data_definition_s data_definition_t;
  69
  70 struct host_definition_s {
  71   char *name;
  72   char *address;
  73   int version;
  74   cdtime_t timeout;
  75   int retries;
  76
  77   /* snmpv1/2 options */
  78   char *community;
  79
  80   /* snmpv3 security options */
  81   char *username;
  82   oid *auth_protocol;
  83   size_t auth_protocol_len;
  84   char *auth_passphrase;
  85   oid *priv_protocol;
  86   size_t priv_protocol_len;
  87   char *priv_passphrase;
  88   int security_level;
  89   char *context;
  90
  91   void *sess_handle;
  92   c_complain_t complaint;
  93   cdtime_t interval;
  94   data_definition_t **data_list;
  95   int data_list_len;
  96 };
  97 typedef struct host_definition_s host_definition_t;
  98
  99 /* These two types are used to cache values in `csnmp_read_table' to handle
 100  * gaps in tables. */
 101 struct csnmp_list_instances_s {
 102   oid_t suffix;
 103   char instance[DATA_MAX_NAME_LEN];
 104   struct csnmp_list_instances_s *next;
 105 };
 106 typedef struct csnmp_list_instances_s csnmp_list_instances_t;
 107
 108 struct csnmp_table_values_s {
 109   oid_t suffix;
 110   value_t value;
 111   struct csnmp_table_values_s *next;
 112 };
 113 typedef struct csnmp_table_values_s csnmp_table_values_t;
 114
 115 /*
 116  * Private variables
 117  */
 118 static data_definition_t *data_head = NULL;
 119
 120 /*
 121  * Prototypes
 122  */
 123 static int csnmp_read_host(user_data_t *ud);
 124
 125 /*
 126  * Private functions
 127  */
 128 static void csnmp_oid_init(oid_t *dst, oid const *src, size_t n) {
 129   assert(n <= STATIC_ARRAY_SIZE(dst->oid));
 130   memcpy(dst->oid, src, sizeof(*src) * n);
 131   dst->oid_len = n;
 132 }
 133
 134 static int csnmp_oid_compare(oid_t const *left, oid_t const *right) {
 135   return snmp_oid_compare(left->oid, left->oid_len, right->oid, right->oid_len);
 136 }
 137
 138 static int csnmp_oid_suffix(oid_t *dst, oid_t const *src, oid_t const *root) {
 139   /* Make sure "src" is in "root"s subtree. */
 140   if (src->oid_len <= root->oid_len)
 141     return EINVAL;
 142   if (snmp_oid_ncompare(root->oid, root->oid_len, src->oid, src->oid_len,
 143                         /* n = */ root->oid_len) != 0)
 144     return EINVAL;
 145
 146   memset(dst, 0, sizeof(*dst));
 147   dst->oid_len = src->oid_len - root->oid_len;
 148   memcpy(dst->oid, &src->oid[root->oid_len],
 149          dst->oid_len * sizeof(dst->oid[0]));
 150   return 0;
 151 }
 152
 153 static int csnmp_oid_to_string(char *buffer, size_t buffer_size,
 154                                oid_t const *o) {
 155   char oid_str[MAX_OID_LEN][16];
 156   char *oid_str_ptr[MAX_OID_LEN];
 157
 158   for (size_t i = 0; i < o->oid_len; i++) {
 159     snprintf(oid_str[i], sizeof(oid_str[i]), "%lu", (unsigned long)o->oid[i]);
 160     oid_str_ptr[i] = oid_str[i];
 161   }
 162
 163   return strjoin(buffer, buffer_size, oid_str_ptr, o->oid_len, ".");
 164 }
 165
 166 static void csnmp_host_close_session(host_definition_t *host) /* {{{ */
 167 {
 168   if (host->sess_handle == NULL)
 169     return;
 170
 171   snmp_sess_close(host->sess_handle);
 172   host->sess_handle = NULL;
 173 } /* }}} void csnmp_host_close_session */
 174
 175 static void csnmp_host_definition_destroy(void *arg) /* {{{ */
 176 {
 177   host_definition_t *hd;
 178
 179   hd = arg;
 180
 181   if (hd == NULL)
 182     return;
 183
 184   if (hd->name != NULL) {
 185     DEBUG("snmp plugin: Destroying host definition for host `%s'.", hd->name);
 186   }
 187
 188   csnmp_host_close_session(hd);
 189
 190   sfree(hd->name);
 191   sfree(hd->address);
 192   sfree(hd->community);
 193   sfree(hd->username);
 194   sfree(hd->auth_passphrase);
 195   sfree(hd->priv_passphrase);
 196   sfree(hd->context);
 197   sfree(hd->data_list);
 198
 199   sfree(hd);
 200 } /* }}} void csnmp_host_definition_destroy */
 201
 202 /* Many functions to handle the configuration. {{{ */
 203 /* First there are many functions which do configuration stuff. It's a big
 204  * bloated and messy, I'm afraid. */
 205
 206 /*
 207  * Callgraph for the config stuff:
 208  *  csnmp_config
 209  *  +-> call_snmp_init_once
 210  *  +-> csnmp_config_add_data
 211  *  !   +-> csnmp_config_add_data_instance
 212  *  !   +-> csnmp_config_add_data_instance_prefix
 213  *  !   +-> csnmp_config_add_data_values
 214  *  +-> csnmp_config_add_host
 215  *      +-> csnmp_config_add_host_version
 216  *      +-> csnmp_config_add_host_collect
 217  *      +-> csnmp_config_add_host_auth_protocol
 218  *      +-> csnmp_config_add_host_priv_protocol
 219  *      +-> csnmp_config_add_host_security_level
 220  */
 221 static void call_snmp_init_once(void) {
 222   static int have_init = 0;
 223
 224   if (have_init == 0)
 225     init_snmp(PACKAGE_NAME);
 226   have_init = 1;
 227 } /* void call_snmp_init_once */
 228
 229 static int csnmp_config_add_data_instance(data_definition_t *dd,
 230                                           oconfig_item_t *ci) {
 231   char buffer[DATA_MAX_NAME_LEN];
 232   int status;
 233
 234   status = cf_util_get_string_buffer(ci, buffer, sizeof(buffer));
 235   if (status != 0)
 236     return status;
 237
 238   if (dd->is_table) {
 239     /* Instance is an OID */
 240     dd->instance.oid.oid_len = MAX_OID_LEN;
 241
 242     if (!read_objid(buffer, dd->instance.oid.oid, &dd->instance.oid.oid_len)) {
 243       ERROR("snmp plugin: read_objid (%s) failed.", buffer);
 244       return -1;
 245     }
 246   } else {
 247     /* Instance is a simple string */
 248     sstrncpy(dd->instance.string, buffer, sizeof(dd->instance.string));
 249   }
 250
 251   return 0;
 252 } /* int csnmp_config_add_data_instance */
 253
 254 static int csnmp_config_add_data_instance_prefix(data_definition_t *dd,
 255                                                  oconfig_item_t *ci) {
 256   int status;
 257
 258   if (!dd->is_table) {
 259     WARNING("snmp plugin: data %s: InstancePrefix is ignored when `Table' "
 260             "is set to `false'.",
 261             dd->name);
 262     return -1;
 263   }
 264
 265   status = cf_util_get_string(ci, &dd->instance_prefix);
 266   return status;
 267 } /* int csnmp_config_add_data_instance_prefix */
 268
 269 static int csnmp_config_add_data_values(data_definition_t *dd,
 270                                         oconfig_item_t *ci) {
 271   if (ci->values_num < 1) {
 272     WARNING("snmp plugin: `Values' needs at least one argument.");
 273     return -1;
 274   }
 275
 276   for (int i = 0; i < ci->values_num; i++)
 277     if (ci->values[i].type != OCONFIG_TYPE_STRING) {
 278       WARNING("snmp plugin: `Values' needs only string argument.");
 279       return -1;
 280     }
 281
 282   sfree(dd->values);
 283   dd->values_len = 0;
 284   dd->values = malloc(sizeof(*dd->values) * ci->values_num);
 285   if (dd->values == NULL)
 286     return -1;
 287   dd->values_len = (size_t)ci->values_num;
 288
 289   for (int i = 0; i < ci->values_num; i++) {
 290     dd->values[i].oid_len = MAX_OID_LEN;
 291
 292     if (NULL == snmp_parse_oid(ci->values[i].value.string, dd->values[i].oid,
 293                                &dd->values[i].oid_len)) {
 294       ERROR("snmp plugin: snmp_parse_oid (%s) failed.",
 295             ci->values[i].value.string);
 296       free(dd->values);
 297       dd->values = NULL;
 298       dd->values_len = 0;
 299       return -1;
 300     }
 301   }
 302
 303   return 0;
 304 } /* int csnmp_config_add_data_instance */
 305
 306 static int csnmp_config_add_data_blacklist(data_definition_t *dd,
 307                                            oconfig_item_t *ci) {
 308   if (ci->values_num < 1)
 309     return 0;
 310
 311   for (int i = 0; i < ci->values_num; i++) {
 312     if (ci->values[i].type != OCONFIG_TYPE_STRING) {
 313       WARNING("snmp plugin: `Ignore' needs only string argument.");
 314       return -1;
 315     }
 316   }
 317
 318   dd->ignores_len = 0;
 319   dd->ignores = NULL;
 320
 321   for (int i = 0; i < ci->values_num; ++i) {
 322     if (strarray_add(&(dd->ignores), &(dd->ignores_len),
 323                      ci->values[i].value.string) != 0) {
 324       ERROR("snmp plugin: Can't allocate memory");
 325       strarray_free(dd->ignores, dd->ignores_len);
 326       return ENOMEM;
 327     }
 328   }
 329   return 0;
 330 } /* int csnmp_config_add_data_blacklist */
 331
 332 static int csnmp_config_add_data(oconfig_item_t *ci) {
 333   data_definition_t *dd = calloc(1, sizeof(*dd));
 334   if (dd == NULL)
 335     return -1;
 336
 337   int status = cf_util_get_string(ci, &dd->name);
 338   if (status != 0) {
 339     sfree(dd);
 340     return -1;
 341   }
 342
 343   dd->scale = 1.0;
 344   dd->shift = 0.0;
 345
 346   for (int i = 0; i < ci->children_num; i++) {
 347     oconfig_item_t *option = ci->children + i;
 348
 349     if (strcasecmp("Type", option->key) == 0)
 350       status = cf_util_get_string(option, &dd->type);
 351     else if (strcasecmp("Table", option->key) == 0)
 352       status = cf_util_get_boolean(option, &dd->is_table);
 353     else if (strcasecmp("Instance", option->key) == 0)
 354       status = csnmp_config_add_data_instance(dd, option);
 355     else if (strcasecmp("InstancePrefix", option->key) == 0)
 356       status = csnmp_config_add_data_instance_prefix(dd, option);
 357     else if (strcasecmp("Values", option->key) == 0)
 358       status = csnmp_config_add_data_values(dd, option);
 359     else if (strcasecmp("Shift", option->key) == 0)
 360       status = cf_util_get_double(option, &dd->shift);
 361     else if (strcasecmp("Scale", option->key) == 0)
 362       status = cf_util_get_double(option, &dd->scale);
 363     else if (strcasecmp("Ignore", option->key) == 0)
 364       status = csnmp_config_add_data_blacklist(dd, option);
 365     else if (strcasecmp("InvertMatch", option->key) == 0)
 366       status = cf_util_get_boolean(option, &dd->invert_match);
 367     else {
 368       WARNING("snmp plugin: Option `%s' not allowed here.", option->key);
 369       status = -1;
 370     }
 371
 372     if (status != 0)
 373       break;
 374   } /* for (ci->children) */
 375
 376   while (status == 0) {
 377     if (dd->type == NULL) {
 378       WARNING("snmp plugin: `Type' not given for data `%s'", dd->name);
 379       status = -1;
 380       break;
 381     }
 382     if (dd->values == NULL) {
 383       WARNING("snmp plugin: No `Value' given for data `%s'", dd->name);
 384       status = -1;
 385       break;
 386     }
 387
 388     break;
 389   } /* while (status == 0) */
 390
 391   if (status != 0) {
 392     sfree(dd->name);
 393     sfree(dd->instance_prefix);
 394     sfree(dd->values);
 395     sfree(dd->ignores);
 396     sfree(dd);
 397     return -1;
 398   }
 399
 400   DEBUG("snmp plugin: dd = { name = %s, type = %s, is_table = %s, values_len = "
 401         "%zu }",
 402         dd->name, dd->type, (dd->is_table != 0) ? "true" : "false",
 403         dd->values_len);
 404
 405   if (data_head == NULL)
 406     data_head = dd;
 407   else {
 408     data_definition_t *last;
 409     last = data_head;
 410     while (last->next != NULL)
 411       last = last->next;
 412     last->next = dd;
 413   }
 414
 415   return 0;
 416 } /* int csnmp_config_add_data */
 417
 418 static int csnmp_config_add_host_version(host_definition_t *hd,
 419                                          oconfig_item_t *ci) {
 420   int version;
 421
 422   if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER)) {
 423     WARNING("snmp plugin: The `Version' config option needs exactly one number "
 424             "argument.");
 425     return -1;
 426   }
 427
 428   version = (int)ci->values[0].value.number;
 429   if ((version < 1) || (version > 3)) {
 430     WARNING("snmp plugin: `Version' must either be `1', `2', or `3'.");
 431     return -1;
 432   }
 433
 434   hd->version = version;
 435
 436   return 0;
 437 } /* int csnmp_config_add_host_address */
 438
 439 static int csnmp_config_add_host_collect(host_definition_t *host,
 440                                          oconfig_item_t *ci) {
 441   data_definition_t *data;
 442   data_definition_t **data_list;
 443   int data_list_len;
 444
 445   if (ci->values_num < 1) {
 446     WARNING("snmp plugin: `Collect' needs at least one argument.");
 447     return -1;
 448   }
 449
 450   for (int i = 0; i < ci->values_num; i++)
 451     if (ci->values[i].type != OCONFIG_TYPE_STRING) {
 452       WARNING("snmp plugin: All arguments to `Collect' must be strings.");
 453       return -1;
 454     }
 455
 456   data_list_len = host->data_list_len + ci->values_num;
 457   data_list =
 458       realloc(host->data_list, sizeof(data_definition_t *) * data_list_len);
 459   if (data_list == NULL)
 460     return -1;
 461   host->data_list = data_list;
 462
 463   for (int i = 0; i < ci->values_num; i++) {
 464     for (data = data_head; data != NULL; data = data->next)
 465       if (strcasecmp(ci->values[i].value.string, data->name) == 0)
 466         break;
 467
 468     if (data == NULL) {
 469       WARNING("snmp plugin: No such data configured: `%s'",
 470               ci->values[i].value.string);
 471       continue;
 472     }
 473
 474     DEBUG("snmp plugin: Collect: host = %s, data[%i] = %s;", host->name,
 475           host->data_list_len, data->name);
 476
 477     host->data_list[host->data_list_len] = data;
 478     host->data_list_len++;
 479   } /* for (values_num) */
 480
 481   return 0;
 482 } /* int csnmp_config_add_host_collect */
 483
 484 static int csnmp_config_add_host_auth_protocol(host_definition_t *hd,
 485                                                oconfig_item_t *ci) {
 486   char buffer[4];
 487   int status;
 488
 489   status = cf_util_get_string_buffer(ci, buffer, sizeof(buffer));
 490   if (status != 0)
 491     return status;
 492
 493   if (strcasecmp("MD5", buffer) == 0) {
 494     hd->auth_protocol = usmHMACMD5AuthProtocol;
 495     hd->auth_protocol_len = sizeof(usmHMACMD5AuthProtocol) / sizeof(oid);
 496   } else if (strcasecmp("SHA", buffer) == 0) {
 497     hd->auth_protocol = usmHMACSHA1AuthProtocol;
 498     hd->auth_protocol_len = sizeof(usmHMACSHA1AuthProtocol) / sizeof(oid);
 499   } else {
 500     WARNING("snmp plugin: The `AuthProtocol' config option must be `MD5' or "
 501             "`SHA'.");
 502     return -1;
 503   }
 504
 505   DEBUG("snmp plugin: host = %s; host->auth_protocol = %s;", hd->name,
 506         hd->auth_protocol == usmHMACMD5AuthProtocol ? "MD5" : "SHA");
 507
 508   return 0;
 509 } /* int csnmp_config_add_host_auth_protocol */
 510
 511 static int csnmp_config_add_host_priv_protocol(host_definition_t *hd,
 512                                                oconfig_item_t *ci) {
 513   char buffer[4];
 514   int status;
 515
 516   status = cf_util_get_string_buffer(ci, buffer, sizeof(buffer));
 517   if (status != 0)
 518     return status;
 519
 520   if (strcasecmp("AES", buffer) == 0) {
 521     hd->priv_protocol = usmAESPrivProtocol;
 522     hd->priv_protocol_len = sizeof(usmAESPrivProtocol) / sizeof(oid);
 523   } else if (strcasecmp("DES", buffer) == 0) {
 524     hd->priv_protocol = usmDESPrivProtocol;
 525     hd->priv_protocol_len = sizeof(usmDESPrivProtocol) / sizeof(oid);
 526   } else {
 527     WARNING("snmp plugin: The `PrivProtocol' config option must be `AES' or "
 528             "`DES'.");
 529     return -1;
 530   }
 531
 532   DEBUG("snmp plugin: host = %s; host->priv_protocol = %s;", hd->name,
 533         hd->priv_protocol == usmAESPrivProtocol ? "AES" : "DES");
 534
 535   return 0;
 536 } /* int csnmp_config_add_host_priv_protocol */
 537
 538 static int csnmp_config_add_host_security_level(host_definition_t *hd,
 539                                                 oconfig_item_t *ci) {
 540   char buffer[16];
 541   int status;
 542
 543   status = cf_util_get_string_buffer(ci, buffer, sizeof(buffer));
 544   if (status != 0)
 545     return status;
 546
 547   if (strcasecmp("noAuthNoPriv", buffer) == 0)
 548     hd->security_level = SNMP_SEC_LEVEL_NOAUTH;
 549   else if (strcasecmp("authNoPriv", buffer) == 0)
 550     hd->security_level = SNMP_SEC_LEVEL_AUTHNOPRIV;
 551   else if (strcasecmp("authPriv", buffer) == 0)
 552     hd->security_level = SNMP_SEC_LEVEL_AUTHPRIV;
 553   else {
 554     WARNING("snmp plugin: The `SecurityLevel' config option must be "
 555             "`noAuthNoPriv', `authNoPriv', or `authPriv'.");
 556     return -1;
 557   }
 558
 559   DEBUG("snmp plugin: host = %s; host->security_level = %d;", hd->name,
 560         hd->security_level);
 561
 562   return 0;
 563 } /* int csnmp_config_add_host_security_level */
 564
 565 static int csnmp_config_add_host(oconfig_item_t *ci) {
 566   host_definition_t *hd;
 567   int status = 0;
 568
 569   /* Registration stuff. */
 570   char cb_name[DATA_MAX_NAME_LEN];
 571
 572   hd = calloc(1, sizeof(*hd));
 573   if (hd == NULL)
 574     return -1;
 575   hd->version = 2;
 576   C_COMPLAIN_INIT(&hd->complaint);
 577
 578   status = cf_util_get_string(ci, &hd->name);
 579   if (status != 0) {
 580     sfree(hd);
 581     return status;
 582   }
 583
 584   hd->sess_handle = NULL;
 585   hd->interval = 0;
 586
 587   /* These mean that we have not set a timeout or retry value */
 588   hd->timeout = 0;
 589   hd->retries = -1;
 590
 591   for (int i = 0; i < ci->children_num; i++) {
 592     oconfig_item_t *option = ci->children + i;
 593     status = 0;
 594
 595     if (strcasecmp("Address", option->key) == 0)
 596       status = cf_util_get_string(option, &hd->address);
 597     else if (strcasecmp("Community", option->key) == 0)
 598       status = cf_util_get_string(option, &hd->community);
 599     else if (strcasecmp("Version", option->key) == 0)
 600       status = csnmp_config_add_host_version(hd, option);
 601     else if (strcasecmp("Timeout", option->key) == 0)
 602       cf_util_get_cdtime(option, &hd->timeout);
 603     else if (strcasecmp("Retries", option->key) == 0)
 604       cf_util_get_int(option, &hd->retries);
 605     else if (strcasecmp("Collect", option->key) == 0)
 606       csnmp_config_add_host_collect(hd, option);
 607     else if (strcasecmp("Interval", option->key) == 0)
 608       cf_util_get_cdtime(option, &hd->interval);
 609     else if (strcasecmp("Username", option->key) == 0)
 610       status = cf_util_get_string(option, &hd->username);
 611     else if (strcasecmp("AuthProtocol", option->key) == 0)
 612       status = csnmp_config_add_host_auth_protocol(hd, option);
 613     else if (strcasecmp("PrivacyProtocol", option->key) == 0)
 614       status = csnmp_config_add_host_priv_protocol(hd, option);
 615     else if (strcasecmp("AuthPassphrase", option->key) == 0)
 616       status = cf_util_get_string(option, &hd->auth_passphrase);
 617     else if (strcasecmp("PrivacyPassphrase", option->key) == 0)
 618       status = cf_util_get_string(option, &hd->priv_passphrase);
 619     else if (strcasecmp("SecurityLevel", option->key) == 0)
 620       status = csnmp_config_add_host_security_level(hd, option);
 621     else if (strcasecmp("Context", option->key) == 0)
 622       status = cf_util_get_string(option, &hd->context);
 623     else {
 624       WARNING(
 625           "snmp plugin: csnmp_config_add_host: Option `%s' not allowed here.",
 626           option->key);
 627       status = -1;
 628     }
 629
 630     if (status != 0)
 631       break;
 632   } /* for (ci->children) */
 633
 634   while (status == 0) {
 635     if (hd->address == NULL) {
 636       WARNING("snmp plugin: `Address' not given for host `%s'", hd->name);
 637       status = -1;
 638       break;
 639     }
 640     if (hd->community == NULL && hd->version < 3) {
 641       WARNING("snmp plugin: `Community' not given for host `%s'", hd->name);
 642       status = -1;
 643       break;
 644     }
 645     if (hd->version == 3) {
 646       if (hd->username == NULL) {
 647         WARNING("snmp plugin: `Username' not given for host `%s'", hd->name);
 648         status = -1;
 649         break;
 650       }
 651       if (hd->security_level == 0) {
 652         WARNING("snmp plugin: `SecurityLevel' not given for host `%s'",
 653                 hd->name);
 654         status = -1;
 655         break;
 656       }
 657       if (hd->security_level == SNMP_SEC_LEVEL_AUTHNOPRIV ||
 658           hd->security_level == SNMP_SEC_LEVEL_AUTHPRIV) {
 659         if (hd->auth_protocol == NULL) {
 660           WARNING("snmp plugin: `AuthProtocol' not given for host `%s'",
 661                   hd->name);
 662           status = -1;
 663           break;
 664         }
 665         if (hd->auth_passphrase == NULL) {
 666           WARNING("snmp plugin: `AuthPassphrase' not given for host `%s'",
 667                   hd->name);
 668           status = -1;
 669           break;
 670         }
 671       }
 672       if (hd->security_level == SNMP_SEC_LEVEL_AUTHPRIV) {
 673         if (hd->priv_protocol == NULL) {
 674           WARNING("snmp plugin: `PrivacyProtocol' not given for host `%s'",
 675                   hd->name);
 676           status = -1;
 677           break;
 678         }
 679         if (hd->priv_passphrase == NULL) {
 680           WARNING("snmp plugin: `PrivacyPassphrase' not given for host `%s'",
 681                   hd->name);
 682           status = -1;
 683           break;
 684         }
 685       }
 686     }
 687
 688     break;
 689   } /* while (status == 0) */
 690
 691   if (status != 0) {
 692     csnmp_host_definition_destroy(hd);
 693     return -1;
 694   }
 695
 696   DEBUG("snmp plugin: hd = { name = %s, address = %s, community = %s, version "
 697         "= %i }",
 698         hd->name, hd->address, hd->community, hd->version);
 699
 700   snprintf(cb_name, sizeof(cb_name), "snmp-%s", hd->name);
 701
 702   status = plugin_register_complex_read(
 703       /* group = */ NULL, cb_name, csnmp_read_host, hd->interval,
 704       &(user_data_t){
 705           .data = hd, .free_func = csnmp_host_definition_destroy,
 706       });
 707   if (status != 0) {
 708     ERROR("snmp plugin: Registering complex read function failed.");
 709     return -1;
 710   }
 711
 712   return 0;
 713 } /* int csnmp_config_add_host */
 714
 715 static int csnmp_config(oconfig_item_t *ci) {
 716   call_snmp_init_once();
 717
 718   for (int i = 0; i < ci->children_num; i++) {
 719     oconfig_item_t *child = ci->children + i;
 720     if (strcasecmp("Data", child->key) == 0)
 721       csnmp_config_add_data(child);
 722     else if (strcasecmp("Host", child->key) == 0)
 723       csnmp_config_add_host(child);
 724     else {
 725       WARNING("snmp plugin: Ignoring unknown config option `%s'.", child->key);
 726     }
 727   } /* for (ci->children) */
 728
 729   return 0;
 730 } /* int csnmp_config */
 731
 732 /* }}} End of the config stuff. Now the interesting part begins */
 733
 734 static void csnmp_host_open_session(host_definition_t *host) {
 735   struct snmp_session sess;
 736   int error;
 737
 738   if (host->sess_handle != NULL)
 739     csnmp_host_close_session(host);
 740
 741   snmp_sess_init(&sess);
 742   sess.peername = host->address;
 743   switch (host->version) {
 744   case 1:
 745     sess.version = SNMP_VERSION_1;
 746     break;
 747   case 3:
 748     sess.version = SNMP_VERSION_3;
 749     break;
 750   default:
 751     sess.version = SNMP_VERSION_2c;
 752     break;
 753   }
 754
 755   if (host->version == 3) {
 756     sess.securityName = host->username;
 757     sess.securityNameLen = strlen(host->username);
 758     sess.securityLevel = host->security_level;
 759
 760     if (sess.securityLevel == SNMP_SEC_LEVEL_AUTHNOPRIV ||
 761         sess.securityLevel == SNMP_SEC_LEVEL_AUTHPRIV) {
 762       sess.securityAuthProto = host->auth_protocol;
 763       sess.securityAuthProtoLen = host->auth_protocol_len;
 764       sess.securityAuthKeyLen = USM_AUTH_KU_LEN;
 765       error = generate_Ku(sess.securityAuthProto, sess.securityAuthProtoLen,
 766                           (u_char *)host->auth_passphrase,
 767                           strlen(host->auth_passphrase), sess.securityAuthKey,
 768                           &sess.securityAuthKeyLen);
 769       if (error != SNMPERR_SUCCESS) {
 770         ERROR("snmp plugin: host %s: Error generating Ku from auth_passphrase. "
 771               "(Error %d)",
 772               host->name, error);
 773       }
 774     }
 775
 776     if (sess.securityLevel == SNMP_SEC_LEVEL_AUTHPRIV) {
 777       sess.securityPrivProto = host->priv_protocol;
 778       sess.securityPrivProtoLen = host->priv_protocol_len;
 779       sess.securityPrivKeyLen = USM_PRIV_KU_LEN;
 780       error = generate_Ku(sess.securityAuthProto, sess.securityAuthProtoLen,
 781                           (u_char *)host->priv_passphrase,
 782                           strlen(host->priv_passphrase), sess.securityPrivKey,
 783                           &sess.securityPrivKeyLen);
 784       if (error != SNMPERR_SUCCESS) {
 785         ERROR("snmp plugin: host %s: Error generating Ku from priv_passphrase. "
 786               "(Error %d)",
 787               host->name, error);
 788       }
 789     }
 790
 791     if (host->context != NULL) {
 792       sess.contextName = host->context;
 793       sess.contextNameLen = strlen(host->context);
 794     }
 795   } else /* SNMPv1/2 "authenticates" with community string */
 796   {
 797     sess.community = (u_char *)host->community;
 798     sess.community_len = strlen(host->community);
 799   }
 800
 801   /* Set timeout & retries, if they have been changed from the default */
 802   if (host->timeout != 0) {
 803     /* net-snmp expects microseconds */
 804     sess.timeout = CDTIME_T_TO_US(host->timeout);
 805   }
 806   if (host->retries >= 0) {
 807     sess.retries = host->retries;
 808   }
 809
 810   /* snmp_sess_open will copy the `struct snmp_session *'. */
 811   host->sess_handle = snmp_sess_open(&sess);
 812
 813   if (host->sess_handle == NULL) {
 814     char *errstr = NULL;
 815
 816     snmp_error(&sess, NULL, NULL, &errstr);
 817
 818     ERROR("snmp plugin: host %s: snmp_sess_open failed: %s", host->name,
 819           (errstr == NULL) ? "Unknown problem" : errstr);
 820     sfree(errstr);
 821   }
 822 } /* void csnmp_host_open_session */
 823
 824 /* TODO: Check if negative values wrap around. Problem: negative temperatures.
 825  */
 826 static value_t csnmp_value_list_to_value(struct variable_list *vl, int type,
 827                                          double scale, double shift,
 828                                          const char *host_name,
 829                                          const char *data_name) {
 830   value_t ret;
 831   uint64_t tmp_unsigned = 0;
 832   int64_t tmp_signed = 0;
 833   _Bool defined = 1;
 834   /* Set to true when the original SNMP type appears to have been signed. */
 835   _Bool prefer_signed = 0;
 836
 837   if ((vl->type == ASN_INTEGER) || (vl->type == ASN_UINTEGER) ||
 838       (vl->type == ASN_COUNTER)
 839 #ifdef ASN_TIMETICKS
 840       || (vl->type == ASN_TIMETICKS)
 841 #endif
 842       || (vl->type == ASN_GAUGE)) {
 843     tmp_unsigned = (uint32_t)*vl->val.integer;
 844     tmp_signed = (int32_t)*vl->val.integer;
 845
 846     if (vl->type == ASN_INTEGER)
 847       prefer_signed = 1;
 848
 849     DEBUG("snmp plugin: Parsed int32 value is %" PRIu64 ".", tmp_unsigned);
 850   } else if (vl->type == ASN_COUNTER64) {
 851     tmp_unsigned = (uint32_t)vl->val.counter64->high;
 852     tmp_unsigned = tmp_unsigned << 32;
 853     tmp_unsigned += (uint32_t)vl->val.counter64->low;
 854     tmp_signed = (int64_t)tmp_unsigned;
 855     DEBUG("snmp plugin: Parsed int64 value is %" PRIu64 ".", tmp_unsigned);
 856   } else if (vl->type == ASN_OCTET_STR) {
 857     /* We'll handle this later.. */
 858   } else {
 859     char oid_buffer[1024] = {0};
 860
 861     snprint_objid(oid_buffer, sizeof(oid_buffer) - 1, vl->name,
 862                   vl->name_length);
 863
 864 #ifdef ASN_NULL
 865     if (vl->type == ASN_NULL)
 866       INFO("snmp plugin: OID \"%s\" is undefined (type ASN_NULL)", oid_buffer);
 867     else
 868 #endif
 869       WARNING("snmp plugin: I don't know the ASN type #%i "
 870               "(OID: \"%s\", data block \"%s\", host block \"%s\")",
 871               (int)vl->type, oid_buffer,
 872               (data_name != NULL) ? data_name : "UNKNOWN",
 873               (host_name != NULL) ? host_name : "UNKNOWN");
 874
 875     defined = 0;
 876   }
 877
 878   if (vl->type == ASN_OCTET_STR) {
 879     int status = -1;
 880
 881     if (vl->val.string != NULL) {
 882       char string[64];
 883       size_t string_length;
 884
 885       string_length = sizeof(string) - 1;
 886       if (vl->val_len < string_length)
 887         string_length = vl->val_len;
 888
 889       /* The strings we get from the Net-SNMP library may not be null
 890        * terminated. That is why we're using `memcpy' here and not `strcpy'.
 891        * `string_length' is set to `vl->val_len' which holds the length of the
 892        * string.  -octo */
 893       memcpy(string, vl->val.string, string_length);
 894       string[string_length] = 0;
 895
 896       status = parse_value(string, &ret, type);
 897       if (status != 0) {
 898         ERROR("snmp plugin: host %s: csnmp_value_list_to_value: Parsing string "
 899               "as %s failed: %s",
 900               (host_name != NULL) ? host_name : "UNKNOWN",
 901               DS_TYPE_TO_STRING(type), string);
 902       }
 903     }
 904
 905     if (status != 0) {
 906       switch (type) {
 907       case DS_TYPE_COUNTER:
 908       case DS_TYPE_DERIVE:
 909       case DS_TYPE_ABSOLUTE:
 910         memset(&ret, 0, sizeof(ret));
 911         break;
 912
 913       case DS_TYPE_GAUGE:
 914         ret.gauge = NAN;
 915         break;
 916
 917       default:
 918         ERROR("snmp plugin: csnmp_value_list_to_value: Unknown "
 919               "data source type: %i.",
 920               type);
 921         ret.gauge = NAN;
 922       }
 923     }
 924   } /* if (vl->type == ASN_OCTET_STR) */
 925   else if (type == DS_TYPE_COUNTER) {
 926     ret.counter = tmp_unsigned;
 927   } else if (type == DS_TYPE_GAUGE) {
 928     if (!defined)
 929       ret.gauge = NAN;
 930     else if (prefer_signed)
 931       ret.gauge = (scale * tmp_signed) + shift;
 932     else
 933       ret.gauge = (scale * tmp_unsigned) + shift;
 934   } else if (type == DS_TYPE_DERIVE) {
 935     if (prefer_signed)
 936       ret.derive = (derive_t)tmp_signed;
 937     else
 938       ret.derive = (derive_t)tmp_unsigned;
 939   } else if (type == DS_TYPE_ABSOLUTE) {
 940     ret.absolute = (absolute_t)tmp_unsigned;
 941   } else {
 942     ERROR("snmp plugin: csnmp_value_list_to_value: Unknown data source "
 943           "type: %i.",
 944           type);
 945     ret.gauge = NAN;
 946   }
 947
 948   return ret;
 949 } /* value_t csnmp_value_list_to_value */
 950
 951 /* csnmp_strvbcopy_hexstring converts the bit string contained in "vb" to a hex
 952  * representation and writes it to dst. Returns zero on success and ENOMEM if
 953  * dst is not large enough to hold the string. dst is guaranteed to be
 954  * nul-terminated. */
 955 static int csnmp_strvbcopy_hexstring(char *dst, /* {{{ */
 956                                      const struct variable_list *vb,
 957                                      size_t dst_size) {
 958   char *buffer_ptr;
 959   size_t buffer_free;
 960
 961   dst[0] = 0;
 962
 963   buffer_ptr = dst;
 964   buffer_free = dst_size;
 965
 966   for (size_t i = 0; i < vb->val_len; i++) {
 967     int status;
 968
 969     status = snprintf(buffer_ptr, buffer_free, (i == 0) ? "%02x" : ":%02x",
 970                       (unsigned int)vb->val.bitstring[i]);
 971     assert(status >= 0);
 972
 973     if (((size_t)status) >= buffer_free) /* truncated */
 974     {
 975       dst[dst_size - 1] = 0;
 976       return ENOMEM;
 977     } else /* if (status < buffer_free) */
 978     {
 979       buffer_ptr += (size_t)status;
 980       buffer_free -= (size_t)status;
 981     }
 982   }
 983
 984   return 0;
 985 } /* }}} int csnmp_strvbcopy_hexstring */
 986
 987 /* csnmp_strvbcopy copies the octet string or bit string contained in vb to
 988  * dst. If non-printable characters are detected, it will switch to a hex
 989  * representation of the string. Returns zero on success, EINVAL if vb does not
 990  * contain a string and ENOMEM if dst is not large enough to contain the
 991  * string. */
 992 static int csnmp_strvbcopy(char *dst, /* {{{ */
 993                            const struct variable_list *vb, size_t dst_size) {
 994   char *src;
 995   size_t num_chars;
 996
 997   if (vb->type == ASN_OCTET_STR)
 998     src = (char *)vb->val.string;
 999   else if (vb->type == ASN_BIT_STR)
1000     src = (char *)vb->val.bitstring;
1001   else if (vb->type == ASN_IPADDRESS) {
1002     return snprintf(dst, dst_size,
1003                     "%" PRIu8 ".%" PRIu8 ".%" PRIu8 ".%" PRIu8 "",
1004                     (uint8_t)vb->val.string[0], (uint8_t)vb->val.string[1],
1005                     (uint8_t)vb->val.string[2], (uint8_t)vb->val.string[3]);
1006   } else {
1007     dst[0] = 0;
1008     return EINVAL;
1009   }
1010
1011   num_chars = dst_size - 1;
1012   if (num_chars > vb->val_len)
1013     num_chars = vb->val_len;
1014
1015   for (size_t i = 0; i < num_chars; i++) {
1016     /* Check for control characters. */
1017     if ((unsigned char)src[i] < 32)
1018       return csnmp_strvbcopy_hexstring(dst, vb, dst_size);
1019     dst[i] = src[i];
1020   }
1021   dst[num_chars] = 0;
1022   dst[dst_size - 1] = 0;
1023
1024   if (dst_size <= vb->val_len)
1025     return ENOMEM;
1026
1027   return 0;
1028 } /* }}} int csnmp_strvbcopy */
1029
1030 static int csnmp_instance_list_add(csnmp_list_instances_t **head,
1031                                    csnmp_list_instances_t **tail,
1032                                    const struct snmp_pdu *res,
1033                                    const host_definition_t *hd,
1034                                    const data_definition_t *dd) {
1035   csnmp_list_instances_t *il;
1036   struct variable_list *vb;
1037   oid_t vb_name;
1038   int status;
1039
1040   /* Set vb on the last variable */
1041   for (vb = res->variables; (vb != NULL) && (vb->next_variable != NULL);
1042        vb = vb->next_variable)
1043     /* do nothing */;
1044   if (vb == NULL)
1045     return -1;
1046
1047   csnmp_oid_init(&vb_name, vb->name, vb->name_length);
1048
1049   il = calloc(1, sizeof(*il));
1050   if (il == NULL) {
1051     ERROR("snmp plugin: calloc failed.");
1052     return -1;
1053   }
1054   il->next = NULL;
1055
1056   status = csnmp_oid_suffix(&il->suffix, &vb_name, &dd->instance.oid);
1057   if (status != 0) {
1058     sfree(il);
1059     return status;
1060   }
1061
1062   /* Get instance name */
1063   if ((vb->type == ASN_OCTET_STR) || (vb->type == ASN_BIT_STR) ||
1064       (vb->type == ASN_IPADDRESS)) {
1065     char *ptr;
1066
1067     csnmp_strvbcopy(il->instance, vb, sizeof(il->instance));
1068     _Bool is_matched = 0;
1069     for (uint32_t i = 0; i < dd->ignores_len; i++) {
1070       status = fnmatch(dd->ignores[i], il->instance, 0);
1071       if (status == 0) {
1072         if (!dd->invert_match) {
1073           sfree(il);
1074           return 0;
1075         } else {
1076           is_matched = 1;
1077           break;
1078         }
1079       }
1080     }
1081     if (dd->invert_match && !is_matched) {
1082       sfree(il);
1083       return 0;
1084     }
1085     for (ptr = il->instance; *ptr != '\0'; ptr++) {
1086       if ((*ptr > 0) && (*ptr < 32))
1087         *ptr = ' ';
1088       else if (*ptr == '/')
1089         *ptr = '_';
1090     }
1091     DEBUG("snmp plugin: il->instance = `%s';", il->instance);
1092   } else {
1093     value_t val = csnmp_value_list_to_value(
1094         vb, DS_TYPE_COUNTER,
1095         /* scale = */ 1.0, /* shift = */ 0.0, hd->name, dd->name);
1096     snprintf(il->instance, sizeof(il->instance), "%llu", val.counter);
1097   }
1098
1099   /* TODO: Debugging output */
1100
1101   if (*head == NULL)
1102     *head = il;
1103   else
1104     (*tail)->next = il;
1105   *tail = il;
1106
1107   return 0;
1108 } /* int csnmp_instance_list_add */
1109
1110 static int csnmp_dispatch_table(host_definition_t *host,
1111                                 data_definition_t *data,
1112                                 csnmp_list_instances_t *instance_list,
1113                                 csnmp_table_values_t **value_table) {
1114   const data_set_t *ds;
1115   value_list_t vl = VALUE_LIST_INIT;
1116
1117   csnmp_list_instances_t *instance_list_ptr;
1118   csnmp_table_values_t *value_table_ptr[data->values_len];
1119
1120   size_t i;
1121   _Bool have_more;
1122   oid_t current_suffix;
1123
1124   ds = plugin_get_ds(data->type);
1125   if (!ds) {
1126     ERROR("snmp plugin: DataSet `%s' not defined.", data->type);
1127     return -1;
1128   }
1129   assert(ds->ds_num == data->values_len);
1130   assert(data->values_len > 0);
1131
1132   instance_list_ptr = instance_list;
1133
1134   for (i = 0; i < data->values_len; i++)
1135     value_table_ptr[i] = value_table[i];
1136
1137   sstrncpy(vl.host, host->name, sizeof(vl.host));
1138   sstrncpy(vl.plugin, "snmp", sizeof(vl.plugin));
1139
1140   vl.interval = host->interval;
1141
1142   have_more = 1;
1143   while (have_more) {
1144     _Bool suffix_skipped = 0;
1145
1146     /* Determine next suffix to handle. */
1147     if (instance_list != NULL) {
1148       if (instance_list_ptr == NULL) {
1149         have_more = 0;
1150         continue;
1151       }
1152
1153       memcpy(&current_suffix, &instance_list_ptr->suffix,
1154              sizeof(current_suffix));
1155     } else {
1156       /* no instance configured */
1157       csnmp_table_values_t *ptr = value_table_ptr[0];
1158       if (ptr == NULL) {
1159         have_more = 0;
1160         continue;
1161       }
1162
1163       memcpy(&current_suffix, &ptr->suffix, sizeof(current_suffix));
1164     }
1165
1166     /* Update all the value_table_ptr to point at the entry with the same
1167      * trailing partial OID */
1168     for (i = 0; i < data->values_len; i++) {
1169       while (
1170           (value_table_ptr[i] != NULL) &&
1171           (csnmp_oid_compare(&value_table_ptr[i]->suffix, &current_suffix) < 0))
1172         value_table_ptr[i] = value_table_ptr[i]->next;
1173
1174       if (value_table_ptr[i] == NULL) {
1175         have_more = 0;
1176         break;
1177       } else if (csnmp_oid_compare(&value_table_ptr[i]->suffix,
1178                                    &current_suffix) > 0) {
1179         /* This suffix is missing in the subtree. Indicate this with the
1180          * "suffix_skipped" flag and try the next instance / suffix. */
1181         suffix_skipped = 1;
1182         break;
1183       }
1184     } /* for (i = 0; i < columns; i++) */
1185
1186     if (!have_more)
1187       break;
1188
1189     /* Matching the values failed. Start from the beginning again. */
1190     if (suffix_skipped) {
1191       if (instance_list != NULL)
1192         instance_list_ptr = instance_list_ptr->next;
1193       else
1194         value_table_ptr[0] = value_table_ptr[0]->next;
1195
1196       continue;
1197     }
1198
1199 /* if we reach this line, all value_table_ptr[i] are non-NULL and are set
1200  * to the same subid. instance_list_ptr is either NULL or points to the
1201  * same subid, too. */
1202 #if COLLECT_DEBUG
1203     for (i = 1; i < data->values_len; i++) {
1204       assert(value_table_ptr[i] != NULL);
1205       assert(csnmp_oid_compare(&value_table_ptr[i - 1]->suffix,
1206                                &value_table_ptr[i]->suffix) == 0);
1207     }
1208     assert((instance_list_ptr == NULL) ||
1209            (csnmp_oid_compare(&instance_list_ptr->suffix,
1210                               &value_table_ptr[0]->suffix) == 0));
1211 #endif
1212
1213     sstrncpy(vl.type, data->type, sizeof(vl.type));
1214
1215     {
1216       char temp[DATA_MAX_NAME_LEN];
1217
1218       if (instance_list_ptr == NULL)
1219         csnmp_oid_to_string(temp, sizeof(temp), &current_suffix);
1220       else
1221         sstrncpy(temp, instance_list_ptr->instance, sizeof(temp));
1222
1223       if (data->instance_prefix == NULL)
1224         sstrncpy(vl.type_instance, temp, sizeof(vl.type_instance));
1225       else
1226         snprintf(vl.type_instance, sizeof(vl.type_instance), "%s%s",
1227                  data->instance_prefix, temp);
1228     }
1229
1230     vl.values_len = data->values_len;
1231     value_t values[vl.values_len];
1232     vl.values = values;
1233
1234     for (i = 0; i < data->values_len; i++)
1235       vl.values[i] = value_table_ptr[i]->value;
1236
1237     /* If we get here `vl.type_instance' and all `vl.values' have been set
1238      * vl.type_instance can be empty, i.e. a blank port description on a
1239      * switch if you're using IF-MIB::ifDescr as Instance.
1240      */
1241     if (vl.type_instance[0] != '\0')
1242       plugin_dispatch_values(&vl);
1243
1244     /* prevent leakage of pointer to local variable. */
1245     vl.values_len = 0;
1246     vl.values = NULL;
1247
1248     if (instance_list != NULL)
1249       instance_list_ptr = instance_list_ptr->next;
1250     else
1251       value_table_ptr[0] = value_table_ptr[0]->next;
1252   } /* while (have_more) */
1253
1254   return (0);
1255 } /* int csnmp_dispatch_table */
1256
1257 static int csnmp_read_table(host_definition_t *host, data_definition_t *data) {
1258   struct snmp_pdu *req;
1259   struct snmp_pdu *res = NULL;
1260   struct variable_list *vb;
1261
1262   const data_set_t *ds;
1263
1264   size_t oid_list_len = data->values_len + 1;
1265   /* Holds the last OID returned by the device. We use this in the GETNEXT
1266    * request to proceed. */
1267   oid_t oid_list[oid_list_len];
1268   /* Set to false when an OID has left its subtree so we don't re-request it
1269    * again. */
1270   _Bool oid_list_todo[oid_list_len];
1271
1272   int status;
1273   size_t i;
1274
1275   /* `value_list_head' and `value_list_tail' implement a linked list for each
1276    * value. `instance_list_head' and `instance_list_tail' implement a linked
1277    * list of
1278    * instance names. This is used to jump gaps in the table. */
1279   csnmp_list_instances_t *instance_list_head;
1280   csnmp_list_instances_t *instance_list_tail;
1281   csnmp_table_values_t **value_list_head;
1282   csnmp_table_values_t **value_list_tail;
1283
1284   DEBUG("snmp plugin: csnmp_read_table (host = %s, data = %s)", host->name,
1285         data->name);
1286
1287   if (host->sess_handle == NULL) {
1288     DEBUG("snmp plugin: csnmp_read_table: host->sess_handle == NULL");
1289     return -1;
1290   }
1291
1292   ds = plugin_get_ds(data->type);
1293   if (!ds) {
1294     ERROR("snmp plugin: DataSet `%s' not defined.", data->type);
1295     return -1;
1296   }
1297
1298   if (ds->ds_num != data->values_len) {
1299     ERROR("snmp plugin: DataSet `%s' requires %zu values, but config talks "
1300           "about %zu",
1301           data->type, ds->ds_num, data->values_len);
1302     return -1;
1303   }
1304   assert(data->values_len > 0);
1305
1306   /* We need a copy of all the OIDs, because GETNEXT will destroy them. */
1307   memcpy(oid_list, data->values, data->values_len * sizeof(oid_t));
1308   if (data->instance.oid.oid_len > 0)
1309     memcpy(oid_list + data->values_len, &data->instance.oid, sizeof(oid_t));
1310   else /* no InstanceFrom option specified. */
1311     oid_list_len--;
1312
1313   for (i = 0; i < oid_list_len; i++)
1314     oid_list_todo[i] = 1;
1315
1316   /* We're going to construct n linked lists, one for each "value".
1317    * value_list_head will contain pointers to the heads of these linked lists,
1318    * value_list_tail will contain pointers to the tail of the lists. */
1319   value_list_head = calloc(data->values_len, sizeof(*value_list_head));
1320   value_list_tail = calloc(data->values_len, sizeof(*value_list_tail));
1321   if ((value_list_head == NULL) || (value_list_tail == NULL)) {
1322     ERROR("snmp plugin: csnmp_read_table: calloc failed.");
1323     sfree(value_list_head);
1324     sfree(value_list_tail);
1325     return -1;
1326   }
1327
1328   instance_list_head = NULL;
1329   instance_list_tail = NULL;
1330
1331   status = 0;
1332   while (status == 0) {
1333     req = snmp_pdu_create(SNMP_MSG_GETNEXT);
1334     if (req == NULL) {
1335       ERROR("snmp plugin: snmp_pdu_create failed.");
1336       status = -1;
1337       break;
1338     }
1339
1340     size_t oid_list_todo_num = 0;
1341     size_t var_idx[oid_list_len];
1342     memset(var_idx, 0, sizeof(var_idx));
1343
1344     for (i = 0; i < oid_list_len; i++) {
1345       /* Do not rerequest already finished OIDs */
1346       if (!oid_list_todo[i])
1347         continue;
1348       snmp_add_null_var(req, oid_list[i].oid, oid_list[i].oid_len);
1349       var_idx[oid_list_todo_num] = i;
1350       oid_list_todo_num++;
1351     }
1352
1353     if (oid_list_todo_num == 0) {
1354       /* The request is still empty - so we are finished */
1355       DEBUG("snmp plugin: all variables have left their subtree");
1356       snmp_free_pdu(req);
1357       status = 0;
1358       break;
1359     }
1360
1361     res = NULL;
1362     status = snmp_sess_synch_response(host->sess_handle, req, &res);
1363
1364     /* snmp_sess_synch_response always frees our req PDU */
1365     req = NULL;
1366
1367     if ((status != STAT_SUCCESS) || (res == NULL)) {
1368       char *errstr = NULL;
1369
1370       snmp_sess_error(host->sess_handle, NULL, NULL, &errstr);
1371
1372       c_complain(LOG_ERR, &host->complaint,
1373                  "snmp plugin: host %s: snmp_sess_synch_response failed: %s",
1374                  host->name, (errstr == NULL) ? "Unknown problem" : errstr);
1375
1376       if (res != NULL)
1377         snmp_free_pdu(res);
1378       res = NULL;
1379
1380       sfree(errstr);
1381       csnmp_host_close_session(host);
1382
1383       status = -1;
1384       break;
1385     }
1386
1387     status = 0;
1388     assert(res != NULL);
1389     c_release(LOG_INFO, &host->complaint,
1390               "snmp plugin: host %s: snmp_sess_synch_response successful.",
1391               host->name);
1392
1393     vb = res->variables;
1394     if (vb == NULL) {
1395       status = -1;
1396       break;
1397     }
1398
1399     if (res->errstat != SNMP_ERR_NOERROR) {
1400       if (res->errindex != 0) {
1401         /* Find the OID which caused error */
1402         for (i = 1, vb = res->variables; vb != NULL && i != res->errindex;
1403              vb = vb->next_variable, i++)
1404           /* do nothing */;
1405       }
1406
1407       if ((res->errindex == 0) || (vb == NULL)) {
1408         ERROR("snmp plugin: host %s; data %s: response error: %s (%li) ",
1409               host->name, data->name, snmp_errstring(res->errstat),
1410               res->errstat);
1411         status = -1;
1412         break;
1413       }
1414
1415       char oid_buffer[1024] = {0};
1416       snprint_objid(oid_buffer, sizeof(oid_buffer) - 1, vb->name,
1417                     vb->name_length);
1418       NOTICE("snmp plugin: host %s; data %s: OID `%s` failed: %s", host->name,
1419              data->name, oid_buffer, snmp_errstring(res->errstat));
1420
1421       /* Get value index from todo list and skip OID found */
1422       assert(res->errindex <= oid_list_todo_num);
1423       i = var_idx[res->errindex - 1];
1424       assert(i < oid_list_len);
1425       oid_list_todo[i] = 0;
1426
1427       snmp_free_pdu(res);
1428       res = NULL;
1429       continue;
1430     }
1431
1432     for (vb = res->variables, i = 0; (vb != NULL);
1433          vb = vb->next_variable, i++) {
1434       /* Calculate value index from todo list */
1435       while ((i < oid_list_len) && !oid_list_todo[i]) {
1436         i++;
1437       }
1438       if (i >= oid_list_len) {
1439         break;
1440       }
1441
1442       /* An instance is configured and the res variable we process is the
1443        * instance value (last index) */
1444       if ((data->instance.oid.oid_len > 0) && (i == data->values_len)) {
1445         if ((vb->type == SNMP_ENDOFMIBVIEW) ||
1446             (snmp_oid_ncompare(
1447                  data->instance.oid.oid, data->instance.oid.oid_len, vb->name,
1448                  vb->name_length, data->instance.oid.oid_len) != 0)) {
1449           DEBUG("snmp plugin: host = %s; data = %s; Instance left its subtree.",
1450                 host->name, data->name);
1451           oid_list_todo[i] = 0;
1452           continue;
1453         }
1454
1455         /* Allocate a new `csnmp_list_instances_t', insert the instance name and
1456          * add it to the list */
1457         if (csnmp_instance_list_add(&instance_list_head, &instance_list_tail,
1458                                     res, host, data) != 0) {
1459           ERROR("snmp plugin: host %s: csnmp_instance_list_add failed.",
1460                 host->name);
1461           status = -1;
1462           break;
1463         }
1464       } else /* The variable we are processing is a normal value */
1465       {
1466         csnmp_table_values_t *vt;
1467         oid_t vb_name;
1468         oid_t suffix;
1469         int ret;
1470
1471         csnmp_oid_init(&vb_name, vb->name, vb->name_length);
1472
1473         /* Calculate the current suffix. This is later used to check that the
1474          * suffix is increasing. This also checks if we left the subtree */
1475         ret = csnmp_oid_suffix(&suffix, &vb_name, data->values + i);
1476         if (ret != 0) {
1477           DEBUG("snmp plugin: host = %s; data = %s; i = %zu; "
1478                 "Value probably left its subtree.",
1479                 host->name, data->name, i);
1480           oid_list_todo[i] = 0;
1481           continue;
1482         }
1483
1484         /* Make sure the OIDs returned by the agent are increasing. Otherwise
1485          * our
1486          * table matching algorithm will get confused. */
1487         if ((value_list_tail[i] != NULL) &&
1488             (csnmp_oid_compare(&suffix, &value_list_tail[i]->suffix) <= 0)) {
1489           DEBUG("snmp plugin: host = %s; data = %s; i = %zu; "
1490                 "Suffix is not increasing.",
1491                 host->name, data->name, i);
1492           oid_list_todo[i] = 0;
1493           continue;
1494         }
1495
1496         vt = calloc(1, sizeof(*vt));
1497         if (vt == NULL) {
1498           ERROR("snmp plugin: calloc failed.");
1499           status = -1;
1500           break;
1501         }
1502
1503         vt->value =
1504             csnmp_value_list_to_value(vb, ds->ds[i].type, data->scale,
1505                                       data->shift, host->name, data->name);
1506         memcpy(&vt->suffix, &suffix, sizeof(vt->suffix));
1507         vt->next = NULL;
1508
1509         if (value_list_tail[i] == NULL)
1510           value_list_head[i] = vt;
1511         else
1512           value_list_tail[i]->next = vt;
1513         value_list_tail[i] = vt;
1514       }
1515
1516       /* Copy OID to oid_list[i] */
1517       memcpy(oid_list[i].oid, vb->name, sizeof(oid) * vb->name_length);
1518       oid_list[i].oid_len = vb->name_length;
1519
1520     } /* for (vb = res->variables ...) */
1521
1522     if (res != NULL)
1523       snmp_free_pdu(res);
1524     res = NULL;
1525   } /* while (status == 0) */
1526
1527   if (res != NULL)
1528     snmp_free_pdu(res);
1529   res = NULL;
1530
1531   if (status == 0)
1532     csnmp_dispatch_table(host, data, instance_list_head, value_list_head);
1533
1534   /* Free all allocated variables here */
1535   while (instance_list_head != NULL) {
1536     csnmp_list_instances_t *next = instance_list_head->next;
1537     sfree(instance_list_head);
1538     instance_list_head = next;
1539   }
1540
1541   for (i = 0; i < data->values_len; i++) {
1542     while (value_list_head[i] != NULL) {
1543       csnmp_table_values_t *next = value_list_head[i]->next;
1544       sfree(value_list_head[i]);
1545       value_list_head[i] = next;
1546     }
1547   }
1548
1549   sfree(value_list_head);
1550   sfree(value_list_tail);
1551
1552   return 0;
1553 } /* int csnmp_read_table */
1554
1555 static int csnmp_read_value(host_definition_t *host, data_definition_t *data) {
1556   struct snmp_pdu *req;
1557   struct snmp_pdu *res = NULL;
1558   struct variable_list *vb;
1559
1560   const data_set_t *ds;
1561   value_list_t vl = VALUE_LIST_INIT;
1562
1563   int status;
1564   size_t i;
1565
1566   DEBUG("snmp plugin: csnmp_read_value (host = %s, data = %s)", host->name,
1567         data->name);
1568
1569   if (host->sess_handle == NULL) {
1570     DEBUG("snmp plugin: csnmp_read_value: host->sess_handle == NULL");
1571     return -1;
1572   }
1573
1574   ds = plugin_get_ds(data->type);
1575   if (!ds) {
1576     ERROR("snmp plugin: DataSet `%s' not defined.", data->type);
1577     return -1;
1578   }
1579
1580   if (ds->ds_num != data->values_len) {
1581     ERROR("snmp plugin: DataSet `%s' requires %zu values, but config talks "
1582           "about %zu",
1583           data->type, ds->ds_num, data->values_len);
1584     return -1;
1585   }
1586
1587   vl.values_len = ds->ds_num;
1588   vl.values = malloc(sizeof(*vl.values) * vl.values_len);
1589   if (vl.values == NULL)
1590     return -1;
1591   for (i = 0; i < vl.values_len; i++) {
1592     if (ds->ds[i].type == DS_TYPE_COUNTER)
1593       vl.values[i].counter = 0;
1594     else
1595       vl.values[i].gauge = NAN;
1596   }
1597
1598   sstrncpy(vl.host, host->name, sizeof(vl.host));
1599   sstrncpy(vl.plugin, "snmp", sizeof(vl.plugin));
1600   sstrncpy(vl.type, data->type, sizeof(vl.type));
1601   sstrncpy(vl.type_instance, data->instance.string, sizeof(vl.type_instance));
1602
1603   vl.interval = host->interval;
1604
1605   req = snmp_pdu_create(SNMP_MSG_GET);
1606   if (req == NULL) {
1607     ERROR("snmp plugin: snmp_pdu_create failed.");
1608     sfree(vl.values);
1609     return -1;
1610   }
1611
1612   for (i = 0; i < data->values_len; i++)
1613     snmp_add_null_var(req, data->values[i].oid, data->values[i].oid_len);
1614
1615   status = snmp_sess_synch_response(host->sess_handle, req, &res);
1616
1617   if ((status != STAT_SUCCESS) || (res == NULL)) {
1618     char *errstr = NULL;
1619
1620     snmp_sess_error(host->sess_handle, NULL, NULL, &errstr);
1621     ERROR("snmp plugin: host %s: snmp_sess_synch_response failed: %s",
1622           host->name, (errstr == NULL) ? "Unknown problem" : errstr);
1623
1624     if (res != NULL)
1625       snmp_free_pdu(res);
1626
1627     sfree(errstr);
1628     sfree(vl.values);
1629     csnmp_host_close_session(host);
1630
1631     return -1;
1632   }
1633
1634   for (vb = res->variables; vb != NULL; vb = vb->next_variable) {
1635 #if COLLECT_DEBUG
1636     char buffer[1024];
1637     snprint_variable(buffer, sizeof(buffer), vb->name, vb->name_length, vb);
1638     DEBUG("snmp plugin: Got this variable: %s", buffer);
1639 #endif /* COLLECT_DEBUG */
1640
1641     for (i = 0; i < data->values_len; i++)
1642       if (snmp_oid_compare(data->values[i].oid, data->values[i].oid_len,
1643                            vb->name, vb->name_length) == 0)
1644         vl.values[i] =
1645             csnmp_value_list_to_value(vb, ds->ds[i].type, data->scale,
1646                                       data->shift, host->name, data->name);
1647   } /* for (res->variables) */
1648
1649   snmp_free_pdu(res);
1650
1651   DEBUG("snmp plugin: -> plugin_dispatch_values (&vl);");
1652   plugin_dispatch_values(&vl);
1653   sfree(vl.values);
1654
1655   return 0;
1656 } /* int csnmp_read_value */
1657
1658 static int csnmp_read_host(user_data_t *ud) {
1659   host_definition_t *host;
1660   int status;
1661   int success;
1662   int i;
1663
1664   host = ud->data;
1665
1666   if (host->interval == 0)
1667     host->interval = plugin_get_interval();
1668
1669   if (host->sess_handle == NULL)
1670     csnmp_host_open_session(host);
1671
1672   if (host->sess_handle == NULL)
1673     return -1;
1674
1675   success = 0;
1676   for (i = 0; i < host->data_list_len; i++) {
1677     data_definition_t *data = host->data_list[i];
1678
1679     if (data->is_table)
1680       status = csnmp_read_table(host, data);
1681     else
1682       status = csnmp_read_value(host, data);
1683
1684     if (status == 0)
1685       success++;
1686   }
1687
1688   if (success == 0)
1689     return -1;
1690
1691   return 0;
1692 } /* int csnmp_read_host */
1693
1694 static int csnmp_init(void) {
1695   call_snmp_init_once();
1696
1697   return 0;
1698 } /* int csnmp_init */
1699
1700 static int csnmp_shutdown(void) {
1701   data_definition_t *data_this;
1702   data_definition_t *data_next;
1703
1704   /* When we get here, the read threads have been stopped and all the
1705    * `host_definition_t' will be freed. */
1706   DEBUG("snmp plugin: Destroying all data definitions.");
1707
1708   data_this = data_head;
1709   data_head = NULL;
1710   while (data_this != NULL) {
1711     data_next = data_this->next;
1712
1713     sfree(data_this->name);
1714     sfree(data_this->type);
1715     sfree(data_this->values);
1716     sfree(data_this->ignores);
1717     sfree(data_this);
1718
1719     data_this = data_next;
1720   }
1721
1722   return 0;
1723 } /* int csnmp_shutdown */
1724
1725 void module_register(void) {
1726   plugin_register_complex_config("snmp", csnmp_config);
1727   plugin_register_init("snmp", csnmp_init);
1728   plugin_register_shutdown("snmp", csnmp_shutdown);
1729 } /* void module_register */