summaryrefslogtreecommitdiff
path: root/sys/net/npf/npf_impl.h
blob: b242e23ec92b61c97bccb7b412a22ea2232e3a77 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
/*	$NetBSD: npf_impl.h,v 1.49 2014/02/19 03:51:31 rmind Exp $	*/

/*-
 * Copyright (c) 2009-2014 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This material is based upon work partially supported by The
 * NetBSD Foundation under a contract with Mindaugas Rasiukevicius.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

/*
 * Private NPF structures and interfaces.
 * For internal use within NPF core only.
 */

#ifndef _NPF_IMPL_H_
#define _NPF_IMPL_H_

#if !defined(_KERNEL)
#error "Kernel-level header only"
#endif

#ifdef _KERNEL_OPT
/* For INET/INET6 definitions. */
#include "opt_inet.h"
#include "opt_inet6.h"
#endif

#include <sys/types.h>
#include <sys/queue.h>
#include <sys/hash.h>
#include <sys/rbtree.h>
#include <sys/ptree.h>
#include <sys/rwlock.h>

#include <net/bpf.h>
#include <net/bpfjit.h>
#include <net/if.h>

#include "npf.h"

#ifdef _NPF_DEBUG
#define	NPF_PRINTF(x)	printf x
#else
#define	NPF_PRINTF(x)
#endif

/*
 * STRUCTURE DECLARATIONS.
 */

struct npf_ruleset;
struct npf_rule;
struct npf_rprocset;
struct npf_nat;
struct npf_session;

typedef struct npf_ruleset	npf_ruleset_t;
typedef struct npf_rule		npf_rule_t;
typedef struct npf_nat		npf_nat_t;
typedef struct npf_rprocset	npf_rprocset_t;
typedef struct npf_alg		npf_alg_t;
typedef struct npf_natpolicy	npf_natpolicy_t;
typedef struct npf_session	npf_session_t;

struct npf_sehash;
struct npf_table;
struct npf_tableset;

typedef struct npf_sehash	npf_sehash_t;
typedef struct npf_table	npf_table_t;
typedef struct npf_tableset	npf_tableset_t;

/*
 * DEFINITIONS.
 */

typedef void (*npf_workfunc_t)(void);

/*
 * Some artificial limits.
 * Note: very unlikely to have many ALGs.
 */
#define	NPF_MAX_RULES		(1024 * 1024)
#define	NPF_MAX_ALGS		4
#define	NPF_MAX_TABLES		128
#define	NPF_MAX_RPROCS		128
#define	NPF_MAX_IFMAP		64

/*
 * SESSION STATE STRUCTURES
 */

#define	NPF_FLOW_FORW		0
#define	NPF_FLOW_BACK		1

typedef struct {
	uint32_t	nst_end;
	uint32_t	nst_maxend;
	uint32_t	nst_maxwin;
	int		nst_wscale;
} npf_tcpstate_t;

typedef struct {
	kmutex_t	nst_lock;
	u_int		nst_state;
	npf_tcpstate_t	nst_tcpst[2];
} npf_state_t;

/*
 * ALG FUNCTIONS.
 */

typedef struct {
	bool		(*match)(npf_cache_t *, nbuf_t *, npf_nat_t *, int);
	bool		(*translate)(npf_cache_t *, nbuf_t *, npf_nat_t *, bool);
	npf_session_t * (*inspect)(npf_cache_t *, nbuf_t *, int);
} npfa_funcs_t;

/*
 * INTERFACES.
 */

/* NPF config, statistics, etc. */
void		npf_config_init(void);
void		npf_config_fini(void);

void		npf_config_enter(void);
void		npf_config_exit(void);
void		npf_config_sync(void);
bool		npf_config_locked_p(void);
int		npf_config_read_enter(void);
void		npf_config_read_exit(int);

