Abstract out the location of an m_tag's data by adding a m_tag_data() inline.
[dragonfly.git] / sys / netinet / ip_encap.c
1 /*      $FreeBSD: src/sys/netinet/ip_encap.c,v 1.1.2.5 2003/01/23 21:06:45 sam Exp $    */
2 /*      $DragonFly: src/sys/netinet/ip_encap.c,v 1.13 2005/06/17 19:12:20 dillon Exp $  */
3 /*      $KAME: ip_encap.c,v 1.41 2001/03/15 08:35:08 itojun Exp $       */
4
5 /*
6  * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
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.
17  * 3. Neither the name of the project nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  */
33 /*
34  * My grandfather said that there's a devil inside tunnelling technology...
35  *
36  * We have surprisingly many protocols that want packets with IP protocol
37  * #4 or #41.  Here's a list of protocols that want protocol #41:
38  *      RFC1933 configured tunnel
39  *      RFC1933 automatic tunnel
40  *      RFC2401 IPsec tunnel
41  *      RFC2473 IPv6 generic packet tunnelling
42  *      RFC2529 6over4 tunnel
43  *      mobile-ip6 (uses RFC2473)
44  *      RFC3056 6to4 tunnel
45  *      isatap tunnel
46  * Here's a list of protocol that want protocol #4:
47  *      RFC1853 IPv4-in-IPv4 tunnelling
48  *      RFC2003 IPv4 encapsulation within IPv4
49  *      RFC2344 reverse tunnelling for mobile-ip4
50  *      RFC2401 IPsec tunnel
51  * Well, what can I say.  They impose different en/decapsulation mechanism
52  * from each other, so they need separate protocol handler.  The only one
53  * we can easily determine by protocol # is IPsec, which always has
54  * AH/ESP/IPComp header right after outer IP header.
55  *
56  * So, clearly good old protosw does not work for protocol #4 and #41.
57  * The code will let you match protocol via src/dst address pair.
58  */
59 /* XXX is M_NETADDR correct? */
60
61 #include "opt_inet.h"
62 #include "opt_inet6.h"
63
64 #include <sys/param.h>
65 #include <sys/systm.h>
66 #include <sys/socket.h>
67 #include <sys/sockio.h>
68 #include <sys/mbuf.h>
69 #include <sys/errno.h>
70 #include <sys/protosw.h>
71 #include <sys/queue.h>
72
73 #include <net/if.h>
74 #include <net/route.h>
75
76 #include <netinet/in.h>
77 #include <netinet/in_systm.h>
78 #include <netinet/ip.h>
79 #include <netinet/ip_var.h>
80 #include <netinet/ip_encap.h>
81
82 #ifdef INET6
83 #include <netinet/ip6.h>
84 #include <netinet6/ip6_var.h>
85 #include <netinet6/ip6protosw.h>
86 #endif
87
88 #include <machine/stdarg.h>
89
90 #include <net/net_osdep.h>
91
92 #include <sys/kernel.h>
93 #include <sys/malloc.h>
94 #include <sys/thread2.h>
95 MALLOC_DEFINE(M_NETADDR, "Export Host", "Export host address structure");
96
97 static void encap_add (struct encaptab *);
98 static int mask_match (const struct encaptab *, const struct sockaddr *,
99                 const struct sockaddr *);
100 static void encap_fillarg (struct mbuf *, const struct encaptab *);
101
102 #ifndef LIST_HEAD_INITIALIZER
103 /* rely upon BSS initialization */
104 LIST_HEAD(, encaptab) encaptab;
105 #else
106 LIST_HEAD(, encaptab) encaptab = LIST_HEAD_INITIALIZER(&encaptab);
107 #endif
108
109 void     (*ipip_input)(struct mbuf *, int, int); /* hook for mrouting */
110
111 void
112 encap_init()
113 {
114         static int initialized = 0;
115
116         if (initialized)
117                 return;
118         initialized++;
119 #if 0
120         /*
121          * we cannot use LIST_INIT() here, since drivers may want to call
122          * encap_attach(), on driver attach.  encap_init() will be called
123          * on AF_INET{,6} initialization, which happens after driver
124          * initialization - using LIST_INIT() here can nuke encap_attach()
125          * from drivers.
126          */
127         LIST_INIT(&encaptab);
128 #endif
129 }
130
131 #ifdef INET
132 void
133 encap4_input(struct mbuf *m, ...)
134 {
135         int off, proto;
136         struct ip *ip;
137         struct sockaddr_in s, d;
138         const struct protosw *psw;
139         struct encaptab *ep, *match;
140         int prio, matchprio;
141         __va_list ap;
142
143         __va_start(ap, m);
144         off = __va_arg(ap, int);
145         proto = __va_arg(ap, int);
146         __va_end(ap);
147
148         ip = mtod(m, struct ip *);
149
150         bzero(&s, sizeof s);
151         s.sin_family = AF_INET;
152         s.sin_len = sizeof(struct sockaddr_in);
153         s.sin_addr = ip->ip_src;
154         bzero(&d, sizeof d);
155         d.sin_family = AF_INET;
156         d.sin_len = sizeof(struct sockaddr_in);
157         d.sin_addr = ip->ip_dst;
158
159         match = NULL;
160         matchprio = 0;
161         for (ep = LIST_FIRST(&encaptab); ep; ep = LIST_NEXT(ep, chain)) {
162                 if (ep->af != AF_INET)
163                         continue;
164                 if (ep->proto >= 0 && ep->proto != proto)
165                         continue;
166                 if (ep->func)
167                         prio = (*ep->func)(m, off, proto, ep->arg);
168                 else {
169                         /*
170                          * it's inbound traffic, we need to match in reverse
171                          * order
172                          */
173                         prio = mask_match(ep, (struct sockaddr *)&d,
174                             (struct sockaddr *)&s);
175                 }
176
177                 /*
178                  * We prioritize the matches by using bit length of the
179                  * matches.  mask_match() and user-supplied matching function
180                  * should return the bit length of the matches (for example,
181                  * if both src/dst are matched for IPv4, 64 should be returned).
182                  * 0 or negative return value means "it did not match".
183                  *
184                  * The question is, since we have two "mask" portion, we
185                  * cannot really define total order between entries.
186                  * For example, which of these should be preferred?
187                  * mask_match() returns 48 (32 + 16) for both of them.
188                  *      src=3ffe::/16, dst=3ffe:501::/32
189                  *      src=3ffe:501::/32, dst=3ffe::/16
190                  *
191                  * We need to loop through all the possible candidates
192                  * to get the best match - the search takes O(n) for
193                  * n attachments (i.e. interfaces).
194                  */
195                 if (prio <= 0)
196                         continue;
197                 if (prio > matchprio) {
198                         matchprio = prio;
199                         match = ep;
200                 }
201         }
202
203         if (match) {
204                 /* found a match, "match" has the best one */
205                 psw = match->psw;
206                 if (psw && psw->pr_input) {
207                         encap_fillarg(m, match);
208                         (*psw->pr_input)(m, off, proto);
209                 } else
210                         m_freem(m);
211                 return;
212         }
213
214         /* for backward compatibility */
215         if (proto == IPPROTO_IPV4 && ipip_input) {
216                 ipip_input(m, off, proto);
217                 return;
218         }
219
220         /* last resort: inject to raw socket */
221         rip_input(m, off, proto);
222 }
223 #endif
224
225 #ifdef INET6
226 int
227 encap6_input(mp, offp, proto)
228         struct mbuf **mp;
229         int *offp;
230         int proto;
231 {
232         struct mbuf *m = *mp;
233         struct ip6_hdr *ip6;
234         struct sockaddr_in6 s, d;
235         const struct ip6protosw *psw;
236         struct encaptab *ep, *match;
237         int prio, matchprio;
238
239         ip6 = mtod(m, struct ip6_hdr *);
240
241         bzero(&s, sizeof s);
242         s.sin6_family = AF_INET6;
243         s.sin6_len = sizeof(struct sockaddr_in6);
244         s.sin6_addr = ip6->ip6_src;
245         bzero(&d, sizeof d);
246         d.sin6_family = AF_INET6;
247         d.sin6_len = sizeof(struct sockaddr_in6);
248         d.sin6_addr = ip6->ip6_dst;
249
250         match = NULL;
251         matchprio = 0;
252         for (ep = LIST_FIRST(&encaptab); ep; ep = LIST_NEXT(ep, chain)) {
253                 if (ep->af != AF_INET6)
254                         continue;
255                 if (ep->proto >= 0 && ep->proto != proto)
256                         continue;
257                 if (ep->func)
258                         prio = (*ep->func)(m, *offp, proto, ep->arg);
259                 else {
260                         /*
261                          * it's inbound traffic, we need to match in reverse
262                          * order
263                          */
264                         prio = mask_match(ep, (struct sockaddr *)&d,
265                             (struct sockaddr *)&s);
266                 }
267
268                 /* see encap4_input() for issues here */
269                 if (prio <= 0)
270                         continue;
271                 if (prio > matchprio) {
272                         matchprio = prio;
273                         match = ep;
274                 }
275         }
276
277         if (match) {
278                 /* found a match */
279                 psw = (const struct ip6protosw *)match->psw;
280                 if (psw && psw->pr_input) {
281                         encap_fillarg(m, match);
282                         return (*psw->pr_input)(mp, offp, proto);
283                 } else {
284                         m_freem(m);
285                         return IPPROTO_DONE;
286                 }
287         }
288
289         /* last resort: inject to raw socket */
290         return rip6_input(mp, offp, proto);
291 }
292 #endif
293
294 static void
295 encap_add(ep)
296         struct encaptab *ep;
297 {
298
299         LIST_INSERT_HEAD(&encaptab, ep, chain);
300 }
301
302 /*
303  * sp (src ptr) is always my side, and dp (dst ptr) is always remote side.
304  * length of mask (sm and dm) is assumed to be same as sp/dp.
305  * Return value will be necessary as input (cookie) for encap_detach().
306  */
307 const struct encaptab *
308 encap_attach(af, proto, sp, sm, dp, dm, psw, arg)
309         int af;
310         int proto;
311         const struct sockaddr *sp, *sm;
312         const struct sockaddr *dp, *dm;
313         const struct protosw *psw;
314         void *arg;
315 {
316         struct encaptab *ep;
317         int error;
318
319         crit_enter();
320         /* sanity check on args */
321         if (sp->sa_len > sizeof ep->src || dp->sa_len > sizeof ep->dst) {
322                 error = EINVAL;
323                 goto fail;
324         }
325         if (sp->sa_len != dp->sa_len) {
326                 error = EINVAL;
327                 goto fail;
328         }
329         if (af != sp->sa_family || af != dp->sa_family) {
330                 error = EINVAL;
331                 goto fail;
332         }
333
334         /* check if anyone have already attached with exactly same config */
335         for (ep = LIST_FIRST(&encaptab); ep; ep = LIST_NEXT(ep, chain)) {
336                 if (ep->af != af)
337                         continue;
338                 if (ep->proto != proto)
339                         continue;
340                 if (ep->src.ss_len != sp->sa_len ||
341                     bcmp(&ep->src, sp, sp->sa_len) != 0 ||
342                     bcmp(&ep->srcmask, sm, sp->sa_len) != 0)
343                         continue;
344                 if (ep->dst.ss_len != dp->sa_len ||
345                     bcmp(&ep->dst, dp, dp->sa_len) != 0 ||
346                     bcmp(&ep->dstmask, dm, dp->sa_len) != 0)
347                         continue;
348
349                 error = EEXIST;
350                 goto fail;
351         }
352
353         ep = malloc(sizeof *ep, M_NETADDR, M_INTWAIT | M_ZERO | M_NULLOK);
354         if (ep == NULL) {
355                 error = ENOBUFS;
356                 goto fail;
357         }
358
359         ep->af = af;
360         ep->proto = proto;
361         bcopy(sp, &ep->src, sp->sa_len);
362         bcopy(sm, &ep->srcmask, sp->sa_len);
363         bcopy(dp, &ep->dst, dp->sa_len);
364         bcopy(dm, &ep->dstmask, dp->sa_len);
365         ep->psw = psw;
366         ep->arg = arg;
367
368         encap_add(ep);
369
370         error = 0;
371         crit_exit();
372         return ep;
373
374 fail:
375         crit_exit();
376         return NULL;
377 }
378
379 const struct encaptab *
380 encap_attach_func(af, proto, func, psw, arg)
381         int af;
382         int proto;
383         int (*func) (const struct mbuf *, int, int, void *);
384         const struct protosw *psw;
385         void *arg;
386 {
387         struct encaptab *ep;
388         int error;
389
390         crit_enter();
391         /* sanity check on args */
392         if (!func) {
393                 error = EINVAL;
394                 goto fail;
395         }
396
397         ep = malloc(sizeof *ep, M_NETADDR, M_INTWAIT | M_ZERO | M_NULLOK);
398         if (ep == NULL) {
399                 error = ENOBUFS;
400                 goto fail;
401         }
402
403         ep->af = af;
404         ep->proto = proto;
405         ep->func = func;
406         ep->psw = psw;
407         ep->arg = arg;
408
409         encap_add(ep);
410
411         error = 0;
412         crit_exit();
413         return ep;
414
415 fail:
416         crit_exit();
417         return NULL;
418 }
419
420 int
421 encap_detach(cookie)
422         const struct encaptab *cookie;
423 {
424         const struct encaptab *ep = cookie;
425         struct encaptab *p;
426
427         for (p = LIST_FIRST(&encaptab); p; p = LIST_NEXT(p, chain)) {
428                 if (p == ep) {
429                         LIST_REMOVE(p, chain);
430                         free(p, M_NETADDR);     /*XXX*/
431                         return 0;
432                 }
433         }
434
435         return EINVAL;
436 }
437
438 static int
439 mask_match(ep, sp, dp)
440         const struct encaptab *ep;
441         const struct sockaddr *sp;
442         const struct sockaddr *dp;
443 {
444         struct sockaddr_storage s;
445         struct sockaddr_storage d;
446         int i;
447         const u_int8_t *p, *q;
448         u_int8_t *r;
449         int matchlen;
450
451         if (sp->sa_len > sizeof s || dp->sa_len > sizeof d)
452                 return 0;
453         if (sp->sa_family != ep->af || dp->sa_family != ep->af)
454                 return 0;
455         if (sp->sa_len != ep->src.ss_len || dp->sa_len != ep->dst.ss_len)
456                 return 0;
457
458         matchlen = 0;
459
460         p = (const u_int8_t *)sp;
461         q = (const u_int8_t *)&ep->srcmask;
462         r = (u_int8_t *)&s;
463         for (i = 0 ; i < sp->sa_len; i++) {
464                 r[i] = p[i] & q[i];
465                 /* XXX estimate */
466                 matchlen += (q[i] ? 8 : 0);
467         }
468
469         p = (const u_int8_t *)dp;
470         q = (const u_int8_t *)&ep->dstmask;
471         r = (u_int8_t *)&d;
472         for (i = 0 ; i < dp->sa_len; i++) {
473                 r[i] = p[i] & q[i];
474                 /* XXX rough estimate */
475                 matchlen += (q[i] ? 8 : 0);
476         }
477
478         /* need to overwrite len/family portion as we don't compare them */
479         s.ss_len = sp->sa_len;
480         s.ss_family = sp->sa_family;
481         d.ss_len = dp->sa_len;
482         d.ss_family = dp->sa_family;
483
484         if (bcmp(&s, &ep->src, ep->src.ss_len) == 0 &&
485             bcmp(&d, &ep->dst, ep->dst.ss_len) == 0) {
486                 return matchlen;
487         } else
488                 return 0;
489 }
490
491 static void
492 encap_fillarg(m, ep)
493         struct mbuf *m;
494         const struct encaptab *ep;
495 {
496         struct m_tag *tag;
497
498         tag = m_tag_get(PACKET_TAG_ENCAP, sizeof(void *), MB_DONTWAIT);
499         if (tag != NULL) {
500                 *(void **)m_tag_data(tag) = ep->arg;
501                 m_tag_prepend(m, tag);
502         }
503 }
504
505 void *
506 encap_getarg(m)
507         struct mbuf *m;
508 {
509         void *p = NULL;
510         struct m_tag *tag;
511
512         tag = m_tag_find(m, PACKET_TAG_ENCAP, NULL);
513         if (tag != NULL) {
514                 p = *(void **)m_tag_data(tag);
515                 m_tag_delete(m, tag);
516         }
517         return p;
518 }