xref: /xnu-11215.41.3/bsd/net/nat464_utils.h (revision 33de042d024d46de5ff4e89f2471de6608e37fa4)
1*33de042dSApple OSS Distributions /*
2*33de042dSApple OSS Distributions  * Copyright (c) 2018 Apple Inc. All rights reserved.
3*33de042dSApple OSS Distributions  *
4*33de042dSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*33de042dSApple OSS Distributions  *
6*33de042dSApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*33de042dSApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*33de042dSApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*33de042dSApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*33de042dSApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*33de042dSApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*33de042dSApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*33de042dSApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*33de042dSApple OSS Distributions  *
15*33de042dSApple OSS Distributions  * Please obtain a copy of the License at
16*33de042dSApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*33de042dSApple OSS Distributions  *
18*33de042dSApple OSS Distributions  * The Original Code and all software distributed under the License are
19*33de042dSApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*33de042dSApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*33de042dSApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*33de042dSApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*33de042dSApple OSS Distributions  * Please see the License for the specific language governing rights and
24*33de042dSApple OSS Distributions  * limitations under the License.
25*33de042dSApple OSS Distributions  *
26*33de042dSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*33de042dSApple OSS Distributions  */
28*33de042dSApple OSS Distributions 
29*33de042dSApple OSS Distributions /*
30*33de042dSApple OSS Distributions  * Copyright (c) 2001 Daniel Hartmeier
31*33de042dSApple OSS Distributions  * Copyright (c) 2002 - 2013 Henning Brauer
32*33de042dSApple OSS Distributions  * NAT64 - Copyright (c) 2010 Viagenie Inc. (http://www.viagenie.ca)
33*33de042dSApple OSS Distributions  * All rights reserved.
34*33de042dSApple OSS Distributions  *
35*33de042dSApple OSS Distributions  * Redistribution and use in source and binary forms, with or without
36*33de042dSApple OSS Distributions  * modification, are permitted provided that the following conditions
37*33de042dSApple OSS Distributions  * are met:
38*33de042dSApple OSS Distributions  *
39*33de042dSApple OSS Distributions  *    - Redistributions of source code must retain the above copyright
40*33de042dSApple OSS Distributions  *	notice, this list of conditions and the following disclaimer.
41*33de042dSApple OSS Distributions  *    - Redistributions in binary form must reproduce the above
42*33de042dSApple OSS Distributions  *	copyright notice, this list of conditions and the following
43*33de042dSApple OSS Distributions  *	disclaimer in the documentation and/or other materials provided
44*33de042dSApple OSS Distributions  *	with the distribution.
45*33de042dSApple OSS Distributions  *
46*33de042dSApple OSS Distributions  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
47*33de042dSApple OSS Distributions  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
48*33de042dSApple OSS Distributions  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
49*33de042dSApple OSS Distributions  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
50*33de042dSApple OSS Distributions  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
51*33de042dSApple OSS Distributions  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
52*33de042dSApple OSS Distributions  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
53*33de042dSApple OSS Distributions  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
54*33de042dSApple OSS Distributions  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
55*33de042dSApple OSS Distributions  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
56*33de042dSApple OSS Distributions  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
57*33de042dSApple OSS Distributions  * POSSIBILITY OF SUCH DAMAGE.
58*33de042dSApple OSS Distributions  *
59*33de042dSApple OSS Distributions  * Effort sponsored in part by the Defense Advanced Research Projects
60*33de042dSApple OSS Distributions  * Agency (DARPA) and Air Force Research Laboratory, Air Force
61*33de042dSApple OSS Distributions  * Materiel Command, USAF, under agreement number F30602-01-2-0537.
62*33de042dSApple OSS Distributions  *
63*33de042dSApple OSS Distributions  */
64*33de042dSApple OSS Distributions #ifndef _NET_NAT464_UTILS_H_
65*33de042dSApple OSS Distributions #define _NET_NAT464_UTILS_H_
66*33de042dSApple OSS Distributions #include <netinet/in.h>
67*33de042dSApple OSS Distributions #include <net/pf_pbuf.h>
68*33de042dSApple OSS Distributions 
69*33de042dSApple OSS Distributions #define clat_log0(x)    do { log x; } while (0)
70*33de042dSApple OSS Distributions #define clat_log1(x)    do { if (clat_debug >= 1) log x; } while (0)
71*33de042dSApple OSS Distributions #define clat_log2(x)    do { if (clat_debug >= 2) log x; } while (0)
72*33de042dSApple OSS Distributions 
73*33de042dSApple OSS Distributions #define CLAT46_NEEDED(x)                                                        \
74*33de042dSApple OSS Distributions 	(!IN_LOOPBACK(x) && !IN_LINKLOCAL(x) && !IN_MULTICAST(x) &&             \
75*33de042dSApple OSS Distributions 	INADDR_BROADCAST != x)
76*33de042dSApple OSS Distributions 
77*33de042dSApple OSS Distributions #define CLAT64_NEEDED(x)                                                        \
78*33de042dSApple OSS Distributions 	(!IN6_IS_ADDR_LOOPBACK(x) && !IN6_IS_ADDR_LINKLOCAL(x) &&               \
79*33de042dSApple OSS Distributions 	!IN6_IS_ADDR_MULTICAST(x))
80*33de042dSApple OSS Distributions 
81*33de042dSApple OSS Distributions extern int clat_debug;
82*33de042dSApple OSS Distributions 
83*33de042dSApple OSS Distributions enum    { NT_DROP, NT_NAT64 };
84*33de042dSApple OSS Distributions enum    { NT_IN, NT_OUT };
85*33de042dSApple OSS Distributions struct nat464_addr {
86*33de042dSApple OSS Distributions 	union {
87*33de042dSApple OSS Distributions 		struct in_addr          _v4addr;
88*33de042dSApple OSS Distributions 		struct in6_addr         _v6addr;
89*33de042dSApple OSS Distributions 		uint8_t         _addr8[16];
90*33de042dSApple OSS Distributions 		uint16_t                _addr16[8];
91*33de042dSApple OSS Distributions 		uint32_t                _addr32[4];
92*33de042dSApple OSS Distributions 	} nat464a;                  /* 128-bit address */
93*33de042dSApple OSS Distributions #define natv4addr       nat464a._v4addr
94*33de042dSApple OSS Distributions #define natv6addr       nat464a._v6addr
95*33de042dSApple OSS Distributions #define nataddr8        nat464a._addr8
96*33de042dSApple OSS Distributions #define nataddr16       nat464a._addr16
97*33de042dSApple OSS Distributions #define nataddr32       nat464a._addr32
98*33de042dSApple OSS Distributions };
99*33de042dSApple OSS Distributions 
100*33de042dSApple OSS Distributions int
101*33de042dSApple OSS Distributions nat464_translate_icmp(int, void *);
102*33de042dSApple OSS Distributions 
103*33de042dSApple OSS Distributions int
104*33de042dSApple OSS Distributions     nat464_translate_icmp_ip(pbuf_t *, uint16_t, uint16_t *, uint16_t *,
105*33de042dSApple OSS Distributions     uint8_t, uint8_t, uint16_t, struct nat464_addr *,
106*33de042dSApple OSS Distributions     struct nat464_addr *, protocol_family_t, protocol_family_t );
107*33de042dSApple OSS Distributions 
108*33de042dSApple OSS Distributions int
109*33de042dSApple OSS Distributions     nat464_synthesize_ipv6(ifnet_t, const struct in_addr *, struct in6_addr *);
110*33de042dSApple OSS Distributions 
111*33de042dSApple OSS Distributions int
112*33de042dSApple OSS Distributions     nat464_synthesize_ipv4(ifnet_t, const struct in6_addr *, struct in_addr *);
113*33de042dSApple OSS Distributions 
114*33de042dSApple OSS Distributions int
115*33de042dSApple OSS Distributions     nat464_translate_64(pbuf_t *, int, uint8_t, uint8_t *, uint8_t, struct in_addr,
116*33de042dSApple OSS Distributions     struct in_addr, uint64_t, boolean_t *);
117*33de042dSApple OSS Distributions 
118*33de042dSApple OSS Distributions int
119*33de042dSApple OSS Distributions     nat464_translate_46(pbuf_t *, uint16_t, uint8_t, uint8_t, uint8_t, struct in6_addr,
120*33de042dSApple OSS Distributions     struct in6_addr, uint16_t);
121*33de042dSApple OSS Distributions 
122*33de042dSApple OSS Distributions int
123*33de042dSApple OSS Distributions     nat464_translate_proto(pbuf_t *, struct nat464_addr *, struct nat464_addr *,
124*33de042dSApple OSS Distributions     uint8_t, protocol_family_t, protocol_family_t, int, boolean_t);
125*33de042dSApple OSS Distributions 
126*33de042dSApple OSS Distributions int
127*33de042dSApple OSS Distributions     nat464_insert_frag46(pbuf_t *, uint16_t, uint16_t, boolean_t);
128*33de042dSApple OSS Distributions 
129*33de042dSApple OSS Distributions int
130*33de042dSApple OSS Distributions     nat464_remove_frag64(pbuf_t *, uint32_t, uint16_t, boolean_t);
131*33de042dSApple OSS Distributions 
132*33de042dSApple OSS Distributions uint16_t
133*33de042dSApple OSS Distributions     nat464_cksum_fixup(uint16_t, uint16_t, uint16_t, uint8_t);
134*33de042dSApple OSS Distributions #endif /* !_NET_NAT464_UTILS_H_ */
135