sys/netipsec/xform_ah.c

   1 /*      $FreeBSD$       */
   2 /*      $OpenBSD: ip_ah.c,v 1.63 2001/06/26 06:18:58 angelos Exp $ */
   3 /*-
   4  * The authors of this code are John Ioannidis (ji@tla.org),
   5  * Angelos D. Keromytis (kermit@csd.uch.gr) and
   6  * Niels Provos (provos@physnet.uni-hamburg.de).
   7  *
   8  * The original version of this code was written by John Ioannidis
   9  * for BSD/OS in Athens, Greece, in November 1995.
  10  *
  11  * Ported to OpenBSD and NetBSD, with additional transforms, in December 1996,
  12  * by Angelos D. Keromytis.
  13  *
  14  * Additional transforms and features in 1997 and 1998 by Angelos D. Keromytis
  15  * and Niels Provos.
  16  *
  17  * Additional features in 1999 by Angelos D. Keromytis and Niklas Hallqvist.
  18  *
  19  * Copyright (c) 1995, 1996, 1997, 1998, 1999 by John Ioannidis,
  20  * Angelos D. Keromytis and Niels Provos.
  21  * Copyright (c) 1999 Niklas Hallqvist.
  22  * Copyright (c) 2001 Angelos D. Keromytis.
  23  *
  24  * Permission to use, copy, and modify this software with or without fee
  25  * is hereby granted, provided that this entire notice is included in
  26  * all copies of any software which is or includes a copy or
  27  * modification of this software.
  28  * You may use this code under the GNU public license if you so wish. Please
  29  * contribute changes back to the authors under this freer than GPL license
  30  * so that we may further the use of strong encryption without limitations to
  31  * all.
  32  *
  33  * THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR
  34  * IMPLIED WARRANTY. IN PARTICULAR, NONE OF THE AUTHORS MAKES ANY
  35  * REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE
  36  * MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR
  37  * PURPOSE.
  38  */
  39 #include "opt_inet.h"
  40 #include "opt_inet6.h"
  41
  42 #include <sys/param.h>
  43 #include <sys/systm.h>
  44 #include <sys/mbuf.h>
  45 #include <sys/socket.h>
  46 #include <sys/syslog.h>
  47 #include <sys/kernel.h>
  48 #include <sys/lock.h>
  49 #include <sys/mutex.h>
  50 #include <sys/sysctl.h>
  51
  52 #include <net/if.h>
  53 #include <net/vnet.h>
  54
  55 #include <netinet/in.h>
  56 #include <netinet/in_systm.h>
  57 #include <netinet/ip.h>
  58 #include <netinet/ip_ecn.h>
  59 #include <netinet/ip6.h>
  60
  61 #include <netipsec/ipsec.h>
  62 #include <netipsec/ah.h>
  63 #include <netipsec/ah_var.h>
  64 #include <netipsec/xform.h>
  65
  66 #ifdef INET6
  67 #include <netinet6/ip6_var.h>
  68 #include <netipsec/ipsec6.h>
  69 #include <netinet6/ip6_ecn.h>
  70 #endif
  71
  72 #include <netipsec/key.h>
  73 #include <netipsec/key_debug.h>
  74
  75 #include <opencrypto/cryptodev.h>
  76
  77 /*
  78  * Return header size in bytes.  The old protocol did not support
  79  * the replay counter; the new protocol always includes the counter.
  80  */
  81 #define HDRSIZE(sav) \
  82         (((sav)->flags & SADB_X_EXT_OLD) ? \
  83                 sizeof (struct ah) : sizeof (struct ah) + sizeof (u_int32_t))
  84 /*
  85  * Return authenticator size in bytes, based on a field in the
  86  * algorithm descriptor.
  87  */
  88 #define AUTHSIZE(sav)   ((sav->flags & SADB_X_EXT_OLD) ? 16 :   \
  89                          xform_ah_authsize((sav)->tdb_authalgxform))
  90
  91 VNET_DEFINE(int, ah_enable) = 1;        /* control flow of packets with AH */
  92 VNET_DEFINE(int, ah_cleartos) = 1;      /* clear ip_tos when doing AH calc */
  93 VNET_PCPUSTAT_DEFINE(struct ahstat, ahstat);
  94 VNET_PCPUSTAT_SYSINIT(ahstat);
  95
  96 #ifdef VIMAGE
  97 VNET_PCPUSTAT_SYSUNINIT(ahstat);
  98 #endif /* VIMAGE */
  99
 100 #ifdef INET
 101 SYSCTL_DECL(_net_inet_ah);
 102 SYSCTL_INT(_net_inet_ah, OID_AUTO, ah_enable,
 103         CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(ah_enable), 0, "");
 104 SYSCTL_INT(_net_inet_ah, OID_AUTO, ah_cleartos,
 105         CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(ah_cleartos), 0, "");
 106 SYSCTL_VNET_PCPUSTAT(_net_inet_ah, IPSECCTL_STATS, stats, struct ahstat,
 107     ahstat, "AH statistics (struct ahstat, netipsec/ah_var.h)");
 108 #endif
 109
 110 static unsigned char ipseczeroes[256];  /* larger than an ip6 extension hdr */
 111
 112 static int ah_input_cb(struct cryptop*);
 113 static int ah_output_cb(struct cryptop*);
 114
 115 int
 116 xform_ah_authsize(const struct auth_hash *esph)
 117 {
 118         int alen;
 119
 120         if (esph == NULL)
 121                 return 0;
 122
 123         switch (esph->type) {
 124         case CRYPTO_SHA2_256_HMAC:
 125         case CRYPTO_SHA2_384_HMAC:
 126         case CRYPTO_SHA2_512_HMAC:
 127                 alen = esph->hashsize / 2;      /* RFC4868 2.3 */
 128                 break;
 129
 130         case CRYPTO_AES_128_NIST_GMAC:
 131         case CRYPTO_AES_192_NIST_GMAC:
 132         case CRYPTO_AES_256_NIST_GMAC:
 133                 alen = esph->hashsize;
 134                 break;
 135
 136         default:
 137                 alen = AH_HMAC_HASHLEN;
 138                 break;
 139         }
 140
 141         return alen;
 142 }
 143
 144 size_t
 145 ah_hdrsiz(struct secasvar *sav)
 146 {
 147         size_t size;
 148
 149         if (sav != NULL) {
 150                 int authsize;
 151                 IPSEC_ASSERT(sav->tdb_authalgxform != NULL, ("null xform"));
 152                 /*XXX not right for null algorithm--does it matter??*/
 153                 authsize = AUTHSIZE(sav);
 154                 size = roundup(authsize, sizeof (u_int32_t)) + HDRSIZE(sav);
 155         } else {
 156                 /* default guess */
 157                 size = sizeof (struct ah) + sizeof (u_int32_t) + 16;
 158         }
 159         return size;
 160 }
 161
 162 /*
 163  * NB: public for use by esp_init.
 164  */
 165 int
 166 ah_init0(struct secasvar *sav, struct xformsw *xsp, struct cryptoini *cria)
 167 {
 168         const struct auth_hash *thash;
 169         int keylen;
 170
 171         thash = auth_algorithm_lookup(sav->alg_auth);
 172         if (thash == NULL) {
 173                 DPRINTF(("%s: unsupported authentication algorithm %u\n",
 174                         __func__, sav->alg_auth));
 175                 return EINVAL;
 176         }
 177         /*
 178          * Verify the replay state block allocation is consistent with
 179          * the protocol type.  We check here so we can make assumptions
 180          * later during protocol processing.
 181          */
 182         /* NB: replay state is setup elsewhere (sigh) */
 183         if (((sav->flags&SADB_X_EXT_OLD) == 0) ^ (sav->replay != NULL)) {
 184                 DPRINTF(("%s: replay state block inconsistency, "
 185                         "%s algorithm %s replay state\n", __func__,
 186                         (sav->flags & SADB_X_EXT_OLD) ? "old" : "new",
 187                         sav->replay == NULL ? "without" : "with"));
 188                 return EINVAL;
 189         }
 190         if (sav->key_auth == NULL) {
 191                 DPRINTF(("%s: no authentication key for %s algorithm\n",
 192                         __func__, thash->name));
 193                 return EINVAL;
 194         }
 195         keylen = _KEYLEN(sav->key_auth);
 196         if (keylen > thash->keysize && thash->keysize != 0) {
 197                 DPRINTF(("%s: invalid keylength %d, algorithm %s requires "
 198                         "keysize less than %d\n", __func__,
 199                          keylen, thash->name, thash->keysize));
 200                 return EINVAL;
 201         }
 202
 203         sav->tdb_xform = xsp;
 204         sav->tdb_authalgxform = thash;
 205
 206         /* Initialize crypto session. */
 207         bzero(cria, sizeof (*cria));
 208         cria->cri_alg = sav->tdb_authalgxform->type;
 209         cria->cri_klen = _KEYBITS(sav->key_auth);
 210         cria->cri_key = sav->key_auth->key_data;
 211         cria->cri_mlen = AUTHSIZE(sav);
 212
 213         return 0;
 214 }
 215
 216 /*
 217  * ah_init() is called when an SPI is being set up.
 218  */
 219 static int
 220 ah_init(struct secasvar *sav, struct xformsw *xsp)
 221 {
 222         struct cryptoini cria;
 223         int error;
 224
 225         error = ah_init0(sav, xsp, &cria);
 226         return error ? error :
 227                  crypto_newsession(&sav->tdb_cryptoid, &cria, V_crypto_support);
 228 }
 229
 230 /*
 231  * Paranoia.
 232  *
 233  * NB: public for use by esp_zeroize (XXX).
 234  */
 235 int
 236 ah_zeroize(struct secasvar *sav)
 237 {
 238         int err;
 239
 240         if (sav->key_auth)
 241                 bzero(sav->key_auth->key_data, _KEYLEN(sav->key_auth));
 242
 243         err = crypto_freesession(sav->tdb_cryptoid);
 244         sav->tdb_cryptoid = 0;
 245         sav->tdb_authalgxform = NULL;
 246         sav->tdb_xform = NULL;
 247         return err;
 248 }
 249
 250 /*
 251  * Massage IPv4/IPv6 headers for AH processing.
 252  */
 253 static int
 254 ah_massage_headers(struct mbuf **m0, int proto, int skip, int alg, int out)
 255 {
 256         struct mbuf *m = *m0;
 257         unsigned char *ptr;
 258         int off, count;
 259
 260 #ifdef INET
 261         struct ip *ip;
 262 #endif /* INET */
 263
 264 #ifdef INET6
 265         struct ip6_ext *ip6e;
 266         struct ip6_hdr ip6;
 267         int ad, alloc, nxt, noff;
 268 #endif /* INET6 */
 269
 270         switch (proto) {
 271 #ifdef INET
 272         case AF_INET:
 273                 /*
 274                  * This is the least painful way of dealing with IPv4 header
 275                  * and option processing -- just make sure they're in
 276                  * contiguous memory.
 277                  */
 278                 *m0 = m = m_pullup(m, skip);
 279                 if (m == NULL) {
 280                         DPRINTF(("%s: m_pullup failed\n", __func__));
 281                         return ENOBUFS;
 282                 }
 283
 284                 /* Fix the IP header */
 285                 ip = mtod(m, struct ip *);
 286                 if (V_ah_cleartos)
 287                         ip->ip_tos = 0;
 288                 ip->ip_ttl = 0;
 289                 ip->ip_sum = 0;
 290
 291                 if (alg == CRYPTO_MD5_KPDK || alg == CRYPTO_SHA1_KPDK)
 292                         ip->ip_off &= htons(IP_DF);
 293                 else
 294                         ip->ip_off = htons(0);
 295
 296                 ptr = mtod(m, unsigned char *);
 297
 298                 /* IPv4 option processing */
 299                 for (off = sizeof(struct ip); off < skip;) {
 300                         if (ptr[off] == IPOPT_EOL || ptr[off] == IPOPT_NOP ||
 301                             off + 1 < skip)
 302                                 ;
 303                         else {
 304                                 DPRINTF(("%s: illegal IPv4 option length for "
 305                                         "option %d\n", __func__, ptr[off]));
 306
 307                                 m_freem(m);
 308                                 return EINVAL;
 309                         }
 310
 311                         switch (ptr[off]) {
 312                         case IPOPT_EOL:
 313                                 off = skip;  /* End the loop. */
 314                                 break;
 315
 316                         case IPOPT_NOP:
 317                                 off++;
 318                                 break;
 319
 320                         case IPOPT_SECURITY:    /* 0x82 */
 321                         case 0x85:      /* Extended security. */
 322                         case 0x86:      /* Commercial security. */
 323                         case 0x94:      /* Router alert */
 324                         case 0x95:      /* RFC1770 */
 325                                 /* Sanity check for option length. */
 326                                 if (ptr[off + 1] < 2) {
 327                                         DPRINTF(("%s: illegal IPv4 option "
 328                                                 "length for option %d\n",
 329                                                 __func__, ptr[off]));
 330
 331                                         m_freem(m);
 332                                         return EINVAL;
 333                                 }
 334
 335                                 off += ptr[off + 1];
 336                                 break;
 337
 338                         case IPOPT_LSRR:
 339                         case IPOPT_SSRR:
 340                                 /* Sanity check for option length. */
 341                                 if (ptr[off + 1] < 2) {
 342                                         DPRINTF(("%s: illegal IPv4 option "
 343                                                 "length for option %d\n",
 344                                                 __func__, ptr[off]));
 345
 346                                         m_freem(m);
 347                                         return EINVAL;
 348                                 }
 349
 350                                 /*
 351                                  * On output, if we have either of the
 352                                  * source routing options, we should
 353                                  * swap the destination address of the
 354                                  * IP header with the last address
 355                                  * specified in the option, as that is
 356                                  * what the destination's IP header
 357                                  * will look like.
 358                                  */
 359                                 if (out)
 360                                         bcopy(ptr + off + ptr[off + 1] -
 361                                             sizeof(struct in_addr),
 362                                             &(ip->ip_dst), sizeof(struct in_addr));
 363
 364                                 /* Fall through */
 365                         default:
 366                                 /* Sanity check for option length. */
 367                                 if (ptr[off + 1] < 2) {
 368                                         DPRINTF(("%s: illegal IPv4 option "
 369                                                 "length for option %d\n",
 370                                                 __func__, ptr[off]));
 371                                         m_freem(m);
 372                                         return EINVAL;
 373                                 }
 374
 375                                 /* Zeroize all other options. */
 376                                 count = ptr[off + 1];
 377                                 bcopy(ipseczeroes, ptr + off, count);
 378                                 off += count;
 379                                 break;
 380                         }
 381
 382                         /* Sanity check. */
 383                         if (off > skip) {
 384                                 DPRINTF(("%s: malformed IPv4 options header\n",
 385                                         __func__));
 386
 387                                 m_freem(m);
 388                                 return EINVAL;
 389                         }
 390                 }
 391
 392                 break;
 393 #endif /* INET */
 394
 395 #ifdef INET6
 396         case AF_INET6:  /* Ugly... */
 397                 /* Copy and "cook" the IPv6 header. */
 398                 m_copydata(m, 0, sizeof(ip6), (caddr_t) &ip6);
 399
 400                 /* We don't do IPv6 Jumbograms. */
 401                 if (ip6.ip6_plen == 0) {
 402                         DPRINTF(("%s: unsupported IPv6 jumbogram\n", __func__));
 403                         m_freem(m);
 404                         return EMSGSIZE;
 405                 }
 406
 407                 ip6.ip6_flow = 0;
 408                 ip6.ip6_hlim = 0;
 409                 ip6.ip6_vfc &= ~IPV6_VERSION_MASK;
 410                 ip6.ip6_vfc |= IPV6_VERSION;
 411
 412                 /* Scoped address handling. */
 413                 if (IN6_IS_SCOPE_LINKLOCAL(&ip6.ip6_src))
 414                         ip6.ip6_src.s6_addr16[1] = 0;
 415                 if (IN6_IS_SCOPE_LINKLOCAL(&ip6.ip6_dst))
 416                         ip6.ip6_dst.s6_addr16[1] = 0;
 417
 418                 /* Done with IPv6 header. */
 419                 m_copyback(m, 0, sizeof(struct ip6_hdr), (caddr_t) &ip6);
 420
 421                 /* Let's deal with the remaining headers (if any). */
 422                 if (skip - sizeof(struct ip6_hdr) > 0) {
 423                         if (m->m_len <= skip) {
 424                                 ptr = (unsigned char *) malloc(
 425                                     skip - sizeof(struct ip6_hdr),
 426                                     M_XDATA, M_NOWAIT);
 427                                 if (ptr == NULL) {
 428                                         DPRINTF(("%s: failed to allocate memory"
 429                                                 "for IPv6 headers\n",__func__));
 430                                         m_freem(m);
 431                                         return ENOBUFS;
 432                                 }
 433
 434                                 /*
 435                                  * Copy all the protocol headers after
 436                                  * the IPv6 header.
 437                                  */
 438                                 m_copydata(m, sizeof(struct ip6_hdr),
 439                                     skip - sizeof(struct ip6_hdr), ptr);
 440                                 alloc = 1;
 441                         } else {
 442                                 /* No need to allocate memory. */
 443                                 ptr = mtod(m, unsigned char *) +
 444                                     sizeof(struct ip6_hdr);
 445                                 alloc = 0;
 446                         }
 447                 } else
 448                         break;
 449
 450                 nxt = ip6.ip6_nxt & 0xff; /* Next header type. */
 451
 452                 for (off = 0; off < skip - sizeof(struct ip6_hdr);)
 453                         switch (nxt) {
 454                         case IPPROTO_HOPOPTS:
 455                         case IPPROTO_DSTOPTS:
 456                                 ip6e = (struct ip6_ext *)(ptr + off);
 457                                 noff = off + ((ip6e->ip6e_len + 1) << 3);
 458
 459                                 /* Sanity check. */
 460                                 if (noff > skip - sizeof(struct ip6_hdr))
 461                                         goto error6;
 462
 463                                 /*
 464                                  * Zero out mutable options.
 465                                  */
 466                                 for (count = off + sizeof(struct ip6_ext);
 467                                      count < noff;) {
 468                                         if (ptr[count] == IP6OPT_PAD1) {
 469                                                 count++;
 470                                                 continue; /* Skip padding. */
 471                                         }
 472
 473                                         ad = ptr[count + 1] + 2;
 474                                         if (count + ad > noff)
 475                                                 goto error6;
 476
 477                                         if (ptr[count] & IP6OPT_MUTABLE)
 478                                                 memset(ptr + count, 0, ad);
 479                                         count += ad;
 480                                 }
 481
 482                                 if (count != noff)
 483                                         goto error6;
 484
 485                                 /* Advance. */
 486                                 off += ((ip6e->ip6e_len + 1) << 3);
 487                                 nxt = ip6e->ip6e_nxt;
 488                                 break;
 489
 490                         case IPPROTO_ROUTING:
 491                                 /*
 492                                  * Always include routing headers in
 493                                  * computation.
 494                                  */
 495                                 ip6e = (struct ip6_ext *) (ptr + off);
 496                                 off += ((ip6e->ip6e_len + 1) << 3);
 497                                 nxt = ip6e->ip6e_nxt;
 498                                 break;
 499
 500                         default:
 501                                 DPRINTF(("%s: unexpected IPv6 header type %d",
 502                                         __func__, off));
 503 error6:
 504                                 if (alloc)
 505                                         free(ptr, M_XDATA);
 506                                 m_freem(m);
 507                                 return EINVAL;
 508                         }
 509
 510                 /* Copyback and free, if we allocated. */
 511                 if (alloc) {
 512                         m_copyback(m, sizeof(struct ip6_hdr),
 513                             skip - sizeof(struct ip6_hdr), ptr);
 514                         free(ptr, M_XDATA);
 515                 }
 516
 517                 break;
 518 #endif /* INET6 */
 519         }
 520
 521         return 0;
 522 }
 523
 524 /*
 525  * ah_input() gets called to verify that an input packet
 526  * passes authentication.
 527  */
 528 static int
 529 ah_input(struct mbuf *m, struct secasvar *sav, int skip, int protoff)
 530 {
 531         IPSEC_DEBUG_DECLARE(char buf[128]);
 532         const struct auth_hash *ahx;
 533         struct cryptodesc *crda;
 534         struct cryptop *crp;
 535         struct xform_data *xd;
 536         struct newah *ah;
 537         uint64_t cryptoid;
 538         int hl, rplen, authsize, error;
 539
 540         IPSEC_ASSERT(sav != NULL, ("null SA"));
 541         IPSEC_ASSERT(sav->key_auth != NULL, ("null authentication key"));
 542         IPSEC_ASSERT(sav->tdb_authalgxform != NULL,
 543                 ("null authentication xform"));
 544
 545         /* Figure out header size. */
 546         rplen = HDRSIZE(sav);
 547
 548         /* XXX don't pullup, just copy header */
 549         IP6_EXTHDR_GET(ah, struct newah *, m, skip, rplen);
 550         if (ah == NULL) {
 551                 DPRINTF(("ah_input: cannot pullup header\n"));
 552                 AHSTAT_INC(ahs_hdrops);         /*XXX*/
 553                 error = ENOBUFS;
 554                 goto bad;
 555         }
 556
 557         /* Check replay window, if applicable. */
 558         SECASVAR_LOCK(sav);
 559         if (sav->replay != NULL && sav->replay->wsize != 0 &&
 560             ipsec_chkreplay(ntohl(ah->ah_seq), sav) == 0) {
 561                 SECASVAR_UNLOCK(sav);
 562                 AHSTAT_INC(ahs_replay);
 563                 DPRINTF(("%s: packet replay failure: %s\n", __func__,
 564                     ipsec_sa2str(sav, buf, sizeof(buf))));
 565                 error = EACCES;
 566                 goto bad;
 567         }
 568         cryptoid = sav->tdb_cryptoid;
 569         SECASVAR_UNLOCK(sav);
 570
 571         /* Verify AH header length. */
 572         hl = ah->ah_len * sizeof (u_int32_t);
 573         ahx = sav->tdb_authalgxform;
 574         authsize = AUTHSIZE(sav);
 575         if (hl != authsize + rplen - sizeof (struct ah)) {
 576                 DPRINTF(("%s: bad authenticator length %u (expecting %lu)"
 577                     " for packet in SA %s/%08lx\n", __func__, hl,
 578                     (u_long) (authsize + rplen - sizeof (struct ah)),
 579                     ipsec_address(&sav->sah->saidx.dst, buf, sizeof(buf)),
 580                     (u_long) ntohl(sav->spi)));
 581                 AHSTAT_INC(ahs_badauthl);
 582                 error = EACCES;
 583                 goto bad;
 584         }
 585         AHSTAT_ADD(ahs_ibytes, m->m_pkthdr.len - skip - hl);
 586
 587         /* Get crypto descriptors. */
 588         crp = crypto_getreq(1);
 589         if (crp == NULL) {
 590                 DPRINTF(("%s: failed to acquire crypto descriptor\n",
 591                     __func__));
 592                 AHSTAT_INC(ahs_crypto);
 593                 error = ENOBUFS;
 594                 goto bad;
 595         }
 596
 597         crda = crp->crp_desc;
 598         IPSEC_ASSERT(crda != NULL, ("null crypto descriptor"));
 599
 600         crda->crd_skip = 0;
 601         crda->crd_len = m->m_pkthdr.len;
 602         crda->crd_inject = skip + rplen;
 603
 604         /* Authentication operation. */
 605         crda->crd_alg = ahx->type;
 606         crda->crd_klen = _KEYBITS(sav->key_auth);
 607         crda->crd_key = sav->key_auth->key_data;
 608
 609         /* Allocate IPsec-specific opaque crypto info. */
 610         xd = malloc(sizeof(*xd) + skip + rplen + authsize, M_XDATA,
 611             M_NOWAIT | M_ZERO);
 612         if (xd == NULL) {
 613                 DPRINTF(("%s: failed to allocate xform_data\n", __func__));
 614                 AHSTAT_INC(ahs_crypto);
 615                 crypto_freereq(crp);
 616                 error = ENOBUFS;
 617                 goto bad;
 618         }
 619
 620         /*
 621          * Save the authenticator, the skipped portion of the packet,
 622          * and the AH header.
 623          */
 624         m_copydata(m, 0, skip + rplen + authsize, (caddr_t)(xd + 1));
 625
 626         /* Zeroize the authenticator on the packet. */
 627         m_copyback(m, skip + rplen, authsize, ipseczeroes);
 628
 629         /* "Massage" the packet headers for crypto processing. */
 630         error = ah_massage_headers(&m, sav->sah->saidx.dst.sa.sa_family,
 631             skip, ahx->type, 0);
 632         if (error != 0) {
 633                 /* NB: mbuf is free'd by ah_massage_headers */
 634                 AHSTAT_INC(ahs_hdrops);
 635                 free(xd, M_XDATA);
 636                 crypto_freereq(crp);
 637                 key_freesav(&sav);
 638                 return (error);
 639         }
 640
 641         /* Crypto operation descriptor. */
 642         crp->crp_ilen = m->m_pkthdr.len; /* Total input length. */
 643         crp->crp_flags = CRYPTO_F_IMBUF | CRYPTO_F_CBIFSYNC;
 644         if (V_async_crypto)
 645                 crp->crp_flags |= CRYPTO_F_ASYNC | CRYPTO_F_ASYNC_KEEPORDER;
 646         crp->crp_buf = (caddr_t) m;
 647         crp->crp_callback = ah_input_cb;
 648         crp->crp_sid = cryptoid;
 649         crp->crp_opaque = (caddr_t) xd;
 650
 651         /* These are passed as-is to the callback. */
 652         xd->sav = sav;
 653         xd->nxt = ah->ah_nxt;
 654         xd->protoff = protoff;
 655         xd->skip = skip;
 656         xd->cryptoid = cryptoid;
 657         return (crypto_dispatch(crp));
 658 bad:
 659         m_freem(m);
 660         key_freesav(&sav);
 661         return (error);
 662 }
 663
 664 /*
 665  * AH input callback from the crypto driver.
 666  */
 667 static int
 668 ah_input_cb(struct cryptop *crp)
 669 {
 670         IPSEC_DEBUG_DECLARE(char buf[IPSEC_ADDRSTRLEN]);
 671         unsigned char calc[AH_ALEN_MAX];
 672         struct mbuf *m;
 673         struct xform_data *xd;
 674         struct secasvar *sav;
 675         struct secasindex *saidx;
 676         caddr_t ptr;
 677         uint64_t cryptoid;
 678         int authsize, rplen, error, skip, protoff;
 679         uint8_t nxt;
 680
 681         m = (struct mbuf *) crp->crp_buf;
 682         xd = (struct xform_data *) crp->crp_opaque;
 683         sav = xd->sav;
 684         skip = xd->skip;
 685         nxt = xd->nxt;
 686         protoff = xd->protoff;
 687         cryptoid = xd->cryptoid;
 688         saidx = &sav->sah->saidx;
 689         IPSEC_ASSERT(saidx->dst.sa.sa_family == AF_INET ||
 690                 saidx->dst.sa.sa_family == AF_INET6,
 691                 ("unexpected protocol family %u", saidx->dst.sa.sa_family));
 692
 693         /* Check for crypto errors. */
 694         if (crp->crp_etype) {
 695                 if (crp->crp_etype == EAGAIN) {
 696                         /* Reset the session ID */
 697                         if (ipsec_updateid(sav, &crp->crp_sid, &cryptoid) != 0)
 698                                 crypto_freesession(cryptoid);
 699                         xd->cryptoid = crp->crp_sid;
 700                         return (crypto_dispatch(crp));
 701                 }
 702                 AHSTAT_INC(ahs_noxform);
 703                 DPRINTF(("%s: crypto error %d\n", __func__, crp->crp_etype));
 704                 error = crp->crp_etype;
 705                 goto bad;
 706         } else {
 707                 AHSTAT_INC(ahs_hist[sav->alg_auth]);
 708                 crypto_freereq(crp);            /* No longer needed. */
 709                 crp = NULL;
 710         }
 711
 712         /* Shouldn't happen... */
 713         if (m == NULL) {
 714                 AHSTAT_INC(ahs_crypto);
 715                 DPRINTF(("%s: bogus returned buffer from crypto\n", __func__));
 716                 error = EINVAL;
 717                 goto bad;
 718         }
 719
 720         /* Figure out header size. */
 721         rplen = HDRSIZE(sav);
 722         authsize = AUTHSIZE(sav);
 723
 724         /* Copy authenticator off the packet. */
 725         m_copydata(m, skip + rplen, authsize, calc);
 726
 727         /* Verify authenticator. */
 728         ptr = (caddr_t) (xd + 1);
 729         if (timingsafe_bcmp(ptr + skip + rplen, calc, authsize)) {
 730                 DPRINTF(("%s: authentication hash mismatch for packet "
 731                     "in SA %s/%08lx\n", __func__,
 732                     ipsec_address(&saidx->dst, buf, sizeof(buf)),
 733                     (u_long) ntohl(sav->spi)));
 734                 AHSTAT_INC(ahs_badauth);
 735                 error = EACCES;
 736                 goto bad;
 737         }
 738         /* Fix the Next Protocol field. */
 739         ((uint8_t *) ptr)[protoff] = nxt;
 740
 741         /* Copyback the saved (uncooked) network headers. */
 742         m_copyback(m, 0, skip, ptr);
 743         free(xd, M_XDATA), xd = NULL;                   /* No longer needed */
 744
 745         /*
 746          * Header is now authenticated.
 747          */
 748         m->m_flags |= M_AUTHIPHDR|M_AUTHIPDGM;
 749
 750         /*
 751          * Update replay sequence number, if appropriate.
 752          */
 753         if (sav->replay) {
 754                 u_int32_t seq;
 755
 756                 m_copydata(m, skip + offsetof(struct newah, ah_seq),
 757                            sizeof (seq), (caddr_t) &seq);
 758                 SECASVAR_LOCK(sav);
 759                 if (ipsec_updatereplay(ntohl(seq), sav)) {
 760                         SECASVAR_UNLOCK(sav);
 761                         AHSTAT_INC(ahs_replay);
 762                         error = EACCES;
 763                         goto bad;
 764                 }
 765                 SECASVAR_UNLOCK(sav);
 766         }
 767
 768         /*
 769          * Remove the AH header and authenticator from the mbuf.
 770          */
 771         error = m_striphdr(m, skip, rplen + authsize);
 772         if (error) {
 773                 DPRINTF(("%s: mangled mbuf chain for SA %s/%08lx\n", __func__,
 774                     ipsec_address(&saidx->dst, buf, sizeof(buf)),
 775                     (u_long) ntohl(sav->spi)));
 776                 AHSTAT_INC(ahs_hdrops);
 777                 goto bad;
 778         }
 779
 780         switch (saidx->dst.sa.sa_family) {
 781 #ifdef INET6
 782         case AF_INET6:
 783                 error = ipsec6_common_input_cb(m, sav, skip, protoff);
 784                 break;
 785 #endif
 786 #ifdef INET
 787         case AF_INET:
 788                 error = ipsec4_common_input_cb(m, sav, skip, protoff);
 789                 break;
 790 #endif
 791         default:
 792                 panic("%s: Unexpected address family: %d saidx=%p", __func__,
 793                     saidx->dst.sa.sa_family, saidx);
 794         }
 795         return error;
 796 bad:
 797         if (sav)
 798                 key_freesav(&sav);
 799         if (m != NULL)
 800                 m_freem(m);
 801         if (xd != NULL)
 802                 free(xd, M_XDATA);
 803         if (crp != NULL)
 804                 crypto_freereq(crp);
 805         return error;
 806 }
 807
 808 /*
 809  * AH output routine, called by ipsec[46]_perform_request().
 810  */
 811 static int
 812 ah_output(struct mbuf *m, struct secpolicy *sp, struct secasvar *sav,
 813     u_int idx, int skip, int protoff)
 814 {
 815         IPSEC_DEBUG_DECLARE(char buf[IPSEC_ADDRSTRLEN]);
 816         const struct auth_hash *ahx;
 817         struct cryptodesc *crda;
 818         struct xform_data *xd;
 819         struct mbuf *mi;
 820         struct cryptop *crp;
 821         struct newah *ah;
 822         uint64_t cryptoid;
 823         uint16_t iplen;
 824         int error, rplen, authsize, maxpacketsize, roff;
 825         uint8_t prot;
 826
 827         IPSEC_ASSERT(sav != NULL, ("null SA"));
 828         ahx = sav->tdb_authalgxform;
 829         IPSEC_ASSERT(ahx != NULL, ("null authentication xform"));
 830
 831         AHSTAT_INC(ahs_output);
 832
 833         /* Figure out header size. */
 834         rplen = HDRSIZE(sav);
 835
 836         /* Check for maximum packet size violations. */
 837         switch (sav->sah->saidx.dst.sa.sa_family) {
 838 #ifdef INET
 839         case AF_INET:
 840                 maxpacketsize = IP_MAXPACKET;
 841                 break;
 842 #endif /* INET */
 843 #ifdef INET6
 844         case AF_INET6:
 845                 maxpacketsize = IPV6_MAXPACKET;
 846                 break;
 847 #endif /* INET6 */
 848         default:
 849                 DPRINTF(("%s: unknown/unsupported protocol family %u, "
 850                     "SA %s/%08lx\n", __func__,
 851                     sav->sah->saidx.dst.sa.sa_family,
 852                     ipsec_address(&sav->sah->saidx.dst, buf, sizeof(buf)),
 853                     (u_long) ntohl(sav->spi)));
 854                 AHSTAT_INC(ahs_nopf);
 855                 error = EPFNOSUPPORT;
 856                 goto bad;
 857         }
 858         authsize = AUTHSIZE(sav);
 859         if (rplen + authsize + m->m_pkthdr.len > maxpacketsize) {
 860                 DPRINTF(("%s: packet in SA %s/%08lx got too big "
 861                     "(len %u, max len %u)\n", __func__,
 862                     ipsec_address(&sav->sah->saidx.dst, buf, sizeof(buf)),
 863                     (u_long) ntohl(sav->spi),
 864                     rplen + authsize + m->m_pkthdr.len, maxpacketsize));
 865                 AHSTAT_INC(ahs_toobig);
 866                 error = EMSGSIZE;
 867                 goto bad;
 868         }
 869
 870         /* Update the counters. */
 871         AHSTAT_ADD(ahs_obytes, m->m_pkthdr.len - skip);
 872
 873         m = m_unshare(m, M_NOWAIT);
 874         if (m == NULL) {
 875                 DPRINTF(("%s: cannot clone mbuf chain, SA %s/%08lx\n", __func__,
 876                     ipsec_address(&sav->sah->saidx.dst, buf, sizeof(buf)),
 877                     (u_long) ntohl(sav->spi)));
 878                 AHSTAT_INC(ahs_hdrops);
 879                 error = ENOBUFS;
 880                 goto bad;
 881         }
 882
 883         /* Inject AH header. */
 884         mi = m_makespace(m, skip, rplen + authsize, &roff);
 885         if (mi == NULL) {
 886                 DPRINTF(("%s: failed to inject %u byte AH header for SA "
 887                     "%s/%08lx\n", __func__,
 888                     rplen + authsize,
 889                     ipsec_address(&sav->sah->saidx.dst, buf, sizeof(buf)),
 890                     (u_long) ntohl(sav->spi)));
 891                 AHSTAT_INC(ahs_hdrops);         /*XXX differs from openbsd */
 892                 error = ENOBUFS;
 893                 goto bad;
 894         }
 895
 896         /*
 897          * The AH header is guaranteed by m_makespace() to be in
 898          * contiguous memory, at roff bytes offset into the returned mbuf.
 899          */
 900         ah = (struct newah *)(mtod(mi, caddr_t) + roff);
 901
 902         /* Initialize the AH header. */
 903         m_copydata(m, protoff, sizeof(u_int8_t), (caddr_t) &ah->ah_nxt);
 904         ah->ah_len = (rplen + authsize - sizeof(struct ah)) / sizeof(u_int32_t);
 905         ah->ah_reserve = 0;
 906         ah->ah_spi = sav->spi;
 907
 908         /* Zeroize authenticator. */
 909         m_copyback(m, skip + rplen, authsize, ipseczeroes);
 910
 911         /* Insert packet replay counter, as requested.  */
 912         SECASVAR_LOCK(sav);
 913         if (sav->replay) {
 914                 if (sav->replay->count == ~0 &&
 915                     (sav->flags & SADB_X_EXT_CYCSEQ) == 0) {
 916                         SECASVAR_UNLOCK(sav);
 917                         DPRINTF(("%s: replay counter wrapped for SA %s/%08lx\n",
 918                             __func__, ipsec_address(&sav->sah->saidx.dst, buf,
 919                             sizeof(buf)), (u_long) ntohl(sav->spi)));
 920                         AHSTAT_INC(ahs_wrap);
 921                         error = EACCES;
 922                         goto bad;
 923                 }
 924 #ifdef REGRESSION
 925                 /* Emulate replay attack when ipsec_replay is TRUE. */
 926                 if (!V_ipsec_replay)
 927 #endif
 928                         sav->replay->count++;
 929                 ah->ah_seq = htonl(sav->replay->count);
 930         }
 931         cryptoid = sav->tdb_cryptoid;
 932         SECASVAR_UNLOCK(sav);
 933
 934         /* Get crypto descriptors. */
 935         crp = crypto_getreq(1);
 936         if (crp == NULL) {
 937                 DPRINTF(("%s: failed to acquire crypto descriptors\n",
 938                         __func__));
 939                 AHSTAT_INC(ahs_crypto);
 940                 error = ENOBUFS;
 941                 goto bad;
 942         }
 943
 944         crda = crp->crp_desc;
 945         crda->crd_skip = 0;
 946         crda->crd_inject = skip + rplen;
 947         crda->crd_len = m->m_pkthdr.len;
 948
 949         /* Authentication operation. */
 950         crda->crd_alg = ahx->type;
 951         crda->crd_key = sav->key_auth->key_data;
 952         crda->crd_klen = _KEYBITS(sav->key_auth);
 953
 954         /* Allocate IPsec-specific opaque crypto info. */
 955         xd =  malloc(sizeof(struct xform_data) + skip, M_XDATA,
 956             M_NOWAIT | M_ZERO);
 957         if (xd == NULL) {
 958                 crypto_freereq(crp);
 959                 DPRINTF(("%s: failed to allocate xform_data\n", __func__));
 960                 AHSTAT_INC(ahs_crypto);
 961                 error = ENOBUFS;
 962                 goto bad;
 963         }
 964
 965         /* Save the skipped portion of the packet. */
 966         m_copydata(m, 0, skip, (caddr_t) (xd + 1));
 967
 968         /*
 969          * Fix IP header length on the header used for
 970          * authentication. We don't need to fix the original
 971          * header length as it will be fixed by our caller.
 972          */
 973         switch (sav->sah->saidx.dst.sa.sa_family) {
 974 #ifdef INET
 975         case AF_INET:
 976                 bcopy(((caddr_t)(xd + 1)) +
 977                     offsetof(struct ip, ip_len),
 978                     (caddr_t) &iplen, sizeof(u_int16_t));
 979                 iplen = htons(ntohs(iplen) + rplen + authsize);
 980                 m_copyback(m, offsetof(struct ip, ip_len),
 981                     sizeof(u_int16_t), (caddr_t) &iplen);
 982                 break;
 983 #endif /* INET */
 984
 985 #ifdef INET6
 986         case AF_INET6:
 987                 bcopy(((caddr_t)(xd + 1)) +
 988                     offsetof(struct ip6_hdr, ip6_plen),
 989                     (caddr_t) &iplen, sizeof(uint16_t));
 990                 iplen = htons(ntohs(iplen) + rplen + authsize);
 991                 m_copyback(m, offsetof(struct ip6_hdr, ip6_plen),
 992                     sizeof(uint16_t), (caddr_t) &iplen);
 993                 break;
 994 #endif /* INET6 */
 995         }
 996
 997         /* Fix the Next Header field in saved header. */
 998         ((uint8_t *) (xd + 1))[protoff] = IPPROTO_AH;
 999
1000         /* Update the Next Protocol field in the IP header. */
1001         prot = IPPROTO_AH;
1002         m_copyback(m, protoff, sizeof(uint8_t), (caddr_t) &prot);
1003
1004         /* "Massage" the packet headers for crypto processing. */
1005         error = ah_massage_headers(&m, sav->sah->saidx.dst.sa.sa_family,
1006                         skip, ahx->type, 1);
1007         if (error != 0) {
1008                 m = NULL;       /* mbuf was free'd by ah_massage_headers. */
1009                 free(xd, M_XDATA);
1010                 crypto_freereq(crp);
1011                 goto bad;
1012         }
1013
1014         /* Crypto operation descriptor. */
1015         crp->crp_ilen = m->m_pkthdr.len; /* Total input length. */
1016         crp->crp_flags = CRYPTO_F_IMBUF | CRYPTO_F_CBIFSYNC;
1017         if (V_async_crypto)
1018                 crp->crp_flags |= CRYPTO_F_ASYNC | CRYPTO_F_ASYNC_KEEPORDER;
1019         crp->crp_buf = (caddr_t) m;
1020         crp->crp_callback = ah_output_cb;
1021         crp->crp_sid = cryptoid;
1022         crp->crp_opaque = (caddr_t) xd;
1023
1024         /* These are passed as-is to the callback. */
1025         xd->sp = sp;
1026         xd->sav = sav;
1027         xd->skip = skip;
1028         xd->idx = idx;
1029         xd->cryptoid = cryptoid;
1030
1031         return crypto_dispatch(crp);
1032 bad:
1033         if (m)
1034                 m_freem(m);
1035         key_freesav(&sav);
1036         key_freesp(&sp);
1037         return (error);
1038 }
1039
1040 /*
1041  * AH output callback from the crypto driver.
1042  */
1043 static int
1044 ah_output_cb(struct cryptop *crp)
1045 {
1046         struct xform_data *xd;
1047         struct secpolicy *sp;
1048         struct secasvar *sav;
1049         struct mbuf *m;
1050         uint64_t cryptoid;
1051         caddr_t ptr;
1052         u_int idx;
1053         int skip, error;
1054
1055         m = (struct mbuf *) crp->crp_buf;
1056         xd = (struct xform_data *) crp->crp_opaque;
1057         sp = xd->sp;
1058         sav = xd->sav;
1059         skip = xd->skip;
1060         idx = xd->idx;
1061         cryptoid = xd->cryptoid;
1062         ptr = (caddr_t) (xd + 1);
1063
1064         /* Check for crypto errors. */
1065         if (crp->crp_etype) {
1066                 if (crp->crp_etype == EAGAIN) {
1067                         /* Reset the session ID */
1068                         if (ipsec_updateid(sav, &crp->crp_sid, &cryptoid) != 0)
1069                                 crypto_freesession(cryptoid);
1070                         xd->cryptoid = crp->crp_sid;
1071                         return (crypto_dispatch(crp));
1072                 }
1073                 AHSTAT_INC(ahs_noxform);
1074                 DPRINTF(("%s: crypto error %d\n", __func__, crp->crp_etype));
1075                 error = crp->crp_etype;
1076                 m_freem(m);
1077                 goto bad;
1078         }
1079
1080         /* Shouldn't happen... */
1081         if (m == NULL) {
1082                 AHSTAT_INC(ahs_crypto);
1083                 DPRINTF(("%s: bogus returned buffer from crypto\n", __func__));
1084                 error = EINVAL;
1085                 goto bad;
1086         }
1087         /*
1088          * Copy original headers (with the new protocol number) back
1089          * in place.
1090          */
1091         m_copyback(m, 0, skip, ptr);
1092
1093         free(xd, M_XDATA);
1094         crypto_freereq(crp);
1095         AHSTAT_INC(ahs_hist[sav->alg_auth]);
1096 #ifdef REGRESSION
1097         /* Emulate man-in-the-middle attack when ipsec_integrity is TRUE. */
1098         if (V_ipsec_integrity) {
1099                 int alen;
1100
1101                 /*
1102                  * Corrupt HMAC if we want to test integrity verification of
1103                  * the other side.
1104                  */
1105                 alen = AUTHSIZE(sav);
1106                 m_copyback(m, m->m_pkthdr.len - alen, alen, ipseczeroes);
1107         }
1108 #endif
1109
1110         /* NB: m is reclaimed by ipsec_process_done. */
1111         error = ipsec_process_done(m, sp, sav, idx);
1112         return (error);
1113 bad:
1114         free(xd, M_XDATA);
1115         crypto_freereq(crp);
1116         key_freesav(&sav);
1117         key_freesp(&sp);
1118         return (error);
1119 }
1120
1121 static struct xformsw ah_xformsw = {
1122         .xf_type =      XF_AH,
1123         .xf_name =      "IPsec AH",
1124         .xf_init =      ah_init,
1125         .xf_zeroize =   ah_zeroize,
1126         .xf_input =     ah_input,
1127         .xf_output =    ah_output,
1128 };
1129
1130 SYSINIT(ah_xform_init, SI_SUB_PROTO_DOMAIN, SI_ORDER_MIDDLE,
1131     xform_attach, &ah_xformsw);
1132 SYSUNINIT(ah_xform_uninit, SI_SUB_PROTO_DOMAIN, SI_ORDER_MIDDLE,
1133     xform_detach, &ah_xformsw);