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