xref: /freebsd/sys/netinet/ip_fw.h (revision 380a989b3223d455375b4fae70fd0b9bdd43bafb)
1 /*
2  * Copyright (c) 1993 Daniel Boulet
3  * Copyright (c) 1994 Ugen J.S.Antsilevich
4  *
5  * Redistribution and use in source forms, with and without modification,
6  * are permitted provided that this entire comment appears intact.
7  *
8  * Redistribution in binary form may occur without any restrictions.
9  * Obviously, it would be nice if you gave credit where credit is due
10  * but requiring it would be too onerous.
11  *
12  * This software is provided ``AS IS'' without any warranties of any kind.
13  *
14  *	$Id: ip_fw.h,v 1.35 1998/09/02 19:14:01 phk Exp $
15  */
16 
17 #ifndef _IP_FW_H
18 #define _IP_FW_H
19 
20 #include <sys/queue.h>
21 
22 /*
23  * This union structure identifies an interface, either explicitly
24  * by name or implicitly by IP address. The flags IP_FW_F_IIFNAME
25  * and IP_FW_F_OIFNAME say how to interpret this structure. An
26  * interface unit number of -1 matches any unit number, while an
27  * IP address of 0.0.0.0 indicates matches any interface.
28  *
29  * The receive and transmit interfaces are only compared against the
30  * the packet if the corresponding bit (IP_FW_F_IIFACE or IP_FW_F_OIFACE)
31  * is set. Note some packets lack a receive or transmit interface
32  * (in which case the missing "interface" never matches).
33  */
34 
35 union ip_fw_if {
36     struct in_addr fu_via_ip;	/* Specified by IP address */
37     struct {			/* Specified by interface name */
38 #define FW_IFNLEN     10 /* need room ! was IFNAMSIZ */
39 	    char  name[FW_IFNLEN];
40 	    short unit;		/* -1 means match any unit */
41     } fu_via_if;
42 };
43 
44 /*
45  * Format of an IP firewall descriptor
46  *
47  * fw_src, fw_dst, fw_smsk, fw_dmsk are always stored in network byte order.
48  * fw_flg and fw_n*p are stored in host byte order (of course).
49  * Port numbers are stored in HOST byte order.
50  * Warning: setsockopt() will fail if sizeof(struct ip_fw) > MLEN (108)
51  */
52 
53 struct ip_fw {
54     u_int64_t fw_pcnt,fw_bcnt;		/* Packet and byte counters */
55     struct in_addr fw_src, fw_dst;	/* Source and destination IP addr */
56     struct in_addr fw_smsk, fw_dmsk;	/* Mask for src and dest IP addr */
57     u_short fw_number;			/* Rule number */
58     u_int fw_flg;			/* Flags word */
59 #define IP_FW_MAX_PORTS	10		/* A reasonable maximum */
60 	union {
61 	u_short fw_pts[IP_FW_MAX_PORTS];	/* Array of port numbers to match */
62 #define IP_FW_ICMPTYPES_MAX	128
63 #define IP_FW_ICMPTYPES_DIM	(IP_FW_ICMPTYPES_MAX / (sizeof(unsigned) * 8))
64 	unsigned fw_icmptypes[IP_FW_ICMPTYPES_DIM]; /* ICMP types bitmap */
65 	} fw_uar;
66     u_char fw_ipopt,fw_ipnopt;		/* IP options set/unset */
67     u_char fw_tcpf,fw_tcpnf;		/* TCP flags set/unset */
68     long timestamp;			/* timestamp (tv_sec) of last match */
69     union ip_fw_if fw_in_if, fw_out_if;	/* Incoming and outgoing interfaces */
70     union {
71 	u_short fu_divert_port;		/* Divert/tee port (options IPDIVERT) */
72 	u_short fu_pipe_nr;		/* pipe number (option DUMMYNET) */
73 	u_short fu_skipto_rule;		/* SKIPTO command rule number */
74 	u_short fu_reject_code;		/* REJECT response code */
75 	struct sockaddr_in fu_fwd_ip;
76     } fw_un;
77     u_char fw_prot;			/* IP protocol */
78     u_char fw_nports;			/* N'of src ports and # of dst ports */
79 					/* in ports array (dst ports follow */
80 					/* src ports; max of 10 ports in all; */
81 					/* count of 0 means match all ports) */
82     void *pipe_ptr;                    /* Pipe ptr in case of dummynet pipe */
83     void *next_rule_ptr ;              /* next rule in case of match */
84 };
85 
86 #define IP_FW_GETNSRCP(rule)		((rule)->fw_nports & 0x0f)
87 #define IP_FW_SETNSRCP(rule, n)		do {				\
88 					  (rule)->fw_nports &= ~0x0f;	\
89 					  (rule)->fw_nports |= (n);	\
90 					} while (0)
91 #define IP_FW_GETNDSTP(rule)		((rule)->fw_nports >> 4)
92 #define IP_FW_SETNDSTP(rule, n)		do {				\
93 					  (rule)->fw_nports &= ~0xf0;	\
94 					  (rule)->fw_nports |= (n) << 4;\
95 					} while (0)
96 
97 #define fw_divert_port	fw_un.fu_divert_port
98 #define fw_skipto_rule	fw_un.fu_skipto_rule
99 #define fw_reject_code	fw_un.fu_reject_code
100 #define fw_pipe_nr	fw_un.fu_pipe_nr
101 #define fw_fwd_ip	fw_un.fu_fwd_ip
102 
103 struct ip_fw_chain {
104         LIST_ENTRY(ip_fw_chain) chain;
105         struct ip_fw    *rule;
106 };
107 
108 /*
109  * Values for "flags" field .
110  */
111 #define IP_FW_F_COMMAND 0x000000ff	/* Mask for type of chain entry:	*/
112 #define IP_FW_F_DENY	0x00000000	/* This is a deny rule			*/
113 #define IP_FW_F_REJECT	0x00000001	/* Deny and send a response packet	*/
114 #define IP_FW_F_ACCEPT	0x00000002	/* This is an accept rule		*/
115 #define IP_FW_F_COUNT	0x00000003	/* This is a count rule			*/
116 #define IP_FW_F_DIVERT	0x00000004	/* This is a divert rule		*/
117 #define IP_FW_F_TEE	0x00000005	/* This is a tee rule			*/
118 #define IP_FW_F_SKIPTO	0x00000006	/* This is a skipto rule		*/
119 #define IP_FW_F_FWD	0x00000007	/* This is a "change forwarding address" rule */
120 #define IP_FW_F_PIPE	0x00000008	/* This is a dummynet rule */
121 
122 #define IP_FW_F_IN	0x00000100	/* Check inbound packets		*/
123 #define IP_FW_F_OUT	0x00000200	/* Check outbound packets		*/
124 #define IP_FW_F_IIFACE	0x00000400	/* Apply inbound interface test		*/
125 #define IP_FW_F_OIFACE	0x00000800	/* Apply outbound interface test	*/
126 
127 #define IP_FW_F_PRN	0x00001000	/* Print if this rule matches		*/
128 
129 #define IP_FW_F_SRNG	0x00002000	/* The first two src ports are a min	*
130 					 * and max range (stored in host byte	*
131 					 * order).				*/
132 
133 #define IP_FW_F_DRNG	0x00004000	/* The first two dst ports are a min	*
134 					 * and max range (stored in host byte	*
135 					 * order).				*/
136 
137 #define IP_FW_F_FRAG	0x00008000	/* Fragment				*/
138 
139 #define IP_FW_F_IIFNAME	0x00010000	/* In interface by name/unit (not IP)	*/
140 #define IP_FW_F_OIFNAME	0x00020000	/* Out interface by name/unit (not IP)	*/
141 
142 #define IP_FW_F_INVSRC	0x00040000	/* Invert sense of src check		*/
143 #define IP_FW_F_INVDST	0x00080000	/* Invert sense of dst check		*/
144 
145 #define IP_FW_F_ICMPBIT 0x00100000	/* ICMP type bitmap is valid		*/
146 
147 #define IP_FW_F_MASK	0x001FFFFF	/* All possible flag bits mask		*/
148 
149 /*
150  * For backwards compatibility with rules specifying "via iface" but
151  * not restricted to only "in" or "out" packets, we define this combination
152  * of bits to represent this configuration.
153  */
154 
155 #define IF_FW_F_VIAHACK	(IP_FW_F_IN|IP_FW_F_OUT|IP_FW_F_IIFACE|IP_FW_F_OIFACE)
156 
157 /*
158  * Definitions for REJECT response codes.
159  * Values less than 256 correspond to ICMP unreachable codes.
160  */
161 #define IP_FW_REJECT_RST	0x0100		/* TCP packets: send RST */
162 
163 /*
164  * Definitions for IP option names.
165  */
166 #define IP_FW_IPOPT_LSRR	0x01
167 #define IP_FW_IPOPT_SSRR	0x02
168 #define IP_FW_IPOPT_RR		0x04
169 #define IP_FW_IPOPT_TS		0x08
170 
171 /*
172  * Definitions for TCP flags.
173  */
174 #define IP_FW_TCPF_FIN		TH_FIN
175 #define IP_FW_TCPF_SYN		TH_SYN
176 #define IP_FW_TCPF_RST		TH_RST
177 #define IP_FW_TCPF_PSH		TH_PUSH
178 #define IP_FW_TCPF_ACK		TH_ACK
179 #define IP_FW_TCPF_URG		TH_URG
180 #define IP_FW_TCPF_ESTAB	0x40
181 
182 /*
183  * Main firewall chains definitions and global var's definitions.
184  */
185 #ifdef KERNEL
186 
187 /*
188  * Function definitions.
189  */
190 void ip_fw_init __P((void));
191 
192 /* Firewall hooks */
193 struct ip;
194 struct sockopt;
195 typedef	int ip_fw_chk_t __P((struct ip **, int, struct ifnet *, u_int16_t *,
196 	     struct mbuf **, struct ip_fw_chain **, struct sockaddr_in **));
197 typedef	int ip_fw_ctl_t __P((struct sockopt *));
198 extern	ip_fw_chk_t *ip_fw_chk_ptr;
199 extern	ip_fw_ctl_t *ip_fw_ctl_ptr;
200 
201 /* IP NAT hooks */
202 typedef	int ip_nat_t __P((struct ip **, struct mbuf **, struct ifnet *, int));
203 typedef	int ip_nat_ctl_t __P((struct sockopt *));
204 extern	ip_nat_t *ip_nat_ptr;
205 extern	ip_nat_ctl_t *ip_nat_ctl_ptr;
206 #define	IP_NAT_IN	0x00000001
207 #define	IP_NAT_OUT	0x00000002
208 
209 #endif /* KERNEL */
210 
211 #endif /* _IP_FW_H */
212