2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2015-2019 Yandex LLC
5 * Copyright (c) 2015 Alexander V. Chernikov <melifaro@FreeBSD.org>
6 * Copyright (c) 2015-2019 Andrey V. Elsukov <ae@FreeBSD.org>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
33 #include <sys/param.h>
34 #include <sys/systm.h>
35 #include <sys/counter.h>
36 #include <sys/errno.h>
37 #include <sys/kernel.h>
39 #include <sys/malloc.h>
41 #include <sys/module.h>
42 #include <sys/rmlock.h>
43 #include <sys/rwlock.h>
44 #include <sys/socket.h>
45 #include <sys/sockopt.h>
46 #include <sys/queue.h>
47 #include <sys/syslog.h>
48 #include <sys/sysctl.h>
51 #include <net/if_var.h>
53 #include <net/route.h>
56 #include <netinet/in.h>
57 #include <netinet/ip_var.h>
58 #include <netinet/ip_fw.h>
59 #include <netinet6/in6_var.h>
60 #include <netinet6/ip6_var.h>
61 #include <netinet6/ip_fw_nat64.h>
63 #include <netpfil/ipfw/ip_fw_private.h>
67 VNET_DEFINE(uint16_t, nat64stl_eid) = 0;
69 static struct nat64stl_cfg *nat64stl_alloc_config(const char *name,
71 static void nat64stl_free_config(struct nat64stl_cfg *cfg);
72 static struct nat64stl_cfg *nat64stl_find(struct namedobj_instance *ni,
73 const char *name, uint8_t set);
75 static struct nat64stl_cfg *
76 nat64stl_alloc_config(const char *name, uint8_t set)
78 struct nat64stl_cfg *cfg;
80 cfg = malloc(sizeof(struct nat64stl_cfg), M_IPFW, M_WAITOK | M_ZERO);
81 COUNTER_ARRAY_ALLOC(cfg->base.stats.cnt, NAT64STATS, M_WAITOK);
82 cfg->no.name = cfg->name;
83 cfg->no.etlv = IPFW_TLV_NAT64STL_NAME;
85 strlcpy(cfg->name, name, sizeof(cfg->name));
90 nat64stl_free_config(struct nat64stl_cfg *cfg)
93 COUNTER_ARRAY_FREE(cfg->base.stats.cnt, NAT64STATS);
98 nat64stl_export_config(struct ip_fw_chain *ch, struct nat64stl_cfg *cfg,
99 ipfw_nat64stl_cfg *uc)
101 struct named_object *no;
103 uc->prefix6 = cfg->base.plat_prefix;
104 uc->plen6 = cfg->base.plat_plen;
105 uc->flags = cfg->base.flags & NAT64STL_FLAGSMASK;
106 uc->set = cfg->no.set;
107 strlcpy(uc->name, cfg->no.name, sizeof(uc->name));
109 no = ipfw_objhash_lookup_table_kidx(ch, cfg->map64);
110 ipfw_export_obj_ntlv(no, &uc->ntlv6);
111 no = ipfw_objhash_lookup_table_kidx(ch, cfg->map46);
112 ipfw_export_obj_ntlv(no, &uc->ntlv4);
115 struct nat64stl_dump_arg {
116 struct ip_fw_chain *ch;
117 struct sockopt_data *sd;
121 export_config_cb(struct namedobj_instance *ni, struct named_object *no,
124 struct nat64stl_dump_arg *da = (struct nat64stl_dump_arg *)arg;
125 ipfw_nat64stl_cfg *uc;
127 uc = (ipfw_nat64stl_cfg *)ipfw_get_sopt_space(da->sd, sizeof(*uc));
128 nat64stl_export_config(da->ch, (struct nat64stl_cfg *)no, uc);
132 static struct nat64stl_cfg *
133 nat64stl_find(struct namedobj_instance *ni, const char *name, uint8_t set)
135 struct nat64stl_cfg *cfg;
137 cfg = (struct nat64stl_cfg *)ipfw_objhash_lookup_name_type(ni, set,
138 IPFW_TLV_NAT64STL_NAME, name);
145 nat64stl_create_internal(struct ip_fw_chain *ch, struct nat64stl_cfg *cfg,
146 ipfw_nat64stl_cfg *i)
149 IPFW_UH_WLOCK_ASSERT(ch);
151 if (ipfw_objhash_alloc_idx(CHAIN_TO_SRV(ch), &cfg->no.kidx) != 0)
153 cfg->base.flags |= NAT64STL_KIDX;
155 if (ipfw_ref_table(ch, &i->ntlv4, &cfg->map46) != 0)
157 cfg->base.flags |= NAT64STL_46T;
159 if (ipfw_ref_table(ch, &i->ntlv6, &cfg->map64) != 0)
161 cfg->base.flags |= NAT64STL_64T;
163 ipfw_objhash_add(CHAIN_TO_SRV(ch), &cfg->no);
169 * Creates new nat64 instance.
170 * Data layout (v0)(current):
171 * Request: [ ipfw_obj_lheader ipfw_nat64stl_cfg ]
173 * Returns 0 on success
176 nat64stl_create(struct ip_fw_chain *ch, ip_fw3_opheader *op3,
177 struct sockopt_data *sd)
179 ipfw_obj_lheader *olh;
180 ipfw_nat64stl_cfg *uc;
181 struct namedobj_instance *ni;
182 struct nat64stl_cfg *cfg;
185 if (sd->valsize != sizeof(*olh) + sizeof(*uc))
188 olh = (ipfw_obj_lheader *)sd->kbuf;
189 uc = (ipfw_nat64stl_cfg *)(olh + 1);
191 if (ipfw_check_object_name_generic(uc->name) != 0)
193 if (uc->set >= IPFW_MAX_SETS ||
194 nat64_check_prefix6(&uc->prefix6, uc->plen6) != 0)
197 /* XXX: check types of tables */
199 ni = CHAIN_TO_SRV(ch);
203 if (nat64stl_find(ni, uc->name, uc->set) != NULL) {
209 cfg = nat64stl_alloc_config(uc->name, uc->set);
210 cfg->base.plat_prefix = uc->prefix6;
211 cfg->base.plat_plen = uc->plen6;
212 cfg->base.flags = (uc->flags & NAT64STL_FLAGSMASK) | NAT64_PLATPFX;
213 if (IN6_IS_ADDR_WKPFX(&cfg->base.plat_prefix))
214 cfg->base.flags |= NAT64_WKPFX;
218 if (nat64stl_find(ni, uc->name, uc->set) != NULL) {
220 nat64stl_free_config(cfg);
223 error = nat64stl_create_internal(ch, cfg, uc);
225 /* Okay, let's link data */
226 SRV_OBJECT(ch, cfg->no.kidx) = cfg;
231 if (cfg->base.flags & NAT64STL_KIDX)
232 ipfw_objhash_free_idx(ni, cfg->no.kidx);
233 if (cfg->base.flags & NAT64STL_46T)
234 ipfw_unref_table(ch, cfg->map46);
235 if (cfg->base.flags & NAT64STL_64T)
236 ipfw_unref_table(ch, cfg->map64);
239 nat64stl_free_config(cfg);
244 * Change existing nat64stl instance configuration.
245 * Data layout (v0)(current):
246 * Request: [ ipfw_obj_header ipfw_nat64stl_cfg ]
247 * Reply: [ ipfw_obj_header ipfw_nat64stl_cfg ]
249 * Returns 0 on success
252 nat64stl_config(struct ip_fw_chain *ch, ip_fw3_opheader *op,
253 struct sockopt_data *sd)
256 ipfw_nat64stl_cfg *uc;
257 struct nat64stl_cfg *cfg;
258 struct namedobj_instance *ni;
260 if (sd->valsize != sizeof(*oh) + sizeof(*uc))
263 oh = (ipfw_obj_header *)ipfw_get_sopt_space(sd,
264 sizeof(*oh) + sizeof(*uc));
265 uc = (ipfw_nat64stl_cfg *)(oh + 1);
267 if (ipfw_check_object_name_generic(oh->ntlv.name) != 0 ||
268 oh->ntlv.set >= IPFW_MAX_SETS)
271 ni = CHAIN_TO_SRV(ch);
272 if (sd->sopt->sopt_dir == SOPT_GET) {
274 cfg = nat64stl_find(ni, oh->ntlv.name, oh->ntlv.set);
279 nat64stl_export_config(ch, cfg, uc);
285 cfg = nat64stl_find(ni, oh->ntlv.name, oh->ntlv.set);
292 * For now allow to change only following values:
295 cfg->base.flags &= ~NAT64STL_FLAGSMASK;
296 cfg->base.flags |= uc->flags & NAT64STL_FLAGSMASK;
303 nat64stl_detach_config(struct ip_fw_chain *ch, struct nat64stl_cfg *cfg)
306 IPFW_UH_WLOCK_ASSERT(ch);
308 ipfw_objhash_del(CHAIN_TO_SRV(ch), &cfg->no);
309 ipfw_objhash_free_idx(CHAIN_TO_SRV(ch), cfg->no.kidx);
310 ipfw_unref_table(ch, cfg->map46);
311 ipfw_unref_table(ch, cfg->map64);
315 * Destroys nat64 instance.
316 * Data layout (v0)(current):
317 * Request: [ ipfw_obj_header ]
319 * Returns 0 on success
322 nat64stl_destroy(struct ip_fw_chain *ch, ip_fw3_opheader *op3,
323 struct sockopt_data *sd)
326 struct nat64stl_cfg *cfg;
328 if (sd->valsize != sizeof(*oh))
331 oh = (ipfw_obj_header *)sd->kbuf;
332 if (ipfw_check_object_name_generic(oh->ntlv.name) != 0)
336 cfg = nat64stl_find(CHAIN_TO_SRV(ch), oh->ntlv.name, oh->ntlv.set);
341 if (cfg->no.refcnt > 0) {
346 ipfw_reset_eaction_instance(ch, V_nat64stl_eid, cfg->no.kidx);
347 SRV_OBJECT(ch, cfg->no.kidx) = NULL;
348 nat64stl_detach_config(ch, cfg);
351 nat64stl_free_config(cfg);
356 * Lists all nat64stl instances currently available in kernel.
357 * Data layout (v0)(current):
358 * Request: [ ipfw_obj_lheader ]
359 * Reply: [ ipfw_obj_lheader ipfw_nat64stl_cfg x N ]
361 * Returns 0 on success
364 nat64stl_list(struct ip_fw_chain *ch, ip_fw3_opheader *op3,
365 struct sockopt_data *sd)
367 ipfw_obj_lheader *olh;
368 struct nat64stl_dump_arg da;
370 /* Check minimum header size */
371 if (sd->valsize < sizeof(ipfw_obj_lheader))
374 olh = (ipfw_obj_lheader *)ipfw_get_sopt_header(sd, sizeof(*olh));
377 olh->count = ipfw_objhash_count_type(CHAIN_TO_SRV(ch),
378 IPFW_TLV_NAT64STL_NAME);
379 olh->objsize = sizeof(ipfw_nat64stl_cfg);
380 olh->size = sizeof(*olh) + olh->count * olh->objsize;
382 if (sd->valsize < olh->size) {
386 memset(&da, 0, sizeof(da));
389 ipfw_objhash_foreach_type(CHAIN_TO_SRV(ch), export_config_cb,
390 &da, IPFW_TLV_NAT64STL_NAME);
396 #define __COPY_STAT_FIELD(_cfg, _stats, _field) \
397 (_stats)->_field = NAT64STAT_FETCH(&(_cfg)->base.stats, _field)
399 export_stats(struct ip_fw_chain *ch, struct nat64stl_cfg *cfg,
400 struct ipfw_nat64stl_stats *stats)
403 __COPY_STAT_FIELD(cfg, stats, opcnt64);
404 __COPY_STAT_FIELD(cfg, stats, opcnt46);
405 __COPY_STAT_FIELD(cfg, stats, ofrags);
406 __COPY_STAT_FIELD(cfg, stats, ifrags);
407 __COPY_STAT_FIELD(cfg, stats, oerrors);
408 __COPY_STAT_FIELD(cfg, stats, noroute4);
409 __COPY_STAT_FIELD(cfg, stats, noroute6);
410 __COPY_STAT_FIELD(cfg, stats, noproto);
411 __COPY_STAT_FIELD(cfg, stats, nomem);
412 __COPY_STAT_FIELD(cfg, stats, dropped);
416 * Get nat64stl statistics.
417 * Data layout (v0)(current):
418 * Request: [ ipfw_obj_header ]
419 * Reply: [ ipfw_obj_header ipfw_obj_ctlv [ uint64_t x N ]]
421 * Returns 0 on success
424 nat64stl_stats(struct ip_fw_chain *ch, ip_fw3_opheader *op,
425 struct sockopt_data *sd)
427 struct ipfw_nat64stl_stats stats;
428 struct nat64stl_cfg *cfg;
433 sz = sizeof(ipfw_obj_header) + sizeof(ipfw_obj_ctlv) + sizeof(stats);
434 if (sd->valsize % sizeof(uint64_t))
436 if (sd->valsize < sz)
438 oh = (ipfw_obj_header *)ipfw_get_sopt_header(sd, sz);
441 memset(&stats, 0, sizeof(stats));
444 cfg = nat64stl_find(CHAIN_TO_SRV(ch), oh->ntlv.name, oh->ntlv.set);
449 export_stats(ch, cfg, &stats);
452 ctlv = (ipfw_obj_ctlv *)(oh + 1);
453 memset(ctlv, 0, sizeof(*ctlv));
454 ctlv->head.type = IPFW_TLV_COUNTERS;
455 ctlv->head.length = sz - sizeof(ipfw_obj_header);
456 ctlv->count = sizeof(stats) / sizeof(uint64_t);
457 ctlv->objsize = sizeof(uint64_t);
458 ctlv->version = IPFW_NAT64_VERSION;
459 memcpy(ctlv + 1, &stats, sizeof(stats));
464 * Reset nat64stl statistics.
465 * Data layout (v0)(current):
466 * Request: [ ipfw_obj_header ]
468 * Returns 0 on success
471 nat64stl_reset_stats(struct ip_fw_chain *ch, ip_fw3_opheader *op,
472 struct sockopt_data *sd)
474 struct nat64stl_cfg *cfg;
477 if (sd->valsize != sizeof(*oh))
479 oh = (ipfw_obj_header *)sd->kbuf;
480 if (ipfw_check_object_name_generic(oh->ntlv.name) != 0 ||
481 oh->ntlv.set >= IPFW_MAX_SETS)
485 cfg = nat64stl_find(CHAIN_TO_SRV(ch), oh->ntlv.name, oh->ntlv.set);
490 COUNTER_ARRAY_ZERO(cfg->base.stats.cnt, NAT64STATS);
495 static struct ipfw_sopt_handler scodes[] = {
497 { IP_FW_NAT64STL_CREATE, 0, HDIR_SET, nat64stl_create },
498 { IP_FW_NAT64STL_DESTROY,0, HDIR_SET, nat64stl_destroy },
499 { IP_FW_NAT64STL_CONFIG, 0, HDIR_BOTH, nat64stl_config },
500 { IP_FW_NAT64STL_LIST, 0, HDIR_GET, nat64stl_list },
501 { IP_FW_NAT64STL_STATS, 0, HDIR_GET, nat64stl_stats },
502 { IP_FW_NAT64STL_RESET_STATS,0, HDIR_SET, nat64stl_reset_stats },
506 nat64stl_classify(ipfw_insn *cmd, uint16_t *puidx, uint8_t *ptype)
511 if (icmd->opcode != O_EXTERNAL_ACTION ||
512 icmd->arg1 != V_nat64stl_eid)
521 nat64stl_update_arg1(ipfw_insn *cmd, uint16_t idx)
528 nat64stl_findbyname(struct ip_fw_chain *ch, struct tid_info *ti,
529 struct named_object **pno)
533 err = ipfw_objhash_find_type(CHAIN_TO_SRV(ch), ti,
534 IPFW_TLV_NAT64STL_NAME, pno);
538 static struct named_object *
539 nat64stl_findbykidx(struct ip_fw_chain *ch, uint16_t idx)
541 struct namedobj_instance *ni;
542 struct named_object *no;
544 IPFW_UH_WLOCK_ASSERT(ch);
545 ni = CHAIN_TO_SRV(ch);
546 no = ipfw_objhash_lookup_kidx(ni, idx);
547 KASSERT(no != NULL, ("NAT with index %d not found", idx));
553 nat64stl_manage_sets(struct ip_fw_chain *ch, uint16_t set, uint8_t new_set,
554 enum ipfw_sets_cmd cmd)
557 return (ipfw_obj_manage_sets(CHAIN_TO_SRV(ch), IPFW_TLV_NAT64STL_NAME,
561 static struct opcode_obj_rewrite opcodes[] = {
563 .opcode = O_EXTERNAL_INSTANCE,
564 .etlv = IPFW_TLV_EACTION /* just show it isn't table */,
565 .classifier = nat64stl_classify,
566 .update = nat64stl_update_arg1,
567 .find_byname = nat64stl_findbyname,
568 .find_bykidx = nat64stl_findbykidx,
569 .manage_sets = nat64stl_manage_sets,
574 destroy_config_cb(struct namedobj_instance *ni, struct named_object *no,
577 struct nat64stl_cfg *cfg;
578 struct ip_fw_chain *ch;
580 ch = (struct ip_fw_chain *)arg;
581 cfg = (struct nat64stl_cfg *)SRV_OBJECT(ch, no->kidx);
582 SRV_OBJECT(ch, no->kidx) = NULL;
583 nat64stl_detach_config(ch, cfg);
584 nat64stl_free_config(cfg);
589 nat64stl_init(struct ip_fw_chain *ch, int first)
592 V_nat64stl_eid = ipfw_add_eaction(ch, ipfw_nat64stl, "nat64stl");
593 if (V_nat64stl_eid == 0)
595 IPFW_ADD_SOPT_HANDLER(first, scodes);
596 IPFW_ADD_OBJ_REWRITER(first, opcodes);
601 nat64stl_uninit(struct ip_fw_chain *ch, int last)
604 IPFW_DEL_OBJ_REWRITER(last, opcodes);
605 IPFW_DEL_SOPT_HANDLER(last, scodes);
606 ipfw_del_eaction(ch, V_nat64stl_eid);
608 * Since we already have deregistered external action,
609 * our named objects become unaccessible via rules, because
610 * all rules were truncated by ipfw_del_eaction().
611 * So, we can unlink and destroy our named objects without holding
615 ipfw_objhash_foreach_type(CHAIN_TO_SRV(ch), destroy_config_cb, ch,
616 IPFW_TLV_NAT64STL_NAME);