npf_impl.h revision 1.24
1 /* $NetBSD: npf_impl.h,v 1.24 2012/10/29 02:27:12 rmind Exp $ */ 2 3 /*- 4 * Copyright (c) 2009-2012 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 #include <net/if.h> 57 58 #include "npf.h" 59 #include "npf_ncode.h" 60 61 #ifdef _NPF_DEBUG 62 #define NPF_PRINTF(x) printf x 63 #else 64 #define NPF_PRINTF(x) 65 #endif 66 67 /* 68 * STRUCTURE DECLARATIONS. 69 */ 70 71 struct npf_ruleset; 72 struct npf_rule; 73 struct npf_nat; 74 struct npf_session; 75 76 typedef struct npf_ruleset npf_ruleset_t; 77 typedef struct npf_rule npf_rule_t; 78 typedef struct npf_nat npf_nat_t; 79 typedef struct npf_alg npf_alg_t; 80 typedef struct npf_natpolicy npf_natpolicy_t; 81 typedef struct npf_session npf_session_t; 82 83 struct npf_sehash; 84 struct npf_table; 85 86 typedef struct npf_sehash npf_sehash_t; 87 typedef struct npf_table npf_table_t; 88 89 typedef npf_table_t * npf_tableset_t; 90 91 /* 92 * DEFINITIONS. 93 */ 94 95 typedef bool (*npf_algfunc_t)(npf_cache_t *, nbuf_t *, void *); 96 97 #define NPF_NCODE_LIMIT 1024 98 #define NPF_TABLE_SLOTS 32 99 100 /* 101 * SESSION STATE STRUCTURES 102 */ 103 104 #define NPF_FLOW_FORW 0 105 #define NPF_FLOW_BACK 1 106 107 typedef struct { 108 uint32_t nst_end; 109 uint32_t nst_maxend; 110 uint32_t nst_maxwin; 111 int nst_wscale; 112 } npf_tcpstate_t; 113 114 typedef struct { 115 kmutex_t nst_lock; 116 int nst_state; 117 npf_tcpstate_t nst_tcpst[2]; 118 } npf_state_t; 119 120 /* 121 * INTERFACES. 122 */ 123 124 /* NPF control, statistics, etc. */ 125 void npf_core_enter(void); 126 npf_ruleset_t * npf_core_ruleset(void); 127 npf_ruleset_t * npf_core_natset(void); 128 npf_tableset_t *npf_core_tableset(void); 129 void npf_core_exit(void); 130 bool npf_core_locked(void); 131 bool npf_default_pass(void); 132 prop_dictionary_t npf_core_dict(void); 133 134 void npf_reload(prop_dictionary_t, npf_ruleset_t *, 135 npf_tableset_t *, npf_ruleset_t *, bool); 136 137 void npflogattach(int); 138 void npflogdetach(void); 139 int npfctl_switch(void *); 140 int npfctl_reload(u_long, void *); 141 int npfctl_getconf(u_long, void *); 142 int npfctl_sessions_save(u_long, void *); 143 int npfctl_sessions_load(u_long, void *); 144 int npfctl_update_rule(u_long, void *); 145 int npfctl_table(void *); 146 147 void npf_stats_inc(npf_stats_t); 148 void npf_stats_dec(npf_stats_t); 149 150 /* Packet filter hooks. */ 151 int npf_pfil_register(void); 152 void npf_pfil_unregister(void); 153 bool npf_pfil_registered_p(void); 154 int npf_packet_handler(void *, struct mbuf **, ifnet_t *, int); 155 156 /* Protocol helpers. */ 157 bool npf_fetch_ip(npf_cache_t *, nbuf_t *, void *); 158 bool npf_fetch_tcp(npf_cache_t *, nbuf_t *, void *); 159 bool npf_fetch_udp(npf_cache_t *, nbuf_t *, void *); 160 bool npf_fetch_icmp(npf_cache_t *, nbuf_t *, void *); 161 int npf_cache_all(npf_cache_t *, nbuf_t *); 162 163 bool npf_rwrip(npf_cache_t *, nbuf_t *, void *, const int, 164 npf_addr_t *); 165 bool npf_rwrport(npf_cache_t *, nbuf_t *, void *, const int, 166 in_port_t); 167 bool npf_rwrcksum(npf_cache_t *, nbuf_t *, void *, const int, 168 npf_addr_t *, in_port_t); 169 170 uint16_t npf_fixup16_cksum(uint16_t, uint16_t, uint16_t); 171 uint16_t npf_fixup32_cksum(uint16_t, uint32_t, uint32_t); 172 uint16_t npf_addr_cksum(uint16_t, int, npf_addr_t *, npf_addr_t *); 173 uint32_t npf_addr_sum(const int, const npf_addr_t *, const npf_addr_t *); 174 int npf_addr_cmp(const npf_addr_t *, const npf_netmask_t, 175 const npf_addr_t *, const npf_netmask_t, const int); 176 void npf_addr_mask(const npf_addr_t *, const npf_netmask_t, 177 const int, npf_addr_t *); 178 179 int npf_tcpsaw(const npf_cache_t *, tcp_seq *, tcp_seq *, 180 uint32_t *); 181 bool npf_fetch_tcpopts(const npf_cache_t *, nbuf_t *, 182 uint16_t *, int *); 183 bool npf_return_block(npf_cache_t *, nbuf_t *, const int); 184 185 /* Complex instructions. */ 186 int npf_match_ether(nbuf_t *, int, int, uint16_t, uint32_t *); 187 int npf_match_proto(npf_cache_t *, nbuf_t *, void *, uint32_t); 188 int npf_match_table(npf_cache_t *, nbuf_t *, void *, 189 const int, const u_int); 190 int npf_match_ipmask(npf_cache_t *, nbuf_t *, void *, 191 const int, const npf_addr_t *, const npf_netmask_t); 192 int npf_match_tcp_ports(npf_cache_t *, nbuf_t *, void *, 193 const int, const uint32_t); 194 int npf_match_udp_ports(npf_cache_t *, nbuf_t *, void *, 195 const int, const uint32_t); 196 int npf_match_icmp4(npf_cache_t *, nbuf_t *, void *, uint32_t); 197 int npf_match_icmp6(npf_cache_t *, nbuf_t *, void *, uint32_t); 198 int npf_match_tcpfl(npf_cache_t *, nbuf_t *, void *, uint32_t); 199 200 /* Tableset interface. */ 201 void npf_tableset_sysinit(void); 202 void npf_tableset_sysfini(void); 203 204 extern const pt_tree_ops_t npf_table_ptree_ops; 205 206 npf_tableset_t *npf_tableset_create(void); 207 void npf_tableset_destroy(npf_tableset_t *); 208 int npf_tableset_insert(npf_tableset_t *, npf_table_t *); 209 void npf_tableset_reload(npf_tableset_t *, npf_tableset_t *); 210 211 npf_table_t * npf_table_create(u_int, int, size_t); 212 void npf_table_destroy(npf_table_t *); 213 214 int npf_table_check(const npf_tableset_t *, u_int, int); 215 int npf_table_insert(npf_tableset_t *, u_int, 216 const int, const npf_addr_t *, const npf_netmask_t); 217 int npf_table_remove(npf_tableset_t *, u_int, 218 const int, const npf_addr_t *, const npf_netmask_t); 219 int npf_table_lookup(npf_tableset_t *, u_int, 220 const int, const npf_addr_t *); 221 int npf_table_list(npf_tableset_t *, u_int, void *, size_t); 222 223 /* Ruleset interface. */ 224 npf_ruleset_t * npf_ruleset_create(void); 225 void npf_ruleset_destroy(npf_ruleset_t *); 226 void npf_ruleset_insert(npf_ruleset_t *, npf_rule_t *); 227 void npf_ruleset_natreload(npf_ruleset_t *, npf_ruleset_t *); 228 npf_rule_t * npf_ruleset_matchnat(npf_ruleset_t *, npf_natpolicy_t *); 229 npf_rule_t * npf_ruleset_sharepm(npf_ruleset_t *, npf_natpolicy_t *); 230 npf_rule_t * npf_ruleset_replace(const char *, npf_ruleset_t *); 231 void npf_ruleset_freealg(npf_ruleset_t *, npf_alg_t *); 232 233 npf_rule_t * npf_ruleset_inspect(npf_cache_t *, nbuf_t *, npf_ruleset_t *, 234 const ifnet_t *, const int, const int); 235 int npf_rule_apply(npf_cache_t *, nbuf_t *, npf_rule_t *, int *); 236 237 /* Rule interface. */ 238 npf_rule_t * npf_rule_alloc(prop_dictionary_t, npf_rproc_t *, void *, size_t); 239 void npf_rule_free(npf_rule_t *); 240 npf_ruleset_t * npf_rule_subset(npf_rule_t *); 241 npf_natpolicy_t *npf_rule_getnat(const npf_rule_t *); 242 void npf_rule_setnat(npf_rule_t *, npf_natpolicy_t *); 243 npf_rproc_t * npf_rule_getrproc(npf_rule_t *); 244 245 void npf_ext_sysinit(void); 246 void npf_ext_sysfini(void); 247 int npf_ext_construct(const char *, 248 npf_rproc_t *, prop_dictionary_t); 249 250 npf_rproc_t * npf_rproc_create(prop_dictionary_t); 251 void npf_rproc_acquire(npf_rproc_t *); 252 void npf_rproc_release(npf_rproc_t *); 253 void npf_rproc_run(npf_cache_t *, nbuf_t *, npf_rproc_t *, int *); 254 255 /* Session handling interface. */ 256 void npf_session_sysinit(void); 257 void npf_session_sysfini(void); 258 int npf_session_tracking(bool); 259 260 npf_sehash_t * sess_htable_create(void); 261 void sess_htable_destroy(npf_sehash_t *); 262 void sess_htable_reload(npf_sehash_t *); 263 264 npf_session_t * npf_session_inspect(npf_cache_t *, nbuf_t *, 265 const ifnet_t *, const int, int *); 266 npf_session_t * npf_session_establish(const npf_cache_t *, nbuf_t *, 267 const ifnet_t *, const int); 268 void npf_session_release(npf_session_t *); 269 void npf_session_expire(npf_session_t *); 270 bool npf_session_pass(const npf_session_t *, npf_rproc_t **); 271 void npf_session_setpass(npf_session_t *, npf_rproc_t *); 272 int npf_session_setnat(npf_session_t *, npf_nat_t *, const int); 273 npf_nat_t * npf_session_retnat(npf_session_t *, const int, bool *); 274 275 int npf_session_save(prop_array_t, prop_array_t); 276 int npf_session_restore(npf_sehash_t *, prop_dictionary_t); 277 278 /* State handling. */ 279 bool npf_state_init(const npf_cache_t *, nbuf_t *, npf_state_t *); 280 bool npf_state_inspect(const npf_cache_t *, nbuf_t *, npf_state_t *, 281 const bool); 282 int npf_state_etime(const npf_state_t *, const int); 283 void npf_state_destroy(npf_state_t *); 284 285 bool npf_state_tcp(const npf_cache_t *, nbuf_t *, npf_state_t *, int); 286 int npf_state_tcp_timeout(const npf_state_t *); 287 288 /* NAT. */ 289 void npf_nat_sysinit(void); 290 void npf_nat_sysfini(void); 291 npf_natpolicy_t *npf_nat_newpolicy(prop_dictionary_t, npf_ruleset_t *); 292 void npf_nat_freepolicy(npf_natpolicy_t *); 293 bool npf_nat_matchpolicy(npf_natpolicy_t *, npf_natpolicy_t *); 294 bool npf_nat_sharepm(npf_natpolicy_t *, npf_natpolicy_t *); 295 void npf_nat_freealg(npf_natpolicy_t *, npf_alg_t *); 296 297 int npf_do_nat(npf_cache_t *, npf_session_t *, nbuf_t *, 298 const ifnet_t *, const int); 299 void npf_nat_expire(npf_nat_t *); 300 void npf_nat_getorig(npf_nat_t *, npf_addr_t **, in_port_t *); 301 void npf_nat_gettrans(npf_nat_t *, npf_addr_t **, in_port_t *); 302 void npf_nat_setalg(npf_nat_t *, npf_alg_t *, uintptr_t); 303 304 int npf_nat_save(prop_dictionary_t, prop_array_t, npf_nat_t *); 305 npf_nat_t * npf_nat_restore(prop_dictionary_t, npf_session_t *); 306 307 /* ALG interface. */ 308 void npf_alg_sysinit(void); 309 void npf_alg_sysfini(void); 310 npf_alg_t * npf_alg_register(npf_algfunc_t, npf_algfunc_t, 311 npf_algfunc_t, npf_algfunc_t); 312 int npf_alg_unregister(npf_alg_t *); 313 bool npf_alg_match(npf_cache_t *, nbuf_t *, npf_nat_t *); 314 void npf_alg_exec(npf_cache_t *, nbuf_t *, npf_nat_t *, const int ); 315 bool npf_alg_sessionid(npf_cache_t *, nbuf_t *, npf_cache_t *); 316 317 /* Debugging routines. */ 318 void npf_addr_dump(const npf_addr_t *); 319 void npf_rulenc_dump(const npf_rule_t *); 320 void npf_sessions_dump(void); 321 void npf_state_dump(const npf_state_t *); 322 void npf_nat_dump(const npf_nat_t *); 323 void npf_state_setsampler(void (*)(npf_state_t *, bool)); 324 325 #endif /* _NPF_IMPL_H_ */ 326
Indexes created Tue Sep 23 14:10:03 GMT 2025