/* * Copyright (c) 2000-2007 Apple Inc. All rights reserved. * * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ * * This file contains Original Code and/or Modifications of Original Code * as defined in and that are subject to the Apple Public Source License * Version 2.0 (the 'License'). You may not use this file except in * compliance with the License. The rights granted to you under the License * may not be used to create, or enable the creation or redistribution of, * unlawful or unlicensed copies of an Apple operating system, or to * circumvent, violate, or enable the circumvention or violation of, any * terms of an Apple operating system software license agreement. * * Please obtain a copy of the License at * http://www.opensource.apple.com/apsl/ and read it before using this file. * * The Original Code and all software distributed under the License are * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. * Please see the License for the specific language governing rights and * limitations under the License. * * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ */ /* $FreeBSD: src/sys/net/if_gif.c,v 1.4.2.6 2001/07/24 19:10:18 brooks Exp $ */ /* $KAME: if_gif.c,v 1.47 2001/05/01 05:28:42 itojun Exp $ */ /* * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project. * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * 3. Neither the name of the project nor the names of its contributors * may be used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. */ /* * NOTICE: This file was modified by SPARTA, Inc. in 2006 to introduce * support for mandatory and extensible security protections. This notice * is included in support of clause 2.2 (b) of the Apple Public License, * Version 2.0. */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #if INET #include #include #include #endif /* INET */ #if INET6 #include #include #include #include #include #endif /* INET6 */ #include #include #include #include #if CONFIG_MACF_NET #include #endif #define GIFNAME "gif" #define GIFDEV "if_gif" #define GIF_MAXUNIT 0x7fff /* ifp->if_unit is only 15 bits */ #ifndef __APPLE__ static MALLOC_DEFINE(M_GIF, "gif", "Generic Tunnel Interface"); #endif TAILQ_HEAD(gifhead, gif_softc) gifs = TAILQ_HEAD_INITIALIZER(gifs); #ifdef __APPLE__ void gifattach(void); static void gif_create_dev(void); static int gif_encapcheck(const struct mbuf*, int, int, void*); static errno_t gif_output(ifnet_t ifp, mbuf_t m); static errno_t gif_input(ifnet_t ifp, protocol_family_t protocol_family, mbuf_t m, char *frame_header); static errno_t gif_ioctl(ifnet_t ifp, u_int32_t cmd, void *data); int ngif = 0; /* number of interfaces */ #endif #if INET struct protosw in_gif_protosw = { SOCK_RAW, 0, 0/*IPPROTO_IPV[46]*/, PR_ATOMIC|PR_ADDR, in_gif_input, 0, 0, 0, 0, 0, 0, 0, 0, 0, &rip_usrreqs, 0, rip_unlock, 0, {0, 0}, 0, {0} }; #endif #if INET6 struct ip6protosw in6_gif_protosw = { SOCK_RAW, 0, 0/*IPPROTO_IPV[46]*/, PR_ATOMIC|PR_ADDR, in6_gif_input, 0, 0, 0, 0, 0, 0, 0, 0, 0, &rip6_usrreqs, 0, rip_unlock, 0, {0, 0}, 0, {0} }; #endif #ifdef __APPLE__ /* * Theory of operation: initially, one gif interface is created. * Any time a gif interface is configured, if there are no other * unconfigured gif interfaces, a new gif interface is created. * BSD uses the clone mechanism to dynamically create more * gif interfaces. * * We have some extra glue to support DLIL. */ /* GIF interface module support */ static int gif_demux( ifnet_t ifp, __unused mbuf_t m, __unused char *frame_header, protocol_family_t *protocol_family) { /* Only one protocol may be attached to a gif interface. */ *protocol_family = ((struct gif_softc*)ifnet_softc(ifp))->gif_proto; return 0; } static errno_t gif_add_proto( ifnet_t ifp, protocol_family_t protocol_family, __unused const struct ifnet_demux_desc *demux_array, __unused u_int32_t demux_count) { /* Only one protocol may be attached at a time */ struct gif_softc* gif = ifnet_softc(ifp); if (gif->gif_proto != 0) printf("gif_add_proto: request add_proto for gif%d\n", ifnet_unit(ifp)); gif->gif_proto = protocol_family; return 0; } static errno_t gif_del_proto( ifnet_t ifp, protocol_family_t protocol_family) { if (((struct gif_softc*)ifnet_softc(ifp))->gif_proto == protocol_family) ((struct gif_softc*)ifnet_softc(ifp))->gif_proto = 0; return 0; } /* Glue code to attach inet to a gif interface through DLIL */ static errno_t gif_attach_proto_family( ifnet_t ifp, protocol_family_t protocol_family) { struct ifnet_attach_proto_param reg; errno_t stat; bzero(®, sizeof(reg)); reg.input = gif_input; stat = ifnet_attach_protocol(ifp, protocol_family, ®); if (stat && stat != EEXIST) { printf("gif_attach_proto_family can't attach interface fam=%d\n", protocol_family); } return stat; } #endif /* Function to setup the first gif interface */ __private_extern__ void gifattach(void) { errno_t result; /* Init the list of interfaces */ TAILQ_INIT(&gifs); /* Register protocol registration functions */ result = proto_register_plumber(PF_INET, APPLE_IF_FAM_GIF, gif_attach_proto_family, NULL); if (result != 0) printf("proto_register_plumber failed for AF_INET error=%d\n", result); result = proto_register_plumber(PF_INET6, APPLE_IF_FAM_GIF, gif_attach_proto_family, NULL); if (result != 0) printf("proto_register_plumber failed for AF_INET6 error=%d\n", result); /* Create first device */ gif_create_dev(); } static errno_t gif_set_bpf_tap( ifnet_t ifp, bpf_tap_mode mode, bpf_packet_func callback) { struct gif_softc *sc = ifnet_softc(ifp); sc->tap_mode = mode; sc->tap_callback = callback; return 0; } /* Creates another gif device if there are none free */ static void gif_create_dev(void) { struct gif_softc *sc; struct ifnet_init_params gif_init; errno_t result = 0; /* Can't create more than GIF_MAXUNIT */ if (ngif >= GIF_MAXUNIT) return; /* Check for unused gif interface */ TAILQ_FOREACH(sc, &gifs, gif_link) { /* If unused, return, no need to create a new interface */ if ((ifnet_flags(sc->gif_if) & IFF_RUNNING) == 0) return; } sc = _MALLOC(sizeof(struct gif_softc), M_DEVBUF, M_WAITOK); if (sc == NULL) { log(LOG_ERR, "gifattach: failed to allocate gif%d\n", ngif); return; } bzero(&gif_init, sizeof(gif_init)); gif_init.name = GIFNAME; gif_init.unit = ngif; gif_init.type = IFT_GIF; gif_init.family = IFNET_FAMILY_GIF; gif_init.output = gif_output; gif_init.demux = gif_demux; gif_init.add_proto = gif_add_proto; gif_init.del_proto = gif_del_proto; gif_init.softc = sc; gif_init.ioctl = gif_ioctl; gif_init.set_bpf_tap = gif_set_bpf_tap; bzero(sc, sizeof(struct gif_softc)); result = ifnet_allocate(&gif_init, &sc->gif_if); if (result != 0) { printf("gif_create_dev, ifnet_allocate failed - %d\n", result); _FREE(sc, M_DEVBUF); return; } sc->encap_cookie4 = sc->encap_cookie6 = NULL; #if INET sc->encap_cookie4 = encap_attach_func(AF_INET, -1, gif_encapcheck, &in_gif_protosw, sc); if (sc->encap_cookie4 == NULL) { printf("%s: unable to attach encap4\n", if_name(sc->gif_if)); ifnet_release(sc->gif_if); FREE(sc, M_DEVBUF); return; } #endif #if INET6 sc->encap_cookie6 = encap_attach_func(AF_INET6, -1, gif_encapcheck, (struct protosw*)&in6_gif_protosw, sc); if (sc->encap_cookie6 == NULL) { if (sc->encap_cookie4) { encap_detach(sc->encap_cookie4); sc->encap_cookie4 = NULL; } printf("%s: unable to attach encap6\n", if_name(sc->gif_if)); ifnet_release(sc->gif_if); FREE(sc, M_DEVBUF); return; } #endif sc->gif_called = 0; ifnet_set_mtu(sc->gif_if, GIF_MTU); ifnet_set_flags(sc->gif_if, IFF_POINTOPOINT | IFF_MULTICAST, 0xffff); #if 0 /* turn off ingress filter */ sc->gif_if.if_flags |= IFF_LINK2; #endif result = ifnet_attach(sc->gif_if, NULL); if (result != 0) { printf("gif_create_dev - ifnet_attach failed - %d\n", result); ifnet_release(sc->gif_if); FREE(sc, M_DEVBUF); return; } #if CONFIG_MACF_NET mac_ifnet_label_init(&sc->gif_if); #endif bpfattach(sc->gif_if, DLT_NULL, sizeof(u_int)); TAILQ_INSERT_TAIL(&gifs, sc, gif_link); ngif++; } static int gif_encapcheck( const struct mbuf *m, int off, int proto, void *arg) { struct ip ip; struct gif_softc *sc; sc = (struct gif_softc *)arg; if (sc == NULL) return 0; if ((ifnet_flags(sc->gif_if) & IFF_UP) == 0) return 0; /* no physical address */ if (!sc->gif_psrc || !sc->gif_pdst) return 0; switch (proto) { #if INET case IPPROTO_IPV4: break; #endif #if INET6 case IPPROTO_IPV6: break; #endif default: return 0; } mbuf_copydata(m, 0, sizeof(ip), &ip); switch (ip.ip_v) { #if INET case 4: if (sc->gif_psrc->sa_family != AF_INET || sc->gif_pdst->sa_family != AF_INET) return 0; return gif_encapcheck4(m, off, proto, arg); #endif #if INET6 case 6: if (sc->gif_psrc->sa_family != AF_INET6 || sc->gif_pdst->sa_family != AF_INET6) return 0; return gif_encapcheck6(m, off, proto, arg); #endif default: return 0; } } static errno_t gif_output( ifnet_t ifp, mbuf_t m) { struct gif_softc *sc = ifnet_softc(ifp); int error = 0; /* max_gif_nesting check used to live here. It doesn't anymore because there is no guaruntee that we won't be called concurrently from more than one thread. */ m->m_flags &= ~(M_BCAST|M_MCAST); if (!(ifnet_flags(ifp) & IFF_UP) || sc->gif_psrc == NULL || sc->gif_pdst == NULL) { ifnet_touch_lastchange(ifp); m_freem(m); /* free it here not in dlil_output */ error = ENETDOWN; goto end; } bpf_tap_out(ifp, 0, m, &sc->gif_proto, sizeof(sc->gif_proto)); /* inner AF-specific encapsulation */ /* XXX should we check if our outer source is legal? */ /* dispatch to output logic based on outer AF */ switch (sc->gif_psrc->sa_family) { #if INET case AF_INET: error = in_gif_output(ifp, sc->gif_proto, m, NULL); break; #endif #if INET6 case AF_INET6: error = in6_gif_output(ifp, sc->gif_proto, m, NULL); break; #endif default: error = ENETDOWN; goto end; } end: if (error) { /* the mbuf was freed either by in_gif_output or in here */ ifnet_stat_increment_out(ifp, 0, 0, 1); } else { ifnet_stat_increment_out(ifp, 1, m->m_pkthdr.len, 0); } if (error == 0) error = EJUSTRETURN; /* if no error, packet got sent already */ return error; } /* * gif_input is the input handler for IP and IPv6 attached to gif */ static errno_t gif_input( ifnet_t ifp, protocol_family_t protocol_family, mbuf_t m, __unused char *frame_header) { errno_t error; struct gif_softc *sc = ifnet_softc(ifp); bpf_tap_in(ifp, 0, m, &sc->gif_proto, sizeof(sc->gif_proto)); /* * Put the packet to the network layer input queue according to the * specified address family. * Note: older versions of gif_input directly called network layer * input functions, e.g. ip6_input, here. We changed the policy to * prevent too many recursive calls of such input functions, which * might cause kernel panic. But the change may introduce another * problem; if the input queue is full, packets are discarded. * We believed it rarely occurs and changed the policy. If we find * it occurs more times than we thought, we may change the policy * again. */ error = proto_input(protocol_family, m); ifnet_stat_increment_in(ifp, 1, m->m_pkthdr.len, 0); return (0); } /* XXX how should we handle IPv6 scope on SIOC[GS]IFPHYADDR? */ static errno_t gif_ioctl( ifnet_t ifp, u_int32_t cmd, void *data) { struct gif_softc *sc = ifnet_softc(ifp); struct ifreq *ifr = (struct ifreq*)data; int error = 0, size; struct sockaddr *dst = NULL, *src = NULL; struct sockaddr *sa; struct ifnet *ifp2; struct gif_softc *sc2; switch (cmd) { case SIOCSIFADDR: break; case SIOCSIFDSTADDR: break; case SIOCADDMULTI: case SIOCDELMULTI: break; #ifdef SIOCSIFMTU /* xxx */ case SIOCGIFMTU: break; case SIOCSIFMTU: { u_long mtu; mtu = ifr->ifr_mtu; if (mtu < GIF_MTU_MIN || mtu > GIF_MTU_MAX) { return (EINVAL); } ifnet_set_mtu(ifp, mtu); } break; #endif /* SIOCSIFMTU */ case SIOCSIFPHYADDR: #if INET6 case SIOCSIFPHYADDR_IN6: #endif /* INET6 */ case SIOCSLIFPHYADDR: switch (cmd) { #if INET case SIOCSIFPHYADDR: src = (struct sockaddr *) &(((struct in_aliasreq *)data)->ifra_addr); dst = (struct sockaddr *) &(((struct in_aliasreq *)data)->ifra_dstaddr); break; #endif #if INET6 case SIOCSIFPHYADDR_IN6: src = (struct sockaddr *) &(((struct in6_aliasreq *)data)->ifra_addr); dst = (struct sockaddr *) &(((struct in6_aliasreq *)data)->ifra_dstaddr); break; #endif case SIOCSLIFPHYADDR: src = (struct sockaddr *) &(((struct if_laddrreq *)data)->addr); dst = (struct sockaddr *) &(((struct if_laddrreq *)data)->dstaddr); } /* sa_family must be equal */ if (src->sa_family != dst->sa_family) return EINVAL; /* validate sa_len */ switch (src->sa_family) { #if INET case AF_INET: if (src->sa_len != sizeof(struct sockaddr_in)) return EINVAL; break; #endif #if INET6 case AF_INET6: if (src->sa_len != sizeof(struct sockaddr_in6)) return EINVAL; break; #endif default: return EAFNOSUPPORT; } switch (dst->sa_family) { #if INET case AF_INET: if (dst->sa_len != sizeof(struct sockaddr_in)) return EINVAL; break; #endif #if INET6 case AF_INET6: if (dst->sa_len != sizeof(struct sockaddr_in6)) return EINVAL; break; #endif default: return EAFNOSUPPORT; } /* check sa_family looks sane for the cmd */ switch (cmd) { case SIOCSIFPHYADDR: if (src->sa_family == AF_INET) break; return EAFNOSUPPORT; #if INET6 case SIOCSIFPHYADDR_IN6: if (src->sa_family == AF_INET6) break; return EAFNOSUPPORT; #endif /* INET6 */ case SIOCSLIFPHYADDR: /* checks done in the above */ break; } ifnet_head_lock_shared(); TAILQ_FOREACH(ifp2, &ifnet_head, if_link) { if (strcmp(ifnet_name(ifp2), GIFNAME) != 0) continue; sc2 = ifnet_softc(ifp2); if (sc2 == sc) continue; if (!sc2->gif_pdst || !sc2->gif_psrc) continue; if (sc2->gif_pdst->sa_family != dst->sa_family || sc2->gif_pdst->sa_len != dst->sa_len || sc2->gif_psrc->sa_family != src->sa_family || sc2->gif_psrc->sa_len != src->sa_len) continue; #ifndef XBONEHACK /* can't configure same pair of address onto two gifs */ if (bcmp(sc2->gif_pdst, dst, dst->sa_len) == 0 && bcmp(sc2->gif_psrc, src, src->sa_len) == 0) { error = EADDRNOTAVAIL; ifnet_head_done(); goto bad; } #endif /* can't configure multiple multi-dest interfaces */ #define multidest(x) \ (((struct sockaddr_in *)(x))->sin_addr.s_addr == INADDR_ANY) #if INET6 #define multidest6(x) \ (IN6_IS_ADDR_UNSPECIFIED(&((struct sockaddr_in6 *)(x))->sin6_addr)) #endif if (dst->sa_family == AF_INET && multidest(dst) && multidest(sc2->gif_pdst)) { error = EADDRNOTAVAIL; ifnet_head_done(); goto bad; } #if INET6 if (dst->sa_family == AF_INET6 && multidest6(dst) && multidest6(sc2->gif_pdst)) { error = EADDRNOTAVAIL; ifnet_head_done(); goto bad; } #endif } ifnet_head_done(); if (sc->gif_psrc) FREE((caddr_t)sc->gif_psrc, M_IFADDR); sa = (struct sockaddr *)_MALLOC(src->sa_len, M_IFADDR, M_WAITOK); bcopy((caddr_t)src, (caddr_t)sa, src->sa_len); sc->gif_psrc = sa; if (sc->gif_pdst) FREE((caddr_t)sc->gif_pdst, M_IFADDR); sa = (struct sockaddr *)_MALLOC(dst->sa_len, M_IFADDR, M_WAITOK); bcopy((caddr_t)dst, (caddr_t)sa, dst->sa_len); sc->gif_pdst = sa; ifnet_set_flags(ifp, IFF_RUNNING | IFF_UP, IFF_RUNNING | IFF_UP); #ifdef __APPLE__ /* Make sure at least one unused device is still available */ gif_create_dev(); #endif error = 0; break; #ifdef SIOCDIFPHYADDR case SIOCDIFPHYADDR: if (sc->gif_psrc) { FREE((caddr_t)sc->gif_psrc, M_IFADDR); sc->gif_psrc = NULL; } if (sc->gif_pdst) { FREE((caddr_t)sc->gif_pdst, M_IFADDR); sc->gif_pdst = NULL; } /* change the IFF_{UP, RUNNING} flag as well? */ break; #endif case SIOCGIFPSRCADDR: #if INET6 case SIOCGIFPSRCADDR_IN6: #endif /* INET6 */ if (sc->gif_psrc == NULL) { error = EADDRNOTAVAIL; goto bad; } src = sc->gif_psrc; switch (cmd) { #if INET case SIOCGIFPSRCADDR: dst = &ifr->ifr_addr; size = sizeof(ifr->ifr_addr); break; #endif /* INET */ #if INET6 case SIOCGIFPSRCADDR_IN6: dst = (struct sockaddr *) &(((struct in6_ifreq *)data)->ifr_addr); size = sizeof(((struct in6_ifreq *)data)->ifr_addr); break; #endif /* INET6 */ default: error = EADDRNOTAVAIL; goto bad; } if (src->sa_len > size) return EINVAL; bcopy((caddr_t)src, (caddr_t)dst, src->sa_len); break; case SIOCGIFPDSTADDR: #if INET6 case SIOCGIFPDSTADDR_IN6: #endif /* INET6 */ if (sc->gif_pdst == NULL) { error = EADDRNOTAVAIL; goto bad; } src = sc->gif_pdst; switch (cmd) { #if INET case SIOCGIFPDSTADDR: dst = &ifr->ifr_addr; size = sizeof(ifr->ifr_addr); break; #endif /* INET */ #if INET6 case SIOCGIFPDSTADDR_IN6: dst = (struct sockaddr *) &(((struct in6_ifreq *)data)->ifr_addr); size = sizeof(((struct in6_ifreq *)data)->ifr_addr); break; #endif /* INET6 */ default: error = EADDRNOTAVAIL; goto bad; } if (src->sa_len > size) return EINVAL; bcopy((caddr_t)src, (caddr_t)dst, src->sa_len); break; case SIOCGLIFPHYADDR: if (sc->gif_psrc == NULL || sc->gif_pdst == NULL) { error = EADDRNOTAVAIL; goto bad; } /* copy src */ src = sc->gif_psrc; dst = (struct sockaddr *) &(((struct if_laddrreq *)data)->addr); size = sizeof(((struct if_laddrreq *)data)->addr); if (src->sa_len > size) return EINVAL; bcopy((caddr_t)src, (caddr_t)dst, src->sa_len); /* copy dst */ src = sc->gif_pdst; dst = (struct sockaddr *) &(((struct if_laddrreq *)data)->dstaddr); size = sizeof(((struct if_laddrreq *)data)->dstaddr); if (src->sa_len > size) return EINVAL; bcopy((caddr_t)src, (caddr_t)dst, src->sa_len); break; case SIOCSIFFLAGS: /* if_ioctl() takes care of it */ break; default: error = EOPNOTSUPP; break; } bad: return error; } #ifndef __APPLE__ /* This function is not used in our stack */ void gif_delete_tunnel(sc) struct gif_softc *sc; { /* XXX: NetBSD protects this function with splsoftnet() */ if (sc->gif_psrc) { FREE((caddr_t)sc->gif_psrc, M_IFADDR); sc->gif_psrc = NULL; } if (sc->gif_pdst) { FREE((caddr_t)sc->gif_pdst, M_IFADDR); sc->gif_pdst = NULL; } /* change the IFF_UP flag as well? */ } #endif