2 * Copyright (c) 2006 The FreeBSD Project.
3 * Copyright (c) 2015 Andrey V. Elsukov <ae@FreeBSD.org>
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 #include "opt_inet6.h"
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/hhook.h>
37 #include <sys/kernel.h>
38 #include <sys/malloc.h>
40 #include <sys/module.h>
41 #include <machine/bus.h>
43 #include <sys/socket.h>
44 #include <sys/sockio.h>
45 #include <sys/sysctl.h>
48 #include <net/if_enc.h>
49 #include <net/if_var.h>
50 #include <net/if_clone.h>
51 #include <net/if_types.h>
53 #include <net/route.h>
54 #include <net/netisr.h>
58 #include <netinet/in.h>
59 #include <netinet/in_systm.h>
60 #include <netinet/ip.h>
61 #include <netinet/ip_var.h>
62 #include <netinet/in_var.h>
65 #include <netinet/ip6.h>
66 #include <netinet6/ip6_var.h>
69 #include <netipsec/ipsec.h>
70 #include <netipsec/xform.h>
72 #define ENCMTU (1024+512)
74 /* XXX this define must have the same value as in OpenBSD */
75 #define M_CONF 0x0400 /* payload was encrypted (ESP-transport) */
76 #define M_AUTH 0x0800 /* payload was authenticated (AH or ESP auth) */
77 #define M_AUTH_AH 0x2000 /* header was authenticated (AH) */
87 static VNET_DEFINE(struct enc_softc *, enc_sc);
88 #define V_enc_sc VNET(enc_sc)
89 static VNET_DEFINE(struct if_clone *, enc_cloner);
90 #define V_enc_cloner VNET(enc_cloner)
92 static int enc_ioctl(struct ifnet *, u_long, caddr_t);
93 static int enc_output(struct ifnet *, struct mbuf *,
94 const struct sockaddr *, struct route *);
95 static int enc_clone_create(struct if_clone *, int, caddr_t);
96 static void enc_clone_destroy(struct ifnet *);
97 static int enc_add_hhooks(struct enc_softc *);
98 static void enc_remove_hhooks(struct enc_softc *);
100 static const char encname[] = "enc";
103 * Before and after are relative to when we are stripping the
106 static VNET_DEFINE(int, filter_mask_in) = IPSEC_ENC_BEFORE;
107 static VNET_DEFINE(int, bpf_mask_in) = IPSEC_ENC_BEFORE;
108 static VNET_DEFINE(int, filter_mask_out) = IPSEC_ENC_BEFORE;
109 static VNET_DEFINE(int, bpf_mask_out) = IPSEC_ENC_BEFORE | IPSEC_ENC_AFTER;
110 #define V_filter_mask_in VNET(filter_mask_in)
111 #define V_bpf_mask_in VNET(bpf_mask_in)
112 #define V_filter_mask_out VNET(filter_mask_out)
113 #define V_bpf_mask_out VNET(bpf_mask_out)
115 static SYSCTL_NODE(_net, OID_AUTO, enc, CTLFLAG_RW, 0, "enc sysctl");
116 static SYSCTL_NODE(_net_enc, OID_AUTO, in, CTLFLAG_RW, 0, "enc input sysctl");
117 static SYSCTL_NODE(_net_enc, OID_AUTO, out, CTLFLAG_RW, 0, "enc output sysctl");
118 SYSCTL_INT(_net_enc_in, OID_AUTO, ipsec_filter_mask,
119 CTLFLAG_RW | CTLFLAG_VNET, &VNET_NAME(filter_mask_in), 0,
120 "IPsec input firewall filter mask");
121 SYSCTL_INT(_net_enc_in, OID_AUTO, ipsec_bpf_mask,
122 CTLFLAG_RW | CTLFLAG_VNET, &VNET_NAME(bpf_mask_in), 0,
123 "IPsec input bpf mask");
124 SYSCTL_INT(_net_enc_out, OID_AUTO, ipsec_filter_mask,
125 CTLFLAG_RW | CTLFLAG_VNET, &VNET_NAME(filter_mask_out), 0,
126 "IPsec output firewall filter mask");
127 SYSCTL_INT(_net_enc_out, OID_AUTO, ipsec_bpf_mask,
128 CTLFLAG_RW | CTLFLAG_VNET, &VNET_NAME(bpf_mask_out), 0,
129 "IPsec output bpf mask");
132 enc_clone_destroy(struct ifnet *ifp)
134 struct enc_softc *sc;
137 KASSERT(sc == V_enc_sc, ("sc != ifp->if_softc"));
147 enc_clone_create(struct if_clone *ifc, int unit, caddr_t params)
150 struct enc_softc *sc;
152 sc = malloc(sizeof(struct enc_softc), M_DEVBUF,
154 ifp = sc->sc_ifp = if_alloc(IFT_ENC);
159 if (V_enc_sc != NULL) {
165 if_initname(ifp, encname, unit);
166 ifp->if_mtu = ENCMTU;
167 ifp->if_ioctl = enc_ioctl;
168 ifp->if_output = enc_output;
171 bpfattach(ifp, DLT_ENC, sizeof(struct enchdr));
176 enc_output(struct ifnet *ifp, struct mbuf *m, const struct sockaddr *dst,
185 enc_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data)
188 if (cmd != SIOCSIFFLAGS)
190 if (ifp->if_flags & IFF_UP)
191 ifp->if_drv_flags |= IFF_DRV_RUNNING;
193 ifp->if_drv_flags &= ~IFF_DRV_RUNNING;
198 * One helper hook function is used by any hook points.
199 * + from hhook_type we can determine the packet direction:
200 * HHOOK_TYPE_IPSEC_IN or HHOOK_TYPE_IPSEC_OUT;
201 * + from hhook_id we can determine address family: AF_INET or AF_INET6;
202 * + udata contains pointer to enc_softc;
203 * + ctx_data contains pointer to struct ipsec_ctx_data.
206 enc_hhook(int32_t hhook_type, int32_t hhook_id, void *udata, void *ctx_data,
207 void *hdata, struct osd *hosd)
210 struct ipsec_ctx_data *ctx;
211 struct enc_softc *sc;
212 struct ifnet *ifp, *rcvif;
213 struct pfil_head *ph;
216 sc = (struct enc_softc *)udata;
218 if ((ifp->if_flags & IFF_UP) == 0)
221 ctx = (struct ipsec_ctx_data *)ctx_data;
222 /* XXX: wrong hook point was used by caller? */
223 if (ctx->af != hhook_id)
224 return (EPFNOSUPPORT);
226 if (((hhook_type == HHOOK_TYPE_IPSEC_IN &&
227 (ctx->enc & V_bpf_mask_in) != 0) ||
228 (hhook_type == HHOOK_TYPE_IPSEC_OUT &&
229 (ctx->enc & V_bpf_mask_out) != 0)) &&
230 bpf_peers_present(ifp->if_bpf) != 0) {
232 hdr.spi = ctx->sav->spi;
234 if (ctx->sav->alg_enc != SADB_EALG_NONE)
236 if (ctx->sav->alg_auth != SADB_AALG_NONE)
238 bpf_mtap2(ifp->if_bpf, &hdr, sizeof(hdr), *ctx->mp);
241 switch (hhook_type) {
242 case HHOOK_TYPE_IPSEC_IN:
243 if (ctx->enc == IPSEC_ENC_BEFORE) {
244 /* Do accounting only once */
245 if_inc_counter(ifp, IFCOUNTER_IPACKETS, 1);
246 if_inc_counter(ifp, IFCOUNTER_IBYTES,
247 (*ctx->mp)->m_pkthdr.len);
249 if ((ctx->enc & V_filter_mask_in) == 0)
250 return (0); /* skip pfil processing */
253 case HHOOK_TYPE_IPSEC_OUT:
254 if (ctx->enc == IPSEC_ENC_BEFORE) {
255 /* Do accounting only once */
256 if_inc_counter(ifp, IFCOUNTER_OPACKETS, 1);
257 if_inc_counter(ifp, IFCOUNTER_OBYTES,
258 (*ctx->mp)->m_pkthdr.len);
260 if ((ctx->enc & V_filter_mask_out) == 0)
261 return (0); /* skip pfil processing */
271 ph = &V_inet_pfil_hook;
276 ph = &V_inet6_pfil_hook;
282 if (ph == NULL || !PFIL_HOOKED(ph))
284 /* Make a packet looks like it was received on enc(4) */
285 rcvif = (*ctx->mp)->m_pkthdr.rcvif;
286 (*ctx->mp)->m_pkthdr.rcvif = ifp;
287 if (pfil_run_hooks(ph, ctx->mp, ifp, pdir, ctx->inp) != 0 ||
289 *ctx->mp = NULL; /* consumed by filter */
292 (*ctx->mp)->m_pkthdr.rcvif = rcvif;
297 enc_add_hhooks(struct enc_softc *sc)
302 error = EPFNOSUPPORT;
303 hki.hook_func = enc_hhook;
304 hki.hook_helper = NULL;
307 hki.hook_id = AF_INET;
308 hki.hook_type = HHOOK_TYPE_IPSEC_IN;
309 error = hhook_add_hook(V_ipsec_hhh_in[HHOOK_IPSEC_INET],
313 hki.hook_type = HHOOK_TYPE_IPSEC_OUT;
314 error = hhook_add_hook(V_ipsec_hhh_out[HHOOK_IPSEC_INET],
320 hki.hook_id = AF_INET6;
321 hki.hook_type = HHOOK_TYPE_IPSEC_IN;
322 error = hhook_add_hook(V_ipsec_hhh_in[HHOOK_IPSEC_INET6],
326 hki.hook_type = HHOOK_TYPE_IPSEC_OUT;
327 error = hhook_add_hook(V_ipsec_hhh_out[HHOOK_IPSEC_INET6],
336 enc_remove_hhooks(struct enc_softc *sc)
340 hki.hook_func = enc_hhook;
341 hki.hook_helper = NULL;
344 hki.hook_id = AF_INET;
345 hki.hook_type = HHOOK_TYPE_IPSEC_IN;
346 hhook_remove_hook(V_ipsec_hhh_in[HHOOK_IPSEC_INET], &hki);
347 hki.hook_type = HHOOK_TYPE_IPSEC_OUT;
348 hhook_remove_hook(V_ipsec_hhh_out[HHOOK_IPSEC_INET], &hki);
351 hki.hook_id = AF_INET6;
352 hki.hook_type = HHOOK_TYPE_IPSEC_IN;
353 hhook_remove_hook(V_ipsec_hhh_in[HHOOK_IPSEC_INET6], &hki);
354 hki.hook_type = HHOOK_TYPE_IPSEC_OUT;
355 hhook_remove_hook(V_ipsec_hhh_out[HHOOK_IPSEC_INET6], &hki);
360 vnet_enc_init(const void *unused __unused)
364 V_enc_cloner = if_clone_simple(encname, enc_clone_create,
365 enc_clone_destroy, 1);
367 VNET_SYSINIT(vnet_enc_init, SI_SUB_PSEUDO, SI_ORDER_ANY,
368 vnet_enc_init, NULL);
371 vnet_enc_init_proto(void *unused __unused)
373 KASSERT(V_enc_sc != NULL, ("%s: V_enc_sc is %p\n", __func__, V_enc_sc));
375 if (enc_add_hhooks(V_enc_sc) != 0)
376 enc_clone_destroy(V_enc_sc->sc_ifp);
378 VNET_SYSINIT(vnet_enc_init_proto, SI_SUB_PROTO_IFATTACHDOMAIN, SI_ORDER_ANY,
379 vnet_enc_init_proto, NULL);
382 vnet_enc_uninit(const void *unused __unused)
384 KASSERT(V_enc_sc != NULL, ("%s: V_enc_sc is %p\n", __func__, V_enc_sc));
386 if_clone_detach(V_enc_cloner);
388 VNET_SYSUNINIT(vnet_enc_uninit, SI_SUB_INIT_IF, SI_ORDER_ANY,
389 vnet_enc_uninit, NULL);
392 * The hhook consumer needs to go before ip[6]_destroy are called on
396 vnet_enc_uninit_hhook(const void *unused __unused)
398 KASSERT(V_enc_sc != NULL, ("%s: V_enc_sc is %p\n", __func__, V_enc_sc));
400 enc_remove_hhooks(V_enc_sc);
402 VNET_SYSUNINIT(vnet_enc_uninit_hhook, SI_SUB_PROTO_DOMAIN, SI_ORDER_FOURTH,
403 vnet_enc_uninit_hhook, NULL);
406 enc_modevent(module_t mod, int type, void *data)
419 static moduledata_t enc_mod = {
425 DECLARE_MODULE(if_enc, enc_mod, SI_SUB_PSEUDO, SI_ORDER_ANY);
426 MODULE_VERSION(if_enc, 1);