npf_impl.h revision 1.58.2.4
1 /* $NetBSD: npf_impl.h,v 1.58.2.4 2016/12/18 07:40:50 snj Exp $ */ 2 3 /*- 4 * Copyright (c) 2009-2014 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 53 #include <net/bpf.h> 54 #include <net/bpfjit.h> 55 #include <net/if.h> 56 57 #include "npf.h" 58 59 #ifdef _NPF_DEBUG 60 #define NPF_PRINTF(x) printf x 61 #else 62 #define NPF_PRINTF(x) 63 #endif 64 65 /* 66 * STRUCTURE DECLARATIONS. 67 */ 68 69 struct npf_ruleset; 70 struct npf_rule; 71 struct npf_rprocset; 72 struct npf_nat; 73 struct npf_conn; 74 75 typedef struct npf_ruleset npf_ruleset_t; 76 typedef struct npf_rule npf_rule_t; 77 typedef struct npf_nat npf_nat_t; 78 typedef struct npf_rprocset npf_rprocset_t; 79 typedef struct npf_alg npf_alg_t; 80 typedef struct npf_natpolicy npf_natpolicy_t; 81 typedef struct npf_conn npf_conn_t; 82 83 struct npf_conndb; 84 struct npf_table; 85 struct npf_tableset; 86 87 typedef struct npf_conndb npf_conndb_t; 88 typedef struct npf_table npf_table_t; 89 typedef struct npf_tableset npf_tableset_t; 90 91 /* 92 * DEFINITIONS. 93 */ 94 95 typedef void (*npf_workfunc_t)(void); 96 97 /* 98 * Some artificial limits. 99 * Note: very unlikely to have many ALGs. 100 */ 101 #define NPF_MAX_RULES (1024 * 1024) 102 #define NPF_MAX_ALGS 4 103 #define NPF_MAX_TABLES 128 104 #define NPF_MAX_RPROCS 128 105 #define NPF_MAX_IFMAP 64 106 107 /* 108 * CONNECTION 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 u_int nst_state; 123 npf_tcpstate_t nst_tcpst[2]; 124 } npf_state_t; 125 126 /* 127 * ALG FUNCTIONS. 128 */ 129 130 typedef struct { 131 bool (*match)(npf_cache_t *, npf_nat_t *, int); 132 bool (*translate)(npf_cache_t *, npf_nat_t *, bool); 133 npf_conn_t * (*inspect)(npf_cache_t *, int); 134 } npfa_funcs_t; 135 136 /* 137 * INTERFACES. 138 */ 139 140 /* NPF config, statistics, etc. */ 141 void npf_config_init(void); 142 void npf_config_fini(void); 143 144 void npf_config_enter(void); 145 void npf_config_exit(void); 146 void npf_config_sync(void); 147 bool npf_config_locked_p(void); 148 int npf_config_read_enter(void); 149 void npf_config_read_exit(int); 150 151 void npf_config_load(npf_ruleset_t *, npf_tableset_t *, 152 npf_ruleset_t *, npf_rprocset_t *, npf_conndb_t *, bool); 153 npf_ruleset_t * npf_config_ruleset(void); 154 npf_ruleset_t * npf_config_natset(void); 155 npf_tableset_t *npf_config_tableset(void); 156 npf_rprocset_t *npf_config_rprocs(void); 157 bool npf_default_pass(void); 158 159 int npf_worker_sysinit(void); 160 void npf_worker_sysfini(void); 161 void npf_worker_signal(void); 162 void npf_worker_register(npf_workfunc_t); 163 void npf_worker_unregister(npf_workfunc_t); 164 165 void npflogattach(int); 166 void npflogdetach(void); 167 int npfctl_switch(void *); 168 int npfctl_reload(u_long, void *); 169 int npfctl_save(u_long, void *); 170 int npfctl_load(u_long, void *); 171 int npfctl_rule(u_long, void *); 172 int npfctl_table(void *); 173 174 void npf_stats_inc(npf_stats_t); 175 void npf_stats_dec(npf_stats_t); 176 177 u_int npf_ifmap_register(const char *); 178 void npf_ifmap_flush(void); 179 void npf_ifmap_attach(ifnet_t *); 180 void npf_ifmap_detach(ifnet_t *); 181 u_int npf_ifmap_getid(const ifnet_t *); 182 const char * npf_ifmap_getname(const u_int); 183 184 /* Packet filter hooks. */ 185 int npf_pfil_register(bool); 186 void npf_pfil_unregister(bool); 187 bool npf_pfil_registered_p(void); 188 int npf_packet_handler(void *, struct mbuf **, ifnet_t *, int); 189 190 /* Protocol helpers. */ 191 int npf_cache_all(npf_cache_t *); 192 void npf_recache(npf_cache_t *); 193 194 bool npf_rwrip(const npf_cache_t *, u_int, const npf_addr_t *); 195 bool npf_rwrport(const npf_cache_t *, u_int, const in_port_t); 196 bool npf_rwrcksum(const npf_cache_t *, u_int, 197 const npf_addr_t *, const in_port_t); 198 int npf_napt_rwr(const npf_cache_t *, u_int, const npf_addr_t *, 199 const in_addr_t); 200 int npf_npt66_rwr(const npf_cache_t *, u_int, const npf_addr_t *, 201 npf_netmask_t, uint16_t); 202 203 uint16_t npf_fixup16_cksum(uint16_t, uint16_t, uint16_t); 204 uint16_t npf_fixup32_cksum(uint16_t, uint32_t, uint32_t); 205 uint16_t npf_addr_cksum(uint16_t, int, const npf_addr_t *, 206 const npf_addr_t *); 207 uint32_t npf_addr_mix(const int, const npf_addr_t *, const npf_addr_t *); 208 int npf_addr_cmp(const npf_addr_t *, const npf_netmask_t, 209 const npf_addr_t *, const npf_netmask_t, const int); 210 void npf_addr_mask(const npf_addr_t *, const npf_netmask_t, 211 const int, npf_addr_t *); 212 213 int npf_tcpsaw(const npf_cache_t *, tcp_seq *, tcp_seq *, 214 uint32_t *); 215 bool npf_fetch_tcpopts(npf_cache_t *, uint16_t *, int *); 216 bool npf_return_block(npf_cache_t *, const int); 217 218 /* BPF interface. */ 219 void npf_bpf_sysinit(void); 220 void npf_bpf_sysfini(void); 221 void npf_bpf_prepare(npf_cache_t *, bpf_args_t *, uint32_t *); 222 int npf_bpf_filter(bpf_args_t *, const void *, bpfjit_func_t); 223 void * npf_bpf_compile(void *, size_t); 224 bool npf_bpf_validate(const void *, size_t); 225 226 /* Tableset interface. */ 227 void npf_tableset_sysinit(void); 228 void npf_tableset_sysfini(void); 229 230 npf_tableset_t *npf_tableset_create(u_int); 231 void npf_tableset_destroy(npf_tableset_t *); 232 int npf_tableset_insert(npf_tableset_t *, npf_table_t *); 233 npf_table_t * npf_tableset_getbyname(npf_tableset_t *, const char *); 234 npf_table_t * npf_tableset_getbyid(npf_tableset_t *, u_int); 235 void npf_tableset_reload(npf_tableset_t *, npf_tableset_t *); 236 int npf_tableset_export(const npf_tableset_t *, prop_array_t); 237 238 npf_table_t * npf_table_create(const char *, u_int, int, void *, size_t); 239 void npf_table_destroy(npf_table_t *); 240 241 int npf_table_check(npf_tableset_t *, const char *, u_int, int); 242 int npf_table_insert(npf_table_t *, const int, 243 const npf_addr_t *, const npf_netmask_t); 244 int npf_table_remove(npf_table_t *, const int, 245 const npf_addr_t *, const npf_netmask_t); 246 int npf_table_lookup(npf_table_t *, const int, const npf_addr_t *); 247 int npf_table_list(npf_table_t *, void *, size_t); 248 int npf_table_flush(npf_table_t *); 249 250 /* Ruleset interface. */ 251 npf_ruleset_t * npf_ruleset_create(size_t); 252 void npf_ruleset_destroy(npf_ruleset_t *); 253 void npf_ruleset_insert(npf_ruleset_t *, npf_rule_t *); 254 void npf_ruleset_reload(npf_ruleset_t *, npf_ruleset_t *, bool); 255 npf_rule_t * npf_ruleset_sharepm(npf_ruleset_t *, npf_natpolicy_t *); 256 npf_natpolicy_t *npf_ruleset_findnat(npf_ruleset_t *, uint64_t); 257 void npf_ruleset_freealg(npf_ruleset_t *, npf_alg_t *); 258 int npf_ruleset_export(const npf_ruleset_t *, prop_array_t); 259 260 int npf_ruleset_add(npf_ruleset_t *, const char *, npf_rule_t *); 261 int npf_ruleset_remove(npf_ruleset_t *, const char *, uint64_t); 262 int npf_ruleset_remkey(npf_ruleset_t *, const char *, 263 const void *, size_t); 264 prop_dictionary_t npf_ruleset_list(npf_ruleset_t *, const char *); 265 int npf_ruleset_flush(npf_ruleset_t *, const char *); 266 void npf_ruleset_gc(npf_ruleset_t *); 267 268 npf_rule_t * npf_ruleset_inspect(npf_cache_t *, const npf_ruleset_t *, 269 const int, const int); 270 int npf_rule_conclude(const npf_rule_t *, int *); 271 272 /* Rule interface. */ 273 npf_rule_t * npf_rule_alloc(prop_dictionary_t); 274 void npf_rule_setcode(npf_rule_t *, int, void *, size_t); 275 void npf_rule_setrproc(npf_rule_t *, npf_rproc_t *); 276 void npf_rule_free(npf_rule_t *); 277 uint64_t npf_rule_getid(const npf_rule_t *); 278 npf_natpolicy_t *npf_rule_getnat(const npf_rule_t *); 279 void npf_rule_setnat(npf_rule_t *, npf_natpolicy_t *); 280 npf_rproc_t * npf_rule_getrproc(const npf_rule_t *); 281 282 void npf_ext_sysinit(void); 283 void npf_ext_sysfini(void); 284 int npf_ext_construct(const char *, 285 npf_rproc_t *, prop_dictionary_t); 286 287 npf_rprocset_t *npf_rprocset_create(void); 288 void npf_rprocset_destroy(npf_rprocset_t *); 289 npf_rproc_t * npf_rprocset_lookup(npf_rprocset_t *, const char *); 290 void npf_rprocset_insert(npf_rprocset_t *, npf_rproc_t *); 291 int npf_rprocset_export(const npf_rprocset_t *, prop_array_t); 292 293 npf_rproc_t * npf_rproc_create(prop_dictionary_t); 294 void npf_rproc_acquire(npf_rproc_t *); 295 void npf_rproc_release(npf_rproc_t *); 296 bool npf_rproc_run(npf_cache_t *, npf_rproc_t *, int *); 297 298 /* State handling. */ 299 bool npf_state_init(npf_cache_t *, npf_state_t *); 300 bool npf_state_inspect(npf_cache_t *, npf_state_t *, const bool); 301 int npf_state_etime(const npf_state_t *, const int); 302 void npf_state_destroy(npf_state_t *); 303 304 bool npf_state_tcp(npf_cache_t *, npf_state_t *, int); 305 int npf_state_tcp_timeout(const npf_state_t *); 306 307 /* NAT. */ 308 void npf_nat_sysinit(void); 309 void npf_nat_sysfini(void); 310 npf_natpolicy_t *npf_nat_newpolicy(prop_dictionary_t, npf_ruleset_t *); 311 int npf_nat_policyexport(const npf_natpolicy_t *, prop_dictionary_t); 312 void npf_nat_freepolicy(npf_natpolicy_t *); 313 bool npf_nat_cmppolicy(npf_natpolicy_t *, npf_natpolicy_t *); 314 bool npf_nat_sharepm(npf_natpolicy_t *, npf_natpolicy_t *); 315 void npf_nat_setid(npf_natpolicy_t *, uint64_t); 316 uint64_t npf_nat_getid(const npf_natpolicy_t *); 317 void npf_nat_freealg(npf_natpolicy_t *, npf_alg_t *); 318 319 int npf_do_nat(npf_cache_t *, npf_conn_t *, const int); 320 void npf_nat_destroy(npf_nat_t *); 321 void npf_nat_getorig(npf_nat_t *, npf_addr_t **, in_port_t *); 322 void npf_nat_gettrans(npf_nat_t *, npf_addr_t **, in_port_t *); 323 void npf_nat_setalg(npf_nat_t *, npf_alg_t *, uintptr_t); 324 325 void npf_nat_export(prop_dictionary_t, npf_nat_t *); 326 npf_nat_t * npf_nat_import(prop_dictionary_t, npf_ruleset_t *, 327 npf_conn_t *); 328 329 /* ALG interface. */ 330 void npf_alg_sysinit(void); 331 void npf_alg_sysfini(void); 332 npf_alg_t * npf_alg_register(const char *, const npfa_funcs_t *); 333 int npf_alg_unregister(npf_alg_t *); 334 npf_alg_t * npf_alg_construct(const char *); 335 bool npf_alg_match(npf_cache_t *, npf_nat_t *, int); 336 void npf_alg_exec(npf_cache_t *, npf_nat_t *, bool); 337 npf_conn_t * npf_alg_conn(npf_cache_t *, int); 338 prop_array_t npf_alg_export(void); 339 340 /* Debugging routines. */ 341 const char * npf_addr_dump(const npf_addr_t *, int); 342 void npf_state_dump(const npf_state_t *); 343 void npf_nat_dump(const npf_nat_t *); 344 void npf_ruleset_dump(const char *); 345 void npf_state_setsampler(void (*)(npf_state_t *, bool)); 346 347 #endif /* _NPF_IMPL_H_ */ 348
Indexes created Fri Oct 03 02:09:57 GMT 2025