2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (c) 2006 The FreeBSD Project.
5 * Copyright (c) 2015 Andrey V. Elsukov <ae@FreeBSD.org>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 #include "opt_inet6.h"
33 #include "opt_ipsec.h"
35 #include <sys/param.h>
36 #include <sys/systm.h>
37 #include <sys/hhook.h>
38 #include <sys/kernel.h>
39 #include <sys/malloc.h>
41 #include <sys/module.h>
42 #include <machine/bus.h>
44 #include <sys/socket.h>
45 #include <sys/sockio.h>
46 #include <sys/sysctl.h>
49 #include <net/if_enc.h>
50 #include <net/if_var.h>
51 #include <net/if_private.h>
52 #include <net/if_clone.h>
53 #include <net/if_types.h>
55 #include <net/route.h>
56 #include <net/netisr.h>
60 #include <netinet/in.h>
61 #include <netinet/in_systm.h>
62 #include <netinet/ip.h>
63 #include <netinet/ip_var.h>
64 #include <netinet/in_var.h>
67 #include <netinet/ip6.h>
68 #include <netinet6/ip6_var.h>
71 #include <netipsec/ipsec.h>
72 #include <netipsec/xform.h>
74 #define ENCMTU (1024+512)
76 /* XXX this define must have the same value as in OpenBSD */
77 #define M_CONF 0x0400 /* payload was encrypted (ESP-transport) */
78 #define M_AUTH 0x0800 /* payload was authenticated (AH or ESP auth) */
79 #define M_AUTH_AH 0x2000 /* header was authenticated (AH) */
89 VNET_DEFINE_STATIC(struct enc_softc *, enc_sc);
90 #define V_enc_sc VNET(enc_sc)
91 VNET_DEFINE_STATIC(struct if_clone *, enc_cloner);
92 #define V_enc_cloner VNET(enc_cloner)
94 static int enc_ioctl(struct ifnet *, u_long, caddr_t);
95 static int enc_output(struct ifnet *, struct mbuf *,
96 const struct sockaddr *, struct route *);
97 static int enc_clone_create(struct if_clone *, int, caddr_t);
98 static void enc_clone_destroy(struct ifnet *);
99 static int enc_add_hhooks(struct enc_softc *);
100 static void enc_remove_hhooks(struct enc_softc *);
102 static const char encname[] = "enc";
104 #define IPSEC_ENC_AFTER_PFIL 0x04
106 * Before and after are relative to when we are stripping the
109 * AFTER_PFIL flag used only for bpf_mask_*. It enables BPF capturing
110 * after PFIL hook execution. It might be useful when PFIL hook does
111 * some changes to the packet, e.g. address translation. If PFIL hook
112 * consumes mbuf, nothing will be captured.
114 VNET_DEFINE_STATIC(int, filter_mask_in) = IPSEC_ENC_BEFORE;
115 VNET_DEFINE_STATIC(int, bpf_mask_in) = IPSEC_ENC_BEFORE;
116 VNET_DEFINE_STATIC(int, filter_mask_out) = IPSEC_ENC_BEFORE;
117 VNET_DEFINE_STATIC(int, bpf_mask_out) = IPSEC_ENC_BEFORE | IPSEC_ENC_AFTER;
118 #define V_filter_mask_in VNET(filter_mask_in)
119 #define V_bpf_mask_in VNET(bpf_mask_in)
120 #define V_filter_mask_out VNET(filter_mask_out)
121 #define V_bpf_mask_out VNET(bpf_mask_out)
123 static SYSCTL_NODE(_net, OID_AUTO, enc, CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
125 static SYSCTL_NODE(_net_enc, OID_AUTO, in, CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
127 static SYSCTL_NODE(_net_enc, OID_AUTO, out, CTLFLAG_RW | CTLFLAG_MPSAFE, 0,
128 "enc output sysctl");
129 SYSCTL_INT(_net_enc_in, OID_AUTO, ipsec_filter_mask,
130 CTLFLAG_RW | CTLFLAG_VNET, &VNET_NAME(filter_mask_in), 0,
131 "IPsec input firewall filter mask");
132 SYSCTL_INT(_net_enc_in, OID_AUTO, ipsec_bpf_mask,
133 CTLFLAG_RW | CTLFLAG_VNET, &VNET_NAME(bpf_mask_in), 0,
134 "IPsec input bpf mask");
135 SYSCTL_INT(_net_enc_out, OID_AUTO, ipsec_filter_mask,
136 CTLFLAG_RW | CTLFLAG_VNET, &VNET_NAME(filter_mask_out), 0,
137 "IPsec output firewall filter mask");
138 SYSCTL_INT(_net_enc_out, OID_AUTO, ipsec_bpf_mask,
139 CTLFLAG_RW | CTLFLAG_VNET, &VNET_NAME(bpf_mask_out), 0,
140 "IPsec output bpf mask");
143 enc_clone_destroy(struct ifnet *ifp)
145 struct enc_softc *sc;
148 KASSERT(sc == V_enc_sc, ("sc != ifp->if_softc"));
158 enc_clone_create(struct if_clone *ifc, int unit, caddr_t params)
161 struct enc_softc *sc;
163 sc = malloc(sizeof(struct enc_softc), M_DEVBUF,
165 ifp = sc->sc_ifp = if_alloc(IFT_ENC);
170 if (V_enc_sc != NULL) {
176 if_initname(ifp, encname, unit);
177 ifp->if_mtu = ENCMTU;
178 ifp->if_ioctl = enc_ioctl;
179 ifp->if_output = enc_output;
182 bpfattach(ifp, DLT_ENC, sizeof(struct enchdr));
187 enc_output(struct ifnet *ifp, struct mbuf *m, const struct sockaddr *dst,
196 enc_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data)
199 if (cmd != SIOCSIFFLAGS)
201 if (ifp->if_flags & IFF_UP)
202 ifp->if_drv_flags |= IFF_DRV_RUNNING;
204 ifp->if_drv_flags &= ~IFF_DRV_RUNNING;
209 enc_bpftap(struct ifnet *ifp, struct mbuf *m, const struct secasvar *sav,
210 int32_t hhook_type, uint8_t enc, uint8_t af)
214 if (hhook_type == HHOOK_TYPE_IPSEC_IN &&
215 (enc & V_bpf_mask_in) == 0)
217 else if (hhook_type == HHOOK_TYPE_IPSEC_OUT &&
218 (enc & V_bpf_mask_out) == 0)
220 if (bpf_peers_present(ifp->if_bpf) == 0)
225 if (sav->alg_enc != SADB_EALG_NONE)
227 if (sav->alg_auth != SADB_AALG_NONE)
229 bpf_mtap2(ifp->if_bpf, &hdr, sizeof(hdr), m);
233 * One helper hook function is used by any hook points.
234 * + from hhook_type we can determine the packet direction:
235 * HHOOK_TYPE_IPSEC_IN or HHOOK_TYPE_IPSEC_OUT;
236 * + from hhook_id we can determine address family: AF_INET or AF_INET6;
237 * + udata contains pointer to enc_softc;
238 * + ctx_data contains pointer to struct ipsec_ctx_data.
241 enc_hhook(int32_t hhook_type, int32_t hhook_id, void *udata, void *ctx_data,
242 void *hdata, struct osd *hosd)
244 struct ipsec_ctx_data *ctx;
245 struct enc_softc *sc;
246 struct ifnet *ifp, *rcvif;
247 struct pfil_head *ph;
250 sc = (struct enc_softc *)udata;
252 if ((ifp->if_flags & IFF_UP) == 0)
255 ctx = (struct ipsec_ctx_data *)ctx_data;
256 /* XXX: wrong hook point was used by caller? */
257 if (ctx->af != hhook_id)
258 return (EPFNOSUPPORT);
260 enc_bpftap(ifp, *ctx->mp, ctx->sav, hhook_type, ctx->enc, ctx->af);
261 switch (hhook_type) {
262 case HHOOK_TYPE_IPSEC_IN:
263 if (ctx->enc == IPSEC_ENC_BEFORE) {
264 /* Do accounting only once */
265 if_inc_counter(ifp, IFCOUNTER_IPACKETS, 1);
266 if_inc_counter(ifp, IFCOUNTER_IBYTES,
267 (*ctx->mp)->m_pkthdr.len);
269 if ((ctx->enc & V_filter_mask_in) == 0)
270 return (0); /* skip pfil processing */
273 case HHOOK_TYPE_IPSEC_OUT:
274 if (ctx->enc == IPSEC_ENC_BEFORE) {
275 /* Do accounting only once */
276 if_inc_counter(ifp, IFCOUNTER_OPACKETS, 1);
277 if_inc_counter(ifp, IFCOUNTER_OBYTES,
278 (*ctx->mp)->m_pkthdr.len);
280 if ((ctx->enc & V_filter_mask_out) == 0)
281 return (0); /* skip pfil processing */
291 ph = V_inet_pfil_head;
296 ph = V_inet6_pfil_head;
302 if (ph == NULL || (pdir == PFIL_OUT && !PFIL_HOOKED_OUT(ph)) ||
303 (pdir == PFIL_IN && !PFIL_HOOKED_IN(ph)))
305 /* Make a packet looks like it was received on enc(4) */
306 rcvif = (*ctx->mp)->m_pkthdr.rcvif;
307 (*ctx->mp)->m_pkthdr.rcvif = ifp;
309 ret = pfil_mbuf_in(ph, ctx->mp, ifp, ctx->inp);
311 ret = pfil_mbuf_out(ph, ctx->mp, ifp, ctx->inp);
312 if (ret != PFIL_PASS) {
313 *ctx->mp = NULL; /* consumed by filter */
316 (*ctx->mp)->m_pkthdr.rcvif = rcvif;
317 enc_bpftap(ifp, *ctx->mp, ctx->sav, hhook_type,
318 IPSEC_ENC_AFTER_PFIL, ctx->af);
323 enc_add_hhooks(struct enc_softc *sc)
328 error = EPFNOSUPPORT;
329 hki.hook_func = enc_hhook;
330 hki.hook_helper = NULL;
333 hki.hook_id = AF_INET;
334 hki.hook_type = HHOOK_TYPE_IPSEC_IN;
335 error = hhook_add_hook(V_ipsec_hhh_in[HHOOK_IPSEC_INET],
339 hki.hook_type = HHOOK_TYPE_IPSEC_OUT;
340 error = hhook_add_hook(V_ipsec_hhh_out[HHOOK_IPSEC_INET],
346 hki.hook_id = AF_INET6;
347 hki.hook_type = HHOOK_TYPE_IPSEC_IN;
348 error = hhook_add_hook(V_ipsec_hhh_in[HHOOK_IPSEC_INET6],
352 hki.hook_type = HHOOK_TYPE_IPSEC_OUT;
353 error = hhook_add_hook(V_ipsec_hhh_out[HHOOK_IPSEC_INET6],
362 enc_remove_hhooks(struct enc_softc *sc)
366 hki.hook_func = enc_hhook;
367 hki.hook_helper = NULL;
370 hki.hook_id = AF_INET;
371 hki.hook_type = HHOOK_TYPE_IPSEC_IN;
372 hhook_remove_hook(V_ipsec_hhh_in[HHOOK_IPSEC_INET], &hki);
373 hki.hook_type = HHOOK_TYPE_IPSEC_OUT;
374 hhook_remove_hook(V_ipsec_hhh_out[HHOOK_IPSEC_INET], &hki);
377 hki.hook_id = AF_INET6;
378 hki.hook_type = HHOOK_TYPE_IPSEC_IN;
379 hhook_remove_hook(V_ipsec_hhh_in[HHOOK_IPSEC_INET6], &hki);
380 hki.hook_type = HHOOK_TYPE_IPSEC_OUT;
381 hhook_remove_hook(V_ipsec_hhh_out[HHOOK_IPSEC_INET6], &hki);
386 vnet_enc_init(const void *unused __unused)
390 V_enc_cloner = if_clone_simple(encname, enc_clone_create,
391 enc_clone_destroy, 1);
393 VNET_SYSINIT(vnet_enc_init, SI_SUB_PSEUDO, SI_ORDER_ANY,
394 vnet_enc_init, NULL);
397 vnet_enc_init_proto(void *unused __unused)
399 KASSERT(V_enc_sc != NULL, ("%s: V_enc_sc is %p\n", __func__, V_enc_sc));
401 if (enc_add_hhooks(V_enc_sc) != 0)
402 enc_clone_destroy(V_enc_sc->sc_ifp);
404 VNET_SYSINIT(vnet_enc_init_proto, SI_SUB_PROTO_IFATTACHDOMAIN, SI_ORDER_ANY,
405 vnet_enc_init_proto, NULL);
408 vnet_enc_uninit(const void *unused __unused)
410 KASSERT(V_enc_sc != NULL, ("%s: V_enc_sc is %p\n", __func__, V_enc_sc));
412 if_clone_detach(V_enc_cloner);
414 VNET_SYSUNINIT(vnet_enc_uninit, SI_SUB_INIT_IF, SI_ORDER_ANY,
415 vnet_enc_uninit, NULL);
418 * The hhook consumer needs to go before ip[6]_destroy are called on
422 vnet_enc_uninit_hhook(const void *unused __unused)
424 KASSERT(V_enc_sc != NULL, ("%s: V_enc_sc is %p\n", __func__, V_enc_sc));
426 enc_remove_hhooks(V_enc_sc);
428 VNET_SYSUNINIT(vnet_enc_uninit_hhook, SI_SUB_PROTO_DOMAIN, SI_ORDER_FOURTH,
429 vnet_enc_uninit_hhook, NULL);
432 enc_modevent(module_t mod, int type, void *data)
445 static moduledata_t enc_mod = {
451 DECLARE_MODULE(if_enc, enc_mod, SI_SUB_PSEUDO, SI_ORDER_ANY);
452 MODULE_VERSION(if_enc, 1);