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#if INET6
72#include <netinet/ip6.h>
73#endif
74
75#include <netinet/ip_ecn.h>
76#if INET6
77#include <netinet6/ip6_ecn.h>
78#endif
79
80/*
81 * modify outer ECN (TOS) field on ingress operation (tunnel encapsulation).
82 */
83void
84ip_ecn_ingress(int mode, u_int8_t *outer, const u_int8_t *inner)
85{
86 if (!outer || !inner)
87 panic("NULL pointer passed to ip_ecn_ingress");
88
89 *outer = *inner;
90 switch (mode) {
91 case ECN_NORMAL: /* ECN normal mode, copy flags */
92 break;
93 case ECN_COMPATIBILITY: /* ECN compatibility mode */
94 *outer &= ~IPTOS_ECN_MASK;
95 break;
96 case ECN_NOCARE: /* no consideration to ECN */
97 break;
98 }
99}
100
101/*
102 * modify inner ECN (TOS) field on egress operation (tunnel decapsulation).
103 */
104int
105ip_ecn_egress(int mode, const u_int8_t *outer, u_int8_t *inner)
106{
107 if (!outer || !inner)
108 panic("NULL pointer passed to ip_ecn_egress");
109
110 switch (mode) {
111 /* Process ECN for both normal and compatibility modes */
112 case ECN_NORMAL:
113 case ECN_COMPATIBILITY:
114 if (((*outer & IPTOS_ECN_MASK) == IPTOS_ECN_CE) &&
115 ((*inner & IPTOS_ECN_MASK) != IPTOS_ECN_NOTECT)) {
116 *inner |= IPTOS_ECN_CE;
117 } else if ((*outer & IPTOS_ECN_MASK) == IPTOS_ECN_ECT1 &&
118 (*inner & IPTOS_ECN_MASK) == IPTOS_ECN_ECT0) {
119 *inner = *outer;
120 }
121 break;
122 case ECN_NOCARE: /* no consideration to ECN */
123 break;
124 }
125 return (1);
126}
127
128#if INET6
129void
130ip6_ecn_ingress(int mode, u_int32_t *outer, const u_int32_t *inner)
131{
132 u_int8_t outer8, inner8;
133
134 if (!outer || !inner)
135 panic("NULL pointer passed to ip6_ecn_ingress");
136
137 inner8 = (ntohl(*inner) >> 20) & 0xff;
138 ip_ecn_ingress(mode, &outer8, &inner8);
139 *outer &= ~htonl(0xff << 20);
140 *outer |= htonl((u_int32_t)outer8 << 20);
141}
142
143int
144ip6_ecn_egress(int mode, const u_int32_t *outer, u_int32_t *inner)
145{
146 u_int8_t outer8, inner8;
147
148 if (!outer || !inner)
149 panic("NULL pointer passed to ip6_ecn_egress");
150
151 outer8 = (ntohl(*outer) >> 20) & 0xff;
152 inner8 = (ntohl(*inner) >> 20) & 0xff;
153 if (ip_ecn_egress(mode, &outer8, &inner8) == 0) {
154 return (0);
155 }
156 *inner &= ~htonl(0xff << 20);
157 *inner |= htonl((u_int32_t)inner8 << 20);
158 return (1);
159}
160
161/*
162 * Modify outer IPv6 ECN (Traffic Class) field according to inner IPv4 TOS field
163 * on ingress operation (tunnel encapsulation).
164 */
165void
166ip46_ecn_ingress(int mode, u_int32_t *outer, const u_int8_t *tos)
167{
168 u_int8_t outer8;
169
170 if (!outer || !tos)
171 panic("NULL pointer passed to ip46_ecn_ingress");
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 */
182int
183ip46_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 outer8 = (ntohl(*outer) >> 20) & 0xff;
191 return ip_ecn_egress(mode, &outer8, tos);
192}
193
194/*
195 * Modify outer IPv4 TOS field according to inner IPv6 ECN (Traffic Class)
196 * on ingress operation (tunnel encapsulation).
197 */
198void
199ip64_ecn_ingress(int mode, u_int8_t *outer, const u_int32_t *inner)
200{
201 u_int8_t inner8;
202
203 if (!outer || ! inner)
204 panic("NULL pointer passed to ip64_ecn_ingress");
205
206 inner8 = (ntohl(*inner) >> 20) & 0xff;
207 ip_ecn_ingress(mode, outer, &inner8);
208}
209
210/*
211 * Modify inner IPv6 ECN (Traffic Class) according to outer IPv4 TOS field
212 * on egress operation (tunnel decapsulation).
213 */
214int
215ip64_ecn_egress(int mode, const u_int8_t *outer, u_int32_t *inner)
216{
217 u_int8_t inner8;
218
219 if (!outer || !inner)
220 panic("NULL pointer passed to ip64_ecn_egress");
221
222 inner8 = (ntohl(*inner) >> 20) & 0xff;
223 if (ip_ecn_egress(mode, outer, &inner8) == 0) {
224 return (0);
225 }
226
227 *inner &= ~htonl(0xff << 20);
228 *inner |= htonl((u_int32_t)inner8 << 20);
229 return (1);
230}
231
232#endif
233