2 * collectd - src/snort.c
3 * Copyright (C) 2013 Kris Nielander
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 * Kris Nielander <nielander@fox-it.com>
21 * This plugin is based on the snmp plugin by Florian octo Forster.
26 #include "plugin.h" /* plugin_register_*, plugin_dispatch_values */
27 #include "common.h" /* auxiliary functions */
34 struct metric_definition_s {
39 struct metric_definition_s *next;
41 typedef struct metric_definition_s metric_definition_t;
43 struct instance_definition_s {
46 metric_definition_t **metric_list;
50 struct instance_definition_s *next;
52 typedef struct instance_definition_s instance_definition_t;
55 static metric_definition_t *metric_head = NULL;
57 static int snort_read_submit(instance_definition_t *id, metric_definition_t *md,
60 /* Registration variables */
62 value_list_t vl = VALUE_LIST_INIT;
64 DEBUG("snort plugin: plugin_instance=%s type=%s value=%s", id->name,
71 parse_value(buf, &value, md->data_source_type);
77 sstrncpy(vl.host, hostname_g, sizeof (vl.host));
78 sstrncpy(vl.plugin, "snort", sizeof(vl.plugin));
79 sstrncpy(vl.plugin_instance, id->name, sizeof(vl.plugin_instance));
80 sstrncpy(vl.type, md->type, sizeof(vl.type));
83 vl.interval = id->interval;
85 DEBUG("snort plugin: -> plugin_dispatch_values (&vl);");
86 plugin_dispatch_values(&vl);
91 static int snort_read_buffer (instance_definition_t *id,
92 char const *buffer, size_t buffer_size)
101 /* mmap, char pointers */
104 /* Set the start value count. */
107 /* Set the pointer to the last line of the file and count the fields.
108 (Skip the last two characters of the buffer: `\n' and `\0') */
109 for (p_end = (buffer + buffer_size) - 2; p_end > buffer; --p_end){
112 } else if (*p_end == '\n'){
118 if (metrics_num == 1){
119 ERROR("snort plugin: last line of `%s' does not contain enough values.", id->path);
124 ERROR("snort plugin: last line of `%s' is a comment.", id->path);
128 /* Copy the line to the buffer */
131 /* Create a list of all values */
132 metrics = calloc (metrics_num, sizeof (*metrics));
133 if (metrics == NULL) {
134 ERROR ("snort plugin: calloc failed.");
141 while (buf_ptr != NULL) {
142 char *next = strchr (buf_ptr, ',');
147 metrics[i] = buf_ptr;
151 assert (i == metrics_num);
154 id->last = TIME_T_TO_CDTIME_T(strtol(*metrics, NULL, 0));
156 /* Register values */
157 for (i = 0; i < id->metric_list_len; ++i){
158 metric_definition_t *md = id->metric_list[i];
160 if (md->index >= metrics_num) {
161 ERROR ("snort plugin: Metric \"%s\": Request for index %i when "
162 "only %i fields are available.",
163 md->name, md->index, metrics_num);
167 snort_read_submit(id, md, metrics[md->index]);
170 /* Free up resources */
176 static int snort_read(user_data_t *ud){
177 instance_definition_t *id;
183 /* mmap, char pointers */
187 DEBUG("snort plugin: snort_read (instance = %s)", id->name);
189 fd = open(id->path, O_RDONLY);
191 ERROR("snort plugin: Unable to open `%s'.", id->path);
195 if ((fstat(fd, &sb) != 0) || (!S_ISREG(sb.st_mode))){
196 ERROR("snort plugin: `%s' is not a file.", id->path);
201 if (sb.st_size == 0){
202 ERROR("snort plugin: `%s' is empty.", id->path);
207 p_start = mmap(/* addr = */ NULL, sb.st_size, PROT_READ, MAP_SHARED, fd,
209 if (p_start == MAP_FAILED){
210 ERROR("snort plugin: mmap error");
215 snort_read_buffer (id, p_start, (size_t) sb.st_size);
217 /* Done with mmap and file pointer */
219 munmap(p_start, sb.st_size);
223 static void snort_metric_definition_destroy(void *arg){
224 metric_definition_t *md;
230 if (md->name != NULL)
231 DEBUG("snort plugin: Destroying metric definition `%s'.", md->name);
238 static int snort_config_add_metric_index(metric_definition_t *md, oconfig_item_t *ci){
239 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_NUMBER)){
240 WARNING("snort plugin: `Index' needs exactly one integer argument.");
244 md->index = (int)ci->values[0].value.number;
246 WARNING("snort plugin: `Index' must be higher than 0.");
254 static int snort_config_add_metric(oconfig_item_t *ci){
255 metric_definition_t *md;
256 const data_set_t *ds;
260 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING)){
261 WARNING("snort plugin: The `Metric' config option needs exactly one string argument.");
265 md = (metric_definition_t *)malloc(sizeof(*md));
268 memset(md, 0, sizeof(*md));
270 md->name = strdup(ci->values[0].value.string);
271 if (md->name == NULL){
276 for (i = 0; i < ci->children_num; ++i){
277 oconfig_item_t *option = ci->children + i;
280 if (strcasecmp("Type", option->key) == 0)
281 status = cf_util_get_string(option, &md->type);
282 else if (strcasecmp("Index", option->key) == 0)
283 status = snort_config_add_metric_index(md, option);
285 WARNING("snort plugin: Option `%s' not allowed here.", option->key);
294 snort_metric_definition_destroy(md);
298 /* Verify all necessary options have been set. */
299 if (md->type == NULL){
300 WARNING("snort plugin: Option `Type' must be set.");
302 } else if (md->index == 0){
303 WARNING("snort plugin: Option `Index' must be set.");
308 snort_metric_definition_destroy(md);
312 /* Retrieve the data source type from the types db. */
313 ds = plugin_get_ds(md->type);
315 WARNING("snort plugin: `Type' must be defined in `types.db'.");
316 snort_metric_definition_destroy(md);
319 md->data_source_type = ds->ds->type;
322 DEBUG("snort plugin: md = { name = %s, type = %s, data_source_type = %d, index = %d }",
323 md->name, md->type, md->data_source_type, md->index);
325 if (metric_head == NULL)
328 metric_definition_t *last;
330 while (last->next != NULL)
338 static void snort_instance_definition_destroy(void *arg){
339 instance_definition_t *id;
345 if (id->name != NULL)
346 DEBUG("snort plugin: Destroying instance definition `%s'.", id->name);
350 sfree(id->metric_list);
354 static int snort_config_add_instance_collect(instance_definition_t *id, oconfig_item_t *ci){
355 metric_definition_t *metric;
358 if (ci->values_num < 1){
359 WARNING("snort plugin: The `Collect' config option needs at least one argument.");
363 /* Verify string arguments */
364 for (i = 0; i < ci->values_num; ++i)
365 if (ci->values[i].type != OCONFIG_TYPE_STRING){
366 WARNING("snort plugin: All arguments to `Collect' must be strings.");
370 id->metric_list = (metric_definition_t **)malloc(sizeof(metric_definition_t *) * ci->values_num);
371 if (id->metric_list == NULL)
374 for (i = 0; i < ci->values_num; ++i){
375 for (metric = metric_head; metric != NULL; metric = metric->next)
376 if (strcasecmp(ci->values[i].value.string, metric->name) == 0)
380 WARNING("snort plugin: `Collect' argument not found `%s'.", ci->values[i].value.string);
384 DEBUG("snort plugin: id { name=%s md->name=%s }", id->name, metric->name);
386 id->metric_list[i] = metric;
387 id->metric_list_len++;
394 static int snort_config_add_instance(oconfig_item_t *ci){
396 instance_definition_t* id;
400 /* Registration variables */
401 char cb_name[DATA_MAX_NAME_LEN];
403 struct timespec cb_interval;
405 if ((ci->values_num != 1) || (ci->values[0].type != OCONFIG_TYPE_STRING)){
406 WARNING("snort plugin: The `Instance' config option needs exactly one string argument.");
410 id = (instance_definition_t *)malloc(sizeof(*id));
413 memset(id, 0, sizeof(*id));
415 id->name = strdup(ci->values[0].value.string);
416 if (id->name == NULL){
421 /* Use default interval. */
422 id->interval = plugin_get_interval();
424 for (i = 0; i < ci->children_num; ++i){
425 oconfig_item_t *option = ci->children + i;
428 if (strcasecmp("Path", option->key) == 0)
429 status = cf_util_get_string(option, &id->path);
430 else if (strcasecmp("Collect", option->key) == 0)
431 status = snort_config_add_instance_collect(id, option);
432 else if (strcasecmp("Interval", option->key) == 0)
433 cf_util_get_cdtime(option, &id->interval);
435 WARNING("snort plugin: Option `%s' not allowed here.", option->key);
444 snort_instance_definition_destroy(id);
448 /* Verify all necessary options have been set. */
449 if (id->path == NULL){
450 WARNING("snort plugin: Option `Path' must be set.");
452 } else if (id->metric_list == NULL){
453 WARNING("snort plugin: Option `Collect' must be set.");
458 snort_instance_definition_destroy(id);
462 DEBUG("snort plugin: id = { name = %s, path = %s }", id->name, id->path);
464 ssnprintf (cb_name, sizeof (cb_name), "snort-%s", id->name);
465 memset(&cb_data, 0, sizeof(cb_data));
467 cb_data.free_func = snort_instance_definition_destroy;
468 CDTIME_T_TO_TIMESPEC(id->interval, &cb_interval);
469 status = plugin_register_complex_read(NULL, cb_name, snort_read, &cb_interval, &cb_data);
472 ERROR("snort plugin: Registering complex read function failed.");
473 snort_instance_definition_destroy(id);
481 static int snort_config(oconfig_item_t *ci){
483 for (i = 0; i < ci->children_num; ++i){
484 oconfig_item_t *child = ci->children + i;
485 if (strcasecmp("Metric", child->key) == 0)
486 snort_config_add_metric(child);
487 else if (strcasecmp("Instance", child->key) == 0)
488 snort_config_add_instance(child);
490 WARNING("snort plugin: Ignore unknown config option `%s'.", child->key);
494 } /* int snort_config */
496 static int snort_shutdown(void){
497 metric_definition_t *metric_this;
498 metric_definition_t *metric_next;
500 metric_this = metric_head;
503 while (metric_this != NULL){
504 metric_next = metric_this->next;
505 snort_metric_definition_destroy(metric_this);
506 metric_this = metric_next;
512 void module_register(void){
513 plugin_register_complex_config("snort", snort_config);
514 plugin_register_shutdown("snort", snort_shutdown);