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