[mirror_ubuntu-hirsute-kernel.git] / include / linux / netfilter_arp / arp_tables.h

/*
 * 	Format of an ARP firewall descriptor
 *
 * 	src, tgt, src_mask, tgt_mask, arpop, arpop_mask are always stored in
 *	network byte order.
 * 	flags are stored in host byte order (of course).
 */

#ifndef _ARPTABLES_H
#define _ARPTABLES_H

#ifdef __KERNEL__
#include <linux/if.h>
#include <linux/types.h>
#include <linux/in.h>
#include <linux/if_arp.h>
#include <linux/skbuff.h>
#endif
#include <linux/compiler.h>
#include <linux/netfilter_arp.h>

#include <linux/netfilter/x_tables.h>

#define ARPT_FUNCTION_MAXNAMELEN XT_FUNCTION_MAXNAMELEN
#define ARPT_TABLE_MAXNAMELEN XT_TABLE_MAXNAMELEN
#define arpt_target xt_target
#define arpt_table xt_table

#define ARPT_DEV_ADDR_LEN_MAX 16

struct arpt_devaddr_info {
	char addr[ARPT_DEV_ADDR_LEN_MAX];
	char mask[ARPT_DEV_ADDR_LEN_MAX];
};

/* Yes, Virginia, you have to zero the padding. */
struct arpt_arp {
	/* Source and target IP addr */
	struct in_addr src, tgt;
	/* Mask for src and target IP addr */
	struct in_addr smsk, tmsk;

	/* Device hw address length, src+target device addresses */
	u_int8_t arhln, arhln_mask;
	struct arpt_devaddr_info src_devaddr;
	struct arpt_devaddr_info tgt_devaddr;

	/* ARP operation code. */
	__be16 arpop, arpop_mask;

	/* ARP hardware address and protocol address format. */
	__be16 arhrd, arhrd_mask;
	__be16 arpro, arpro_mask;

	/* The protocol address length is only accepted if it is 4
	 * so there is no use in offering a way to do filtering on it.
	 */

	char iniface[IFNAMSIZ], outiface[IFNAMSIZ];
	unsigned char iniface_mask[IFNAMSIZ], outiface_mask[IFNAMSIZ];

	/* Flags word */
	u_int8_t flags;
	/* Inverse flags */
	u_int16_t invflags;
};

#define arpt_entry_target xt_entry_target
#define arpt_standard_target xt_standard_target

/* Values for "flag" field in struct arpt_ip (general arp structure).
 * No flags defined yet.
 */
#define ARPT_F_MASK		0x00	/* All possible flag bits mask. */

/* Values for "inv" field in struct arpt_arp. */
#define ARPT_INV_VIA_IN		0x0001	/* Invert the sense of IN IFACE. */
#define ARPT_INV_VIA_OUT	0x0002	/* Invert the sense of OUT IFACE */
#define ARPT_INV_SRCIP		0x0004	/* Invert the sense of SRC IP. */
#define ARPT_INV_TGTIP		0x0008	/* Invert the sense of TGT IP. */
#define ARPT_INV_SRCDEVADDR	0x0010	/* Invert the sense of SRC DEV ADDR. */
#define ARPT_INV_TGTDEVADDR	0x0020	/* Invert the sense of TGT DEV ADDR. */
#define ARPT_INV_ARPOP		0x0040	/* Invert the sense of ARP OP. */
#define ARPT_INV_ARPHRD		0x0080	/* Invert the sense of ARP HRD. */
#define ARPT_INV_ARPPRO		0x0100	/* Invert the sense of ARP PRO. */
#define ARPT_INV_ARPHLN		0x0200	/* Invert the sense of ARP HLN. */
#define ARPT_INV_MASK		0x03FF	/* All possible flag bits mask. */

/* This structure defines each of the firewall rules.  Consists of 3
   parts which are 1) general ARP header stuff 2) match specific
   stuff 3) the target to perform if the rule matches */
struct arpt_entry
{
	struct arpt_arp arp;