void		npf_config_reload(prop_dictionary_t, npf_ruleset_t *,
		    npf_tableset_t *, npf_ruleset_t *, npf_rprocset_t *, bool);
npf_ruleset_t *	npf_config_ruleset(void);
npf_ruleset_t *	npf_config_natset(void);
npf_tableset_t *npf_config_tableset(void);
prop_dictionary_t npf_config_dict(void);
bool		npf_default_pass(void);

int		npf_worker_sysinit(void);
void		npf_worker_sysfini(void);
void		npf_worker_signal(void);
void		npf_worker_register(npf_workfunc_t);
void		npf_worker_unregister(npf_workfunc_t);

void		npflogattach(int);
void		npflogdetach(void);
int		npfctl_switch(void *);
int		npfctl_reload(u_long, void *);
int		npfctl_getconf(u_long, void *);
int		npfctl_sessions_save(u_long, void *);
int		npfctl_sessions_load(u_long, void *);
int		npfctl_rule(u_long, void *);
int		npfctl_table(void *);

void		npf_stats_inc(npf_stats_t);
void		npf_stats_dec(npf_stats_t);

u_int		npf_ifmap_register(const char *);
void		npf_ifmap_flush(void);
void		npf_ifmap_attach(ifnet_t *);
void		npf_ifmap_detach(ifnet_t *);
u_int		npf_ifmap_id(const ifnet_t *);

/* Packet filter hooks. */
int		npf_pfil_register(bool);
void		npf_pfil_unregister(bool);
bool		npf_pfil_registered_p(void);
int		npf_packet_handler(void *, struct mbuf **, ifnet_t *, int);

/* Protocol helpers. */
int		npf_cache_all(npf_cache_t *, nbuf_t *);
void		npf_recache(npf_cache_t *, nbuf_t *);

bool		npf_rwrip(const npf_cache_t *, u_int, const npf_addr_t *);
bool		npf_rwrport(const npf_cache_t *, u_int, const in_port_t);
bool		npf_rwrcksum(const npf_cache_t *, u_int,
		    const npf_addr_t *, const in_port_t);
int		npf_napt_rwr(const npf_cache_t *, u_int, const npf_addr_t *,
		    const in_addr_t);
int		npf_npt66_rwr(const npf_cache_t *, u_int, const npf_addr_t *,
		    npf_netmask_t, uint16_t);

uint16_t	npf_fixup16_cksum(uint16_t, uint16_t, uint16_t);
uint16_t	npf_fixup32_cksum(uint16_t, uint32_t, uint32_t);
uint16_t	npf_addr_cksum(uint16_t, int, const npf_addr_t *,
		    const npf_addr_t *);
uint32_t	npf_addr_mix(const int, const npf_addr_t *, const npf_addr_t *);
int		npf_addr_cmp(const npf_addr_t *, const npf_netmask_t,
		    const npf_addr_t *, const npf_netmask_t, const int);
void		npf_addr_mask(const npf_addr_t *, const npf_netmask_t,
		    const int, npf_addr_t *);

int		npf_tcpsaw(const npf_cache_t *, tcp_seq *, tcp_seq *,
		    uint32_t *);
bool		npf_fetch_tcpopts(npf_cache_t *, nbuf_t *, uint16_t *, int *);
bool		npf_return_block(npf_cache_t *, nbuf_t *, const int);

/* BPF interface. */
void		npf_bpf_sysinit(void);
void		npf_bpf_sysfini(void);
int		npf_bpf_filter(bpf_args_t *, const void *, bpfjit_func_t);
void *		npf_bpf_compile(void *, size_t);
bool		npf_bpf_validate(const void *, size_t);

/* Tableset interface. */
void		npf_tableset_sysinit(void);
void		npf_tableset_sysfini(void);

extern const pt_tree_ops_t npf_table_ptree_ops;

