netfilter.h 9.9 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8
#ifndef __LINUX_NETFILTER_H
#define __LINUX_NETFILTER_H

#ifdef __KERNEL__
#include <linux/init.h>
#include <linux/skbuff.h>
#include <linux/net.h>
#include <linux/if.h>
9 10
#include <linux/in.h>
#include <linux/in6.h>
L
Linus Torvalds 已提交
11 12 13
#include <linux/wait.h>
#include <linux/list.h>
#endif
14
#include <linux/types.h>
L
Linus Torvalds 已提交
15 16 17 18 19 20 21 22 23 24 25
#include <linux/compiler.h>

/* Responses from hook functions. */
#define NF_DROP 0
#define NF_ACCEPT 1
#define NF_STOLEN 2
#define NF_QUEUE 3
#define NF_REPEAT 4
#define NF_STOP 5
#define NF_MAX_VERDICT NF_STOP

26 27 28 29 30 31 32 33
/* we overload the higher bits for encoding auxiliary data such as the queue
 * number. Not nice, but better than additional function arguments. */
#define NF_VERDICT_MASK 0x0000ffff
#define NF_VERDICT_BITS 16

#define NF_VERDICT_QMASK 0xffff0000
#define NF_VERDICT_QBITS 16

34
#define NF_QUEUE_NR(x) ((((x) << NF_VERDICT_BITS) & NF_VERDICT_QMASK) | NF_QUEUE)
35

36 37
/* only for userspace compatibility */
#ifndef __KERNEL__
L
Linus Torvalds 已提交
38 39 40 41
/* Generic cache responses from hook functions.
   <= 0x2000 is used for protocol-flags. */
#define NFC_UNKNOWN 0x4000
#define NFC_ALTERED 0x8000
42
#endif
L
Linus Torvalds 已提交
43

44 45 46 47 48 49 50 51 52
enum nf_inet_hooks {
	NF_INET_PRE_ROUTING,
	NF_INET_LOCAL_IN,
	NF_INET_FORWARD,
	NF_INET_LOCAL_OUT,
	NF_INET_POST_ROUTING,
	NF_INET_NUMHOOKS
};

53 54 55 56 57 58 59 60 61 62
enum {
	NFPROTO_UNSPEC =  0,
	NFPROTO_IPV4   =  2,
	NFPROTO_ARP    =  3,
	NFPROTO_BRIDGE =  7,
	NFPROTO_IPV6   = 10,
	NFPROTO_DECNET = 12,
	NFPROTO_NUMPROTO,
};

63
union nf_inet_addr {
64
	__u32		all[4];
65 66
	__be32		ip;
	__be32		ip6[4];
67 68
	struct in_addr	in;
	struct in6_addr	in6;
69 70
};

L
Linus Torvalds 已提交
71 72 73
#ifdef __KERNEL__
#ifdef CONFIG_NETFILTER

74 75 76 77 78 79 80 81 82
static inline int nf_inet_addr_cmp(const union nf_inet_addr *a1,
				   const union nf_inet_addr *a2)
{
	return a1->all[0] == a2->all[0] &&
	       a1->all[1] == a2->all[1] &&
	       a1->all[2] == a2->all[2] &&
	       a1->all[3] == a2->all[3];
}

L
Linus Torvalds 已提交
83 84 85 86 87 88 89 90
extern void netfilter_init(void);

/* Largest hook number + 1 */
#define NF_MAX_HOOKS 8

struct sk_buff;

typedef unsigned int nf_hookfn(unsigned int hooknum,
91
			       struct sk_buff *skb,
L
Linus Torvalds 已提交
92 93 94 95
			       const struct net_device *in,
			       const struct net_device *out,
			       int (*okfn)(struct sk_buff *));

E
Eric Dumazet 已提交
96
struct nf_hook_ops {
L
Linus Torvalds 已提交
97 98 99 100 101
	struct list_head list;

	/* User fills in from here down. */
	nf_hookfn *hook;
	struct module *owner;
102 103
	u_int8_t pf;
	unsigned int hooknum;
L
Linus Torvalds 已提交
104 105 106 107
	/* Hooks are ordered in ascending priority. */
	int priority;
};

E
Eric Dumazet 已提交
108
struct nf_sockopt_ops {
L
Linus Torvalds 已提交
109 110
	struct list_head list;

111
	u_int8_t pf;
L
Linus Torvalds 已提交
112 113 114 115 116

	/* Non-inclusive ranges: use 0/0/NULL to never get called. */
	int set_optmin;
	int set_optmax;
	int (*set)(struct sock *sk, int optval, void __user *user, unsigned int len);
117 118
	int (*compat_set)(struct sock *sk, int optval,
			void __user *user, unsigned int len);
L
Linus Torvalds 已提交
119 120 121 122

	int get_optmin;
	int get_optmax;
	int (*get)(struct sock *sk, int optval, void __user *user, int *len);
123 124
	int (*compat_get)(struct sock *sk, int optval,
			void __user *user, int *len);
L
Linus Torvalds 已提交
125

126 127
	/* Use the module struct to lock set/get code in place */
	struct module *owner;
L
Linus Torvalds 已提交
128 129 130 131 132
};

