sys/netinet6/ipcomp_core.c

   1 /*      $FreeBSD: src/sys/netinet6/ipcomp_core.c,v 1.1.2.5 2003/01/11 19:10:59 ume Exp $        */
   2 /*      $KAME: ipcomp_core.c,v 1.25 2001/07/26 06:53:17 jinmei Exp $    */
   3
   4 /*
   5  * Copyright (C) 1999 WIDE Project.
   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  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. Neither the name of the project nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  */
  32
  33 /*
  34  * RFC2393 IP payload compression protocol (IPComp).
  35  */
  36
  37 #include "opt_inet.h"
  38 #include "opt_inet6.h"
  39
  40 #include <sys/param.h>
  41 #include <sys/systm.h>
  42 #include <sys/malloc.h>
  43 #include <sys/mbuf.h>
  44 #include <sys/domain.h>
  45 #include <sys/protosw.h>
  46 #include <sys/socket.h>
  47 #include <sys/errno.h>
  48 #include <sys/time.h>
  49 #include <sys/syslog.h>
  50 #include <sys/queue.h>
  51
  52 #include <net/if.h>
  53 #include <net/route.h>
  54 #include <netinet/in.h>
  55 #include <net/netisr.h>
  56 #include <net/zlib.h>
  57 #include <machine/cpu.h>
  58
  59 #include <netinet6/ipcomp.h>
  60 #ifdef INET6
  61 #include <netinet6/ipcomp6.h>
  62 #endif
  63 #include <netinet6/ipsec.h>
  64 #ifdef INET6
  65 #include <netinet6/ipsec6.h>
  66 #endif
  67
  68 #include <machine/stdarg.h>
  69
  70 #include <net/net_osdep.h>
  71
  72 static void *deflate_alloc (void *, u_int, u_int);
  73 static void deflate_free (void *, void *);
  74 static int deflate_common (struct mbuf *, struct mbuf *, size_t *, int);
  75 static int deflate_compress (struct mbuf *, struct mbuf *, size_t *);
  76 static int deflate_decompress (struct mbuf *, struct mbuf *, size_t *);
  77
  78 /*
  79  * We need to use default window size (2^15 = 32Kbytes as of writing) for
  80  * inbound case.  Otherwise we get interop problem.
  81  * Use negative value to avoid Adler32 checksum.  This is an undocumented
  82  * feature in zlib (see ipsec wg mailing list archive in January 2000).
  83  */
  84 static int deflate_policy = Z_DEFAULT_COMPRESSION;
  85 static int deflate_window_out = -12;
  86 static const int deflate_window_in = -1 * MAX_WBITS;    /* don't change it */
  87 static int deflate_memlevel = MAX_MEM_LEVEL;
  88
  89 static const struct ipcomp_algorithm ipcomp_algorithms[] = {
  90         { deflate_compress, deflate_decompress, 90 },
  91 };
  92
  93 const struct ipcomp_algorithm *
  94 ipcomp_algorithm_lookup(int idx)
  95 {
  96
  97         if (idx == SADB_X_CALG_DEFLATE)
  98                 return &ipcomp_algorithms[0];
  99         return NULL;
 100 }
 101
 102 static void *
 103 deflate_alloc(void *aux, u_int items, u_int siz)
 104 {
 105         void *ptr;
 106         ptr = kmalloc(items * siz, M_TEMP, M_NOWAIT);
 107         return ptr;
 108 }
 109
 110 static void
 111 deflate_free(void *aux, void *ptr)
 112 {
 113         kfree(ptr, M_TEMP);
 114 }
 115
 116 static int
 117 deflate_common(struct mbuf *m, struct mbuf *md, size_t *lenp,
 118                int mode)        /* 0: compress 1: decompress */
 119 {
 120         struct mbuf *mprev;
 121         struct mbuf *p;
 122         struct mbuf *n = NULL, *n0 = NULL, **np;
 123         z_stream zs;
 124         int error = 0;
 125         int zerror;
 126         size_t offset;
 127
 128 #define MOREBLOCK() \
 129 do { \
 130         /* keep the reply buffer into our chain */              \
 131         if (n) {                                                \
 132                 n->m_len = zs.total_out - offset;               \
 133                 offset = zs.total_out;                          \
 134                 *np = n;                                        \
 135                 np = &n->m_next;                                \
 136                 n = NULL;                                       \
 137         }                                                       \
 138                                                                 \
 139         /* get a fresh reply buffer */                          \
 140         n = m_getcl(M_NOWAIT, MT_DATA, 0);                      \
 141         if (!n) {                                               \
 142                 error = ENOBUFS;                                \
 143                 goto fail;                                      \
 144         }                                                       \
 145         n->m_len = 0;                                           \
 146         n->m_len = M_TRAILINGSPACE(n);                          \
 147         n->m_next = NULL;                                       \
 148         /*                                                      \
 149          * if this is the first reply buffer, reserve           \
 150          * region for ipcomp header.                            \
 151          */                                                     \
 152         if (*np == NULL) {                                      \
 153                 n->m_len -= sizeof(struct ipcomp);              \
 154                 n->m_data += sizeof(struct ipcomp);             \
 155         }                                                       \
 156                                                                 \
 157         zs.next_out = mtod(n, u_int8_t *);                      \
 158         zs.avail_out = n->m_len;                                \
 159 } while (0)
 160
 161         for (mprev = m; mprev && mprev->m_next != md; mprev = mprev->m_next)
 162                 ;
 163         if (!mprev)
 164                 panic("md is not in m in deflate_common");
 165
 166         bzero(&zs, sizeof(zs));
 167         zs.zalloc = deflate_alloc;
 168         zs.zfree = deflate_free;
 169
 170         zerror = mode ? inflateInit2(&zs, deflate_window_in)
 171                       : deflateInit2(&zs, deflate_policy, Z_DEFLATED,
 172                                 deflate_window_out, deflate_memlevel,
 173                                 Z_DEFAULT_STRATEGY);
 174         if (zerror != Z_OK) {
 175                 error = ENOBUFS;
 176                 goto fail;
 177         }
 178
 179         n0 = n = NULL;
 180         np = &n0;
 181         offset = 0;
 182         zerror = 0;
 183         p = md;
 184         while (p && p->m_len == 0) {
 185                 p = p->m_next;
 186         }
 187
 188         /* input stream and output stream are available */
 189         while (p && zs.avail_in == 0) {
 190                 /* get input buffer */
 191                 if (p && zs.avail_in == 0) {
 192                         zs.next_in = mtod(p, u_int8_t *);
 193                         zs.avail_in = p->m_len;
 194                         p = p->m_next;
 195                         while (p && p->m_len == 0) {
 196                                 p = p->m_next;
 197                         }
 198                 }
 199
 200                 /* get output buffer */
 201                 if (zs.next_out == NULL || zs.avail_out == 0) {
 202                         MOREBLOCK();
 203                 }
 204
 205                 zerror = mode ? inflate(&zs, Z_NO_FLUSH)
 206                               : deflate(&zs, Z_NO_FLUSH);
 207
 208                 if (zerror == Z_STREAM_END)
 209                         ; /* once more. */
 210                 else if (zerror == Z_OK) {
 211                         /* inflate: Z_OK can indicate the end of decode */
 212                         if (mode && !p && zs.avail_out != 0)
 213                                 goto terminate;
 214                         else
 215                                 ; /* once more. */
 216                 } else {
 217                         if (zs.msg) {
 218                                 ipseclog((LOG_ERR, "ipcomp_%scompress: "
 219                                     "%sflate(Z_NO_FLUSH): %s\n",
 220                                     mode ? "de" : "", mode ? "in" : "de",
 221                                     zs.msg));
 222                         } else {
 223                                 ipseclog((LOG_ERR, "ipcomp_%scompress: "
 224                                     "%sflate(Z_NO_FLUSH): unknown error (%d)\n",
 225                                     mode ? "de" : "", mode ? "in" : "de",
 226                                     zerror));
 227                         }
 228                         mode ? inflateEnd(&zs) : deflateEnd(&zs);
 229                         error = EINVAL;
 230                         goto fail;
 231                 }
 232         }
 233
 234         if (zerror == Z_STREAM_END)
 235                 goto terminate;
 236
 237         /* termination */
 238         while (1) {
 239                 /* get output buffer */
 240                 if (zs.next_out == NULL || zs.avail_out == 0) {
 241                         MOREBLOCK();
 242                 }
 243
 244                 zerror = mode ? inflate(&zs, Z_SYNC_FLUSH)
 245                               : deflate(&zs, Z_FINISH);
 246
 247                 if (zerror == Z_STREAM_END)
 248                         break;
 249                 else if (zerror == Z_OK) {
 250                         if (mode && zs.avail_out != 0)
 251                                 goto terminate;
 252                         else
 253                                 ; /* once more. */
 254                 } else {
 255                         if (zs.msg) {
 256                                 ipseclog((LOG_ERR, "ipcomp_%scompress: "
 257                                     "%sflate(Z_FINISH): %s\n",
 258                                     mode ? "de" : "", mode ? "in" : "de",
 259                                     zs.msg));
 260                         } else {
 261                                 ipseclog((LOG_ERR, "ipcomp_%scompress: "
 262                                     "%sflate(Z_FINISH): unknown error (%d)\n",
 263                                     mode ? "de" : "", mode ? "in" : "de",
 264                                     zerror));
 265                         }
 266                         mode ? inflateEnd(&zs) : deflateEnd(&zs);
 267                         error = EINVAL;
 268                         goto fail;
 269                 }
 270         }
 271
 272 terminate:
 273         zerror = mode ? inflateEnd(&zs) : deflateEnd(&zs);
 274         if (zerror != Z_OK) {
 275                 if (zs.msg) {
 276                         ipseclog((LOG_ERR, "ipcomp_%scompress: "
 277                             "%sflateEnd: %s\n",
 278                             mode ? "de" : "", mode ? "in" : "de",
 279                             zs.msg));
 280                 } else {
 281                         ipseclog((LOG_ERR, "ipcomp_%scompress: "
 282                             "%sflateEnd: unknown error (%d)\n",
 283                             mode ? "de" : "", mode ? "in" : "de",
 284                             zerror));
 285                 }
 286                 error = EINVAL;
 287                 goto fail;
 288         }
 289         /* keep the final reply buffer into our chain */
 290         if (n) {
 291                 n->m_len = zs.total_out - offset;
 292                 offset = zs.total_out;
 293                 *np = n;
 294                 np = &n->m_next;
 295                 n = NULL;
 296         }
 297
 298         /* switch the mbuf to the new one */
 299         mprev->m_next = n0;
 300         m_freem(md);
 301         *lenp = zs.total_out;
 302
 303         return 0;
 304
 305 fail:
 306         if (m)
 307                 m_freem(m);
 308         if (n)
 309                 m_freem(n);
 310         if (n0)
 311                 m_freem(n0);
 312         return error;
 313 #undef MOREBLOCK
 314 }
 315
 316 static int
 317 deflate_compress(struct mbuf *m, struct mbuf *md, size_t *lenp)
 318 {
 319         if (!m)
 320                 panic("m == NULL in deflate_compress");
 321         if (!md)
 322                 panic("md == NULL in deflate_compress");
 323         if (!lenp)
 324                 panic("lenp == NULL in deflate_compress");
 325
 326         return deflate_common(m, md, lenp, 0);
 327 }
 328
 329 static int
 330 deflate_decompress(struct mbuf *m, struct mbuf *md, size_t *lenp)
 331 {
 332         if (!m)
 333                 panic("m == NULL in deflate_decompress");
 334         if (!md)
 335                 panic("md == NULL in deflate_decompress");
 336         if (!lenp)
 337                 panic("lenp == NULL in deflate_decompress");
 338
 339         return deflate_common(m, md, lenp, 1);
 340 }