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