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