]> git.saurik.com Git - apple/xnu.git/blame - bsd/netinet/ip_fw.h
xnu-792.6.56.tar.gz
[apple/xnu.git] / bsd / netinet / ip_fw.h
CommitLineData
1c79356b 1/*
9bccf70c 2 * Copyright (c) 2002 Apple Computer, Inc. All rights reserved.
1c79356b
A
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
ff6e181a
A
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. Please obtain a copy of the License at
10 * http://www.opensource.apple.com/apsl/ and read it before using this
11 * file.
1c79356b 12 *
ff6e181a
A
13 * The Original Code and all software distributed under the License are
14 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b
A
15 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
ff6e181a
A
17 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18 * Please see the License for the specific language governing rights and
19 * limitations under the License.
1c79356b
A
20 *
21 * @APPLE_LICENSE_HEADER_END@
22 */
23/*
24 * Copyright (c) 1993 Daniel Boulet
25 * Copyright (c) 1994 Ugen J.S.Antsilevich
26 *
27 * Redistribution and use in source forms, with and without modification,
28 * are permitted provided that this entire comment appears intact.
29 *
30 * Redistribution in binary form may occur without any restrictions.
31 * Obviously, it would be nice if you gave credit where credit is due
32 * but requiring it would be too onerous.
33 *
34 * This software is provided ``AS IS'' without any warranties of any kind.
35 *
36 */
37
38#ifndef _IP_FW_H
39#define _IP_FW_H
9bccf70c 40#include <sys/appleapiopts.h>
1c79356b 41
91447636
A
42#ifdef IPFW2
43#include <netinet/ip_fw2.h>
44#else /* !IPFW2, good old ipfw */
45
1c79356b
A
46#include <sys/queue.h>
47
9bccf70c
A
48
49#define IP_FW_CURRENT_API_VERSION 20 /* Version of this API */
50
51
1c79356b
A
52/*
53 * This union structure identifies an interface, either explicitly
54 * by name or implicitly by IP address. The flags IP_FW_F_IIFNAME
55 * and IP_FW_F_OIFNAME say how to interpret this structure. An
56 * interface unit number of -1 matches any unit number, while an
57 * IP address of 0.0.0.0 indicates matches any interface.
58 *
59 * The receive and transmit interfaces are only compared against the
60 * the packet if the corresponding bit (IP_FW_F_IIFACE or IP_FW_F_OIFACE)
61 * is set. Note some packets lack a receive or transmit interface
62 * (in which case the missing "interface" never matches).
63 */
64
65union ip_fw_if {
66 struct in_addr fu_via_ip; /* Specified by IP address */
67 struct { /* Specified by interface name */
68#define FW_IFNLEN 10 /* need room ! was IFNAMSIZ */
69 char name[FW_IFNLEN];
70 short unit; /* -1 means match any unit */
71 } fu_via_if;
72};
73
74/*
75 * Format of an IP firewall descriptor
76 *
77 * fw_src, fw_dst, fw_smsk, fw_dmsk are always stored in network byte order.
78 * fw_flg and fw_n*p are stored in host byte order (of course).
79 * Port numbers are stored in HOST byte order.
1c79356b
A
80 */
81
82struct ip_fw {
9bccf70c
A
83 u_int32_t version; /* Version of this structure. Should always be */
84 /* set to IP_FW_CURRENT_API_VERSION by clients. */
85 void *context; /* Context that is usable by user processes to */
86 /* identify this rule. */
1c79356b
A
87 u_int64_t fw_pcnt,fw_bcnt; /* Packet and byte counters */
88 struct in_addr fw_src, fw_dst; /* Source and destination IP addr */
89 struct in_addr fw_smsk, fw_dmsk; /* Mask for src and dest IP addr */
90 u_short fw_number; /* Rule number */
91 u_int fw_flg; /* Flags word */
92#define IP_FW_MAX_PORTS 10 /* A reasonable maximum */
93 union {
94 u_short fw_pts[IP_FW_MAX_PORTS]; /* Array of port numbers to match */
95#define IP_FW_ICMPTYPES_MAX 128
96#define IP_FW_ICMPTYPES_DIM (IP_FW_ICMPTYPES_MAX / (sizeof(unsigned) * 8))
97 unsigned fw_icmptypes[IP_FW_ICMPTYPES_DIM]; /* ICMP types bitmap */
98 } fw_uar;
9bccf70c 99 u_int fw_ipflg; /* IP flags word */
1c79356b 100 u_char fw_ipopt,fw_ipnopt; /* IP options set/unset */
9bccf70c 101 u_char fw_tcpopt,fw_tcpnopt; /* TCP options set/unset */
1c79356b
A
102 u_char fw_tcpf,fw_tcpnf; /* TCP flags set/unset */
103 long timestamp; /* timestamp (tv_sec) of last match */
104 union ip_fw_if fw_in_if, fw_out_if; /* Incoming and outgoing interfaces */
105 union {
106 u_short fu_divert_port; /* Divert/tee port (options IPDIVERT) */
9bccf70c 107 u_short fu_pipe_nr; /* queue number (option DUMMYNET) */
1c79356b
A
108 u_short fu_skipto_rule; /* SKIPTO command rule number */
109 u_short fu_reject_code; /* REJECT response code */
110 struct sockaddr_in fu_fwd_ip;
111 } fw_un;
112 u_char fw_prot; /* IP protocol */
9bccf70c
A
113 /*
114 * N'of src ports and # of dst ports in ports array (dst ports
115 * follow src ports; max of 10 ports in all; count of 0 means
116 * match all ports)
117 */
118 u_char fw_nports;
119 void *pipe_ptr; /* flow_set ptr for dummynet pipe */
1c79356b 120 void *next_rule_ptr ; /* next rule in case of match */
9bccf70c
A
121 uid_t fw_uid; /* uid to match */
122 int fw_logamount; /* amount to log */
123 u_int64_t fw_loghighest; /* highest number packet to log */
124};
125
126/*
127 * extended ipfw structure... some fields in the original struct
128 * can be used to pass parameters up/down, namely pointers
129 * void *pipe_ptr
130 * void *next_rule_ptr
131 * some others can be used to pass parameters down, namely counters etc.
132 * u_int64_t fw_pcnt,fw_bcnt;
133 * long timestamp;
134 */
135
136struct ip_fw_ext { /* extended structure */
137 struct ip_fw rule; /* must be at offset 0 */
138 long dont_match_prob; /* 0x7fffffff means 1.0, always fail */
139 u_int dyn_type; /* type for dynamic rule */
1c79356b
A
140};
141
142#define IP_FW_GETNSRCP(rule) ((rule)->fw_nports & 0x0f)
143#define IP_FW_SETNSRCP(rule, n) do { \
144 (rule)->fw_nports &= ~0x0f; \
145 (rule)->fw_nports |= (n); \
146 } while (0)
147#define IP_FW_GETNDSTP(rule) ((rule)->fw_nports >> 4)
148#define IP_FW_SETNDSTP(rule, n) do { \
149 (rule)->fw_nports &= ~0xf0; \
150 (rule)->fw_nports |= (n) << 4;\
151 } while (0)
152
153#define fw_divert_port fw_un.fu_divert_port
154#define fw_skipto_rule fw_un.fu_skipto_rule
155#define fw_reject_code fw_un.fu_reject_code
156#define fw_pipe_nr fw_un.fu_pipe_nr
157#define fw_fwd_ip fw_un.fu_fwd_ip
158
159struct ip_fw_chain {
9bccf70c
A
160 LIST_ENTRY(ip_fw_chain) next;
161 struct ip_fw *rule;
1c79356b
A
162};
163
9bccf70c
A
164/*
165 * Flow mask/flow id for each queue.
166 */
167struct ipfw_flow_id {
168 u_int32_t dst_ip, src_ip ;
169 u_int16_t dst_port, src_port ;
170 u_int8_t proto ;
171 u_int8_t flags ; /* protocol-specific flags */
172} ;
173
174/*
175 * dynamic ipfw rule
176 */
177struct ipfw_dyn_rule {
178 struct ipfw_dyn_rule *next ;
179
180 struct ipfw_flow_id id ;
181 struct ipfw_flow_id mask ;
182 struct ip_fw_chain *chain ; /* pointer to parent rule */
183 u_int32_t type ; /* rule type */
184 u_int32_t expire ; /* expire time */
185 u_int64_t pcnt, bcnt; /* match counters */
186 u_int32_t bucket ; /* which bucket in hash table */
187 u_int32_t state ; /* state of this rule (typ. a */
188 /* combination of TCP flags) */
189} ;
190
1c79356b
A
191/*
192 * Values for "flags" field .
193 */
194#define IP_FW_F_COMMAND 0x000000ff /* Mask for type of chain entry: */
195#define IP_FW_F_DENY 0x00000000 /* This is a deny rule */
196#define IP_FW_F_REJECT 0x00000001 /* Deny and send a response packet */
197#define IP_FW_F_ACCEPT 0x00000002 /* This is an accept rule */
198#define IP_FW_F_COUNT 0x00000003 /* This is a count rule */
199#define IP_FW_F_DIVERT 0x00000004 /* This is a divert rule */
200#define IP_FW_F_TEE 0x00000005 /* This is a tee rule */
201#define IP_FW_F_SKIPTO 0x00000006 /* This is a skipto rule */
202#define IP_FW_F_FWD 0x00000007 /* This is a "change forwarding address" rule */
203#define IP_FW_F_PIPE 0x00000008 /* This is a dummynet rule */
9bccf70c 204#define IP_FW_F_QUEUE 0x00000009 /* This is a dummynet queue */
1c79356b
A
205
206#define IP_FW_F_IN 0x00000100 /* Check inbound packets */
207#define IP_FW_F_OUT 0x00000200 /* Check outbound packets */
208#define IP_FW_F_IIFACE 0x00000400 /* Apply inbound interface test */
209#define IP_FW_F_OIFACE 0x00000800 /* Apply outbound interface test */
210
211#define IP_FW_F_PRN 0x00001000 /* Print if this rule matches */
212
213#define IP_FW_F_SRNG 0x00002000 /* The first two src ports are a min *
214 * and max range (stored in host byte *
215 * order). */
216
217#define IP_FW_F_DRNG 0x00004000 /* The first two dst ports are a min *
218 * and max range (stored in host byte *
219 * order). */
220
221#define IP_FW_F_FRAG 0x00008000 /* Fragment */
222
223#define IP_FW_F_IIFNAME 0x00010000 /* In interface by name/unit (not IP) */
224#define IP_FW_F_OIFNAME 0x00020000 /* Out interface by name/unit (not IP) */
225
226#define IP_FW_F_INVSRC 0x00040000 /* Invert sense of src check */
227#define IP_FW_F_INVDST 0x00080000 /* Invert sense of dst check */
228
229#define IP_FW_F_ICMPBIT 0x00100000 /* ICMP type bitmap is valid */
230
9bccf70c
A
231#define IP_FW_F_UID 0x00200000 /* filter by uid */
232
233#define IP_FW_F_RND_MATCH 0x00800000 /* probabilistic rule match */
234#define IP_FW_F_SMSK 0x01000000 /* src-port + mask */
235#define IP_FW_F_DMSK 0x02000000 /* dst-port + mask */
236#define IP_FW_BRIDGED 0x04000000 /* only match bridged packets */
237#define IP_FW_F_KEEP_S 0x08000000 /* keep state */
238#define IP_FW_F_CHECK_S 0x10000000 /* check state */
239
240#define IP_FW_F_SME 0x20000000 /* source = me */
241#define IP_FW_F_DME 0x40000000 /* destination = me */
242
243#define IP_FW_F_MASK 0x7FFFFFFF /* All possible flag bits mask */
244
245/*
246 * Flags for the 'fw_ipflg' field, for comparing values of ip and its protocols.
247 */
248#define IP_FW_IF_TCPEST 0x00000020 /* established TCP connection */
249#define IP_FW_IF_TCPMSK 0x00000020 /* mask of all TCP values */
1c79356b
A
250
251/*
252 * For backwards compatibility with rules specifying "via iface" but
253 * not restricted to only "in" or "out" packets, we define this combination
254 * of bits to represent this configuration.
255 */
256
257#define IF_FW_F_VIAHACK (IP_FW_F_IN|IP_FW_F_OUT|IP_FW_F_IIFACE|IP_FW_F_OIFACE)
258
259/*
260 * Definitions for REJECT response codes.
261 * Values less than 256 correspond to ICMP unreachable codes.
262 */
263#define IP_FW_REJECT_RST 0x0100 /* TCP packets: send RST */
264
265/*
266 * Definitions for IP option names.
267 */
268#define IP_FW_IPOPT_LSRR 0x01
269#define IP_FW_IPOPT_SSRR 0x02
270#define IP_FW_IPOPT_RR 0x04
271#define IP_FW_IPOPT_TS 0x08
272
9bccf70c
A
273/*
274 * Definitions for TCP option names.
275 */
276#define IP_FW_TCPOPT_MSS 0x01
277#define IP_FW_TCPOPT_WINDOW 0x02
278#define IP_FW_TCPOPT_SACK 0x04
279#define IP_FW_TCPOPT_TS 0x08
280#define IP_FW_TCPOPT_CC 0x10
281
1c79356b
A
282/*
283 * Definitions for TCP flags.
284 */
285#define IP_FW_TCPF_FIN TH_FIN
286#define IP_FW_TCPF_SYN TH_SYN
287#define IP_FW_TCPF_RST TH_RST
288#define IP_FW_TCPF_PSH TH_PUSH
289#define IP_FW_TCPF_ACK TH_ACK
290#define IP_FW_TCPF_URG TH_URG
1c79356b
A
291
292/*
293 * Main firewall chains definitions and global var's definitions.
294 */
91447636 295#ifdef KERNEL_PRIVATE
9bccf70c
A
296
297#define IP_FW_PORT_DYNT_FLAG 0x10000
298#define IP_FW_PORT_TEE_FLAG 0x20000
299#define IP_FW_PORT_DENY_FLAG 0x40000
1c79356b
A
300
301/*
302 * Function definitions.
303 */
91447636 304void ip_fw_init(void);
1c79356b
A
305
306/* Firewall hooks */
307struct ip;
308struct sockopt;
91447636
A
309typedef int ip_fw_chk_t(struct ip **, int, struct ifnet *, u_int16_t *,
310 struct mbuf **, struct ip_fw_chain **, struct sockaddr_in **);
311typedef int ip_fw_ctl_t(struct sockopt *);
1c79356b
A
312extern ip_fw_chk_t *ip_fw_chk_ptr;
313extern ip_fw_ctl_t *ip_fw_ctl_ptr;
9bccf70c
A
314extern int fw_one_pass;
315extern int fw_enable;
316extern struct ipfw_flow_id last_pkt ;
91447636 317#endif KERNEL_PRIVATE
1c79356b 318
91447636
A
319#endif !IPFW2
320#endif _IP_FW_H