sys/netipsec/xform_esp.c

   1 /*      $FreeBSD$       */
   2 /*      $OpenBSD: ip_esp.c,v 1.69 2001/06/26 06:18:59 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.
  18  *
  19  * Copyright (C) 1995, 1996, 1997, 1998, 1999 by John Ioannidis,
  20  * Angelos D. Keromytis and Niels Provos.
  21  * Copyright (c) 2001 Angelos D. Keromytis.
  22  *
  23  * Permission to use, copy, and modify this software with or without fee
  24  * is hereby granted, provided that this entire notice is included in
  25  * all copies of any software which is or includes a copy or
  26  * modification of this software.
  27  * You may use this code under the GNU public license if you so wish. Please
  28  * contribute changes back to the authors under this freer than GPL license
  29  * so that we may further the use of strong encryption without limitations to
  30  * all.
  31  *
  32  * THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR
  33  * IMPLIED WARRANTY. IN PARTICULAR, NONE OF THE AUTHORS MAKES ANY
  34  * REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE
  35  * MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR
  36  * PURPOSE.
  37  */
  38 #include "opt_inet.h"
  39 #include "opt_inet6.h"
  40 #include "opt_ipsec.h"
  41
  42 #include <sys/param.h>
  43 #include <sys/systm.h>
  44 #include <sys/malloc.h>
  45 #include <sys/mbuf.h>
  46 #include <sys/socket.h>
  47 #include <sys/syslog.h>
  48 #include <sys/kernel.h>
  49 #include <sys/lock.h>
  50 #include <sys/random.h>
  51 #include <sys/mutex.h>
  52 #include <sys/sysctl.h>
  53 #include <sys/mutex.h>
  54 #include <machine/atomic.h>
  55
  56 #include <net/if.h>
  57 #include <net/vnet.h>
  58
  59 #include <netinet/in.h>
  60 #include <netinet/in_systm.h>
  61 #include <netinet/ip.h>
  62 #include <netinet/ip_ecn.h>
  63 #include <netinet/ip6.h>
  64
  65 #include <netipsec/ipsec.h>
  66 #include <netipsec/ah.h>
  67 #include <netipsec/ah_var.h>
  68 #include <netipsec/esp.h>
  69 #include <netipsec/esp_var.h>
  70 #include <netipsec/xform.h>
  71
  72 #ifdef INET6
  73 #include <netinet6/ip6_var.h>
  74 #include <netipsec/ipsec6.h>
  75 #include <netinet6/ip6_ecn.h>
  76 #endif
  77
  78 #include <netipsec/key.h>
  79 #include <netipsec/key_debug.h>
  80
  81 #include <opencrypto/cryptodev.h>
  82 #include <opencrypto/xform.h>
  83
  84 #define SPI_SIZE        4
  85
  86 VNET_DEFINE(int, esp_enable) = 1;
  87 VNET_DEFINE_STATIC(int, esp_ctr_compatibility) = 1;
  88 #define V_esp_ctr_compatibility VNET(esp_ctr_compatibility)
  89 VNET_PCPUSTAT_DEFINE(struct espstat, espstat);
  90 VNET_PCPUSTAT_SYSINIT(espstat);
  91
  92 #ifdef VIMAGE
  93 VNET_PCPUSTAT_SYSUNINIT(espstat);
  94 #endif /* VIMAGE */
  95
  96 SYSCTL_DECL(_net_inet_esp);
  97 SYSCTL_INT(_net_inet_esp, OID_AUTO, esp_enable,
  98         CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(esp_enable), 0, "");
  99 SYSCTL_INT(_net_inet_esp, OID_AUTO, ctr_compatibility,
 100     CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(esp_ctr_compatibility), 0,
 101     "Align AES-CTR encrypted transmitted frames to blocksize");
 102 SYSCTL_VNET_PCPUSTAT(_net_inet_esp, IPSECCTL_STATS, stats,
 103     struct espstat, espstat,
 104     "ESP statistics (struct espstat, netipsec/esp_var.h");
 105
 106 static MALLOC_DEFINE(M_ESP, "esp", "IPsec ESP");
 107
 108 static int esp_input_cb(struct cryptop *op);
 109 static int esp_output_cb(struct cryptop *crp);
 110
 111 size_t
 112 esp_hdrsiz(struct secasvar *sav)
 113 {
 114         size_t size;
 115
 116         if (sav != NULL) {
 117                 /*XXX not right for null algorithm--does it matter??*/
 118                 IPSEC_ASSERT(sav->tdb_encalgxform != NULL,
 119                         ("SA with null xform"));
 120                 if (sav->flags & SADB_X_EXT_OLD)
 121                         size = sizeof (struct esp);
 122                 else
 123                         size = sizeof (struct newesp);
 124                 size += sav->tdb_encalgxform->blocksize + 9;
 125                 /*XXX need alg check???*/
 126                 if (sav->tdb_authalgxform != NULL && sav->replay)
 127                         size += ah_hdrsiz(sav);
 128         } else {
 129                 /*
 130                  *   base header size
 131                  * + max iv length for CBC mode
 132                  * + max pad length
 133                  * + sizeof (pad length field)
 134                  * + sizeof (next header field)
 135                  * + max icv supported.
 136                  */
 137                 size = sizeof (struct newesp) + EALG_MAX_BLOCK_LEN + 9 + 16;
 138         }
 139         return size;
 140 }
 141
 142 /*
 143  * esp_init() is called when an SPI is being set up.
 144  */
 145 static int
 146 esp_init(struct secasvar *sav, struct xformsw *xsp)
 147 {
 148         const struct enc_xform *txform;
 149         struct crypto_session_params csp;
 150         int keylen;
 151         int error;
 152
 153         txform = enc_algorithm_lookup(sav->alg_enc);
 154         if (txform == NULL) {
 155                 DPRINTF(("%s: unsupported encryption algorithm %d\n",
 156                         __func__, sav->alg_enc));
 157                 return EINVAL;
 158         }
 159         if (sav->key_enc == NULL) {
 160                 DPRINTF(("%s: no encoding key for %s algorithm\n",
 161                          __func__, txform->name));
 162                 return EINVAL;
 163         }
 164         if ((sav->flags & (SADB_X_EXT_OLD | SADB_X_EXT_IV4B)) ==
 165             SADB_X_EXT_IV4B) {
 166                 DPRINTF(("%s: 4-byte IV not supported with protocol\n",
 167                         __func__));
 168                 return EINVAL;
 169         }
 170
 171         /* subtract off the salt, RFC4106, 8.1 and RFC3686, 5.1 */
 172         keylen = _KEYLEN(sav->key_enc) - SAV_ISCTRORGCM(sav) * 4;
 173         if (txform->minkey > keylen || keylen > txform->maxkey) {
 174                 DPRINTF(("%s: invalid key length %u, must be in the range "
 175                         "[%u..%u] for algorithm %s\n", __func__,
 176                         keylen, txform->minkey, txform->maxkey,
 177                         txform->name));
 178                 return EINVAL;
 179         }
 180
 181         if (SAV_ISCTRORGCM(sav))
 182                 sav->ivlen = 8; /* RFC4106 3.1 and RFC3686 3.1 */
 183         else
 184                 sav->ivlen = txform->ivsize;
 185
 186         memset(&csp, 0, sizeof(csp));
 187
 188         /*
 189          * Setup AH-related state.
 190          */
 191         if (sav->alg_auth != 0) {
 192                 error = ah_init0(sav, xsp, &csp);
 193                 if (error)
 194                         return error;
 195         }
 196
 197         /* NB: override anything set in ah_init0 */
 198         sav->tdb_xform = xsp;
 199         sav->tdb_encalgxform = txform;
 200
 201         /*
 202          * Whenever AES-GCM is used for encryption, one
 203          * of the AES authentication algorithms is chosen
 204          * as well, based on the key size.
 205          */
 206         if (sav->alg_enc == SADB_X_EALG_AESGCM16) {
 207                 switch (keylen) {
 208                 case AES_128_GMAC_KEY_LEN:
 209                         sav->alg_auth = SADB_X_AALG_AES128GMAC;
 210                         sav->tdb_authalgxform = &auth_hash_nist_gmac_aes_128;
 211                         break;
 212                 case AES_192_GMAC_KEY_LEN:
 213                         sav->alg_auth = SADB_X_AALG_AES192GMAC;
 214                         sav->tdb_authalgxform = &auth_hash_nist_gmac_aes_192;
 215                         break;
 216                 case AES_256_GMAC_KEY_LEN:
 217                         sav->alg_auth = SADB_X_AALG_AES256GMAC;
 218                         sav->tdb_authalgxform = &auth_hash_nist_gmac_aes_256;
 219                         break;
 220                 default:
 221                         DPRINTF(("%s: invalid key length %u"
 222                                  "for algorithm %s\n", __func__,
 223                                  keylen, txform->name));
 224                         return EINVAL;
 225                 }
 226                 csp.csp_mode = CSP_MODE_AEAD;
 227                 if (sav->flags & SADB_X_SAFLAGS_ESN)
 228                         csp.csp_flags |= CSP_F_SEPARATE_AAD;
 229         } else if (sav->alg_auth != 0) {
 230                 csp.csp_mode = CSP_MODE_ETA;
 231                 if (sav->flags & SADB_X_SAFLAGS_ESN)
 232                         csp.csp_flags |= CSP_F_ESN;
 233         } else
 234                 csp.csp_mode = CSP_MODE_CIPHER;
 235
 236         /* Initialize crypto session. */
 237         csp.csp_cipher_alg = sav->tdb_encalgxform->type;
 238         if (csp.csp_cipher_alg != CRYPTO_NULL_CBC) {
 239                 csp.csp_cipher_key = sav->key_enc->key_data;
 240                 csp.csp_cipher_klen = _KEYBITS(sav->key_enc) / 8 -
 241                     SAV_ISCTRORGCM(sav) * 4;
 242         };
 243         csp.csp_ivlen = txform->ivsize;
 244
 245         error = crypto_newsession(&sav->tdb_cryptoid, &csp, V_crypto_support);
 246         return error;
 247 }
 248
 249 static void
 250 esp_cleanup(struct secasvar *sav)
 251 {
 252
 253         crypto_freesession(sav->tdb_cryptoid);
 254         sav->tdb_cryptoid = NULL;
 255         sav->tdb_authalgxform = NULL;
 256         sav->tdb_encalgxform = NULL;
 257 }
 258
 259 /*
 260  * ESP input processing, called (eventually) through the protocol switch.
 261  */
 262 static int
 263 esp_input(struct mbuf *m, struct secasvar *sav, int skip, int protoff)
 264 {
 265         IPSEC_DEBUG_DECLARE(char buf[128]);
 266         const struct auth_hash *esph;
 267         const struct enc_xform *espx;
 268         struct xform_data *xd;
 269         struct cryptop *crp;
 270         struct newesp *esp;
 271         uint8_t *ivp;
 272         crypto_session_t cryptoid;
 273         int alen, error, hlen, plen;
 274         uint32_t seqh;
 275         const struct crypto_session_params *csp;
 276
 277         SECASVAR_RLOCK_TRACKER;
 278
 279         IPSEC_ASSERT(sav != NULL, ("null SA"));
 280         IPSEC_ASSERT(sav->tdb_encalgxform != NULL, ("null encoding xform"));
 281
 282         error = EINVAL;
 283         /* Valid IP Packet length ? */
 284         if ( (skip&3) || (m->m_pkthdr.len&3) ){
 285                 DPRINTF(("%s: misaligned packet, skip %u pkt len %u",
 286                                 __func__, skip, m->m_pkthdr.len));
 287                 ESPSTAT_INC(esps_badilen);
 288                 goto bad;
 289         }
 290
 291         if (m->m_len < skip + sizeof(*esp)) {
 292                 m = m_pullup(m, skip + sizeof(*esp));
 293                 if (m == NULL) {
 294                         DPRINTF(("%s: cannot pullup header\n", __func__));
 295                         ESPSTAT_INC(esps_hdrops);       /*XXX*/
 296                         error = ENOBUFS;
 297                         goto bad;
 298                 }
 299         }
 300         esp = (struct newesp *)(mtod(m, caddr_t) + skip);
 301
 302         esph = sav->tdb_authalgxform;
 303         espx = sav->tdb_encalgxform;
 304
 305         /* Determine the ESP header and auth length */
 306         if (sav->flags & SADB_X_EXT_OLD)
 307                 hlen = sizeof (struct esp) + sav->ivlen;
 308         else
 309                 hlen = sizeof (struct newesp) + sav->ivlen;
 310
 311         alen = xform_ah_authsize(esph);
 312
 313         /*
 314          * Verify payload length is multiple of encryption algorithm
 315          * block size.
 316          *
 317          * NB: This works for the null algorithm because the blocksize
 318          *     is 4 and all packets must be 4-byte aligned regardless
 319          *     of the algorithm.
 320          */
 321         plen = m->m_pkthdr.len - (skip + hlen + alen);
 322         if ((plen & (espx->blocksize - 1)) || (plen <= 0)) {
 323                 DPRINTF(("%s: payload of %d octets not a multiple of %d octets,"
 324                     "  SA %s/%08lx\n", __func__, plen, espx->blocksize,
 325                     ipsec_address(&sav->sah->saidx.dst, buf, sizeof(buf)),
 326                     (u_long)ntohl(sav->spi)));
 327                 ESPSTAT_INC(esps_badilen);
 328                 goto bad;
 329         }
 330
 331         /*
 332          * Check sequence number.
 333          */
 334         SECASVAR_RLOCK(sav);
 335         if (esph != NULL && sav->replay != NULL && sav->replay->wsize != 0) {
 336                 if (ipsec_chkreplay(ntohl(esp->esp_seq), &seqh, sav) == 0) {
 337                         SECASVAR_RUNLOCK(sav);
 338                         DPRINTF(("%s: packet replay check for %s\n", __func__,
 339                             ipsec_sa2str(sav, buf, sizeof(buf))));
 340                         ESPSTAT_INC(esps_replay);
 341                         error = EACCES;
 342                         goto bad;
 343                 }
 344                 seqh = htonl(seqh);
 345         }
 346         cryptoid = sav->tdb_cryptoid;
 347         SECASVAR_RUNLOCK(sav);
 348
 349         /* Update the counters */
 350         ESPSTAT_ADD(esps_ibytes, m->m_pkthdr.len - (skip + hlen + alen));
 351
 352         /* Get crypto descriptors */
 353         crp = crypto_getreq(cryptoid, M_NOWAIT);
 354         if (crp == NULL) {
 355                 DPRINTF(("%s: failed to acquire crypto descriptors\n",
 356                         __func__));
 357                 ESPSTAT_INC(esps_crypto);
 358                 error = ENOBUFS;
 359                 goto bad;
 360         }
 361
 362         /* Get IPsec-specific opaque pointer */
 363         xd = malloc(sizeof(*xd), M_ESP, M_NOWAIT | M_ZERO);
 364         if (xd == NULL) {
 365                 DPRINTF(("%s: failed to allocate xform_data\n", __func__));
 366                 goto xd_fail;
 367         }
 368
 369         if (esph != NULL) {
 370                 crp->crp_op = CRYPTO_OP_VERIFY_DIGEST;
 371                 if (SAV_ISGCM(sav))
 372                         crp->crp_aad_length = 8; /* RFC4106 5, SPI + SN */
 373                 else
 374                         crp->crp_aad_length = hlen;
 375
 376                 csp = crypto_get_params(crp->crp_session);
 377                 if ((csp->csp_flags & CSP_F_SEPARATE_AAD) &&
 378                     (sav->replay != NULL) && (sav->replay->wsize != 0)) {
 379                         int aad_skip;
 380
 381                         crp->crp_aad_length += sizeof(seqh);
 382                         crp->crp_aad = malloc(crp->crp_aad_length, M_ESP, M_NOWAIT);
 383                         if (crp->crp_aad == NULL) {
 384                                 DPRINTF(("%s: failed to allocate xform_data\n",
 385                                          __func__));
 386                                 goto crp_aad_fail;
 387                         }
 388
 389                         /* SPI */
 390                         m_copydata(m, skip, SPI_SIZE, crp->crp_aad);
 391                         aad_skip = SPI_SIZE;
 392
 393                         /* ESN */
 394                         bcopy(&seqh, (char *)crp->crp_aad + aad_skip, sizeof(seqh));
 395                         aad_skip += sizeof(seqh);
 396
 397                         /* Rest of aad */
 398                         if (crp->crp_aad_length - aad_skip > 0)
 399                                 m_copydata(m, skip + SPI_SIZE,
 400                                            crp->crp_aad_length - aad_skip,
 401                                            (char *)crp->crp_aad + aad_skip);
 402                 } else
 403                         crp->crp_aad_start = skip;
 404
 405                 if (csp->csp_flags & CSP_F_ESN &&
 406                            sav->replay != NULL && sav->replay->wsize != 0)
 407                         memcpy(crp->crp_esn, &seqh, sizeof(seqh));
 408
 409                 crp->crp_digest_start = m->m_pkthdr.len - alen;
 410         }
 411
 412         /* Crypto operation descriptor */
 413         crp->crp_flags = CRYPTO_F_CBIFSYNC;
 414         if (V_async_crypto)
 415                 crp->crp_flags |= CRYPTO_F_ASYNC | CRYPTO_F_ASYNC_KEEPORDER;
 416         crypto_use_mbuf(crp, m);
 417         crp->crp_callback = esp_input_cb;
 418         crp->crp_opaque = xd;
 419
 420         /* These are passed as-is to the callback */
 421         xd->sav = sav;
 422         xd->protoff = protoff;
 423         xd->skip = skip;
 424         xd->cryptoid = cryptoid;
 425         xd->vnet = curvnet;
 426
 427         /* Decryption descriptor */
 428         crp->crp_op |= CRYPTO_OP_DECRYPT;
 429         crp->crp_payload_start = skip + hlen;
 430         crp->crp_payload_length = m->m_pkthdr.len - (skip + hlen + alen);
 431
 432         /* Generate or read cipher IV. */
 433         if (SAV_ISCTRORGCM(sav)) {
 434                 ivp = &crp->crp_iv[0];
 435
 436                 /*
 437                  * AES-GCM and AES-CTR use similar cipher IV formats
 438                  * defined in RFC 4106 section 4 and RFC 3686 section
 439                  * 4, respectively.
 440                  *
 441                  * The first 4 bytes of the cipher IV contain an
 442                  * implicit salt, or nonce, obtained from the last 4
 443                  * bytes of the encryption key.  The next 8 bytes hold
 444                  * an explicit IV unique to each packet.  This
 445                  * explicit IV is used as the ESP IV for the packet.
 446                  * The last 4 bytes hold a big-endian block counter
 447                  * incremented for each block.  For AES-GCM, the block
 448                  * counter's initial value is defined as part of the
 449                  * algorithm.  For AES-CTR, the block counter's
 450                  * initial value for each packet is defined as 1 by
 451                  * RFC 3686.
 452                  *
 453                  * ------------------------------------------
 454                  * | Salt | Explicit ESP IV | Block Counter |
 455                  * ------------------------------------------
 456                  *  4 bytes     8 bytes          4 bytes
 457                  */
 458                 memcpy(ivp, sav->key_enc->key_data +
 459                     _KEYLEN(sav->key_enc) - 4, 4);
 460                 m_copydata(m, skip + hlen - sav->ivlen, sav->ivlen, &ivp[4]);
 461                 if (SAV_ISCTR(sav)) {
 462                         be32enc(&ivp[sav->ivlen + 4], 1);
 463                 }
 464                 crp->crp_flags |= CRYPTO_F_IV_SEPARATE;
 465         } else if (sav->ivlen != 0)
 466                 crp->crp_iv_start = skip + hlen - sav->ivlen;
 467
 468         return (crypto_dispatch(crp));
 469
 470 crp_aad_fail:
 471         free(xd, M_ESP);
 472 xd_fail:
 473         crypto_freereq(crp);
 474         ESPSTAT_INC(esps_crypto);
 475         error = ENOBUFS;
 476 bad:
 477         m_freem(m);
 478         key_freesav(&sav);
 479         return (error);
 480 }
 481
 482 /*
 483  * ESP input callback from the crypto driver.
 484  */
 485 static int
 486 esp_input_cb(struct cryptop *crp)
 487 {
 488         IPSEC_DEBUG_DECLARE(char buf[128]);
 489         uint8_t lastthree[3];
 490         const struct auth_hash *esph;
 491         struct mbuf *m;
 492         struct xform_data *xd;
 493         struct secasvar *sav;
 494         struct secasindex *saidx;
 495         crypto_session_t cryptoid;
 496         int hlen, skip, protoff, error, alen;
 497
 498         SECASVAR_RLOCK_TRACKER;
 499
 500         m = crp->crp_buf.cb_mbuf;
 501         xd = crp->crp_opaque;
 502         CURVNET_SET(xd->vnet);
 503         sav = xd->sav;
 504         skip = xd->skip;
 505         protoff = xd->protoff;
 506         cryptoid = xd->cryptoid;
 507         saidx = &sav->sah->saidx;
 508         esph = sav->tdb_authalgxform;
 509
 510         /* Check for crypto errors */
 511         if (crp->crp_etype) {
 512                 if (crp->crp_etype == EAGAIN) {
 513                         /* Reset the session ID */
 514                         if (ipsec_updateid(sav, &crp->crp_session, &cryptoid) != 0)
 515                                 crypto_freesession(cryptoid);
 516                         xd->cryptoid = crp->crp_session;
 517                         CURVNET_RESTORE();
 518                         return (crypto_dispatch(crp));
 519                 }
 520
 521                 /* EBADMSG indicates authentication failure. */
 522                 if (!(crp->crp_etype == EBADMSG && esph != NULL)) {
 523                         ESPSTAT_INC(esps_noxform);
 524                         DPRINTF(("%s: crypto error %d\n", __func__,
 525                                 crp->crp_etype));
 526                         error = crp->crp_etype;
 527                         goto bad;
 528                 }
 529         }
 530
 531         /* Shouldn't happen... */
 532         if (m == NULL) {
 533                 ESPSTAT_INC(esps_crypto);
 534                 DPRINTF(("%s: bogus returned buffer from crypto\n", __func__));
 535                 error = EINVAL;
 536                 goto bad;
 537         }
 538         ESPSTAT_INC(esps_hist[sav->alg_enc]);
 539
 540         /* If authentication was performed, check now. */
 541         if (esph != NULL) {
 542                 alen = xform_ah_authsize(esph);
 543                 AHSTAT_INC(ahs_hist[sav->alg_auth]);
 544                 if (crp->crp_etype == EBADMSG) {
 545                         DPRINTF(("%s: authentication hash mismatch for "
 546                             "packet in SA %s/%08lx\n", __func__,
 547                             ipsec_address(&saidx->dst, buf, sizeof(buf)),
 548                             (u_long) ntohl(sav->spi)));
 549                         ESPSTAT_INC(esps_badauth);
 550                         error = EACCES;
 551                         goto bad;
 552                 }
 553                 m->m_flags |= M_AUTHIPDGM;
 554                 /* Remove trailing authenticator */
 555                 m_adj(m, -alen);
 556         }
 557
 558         /* Release the crypto descriptors */
 559         free(xd, M_ESP), xd = NULL;
 560         free(crp->crp_aad, M_ESP), crp->crp_aad = NULL;
 561         crypto_freereq(crp), crp = NULL;
 562
 563         /*
 564          * Packet is now decrypted.
 565          */
 566         m->m_flags |= M_DECRYPTED;
 567
 568         /*
 569          * Update replay sequence number, if appropriate.
 570          */
 571         if (sav->replay) {
 572                 u_int32_t seq;
 573
 574                 m_copydata(m, skip + offsetof(struct newesp, esp_seq),
 575                            sizeof (seq), (caddr_t) &seq);
 576                 SECASVAR_RLOCK(sav);
 577                 if (ipsec_updatereplay(ntohl(seq), sav)) {
 578                         SECASVAR_RUNLOCK(sav);
 579                         DPRINTF(("%s: packet replay check for %s\n", __func__,
 580                             ipsec_sa2str(sav, buf, sizeof(buf))));
 581                         ESPSTAT_INC(esps_replay);
 582                         error = EACCES;
 583                         goto bad;
 584                 }
 585                 SECASVAR_RUNLOCK(sav);
 586         }
 587
 588         /* Determine the ESP header length */
 589         if (sav->flags & SADB_X_EXT_OLD)
 590                 hlen = sizeof (struct esp) + sav->ivlen;
 591         else
 592                 hlen = sizeof (struct newesp) + sav->ivlen;
 593
 594         /* Remove the ESP header and IV from the mbuf. */
 595         error = m_striphdr(m, skip, hlen);
 596         if (error) {
 597                 ESPSTAT_INC(esps_hdrops);
 598                 DPRINTF(("%s: bad mbuf chain, SA %s/%08lx\n", __func__,
 599                     ipsec_address(&sav->sah->saidx.dst, buf, sizeof(buf)),
 600                     (u_long) ntohl(sav->spi)));
 601                 goto bad;
 602         }
 603
 604         /* Save the last three bytes of decrypted data */
 605         m_copydata(m, m->m_pkthdr.len - 3, 3, lastthree);
 606
 607         /* Verify pad length */
 608         if (lastthree[1] + 2 > m->m_pkthdr.len - skip) {
 609                 ESPSTAT_INC(esps_badilen);
 610                 DPRINTF(("%s: invalid padding length %d for %u byte packet "
 611                     "in SA %s/%08lx\n", __func__, lastthree[1],
 612                     m->m_pkthdr.len - skip,
 613                     ipsec_address(&sav->sah->saidx.dst, buf, sizeof(buf)),
 614                     (u_long) ntohl(sav->spi)));
 615                 error = EINVAL;
 616                 goto bad;
 617         }
 618
 619         /* Verify correct decryption by checking the last padding bytes */
 620         if ((sav->flags & SADB_X_EXT_PMASK) != SADB_X_EXT_PRAND) {
 621                 if (lastthree[1] != lastthree[0] && lastthree[1] != 0) {
 622                         ESPSTAT_INC(esps_badenc);
 623                         DPRINTF(("%s: decryption failed for packet in "
 624                             "SA %s/%08lx\n", __func__, ipsec_address(
 625                             &sav->sah->saidx.dst, buf, sizeof(buf)),
 626                             (u_long) ntohl(sav->spi)));
 627                         error = EINVAL;
 628                         goto bad;
 629                 }
 630         }
 631
 632         /*
 633          * RFC4303 2.6:
 634          * Silently drop packet if next header field is IPPROTO_NONE.
 635          */
 636         if (lastthree[2] == IPPROTO_NONE)
 637                 goto bad;
 638
 639         /* Trim the mbuf chain to remove trailing authenticator and padding */
 640         m_adj(m, -(lastthree[1] + 2));
 641
 642         /* Restore the Next Protocol field */
 643         m_copyback(m, protoff, sizeof (u_int8_t), lastthree + 2);
 644
 645         switch (saidx->dst.sa.sa_family) {
 646 #ifdef INET6
 647         case AF_INET6:
 648                 error = ipsec6_common_input_cb(m, sav, skip, protoff);
 649                 break;
 650 #endif
 651 #ifdef INET
 652         case AF_INET:
 653                 error = ipsec4_common_input_cb(m, sav, skip, protoff);
 654                 break;
 655 #endif
 656         default:
 657                 panic("%s: Unexpected address family: %d saidx=%p", __func__,
 658                     saidx->dst.sa.sa_family, saidx);
 659         }
 660         CURVNET_RESTORE();
 661         return error;
 662 bad:
 663         CURVNET_RESTORE();
 664         if (sav != NULL)
 665                 key_freesav(&sav);
 666         if (m != NULL)
 667                 m_freem(m);
 668         if (xd != NULL)
 669                 free(xd, M_ESP);
 670         if (crp != NULL) {
 671                 free(crp->crp_aad, M_ESP);
 672                 crypto_freereq(crp);
 673         }
 674         return error;
 675 }
 676 /*
 677  * ESP output routine, called by ipsec[46]_perform_request().
 678  */
 679 static int
 680 esp_output(struct mbuf *m, struct secpolicy *sp, struct secasvar *sav,
 681     u_int idx, int skip, int protoff)
 682 {
 683         IPSEC_DEBUG_DECLARE(char buf[IPSEC_ADDRSTRLEN]);
 684         struct cryptop *crp;
 685         const struct auth_hash *esph;
 686         const struct enc_xform *espx;
 687         struct mbuf *mo = NULL;
 688         struct xform_data *xd;
 689         struct secasindex *saidx;
 690         unsigned char *pad;
 691         uint8_t *ivp;
 692         uint64_t cntr;
 693         crypto_session_t cryptoid;
 694         int hlen, rlen, padding, blks, alen, i, roff;
 695         int error, maxpacketsize;
 696         uint8_t prot;
 697         uint32_t seqh;
 698         const struct crypto_session_params *csp;
 699
 700         SECASVAR_RLOCK_TRACKER;
 701
 702         IPSEC_ASSERT(sav != NULL, ("null SA"));
 703         esph = sav->tdb_authalgxform;
 704         espx = sav->tdb_encalgxform;
 705         IPSEC_ASSERT(espx != NULL, ("null encoding xform"));
 706
 707         if (sav->flags & SADB_X_EXT_OLD)
 708                 hlen = sizeof (struct esp) + sav->ivlen;
 709         else
 710                 hlen = sizeof (struct newesp) + sav->ivlen;
 711
 712         rlen = m->m_pkthdr.len - skip;  /* Raw payload length. */
 713         /*
 714          * RFC4303 2.4 Requires 4 byte alignment.
 715          * Old versions of FreeBSD can't decrypt partial blocks encrypted
 716          * with AES-CTR. Align payload to native_blocksize (16 bytes)
 717          * in order to preserve compatibility.
 718          */
 719         if (SAV_ISCTR(sav) && V_esp_ctr_compatibility)
 720                 blks = MAX(4, espx->native_blocksize);  /* Cipher blocksize */
 721         else
 722                 blks = MAX(4, espx->blocksize);
 723
 724         /* XXX clamp padding length a la KAME??? */
 725         padding = ((blks - ((rlen + 2) % blks)) % blks) + 2;
 726
 727         alen = xform_ah_authsize(esph);
 728
 729         ESPSTAT_INC(esps_output);
 730
 731         saidx = &sav->sah->saidx;
 732         /* Check for maximum packet size violations. */
 733         switch (saidx->dst.sa.sa_family) {
 734 #ifdef INET
 735         case AF_INET:
 736                 maxpacketsize = IP_MAXPACKET;
 737                 break;
 738 #endif /* INET */
 739 #ifdef INET6
 740         case AF_INET6:
 741                 maxpacketsize = IPV6_MAXPACKET;
 742                 break;
 743 #endif /* INET6 */
 744         default:
 745                 DPRINTF(("%s: unknown/unsupported protocol "
 746                     "family %d, SA %s/%08lx\n", __func__,
 747                     saidx->dst.sa.sa_family, ipsec_address(&saidx->dst,
 748                         buf, sizeof(buf)), (u_long) ntohl(sav->spi)));
 749                 ESPSTAT_INC(esps_nopf);
 750                 error = EPFNOSUPPORT;
 751                 goto bad;
 752         }
 753         /*
 754         DPRINTF(("%s: skip %d hlen %d rlen %d padding %d alen %d blksd %d\n",
 755                 __func__, skip, hlen, rlen, padding, alen, blks)); */
 756         if (skip + hlen + rlen + padding + alen > maxpacketsize) {
 757                 DPRINTF(("%s: packet in SA %s/%08lx got too big "
 758                     "(len %u, max len %u)\n", __func__,
 759                     ipsec_address(&saidx->dst, buf, sizeof(buf)),
 760                     (u_long) ntohl(sav->spi),
 761                     skip + hlen + rlen + padding + alen, maxpacketsize));
 762                 ESPSTAT_INC(esps_toobig);
 763                 error = EMSGSIZE;
 764                 goto bad;
 765         }
 766
 767         /* Update the counters. */
 768         ESPSTAT_ADD(esps_obytes, m->m_pkthdr.len - skip);
 769
 770         m = m_unshare(m, M_NOWAIT);
 771         if (m == NULL) {
 772                 DPRINTF(("%s: cannot clone mbuf chain, SA %s/%08lx\n", __func__,
 773                     ipsec_address(&saidx->dst, buf, sizeof(buf)),
 774                     (u_long) ntohl(sav->spi)));
 775                 ESPSTAT_INC(esps_hdrops);
 776                 error = ENOBUFS;
 777                 goto bad;
 778         }
 779
 780         /* Inject ESP header. */
 781         mo = m_makespace(m, skip, hlen, &roff);
 782         if (mo == NULL) {
 783                 DPRINTF(("%s: %u byte ESP hdr inject failed for SA %s/%08lx\n",
 784                     __func__, hlen, ipsec_address(&saidx->dst, buf,
 785                     sizeof(buf)), (u_long) ntohl(sav->spi)));
 786                 ESPSTAT_INC(esps_hdrops);       /* XXX diffs from openbsd */
 787                 error = ENOBUFS;
 788                 goto bad;
 789         }
 790
 791         /* Initialize ESP header. */
 792         bcopy((caddr_t) &sav->spi, mtod(mo, caddr_t) + roff,
 793             sizeof(uint32_t));
 794         SECASVAR_RLOCK(sav);
 795         if (sav->replay) {
 796                 uint32_t replay;
 797
 798                 SECREPLAY_LOCK(sav->replay);
 799 #ifdef REGRESSION
 800                 /* Emulate replay attack when ipsec_replay is TRUE. */
 801                 if (!V_ipsec_replay)
 802 #endif
 803                         sav->replay->count++;
 804                 replay = htonl((uint32_t)sav->replay->count);
 805
 806                 bcopy((caddr_t) &replay, mtod(mo, caddr_t) + roff +
 807                     sizeof(uint32_t), sizeof(uint32_t));
 808
 809                 seqh = htonl((uint32_t)(sav->replay->count >> IPSEC_SEQH_SHIFT));
 810                 SECREPLAY_UNLOCK(sav->replay);
 811         }
 812         cryptoid = sav->tdb_cryptoid;
 813         if (SAV_ISCTRORGCM(sav))
 814                 cntr = sav->cntr++;
 815         SECASVAR_RUNLOCK(sav);
 816
 817         /*
 818          * Add padding -- better to do it ourselves than use the crypto engine,
 819          * although if/when we support compression, we'd have to do that.
 820          */
 821         pad = (u_char *) m_pad(m, padding + alen);
 822         if (pad == NULL) {
 823                 DPRINTF(("%s: m_pad failed for SA %s/%08lx\n", __func__,
 824                     ipsec_address(&saidx->dst, buf, sizeof(buf)),
 825                     (u_long) ntohl(sav->spi)));
 826                 m = NULL;               /* NB: free'd by m_pad */
 827                 error = ENOBUFS;
 828                 goto bad;
 829         }
 830
 831         /*
 832          * Add padding: random, zero, or self-describing.
 833          * XXX catch unexpected setting
 834          */
 835         switch (sav->flags & SADB_X_EXT_PMASK) {
 836         case SADB_X_EXT_PRAND:
 837                 arc4random_buf(pad, padding - 2);
 838                 break;
 839         case SADB_X_EXT_PZERO:
 840                 bzero(pad, padding - 2);
 841                 break;
 842         case SADB_X_EXT_PSEQ:
 843                 for (i = 0; i < padding - 2; i++)
 844                         pad[i] = i+1;
 845                 break;
 846         }
 847
 848         /* Fix padding length and Next Protocol in padding itself. */
 849         pad[padding - 2] = padding - 2;
 850         m_copydata(m, protoff, sizeof(u_int8_t), pad + padding - 1);
 851
 852         /* Fix Next Protocol in IPv4/IPv6 header. */
 853         prot = IPPROTO_ESP;
 854         m_copyback(m, protoff, sizeof(u_int8_t), (u_char *) &prot);
 855
 856         /* Get crypto descriptor. */
 857         crp = crypto_getreq(cryptoid, M_NOWAIT);
 858         if (crp == NULL) {
 859                 DPRINTF(("%s: failed to acquire crypto descriptor\n",
 860                         __func__));
 861                 ESPSTAT_INC(esps_crypto);
 862                 error = ENOBUFS;
 863                 goto bad;
 864         }
 865
 866         /* IPsec-specific opaque crypto info. */
 867         xd = malloc(sizeof(struct xform_data), M_ESP, M_NOWAIT | M_ZERO);
 868         if (xd == NULL) {
 869                 DPRINTF(("%s: failed to allocate xform_data\n", __func__));
 870                 goto xd_fail;
 871         }
 872
 873         /* Encryption descriptor. */
 874         crp->crp_payload_start = skip + hlen;
 875         crp->crp_payload_length = m->m_pkthdr.len - (skip + hlen + alen);
 876         crp->crp_op = CRYPTO_OP_ENCRYPT;
 877
 878         /* Generate cipher and ESP IVs. */
 879         ivp = &crp->crp_iv[0];
 880         if (SAV_ISCTRORGCM(sav)) {
 881                 /*
 882                  * See comment in esp_input() for details on the
 883                  * cipher IV.  A simple per-SA counter stored in
 884                  * 'cntr' is used as the explicit ESP IV.
 885                  */
 886                 memcpy(ivp, sav->key_enc->key_data +
 887                     _KEYLEN(sav->key_enc) - 4, 4);
 888                 be64enc(&ivp[4], cntr);
 889                 if (SAV_ISCTR(sav)) {
 890                         be32enc(&ivp[sav->ivlen + 4], 1);
 891                 }
 892                 m_copyback(m, skip + hlen - sav->ivlen, sav->ivlen, &ivp[4]);
 893                 crp->crp_flags |= CRYPTO_F_IV_SEPARATE;
 894         } else if (sav->ivlen != 0) {
 895                 arc4rand(ivp, sav->ivlen, 0);
 896                 crp->crp_iv_start = skip + hlen - sav->ivlen;
 897                 m_copyback(m, crp->crp_iv_start, sav->ivlen, ivp);
 898         }
 899
 900         /* Callback parameters */
 901         xd->sp = sp;
 902         xd->sav = sav;
 903         xd->idx = idx;
 904         xd->cryptoid = cryptoid;
 905         xd->vnet = curvnet;
 906
 907         /* Crypto operation descriptor. */
 908         crp->crp_flags |= CRYPTO_F_CBIFSYNC;
 909         if (V_async_crypto)
 910                 crp->crp_flags |= CRYPTO_F_ASYNC | CRYPTO_F_ASYNC_KEEPORDER;
 911         crypto_use_mbuf(crp, m);
 912         crp->crp_callback = esp_output_cb;
 913         crp->crp_opaque = xd;
 914
 915         if (esph) {
 916                 /* Authentication descriptor. */
 917                 crp->crp_op |= CRYPTO_OP_COMPUTE_DIGEST;
 918                 if (SAV_ISGCM(sav))
 919                         crp->crp_aad_length = 8; /* RFC4106 5, SPI + SN */
 920                 else
 921                         crp->crp_aad_length = hlen;
 922
 923                 csp = crypto_get_params(crp->crp_session);
 924                 if (csp->csp_flags & CSP_F_SEPARATE_AAD &&
 925                     sav->replay != NULL) {
 926                         int aad_skip;
 927
 928                         crp->crp_aad_length += sizeof(seqh);
 929                         crp->crp_aad = malloc(crp->crp_aad_length, M_ESP, M_NOWAIT);
 930                         if (crp->crp_aad == NULL) {
 931                                 DPRINTF(("%s: failed to allocate xform_data\n",
 932                                          __func__));
 933                                 goto crp_aad_fail;
 934                         }
 935
 936                         /* SPI */
 937                         m_copydata(m, skip, SPI_SIZE, crp->crp_aad);
 938                         aad_skip = SPI_SIZE;
 939
 940                         /* ESN */
 941                         bcopy(&seqh, (char *)crp->crp_aad + aad_skip, sizeof(seqh));
 942                         aad_skip += sizeof(seqh);
 943
 944                         /* Rest of aad */
 945                         if (crp->crp_aad_length - aad_skip > 0)
 946                                 m_copydata(m, skip + SPI_SIZE,
 947                                            crp->crp_aad_length - aad_skip,
 948                                            (char *)crp->crp_aad + aad_skip);
 949                 } else
 950                         crp->crp_aad_start = skip;
 951
 952                 if (csp->csp_flags & CSP_F_ESN && sav->replay != NULL)
 953                         memcpy(crp->crp_esn, &seqh, sizeof(seqh));
 954
 955                 crp->crp_digest_start = m->m_pkthdr.len - alen;
 956         }
 957
 958         return crypto_dispatch(crp);
 959
 960 crp_aad_fail:
 961         free(xd, M_ESP);
 962 xd_fail:
 963         crypto_freereq(crp);
 964         ESPSTAT_INC(esps_crypto);
 965         error = ENOBUFS;
 966 bad:
 967         if (m)
 968                 m_freem(m);
 969         key_freesav(&sav);
 970         key_freesp(&sp);
 971         return (error);
 972 }
 973 /*
 974  * ESP output callback from the crypto driver.
 975  */
 976 static int
 977 esp_output_cb(struct cryptop *crp)
 978 {
 979         struct xform_data *xd;
 980         struct secpolicy *sp;
 981         struct secasvar *sav;
 982         struct mbuf *m;
 983         crypto_session_t cryptoid;
 984         u_int idx;
 985         int error;
 986
 987         xd = (struct xform_data *) crp->crp_opaque;
 988         CURVNET_SET(xd->vnet);
 989         m = crp->crp_buf.cb_mbuf;
 990         sp = xd->sp;
 991         sav = xd->sav;
 992         idx = xd->idx;
 993         cryptoid = xd->cryptoid;
 994
 995         /* Check for crypto errors. */
 996         if (crp->crp_etype) {
 997                 if (crp->crp_etype == EAGAIN) {
 998                         /* Reset the session ID */
 999                         if (ipsec_updateid(sav, &crp->crp_session, &cryptoid) != 0)
1000                                 crypto_freesession(cryptoid);
1001                         xd->cryptoid = crp->crp_session;
1002                         CURVNET_RESTORE();
1003                         return (crypto_dispatch(crp));
1004                 }
1005                 ESPSTAT_INC(esps_noxform);
1006                 DPRINTF(("%s: crypto error %d\n", __func__, crp->crp_etype));
1007                 error = crp->crp_etype;
1008                 m_freem(m);
1009                 goto bad;
1010         }
1011
1012         /* Shouldn't happen... */
1013         if (m == NULL) {
1014                 ESPSTAT_INC(esps_crypto);
1015                 DPRINTF(("%s: bogus returned buffer from crypto\n", __func__));
1016                 error = EINVAL;
1017                 goto bad;
1018         }
1019         free(xd, M_ESP);
1020         free(crp->crp_aad, M_ESP);
1021         crypto_freereq(crp);
1022         ESPSTAT_INC(esps_hist[sav->alg_enc]);
1023         if (sav->tdb_authalgxform != NULL)
1024                 AHSTAT_INC(ahs_hist[sav->alg_auth]);
1025
1026 #ifdef REGRESSION
1027         /* Emulate man-in-the-middle attack when ipsec_integrity is TRUE. */
1028         if (V_ipsec_integrity) {
1029                 static unsigned char ipseczeroes[AH_HMAC_MAXHASHLEN];
1030                 const struct auth_hash *esph;
1031
1032                 /*
1033                  * Corrupt HMAC if we want to test integrity verification of
1034                  * the other side.
1035                  */
1036                 esph = sav->tdb_authalgxform;
1037                 if (esph !=  NULL) {
1038                         int alen;
1039
1040                         alen = xform_ah_authsize(esph);
1041                         m_copyback(m, m->m_pkthdr.len - alen,
1042                             alen, ipseczeroes);
1043                 }
1044         }
1045 #endif
1046
1047         /* NB: m is reclaimed by ipsec_process_done. */
1048         error = ipsec_process_done(m, sp, sav, idx);
1049         CURVNET_RESTORE();
1050         return (error);
1051 bad:
1052         CURVNET_RESTORE();
1053         free(xd, M_ESP);
1054         free(crp->crp_aad, M_ESP);
1055         crypto_freereq(crp);
1056         key_freesav(&sav);
1057         key_freesp(&sp);
1058         return (error);
1059 }
1060
1061 static struct xformsw esp_xformsw = {
1062         .xf_type =      XF_ESP,
1063         .xf_name =      "IPsec ESP",
1064         .xf_init =      esp_init,
1065         .xf_cleanup =   esp_cleanup,
1066         .xf_input =     esp_input,
1067         .xf_output =    esp_output,
1068 };
1069
1070 SYSINIT(esp_xform_init, SI_SUB_PROTO_DOMAIN, SI_ORDER_MIDDLE,
1071     xform_attach, &esp_xformsw);
1072 SYSUNINIT(esp_xform_uninit, SI_SUB_PROTO_DOMAIN, SI_ORDER_MIDDLE,
1073     xform_detach, &esp_xformsw);