1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2002-2009 Luigi Rizzo, Universita` di Pisa 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25 * SUCH DAMAGE. 26 */ 27 28 #ifndef _IPFW2_PRIVATE_H 29 #define _IPFW2_PRIVATE_H 30 31 /* 32 * Internal constants and data structures used by ipfw components 33 * and not meant to be exported outside the kernel. 34 */ 35 36 #ifdef _KERNEL 37 38 /* 39 * For platforms that do not have SYSCTL support, we wrap the 40 * SYSCTL_* into a function (one per file) to collect the values 41 * into an array at module initialization. The wrapping macros, 42 * SYSBEGIN() and SYSEND, are empty in the default case. 43 */ 44 #ifndef SYSBEGIN 45 #define SYSBEGIN(x) 46 #endif 47 #ifndef SYSEND 48 #define SYSEND 49 #endif 50 51 /* Return values from ipfw_chk() */ 52 enum { 53 IP_FW_PASS = 0, 54 IP_FW_DENY, 55 IP_FW_DIVERT, 56 IP_FW_TEE, 57 IP_FW_DUMMYNET, 58 IP_FW_NETGRAPH, 59 IP_FW_NGTEE, 60 IP_FW_NAT, 61 IP_FW_REASS, 62 IP_FW_NAT64, 63 }; 64 65 /* 66 * Structure for collecting parameters to dummynet for ip6_output forwarding 67 */ 68 struct _ip6dn_args { 69 struct ip6_pktopts *opt_or; 70 int flags_or; 71 struct ip6_moptions *im6o_or; 72 struct ifnet *origifp_or; 73 struct ifnet *ifp_or; 74 struct sockaddr_in6 dst_or; 75 u_long mtu_or; 76 }; 77 78 /* 79 * Arguments for calling ipfw_chk() and dummynet_io(). We put them 80 * all into a structure because this way it is easier and more 81 * efficient to pass variables around and extend the interface. 82 */ 83 struct ip_fw_args { 84 uint32_t flags; 85 #define IPFW_ARGS_ETHER 0x00010000 /* valid ethernet header */ 86 #define IPFW_ARGS_NH4 0x00020000 /* IPv4 next hop in hopstore */ 87 #define IPFW_ARGS_NH6 0x00040000 /* IPv6 next hop in hopstore */ 88 #define IPFW_ARGS_NH4PTR 0x00080000 /* IPv4 next hop in next_hop */ 89 #define IPFW_ARGS_NH6PTR 0x00100000 /* IPv6 next hop in next_hop6 */ 90 #define IPFW_ARGS_REF 0x00200000 /* valid ipfw_rule_ref */ 91 #define IPFW_ARGS_IN 0x00400000 /* called on input */ 92 #define IPFW_ARGS_OUT 0x00800000 /* called on output */ 93 #define IPFW_ARGS_IP4 0x01000000 /* belongs to v4 ISR */ 94 #define IPFW_ARGS_IP6 0x02000000 /* belongs to v6 ISR */ 95 #define IPFW_ARGS_DROP 0x04000000 /* drop it (dummynet) */ 96 #define IPFW_ARGS_LENMASK 0x0000ffff /* length of data in *mem */ 97 #define IPFW_ARGS_LENGTH(f) ((f) & IPFW_ARGS_LENMASK) 98 /* 99 * On return, it points to the matching rule. 100 * On entry, rule.slot > 0 means the info is valid and 101 * contains the starting rule for an ipfw search. 102 * If chain_id == chain->id && slot >0 then jump to that slot. 103 * Otherwise, we locate the first rule >= rulenum:rule_id 104 */ 105 struct ipfw_rule_ref rule; /* match/restart info */ 106 107 struct ifnet *ifp; /* input/output interface */ 108 struct inpcb *inp; 109 union { 110 /* 111 * next_hop[6] pointers can be used to point to next hop 112 * stored in rule's opcode to avoid copying into hopstore. 113 * Also, it is expected that all 0x1-0x10 flags are mutually 114 * exclusive. 115 */ 116 struct sockaddr_in *next_hop; 117 struct sockaddr_in6 *next_hop6; 118 /* ipfw next hop storage */ 119 struct sockaddr_in hopstore; 120 struct ip_fw_nh6 { 121 struct in6_addr sin6_addr; 122 uint32_t sin6_scope_id; 123 uint16_t sin6_port; 124 } hopstore6; 125 }; 126 union { 127 struct mbuf *m; /* the mbuf chain */ 128 void *mem; /* or memory pointer */ 129 }; 130 struct ipfw_flow_id f_id; /* grabbed from IP header */ 131 }; 132 133 MALLOC_DECLARE(M_IPFW); 134 135 /* wrapper for freeing a packet, in case we need to do more work */ 136 #ifndef FREE_PKT 137 #if defined(__linux__) || defined(_WIN32) 138 #define FREE_PKT(m) netisr_dispatch(-1, m) 139 #else 140 #define FREE_PKT(m) m_freem(m) 141 #endif 142 #endif /* !FREE_PKT */ 143 144 /* 145 * Function definitions. 146 */ 147 int ipfw_chk(struct ip_fw_args *args); 148 struct mbuf *ipfw_send_pkt(struct mbuf *, struct ipfw_flow_id *, 149 u_int32_t, u_int32_t, int); 150 151 int ipfw_attach_hooks(void); 152 void ipfw_detach_hooks(void); 153 #ifdef NOTYET 154 void ipfw_nat_destroy(void); 155 #endif 156 157 /* In ip_fw_log.c */ 158 struct ip; 159 struct ip_fw; 160 struct ip_fw_chain; 161 162 void ipfw_bpf_init(int); 163 void ipfw_bpf_uninit(int); 164 void ipfw_bpf_tap(u_char *, u_int); 165 void ipfw_bpf_mtap(struct mbuf *); 166 void ipfw_bpf_mtap2(void *, u_int, struct mbuf *); 167 void ipfw_log(struct ip_fw_chain *chain, struct ip_fw *f, u_int hlen, 168 struct ip_fw_args *args, u_short offset, uint32_t tablearg, struct ip *ip, 169 void *eh); 170 VNET_DECLARE(u_int64_t, norule_counter); 171 #define V_norule_counter VNET(norule_counter) 172 VNET_DECLARE(int, verbose_limit); 173 #define V_verbose_limit VNET(verbose_limit) 174 175 /* In ip_fw_dynamic.c */ 176 struct sockopt_data; 177 178 enum { /* result for matching dynamic rules */ 179 MATCH_REVERSE = 0, 180 MATCH_FORWARD, 181 MATCH_NONE, 182 MATCH_UNKNOWN, 183 }; 184 185 /* 186 * Macro to determine that we need to do or redo dynamic state lookup. 187 * direction == MATCH_UNKNOWN means that this is first lookup, then we need 188 * to do lookup. 189 * Otherwise check the state name, if previous lookup was for "any" name, 190 * this means there is no state with specific name. Thus no need to do 191 * lookup. If previous name was not "any", redo lookup for specific name. 192 */ 193 #define DYN_LOOKUP_NEEDED(p, cmd) \ 194 ((p)->direction == MATCH_UNKNOWN || \ 195 ((p)->kidx != 0 && (p)->kidx != (cmd)->arg1)) 196 #define DYN_INFO_INIT(p) do { \ 197 (p)->direction = MATCH_UNKNOWN; \ 198 (p)->kidx = 0; \ 199 } while (0) 200 struct ipfw_dyn_info { 201 uint32_t direction; /* match direction */ 202 uint32_t kidx; /* state name kidx */ 203 uint32_t hashval; /* hash value */ 204 uint32_t version; /* bucket version */ 205 uint32_t f_pos; 206 }; 207 int ipfw_dyn_install_state(struct ip_fw_chain *chain, struct ip_fw *rule, 208 const ipfw_insn_limit *cmd, const struct ip_fw_args *args, 209 const void *ulp, int pktlen, struct ipfw_dyn_info *info, 210 uint32_t tablearg); 211 struct ip_fw *ipfw_dyn_lookup_state(const struct ip_fw_args *args, 212 const void *ulp, int pktlen, const ipfw_insn *cmd, 213 struct ipfw_dyn_info *info); 214 215 int ipfw_is_dyn_rule(struct ip_fw *rule); 216 void ipfw_expire_dyn_states(struct ip_fw_chain *, ipfw_range_tlv *); 217 void ipfw_get_dynamic(struct ip_fw_chain *chain, char **bp, const char *ep); 218 int ipfw_dump_states(struct ip_fw_chain *chain, struct sockopt_data *sd); 219 220 void ipfw_dyn_init(struct ip_fw_chain *); /* per-vnet initialization */ 221 void ipfw_dyn_uninit(int); /* per-vnet deinitialization */ 222 int ipfw_dyn_len(void); 223 uint32_t ipfw_dyn_get_count(uint32_t *, int *); 224 void ipfw_dyn_reset_eaction(struct ip_fw_chain *ch, uint32_t eaction_id, 225 uint32_t default_id, uint32_t instance_id); 226 227 /* common variables */ 228 VNET_DECLARE(int, fw_one_pass); 229 #define V_fw_one_pass VNET(fw_one_pass) 230 231 VNET_DECLARE(int, fw_verbose); 232 #define V_fw_verbose VNET(fw_verbose) 233 234 VNET_DECLARE(struct ip_fw_chain, layer3_chain); 235 #define V_layer3_chain VNET(layer3_chain) 236 237 VNET_DECLARE(int, ipfw_vnet_ready); 238 #define V_ipfw_vnet_ready VNET(ipfw_vnet_ready) 239 240 VNET_DECLARE(int, skipto_cache); 241 #define V_skipto_cache VNET(skipto_cache) 242 243 VNET_DECLARE(u_int32_t, set_disable); 244 #define V_set_disable VNET(set_disable) 245 246 VNET_DECLARE(int, autoinc_step); 247 #define V_autoinc_step VNET(autoinc_step) 248 249 VNET_DECLARE(unsigned int, fw_tables_max); 250 #define V_fw_tables_max VNET(fw_tables_max) 251 252 VNET_DECLARE(unsigned int, fw_tables_sets); 253 #define V_fw_tables_sets VNET(fw_tables_sets) 254 255 struct tables_config; 256 257 #ifdef _KERNEL 258 /* 259 * Here we have the structure representing an ipfw rule. 260 * 261 * It starts with a general area 262 * followed by an array of one or more instructions, which the code 263 * accesses as an array of 32-bit values. 264 * 265 * Given a rule pointer r: 266 * 267 * r->cmd is the start of the first instruction. 268 * ACTION_PTR(r) is the start of the first action (things to do 269 * once a rule matched). 270 */ 271 struct ip_fw_jump_cache { 272 union { 273 struct { 274 uint32_t id; 275 uint32_t pos; 276 }; 277 uint64_t raw_value; 278 }; 279 }; 280 281 struct ip_fw { 282 uint16_t act_ofs; /* offset of action in 32-bit units */ 283 uint16_t cmd_len; /* # of 32-bit words in cmd */ 284 uint32_t rulenum; /* rule number */ 285 uint8_t set; /* rule set (0..31) */ 286 uint8_t flags; /* currently unused */ 287 uint16_t _pad; 288 counter_u64_t cntr; /* Pointer to rule counters */ 289 struct ip_fw_jump_cache cache; /* used by jump_fast */ 290 uint32_t timestamp; /* tv_sec of last match */ 291 uint32_t id; /* rule id */ 292 uint32_t refcnt; /* number of references */ 293 294 struct ip_fw *next; /* linked list of deleted rules */ 295 ipfw_insn cmd[1]; /* storage for commands */ 296 }; 297 298 #define IPFW_RULE_CNTR_SIZE (2 * sizeof(uint64_t)) 299 300 #endif 301 302 struct ip_fw_chain { 303 struct ip_fw **map; /* array of rule ptrs to ease lookup */ 304 uint32_t id; /* ruleset id */ 305 int n_rules; /* number of static rules */ 306 void *tablestate; /* runtime table info */ 307 void *valuestate; /* runtime table value info */ 308 int *idxmap; /* skipto array of rules */ 309 void **srvstate; /* runtime service mappings */ 310 #if defined( __linux__ ) || defined( _WIN32 ) 311 spinlock_t rwmtx; 312 #else 313 struct rmlock rwmtx; 314 #endif 315 uint32_t gencnt; /* NAT generation count */ 316 LIST_HEAD(nat_list, cfg_nat) nat; /* list of nat entries */ 317 struct ip_fw *default_rule; 318 struct tables_config *tblcfg; /* tables module data */ 319 void *ifcfg; /* interface module data */ 320 int *idxmap_back; /* standby skipto array of rules */ 321 struct namedobj_instance *srvmap; /* cfg name->number mappings */ 322 #if defined( __linux__ ) || defined( _WIN32 ) 323 spinlock_t uh_lock; 324 #else 325 struct rwlock uh_lock; /* lock for upper half */ 326 #endif 327 }; 328 329 /* 64-byte structure representing multi-field table value */ 330 struct table_value { 331 uint32_t tag; /* O_TAG/O_TAGGED */ 332 uint16_t pipe; /* O_PIPE/O_QUEUE */ 333 uint16_t divert; /* O_DIVERT/O_TEE */ 334 uint32_t skipto; /* skipto, CALLRET */ 335 uint32_t netgraph; /* O_NETGRAPH/O_NGTEE */ 336 uint16_t fib; /* O_SETFIB */ 337 uint16_t nat; /* O_NAT */ 338 uint32_t mark; /* O_SETMARK/O_MARK */ 339 uint32_t nh4; 340 uint8_t dscp; 341 uint8_t spare0; 342 uint16_t kidx; /* value kernel index */ 343 /* -- 32 bytes -- */ 344 struct in6_addr nh6; 345 uint32_t limit; /* O_LIMIT */ 346 uint32_t zoneid; /* scope zone id for nh6 */ 347 uint64_t refcnt; /* Number of references */ 348 }; 349 350 struct named_object { 351 TAILQ_ENTRY(named_object) nn_next; /* namehash */ 352 TAILQ_ENTRY(named_object) nv_next; /* valuehash */ 353 char *name; /* object name */ 354 uint16_t etlv; /* Export TLV id */ 355 uint8_t subtype;/* object subtype within class */ 356 uint8_t set; /* set object belongs to */ 357 uint32_t kidx; /* object kernel index */ 358 uint32_t ocnt; /* object counter for internal use */ 359 uint32_t refcnt; /* number of references */ 360 }; 361 TAILQ_HEAD(namedobjects_head, named_object); 362 363 struct sockopt; /* used by tcp_var.h */ 364 struct sockopt_data { 365 caddr_t kbuf; /* allocated buffer */ 366 size_t ksize; /* given buffer size */ 367 size_t koff; /* data already used */ 368 size_t kavail; /* number of bytes available */ 369 size_t ktotal; /* total bytes pushed */ 370 struct sockopt *sopt; /* socket data */ 371 caddr_t sopt_val; /* sopt user buffer */ 372 size_t valsize; /* original data size */ 373 }; 374 375 struct ipfw_ifc; 376 377 typedef void (ipfw_ifc_cb)(struct ip_fw_chain *ch, void *cbdata, 378 uint16_t ifindex); 379 380 struct ipfw_iface { 381 struct named_object no; 382 char ifname[64]; 383 int resolved; 384 uint16_t ifindex; 385 uint16_t spare; 386 uint64_t gencnt; 387 TAILQ_HEAD(, ipfw_ifc) consumers; 388 }; 389 390 struct ipfw_ifc { 391 TAILQ_ENTRY(ipfw_ifc) next; 392 struct ipfw_iface *iface; 393 ipfw_ifc_cb *cb; 394 void *cbdata; 395 }; 396 397 /* Macro for working with various counters */ 398 #define IPFW_INC_RULE_COUNTER(_cntr, _bytes) do { \ 399 counter_u64_add((_cntr)->cntr, 1); \ 400 counter_u64_add((_cntr)->cntr + 1, _bytes); \ 401 if ((_cntr)->timestamp != time_uptime) \ 402 (_cntr)->timestamp = time_uptime; \ 403 } while (0) 404 405 #define IPFW_INC_DYN_COUNTER(_cntr, _bytes) do { \ 406 (_cntr)->pcnt++; \ 407 (_cntr)->bcnt += _bytes; \ 408 } while (0) 409 410 #define IPFW_ZERO_RULE_COUNTER(_cntr) do { \ 411 counter_u64_zero((_cntr)->cntr); \ 412 counter_u64_zero((_cntr)->cntr + 1); \ 413 (_cntr)->timestamp = 0; \ 414 } while (0) 415 416 #define IPFW_ZERO_DYN_COUNTER(_cntr) do { \ 417 (_cntr)->pcnt = 0; \ 418 (_cntr)->bcnt = 0; \ 419 } while (0) 420 421 #define TARG_VAL(ch, k, f) ((struct table_value *)((ch)->valuestate))[k].f 422 #define IP_FW_ARG_TABLEARG(ch, a, f) \ 423 (((a) == IP_FW_TARG) ? TARG_VAL(ch, tablearg, f) : (a)) 424 /* 425 * The lock is heavily used by ip_fw2.c (the main file) and ip_fw_nat.c 426 * so the variable and the macros must be here. 427 */ 428 429 #if defined( __linux__ ) || defined( _WIN32 ) 430 #define IPFW_LOCK_INIT(_chain) do { \ 431 rw_init(&(_chain)->rwmtx, "IPFW static rules"); \ 432 rw_init(&(_chain)->uh_lock, "IPFW UH lock"); \ 433 } while (0) 434 435 #define IPFW_LOCK_DESTROY(_chain) do { \ 436 rw_destroy(&(_chain)->rwmtx); \ 437 rw_destroy(&(_chain)->uh_lock); \ 438 } while (0) 439 440 #define IPFW_RLOCK_ASSERT(_chain) rw_assert(&(_chain)->rwmtx, RA_RLOCKED) 441 #define IPFW_WLOCK_ASSERT(_chain) rw_assert(&(_chain)->rwmtx, RA_WLOCKED) 442 443 #define IPFW_RLOCK_TRACKER 444 #define IPFW_RLOCK(p) rw_rlock(&(p)->rwmtx) 445 #define IPFW_RUNLOCK(p) rw_runlock(&(p)->rwmtx) 446 #define IPFW_WLOCK(p) rw_wlock(&(p)->rwmtx) 447 #define IPFW_WUNLOCK(p) rw_wunlock(&(p)->rwmtx) 448 #define IPFW_PF_RLOCK(p) IPFW_RLOCK(p) 449 #define IPFW_PF_RUNLOCK(p) IPFW_RUNLOCK(p) 450 #else /* FreeBSD */ 451 #define IPFW_LOCK_INIT(_chain) do { \ 452 rm_init_flags(&(_chain)->rwmtx, "IPFW static rules", RM_RECURSE); \ 453 rw_init(&(_chain)->uh_lock, "IPFW UH lock"); \ 454 } while (0) 455 456 #define IPFW_LOCK_DESTROY(_chain) do { \ 457 rm_destroy(&(_chain)->rwmtx); \ 458 rw_destroy(&(_chain)->uh_lock); \ 459 } while (0) 460 461 #define IPFW_RLOCK_ASSERT(_chain) rm_assert(&(_chain)->rwmtx, RA_RLOCKED) 462 #define IPFW_WLOCK_ASSERT(_chain) rm_assert(&(_chain)->rwmtx, RA_WLOCKED) 463 464 #define IPFW_RLOCK_TRACKER struct rm_priotracker _tracker 465 #define IPFW_RLOCK(p) rm_rlock(&(p)->rwmtx, &_tracker) 466 #define IPFW_RUNLOCK(p) rm_runlock(&(p)->rwmtx, &_tracker) 467 #define IPFW_WLOCK(p) rm_wlock(&(p)->rwmtx) 468 #define IPFW_WUNLOCK(p) rm_wunlock(&(p)->rwmtx) 469 #define IPFW_PF_RLOCK(p) IPFW_RLOCK(p) 470 #define IPFW_PF_RUNLOCK(p) IPFW_RUNLOCK(p) 471 #endif 472 473 #define IPFW_UH_RLOCK_ASSERT(_chain) rw_assert(&(_chain)->uh_lock, RA_RLOCKED) 474 #define IPFW_UH_WLOCK_ASSERT(_chain) rw_assert(&(_chain)->uh_lock, RA_WLOCKED) 475 #define IPFW_UH_UNLOCK_ASSERT(_chain) rw_assert(&(_chain)->uh_lock, RA_UNLOCKED) 476 477 #define IPFW_UH_RLOCK(p) rw_rlock(&(p)->uh_lock) 478 #define IPFW_UH_RUNLOCK(p) rw_runlock(&(p)->uh_lock) 479 #define IPFW_UH_WLOCK(p) rw_wlock(&(p)->uh_lock) 480 #define IPFW_UH_WUNLOCK(p) rw_wunlock(&(p)->uh_lock) 481 482 struct obj_idx { 483 uint32_t uidx; /* internal index supplied by userland */ 484 uint32_t kidx; /* kernel object index */ 485 uint16_t off; /* tlv offset from rule end in 4-byte words */ 486 uint8_t spare; 487 uint8_t type; /* object type within its category */ 488 }; 489 490 struct rule_check_info { 491 uint16_t flags; /* rule-specific check flags */ 492 uint16_t object_opcodes; /* num of opcodes referencing objects */ 493 uint16_t urule_numoff; /* offset of rulenum in bytes */ 494 uint8_t version; /* rule version */ 495 uint8_t spare; 496 ipfw_obj_ctlv *ctlv; /* name TLV containter */ 497 struct ip_fw *krule; /* resulting rule pointer */ 498 caddr_t urule; /* original rule pointer */ 499 struct obj_idx obuf[8]; /* table references storage */ 500 }; 501 502 /* Kernel rule length */ 503 /* 504 * RULE _K_ SIZE _V_ -> 505 * get kernel size from userland rool version _V_. 506 * RULE _U_ SIZE _V_ -> 507 * get user size version _V_ from kernel rule 508 * RULESIZE _V_ -> 509 * get user size rule length 510 */ 511 /* FreeBSD11 <> current kernel format */ 512 #define RULEUSIZE1(r) (roundup2(sizeof(struct ip_fw_rule) + \ 513 (r)->cmd_len * 4 - 4, 8)) 514 #define RULEKSIZE1(r) roundup2((sizeof(struct ip_fw) + (r)->cmd_len*4 - 4), 8) 515 516 /* 517 * Tables/Objects index rewriting code 518 */ 519 520 /* Default and maximum number of ipfw tables/objects. */ 521 #define IPFW_TABLES_MAX 65536 522 #define IPFW_TABLES_DEFAULT 128 523 #define IPFW_OBJECTS_MAX 65536 524 #define IPFW_OBJECTS_DEFAULT 4096 525 526 #define CHAIN_TO_SRV(ch) ((ch)->srvmap) 527 #define SRV_OBJECT(ch, idx) ((ch)->srvstate[(idx)]) 528 529 struct tid_info { 530 uint32_t set; /* table set */ 531 uint32_t uidx; /* table index */ 532 uint8_t type; /* table type */ 533 uint8_t atype; 534 uint16_t spare; 535 int tlen; /* Total TLV size block */ 536 void *tlvs; /* Pointer to first TLV */ 537 }; 538 539 /* 540 * Classifier callback. Checks if @cmd opcode contains kernel object reference. 541 * If true, returns its index and type. 542 * Returns 0 if match is found, 1 overwise. 543 */ 544 typedef int (ipfw_obj_rw_cl)(ipfw_insn *cmd, uint32_t *puidx, uint8_t *ptype); 545 /* 546 * Updater callback. Sets kernel object reference index to @puidx 547 */ 548 typedef void (ipfw_obj_rw_upd)(ipfw_insn *cmd, uint32_t puidx); 549 /* 550 * Finder callback. Tries to find named object by name (specified via @ti). 551 * Stores found named object pointer in @pno. 552 * If object was not found, NULL is stored. 553 * 554 * Return 0 if input data was valid. 555 */ 556 typedef int (ipfw_obj_fname_cb)(struct ip_fw_chain *ch, 557 struct tid_info *ti, struct named_object **pno); 558 /* 559 * Another finder callback. Tries to findex named object by kernel index. 560 * 561 * Returns pointer to named object or NULL. 562 */ 563 typedef struct named_object *(ipfw_obj_fidx_cb)(struct ip_fw_chain *ch, 564 uint32_t kidx); 565 /* 566 * Object creator callback. Tries to create object specified by @ti. 567 * Stores newly-allocated object index in @pkidx. 568 * 569 * Returns 0 on success. 570 */ 571 typedef int (ipfw_obj_create_cb)(struct ip_fw_chain *ch, struct tid_info *ti, 572 uint32_t *pkidx); 573 /* 574 * Object destroy callback. Intended to free resources allocated by 575 * create_object callback. 576 */ 577 typedef void (ipfw_obj_destroy_cb)(struct ip_fw_chain *ch, 578 struct named_object *no); 579 /* 580 * Sets handler callback. Handles moving and swaping set of named object. 581 * SWAP_ALL moves all named objects from set `set' to `new_set' and vise versa; 582 * TEST_ALL checks that there aren't any named object with conflicting names; 583 * MOVE_ALL moves all named objects from set `set' to `new_set'; 584 * COUNT_ONE used to count number of references used by object with kidx `set'; 585 * TEST_ONE checks that named object with kidx `set' can be moved to `new_set`; 586 * MOVE_ONE moves named object with kidx `set' to set `new_set'. 587 */ 588 enum ipfw_sets_cmd { 589 SWAP_ALL = 0, TEST_ALL, MOVE_ALL, COUNT_ONE, TEST_ONE, MOVE_ONE 590 }; 591 typedef int (ipfw_obj_sets_cb)(struct ip_fw_chain *ch, 592 uint32_t set, uint8_t new_set, enum ipfw_sets_cmd cmd); 593 594 struct opcode_obj_rewrite { 595 uint32_t opcode; /* Opcode to act upon */ 596 uint32_t etlv; /* Relevant export TLV id */ 597 ipfw_obj_rw_cl *classifier; /* Check if rewrite is needed */ 598 ipfw_obj_rw_upd *update; /* update cmd with new value */ 599 ipfw_obj_fname_cb *find_byname; /* Find named object by name */ 600 ipfw_obj_fidx_cb *find_bykidx; /* Find named object by kidx */ 601 ipfw_obj_create_cb *create_object; /* Create named object */ 602 ipfw_obj_destroy_cb *destroy_object;/* Destroy named object */ 603 ipfw_obj_sets_cb *manage_sets; /* Swap or move sets */ 604 }; 605 606 #define IPFW_ADD_OBJ_REWRITER(f, c) do { \ 607 if ((f) != 0) \ 608 ipfw_add_obj_rewriter(c, \ 609 sizeof(c) / sizeof(c[0])); \ 610 } while(0) 611 #define IPFW_DEL_OBJ_REWRITER(l, c) do { \ 612 if ((l) != 0) \ 613 ipfw_del_obj_rewriter(c, \ 614 sizeof(c) / sizeof(c[0])); \ 615 } while(0) 616 617 /* In ip_fw_iface.c */ 618 int ipfw_iface_init(void); 619 void ipfw_iface_destroy(void); 620 void vnet_ipfw_iface_destroy(struct ip_fw_chain *ch); 621 int ipfw_iface_ref(struct ip_fw_chain *ch, char *name, 622 struct ipfw_ifc *ic); 623 void ipfw_iface_unref(struct ip_fw_chain *ch, struct ipfw_ifc *ic); 624 void ipfw_iface_add_notify(struct ip_fw_chain *ch, struct ipfw_ifc *ic); 625 void ipfw_iface_del_notify(struct ip_fw_chain *ch, struct ipfw_ifc *ic); 626 627 /* In ip_fw_sockopt.c */ 628 enum ipfw_opcheck_result { 629 SUCCESS = 0, 630 FAILED, 631 BAD_SIZE, 632 CHECK_ACTION, 633 }; 634 typedef enum ipfw_opcheck_result (*ipfw_check_opcode_t)(ipfw_insn **, 635 int *, struct rule_check_info *); 636 637 void ipfw_register_compat(ipfw_check_opcode_t); 638 void ipfw_unregister_compat(void); 639 640 enum ipfw_opcheck_result ipfw_check_opcode(ipfw_insn **, int *, 641 struct rule_check_info *); 642 void ipfw_init_skipto_cache(struct ip_fw_chain *chain); 643 void ipfw_destroy_skipto_cache(struct ip_fw_chain *chain); 644 void ipfw_enable_skipto_cache(struct ip_fw_chain *chain); 645 int ipfw_find_rule(struct ip_fw_chain *chain, uint32_t key, uint32_t id); 646 int ipfw_ctl3(struct sockopt *sopt); 647 int ipfw_add_protected_rule(struct ip_fw_chain *chain, struct ip_fw *rule, 648 int locked); 649 void ipfw_reap_add(struct ip_fw_chain *chain, struct ip_fw **head, 650 struct ip_fw *rule); 651 void ipfw_reap_rules(struct ip_fw *head); 652 void ipfw_init_counters(void); 653 void ipfw_destroy_counters(void); 654 int ipfw_commit_rules(struct ip_fw_chain *chain, struct rule_check_info *rci, 655 int count); 656 int delete_range(struct ip_fw_chain *chain, ipfw_range_tlv *rt, int *ndel); 657 struct ip_fw *ipfw_alloc_rule(struct ip_fw_chain *chain, size_t rulesize); 658 void ipfw_free_rule(struct ip_fw *rule); 659 int ipfw_match_range(struct ip_fw *rule, ipfw_range_tlv *rt); 660 int ipfw_mark_object_kidx(uint32_t *bmask, uint16_t etlv, uint32_t kidx); 661 ipfw_insn *ipfw_get_action(struct ip_fw *); 662 int ipfw_check_rule(struct ip_fw_rule *rule, size_t size, 663 struct rule_check_info *ci); 664 665 typedef int (sopt_handler_f)(struct ip_fw_chain *ch, 666 ip_fw3_opheader *op3, struct sockopt_data *sd); 667 struct ipfw_sopt_handler { 668 uint16_t opcode; 669 uint8_t version; 670 uint8_t dir; 671 sopt_handler_f *handler; 672 uint64_t refcnt; 673 }; 674 #define HDIR_SET 0x01 /* Handler is used to set some data */ 675 #define HDIR_GET 0x02 /* Handler is used to retrieve data */ 676 #define HDIR_BOTH HDIR_GET|HDIR_SET 677 678 void ipfw_init_sopt_handler(void); 679 void ipfw_destroy_sopt_handler(void); 680 void ipfw_add_sopt_handler(struct ipfw_sopt_handler *sh, size_t count); 681 int ipfw_del_sopt_handler(struct ipfw_sopt_handler *sh, size_t count); 682 caddr_t ipfw_get_sopt_space(struct sockopt_data *sd, size_t needed); 683 caddr_t ipfw_get_sopt_header(struct sockopt_data *sd, size_t needed); 684 #define IPFW_ADD_SOPT_HANDLER(f, c) do { \ 685 if ((f) != 0) \ 686 ipfw_add_sopt_handler(c, \ 687 sizeof(c) / sizeof(c[0])); \ 688 } while(0) 689 #define IPFW_DEL_SOPT_HANDLER(l, c) do { \ 690 if ((l) != 0) \ 691 ipfw_del_sopt_handler(c, \ 692 sizeof(c) / sizeof(c[0])); \ 693 } while(0) 694 695 #define DEFAULT_OBJHASH_SIZE 32 696 struct namedobj_instance; 697 typedef int (objhash_cb_t)(struct namedobj_instance *ni, struct named_object *, 698 void *arg); 699 typedef uint32_t (objhash_hash_f)(struct namedobj_instance *ni, const void *key, 700 uint32_t kopt); 701 typedef int (objhash_cmp_f)(struct named_object *no, const void *key, 702 uint32_t kopt); 703 struct namedobj_instance *ipfw_objhash_create(uint32_t items, size_t hash_size); 704 void ipfw_objhash_destroy(struct namedobj_instance *); 705 void ipfw_objhash_bitmap_alloc(uint32_t items, void **idx, int *pblocks); 706 void ipfw_objhash_bitmap_merge(struct namedobj_instance *ni, 707 void **idx, int *blocks); 708 void ipfw_objhash_bitmap_swap(struct namedobj_instance *ni, 709 void **idx, int *blocks); 710 void ipfw_objhash_bitmap_free(void *idx, int blocks); 711 void ipfw_objhash_set_hashf(struct namedobj_instance *ni, objhash_hash_f *f); 712 struct named_object *ipfw_objhash_lookup_name(struct namedobj_instance *ni, 713 uint32_t set, const char *name); 714 struct named_object *ipfw_objhash_lookup_name_type(struct namedobj_instance *ni, 715 uint32_t set, uint32_t type, const char *name); 716 struct named_object *ipfw_objhash_lookup_kidx(struct namedobj_instance *ni, 717 uint32_t idx); 718 int ipfw_objhash_same_name(struct namedobj_instance *ni, struct named_object *a, 719 struct named_object *b); 720 void ipfw_objhash_add(struct namedobj_instance *ni, struct named_object *no); 721 void ipfw_objhash_del(struct namedobj_instance *ni, struct named_object *no); 722 uint32_t ipfw_objhash_count(struct namedobj_instance *ni); 723 uint32_t ipfw_objhash_count_type(struct namedobj_instance *ni, uint16_t type); 724 int ipfw_objhash_foreach(struct namedobj_instance *ni, objhash_cb_t *f, 725 void *arg); 726 int ipfw_objhash_foreach_type(struct namedobj_instance *ni, objhash_cb_t *f, 727 void *arg, uint16_t type); 728 int ipfw_objhash_free_idx(struct namedobj_instance *ni, uint32_t idx); 729 int ipfw_objhash_alloc_idx(void *n, uint32_t *pidx); 730 void ipfw_objhash_set_funcs(struct namedobj_instance *ni, 731 objhash_hash_f *hash_f, objhash_cmp_f *cmp_f); 732 int ipfw_objhash_find_type(struct namedobj_instance *ni, struct tid_info *ti, 733 uint32_t etlv, struct named_object **pno); 734 void ipfw_export_obj_ntlv(struct named_object *no, ipfw_obj_ntlv *ntlv); 735 ipfw_obj_ntlv *ipfw_find_name_tlv_type(void *tlvs, int len, uint32_t uidx, 736 uint32_t etlv); 737 void ipfw_init_obj_rewriter(void); 738 void ipfw_destroy_obj_rewriter(void); 739 void ipfw_add_obj_rewriter(struct opcode_obj_rewrite *rw, size_t count); 740 int ipfw_del_obj_rewriter(struct opcode_obj_rewrite *rw, size_t count); 741 742 int create_objects_compat(struct ip_fw_chain *ch, ipfw_insn *cmd, 743 struct obj_idx *oib, struct obj_idx *pidx, struct tid_info *ti); 744 void update_opcode_kidx(ipfw_insn *cmd, uint32_t idx); 745 int classify_opcode_kidx(ipfw_insn *cmd, uint32_t *puidx); 746 void ipfw_init_srv(struct ip_fw_chain *ch); 747 void ipfw_destroy_srv(struct ip_fw_chain *ch); 748 int ipfw_check_object_name_generic(const char *name); 749 int ipfw_obj_manage_sets(struct namedobj_instance *ni, uint16_t type, 750 uint32_t set, uint8_t new_set, enum ipfw_sets_cmd cmd); 751 752 /* In ip_fw_eaction.c */ 753 typedef int (ipfw_eaction_t)(struct ip_fw_chain *ch, struct ip_fw_args *args, 754 ipfw_insn *cmd, int *done); 755 int ipfw_eaction_init(struct ip_fw_chain *ch, int first); 756 void ipfw_eaction_uninit(struct ip_fw_chain *ch, int last); 757 758 uint32_t ipfw_add_eaction(struct ip_fw_chain *ch, ipfw_eaction_t handler, 759 const char *name); 760 int ipfw_del_eaction(struct ip_fw_chain *ch, uint32_t eaction_id); 761 int ipfw_run_eaction(struct ip_fw_chain *ch, struct ip_fw_args *args, 762 ipfw_insn *cmd, int *done); 763 int ipfw_reset_eaction(struct ip_fw_chain *ch, struct ip_fw *rule, 764 uint32_t eaction_id, uint32_t default_id, uint32_t instance_id); 765 int ipfw_reset_eaction_instance(struct ip_fw_chain *ch, uint32_t eaction_id, 766 uint32_t instance_id); 767 768 /* In ip_fw_table.c */ 769 struct table_info; 770 771 typedef int (table_lookup_t)(struct table_info *ti, void *key, uint32_t keylen, 772 uint32_t *val); 773 774 int ipfw_lookup_table(struct ip_fw_chain *ch, uint32_t tbl, uint16_t plen, 775 void *paddr, uint32_t *val); 776 struct named_object *ipfw_objhash_lookup_table_kidx(struct ip_fw_chain *ch, 777 uint32_t kidx); 778 int ipfw_ref_table(struct ip_fw_chain *ch, ipfw_obj_ntlv *ntlv, uint32_t *kidx); 779 void ipfw_unref_table(struct ip_fw_chain *ch, uint32_t kidx); 780 int ipfw_init_tables(struct ip_fw_chain *ch, int first); 781 int ipfw_resize_tables(struct ip_fw_chain *ch, unsigned int ntables); 782 int ipfw_switch_tables_namespace(struct ip_fw_chain *ch, unsigned int nsets); 783 void ipfw_destroy_tables(struct ip_fw_chain *ch, int last); 784 785 /* In ip_fw_nat.c -- XXX to be moved to ip_var.h */ 786 787 extern struct cfg_nat *(*lookup_nat_ptr)(struct nat_list *, int); 788 789 typedef int ipfw_nat_t(struct ip_fw_args *, struct cfg_nat *, struct mbuf *); 790 typedef int ipfw_nat_cfg_t(struct sockopt *); 791 792 VNET_DECLARE(int, ipfw_nat_ready); 793 #define V_ipfw_nat_ready VNET(ipfw_nat_ready) 794 #define IPFW_NAT_LOADED (V_ipfw_nat_ready) 795 796 extern ipfw_nat_t *ipfw_nat_ptr; 797 extern ipfw_nat_cfg_t *ipfw_nat_cfg_ptr; 798 extern ipfw_nat_cfg_t *ipfw_nat_del_ptr; 799 extern ipfw_nat_cfg_t *ipfw_nat_get_cfg_ptr; 800 extern ipfw_nat_cfg_t *ipfw_nat_get_log_ptr; 801 802 /* Helper functions for IP checksum adjustment */ 803 static __inline uint16_t 804 cksum_add(uint16_t sum, uint16_t a) 805 { 806 uint16_t res; 807 808 res = sum + a; 809 return (res + (res < a)); 810 } 811 812 static __inline uint16_t 813 cksum_adjust(uint16_t oldsum, uint16_t old, uint16_t new) 814 { 815 816 return (~cksum_add(cksum_add(~oldsum, ~old), new)); 817 } 818 819 #endif /* _KERNEL */ 820 #endif /* _IPFW2_PRIVATE_H */ 821