npf_tableset_t *npf_tableset_create(u_int);
void		npf_tableset_destroy(npf_tableset_t *);
int		npf_tableset_insert(npf_tableset_t *, npf_table_t *);
npf_table_t *	npf_tableset_getbyname(npf_tableset_t *, const char *);
npf_table_t *	npf_tableset_getbyid(npf_tableset_t *, u_int);
void		npf_tableset_reload(npf_tableset_t *, npf_tableset_t *);
void		npf_tableset_syncdict(const npf_tableset_t *, prop_dictionary_t);

npf_table_t *	npf_table_create(const char *, u_int, int, void *, size_t);
void		npf_table_destroy(npf_table_t *);

int		npf_table_check(npf_tableset_t *, const char *, u_int, int);
int		npf_table_insert(npf_table_t *, const int,
		    const npf_addr_t *, const npf_netmask_t);
int		npf_table_remove(npf_table_t *, const int,
		    const npf_addr_t *, const npf_netmask_t);
int		npf_table_lookup(npf_table_t *, const int, const npf_addr_t *);
int		npf_table_list(npf_table_t *, void *, size_t);
int		npf_table_flush(npf_table_t *);

/* Ruleset interface. */
npf_ruleset_t *	npf_ruleset_create(size_t);
void		npf_ruleset_destroy(npf_ruleset_t *);
void		npf_ruleset_insert(npf_ruleset_t *, npf_rule_t *);
void		npf_ruleset_reload(npf_ruleset_t *, npf_ruleset_t *);
void		npf_ruleset_natreload(npf_ruleset_t *, npf_ruleset_t *);
npf_rule_t *	npf_ruleset_matchnat(npf_ruleset_t *, npf_natpolicy_t *);
npf_rule_t *	npf_ruleset_sharepm(npf_ruleset_t *, npf_natpolicy_t *);
void		npf_ruleset_freealg(npf_ruleset_t *, npf_alg_t *);

int		npf_ruleset_add(npf_ruleset_t *, const char *, npf_rule_t *);
int		npf_ruleset_remove(npf_ruleset_t *, const char *, uint64_t);
int		npf_ruleset_remkey(npf_ruleset_t *, const char *,
		    const void *, size_t);
prop_dictionary_t npf_ruleset_list(npf_ruleset_t *, const char *);
int		npf_ruleset_flush(npf_ruleset_t *, const char *);
void		npf_ruleset_gc(npf_ruleset_t *);

npf_rule_t *	npf_ruleset_inspect(npf_cache_t *, nbuf_t *,
		    const npf_ruleset_t *, const int, const int);
int		npf_rule_conclude(const npf_rule_t *, int *);

/* Rule interface. */
npf_rule_t *	npf_rule_alloc(prop_dictionary_t);
void		npf_rule_setcode(npf_rule_t *, int, void *, size_t);
void		npf_rule_setrproc(npf_rule_t *, npf_rproc_t *);
void		npf_rule_free(npf_rule_t *);
uint64_t	npf_rule_getid(const npf_rule_t *);
npf_natpolicy_t *npf_rule_getnat(const npf_rule_t *);
void		npf_rule_setnat(npf_rule_t *, npf_natpolicy_t *);
npf_rproc_t *	npf_rule_getrproc(const npf_rule_t *);

void		npf_ext_sysinit(void);
void		npf_ext_sysfini(void);
int		npf_ext_construct(const char *,
		    npf_rproc_t *, prop_dictionary_t);

npf_rprocset_t *npf_rprocset_create(void);
void		npf_rprocset_destroy(npf_rprocset_t *);
npf_rproc_t *	npf_rprocset_lookup(npf_rprocset_t *, const char *);
void		npf_rprocset_insert(npf_rprocset_t *, npf_rproc_t *);

npf_rproc_t *	npf_rproc_create(prop_dictionary_t);
void		npf_rproc_acquire(npf_rproc_t *);
void		npf_rproc_release(npf_rproc_t *);
void		npf_rproc_run(npf_cache_t *, nbuf_t *, npf_rproc_t *, int *);