/* Function to register/unregister hook points. */
int nf_register_hook(struct nf_hook_ops *reg);
void nf_unregister_hook(struct nf_hook_ops *reg);
133 134
int nf_register_hooks(struct nf_hook_ops *reg, unsigned int n);
void nf_unregister_hooks(struct nf_hook_ops *reg, unsigned int n);
L
Linus Torvalds 已提交
135 136 137 138 139 140

/* Functions to register get/setsockopt ranges (non-inclusive).  You
   need to check permissions yourself! */
int nf_register_sockopt(struct nf_sockopt_ops *reg);
void nf_unregister_sockopt(struct nf_sockopt_ops *reg);

141 142
#ifdef CONFIG_SYSCTL
/* Sysctl registration */
143 144
extern struct ctl_path nf_net_netfilter_sysctl_path[];
extern struct ctl_path nf_net_ipv4_netfilter_sysctl_path[];
145 146
#endif /* CONFIG_SYSCTL */

147
extern struct list_head nf_hooks[NFPROTO_NUMPROTO][NF_MAX_HOOKS];
L
Linus Torvalds 已提交
148

149
int nf_hook_slow(u_int8_t pf, unsigned int hook, struct sk_buff *skb,
150 151 152 153 154 155 156 157 158 159
		 struct net_device *indev, struct net_device *outdev,
		 int (*okfn)(struct sk_buff *), int thresh);

/**
 *	nf_hook_thresh - call a netfilter hook
 *	
 *	Returns 1 if the hook has allowed the packet to pass.  The function
 *	okfn must be invoked by the caller in this case.  Any other return
 *	value indicates the packet has been consumed by the hook.
 */
160
static inline int nf_hook_thresh(u_int8_t pf, unsigned int hook,
161
				 struct sk_buff *skb,
162 163
				 struct net_device *indev,
				 struct net_device *outdev,
164 165
				 int (*okfn)(struct sk_buff *), int thresh,
				 int cond)
166
{
167 168
	if (!cond)
		return 1;
169 170 171 172
#ifndef CONFIG_NETFILTER_DEBUG
	if (list_empty(&nf_hooks[pf][hook]))
		return 1;
#endif
173
	return nf_hook_slow(pf, hook, skb, indev, outdev, okfn, thresh);
174 175
}

176
static inline int nf_hook(u_int8_t pf, unsigned int hook, struct sk_buff *skb,
177 178 179
			  struct net_device *indev, struct net_device *outdev,
			  int (*okfn)(struct sk_buff *))
{
180
	return nf_hook_thresh(pf, hook, skb, indev, outdev, okfn, INT_MIN, 1);
181
}
L
Linus Torvalds 已提交
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
                   
/* Activate hook; either okfn or kfree_skb called, unless a hook
   returns NF_STOLEN (in which case, it's up to the hook to deal with
   the consequences).

   Returns -ERRNO if packet dropped.  Zero means queued, stolen or
   accepted.
*/

/* RR:
   > I don't want nf_hook to return anything because people might forget
   > about async and trust the return value to mean "packet was ok".

   AK:
   Just document it clearly, then you can expect some sense from kernel
   coders :)
*/

/* This is gross, but inline doesn't cut it for avoiding the function
   call in fast path: gcc doesn't inline (needs value tracking?). --RR */
202 203 204

/* HX: It's slightly less gross now. */

L
Linus Torvalds 已提交
205 206
#define NF_HOOK_THRESH(pf, hook, skb, indev, outdev, okfn, thresh)	       \
({int __ret;								       \
207
if ((__ret=nf_hook_thresh(pf, hook, (skb), indev, outdev, okfn, thresh, 1)) == 1)\
208 209 210 211 212
	__ret = (okfn)(skb);						       \
__ret;})

#define NF_HOOK_COND(pf, hook, skb, indev, outdev, okfn, cond)		       \
({int __ret;								       \
213
if ((__ret=nf_hook_thresh(pf, hook, (skb), indev, outdev, okfn, INT_MIN, cond)) == 1)\
L
Linus Torvalds 已提交
214 215 216
	__ret = (okfn)(skb);						       \
__ret;})

217 218
#define NF_HOOK(pf, hook, skb, indev, outdev, okfn) \
	NF_HOOK_THRESH(pf, hook, skb, indev, outdev, okfn, INT_MIN)
L
Linus Torvalds 已提交
219 220

/* Call setsockopt() */
221
int nf_setsockopt(struct sock *sk, u_int8_t pf, int optval, char __user *opt,
222
		  unsigned int len);
223
int nf_getsockopt(struct sock *sk, u_int8_t pf, int optval, char __user *opt,
L
Linus Torvalds 已提交
224 225
		  int *len);

226
int compat_nf_setsockopt(struct sock *sk, u_int8_t pf, int optval,
227
		char __user *opt, unsigned int len);
228
int compat_nf_getsockopt(struct sock *sk, u_int8_t pf, int optval,
229 230
		char __user *opt, int *len);

231 232 233
/* Call this before modifying an existing packet: ensures it is
   modifiable and linear to the point you care about (writable_len).
   Returns true or false. */
