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 /* invalid string to print '(invalid)' for malformed or corrupted packets */
61 const char istr
[] = " (invalid)";
63 #define TOKBUFSIZE 128
66 enum date_flag
{ WITHOUT_DATE
= 0, WITH_DATE
= 1 };
67 enum time_flag
{ UTC_TIME
= 0, LOCAL_TIME
= 1 };
70 * Print out a character, filtering out the non-printable ones
73 fn_print_char(netdissect_options
*ndo
, u_char c
)
80 c
^= 0x40; /* DEL to ?, others to alpha */
87 * Print a null-terminated string, filtering out non-printable characters.
88 * DON'T USE IT with a pointer on the packet buffer because there is no
89 * truncation check. For this use, see the nd_printX() functions below.
92 fn_print_str(netdissect_options
*ndo
, const u_char
*s
)
95 fn_print_char(ndo
, *s
);
101 * Print out a null-terminated filename (or other ASCII string), part of
103 * If ep is NULL, assume no truncation check is needed.
104 * Return true if truncated.
105 * Stop at ep (if given) or before the null char, whichever is first.
108 nd_print(netdissect_options
*ndo
,
109 const u_char
*s
, const u_char
*ep
)
114 ret
= 1; /* assume truncated */
115 while (ep
== NULL
|| s
< ep
) {
122 fn_print_char(ndo
, c
);
128 * Print out a null-terminated filename (or other ASCII string) from
129 * a fixed-length field in the packet buffer, or from what remains of
132 * n is the length of the fixed-length field, or the number of bytes
133 * remaining in the packet based on its on-the-network length.
135 * If ep is non-null, it should point just past the last captured byte
136 * of the packet, e.g. ndo->ndo_snapend. If ep is NULL, we assume no
137 * truncation check, other than the checks of the field length/remaining
138 * packet data length, is needed.
140 * Return the number of bytes of string processed, including the
141 * terminating null, if not truncated; as the terminating null is
142 * included in the count, and as there must be a terminating null,
143 * this will always be non-zero. Return 0 if truncated.
146 nd_printztn(netdissect_options
*ndo
,
147 const u_char
*s
, u_int n
, const u_char
*ep
)
154 if (n
== 0 || (ep
!= NULL
&& s
>= ep
)) {
156 * Truncated. This includes "no null before we
157 * got to the end of the fixed-length buffer or
158 * the end of the packet".
160 * XXX - BOOTP says "null-terminated", which
161 * means the maximum length of the string, in
162 * bytes, is 1 less than the size of the buffer,
163 * as there must always be a terminating null.
177 fn_print_char(ndo
, c
);
183 * Print out a counted filename (or other ASCII string), part of
185 * If ep is NULL, assume no truncation check is needed.
186 * Return true if truncated.
187 * Stop at ep (if given) or after n bytes, whichever is first.
190 nd_printn(netdissect_options
*ndo
,
191 const u_char
*s
, u_int n
, const u_char
*ep
)
195 while (n
> 0 && (ep
== NULL
|| s
< ep
)) {
199 fn_print_char(ndo
, c
);
201 return (n
== 0) ? 0 : 1;
205 * Print out a null-padded filename (or other ASCII string), part of
207 * If ep is NULL, assume no truncation check is needed.
208 * Return true if truncated.
209 * Stop at ep (if given) or after n bytes or before the null char,
210 * whichever is first.
213 nd_printzp(netdissect_options
*ndo
,
214 const u_char
*s
, u_int n
,
220 ret
= 1; /* assume truncated */
221 while (n
> 0 && (ep
== NULL
|| s
< ep
)) {
229 fn_print_char(ndo
, c
);
231 return (n
== 0) ? 0 : ret
;
235 * Print the timestamp .FRAC part (Microseconds/nanoseconds)
238 ts_frac_print(netdissect_options
*ndo
, int usec
)
240 #ifdef HAVE_PCAP_SET_TSTAMP_PRECISION
241 switch (ndo
->ndo_tstamp_precision
) {
243 case PCAP_TSTAMP_PRECISION_MICRO
:
244 ND_PRINT(".%06u", (unsigned)usec
);
247 case PCAP_TSTAMP_PRECISION_NANO
:
248 ND_PRINT(".%09u", (unsigned)usec
);
252 ND_PRINT(".{unknown}");
256 ND_PRINT(".%06u", (unsigned)usec
);
261 * Print the timestamp as [YY:MM:DD] HH:MM:SS.FRAC.
262 * if time_flag == LOCAL_TIME print local time else UTC/GMT time
263 * if date_flag == WITH_DATE print YY:MM:DD before HH:MM:SS.FRAC
266 ts_date_hmsfrac_print(netdissect_options
*ndo
, int sec
, int usec
,
267 enum date_flag date_flag
, enum time_flag time_flag
)
273 if ((unsigned)sec
& 0x80000000) {
274 ND_PRINT("[Error converting time]");
278 if (time_flag
== LOCAL_TIME
)
279 tm
= localtime(&Time
);
284 ND_PRINT("[Error converting time]");
287 if (date_flag
== WITH_DATE
)
288 strftime(timestr
, sizeof(timestr
), "%Y-%m-%d %H:%M:%S", tm
);
290 strftime(timestr
, sizeof(timestr
), "%H:%M:%S", tm
);
291 ND_PRINT("%s", timestr
);
293 ts_frac_print(ndo
, usec
);
297 * Print the timestamp - Unix timeval style, as SECS.FRAC.
300 ts_unix_print(netdissect_options
*ndo
, int sec
, int usec
)
302 ND_PRINT("%u", (unsigned)sec
);
303 ts_frac_print(ndo
, usec
);
307 * Print the timestamp
310 ts_print(netdissect_options
*ndo
,
311 const struct timeval
*tvp
)
313 static struct timeval tv_ref
;
314 struct timeval tv_result
;
318 switch (ndo
->ndo_tflag
) {
320 case 0: /* Default */
321 ts_date_hmsfrac_print(ndo
, tvp
->tv_sec
, tvp
->tv_usec
,
322 WITHOUT_DATE
, LOCAL_TIME
);
326 case 1: /* No time stamp */
329 case 2: /* Unix timeval style */
330 ts_unix_print(ndo
, tvp
->tv_sec
, tvp
->tv_usec
);
334 case 3: /* Microseconds/nanoseconds since previous packet */
335 case 5: /* Microseconds/nanoseconds since first packet */
336 #ifdef HAVE_PCAP_SET_TSTAMP_PRECISION
337 switch (ndo
->ndo_tstamp_precision
) {
338 case PCAP_TSTAMP_PRECISION_MICRO
:
341 case PCAP_TSTAMP_PRECISION_NANO
:
351 if (!(netdissect_timevalisset(&tv_ref
)))
352 tv_ref
= *tvp
; /* set timestamp for first packet */
354 negative_offset
= netdissect_timevalcmp(tvp
, &tv_ref
, <);
356 netdissect_timevalsub(&tv_ref
, tvp
, &tv_result
, nano_prec
);
358 netdissect_timevalsub(tvp
, &tv_ref
, &tv_result
, nano_prec
);
360 ND_PRINT((negative_offset
? "-" : " "));
361 ts_date_hmsfrac_print(ndo
, tv_result
.tv_sec
, tv_result
.tv_usec
,
362 WITHOUT_DATE
, UTC_TIME
);
365 if (ndo
->ndo_tflag
== 3)
366 tv_ref
= *tvp
; /* set timestamp for previous packet */
369 case 4: /* Date + Default */
370 ts_date_hmsfrac_print(ndo
, tvp
->tv_sec
, tvp
->tv_usec
,
371 WITH_DATE
, LOCAL_TIME
);
378 * Print an unsigned relative number of seconds (e.g. hold time, prune timer)
379 * in the form 5m1s. This does no truncation, so 32230861 seconds
380 * is represented as 1y1w1d1h1m1s.
383 unsigned_relts_print(netdissect_options
*ndo
,
386 static const char *lengths
[] = {"y", "w", "d", "h", "m", "s"};
387 static const u_int seconds
[] = {31536000, 604800, 86400, 3600, 60, 1};
388 const char **l
= lengths
;
389 const u_int
*s
= seconds
;
397 ND_PRINT("%u%s", secs
/ *s
, *l
);
398 secs
-= (secs
/ *s
) * *s
;
406 * Print a signed relative number of seconds (e.g. hold time, prune timer)
407 * in the form 5m1s. This does no truncation, so 32230861 seconds
408 * is represented as 1y1w1d1h1m1s.
411 signed_relts_print(netdissect_options
*ndo
,
416 if (secs
== INT32_MIN
) {
418 * -2^31; you can't fit its absolute value into
419 * a 32-bit signed integer.
421 * Just directly pass said absolute value to
422 * unsigned_relts_print() directly.
424 * (XXX - does ISO C guarantee that -(-2^n),
425 * when calculated and cast to an n-bit unsigned
426 * integer type, will have the value 2^n?)
428 unsigned_relts_print(ndo
, 2147483648U);
431 * We now know -secs will fit into an int32_t;
432 * negate it and pass that to unsigned_relts_print().
434 unsigned_relts_print(ndo
, -secs
);
438 unsigned_relts_print(ndo
, secs
);
441 /* Print the truncated string */
442 void nd_print_trunc(netdissect_options
*ndo
)
444 ND_PRINT(" [|%s]", ndo
->ndo_protocol
);
448 * this is a generic routine for printing unknown data;
449 * we pass on the linefeed plus indentation string to
450 * get a proper output - returns 0 on error
454 print_unknown_data(netdissect_options
*ndo
, const u_char
*cp
,const char *ident
,int len
)
457 ND_PRINT("%sDissector error: print_unknown_data called with negative length",
461 if (ndo
->ndo_snapend
- cp
< len
)
462 len
= ndo
->ndo_snapend
- cp
;
464 ND_PRINT("%sDissector error: print_unknown_data called with pointer past end of packet",
468 hex_print(ndo
, ident
,cp
,len
);
469 return(1); /* everything is ok */
473 * Convert a token value to a string; use "fmt" if not found.
476 tok2strbuf(const struct tok
*lp
, const char *fmt
,
477 u_int v
, char *buf
, size_t bufsize
)
480 while (lp
->s
!= NULL
) {
489 (void)nd_snprintf(buf
, bufsize
, fmt
, v
);
490 return (const char *)buf
;
494 * Convert a token value to a string; use "fmt" if not found.
495 * Uses tok2strbuf() on one of four local static buffers of size TOKBUFSIZE
496 * in round-robin fashion.
499 tok2str(const struct tok
*lp
, const char *fmt
,
502 static char buf
[4][TOKBUFSIZE
];
508 return tok2strbuf(lp
, fmt
, v
, ret
, sizeof(buf
[0]));
512 * Convert a bit token value to a string; use "fmt" if not found.
513 * this is useful for parsing bitfields, the output strings are separated
514 * if the s field is positive.
517 bittok2str_internal(const struct tok
*lp
, const char *fmt
,
518 u_int v
, const char *sep
)
520 static char buf
[1024+1]; /* our string buffer */
522 size_t space_left
= sizeof(buf
), string_size
;
523 u_int rotbit
; /* this is the bit we rotate through all bitpositions */
525 const char * sepstr
= "";
527 while (lp
!= NULL
&& lp
->s
!= NULL
) {
528 tokval
=lp
->v
; /* load our first value */
530 while (rotbit
!= 0) {
532 * lets AND the rotating bit with our token value
533 * and see if we have got a match
535 if (tokval
== (v
&rotbit
)) {
536 /* ok we have found something */
538 return (buf
); /* only enough room left for NUL, if that */
539 string_size
= strlcpy(bufp
, sepstr
, space_left
);
540 if (string_size
>= space_left
)
541 return (buf
); /* we ran out of room */
543 space_left
-= string_size
;
545 return (buf
); /* only enough room left for NUL, if that */
546 string_size
= strlcpy(bufp
, lp
->s
, space_left
);
547 if (string_size
>= space_left
)
548 return (buf
); /* we ran out of room */
550 space_left
-= string_size
;
554 rotbit
=rotbit
<<1; /* no match - lets shift and try again */
560 /* bummer - lets print the "unknown" message as advised in the fmt string if we got one */
561 (void)nd_snprintf(buf
, sizeof(buf
), fmt
== NULL
? "#%08x" : fmt
, v
);
566 * Convert a bit token value to a string; use "fmt" if not found.
567 * this is useful for parsing bitfields, the output strings are not separated.
570 bittok2str_nosep(const struct tok
*lp
, const char *fmt
,
573 return (bittok2str_internal(lp
, fmt
, v
, ""));
577 * Convert a bit token value to a string; use "fmt" if not found.
578 * this is useful for parsing bitfields, the output strings are comma separated.
581 bittok2str(const struct tok
*lp
, const char *fmt
,
584 return (bittok2str_internal(lp
, fmt
, v
, ", "));
588 * Convert a value to a string using an array; the macro
589 * tok2strary() in <netdissect.h> is the public interface to
590 * this function and ensures that the second argument is
591 * correct for bounds-checking.
594 tok2strary_internal(const char **lp
, int n
, const char *fmt
,
597 static char buf
[TOKBUFSIZE
];
599 if (v
>= 0 && v
< n
&& lp
[v
] != NULL
)
603 (void)nd_snprintf(buf
, sizeof(buf
), fmt
, v
);
608 * Convert a 32-bit netmask to prefixlen if possible
609 * the function returns the prefix-len; if plen == -1
610 * then conversion was not possible;
614 mask2plen(uint32_t mask
)
616 uint32_t bitmasks
[33] = {
618 0x80000000, 0xc0000000, 0xe0000000, 0xf0000000,
619 0xf8000000, 0xfc000000, 0xfe000000, 0xff000000,
620 0xff800000, 0xffc00000, 0xffe00000, 0xfff00000,
621 0xfff80000, 0xfffc0000, 0xfffe0000, 0xffff0000,
622 0xffff8000, 0xffffc000, 0xffffe000, 0xfffff000,
623 0xfffff800, 0xfffffc00, 0xfffffe00, 0xffffff00,
624 0xffffff80, 0xffffffc0, 0xffffffe0, 0xfffffff0,
625 0xfffffff8, 0xfffffffc, 0xfffffffe, 0xffffffff
629 /* let's see if we can transform the mask into a prefixlen */
630 while (prefix_len
>= 0) {
631 if (bitmasks
[prefix_len
] == mask
)
639 mask62plen(const u_char
*mask
)
641 u_char bitmasks
[9] = {
643 0x80, 0xc0, 0xe0, 0xf0,
644 0xf8, 0xfc, 0xfe, 0xff
649 for (byte
= 0; byte
< 16; byte
++) {
652 for (bits
= 0; bits
< (sizeof (bitmasks
) / sizeof (bitmasks
[0])); bits
++) {
653 if (mask
[byte
] == bitmasks
[bits
]) {
659 if (mask
[byte
] != 0xff)
666 * Routine to print out information for text-based protocols such as FTP,
667 * HTTP, SMTP, RTSP, SIP, ....
669 #define MAX_TOKEN 128
672 * Fetch a token from a packet, starting at the specified index,
673 * and return the length of the token.
675 * Returns 0 on error; yes, this is indistinguishable from an empty
676 * token, but an "empty token" isn't a valid token - it just means
677 * either a space character at the beginning of the line (this
678 * includes a blank line) or no more tokens remaining on the line.
681 fetch_token(netdissect_options
*ndo
, const u_char
*pptr
, u_int idx
, u_int len
,
682 u_char
*tbuf
, size_t tbuflen
)
686 for (; idx
< len
; idx
++) {
687 if (!ND_TTEST_1(pptr
+ idx
)) {
688 /* ran past end of captured data */
691 if (!isascii(EXTRACT_U_1(pptr
+ idx
))) {
692 /* not an ASCII character */
695 if (isspace(EXTRACT_U_1(pptr
+ idx
))) {
699 if (!isprint(EXTRACT_U_1(pptr
+ idx
))) {
700 /* not part of a command token or response code */
703 if (toklen
+ 2 > tbuflen
) {
704 /* no room for this character and terminating '\0' */
707 tbuf
[toklen
] = EXTRACT_U_1(pptr
+ idx
);
717 * Skip past any white space after the token, until we see
718 * an end-of-line (CR or LF).
720 for (; idx
< len
; idx
++) {
721 if (!ND_TTEST_1(pptr
+ idx
)) {
722 /* ran past end of captured data */
725 if (EXTRACT_U_1(pptr
+ idx
) == '\r' || EXTRACT_U_1(pptr
+ idx
) == '\n') {
729 if (!isascii(EXTRACT_U_1(pptr
+ idx
)) || !isprint(EXTRACT_U_1(pptr
+ idx
))) {
730 /* not a printable ASCII character */
733 if (!isspace(EXTRACT_U_1(pptr
+ idx
))) {
734 /* beginning of next token */
742 * Scan a buffer looking for a line ending - LF or CR-LF.
743 * Return the index of the character after the line ending or 0 if
744 * we encounter a non-ASCII or non-printable character or don't find
748 print_txt_line(netdissect_options
*ndo
, const char *protoname
,
749 const char *prefix
, const u_char
*pptr
, u_int idx
, u_int len
)
756 ND_TCHECK_1(pptr
+ idx
);
757 if (EXTRACT_U_1(pptr
+ idx
) == '\n') {
759 * LF without CR; end of line.
760 * Skip the LF and print the line, with the
761 * exception of the LF.
763 linelen
= idx
- startidx
;
766 } else if (EXTRACT_U_1(pptr
+ idx
) == '\r') {
768 if ((idx
+1) >= len
) {
769 /* not in this packet */
772 ND_TCHECK_1(pptr
+ idx
+ 1);
773 if (EXTRACT_U_1(pptr
+ idx
+ 1) == '\n') {
775 * CR-LF; end of line.
776 * Skip the CR-LF and print the line, with
777 * the exception of the CR-LF.
779 linelen
= idx
- startidx
;
785 * CR followed by something else; treat this
786 * as if it were binary data, and don't print
790 } else if (!isascii(EXTRACT_U_1(pptr
+ idx
)) ||
791 (!isprint(EXTRACT_U_1(pptr
+ idx
)) &&
792 EXTRACT_U_1(pptr
+ idx
) != '\t')) {
794 * Not a printable ASCII character and not a tab;
795 * treat this as if it were binary data, and
804 * All printable ASCII, but no line ending after that point
805 * in the buffer; treat this as if it were truncated.
808 linelen
= idx
- startidx
;
809 ND_PRINT("%s%.*s[!%s]", prefix
, (int)linelen
, pptr
+ startidx
,
814 ND_PRINT("%s%.*s", prefix
, (int)linelen
, pptr
+ startidx
);
819 txtproto_print(netdissect_options
*ndo
, const u_char
*pptr
, u_int len
,
820 const char *protoname
, const char **cmds
, u_int flags
)
823 u_char token
[MAX_TOKEN
+1];
830 * This protocol has more than just request and
831 * response lines; see whether this looks like a
832 * request or response and, if so, print it and,
833 * in verbose mode, print everything after it.
835 * This is for HTTP-like protocols, where we
836 * want to print requests and responses, but
837 * don't want to print continuations of request
838 * or response bodies in packets that don't
839 * contain the request or response line.
841 idx
= fetch_token(ndo
, pptr
, 0, len
, token
, sizeof(token
));
843 /* Is this a valid request name? */
844 while ((cmd
= *cmds
++) != NULL
) {
845 if (ascii_strcasecmp((const char *)token
, cmd
) == 0) {
853 * No - is this a valid response code (3 digits)?
855 * Is this token the response code, or is the next
856 * token the response code?
858 if (flags
& RESP_CODE_SECOND_TOKEN
) {
860 * Next token - get it.
862 idx
= fetch_token(ndo
, pptr
, idx
, len
, token
,
866 if (isdigit(token
[0]) && isdigit(token
[1]) &&
867 isdigit(token
[2]) && token
[3] == '\0') {
877 * 1) This protocol has only request and response lines
878 * (e.g., FTP, where all the data goes over a different
879 * connection); assume the payload is a request or
884 * 2) This protocol is just text, so that we should
885 * always, at minimum, print the first line and,
886 * in verbose mode, print all lines.
891 /* Capitalize the protocol name */
892 for (pnp
= protoname
; *pnp
!= '\0'; pnp
++)
893 ND_PRINT("%c", toupper((u_char
)*pnp
));
897 * In non-verbose mode, just print the protocol, followed
900 * In verbose mode, print lines as text until we run out
901 * of characters or see something that's not a
902 * printable-ASCII line.
904 if (ndo
->ndo_vflag
) {
906 * We're going to print all the text lines in the
907 * request or response; just print the length
908 * on the first line of the output.
910 ND_PRINT(", length: %u", len
);
912 idx
< len
&& (eol
= print_txt_line(ndo
, protoname
, "\n\t", pptr
, idx
, len
)) != 0;
917 * Just print the first text line.
919 print_txt_line(ndo
, protoname
, ": ", pptr
, 0, len
);
924 #if (defined(__i386__) || defined(_M_IX86) || defined(__X86__) || defined(__x86_64__) || defined(_M_X64)) || \
925 (defined(__arm__) || defined(_M_ARM) || defined(__aarch64__)) || \
926 (defined(__m68k__) && (!defined(__mc68000__) && !defined(__mc68010__))) || \
927 (defined(__ppc__) || defined(__ppc64__) || defined(_M_PPC) || defined(_ARCH_PPC) || defined(_ARCH_PPC64)) || \
928 (defined(__s390__) || defined(__s390x__) || defined(__zarch__)) || \
931 * The procesor natively handles unaligned loads, so just use memcpy()
932 * and memcmp(), to enable those optimizations.
934 * XXX - are those all the x86 tests we need?
935 * XXX - do we need to worry about ARMv1 through ARMv5, which didn't
936 * support unaligned loads, and, if so, do we need to worry about all
937 * of them, or just some of them, e.g. ARMv5?
938 * XXX - are those the only 68k tests we need not to generated
939 * unaligned accesses if the target is the 68000 or 68010?
940 * XXX - are there any tests we don't need, because some definitions are for
941 * compilers that also predefine the GCC symbols?
942 * XXX - do we need to test for both 32-bit and 64-bit versions of those
943 * architectures in all cases?
947 * The processor doesn't natively handle unaligned loads,
948 * and the compiler might "helpfully" optimize memcpy()
949 * and memcmp(), when handed pointers that would normally
950 * be properly aligned, into sequences that assume proper
953 * Do copies and compares of possibly-unaligned data by
954 * calling routines that wrap memcpy() and memcmp(), to
955 * prevent that optimization.
958 unaligned_memcpy(void *p
, const void *q
, size_t l
)
963 /* As with memcpy(), so with memcmp(). */
965 unaligned_memcmp(const void *p
, const void *q
, size_t l
)
967 return (memcmp(p
, q
, l
));