2 * collectd - src/openvpn.c
3 * Copyright (C) 2008 Doug MacEachern
4 * Copyright (C) 2009 Florian octo Forster
5 * Copyright (C) 2009 Marco Chiappero
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; only version 2 of the License is applicable.
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 * Doug MacEachern <dougm at hyperic.com>
22 * Florian octo Forster <octo at verplant.org>
23 * Marco Chiappero <marco at absence.it>
30 #define V1STRING "Common Name,Real Address,Bytes Received,Bytes Sent,Connected Since\n"
31 #define V2STRING "HEADER,CLIENT_LIST,Common Name,Real Address,Virtual Address,Bytes Received,Bytes Sent,Connected Since,Connected Since (time_t)\n"
32 #define V3STRING "HEADER CLIENT_LIST Common Name Real Address Virtual Address Bytes Received Bytes Sent Connected Since Connected Since (time_t)\n"
33 #define VSSTRING "OpenVPN STATISTICS\n"
41 MULTI1 = 1, /* status-version 1 */
42 MULTI2, /* status-version 2 */
43 MULTI3, /* status-version 3 */
44 SINGLE = 10 /* currently no versions for single mode, maybe in the future */
48 typedef struct vpn_status_s vpn_status_t;
50 static vpn_status_t **vpn_list = NULL;
51 static int vpn_num = 0;
53 static int store_compression = 1;
55 static const char *config_keys[] =
60 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
64 /* copy-n-pasted from common.c - changed delim to "," */
65 static int openvpn_strsplit (char *string, char **fields, size_t size)
74 while ((fields[i] = strtok_r (ptr, ",", &saveptr)) != NULL)
84 } /* int openvpn_strsplit */
87 /* dispatches stats about traffic (TCP or UDP) generated by the tunnel per single endpoint */
88 static void iostats_submit (char *name, char *type, counter_t rx, counter_t tx)
91 value_list_t vl = VALUE_LIST_INIT;
93 values[0].counter = rx;
94 values[1].counter = tx;
96 /* NOTE: using plugin_instance to identify each vpn config (and
97 * status) file; using type_instance to identify the endpoint
98 * host when in multimode, traffic or overhead when in single.
102 vl.values_len = STATIC_ARRAY_SIZE (values);
103 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
104 sstrncpy (vl.plugin, "openvpn", sizeof (vl.plugin));
105 sstrncpy (vl.plugin_instance, name, sizeof (vl.plugin_instance));
106 sstrncpy (vl.type, "io_octets", sizeof (vl.type));
107 sstrncpy (vl.type_instance, type, sizeof (vl.type_instance));
109 plugin_dispatch_values (&vl);
110 } /* void traffic_submit */
112 /* dispatches stats about data compression shown when in single mode */
113 static void compression_submit (char *name, char *type, counter_t uncompressed, counter_t compressed)
116 value_list_t vl = VALUE_LIST_INIT;
118 values[0].counter = uncompressed;
119 values[1].counter = compressed;
122 vl.values_len = STATIC_ARRAY_SIZE (values);
123 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
124 sstrncpy (vl.plugin, "openvpn", sizeof (vl.plugin));
125 sstrncpy (vl.plugin_instance, name, sizeof (vl.plugin_instance));
126 sstrncpy (vl.type, "compression", sizeof (vl.type));
127 sstrncpy (vl.type_instance, type, sizeof (vl.type_instance));
129 plugin_dispatch_values (&vl);
130 } /* void compression_submit */
132 static int single_read (char *name, FILE *fh)
136 const int max_fields = STATIC_ARRAY_SIZE (fields);
137 int fields_num, read = 0;
139 counter_t link_rx, link_tx;
140 counter_t tun_rx, tun_tx;
141 counter_t pre_compress, post_compress;
142 counter_t pre_decompress, post_decompress;
143 counter_t overhead_rx, overhead_tx;
157 while (fgets (buffer, sizeof (buffer), fh) != NULL)
159 fields_num = openvpn_strsplit (buffer, fields, max_fields);
161 /* status file is generated by openvpn/sig.c:print_status()
162 * http://svn.openvpn.net/projects/openvpn/trunk/openvpn/sig.c
164 * The line we're expecting has 2 fields. We ignore all lines
165 * with more or less fields.
173 if (strcmp (fields[0], "TUN/TAP read bytes") == 0)
175 /* read from the system and sent over the tunnel */
176 tun_tx = atoll (fields[1]);
178 else if (strcmp (fields[0], "TUN/TAP write bytes") == 0)
180 /* read from the tunnel and written in the system */
181 tun_rx = atoll (fields[1]);
183 else if (strcmp (fields[0], "TCP/UDP read bytes") == 0)
185 link_rx = atoll (fields[1]);
187 else if (strcmp (fields[0], "TCP/UDP write bytes") == 0)
189 link_tx = atoll (fields[1]);
191 else if (strcmp (fields[0], "pre-compress bytes") == 0)
193 pre_compress = atoll (fields[1]);
195 else if (strcmp (fields[0], "post-compress bytes") == 0)
197 post_compress = atoll (fields[1]);
199 else if (strcmp (fields[0], "pre-decompress bytes") == 0)
201 pre_decompress = atoll (fields[1]);
203 else if (strcmp (fields[0], "post-decompress bytes") == 0)
205 post_decompress = atoll (fields[1]);
210 iostats_submit (name, "traffic", link_rx, link_tx);
212 /* we need to force this order to avoid negative values with these unsigned */
213 overhead_rx = (((link_rx - pre_decompress) + post_decompress) - tun_rx);
214 overhead_tx = (((link_tx - post_compress) + pre_compress) - tun_tx);
216 iostats_submit (name, "overhead", overhead_rx, overhead_tx);
218 if (store_compression)
220 compression_submit (name, "data_in", post_decompress, pre_decompress);
221 compression_submit (name, "data_out", pre_compress, post_compress);
227 } /* int single_read */
229 /* for reading status version 1 */
230 static int multi1_read (char *name, FILE *fh)
234 const int max_fields = STATIC_ARRAY_SIZE (fields);
235 int fields_num, read = 0, skip = 1;
237 /* read the file until the "ROUTING TABLE" line is found (no more info after) */
238 for ( ; strcmp (buffer, "ROUTING TABLE\n"); fgets (buffer, sizeof (buffer), fh))
240 if (skip) /* skip the first lines until the client list section is found */
242 /* we can't start reading data until this string is found */
243 if (strcmp (buffer, V1STRING) == 0)
250 fields_num = openvpn_strsplit (buffer, fields, max_fields);
252 iostats_submit (name, /* vpn instance */
253 fields[0], /* "Common Name" */
254 atoll (fields[2]), /* "Bytes Received" */
255 atoll (fields[3])); /* "Bytes Sent" */
261 } /* int multi1_read */
263 /* for reading status version 2 */
264 static int multi2_read (char *name, FILE *fh)
268 const int max_fields = STATIC_ARRAY_SIZE (fields);
269 int fields_num, read = 0;
271 while (fgets (buffer, sizeof (buffer), fh) != NULL)
273 fields_num = openvpn_strsplit (buffer, fields, max_fields);
275 /* status file is generated by openvpn/multi.c:multi_print_status()
276 * http://svn.openvpn.net/projects/openvpn/trunk/openvpn/multi.c
278 * The line we're expecting has 8 fields. We ignore all lines
279 * with more or less fields.
287 if (strcmp (fields[0], "CLIENT_LIST") == 0)
289 iostats_submit (name, /* vpn instance */
290 fields[1], /* "Common Name" */
291 atoll (fields[4]), /* "Bytes Received" */
292 atoll (fields[5])); /* "Bytes Sent" */
299 } /* int multi2_read */
301 /* for reading status version 3 */
302 static int multi3_read (char *name, FILE *fh)
306 const int max_fields = STATIC_ARRAY_SIZE (fields);
307 int fields_num, read = 0;
309 while (fgets (buffer, sizeof (buffer), fh) != NULL)
311 fields_num = strsplit (buffer, fields, max_fields);
313 /* status file is generated by openvpn/multi.c:multi_print_status()
314 * http://svn.openvpn.net/projects/openvpn/trunk/openvpn/multi.c
316 * The line we're expecting has 12 fields. We ignore all lines
317 * with more or less fields.
319 if (fields_num != 12)
325 if (strcmp (fields[0], "CLIENT_LIST") == 0)
327 iostats_submit (name, /* vpn instance */
328 fields[1], /* "Common Name" */
329 atoll (fields[4]), /* "Bytes Received" */
330 atoll (fields[5])); /* "Bytes Sent" */
337 } /* int multi3_read */
340 static int openvpn_read (void)
347 /* call the right read function for every status entry in the list */
348 for (i = 0; i < vpn_num; i++)
350 fh = fopen (vpn_list[i]->file, "r");
354 WARNING ("openvpn plugin: fopen(%s) failed: %s", vpn_list[i]->file,
355 sstrerror (errno, errbuf, sizeof (errbuf)));
360 switch (vpn_list[i]->version)
363 read = single_read(vpn_list[i]->name, fh);
367 read = multi1_read(vpn_list[i]->name, fh);
371 read = multi2_read(vpn_list[i]->name, fh);
375 read = multi3_read(vpn_list[i]->name, fh);
382 return (read ? 0 : -1);
383 } /* int openvpn_read */
385 static int version_detect (const char *filename)
391 /* Sanity checking. We're called from the config handling routine, so
392 * better play it save. */
393 if ((filename == NULL) || (*filename == 0))
396 fh = fopen (filename, "r");
400 WARNING ("openvpn plugin: Unable to read \"%s\": %s", filename,
401 sstrerror (errno, errbuf, sizeof (errbuf)));
405 /* now search for the specific multimode data format */
406 while ((fgets (buffer, sizeof (buffer), fh)) != NULL)
408 /* we look at the first line searching for SINGLE mode configuration */
409 if (strcmp (buffer, VSSTRING) == 0)
411 DEBUG ("openvpn plugin: found status file version SINGLE");
415 /* searching for multi version 1 */
416 else if (strcmp (buffer, V1STRING) == 0)
418 DEBUG ("openvpn plugin: found status file version MULTI1");
422 /* searching for multi version 2 */
423 else if (strcmp (buffer, V2STRING) == 0)
425 DEBUG ("openvpn plugin: found status file version MULTI2");
429 /* searching for multi version 3 */
430 else if (strcmp (buffer, V3STRING) == 0)
432 DEBUG ("openvpn plugin: found status file version MULTI3");
440 /* This is only reached during configuration, so complaining to
441 * the user is in order. */
442 NOTICE ("openvpn plugin: %s: Unknown file format, please "
443 "report this as bug. Make sure to include "
444 "your status file, so the plugin can "
445 "be adapted.", filename);
451 } /* int version_detect */
453 static int openvpn_config (const char *key, const char *value)
455 if (strcasecmp ("StatusFile", key) == 0)
457 char *status_file, *status_name, *filename;
458 int status_version, i;
461 /* try to detect the status file format */
462 status_version = version_detect (value);
464 if (status_version == 0)
466 WARNING ("openvpn plugin: unable to detect status version, \
467 discarding status file \"%s\".", value);
471 status_file = sstrdup (value);
472 if (status_file == NULL)
475 WARNING ("openvpn plugin: sstrdup failed: %s",
476 sstrerror (errno, errbuf, sizeof (errbuf)));
480 /* it determines the file name as string starting at location filename + 1 */
481 filename = strrchr (status_file, (int) '/');
482 if (filename == NULL)
484 /* status_file is already the file name only */
485 status_name = status_file;
489 /* doesn't waist memory, uses status_file starting at filename + 1 */
490 status_name = filename + 1;
493 /* scan the list looking for a clone */
494 for (i = 0; i < vpn_num; i++)
496 if (strcasecmp (vpn_list[i]->name, status_name) == 0)
498 WARNING ("openvpn plugin: status filename \"%s\" "
499 "already used, please choose a "
500 "different one.", status_name);
506 /* create a new vpn element since file, version and name are ok */
507 temp = (vpn_status_t *) malloc (sizeof (vpn_status_t));
508 temp->file = status_file;
509 temp->version = status_version;
510 temp->name = status_name;
512 vpn_list = (vpn_status_t **) realloc (vpn_list, (vpn_num + 1) * sizeof (vpn_status_t *));
513 if (vpn_list == NULL)
516 ERROR ("openvpn plugin: malloc failed: %s",
517 sstrerror (errno, errbuf, sizeof (errbuf)));
524 vpn_list[vpn_num] = temp;
527 DEBUG ("openvpn plugin: status file \"%s\" added", temp->file);
530 else if (strcasecmp ("Compression", key) == 0)
533 store_compression = 1;
536 store_compression = 0;
537 DEBUG ("openvpn plugin: no 'compression statistcs' collected");
546 } /* int openvpn_config */
548 /* shutdown callback */
549 static int openvpn_shutdown (void)
553 for (i = 0; i < vpn_num; i++)
555 sfree (vpn_list[i]->file);
562 } /* int openvpn_shutdown */
564 void module_register (void)
566 plugin_register_config ("openvpn", openvpn_config,
567 config_keys, config_keys_num);
568 plugin_register_read ("openvpn", openvpn_read);
569 plugin_register_shutdown ("openvpn", openvpn_shutdown);
570 } /* void module_register */