1 /* $NetBSD: print-ah.c,v 1.4 1996/05/20 00:41:16 fvdl Exp $ */
4 * Copyright (c) 1988, 1989, 1990, 1991, 1992, 1993, 1994
5 * The Regents of the University of California. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that: (1) source code distributions
9 * retain the above copyright notice and this paragraph in its entirety, (2)
10 * distributions including binary code include the above copyright notice and
11 * this paragraph in its entirety in the documentation or other materials
12 * provided with the distribution, and (3) all advertising materials mentioning
13 * features or use of this software display the following acknowledgement:
14 * ``This product includes software developed by the University of California,
15 * Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
16 * the University nor the names of its contributors may be used to endorse
17 * or promote products derived from this software without specific prior
19 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
20 * WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
21 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
24 /* \summary: IPSEC Encapsulating Security Payload (ESP) printer */
30 #include "netdissect-stdinc.h"
35 /* Any code in this file that depends on HAVE_LIBCRYPTO depends on
36 * HAVE_OPENSSL_EVP_H too. Undefining the former when the latter isn't defined
37 * is the simplest way of handling the dependency.
40 #ifdef HAVE_OPENSSL_EVP_H
41 #include <openssl/evp.h>
47 #include "netdissect.h"
48 #include "strtoaddr.h"
51 #include "ascii_strcasecmp.h"
57 * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
58 * All rights reserved.
60 * Redistribution and use in source and binary forms, with or without
61 * modification, are permitted provided that the following conditions
63 * 1. Redistributions of source code must retain the above copyright
64 * notice, this list of conditions and the following disclaimer.
65 * 2. Redistributions in binary form must reproduce the above copyright
66 * notice, this list of conditions and the following disclaimer in the
67 * documentation and/or other materials provided with the distribution.
68 * 3. Neither the name of the project nor the names of its contributors
69 * may be used to endorse or promote products derived from this software
70 * without specific prior written permission.
72 * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
73 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
74 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
75 * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
76 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
77 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
78 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
79 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
80 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
81 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
86 * RFC1827/2406 Encapsulated Security Payload.
90 nd_uint32_t esp_spi
; /* ESP */
91 nd_uint32_t esp_seq
; /* Sequence number */
92 /*variable size*/ /* (IV and) Payload data */
93 /*variable size*/ /* padding */
94 /*8bit*/ /* pad size */
95 /*8bit*/ /* next header */
96 /*8bit*/ /* next header */
97 /*variable size, 32bit bound*/ /* Authentication data */
100 #ifdef HAVE_LIBCRYPTO
106 struct sa_list
*next
;
108 union inaddr_u daddr
;
109 uint32_t spi
; /* if == 0, then IKEv2 */
111 u_char spii
[8]; /* for IKEv2 */
113 const EVP_CIPHER
*evp
;
116 u_char authsecret
[256];
118 u_char secret
[256]; /* is that big enough for all secrets? */
122 #ifndef HAVE_EVP_CIPHER_CTX_NEW
124 * Allocate an EVP_CIPHER_CTX.
125 * Used if we have an older version of OpenSSL that doesn't provide
126 * routines to allocate and free them.
128 static EVP_CIPHER_CTX
*
129 EVP_CIPHER_CTX_new(void)
133 ctx
= malloc(sizeof(*ctx
));
136 memset(ctx
, 0, sizeof(*ctx
));
141 EVP_CIPHER_CTX_free(EVP_CIPHER_CTX
*ctx
)
143 EVP_CIPHER_CTX_cleanup(ctx
);
148 #ifdef HAVE_EVP_CIPHERINIT_EX
150 * Initialize the cipher by calling EVP_CipherInit_ex(), because
151 * calling EVP_CipherInit() will reset the cipher context, clearing
152 * the cipher, so calling it twice, with the second call having a
153 * null cipher, will clear the already-set cipher. EVP_CipherInit_ex(),
154 * however, won't reset the cipher context, so you can use it to specify
155 * the IV oin a second call after a first call to EVP_CipherInit_ex()
156 * to set the cipher and the key.
158 * XXX - is there some reason why we need to make two calls?
161 set_cipher_parameters(EVP_CIPHER_CTX
*ctx
, const EVP_CIPHER
*cipher
,
162 const unsigned char *key
,
163 const unsigned char *iv
, int enc
)
165 return EVP_CipherInit_ex(ctx
, cipher
, NULL
, key
, iv
, enc
);
169 * Initialize the cipher by calling EVP_CipherInit(), because we don't
170 * have EVP_CipherInit_ex(); we rely on it not trashing the context.
173 set_cipher_parameters(EVP_CIPHER_CTX
*ctx
, const EVP_CIPHER
*cipher
,
174 const unsigned char *key
,
175 const unsigned char *iv
, int enc
)
177 return EVP_CipherInit(ctx
, cipher
, key
, iv
, enc
);
182 * this will adjust ndo_packetp and ndo_snapend to new buffer!
184 USES_APPLE_DEPRECATED_API
185 int esp_print_decrypt_buffer_by_ikev2(netdissect_options
*ndo
,
187 const u_char spii
[8],
188 const u_char spir
[8],
189 const u_char
*buf
, const u_char
*end
)
195 unsigned int block_size
, output_buffer_size
;
196 u_char
*output_buffer
;
198 /* initiator arg is any non-zero value */
199 if(initiator
) initiator
=1;
201 /* see if we can find the SA, and if so, decode it */
202 for (sa
= ndo
->ndo_sa_list_head
; sa
!= NULL
; sa
= sa
->next
) {
204 && initiator
== sa
->initiator
205 && memcmp(spii
, sa
->spii
, 8) == 0
206 && memcmp(spir
, sa
->spir
, 8) == 0)
210 if(sa
== NULL
) return 0;
211 if(sa
->evp
== NULL
) return 0;
214 * remove authenticator, and see if we still have something to
217 end
= end
- sa
->authlen
;
219 buf
= buf
+ sa
->ivlen
;
222 if(end
<= buf
) return 0;
224 ctx
= EVP_CIPHER_CTX_new();
227 if (set_cipher_parameters(ctx
, sa
->evp
, sa
->secret
, NULL
, 0) < 0)
228 (*ndo
->ndo_warning
)(ndo
, "espkey init failed");
229 set_cipher_parameters(ctx
, NULL
, NULL
, iv
, 0);
231 * Allocate a buffer for the decrypted data.
232 * The output buffer must be separate from the input buffer, and
233 * its size must be a multiple of the cipher block size.
235 block_size
= (unsigned int)EVP_CIPHER_CTX_block_size(ctx
);
236 output_buffer_size
= len
+ (block_size
- len
% block_size
);
237 output_buffer
= (u_char
*)malloc(output_buffer_size
);
238 if (output_buffer
== NULL
) {
239 (*ndo
->ndo_error
)(ndo
, S_ERR_ND_MEM_ALLOC
,
240 "can't allocate memory for decryption buffer");
241 EVP_CIPHER_CTX_free(ctx
);
244 EVP_Cipher(ctx
, output_buffer
, buf
, len
);
245 EVP_CIPHER_CTX_free(ctx
);
248 * XXX - of course this is wrong, because buf is a const buffer,
249 * but changing this would require a more complicated fix.
251 memcpy(buf
, output_buffer
, len
);
254 ndo
->ndo_packetp
= buf
;
255 ndo
->ndo_snapend
= end
;
261 static void esp_print_addsa(netdissect_options
*ndo
,
262 struct sa_list
*sa
, int sa_def
)
268 /* malloc() return used in a 'struct sa_list': do not free() */
269 nsa
= (struct sa_list
*)malloc(sizeof(struct sa_list
));
271 (*ndo
->ndo_error
)(ndo
, S_ERR_ND_MEM_ALLOC
,
272 "esp_print_addsa: malloc");
277 ndo
->ndo_sa_default
= nsa
;
279 nsa
->next
= ndo
->ndo_sa_list_head
;
280 ndo
->ndo_sa_list_head
= nsa
;
284 static u_int
hexdigit(netdissect_options
*ndo
, char hex
)
286 if (hex
>= '0' && hex
<= '9')
288 else if (hex
>= 'A' && hex
<= 'F')
289 return (hex
- 'A' + 10);
290 else if (hex
>= 'a' && hex
<= 'f')
291 return (hex
- 'a' + 10);
293 (*ndo
->ndo_error
)(ndo
, S_ERR_ND_ESP_SECRET
,
294 "invalid hex digit %c in espsecret\n", hex
);
299 static u_int
hex2byte(netdissect_options
*ndo
, char *hexstring
)
303 byte
= (hexdigit(ndo
, hexstring
[0]) << 4) + hexdigit(ndo
, hexstring
[1]);
308 * returns size of binary, 0 on failure.
311 int espprint_decode_hex(netdissect_options
*ndo
,
312 u_char
*binbuf
, unsigned int binbuf_len
,
318 len
= strlen(hex
) / 2;
320 if (len
> binbuf_len
) {
321 (*ndo
->ndo_warning
)(ndo
, "secret is too big: %u\n", len
);
326 while (hex
[0] != '\0' && hex
[1]!='\0') {
327 binbuf
[i
] = hex2byte(ndo
, hex
);
336 * decode the form: SPINUM@IP <tab> ALGONAME:0xsecret
339 USES_APPLE_DEPRECATED_API
341 espprint_decode_encalgo(netdissect_options
*ndo
,
342 char *decode
, struct sa_list
*sa
)
345 const EVP_CIPHER
*evp
;
349 colon
= strchr(decode
, ':');
351 (*ndo
->ndo_warning
)(ndo
, "failed to decode espsecret: %s\n", decode
);
356 if (strlen(decode
) > strlen("-hmac96") &&
357 !strcmp(decode
+ strlen(decode
) - strlen("-hmac96"),
359 p
= strstr(decode
, "-hmac96");
363 if (strlen(decode
) > strlen("-cbc") &&
364 !strcmp(decode
+ strlen(decode
) - strlen("-cbc"), "-cbc")) {
365 p
= strstr(decode
, "-cbc");
368 evp
= EVP_get_cipherbyname(decode
);
371 (*ndo
->ndo_warning
)(ndo
, "failed to find cipher algo %s\n", decode
);
379 sa
->authlen
= authlen
;
380 sa
->ivlen
= EVP_CIPHER_iv_length(evp
);
383 if (colon
[0] == '0' && colon
[1] == 'x') {
384 /* decode some hex! */
387 sa
->secretlen
= espprint_decode_hex(ndo
, sa
->secret
, sizeof(sa
->secret
), colon
);
388 if(sa
->secretlen
== 0) return 0;
392 if (i
< sizeof(sa
->secret
)) {
393 memcpy(sa
->secret
, colon
, i
);
396 memcpy(sa
->secret
, colon
, sizeof(sa
->secret
));
397 sa
->secretlen
= sizeof(sa
->secret
);
406 * for the moment, ignore the auth algorith, just hard code the authenticator
407 * length. Need to research how openssl looks up HMAC stuff.
410 espprint_decode_authalgo(netdissect_options
*ndo
,
411 char *decode
, struct sa_list
*sa
)
415 colon
= strchr(decode
, ':');
417 (*ndo
->ndo_warning
)(ndo
, "failed to decode espsecret: %s\n", decode
);
422 if(ascii_strcasecmp(colon
,"sha1") == 0 ||
423 ascii_strcasecmp(colon
,"md5") == 0) {
429 static void esp_print_decode_ikeline(netdissect_options
*ndo
, char *line
,
430 const char *file
, int lineno
)
432 /* it's an IKEv2 secret, store it instead */
436 char *icookie
, *rcookie
;
441 init
= strsep(&line
, " \t");
442 icookie
= strsep(&line
, " \t");
443 rcookie
= strsep(&line
, " \t");
444 authkey
= strsep(&line
, " \t");
445 enckey
= strsep(&line
, " \t");
447 /* if any fields are missing */
448 if(!init
|| !icookie
|| !rcookie
|| !authkey
|| !enckey
) {
449 (*ndo
->ndo_warning
)(ndo
, "print_esp: failed to find all fields for ikev2 at %s:%u",
455 ilen
= strlen(icookie
);
456 rlen
= strlen(rcookie
);
458 if((init
[0]!='I' && init
[0]!='R')
459 || icookie
[0]!='0' || icookie
[1]!='x'
460 || rcookie
[0]!='0' || rcookie
[1]!='x'
463 (*ndo
->ndo_warning
)(ndo
, "print_esp: line %s:%u improperly formatted.",
466 (*ndo
->ndo_warning
)(ndo
, "init=%s icookie=%s(%u) rcookie=%s(%u)",
467 init
, icookie
, ilen
, rcookie
, rlen
);
473 sa1
.initiator
= (init
[0] == 'I');
474 if(espprint_decode_hex(ndo
, sa1
.spii
, sizeof(sa1
.spii
), icookie
+2)!=8)
477 if(espprint_decode_hex(ndo
, sa1
.spir
, sizeof(sa1
.spir
), rcookie
+2)!=8)
480 if(!espprint_decode_encalgo(ndo
, enckey
, &sa1
)) return;
482 if(!espprint_decode_authalgo(ndo
, authkey
, &sa1
)) return;
484 esp_print_addsa(ndo
, &sa1
, FALSE
);
489 * special form: file /name
490 * causes us to go read from this file instead.
493 static void esp_print_decode_onesecret(netdissect_options
*ndo
, char *line
,
494 const char *file
, int lineno
)
502 spikey
= strsep(&line
, " \t");
504 memset(&sa1
, 0, sizeof(struct sa_list
));
506 /* if there is only one token, then it is an algo:key token */
510 /* sa1.daddr.version = 0; */
511 /* memset(&sa1.daddr, 0, sizeof(sa1.daddr)); */
517 if (spikey
&& ascii_strcasecmp(spikey
, "file") == 0) {
518 /* open file and read it */
521 int subfile_lineno
=0;
523 char *filename
= line
;
525 secretfile
= fopen(filename
, FOPEN_READ_TXT
);
526 if (secretfile
== NULL
) {
527 (*ndo
->ndo_error
)(ndo
, S_ERR_ND_OPEN_FILE
,
528 "print_esp: can't open %s: %s\n",
529 filename
, strerror(errno
));
533 while (fgets(fileline
, sizeof(fileline
)-1, secretfile
) != NULL
) {
535 /* remove newline from the line */
536 nl
= strchr(fileline
, '\n');
539 if (fileline
[0] == '#') continue;
540 if (fileline
[0] == '\0') continue;
542 esp_print_decode_onesecret(ndo
, fileline
, filename
, subfile_lineno
);
549 if (spikey
&& ascii_strcasecmp(spikey
, "ikev2") == 0) {
550 esp_print_decode_ikeline(ndo
, line
, file
, lineno
);
559 spistr
= strsep(&spikey
, "@");
561 spino
= strtoul(spistr
, &foo
, 0);
562 if (spistr
== foo
|| !spikey
) {
563 (*ndo
->ndo_warning
)(ndo
, "print_esp: failed to decode spi# %s\n", foo
);
569 if (strtoaddr6(spikey
, &sa1
.daddr
.in6
) == 1) {
570 sa1
.daddr_version
= 6;
571 } else if (strtoaddr(spikey
, &sa1
.daddr
.in4
) == 1) {
572 sa1
.daddr_version
= 4;
574 (*ndo
->ndo_warning
)(ndo
, "print_esp: can not decode IP# %s\n", spikey
);
580 /* skip any blank spaces */
581 while (isspace((unsigned char)*decode
))
584 if(!espprint_decode_encalgo(ndo
, decode
, &sa1
)) {
589 esp_print_addsa(ndo
, &sa1
, sa_def
);
592 USES_APPLE_DEPRECATED_API
593 static void esp_init(netdissect_options
*ndo _U_
)
596 * 0.9.6 doesn't appear to define OPENSSL_API_COMPAT, so
597 * we check whether it's undefined or it's less than the
600 #if !defined(OPENSSL_API_COMPAT) || OPENSSL_API_COMPAT < 0x10100000L
601 OpenSSL_add_all_algorithms();
603 EVP_add_cipher_alias(SN_des_ede3_cbc
, "3des");
607 void esp_print_decodesecret(netdissect_options
*ndo
)
611 static int initialized
= 0;
618 p
= ndo
->ndo_espsecret
;
620 while (p
&& p
[0] != '\0') {
621 /* pick out the first line or first thing until a comma */
622 if ((line
= strsep(&p
, "\n,")) == NULL
) {
627 esp_print_decode_onesecret(ndo
, line
, "cmdline", 0);
630 ndo
->ndo_espsecret
= NULL
;
635 #ifdef HAVE_LIBCRYPTO
636 USES_APPLE_DEPRECATED_API
639 esp_print(netdissect_options
*ndo
,
640 const u_char
*bp
, const int length
, const u_char
*bp2
641 #ifndef HAVE_LIBCRYPTO
646 #ifndef HAVE_LIBCRYPTO
651 #ifndef HAVE_LIBCRYPTO
656 const struct newesp
*esp
;
658 #ifdef HAVE_LIBCRYPTO
660 struct sa_list
*sa
= NULL
;
661 const struct ip6_hdr
*ip6
= NULL
;
669 unsigned int block_size
, output_buffer_size
;
670 u_char
*output_buffer
;
673 ndo
->ndo_protocol
= "esp";
674 esp
= (const struct newesp
*)bp
;
676 #ifdef HAVE_LIBCRYPTO
682 /* keep secret out of a register */
683 p
= (u_char
*)&secret
;
686 /* 'ep' points to the end of available data. */
687 ep
= ndo
->ndo_snapend
;
689 if ((const u_char
*)(esp
+ 1) >= ep
) {
693 ND_PRINT("ESP(spi=0x%08x", EXTRACT_BE_U_4(esp
->esp_spi
));
694 ND_PRINT(",seq=0x%x)", EXTRACT_BE_U_4(esp
->esp_seq
));
695 ND_PRINT(", length %u", length
);
697 #ifndef HAVE_LIBCRYPTO
700 /* initiailize SAs */
701 if (ndo
->ndo_sa_list_head
== NULL
) {
702 if (!ndo
->ndo_espsecret
)
705 esp_print_decodesecret(ndo
);
708 if (ndo
->ndo_sa_list_head
== NULL
)
711 ip
= (const struct ip
*)bp2
;
714 ip6
= (const struct ip6_hdr
*)bp2
;
715 /* we do not attempt to decrypt jumbograms */
716 if (!EXTRACT_BE_U_2(ip6
->ip6_plen
))
718 /* if we can't get nexthdr, we do not need to decrypt it */
719 len
= sizeof(struct ip6_hdr
) + EXTRACT_BE_U_2(ip6
->ip6_plen
);
721 /* see if we can find the SA, and if so, decode it */
722 for (sa
= ndo
->ndo_sa_list_head
; sa
!= NULL
; sa
= sa
->next
) {
723 if (sa
->spi
== EXTRACT_BE_U_4(esp
->esp_spi
) &&
724 sa
->daddr_version
== 6 &&
725 UNALIGNED_MEMCMP(&sa
->daddr
.in6
, &ip6
->ip6_dst
,
726 sizeof(nd_ipv6
)) == 0) {
732 /* nexthdr & padding are in the last fragment */
733 if (EXTRACT_BE_U_2(ip
->ip_off
) & IP_MF
)
735 len
= EXTRACT_BE_U_2(ip
->ip_len
);
737 /* see if we can find the SA, and if so, decode it */
738 for (sa
= ndo
->ndo_sa_list_head
; sa
!= NULL
; sa
= sa
->next
) {
739 if (sa
->spi
== EXTRACT_BE_U_4(esp
->esp_spi
) &&
740 sa
->daddr_version
== 4 &&
741 UNALIGNED_MEMCMP(&sa
->daddr
.in4
, &ip
->ip_dst
,
742 sizeof(nd_ipv4
)) == 0) {
751 /* if we didn't find the specific one, then look for
752 * an unspecified one.
755 sa
= ndo
->ndo_sa_default
;
757 /* if not found fail */
761 /* if we can't get nexthdr, we do not need to decrypt it */
764 if (ep
- bp2
> len
) {
765 /* FCS included at end of frame (NetBSD 1.6 or later) */
769 /* pointer to the IV, if there is one */
770 ivoff
= (const u_char
*)(esp
+ 1) + 0;
771 /* length of the IV, if there is one; 0, if there isn't */
774 ep
= ep
- sa
->authlen
;
777 ctx
= EVP_CIPHER_CTX_new();
779 if (set_cipher_parameters(ctx
, sa
->evp
, secret
, NULL
, 0) < 0)
780 (*ndo
->ndo_warning
)(ndo
, "espkey init failed");
783 set_cipher_parameters(ctx
, NULL
, NULL
, p
, 0);
784 len
= ep
- (p
+ ivlen
);
787 * Allocate a buffer for the decrypted data.
788 * The output buffer must be separate from the
789 * input buffer, and its size must be a multiple
790 * of the cipher block size.
792 block_size
= (unsigned int)EVP_CIPHER_CTX_block_size(ctx
);
793 output_buffer_size
= len
+ (block_size
- len
% block_size
);
794 output_buffer
= (u_char
*)malloc(output_buffer_size
);
795 if (output_buffer
== NULL
) {
796 (*ndo
->ndo_error
)(ndo
, S_ERR_ND_MEM_ALLOC
,
797 "esp_print: malloc decryption buffer");
798 EVP_CIPHER_CTX_free(ctx
);
802 EVP_Cipher(ctx
, output_buffer
, p
+ ivlen
, len
);
803 EVP_CIPHER_CTX_free(ctx
);
805 * XXX - of course this is wrong, because buf is a
806 * const buffer, but changing this would require a
807 * more complicated fix.
809 memcpy(p
+ ivlen
, output_buffer
, len
);
811 advance
= ivoff
- (const u_char
*)esp
+ ivlen
;
813 advance
= sizeof(struct newesp
);
815 advance
= sizeof(struct newesp
);
817 /* sanity check for pad length */
818 if (ep
- bp
< EXTRACT_U_1(ep
- 2))
822 *padlen
= EXTRACT_U_1(ep
- 2) + 2;
825 *nhdr
= EXTRACT_U_1(ep
- 1);
834 #ifdef HAVE_LIBCRYPTO