2 * Copyright (C) 2012 by Darren Reed.
4 * See the IPFILTER.LICENCE file for details on licencing.
6 * @(#)ip_fil.h 1.35 6/5/96
8 * Id: ip_fil.h,v 2.170.2.51 2007/10/10 09:48:03 darrenr Exp $
14 # include <netinet/in.h>
16 #include "netinet/ip_compat.h"
17 #include "netinet/ipf_rb.h"
18 #if NETBSD_GE_REV(104040000)
19 # include <sys/callout.h>
21 #if defined(BSD) && defined(_KERNEL)
22 # include <sys/selinfo.h>
26 # if defined(sun) && defined(__SVR4)
41 #if defined(__STDC__) || defined(__GNUC__)
42 # define SIOCADAFR _IOW('r', 60, struct ipfobj)
43 # define SIOCRMAFR _IOW('r', 61, struct ipfobj)
44 # define SIOCSETFF _IOW('r', 62, u_int)
45 # define SIOCGETFF _IOR('r', 63, u_int)
46 # define SIOCGETFS _IOWR('r', 64, struct ipfobj)
47 # define SIOCIPFFL _IOWR('r', 65, int)
48 # define SIOCIPFFB _IOR('r', 66, int)
49 # define SIOCADIFR _IOW('r', 67, struct ipfobj)
50 # define SIOCRMIFR _IOW('r', 68, struct ipfobj)
51 # define SIOCSWAPA _IOR('r', 69, u_int)
52 # define SIOCINAFR _IOW('r', 70, struct ipfobj)
53 # define SIOCINIFR _IOW('r', 71, struct ipfobj)
54 # define SIOCFRENB _IOW('r', 72, u_int)
55 # define SIOCFRSYN _IOW('r', 73, u_int)
56 # define SIOCFRZST _IOWR('r', 74, struct ipfobj)
57 # define SIOCZRLST _IOWR('r', 75, struct ipfobj)
58 # define SIOCAUTHW _IOWR('r', 76, struct ipfobj)
59 # define SIOCAUTHR _IOWR('r', 77, struct ipfobj)
60 # define SIOCSTAT1 _IOWR('r', 78, struct ipfobj)
61 # define SIOCSTLCK _IOWR('r', 79, u_int)
62 # define SIOCSTPUT _IOWR('r', 80, struct ipfobj)
63 # define SIOCSTGET _IOWR('r', 81, struct ipfobj)
64 # define SIOCSTGSZ _IOWR('r', 82, struct ipfobj)
65 # define SIOCSTAT2 _IOWR('r', 83, struct ipfobj)
66 # define SIOCSETLG _IOWR('r', 84, int)
67 # define SIOCGETLG _IOWR('r', 85, int)
68 # define SIOCFUNCL _IOWR('r', 86, struct ipfunc_resolve)
69 # define SIOCIPFGETNEXT _IOWR('r', 87, struct ipfobj)
70 # define SIOCIPFGET _IOWR('r', 88, struct ipfobj)
71 # define SIOCIPFSET _IOWR('r', 89, struct ipfobj)
72 # define SIOCIPFL6 _IOWR('r', 90, int)
73 # define SIOCIPFITER _IOWR('r', 91, struct ipfobj)
74 # define SIOCGENITER _IOWR('r', 92, struct ipfobj)
75 # define SIOCGTABL _IOWR('r', 93, struct ipfobj)
76 # define SIOCIPFDELTOK _IOWR('r', 94, int)
77 # define SIOCLOOKUPITER _IOWR('r', 95, struct ipfobj)
78 # define SIOCGTQTAB _IOWR('r', 96, struct ipfobj)
79 # define SIOCMATCHFLUSH _IOWR('r', 97, struct ipfobj)
80 # define SIOCIPFINTERROR _IOR('r', 98, int)
82 # define SIOCADAFR _IOW(r, 60, struct ipfobj)
83 # define SIOCRMAFR _IOW(r, 61, struct ipfobj)
84 # define SIOCSETFF _IOW(r, 62, u_int)
85 # define SIOCGETFF _IOR(r, 63, u_int)
86 # define SIOCGETFS _IOWR(r, 64, struct ipfobj)
87 # define SIOCIPFFL _IOWR(r, 65, int)
88 # define SIOCIPFFB _IOR(r, 66, int)
89 # define SIOCADIFR _IOW(r, 67, struct ipfobj)
90 # define SIOCRMIFR _IOW(r, 68, struct ipfobj)
91 # define SIOCSWAPA _IOR(r, 69, u_int)
92 # define SIOCINAFR _IOW(r, 70, struct ipfobj)
93 # define SIOCINIFR _IOW(r, 71, struct ipfobj)
94 # define SIOCFRENB _IOW(r, 72, u_int)
95 # define SIOCFRSYN _IOW(r, 73, u_int)
96 # define SIOCFRZST _IOWR(r, 74, struct ipfobj)
97 # define SIOCZRLST _IOWR(r, 75, struct ipfobj)
98 # define SIOCAUTHW _IOWR(r, 76, struct ipfobj)
99 # define SIOCAUTHR _IOWR(r, 77, struct ipfobj)
100 # define SIOCSTAT1 _IOWR(r, 78, struct ipfobj)
101 # define SIOCSTLCK _IOWR(r, 79, u_int)
102 # define SIOCSTPUT _IOWR(r, 80, struct ipfobj)
103 # define SIOCSTGET _IOWR(r, 81, struct ipfobj)
104 # define SIOCSTGSZ _IOWR(r, 82, struct ipfobj)
105 # define SIOCSTAT2 _IOWR(r, 83, struct ipfobj)
106 # define SIOCSETLG _IOWR(r, 84, int)
107 # define SIOCGETLG _IOWR(r, 85, int)
108 # define SIOCFUNCL _IOWR(r, 86, struct ipfunc_resolve)
109 # define SIOCIPFGETNEXT _IOWR(r, 87, struct ipfobj)
110 # define SIOCIPFGET _IOWR(r, 88, struct ipfobj)
111 # define SIOCIPFSET _IOWR(r, 89, struct ipfobj)
112 # define SIOCIPFL6 _IOWR(r, 90, int)
113 # define SIOCIPFITER _IOWR(r, 91, struct ipfobj)
114 # define SIOCGENITER _IOWR(r, 92, struct ipfobj)
115 # define SIOCGTABL _IOWR(r, 93, struct ipfobj)
116 # define SIOCIPFDELTOK _IOWR(r, 94, int)
117 # define SIOCLOOKUPITER _IOWR(r, 95, struct ipfobj)
118 # define SIOCGTQTAB _IOWR(r, 96, struct ipfobj)
119 # define SIOCMATCHFLUSH _IOWR(r, 97, struct ipfobj)
120 # define SIOCIPFINTERROR _IOR(r, 98, int)
122 #define SIOCADDFR SIOCADAFR
123 #define SIOCDELFR SIOCRMAFR
124 #define SIOCINSFR SIOCINAFR
125 #define SIOCATHST SIOCSTAT1
126 #define SIOCGFRST SIOCSTAT2
131 struct ipf_main_softc_s;
133 typedef int (* lookupfunc_t) __P((struct ipf_main_softc_s *, void *,
134 int, void *, u_int));
137 * i6addr is used as a container for both IPv4 and IPv6 addresses, as well
138 * as other types of objects, depending on its qualifier.
140 typedef union i6addr {
147 lookupfunc_t lptr[2];
155 #define in4_addr in4.s_addr
156 #define iplookupnum i6[1]
157 #define iplookupname i6un.name
158 #define iplookuptype i6un.type
159 #define iplookupsubtype i6un.subtype
161 * NOTE: These DO overlap the above on 64bit systems and this IS recognised.
163 #define iplookupptr vptr[0]
164 #define iplookupfunc lptr[1]
166 #define I60(x) (((u_32_t *)(x))[0])
167 #define I61(x) (((u_32_t *)(x))[1])
168 #define I62(x) (((u_32_t *)(x))[2])
169 #define I63(x) (((u_32_t *)(x))[3])
170 #define HI60(x) ntohl(((u_32_t *)(x))[0])
171 #define HI61(x) ntohl(((u_32_t *)(x))[1])
172 #define HI62(x) ntohl(((u_32_t *)(x))[2])
173 #define HI63(x) ntohl(((u_32_t *)(x))[3])
175 #define IP6_EQ(a,b) ((I63(a) == I63(b)) && (I62(a) == I62(b)) && \
176 (I61(a) == I61(b)) && (I60(a) == I60(b)))
177 #define IP6_NEQ(a,b) ((I63(a) != I63(b)) || (I62(a) != I62(b)) || \
178 (I61(a) != I61(b)) || (I60(a) != I60(b)))
179 #define IP6_ISZERO(a) ((I60(a) | I61(a) | I62(a) | I63(a)) == 0)
180 #define IP6_NOTZERO(a) ((I60(a) | I61(a) | I62(a) | I63(a)) != 0)
181 #define IP6_ISONES(a) ((I63(a) == 0xffffffff) && (I62(a) == 0xffffffff) && \
182 (I61(a) == 0xffffffff) && (I60(a) == 0xffffffff))
183 #define IP6_GT(a,b) (ntohl(HI60(a)) > ntohl(HI60(b)) || \
184 (HI60(a) == HI60(b) && \
185 (ntohl(HI61(a)) > ntohl(HI61(b)) || \
186 (HI61(a) == HI61(b) && \
187 (ntohl(HI62(a)) > ntohl(HI62(b)) || \
188 (HI62(a) == HI62(b) && \
189 ntohl(HI63(a)) > ntohl(HI63(b))))))))
190 #define IP6_LT(a,b) (ntohl(HI60(a)) < ntohl(HI60(b)) || \
191 (HI60(a) == HI60(b) && \
192 (ntohl(HI61(a)) < ntohl(HI61(b)) || \
193 (HI61(a) == HI61(b) && \
194 (ntohl(HI62(a)) < ntohl(HI62(b)) || \
195 (HI62(a) == HI62(b) && \
196 ntohl(HI63(a)) < ntohl(HI63(b))))))))
197 #define NLADD(n,x) htonl(ntohl(n) + (x))
199 do { u_32_t *_i6 = (u_32_t *)(a); \
200 _i6[3] = NLADD(_i6[3], 1); \
202 _i6[2] = NLADD(_i6[2], 1); \
204 _i6[1] = NLADD(_i6[1], 1); \
206 _i6[0] = NLADD(_i6[0], 1); \
211 #define IP6_ADD(a,x,d) \
212 do { i6addr_t *_s = (i6addr_t *)(a); \
213 i6addr_t *_d = (i6addr_t *)(d); \
214 _d->i6[0] = NLADD(_s->i6[0], x); \
215 if (ntohl(_d->i6[0]) < ntohl(_s->i6[0])) { \
216 _d->i6[1] = NLADD(_d->i6[1], 1); \
217 if (ntohl(_d->i6[1]) < ntohl(_s->i6[1])) { \
218 _d->i6[2] = NLADD(_d->i6[2], 1); \
219 if (ntohl(_d->i6[2]) < ntohl(_s->i6[2])) { \
220 _d->i6[3] = NLADD(_d->i6[3], 1); \
225 #define IP6_AND(a,b,d) do { i6addr_t *_s1 = (i6addr_t *)(a); \
226 i6addr_t *_s2 = (i6addr_t *)(b); \
227 i6addr_t *_d = (i6addr_t *)(d); \
228 _d->i6[0] = _s1->i6[0] & _s2->i6[0]; \
229 _d->i6[1] = _s1->i6[1] & _s2->i6[1]; \
230 _d->i6[2] = _s1->i6[2] & _s2->i6[2]; \
231 _d->i6[3] = _s1->i6[3] & _s2->i6[3]; \
233 #define IP6_ANDASSIGN(a,m) \
234 do { i6addr_t *_d = (i6addr_t *)(a); \
235 i6addr_t *_m = (i6addr_t *)(m); \
236 _d->i6[0] &= _m->i6[0]; \
237 _d->i6[1] &= _m->i6[1]; \
238 _d->i6[2] &= _m->i6[2]; \
239 _d->i6[3] &= _m->i6[3]; \
241 #define IP6_MASKEQ(a,m,b) \
242 (((I60(a) & I60(m)) == I60(b)) && \
243 ((I61(a) & I61(m)) == I61(b)) && \
244 ((I62(a) & I62(m)) == I62(b)) && \
245 ((I63(a) & I63(m)) == I63(b)))
246 #define IP6_MASKNEQ(a,m,b) \
247 (((I60(a) & I60(m)) != I60(b)) || \
248 ((I61(a) & I61(m)) != I61(b)) || \
249 ((I62(a) & I62(m)) != I62(b)) || \
250 ((I63(a) & I63(m)) != I63(b)))
251 #define IP6_MERGE(a,b,c) \
252 do { i6addr_t *_d, *_s1, *_s2; \
253 _d = (i6addr_t *)(a); \
254 _s1 = (i6addr_t *)(b); \
255 _s2 = (i6addr_t *)(c); \
256 _d->i6[0] |= _s1->i6[0] & ~_s2->i6[0]; \
257 _d->i6[1] |= _s1->i6[1] & ~_s2->i6[1]; \
258 _d->i6[2] |= _s1->i6[2] & ~_s2->i6[2]; \
259 _d->i6[3] |= _s1->i6[3] & ~_s2->i6[3]; \
261 #define IP6_MASK(a,b,c) \
262 do { i6addr_t *_d, *_s1, *_s2; \
263 _d = (i6addr_t *)(a); \
264 _s1 = (i6addr_t *)(b); \
265 _s2 = (i6addr_t *)(c); \
266 _d->i6[0] = _s1->i6[0] & ~_s2->i6[0]; \
267 _d->i6[1] = _s1->i6[1] & ~_s2->i6[1]; \
268 _d->i6[2] = _s1->i6[2] & ~_s2->i6[2]; \
269 _d->i6[3] = _s1->i6[3] & ~_s2->i6[3]; \
271 #define IP6_SETONES(a) \
272 do { i6addr_t *_d = (i6addr_t *)(a); \
273 _d->i6[0] = 0xffffffff; \
274 _d->i6[1] = 0xffffffff; \
275 _d->i6[2] = 0xffffffff; \
276 _d->i6[3] = 0xffffffff; \
279 typedef union ipso_u {
280 u_short ipso_ripso[2];
284 typedef struct fr_ip {
285 u_32_t fi_v:4; /* IP version */
286 u_32_t fi_xx:4; /* spare */
287 u_32_t fi_tos:8; /* IP packet TOS */
288 u_32_t fi_ttl:8; /* IP packet TTL */
289 u_32_t fi_p:8; /* IP packet protocol */
290 u_32_t fi_optmsk; /* bitmask composed from IP options */
291 i6addr_t fi_src; /* source address from packet */
292 i6addr_t fi_dst; /* destination address from packet */
293 ipso_t fi_ipso; /* IP security options */
294 u_32_t fi_flx; /* packet flags */
295 u_32_t fi_tcpmsk; /* TCP options set/reset */
296 u_32_t fi_ports[2]; /* TCP ports */
297 u_char fi_tcpf; /* TCP flags */
298 u_char fi_sensitivity;
299 u_char fi_xxx[2]; /* pad */
305 #define FI_TCPUDP 0x0001 /* TCP/UCP implied comparison*/
306 #define FI_OPTIONS 0x0002
307 #define FI_FRAG 0x0004
308 #define FI_SHORT 0x0008
309 #define FI_NATED 0x0010
310 #define FI_MULTICAST 0x0020
311 #define FI_BROADCAST 0x0040
312 #define FI_MBCAST 0x0080
313 #define FI_STATE 0x0100
314 #define FI_BADNAT 0x0200
315 #define FI_BAD 0x0400
316 #define FI_OOW 0x0800 /* Out of state window, else match */
317 #define FI_ICMPERR 0x1000
318 #define FI_FRAGBODY 0x2000
319 #define FI_BADSRC 0x4000
320 #define FI_LOWTTL 0x8000
321 #define FI_CMP 0x5cfe3 /* Not FI_FRAG,FI_NATED,FI_FRAGTAIL */
322 #define FI_ICMPCMP 0x0003 /* Flags we can check for ICMP error packets */
323 #define FI_WITH 0x5effe /* Not FI_TCPUDP */
324 #define FI_V6EXTHDR 0x10000
325 #define FI_COALESCE 0x20000
326 #define FI_NEWNAT 0x40000
327 #define FI_ICMPQUERY 0x80000
328 #define FI_ENCAP 0x100000 /* encap/decap with NAT */
329 #define FI_AH 0x200000 /* AH header present */
330 #define FI_DOCKSUM 0x10000000 /* Proxy wants L4 recalculation */
331 #define FI_NOCKSUM 0x20000000 /* don't do a L4 checksum validation */
332 #define FI_NOWILD 0x40000000 /* Do not do wildcard searches */
333 #define FI_IGNORE 0x80000000
335 #define fi_secmsk fi_ipso.ipso_ripso[0]
336 #define fi_auth fi_ipso.ipso_ripso[1]
337 #define fi_doi fi_ipso.ipso_doi
338 #define fi_saddr fi_src.in4.s_addr
339 #define fi_daddr fi_dst.in4.s_addr
340 #define fi_srcnum fi_src.iplookupnum
341 #define fi_dstnum fi_dst.iplookupnum
342 #define fi_srcname fi_src.iplookupname
343 #define fi_dstname fi_dst.iplookupname
344 #define fi_srctype fi_src.iplookuptype
345 #define fi_dsttype fi_dst.iplookuptype
346 #define fi_srcsubtype fi_src.iplookupsubtype
347 #define fi_dstsubtype fi_dst.iplookupsubtype
348 #define fi_srcptr fi_src.iplookupptr
349 #define fi_dstptr fi_dst.iplookupptr
350 #define fi_srcfunc fi_src.iplookupfunc
351 #define fi_dstfunc fi_dst.iplookupfunc
355 * These are both used by the state and NAT code to indicate that one port or
356 * the other should be treated as a wildcard.
357 * NOTE: When updating, check bit masks in ip_state.h and update there too.
359 #define SI_W_SPORT 0x00000100
360 #define SI_W_DPORT 0x00000200
361 #define SI_WILDP (SI_W_SPORT|SI_W_DPORT)
362 #define SI_W_SADDR 0x00000400
363 #define SI_W_DADDR 0x00000800
364 #define SI_WILDA (SI_W_SADDR|SI_W_DADDR)
365 #define SI_NEWFR 0x00001000
366 #define SI_CLONE 0x00002000
367 #define SI_CLONED 0x00004000
368 #define SI_NEWCLONE 0x00008000
371 u_short fda_ports[2];
372 u_char fda_tcpf; /* TCP header flags (SYN, ACK, etc) */
375 typedef enum fr_breasons_e {
386 FRB_AUTHCAPTURE = 10,
389 FRB_AUTHFEEDBACK = 13,
395 #define FRB_MAX_VALUE 16
397 typedef enum ipf_cksum_e {
405 typedef struct fr_info {
407 void *fin_ifp; /* interface packet is `on' */
408 struct frentry *fin_fr; /* last matching rule */
409 int fin_out; /* in or out ? 1 == out, 0 == in */
410 fr_ip_t fin_fi; /* IP Packet summary */
411 frdat_t fin_dat; /* TCP/UDP ports, ICMP code/type */
412 int fin_dlen; /* length of data portion of packet */
414 u_32_t fin_rule; /* rule # last matched */
415 u_short fin_hlen; /* length of IP header in bytes */
416 char fin_group[FR_GROUPLEN]; /* group number, -1 for none */
417 void *fin_dp; /* start of data past IP header */
419 * Fields after fin_dp aren't used for compression of log records.
420 * fin_fi contains the IP version (fin_family)
421 * fin_rule isn't included because adding a new rule can change it but
422 * not change fin_fr. fin_rule is the rule number reported.
423 * It isn't necessary to include fin_crc because that is checked
424 * for explicitly, before calling bcmp.
426 u_32_t fin_crc; /* Simple calculation for logging */
427 int fin_family; /* AF_INET, etc. */
428 int fin_icode; /* ICMP error to return */
429 int fin_mtu; /* MTU input for ICMP need-frag */
430 int fin_rev; /* state only: 1 = reverse */
431 int fin_ipoff; /* # bytes from buffer start to hdr */
432 u_32_t fin_id; /* IP packet id field */
433 u_short fin_l4hlen; /* length of L4 header, if known */
435 int fin_depth; /* Group nesting depth */
436 int fin_error; /* Error code to return */
437 ipf_cksum_t fin_cksum; /* -1 = bad, 1 = good, 0 = not done */
438 fr_breason_t fin_reason; /* why auto blocked */
441 struct frdest *fin_dif;
442 struct frdest *fin_tif;
449 mb_t **fin_mp; /* pointer to pointer to mbuf */
450 mb_t *fin_m; /* pointer to mbuf */
452 mb_t *fin_qfm; /* pointer to mblk where pkt starts */
454 char fin_ifname[LIFNAMSIZ];
456 void *fin_fraghdr; /* pointer to start of ipv6 frag hdr */
459 #define fin_ip fin_ipu.fip_ip
460 #define fin_ip6 fin_ipu.fip_ip6
461 #define fin_v fin_fi.fi_v
462 #define fin_p fin_fi.fi_p
463 #define fin_flx fin_fi.fi_flx
464 #define fin_optmsk fin_fi.fi_optmsk
465 #define fin_secmsk fin_fi.fi_secmsk
466 #define fin_doi fin_fi.fi_doi
467 #define fin_auth fin_fi.fi_auth
468 #define fin_src fin_fi.fi_src.in4
469 #define fin_saddr fin_fi.fi_saddr
470 #define fin_dst fin_fi.fi_dst.in4
471 #define fin_daddr fin_fi.fi_daddr
472 #define fin_data fin_fi.fi_ports
473 #define fin_sport fin_fi.fi_ports[0]
474 #define fin_dport fin_fi.fi_ports[1]
475 #define fin_tcpf fin_fi.fi_tcpf
476 #define fin_src6 fin_fi.fi_src
477 #define fin_dst6 fin_fi.fi_dst
478 #define fin_srcip6 fin_fi.fi_src.in6
479 #define fin_dstip6 fin_fi.fi_dst.in6
484 typedef struct frentry *(*ipfunc_t) __P((fr_info_t *, u_32_t *));
485 typedef int (*ipfuncinit_t) __P((struct ipf_main_softc_s *, struct frentry *));
487 typedef struct ipfunc_resolve {
490 ipfuncinit_t ipfu_init;
491 ipfuncinit_t ipfu_fini;
495 * Size for compares on fr_info structures
497 #define FI_CSIZE offsetof(fr_info_t, fin_icode)
498 #define FI_LCSIZE offsetof(fr_info_t, fin_dp)
501 * Size for copying cache fr_info structure
503 #define FI_COPYSIZE offsetof(fr_info_t, fin_dp)
506 * Structure for holding IPFilter's tag information
508 #define IPFTAG_LEN 16
512 char iptu_tag[IPFTAG_LEN];
517 #define ipt_tag ipt_un.iptu_tag
518 #define ipt_num ipt_un.iptu_num
521 * Structure to define address for pool lookups.
525 sa_family_t adf_family;
531 RBI_LINK(ipf_rb, host_node_s);
533 typedef struct host_node_s {
534 RBI_FIELD(ipf_rb) hn_entry;
535 addrfamily_t hn_addr;
539 typedef RBI_HEAD(ipf_rb, host_node_s) ipf_rb_head_t;
541 typedef struct host_track_s {
542 ipf_rb_head_t ht_root;
550 typedef enum fr_dtypes_e {
555 * This structure is used to hold information about the next hop for where
556 * to forward a packet.
558 typedef struct frdest {
560 addrfamily_t fd_addr;
566 #define fd_ip6 fd_addr.adf_addr
567 #define fd_ip fd_ip6.in4
570 typedef enum fr_ctypes_e {
584 * This structure holds information about a port comparison.
586 typedef struct frpcmp {
587 fr_ctypes_t frp_cmp; /* data for port comparisons */
588 u_32_t frp_port; /* top port for <> and >< */
589 u_32_t frp_top; /* top port for <> and >< */
594 * Structure containing all the relevant TCP things that can be checked in
597 typedef struct frtuc {
598 u_char ftu_tcpfm; /* tcp flags mask */
599 u_char ftu_tcpf; /* tcp flags */
604 #define ftu_scmp ftu_src.frp_cmp
605 #define ftu_dcmp ftu_dst.frp_cmp
606 #define ftu_sport ftu_src.frp_port
607 #define ftu_dport ftu_dst.frp_port
608 #define ftu_stop ftu_src.frp_top
609 #define ftu_dtop ftu_dst.frp_top
611 #define FR_TCPFMAX 0x3f
613 typedef enum fr_atypes_e {
614 FRI_NONE = -1, /* For LHS of NAT */
615 FRI_NORMAL = 0, /* Normal address */
616 FRI_DYNAMIC, /* dynamic address */
617 FRI_LOOKUP, /* address is a pool # */
618 FRI_RANGE, /* address/mask is a range */
619 FRI_NETWORK, /* network address from if */
620 FRI_BROADCAST, /* broadcast address from if */
621 FRI_PEERADDR, /* Peer address for P-to-P */
622 FRI_NETMASKED, /* network address with netmask from if */
623 FRI_SPLIT, /* For NAT compatibility */
624 FRI_INTERFACE /* address is based on interface name */
628 * This structure makes up what is considered to be the IPFilter specific
629 * matching components of a filter rule, as opposed to the data structures
630 * used to define the result which are in frentry_t and not here.
632 typedef struct fripf {
634 fr_ip_t fri_mip; /* mask structure */
636 u_short fri_icmpm; /* data for ICMP packets (mask) */
640 fr_atypes_t fri_satype; /* addres type */
641 fr_atypes_t fri_datype; /* addres type */
642 int fri_sifpidx; /* doing dynamic addressing */
643 int fri_difpidx; /* index into fr_ifps[] to use when */
646 #define fri_dlookup fri_mip.fi_dst
647 #define fri_slookup fri_mip.fi_src
648 #define fri_dstnum fri_mip.fi_dstnum
649 #define fri_srcnum fri_mip.fi_srcnum
650 #define fri_dstname fri_mip.fi_dstname
651 #define fri_srcname fri_mip.fi_srcname
652 #define fri_dstptr fri_mip.fi_dstptr
653 #define fri_srcptr fri_mip.fi_srcptr
656 typedef enum fr_rtypes_e {
658 FR_T_IPF, /* IPF structures */
659 FR_T_BPFOPC, /* BPF opcode */
660 FR_T_CALLFUNC, /* callout to function in fr_func only */
661 FR_T_COMPIPF, /* compiled C code */
662 FR_T_IPFEXPR, /* IPF expression */
663 FR_T_BUILTIN = 0x40000000, /* rule is in kernel space */
666 FR_T_CALLFUNC_BUILTIN,
667 FR_T_COMPIPF_BUILTIN,
671 typedef struct frentry * (* frentfunc_t) __P((fr_info_t *));
673 typedef struct frentry {
675 struct frentry *fr_next;
676 struct frentry **fr_pnext;
677 struct frgroup *fr_grp;
678 struct frgroup *fr_grphead;
679 struct frgroup *fr_icmpgrp;
680 struct ipscan *fr_isc;
681 struct frentry *fr_dnext; /* 2 fr_die linked list pointers */
682 struct frentry **fr_pdnext;
684 void *fr_ptr; /* for use with fr_arg */
685 int fr_comment; /* text comment for rule */
686 int fr_size; /* size of this structure */
687 int fr_ref; /* reference count */
688 int fr_statecnt; /* state count - for limit rules */
689 u_32_t fr_die; /* only used on loading the rule */
690 u_int fr_cksum; /* checksum on filter rules for performance */
692 * The line number from a file is here because we need to be able to
693 * match the rule generated with ``grep rule ipf.conf | ipf -rf -''
694 * with the rule loaded using ``ipf -f ipf.conf'' - thus it can't be
695 * on the other side of fr_func.
697 int fr_flineno; /* line number from conf file */
699 * These are only incremented when a packet matches this rule and
700 * it is the last match
706 * For PPS rate limiting
707 * fr_lpu is used to always have the same size for this field,
708 * allocating 64bits for seconds and 32bits for milliseconds.
711 struct timeval frp_lastpkt;
720 frentfunc_t fru_func;
724 * Fields after this may not change whilst in the kernel.
726 ipfunc_t fr_func; /* call this function */
730 u_32_t fr_flags; /* per-rule flags && options (see below) */
731 u_32_t fr_logtag; /* user defined log tag # */
732 u_32_t fr_collect; /* collection number */
733 u_int fr_arg; /* misc. numeric arg for rule */
734 u_int fr_loglevel; /* syslog log facility + priority */
736 u_char fr_icode; /* return ICMP code */
737 int fr_group; /* group to which this rule belongs */
738 int fr_grhead; /* group # which this rule starts */
741 int fr_rpc; /* XID Filtering */
743 frdest_t fr_tifs[2]; /* "to"/"reply-to" interface */
744 frdest_t fr_dif; /* duplicate packet interface */
746 * These are all options related to stateful filtering
748 host_track_t fr_srctrack;
750 int fr_statemax; /* max reference count */
751 int fr_icmphead; /* ICMP group for state options */
752 u_int fr_age[2]; /* non-TCP state timeouts */
754 * How big is the name buffer at the end?
760 #define fr_lastpkt fr_lpu.frp_lastpkt
761 #define fr_caddr fr_dun.fru_caddr
762 #define fr_data fr_dun.fru_data
763 #define fr_dfunc fr_dun.fru_func
764 #define fr_ipf fr_dun.fru_ipf
765 #define fr_ip fr_ipf->fri_ip
766 #define fr_mip fr_ipf->fri_mip
767 #define fr_icmpm fr_ipf->fri_icmpm
768 #define fr_icmp fr_ipf->fri_icmp
769 #define fr_tuc fr_ipf->fri_tuc
770 #define fr_satype fr_ipf->fri_satype
771 #define fr_datype fr_ipf->fri_datype
772 #define fr_sifpidx fr_ipf->fri_sifpidx
773 #define fr_difpidx fr_ipf->fri_difpidx
774 #define fr_proto fr_ip.fi_p
775 #define fr_mproto fr_mip.fi_p
776 #define fr_ttl fr_ip.fi_ttl
777 #define fr_mttl fr_mip.fi_ttl
778 #define fr_tos fr_ip.fi_tos
779 #define fr_mtos fr_mip.fi_tos
780 #define fr_tcpfm fr_tuc.ftu_tcpfm
781 #define fr_tcpf fr_tuc.ftu_tcpf
782 #define fr_scmp fr_tuc.ftu_scmp
783 #define fr_dcmp fr_tuc.ftu_dcmp
784 #define fr_dport fr_tuc.ftu_dport
785 #define fr_sport fr_tuc.ftu_sport
786 #define fr_stop fr_tuc.ftu_stop
787 #define fr_dtop fr_tuc.ftu_dtop
788 #define fr_dst fr_ip.fi_dst.in4
789 #define fr_dst6 fr_ip.fi_dst
790 #define fr_daddr fr_ip.fi_dst.in4.s_addr
791 #define fr_src fr_ip.fi_src.in4
792 #define fr_src6 fr_ip.fi_src
793 #define fr_saddr fr_ip.fi_src.in4.s_addr
794 #define fr_dmsk fr_mip.fi_dst.in4
795 #define fr_dmsk6 fr_mip.fi_dst
796 #define fr_dmask fr_mip.fi_dst.in4.s_addr
797 #define fr_smsk fr_mip.fi_src.in4
798 #define fr_smsk6 fr_mip.fi_src
799 #define fr_smask fr_mip.fi_src.in4.s_addr
800 #define fr_dstnum fr_ip.fi_dstnum
801 #define fr_srcnum fr_ip.fi_srcnum
802 #define fr_dlookup fr_ip.fi_dst
803 #define fr_slookup fr_ip.fi_src
804 #define fr_dstname fr_ip.fi_dstname
805 #define fr_srcname fr_ip.fi_srcname
806 #define fr_dsttype fr_ip.fi_dsttype
807 #define fr_srctype fr_ip.fi_srctype
808 #define fr_dstsubtype fr_ip.fi_dstsubtype
809 #define fr_srcsubtype fr_ip.fi_srcsubtype
810 #define fr_dstptr fr_mip.fi_dstptr
811 #define fr_srcptr fr_mip.fi_srcptr
812 #define fr_dstfunc fr_mip.fi_dstfunc
813 #define fr_srcfunc fr_mip.fi_srcfunc
814 #define fr_optbits fr_ip.fi_optmsk
815 #define fr_optmask fr_mip.fi_optmsk
816 #define fr_secbits fr_ip.fi_secmsk
817 #define fr_secmask fr_mip.fi_secmsk
818 #define fr_authbits fr_ip.fi_auth
819 #define fr_authmask fr_mip.fi_auth
820 #define fr_doi fr_ip.fi_doi
821 #define fr_doimask fr_mip.fi_doi
822 #define fr_flx fr_ip.fi_flx
823 #define fr_mflx fr_mip.fi_flx
824 #define fr_ifa fr_ifas[0]
825 #define fr_oifa fr_ifas[2]
826 #define fr_tif fr_tifs[0]
827 #define fr_rif fr_tifs[1]
829 #define FR_NOLOGTAG 0
831 #define FR_CMPSIZ (sizeof(struct frentry) - \
832 offsetof(struct frentry, fr_func))
833 #define FR_NAME(_f, _n) (_f)->fr_names + (_f)->_n
839 #define FR_BLOCK 0x00001 /* do not allow packet to pass */
840 #define FR_PASS 0x00002 /* allow packet to pass */
841 #define FR_AUTH 0x00003 /* use authentication */
842 #define FR_PREAUTH 0x00004 /* require preauthentication */
843 #define FR_ACCOUNT 0x00005 /* Accounting rule */
844 #define FR_SKIP 0x00006 /* skip rule */
845 #define FR_DECAPSULATE 0x00008 /* decapsulate rule */
846 #define FR_CALL 0x00009 /* call rule */
847 #define FR_CMDMASK 0x0000f
848 #define FR_LOG 0x00010 /* Log */
849 #define FR_LOGB 0x00011 /* Log-fail */
850 #define FR_LOGP 0x00012 /* Log-pass */
851 #define FR_LOGMASK (FR_LOG|FR_CMDMASK)
852 #define FR_CALLNOW 0x00020 /* call another function (fr_func) if matches */
853 #define FR_NOTSRCIP 0x00040
854 #define FR_NOTDSTIP 0x00080
855 #define FR_QUICK 0x00100 /* match & stop processing list */
856 #define FR_KEEPFRAG 0x00200 /* keep fragment information */
857 #define FR_KEEPSTATE 0x00400 /* keep `connection' state information */
858 #define FR_FASTROUTE 0x00800 /* bypass normal routing */
859 #define FR_RETRST 0x01000 /* Return TCP RST packet - reset connection */
860 #define FR_RETICMP 0x02000 /* Return ICMP unreachable packet */
861 #define FR_FAKEICMP 0x03000 /* Return ICMP unreachable with fake source */
862 #define FR_OUTQUE 0x04000 /* outgoing packets */
863 #define FR_INQUE 0x08000 /* ingoing packets */
864 #define FR_LOGBODY 0x10000 /* Log the body */
865 #define FR_LOGFIRST 0x20000 /* Log the first byte if state held */
866 #define FR_LOGORBLOCK 0x40000 /* block the packet if it can't be logged */
867 #define FR_STLOOSE 0x80000 /* loose state checking */
868 #define FR_FRSTRICT 0x100000 /* strict frag. cache */
869 #define FR_STSTRICT 0x200000 /* strict keep state */
870 #define FR_NEWISN 0x400000 /* new ISN for outgoing TCP */
871 #define FR_NOICMPERR 0x800000 /* do not match ICMP errors in state */
872 #define FR_STATESYNC 0x1000000 /* synchronize state to slave */
873 #define FR_COPIED 0x2000000 /* copied from user space */
874 #define FR_INACTIVE 0x4000000 /* only used when flush'ing rules */
875 #define FR_NOMATCH 0x8000000 /* no match occured */
876 /* 0x10000000 FF_LOGPASS */
877 /* 0x20000000 FF_LOGBLOCK */
878 /* 0x40000000 FF_LOGNOMATCH */
879 /* 0x80000000 FF_BLOCKNONIP */
881 #define FR_RETMASK (FR_RETICMP|FR_RETRST|FR_FAKEICMP)
882 #define FR_ISBLOCK(x) (((x) & FR_CMDMASK) == FR_BLOCK)
883 #define FR_ISPASS(x) (((x) & FR_CMDMASK) == FR_PASS)
884 #define FR_ISAUTH(x) (((x) & FR_CMDMASK) == FR_AUTH)
885 #define FR_ISPREAUTH(x) (((x) & FR_CMDMASK) == FR_PREAUTH)
886 #define FR_ISACCOUNT(x) (((x) & FR_CMDMASK) == FR_ACCOUNT)
887 #define FR_ISSKIP(x) (((x) & FR_CMDMASK) == FR_SKIP)
888 #define FR_ISDECAPS(x) (((x) & FR_CMDMASK) == FR_DECAPSULATE)
889 #define FR_ISNOMATCH(x) ((x) & FR_NOMATCH)
890 #define FR_INOUT (FR_INQUE|FR_OUTQUE)
893 * recognized flags for SIOCGETFF and SIOCSETFF, and get put in fr_flags
895 #define FF_LOGPASS 0x10000000
896 #define FF_LOGBLOCK 0x20000000
897 #define FF_LOGNOMATCH 0x40000000
898 #define FF_LOGGING (FF_LOGPASS|FF_LOGBLOCK|FF_LOGNOMATCH)
899 #define FF_BLOCKNONIP 0x80000000 /* Solaris2 Only */
903 * Structure that passes information on what/how to flush to the kernel.
905 typedef struct ipfflush {
914 typedef struct ipfgetctl {
915 u_int ipfg_min; /* min value */
916 u_int ipfg_current; /* current value */
917 u_int ipfg_max; /* max value */
918 u_int ipfg_default; /* default value */
919 u_int ipfg_steps; /* value increments */
920 char ipfg_name[40]; /* tag name for this control */
923 typedef struct ipfsetctl {
924 int ipfs_which; /* 0 = min 1 = current 2 = max 3 = default */
925 u_int ipfs_value; /* min value */
926 char ipfs_name[40]; /* tag name for this control */
931 * Some of the statistics below are in their own counters, but most are kept
932 * in this single structure so that they can all easily be collected and
933 * copied back as required.
935 typedef struct ipf_statistics {
936 u_long fr_icmp_coalesce;
938 u_long fr_tcp_pullup;
941 u_long fr_tcp_bad_flags;
942 u_long fr_udp_pullup;
946 u_long fr_v6_badfrag;
947 u_long fr_v6_dst_bad;
948 u_long fr_v6_esp_pullup;
949 u_long fr_v6_ext_short;
950 u_long fr_v6_ext_pullup;
951 u_long fr_v6_ext_hlen;
952 u_long fr_v6_frag_bad;
953 u_long fr_v6_frag_pullup;
954 u_long fr_v6_frag_size;
955 u_long fr_v6_gre_pullup;
956 u_long fr_v6_icmp6_pullup;
958 u_long fr_v6_badttl; /* TTL in packet doesn't reach minimum */
960 u_long fr_v4_ah_pullup;
961 u_long fr_v4_esp_pullup;
962 u_long fr_v4_cipso_bad;
963 u_long fr_v4_cipso_tlen;
964 u_long fr_v4_gre_frag;
965 u_long fr_v4_gre_pullup;
966 u_long fr_v4_icmp_frag;
967 u_long fr_v4_icmp_pullup;
968 u_long fr_v4_badttl; /* TTL in packet doesn't reach minimum */
969 u_long fr_v4_badsrc; /* source received doesn't match route */
970 u_long fr_l4_badcksum; /* layer 4 header checksum failure */
971 u_long fr_badcoalesces;
972 u_long fr_pass; /* packets allowed */
973 u_long fr_block; /* packets denied */
974 u_long fr_nom; /* packets which don't match any rule */
975 u_long fr_short; /* packets which are short */
976 u_long fr_ppkl; /* packets allowed and logged */
977 u_long fr_bpkl; /* packets denied and logged */
978 u_long fr_npkl; /* packets unmatched and logged */
979 u_long fr_ret; /* packets for which a return is sent */
980 u_long fr_acct; /* packets for which counting was performed */
981 u_long fr_bnfr; /* bad attempts to allocate fragment state */
982 u_long fr_nfr; /* new fragment state kept */
983 u_long fr_cfr; /* add new fragment state but complete pkt */
984 u_long fr_bads; /* bad attempts to allocate packet state */
985 u_long fr_ads; /* new packet state kept */
986 u_long fr_chit; /* cached hit */
987 u_long fr_cmiss; /* cached miss */
988 u_long fr_tcpbad; /* TCP checksum check failures */
989 u_long fr_pull[2]; /* good and bad pullup attempts */
990 u_long fr_bad; /* bad IP packets to the filter */
991 u_long fr_ipv6; /* IPv6 packets in/out */
992 u_long fr_ppshit; /* dropped because of pps ceiling */
993 u_long fr_ipud; /* IP id update failures */
994 u_long fr_blocked[FRB_MAX_VALUE + 1];
998 * Log structure. Each packet header logged is prepended by one of these.
999 * Following this in the log records read from the device will be an ipflog
1000 * structure which is then followed by any packet data.
1002 typedef struct iplog {
1006 struct timeval ipl_time;
1008 struct iplog *ipl_next;
1011 #define ipl_sec ipl_time.tv_sec
1012 #define ipl_usec ipl_time.tv_usec
1014 #define IPL_MAGIC 0x49504c4d /* 'IPLM' */
1015 #define IPL_MAGIC_NAT 0x49504c4e /* 'IPLN' */
1016 #define IPL_MAGIC_STATE 0x49504c53 /* 'IPLS' */
1017 #define IPLOG_SIZE sizeof(iplog_t)
1019 typedef struct ipflog {
1026 u_short fl_plen; /* extra data after hlen */
1027 u_short fl_loglevel; /* syslog log level */
1028 char fl_group[FR_GROUPLEN];
1029 u_char fl_hlen; /* length of IP headers saved */
1031 u_char fl_breason; /* from fin_reason */
1032 u_char fl_family; /* address family of packet logged */
1033 char fl_ifname[LIFNAMSIZ];
1037 # define IPF_LOGGING 0
1039 #ifndef IPF_DEFAULT_PASS
1040 # define IPF_DEFAULT_PASS FR_PASS
1043 #define DEFAULT_IPFLOGSIZE 32768
1044 #ifndef IPFILTER_LOGSIZE
1045 # define IPFILTER_LOGSIZE DEFAULT_IPFLOGSIZE
1047 # if IPFILTER_LOGSIZE < 8192
1048 # error IPFILTER_LOGSIZE too small. Must be >= 8192
1052 #define IPF_OPTCOPY 0x07ff00 /* bit mask of copied options */
1055 * Device filenames for reading log information. Use ipf on Solaris2 because
1056 * ipl is already a name used by something else.
1060 # define IPL_NAME "/dev/ipf"
1062 # define IPL_NAME "/dev/ipl"
1066 * Pathnames for various IP Filter control devices. Used by LKM
1067 * and userland, so defined here.
1069 #define IPNAT_NAME "/dev/ipnat"
1070 #define IPSTATE_NAME "/dev/ipstate"
1071 #define IPAUTH_NAME "/dev/ipauth"
1072 #define IPSYNC_NAME "/dev/ipsync"
1073 #define IPSCAN_NAME "/dev/ipscan"
1074 #define IPLOOKUP_NAME "/dev/iplookup"
1076 #define IPL_LOGIPF 0 /* Minor device #'s for accessing logs */
1077 #define IPL_LOGNAT 1
1078 #define IPL_LOGSTATE 2
1079 #define IPL_LOGAUTH 3
1080 #define IPL_LOGSYNC 4
1081 #define IPL_LOGSCAN 5
1082 #define IPL_LOGLOOKUP 6
1083 #define IPL_LOGCOUNT 7
1084 #define IPL_LOGMAX 7
1085 #define IPL_LOGSIZE IPL_LOGMAX + 1
1086 #define IPL_LOGALL -1
1087 #define IPL_LOGNONE -2
1092 typedef struct friostat {
1093 ipf_statistics_t f_st[2];
1094 frentry_t *f_ipf[2][2];
1095 frentry_t *f_acct[2][2];
1097 struct frgroup *f_groups[IPL_LOGSIZE][2];
1102 u_long f_rb_node_max;
1104 int f_locks[IPL_LOGSIZE];
1105 int f_defpass; /* default pass - from fr_pass */
1106 int f_active; /* 1 or 0 - active rule set */
1107 int f_running; /* 1 if running, else 0 */
1108 int f_logging; /* 1 if enabled, else 0 */
1110 char f_version[32]; /* version string */
1113 #define f_fin f_ipf[0]
1114 #define f_fout f_ipf[1]
1115 #define f_acctin f_acct[0]
1116 #define f_acctout f_acct[1]
1118 #define IPF_FEAT_LKM 0x001
1119 #define IPF_FEAT_LOG 0x002
1120 #define IPF_FEAT_LOOKUP 0x004
1121 #define IPF_FEAT_BPF 0x008
1122 #define IPF_FEAT_COMPILED 0x010
1123 #define IPF_FEAT_CKSUM 0x020
1124 #define IPF_FEAT_SYNC 0x040
1125 #define IPF_FEAT_SCAN 0x080
1126 #define IPF_FEAT_IPV6 0x100
1128 typedef struct optlist {
1135 * Group list structure.
1137 typedef struct frgroup {
1138 struct frgroup *fg_next;
1139 struct frentry *fg_head;
1140 struct frentry *fg_start;
1141 struct frgroup **fg_set;
1144 char fg_name[FR_GROUPLEN];
1147 #define FG_NAME(g) (*(g)->fg_name == '\0' ? "" : (g)->fg_name)
1151 * Used by state and NAT tables
1153 typedef struct icmpinfo {
1159 typedef struct udpinfo {
1165 typedef struct tcpdata {
1174 #define TCP_WSCALE_MAX 14
1176 #define TCP_WSCALE_SEEN 0x00000001
1177 #define TCP_WSCALE_FIRST 0x00000002
1178 #define TCP_SACK_PERMIT 0x00000004
1181 typedef struct tcpinfo {
1184 tcpdata_t ts_data[2];
1189 * Structures to define a GRE header as seen in a packet.
1216 typedef struct grehdr {
1218 struct grebits gru_bits;
1225 #define gr_flags gr_un.gru_flags
1226 #define gr_bits gr_un.gru_bits
1227 #define gr_ptype gr_bits.grb_ptype
1228 #define gr_C gr_bits.grb_C
1229 #define gr_R gr_bits.grb_R
1230 #define gr_K gr_bits.grb_K
1231 #define gr_S gr_bits.grb_S
1232 #define gr_s gr_bits.grb_s
1233 #define gr_recur gr_bits.grb_recur
1234 #define gr_A gr_bits.grb_A
1235 #define gr_ver gr_bits.grb_ver
1238 * GRE information tracked by "keep state"
1240 typedef struct greinfo {
1246 #define GRE_REV(x) ((ntohs(x) >> 13) & 7)
1250 * Format of an Authentication header
1252 typedef struct authhdr {
1255 u_short ah_reserved;
1258 /* Following the sequence number field is 0 or more bytes of */
1259 /* authentication data, as specified by ah_plen - RFC 2402. */
1264 * Timeout tail queue list member
1266 typedef struct ipftqent {
1267 struct ipftqent **tqe_pnext;
1268 struct ipftqent *tqe_next;
1269 struct ipftq *tqe_ifq;
1270 void *tqe_parent; /* pointer back to NAT/state struct */
1271 u_32_t tqe_die; /* when this entriy is to die */
1274 int tqe_state[2]; /* current state of this entry */
1277 #define TQE_RULEBASED 0x00000001
1278 #define TQE_DELETE 0x00000002
1282 * Timeout tail queue head for IPFilter
1284 typedef struct ipftq {
1285 ipfmutex_t ifq_lock;
1287 ipftqent_t *ifq_head;
1288 ipftqent_t **ifq_tail;
1289 struct ipftq *ifq_next;
1290 struct ipftq **ifq_pnext;
1295 #define IFQF_USER 0x01 /* User defined aging */
1296 #define IFQF_DELETE 0x02 /* Marked for deletion */
1297 #define IFQF_PROXY 0x04 /* Timeout queue in use by a proxy */
1299 #define IPFTQ_INIT(x,y,z) do { \
1300 (x)->ifq_ttl = (y); \
1301 (x)->ifq_head = NULL; \
1303 (x)->ifq_tail = &(x)->ifq_head; \
1304 MUTEX_INIT(&(x)->ifq_lock, (z)); \
1307 #define IPF_HZ_MULT 1
1308 #define IPF_HZ_DIVIDE 2 /* How many times a second ipfilter */
1309 /* checks its timeout queues. */
1310 #define IPF_TTLVAL(x) (((x) / IPF_HZ_MULT) * IPF_HZ_DIVIDE)
1312 typedef int (*ipftq_delete_fn_t)(struct ipf_main_softc_s *, void *);
1316 * Object structure description. For passing through in ioctls.
1318 typedef struct ipfobj {
1319 u_32_t ipfo_rev; /* IPFilter version number */
1320 u_32_t ipfo_size; /* size of object at ipfo_ptr */
1321 void *ipfo_ptr; /* pointer to object */
1322 int ipfo_type; /* type of object being pointed to */
1323 int ipfo_offset; /* bytes from ipfo_ptr where to start */
1324 int ipfo_retval; /* return value */
1325 u_char ipfo_xxxpad[28]; /* reserved for future use */
1328 #define IPFOBJ_FRENTRY 0 /* struct frentry */
1329 #define IPFOBJ_IPFSTAT 1 /* struct friostat */
1330 #define IPFOBJ_IPFINFO 2 /* struct fr_info */
1331 #define IPFOBJ_AUTHSTAT 3 /* struct fr_authstat */
1332 #define IPFOBJ_FRAGSTAT 4 /* struct ipfrstat */
1333 #define IPFOBJ_IPNAT 5 /* struct ipnat */
1334 #define IPFOBJ_NATSTAT 6 /* struct natstat */
1335 #define IPFOBJ_STATESAVE 7 /* struct ipstate_save */
1336 #define IPFOBJ_NATSAVE 8 /* struct nat_save */
1337 #define IPFOBJ_NATLOOKUP 9 /* struct natlookup */
1338 #define IPFOBJ_IPSTATE 10 /* struct ipstate */
1339 #define IPFOBJ_STATESTAT 11 /* struct ips_stat */
1340 #define IPFOBJ_FRAUTH 12 /* struct frauth */
1341 #define IPFOBJ_TUNEABLE 13 /* struct ipftune */
1342 #define IPFOBJ_NAT 14 /* struct nat */
1343 #define IPFOBJ_IPFITER 15 /* struct ipfruleiter */
1344 #define IPFOBJ_GENITER 16 /* struct ipfgeniter */
1345 #define IPFOBJ_GTABLE 17 /* struct ipftable */
1346 #define IPFOBJ_LOOKUPITER 18 /* struct ipflookupiter */
1347 #define IPFOBJ_STATETQTAB 19 /* struct ipftq * NSTATES */
1348 #define IPFOBJ_IPFEXPR 20
1349 #define IPFOBJ_PROXYCTL 21 /* strct ap_ctl */
1350 #define IPFOBJ_FRIPF 22 /* structfripf */
1351 #define IPFOBJ_COUNT 23 /* How many #defines are above this? */
1354 typedef union ipftunevalptr {
1358 u_short *ipftp_short;
1360 u_long ipftp_offset;
1363 typedef union ipftuneval {
1366 u_short ipftu_short;
1371 typedef int (* ipftunefunc_t) __P((struct ipf_main_softc_s *, struct ipftuneable *, ipftuneval_t *));
1373 typedef struct ipftuneable {
1374 ipftunevalptr_t ipft_una;
1375 const char *ipft_name;
1380 struct ipftuneable *ipft_next;
1381 ipftunefunc_t ipft_func;
1384 #define ipft_addr ipft_una.ipftp_void
1385 #define ipft_plong ipft_una.ipftp_long
1386 #define ipft_pint ipft_una.ipftp_int
1387 #define ipft_pshort ipft_una.ipftp_short
1388 #define ipft_pchar ipft_una.ipftp_char
1390 #define IPFT_RDONLY 1 /* read-only */
1391 #define IPFT_WRDISABLED 2 /* write when disabled only */
1393 typedef struct ipftune {
1395 ipftuneval_t ipft_un;
1403 #define ipft_vlong ipft_un.ipftu_long
1404 #define ipft_vint ipft_un.ipftu_int
1405 #define ipft_vshort ipft_un.ipftu_short
1406 #define ipft_vchar ipft_un.ipftu_char
1411 #define IPFHASH(x,y) typedef struct { \
1412 ipfrwlock_t ipfh_lock; \
1413 struct x *ipfh_head; \
1420 #if !defined(CDEV_MAJOR) && defined (__FreeBSD_version) && \
1421 (__FreeBSD_version >= 220000)
1422 # define CDEV_MAJOR 79
1426 # define FR_VERBOSE(verb_pr)
1427 # define FR_DEBUG(verb_pr)
1429 extern void ipfkdebug __P((char *, ...));
1430 extern void ipfkverbose __P((char *, ...));
1431 # define FR_VERBOSE(verb_pr) ipfkverbose verb_pr
1432 # define FR_DEBUG(verb_pr) ipfkdebug verb_pr
1438 typedef struct ipfruleiter {
1440 char iri_group[FR_GROUPLEN];
1443 int iri_v; /* No longer used (compatibility) */
1444 frentry_t *iri_rule;
1448 * Values for iri_inout
1456 typedef struct ipfgeniter {
1462 #define IPFGENITER_IPF 0
1463 #define IPFGENITER_NAT 1
1464 #define IPFGENITER_IPNAT 2
1465 #define IPFGENITER_FRAG 3
1466 #define IPFGENITER_AUTH 4
1467 #define IPFGENITER_STATE 5
1468 #define IPFGENITER_NATFRAG 6
1469 #define IPFGENITER_HOSTMAP 7
1470 #define IPFGENITER_LOOKUP 8
1472 typedef struct ipftable {
1477 #define IPFTABLE_BUCKETS 1
1478 #define IPFTABLE_BUCKETS_NATIN 2
1479 #define IPFTABLE_BUCKETS_NATOUT 3
1482 typedef struct ipf_v4_masktab_s {
1483 u_32_t imt4_active[33];
1488 typedef struct ipf_v6_masktab_s {
1489 i6addr_t imt6_active[129];
1490 int imt6_masks[129];
1498 typedef struct ipftoken {
1499 struct ipftoken *ipt_next;
1500 struct ipftoken **ipt_pnext;
1515 typedef struct ipfexp {
1524 * Currently support commands (ipfe_cmd)
1525 * 32bits is split up follows:
1527 * aa = 0 = packet matching, 1 = meta data matching
1528 * bb = IP protocol number
1531 #define IPF_EXP_IP_PR 0x00000001
1532 #define IPF_EXP_IP_ADDR 0x00000002
1533 #define IPF_EXP_IP_SRCADDR 0x00000003
1534 #define IPF_EXP_IP_DSTADDR 0x00000004
1535 #define IPF_EXP_IP6_ADDR 0x00000005
1536 #define IPF_EXP_IP6_SRCADDR 0x00000006
1537 #define IPF_EXP_IP6_DSTADDR 0x00000007
1538 #define IPF_EXP_TCP_FLAGS 0x00060001
1539 #define IPF_EXP_TCP_PORT 0x00060002
1540 #define IPF_EXP_TCP_SPORT 0x00060003
1541 #define IPF_EXP_TCP_DPORT 0x00060004
1542 #define IPF_EXP_UDP_PORT 0x00110002
1543 #define IPF_EXP_UDP_SPORT 0x00110003
1544 #define IPF_EXP_UDP_DPORT 0x00110004
1545 #define IPF_EXP_IDLE_GT 0x01000001
1546 #define IPF_EXP_TCP_STATE 0x01060002
1547 #define IPF_EXP_END 0xffffffff
1549 #define ONE_DAY IPF_TTLVAL(1 * 86400) /* 1 day */
1550 #define FIVE_DAYS (5 * ONE_DAY)
1552 typedef struct ipf_main_softc_s {
1553 struct ipf_main_softc_s *ipf_next;
1555 ipfmutex_t ipf_timeoutlock;
1556 ipfrwlock_t ipf_mutex;
1557 ipfrwlock_t ipf_frag;
1558 ipfrwlock_t ipf_global;
1559 ipfrwlock_t ipf_tokens;
1560 ipfrwlock_t ipf_state;
1561 ipfrwlock_t ipf_nat;
1562 ipfrwlock_t ipf_natfrag;
1563 ipfrwlock_t ipf_poolrw;
1564 int ipf_dynamic_softc;
1569 int ipf_control_forwarding;
1570 int ipf_update_ipid;
1571 int ipf_chksrc; /* causes a system crash if enabled */
1574 int ipf_icmpminfragmtu;
1575 int ipf_interror; /* Should be in a struct that is per */
1576 /* thread or process. Does not belong */
1577 /* here but there's a lot more work */
1578 /* in doing that properly. For now, */
1579 /* it is squatting. */
1580 u_int ipf_tcpidletimeout;
1581 u_int ipf_tcpclosewait;
1582 u_int ipf_tcplastack;
1583 u_int ipf_tcptimewait;
1584 u_int ipf_tcptimeout;
1585 u_int ipf_tcpsynsent;
1586 u_int ipf_tcpsynrecv;
1587 u_int ipf_tcpclosed;
1588 u_int ipf_tcphalfclosed;
1589 u_int ipf_udptimeout;
1590 u_int ipf_udpacktimeout;
1591 u_int ipf_icmptimeout;
1592 u_int ipf_icmpacktimeout;
1593 u_int ipf_iptimeout;
1595 u_long ipf_userifqs;
1596 u_long ipf_rb_no_mem;
1597 u_long ipf_rb_node_max;
1598 u_long ipf_frouteok[2];
1599 ipftuneable_t *ipf_tuners;
1600 void *ipf_frag_soft;
1602 void *ipf_state_soft;
1603 void *ipf_auth_soft;
1604 void *ipf_proxy_soft;
1605 void *ipf_sync_soft;
1606 void *ipf_lookup_soft;
1608 struct frgroup *ipf_groups[IPL_LOGSIZE][2];
1609 frentry_t *ipf_rules[2][2];
1610 frentry_t *ipf_acct[2][2];
1611 frentry_t *ipf_rule_explist[2];
1612 ipftoken_t *ipf_token_head;
1613 ipftoken_t **ipf_token_tail;
1614 #if defined(__FreeBSD_version) && defined(_KERNEL)
1615 struct callout ipf_slow_ch;
1617 #if NETBSD_GE_REV(104040000)
1618 struct callout ipf_slow_ch;
1621 timeout_id_t ipf_slow_ch;
1623 #if defined(_KERNEL)
1625 struct pollhead ipf_poll_head[IPL_LOGSIZE];
1627 # if defined(INSTANCES)
1628 int ipf_get_loopback;
1630 net_handle_t ipf_nd_v4;
1631 net_handle_t ipf_nd_v6;
1632 hook_t *ipf_hk_v4_in;
1633 hook_t *ipf_hk_v4_out;
1634 hook_t *ipf_hk_v4_nic;
1635 hook_t *ipf_hk_v6_in;
1636 hook_t *ipf_hk_v6_out;
1637 hook_t *ipf_hk_v6_nic;
1638 hook_t *ipf_hk_loop_v4_in;
1639 hook_t *ipf_hk_loop_v4_out;
1640 hook_t *ipf_hk_loop_v6_in;
1641 hook_t *ipf_hk_loop_v6_out;
1644 struct selinfo ipf_selwait[IPL_LOGSIZE];
1648 ipf_statistics_t ipf_stats[2];
1649 u_char ipf_iss_secret[32];
1653 #define IPFERROR(_e) do { softc->ipf_interror = (_e); \
1654 DT1(user_error, int, _e); \
1658 extern int ipf_check __P((void *, struct ip *, int, void *, int, mb_t **));
1659 extern struct ifnet *get_unit __P((char *, int));
1660 extern char *get_ifname __P((struct ifnet *));
1661 extern int ipfioctl __P((ipf_main_softc_t *, int, ioctlcmd_t,
1663 extern void m_freem __P((mb_t *));
1664 extern size_t msgdsize __P((mb_t *));
1665 extern int bcopywrap __P((void *, void *, size_t));
1666 extern void ip_fillid(struct ip *);
1667 #else /* #ifndef _KERNEL */
1668 # if defined(__NetBSD__) && defined(PFIL_HOOKS)
1669 extern void ipfilterattach __P((int));
1671 extern int ipl_enable __P((void));
1672 extern int ipl_disable __P((void));
1674 /* XXX MENTAT is always defined for Solaris */
1675 extern int ipf_check __P((void *, struct ip *, int, void *, int, void *,
1678 extern void ipf_prependmbt(fr_info_t *, mblk_t *);
1679 extern int ipfioctl __P((dev_t, int, intptr_t, int, cred_t *, int *));
1681 extern int ipf_qout __P((queue_t *, mblk_t *));
1683 /* XXX MENTAT is never defined for FreeBSD & NetBSD */
1684 extern int ipf_check __P((void *, struct ip *, int, void *, int, mb_t **));
1685 extern int (*fr_checkp) __P((ip_t *, int, void *, int, mb_t **));
1686 extern size_t mbufchainlen __P((mb_t *));
1687 # ifdef IPFILTER_LKM
1688 extern int ipf_identify __P((char *));
1690 # if defined(__FreeBSD_version)
1691 extern int ipfioctl __P((struct cdev*, u_long, caddr_t, int, struct thread *));
1692 # elif defined(__NetBSD__)
1693 extern int ipfioctl __P((dev_t, u_long, void *, int, struct lwp *));
1695 # endif /* MENTAT */
1697 # if defined(__FreeBSD_version)
1698 extern int ipf_pfil_hook __P((void));
1699 extern int ipf_pfil_unhook __P((void));
1700 extern void ipf_event_reg __P((void));
1701 extern void ipf_event_dereg __P((void));
1704 # if defined(INSTANCES)
1705 extern ipf_main_softc_t *ipf_find_softc __P((u_long));
1706 extern int ipf_set_loopback __P((ipf_main_softc_t *, ipftuneable_t *,
1710 #endif /* #ifndef _KERNEL */
1712 extern char *memstr __P((const char *, char *, size_t, size_t));
1713 extern int count4bits __P((u_32_t));
1715 extern int count6bits __P((u_32_t *));
1717 extern int frrequest __P((ipf_main_softc_t *, int, ioctlcmd_t, caddr_t,
1719 extern char *getifname __P((struct ifnet *));
1720 extern int ipfattach __P((ipf_main_softc_t *));
1721 extern int ipfdetach __P((ipf_main_softc_t *));
1722 extern u_short ipf_cksum __P((u_short *, int));
1723 extern int copyinptr __P((ipf_main_softc_t *, void *, void *, size_t));
1724 extern int copyoutptr __P((ipf_main_softc_t *, void *, void *, size_t));
1725 extern int ipf_fastroute __P((mb_t *, mb_t **, fr_info_t *, frdest_t *));
1726 extern int ipf_inject __P((fr_info_t *, mb_t *));
1727 extern int ipf_inobj __P((ipf_main_softc_t *, void *, ipfobj_t *,
1729 extern int ipf_inobjsz __P((ipf_main_softc_t *, void *, void *,
1731 extern int ipf_ioctlswitch __P((ipf_main_softc_t *, int, void *,
1732 ioctlcmd_t, int, int, void *));
1733 extern int ipf_ipf_ioctl __P((ipf_main_softc_t *, caddr_t, ioctlcmd_t,
1735 extern int ipf_ipftune __P((ipf_main_softc_t *, ioctlcmd_t, void *));
1736 extern int ipf_matcharray_load __P((ipf_main_softc_t *, caddr_t,
1737 ipfobj_t *, int **));
1738 extern int ipf_matcharray_verify __P((int *, int));
1739 extern int ipf_outobj __P((ipf_main_softc_t *, void *, void *, int));
1740 extern int ipf_outobjk __P((ipf_main_softc_t *, ipfobj_t *, void *));
1741 extern int ipf_outobjsz __P((ipf_main_softc_t *, void *, void *,
1743 extern void *ipf_pullup __P((mb_t *, fr_info_t *, int));
1744 extern int ipf_resolvedest __P((ipf_main_softc_t *, char *,
1745 struct frdest *, int));
1746 extern int ipf_resolvefunc __P((ipf_main_softc_t *, void *));
1747 extern void *ipf_resolvenic __P((ipf_main_softc_t *, char *, int));
1748 extern int ipf_send_icmp_err __P((int, fr_info_t *, int));
1749 extern int ipf_send_reset __P((fr_info_t *));
1750 extern void ipf_apply_timeout __P((ipftq_t *, u_int));
1751 extern ipftq_t *ipf_addtimeoutqueue __P((ipf_main_softc_t *, ipftq_t **,
1753 extern void ipf_deletequeueentry __P((ipftqent_t *));
1754 extern int ipf_deletetimeoutqueue __P((ipftq_t *));
1755 extern void ipf_freetimeoutqueue __P((ipf_main_softc_t *, ipftq_t *));
1756 extern void ipf_movequeue __P((u_long, ipftqent_t *, ipftq_t *,
1758 extern void ipf_queueappend __P((u_long, ipftqent_t *, ipftq_t *, void *));
1759 extern void ipf_queueback __P((u_long, ipftqent_t *));
1760 extern int ipf_queueflush __P((ipf_main_softc_t *, ipftq_delete_fn_t,
1761 ipftq_t *, ipftq_t *, u_int *, int, int));
1762 extern void ipf_queuefront __P((ipftqent_t *));
1763 extern int ipf_settimeout_tcp __P((ipftuneable_t *, ipftuneval_t *,
1765 extern int ipf_checkv4sum __P((fr_info_t *));
1766 extern int ipf_checkl4sum __P((fr_info_t *));
1767 extern int ipf_ifpfillv4addr __P((int, struct sockaddr_in *,
1768 struct sockaddr_in *, struct in_addr *,
1770 extern int ipf_coalesce __P((fr_info_t *));
1772 extern int ipf_checkv6sum __P((fr_info_t *));
1773 extern int ipf_ifpfillv6addr __P((int, struct sockaddr_in6 *,
1774 struct sockaddr_in6 *, i6addr_t *,
1778 extern int ipf_tune_add __P((ipf_main_softc_t *, ipftuneable_t *));
1779 extern int ipf_tune_add_array __P((ipf_main_softc_t *, ipftuneable_t *));
1780 extern int ipf_tune_del __P((ipf_main_softc_t *, ipftuneable_t *));
1781 extern int ipf_tune_del_array __P((ipf_main_softc_t *, ipftuneable_t *));
1782 extern int ipf_tune_array_link __P((ipf_main_softc_t *, ipftuneable_t *));
1783 extern int ipf_tune_array_unlink __P((ipf_main_softc_t *,
1785 extern ipftuneable_t *ipf_tune_array_copy __P((void *, size_t,
1788 extern int ipf_pr_pullup __P((fr_info_t *, int));
1790 extern int ipf_flush __P((ipf_main_softc_t *, minor_t, int));
1791 extern frgroup_t *ipf_group_add __P((ipf_main_softc_t *, char *, void *,
1792 u_32_t, minor_t, int));
1793 extern void ipf_group_del __P((ipf_main_softc_t *, frgroup_t *,
1795 extern int ipf_derefrule __P((ipf_main_softc_t *, frentry_t **));
1796 extern frgroup_t *ipf_findgroup __P((ipf_main_softc_t *, char *, minor_t,
1797 int, frgroup_t ***));
1799 extern int ipf_log_init __P((void));
1800 extern int ipf_log_bytesused __P((ipf_main_softc_t *, int));
1801 extern int ipf_log_canread __P((ipf_main_softc_t *, int));
1802 extern int ipf_log_clear __P((ipf_main_softc_t *, minor_t));
1803 extern u_long ipf_log_failures __P((ipf_main_softc_t *, int));
1804 extern int ipf_log_read __P((ipf_main_softc_t *, minor_t, uio_t *));
1805 extern int ipf_log_items __P((ipf_main_softc_t *, int, fr_info_t *,
1806 void **, size_t *, int *, int));
1807 extern u_long ipf_log_logok __P((ipf_main_softc_t *, int));
1808 extern void ipf_log_unload __P((ipf_main_softc_t *));
1809 extern int ipf_log_pkt __P((fr_info_t *, u_int));
1811 extern frentry_t *ipf_acctpkt __P((fr_info_t *, u_32_t *));
1812 extern u_short fr_cksum __P((fr_info_t *, ip_t *, int, void *));
1813 extern void ipf_deinitialise __P((ipf_main_softc_t *));
1814 extern int ipf_deliverlocal __P((ipf_main_softc_t *, int, void *,
1816 extern frentry_t *ipf_dstgrpmap __P((fr_info_t *, u_32_t *));
1817 extern void ipf_fixskip __P((frentry_t **, frentry_t *, int));
1818 extern void ipf_forgetifp __P((ipf_main_softc_t *, void *));
1819 extern frentry_t *ipf_getrulen __P((ipf_main_softc_t *, int, char *,
1821 extern int ipf_ifpaddr __P((ipf_main_softc_t *, int, int, void *,
1822 i6addr_t *, i6addr_t *));
1823 extern void ipf_inet_mask_add __P((int, ipf_v4_masktab_t *));
1824 extern void ipf_inet_mask_del __P((int, ipf_v4_masktab_t *));
1826 extern void ipf_inet6_mask_add __P((int, i6addr_t *,
1827 ipf_v6_masktab_t *));
1828 extern void ipf_inet6_mask_del __P((int, i6addr_t *,
1829 ipf_v6_masktab_t *));
1831 extern int ipf_initialise __P((void));
1832 extern int ipf_lock __P((caddr_t, int *));
1833 extern int ipf_makefrip __P((int, ip_t *, fr_info_t *));
1834 extern int ipf_matchtag __P((ipftag_t *, ipftag_t *));
1835 extern int ipf_matchicmpqueryreply __P((int, icmpinfo_t *,
1836 struct icmp *, int));
1837 extern u_32_t ipf_newisn __P((fr_info_t *));
1838 extern u_int ipf_pcksum __P((fr_info_t *, int, u_int));
1839 extern void ipf_rule_expire __P((ipf_main_softc_t *));
1840 extern int ipf_scanlist __P((fr_info_t *, u_32_t));
1841 extern frentry_t *ipf_srcgrpmap __P((fr_info_t *, u_32_t *));
1842 extern int ipf_tcpudpchk __P((fr_ip_t *, frtuc_t *));
1843 extern int ipf_verifysrc __P((fr_info_t *fin));
1844 extern int ipf_zerostats __P((ipf_main_softc_t *, char *));
1845 extern int ipf_getnextrule __P((ipf_main_softc_t *, ipftoken_t *,
1847 extern int ipf_sync __P((ipf_main_softc_t *, void *));
1848 extern int ipf_token_deref __P((ipf_main_softc_t *, ipftoken_t *));
1849 extern void ipf_token_expire __P((ipf_main_softc_t *));
1850 extern ipftoken_t *ipf_token_find __P((ipf_main_softc_t *, int, int,
1852 extern int ipf_token_del __P((ipf_main_softc_t *, int, int,
1854 extern void ipf_token_mark_complete __P((ipftoken_t *));
1855 extern int ipf_genericiter __P((ipf_main_softc_t *, void *,
1857 #ifdef IPFILTER_LOOKUP
1858 extern void *ipf_resolvelookup __P((int, u_int, u_int,
1861 extern u_32_t ipf_random __P((void));
1863 extern int ipf_main_load __P((void));
1864 extern void *ipf_main_soft_create __P((void *));
1865 extern void ipf_main_soft_destroy __P((ipf_main_softc_t *));
1866 extern int ipf_main_soft_init __P((ipf_main_softc_t *));
1867 extern int ipf_main_soft_fini __P((ipf_main_softc_t *));
1868 extern int ipf_main_unload __P((void));
1869 extern int ipf_load_all __P((void));
1870 extern int ipf_unload_all __P((void));
1871 extern void ipf_destroy_all __P((ipf_main_softc_t *));
1872 extern ipf_main_softc_t *ipf_create_all __P((void *));
1873 extern int ipf_init_all __P((ipf_main_softc_t *));
1874 extern int ipf_fini_all __P((ipf_main_softc_t *));
1875 extern void ipf_log_soft_destroy __P((ipf_main_softc_t *, void *));
1876 extern void *ipf_log_soft_create __P((ipf_main_softc_t *));
1877 extern int ipf_log_soft_init __P((ipf_main_softc_t *, void *));
1878 extern int ipf_log_soft_fini __P((ipf_main_softc_t *, void *));
1879 extern int ipf_log_main_load __P((void));
1880 extern int ipf_log_main_unload __P((void));
1883 extern char ipfilter_version[];
1885 extern int icmptoicmp6types[ICMP_MAXTYPE+1];
1886 extern int icmptoicmp6unreach[ICMP_MAX_UNREACH];
1887 extern int icmpreplytype6[ICMP6_MAXTYPE + 1];
1889 #ifdef IPFILTER_COMPAT
1890 extern int ipf_in_compat __P((ipf_main_softc_t *, ipfobj_t *, void *,int));
1891 extern int ipf_out_compat __P((ipf_main_softc_t *, ipfobj_t *, void *));
1893 extern int icmpreplytype4[ICMP_MAXTYPE + 1];
1895 extern int ipf_ht_node_add __P((ipf_main_softc_t *, host_track_t *,
1897 extern int ipf_ht_node_del __P((host_track_t *, int, i6addr_t *));
1898 extern void ipf_rb_ht_flush __P((host_track_t *));
1899 extern void ipf_rb_ht_freenode __P((host_node_t *, void *));
1900 extern void ipf_rb_ht_init __P((host_track_t *));
1902 #endif /* __IP_FIL_H__ */