	/* Size of arpt_entry + matches */
	u_int16_t target_offset;
	/* Size of arpt_entry + matches + target */
	u_int16_t next_offset;

	/* Back pointer */
	unsigned int comefrom;

	/* Packet and byte counters. */
	struct xt_counters counters;

	/* The matches (if any), then the target. */
	unsigned char elems[0];
};

/*
 * New IP firewall options for [gs]etsockopt at the RAW IP level.
 * Unlike BSD Linux inherits IP options so you don't have to use a raw
 * socket for this. Instead we check rights in the calls.
 *
 * ATTENTION: check linux/in.h before adding new number here.
 */
#define ARPT_BASE_CTL		96

#define ARPT_SO_SET_REPLACE		(ARPT_BASE_CTL)
#define ARPT_SO_SET_ADD_COUNTERS	(ARPT_BASE_CTL + 1)
#define ARPT_SO_SET_MAX			ARPT_SO_SET_ADD_COUNTERS

#define ARPT_SO_GET_INFO		(ARPT_BASE_CTL)
#define ARPT_SO_GET_ENTRIES		(ARPT_BASE_CTL + 1)
/* #define ARPT_SO_GET_REVISION_MATCH	(APRT_BASE_CTL + 2) */
#define ARPT_SO_GET_REVISION_TARGET	(ARPT_BASE_CTL + 3)
#define ARPT_SO_GET_MAX			(ARPT_SO_GET_REVISION_TARGET)

/* CONTINUE verdict for targets */
#define ARPT_CONTINUE XT_CONTINUE

/* For standard target */
#define ARPT_RETURN XT_RETURN

/* The argument to ARPT_SO_GET_INFO */
struct arpt_getinfo
{
	/* Which table: caller fills this in. */
	char name[ARPT_TABLE_MAXNAMELEN];

	/* Kernel fills these in. */
	/* Which hook entry points are valid: bitmask */
	unsigned int valid_hooks;

	/* Hook entry points: one per netfilter hook. */
	unsigned int hook_entry[NF_ARP_NUMHOOKS];

	/* Underflow points. */
	unsigned int underflow[NF_ARP_NUMHOOKS];

	/* Number of entries */
	unsigned int num_entries;

	/* Size of entries. */
	unsigned int size;
};

/* The argument to ARPT_SO_SET_REPLACE. */
struct arpt_replace
{
	/* Which table. */
	char name[ARPT_TABLE_MAXNAMELEN];

	/* Which hook entry points are valid: bitmask.  You can't
           change this. */
	unsigned int valid_hooks;

	/* Number of entries */
	unsigned int num_entries;

	/* Total size of new entries */
	unsigned int size;

	/* Hook entry points. */
	unsigned int hook_entry[NF_ARP_NUMHOOKS];

	/* Underflow points. */
	unsigned int underflow[NF_ARP_NUMHOOKS];

	/* Information about old entries: */
	/* Number of counters (must be equal to current number of entries). */
	unsigned int num_counters;
	/* The old entries' counters. */
	struct xt_counters __user *counters;

	/* The entries (hang off end: not really an array). */
	struct arpt_entry entries[0];
};

/* The argument to ARPT_SO_ADD_COUNTERS. */
#define arpt_counters_info xt_counters_info
#define arpt_counters xt_counters

/* The argument to ARPT_SO_GET_ENTRIES. */
struct arpt_get_entries
{
	/* Which table: user fills this in. */
	char name[ARPT_TABLE_MAXNAMELEN];

	/* User fills this in: total entry size. */
	unsigned int size;

	/* The entries. */
	struct arpt_entry entrytable[0];
};

/* Standard return verdict, or do jump. */
#define ARPT_STANDARD_TARGET XT_STANDARD_TARGET
/* Error verdict. */
#define ARPT_ERROR_TARGET XT_ERROR_TARGET

/* Helper functions */
static __inline__ struct arpt_entry_target *arpt_get_target(struct arpt_entry *e)
{
	return (void *)e + e->target_offset;
}

