2 * Copyright (c) 1990, 1991, 1993, 1994, 1995, 1996, 1997
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that: (1) source code distributions
7 * retain the above copyright notice and this paragraph in its entirety, (2)
8 * distributions including binary code include the above copyright notice and
9 * this paragraph in its entirety in the documentation or other materials
10 * provided with the distribution, and (3) all advertising materials mentioning
11 * features or use of this software display the following acknowledgement:
12 * ``This product includes software developed by the University of California,
13 * Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
14 * the University nor the names of its contributors may be used to endorse
15 * or promote products derived from this software without specific prior
17 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
18 * WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
19 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
23 * txtproto_print() derived from original code by Hannes Gredler
24 * (hannes@gredler.at):
26 * Redistribution and use in source and binary forms, with or without
27 * modification, are permitted provided that: (1) source code
28 * distributions retain the above copyright notice and this paragraph
29 * in its entirety, and (2) distributions including binary code include
30 * the above copyright notice and this paragraph in its entirety in
31 * the documentation or other materials provided with the distribution.
32 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND
33 * WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT
34 * LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
35 * FOR A PARTICULAR PURPOSE.
42 #include "netdissect-stdinc.h"
55 #include "netdissect.h"
57 #include "ascii_strcasecmp.h"
58 #include "timeval-operations.h"
60 int32_t thiszone
; /* seconds offset from gmt to local time */
61 /* invalid string to print '(invalid)' for malformed or corrupted packets */
62 const char istr
[] = " (invalid)";
65 * timestamp display buffer size, the biggest size of both formats is needed
66 * sizeof("0000000000.000000000") > sizeof("00:00:00.000000000")
68 #define TS_BUF_SIZE sizeof("0000000000.000000000")
70 #define TOKBUFSIZE 128
73 * Print out a character, filtering out the non-printable ones
76 fn_print_char(netdissect_options
*ndo
, u_char c
)
83 c
^= 0x40; /* DEL to ?, others to alpha */
90 * Print a null-terminated string, filtering out non-printable characters.
91 * DON'T USE IT with a pointer on the packet buffer because there is no
92 * truncation check. For this use, see the nd_printX() functions below.
95 fn_print_str(netdissect_options
*ndo
, const u_char
*s
)
98 fn_print_char(ndo
, *s
);
104 * Print out a null-terminated filename (or other ASCII string), part of
106 * If ep is NULL, assume no truncation check is needed.
107 * Return true if truncated.
108 * Stop at ep (if given) or before the null char, whichever is first.
111 nd_print(netdissect_options
*ndo
,
112 const u_char
*s
, const u_char
*ep
)
117 ret
= 1; /* assume truncated */
118 while (ep
== NULL
|| s
< ep
) {
125 fn_print_char(ndo
, c
);
131 * Print out a null-terminated filename (or other ASCII string) from
132 * a fixed-length field in the packet buffer, or from what remains of
135 * n is the length of the fixed-length field, or the number of bytes
136 * remaining in the packet based on its on-the-network length.
138 * If ep is non-null, it should point just past the last captured byte
139 * of the packet, e.g. ndo->ndo_snapend. If ep is NULL, we assume no
140 * truncation check, other than the checks of the field length/remaining
141 * packet data length, is needed.
143 * Return the number of bytes of string processed, including the
144 * terminating null, if not truncated; as the terminating null is
145 * included in the count, and as there must be a terminating null,
146 * this will always be non-zero. Return 0 if truncated.
149 nd_printztn(netdissect_options
*ndo
,
150 const u_char
*s
, u_int n
, const u_char
*ep
)
157 if (n
== 0 || (ep
!= NULL
&& s
>= ep
)) {
159 * Truncated. This includes "no null before we
160 * got to the end of the fixed-length buffer or
161 * the end of the packet".
163 * XXX - BOOTP says "null-terminated", which
164 * means the maximum length of the string, in
165 * bytes, is 1 less than the size of the buffer,
166 * as there must always be a terminating null.
180 fn_print_char(ndo
, c
);
186 * Print out a counted filename (or other ASCII string), part of
188 * If ep is NULL, assume no truncation check is needed.
189 * Return true if truncated.
190 * Stop at ep (if given) or after n bytes, whichever is first.
193 nd_printn(netdissect_options
*ndo
,
194 const u_char
*s
, u_int n
, const u_char
*ep
)
198 while (n
> 0 && (ep
== NULL
|| s
< ep
)) {
202 fn_print_char(ndo
, c
);
204 return (n
== 0) ? 0 : 1;
208 * Print out a null-padded filename (or other ASCII string), part of
210 * If ep is NULL, assume no truncation check is needed.
211 * Return true if truncated.
212 * Stop at ep (if given) or after n bytes or before the null char,
213 * whichever is first.
216 nd_printzp(netdissect_options
*ndo
,
217 const u_char
*s
, u_int n
,
223 ret
= 1; /* assume truncated */
224 while (n
> 0 && (ep
== NULL
|| s
< ep
)) {
232 fn_print_char(ndo
, c
);
234 return (n
== 0) ? 0 : ret
;
238 * Format the timestamp
241 ts_format(netdissect_options
*ndo
242 #ifndef HAVE_PCAP_SET_TSTAMP_PRECISION
245 , int sec
, int usec
, char *buf
)
249 #ifdef HAVE_PCAP_SET_TSTAMP_PRECISION
250 switch (ndo
->ndo_tstamp_precision
) {
252 case PCAP_TSTAMP_PRECISION_MICRO
:
253 format
= "%02d:%02d:%02d.%06u";
256 case PCAP_TSTAMP_PRECISION_NANO
:
257 format
= "%02d:%02d:%02d.%09u";
261 format
= "%02d:%02d:%02d.{unknown}";
265 format
= "%02d:%02d:%02d.%06u";
268 nd_snprintf(buf
, TS_BUF_SIZE
, format
,
269 sec
/ 3600, (sec
% 3600) / 60, sec
% 60, usec
);
275 * Format the timestamp - Unix timeval style
278 ts_unix_format(netdissect_options
*ndo
279 #ifndef HAVE_PCAP_SET_TSTAMP_PRECISION
282 , int sec
, int usec
, char *buf
)
286 #ifdef HAVE_PCAP_SET_TSTAMP_PRECISION
287 switch (ndo
->ndo_tstamp_precision
) {
289 case PCAP_TSTAMP_PRECISION_MICRO
:
293 case PCAP_TSTAMP_PRECISION_NANO
:
298 format
= "%u.{unknown}";
305 nd_snprintf(buf
, TS_BUF_SIZE
, format
,
306 (unsigned)sec
, (unsigned)usec
);
312 * Print the timestamp
315 ts_print(netdissect_options
*ndo
,
316 const struct timeval
*tvp
)
321 char buf
[TS_BUF_SIZE
];
322 static struct timeval tv_ref
;
323 struct timeval tv_result
;
327 switch (ndo
->ndo_tflag
) {
329 case 0: /* Default */
330 s
= (tvp
->tv_sec
+ thiszone
) % 86400;
331 ND_PRINT("%s ", ts_format(ndo
, s
, tvp
->tv_usec
, buf
));
334 case 1: /* No time stamp */
337 case 2: /* Unix timeval style */
338 ND_PRINT("%s ", ts_unix_format(ndo
,
339 tvp
->tv_sec
, tvp
->tv_usec
, buf
));
342 case 3: /* Microseconds/nanoseconds since previous packet */
343 case 5: /* Microseconds/nanoseconds since first packet */
344 #ifdef HAVE_PCAP_SET_TSTAMP_PRECISION
345 switch (ndo
->ndo_tstamp_precision
) {
346 case PCAP_TSTAMP_PRECISION_MICRO
:
349 case PCAP_TSTAMP_PRECISION_NANO
:
359 if (!(netdissect_timevalisset(&tv_ref
)))
360 tv_ref
= *tvp
; /* set timestamp for first packet */
362 negative_offset
= netdissect_timevalcmp(tvp
, &tv_ref
, <);
364 netdissect_timevalsub(&tv_ref
, tvp
, &tv_result
, nano_prec
);
366 netdissect_timevalsub(tvp
, &tv_ref
, &tv_result
, nano_prec
);
368 ND_PRINT((negative_offset
? "-" : " "));
370 ND_PRINT("%s ", ts_format(ndo
,
371 tv_result
.tv_sec
, tv_result
.tv_usec
, buf
));
373 if (ndo
->ndo_tflag
== 3)
374 tv_ref
= *tvp
; /* set timestamp for previous packet */
377 case 4: /* Default + Date */
378 s
= (tvp
->tv_sec
+ thiszone
) % 86400;
379 Time
= (tvp
->tv_sec
+ thiszone
) - s
;
382 ND_PRINT("Date fail ");
384 ND_PRINT("%04d-%02d-%02d %s ",
385 tm
->tm_year
+1900, tm
->tm_mon
+1, tm
->tm_mday
,
386 ts_format(ndo
, s
, tvp
->tv_usec
, buf
));
392 * Print an unsigned relative number of seconds (e.g. hold time, prune timer)
393 * in the form 5m1s. This does no truncation, so 32230861 seconds
394 * is represented as 1y1w1d1h1m1s.
397 unsigned_relts_print(netdissect_options
*ndo
,
400 static const char *lengths
[] = {"y", "w", "d", "h", "m", "s"};
401 static const u_int seconds
[] = {31536000, 604800, 86400, 3600, 60, 1};
402 const char **l
= lengths
;
403 const u_int
*s
= seconds
;
411 ND_PRINT("%u%s", secs
/ *s
, *l
);
412 secs
-= (secs
/ *s
) * *s
;
420 * Print a signed relative number of seconds (e.g. hold time, prune timer)
421 * in the form 5m1s. This does no truncation, so 32230861 seconds
422 * is represented as 1y1w1d1h1m1s.
425 signed_relts_print(netdissect_options
*ndo
,
430 if (secs
== INT32_MIN
) {
432 * -2^31; you can't fit its absolute value into
433 * a 32-bit signed integer.
435 * Just directly pass said absolute value to
436 * unsigned_relts_print() directly.
438 * (XXX - does ISO C guarantee that -(-2^n),
439 * when calculated and cast to an n-bit unsigned
440 * integer type, will have the value 2^n?)
442 unsigned_relts_print(ndo
, 2147483648U);
445 * We now know -secs will fit into an int32_t;
446 * negate it and pass that to unsigned_relts_print().
448 unsigned_relts_print(ndo
, -secs
);
452 unsigned_relts_print(ndo
, secs
);
455 /* Print the truncated string */
456 void nd_print_trunc(netdissect_options
*ndo
)
458 ND_PRINT(" [|%s]", ndo
->ndo_protocol
);
462 * this is a generic routine for printing unknown data;
463 * we pass on the linefeed plus indentation string to
464 * get a proper output - returns 0 on error
468 print_unknown_data(netdissect_options
*ndo
, const u_char
*cp
,const char *ident
,int len
)
471 ND_PRINT("%sDissector error: print_unknown_data called with negative length",
475 if (ndo
->ndo_snapend
- cp
< len
)
476 len
= ndo
->ndo_snapend
- cp
;
478 ND_PRINT("%sDissector error: print_unknown_data called with pointer past end of packet",
482 hex_print(ndo
, ident
,cp
,len
);
483 return(1); /* everything is ok */
487 * Convert a token value to a string; use "fmt" if not found.
490 tok2strbuf(const struct tok
*lp
, const char *fmt
,
491 u_int v
, char *buf
, size_t bufsize
)
494 while (lp
->s
!= NULL
) {
503 (void)nd_snprintf(buf
, bufsize
, fmt
, v
);
504 return (const char *)buf
;
508 * Convert a token value to a string; use "fmt" if not found.
509 * Uses tok2strbuf() on one of four local static buffers of size TOKBUFSIZE
510 * in round-robin fashion.
513 tok2str(const struct tok
*lp
, const char *fmt
,
516 static char buf
[4][TOKBUFSIZE
];
522 return tok2strbuf(lp
, fmt
, v
, ret
, sizeof(buf
[0]));
526 * Convert a bit token value to a string; use "fmt" if not found.
527 * this is useful for parsing bitfields, the output strings are seperated
528 * if the s field is positive.
531 bittok2str_internal(const struct tok
*lp
, const char *fmt
,
532 u_int v
, const char *sep
)
534 static char buf
[1024+1]; /* our string buffer */
536 size_t space_left
= sizeof(buf
), string_size
;
537 u_int rotbit
; /* this is the bit we rotate through all bitpositions */
539 const char * sepstr
= "";
541 while (lp
!= NULL
&& lp
->s
!= NULL
) {
542 tokval
=lp
->v
; /* load our first value */
544 while (rotbit
!= 0) {
546 * lets AND the rotating bit with our token value
547 * and see if we have got a match
549 if (tokval
== (v
&rotbit
)) {
550 /* ok we have found something */
552 return (buf
); /* only enough room left for NUL, if that */
553 string_size
= strlcpy(bufp
, sepstr
, space_left
);
554 if (string_size
>= space_left
)
555 return (buf
); /* we ran out of room */
557 space_left
-= string_size
;
559 return (buf
); /* only enough room left for NUL, if that */
560 string_size
= strlcpy(bufp
, lp
->s
, space_left
);
561 if (string_size
>= space_left
)
562 return (buf
); /* we ran out of room */
564 space_left
-= string_size
;
568 rotbit
=rotbit
<<1; /* no match - lets shift and try again */
574 /* bummer - lets print the "unknown" message as advised in the fmt string if we got one */
575 (void)nd_snprintf(buf
, sizeof(buf
), fmt
== NULL
? "#%08x" : fmt
, v
);
580 * Convert a bit token value to a string; use "fmt" if not found.
581 * this is useful for parsing bitfields, the output strings are not seperated.
584 bittok2str_nosep(const struct tok
*lp
, const char *fmt
,
587 return (bittok2str_internal(lp
, fmt
, v
, ""));
591 * Convert a bit token value to a string; use "fmt" if not found.
592 * this is useful for parsing bitfields, the output strings are comma seperated.
595 bittok2str(const struct tok
*lp
, const char *fmt
,
598 return (bittok2str_internal(lp
, fmt
, v
, ", "));
602 * Convert a value to a string using an array; the macro
603 * tok2strary() in <netdissect.h> is the public interface to
604 * this function and ensures that the second argument is
605 * correct for bounds-checking.
608 tok2strary_internal(const char **lp
, int n
, const char *fmt
,
611 static char buf
[TOKBUFSIZE
];
613 if (v
>= 0 && v
< n
&& lp
[v
] != NULL
)
617 (void)nd_snprintf(buf
, sizeof(buf
), fmt
, v
);
622 * Convert a 32-bit netmask to prefixlen if possible
623 * the function returns the prefix-len; if plen == -1
624 * then conversion was not possible;
628 mask2plen(uint32_t mask
)
630 uint32_t bitmasks
[33] = {
632 0x80000000, 0xc0000000, 0xe0000000, 0xf0000000,
633 0xf8000000, 0xfc000000, 0xfe000000, 0xff000000,
634 0xff800000, 0xffc00000, 0xffe00000, 0xfff00000,
635 0xfff80000, 0xfffc0000, 0xfffe0000, 0xffff0000,
636 0xffff8000, 0xffffc000, 0xffffe000, 0xfffff000,
637 0xfffff800, 0xfffffc00, 0xfffffe00, 0xffffff00,
638 0xffffff80, 0xffffffc0, 0xffffffe0, 0xfffffff0,
639 0xfffffff8, 0xfffffffc, 0xfffffffe, 0xffffffff
643 /* let's see if we can transform the mask into a prefixlen */
644 while (prefix_len
>= 0) {
645 if (bitmasks
[prefix_len
] == mask
)
653 mask62plen(const u_char
*mask
)
655 u_char bitmasks
[9] = {
657 0x80, 0xc0, 0xe0, 0xf0,
658 0xf8, 0xfc, 0xfe, 0xff
663 for (byte
= 0; byte
< 16; byte
++) {
666 for (bits
= 0; bits
< (sizeof (bitmasks
) / sizeof (bitmasks
[0])); bits
++) {
667 if (mask
[byte
] == bitmasks
[bits
]) {
673 if (mask
[byte
] != 0xff)
680 * Routine to print out information for text-based protocols such as FTP,
681 * HTTP, SMTP, RTSP, SIP, ....
683 #define MAX_TOKEN 128
686 * Fetch a token from a packet, starting at the specified index,
687 * and return the length of the token.
689 * Returns 0 on error; yes, this is indistinguishable from an empty
690 * token, but an "empty token" isn't a valid token - it just means
691 * either a space character at the beginning of the line (this
692 * includes a blank line) or no more tokens remaining on the line.
695 fetch_token(netdissect_options
*ndo
, const u_char
*pptr
, u_int idx
, u_int len
,
696 u_char
*tbuf
, size_t tbuflen
)
700 for (; idx
< len
; idx
++) {
701 if (!ND_TTEST_1(pptr
+ idx
)) {
702 /* ran past end of captured data */
705 if (!isascii(EXTRACT_U_1(pptr
+ idx
))) {
706 /* not an ASCII character */
709 if (isspace(EXTRACT_U_1(pptr
+ idx
))) {
713 if (!isprint(EXTRACT_U_1(pptr
+ idx
))) {
714 /* not part of a command token or response code */
717 if (toklen
+ 2 > tbuflen
) {
718 /* no room for this character and terminating '\0' */
721 tbuf
[toklen
] = EXTRACT_U_1(pptr
+ idx
);
731 * Skip past any white space after the token, until we see
732 * an end-of-line (CR or LF).
734 for (; idx
< len
; idx
++) {
735 if (!ND_TTEST_1(pptr
+ idx
)) {
736 /* ran past end of captured data */
739 if (EXTRACT_U_1(pptr
+ idx
) == '\r' || EXTRACT_U_1(pptr
+ idx
) == '\n') {
743 if (!isascii(EXTRACT_U_1(pptr
+ idx
)) || !isprint(EXTRACT_U_1(pptr
+ idx
))) {
744 /* not a printable ASCII character */
747 if (!isspace(EXTRACT_U_1(pptr
+ idx
))) {
748 /* beginning of next token */
756 * Scan a buffer looking for a line ending - LF or CR-LF.
757 * Return the index of the character after the line ending or 0 if
758 * we encounter a non-ASCII or non-printable character or don't find
762 print_txt_line(netdissect_options
*ndo
, const char *protoname
,
763 const char *prefix
, const u_char
*pptr
, u_int idx
, u_int len
)
770 ND_TCHECK_1(pptr
+ idx
);
771 if (EXTRACT_U_1(pptr
+ idx
) == '\n') {
773 * LF without CR; end of line.
774 * Skip the LF and print the line, with the
775 * exception of the LF.
777 linelen
= idx
- startidx
;
780 } else if (EXTRACT_U_1(pptr
+ idx
) == '\r') {
782 if ((idx
+1) >= len
) {
783 /* not in this packet */
786 ND_TCHECK_1(pptr
+ idx
+ 1);
787 if (EXTRACT_U_1(pptr
+ idx
+ 1) == '\n') {
789 * CR-LF; end of line.
790 * Skip the CR-LF and print the line, with
791 * the exception of the CR-LF.
793 linelen
= idx
- startidx
;
799 * CR followed by something else; treat this
800 * as if it were binary data, and don't print
804 } else if (!isascii(EXTRACT_U_1(pptr
+ idx
)) ||
805 (!isprint(EXTRACT_U_1(pptr
+ idx
)) &&
806 EXTRACT_U_1(pptr
+ idx
) != '\t')) {
808 * Not a printable ASCII character and not a tab;
809 * treat this as if it were binary data, and
818 * All printable ASCII, but no line ending after that point
819 * in the buffer; treat this as if it were truncated.
822 linelen
= idx
- startidx
;
823 ND_PRINT("%s%.*s[!%s]", prefix
, (int)linelen
, pptr
+ startidx
,
828 ND_PRINT("%s%.*s", prefix
, (int)linelen
, pptr
+ startidx
);
833 txtproto_print(netdissect_options
*ndo
, const u_char
*pptr
, u_int len
,
834 const char *protoname
, const char **cmds
, u_int flags
)
837 u_char token
[MAX_TOKEN
+1];
844 * This protocol has more than just request and
845 * response lines; see whether this looks like a
846 * request or response and, if so, print it and,
847 * in verbose mode, print everything after it.
849 * This is for HTTP-like protocols, where we
850 * want to print requests and responses, but
851 * don't want to print continuations of request
852 * or response bodies in packets that don't
853 * contain the request or response line.
855 idx
= fetch_token(ndo
, pptr
, 0, len
, token
, sizeof(token
));
857 /* Is this a valid request name? */
858 while ((cmd
= *cmds
++) != NULL
) {
859 if (ascii_strcasecmp((const char *)token
, cmd
) == 0) {
867 * No - is this a valid response code (3 digits)?
869 * Is this token the response code, or is the next
870 * token the response code?
872 if (flags
& RESP_CODE_SECOND_TOKEN
) {
874 * Next token - get it.
876 idx
= fetch_token(ndo
, pptr
, idx
, len
, token
,
880 if (isdigit(token
[0]) && isdigit(token
[1]) &&
881 isdigit(token
[2]) && token
[3] == '\0') {
891 * 1) This protocol has only request and response lines
892 * (e.g., FTP, where all the data goes over a different
893 * connection); assume the payload is a request or
898 * 2) This protocol is just text, so that we should
899 * always, at minimum, print the first line and,
900 * in verbose mode, print all lines.
905 /* Capitalize the protocol name */
906 for (pnp
= protoname
; *pnp
!= '\0'; pnp
++)
907 ND_PRINT("%c", toupper((u_char
)*pnp
));
911 * In non-verbose mode, just print the protocol, followed
914 * In verbose mode, print lines as text until we run out
915 * of characters or see something that's not a
916 * printable-ASCII line.
918 if (ndo
->ndo_vflag
) {
920 * We're going to print all the text lines in the
921 * request or response; just print the length
922 * on the first line of the output.
924 ND_PRINT(", length: %u", len
);
926 idx
< len
&& (eol
= print_txt_line(ndo
, protoname
, "\n\t", pptr
, idx
, len
)) != 0;
931 * Just print the first text line.
933 print_txt_line(ndo
, protoname
, ": ", pptr
, 0, len
);
938 #if (defined(__i386__) || defined(_M_IX86) || defined(__X86__) || defined(__x86_64__) || defined(_M_X64)) || \
939 (defined(__arm__) || defined(_M_ARM) || defined(__aarch64__)) || \
940 (defined(__m68k__) && (!defined(__mc68000__) && !defined(__mc68010__))) || \
941 (defined(__ppc__) || defined(__ppc64__) || defined(_M_PPC) || defined(_ARCH_PPC) || defined(_ARCH_PPC64)) || \
942 (defined(__s390__) || defined(__s390x__) || defined(__zarch__)) || \
945 * The procesor natively handles unaligned loads, so just use memcpy()
946 * and memcmp(), to enable those optimizations.
948 * XXX - are those all the x86 tests we need?
949 * XXX - do we need to worry about ARMv1 through ARMv5, which didn't
950 * support unaligned loads, and, if so, do we need to worry about all
951 * of them, or just some of them, e.g. ARMv5?
952 * XXX - are those the only 68k tests we need not to generated
953 * unaligned accesses if the target is the 68000 or 68010?
954 * XXX - are there any tests we don't need, because some definitions are for
955 * compilers that also predefine the GCC symbols?
956 * XXX - do we need to test for both 32-bit and 64-bit versions of those
957 * architectures in all cases?
961 * The processor doesn't natively handle unaligned loads,
962 * and the compiler might "helpfully" optimize memcpy()
963 * and memcmp(), when handed pointers that would normally
964 * be properly aligned, into sequences that assume proper
967 * Do copies and compares of possibly-unaligned data by
968 * calling routines that wrap memcpy() and memcmp(), to
969 * prevent that optimization.
972 unaligned_memcpy(void *p
, const void *q
, size_t l
)
977 /* As with memcpy(), so with memcmp(). */
979 unaligned_memcmp(const void *p
, const void *q
, size_t l
)
981 return (memcmp(p
, q
, l
));