2 * collectd - src/iptables.c
3 * Copyright (C) 2007 Sjoerd van der Berg
4 * Copyright (C) 2007-2010 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; either version 2 of the License, or (at your
10 * option) any later version.
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 * Sjoerd van der Berg <harekiet at users.sourceforge.net>
23 * Florian Forster <octo at collectd.org>
24 * Marco Chiappero <marco at absence.it>
32 #include <libiptc/libip6tc.h>
33 #include <libiptc/libiptc.h>
35 #ifdef HAVE_SYS_CAPABILITY_H
36 #include <sys/capability.h>
40 * iptc_handle_t was available before libiptc was officially available as a
41 * shared library. Note, that when the shared lib was introduced, the API and
42 * ABI have changed slightly:
43 * 'iptc_handle_t' used to be 'struct iptc_handle *' and most functions used
44 * 'iptc_handle_t *' as an argument. Now, most functions use 'struct
45 * iptc_handle *' (thus removing one level of pointer indirection).
47 * HAVE_IPTC_HANDLE_T is used to determine which API ought to be used. While
48 * this is somewhat hacky, I didn't find better way to solve that :-/
51 #ifndef HAVE_IPTC_HANDLE_T
52 typedef struct iptc_handle iptc_handle_t;
54 #ifndef HAVE_IP6TC_HANDLE_T
55 typedef struct ip6tc_handle ip6tc_handle_t;
59 * (Module-)Global variables
63 * Config format should be `Chain table chainname',
64 * e. g. `Chain mangle incoming'
66 static const char *config_keys[] = {"Chain", "Chain6"};
67 static int config_keys_num = STATIC_ARRAY_SIZE(config_keys);
68 enum protocol_version_e { IPV4, IPV6 };
69 typedef enum protocol_version_e protocol_version_t;
72 * Each table/chain combo that will be queried goes into this list
74 #ifndef XT_TABLE_MAXNAMELEN
75 #define XT_TABLE_MAXNAMELEN 32
78 protocol_version_t ip_version;
79 char table[XT_TABLE_MAXNAMELEN];
80 char chain[XT_TABLE_MAXNAMELEN];
85 enum { RTYPE_NUM, RTYPE_COMMENT, RTYPE_COMMENT_ALL } rule_type;
89 static ip_chain_t **chain_list;
92 static int iptables_config(const char *key, const char *value) {
94 protocol_version_t ip_version = 0;
96 if (strcasecmp(key, "Chain") == 0)
98 else if (strcasecmp(key, "Chain6") == 0)
103 ip_chain_t temp = {0};
104 ip_chain_t *final, **list;
114 value_copy = strdup(value);
115 if (value_copy == NULL) {
116 ERROR("strdup failed: %s", STRERRNO);
121 * Time to fill the temp element
122 * Examine value string, it should look like:
123 * Chain[6] <table> <chain> [<comment|num> [name]]
126 /* set IPv4 or IPv6 */
127 temp.ip_version = ip_version;
129 /* Chain <table> <chain> [<comment|num> [name]] */
130 fields_num = strsplit(value_copy, fields, 4);
131 if (fields_num < 2) {
139 table_len = strlen(table) + 1;
140 if ((unsigned int)table_len > sizeof(temp.table)) {
141 ERROR("Table `%s' too long.", table);
145 sstrncpy(temp.table, table, table_len);
147 chain_len = strlen(chain) + 1;
148 if ((unsigned int)chain_len > sizeof(temp.chain)) {
149 ERROR("Chain `%s' too long.", chain);
153 sstrncpy(temp.chain, chain, chain_len);
155 if (fields_num >= 3) {
156 char *comment = fields[2];
157 int rule = atoi(comment);
160 temp.rule.num = rule;
161 temp.rule_type = RTYPE_NUM;
163 temp.rule.comment = strdup(comment);
164 if (temp.rule.comment == NULL) {
168 temp.rule_type = RTYPE_COMMENT;
171 temp.rule_type = RTYPE_COMMENT_ALL;
175 sstrncpy(temp.name, fields[3], sizeof(temp.name));
182 list = realloc(chain_list, (chain_num + 1) * sizeof(ip_chain_t *));
184 ERROR("realloc failed: %s", STRERRNO);
185 sfree(temp.rule.comment);
190 final = malloc(sizeof(*final));
192 ERROR("malloc failed: %s", STRERRNO);
193 sfree(temp.rule.comment);
196 memcpy(final, &temp, sizeof(temp));
197 chain_list[chain_num] = final;
200 DEBUG("Chain #%i: table = %s; chain = %s;", chain_num, final->table,
204 } /* int iptables_config */
206 static int submit6_match(const struct ip6t_entry_match *match,
207 const struct ip6t_entry *entry,
208 const ip_chain_t *chain, int rule_num) {
210 value_list_t vl = VALUE_LIST_INIT;
212 /* Select the rules to collect */
213 if (chain->rule_type == RTYPE_NUM) {
214 if (chain->rule.num != rule_num)
217 if (strcmp(match->u.user.name, "comment") != 0)
219 if ((chain->rule_type == RTYPE_COMMENT) &&
220 (strcmp(chain->rule.comment, (char *)match->data) != 0))
224 sstrncpy(vl.plugin, "ip6tables", sizeof(vl.plugin));
226 status = snprintf(vl.plugin_instance, sizeof(vl.plugin_instance), "%s-%s",
227 chain->table, chain->chain);
228 if ((status < 1) || ((unsigned int)status >= sizeof(vl.plugin_instance)))
231 if (chain->name[0] != '\0') {
232 sstrncpy(vl.type_instance, chain->name, sizeof(vl.type_instance));
234 if (chain->rule_type == RTYPE_NUM)
235 snprintf(vl.type_instance, sizeof(vl.type_instance), "%i",
238 sstrncpy(vl.type_instance, (char *)match->data, sizeof(vl.type_instance));
241 sstrncpy(vl.type, "ipt_bytes", sizeof(vl.type));
242 vl.values = &(value_t){.derive = (derive_t)entry->counters.bcnt};
244 plugin_dispatch_values(&vl);
246 sstrncpy(vl.type, "ipt_packets", sizeof(vl.type));
247 vl.values = &(value_t){.derive = (derive_t)entry->counters.pcnt};
248 plugin_dispatch_values(&vl);
251 } /* int submit6_match */
253 /* This needs to return `int' for IPT_MATCH_ITERATE to work. */
254 static int submit_match(const struct ipt_entry_match *match,
255 const struct ipt_entry *entry, const ip_chain_t *chain,
258 value_list_t vl = VALUE_LIST_INIT;
260 /* Select the rules to collect */
261 if (chain->rule_type == RTYPE_NUM) {
262 if (chain->rule.num != rule_num)
265 if (strcmp(match->u.user.name, "comment") != 0)
267 if ((chain->rule_type == RTYPE_COMMENT) &&
268 (strcmp(chain->rule.comment, (char *)match->data) != 0))
272 sstrncpy(vl.plugin, "iptables", sizeof(vl.plugin));
274 status = snprintf(vl.plugin_instance, sizeof(vl.plugin_instance), "%s-%s",
275 chain->table, chain->chain);
276 if ((status < 1) || ((unsigned int)status >= sizeof(vl.plugin_instance)))
279 if (chain->name[0] != '\0') {
280 sstrncpy(vl.type_instance, chain->name, sizeof(vl.type_instance));
282 if (chain->rule_type == RTYPE_NUM)
283 snprintf(vl.type_instance, sizeof(vl.type_instance), "%i",
286 sstrncpy(vl.type_instance, (char *)match->data, sizeof(vl.type_instance));
289 sstrncpy(vl.type, "ipt_bytes", sizeof(vl.type));
290 vl.values = &(value_t){.derive = (derive_t)entry->counters.bcnt};
292 plugin_dispatch_values(&vl);
294 sstrncpy(vl.type, "ipt_packets", sizeof(vl.type));
295 vl.values = &(value_t){.derive = (derive_t)entry->counters.pcnt};
296 plugin_dispatch_values(&vl);
299 } /* int submit_match */
301 /* ipv6 submit_chain */
302 static void submit6_chain(ip6tc_handle_t *handle, ip_chain_t *chain) {
303 const struct ip6t_entry *entry;
306 /* Find first rule for chain and use the iterate macro */
307 entry = ip6tc_first_rule(chain->chain, handle);
309 DEBUG("ip6tc_first_rule failed: %s", ip6tc_strerror(errno));
315 if (chain->rule_type == RTYPE_NUM) {
316 submit6_match(NULL, entry, chain, rule_num);
318 IP6T_MATCH_ITERATE(entry, submit6_match, entry, chain, rule_num);
321 entry = ip6tc_next_rule(entry, handle);
323 } /* while (entry) */
326 /* ipv4 submit_chain */
327 static void submit_chain(iptc_handle_t *handle, ip_chain_t *chain) {
328 const struct ipt_entry *entry;
331 /* Find first rule for chain and use the iterate macro */
332 entry = iptc_first_rule(chain->chain, handle);
334 DEBUG("iptc_first_rule failed: %s", iptc_strerror(errno));
340 if (chain->rule_type == RTYPE_NUM) {
341 submit_match(NULL, entry, chain, rule_num);
343 IPT_MATCH_ITERATE(entry, submit_match, entry, chain, rule_num);
346 entry = iptc_next_rule(entry, handle);
348 } /* while (entry) */
351 static int iptables_read(void) {
352 int num_failures = 0;
355 /* Init the iptc handle structure and query the correct table */
356 for (int i = 0; i < chain_num; i++) {
357 chain = chain_list[i];
360 DEBUG("iptables plugin: chain == NULL");
364 if (chain->ip_version == IPV4) {
365 #ifdef HAVE_IPTC_HANDLE_T
366 iptc_handle_t _handle;
367 iptc_handle_t *handle = &_handle;
369 *handle = iptc_init(chain->table);
371 iptc_handle_t *handle;
372 handle = iptc_init(chain->table);
376 ERROR("iptables plugin: iptc_init (%s) failed: %s", chain->table,
377 iptc_strerror(errno));
382 submit_chain(handle, chain);
384 } else if (chain->ip_version == IPV6) {
385 #ifdef HAVE_IP6TC_HANDLE_T
386 ip6tc_handle_t _handle;
387 ip6tc_handle_t *handle = &_handle;
389 *handle = ip6tc_init(chain->table);
391 ip6tc_handle_t *handle;
392 handle = ip6tc_init(chain->table);
395 ERROR("iptables plugin: ip6tc_init (%s) failed: %s", chain->table,
396 ip6tc_strerror(errno));
401 submit6_chain(handle, chain);
405 } /* for (i = 0 .. chain_num) */
407 return (num_failures < chain_num) ? 0 : -1;
408 } /* int iptables_read */
410 static int iptables_shutdown(void) {
411 for (int i = 0; i < chain_num; i++) {
412 if ((chain_list[i] != NULL) && (chain_list[i]->rule_type == RTYPE_COMMENT))
413 sfree(chain_list[i]->rule.comment);
414 sfree(chain_list[i]);
419 } /* int iptables_shutdown */
421 static int iptables_init(void) {
422 #if defined(HAVE_SYS_CAPABILITY_H) && defined(CAP_NET_ADMIN)
423 if (check_capability(CAP_NET_ADMIN) != 0) {
425 WARNING("iptables plugin: Running collectd as root, but the "
426 "CAP_NET_ADMIN capability is missing. The plugin's read "
427 "function will probably fail. Is your init system dropping "
430 WARNING("iptables plugin: collectd doesn't have the CAP_NET_ADMIN "
431 "capability. If you don't want to run collectd as root, try "
432 "running \"setcap cap_net_admin=ep\" on the collectd binary.");
436 } /* int iptables_init */
438 void module_register(void) {
439 plugin_register_config("iptables", iptables_config, config_keys,
441 plugin_register_init("iptables", iptables_init);
442 plugin_register_read("iptables", iptables_read);
443 plugin_register_shutdown("iptables", iptables_shutdown);
444 } /* void module_register */