1 /* $NetBSD: xform_esp.c,v 1.40 2012/01/25 20:31:23 drochner Exp $ */ 2 /* $FreeBSD: src/sys/netipsec/xform_esp.c,v 1.2.2.1 2003/01/24 05:11:36 sam Exp $ */ 3 /* $OpenBSD: ip_esp.c,v 1.69 2001/06/26 06:18:59 angelos Exp $ */ 4 5 /* 6 * The authors of this code are John Ioannidis (ji@tla.org), 7 * Angelos D. Keromytis (kermit@csd.uch.gr) and 8 * Niels Provos (provos@physnet.uni-hamburg.de). 9 * 10 * The original version of this code was written by John Ioannidis 11 * for BSD/OS in Athens, Greece, in November 1995. 12 * 13 * Ported to OpenBSD and NetBSD, with additional transforms, in December 1996, 14 * by Angelos D. Keromytis. 15 * 16 * Additional transforms and features in 1997 and 1998 by Angelos D. Keromytis 17 * and Niels Provos. 18 * 19 * Additional features in 1999 by Angelos D. Keromytis. 20 * 21 * Copyright (C) 1995, 1996, 1997, 1998, 1999 by John Ioannidis, 22 * Angelos D. Keromytis and Niels Provos. 23 * Copyright (c) 2001 Angelos D. Keromytis. 24 * 25 * Permission to use, copy, and modify this software with or without fee 26 * is hereby granted, provided that this entire notice is included in 27 * all copies of any software which is or includes a copy or 28 * modification of this software. 29 * You may use this code under the GNU public license if you so wish. Please 30 * contribute changes back to the authors under this freer than GPL license 31 * so that we may further the use of strong encryption without limitations to 32 * all. 33 * 34 * THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR 35 * IMPLIED WARRANTY. IN PARTICULAR, NONE OF THE AUTHORS MAKES ANY 36 * REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE 37 * MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR 38 * PURPOSE. 39 */ 40 41 #include <sys/cdefs.h> 42 __KERNEL_RCSID(0, "$NetBSD: xform_esp.c,v 1.40 2012/01/25 20:31:23 drochner Exp $"); 43 44 #include "opt_inet.h" 45 #ifdef __FreeBSD__ 46 #include "opt_inet6.h" 47 #endif 48 49 #include <sys/param.h> 50 #include <sys/systm.h> 51 #include <sys/mbuf.h> 52 #include <sys/socket.h> 53 #include <sys/syslog.h> 54 #include <sys/kernel.h> 55 /*#include <sys/random.h>*/ 56 #include <sys/sysctl.h> 57 #include <sys/socketvar.h> /* for softnet_lock */ 58 59 #include <net/if.h> 60 61 #include <netinet/in.h> 62 #include <netinet/in_systm.h> 63 #include <netinet/ip.h> 64 #include <netinet/ip_ecn.h> 65 #include <netinet/ip6.h> 66 67 #include <net/route.h> 68 #include <netipsec/ipsec.h> 69 #include <netipsec/ipsec_private.h> 70 #include <netipsec/ah.h> 71 #include <netipsec/ah_var.h> 72 #include <netipsec/esp.h> 73 #include <netipsec/esp_var.h> 74 #include <netipsec/xform.h> 75 76 #ifdef INET6 77 #include <netinet6/ip6_var.h> 78 #include <netipsec/ipsec6.h> 79 # ifdef __FreeBSD__ 80 # include <netinet6/ip6_ecn.h> 81 # endif 82 #endif 83 84 #include <netipsec/key.h> 85 #include <netipsec/key_debug.h> 86 87 #include <netipsec/ipsec_osdep.h> 88 89 #include <opencrypto/cryptodev.h> 90 #include <opencrypto/xform.h> 91 92 percpu_t *espstat_percpu; 93 94 int esp_enable = 1; 95 96 #ifdef __FreeBSD__ 97 SYSCTL_DECL(_net_inet_esp); 98 SYSCTL_INT(_net_inet_esp, OID_AUTO, 99 esp_enable, CTLFLAG_RW, &esp_enable, 0, ""); 100 SYSCTL_STRUCT(_net_inet_esp, IPSECCTL_STATS, 101 stats, CTLFLAG_RD, &espstat, espstat, ""); 102 #endif /* __FreeBSD__ */ 103 104 static int esp_max_ivlen; /* max iv length over all algorithms */ 105 106 static int esp_input_cb(struct cryptop *op); 107 static int esp_output_cb(struct cryptop *crp); 108 109 /* 110 * NB: this is public for use by the PF_KEY support. 111 * NB: if you add support here; be sure to add code to esp_attach below! 112 */ 113 const struct enc_xform * 114 esp_algorithm_lookup(int alg) 115 { 116 if (alg >= ESP_ALG_MAX) 117 return NULL; 118 switch (alg) { 119 case SADB_EALG_DESCBC: 120 return &enc_xform_des; 121 case SADB_EALG_3DESCBC: 122 return &enc_xform_3des; 123 case SADB_X_EALG_AES: 124 return &enc_xform_rijndael128; 125 case SADB_X_EALG_BLOWFISHCBC: 126 return &enc_xform_blf; 127 case SADB_X_EALG_CAST128CBC: 128 return &enc_xform_cast5; 129 case SADB_X_EALG_SKIPJACK: 130 return &enc_xform_skipjack; 131 case SADB_X_EALG_CAMELLIACBC: 132 return &enc_xform_camellia; 133 case SADB_X_EALG_AESCTR: 134 return &enc_xform_aes_ctr; 135 case SADB_X_EALG_AESGCM16: 136 return &enc_xform_aes_gcm; 137 case SADB_X_EALG_AESGMAC: 138 return &enc_xform_aes_gmac; 139 case SADB_EALG_NULL: 140 return &enc_xform_null; 141 } 142 return NULL; 143 } 144 145 size_t 146 esp_hdrsiz(const struct secasvar *sav) 147 { 148 size_t size; 149 150 if (sav != NULL) { 151 /*XXX not right for null algorithm--does it matter??*/ 152 IPSEC_ASSERT(sav->tdb_encalgxform != NULL, 153 ("esp_hdrsiz: SA with null xform")); 154 if (sav->flags & SADB_X_EXT_OLD) 155 size = sizeof (struct esp); 156 else 157 size = sizeof (struct newesp); 158 size += sav->tdb_encalgxform->ivsize + 9; 159 /*XXX need alg check???*/ 160 if (sav->tdb_authalgxform != NULL && sav->replay) 161 size += ah_hdrsiz(sav); 162 } else { 163 /* 164 * base header size 165 * + max iv length for CBC mode 166 * + max pad length 167 * + sizeof (pad length field) 168 * + sizeof (next header field) 169 * + max icv supported. 170 */ 171 size = sizeof (struct newesp) + esp_max_ivlen + 9 + 16; 172 } 173 return size; 174 } 175 176 /* 177 * esp_init() is called when an SPI is being set up. 178 */ 179 static int 180 esp_init(struct secasvar *sav, const struct xformsw *xsp) 181 { 182 const struct enc_xform *txform; 183 struct cryptoini cria, crie; 184 int keylen; 185 int error; 186 187 txform = esp_algorithm_lookup(sav->alg_enc); 188 if (txform == NULL) { 189 DPRINTF(("esp_init: unsupported encryption algorithm %d\n", 190 sav->alg_enc)); 191 return EINVAL; 192 } 193 if (sav->key_enc == NULL) { 194 DPRINTF(("esp_init: no encoding key for %s algorithm\n", 195 txform->name)); 196 return EINVAL; 197 } 198 if ((sav->flags&(SADB_X_EXT_OLD|SADB_X_EXT_IV4B)) == SADB_X_EXT_IV4B) { 199 DPRINTF(("esp_init: 4-byte IV not supported with protocol\n")); 200 return EINVAL; 201 } 202 keylen = _KEYLEN(sav->key_enc); 203 if (txform->minkey > keylen || keylen > txform->maxkey) { 204 DPRINTF(("esp_init: invalid key length %u, must be in " 205 "the range [%u..%u] for algorithm %s\n", 206 keylen, txform->minkey, txform->maxkey, 207 txform->name)); 208 return EINVAL; 209 } 210 211 sav->ivlen = txform->ivsize; 212 213 /* 214 * Setup AH-related state. 215 */ 216 if (sav->alg_auth != 0) { 217 error = ah_init0(sav, xsp, &cria); 218 if (error) 219 return error; 220 } 221 222 /* NB: override anything set in ah_init0 */ 223 sav->tdb_xform = xsp; 224 sav->tdb_encalgxform = txform; 225 226 if (sav->alg_enc == SADB_X_EALG_AESGCM16 || 227 sav->alg_enc == SADB_X_EALG_AESGMAC) { 228 switch (keylen) { 229 case 20: 230 sav->alg_auth = SADB_X_AALG_AES128GMAC; 231 sav->tdb_authalgxform = &auth_hash_gmac_aes_128; 232 break; 233 case 28: 234 sav->alg_auth = SADB_X_AALG_AES192GMAC; 235 sav->tdb_authalgxform = &auth_hash_gmac_aes_192; 236 break; 237 case 36: 238 sav->alg_auth = SADB_X_AALG_AES256GMAC; 239 sav->tdb_authalgxform = &auth_hash_gmac_aes_256; 240 break; 241 } 242 memset(&cria, 0, sizeof(cria)); 243 cria.cri_alg = sav->tdb_authalgxform->type; 244 cria.cri_klen = _KEYBITS(sav->key_enc); 245 cria.cri_key = _KEYBUF(sav->key_enc); 246 } 247 248 /* Initialize crypto session. */ 249 memset(&crie, 0, sizeof (crie)); 250 crie.cri_alg = sav->tdb_encalgxform->type; 251 crie.cri_klen = _KEYBITS(sav->key_enc); 252 crie.cri_key = _KEYBUF(sav->key_enc); 253 /* XXX Rounds ? */ 254 255 if (sav->tdb_authalgxform && sav->tdb_encalgxform) { 256 /* init both auth & enc */ 257 crie.cri_next = &cria; 258 error = crypto_newsession(&sav->tdb_cryptoid, 259 &crie, crypto_support); 260 } else if (sav->tdb_encalgxform) { 261 error = crypto_newsession(&sav->tdb_cryptoid, 262 &crie, crypto_support); 263 } else if (sav->tdb_authalgxform) { 264 error = crypto_newsession(&sav->tdb_cryptoid, 265 &cria, crypto_support); 266 } else { 267 /* XXX cannot happen? */ 268 DPRINTF(("esp_init: no encoding OR authentication xform!\n")); 269 error = EINVAL; 270 } 271 return error; 272 } 273 274 /* 275 * Paranoia. 276 */ 277 static int 278 esp_zeroize(struct secasvar *sav) 279 { 280 /* NB: ah_zerorize free's the crypto session state */ 281 int error = ah_zeroize(sav); 282 283 if (sav->key_enc) 284 memset(_KEYBUF(sav->key_enc), 0, _KEYLEN(sav->key_enc)); 285 sav->tdb_encalgxform = NULL; 286 sav->tdb_xform = NULL; 287 return error; 288 } 289 290 /* 291 * ESP input processing, called (eventually) through the protocol switch. 292 */ 293 static int 294 esp_input(struct mbuf *m, const struct secasvar *sav, int skip, int protoff) 295 { 296 const struct auth_hash *esph; 297 const struct enc_xform *espx; 298 struct tdb_ident *tdbi; 299 struct tdb_crypto *tc; 300 int plen, alen, hlen, error; 301 struct m_tag *mtag; 302 struct newesp *esp; 303 304 struct cryptodesc *crde; 305 struct cryptop *crp; 306 307 IPSEC_SPLASSERT_SOFTNET("esp_input"); 308 309 IPSEC_ASSERT(sav != NULL, ("esp_input: null SA")); 310 IPSEC_ASSERT(sav->tdb_encalgxform != NULL, 311 ("esp_input: null encoding xform")); 312 IPSEC_ASSERT((skip&3) == 0 && (m->m_pkthdr.len&3) == 0, 313 ("esp_input: misaligned packet, skip %u pkt len %u", 314 skip, m->m_pkthdr.len)); 315 316 /* XXX don't pullup, just copy header */ 317 IP6_EXTHDR_GET(esp, struct newesp *, m, skip, sizeof (struct newesp)); 318 319 esph = sav->tdb_authalgxform; 320 espx = sav->tdb_encalgxform; 321 322 /* Determine the ESP header length */ 323 if (sav->flags & SADB_X_EXT_OLD) 324 hlen = sizeof (struct esp) + sav->ivlen; 325 else 326 hlen = sizeof (struct newesp) + sav->ivlen; 327 /* Authenticator hash size */ 328 alen = esph ? esph->authsize : 0; 329 330 /* 331 * Verify payload length is multiple of encryption algorithm 332 * block size. 333 * 334 * NB: This works for the null algorithm because the blocksize 335 * is 4 and all packets must be 4-byte aligned regardless 336 * of the algorithm. 337 */ 338 plen = m->m_pkthdr.len - (skip + hlen + alen); 339 if ((plen & (espx->blocksize - 1)) || (plen <= 0)) { 340 DPRINTF(("esp_input: " 341 "payload of %d octets not a multiple of %d octets," 342 " SA %s/%08lx\n", 343 plen, espx->blocksize, 344 ipsec_address(&sav->sah->saidx.dst), 345 (u_long) ntohl(sav->spi))); 346 ESP_STATINC(ESP_STAT_BADILEN); 347 m_freem(m); 348 return EINVAL; 349 } 350 351 /* 352 * Check sequence number. 353 */ 354 if (esph && sav->replay && !ipsec_chkreplay(ntohl(esp->esp_seq), sav)) { 355 DPRINTF(("esp_input: packet replay check for %s\n", 356 ipsec_logsastr(sav))); /*XXX*/ 357 ESP_STATINC(ESP_STAT_REPLAY); 358 m_freem(m); 359 return ENOBUFS; /*XXX*/ 360 } 361 362 /* Update the counters */ 363 ESP_STATADD(ESP_STAT_IBYTES, m->m_pkthdr.len - skip - hlen - alen); 364 365 /* Find out if we've already done crypto */ 366 for (mtag = m_tag_find(m, PACKET_TAG_IPSEC_IN_CRYPTO_DONE, NULL); 367 mtag != NULL; 368 mtag = m_tag_find(m, PACKET_TAG_IPSEC_IN_CRYPTO_DONE, mtag)) { 369 tdbi = (struct tdb_ident *) (mtag + 1); 370 if (tdbi->proto == sav->sah->saidx.proto && 371 tdbi->spi == sav->spi && 372 !memcmp(&tdbi->dst, &sav->sah->saidx.dst, 373 sizeof(union sockaddr_union))) 374 break; 375 } 376 377 /* Get crypto descriptors */ 378 crp = crypto_getreq(esph && espx ? 2 : 1); 379 if (crp == NULL) { 380 DPRINTF(("esp_input: failed to acquire crypto descriptors\n")); 381 ESP_STATINC(ESP_STAT_CRYPTO); 382 m_freem(m); 383 return ENOBUFS; 384 } 385 386 /* Get IPsec-specific opaque pointer */ 387 if (esph == NULL || mtag != NULL) 388 tc = (struct tdb_crypto *) malloc(sizeof(struct tdb_crypto), 389 M_XDATA, M_NOWAIT|M_ZERO); 390 else 391 tc = (struct tdb_crypto *) malloc(sizeof(struct tdb_crypto) + alen, 392 M_XDATA, M_NOWAIT|M_ZERO); 393 if (tc == NULL) { 394 crypto_freereq(crp); 395 DPRINTF(("esp_input: failed to allocate tdb_crypto\n")); 396 ESP_STATINC(ESP_STAT_CRYPTO); 397 m_freem(m); 398 return ENOBUFS; 399 } 400 401 error = m_makewritable(&m, 0, m->m_pkthdr.len, M_NOWAIT); 402 if (error) { 403 m_freem(m); 404 free(tc, M_XDATA); 405 crypto_freereq(crp); 406 DPRINTF(("esp_input: m_makewritable failed\n")); 407 ESP_STATINC(ESP_STAT_CRYPTO); 408 return error; 409 } 410 411 tc->tc_ptr = mtag; 412 413 if (esph) { 414 struct cryptodesc *crda = crp->crp_desc; 415 416 IPSEC_ASSERT(crda != NULL, ("esp_input: null ah crypto descriptor")); 417 418 /* Authentication descriptor */ 419 crda->crd_skip = skip; 420 if (espx && espx->type == CRYPTO_AES_GCM_16) 421 crda->crd_len = hlen - sav->ivlen; 422 else 423 crda->crd_len = m->m_pkthdr.len - (skip + alen); 424 crda->crd_inject = m->m_pkthdr.len - alen; 425 426 crda->crd_alg = esph->type; 427 if (espx && (espx->type == CRYPTO_AES_GCM_16 || 428 espx->type == CRYPTO_AES_GMAC)) { 429 crda->crd_key = _KEYBUF(sav->key_enc); 430 crda->crd_klen = _KEYBITS(sav->key_enc); 431 } else { 432 crda->crd_key = _KEYBUF(sav->key_auth); 433 crda->crd_klen = _KEYBITS(sav->key_auth); 434 } 435 436 /* Copy the authenticator */ 437 if (mtag == NULL) 438 m_copydata(m, m->m_pkthdr.len - alen, alen, 439 (tc + 1)); 440 441 /* Chain authentication request */ 442 crde = crda->crd_next; 443 } else { 444 crde = crp->crp_desc; 445 } 446 447 /* Crypto operation descriptor */ 448 crp->crp_ilen = m->m_pkthdr.len; /* Total input length */ 449 crp->crp_flags = CRYPTO_F_IMBUF; 450 crp->crp_buf = m; 451 crp->crp_callback = esp_input_cb; 452 crp->crp_sid = sav->tdb_cryptoid; 453 crp->crp_opaque = tc; 454 455 /* These are passed as-is to the callback */ 456 tc->tc_spi = sav->spi; 457 tc->tc_dst = sav->sah->saidx.dst; 458 tc->tc_proto = sav->sah->saidx.proto; 459 tc->tc_protoff = protoff; 460 tc->tc_skip = skip; 461 462 /* Decryption descriptor */ 463 if (espx) { 464 IPSEC_ASSERT(crde != NULL, ("esp_input: null esp crypto descriptor")); 465 crde->crd_skip = skip + hlen; 466 if (espx->type == CRYPTO_AES_GMAC) 467 crde->crd_len = 0; 468 else 469 crde->crd_len = m->m_pkthdr.len - (skip + hlen + alen); 470 crde->crd_inject = skip + hlen - sav->ivlen; 471 472 crde->crd_alg = espx->type; 473 crde->crd_key = _KEYBUF(sav->key_enc); 474 crde->crd_klen = _KEYBITS(sav->key_enc); 475 /* XXX Rounds ? */ 476 } 477 478 if (mtag == NULL) 479 return crypto_dispatch(crp); 480 else 481 return esp_input_cb(crp); 482 } 483 484 #ifdef INET6 485 #define IPSEC_COMMON_INPUT_CB(m, sav, skip, protoff, mtag) do { \ 486 if (saidx->dst.sa.sa_family == AF_INET6) { \ 487 error = ipsec6_common_input_cb(m, sav, skip, protoff, mtag); \ 488 } else { \ 489 error = ipsec4_common_input_cb(m, sav, skip, protoff, mtag); \ 490 } \ 491 } while (0) 492 #else 493 #define IPSEC_COMMON_INPUT_CB(m, sav, skip, protoff, mtag) \ 494 (error = ipsec4_common_input_cb(m, sav, skip, protoff, mtag)) 495 #endif 496 497 /* 498 * ESP input callback from the crypto driver. 499 */ 500 static int 501 esp_input_cb(struct cryptop *crp) 502 { 503 u_int8_t lastthree[3], aalg[AH_ALEN_MAX]; 504 int s, hlen, skip, protoff, error; 505 struct mbuf *m; 506 struct cryptodesc *crd; 507 const struct auth_hash *esph; 508 const struct enc_xform *espx; 509 struct tdb_crypto *tc; 510 struct m_tag *mtag; 511 struct secasvar *sav; 512 struct secasindex *saidx; 513 void *ptr; 514 u_int16_t dport = 0; 515 u_int16_t sport = 0; 516 #ifdef IPSEC_NAT_T 517 struct m_tag * tag = NULL; 518 #endif 519 520 crd = crp->crp_desc; 521 IPSEC_ASSERT(crd != NULL, ("esp_input_cb: null crypto descriptor!")); 522 523 tc = (struct tdb_crypto *) crp->crp_opaque; 524 IPSEC_ASSERT(tc != NULL, ("esp_input_cb: null opaque crypto data area!")); 525 skip = tc->tc_skip; 526 protoff = tc->tc_protoff; 527 mtag = (struct m_tag *) tc->tc_ptr; 528 m = (struct mbuf *) crp->crp_buf; 529 530 #ifdef IPSEC_NAT_T 531 /* find the source port for NAT-T */ 532 if ((tag = m_tag_find(m, PACKET_TAG_IPSEC_NAT_T_PORTS, NULL))) { 533 sport = ((u_int16_t *)(tag + 1))[0]; 534 dport = ((u_int16_t *)(tag + 1))[1]; 535 } 536 #endif 537 538 s = splsoftnet(); 539 mutex_enter(softnet_lock); 540 541 sav = KEY_ALLOCSA(&tc->tc_dst, tc->tc_proto, tc->tc_spi, sport, dport); 542 if (sav == NULL) { 543 ESP_STATINC(ESP_STAT_NOTDB); 544 DPRINTF(("esp_input_cb: SA expired while in crypto " 545 "(SA %s/%08lx proto %u)\n", ipsec_address(&tc->tc_dst), 546 (u_long) ntohl(tc->tc_spi), tc->tc_proto)); 547 error = ENOBUFS; /*XXX*/ 548 goto bad; 549 } 550 551 saidx = &sav->sah->saidx; 552 IPSEC_ASSERT(saidx->dst.sa.sa_family == AF_INET || 553 saidx->dst.sa.sa_family == AF_INET6, 554 ("esp_input_cb: unexpected protocol family %u", 555 saidx->dst.sa.sa_family)); 556 557 esph = sav->tdb_authalgxform; 558 espx = sav->tdb_encalgxform; 559 560 /* Check for crypto errors */ 561 if (crp->crp_etype) { 562 /* Reset the session ID */ 563 if (sav->tdb_cryptoid != 0) 564 sav->tdb_cryptoid = crp->crp_sid; 565 566 if (crp->crp_etype == EAGAIN) { 567 KEY_FREESAV(&sav); 568 mutex_exit(softnet_lock); 569 splx(s); 570 return crypto_dispatch(crp); 571 } 572 573 ESP_STATINC(ESP_STAT_NOXFORM); 574 DPRINTF(("esp_input_cb: crypto error %d\n", crp->crp_etype)); 575 error = crp->crp_etype; 576 goto bad; 577 } 578 579 /* Shouldn't happen... */ 580 if (m == NULL) { 581 ESP_STATINC(ESP_STAT_CRYPTO); 582 DPRINTF(("esp_input_cb: bogus returned buffer from crypto\n")); 583 error = EINVAL; 584 goto bad; 585 } 586 ESP_STATINC(ESP_STAT_HIST + sav->alg_enc); 587 588 /* If authentication was performed, check now. */ 589 if (esph != NULL) { 590 /* 591 * If we have a tag, it means an IPsec-aware NIC did 592 * the verification for us. Otherwise we need to 593 * check the authentication calculation. 594 */ 595 AH_STATINC(AH_STAT_HIST + sav->alg_auth); 596 if (mtag == NULL) { 597 /* Copy the authenticator from the packet */ 598 m_copydata(m, m->m_pkthdr.len - esph->authsize, 599 esph->authsize, aalg); 600 601 ptr = (tc + 1); 602 603 /* Verify authenticator */ 604 if (memcmp(ptr, aalg, esph->authsize) != 0) { 605 DPRINTF(("esp_input_cb: " 606 "authentication hash mismatch for packet in SA %s/%08lx\n", 607 ipsec_address(&saidx->dst), 608 (u_long) ntohl(sav->spi))); 609 ESP_STATINC(ESP_STAT_BADAUTH); 610 error = EACCES; 611 goto bad; 612 } 613 } 614 615 /* Remove trailing authenticator */ 616 m_adj(m, -(esph->authsize)); 617 } 618 619 /* Release the crypto descriptors */ 620 free(tc, M_XDATA), tc = NULL; 621 crypto_freereq(crp), crp = NULL; 622 623 /* 624 * Packet is now decrypted. 625 */ 626 m->m_flags |= M_DECRYPTED; 627 628 /* 629 * Update replay sequence number, if appropriate. 630 */ 631 if (sav->replay) { 632 u_int32_t seq; 633 634 m_copydata(m, skip + offsetof(struct newesp, esp_seq), 635 sizeof (seq), &seq); 636 if (ipsec_updatereplay(ntohl(seq), sav)) { 637 DPRINTF(("%s: packet replay check for %s\n", __func__, 638 ipsec_logsastr(sav))); 639 ESP_STATINC(ESP_STAT_REPLAY); 640 error = ENOBUFS; 641 goto bad; 642 } 643 } 644 645 /* Determine the ESP header length */ 646 if (sav->flags & SADB_X_EXT_OLD) 647 hlen = sizeof (struct esp) + sav->ivlen; 648 else 649 hlen = sizeof (struct newesp) + sav->ivlen; 650 651 /* Remove the ESP header and IV from the mbuf. */ 652 error = m_striphdr(m, skip, hlen); 653 if (error) { 654 ESP_STATINC(ESP_STAT_HDROPS); 655 DPRINTF(("esp_input_cb: bad mbuf chain, SA %s/%08lx\n", 656 ipsec_address(&sav->sah->saidx.dst), 657 (u_long) ntohl(sav->spi))); 658 goto bad; 659 } 660 661 /* Save the last three bytes of decrypted data */ 662 m_copydata(m, m->m_pkthdr.len - 3, 3, lastthree); 663 664 /* Verify pad length */ 665 if (lastthree[1] + 2 > m->m_pkthdr.len - skip) { 666 ESP_STATINC(ESP_STAT_BADILEN); 667 DPRINTF(("esp_input_cb: invalid padding length %d " 668 "for %u byte packet in SA %s/%08lx\n", 669 lastthree[1], m->m_pkthdr.len - skip, 670 ipsec_address(&sav->sah->saidx.dst), 671 (u_long) ntohl(sav->spi))); 672 error = EINVAL; 673 goto bad; 674 } 675 676 /* Verify correct decryption by checking the last padding bytes */ 677 if ((sav->flags & SADB_X_EXT_PMASK) != SADB_X_EXT_PRAND) { 678 if (lastthree[1] != lastthree[0] && lastthree[1] != 0) { 679 ESP_STATINC(ESP_STAT_BADENC); 680 DPRINTF(("esp_input_cb: decryption failed " 681 "for packet in SA %s/%08lx\n", 682 ipsec_address(&sav->sah->saidx.dst), 683 (u_long) ntohl(sav->spi))); 684 DPRINTF(("esp_input_cb: %x %x\n", lastthree[0], lastthree[1])); 685 error = EINVAL; 686 goto bad; 687 } 688 } 689 690 /* Trim the mbuf chain to remove trailing authenticator and padding */ 691 m_adj(m, -(lastthree[1] + 2)); 692 693 /* Restore the Next Protocol field */ 694 m_copyback(m, protoff, sizeof (u_int8_t), lastthree + 2); 695 696 IPSEC_COMMON_INPUT_CB(m, sav, skip, protoff, mtag); 697 698 KEY_FREESAV(&sav); 699 mutex_exit(softnet_lock); 700 splx(s); 701 return error; 702 bad: 703 if (sav) 704 KEY_FREESAV(&sav); 705 mutex_exit(softnet_lock); 706 splx(s); 707 if (m != NULL) 708 m_freem(m); 709 if (tc != NULL) 710 free(tc, M_XDATA); 711 if (crp != NULL) 712 crypto_freereq(crp); 713 return error; 714 } 715 716 /* 717 * ESP output routine, called by ipsec[46]_process_packet(). 718 */ 719 static int 720 esp_output( 721 struct mbuf *m, 722 struct ipsecrequest *isr, 723 struct mbuf **mp, 724 int skip, 725 int protoff 726 ) 727 { 728 const struct enc_xform *espx; 729 const struct auth_hash *esph; 730 int hlen, rlen, plen, padding, blks, alen, i, roff; 731 struct mbuf *mo = NULL; 732 struct tdb_crypto *tc; 733 const struct secasvar *sav; 734 struct secasindex *saidx; 735 unsigned char *pad; 736 u_int8_t prot; 737 int error, maxpacketsize; 738 739 struct cryptodesc *crde = NULL, *crda = NULL; 740 struct cryptop *crp; 741 742 IPSEC_SPLASSERT_SOFTNET("esp_output"); 743 744 sav = isr->sav; 745 IPSEC_ASSERT(sav != NULL, ("esp_output: null SA")); 746 esph = sav->tdb_authalgxform; 747 espx = sav->tdb_encalgxform; 748 IPSEC_ASSERT(espx != NULL, ("esp_output: null encoding xform")); 749 750 if (sav->flags & SADB_X_EXT_OLD) 751 hlen = sizeof (struct esp) + sav->ivlen; 752 else 753 hlen = sizeof (struct newesp) + sav->ivlen; 754 755 rlen = m->m_pkthdr.len - skip; /* Raw payload length. */ 756 /* 757 * NB: The null encoding transform has a blocksize of 4 758 * so that headers are properly aligned. 759 */ 760 blks = espx->blocksize; /* IV blocksize */ 761 762 /* XXX clamp padding length a la KAME??? */ 763 padding = ((blks - ((rlen + 2) % blks)) % blks) + 2; 764 plen = rlen + padding; /* Padded payload length. */ 765 766 if (esph) 767 alen = esph->authsize; 768 else 769 alen = 0; 770 771 ESP_STATINC(ESP_STAT_OUTPUT); 772 773 saidx = &sav->sah->saidx; 774 /* Check for maximum packet size violations. */ 775 switch (saidx->dst.sa.sa_family) { 776 #ifdef INET 777 case AF_INET: 778 maxpacketsize = IP_MAXPACKET; 779 break; 780 #endif /* INET */ 781 #ifdef INET6 782 case AF_INET6: 783 maxpacketsize = IPV6_MAXPACKET; 784 break; 785 #endif /* INET6 */ 786 default: 787 DPRINTF(("esp_output: unknown/unsupported protocol " 788 "family %d, SA %s/%08lx\n", 789 saidx->dst.sa.sa_family, ipsec_address(&saidx->dst), 790 (u_long) ntohl(sav->spi))); 791 ESP_STATINC(ESP_STAT_NOPF); 792 error = EPFNOSUPPORT; 793 goto bad; 794 } 795 if (skip + hlen + rlen + padding + alen > maxpacketsize) { 796 DPRINTF(("esp_output: packet in SA %s/%08lx got too big " 797 "(len %u, max len %u)\n", 798 ipsec_address(&saidx->dst), (u_long) ntohl(sav->spi), 799 skip + hlen + rlen + padding + alen, maxpacketsize)); 800 ESP_STATINC(ESP_STAT_TOOBIG); 801 error = EMSGSIZE; 802 goto bad; 803 } 804 805 /* Update the counters. */ 806 ESP_STATADD(ESP_STAT_OBYTES, m->m_pkthdr.len - skip); 807 808 m = m_clone(m); 809 if (m == NULL) { 810 DPRINTF(("esp_output: cannot clone mbuf chain, SA %s/%08lx\n", 811 ipsec_address(&saidx->dst), (u_long) ntohl(sav->spi))); 812 ESP_STATINC(ESP_STAT_HDROPS); 813 error = ENOBUFS; 814 goto bad; 815 } 816 817 /* Inject ESP header. */ 818 mo = m_makespace(m, skip, hlen, &roff); 819 if (mo == NULL) { 820 DPRINTF(("esp_output: failed to inject %u byte ESP hdr for SA " 821 "%s/%08lx\n", 822 hlen, ipsec_address(&saidx->dst), 823 (u_long) ntohl(sav->spi))); 824 ESP_STATINC(ESP_STAT_HDROPS); /* XXX diffs from openbsd */ 825 error = ENOBUFS; 826 goto bad; 827 } 828 829 /* Initialize ESP header. */ 830 memcpy(mtod(mo, char *) + roff, &sav->spi, sizeof(u_int32_t)); 831 if (sav->replay) { 832 u_int32_t replay; 833 834 #ifdef IPSEC_DEBUG 835 /* Emulate replay attack when ipsec_replay is TRUE. */ 836 if (!ipsec_replay) 837 #endif 838 sav->replay->count++; 839 840 replay = htonl(sav->replay->count); 841 bcopy(&replay, 842 mtod(mo,char *) + roff + sizeof(u_int32_t), 843 sizeof(u_int32_t)); 844 } 845 846 /* 847 * Add padding -- better to do it ourselves than use the crypto engine, 848 * although if/when we support compression, we'd have to do that. 849 */ 850 pad = (u_char *) m_pad(m, padding + alen); 851 if (pad == NULL) { 852 DPRINTF(("esp_output: m_pad failed for SA %s/%08lx\n", 853 ipsec_address(&saidx->dst), (u_long) ntohl(sav->spi))); 854 m = NULL; /* NB: free'd by m_pad */ 855 error = ENOBUFS; 856 goto bad; 857 } 858 859 /* 860 * Add padding: random, zero, or self-describing. 861 * XXX catch unexpected setting 862 */ 863 switch (sav->flags & SADB_X_EXT_PMASK) { 864 case SADB_X_EXT_PRAND: 865 (void) read_random(pad, padding - 2); 866 break; 867 case SADB_X_EXT_PZERO: 868 memset(pad, 0, padding - 2); 869 break; 870 case SADB_X_EXT_PSEQ: 871 for (i = 0; i < padding - 2; i++) 872 pad[i] = i+1; 873 break; 874 } 875 876 /* Fix padding length and Next Protocol in padding itself. */ 877 pad[padding - 2] = padding - 2; 878 m_copydata(m, protoff, sizeof(u_int8_t), pad + padding - 1); 879 880 /* Fix Next Protocol in IPv4/IPv6 header. */ 881 prot = IPPROTO_ESP; 882 m_copyback(m, protoff, sizeof(u_int8_t), (u_char *) &prot); 883 884 /* Get crypto descriptors. */ 885 crp = crypto_getreq(esph && espx ? 2 : 1); 886 if (crp == NULL) { 887 DPRINTF(("esp_output: failed to acquire crypto descriptors\n")); 888 ESP_STATINC(ESP_STAT_CRYPTO); 889 error = ENOBUFS; 890 goto bad; 891 } 892 893 if (espx) { 894 crde = crp->crp_desc; 895 crda = crde->crd_next; 896 897 /* Encryption descriptor. */ 898 crde->crd_skip = skip + hlen; 899 if (espx->type == CRYPTO_AES_GMAC) 900 crde->crd_len = 0; 901 else 902 crde->crd_len = m->m_pkthdr.len - (skip + hlen + alen); 903 crde->crd_flags = CRD_F_ENCRYPT; 904 crde->crd_inject = skip + hlen - sav->ivlen; 905 906 /* Encryption operation. */ 907 crde->crd_alg = espx->type; 908 crde->crd_key = _KEYBUF(sav->key_enc); 909 crde->crd_klen = _KEYBITS(sav->key_enc); 910 /* XXX Rounds ? */ 911 } else 912 crda = crp->crp_desc; 913 914 /* IPsec-specific opaque crypto info. */ 915 tc = (struct tdb_crypto *) malloc(sizeof(struct tdb_crypto), 916 M_XDATA, M_NOWAIT|M_ZERO); 917 if (tc == NULL) { 918 crypto_freereq(crp); 919 DPRINTF(("esp_output: failed to allocate tdb_crypto\n")); 920 ESP_STATINC(ESP_STAT_CRYPTO); 921 error = ENOBUFS; 922 goto bad; 923 } 924 925 /* Callback parameters */ 926 tc->tc_isr = isr; 927 tc->tc_spi = sav->spi; 928 tc->tc_dst = saidx->dst; 929 tc->tc_proto = saidx->proto; 930 931 /* Crypto operation descriptor. */ 932 crp->crp_ilen = m->m_pkthdr.len; /* Total input length. */ 933 crp->crp_flags = CRYPTO_F_IMBUF; 934 crp->crp_buf = m; 935 crp->crp_callback = esp_output_cb; 936 crp->crp_opaque = tc; 937 crp->crp_sid = sav->tdb_cryptoid; 938 939 if (esph) { 940 /* Authentication descriptor. */ 941 crda->crd_skip = skip; 942 if (espx && espx->type == CRYPTO_AES_GCM_16) 943 crda->crd_len = hlen - sav->ivlen; 944 else 945 crda->crd_len = m->m_pkthdr.len - (skip + alen); 946 crda->crd_inject = m->m_pkthdr.len - alen; 947 948 /* Authentication operation. */ 949 crda->crd_alg = esph->type; 950 if (espx && (espx->type == CRYPTO_AES_GCM_16 || 951 espx->type == CRYPTO_AES_GMAC)) { 952 crda->crd_key = _KEYBUF(sav->key_enc); 953 crda->crd_klen = _KEYBITS(sav->key_enc); 954 } else { 955 crda->crd_key = _KEYBUF(sav->key_auth); 956 crda->crd_klen = _KEYBITS(sav->key_auth); 957 } 958 } 959 960 return crypto_dispatch(crp); 961 bad: 962 if (m) 963 m_freem(m); 964 return (error); 965 } 966 967 /* 968 * ESP output callback from the crypto driver. 969 */ 970 static int 971 esp_output_cb(struct cryptop *crp) 972 { 973 struct tdb_crypto *tc; 974 struct ipsecrequest *isr; 975 struct secasvar *sav; 976 struct mbuf *m; 977 int s, err, error; 978 979 tc = (struct tdb_crypto *) crp->crp_opaque; 980 IPSEC_ASSERT(tc != NULL, ("esp_output_cb: null opaque data area!")); 981 m = (struct mbuf *) crp->crp_buf; 982 983 s = splsoftnet(); 984 mutex_enter(softnet_lock); 985 986 isr = tc->tc_isr; 987 sav = KEY_ALLOCSA(&tc->tc_dst, tc->tc_proto, tc->tc_spi, 0, 0); 988 if (sav == NULL) { 989 ESP_STATINC(ESP_STAT_NOTDB); 990 DPRINTF(("esp_output_cb: SA expired while in crypto " 991 "(SA %s/%08lx proto %u)\n", ipsec_address(&tc->tc_dst), 992 (u_long) ntohl(tc->tc_spi), tc->tc_proto)); 993 error = ENOBUFS; /*XXX*/ 994 goto bad; 995 } 996 IPSEC_ASSERT(isr->sav == sav, 997 ("esp_output_cb: SA changed was %p now %p\n", isr->sav, sav)); 998 999 /* Check for crypto errors. */ 1000 if (crp->crp_etype) { 1001 /* Reset session ID. */ 1002 if (sav->tdb_cryptoid != 0) 1003 sav->tdb_cryptoid = crp->crp_sid; 1004 1005 if (crp->crp_etype == EAGAIN) { 1006 KEY_FREESAV(&sav); 1007 mutex_exit(softnet_lock); 1008 splx(s); 1009 return crypto_dispatch(crp); 1010 } 1011 1012 ESP_STATINC(ESP_STAT_NOXFORM); 1013 DPRINTF(("esp_output_cb: crypto error %d\n", crp->crp_etype)); 1014 error = crp->crp_etype; 1015 goto bad; 1016 } 1017 1018 /* Shouldn't happen... */ 1019 if (m == NULL) { 1020 ESP_STATINC(ESP_STAT_CRYPTO); 1021 DPRINTF(("esp_output_cb: bogus returned buffer from crypto\n")); 1022 error = EINVAL; 1023 goto bad; 1024 } 1025 ESP_STATINC(ESP_STAT_HIST + sav->alg_enc); 1026 if (sav->tdb_authalgxform != NULL) 1027 AH_STATINC(AH_STAT_HIST + sav->alg_auth); 1028 1029 /* Release crypto descriptors. */ 1030 free(tc, M_XDATA); 1031 crypto_freereq(crp); 1032 1033 #ifdef IPSEC_DEBUG 1034 /* Emulate man-in-the-middle attack when ipsec_integrity is TRUE. */ 1035 if (ipsec_integrity) { 1036 static unsigned char ipseczeroes[AH_ALEN_MAX]; 1037 const struct auth_hash *esph; 1038 1039 /* 1040 * Corrupt HMAC if we want to test integrity verification of 1041 * the other side. 1042 */ 1043 esph = sav->tdb_authalgxform; 1044 if (esph != NULL) { 1045 m_copyback(m, m->m_pkthdr.len - esph->authsize, 1046 esph->authsize, ipseczeroes); 1047 } 1048 } 1049 #endif 1050 1051 /* NB: m is reclaimed by ipsec_process_done. */ 1052 err = ipsec_process_done(m, isr); 1053 KEY_FREESAV(&sav); 1054 mutex_exit(softnet_lock); 1055 splx(s); 1056 return err; 1057 bad: 1058 if (sav) 1059 KEY_FREESAV(&sav); 1060 mutex_exit(softnet_lock); 1061 splx(s); 1062 if (m) 1063 m_freem(m); 1064 free(tc, M_XDATA); 1065 crypto_freereq(crp); 1066 return error; 1067 } 1068 1069 static struct xformsw esp_xformsw = { 1070 XF_ESP, XFT_CONF|XFT_AUTH, "IPsec ESP", 1071 esp_init, esp_zeroize, esp_input, 1072 esp_output, 1073 NULL, 1074 }; 1075 1076 INITFN void 1077 esp_attach(void) 1078 { 1079 1080 espstat_percpu = percpu_alloc(sizeof(uint64_t) * ESP_NSTATS); 1081 1082 #define MAXIV(xform) \ 1083 if (xform.ivsize > esp_max_ivlen) \ 1084 esp_max_ivlen = xform.ivsize \ 1085 1086 esp_max_ivlen = 0; 1087 MAXIV(enc_xform_des); /* SADB_EALG_DESCBC */ 1088 MAXIV(enc_xform_3des); /* SADB_EALG_3DESCBC */ 1089 MAXIV(enc_xform_rijndael128); /* SADB_X_EALG_AES */ 1090 MAXIV(enc_xform_blf); /* SADB_X_EALG_BLOWFISHCBC */ 1091 MAXIV(enc_xform_cast5); /* SADB_X_EALG_CAST128CBC */ 1092 MAXIV(enc_xform_skipjack); /* SADB_X_EALG_SKIPJACK */ 1093 MAXIV(enc_xform_camellia); /* SADB_X_EALG_CAMELLIACBC */ 1094 MAXIV(enc_xform_aes_ctr); /* SADB_X_EALG_AESCTR */ 1095 MAXIV(enc_xform_null); /* SADB_EALG_NULL */ 1096 1097 xform_register(&esp_xformsw); 1098 #undef MAXIV 1099 } 1100 #ifdef __FreeBSD__ 1101 SYSINIT(esp_xform_init, SI_SUB_DRIVERS, SI_ORDER_FIRST, esp_attach, NULL) 1102 #else 1103 #endif 1104