1 /*
2 * Copyright (c) 2000-2016 Apple Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
14 *
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27 */
28 /*
29 * Copyright (C) 1999 WIDE Project.
30 * All rights reserved.
31 *
32 * Redistribution and use in source and binary forms, with or without
33 * modification, are permitted provided that the following conditions
34 * are met:
35 * 1. Redistributions of source code must retain the above copyright
36 * notice, this list of conditions and the following disclaimer.
37 * 2. Redistributions in binary form must reproduce the above copyright
38 * notice, this list of conditions and the following disclaimer in the
39 * documentation and/or other materials provided with the distribution.
40 * 3. Neither the name of the project nor the names of its contributors
41 * may be used to endorse or promote products derived from this software
42 * without specific prior written permission.
43 *
44 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
45 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
46 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
47 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
48 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
49 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
50 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
51 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
52 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
53 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
54 * SUCH DAMAGE.
55 *
56 */
57 /*
58 * ECN consideration on tunnel ingress/egress operation.
59 * http://www.aciri.org/floyd/papers/draft-ipsec-ecn-00.txt
60 */
61
62 #include <sys/param.h>
63 #include <sys/systm.h>
64 #include <sys/malloc.h>
65 #include <sys/mbuf.h>
66 #include <sys/errno.h>
67
68 #include <netinet/in.h>
69 #include <netinet/in_systm.h>
70 #include <netinet/ip.h>
71 #include <netinet/ip6.h>
72
73 #include <netinet/ip_ecn.h>
74 #include <netinet6/ip6_ecn.h>
75
76 /*
77 * modify outer ECN (TOS) field on ingress operation (tunnel encapsulation).
78 */
79 void
ip_ecn_ingress(int mode,u_int8_t * outer,const u_int8_t * inner)80 ip_ecn_ingress(int mode, u_int8_t *outer, const u_int8_t *inner)
81 {
82 if (!outer || !inner) {
83 panic("NULL pointer passed to ip_ecn_ingress");
84 }
85
86 *outer = *inner;
87 switch (mode) {
88 case ECN_NORMAL: /* ECN normal mode, copy flags */
89 break;
90 case ECN_COMPATIBILITY: /* ECN compatibility mode */
91 *outer &= ~IPTOS_ECN_MASK;
92 break;
93 case ECN_NOCARE: /* no consideration to ECN */
94 break;
95 }
96 }
97
98 /*
99 * modify inner ECN (TOS) field on egress operation (tunnel decapsulation).
100 */
101 int
ip_ecn_egress(int mode,const u_int8_t * outer,u_int8_t * inner)102 ip_ecn_egress(int mode, const u_int8_t *outer, u_int8_t *inner)
103 {
104 if (!outer || !inner) {
105 panic("NULL pointer passed to ip_ecn_egress");
106 }
107
108 switch (mode) {
109 /* Process ECN for both normal and compatibility modes */
110 case ECN_NORMAL:
111 case ECN_COMPATIBILITY:
112 if (((*outer & IPTOS_ECN_MASK) == IPTOS_ECN_CE) &&
113 ((*inner & IPTOS_ECN_MASK) != IPTOS_ECN_NOTECT)) {
114 *inner |= IPTOS_ECN_CE;
115 } else if ((*outer & IPTOS_ECN_MASK) == IPTOS_ECN_ECT1 &&
116 (*inner & IPTOS_ECN_MASK) == IPTOS_ECN_ECT0) {
117 *inner = *outer;
118 }
119 break;
120 case ECN_NOCARE: /* no consideration to ECN */
121 break;
122 }
123 return 1;
124 }
125
126 void
ip6_ecn_ingress(int mode,u_int32_t * outer,const u_int32_t * inner)127 ip6_ecn_ingress(int mode, u_int32_t *outer, const u_int32_t *inner)
128 {
129 u_int8_t outer8, inner8;
130
131 if (!outer || !inner) {
132 panic("NULL pointer passed to ip6_ecn_ingress");
133 }
134
135 inner8 = (ntohl(*inner) >> 20) & 0xff;
136 ip_ecn_ingress(mode, &outer8, &inner8);
137 *outer &= ~htonl(0xff << 20);
138 *outer |= htonl((u_int32_t)outer8 << 20);
139 }
140
141 int
ip6_ecn_egress(int mode,const u_int32_t * outer,u_int32_t * inner)142 ip6_ecn_egress(int mode, const u_int32_t *outer, u_int32_t *inner)
143 {
144 u_int8_t outer8, inner8;
145
146 if (!outer || !inner) {
147 panic("NULL pointer passed to ip6_ecn_egress");
148 }
149
150 outer8 = (ntohl(*outer) >> 20) & 0xff;
151 inner8 = (ntohl(*inner) >> 20) & 0xff;
152 if (ip_ecn_egress(mode, &outer8, &inner8) == 0) {
153 return 0;
154 }
155 *inner &= ~htonl(0xff << 20);
156 *inner |= htonl((u_int32_t)inner8 << 20);
157 return 1;
158 }
159
160 /*
161 * Modify outer IPv6 ECN (Traffic Class) field according to inner IPv4 TOS field
162 * on ingress operation (tunnel encapsulation).
163 */
164 void
ip46_ecn_ingress(int mode,u_int32_t * outer,const u_int8_t * tos)165 ip46_ecn_ingress(int mode, u_int32_t *outer, const u_int8_t *tos)
166 {
167 u_int8_t outer8;
168
169 if (!outer || !tos) {
170 panic("NULL pointer passed to ip46_ecn_ingress");
171 }
172
173 ip_ecn_ingress(mode, &outer8, tos);
174 *outer &= ~htonl(0xff << 20);
175 *outer |= htonl((u_int32_t)outer8 << 20);
176 }
177
178 /*
179 * Modify inner IPv4 ECN (TOS) field according to output IPv6 ECN (Traffic Class)
180 * on egress operation (tunnel decapsulation).
181 */
182 int
ip46_ecn_egress(int mode,const u_int32_t * outer,u_int8_t * tos)183 ip46_ecn_egress(int mode, const u_int32_t *outer, u_int8_t *tos)
184 {
185 u_int8_t outer8;
186
187 if (!outer || !tos) {
188 panic("NULL pointer passed to ip46_ecn_egress");
189 }
190
191 outer8 = (ntohl(*outer) >> 20) & 0xff;
192 return ip_ecn_egress(mode, &outer8, tos);
193 }
194
195 /*
196 * Modify outer IPv4 TOS field according to inner IPv6 ECN (Traffic Class)
197 * on ingress operation (tunnel encapsulation).
198 */
199 void
ip64_ecn_ingress(int mode,u_int8_t * outer,const u_int32_t * inner)200 ip64_ecn_ingress(int mode, u_int8_t *outer, const u_int32_t *inner)
201 {
202 u_int8_t inner8;
203
204 if (!outer || !inner) {
205 panic("NULL pointer passed to ip64_ecn_ingress");
206 }
207
208 inner8 = (ntohl(*inner) >> 20) & 0xff;
209 ip_ecn_ingress(mode, outer, &inner8);
210 }
211
212 /*
213 * Modify inner IPv6 ECN (Traffic Class) according to outer IPv4 TOS field
214 * on egress operation (tunnel decapsulation).
215 */
216 int
ip64_ecn_egress(int mode,const u_int8_t * outer,u_int32_t * inner)217 ip64_ecn_egress(int mode, const u_int8_t *outer, u_int32_t *inner)
218 {
219 u_int8_t inner8;
220
221 if (!outer || !inner) {
222 panic("NULL pointer passed to ip64_ecn_egress");
223 }
224
225 inner8 = (ntohl(*inner) >> 20) & 0xff;
226 if (ip_ecn_egress(mode, outer, &inner8) == 0) {
227 return 0;
228 }
229
230 *inner &= ~htonl(0xff << 20);
231 *inner |= htonl((u_int32_t)inner8 << 20);
232 return 1;
233 }
234