X-Git-Url: https://git.tcpdump.org/tcpdump/blobdiff_plain/b19c83b54e688461fe0cc3a6e77fb3ca86ee9a3c..cda9bf8c5f842fc7110fbbf2234bcc898f78c0bd:/print-esp.c diff --git a/print-esp.c b/print-esp.c index 748fb4a1..f182f162 100644 --- a/print-esp.c +++ b/print-esp.c @@ -24,10 +24,10 @@ /* \summary: IPSEC Encapsulating Security Payload (ESP) printer */ #ifdef HAVE_CONFIG_H -#include "config.h" +#include #endif -#include +#include "netdissect-stdinc.h" #include #include @@ -87,8 +87,8 @@ */ struct newesp { - uint32_t esp_spi; /* ESP */ - uint32_t esp_seq; /* Sequence number */ + nd_uint32_t esp_spi; /* ESP */ + nd_uint32_t esp_seq; /* Sequence number */ /*variable size*/ /* (IV and) Payload data */ /*variable size*/ /* padding */ /*8bit*/ /* pad size */ @@ -111,7 +111,7 @@ struct sa_list { u_char spii[8]; /* for IKEv2 */ u_char spir[8]; const EVP_CIPHER *evp; - int ivlen; + u_int ivlen; int authlen; u_char authsecret[256]; int authsecret_len; @@ -145,20 +145,66 @@ EVP_CIPHER_CTX_free(EVP_CIPHER_CTX *ctx) } #endif +#ifdef HAVE_EVP_CIPHERINIT_EX /* - * this will adjust ndo_packetp and ndo_snapend to new buffer! + * Initialize the cipher by calling EVP_CipherInit_ex(), because + * calling EVP_CipherInit() will reset the cipher context, clearing + * the cipher, so calling it twice, with the second call having a + * null cipher, will clear the already-set cipher. EVP_CipherInit_ex(), + * however, won't reset the cipher context, so you can use it to specify + * the IV in a second call after a first call to EVP_CipherInit_ex() + * to set the cipher and the key. + * + * XXX - is there some reason why we need to make two calls? + */ +static int +set_cipher_parameters(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher, + const unsigned char *key, + const unsigned char *iv, int enc) +{ + return EVP_CipherInit_ex(ctx, cipher, NULL, key, iv, enc); +} +#else +/* + * Initialize the cipher by calling EVP_CipherInit(), because we don't + * have EVP_CipherInit_ex(); we rely on it not trashing the context. + */ +static int +set_cipher_parameters(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher, + const unsigned char *key, + const unsigned char *iv, int enc) +{ + return EVP_CipherInit(ctx, cipher, key, iv, enc); +} +#endif + +/* + * This will allocate a new buffer containing the decrypted data. + * It returns 1 on success and 0 on failure. + * + * It will push the new buffer and the values of ndo->ndo_packetp and + * ndo->ndo_snapend onto the buffer stack, and change ndo->ndo_packetp + * and ndo->ndo_snapend to refer to the new buffer. + * + * Our caller must pop the buffer off the stack when it's finished + * dissecting anything in it and before it does any dissection of + * anything in the old buffer. That will free the new buffer. */ USES_APPLE_DEPRECATED_API int esp_print_decrypt_buffer_by_ikev2(netdissect_options *ndo, int initiator, - u_char spii[8], u_char spir[8], + const u_char spii[8], + const u_char spir[8], const u_char *buf, const u_char *end) { struct sa_list *sa; const u_char *iv; - u_char *buf_mut, *output_buffer; - int len, block_size, cipher_nid, output_buffer_size ; + const u_char *ct; + unsigned int len; EVP_CIPHER_CTX *ctx; + unsigned int block_size, buffer_size; + u_char *input_buffer, *output_buffer; + const u_char *pt; /* initiator arg is any non-zero value */ if(initiator) initiator=1; @@ -181,40 +227,84 @@ int esp_print_decrypt_buffer_by_ikev2(netdissect_options *ndo, */ end = end - sa->authlen; iv = buf; - buf = buf + sa->ivlen; - len = end-buf; + ct = iv + sa->ivlen; + len = end-ct; - if(end <= buf) return 0; + if(end <= ct) return 0; ctx = EVP_CIPHER_CTX_new(); if (ctx == NULL) return 0; - if (EVP_CipherInit(ctx, sa->evp, sa->secret, NULL, 0) < 0) + if (set_cipher_parameters(ctx, sa->evp, sa->secret, NULL, 0) < 0) { (*ndo->ndo_warning)(ndo, "espkey init failed"); - EVP_CipherInit(ctx, NULL, NULL, iv, 0); - - /* We need a block size */ - block_size = EVP_CIPHER_CTX_block_size(ctx); - /* We need the buffer size to be multiple of a block size */ - output_buffer_size = len + (block_size - len % block_size); - output_buffer = (u_char *)calloc(output_buffer_size, sizeof(u_char)); - /* EVP_Cipher output buffer should be different from the input one. - * Also it should be of size that is multiple of cipher block size. */ - EVP_Cipher(ctx, output_buffer, buf, len); - EVP_CIPHER_CTX_free(ctx); + return 0; + } + if (set_cipher_parameters(ctx, NULL, NULL, iv, 0) < 0) { + (*ndo->ndo_warning)(ndo, "IV init failed"); + return 0; + } + /* + * Allocate buffers for the encrypted and decrypted data. + * Both buffers' sizes must be a multiple of the cipher block + * size, and the output buffer must be separate from the input + * buffer. + */ + block_size = (unsigned int)EVP_CIPHER_CTX_block_size(ctx); + buffer_size = len + (block_size - len % block_size); - buf_mut = (u_char*) buf; - /* Of course this is wrong, because buf is a const buffer, but changing this - * would require more complicated fix. */ - memcpy(buf_mut, output_buffer, len); - free(output_buffer); + /* + * Attempt to allocate the input buffer. + */ + input_buffer = (u_char *)malloc(buffer_size); + if (input_buffer == NULL) { + EVP_CIPHER_CTX_free(ctx); + (*ndo->ndo_error)(ndo, S_ERR_ND_MEM_ALLOC, + "can't allocate memory for encrypted data buffer"); + } + /* + * Copy the input data to the encrypted data buffer, and pad it + * with zeroes. + */ + memcpy(input_buffer, ct, len); + memset(input_buffer + len, 0, buffer_size - len); - ndo->ndo_packetp = buf; - ndo->ndo_snapend = end; + /* + * Attempt to allocate the output buffer. + */ + output_buffer = (u_char *)malloc(buffer_size); + if (output_buffer == NULL) { + free(input_buffer); + EVP_CIPHER_CTX_free(ctx); + (*ndo->ndo_error)(ndo, S_ERR_ND_MEM_ALLOC, + "can't allocate memory for decryption buffer"); + } + if (!EVP_Cipher(ctx, output_buffer, input_buffer, len)) { + (*ndo->ndo_warning)(ndo, "EVP_Cipher failed"); + return 0; + } + EVP_CIPHER_CTX_free(ctx); - return 1; + /* + * Free the input buffer; we no longer need it. + */ + free(input_buffer); + /* + * Get a pointer to the plaintext. + */ + pt = output_buffer; + /* + * Switch to the output buffer for dissection, and save it + * on the buffer stack so it can be freed; our caller must + * pop it when done. + */ + if (!nd_push_buffer(ndo, output_buffer, pt, pt + len)) { + free(output_buffer); + return 0; + } + + return 1; } USES_APPLE_RST @@ -225,9 +315,11 @@ static void esp_print_addsa(netdissect_options *ndo, struct sa_list *nsa; + /* malloc() return used in a 'struct sa_list': do not free() */ nsa = (struct sa_list *)malloc(sizeof(struct sa_list)); if (nsa == NULL) - (*ndo->ndo_error)(ndo, "ran out of memory to allocate sa structure"); + (*ndo->ndo_error)(ndo, S_ERR_ND_MEM_ALLOC, + "esp_print_addsa: malloc"); *nsa = *sa; @@ -248,8 +340,8 @@ static u_int hexdigit(netdissect_options *ndo, char hex) else if (hex >= 'a' && hex <= 'f') return (hex - 'a' + 10); else { - (*ndo->ndo_error)(ndo, "invalid hex digit %c in espsecret\n", hex); - return 0; + (*ndo->ndo_error)(ndo, S_ERR_ND_ESP_SECRET, + "invalid hex digit %c in espsecret\n", hex); } } @@ -275,7 +367,7 @@ int espprint_decode_hex(netdissect_options *ndo, len = strlen(hex) / 2; if (len > binbuf_len) { - (*ndo->ndo_warning)(ndo, "secret is too big: %d\n", len); + (*ndo->ndo_warning)(ndo, "secret is too big: %u\n", len); return 0; } @@ -334,6 +426,7 @@ espprint_decode_encalgo(netdissect_options *ndo, sa->evp = evp; sa->authlen = authlen; + /* This returns an int, but it should never be negative */ sa->ivlen = EVP_CIPHER_iv_length(evp); colon++; @@ -360,7 +453,7 @@ espprint_decode_encalgo(netdissect_options *ndo, USES_APPLE_RST /* - * for the moment, ignore the auth algorith, just hard code the authenticator + * for the moment, ignore the auth algorithm, just hard code the authenticator * length. Need to research how openssl looks up HMAC stuff. */ static int @@ -481,9 +574,9 @@ static void esp_print_decode_onesecret(netdissect_options *ndo, char *line, secretfile = fopen(filename, FOPEN_READ_TXT); if (secretfile == NULL) { - (*ndo->ndo_error)(ndo, "print_esp: can't open %s: %s\n", - filename, strerror(errno)); - return; + (*ndo->ndo_error)(ndo, S_ERR_ND_OPEN_FILE, + "print_esp: can't open %s: %s\n", + filename, strerror(errno)); } while (fgets(fileline, sizeof(fileline)-1, secretfile) != NULL) { @@ -513,6 +606,10 @@ static void esp_print_decode_onesecret(netdissect_options *ndo, char *line, uint32_t spino; spistr = strsep(&spikey, "@"); + if (spistr == NULL) { + (*ndo->ndo_warning)(ndo, "print_esp: failed to find the @ token"); + return; + } spino = strtoul(spistr, &foo, 0); if (spistr == foo || !spikey) { @@ -588,119 +685,105 @@ void esp_print_decodesecret(netdissect_options *ndo) #endif +#ifdef HAVE_LIBCRYPTO +#define USED_IF_LIBCRYPTO +#else +#define USED_IF_LIBCRYPTO _U_ +#endif + #ifdef HAVE_LIBCRYPTO USES_APPLE_DEPRECATED_API #endif -int +void esp_print(netdissect_options *ndo, - const u_char *bp, const int length, const u_char *bp2 -#ifndef HAVE_LIBCRYPTO - _U_ -#endif - , - int *nhdr -#ifndef HAVE_LIBCRYPTO - _U_ -#endif - , - int *padlen -#ifndef HAVE_LIBCRYPTO - _U_ -#endif - ) + const u_char *bp, u_int length, + const u_char *bp2 USED_IF_LIBCRYPTO, + u_int ver USED_IF_LIBCRYPTO, + int fragmented USED_IF_LIBCRYPTO, + u_int ttl_hl USED_IF_LIBCRYPTO) { - register const struct newesp *esp; - register const u_char *ep; + const struct newesp *esp; + const u_char *ep; #ifdef HAVE_LIBCRYPTO const struct ip *ip; struct sa_list *sa = NULL; const struct ip6_hdr *ip6 = NULL; - int advance; - int len; - u_char *secret; - int ivlen = 0; - const u_char *ivoff; - const u_char *p; + const u_char *iv; + u_int ivlen; + const u_char *ct; + u_int ctlen; EVP_CIPHER_CTX *ctx; - u_char *buf_mut, *output_buffer; - int block_size, cipher_nid, output_buffer_size; + unsigned int block_size, buffer_size; + u_char *input_buffer, *output_buffer; + const u_char *pt; + u_int ptlen; + u_int padlen; + u_int nh; #endif + ndo->ndo_protocol = "esp"; esp = (const struct newesp *)bp; -#ifdef HAVE_LIBCRYPTO - secret = NULL; - advance = 0; -#endif - -#if 0 - /* keep secret out of a register */ - p = (u_char *)&secret; -#endif - /* 'ep' points to the end of available data. */ ep = ndo->ndo_snapend; if ((const u_char *)(esp + 1) >= ep) { - ND_PRINT((ndo, "[|ESP]")); - goto fail; + nd_print_trunc(ndo); + return; } - ND_PRINT((ndo, "ESP(spi=0x%08x", EXTRACT_32BITS(&esp->esp_spi))); - ND_PRINT((ndo, ",seq=0x%x)", EXTRACT_32BITS(&esp->esp_seq))); - ND_PRINT((ndo, ", length %u", length)); + ND_PRINT("ESP(spi=0x%08x", GET_BE_U_4(esp->esp_spi)); + ND_PRINT(",seq=0x%x)", GET_BE_U_4(esp->esp_seq)); + ND_PRINT(", length %u", length); -#ifndef HAVE_LIBCRYPTO - goto fail; -#else +#ifdef HAVE_LIBCRYPTO /* initiailize SAs */ if (ndo->ndo_sa_list_head == NULL) { if (!ndo->ndo_espsecret) - goto fail; + return; esp_print_decodesecret(ndo); } if (ndo->ndo_sa_list_head == NULL) - goto fail; + return; ip = (const struct ip *)bp2; - switch (IP_V(ip)) { + switch (ver) { case 6: ip6 = (const struct ip6_hdr *)bp2; /* we do not attempt to decrypt jumbograms */ - if (!EXTRACT_16BITS(&ip6->ip6_plen)) - goto fail; + if (!GET_BE_U_2(ip6->ip6_plen)) + return; + /* XXX - check whether it's fragmented? */ /* if we can't get nexthdr, we do not need to decrypt it */ - len = sizeof(struct ip6_hdr) + EXTRACT_16BITS(&ip6->ip6_plen); /* see if we can find the SA, and if so, decode it */ for (sa = ndo->ndo_sa_list_head; sa != NULL; sa = sa->next) { - if (sa->spi == EXTRACT_32BITS(&esp->esp_spi) && + if (sa->spi == GET_BE_U_4(esp->esp_spi) && sa->daddr_version == 6 && UNALIGNED_MEMCMP(&sa->daddr.in6, &ip6->ip6_dst, - sizeof(struct in6_addr)) == 0) { + sizeof(nd_ipv6)) == 0) { break; } } break; case 4: /* nexthdr & padding are in the last fragment */ - if (EXTRACT_16BITS(&ip->ip_off) & IP_MF) - goto fail; - len = EXTRACT_16BITS(&ip->ip_len); + if (fragmented) + return; /* see if we can find the SA, and if so, decode it */ for (sa = ndo->ndo_sa_list_head; sa != NULL; sa = sa->next) { - if (sa->spi == EXTRACT_32BITS(&esp->esp_spi) && + if (sa->spi == GET_BE_U_4(esp->esp_spi) && sa->daddr_version == 4 && UNALIGNED_MEMCMP(&sa->daddr.in4, &ip->ip_dst, - sizeof(struct in_addr)) == 0) { + sizeof(nd_ipv4)) == 0) { break; } } break; default: - goto fail; + return; } /* if we didn't find the specific one, then look for @@ -711,72 +794,173 @@ esp_print(netdissect_options *ndo, /* if not found fail */ if (sa == NULL) - goto fail; - - /* if we can't get nexthdr, we do not need to decrypt it */ - if (ep - bp2 < len) - goto fail; - if (ep - bp2 > len) { - /* FCS included at end of frame (NetBSD 1.6 or later) */ - ep = bp2 + len; - } + return; - ivoff = (const u_char *)(esp + 1) + 0; + /* pointer to the IV, if there is one */ + iv = (const u_char *)(esp + 1) + 0; + /* length of the IV, if there is one; 0, if there isn't */ ivlen = sa->ivlen; - secret = sa->secret; + + /* + * Get a pointer to the ciphertext. + * + * p points to the beginning of the payload, i.e. to the + * initialization vector, so if we skip past the initialization + * vector, it points to the beginning of the ciphertext. + */ + ct = iv + ivlen; + + /* + * Make sure the authentication data/integrity check value length + * isn't bigger than the total amount of data available after + * the ESP header and initialization vector is removed and, + * if not, slice the authentication data/ICV off. + */ + if (ep - ct < sa->authlen) { + nd_print_trunc(ndo); + return; + } ep = ep - sa->authlen; - if (sa->evp) { - ctx = EVP_CIPHER_CTX_new(); - if (ctx != NULL) { - if (EVP_CipherInit(ctx, sa->evp, secret, NULL, 0) < 0) - (*ndo->ndo_warning)(ndo, "espkey init failed"); - - p = ivoff; - EVP_CipherInit(ctx, NULL, NULL, p, 0); - len = ep - (p + ivlen); - - /* We need a block size */ - block_size = EVP_CIPHER_CTX_block_size(ctx); - /* We need the buffer size to be multiple of a block size */ - output_buffer_size = len + (block_size - len % block_size); - output_buffer = (u_char *)calloc(output_buffer_size, sizeof(u_char)); - /* EVP_Cipher output buffer should be different from the input one. - * Also it should be of size that is multiple of cipher block size. */ - EVP_Cipher(ctx, output_buffer, p + ivlen, len); - EVP_CIPHER_CTX_free(ctx); - memcpy(p + ivlen, output_buffer, len); - free(output_buffer); - advance = ivoff - (const u_char *)esp + ivlen; - } else - advance = sizeof(struct newesp); - } else - advance = sizeof(struct newesp); + /* + * Calculate the length of the ciphertext. ep points to + * the beginning of the authentication data/integrity check + * value, i.e. right past the end of the ciphertext; + */ + ctlen = ep - ct; - /* sanity check for pad length */ - if (ep - bp < *(ep - 2)) - goto fail; + if (sa->evp == NULL) + return; - if (padlen) - *padlen = *(ep - 2) + 2; + /* + * If the next header value is past the end of the available + * data, we won't be able to fetch it once we've decrypted + * the ciphertext, so there's no point in decrypting the data. + * + * Report it as truncation. + */ + if (!ND_TTEST_1(ep - 1)) { + nd_print_trunc(ndo); + return; + } - if (nhdr) - *nhdr = *(ep - 1); + ctx = EVP_CIPHER_CTX_new(); + if (ctx == NULL) { + /* + * Failed to initialize the cipher context. + * From a look at the OpenSSL code, this appears to + * mean "couldn't allocate memory for the cipher context"; + * note that we're not passing any parameters, so there's + * not much else it can mean. + */ + (*ndo->ndo_error)(ndo, S_ERR_ND_MEM_ALLOC, + "esp_print: can't allocate memory for cipher context"); + } - ND_PRINT((ndo, ": ")); - return advance; -#endif + if (set_cipher_parameters(ctx, sa->evp, sa->secret, NULL, 0) < 0) { + (*ndo->ndo_warning)(ndo, "espkey init failed"); + return; + } -fail: - return -1; + if (set_cipher_parameters(ctx, NULL, NULL, iv, 0) < 0) { + (*ndo->ndo_warning)(ndo, "IV init failed"); + return; + } + + /* + * Allocate buffers for the encrypted and decrypted + * data. Both buffers' sizes must be a multiple of + * the cipher block size, and the output buffer must + * be separate from the input buffer. + */ + block_size = (unsigned int)EVP_CIPHER_CTX_block_size(ctx); + buffer_size = ctlen + (block_size - ctlen % block_size); + + /* + * Attempt to allocate the input buffer. + */ + input_buffer = (u_char *)malloc(buffer_size); + if (input_buffer == NULL) { + EVP_CIPHER_CTX_free(ctx); + (*ndo->ndo_error)(ndo, S_ERR_ND_MEM_ALLOC, + "esp_print: can't allocate memory for encrypted data buffer"); + } + /* + * Copy the input data to the encrypted data buffer, + * and pad it with zeroes. + */ + memcpy(input_buffer, ct, ctlen); + memset(input_buffer + ctlen, 0, buffer_size - ctlen); + + /* + * Attempt to allocate the output buffer. + */ + output_buffer = (u_char *)malloc(buffer_size); + if (output_buffer == NULL) { + free(input_buffer); + EVP_CIPHER_CTX_free(ctx); + (*ndo->ndo_error)(ndo, S_ERR_ND_MEM_ALLOC, + "esp_print: can't allocate memory for decryption buffer"); + } + + if (!EVP_Cipher(ctx, output_buffer, input_buffer, ctlen)) { + free(input_buffer); + (*ndo->ndo_warning)(ndo, "EVP_Cipher failed"); + return; + } + free(input_buffer); + EVP_CIPHER_CTX_free(ctx); + + /* + * Pointer to the plaintext. + */ + pt = output_buffer; + + /* + * Length of the plaintext, which is the same as the length + * of the ciphertext. + */ + ptlen = ctlen; + + /* + * Switch to the output buffer for dissection, and + * save it on the buffer stack so it can be freed. + */ + if (!nd_push_buffer(ndo, output_buffer, pt, pt + ctlen)) { + free(output_buffer); + (*ndo->ndo_error)(ndo, S_ERR_ND_MEM_ALLOC, + "esp_print: can't push buffer on buffer stack"); + } + ep = pt + ptlen; + + /* + * Sanity check for pad length; if it, plus 2 for the pad + * length and next header fields, is bigger than the ciphertext + * length (which is also the plaintext length), it's too big. + * + * XXX - the check can fail if the packet is corrupt *or* if + * it was not decrypted with the correct key, so that the + * "plaintext" is not what was being sent. + */ + padlen = GET_U_1(ep - 2); + if (padlen + 2 > ptlen) { + nd_print_trunc(ndo); + return; + } + + /* Get the next header */ + nh = GET_U_1(ep - 1); + + ND_PRINT(": "); + + /* Now dissect the plaintext. */ + ip_print_demux(ndo, pt, ptlen - (padlen + 2), ver, fragmented, + ttl_hl, nh, bp2); + + /* Pop the buffer, freeing it. */ + nd_pop_buffer(ndo); +#endif } #ifdef HAVE_LIBCRYPTO USES_APPLE_RST #endif - -/* - * Local Variables: - * c-style: whitesmith - * c-basic-offset: 8 - * End: - */