/* Session handling interface. */
void		npf_session_sysinit(void);
void		npf_session_sysfini(void);
void		npf_session_tracking(bool);

npf_sehash_t *	sess_htable_create(void);
void		sess_htable_destroy(npf_sehash_t *);

npf_session_t *	npf_session_lookup(const npf_cache_t *, const nbuf_t *,
		    const int, bool *);
npf_session_t *	npf_session_inspect(npf_cache_t *, nbuf_t *, const int, int *);
npf_session_t *	npf_session_establish(npf_cache_t *, nbuf_t *, const int);
void		npf_session_release(npf_session_t *);
void		npf_session_expire(npf_session_t *);
bool		npf_session_pass(const npf_session_t *, npf_rproc_t **);
void		npf_session_setpass(npf_session_t *, npf_rproc_t *);
int		npf_session_setnat(npf_session_t *, npf_nat_t *, u_int);
npf_nat_t *	npf_session_retnat(npf_session_t *, const int, bool *);

void		npf_session_load(npf_sehash_t *);
int		npf_session_save(prop_array_t, prop_array_t);
int		npf_session_restore(npf_sehash_t *, prop_dictionary_t);

/* State handling. */
bool		npf_state_init(npf_cache_t *, nbuf_t *, npf_state_t *);
bool		npf_state_inspect(npf_cache_t *, nbuf_t *, npf_state_t *,
		    const bool);
int		npf_state_etime(const npf_state_t *, const int);
void		npf_state_destroy(npf_state_t *);

bool		npf_state_tcp(npf_cache_t *, nbuf_t *, npf_state_t *, int);
int		npf_state_tcp_timeout(const npf_state_t *);

/* NAT. */
void		npf_nat_sysinit(void);
void		npf_nat_sysfini(void);
npf_natpolicy_t *npf_nat_newpolicy(prop_dictionary_t, npf_ruleset_t *);
void		npf_nat_freepolicy(npf_natpolicy_t *);
bool		npf_nat_matchpolicy(npf_natpolicy_t *, npf_natpolicy_t *);
bool		npf_nat_sharepm(npf_natpolicy_t *, npf_natpolicy_t *);
void		npf_nat_freealg(npf_natpolicy_t *, npf_alg_t *);

int		npf_do_nat(npf_cache_t *, npf_session_t *, nbuf_t *, const int);
void		npf_nat_destroy(npf_nat_t *);
void		npf_nat_getorig(npf_nat_t *, npf_addr_t **, in_port_t *);
void		npf_nat_gettrans(npf_nat_t *, npf_addr_t **, in_port_t *);
void		npf_nat_setalg(npf_nat_t *, npf_alg_t *, uintptr_t);

int		npf_nat_save(prop_dictionary_t, prop_array_t, npf_nat_t *);
npf_nat_t *	npf_nat_restore(prop_dictionary_t, npf_session_t *);

/* ALG interface. */
void		npf_alg_sysinit(void);
void		npf_alg_sysfini(void);
npf_alg_t *	npf_alg_register(const char *, const npfa_funcs_t *);
int		npf_alg_unregister(npf_alg_t *);
npf_alg_t *	npf_alg_construct(const char *);
bool		npf_alg_match(npf_cache_t *, nbuf_t *, npf_nat_t *, int);
void		npf_alg_exec(npf_cache_t *, nbuf_t *, npf_nat_t *, bool);
npf_session_t *	npf_alg_session(npf_cache_t *, nbuf_t *, int);

/* Debugging routines. */
void		npf_addr_dump(const npf_addr_t *);
void		npf_sessions_dump(void);
void		npf_state_dump(const npf_state_t *);
void		npf_nat_dump(const npf_nat_t *);
void		npf_state_setsampler(void (*)(npf_state_t *, bool));

#endif	/* _NPF_IMPL_H_ */