1/*
2 * Copyright (C) 2012 by Darren Reed.
3 *
4 * See the IPFILTER.LICENCE file for details on licencing.
5 * Id: ip_state.h,v 2.68.2.10 2007/10/16 09:33:24 darrenr Exp $
6 */
7#ifndef __IP_STATE_H__
8#define __IP_STATE_H__
9
10# define SIOCDELST _IOW('r', 61, struct ipfobj)
11
12struct ipscan;
13
14#ifndef IPSTATE_SIZE
15# define IPSTATE_SIZE 5737
16#endif
17#ifndef IPSTATE_MAX
18# define IPSTATE_MAX 4013 /* Maximum number of states held */
19#endif
20
21#define PAIRS(s1,d1,s2,d2) ((((s1) == (s2)) && ((d1) == (d2))) ||\
22 (((s1) == (d2)) && ((d1) == (s2))))
23#define IPPAIR(s1,d1,s2,d2) PAIRS((s1).s_addr, (d1).s_addr, \
24 (s2).s_addr, (d2).s_addr)
25
26
27typedef struct ipstate {
28 ipfmutex_t is_lock;
29 struct ipstate *is_next;
30 struct ipstate **is_pnext;
31 struct ipstate *is_hnext;
32 struct ipstate **is_phnext;
33 struct ipstate **is_me;
34 void *is_ifp[4];
35 void *is_sync;
36 frentry_t *is_rule;
37 struct ipftq *is_tqehead[2];
38 struct ipscan *is_isc;
39 U_QUAD_T is_pkts[4];
40 U_QUAD_T is_bytes[4];
41 U_QUAD_T is_icmppkts[4];
42 struct ipftqent is_sti;
43 u_int is_frage[2];
44 int is_ref; /* reference count */
45 int is_isninc[2];
46 u_short is_sumd[2];
47 i6addr_t is_src;
48 i6addr_t is_dst;
49 u_int is_pass;
50 u_char is_p; /* Protocol */
51 u_char is_v;
52 int is_family;
53 u_32_t is_hv;
54 u_32_t is_tag;
55 u_32_t is_opt[2]; /* packet options set */
56 u_32_t is_optmsk[2]; /* " " mask */
57 u_short is_sec; /* security options set */
58 u_short is_secmsk; /* " " mask */
59 u_short is_auth; /* authentication options set */
60 u_short is_authmsk; /* " " mask */
61 union {
62 icmpinfo_t is_ics;
63 tcpinfo_t is_ts;
64 udpinfo_t is_us;
65 greinfo_t is_ug;
66 } is_ps;
67 u_32_t is_flags;
68 int is_flx[2][2];
69 u_32_t is_rulen; /* rule number when created */
70 u_32_t is_s0[2];
71 u_short is_smsk[2];
72 frdest_t is_dif;
73 frdest_t is_tifs[2];
74 char is_group[FR_GROUPLEN];
75 char is_sbuf[2][16];
76 char is_ifname[4][LIFNAMSIZ];
77} ipstate_t;
78
79#define is_die is_sti.tqe_die
80#define is_state is_sti.tqe_state
81#define is_touched is_sti.tqe_touched
82#define is_saddr is_src.in4.s_addr
83#define is_daddr is_dst.in4.s_addr
84#define is_icmp is_ps.is_ics
85#define is_type is_icmp.ici_type
86#define is_tcp is_ps.is_ts
87#define is_udp is_ps.is_us
88#define is_send is_tcp.ts_data[0].td_end
89#define is_dend is_tcp.ts_data[1].td_end
90#define is_maxswin is_tcp.ts_data[0].td_maxwin
91#define is_maxdwin is_tcp.ts_data[1].td_maxwin
92#define is_maxsend is_tcp.ts_data[0].td_maxend
93#define is_maxdend is_tcp.ts_data[1].td_maxend
94#define is_swinscale is_tcp.ts_data[0].td_winscale
95#define is_dwinscale is_tcp.ts_data[1].td_winscale
96#define is_swinflags is_tcp.ts_data[0].td_winflags
97#define is_dwinflags is_tcp.ts_data[1].td_winflags
98#define is_sport is_tcp.ts_sport
99#define is_dport is_tcp.ts_dport
100#define is_ifpin is_ifp[0]
101#define is_ifpout is_ifp[2]
102#define is_gre is_ps.is_ug
103#define is_call is_gre.gs_call
104
105#define IS_WSPORT SI_W_SPORT /* 0x00100 */
106#define IS_WDPORT SI_W_DPORT /* 0x00200 */
107#define IS_WSADDR SI_W_SADDR /* 0x00400 */
108#define IS_WDADDR SI_W_DADDR /* 0x00800 */
109#define IS_NEWFR SI_NEWFR /* 0x01000 */
110#define IS_CLONE SI_CLONE /* 0x02000 */
111#define IS_CLONED SI_CLONED /* 0x04000 */
112#define IS_TCPFSM 0x10000
113#define IS_STRICT 0x20000
114#define IS_ISNSYN 0x40000
115#define IS_ISNACK 0x80000
116#define IS_STATESYNC 0x100000
117#define IS_LOOSE 0x200000
118/*
119 * IS_SC flags are for scan-operations that need to be recognised in state.
120 */
121#define IS_SC_CLIENT 0x10000000
122#define IS_SC_SERVER 0x20000000
123#define IS_SC_MATCHC 0x40000000
124#define IS_SC_MATCHS 0x80000000
125#define IS_SC_MATCHALL (IS_SC_MATCHC|IS_SC_MATCHC)
126#define IS_SC_ALL (IS_SC_MATCHC|IS_SC_MATCHC|IS_SC_CLIENT|IS_SC_SERVER)
127
128/*
129 * Flags that can be passed into ipf_addstate
130 */
131#define IS_INHERITED 0x0fffff00
132
133#define TH_OPENING (TH_SYN|TH_ACK)
134/*
135 * is_flags:
136 * Bits 0 - 3 are use as a mask with the current packet's bits to check for
137 * whether it is short, tcp/udp, a fragment or the presence of IP options.
138 * Bits 4 - 7 are set from the initial packet and contain what the packet
139 * anded with bits 0-3 must match.
140 * Bits 8,9 are used to indicate wildcard source/destination port matching.
141 * Bits 10,11 are reserved for other wildcard flag compatibility.
142 * Bits 12,13 are for scaning.
143 */
144
145typedef struct ipstate_save {
146 void *ips_next;
147 struct ipstate ips_is;
148 struct frentry ips_fr;
149} ipstate_save_t;
150
151#define ips_rule ips_is.is_rule
152
153
154typedef struct ipslog {
155 U_QUAD_T isl_pkts[4];
156 U_QUAD_T isl_bytes[4];
157 i6addr_t isl_src;
158 i6addr_t isl_dst;
159 u_32_t isl_tag;
160 u_short isl_type;
161 union {
162 u_short isl_filler[2];
163 u_short isl_ports[2];
164 u_short isl_icmp;
165 } isl_ps;
166 u_char isl_v;
167 u_char isl_p;
168 u_char isl_flags;
169 u_char isl_state[2];
170 u_32_t isl_rulen;
171 char isl_group[FR_GROUPLEN];
172} ipslog_t;
173
174#define isl_sport isl_ps.isl_ports[0]
175#define isl_dport isl_ps.isl_ports[1]
176#define isl_itype isl_ps.isl_icmp
177
178#define ISL_NEW 0
179#define ISL_CLONE 1
180#define ISL_STATECHANGE 2
181#define ISL_EXPIRE 0xffff
182#define ISL_FLUSH 0xfffe
183#define ISL_REMOVE 0xfffd
184#define ISL_INTERMEDIATE 0xfffc
185#define ISL_KILLED 0xfffb
186#define ISL_ORPHAN 0xfffa
187#define ISL_UNLOAD 0xfff9
188
189
190typedef struct ips_stat {
191 u_int iss_active;
192 u_int iss_active_proto[256];
193 u_long iss_add_bad;
194 u_long iss_add_dup;
195 u_long iss_add_locked;
196 u_long iss_add_oow;
197 u_long iss_bucket_full;
198 u_long iss_check_bad;
199 u_long iss_check_miss;
200 u_long iss_check_nattag;
201 u_long iss_check_notag;
202 u_long iss_clone_nomem;
203 u_long iss_cloned;
204 u_long iss_expire;
205 u_long iss_fin;
206 u_long iss_flush_all;
207 u_long iss_flush_closing;
208 u_long iss_flush_queue;
209 u_long iss_flush_state;
210 u_long iss_flush_timeout;
211 u_long iss_hits;
212 u_long iss_icmp6_icmperr;
213 u_long iss_icmp6_miss;
214 u_long iss_icmp6_notinfo;
215 u_long iss_icmp6_notquery;
216 u_long iss_icmp_bad;
217 u_long iss_icmp_banned;
218 u_long iss_icmp_headblock;
219 u_long iss_icmp_hits;
220 u_long iss_icmp_icmperr;
221 u_long iss_icmp_miss;
222 u_long iss_icmp_notquery;
223 u_long iss_icmp_short;
224 u_long iss_icmp_toomany;
225 u_int iss_inuse;
226 ipstate_t *iss_list;
227 u_long iss_log_fail;
228 u_long iss_log_ok;
229 u_long iss_lookup_badifp;
230 u_long iss_lookup_badport;
231 u_long iss_lookup_miss;
232 u_long iss_max;
233 u_long iss_max_ref;
234 u_long iss_max_track;
235 u_long iss_miss_mask;
236 u_long iss_nomem;
237 u_long iss_oow;
238 u_long iss_orphan;
239 u_long iss_proto[256];
240 u_long iss_scan_block;
241 u_long iss_state_max;
242 u_long iss_state_size;
243 u_long iss_states[IPF_TCP_NSTATES];
244 ipstate_t **iss_table;
245 u_long iss_tcp_closing;
246 u_long iss_tcp_oow;
247 u_long iss_tcp_rstadd;
248 u_long iss_tcp_toosmall;
249 u_long iss_tcp_badopt;
250 u_long iss_tcp_fsm;
251 u_long iss_tcp_strict;
252 ipftq_t *iss_tcptab;
253 u_int iss_ticks;
254 u_long iss_wild;
255 u_long iss_winsack;
256 u_int *iss_bucketlen;
257} ips_stat_t;
258
259
260typedef struct ipf_state_softc_s {
261 ipfmutex_t ipf_stinsert;
262 int ipf_state_logging;
263 int ipf_state_lock;
264 int ipf_state_doflush;
265 u_int ipf_state_inited;
266 u_int ipf_state_max;
267 u_int ipf_state_maxbucket;
268 u_int ipf_state_size;
269 u_int ipf_state_wm_freq;
270 u_int ipf_state_wm_high;
271 u_int ipf_state_wm_low;
272 u_int ipf_state_wm_last;
273 u_long *ipf_state_seed;
274 ipstate_t *ipf_state_list;
275 ipstate_t **ipf_state_table;
276 ipftuneable_t *ipf_state_tune;
277 ipftq_t *ipf_state_usertq;
278 ipftq_t ipf_state_pending;
279 ipftq_t ipf_state_deletetq;
280 ipftq_t ipf_state_udptq;
281 ipftq_t ipf_state_udpacktq;
282 ipftq_t ipf_state_iptq;
283 ipftq_t ipf_state_icmptq;
284 ipftq_t ipf_state_icmpacktq;
285 ipftq_t ipf_state_tcptq[IPF_TCP_NSTATES];
286 ips_stat_t ipf_state_stats;
287} ipf_state_softc_t;
288
289
290#ifndef _KERNEL
291extern void ipf_state_dump(ipf_main_softc_t *, void *);
292#endif
293extern int ipf_tcp_age(struct ipftqent *, struct fr_info *,
294 struct ipftq *, int, int);
295extern int ipf_tcpinwindow(struct fr_info *, struct tcpdata *,
296 struct tcpdata *, tcphdr_t *, int);
297
298extern int ipf_state_add(ipf_main_softc_t *, fr_info_t *,
299 ipstate_t **, u_int);
300extern frentry_t *ipf_state_check(struct fr_info *, u_32_t *);
301extern void ipf_state_deref(ipf_main_softc_t *, ipstate_t **);
302extern void ipf_state_expire(ipf_main_softc_t *);
303extern int ipf_state_flush(ipf_main_softc_t *, int, int);
304extern ipstate_t *ipf_state_lookup(fr_info_t *, tcphdr_t *, ipftq_t **);
305extern int ipf_state_init(void);
306extern int ipf_state_insert(ipf_main_softc_t *, struct ipstate *, int);
307extern int ipf_state_ioctl(ipf_main_softc_t *, caddr_t, ioctlcmd_t, int, int, void *);
308extern void ipf_state_log(ipf_main_softc_t *, struct ipstate *, u_int);
309extern int ipf_state_matchflush(ipf_main_softc_t *, caddr_t);
310extern int ipf_state_rehash(ipf_main_softc_t *, ipftuneable_t *, ipftuneval_t *);
311extern void ipf_state_setqueue(ipf_main_softc_t *, ipstate_t *, int);
312extern void ipf_state_setpending(ipf_main_softc_t *, ipstate_t *);
313extern int ipf_state_settimeout(struct ipf_main_softc_s *, ipftuneable_t *, ipftuneval_t *);
314extern void ipf_state_sync(ipf_main_softc_t *, void *);
315extern void ipf_state_update(fr_info_t *, ipstate_t *);
316
317extern void ipf_sttab_init(ipf_main_softc_t *, struct ipftq *);
318extern void ipf_sttab_destroy(struct ipftq *);
319extern void ipf_state_setlock(void *, int);
320extern int ipf_state_main_load(void);
321extern int ipf_state_main_unload(void);
322extern void *ipf_state_soft_create(ipf_main_softc_t *);
323extern void ipf_state_soft_destroy(ipf_main_softc_t *, void *);
324extern int ipf_state_soft_init(ipf_main_softc_t *, void *);
325extern int ipf_state_soft_fini(ipf_main_softc_t *, void *);
326extern ipftq_t *ipf_state_add_tq(ipf_main_softc_t *, int);
327
328#endif /* __IP_STATE_H__ */