New netfilter target to trigger LED devices
PATCH v2 1/2 New netfilter target to trigger LED devices
Add a new "LED" target to iptables, which allows LEDs to blink in response to matching rules.
---
Okay, here's version two of the patch incorporating all Jan's suggestions.
Changes since the last post:
- Moved xt_led_info into separate .h file, shared between the kernel and iptables (Jan, please advise if you would prefer this done differently.)
- Moved usage example from code comments to iptables manpage
- Added --led-always-blink option
- Removed LED_init() as everything is already initialised to zero
- Replaced check_inverse() with param_act(P_NO_INVERT)
- atoi() -> strtoul()
- Math replaced with strlen("netfilter-") for clarity
- Changed quoting in LED_save() to double quotes
- xtables_target.userspacesize fixed
- Various coding style fixes
- Moved usage example from code comments to iptables manpage
- manpage formatting fixes and --led-always-blink added
extensions/libxt_LED.c new file +158 -0
@@ -0,0 +1,158 @@ +/* +* libxt_LED.c - shared library add-on to iptables to add customized LED +* trigger support. +* +* (C) 2008 Adam Nielsen <[email protected]> +* +* This program is free software; you can redistribute it and/or modify +* it under the terms of the GNU General Public License version 2 as +* published by the Free Software Foundation. +* +*/ + +#include <stdio.h> +#include <string.h> +#include <stdlib.h> +#include <getopt.h> +#include <stddef.h> + +#include <xtables.h> + +#include <linux/netfilter/xt_LED.h> + +static const struct option LED_opts[] = { + { .name ="led-trigger-id" , .has_arg =1 , .val ='i' }, + { .name ="led-delay" , .has_arg =1 , .val ='d' }, + { .name ="led-always-blink" , .has_arg =0 , .val ='a' }, + { .name =NULL } +}; + +static void LED_help (void ) +{ +printf ( +"LED target options:\n" +"--led-trigger-id name suffix for led trigger name\n" +"--led-delay ms leave the LED on for this number of\n" +" milliseconds after triggering.\n" +"--led-always-blink blink on arriving packets, even if\n" +" the LED is already on.\n" + ); +} + +static int LED_parse (int c,char **argv,int invert,unsigned int *flags, +const void *entry,struct xt_entry_target **target) +{ +struct xt_led_info *led = (struct xt_led_info *)(*target)->data; + +switch (c) { +case 'i' : +param_act (P_NO_INVERT ,"LED" ,"--led-trigger-id" , invert); + +if (strlen ("netfilter-" ) +strlen (optarg) >sizeof (led->id)) +exit_error (PARAMETER_PROBLEM , +"--led-trigger-id must be 16 chars or less" ); + +if (optarg[0 ] =='\0' ) +exit_error (PARAMETER_PROBLEM , +"--led-trigger-id cannot be blank" ); + +/* "netfilter-" + 16 char id == 26 == sizeof(led->id) */ +strcpy (led->id,"netfilter-" ); +strcat (led->id, optarg); + *flags =1 ; +return 1 ; + +case 'd' : +param_act (P_NO_INVERT ,"LED" ,"--led-delay" , invert); + +if (strncasecmp (optarg,"inf" ,3 ) ==0 ) + led->delay =-1 ; +else + led->delay =strtoul (optarg,NULL ,0 ); + +return 1 ; + +case 'a' : +if (!invert) + led->always_blink =1 ; + +return 1 ; + + } +return 0 ; +} + +static void LED_final_check (unsigned int flags) +{ +if (!flags) +exit_error (PARAMETER_PROBLEM , +"--led-trigger-id must be specified" ); +} + +static void LED_print (const void *ip,const struct xt_entry_target *target, +int numeric) +{ +const struct xt_led_info *led = (const struct xt_led_info *)target->data; +const char *id = led->id +strlen ("netfilter-" );/* trim off prefix */ + +printf ("led-trigger-id:\"" ); +/* Escape double quotes and backslashes in the ID */ +while (*id) { +if ((*id =='"' ) || (*id =='\\' )) +printf ("\\" ); +printf ("%c" , *id++); + } +printf ("\" " ); + +if (led->delay ==-1 ) +printf ("led-delay:inf " ); +else +printf ("led-delay:%dms " , led->delay); + +if (led->always_blink) +printf ("led-always-blink " ); +} + +static void LED_save (const void *ip,const struct xt_entry_target *target) +{ +const struct xt_led_info *led = (const struct xt_led_info *)target->data; +const char *id = led->id +strlen ("netfilter-" );/* trim off prefix */ + +printf ("--led-trigger-id \"" ); +/* Escape double quotes and backslashes in the ID */ +while (*id) { +if ((*id =='"' ) || (*id =='\\' )) +printf ("\\" ); +printf ("%c" , *id++); + } +printf ("\" " ); + +/* Only print the delay if it's not zero (the default) */ +if (led->delay >0 ) +printf ("--led-delay %d " , led->delay); +else if (led->delay ==-1 ) +printf ("--led-delay inf " ); + +/* Only print always_blink if it's not set to the default */ +if (led->always_blink) +printf ("--led-always-blink " ); +} + +static struct xtables_target led_tg_reg = { + .family =PF_UNSPEC , + .name ="LED" , + .version =XTABLES_VERSION , + .size =XT_ALIGN (sizeof (struct xt_led_info )), + .userspacesize = offsetof(struct xt_led_info , internal_data), + .help = LED_help, + .parse = LED_parse, + .final_check = LED_final_check, + .extra_opts = LED_opts, + .print = LED_print, + .save = LED_save, +}; + +void _init (void ) +{ +xtables_register_target (&led_tg_reg); +}
extensions/libxt_LED.man new file +30 -0
@@ -0,0 +1,30 @@ +This creates an LED-trigger that can then be attached to system indicator +lights, to blink or illuminate them when certain packets pass through the +system. One example might be to light up an LED for a few minutes every time +an SSH connection is made to the local machine. The following options control +the trigger behaviour: +.TP +\fB--led-trigger-id\fP \fIname\fP +This is the name given to the LED trigger. The actual name of the trigger +will be prefixed with "netfilter-". +.TP +\fB--led-delay\fP \fIms\fP +This indicates how long (in milliseconds) the LED should be left illuminated +when a packet arrives before being switched off again. The default is 0 +(blink as fast as possible.) The special value \fIinf\fP can be given to +leave the LED on permanently once activated. (In this case the trigger will +need to be manually detached and reattached to the LED device to switch it +off again.) +.TP +\fB--led-always-blink\fP +Always make the LED blink on packet arrival, even if the LED is already on. +This allows notification of new packets even with long delay values (which +otherwise would result in a silent prolonging of the delay time.) +.TP +Example: +.TP +Create an LED trigger for incoming SSH traffic: +iptables -A INPUT -p tcp --dport 22 -j LED --led-trigger-id ssh +.TP +Then attach the new trigger to an LED: +echo netfilter-ssh > /sys/class/leds/<ledname>/trigger
include/linux/netfilter/xt_LED.h new file +12 -0
@@ -0,0 +1,12 @@ +#ifndef _XT_LED_H +#define _XT_LED_H + +struct xt_led_info { +char id[26 ];/* Unique ID for this trigger in the LED class */ +__u32 delay;/* Delay until LED is switched off after trigger */ +__u8 always_blink;/* Blink even if the LED is already on */ + +void *internal_data;/* Kernel data used in the module */ +}; + +#endif /* _XT_LED_H */
include/linux/netfilter/xt_LED.h line 10
Quoted 12 lines · Adam Nielsen
+++
b/include/linux/netfilter/xt_LED.hinclude/linux/netfilter/xt_LED.h new file +10
-0@@ -0,0 +1,12 @@ +#ifndef _XT_LED_H +#define _XT_LED_H + +struct xt_led_info { +char id[26 ];/* Unique ID for this trigger in the LED class */ +__u32 delay;/* Delay until LED is switched off after trigger */ +__u8 always_blink;/* Blink even if the LED is already on */ + +void *internal_data;/* Kernel data used in the module */ +};
You now have an alignment problem, and need at least
void *internal_data __attribute__((aligned(8)))
as explained in the PDF. Ultimatively, these shouls be reordered to accomodate for gaps (see doc).
Also, why is it 26?
Quoted 9 lines
include/linux/netfilter/xt_LED.h line 10
Quoted 7 lines
include/linux/netfilter/xt_LED.h new file +7
-0+struct xt_led_info { +char id[26 ];/* Unique ID for this trigger in the LED class */ +__u32 delay;/* Delay until LED is switched off after trigger */ +__u8 always_blink;/* Blink even if the LED is already on */ + +void *internal_data;/* Kernel data used in the module */ +};You now have an alignment problem, and need at least
Quoted 5 lines
void *internal_data __attribute__((aligned(8)))as explained in the PDF. Ultimatively, these shouls be reordered to accomodate for gaps (see doc).
Also, why is it 26?
Ah bummer, I forgot about that. Is this the best order? If I'm understanding correctly this order shouldn't need member alignment.
struct xt_led_info {
void *internal_data;
__u32 delay;
__u8 always_blink;
char id[26];
};The id[26] is for a 16 char ID + the 10 digit "netfilter-" prefix. Actually that's a good point, it needs to be 27 to accomodate the terminating NULL. At any rate, I'm not sure of the best way to describe that, without using #define. What do you suggest?
/* strlen("netfilter-") + 16 char user-definable name */
#define LED_TRIGGER_ID_LENGTH (10 + 16)
char id[LED_TRIGGER_ID_LENGTH + 1];In that case it might be worth #defining the 16 char part separately, so that it can be used in the parameter verification code too. Let me know what you think.
Thanks,
Adam.
Pablo Neira Ayuso
maintainerQuoted 2 lines · Adam Nielsen
Add a new "LED" target to iptables, which allows LEDs to blink in response to matching rules.
I did not have a look in deep into your patch but the first questions that comes to my mind is, how many people can benefit from this LED target? What is its real application?
Signature · 1 line
"Los honestos son inadaptados sociales" -- Les Luthiers
Quoted 9 lines · Adam Nielsen
Quoted 7 lines
You now have an alignment problem, and need at least
void *internal_data __attribute__((aligned(8)))as explained in the PDF. Ultimatively, these shouls be reordered to accomodate for gaps (see doc).
Also, why is it 26?
Ah bummer, I forgot about that. Is this the best order?
No, that will break offsetof() in .userspacesize, as it will become 0.
Quoted 10 lines
If I'm
understanding correctly this order shouldn't need member alignment.struct xt_led_info { void *internal_data; __u32 delay; __u8 always_blink; char id[26]; };
Quoted 4 lines
The id[26] is for a 16 char ID + the 10 digit "netfilter-" prefix. Actually that's a good point, it needs to be 27 to accomodate the terminating NULL. At any rate, I'm not sure of the best way to describe that, without using #define. What do you suggest?
struct xt_led_tginfo {
char id[27];
__u8 always_blink;
__u32 delay;
void *internal_data __attribute__((aligned(8)));
};add id - 27 bytes.
add always_blink - 28 bytes.
28? That's good for alignment of a u32. Add delay. 32? That's good for alignment of a potentially-ptr64. And it's solved, even without thinking of NULs or prefixes.
Quoted 9 lines
/*
strlen("netfilter-")+ 16 char user-definable name */ #defineLED_TRIGGER_ID_LENGTH(10 + 16)char id[LED_TRIGGER_ID_LENGTH + 1];
In that case it might be worth #defining the 16 char part separately, so that it can be used in the parameter verification code too. Let me know what you think.
Just use [27] - the struct will be hardcoded forever,
and putting #defines somewhere gives a wrong illusion it might be changeable.
Quoted 6 lines
Quoted 2 lines
Add a new "LED" target to iptables, which allows LEDs to blink in response to matching rules.
I did not have a look in deep into your patch but the first questions that comes to my mind is, how many people can benefit from this LED target? What is its real application?
Well granted its purpose is somewhat trivial, but if you do have devices on your system that appear in the LED class it could be quite useful.
Linux running on an embedded router for example, could blink specific LEDs on the device's front panel depending on the traffic being routed. You wouldn't be limited to one LED per interface either, you could have an LED dedicated to OpenVPN traffic only for instance. Or you could have a couple of LEDs for different classes of traffic, which would tell you at a glance whether your device is being hammered by HTTP traffic or BitTorrent transfers.
Hopefully once more devices start appearing in the LED class, having a target like this will help people put them to good use.
Cheers,
Adam.
Quoted 4 lines
Quoted 1 line
Ah bummer, I forgot about that. Is this the best order?
No, that will break
offsetof()in .userspacesize, as it will become 0.
Oh, double bummer, I forgot about that also.
Quoted 4 lines
add id - 27 bytes.
addalways_blink- 28 bytes.
28? That's good for alignment of a u32. Add delay. 32? That's good for alignment of a potentially-ptr64.
Ah okay, that works out quite well then.
Quoted 1 line
And it's solved, even without thinking of NULs or prefixes.
Sorry, I thought you meant "please explain where the 26 comes from"
Quoted 2 lines
Just use [27] - the struct will be hardcoded forever,
and putting #defines somewhere gives a wrong illusion it might be changeable.
Will do.
Cheers,
Adam.
Quoted 19 lines · Adam Nielsen
Quoted 6 lines
Quoted 2 lines
Add a new "LED" target to iptables, which allows LEDs to blink in response to matching rules.
I did not have a look in deep into your patch but the first questions that comes to my mind is, how many people can benefit from this LED target? What is its real application?
Well granted its purpose is somewhat trivial, but if you do have devices on your system that appear in the LED class it could be quite useful.
Linux running on an embedded router for example, could blink specific LEDs on the device's front panel depending on the traffic being routed. You wouldn't be limited to one LED per interface either, you could have an LED dedicated to OpenVPN traffic only for instance. Or you could have a couple of LEDs for different classes of traffic, which would tell you at a glance whether your device is being hammered by HTTP traffic or BitTorrent transfers.
Quoted 2 lines
Hopefully once more devices start appearing in the LED class, having a target like this will help people put them to good use.
Well, its better than the patch from one or two years ago that added LED-triggers to netif_receive_skb() or dev_queue_xmit() :)
I don't have a problem taking this patch if the LED-people agree that this is a good approach.
Quoted 4 lines · Adam Nielsen
Quoted 2 lines
And it's solved, even without thinking of NULs or prefixes.
Sorry, I thought you meant "please explain where the 26 comes from"
Yeah I really *did* wonder why it was 26... because the "perfect layout" was only attainable with 27, and I would not see why LED names were limited to 16 chars, unless of course, the LED system has such a limitation.