1/*	$FreeBSD$	*/
2
3/*
4 * Copyright (C) 1995-2001 by Darren Reed.
5 *
6 * See the IPFILTER.LICENCE file for details on licencing.
7 *
8 * @(#)ip_state.h	1.3 1/12/96 (C) 1995 Darren Reed
9 * $FreeBSD$
10 * Id: ip_state.h,v 2.68.2.10 2007/10/16 09:33:24 darrenr Exp $
11 */
12#ifndef	__IP_STATE_H__
13#define	__IP_STATE_H__
14
15#if defined(__STDC__) || defined(__GNUC__) || defined(_AIX51)
16# define	SIOCDELST	_IOW('r', 61, struct ipfobj)
17#else
18# define	SIOCDELST	_IOW(r, 61, struct ipfobj)
19#endif
20
21struct ipscan;
22
23#ifndef	IPSTATE_SIZE
24# define	IPSTATE_SIZE	5737
25#endif
26#ifndef	IPSTATE_MAX
27# define	IPSTATE_MAX	4013	/* Maximum number of states held */
28#endif
29
30#define	SEQ_GE(a,b)	((int)((a) - (b)) >= 0)
31#define	SEQ_GT(a,b)	((int)((a) - (b)) > 0)
32
33
34typedef struct ipstate {
35	ipfmutex_t	is_lock;
36	struct	ipstate	*is_next;
37	struct	ipstate	**is_pnext;
38	struct	ipstate	*is_hnext;
39	struct	ipstate	**is_phnext;
40	struct	ipstate	**is_me;
41	void		*is_ifp[4];
42	void		*is_sync;
43	frentry_t	*is_rule;
44	struct	ipftq	*is_tqehead[2];
45	struct	ipscan	*is_isc;
46	U_QUAD_T	is_pkts[4];
47	U_QUAD_T	is_bytes[4];
48	U_QUAD_T	is_icmppkts[4];
49	struct	ipftqent is_sti;
50	u_int	is_frage[2];
51	int	is_ref;			/* reference count */
52	int	is_isninc[2];
53	u_short	is_sumd[2];
54	i6addr_t	is_src;
55	i6addr_t	is_dst;
56	u_int	is_pass;
57	u_char	is_p;			/* Protocol */
58	u_char	is_v;
59	u_32_t	is_hv;
60	u_32_t	is_tag;
61	u_32_t	is_opt[2];		/* packet options set */
62	u_32_t	is_optmsk[2];		/*    "      "    mask */
63	u_short	is_sec;			/* security options set */
64	u_short	is_secmsk;		/*    "        "    mask */
65	u_short	is_auth;		/* authentication options set */
66	u_short	is_authmsk;		/*    "              "    mask */
67	union {
68		icmpinfo_t	is_ics;
69		tcpinfo_t	is_ts;
70		udpinfo_t	is_us;
71		greinfo_t	is_ug;
72	} is_ps;
73	u_32_t	is_flags;
74	int	is_flx[2][2];
75	u_32_t	is_rulen;		/* rule number when created */
76	u_32_t	is_s0[2];
77	u_short	is_smsk[2];
78	char	is_group[FR_GROUPLEN];
79	char	is_sbuf[2][16];
80	char	is_ifname[4][LIFNAMSIZ];
81} ipstate_t;
82
83#define	is_die		is_sti.tqe_die
84#define	is_state	is_sti.tqe_state
85#define	is_touched	is_sti.tqe_touched
86#define	is_saddr	is_src.in4.s_addr
87#define	is_daddr	is_dst.in4.s_addr
88#define	is_icmp		is_ps.is_ics
89#define	is_type		is_icmp.ici_type
90#define	is_code		is_icmp.ici_code
91#define	is_tcp		is_ps.is_ts
92#define	is_udp		is_ps.is_us
93#define is_send		is_tcp.ts_data[0].td_end
94#define is_dend		is_tcp.ts_data[1].td_end
95#define is_maxswin	is_tcp.ts_data[0].td_maxwin
96#define is_maxdwin	is_tcp.ts_data[1].td_maxwin
97#define is_maxsend	is_tcp.ts_data[0].td_maxend
98#define is_maxdend	is_tcp.ts_data[1].td_maxend
99#define	is_swinscale	is_tcp.ts_data[0].td_winscale
100#define	is_dwinscale	is_tcp.ts_data[1].td_winscale
101#define	is_swinflags	is_tcp.ts_data[0].td_winflags
102#define	is_dwinflags	is_tcp.ts_data[1].td_winflags
103#define	is_sport	is_tcp.ts_sport
104#define	is_dport	is_tcp.ts_dport
105#define	is_ifpin	is_ifp[0]
106#define	is_ifpout	is_ifp[2]
107#define	is_gre		is_ps.is_ug
108#define	is_call		is_gre.gs_call
109
110#define	IS_WSPORT	SI_W_SPORT	/* 0x00100 */
111#define	IS_WDPORT	SI_W_DPORT	/* 0x00200 */
112#define	IS_WSADDR	SI_W_SADDR	/* 0x00400 */
113#define	IS_WDADDR	SI_W_DADDR	/* 0x00800 */
114#define	IS_NEWFR	SI_NEWFR	/* 0x01000 */
115#define	IS_CLONE	SI_CLONE	/* 0x02000 */
116#define	IS_CLONED	SI_CLONED	/* 0x04000 */
117#define	IS_TCPFSM			   0x10000
118#define	IS_STRICT			   0x20000
119#define	IS_ISNSYN			   0x40000
120#define	IS_ISNACK			   0x80000
121#define	IS_STATESYNC			   0x100000
122/*
123 * IS_SC flags are for scan-operations that need to be recognised in state.
124 */
125#define	IS_SC_CLIENT			0x10000000
126#define	IS_SC_SERVER			0x20000000
127#define	IS_SC_MATCHC			0x40000000
128#define	IS_SC_MATCHS			0x80000000
129#define	IS_SC_MATCHALL	(IS_SC_MATCHC|IS_SC_MATCHC)
130#define	IS_SC_ALL	(IS_SC_MATCHC|IS_SC_MATCHC|IS_SC_CLIENT|IS_SC_SERVER)
131
132/*
133 * Flags that can be passed into fr_addstate
134 */
135#define	IS_INHERITED			0x0fffff00
136
137#define	TH_OPENING	(TH_SYN|TH_ACK)
138/*
139 * is_flags:
140 * Bits 0 - 3 are use as a mask with the current packet's bits to check for
141 * whether it is short, tcp/udp, a fragment or the presence of IP options.
142 * Bits 4 - 7 are set from the initial packet and contain what the packet
143 * anded with bits 0-3 must match.
144 * Bits 8,9 are used to indicate wildcard source/destination port matching.
145 * Bits 10,11 are reserved for other wildcard flag compatibility.
146 * Bits 12,13 are for scaning.
147 */
148
149typedef	struct	ipstate_save	{
150	void	*ips_next;
151	struct	ipstate	ips_is;
152	struct	frentry	ips_fr;
153} ipstate_save_t;
154
155#define	ips_rule	ips_is.is_rule
156
157
158typedef	struct	ipslog	{
159	U_QUAD_T	isl_pkts[4];
160	U_QUAD_T	isl_bytes[4];
161	i6addr_t	isl_src;
162	i6addr_t	isl_dst;
163	u_32_t	isl_tag;
164	u_short	isl_type;
165	union {
166		u_short	isl_filler[2];
167		u_short	isl_ports[2];
168		u_short	isl_icmp;
169	} isl_ps;
170	u_char	isl_v;
171	u_char	isl_p;
172	u_char	isl_flags;
173	u_char	isl_state[2];
174	u_32_t	isl_rulen;
175	char	isl_group[FR_GROUPLEN];
176} ipslog_t;
177
178#define	isl_sport	isl_ps.isl_ports[0]
179#define	isl_dport	isl_ps.isl_ports[1]
180#define	isl_itype	isl_ps.isl_icmp
181
182#define	ISL_NEW			0
183#define	ISL_CLONE		1
184#define	ISL_EXPIRE		0xffff
185#define	ISL_FLUSH		0xfffe
186#define	ISL_REMOVE		0xfffd
187#define	ISL_INTERMEDIATE	0xfffc
188#define	ISL_KILLED		0xfffb
189#define	ISL_ORPHAN		0xfffa
190#define	ISL_UNLOAD		0xfff9
191
192
193typedef	struct	ips_stat {
194	u_long	iss_hits;
195	u_long	iss_miss;
196	u_long	iss_max;
197	u_long	iss_maxref;
198	u_long	iss_tcp;
199	u_long	iss_udp;
200	u_long	iss_icmp;
201	u_long	iss_nomem;
202	u_long	iss_expire;
203	u_long	iss_fin;
204	u_long	iss_active;
205	u_long	iss_logged;
206	u_long	iss_logfail;
207	u_long	iss_inuse;
208	u_long	iss_wild;
209	u_long	iss_killed;
210	u_long	iss_ticks;
211	u_long	iss_bucketfull;
212	int	iss_statesize;
213	int	iss_statemax;
214	ipstate_t **iss_table;
215	ipstate_t *iss_list;
216	u_long	*iss_bucketlen;
217	ipftq_t	*iss_tcptab;
218} ips_stat_t;
219
220
221extern	u_long	fr_tcpidletimeout;
222extern	u_long	fr_tcpclosewait;
223extern	u_long	fr_tcplastack;
224extern	u_long	fr_tcptimeout;
225extern	u_long	fr_tcpclosed;
226extern	u_long	fr_tcphalfclosed;
227extern	u_long	fr_udptimeout;
228extern	u_long	fr_udpacktimeout;
229extern	u_long	fr_icmptimeout;
230extern	u_long	fr_icmpacktimeout;
231extern	u_long	fr_iptimeout;
232extern	int	fr_statemax;
233extern	int	fr_statesize;
234extern	int	fr_state_lock;
235extern	int	fr_state_maxbucket;
236extern	int	fr_state_maxbucket_reset;
237extern	ipstate_t	*ips_list;
238extern	ipftq_t	*ips_utqe;
239extern	ipftq_t	ips_tqtqb[IPF_TCP_NSTATES];
240
241extern	int	fr_stateinit __P((void));
242extern	ipstate_t *fr_addstate __P((fr_info_t *, ipstate_t **, u_int));
243extern	frentry_t *fr_checkstate __P((struct fr_info *, u_32_t *));
244extern	ipstate_t *fr_stlookup __P((fr_info_t *, tcphdr_t *, ipftq_t **));
245extern	void	fr_statesync __P((void *));
246extern	void	fr_timeoutstate __P((void));
247extern	int	fr_tcp_age __P((struct ipftqent *, struct fr_info *,
248				struct ipftq *, int));
249extern	int	fr_tcpinwindow __P((struct fr_info *, struct tcpdata *,
250				    struct tcpdata *, tcphdr_t *, int));
251extern	void	fr_stateunload __P((void));
252extern	void	ipstate_log __P((struct ipstate *, u_int));
253extern	int	fr_state_ioctl __P((caddr_t, ioctlcmd_t, int, int, void *));
254extern	void	fr_stinsert __P((struct ipstate *, int));
255extern	void	fr_sttab_init __P((struct ipftq *));
256extern	void	fr_sttab_destroy __P((struct ipftq *));
257extern	void	fr_updatestate __P((fr_info_t *, ipstate_t *, ipftq_t *));
258extern	void	fr_statederef __P((ipstate_t **));
259extern	void	fr_setstatequeue __P((ipstate_t *, int));
260
261#endif /* __IP_STATE_H__ */
262