2 * collectd - src/openvpn.c
3 * Copyright (C) 2008 Doug MacEachern
4 * Copyright (C) 2009,2010 Florian octo Forster
5 * Copyright (C) 2009 Marco Chiappero
6 * Copyright (C) 2009 Fabian Schuh
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; only version 2 of the License is applicable.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 * Doug MacEachern <dougm at hyperic.com>
23 * Florian octo Forster <octo at collectd.org>
24 * Marco Chiappero <marco at absence.it>
25 * Fabian Schuh <mail at xeroc.org>
32 #define V1STRING "Common Name,Real Address,Bytes Received,Bytes Sent,Connected Since\n"
33 #define V2STRING "HEADER,CLIENT_LIST,Common Name,Real Address,Virtual Address,Bytes Received,Bytes Sent,Connected Since,Connected Since (time_t)\n"
34 #define V3STRING "HEADER CLIENT_LIST Common Name Real Address Virtual Address Bytes Received Bytes Sent Connected Since Connected Since (time_t)\n"
35 #define V4STRING "HEADER,CLIENT_LIST,Common Name,Real Address,Virtual Address,Bytes Received,Bytes Sent,Connected Since,Connected Since (time_t),Username\n"
36 #define VSSTRING "OpenVPN STATISTICS\n"
44 MULTI1 = 1, /* status-version 1 */
45 MULTI2, /* status-version 2 */
46 MULTI3, /* status-version 3 */
47 MULTI4, /* status-version 4 */
48 SINGLE = 10 /* currently no versions for single mode, maybe in the future */
52 typedef struct vpn_status_s vpn_status_t;
54 static vpn_status_t **vpn_list = NULL;
55 static int vpn_num = 0;
57 static _Bool new_naming_schema = 0;
58 static _Bool collect_compression = 1;
59 static _Bool collect_user_count = 0;
60 static _Bool collect_individual_users = 1;
62 static const char *config_keys[] =
65 "Compression", /* old, deprecated name */
66 "ImprovedNamingSchema",
69 "CollectIndividualUsers"
71 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
75 * copy-n-pasted from common.c - changed delim to "," */
76 static int openvpn_strsplit (char *string, char **fields, size_t size)
85 while ((fields[i] = strtok_r (ptr, ",", &saveptr)) != NULL)
95 } /* int openvpn_strsplit */
97 /* dispatches number of users */
98 static void numusers_submit (char *pinst, char *tinst, gauge_t value)
101 value_list_t vl = VALUE_LIST_INIT;
103 values[0].gauge = value;
106 vl.values_len = STATIC_ARRAY_SIZE (values);
107 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
108 sstrncpy (vl.plugin, "openvpn", sizeof (vl.plugin));
109 sstrncpy (vl.type, "users", sizeof (vl.type));
111 sstrncpy (vl.plugin_instance, pinst, sizeof (vl.plugin_instance));
113 sstrncpy (vl.type_instance, tinst, sizeof (vl.type_instance));
115 plugin_dispatch_values (&vl);
116 } /* void numusers_submit */
118 /* dispatches stats about traffic (TCP or UDP) generated by the tunnel per single endpoint */
119 static void iostats_submit (char *pinst, char *tinst, derive_t rx, derive_t tx)
122 value_list_t vl = VALUE_LIST_INIT;
124 values[0].derive = rx;
125 values[1].derive = tx;
127 /* NOTE ON THE NEW NAMING SCHEMA:
128 * using plugin_instance to identify each vpn config (and
129 * status) file; using type_instance to identify the endpoint
130 * host when in multimode, traffic or overhead when in single.
134 vl.values_len = STATIC_ARRAY_SIZE (values);
135 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
136 sstrncpy (vl.plugin, "openvpn", sizeof (vl.plugin));
138 sstrncpy (vl.plugin_instance, pinst,
139 sizeof (vl.plugin_instance));
140 sstrncpy (vl.type, "if_octets", sizeof (vl.type));
142 sstrncpy (vl.type_instance, tinst, sizeof (vl.type_instance));
144 plugin_dispatch_values (&vl);
145 } /* void traffic_submit */
147 /* dispatches stats about data compression shown when in single mode */
148 static void compression_submit (char *pinst, char *tinst,
149 derive_t uncompressed, derive_t compressed)
152 value_list_t vl = VALUE_LIST_INIT;
154 values[0].derive = uncompressed;
155 values[1].derive = compressed;
158 vl.values_len = STATIC_ARRAY_SIZE (values);
159 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
160 sstrncpy (vl.plugin, "openvpn", sizeof (vl.plugin));
162 sstrncpy (vl.plugin_instance, pinst,
163 sizeof (vl.plugin_instance));
164 sstrncpy (vl.type, "compression", sizeof (vl.type));
166 sstrncpy (vl.type_instance, tinst, sizeof (vl.type_instance));
168 plugin_dispatch_values (&vl);
169 } /* void compression_submit */
171 static int single_read (char *name, FILE *fh)
175 const int max_fields = STATIC_ARRAY_SIZE (fields);
176 int fields_num, read = 0;
178 derive_t link_rx, link_tx;
179 derive_t tun_rx, tun_tx;
180 derive_t pre_compress, post_compress;
181 derive_t pre_decompress, post_decompress;
182 derive_t overhead_rx, overhead_tx;
193 while (fgets (buffer, sizeof (buffer), fh) != NULL)
195 fields_num = openvpn_strsplit (buffer, fields, max_fields);
197 /* status file is generated by openvpn/sig.c:print_status()
198 * http://svn.openvpn.net/projects/openvpn/trunk/openvpn/sig.c
200 * The line we're expecting has 2 fields. We ignore all lines
201 * with more or less fields.
208 if (strcmp (fields[0], "TUN/TAP read bytes") == 0)
210 /* read from the system and sent over the tunnel */
211 tun_tx = atoll (fields[1]);
213 else if (strcmp (fields[0], "TUN/TAP write bytes") == 0)
215 /* read from the tunnel and written in the system */
216 tun_rx = atoll (fields[1]);
218 else if (strcmp (fields[0], "TCP/UDP read bytes") == 0)
220 link_rx = atoll (fields[1]);
222 else if (strcmp (fields[0], "TCP/UDP write bytes") == 0)
224 link_tx = atoll (fields[1]);
226 else if (strcmp (fields[0], "pre-compress bytes") == 0)
228 pre_compress = atoll (fields[1]);
230 else if (strcmp (fields[0], "post-compress bytes") == 0)
232 post_compress = atoll (fields[1]);
234 else if (strcmp (fields[0], "pre-decompress bytes") == 0)
236 pre_decompress = atoll (fields[1]);
238 else if (strcmp (fields[0], "post-decompress bytes") == 0)
240 post_decompress = atoll (fields[1]);
244 iostats_submit (name, "traffic", link_rx, link_tx);
246 /* we need to force this order to avoid negative values with these unsigned */
247 overhead_rx = (((link_rx - pre_decompress) + post_decompress) - tun_rx);
248 overhead_tx = (((link_tx - post_compress) + pre_compress) - tun_tx);
250 iostats_submit (name, "overhead", overhead_rx, overhead_tx);
252 if (collect_compression)
254 compression_submit (name, "data_in", post_decompress, pre_decompress);
255 compression_submit (name, "data_out", pre_compress, post_compress);
261 } /* int single_read */
263 /* for reading status version 1 */
264 static int multi1_read (char *name, FILE *fh)
268 int fields_num, found_header = 0;
269 long long sum_users = 0;
271 /* read the file until the "ROUTING TABLE" line is found (no more info after) */
272 while (fgets (buffer, sizeof (buffer), fh) != NULL)
274 if (strcmp (buffer, "ROUTING TABLE\n") == 0)
277 if (strcmp (buffer, V1STRING) == 0)
283 /* skip the first lines until the client list section is found */
284 if (found_header == 0)
285 /* we can't start reading data until this string is found */
288 fields_num = openvpn_strsplit (buffer,
289 fields, STATIC_ARRAY_SIZE (fields));
293 if (collect_user_count)
294 /* If so, sum all users, ignore the individuals*/
298 if (collect_individual_users)
300 if (new_naming_schema)
302 iostats_submit (name, /* vpn instance */
303 fields[0], /* "Common Name" */
304 atoll (fields[2]), /* "Bytes Received" */
305 atoll (fields[3])); /* "Bytes Sent" */
309 iostats_submit (fields[0], /* "Common Name" */
310 NULL, /* unused when in multimode */
311 atoll (fields[2]), /* "Bytes Received" */
312 atoll (fields[3])); /* "Bytes Sent" */
320 if (collect_user_count)
321 numusers_submit(name, name, sum_users);
324 } /* int multi1_read */
326 /* for reading status version 2 */
327 static int multi2_read (char *name, FILE *fh)
331 const int max_fields = STATIC_ARRAY_SIZE (fields);
332 int fields_num, read = 0;
333 long long sum_users = 0;
335 while (fgets (buffer, sizeof (buffer), fh) != NULL)
337 fields_num = openvpn_strsplit (buffer, fields, max_fields);
339 /* status file is generated by openvpn/multi.c:multi_print_status()
340 * http://svn.openvpn.net/projects/openvpn/trunk/openvpn/multi.c
342 * The line we're expecting has 8 fields. We ignore all lines
343 * with more or less fields.
348 if (strcmp (fields[0], "CLIENT_LIST") != 0)
351 if (collect_user_count)
352 /* If so, sum all users, ignore the individuals*/
356 if (collect_individual_users)
358 if (new_naming_schema)
360 /* plugin inst = file name, type inst = fields[1] */
361 iostats_submit (name, /* vpn instance */
362 fields[1], /* "Common Name" */
363 atoll (fields[4]), /* "Bytes Received" */
364 atoll (fields[5])); /* "Bytes Sent" */
368 /* plugin inst = fields[1], type inst = "" */
369 iostats_submit (fields[1], /* "Common Name" */
370 NULL, /* unused when in multimode */
371 atoll (fields[4]), /* "Bytes Received" */
372 atoll (fields[5])); /* "Bytes Sent" */
379 if (collect_user_count)
381 numusers_submit(name, name, sum_users);
386 } /* int multi2_read */
388 /* for reading status version 3 */
389 static int multi3_read (char *name, FILE *fh)
393 const int max_fields = STATIC_ARRAY_SIZE (fields);
394 int fields_num, read = 0;
395 long long sum_users = 0;
397 while (fgets (buffer, sizeof (buffer), fh) != NULL)
399 fields_num = strsplit (buffer, fields, max_fields);
401 /* status file is generated by openvpn/multi.c:multi_print_status()
402 * http://svn.openvpn.net/projects/openvpn/trunk/openvpn/multi.c
404 * The line we're expecting has 12 fields. We ignore all lines
405 * with more or less fields.
407 if (fields_num != 12)
413 if (strcmp (fields[0], "CLIENT_LIST") != 0)
416 if (collect_user_count)
417 /* If so, sum all users, ignore the individuals*/
422 if (collect_individual_users)
424 if (new_naming_schema)
426 iostats_submit (name, /* vpn instance */
427 fields[1], /* "Common Name" */
428 atoll (fields[4]), /* "Bytes Received" */
429 atoll (fields[5])); /* "Bytes Sent" */
433 iostats_submit (fields[1], /* "Common Name" */
434 NULL, /* unused when in multimode */
435 atoll (fields[4]), /* "Bytes Received" */
436 atoll (fields[5])); /* "Bytes Sent" */
444 if (collect_user_count)
446 numusers_submit(name, name, sum_users);
451 } /* int multi3_read */
453 /* for reading status version 4 */
454 static int multi4_read (char *name, FILE *fh)
458 const int max_fields = STATIC_ARRAY_SIZE (fields);
459 int fields_num, read = 0;
460 long long sum_users = 0;
462 while (fgets (buffer, sizeof (buffer), fh) != NULL)
464 fields_num = openvpn_strsplit (buffer, fields, max_fields);
466 /* status file is generated by openvpn/multi.c:multi_print_status()
467 * http://svn.openvpn.net/projects/openvpn/trunk/openvpn/multi.c
469 * The line we're expecting has 9 fields. We ignore all lines
470 * with more or less fields.
476 if (strcmp (fields[0], "CLIENT_LIST") != 0)
480 if (collect_user_count)
481 /* If so, sum all users, ignore the individuals*/
485 if (collect_individual_users)
487 if (new_naming_schema)
489 /* plugin inst = file name, type inst = fields[1] */
490 iostats_submit (name, /* vpn instance */
491 fields[1], /* "Common Name" */
492 atoll (fields[4]), /* "Bytes Received" */
493 atoll (fields[5])); /* "Bytes Sent" */
497 /* plugin inst = fields[1], type inst = "" */
498 iostats_submit (fields[1], /* "Common Name" */
499 NULL, /* unused when in multimode */
500 atoll (fields[4]), /* "Bytes Received" */
501 atoll (fields[5])); /* "Bytes Sent" */
508 if (collect_user_count)
510 numusers_submit(name, name, sum_users);
515 } /* int multi4_read */
518 static int openvpn_read (void)
525 /* call the right read function for every status entry in the list */
526 for (i = 0; i < vpn_num; i++)
530 fh = fopen (vpn_list[i]->file, "r");
534 WARNING ("openvpn plugin: fopen(%s) failed: %s", vpn_list[i]->file,
535 sstrerror (errno, errbuf, sizeof (errbuf)));
540 switch (vpn_list[i]->version)
543 vpn_read = single_read(vpn_list[i]->name, fh);
547 vpn_read = multi1_read(vpn_list[i]->name, fh);
551 vpn_read = multi2_read(vpn_list[i]->name, fh);
555 vpn_read = multi3_read(vpn_list[i]->name, fh);
559 vpn_read = multi4_read(vpn_list[i]->name, fh);
567 return (read ? 0 : -1);
568 } /* int openvpn_read */
570 static int version_detect (const char *filename)
576 /* Sanity checking. We're called from the config handling routine, so
577 * better play it save. */
578 if ((filename == NULL) || (*filename == 0))
581 fh = fopen (filename, "r");
585 WARNING ("openvpn plugin: Unable to read \"%s\": %s", filename,
586 sstrerror (errno, errbuf, sizeof (errbuf)));
590 /* now search for the specific multimode data format */
591 while ((fgets (buffer, sizeof (buffer), fh)) != NULL)
593 /* we look at the first line searching for SINGLE mode configuration */
594 if (strcmp (buffer, VSSTRING) == 0)
596 DEBUG ("openvpn plugin: found status file version SINGLE");
600 /* searching for multi version 1 */
601 else if (strcmp (buffer, V1STRING) == 0)
603 DEBUG ("openvpn plugin: found status file version MULTI1");
607 /* searching for multi version 2 */
608 else if (strcmp (buffer, V2STRING) == 0)
610 DEBUG ("openvpn plugin: found status file version MULTI2");
614 /* searching for multi version 3 */
615 else if (strcmp (buffer, V3STRING) == 0)
617 DEBUG ("openvpn plugin: found status file version MULTI3");
621 /* searching for multi version 4 */
622 else if (strcmp (buffer, V4STRING) == 0)
624 DEBUG ("openvpn plugin: found status file version MULTI4");
632 /* This is only reached during configuration, so complaining to
633 * the user is in order. */
634 NOTICE ("openvpn plugin: %s: Unknown file format, please "
635 "report this as bug. Make sure to include "
636 "your status file, so the plugin can "
637 "be adapted.", filename);
643 } /* int version_detect */
645 static int openvpn_config (const char *key, const char *value)
647 if (strcasecmp ("StatusFile", key) == 0)
649 char *status_file, *status_name, *filename;
650 int status_version, i;
653 /* try to detect the status file format */
654 status_version = version_detect (value);
656 if (status_version == 0)
658 WARNING ("openvpn plugin: unable to detect status version, \
659 discarding status file \"%s\".", value);
663 status_file = sstrdup (value);
664 if (status_file == NULL)
667 WARNING ("openvpn plugin: sstrdup failed: %s",
668 sstrerror (errno, errbuf, sizeof (errbuf)));
672 /* it determines the file name as string starting at location filename + 1 */
673 filename = strrchr (status_file, (int) '/');
674 if (filename == NULL)
676 /* status_file is already the file name only */
677 status_name = status_file;
681 /* doesn't waste memory, uses status_file starting at filename + 1 */
682 status_name = filename + 1;
685 /* scan the list looking for a clone */
686 for (i = 0; i < vpn_num; i++)
688 if (strcasecmp (vpn_list[i]->name, status_name) == 0)
690 WARNING ("openvpn plugin: status filename \"%s\" "
691 "already used, please choose a "
692 "different one.", status_name);
698 /* create a new vpn element since file, version and name are ok */
699 temp = (vpn_status_t *) malloc (sizeof (vpn_status_t));
703 ERROR ("openvpn plugin: malloc failed: %s",
704 sstrerror (errno, errbuf, sizeof (errbuf)));
708 temp->file = status_file;
709 temp->version = status_version;
710 temp->name = status_name;
712 vpn_list = (vpn_status_t **) realloc (vpn_list, (vpn_num + 1) * sizeof (vpn_status_t *));
713 if (vpn_list == NULL)
716 ERROR ("openvpn plugin: realloc failed: %s",
717 sstrerror (errno, errbuf, sizeof (errbuf)));
724 vpn_list[vpn_num] = temp;
727 DEBUG ("openvpn plugin: status file \"%s\" added", temp->file);
729 } /* if (strcasecmp ("StatusFile", key) == 0) */
730 else if ((strcasecmp ("CollectCompression", key) == 0)
731 || (strcasecmp ("Compression", key) == 0)) /* old, deprecated name */
733 if (IS_FALSE (value))
734 collect_compression = 0;
736 collect_compression = 1;
737 } /* if (strcasecmp ("CollectCompression", key) == 0) */
738 else if (strcasecmp ("ImprovedNamingSchema", key) == 0)
742 DEBUG ("openvpn plugin: using the new naming schema");
743 new_naming_schema = 1;
747 new_naming_schema = 0;
749 } /* if (strcasecmp ("ImprovedNamingSchema", key) == 0) */
750 else if (strcasecmp("CollectUserCount", key) == 0)
753 collect_user_count = 1;
755 collect_user_count = 0;
756 } /* if (strcasecmp("CollectUserCount", key) == 0) */
757 else if (strcasecmp("CollectIndividualUsers", key) == 0)
759 if (IS_FALSE (value))
760 collect_individual_users = 0;
762 collect_individual_users = 1;
763 } /* if (strcasecmp("CollectIndividualUsers", key) == 0) */
770 } /* int openvpn_config */
772 /* shutdown callback */
773 static int openvpn_shutdown (void)
777 for (i = 0; i < vpn_num; i++)
779 sfree (vpn_list[i]->file);
786 } /* int openvpn_shutdown */
788 static int openvpn_init (void)
790 if (!collect_individual_users
791 && !collect_compression
792 && !collect_user_count)
794 WARNING ("OpenVPN plugin: Neither `CollectIndividualUsers', "
795 "`CollectCompression', nor `CollectUserCount' is true. There's no "
796 "data left to collect.");
800 plugin_register_read ("openvpn", openvpn_read);
801 plugin_register_shutdown ("openvpn", openvpn_shutdown);
804 } /* int openvpn_init */
806 void module_register (void)
808 plugin_register_config ("openvpn", openvpn_config,
809 config_keys, config_keys_num);
810 plugin_register_init ("openvpn", openvpn_init);
811 } /* void module_register */
813 /* vim: set sw=2 ts=2 : */