npf_impl.h revision 1.9.2.5
1 /* $NetBSD: npf_impl.h,v 1.9.2.5 2012/06/02 11:09:38 mrg 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 #include <sys/types.h> 45 #include <sys/queue.h> 46 #include <sys/hash.h> 47 #include <sys/rbtree.h> 48 #include <sys/rwlock.h> 49 #include <net/if.h> 50 51 #include "npf.h" 52 #include "npf_ncode.h" 53 54 #ifdef _NPF_DEBUG 55 #define NPF_PRINTF(x) printf x 56 #else 57 #define NPF_PRINTF(x) 58 #endif 59 60 /* 61 * STRUCTURE DECLARATIONS. 62 */ 63 64 struct npf_ruleset; 65 struct npf_rule; 66 struct npf_nat; 67 struct npf_session; 68 69 typedef struct npf_ruleset npf_ruleset_t; 70 typedef struct npf_rule npf_rule_t; 71 typedef struct npf_nat npf_nat_t; 72 typedef struct npf_alg npf_alg_t; 73 typedef struct npf_natpolicy npf_natpolicy_t; 74 typedef struct npf_session npf_session_t; 75 76 struct npf_sehash; 77 struct npf_tblent; 78 struct npf_table; 79 80 typedef struct npf_sehash npf_sehash_t; 81 typedef struct npf_tblent npf_tblent_t; 82 typedef struct npf_table npf_table_t; 83 84 typedef npf_table_t * npf_tableset_t; 85 86 /* 87 * DEFINITIONS. 88 */ 89 90 #define NPF_DECISION_BLOCK 0 91 #define NPF_DECISION_PASS 1 92 93 typedef bool (*npf_algfunc_t)(npf_cache_t *, nbuf_t *, void *); 94 95 #define NPF_NCODE_LIMIT 1024 96 #define NPF_TABLE_SLOTS 32 97 98 /* 99 * SESSION STATE STRUCTURES 100 */ 101 102 #define NPF_FLOW_FORW 0 103 #define NPF_FLOW_BACK 1 104 105 typedef struct { 106 uint32_t nst_end; 107 uint32_t nst_maxend; 108 uint32_t nst_maxwin; 109 int nst_wscale; 110 } npf_tcpstate_t; 111 112 typedef struct { 113 kmutex_t nst_lock; 114 int nst_state; 115 npf_tcpstate_t nst_tcpst[2]; 116 } npf_state_t; 117 118 #if defined(_NPF_TESTING) 119 void npf_state_sample(npf_state_t *, bool); 120 #define NPF_TCP_STATE_SAMPLE(n, r) npf_state_sample(n, r) 121 #else 122 #define NPF_TCP_STATE_SAMPLE(n, r) 123 #endif 124 125 /* 126 * INTERFACES. 127 */ 128 129 /* NPF control, statistics, etc. */ 130 void npf_core_enter(void); 131 npf_ruleset_t * npf_core_ruleset(void); 132 npf_ruleset_t * npf_core_natset(void); 133 npf_tableset_t *npf_core_tableset(void); 134 void npf_core_exit(void); 135 bool npf_core_locked(void); 136 bool npf_default_pass(void); 137 prop_dictionary_t npf_core_dict(void); 138 139 void npf_reload(prop_dictionary_t, npf_ruleset_t *, 140 npf_tableset_t *, npf_ruleset_t *, bool); 141 142 void npflogattach(int); 143 void npflogdetach(void); 144 int npfctl_switch(void *); 145 int npfctl_reload(u_long, void *); 146 int npfctl_getconf(u_long, void *); 147 int npfctl_sessions_save(u_long, void *); 148 int npfctl_sessions_load(u_long, void *); 149 int npfctl_update_rule(u_long, void *); 150 int npfctl_table(void *); 151 152 void npf_stats_inc(npf_stats_t); 153 void npf_stats_dec(npf_stats_t); 154 155 /* Packet filter hooks. */ 156 int npf_pfil_register(void); 157 void npf_pfil_unregister(void); 158 bool npf_pfil_registered_p(void); 159 int npf_packet_handler(void *, struct mbuf **, ifnet_t *, int); 160 void npf_log_packet(npf_cache_t *, nbuf_t *, int); 161 162 /* Protocol helpers. */ 163 bool npf_fetch_ip(npf_cache_t *, nbuf_t *, void *); 164 bool npf_fetch_tcp(npf_cache_t *, nbuf_t *, void *); 165 bool npf_fetch_udp(npf_cache_t *, nbuf_t *, void *); 166 bool npf_fetch_icmp(npf_cache_t *, nbuf_t *, void *); 167 int npf_cache_all(npf_cache_t *, nbuf_t *); 168 169 bool npf_rwrip(npf_cache_t *, nbuf_t *, void *, const int, 170 npf_addr_t *); 171 bool npf_rwrport(npf_cache_t *, nbuf_t *, void *, const int, 172 in_port_t); 173 bool npf_rwrcksum(npf_cache_t *, nbuf_t *, void *, const int, 174 npf_addr_t *, in_port_t); 175 176 uint16_t npf_fixup16_cksum(uint16_t, uint16_t, uint16_t); 177 uint16_t npf_fixup32_cksum(uint16_t, uint32_t, uint32_t); 178 uint16_t npf_addr_cksum(uint16_t, int, npf_addr_t *, npf_addr_t *); 179 uint32_t npf_addr_sum(const int, const npf_addr_t *, const npf_addr_t *); 180 int npf_tcpsaw(npf_cache_t *, tcp_seq *, tcp_seq *, uint32_t *); 181 bool npf_fetch_tcpopts(const npf_cache_t *, nbuf_t *, 182 uint16_t *, int *); 183 bool npf_normalize(npf_cache_t *, nbuf_t *, bool, bool, u_int, u_int); 184 bool npf_return_block(npf_cache_t *, nbuf_t *, const int); 185 186 /* Complex instructions. */ 187 int npf_match_ether(nbuf_t *, int, int, uint16_t, 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_tcpfl(npf_cache_t *, nbuf_t *, void *, uint32_t); 198 199 /* Tableset interface. */ 200 void npf_tableset_sysinit(void); 201 void npf_tableset_sysfini(void); 202 203 npf_tableset_t *npf_tableset_create(void); 204 void npf_tableset_destroy(npf_tableset_t *); 205 int npf_tableset_insert(npf_tableset_t *, npf_table_t *); 206 npf_tableset_t *npf_tableset_reload(npf_tableset_t *); 207 208 npf_table_t * npf_table_create(u_int, int, size_t); 209 void npf_table_destroy(npf_table_t *); 210 void npf_table_ref(npf_table_t *); 211 void npf_table_unref(npf_table_t *); 212 213 npf_table_t * npf_table_get(npf_tableset_t *, u_int); 214 void npf_table_put(npf_table_t *); 215 int npf_table_check(npf_tableset_t *, u_int, int); 216 int npf_table_add_cidr(npf_tableset_t *, u_int, 217 const npf_addr_t *, const npf_netmask_t); 218 int npf_table_rem_cidr(npf_tableset_t *, u_int, 219 const npf_addr_t *, const npf_netmask_t); 220 int npf_table_match_addr(npf_tableset_t *, u_int, 221 const npf_addr_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 232 npf_rule_t * npf_ruleset_inspect(npf_cache_t *, nbuf_t *, npf_ruleset_t *, 233 ifnet_t *, const int, const int); 234 int npf_rule_apply(npf_cache_t *, nbuf_t *, npf_rule_t *, int *); 235 236 /* Rule interface. */ 237 npf_rule_t * npf_rule_alloc(prop_dictionary_t, npf_rproc_t *, void *, size_t); 238 void npf_rule_free(npf_rule_t *); 239 npf_ruleset_t * npf_rule_subset(npf_rule_t *); 240 npf_natpolicy_t *npf_rule_getnat(const npf_rule_t *); 241 void npf_rule_setnat(npf_rule_t *, npf_natpolicy_t *); 242 npf_rproc_t * npf_rule_getrproc(npf_rule_t *); 243 244 npf_rproc_t * npf_rproc_create(prop_dictionary_t); 245 void npf_rproc_acquire(npf_rproc_t *); 246 void npf_rproc_release(npf_rproc_t *); 247 void npf_rproc_run(npf_cache_t *, nbuf_t *, npf_rproc_t *, int); 248 249 /* Session handling interface. */ 250 void npf_session_sysinit(void); 251 void npf_session_sysfini(void); 252 int npf_session_tracking(bool); 253 254 npf_sehash_t * sess_htable_create(void); 255 void sess_htable_destroy(npf_sehash_t *); 256 void sess_htable_reload(npf_sehash_t *); 257 258 npf_session_t * npf_session_inspect(npf_cache_t *, nbuf_t *, const int, int *); 259 npf_session_t * npf_session_establish(const npf_cache_t *, nbuf_t *, const int); 260 void npf_session_release(npf_session_t *); 261 void npf_session_expire(npf_session_t *); 262 bool npf_session_pass(const npf_session_t *, npf_rproc_t **); 263 void npf_session_setpass(npf_session_t *, npf_rproc_t *); 264 int npf_session_setnat(npf_session_t *, npf_nat_t *, const int); 265 npf_nat_t * npf_session_retnat(npf_session_t *, const int, bool *); 266 267 int npf_session_save(prop_array_t, prop_array_t); 268 int npf_session_restore(npf_sehash_t *, prop_dictionary_t); 269 270 /* State handling. */ 271 bool npf_state_init(const npf_cache_t *, nbuf_t *, npf_state_t *); 272 bool npf_state_inspect(const npf_cache_t *, nbuf_t *, npf_state_t *, 273 const bool); 274 int npf_state_etime(const npf_state_t *, const int); 275 void npf_state_destroy(npf_state_t *); 276 277 bool npf_state_tcp(const npf_cache_t *, nbuf_t *, npf_state_t *, int); 278 int npf_state_tcp_timeout(const npf_state_t *); 279 280 /* NAT. */ 281 void npf_nat_sysinit(void); 282 void npf_nat_sysfini(void); 283 npf_natpolicy_t *npf_nat_newpolicy(prop_dictionary_t, npf_ruleset_t *); 284 void npf_nat_freepolicy(npf_natpolicy_t *); 285 bool npf_nat_matchpolicy(npf_natpolicy_t *, npf_natpolicy_t *); 286 bool npf_nat_sharepm(npf_natpolicy_t *, npf_natpolicy_t *); 287 288 int npf_do_nat(npf_cache_t *, npf_session_t *, nbuf_t *, 289 ifnet_t *, const int); 290 void npf_nat_expire(npf_nat_t *); 291 void npf_nat_getorig(npf_nat_t *, npf_addr_t **, in_port_t *); 292 void npf_nat_gettrans(npf_nat_t *, npf_addr_t **, in_port_t *); 293 void npf_nat_setalg(npf_nat_t *, npf_alg_t *, uintptr_t); 294 295 int npf_nat_save(prop_dictionary_t, prop_array_t, npf_nat_t *); 296 npf_nat_t * npf_nat_restore(prop_dictionary_t, npf_session_t *); 297 298 /* ALG interface. */ 299 void npf_alg_sysinit(void); 300 void npf_alg_sysfini(void); 301 npf_alg_t * npf_alg_register(npf_algfunc_t, npf_algfunc_t, 302 npf_algfunc_t, npf_algfunc_t); 303 int npf_alg_unregister(npf_alg_t *); 304 bool npf_alg_match(npf_cache_t *, nbuf_t *, npf_nat_t *); 305 void npf_alg_exec(npf_cache_t *, nbuf_t *, npf_nat_t *, const int ); 306 bool npf_alg_sessionid(npf_cache_t *, nbuf_t *, npf_cache_t *); 307 308 /* Debugging routines. */ 309 void npf_rulenc_dump(npf_rule_t *); 310 void npf_sessions_dump(void); 311 void npf_state_dump(npf_state_t *); 312 void npf_nat_dump(npf_nat_t *); 313 314 #endif /* _NPF_IMPL_H_ */ 315
Indexes created Fri Oct 03 02:09:57 GMT 2025