]> git.saurik.com Git - apple/xnu.git/blame - bsd/netinet6/ip6_fw.h
xnu-1228.5.20.tar.gz
[apple/xnu.git] / bsd / netinet6 / ip6_fw.h
CommitLineData
9bccf70c
A
1/*
2 * Copyright (c) 2002 Apple Computer, Inc. All rights reserved.
3 *
2d21ac55 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
9bccf70c 5 *
2d21ac55
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. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
8f6c56a5 14 *
2d21ac55
A
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5
A
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55
A
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
8f6c56a5 25 *
2d21ac55 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
9bccf70c 27 */
1c79356b
A
28/*
29 * Copyright (c) 1993 Daniel Boulet
30 * Copyright (c) 1994 Ugen J.S.Antsilevich
31 *
32 * Redistribution and use in source forms, with and without modification,
33 * are permitted provided that this entire comment appears intact.
34 *
35 * Redistribution in binary form may occur without any restrictions.
36 * Obviously, it would be nice if you gave credit where credit is due
37 * but requiring it would be too onerous.
38 *
39 * This software is provided ``AS IS'' without any warranties of any kind.
40 *
41 */
42
43#ifndef _IP6_FW_H
44#define _IP6_FW_H
2d21ac55
A
45
46/*
47 * Define IPv6 Firewall event subclass, and associated events.
48 */
49
50/*!
51 @defined KEV_IP6FW_SUBCLASS
52 @discussion The kernel event subclass for IPv6 Firewall.
53*/
54#define KEV_IP6FW_SUBCLASS 2
55
56/*!
57 @defined KEV_IP6FW_ADD
58 @discussion The event code indicating a rule has been added.
59*/
60#define KEV_IP6FW_ADD 1
61
62/*!
63 @defined KEV_IP6FW_DEL
64 @discussion The event code indicating a rule has been removed.
65*/
66#define KEV_IP6FW_DEL 2
67
68/*!
69 @defined KEV_IP6FW_FLUSH
70 @discussion The event code indicating the rule set has been flushed.
71*/
72#define KEV_IP6FW_FLUSH 3
73
74/*!
75 @defined KEV_IP6FW_FLUSH
76 @discussion The event code indicating the enable flag has been changed
77*/
78#define KEV_IP6FW_ENABLE 4
79
80
81
82#if !__LP64__
83
9bccf70c 84#include <sys/appleapiopts.h>
1c79356b
A
85
86#include <net/if.h>
9bccf70c 87
55e303ae 88#define IPV6_FW_CURRENT_API_VERSION 20 /* Version of this API */
9bccf70c 89
1c79356b
A
90
91/*
92 * This union structure identifies an interface, either explicitly
93 * by name or implicitly by IP address. The flags IP_FW_F_IIFNAME
94 * and IP_FW_F_OIFNAME say how to interpret this structure. An
95 * interface unit number of -1 matches any unit number, while an
96 * IP address of 0.0.0.0 indicates matches any interface.
97 *
98 * The receive and transmit interfaces are only compared against the
99 * the packet if the corresponding bit (IP_FW_F_IIFACE or IP_FW_F_OIFACE)
100 * is set. Note some packets lack a receive or transmit interface
101 * (in which case the missing "interface" never matches).
102 */
103
104union ip6_fw_if {
105 struct in6_addr fu_via_ip6; /* Specified by IPv6 address */
106 struct { /* Specified by interface name */
9bccf70c
A
107#define IP6FW_IFNLEN IFNAMSIZ
108 char name[IP6FW_IFNLEN];
1c79356b
A
109 short unit; /* -1 means match any unit */
110 } fu_via_if;
111};
112
113/*
114 * Format of an IP firewall descriptor
115 *
116 * fw_src, fw_dst, fw_smsk, fw_dmsk are always stored in network byte order.
117 * fw_flg and fw_n*p are stored in host byte order (of course).
118 * Port numbers are stored in HOST byte order.
119 * Warning: setsockopt() will fail if sizeof(struct ip_fw) > MLEN (108)
120 */
121
122struct ip6_fw {
9bccf70c
A
123 u_int32_t version; /* Version of this structure. Should always be */
124 /* set to IP6_FW_CURRENT_API_VERSION by clients. */
125 void *context; /* Context that is usable by user processes to */
126 /* identify this rule. */
1c79356b
A
127 u_long fw_pcnt,fw_bcnt; /* Packet and byte counters */
128 struct in6_addr fw_src, fw_dst; /* Source and destination IPv6 addr */
129 struct in6_addr fw_smsk, fw_dmsk; /* Mask for src and dest IPv6 addr */
130 u_short fw_number; /* Rule number */
131 u_short fw_flg; /* Flags word */
132#define IPV6_FW_MAX_PORTS 10 /* A reasonable maximum */
9bccf70c 133 u_int fw_ipflg; /* IP flags word */
1c79356b
A
134 u_short fw_pts[IPV6_FW_MAX_PORTS]; /* Array of port numbers to match */
135 u_char fw_ip6opt,fw_ip6nopt; /* IPv6 options set/unset */
136 u_char fw_tcpf,fw_tcpnf; /* TCP flags set/unset */
9bccf70c 137#define IPV6_FW_ICMPTYPES_DIM (256 / (sizeof(unsigned) * 8))
1c79356b
A
138 unsigned fw_icmp6types[IPV6_FW_ICMPTYPES_DIM]; /* ICMP types bitmap */
139 long timestamp; /* timestamp (tv_sec) of last match */
140 union ip6_fw_if fw_in_if, fw_out_if;/* Incoming and outgoing interfaces */
141 union {
142 u_short fu_divert_port; /* Divert/tee port (options IP6DIVERT) */
143 u_short fu_skipto_rule; /* SKIPTO command rule number */
144 u_short fu_reject_code; /* REJECT response code */
145 } fw_un;
146 u_char fw_prot; /* IPv6 protocol */
147 u_char fw_nports; /* N'of src ports and # of dst ports */
148 /* in ports array (dst ports follow */
149 /* src ports; max of 10 ports in all; */
150 /* count of 0 means match all ports) */
151};
152
153#define IPV6_FW_GETNSRCP(rule) ((rule)->fw_nports & 0x0f)
154#define IPV6_FW_SETNSRCP(rule, n) do { \
155 (rule)->fw_nports &= ~0x0f; \
156 (rule)->fw_nports |= (n); \
157 } while (0)
158#define IPV6_FW_GETNDSTP(rule) ((rule)->fw_nports >> 4)
159#define IPV6_FW_SETNDSTP(rule, n) do { \
160 (rule)->fw_nports &= ~0xf0; \
161 (rule)->fw_nports |= (n) << 4;\
162 } while (0)
163
164#define fw_divert_port fw_un.fu_divert_port
165#define fw_skipto_rule fw_un.fu_skipto_rule
166#define fw_reject_code fw_un.fu_reject_code
167
168struct ip6_fw_chain {
169 LIST_ENTRY(ip6_fw_chain) chain;
170 struct ip6_fw *rule;
171};
172
173/*
174 * Values for "flags" field .
175 */
176#define IPV6_FW_F_IN 0x0001 /* Check inbound packets */
177#define IPV6_FW_F_OUT 0x0002 /* Check outbound packets */
178#define IPV6_FW_F_IIFACE 0x0004 /* Apply inbound interface test */
179#define IPV6_FW_F_OIFACE 0x0008 /* Apply outbound interface test */
180
181#define IPV6_FW_F_COMMAND 0x0070 /* Mask for type of chain entry: */
182#define IPV6_FW_F_DENY 0x0000 /* This is a deny rule */
183#define IPV6_FW_F_REJECT 0x0010 /* Deny and send a response packet */
184#define IPV6_FW_F_ACCEPT 0x0020 /* This is an accept rule */
185#define IPV6_FW_F_COUNT 0x0030 /* This is a count rule */
186#define IPV6_FW_F_DIVERT 0x0040 /* This is a divert rule */
187#define IPV6_FW_F_TEE 0x0050 /* This is a tee rule */
188#define IPV6_FW_F_SKIPTO 0x0060 /* This is a skipto rule */
189
190#define IPV6_FW_F_PRN 0x0080 /* Print if this rule matches */
191
192#define IPV6_FW_F_SRNG 0x0100 /* The first two src ports are a min *
193 * and max range (stored in host byte *
194 * order). */
195
196#define IPV6_FW_F_DRNG 0x0200 /* The first two dst ports are a min *
197 * and max range (stored in host byte *
198 * order). */
199
200#define IPV6_FW_F_IIFNAME 0x0400 /* In interface by name/unit (not IP) */
201#define IPV6_FW_F_OIFNAME 0x0800 /* Out interface by name/unit (not IP) */
202
203#define IPV6_FW_F_INVSRC 0x1000 /* Invert sense of src check */
204#define IPV6_FW_F_INVDST 0x2000 /* Invert sense of dst check */
205
206#define IPV6_FW_F_FRAG 0x4000 /* Fragment */
207
208#define IPV6_FW_F_ICMPBIT 0x8000 /* ICMP type bitmap is valid */
209
210#define IPV6_FW_F_MASK 0xFFFF /* All possible flag bits mask */
211
9bccf70c
A
212/*
213 * Flags for the 'fw_ipflg' field, for comparing values of ip and its protocols. */
214#define IPV6_FW_IF_TCPEST 0x00000020 /* established TCP connection */
215#define IPV6_FW_IF_TCPMSK 0x00000020 /* mask of all TCP values */
216
1c79356b
A
217/*
218 * For backwards compatibility with rules specifying "via iface" but
219 * not restricted to only "in" or "out" packets, we define this combination
220 * of bits to represent this configuration.
221 */
222
223#define IF6_FW_F_VIAHACK (IPV6_FW_F_IN|IPV6_FW_F_OUT|IPV6_FW_F_IIFACE|IPV6_FW_F_OIFACE)
224
225/*
226 * Definitions for REJECT response codes.
227 * Values less than 256 correspond to ICMP unreachable codes.
228 */
229#define IPV6_FW_REJECT_RST 0x0100 /* TCP packets: send RST */
230
231/*
232 * Definitions for IPv6 option names.
233 */
234#define IPV6_FW_IP6OPT_HOPOPT 0x01
235#define IPV6_FW_IP6OPT_ROUTE 0x02
236#define IPV6_FW_IP6OPT_FRAG 0x04
237#define IPV6_FW_IP6OPT_ESP 0x08
238#define IPV6_FW_IP6OPT_AH 0x10
239#define IPV6_FW_IP6OPT_NONXT 0x20
240#define IPV6_FW_IP6OPT_OPTS 0x40
241
242/*
243 * Definitions for TCP flags.
244 */
245#define IPV6_FW_TCPF_FIN TH_FIN
246#define IPV6_FW_TCPF_SYN TH_SYN
247#define IPV6_FW_TCPF_RST TH_RST
248#define IPV6_FW_TCPF_PSH TH_PUSH
249#define IPV6_FW_TCPF_ACK TH_ACK
250#define IPV6_FW_TCPF_URG TH_URG
1c79356b
A
251
252/*
253 * Main firewall chains definitions and global var's definitions.
254 */
91447636 255#ifdef KERNEL_PRIVATE
9bccf70c
A
256
257#define M_IP6FW M_IPFW
258
1c79356b
A
259
260/*
261 * Function definitions.
262 */
263void ip6_fw_init(void);
264
265/* Firewall hooks */
266struct ip6_hdr;
55e303ae 267struct sockopt;
91447636
A
268typedef int ip6_fw_chk_t(struct ip6_hdr**, struct ifnet*,
269 u_short *, struct mbuf**);
270typedef int ip6_fw_ctl_t(struct sockopt *);
1c79356b
A
271extern ip6_fw_chk_t *ip6_fw_chk_ptr;
272extern ip6_fw_ctl_t *ip6_fw_ctl_ptr;
9bccf70c 273extern int ip6_fw_enable;
1c79356b 274
91447636 275#endif /* KERNEL_PRIVATE */
1c79356b 276
2d21ac55 277#endif /* !__LP64__ */
1c79356b 278#endif /* _IP6_FW_H */