/* fn returns 0 to continue iteration */
#define ARPT_ENTRY_ITERATE(entries, size, fn, args...)		\
({								\
	unsigned int __i;					\
	int __ret = 0;						\
	struct arpt_entry *__entry;				\
								\
	for (__i = 0; __i < (size); __i += __entry->next_offset) { \
		__entry = (void *)(entries) + __i;		\
								\
		__ret = fn(__entry , ## args);			\
		if (__ret != 0)					\
			break;					\
	}							\
	__ret;							\
})

/*
 *	Main firewall chains definitions and global var's definitions.
 */
#ifdef __KERNEL__

/* Standard entry. */
struct arpt_standard
{
	struct arpt_entry entry;
	struct arpt_standard_target target;
};

struct arpt_error_target
{
	struct arpt_entry_target target;
	char errorname[ARPT_FUNCTION_MAXNAMELEN];
};

struct arpt_error
{
	struct arpt_entry entry;
	struct arpt_error_target target;
};

#define ARPT_ENTRY_INIT(__size)						       \
{									       \
	.target_offset	= sizeof(struct arpt_entry),			       \
	.next_offset	= (__size),					       \
}

#define ARPT_STANDARD_INIT(__verdict)					       \
{									       \
	.entry		= ARPT_ENTRY_INIT(sizeof(struct arpt_standard)),       \
	.target		= XT_TARGET_INIT(ARPT_STANDARD_TARGET,		       \
					 sizeof(struct arpt_standard_target)), \
	.target.verdict	= -(__verdict) - 1,				       \
}

#define ARPT_ERROR_INIT							       \
{									       \
	.entry		= ARPT_ENTRY_INIT(sizeof(struct arpt_error)),	       \
	.target		= XT_TARGET_INIT(ARPT_ERROR_TARGET,		       \
					 sizeof(struct arpt_error_target)),    \
	.target.errorname = "ERROR",					       \
}

#define arpt_register_target(tgt) 	\
({	(tgt)->family = NF_ARP;		\
 	xt_register_target(tgt); })
#define arpt_unregister_target(tgt) xt_unregister_target(tgt)

extern int arpt_register_table(struct arpt_table *table,
			       const struct arpt_replace *repl);
extern void arpt_unregister_table(struct arpt_table *table);
extern unsigned int arpt_do_table(struct sk_buff *skb,
				  unsigned int hook,
				  const struct net_device *in,
				  const struct net_device *out,
				  struct arpt_table *table);

#define ARPT_ALIGN(s) (((s) + (__alignof__(struct arpt_entry)-1)) & ~(__alignof__(struct arpt_entry)-1))
#endif /*__KERNEL__*/
#endif /* _ARPTABLES_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Format of an ARP firewall descriptor
	3	*
	4	* src, tgt, src_mask, tgt_mask, arpop, arpop_mask are always stored in
	5	* network byte order.
	6	* flags are stored in host byte order (of course).
	7	*/
	8
	9	#ifndef _ARPTABLES_H
	10	#define _ARPTABLES_H
	11
	12	#ifdef __KERNEL__
	13	#include <linux/if.h>
	14	#include <linux/types.h>
	15	#include <linux/in.h>
	16	#include <linux/if_arp.h>
	17	#include <linux/skbuff.h>
	18	#endif
	19	#include <linux/compiler.h>
	20	#include <linux/netfilter_arp.h>
	21
2e4e6a17 HW	22	#include <linux/netfilter/x_tables.h>
	23
	24	#define ARPT_FUNCTION_MAXNAMELEN XT_FUNCTION_MAXNAMELEN
	25	#define ARPT_TABLE_MAXNAMELEN XT_TABLE_MAXNAMELEN
	26	#define arpt_target xt_target
	27	#define arpt_table xt_table
1da177e4 LT	28
	29	#define ARPT_DEV_ADDR_LEN_MAX 16
	30
	31	struct arpt_devaddr_info {
	32	char addr[ARPT_DEV_ADDR_LEN_MAX];
	33	char mask[ARPT_DEV_ADDR_LEN_MAX];
	34	};
	35
	36	/* Yes, Virginia, you have to zero the padding. */
	37	struct arpt_arp {
	38	/* Source and target IP addr */
	39	struct in_addr src, tgt;
	40	/* Mask for src and target IP addr */
	41	struct in_addr smsk, tmsk;
	42
	43	/* Device hw address length, src+target device addresses */
	44	u_int8_t arhln, arhln_mask;
	45	struct arpt_devaddr_info src_devaddr;
	46	struct arpt_devaddr_info tgt_devaddr;
	47
	48	/* ARP operation code. */
59b8bfd8	49	__be16 arpop, arpop_mask;
1da177e4 LT	50
1da177e4 LT	51	/* ARP hardware address and protocol address format. */
59b8bfd8 AV	52	__be16 arhrd, arhrd_mask;
59b8bfd8 AV	53	__be16 arpro, arpro_mask;
1da177e4 LT	54
	55	/* The protocol address length is only accepted if it is 4
	56	* so there is no use in offering a way to do filtering on it.
	57	*/
	58
	59	char iniface[IFNAMSIZ], outiface[IFNAMSIZ];
	60	unsigned char iniface_mask[IFNAMSIZ], outiface_mask[IFNAMSIZ];
	61
	62	/* Flags word */
	63	u_int8_t flags;
	64	/* Inverse flags */
	65	u_int16_t invflags;
	66	};
	67
1e30a014 DM	68	#define arpt_entry_target xt_entry_target
1e30a014 DM	69	#define arpt_standard_target xt_standard_target
1da177e4	70
1da177e4 LT	71	/* Values for "flag" field in struct arpt_ip (general arp structure).
	72	* No flags defined yet.
	73	*/
	74	#define ARPT_F_MASK 0x00 /* All possible flag bits mask. */
	75
	76	/* Values for "inv" field in struct arpt_arp. */
	77	#define ARPT_INV_VIA_IN 0x0001 /* Invert the sense of IN IFACE. */
	78	#define ARPT_INV_VIA_OUT 0x0002 /* Invert the sense of OUT IFACE */
	79	#define ARPT_INV_SRCIP 0x0004 /* Invert the sense of SRC IP. */
	80	#define ARPT_INV_TGTIP 0x0008 /* Invert the sense of TGT IP. */
	81	#define ARPT_INV_SRCDEVADDR 0x0010 /* Invert the sense of SRC DEV ADDR. */
	82	#define ARPT_INV_TGTDEVADDR 0x0020 /* Invert the sense of TGT DEV ADDR. */
	83	#define ARPT_INV_ARPOP 0x0040 /* Invert the sense of ARP OP. */
	84	#define ARPT_INV_ARPHRD 0x0080 /* Invert the sense of ARP HRD. */
	85	#define ARPT_INV_ARPPRO 0x0100 /* Invert the sense of ARP PRO. */
	86	#define ARPT_INV_ARPHLN 0x0200 /* Invert the sense of ARP HLN. */
	87	#define ARPT_INV_MASK 0x03FF /* All possible flag bits mask. */
	88
	89	/* This structure defines each of the firewall rules. Consists of 3
	90	parts which are 1) general ARP header stuff 2) match specific
	91	stuff 3) the target to perform if the rule matches */
	92	struct arpt_entry
	93	{
	94	struct arpt_arp arp;
	95
	96	/* Size of arpt_entry + matches */
	97	u_int16_t target_offset;
	98	/* Size of arpt_entry + matches + target */
	99	u_int16_t next_offset;
	100
	101	/* Back pointer */
	102	unsigned int comefrom;
	103
	104	/* Packet and byte counters. */
2e4e6a17	105	struct xt_counters counters;
1da177e4 LT	106
	107	/* The matches (if any), then the target. */
	108	unsigned char elems[0];
	109	};
	110
	111	/*
	112	* New IP firewall options for [gs]etsockopt at the RAW IP level.
	113	* Unlike BSD Linux inherits IP options so you don't have to use a raw
	114	* socket for this. Instead we check rights in the calls.
b96e7ecb YK	115	*
b96e7ecb YK	116	* ATTENTION: check linux/in.h before adding new number here.
1da177e4	117	*/
b96e7ecb YK	118	#define ARPT_BASE_CTL 96
	119
	120	#define ARPT_SO_SET_REPLACE (ARPT_BASE_CTL)
	121	#define ARPT_SO_SET_ADD_COUNTERS (ARPT_BASE_CTL + 1)
	122	#define ARPT_SO_SET_MAX ARPT_SO_SET_ADD_COUNTERS
	123
	124	#define ARPT_SO_GET_INFO (ARPT_BASE_CTL)
	125	#define ARPT_SO_GET_ENTRIES (ARPT_BASE_CTL + 1)
	126	/* #define ARPT_SO_GET_REVISION_MATCH (APRT_BASE_CTL + 2) */
	127	#define ARPT_SO_GET_REVISION_TARGET (ARPT_BASE_CTL + 3)
	128	#define ARPT_SO_GET_MAX (ARPT_SO_GET_REVISION_TARGET)
1da177e4 LT	129
1da177e4 LT	130	/* CONTINUE verdict for targets */
2e4e6a17	131	#define ARPT_CONTINUE XT_CONTINUE
1da177e4 LT	132
1da177e4 LT	133	/* For standard target */
2e4e6a17	134	#define ARPT_RETURN XT_RETURN
1da177e4 LT	135
	136	/* The argument to ARPT_SO_GET_INFO */
	137	struct arpt_getinfo
	138	{
	139	/* Which table: caller fills this in. */
	140	char name[ARPT_TABLE_MAXNAMELEN];
	141
	142	/* Kernel fills these in. */
	143	/* Which hook entry points are valid: bitmask */
	144	unsigned int valid_hooks;
	145
	146	/* Hook entry points: one per netfilter hook. */
	147	unsigned int hook_entry[NF_ARP_NUMHOOKS];
	148
	149	/* Underflow points. */
	150	unsigned int underflow[NF_ARP_NUMHOOKS];
	151
	152	/* Number of entries */
	153	unsigned int num_entries;
	154
	155	/* Size of entries. */
	156	unsigned int size;
	157	};
	158
	159	/* The argument to ARPT_SO_SET_REPLACE. */
	160	struct arpt_replace
	161	{
	162	/* Which table. */
	163	char name[ARPT_TABLE_MAXNAMELEN];
	164
	165	/* Which hook entry points are valid: bitmask. You can't
	166	change this. */
	167	unsigned int valid_hooks;
	168
	169	/* Number of entries */
	170	unsigned int num_entries;
	171
	172	/* Total size of new entries */
	173	unsigned int size;
	174
	175	/* Hook entry points. */
	176	unsigned int hook_entry[NF_ARP_NUMHOOKS];
	177
	178	/* Underflow points. */
	179	unsigned int underflow[NF_ARP_NUMHOOKS];
	180
	181	/* Information about old entries: */
	182	/* Number of counters (must be equal to current number of entries). */
	183	unsigned int num_counters;
	184	/* The old entries' counters. */
2e4e6a17	185	struct xt_counters __user *counters;
1da177e4 LT	186
	187	/* The entries (hang off end: not really an array). */
	188	struct arpt_entry entries[0];
	189	};
	190
	191	/* The argument to ARPT_SO_ADD_COUNTERS. */
2e4e6a17	192	#define arpt_counters_info xt_counters_info
8c82d8df	193	#define arpt_counters xt_counters
1da177e4 LT	194
	195	/* The argument to ARPT_SO_GET_ENTRIES. */
	196	struct arpt_get_entries
	197	{
	198	/* Which table: user fills this in. */
	199	char name[ARPT_TABLE_MAXNAMELEN];
	200
	201	/* User fills this in: total entry size. */
	202	unsigned int size;
	203
	204	/* The entries. */
	205	struct arpt_entry entrytable[0];
	206	};
	207
	208	/* Standard return verdict, or do jump. */
2e4e6a17	209	#define ARPT_STANDARD_TARGET XT_STANDARD_TARGET
1da177e4	210	/* Error verdict. */
2e4e6a17	211	#define ARPT_ERROR_TARGET XT_ERROR_TARGET
1da177e4 LT	212
	213	/* Helper functions */
	214	static __inline__ struct arpt_entry_target arpt_get_target(struct arpt_entry e)
	215	{
	216	return (void *)e + e->target_offset;
	217	}
	218
	219	/* fn returns 0 to continue iteration */
	220	#define ARPT_ENTRY_ITERATE(entries, size, fn, args...) \
	221	({ \
	222	unsigned int __i; \
	223	int __ret = 0; \
	224	struct arpt_entry *__entry; \
	225	\
	226	for (__i = 0; __i < (size); __i += __entry->next_offset) { \
	227	__entry = (void *)(entries) + __i; \
	228	\
	229	__ret = fn(__entry , ## args); \
	230	if (__ret != 0) \
	231	break; \
	232	} \
	233	__ret; \
	234	})
	235
	236	/*
	237	* Main firewall chains definitions and global var's definitions.
	238	*/
	239	#ifdef __KERNEL__
	240
3c2ad469 PM	241	/* Standard entry. */
	242	struct arpt_standard
	243	{
	244	struct arpt_entry entry;
	245	struct arpt_standard_target target;
	246	};
	247
	248	struct arpt_error_target
	249	{
	250	struct arpt_entry_target target;
	251	char errorname[ARPT_FUNCTION_MAXNAMELEN];
	252	};
	253
	254	struct arpt_error
	255	{
	256	struct arpt_entry entry;
	257	struct arpt_error_target target;
	258	};
	259
	260	#define ARPT_ENTRY_INIT(__size) \
	261	{ \
	262	.target_offset = sizeof(struct arpt_entry), \
	263	.next_offset = (__size), \
	264	}
	265
	266	#define ARPT_STANDARD_INIT(__verdict) \
	267	{ \
	268	.entry = ARPT_ENTRY_INIT(sizeof(struct arpt_standard)), \
	269	.target = XT_TARGET_INIT(ARPT_STANDARD_TARGET, \
	270	sizeof(struct arpt_standard_target)), \
	271	.target.verdict = -(__verdict) - 1, \
	272	}
	273
	274	#define ARPT_ERROR_INIT \
	275	{ \
	276	.entry = ARPT_ENTRY_INIT(sizeof(struct arpt_error)), \
	277	.target = XT_TARGET_INIT(ARPT_ERROR_TARGET, \
	278	sizeof(struct arpt_error_target)), \
	279	.target.errorname = "ERROR", \
	280	}
	281
a45049c5 PNA	282	#define arpt_register_target(tgt) \
	283	({ (tgt)->family = NF_ARP; \
	284	xt_register_target(tgt); })
	285	#define arpt_unregister_target(tgt) xt_unregister_target(tgt)
1da177e4 LT	286
	287	extern int arpt_register_table(struct arpt_table *table,
	288	const struct arpt_replace *repl);
	289	extern void arpt_unregister_table(struct arpt_table *table);
3db05fea	290	extern unsigned int arpt_do_table(struct sk_buff *skb,
1da177e4 LT	291	unsigned int hook,
	292	const struct net_device *in,
	293	const struct net_device *out,
fe1cb108	294	struct arpt_table *table);
1da177e4 LT	295
	296	#define ARPT_ALIGN(s) (((s) + (__alignof__(struct arpt_entry)-1)) & ~(__alignof__(struct arpt_entry)-1))
	297	#endif /__KERNEL__/
	298	#endif /* _ARPTABLES_H */