netfilter: ebtables: do centralized size checking
[linux-2.6.git] / include / linux / netfilter_bridge / ebtables.h
1 /*
2  *  ebtables
3  *
4  *      Authors:
5  *      Bart De Schuymer                <bdschuym@pandora.be>
6  *
7  *  ebtables.c,v 2.0, April, 2002
8  *
9  *  This code is stongly inspired on the iptables code which is
10  *  Copyright (C) 1999 Paul `Rusty' Russell & Michael J. Neuling
11  */
12
13 #ifndef __LINUX_BRIDGE_EFF_H
14 #define __LINUX_BRIDGE_EFF_H
15 #include <linux/if.h>
16 #include <linux/netfilter_bridge.h>
17 #include <linux/if_ether.h>
18
19 #define EBT_TABLE_MAXNAMELEN 32
20 #define EBT_CHAIN_MAXNAMELEN EBT_TABLE_MAXNAMELEN
21 #define EBT_FUNCTION_MAXNAMELEN EBT_TABLE_MAXNAMELEN
22
23 /* verdicts >0 are "branches" */
24 #define EBT_ACCEPT   -1
25 #define EBT_DROP     -2
26 #define EBT_CONTINUE -3
27 #define EBT_RETURN   -4
28 #define NUM_STANDARD_TARGETS   4
29 /* ebtables target modules store the verdict inside an int. We can
30  * reclaim a part of this int for backwards compatible extensions.
31  * The 4 lsb are more than enough to store the verdict. */
32 #define EBT_VERDICT_BITS 0x0000000F
33
34 struct ebt_counter
35 {
36         uint64_t pcnt;
37         uint64_t bcnt;
38 };
39
40 struct ebt_replace
41 {
42         char name[EBT_TABLE_MAXNAMELEN];
43         unsigned int valid_hooks;
44         /* nr of rules in the table */
45         unsigned int nentries;
46         /* total size of the entries */
47         unsigned int entries_size;
48         /* start of the chains */
49         struct ebt_entries __user *hook_entry[NF_BR_NUMHOOKS];
50         /* nr of counters userspace expects back */
51         unsigned int num_counters;
52         /* where the kernel will put the old counters */
53         struct ebt_counter __user *counters;
54         char __user *entries;
55 };
56
57 struct ebt_replace_kernel
58 {
59         char name[EBT_TABLE_MAXNAMELEN];
60         unsigned int valid_hooks;
61         /* nr of rules in the table */
62         unsigned int nentries;
63         /* total size of the entries */
64         unsigned int entries_size;
65         /* start of the chains */
66         struct ebt_entries *hook_entry[NF_BR_NUMHOOKS];
67         /* nr of counters userspace expects back */
68         unsigned int num_counters;
69         /* where the kernel will put the old counters */
70         struct ebt_counter *counters;
71         char *entries;
72 };
73
74 struct ebt_entries {
75         /* this field is always set to zero
76          * See EBT_ENTRY_OR_ENTRIES.
77          * Must be same size as ebt_entry.bitmask */
78         unsigned int distinguisher;
79         /* the chain name */
80         char name[EBT_CHAIN_MAXNAMELEN];
81         /* counter offset for this chain */
82         unsigned int counter_offset;
83         /* one standard (accept, drop, return) per hook */
84         int policy;
85         /* nr. of entries */
86         unsigned int nentries;
87         /* entry list */
88         char data[0] __attribute__ ((aligned (__alignof__(struct ebt_replace))));
89 };
90
91 /* used for the bitmask of struct ebt_entry */
92
93 /* This is a hack to make a difference between an ebt_entry struct and an
94  * ebt_entries struct when traversing the entries from start to end.
95  * Using this simplifies the code alot, while still being able to use
96  * ebt_entries.
97  * Contrary, iptables doesn't use something like ebt_entries and therefore uses
98  * different techniques for naming the policy and such. So, iptables doesn't
99  * need a hack like this.
100  */
101 #define EBT_ENTRY_OR_ENTRIES 0x01
102 /* these are the normal masks */
103 #define EBT_NOPROTO 0x02
104 #define EBT_802_3 0x04
105 #define EBT_SOURCEMAC 0x08
106 #define EBT_DESTMAC 0x10
107 #define EBT_F_MASK (EBT_NOPROTO | EBT_802_3 | EBT_SOURCEMAC | EBT_DESTMAC \
108    | EBT_ENTRY_OR_ENTRIES)
109
110 #define EBT_IPROTO 0x01
111 #define EBT_IIN 0x02
112 #define EBT_IOUT 0x04
113 #define EBT_ISOURCE 0x8
114 #define EBT_IDEST 0x10
115 #define EBT_ILOGICALIN 0x20
116 #define EBT_ILOGICALOUT 0x40
117 #define EBT_INV_MASK (EBT_IPROTO | EBT_IIN | EBT_IOUT | EBT_ILOGICALIN \
118    | EBT_ILOGICALOUT | EBT_ISOURCE | EBT_IDEST)
119
120 struct ebt_entry_match
121 {
122         union {
123                 char name[EBT_FUNCTION_MAXNAMELEN];
124                 struct ebt_match *match;
125         } u;
126         /* size of data */
127         unsigned int match_size;
128         unsigned char data[0] __attribute__ ((aligned (__alignof__(struct ebt_replace))));
129 };
130
131 struct ebt_entry_watcher
132 {
133         union {
134                 char name[EBT_FUNCTION_MAXNAMELEN];
135                 struct ebt_watcher *watcher;
136         } u;
137         /* size of data */
138         unsigned int watcher_size;
139         unsigned char data[0] __attribute__ ((aligned (__alignof__(struct ebt_replace))));
140 };
141
142 struct ebt_entry_target
143 {
144         union {
145                 char name[EBT_FUNCTION_MAXNAMELEN];
146                 struct ebt_target *target;
147         } u;
148         /* size of data */
149         unsigned int target_size;
150         unsigned char data[0] __attribute__ ((aligned (__alignof__(struct ebt_replace))));
151 };
152
153 #define EBT_STANDARD_TARGET "standard"
154 struct ebt_standard_target
155 {
156         struct ebt_entry_target target;
157         int verdict;
158 };
159
160 /* one entry */
161 struct ebt_entry {
162         /* this needs to be the first field */
163         unsigned int bitmask;
164         unsigned int invflags;
165         __be16 ethproto;
166         /* the physical in-dev */
167         char in[IFNAMSIZ];
168         /* the logical in-dev */
169         char logical_in[IFNAMSIZ];
170         /* the physical out-dev */
171         char out[IFNAMSIZ];
172         /* the logical out-dev */
173         char logical_out[IFNAMSIZ];
174         unsigned char sourcemac[ETH_ALEN];
175         unsigned char sourcemsk[ETH_ALEN];
176         unsigned char destmac[ETH_ALEN];
177         unsigned char destmsk[ETH_ALEN];
178         /* sizeof ebt_entry + matches */
179         unsigned int watchers_offset;
180         /* sizeof ebt_entry + matches + watchers */
181         unsigned int target_offset;
182         /* sizeof ebt_entry + matches + watchers + target */
183         unsigned int next_offset;
184         unsigned char elems[0] __attribute__ ((aligned (__alignof__(struct ebt_replace))));
185 };
186
187 /* {g,s}etsockopt numbers */
188 #define EBT_BASE_CTL            128
189
190 #define EBT_SO_SET_ENTRIES      (EBT_BASE_CTL)
191 #define EBT_SO_SET_COUNTERS     (EBT_SO_SET_ENTRIES+1)
192 #define EBT_SO_SET_MAX          (EBT_SO_SET_COUNTERS+1)
193
194 #define EBT_SO_GET_INFO         (EBT_BASE_CTL)
195 #define EBT_SO_GET_ENTRIES      (EBT_SO_GET_INFO+1)
196 #define EBT_SO_GET_INIT_INFO    (EBT_SO_GET_ENTRIES+1)
197 #define EBT_SO_GET_INIT_ENTRIES (EBT_SO_GET_INIT_INFO+1)
198 #define EBT_SO_GET_MAX          (EBT_SO_GET_INIT_ENTRIES+1)
199
200 #ifdef __KERNEL__
201
202 /* return values for match() functions */
203 #define EBT_MATCH 0
204 #define EBT_NOMATCH 1
205
206 struct ebt_match
207 {
208         struct list_head list;
209         const char name[EBT_FUNCTION_MAXNAMELEN];
210         /* 0 == it matches */
211         int (*match)(const struct sk_buff *skb, const struct net_device *in,
212            const struct net_device *out, const void *matchdata,
213            unsigned int datalen);
214         /* 0 == let it in */
215         int (*check)(const char *tablename, unsigned int hookmask,
216            const struct ebt_entry *e, void *matchdata, unsigned int datalen);
217         void (*destroy)(void *matchdata, unsigned int datalen);
218         unsigned int matchsize;
219         struct module *me;
220 };
221
222 struct ebt_watcher
223 {
224         struct list_head list;
225         const char name[EBT_FUNCTION_MAXNAMELEN];
226         void (*watcher)(const struct sk_buff *skb, unsigned int hooknr,
227            const struct net_device *in, const struct net_device *out,
228            const void *watcherdata, unsigned int datalen);
229         /* 0 == let it in */
230         int (*check)(const char *tablename, unsigned int hookmask,
231            const struct ebt_entry *e, void *watcherdata, unsigned int datalen);
232         void (*destroy)(void *watcherdata, unsigned int datalen);
233         unsigned int targetsize;
234         struct module *me;
235 };
236
237 struct ebt_target
238 {
239         struct list_head list;
240         const char name[EBT_FUNCTION_MAXNAMELEN];
241         /* returns one of the standard verdicts */
242         int (*target)(struct sk_buff *skb, unsigned int hooknr,
243            const struct net_device *in, const struct net_device *out,
244            const void *targetdata, unsigned int datalen);
245         /* 0 == let it in */
246         int (*check)(const char *tablename, unsigned int hookmask,
247            const struct ebt_entry *e, void *targetdata, unsigned int datalen);
248         void (*destroy)(void *targetdata, unsigned int datalen);
249         unsigned int targetsize;
250         struct module *me;
251 };
252
253 /* used for jumping from and into user defined chains (udc) */
254 struct ebt_chainstack
255 {
256         struct ebt_entries *chaininfo; /* pointer to chain data */
257         struct ebt_entry *e; /* pointer to entry data */
258         unsigned int n; /* n'th entry */
259 };
260
261 struct ebt_table_info
262 {
263         /* total size of the entries */
264         unsigned int entries_size;
265         unsigned int nentries;
266         /* pointers to the start of the chains */
267         struct ebt_entries *hook_entry[NF_BR_NUMHOOKS];
268         /* room to maintain the stack used for jumping from and into udc */
269         struct ebt_chainstack **chainstack;
270         char *entries;
271         struct ebt_counter counters[0] ____cacheline_aligned;
272 };
273
274 struct ebt_table
275 {
276         struct list_head list;
277         char name[EBT_TABLE_MAXNAMELEN];
278         struct ebt_replace_kernel *table;
279         unsigned int valid_hooks;
280         rwlock_t lock;
281         /* e.g. could be the table explicitly only allows certain
282          * matches, targets, ... 0 == let it in */
283         int (*check)(const struct ebt_table_info *info,
284            unsigned int valid_hooks);
285         /* the data used by the kernel */
286         struct ebt_table_info *private;
287         struct module *me;
288 };
289
290 #define EBT_ALIGN(s) (((s) + (__alignof__(struct ebt_replace)-1)) & \
291                      ~(__alignof__(struct ebt_replace)-1))
292 extern int ebt_register_table(struct ebt_table *table);
293 extern void ebt_unregister_table(struct ebt_table *table);
294 extern int ebt_register_match(struct ebt_match *match);
295 extern void ebt_unregister_match(struct ebt_match *match);
296 extern int ebt_register_watcher(struct ebt_watcher *watcher);
297 extern void ebt_unregister_watcher(struct ebt_watcher *watcher);
298 extern int ebt_register_target(struct ebt_target *target);
299 extern void ebt_unregister_target(struct ebt_target *target);
300 extern unsigned int ebt_do_table(unsigned int hook, struct sk_buff *skb,
301    const struct net_device *in, const struct net_device *out,
302    struct ebt_table *table);
303
304 /* Used in the kernel match() functions */
305 #define FWINV(bool,invflg) ((bool) ^ !!(info->invflags & invflg))
306 /* True if the hook mask denotes that the rule is in a base chain,
307  * used in the check() functions */
308 #define BASE_CHAIN (hookmask & (1 << NF_BR_NUMHOOKS))
309 /* Clear the bit in the hook mask that tells if the rule is on a base chain */
310 #define CLEAR_BASE_CHAIN_BIT (hookmask &= ~(1 << NF_BR_NUMHOOKS))
311 /* True if the target is not a standard target */
312 #define INVALID_TARGET (info->target < -NUM_STANDARD_TARGETS || info->target >= 0)
313
314 #endif /* __KERNEL__ */
315
316 /* blatently stolen from ip_tables.h
317  * fn returns 0 to continue iteration */
318 #define EBT_MATCH_ITERATE(e, fn, args...)                   \
319 ({                                                          \
320         unsigned int __i;                                   \
321         int __ret = 0;                                      \
322         struct ebt_entry_match *__match;                    \
323                                                             \
324         for (__i = sizeof(struct ebt_entry);                \
325              __i < (e)->watchers_offset;                    \
326              __i += __match->match_size +                   \
327              sizeof(struct ebt_entry_match)) {              \
328                 __match = (void *)(e) + __i;                \
329                                                             \
330                 __ret = fn(__match , ## args);              \
331                 if (__ret != 0)                             \
332                         break;                              \
333         }                                                   \
334         if (__ret == 0) {                                   \
335                 if (__i != (e)->watchers_offset)            \
336                         __ret = -EINVAL;                    \
337         }                                                   \
338         __ret;                                              \
339 })
340
341 #define EBT_WATCHER_ITERATE(e, fn, args...)                 \
342 ({                                                          \
343         unsigned int __i;                                   \
344         int __ret = 0;                                      \
345         struct ebt_entry_watcher *__watcher;                \
346                                                             \
347         for (__i = e->watchers_offset;                      \
348              __i < (e)->target_offset;                      \
349              __i += __watcher->watcher_size +               \
350              sizeof(struct ebt_entry_watcher)) {            \
351                 __watcher = (void *)(e) + __i;              \
352                                                             \
353                 __ret = fn(__watcher , ## args);            \
354                 if (__ret != 0)                             \
355                         break;                              \
356         }                                                   \
357         if (__ret == 0) {                                   \
358                 if (__i != (e)->target_offset)              \
359                         __ret = -EINVAL;                    \
360         }                                                   \
361         __ret;                                              \
362 })
363
364 #define EBT_ENTRY_ITERATE(entries, size, fn, args...)       \
365 ({                                                          \
366         unsigned int __i;                                   \
367         int __ret = 0;                                      \
368         struct ebt_entry *__entry;                          \
369                                                             \
370         for (__i = 0; __i < (size);) {                      \
371                 __entry = (void *)(entries) + __i;          \
372                 __ret = fn(__entry , ## args);              \
373                 if (__ret != 0)                             \
374                         break;                              \
375                 if (__entry->bitmask != 0)                  \
376                         __i += __entry->next_offset;        \
377                 else                                        \
378                         __i += sizeof(struct ebt_entries);  \
379         }                                                   \
380         if (__ret == 0) {                                   \
381                 if (__i != (size))                          \
382                         __ret = -EINVAL;                    \
383         }                                                   \
384         __ret;                                              \
385 })
386
387 #endif