2 /* $OpenBSD: ip_ipcomp.c,v 1.1 2001/07/05 12:08:52 jjbg Exp $ */
5 * SPDX-License-Identifier: BSD-3-Clause
7 * Copyright (c) 2001 Jean-Jacques Bernard-Gundol (jj@wabbitt.org)
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. The name of the author may not be used to endorse or promote products
19 * derived from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 /* IP payload compression protocol (IPComp), see RFC 2393 */
35 #include "opt_inet6.h"
36 #include "opt_ipsec.h"
38 #include <sys/param.h>
39 #include <sys/systm.h>
42 #include <sys/mutex.h>
43 #include <sys/socket.h>
44 #include <sys/kernel.h>
45 #include <sys/protosw.h>
46 #include <sys/sysctl.h>
48 #include <netinet/in.h>
49 #include <netinet/in_systm.h>
50 #include <netinet/ip.h>
51 #include <netinet/ip_var.h>
52 #include <netinet/ip_encap.h>
54 #include <net/netisr.h>
56 #include <net/if.h> /* XXXGL: net_epoch should move out there */
57 #include <net/if_var.h> /* XXXGL: net_epoch should move out there */
59 #include <netipsec/ipsec.h>
60 #include <netipsec/xform.h>
63 #include <netinet/ip6.h>
64 #include <netinet6/ip6_var.h>
65 #include <netipsec/ipsec6.h>
68 #include <netipsec/ipcomp.h>
69 #include <netipsec/ipcomp_var.h>
71 #include <netipsec/key.h>
72 #include <netipsec/key_debug.h>
74 #include <opencrypto/cryptodev.h>
75 #include <opencrypto/deflate.h>
76 #include <opencrypto/xform.h>
78 VNET_DEFINE(int, ipcomp_enable) = 1;
79 VNET_PCPUSTAT_DEFINE(struct ipcompstat, ipcompstat);
80 VNET_PCPUSTAT_SYSINIT(ipcompstat);
83 VNET_PCPUSTAT_SYSUNINIT(ipcompstat);
86 SYSCTL_DECL(_net_inet_ipcomp);
87 SYSCTL_INT(_net_inet_ipcomp, OID_AUTO, ipcomp_enable,
88 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(ipcomp_enable), 0, "");
89 SYSCTL_VNET_PCPUSTAT(_net_inet_ipcomp, IPSECCTL_STATS, stats,
90 struct ipcompstat, ipcompstat,
91 "IPCOMP statistics (struct ipcompstat, netipsec/ipcomp_var.h");
93 static int ipcomp_input_cb(struct cryptop *crp);
94 static int ipcomp_output_cb(struct cryptop *crp);
97 * RFC 3173 p 2.2. Non-Expansion Policy:
98 * If the total size of a compressed payload and the IPComp header, as
99 * defined in section 3, is not smaller than the size of the original
100 * payload, the IP datagram MUST be sent in the original non-compressed
103 * When we use IPComp in tunnel mode, for small packets we will receive
104 * encapsulated IP-IP datagrams without any compression and without IPComp
108 ipcomp_encapcheck(union sockaddr_union *src, union sockaddr_union *dst)
110 struct secasvar *sav;
112 sav = key_allocsa_tunnel(src, dst, IPPROTO_IPCOMP);
117 if (src->sa.sa_family == AF_INET)
118 return (sizeof(struct in_addr) << 4);
120 return (sizeof(struct in6_addr) << 4);
124 ipcomp_nonexp_input(struct mbuf *m, int off, int proto, void *arg __unused)
142 IPCOMPSTAT_INC(ipcomps_nopf);
144 return (IPPROTO_DONE);
147 IPCOMPSTAT_ADD(ipcomps_ibytes, m->m_pkthdr.len);
148 IPCOMPSTAT_INC(ipcomps_input);
149 netisr_dispatch(isr, m);
150 return (IPPROTO_DONE);
154 * ipcomp_init() is called when an CPI is being set up.
157 ipcomp_init(struct secasvar *sav, struct xformsw *xsp)
159 const struct comp_algo *tcomp;
160 struct crypto_session_params csp;
162 /* NB: algorithm really comes in alg_enc and not alg_comp! */
163 tcomp = comp_algorithm_lookup(sav->alg_enc);
165 DPRINTF(("%s: unsupported compression algorithm %d\n", __func__,
169 sav->alg_comp = sav->alg_enc; /* set for doing histogram */
170 sav->tdb_xform = xsp;
171 sav->tdb_compalgxform = tcomp;
173 /* Initialize crypto session */
174 memset(&csp, 0, sizeof(csp));
175 csp.csp_mode = CSP_MODE_COMPRESS;
176 csp.csp_cipher_alg = sav->tdb_compalgxform->type;
178 return crypto_newsession(&sav->tdb_cryptoid, &csp, V_crypto_support);
182 * ipcomp_cleanup() used when IPCA is deleted
185 ipcomp_cleanup(struct secasvar *sav)
188 crypto_freesession(sav->tdb_cryptoid);
189 sav->tdb_cryptoid = NULL;
193 * ipcomp_input() gets called to uncompress an input packet
196 ipcomp_input(struct mbuf *m, struct secasvar *sav, int skip, int protoff)
198 struct xform_data *xd;
200 struct ipcomp *ipcomp;
201 crypto_session_t cryptoid;
203 int error, hlen = IPCOMP_HLENGTH;
206 * Check that the next header of the IPComp is not IPComp again, before
207 * doing any real work. Given it is not possible to do double
208 * compression it means someone is playing tricks on us.
211 if (m->m_len < skip + hlen && (m = m_pullup(m, skip + hlen)) == NULL) {
212 IPCOMPSTAT_INC(ipcomps_hdrops); /*XXX*/
213 DPRINTF(("%s: m_pullup failed\n", __func__));
217 addr = (caddr_t) mtod(m, struct ip *) + skip;
218 ipcomp = (struct ipcomp *)addr;
219 if (ipcomp->comp_nxt == IPPROTO_IPCOMP) {
220 IPCOMPSTAT_INC(ipcomps_pdrops); /* XXX have our own stats? */
221 DPRINTF(("%s: recursive compression detected\n", __func__));
227 cryptoid = sav->tdb_cryptoid;
228 SECASVAR_UNLOCK(sav);
230 /* Get crypto descriptors */
231 crp = crypto_getreq(cryptoid, M_NOWAIT);
233 DPRINTF(("%s: no crypto descriptors\n", __func__));
234 IPCOMPSTAT_INC(ipcomps_crypto);
237 /* Get IPsec-specific opaque pointer */
238 xd = malloc(sizeof(*xd), M_XDATA, M_NOWAIT | M_ZERO);
240 DPRINTF(("%s: cannot allocate xform_data\n", __func__));
241 IPCOMPSTAT_INC(ipcomps_crypto);
246 /* Decompression operation */
247 crp->crp_op = CRYPTO_OP_DECOMPRESS;
248 crp->crp_payload_start = skip + hlen;
249 crp->crp_payload_length = m->m_pkthdr.len - (skip + hlen);
251 /* Crypto operation descriptor */
252 crp->crp_flags = CRYPTO_F_CBIFSYNC;
253 crypto_use_mbuf(crp, m);
254 crp->crp_callback = ipcomp_input_cb;
255 crp->crp_opaque = xd;
257 /* These are passed as-is to the callback */
259 xd->protoff = protoff;
262 xd->cryptoid = cryptoid;
265 crp->crp_session = xd->cryptoid = sav->tdb_cryptoid;
266 SECASVAR_UNLOCK(sav);
268 return crypto_dispatch(crp);
276 * IPComp input callback from the crypto driver.
279 ipcomp_input_cb(struct cryptop *crp)
281 IPSEC_DEBUG_DECLARE(char buf[IPSEC_ADDRSTRLEN]);
282 struct xform_data *xd;
284 struct secasvar *sav;
285 struct secasindex *saidx;
287 crypto_session_t cryptoid;
288 int hlen = IPCOMP_HLENGTH, error, clen;
292 m = crp->crp_buf.cb_mbuf;
293 xd = crp->crp_opaque;
294 CURVNET_SET(xd->vnet);
297 protoff = xd->protoff;
298 cryptoid = xd->cryptoid;
299 saidx = &sav->sah->saidx;
300 IPSEC_ASSERT(saidx->dst.sa.sa_family == AF_INET ||
301 saidx->dst.sa.sa_family == AF_INET6,
302 ("unexpected protocol family %u", saidx->dst.sa.sa_family));
304 /* Check for crypto errors */
305 if (crp->crp_etype) {
306 if (crp->crp_etype == EAGAIN) {
307 /* Reset the session ID */
308 if (ipsec_updateid(sav, &crp->crp_session, &cryptoid) != 0)
309 crypto_freesession(cryptoid);
310 xd->cryptoid = crp->crp_session;
312 return (crypto_dispatch(crp));
314 IPCOMPSTAT_INC(ipcomps_noxform);
315 DPRINTF(("%s: crypto error %d\n", __func__, crp->crp_etype));
316 error = crp->crp_etype;
319 /* Shouldn't happen... */
321 IPCOMPSTAT_INC(ipcomps_crypto);
322 DPRINTF(("%s: null mbuf returned from crypto\n", __func__));
326 IPCOMPSTAT_INC(ipcomps_hist[sav->alg_comp]);
328 clen = crp->crp_olen; /* Length of data after processing */
330 /* Release the crypto descriptors */
331 free(xd, M_XDATA), xd = NULL;
332 crypto_freereq(crp), crp = NULL;
334 /* In case it's not done already, adjust the size of the mbuf chain */
335 m->m_pkthdr.len = clen + hlen + skip;
337 if (m->m_len < skip + hlen && (m = m_pullup(m, skip + hlen)) == NULL) {
338 IPCOMPSTAT_INC(ipcomps_hdrops); /*XXX*/
339 DPRINTF(("%s: m_pullup failed\n", __func__));
340 error = EINVAL; /*XXX*/
344 /* Keep the next protocol field */
345 addr = (caddr_t) mtod(m, struct ip *) + skip;
346 nproto = ((struct ipcomp *) addr)->comp_nxt;
348 /* Remove the IPCOMP header */
349 error = m_striphdr(m, skip, hlen);
351 IPCOMPSTAT_INC(ipcomps_hdrops);
352 DPRINTF(("%s: bad mbuf chain, IPCA %s/%08lx\n", __func__,
353 ipsec_address(&sav->sah->saidx.dst, buf, sizeof(buf)),
354 (u_long) ntohl(sav->spi)));
358 /* Restore the Next Protocol field */
359 m_copyback(m, protoff, sizeof (u_int8_t), (u_int8_t *) &nproto);
361 switch (saidx->dst.sa.sa_family) {
364 error = ipsec6_common_input_cb(m, sav, skip, protoff);
369 error = ipsec4_common_input_cb(m, sav, skip, protoff);
373 panic("%s: Unexpected address family: %d saidx=%p", __func__,
374 saidx->dst.sa.sa_family, saidx);
392 * IPComp output routine, called by ipsec[46]_perform_request()
395 ipcomp_output(struct mbuf *m, struct secpolicy *sp, struct secasvar *sav,
396 u_int idx, int skip, int protoff)
398 IPSEC_DEBUG_DECLARE(char buf[IPSEC_ADDRSTRLEN]);
399 const struct comp_algo *ipcompx;
401 struct xform_data *xd;
402 crypto_session_t cryptoid;
403 int error, ralen, maxpacketsize;
405 IPSEC_ASSERT(sav != NULL, ("null SA"));
406 ipcompx = sav->tdb_compalgxform;
407 IPSEC_ASSERT(ipcompx != NULL, ("null compression xform"));
410 * Do not touch the packet in case our payload to compress
411 * is lower than the minimal threshold of the compression
412 * alogrithm. We will just send out the data uncompressed.
413 * See RFC 3173, 2.2. Non-Expansion Policy.
415 if (m->m_pkthdr.len <= ipcompx->minlen) {
416 IPCOMPSTAT_INC(ipcomps_threshold);
417 return ipsec_process_done(m, sp, sav, idx);
420 ralen = m->m_pkthdr.len - skip; /* Raw payload length before comp. */
421 IPCOMPSTAT_INC(ipcomps_output);
423 /* Check for maximum packet size violations. */
424 switch (sav->sah->saidx.dst.sa.sa_family) {
427 maxpacketsize = IP_MAXPACKET;
432 maxpacketsize = IPV6_MAXPACKET;
436 IPCOMPSTAT_INC(ipcomps_nopf);
437 DPRINTF(("%s: unknown/unsupported protocol family %d, "
438 "IPCA %s/%08lx\n", __func__,
439 sav->sah->saidx.dst.sa.sa_family,
440 ipsec_address(&sav->sah->saidx.dst, buf, sizeof(buf)),
441 (u_long) ntohl(sav->spi)));
442 error = EPFNOSUPPORT;
445 if (ralen + skip + IPCOMP_HLENGTH > maxpacketsize) {
446 IPCOMPSTAT_INC(ipcomps_toobig);
447 DPRINTF(("%s: packet in IPCA %s/%08lx got too big "
448 "(len %u, max len %u)\n", __func__,
449 ipsec_address(&sav->sah->saidx.dst, buf, sizeof(buf)),
450 (u_long) ntohl(sav->spi),
451 ralen + skip + IPCOMP_HLENGTH, maxpacketsize));
456 /* Update the counters */
457 IPCOMPSTAT_ADD(ipcomps_obytes, m->m_pkthdr.len - skip);
459 m = m_unshare(m, M_NOWAIT);
461 IPCOMPSTAT_INC(ipcomps_hdrops);
462 DPRINTF(("%s: cannot clone mbuf chain, IPCA %s/%08lx\n",
463 __func__, ipsec_address(&sav->sah->saidx.dst, buf,
464 sizeof(buf)), (u_long) ntohl(sav->spi)));
469 /* Ok now, we can pass to the crypto processing. */
471 cryptoid = sav->tdb_cryptoid;
472 SECASVAR_UNLOCK(sav);
474 /* Get crypto descriptors */
475 crp = crypto_getreq(cryptoid, M_NOWAIT);
477 IPCOMPSTAT_INC(ipcomps_crypto);
478 DPRINTF(("%s: failed to acquire crypto descriptor\n",__func__));
483 /* Compression descriptor */
484 crp->crp_op = CRYPTO_OP_COMPRESS;
485 crp->crp_payload_start = skip;
486 crp->crp_payload_length = ralen;
488 /* IPsec-specific opaque crypto info */
489 xd = malloc(sizeof(struct xform_data), M_XDATA, M_NOWAIT | M_ZERO);
491 IPCOMPSTAT_INC(ipcomps_crypto);
492 DPRINTF(("%s: failed to allocate xform_data\n", __func__));
502 xd->protoff = protoff;
504 xd->cryptoid = cryptoid;
506 /* Crypto operation descriptor */
507 crp->crp_flags = CRYPTO_F_CBIFSYNC;
508 crypto_use_mbuf(crp, m);
509 crp->crp_callback = ipcomp_output_cb;
510 crp->crp_opaque = xd;
512 return crypto_dispatch(crp);
522 * IPComp output callback from the crypto driver.
525 ipcomp_output_cb(struct cryptop *crp)
527 IPSEC_DEBUG_DECLARE(char buf[IPSEC_ADDRSTRLEN]);
528 struct xform_data *xd;
529 struct secpolicy *sp;
530 struct secasvar *sav;
532 crypto_session_t cryptoid;
534 int error, skip, protoff;
536 m = crp->crp_buf.cb_mbuf;
537 xd = crp->crp_opaque;
538 CURVNET_SET(xd->vnet);
543 protoff = xd->protoff;
544 cryptoid = xd->cryptoid;
546 /* Check for crypto errors */
547 if (crp->crp_etype) {
548 if (crp->crp_etype == EAGAIN) {
549 /* Reset the session ID */
550 if (ipsec_updateid(sav, &crp->crp_session, &cryptoid) != 0)
551 crypto_freesession(cryptoid);
552 xd->cryptoid = crp->crp_session;
554 return (crypto_dispatch(crp));
556 IPCOMPSTAT_INC(ipcomps_noxform);
557 DPRINTF(("%s: crypto error %d\n", __func__, crp->crp_etype));
558 error = crp->crp_etype;
561 /* Shouldn't happen... */
563 IPCOMPSTAT_INC(ipcomps_crypto);
564 DPRINTF(("%s: bogus return buffer from crypto\n", __func__));
568 IPCOMPSTAT_INC(ipcomps_hist[sav->alg_comp]);
570 if (crp->crp_payload_length > crp->crp_olen) {
572 struct ipcomp *ipcomp;
576 /* Compression helped, inject IPCOMP header. */
577 mo = m_makespace(m, skip, IPCOMP_HLENGTH, &roff);
579 IPCOMPSTAT_INC(ipcomps_wrap);
580 DPRINTF(("%s: IPCOMP header inject failed "
581 "for IPCA %s/%08lx\n",
582 __func__, ipsec_address(&sav->sah->saidx.dst, buf,
583 sizeof(buf)), (u_long) ntohl(sav->spi)));
587 ipcomp = (struct ipcomp *)(mtod(mo, caddr_t) + roff);
589 /* Initialize the IPCOMP header */
590 /* XXX alignment always correct? */
591 switch (sav->sah->saidx.dst.sa.sa_family) {
594 ipcomp->comp_nxt = mtod(m, struct ip *)->ip_p;
599 ipcomp->comp_nxt = mtod(m, struct ip6_hdr *)->ip6_nxt;
603 ipcomp->comp_flags = 0;
604 ipcomp->comp_cpi = htons((u_int16_t) ntohl(sav->spi));
606 /* Fix Next Protocol in IPv4/IPv6 header */
607 prot = IPPROTO_IPCOMP;
608 m_copyback(m, protoff, sizeof(u_int8_t),
611 /* Adjust the length in the IP header */
612 switch (sav->sah->saidx.dst.sa.sa_family) {
615 mtod(m, struct ip *)->ip_len = htons(m->m_pkthdr.len);
620 mtod(m, struct ip6_hdr *)->ip6_plen =
621 htons(m->m_pkthdr.len) - sizeof(struct ip6_hdr);
625 IPCOMPSTAT_INC(ipcomps_nopf);
626 DPRINTF(("%s: unknown/unsupported protocol "
627 "family %d, IPCA %s/%08lx\n", __func__,
628 sav->sah->saidx.dst.sa.sa_family,
629 ipsec_address(&sav->sah->saidx.dst, buf,
630 sizeof(buf)), (u_long) ntohl(sav->spi)));
631 error = EPFNOSUPPORT;
635 /* Compression was useless, we have lost time. */
636 IPCOMPSTAT_INC(ipcomps_uncompr);
637 DPRINTF(("%s: compressions was useless %d <= %d\n",
638 __func__, crp->crp_payload_length, crp->crp_olen));
639 /* XXX remember state to not compress the next couple
640 * of packets, RFC 3173, 2.2. Non-Expansion Policy */
643 /* Release the crypto descriptor */
647 /* NB: m is reclaimed by ipsec_process_done. */
648 error = ipsec_process_done(m, sp, sav, idx);
664 ipcomp4_nonexp_encapcheck(const struct mbuf *m, int off, int proto,
667 union sockaddr_union src, dst;
670 if (V_ipcomp_enable == 0)
672 if (proto != IPPROTO_IPV4 && proto != IPPROTO_IPV6)
674 bzero(&src, sizeof(src));
675 bzero(&dst, sizeof(dst));
676 src.sa.sa_family = dst.sa.sa_family = AF_INET;
677 src.sin.sin_len = dst.sin.sin_len = sizeof(struct sockaddr_in);
678 ip = mtod(m, const struct ip *);
679 src.sin.sin_addr = ip->ip_src;
680 dst.sin.sin_addr = ip->ip_dst;
681 return (ipcomp_encapcheck(&src, &dst));
684 static const struct encaptab *ipe4_cookie = NULL;
685 static const struct encap_config ipv4_encap_cfg = {
687 .min_length = sizeof(struct ip),
688 .exact_match = sizeof(in_addr_t) << 4,
689 .check = ipcomp4_nonexp_encapcheck,
690 .input = ipcomp_nonexp_input
695 ipcomp6_nonexp_encapcheck(const struct mbuf *m, int off, int proto,
698 union sockaddr_union src, dst;
699 const struct ip6_hdr *ip6;
701 if (V_ipcomp_enable == 0)
703 if (proto != IPPROTO_IPV4 && proto != IPPROTO_IPV6)
705 bzero(&src, sizeof(src));
706 bzero(&dst, sizeof(dst));
707 src.sa.sa_family = dst.sa.sa_family = AF_INET;
708 src.sin6.sin6_len = dst.sin6.sin6_len = sizeof(struct sockaddr_in6);
709 ip6 = mtod(m, const struct ip6_hdr *);
710 src.sin6.sin6_addr = ip6->ip6_src;
711 dst.sin6.sin6_addr = ip6->ip6_dst;
712 if (IN6_IS_SCOPE_LINKLOCAL(&src.sin6.sin6_addr)) {
713 /* XXX: sa6_recoverscope() */
714 src.sin6.sin6_scope_id =
715 ntohs(src.sin6.sin6_addr.s6_addr16[1]);
716 src.sin6.sin6_addr.s6_addr16[1] = 0;
718 if (IN6_IS_SCOPE_LINKLOCAL(&dst.sin6.sin6_addr)) {
719 /* XXX: sa6_recoverscope() */
720 dst.sin6.sin6_scope_id =
721 ntohs(dst.sin6.sin6_addr.s6_addr16[1]);
722 dst.sin6.sin6_addr.s6_addr16[1] = 0;
724 return (ipcomp_encapcheck(&src, &dst));
727 static const struct encaptab *ipe6_cookie = NULL;
728 static const struct encap_config ipv6_encap_cfg = {
730 .min_length = sizeof(struct ip6_hdr),
731 .exact_match = sizeof(struct in6_addr) << 4,
732 .check = ipcomp6_nonexp_encapcheck,
733 .input = ipcomp_nonexp_input
737 static struct xformsw ipcomp_xformsw = {
738 .xf_type = XF_IPCOMP,
740 .xf_init = ipcomp_init,
741 .xf_cleanup = ipcomp_cleanup,
742 .xf_input = ipcomp_input,
743 .xf_output = ipcomp_output,
751 ipe4_cookie = ip_encap_attach(&ipv4_encap_cfg, NULL, M_WAITOK);
754 ipe6_cookie = ip6_encap_attach(&ipv6_encap_cfg, NULL, M_WAITOK);
756 xform_attach(&ipcomp_xformsw);
764 ip_encap_detach(ipe4_cookie);
767 ip6_encap_detach(ipe6_cookie);
769 xform_detach(&ipcomp_xformsw);
772 SYSINIT(ipcomp_xform_init, SI_SUB_PROTO_DOMAIN, SI_ORDER_MIDDLE,
773 ipcomp_attach, NULL);
774 SYSUNINIT(ipcomp_xform_uninit, SI_SUB_PROTO_DOMAIN, SI_ORDER_MIDDLE,
775 ipcomp_detach, NULL);