234
extern int skb_make_writable(struct sk_buff *skb, unsigned int writable_len);
235

236
struct flowi;
237
struct nf_queue_entry;
238

239 240
struct nf_afinfo {
	unsigned short	family;
241
	__sum16		(*checksum)(struct sk_buff *skb, unsigned int hook,
242
				    unsigned int dataoff, u_int8_t protocol);
243 244 245 246 247
	__sum16		(*checksum_partial)(struct sk_buff *skb,
					    unsigned int hook,
					    unsigned int dataoff,
					    unsigned int len,
					    u_int8_t protocol);
248
	int		(*route)(struct dst_entry **dst, struct flowi *fl);
249
	void		(*saveroute)(const struct sk_buff *skb,
250
				     struct nf_queue_entry *entry);
251
	int		(*reroute)(struct sk_buff *skb,
252
				   const struct nf_queue_entry *entry);
253
	int		route_key_size;
254 255
};

256
extern const struct nf_afinfo *nf_afinfo[NFPROTO_NUMPROTO];
257
static inline const struct nf_afinfo *nf_get_afinfo(unsigned short family)
258 259 260
{
	return rcu_dereference(nf_afinfo[family]);
}
261

262
static inline __sum16
263 264 265
nf_checksum(struct sk_buff *skb, unsigned int hook, unsigned int dataoff,
	    u_int8_t protocol, unsigned short family)
{
266
	const struct nf_afinfo *afinfo;
267
	__sum16 csum = 0;
268 269 270 271 272 273 274 275 276

	rcu_read_lock();
	afinfo = nf_get_afinfo(family);
	if (afinfo)
		csum = afinfo->checksum(skb, hook, dataoff, protocol);
	rcu_read_unlock();
	return csum;
}

277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
static inline __sum16
nf_checksum_partial(struct sk_buff *skb, unsigned int hook,
		    unsigned int dataoff, unsigned int len,
		    u_int8_t protocol, unsigned short family)
{
	const struct nf_afinfo *afinfo;
	__sum16 csum = 0;

	rcu_read_lock();
	afinfo = nf_get_afinfo(family);
	if (afinfo)
		csum = afinfo->checksum_partial(skb, hook, dataoff, len,
						protocol);
	rcu_read_unlock();
	return csum;
}

294 295
extern int nf_register_afinfo(const struct nf_afinfo *afinfo);
extern void nf_unregister_afinfo(const struct nf_afinfo *afinfo);
296

297 298 299 300
#include <net/flow.h>
extern void (*ip_nat_decode_session)(struct sk_buff *, struct flowi *);

static inline void
301
nf_nat_decode_session(struct sk_buff *skb, struct flowi *fl, u_int8_t family)
302
{
303
#ifdef CONFIG_NF_NAT_NEEDED
304 305
	void (*decodefn)(struct sk_buff *, struct flowi *);

306 307 308 309 310 311 312
	if (family == AF_INET) {
		rcu_read_lock();
		decodefn = rcu_dereference(ip_nat_decode_session);
		if (decodefn)
			decodefn(skb, fl);
		rcu_read_unlock();
	}
313 314 315
#endif
}

316 317 318 319 320
#ifdef CONFIG_PROC_FS
#include <linux/proc_fs.h>
extern struct proc_dir_entry *proc_net_netfilter;
#endif

L
Linus Torvalds 已提交
321 322
#else /* !CONFIG_NETFILTER */
#define NF_HOOK(pf, hook, skb, indev, outdev, okfn) (okfn)(skb)
323
#define NF_HOOK_COND(pf, hook, skb, indev, outdev, okfn, cond) (okfn)(skb)
324
static inline int nf_hook_thresh(u_int8_t pf, unsigned int hook,
325
				 struct sk_buff *skb,
326 327
				 struct net_device *indev,
				 struct net_device *outdev,
328 329
				 int (*okfn)(struct sk_buff *), int thresh,
				 int cond)
330
{
331
	return okfn(skb);
332
}
333
static inline int nf_hook(u_int8_t pf, unsigned int hook, struct sk_buff *skb,
334 335 336
			  struct net_device *indev, struct net_device *outdev,
			  int (*okfn)(struct sk_buff *))
{
337
	return 1;
338 339
}
struct flowi;
340
static inline void
341 342 343
nf_nat_decode_session(struct sk_buff *skb, struct flowi *fl, u_int8_t family)
{
}
L
Linus Torvalds 已提交
344 345
#endif /*CONFIG_NETFILTER*/

346 347 348
#if defined(CONFIG_NF_CONNTRACK) || defined(CONFIG_NF_CONNTRACK_MODULE)
extern void (*ip_ct_attach)(struct sk_buff *, struct sk_buff *);
extern void nf_ct_attach(struct sk_buff *, struct sk_buff *);
349
extern void (*nf_ct_destroy)(struct nf_conntrack *);
350 351 352 353
#else
static inline void nf_ct_attach(struct sk_buff *new, struct sk_buff *skb) {}
#endif

L
Linus Torvalds 已提交
354 355
#endif /*__KERNEL__*/
#endif /*__LINUX_NETFILTER_H*/