npf_impl.h revision 1.34
1 /* $NetBSD: npf_impl.h,v 1.34 2013/10/27 16:22:08 rmind Exp $ */ 2 3 /*- 4 * Copyright (c) 2009-2013 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This material is based upon work partially supported by The 8 * NetBSD Foundation under a contract with Mindaugas Rasiukevicius. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29 * POSSIBILITY OF SUCH DAMAGE. 30 */ 31 32 /* 33 * Private NPF structures and interfaces. 34 * For internal use within NPF core only. 35 */ 36 37 #ifndef _NPF_IMPL_H_ 38 #define _NPF_IMPL_H_ 39 40 #if !defined(_KERNEL) 41 #error "Kernel-level header only" 42 #endif 43 44 #ifdef _KERNEL_OPT 45 /* For INET/INET6 definitions. */ 46 #include "opt_inet.h" 47 #include "opt_inet6.h" 48 #endif 49 50 #include <sys/types.h> 51 #include <sys/queue.h> 52 #include <sys/hash.h> 53 #include <sys/rbtree.h> 54 #include <sys/ptree.h> 55 #include <sys/rwlock.h> 56 57 #include <net/bpf.h> 58 #include <net/bpfjit.h> 59 #include <net/if.h> 60 61 #include "npf.h" 62 63 #ifdef _NPF_DEBUG 64 #define NPF_PRINTF(x) printf x 65 #else 66 #define NPF_PRINTF(x) 67 #endif 68 69 /* 70 * STRUCTURE DECLARATIONS. 71 */ 72 73 struct npf_ruleset; 74 struct npf_rule; 75 struct npf_rprocset; 76 struct npf_nat; 77 struct npf_session; 78 79 typedef struct npf_ruleset npf_ruleset_t; 80 typedef struct npf_rule npf_rule_t; 81 typedef struct npf_nat npf_nat_t; 82 typedef struct npf_rprocset npf_rprocset_t; 83 typedef struct npf_alg npf_alg_t; 84 typedef struct npf_natpolicy npf_natpolicy_t; 85 typedef struct npf_session npf_session_t; 86 87 struct npf_sehash; 88 struct npf_table; 89 90 typedef struct npf_sehash npf_sehash_t; 91 typedef struct npf_table npf_table_t; 92 93 typedef npf_table_t * npf_tableset_t; 94 95 /* 96 * DEFINITIONS. 97 */ 98 99 typedef bool (*npf_alg_func_t)(npf_cache_t *, nbuf_t *, npf_nat_t *, int); 100 typedef npf_session_t *(*npf_alg_sfunc_t)(npf_cache_t *, nbuf_t *, int); 101 typedef void (*npf_workfunc_t)(void); 102 103 /* Some artificial limits. */ 104 #define NPF_TABLE_SLOTS 32 105 #define NPF_MAX_RULES (1024 * 1024) 106 107 /* 108 * SESSION STATE STRUCTURES 109 */ 110 111 #define NPF_FLOW_FORW 0 112 #define NPF_FLOW_BACK 1 113 114 typedef struct { 115 uint32_t nst_end; 116 uint32_t nst_maxend; 117 uint32_t nst_maxwin; 118 int nst_wscale; 119 } npf_tcpstate_t; 120 121 typedef struct { 122 kmutex_t nst_lock; 123 int nst_state; 124 npf_tcpstate_t nst_tcpst[2]; 125 } npf_state_t; 126 127 /* 128 * INTERFACES. 129 */ 130 131 /* NPF config, statistics, etc. */ 132 void npf_config_init(void); 133 void npf_config_fini(void); 134 135 void npf_config_enter(void); 136 void npf_config_exit(void); 137 void npf_config_sync(void); 138 bool npf_config_locked_p(void); 139 int npf_config_read_enter(void); 140 void npf_config_read_exit(int); 141 142 void npf_config_reload(prop_dictionary_t, npf_ruleset_t *, 143 npf_tableset_t *, npf_ruleset_t *, npf_rprocset_t *, bool); 144 npf_ruleset_t * npf_config_ruleset(void); 145 npf_ruleset_t * npf_config_natset(void); 146 npf_tableset_t *npf_config_tableset(void); 147 prop_dictionary_t npf_config_dict(void); 148 bool npf_default_pass(void); 149 150 int npf_worker_sysinit(void); 151 void npf_worker_sysfini(void); 152 void npf_worker_signal(void); 153 void npf_worker_register(npf_workfunc_t); 154 void npf_worker_unregister(npf_workfunc_t); 155 156 void npflogattach(int); 157 void npflogdetach(void); 158 int npfctl_switch(void *); 159 int npfctl_reload(u_long, void *); 160 int npfctl_getconf(u_long, void *); 161 int npfctl_sessions_save(u_long, void *); 162 int npfctl_sessions_load(u_long, void *); 163 int npfctl_rule(u_long, void *); 164 int npfctl_table(void *); 165 166 void npf_stats_inc(npf_stats_t); 167 void npf_stats_dec(npf_stats_t); 168 169 /* Packet filter hooks. */ 170 int npf_pfil_register(void); 171 void npf_pfil_unregister(void); 172 bool npf_pfil_registered_p(void); 173 int npf_packet_handler(void *, struct mbuf **, ifnet_t *, int); 174 175 /* Protocol helpers. */ 176 int npf_cache_all(npf_cache_t *, nbuf_t *); 177 void npf_recache(npf_cache_t *, nbuf_t *); 178 179 bool npf_rwrip(const npf_cache_t *, int, const npf_addr_t *); 180 bool npf_rwrport(const npf_cache_t *, int, const in_port_t); 181 bool npf_rwrcksum(const npf_cache_t *, const int, 182 const npf_addr_t *, const in_port_t); 183 184 uint16_t npf_fixup16_cksum(uint16_t, uint16_t, uint16_t); 185 uint16_t npf_fixup32_cksum(uint16_t, uint32_t, uint32_t); 186 uint16_t npf_addr_cksum(uint16_t, int, const npf_addr_t *, 187 const npf_addr_t *); 188 uint32_t npf_addr_sum(const int, const npf_addr_t *, const npf_addr_t *); 189 int npf_addr_cmp(const npf_addr_t *, const npf_netmask_t, 190 const npf_addr_t *, const npf_netmask_t, const int); 191 void npf_addr_mask(const npf_addr_t *, const npf_netmask_t, 192 const int, npf_addr_t *); 193 194 int npf_tcpsaw(const npf_cache_t *, tcp_seq *, tcp_seq *, 195 uint32_t *); 196 bool npf_fetch_tcpopts(npf_cache_t *, nbuf_t *, uint16_t *, int *); 197 bool npf_return_block(npf_cache_t *, nbuf_t *, const int); 198 199 /* BPF interface. */ 200 void npf_bpf_sysinit(void); 201 void npf_bpf_sysfini(void); 202 int npf_bpf_filter(npf_cache_t *, nbuf_t *, 203 const void *, bpfjit_function_t); 204 bool npf_bpf_validate(const void *, size_t); 205 206 /* Tableset interface. */ 207 void npf_tableset_sysinit(void); 208 void npf_tableset_sysfini(void); 209 210 extern const pt_tree_ops_t npf_table_ptree_ops; 211 212 npf_tableset_t *npf_tableset_create(void); 213 void npf_tableset_destroy(npf_tableset_t *); 214 int npf_tableset_insert(npf_tableset_t *, npf_table_t *); 215 void npf_tableset_reload(npf_tableset_t *, npf_tableset_t *); 216 217 npf_table_t * npf_table_create(u_int, int, size_t); 218 void npf_table_destroy(npf_table_t *); 219 220 int npf_table_check(const npf_tableset_t *, u_int, int); 221 int npf_table_insert(npf_tableset_t *, u_int, 222 const int, const npf_addr_t *, const npf_netmask_t); 223 int npf_table_remove(npf_tableset_t *, u_int, 224 const int, const npf_addr_t *, const npf_netmask_t); 225 int npf_table_lookup(npf_tableset_t *, u_int, 226 const int, const npf_addr_t *); 227 int npf_table_list(npf_tableset_t *, u_int, void *, size_t); 228 int npf_table_flush(npf_tableset_t *, u_int); 229 230 /* Ruleset interface. */ 231 npf_ruleset_t * npf_ruleset_create(size_t); 232 void npf_ruleset_destroy(npf_ruleset_t *); 233 void npf_ruleset_insert(npf_ruleset_t *, npf_rule_t *); 234 void npf_ruleset_reload(npf_ruleset_t *, npf_ruleset_t *); 235 void npf_ruleset_natreload(npf_ruleset_t *, npf_ruleset_t *); 236 npf_rule_t * npf_ruleset_matchnat(npf_ruleset_t *, npf_natpolicy_t *); 237 npf_rule_t * npf_ruleset_sharepm(npf_ruleset_t *, npf_natpolicy_t *); 238 void npf_ruleset_freealg(npf_ruleset_t *, npf_alg_t *); 239 240 int npf_ruleset_add(npf_ruleset_t *, const char *, npf_rule_t *); 241 int npf_ruleset_remove(npf_ruleset_t *, const char *, uint64_t); 242 int npf_ruleset_remkey(npf_ruleset_t *, const char *, 243 const void *, size_t); 244 prop_dictionary_t npf_ruleset_list(npf_ruleset_t *, const char *); 245 int npf_ruleset_flush(npf_ruleset_t *, const char *); 246 void npf_ruleset_gc(npf_ruleset_t *); 247 248 npf_rule_t * npf_ruleset_inspect(npf_cache_t *, nbuf_t *, 249 const npf_ruleset_t *, const int, const int); 250 int npf_rule_conclude(const npf_rule_t *, int *); 251 252 /* Rule interface. */ 253 npf_rule_t * npf_rule_alloc(prop_dictionary_t); 254 void npf_rule_setcode(npf_rule_t *, int, void *, size_t); 255 void npf_rule_setrproc(npf_rule_t *, npf_rproc_t *); 256 void npf_rule_free(npf_rule_t *); 257 uint64_t npf_rule_getid(const npf_rule_t *); 258 npf_natpolicy_t *npf_rule_getnat(const npf_rule_t *); 259 void npf_rule_setnat(npf_rule_t *, npf_natpolicy_t *); 260 npf_rproc_t * npf_rule_getrproc(npf_rule_t *); 261 262 void npf_ext_sysinit(void); 263 void npf_ext_sysfini(void); 264 int npf_ext_construct(const char *, 265 npf_rproc_t *, prop_dictionary_t); 266 267 npf_rprocset_t *npf_rprocset_create(void); 268 void npf_rprocset_destroy(npf_rprocset_t *); 269 npf_rproc_t * npf_rprocset_lookup(npf_rprocset_t *, const char *); 270 void npf_rprocset_insert(npf_rprocset_t *, npf_rproc_t *); 271 272 npf_rproc_t * npf_rproc_create(prop_dictionary_t); 273 void npf_rproc_acquire(npf_rproc_t *); 274 void npf_rproc_release(npf_rproc_t *); 275 void npf_rproc_run(npf_cache_t *, nbuf_t *, npf_rproc_t *, int *); 276 277 /* Session handling interface. */ 278 void npf_session_sysinit(void); 279 void npf_session_sysfini(void); 280 void npf_session_tracking(bool); 281 282 npf_sehash_t * sess_htable_create(void); 283 void sess_htable_destroy(npf_sehash_t *); 284 285 npf_session_t * npf_session_lookup(const npf_cache_t *, const nbuf_t *, 286 const int, bool *); 287 npf_session_t * npf_session_inspect(npf_cache_t *, nbuf_t *, const int, int *); 288 npf_session_t * npf_session_establish(npf_cache_t *, nbuf_t *, const int); 289 void npf_session_release(npf_session_t *); 290 void npf_session_expire(npf_session_t *); 291 bool npf_session_pass(const npf_session_t *, npf_rproc_t **); 292 void npf_session_setpass(npf_session_t *, npf_rproc_t *); 293 int npf_session_setnat(npf_session_t *, npf_nat_t *, const int); 294 npf_nat_t * npf_session_retnat(npf_session_t *, const int, bool *); 295 296 void npf_session_load(npf_sehash_t *); 297 int npf_session_save(prop_array_t, prop_array_t); 298 int npf_session_restore(npf_sehash_t *, prop_dictionary_t); 299 300 /* State handling. */ 301 bool npf_state_init(npf_cache_t *, nbuf_t *, npf_state_t *); 302 bool npf_state_inspect(npf_cache_t *, nbuf_t *, npf_state_t *, 303 const bool); 304 int npf_state_etime(const npf_state_t *, const int); 305 void npf_state_destroy(npf_state_t *); 306 307 bool npf_state_tcp(npf_cache_t *, nbuf_t *, npf_state_t *, int); 308 int npf_state_tcp_timeout(const npf_state_t *); 309 310 /* NAT. */ 311 void npf_nat_sysinit(void); 312 void npf_nat_sysfini(void); 313 npf_natpolicy_t *npf_nat_newpolicy(prop_dictionary_t, npf_ruleset_t *); 314 void npf_nat_freepolicy(npf_natpolicy_t *); 315 bool npf_nat_matchpolicy(npf_natpolicy_t *, npf_natpolicy_t *); 316 bool npf_nat_sharepm(npf_natpolicy_t *, npf_natpolicy_t *); 317 void npf_nat_freealg(npf_natpolicy_t *, npf_alg_t *); 318 319 int npf_do_nat(npf_cache_t *, npf_session_t *, nbuf_t *, const int); 320 int npf_nat_translate(npf_cache_t *, nbuf_t *, npf_nat_t *, 321 const bool, const int); 322 void npf_nat_expire(npf_nat_t *); 323 void npf_nat_getorig(npf_nat_t *, npf_addr_t **, in_port_t *); 324 void npf_nat_gettrans(npf_nat_t *, npf_addr_t **, in_port_t *); 325 void npf_nat_setalg(npf_nat_t *, npf_alg_t *, uintptr_t); 326 327 int npf_nat_save(prop_dictionary_t, prop_array_t, npf_nat_t *); 328 npf_nat_t * npf_nat_restore(prop_dictionary_t, npf_session_t *); 329 330 /* ALG interface. */ 331 void npf_alg_sysinit(void); 332 void npf_alg_sysfini(void); 333 npf_alg_t * npf_alg_register(const char *, npf_alg_func_t, npf_alg_func_t, 334 npf_alg_sfunc_t); 335 int npf_alg_unregister(npf_alg_t *); 336 npf_alg_t * npf_alg_construct(const char *); 337 bool npf_alg_match(npf_cache_t *, nbuf_t *, npf_nat_t *, int); 338 void npf_alg_exec(npf_cache_t *, nbuf_t *, npf_nat_t *, int); 339 npf_session_t * npf_alg_session(npf_cache_t *, nbuf_t *, int); 340 341 /* Debugging routines. */ 342 void npf_addr_dump(const npf_addr_t *); 343 void npf_sessions_dump(void); 344 void npf_state_dump(const npf_state_t *); 345 void npf_nat_dump(const npf_nat_t *); 346 void npf_state_setsampler(void (*)(npf_state_t *, bool)); 347 348 #endif /* _NPF_IMPL_H_ */ 349
Indexes created Wed Sep 24 05:09:52 GMT 2025