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 41 #include <sys/param.h> 42 #include <sys/systm.h> 43 #include <sys/mbuf.h> 44 #include <sys/socket.h> 45 #include <sys/syslog.h> 46 #include <sys/kernel.h> 47 #include <sys/lock.h> 48 #include <sys/random.h> 49 #include <sys/mutex.h> 50 #include <sys/sysctl.h> 51 #include <sys/mutex.h> 52 #include <machine/atomic.h> 53 54 #include <net/if.h> 55 #include <net/vnet.h> 56 57 #include <netinet/in.h> 58 #include <netinet/in_systm.h> 59 #include <netinet/ip.h> 60 #include <netinet/ip_ecn.h> 61 #include <netinet/ip6.h> 62 63 #include <netipsec/ipsec.h> 64 #include <netipsec/ah.h> 65 #include <netipsec/ah_var.h> 66 #include <netipsec/esp.h> 67 #include <netipsec/esp_var.h> 68 #include <netipsec/xform.h> 69 70 #ifdef INET6 71 #include <netinet6/ip6_var.h> 72 #include <netipsec/ipsec6.h> 73 #include <netinet6/ip6_ecn.h> 74 #endif 75 76 #include <netipsec/key.h> 77 #include <netipsec/key_debug.h> 78 79 #include <opencrypto/cryptodev.h> 80 #include <opencrypto/xform.h> 81 82 VNET_DEFINE(int, esp_enable) = 1; 83 VNET_PCPUSTAT_DEFINE(struct espstat, espstat); 84 VNET_PCPUSTAT_SYSINIT(espstat); 85 86 #ifdef VIMAGE 87 VNET_PCPUSTAT_SYSUNINIT(espstat); 88 #endif /* VIMAGE */ 89 90 SYSCTL_DECL(_net_inet_esp); 91 SYSCTL_INT(_net_inet_esp, OID_AUTO, esp_enable, 92 CTLFLAG_VNET | CTLFLAG_RW, &VNET_NAME(esp_enable), 0, ""); 93 SYSCTL_VNET_PCPUSTAT(_net_inet_esp, IPSECCTL_STATS, stats, 94 struct espstat, espstat, 95 "ESP statistics (struct espstat, netipsec/esp_var.h"); 96 97 static int esp_input_cb(struct cryptop *op); 98 static int esp_output_cb(struct cryptop *crp); 99 100 size_t 101 esp_hdrsiz(struct secasvar *sav) 102 { 103 size_t size; 104 105 if (sav != NULL) { 106 /*XXX not right for null algorithm--does it matter??*/ 107 IPSEC_ASSERT(sav->tdb_encalgxform != NULL, 108 ("SA with null xform")); 109 if (sav->flags & SADB_X_EXT_OLD) 110 size = sizeof (struct esp); 111 else 112 size = sizeof (struct newesp); 113 size += sav->tdb_encalgxform->blocksize + 9; 114 /*XXX need alg check???*/ 115 if (sav->tdb_authalgxform != NULL && sav->replay) 116 size += ah_hdrsiz(sav); 117 } else { 118 /* 119 * base header size 120 * + max iv length for CBC mode 121 * + max pad length 122 * + sizeof (pad length field) 123 * + sizeof (next header field) 124 * + max icv supported. 125 */ 126 size = sizeof (struct newesp) + EALG_MAX_BLOCK_LEN + 9 + 16; 127 } 128 return size; 129 } 130 131 /* 132 * esp_init() is called when an SPI is being set up. 133 */ 134 static int 135 esp_init(struct secasvar *sav, struct xformsw *xsp) 136 { 137 const struct enc_xform *txform; 138 struct cryptoini cria, crie; 139 int keylen; 140 int error; 141 142 txform = enc_algorithm_lookup(sav->alg_enc); 143 if (txform == NULL) { 144 DPRINTF(("%s: unsupported encryption algorithm %d\n", 145 __func__, sav->alg_enc)); 146 return EINVAL; 147 } 148 if (sav->key_enc == NULL) { 149 DPRINTF(("%s: no encoding key for %s algorithm\n", 150 __func__, txform->name)); 151 return EINVAL; 152 } 153 if ((sav->flags & (SADB_X_EXT_OLD | SADB_X_EXT_IV4B)) == 154 SADB_X_EXT_IV4B) { 155 DPRINTF(("%s: 4-byte IV not supported with protocol\n", 156 __func__)); 157 return EINVAL; 158 } 159 /* subtract off the salt, RFC4106, 8.1 and RFC3686, 5.1 */ 160 keylen = _KEYLEN(sav->key_enc) - SAV_ISCTRORGCM(sav) * 4; 161 if (txform->minkey > keylen || keylen > txform->maxkey) { 162 DPRINTF(("%s: invalid key length %u, must be in the range " 163 "[%u..%u] for algorithm %s\n", __func__, 164 keylen, txform->minkey, txform->maxkey, 165 txform->name)); 166 return EINVAL; 167 } 168 169 if (SAV_ISCTRORGCM(sav)) 170 sav->ivlen = 8; /* RFC4106 3.1 and RFC3686 3.1 */ 171 else 172 sav->ivlen = txform->ivsize; 173 174 /* 175 * Setup AH-related state. 176 */ 177 if (sav->alg_auth != 0) { 178 error = ah_init0(sav, xsp, &cria); 179 if (error) 180 return error; 181 } 182 183 /* NB: override anything set in ah_init0 */ 184 sav->tdb_xform = xsp; 185 sav->tdb_encalgxform = txform; 186 187 /* 188 * Whenever AES-GCM is used for encryption, one 189 * of the AES authentication algorithms is chosen 190 * as well, based on the key size. 191 */ 192 if (sav->alg_enc == SADB_X_EALG_AESGCM16) { 193 switch (keylen) { 194 case AES_128_GMAC_KEY_LEN: 195 sav->alg_auth = SADB_X_AALG_AES128GMAC; 196 sav->tdb_authalgxform = &auth_hash_nist_gmac_aes_128; 197 break; 198 case AES_192_GMAC_KEY_LEN: 199 sav->alg_auth = SADB_X_AALG_AES192GMAC; 200 sav->tdb_authalgxform = &auth_hash_nist_gmac_aes_192; 201 break; 202 case AES_256_GMAC_KEY_LEN: 203 sav->alg_auth = SADB_X_AALG_AES256GMAC; 204 sav->tdb_authalgxform = &auth_hash_nist_gmac_aes_256; 205 break; 206 default: 207 DPRINTF(("%s: invalid key length %u" 208 "for algorithm %s\n", __func__, 209 keylen, txform->name)); 210 return EINVAL; 211 } 212 bzero(&cria, sizeof(cria)); 213 cria.cri_alg = sav->tdb_authalgxform->type; 214 cria.cri_key = sav->key_enc->key_data; 215 cria.cri_klen = _KEYBITS(sav->key_enc) - SAV_ISGCM(sav) * 32; 216 } 217 218 /* Initialize crypto session. */ 219 bzero(&crie, sizeof(crie)); 220 crie.cri_alg = sav->tdb_encalgxform->type; 221 crie.cri_key = sav->key_enc->key_data; 222 crie.cri_klen = _KEYBITS(sav->key_enc) - SAV_ISCTRORGCM(sav) * 32; 223 224 if (sav->tdb_authalgxform && sav->tdb_encalgxform) { 225 /* init both auth & enc */ 226 crie.cri_next = &cria; 227 error = crypto_newsession(&sav->tdb_cryptoid, 228 &crie, V_crypto_support); 229 } else if (sav->tdb_encalgxform) { 230 error = crypto_newsession(&sav->tdb_cryptoid, 231 &crie, V_crypto_support); 232 } else if (sav->tdb_authalgxform) { 233 error = crypto_newsession(&sav->tdb_cryptoid, 234 &cria, V_crypto_support); 235 } else { 236 /* XXX cannot happen? */ 237 DPRINTF(("%s: no encoding OR authentication xform!\n", 238 __func__)); 239 error = EINVAL; 240 } 241 return error; 242 } 243 244 /* 245 * Paranoia. 246 */ 247 static int 248 esp_zeroize(struct secasvar *sav) 249 { 250 /* NB: ah_zerorize free's the crypto session state */ 251 int error = ah_zeroize(sav); 252 253 if (sav->key_enc) 254 bzero(sav->key_enc->key_data, _KEYLEN(sav->key_enc)); 255 sav->tdb_encalgxform = NULL; 256 sav->tdb_xform = NULL; 257 return error; 258 } 259 260 /* 261 * ESP input processing, called (eventually) through the protocol switch. 262 */ 263 static int 264 esp_input(struct mbuf *m, struct secasvar *sav, int skip, int protoff) 265 { 266 IPSEC_DEBUG_DECLARE(char buf[128]); 267 const struct auth_hash *esph; 268 const struct enc_xform *espx; 269 struct xform_data *xd; 270 struct cryptodesc *crde; 271 struct cryptop *crp; 272 struct newesp *esp; 273 uint8_t *ivp; 274 uint64_t cryptoid; 275 int alen, error, hlen, plen; 276 277 IPSEC_ASSERT(sav != NULL, ("null SA")); 278 IPSEC_ASSERT(sav->tdb_encalgxform != NULL, ("null encoding xform")); 279 280 error = EINVAL; 281 /* Valid IP Packet length ? */ 282 if ( (skip&3) || (m->m_pkthdr.len&3) ){ 283 DPRINTF(("%s: misaligned packet, skip %u pkt len %u", 284 __func__, skip, m->m_pkthdr.len)); 285 ESPSTAT_INC(esps_badilen); 286 goto bad; 287 } 288 /* XXX don't pullup, just copy header */ 289 IP6_EXTHDR_GET(esp, struct newesp *, m, skip, sizeof (struct newesp)); 290 291 esph = sav->tdb_authalgxform; 292 espx = sav->tdb_encalgxform; 293 294 /* Determine the ESP header and auth length */ 295 if (sav->flags & SADB_X_EXT_OLD) 296 hlen = sizeof (struct esp) + sav->ivlen; 297 else 298 hlen = sizeof (struct newesp) + sav->ivlen; 299 300 alen = xform_ah_authsize(esph); 301 302 /* 303 * Verify payload length is multiple of encryption algorithm 304 * block size. 305 * 306 * NB: This works for the null algorithm because the blocksize 307 * is 4 and all packets must be 4-byte aligned regardless 308 * of the algorithm. 309 */ 310 plen = m->m_pkthdr.len - (skip + hlen + alen); 311 if ((plen & (espx->blocksize - 1)) || (plen <= 0)) { 312 DPRINTF(("%s: payload of %d octets not a multiple of %d octets," 313 " SA %s/%08lx\n", __func__, plen, espx->blocksize, 314 ipsec_address(&sav->sah->saidx.dst, buf, sizeof(buf)), 315 (u_long)ntohl(sav->spi))); 316 ESPSTAT_INC(esps_badilen); 317 goto bad; 318 } 319 320 /* 321 * Check sequence number. 322 */ 323 SECASVAR_LOCK(sav); 324 if (esph != NULL && sav->replay != NULL && sav->replay->wsize != 0) { 325 if (ipsec_chkreplay(ntohl(esp->esp_seq), sav) == 0) { 326 SECASVAR_UNLOCK(sav); 327 DPRINTF(("%s: packet replay check for %s\n", __func__, 328 ipsec_sa2str(sav, buf, sizeof(buf)))); 329 ESPSTAT_INC(esps_replay); 330 error = EACCES; 331 goto bad; 332 } 333 } 334 cryptoid = sav->tdb_cryptoid; 335 SECASVAR_UNLOCK(sav); 336 337 /* Update the counters */ 338 ESPSTAT_ADD(esps_ibytes, m->m_pkthdr.len - (skip + hlen + alen)); 339 340 /* Get crypto descriptors */ 341 crp = crypto_getreq(esph && espx ? 2 : 1); 342 if (crp == NULL) { 343 DPRINTF(("%s: failed to acquire crypto descriptors\n", 344 __func__)); 345 ESPSTAT_INC(esps_crypto); 346 error = ENOBUFS; 347 goto bad; 348 } 349 350 /* Get IPsec-specific opaque pointer */ 351 xd = malloc(sizeof(*xd) + alen, M_XDATA, M_NOWAIT | M_ZERO); 352 if (xd == NULL) { 353 DPRINTF(("%s: failed to allocate xform_data\n", __func__)); 354 ESPSTAT_INC(esps_crypto); 355 crypto_freereq(crp); 356 error = ENOBUFS; 357 goto bad; 358 } 359 360 if (esph != NULL) { 361 struct cryptodesc *crda = crp->crp_desc; 362 363 IPSEC_ASSERT(crda != NULL, ("null ah crypto descriptor")); 364 365 /* Authentication descriptor */ 366 crda->crd_skip = skip; 367 if (SAV_ISGCM(sav)) 368 crda->crd_len = 8; /* RFC4106 5, SPI + SN */ 369 else 370 crda->crd_len = m->m_pkthdr.len - (skip + alen); 371 crda->crd_inject = m->m_pkthdr.len - alen; 372 373 crda->crd_alg = esph->type; 374 375 /* Copy the authenticator */ 376 m_copydata(m, m->m_pkthdr.len - alen, alen, 377 (caddr_t) (xd + 1)); 378 379 /* Chain authentication request */ 380 crde = crda->crd_next; 381 } else { 382 crde = crp->crp_desc; 383 } 384 385 /* Crypto operation descriptor */ 386 crp->crp_ilen = m->m_pkthdr.len; /* Total input length */ 387 crp->crp_flags = CRYPTO_F_IMBUF | CRYPTO_F_CBIFSYNC; 388 if (V_async_crypto) 389 crp->crp_flags |= CRYPTO_F_ASYNC | CRYPTO_F_ASYNC_KEEPORDER; 390 crp->crp_buf = (caddr_t) m; 391 crp->crp_callback = esp_input_cb; 392 crp->crp_sid = cryptoid; 393 crp->crp_opaque = (caddr_t) xd; 394 395 /* These are passed as-is to the callback */ 396 xd->sav = sav; 397 xd->protoff = protoff; 398 xd->skip = skip; 399 xd->cryptoid = cryptoid; 400 401 /* Decryption descriptor */ 402 IPSEC_ASSERT(crde != NULL, ("null esp crypto descriptor")); 403 crde->crd_skip = skip + hlen; 404 crde->crd_len = m->m_pkthdr.len - (skip + hlen + alen); 405 crde->crd_inject = skip + hlen - sav->ivlen; 406 407 if (SAV_ISCTRORGCM(sav)) { 408 ivp = &crde->crd_iv[0]; 409 410 /* GCM IV Format: RFC4106 4 */ 411 /* CTR IV Format: RFC3686 4 */ 412 /* Salt is last four bytes of key, RFC4106 8.1 */ 413 /* Nonce is last four bytes of key, RFC3686 5.1 */ 414 memcpy(ivp, sav->key_enc->key_data + 415 _KEYLEN(sav->key_enc) - 4, 4); 416 417 if (SAV_ISCTR(sav)) { 418 /* Initial block counter is 1, RFC3686 4 */ 419 be32enc(&ivp[sav->ivlen + 4], 1); 420 } 421 422 m_copydata(m, skip + hlen - sav->ivlen, sav->ivlen, &ivp[4]); 423 crde->crd_flags |= CRD_F_IV_EXPLICIT; 424 } 425 426 crde->crd_alg = espx->type; 427 428 return (crypto_dispatch(crp)); 429 bad: 430 m_freem(m); 431 key_freesav(&sav); 432 return (error); 433 } 434 435 /* 436 * ESP input callback from the crypto driver. 437 */ 438 static int 439 esp_input_cb(struct cryptop *crp) 440 { 441 IPSEC_DEBUG_DECLARE(char buf[128]); 442 u_int8_t lastthree[3], aalg[AH_HMAC_MAXHASHLEN]; 443 const struct auth_hash *esph; 444 const struct enc_xform *espx; 445 struct mbuf *m; 446 struct cryptodesc *crd; 447 struct xform_data *xd; 448 struct secasvar *sav; 449 struct secasindex *saidx; 450 caddr_t ptr; 451 uint64_t cryptoid; 452 int hlen, skip, protoff, error, alen; 453 454 crd = crp->crp_desc; 455 IPSEC_ASSERT(crd != NULL, ("null crypto descriptor!")); 456 457 m = (struct mbuf *) crp->crp_buf; 458 xd = (struct xform_data *) crp->crp_opaque; 459 sav = xd->sav; 460 skip = xd->skip; 461 protoff = xd->protoff; 462 cryptoid = xd->cryptoid; 463 saidx = &sav->sah->saidx; 464 esph = sav->tdb_authalgxform; 465 espx = sav->tdb_encalgxform; 466 467 /* Check for crypto errors */ 468 if (crp->crp_etype) { 469 if (crp->crp_etype == EAGAIN) { 470 /* Reset the session ID */ 471 if (ipsec_updateid(sav, &crp->crp_sid, &cryptoid) != 0) 472 crypto_freesession(cryptoid); 473 xd->cryptoid = crp->crp_sid; 474 return (crypto_dispatch(crp)); 475 } 476 ESPSTAT_INC(esps_noxform); 477 DPRINTF(("%s: crypto error %d\n", __func__, crp->crp_etype)); 478 error = crp->crp_etype; 479 goto bad; 480 } 481 482 /* Shouldn't happen... */ 483 if (m == NULL) { 484 ESPSTAT_INC(esps_crypto); 485 DPRINTF(("%s: bogus returned buffer from crypto\n", __func__)); 486 error = EINVAL; 487 goto bad; 488 } 489 ESPSTAT_INC(esps_hist[sav->alg_enc]); 490 491 /* If authentication was performed, check now. */ 492 if (esph != NULL) { 493 alen = xform_ah_authsize(esph); 494 AHSTAT_INC(ahs_hist[sav->alg_auth]); 495 /* Copy the authenticator from the packet */ 496 m_copydata(m, m->m_pkthdr.len - alen, alen, aalg); 497 ptr = (caddr_t) (xd + 1); 498 499 /* Verify authenticator */ 500 if (timingsafe_bcmp(ptr, aalg, alen) != 0) { 501 DPRINTF(("%s: authentication hash mismatch for " 502 "packet in SA %s/%08lx\n", __func__, 503 ipsec_address(&saidx->dst, buf, sizeof(buf)), 504 (u_long) ntohl(sav->spi))); 505 ESPSTAT_INC(esps_badauth); 506 error = EACCES; 507 goto bad; 508 } 509 m->m_flags |= M_AUTHIPDGM; 510 /* Remove trailing authenticator */ 511 m_adj(m, -alen); 512 } 513 514 /* Release the crypto descriptors */ 515 free(xd, M_XDATA), xd = NULL; 516 crypto_freereq(crp), crp = NULL; 517 518 /* 519 * Packet is now decrypted. 520 */ 521 m->m_flags |= M_DECRYPTED; 522 523 /* 524 * Update replay sequence number, if appropriate. 525 */ 526 if (sav->replay) { 527 u_int32_t seq; 528 529 m_copydata(m, skip + offsetof(struct newesp, esp_seq), 530 sizeof (seq), (caddr_t) &seq); 531 SECASVAR_LOCK(sav); 532 if (ipsec_updatereplay(ntohl(seq), sav)) { 533 SECASVAR_UNLOCK(sav); 534 DPRINTF(("%s: packet replay check for %s\n", __func__, 535 ipsec_sa2str(sav, buf, sizeof(buf)))); 536 ESPSTAT_INC(esps_replay); 537 error = EACCES; 538 goto bad; 539 } 540 SECASVAR_UNLOCK(sav); 541 } 542 543 /* Determine the ESP header length */ 544 if (sav->flags & SADB_X_EXT_OLD) 545 hlen = sizeof (struct esp) + sav->ivlen; 546 else 547 hlen = sizeof (struct newesp) + sav->ivlen; 548 549 /* Remove the ESP header and IV from the mbuf. */ 550 error = m_striphdr(m, skip, hlen); 551 if (error) { 552 ESPSTAT_INC(esps_hdrops); 553 DPRINTF(("%s: bad mbuf chain, SA %s/%08lx\n", __func__, 554 ipsec_address(&sav->sah->saidx.dst, buf, sizeof(buf)), 555 (u_long) ntohl(sav->spi))); 556 goto bad; 557 } 558 559 /* Save the last three bytes of decrypted data */ 560 m_copydata(m, m->m_pkthdr.len - 3, 3, lastthree); 561 562 /* Verify pad length */ 563 if (lastthree[1] + 2 > m->m_pkthdr.len - skip) { 564 ESPSTAT_INC(esps_badilen); 565 DPRINTF(("%s: invalid padding length %d for %u byte packet " 566 "in SA %s/%08lx\n", __func__, lastthree[1], 567 m->m_pkthdr.len - skip, 568 ipsec_address(&sav->sah->saidx.dst, buf, sizeof(buf)), 569 (u_long) ntohl(sav->spi))); 570 error = EINVAL; 571 goto bad; 572 } 573 574 /* Verify correct decryption by checking the last padding bytes */ 575 if ((sav->flags & SADB_X_EXT_PMASK) != SADB_X_EXT_PRAND) { 576 if (lastthree[1] != lastthree[0] && lastthree[1] != 0) { 577 ESPSTAT_INC(esps_badenc); 578 DPRINTF(("%s: decryption failed for packet in " 579 "SA %s/%08lx\n", __func__, ipsec_address( 580 &sav->sah->saidx.dst, buf, sizeof(buf)), 581 (u_long) ntohl(sav->spi))); 582 error = EINVAL; 583 goto bad; 584 } 585 } 586 587 /* Trim the mbuf chain to remove trailing authenticator and padding */ 588 m_adj(m, -(lastthree[1] + 2)); 589 590 /* Restore the Next Protocol field */ 591 m_copyback(m, protoff, sizeof (u_int8_t), lastthree + 2); 592 593 switch (saidx->dst.sa.sa_family) { 594 #ifdef INET6 595 case AF_INET6: 596 error = ipsec6_common_input_cb(m, sav, skip, protoff); 597 break; 598 #endif 599 #ifdef INET 600 case AF_INET: 601 error = ipsec4_common_input_cb(m, sav, skip, protoff); 602 break; 603 #endif 604 default: 605 panic("%s: Unexpected address family: %d saidx=%p", __func__, 606 saidx->dst.sa.sa_family, saidx); 607 } 608 return error; 609 bad: 610 if (sav != NULL) 611 key_freesav(&sav); 612 if (m != NULL) 613 m_freem(m); 614 if (xd != NULL) 615 free(xd, M_XDATA); 616 if (crp != NULL) 617 crypto_freereq(crp); 618 return error; 619 } 620 /* 621 * ESP output routine, called by ipsec[46]_perform_request(). 622 */ 623 static int 624 esp_output(struct mbuf *m, struct secpolicy *sp, struct secasvar *sav, 625 u_int idx, int skip, int protoff) 626 { 627 IPSEC_DEBUG_DECLARE(char buf[IPSEC_ADDRSTRLEN]); 628 struct cryptodesc *crde = NULL, *crda = NULL; 629 struct cryptop *crp; 630 const struct auth_hash *esph; 631 const struct enc_xform *espx; 632 struct mbuf *mo = NULL; 633 struct xform_data *xd; 634 struct secasindex *saidx; 635 unsigned char *pad; 636 uint8_t *ivp; 637 uint64_t cntr, cryptoid; 638 int hlen, rlen, padding, blks, alen, i, roff; 639 int error, maxpacketsize; 640 uint8_t prot; 641 642 IPSEC_ASSERT(sav != NULL, ("null SA")); 643 esph = sav->tdb_authalgxform; 644 espx = sav->tdb_encalgxform; 645 IPSEC_ASSERT(espx != NULL, ("null encoding xform")); 646 647 if (sav->flags & SADB_X_EXT_OLD) 648 hlen = sizeof (struct esp) + sav->ivlen; 649 else 650 hlen = sizeof (struct newesp) + sav->ivlen; 651 652 rlen = m->m_pkthdr.len - skip; /* Raw payload length. */ 653 /* 654 * RFC4303 2.4 Requires 4 byte alignment. 655 */ 656 blks = MAX(4, espx->blocksize); /* Cipher blocksize */ 657 658 /* XXX clamp padding length a la KAME??? */ 659 padding = ((blks - ((rlen + 2) % blks)) % blks) + 2; 660 661 alen = xform_ah_authsize(esph); 662 663 ESPSTAT_INC(esps_output); 664 665 saidx = &sav->sah->saidx; 666 /* Check for maximum packet size violations. */ 667 switch (saidx->dst.sa.sa_family) { 668 #ifdef INET 669 case AF_INET: 670 maxpacketsize = IP_MAXPACKET; 671 break; 672 #endif /* INET */ 673 #ifdef INET6 674 case AF_INET6: 675 maxpacketsize = IPV6_MAXPACKET; 676 break; 677 #endif /* INET6 */ 678 default: 679 DPRINTF(("%s: unknown/unsupported protocol " 680 "family %d, SA %s/%08lx\n", __func__, 681 saidx->dst.sa.sa_family, ipsec_address(&saidx->dst, 682 buf, sizeof(buf)), (u_long) ntohl(sav->spi))); 683 ESPSTAT_INC(esps_nopf); 684 error = EPFNOSUPPORT; 685 goto bad; 686 } 687 /* 688 DPRINTF(("%s: skip %d hlen %d rlen %d padding %d alen %d blksd %d\n", 689 __func__, skip, hlen, rlen, padding, alen, blks)); */ 690 if (skip + hlen + rlen + padding + alen > maxpacketsize) { 691 DPRINTF(("%s: packet in SA %s/%08lx got too big " 692 "(len %u, max len %u)\n", __func__, 693 ipsec_address(&saidx->dst, buf, sizeof(buf)), 694 (u_long) ntohl(sav->spi), 695 skip + hlen + rlen + padding + alen, maxpacketsize)); 696 ESPSTAT_INC(esps_toobig); 697 error = EMSGSIZE; 698 goto bad; 699 } 700 701 /* Update the counters. */ 702 ESPSTAT_ADD(esps_obytes, m->m_pkthdr.len - skip); 703 704 m = m_unshare(m, M_NOWAIT); 705 if (m == NULL) { 706 DPRINTF(("%s: cannot clone mbuf chain, SA %s/%08lx\n", __func__, 707 ipsec_address(&saidx->dst, buf, sizeof(buf)), 708 (u_long) ntohl(sav->spi))); 709 ESPSTAT_INC(esps_hdrops); 710 error = ENOBUFS; 711 goto bad; 712 } 713 714 /* Inject ESP header. */ 715 mo = m_makespace(m, skip, hlen, &roff); 716 if (mo == NULL) { 717 DPRINTF(("%s: %u byte ESP hdr inject failed for SA %s/%08lx\n", 718 __func__, hlen, ipsec_address(&saidx->dst, buf, 719 sizeof(buf)), (u_long) ntohl(sav->spi))); 720 ESPSTAT_INC(esps_hdrops); /* XXX diffs from openbsd */ 721 error = ENOBUFS; 722 goto bad; 723 } 724 725 /* Initialize ESP header. */ 726 bcopy((caddr_t) &sav->spi, mtod(mo, caddr_t) + roff, 727 sizeof(uint32_t)); 728 SECASVAR_LOCK(sav); 729 if (sav->replay) { 730 uint32_t replay; 731 732 #ifdef REGRESSION 733 /* Emulate replay attack when ipsec_replay is TRUE. */ 734 if (!V_ipsec_replay) 735 #endif 736 sav->replay->count++; 737 replay = htonl(sav->replay->count); 738 739 bcopy((caddr_t) &replay, mtod(mo, caddr_t) + roff + 740 sizeof(uint32_t), sizeof(uint32_t)); 741 } 742 cryptoid = sav->tdb_cryptoid; 743 if (SAV_ISCTRORGCM(sav)) 744 cntr = sav->cntr++; 745 SECASVAR_UNLOCK(sav); 746 747 /* 748 * Add padding -- better to do it ourselves than use the crypto engine, 749 * although if/when we support compression, we'd have to do that. 750 */ 751 pad = (u_char *) m_pad(m, padding + alen); 752 if (pad == NULL) { 753 DPRINTF(("%s: m_pad failed for SA %s/%08lx\n", __func__, 754 ipsec_address(&saidx->dst, buf, sizeof(buf)), 755 (u_long) ntohl(sav->spi))); 756 m = NULL; /* NB: free'd by m_pad */ 757 error = ENOBUFS; 758 goto bad; 759 } 760 761 /* 762 * Add padding: random, zero, or self-describing. 763 * XXX catch unexpected setting 764 */ 765 switch (sav->flags & SADB_X_EXT_PMASK) { 766 case SADB_X_EXT_PRAND: 767 (void) read_random(pad, padding - 2); 768 break; 769 case SADB_X_EXT_PZERO: 770 bzero(pad, padding - 2); 771 break; 772 case SADB_X_EXT_PSEQ: 773 for (i = 0; i < padding - 2; i++) 774 pad[i] = i+1; 775 break; 776 } 777 778 /* Fix padding length and Next Protocol in padding itself. */ 779 pad[padding - 2] = padding - 2; 780 m_copydata(m, protoff, sizeof(u_int8_t), pad + padding - 1); 781 782 /* Fix Next Protocol in IPv4/IPv6 header. */ 783 prot = IPPROTO_ESP; 784 m_copyback(m, protoff, sizeof(u_int8_t), (u_char *) &prot); 785 786 /* Get crypto descriptors. */ 787 crp = crypto_getreq(esph != NULL ? 2 : 1); 788 if (crp == NULL) { 789 DPRINTF(("%s: failed to acquire crypto descriptors\n", 790 __func__)); 791 ESPSTAT_INC(esps_crypto); 792 error = ENOBUFS; 793 goto bad; 794 } 795 796 /* IPsec-specific opaque crypto info. */ 797 xd = malloc(sizeof(struct xform_data), M_XDATA, M_NOWAIT | M_ZERO); 798 if (xd == NULL) { 799 crypto_freereq(crp); 800 DPRINTF(("%s: failed to allocate xform_data\n", __func__)); 801 ESPSTAT_INC(esps_crypto); 802 error = ENOBUFS; 803 goto bad; 804 } 805 806 crde = crp->crp_desc; 807 crda = crde->crd_next; 808 809 /* Encryption descriptor. */ 810 crde->crd_skip = skip + hlen; 811 crde->crd_len = m->m_pkthdr.len - (skip + hlen + alen); 812 crde->crd_flags = CRD_F_ENCRYPT; 813 crde->crd_inject = skip + hlen - sav->ivlen; 814 815 /* Encryption operation. */ 816 crde->crd_alg = espx->type; 817 if (SAV_ISCTRORGCM(sav)) { 818 ivp = &crde->crd_iv[0]; 819 820 /* GCM IV Format: RFC4106 4 */ 821 /* CTR IV Format: RFC3686 4 */ 822 /* Salt is last four bytes of key, RFC4106 8.1 */ 823 /* Nonce is last four bytes of key, RFC3686 5.1 */ 824 memcpy(ivp, sav->key_enc->key_data + 825 _KEYLEN(sav->key_enc) - 4, 4); 826 be64enc(&ivp[4], cntr); 827 if (SAV_ISCTR(sav)) { 828 /* Initial block counter is 1, RFC3686 4 */ 829 /* XXXAE: should we use this only for first packet? */ 830 be32enc(&ivp[sav->ivlen + 4], 1); 831 } 832 833 m_copyback(m, skip + hlen - sav->ivlen, sav->ivlen, &ivp[4]); 834 crde->crd_flags |= CRD_F_IV_EXPLICIT|CRD_F_IV_PRESENT; 835 } 836 837 /* Callback parameters */ 838 xd->sp = sp; 839 xd->sav = sav; 840 xd->idx = idx; 841 xd->cryptoid = cryptoid; 842 843 /* Crypto operation descriptor. */ 844 crp->crp_ilen = m->m_pkthdr.len; /* Total input length. */ 845 crp->crp_flags = CRYPTO_F_IMBUF | CRYPTO_F_CBIFSYNC; 846 if (V_async_crypto) 847 crp->crp_flags |= CRYPTO_F_ASYNC | CRYPTO_F_ASYNC_KEEPORDER; 848 crp->crp_buf = (caddr_t) m; 849 crp->crp_callback = esp_output_cb; 850 crp->crp_opaque = (caddr_t) xd; 851 crp->crp_sid = cryptoid; 852 853 if (esph) { 854 /* Authentication descriptor. */ 855 crda->crd_alg = esph->type; 856 crda->crd_skip = skip; 857 if (SAV_ISGCM(sav)) 858 crda->crd_len = 8; /* RFC4106 5, SPI + SN */ 859 else 860 crda->crd_len = m->m_pkthdr.len - (skip + alen); 861 crda->crd_inject = m->m_pkthdr.len - alen; 862 } 863 864 return crypto_dispatch(crp); 865 bad: 866 if (m) 867 m_freem(m); 868 key_freesav(&sav); 869 key_freesp(&sp); 870 return (error); 871 } 872 /* 873 * ESP output callback from the crypto driver. 874 */ 875 static int 876 esp_output_cb(struct cryptop *crp) 877 { 878 struct xform_data *xd; 879 struct secpolicy *sp; 880 struct secasvar *sav; 881 struct mbuf *m; 882 uint64_t cryptoid; 883 u_int idx; 884 int error; 885 886 xd = (struct xform_data *) crp->crp_opaque; 887 m = (struct mbuf *) crp->crp_buf; 888 sp = xd->sp; 889 sav = xd->sav; 890 idx = xd->idx; 891 cryptoid = xd->cryptoid; 892 893 /* Check for crypto errors. */ 894 if (crp->crp_etype) { 895 if (crp->crp_etype == EAGAIN) { 896 /* Reset the session ID */ 897 if (ipsec_updateid(sav, &crp->crp_sid, &cryptoid) != 0) 898 crypto_freesession(cryptoid); 899 xd->cryptoid = crp->crp_sid; 900 return (crypto_dispatch(crp)); 901 } 902 ESPSTAT_INC(esps_noxform); 903 DPRINTF(("%s: crypto error %d\n", __func__, crp->crp_etype)); 904 error = crp->crp_etype; 905 m_freem(m); 906 goto bad; 907 } 908 909 /* Shouldn't happen... */ 910 if (m == NULL) { 911 ESPSTAT_INC(esps_crypto); 912 DPRINTF(("%s: bogus returned buffer from crypto\n", __func__)); 913 error = EINVAL; 914 goto bad; 915 } 916 free(xd, M_XDATA); 917 crypto_freereq(crp); 918 ESPSTAT_INC(esps_hist[sav->alg_enc]); 919 if (sav->tdb_authalgxform != NULL) 920 AHSTAT_INC(ahs_hist[sav->alg_auth]); 921 922 #ifdef REGRESSION 923 /* Emulate man-in-the-middle attack when ipsec_integrity is TRUE. */ 924 if (V_ipsec_integrity) { 925 static unsigned char ipseczeroes[AH_HMAC_MAXHASHLEN]; 926 const struct auth_hash *esph; 927 928 /* 929 * Corrupt HMAC if we want to test integrity verification of 930 * the other side. 931 */ 932 esph = sav->tdb_authalgxform; 933 if (esph != NULL) { 934 int alen; 935 936 alen = xform_ah_authsize(esph); 937 m_copyback(m, m->m_pkthdr.len - alen, 938 alen, ipseczeroes); 939 } 940 } 941 #endif 942 943 /* NB: m is reclaimed by ipsec_process_done. */ 944 error = ipsec_process_done(m, sp, sav, idx); 945 return (error); 946 bad: 947 free(xd, M_XDATA); 948 crypto_freereq(crp); 949 key_freesav(&sav); 950 key_freesp(&sp); 951 return (error); 952 } 953 954 static struct xformsw esp_xformsw = { 955 .xf_type = XF_ESP, 956 .xf_name = "IPsec ESP", 957 .xf_init = esp_init, 958 .xf_zeroize = esp_zeroize, 959 .xf_input = esp_input, 960 .xf_output = esp_output, 961 }; 962 963 SYSINIT(esp_xform_init, SI_SUB_PROTO_DOMAIN, SI_ORDER_MIDDLE, 964 xform_attach, &esp_xformsw); 965 SYSUNINIT(esp_xform_uninit, SI_SUB_PROTO_DOMAIN, SI_ORDER_MIDDLE, 966 xform_detach, &esp_xformsw); 967