1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2006 The FreeBSD Project. 5 * Copyright (c) 2015 Andrey V. Elsukov <ae@FreeBSD.org> 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 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 * 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 28 * SUCH DAMAGE. 29 */ 30 31 #include "opt_inet.h" 32 #include "opt_inet6.h" 33 #include "opt_ipsec.h" 34 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> 40 #include <sys/mbuf.h> 41 #include <sys/module.h> 42 #include <machine/bus.h> 43 #include <sys/rman.h> 44 #include <sys/socket.h> 45 #include <sys/sockio.h> 46 #include <sys/sysctl.h> 47 48 #include <net/if.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> 54 #include <net/pfil.h> 55 #include <net/route.h> 56 #include <net/netisr.h> 57 #include <net/bpf.h> 58 #include <net/vnet.h> 59 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> 65 66 #ifdef INET6 67 #include <netinet/ip6.h> 68 #include <netinet6/ip6_var.h> 69 #endif 70 71 #include <netipsec/ipsec.h> 72 #include <netipsec/xform.h> 73 74 #define ENCMTU (1024+512) 75 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) */ 80 81 struct enchdr { 82 u_int32_t af; 83 u_int32_t spi; 84 u_int32_t flags; 85 }; 86 struct enc_softc { 87 struct ifnet *sc_ifp; 88 }; 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) 93 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 void enc_add_hhooks(struct enc_softc *); 100 static void enc_remove_hhooks(struct enc_softc *); 101 102 static const char encname[] = "enc"; 103 104 #define IPSEC_ENC_AFTER_PFIL 0x04 105 /* 106 * Before and after are relative to when we are stripping the 107 * outer IP header. 108 * 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. 113 */ 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) 122 123 static SYSCTL_NODE(_net, OID_AUTO, enc, CTLFLAG_RW | CTLFLAG_MPSAFE, 0, 124 "enc sysctl"); 125 static SYSCTL_NODE(_net_enc, OID_AUTO, in, CTLFLAG_RW | CTLFLAG_MPSAFE, 0, 126 "enc input sysctl"); 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"); 141 142 static void 143 enc_clone_destroy(struct ifnet *ifp) 144 { 145 struct enc_softc *sc; 146 147 sc = ifp->if_softc; 148 KASSERT(sc == V_enc_sc, ("sc != ifp->if_softc")); 149 150 bpfdetach(ifp); 151 if_detach(ifp); 152 if_free(ifp); 153 free(sc, M_DEVBUF); 154 V_enc_sc = NULL; 155 } 156 157 static int 158 enc_clone_create(struct if_clone *ifc, int unit, caddr_t params) 159 { 160 struct ifnet *ifp; 161 struct enc_softc *sc; 162 163 sc = malloc(sizeof(struct enc_softc), M_DEVBUF, 164 M_WAITOK | M_ZERO); 165 ifp = sc->sc_ifp = if_alloc(IFT_ENC); 166 if (V_enc_sc != NULL) { 167 if_free(ifp); 168 free(sc, M_DEVBUF); 169 return (EEXIST); 170 } 171 V_enc_sc = sc; 172 if_initname(ifp, encname, unit); 173 ifp->if_mtu = ENCMTU; 174 ifp->if_ioctl = enc_ioctl; 175 ifp->if_output = enc_output; 176 ifp->if_softc = sc; 177 if_attach(ifp); 178 bpfattach(ifp, DLT_ENC, sizeof(struct enchdr)); 179 return (0); 180 } 181 182 static int 183 enc_output(struct ifnet *ifp, struct mbuf *m, const struct sockaddr *dst, 184 struct route *ro) 185 { 186 187 m_freem(m); 188 return (0); 189 } 190 191 static int 192 enc_ioctl(struct ifnet *ifp, u_long cmd, caddr_t data) 193 { 194 195 if (cmd != SIOCSIFFLAGS) 196 return (EINVAL); 197 if (ifp->if_flags & IFF_UP) 198 ifp->if_drv_flags |= IFF_DRV_RUNNING; 199 else 200 ifp->if_drv_flags &= ~IFF_DRV_RUNNING; 201 return (0); 202 } 203 204 static void 205 enc_bpftap(struct ifnet *ifp, struct mbuf *m, const struct secasvar *sav, 206 int32_t hhook_type, uint8_t enc, uint8_t af) 207 { 208 struct enchdr hdr; 209 210 if (hhook_type == HHOOK_TYPE_IPSEC_IN && 211 (enc & V_bpf_mask_in) == 0) 212 return; 213 else if (hhook_type == HHOOK_TYPE_IPSEC_OUT && 214 (enc & V_bpf_mask_out) == 0) 215 return; 216 if (!bpf_peers_present(ifp->if_bpf)) 217 return; 218 hdr.af = af; 219 hdr.spi = sav->spi; 220 hdr.flags = 0; 221 if (sav->alg_enc != SADB_EALG_NONE) 222 hdr.flags |= M_CONF; 223 if (sav->alg_auth != SADB_AALG_NONE) 224 hdr.flags |= M_AUTH; 225 bpf_mtap2(ifp->if_bpf, &hdr, sizeof(hdr), m); 226 } 227 228 /* 229 * One helper hook function is used by any hook points. 230 * + from hhook_type we can determine the packet direction: 231 * HHOOK_TYPE_IPSEC_IN or HHOOK_TYPE_IPSEC_OUT; 232 * + from hhook_id we can determine address family: AF_INET or AF_INET6; 233 * + udata contains pointer to enc_softc; 234 * + ctx_data contains pointer to struct ipsec_ctx_data. 235 */ 236 static int 237 enc_hhook(int32_t hhook_type, int32_t hhook_id, void *udata, void *ctx_data, 238 void *hdata, struct osd *hosd) 239 { 240 struct ipsec_ctx_data *ctx; 241 struct enc_softc *sc; 242 struct ifnet *ifp, *rcvif; 243 struct pfil_head *ph; 244 int pdir, ret; 245 246 sc = (struct enc_softc *)udata; 247 ifp = sc->sc_ifp; 248 if ((ifp->if_flags & IFF_UP) == 0) 249 return (0); 250 251 ctx = (struct ipsec_ctx_data *)ctx_data; 252 /* XXX: wrong hook point was used by caller? */ 253 if (ctx->af != hhook_id) 254 return (EPFNOSUPPORT); 255 256 enc_bpftap(ifp, *ctx->mp, ctx->sav, hhook_type, ctx->enc, ctx->af); 257 switch (hhook_type) { 258 case HHOOK_TYPE_IPSEC_IN: 259 if (ctx->enc == IPSEC_ENC_BEFORE) { 260 /* Do accounting only once */ 261 if_inc_counter(ifp, IFCOUNTER_IPACKETS, 1); 262 if_inc_counter(ifp, IFCOUNTER_IBYTES, 263 (*ctx->mp)->m_pkthdr.len); 264 } 265 if ((ctx->enc & V_filter_mask_in) == 0) 266 return (0); /* skip pfil processing */ 267 pdir = PFIL_IN; 268 break; 269 case HHOOK_TYPE_IPSEC_OUT: 270 if (ctx->enc == IPSEC_ENC_BEFORE) { 271 /* Do accounting only once */ 272 if_inc_counter(ifp, IFCOUNTER_OPACKETS, 1); 273 if_inc_counter(ifp, IFCOUNTER_OBYTES, 274 (*ctx->mp)->m_pkthdr.len); 275 } 276 if ((ctx->enc & V_filter_mask_out) == 0) 277 return (0); /* skip pfil processing */ 278 pdir = PFIL_OUT; 279 break; 280 default: 281 return (EINVAL); 282 } 283 284 switch (hhook_id) { 285 #ifdef INET 286 case AF_INET: 287 ph = V_inet_pfil_head; 288 break; 289 #endif 290 #ifdef INET6 291 case AF_INET6: 292 ph = V_inet6_pfil_head; 293 break; 294 #endif 295 default: 296 ph = NULL; 297 } 298 if (ph == NULL || (pdir == PFIL_OUT && !PFIL_HOOKED_OUT(ph)) || 299 (pdir == PFIL_IN && !PFIL_HOOKED_IN(ph))) 300 return (0); 301 /* Make a packet looks like it was received on enc(4) */ 302 rcvif = (*ctx->mp)->m_pkthdr.rcvif; 303 (*ctx->mp)->m_pkthdr.rcvif = ifp; 304 if (pdir == PFIL_IN) 305 ret = pfil_mbuf_in(ph, ctx->mp, ifp, ctx->inp); 306 else 307 ret = pfil_mbuf_out(ph, ctx->mp, ifp, ctx->inp); 308 if (ret != PFIL_PASS) { 309 *ctx->mp = NULL; /* consumed by filter */ 310 return (EACCES); 311 } 312 (*ctx->mp)->m_pkthdr.rcvif = rcvif; 313 enc_bpftap(ifp, *ctx->mp, ctx->sav, hhook_type, 314 IPSEC_ENC_AFTER_PFIL, ctx->af); 315 return (0); 316 } 317 318 static void 319 enc_add_hhooks(struct enc_softc *sc) 320 { 321 struct hookinfo hki; 322 int error __diagused; 323 324 hki.hook_func = enc_hhook; 325 hki.hook_helper = NULL; 326 hki.hook_udata = sc; 327 #ifdef INET 328 hki.hook_id = AF_INET; 329 hki.hook_type = HHOOK_TYPE_IPSEC_IN; 330 error = hhook_add_hook(V_ipsec_hhh_in[HHOOK_IPSEC_INET], 331 &hki, HHOOK_WAITOK); 332 MPASS(error == 0); 333 hki.hook_type = HHOOK_TYPE_IPSEC_OUT; 334 error = hhook_add_hook(V_ipsec_hhh_out[HHOOK_IPSEC_INET], 335 &hki, HHOOK_WAITOK); 336 MPASS(error == 0); 337 #endif 338 #ifdef INET6 339 hki.hook_id = AF_INET6; 340 hki.hook_type = HHOOK_TYPE_IPSEC_IN; 341 error = hhook_add_hook(V_ipsec_hhh_in[HHOOK_IPSEC_INET6], 342 &hki, HHOOK_WAITOK); 343 MPASS(error == 0); 344 hki.hook_type = HHOOK_TYPE_IPSEC_OUT; 345 error = hhook_add_hook(V_ipsec_hhh_out[HHOOK_IPSEC_INET6], 346 &hki, HHOOK_WAITOK); 347 MPASS(error == 0); 348 #endif 349 } 350 351 static void 352 enc_remove_hhooks(struct enc_softc *sc) 353 { 354 struct hookinfo hki; 355 356 hki.hook_func = enc_hhook; 357 hki.hook_helper = NULL; 358 hki.hook_udata = sc; 359 #ifdef INET 360 hki.hook_id = AF_INET; 361 hki.hook_type = HHOOK_TYPE_IPSEC_IN; 362 hhook_remove_hook(V_ipsec_hhh_in[HHOOK_IPSEC_INET], &hki); 363 hki.hook_type = HHOOK_TYPE_IPSEC_OUT; 364 hhook_remove_hook(V_ipsec_hhh_out[HHOOK_IPSEC_INET], &hki); 365 #endif 366 #ifdef INET6 367 hki.hook_id = AF_INET6; 368 hki.hook_type = HHOOK_TYPE_IPSEC_IN; 369 hhook_remove_hook(V_ipsec_hhh_in[HHOOK_IPSEC_INET6], &hki); 370 hki.hook_type = HHOOK_TYPE_IPSEC_OUT; 371 hhook_remove_hook(V_ipsec_hhh_out[HHOOK_IPSEC_INET6], &hki); 372 #endif 373 } 374 375 static void 376 vnet_enc_init(const void *unused __unused) 377 { 378 379 V_enc_sc = NULL; 380 V_enc_cloner = if_clone_simple(encname, enc_clone_create, 381 enc_clone_destroy, 1); 382 } 383 VNET_SYSINIT(vnet_enc_init, SI_SUB_PSEUDO, SI_ORDER_ANY, 384 vnet_enc_init, NULL); 385 386 static void 387 vnet_enc_init_proto(void *unused __unused) 388 { 389 KASSERT(V_enc_sc != NULL, ("%s: V_enc_sc is %p\n", __func__, V_enc_sc)); 390 391 enc_add_hhooks(V_enc_sc); 392 } 393 VNET_SYSINIT(vnet_enc_init_proto, SI_SUB_PROTO_IFATTACHDOMAIN, SI_ORDER_ANY, 394 vnet_enc_init_proto, NULL); 395 396 static void 397 vnet_enc_uninit(const void *unused __unused) 398 { 399 KASSERT(V_enc_sc != NULL, ("%s: V_enc_sc is %p\n", __func__, V_enc_sc)); 400 401 if_clone_detach(V_enc_cloner); 402 } 403 VNET_SYSUNINIT(vnet_enc_uninit, SI_SUB_INIT_IF, SI_ORDER_ANY, 404 vnet_enc_uninit, NULL); 405 406 /* 407 * The hhook consumer needs to go before ip[6]_destroy are called on 408 * SI_ORDER_THIRD. 409 */ 410 static void 411 vnet_enc_uninit_hhook(const void *unused __unused) 412 { 413 KASSERT(V_enc_sc != NULL, ("%s: V_enc_sc is %p\n", __func__, V_enc_sc)); 414 415 enc_remove_hhooks(V_enc_sc); 416 } 417 VNET_SYSUNINIT(vnet_enc_uninit_hhook, SI_SUB_PROTO_DOMAIN, SI_ORDER_FOURTH, 418 vnet_enc_uninit_hhook, NULL); 419 420 static int 421 enc_modevent(module_t mod, int type, void *data) 422 { 423 424 switch (type) { 425 case MOD_LOAD: 426 case MOD_UNLOAD: 427 break; 428 default: 429 return (EOPNOTSUPP); 430 } 431 return (0); 432 } 433 434 static moduledata_t enc_mod = { 435 "if_enc", 436 enc_modevent, 437 0 438 }; 439 440 DECLARE_MODULE(if_enc, enc_mod, SI_SUB_PSEUDO, SI_ORDER_ANY); 441 MODULE_VERSION(if_enc, 1); 442