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)";
64 #define TOKBUFSIZE 128
67 * Print out a character, filtering out the non-printable ones
70 fn_print_char(netdissect_options
*ndo
, u_char c
)
77 c
^= 0x40; /* DEL to ?, others to alpha */
84 * Print a null-terminated string, filtering out non-printable characters.
85 * DON'T USE IT with a pointer on the packet buffer because there is no
86 * truncation check. For this use, see the nd_printX() functions below.
89 fn_print_str(netdissect_options
*ndo
, const u_char
*s
)
92 fn_print_char(ndo
, *s
);
98 * Print out a null-terminated filename (or other ASCII string), part of
100 * If ep is NULL, assume no truncation check is needed.
101 * Return true if truncated.
102 * Stop at ep (if given) or before the null char, whichever is first.
105 nd_print(netdissect_options
*ndo
,
106 const u_char
*s
, const u_char
*ep
)
111 ret
= 1; /* assume truncated */
112 while (ep
== NULL
|| s
< ep
) {
119 fn_print_char(ndo
, c
);
125 * Print out a null-terminated filename (or other ASCII string) from
126 * a fixed-length field in the packet buffer, or from what remains of
129 * n is the length of the fixed-length field, or the number of bytes
130 * remaining in the packet based on its on-the-network length.
132 * If ep is non-null, it should point just past the last captured byte
133 * of the packet, e.g. ndo->ndo_snapend. If ep is NULL, we assume no
134 * truncation check, other than the checks of the field length/remaining
135 * packet data length, is needed.
137 * Return the number of bytes of string processed, including the
138 * terminating null, if not truncated; as the terminating null is
139 * included in the count, and as there must be a terminating null,
140 * this will always be non-zero. Return 0 if truncated.
143 nd_printztn(netdissect_options
*ndo
,
144 const u_char
*s
, u_int n
, const u_char
*ep
)
151 if (n
== 0 || (ep
!= NULL
&& s
>= ep
)) {
153 * Truncated. This includes "no null before we
154 * got to the end of the fixed-length buffer or
155 * the end of the packet".
157 * XXX - BOOTP says "null-terminated", which
158 * means the maximum length of the string, in
159 * bytes, is 1 less than the size of the buffer,
160 * as there must always be a terminating null.
174 fn_print_char(ndo
, c
);
180 * Print out a counted filename (or other ASCII string), part of
182 * If ep is NULL, assume no truncation check is needed.
183 * Return true if truncated.
184 * Stop at ep (if given) or after n bytes, whichever is first.
187 nd_printn(netdissect_options
*ndo
,
188 const u_char
*s
, u_int n
, const u_char
*ep
)
192 while (n
> 0 && (ep
== NULL
|| s
< ep
)) {
196 fn_print_char(ndo
, c
);
198 return (n
== 0) ? 0 : 1;
202 * Print out a null-padded filename (or other ASCII string), part of
204 * If ep is NULL, assume no truncation check is needed.
205 * Return true if truncated.
206 * Stop at ep (if given) or after n bytes or before the null char,
207 * whichever is first.
210 nd_printzp(netdissect_options
*ndo
,
211 const u_char
*s
, u_int n
,
217 ret
= 1; /* assume truncated */
218 while (n
> 0 && (ep
== NULL
|| s
< ep
)) {
226 fn_print_char(ndo
, c
);
228 return (n
== 0) ? 0 : ret
;
232 * Print the timestamp as HH:MM:SS.FRAC.
235 ts_hmsfrac_print(netdissect_options
*ndo
, int sec
, int usec
)
237 #ifdef HAVE_PCAP_SET_TSTAMP_PRECISION
238 switch (ndo
->ndo_tstamp_precision
) {
240 case PCAP_TSTAMP_PRECISION_MICRO
:
241 ND_PRINT("%02d:%02d:%02d.%06u", sec
/ 3600, (sec
% 3600) / 60,
245 case PCAP_TSTAMP_PRECISION_NANO
:
246 ND_PRINT("%02d:%02d:%02d.%09u", sec
/ 3600, (sec
% 3600) / 60,
251 ND_PRINT("%02d:%02d:%02d.{unknown}", sec
/ 3600, (sec
% 3600) / 60,
256 ND_PRINT("%02d:%02d:%02d.%06u", sec
/ 3600, (sec
% 3600) / 60,
262 * Print the timestamp - Unix timeval style, as SECS.FRAC.
265 ts_unix_print(netdissect_options
*ndo
, int sec
, int usec
)
267 #ifdef HAVE_PCAP_SET_TSTAMP_PRECISION
268 switch (ndo
->ndo_tstamp_precision
) {
270 case PCAP_TSTAMP_PRECISION_MICRO
:
271 ND_PRINT("%u.%06u", (unsigned)sec
, (unsigned)usec
);
274 case PCAP_TSTAMP_PRECISION_NANO
:
275 ND_PRINT("%u.%09u", (unsigned)sec
, (unsigned)usec
);
279 ND_PRINT("%u.{unknown}", (unsigned)sec
);
283 ND_PRINT("%u.%06u", (unsigned)sec
, (unsigned)usec
);
288 * Print the timestamp
291 ts_print(netdissect_options
*ndo
,
292 const struct timeval
*tvp
)
297 static struct timeval tv_ref
;
298 struct timeval tv_result
;
302 switch (ndo
->ndo_tflag
) {
304 case 0: /* Default */
305 s
= (tvp
->tv_sec
+ thiszone
) % 86400;
306 ts_hmsfrac_print(ndo
, s
, tvp
->tv_usec
);
310 case 1: /* No time stamp */
313 case 2: /* Unix timeval style */
314 ts_unix_print(ndo
, tvp
->tv_sec
, tvp
->tv_usec
);
318 case 3: /* Microseconds/nanoseconds since previous packet */
319 case 5: /* Microseconds/nanoseconds since first packet */
320 #ifdef HAVE_PCAP_SET_TSTAMP_PRECISION
321 switch (ndo
->ndo_tstamp_precision
) {
322 case PCAP_TSTAMP_PRECISION_MICRO
:
325 case PCAP_TSTAMP_PRECISION_NANO
:
335 if (!(netdissect_timevalisset(&tv_ref
)))
336 tv_ref
= *tvp
; /* set timestamp for first packet */
338 negative_offset
= netdissect_timevalcmp(tvp
, &tv_ref
, <);
340 netdissect_timevalsub(&tv_ref
, tvp
, &tv_result
, nano_prec
);
342 netdissect_timevalsub(tvp
, &tv_ref
, &tv_result
, nano_prec
);
344 ND_PRINT((negative_offset
? "-" : " "));
345 ts_hmsfrac_print(ndo
, tv_result
.tv_sec
, tv_result
.tv_usec
);
348 if (ndo
->ndo_tflag
== 3)
349 tv_ref
= *tvp
; /* set timestamp for previous packet */
352 case 4: /* Default + Date */
353 s
= (tvp
->tv_sec
+ thiszone
) % 86400;
354 Time
= (tvp
->tv_sec
+ thiszone
) - s
;
357 ND_PRINT("Date fail ");
359 ND_PRINT("%04d-%02d-%02d ",
360 tm
->tm_year
+1900, tm
->tm_mon
+1, tm
->tm_mday
);
361 ts_hmsfrac_print(ndo
, s
, tvp
->tv_usec
);
369 * Print an unsigned relative number of seconds (e.g. hold time, prune timer)
370 * in the form 5m1s. This does no truncation, so 32230861 seconds
371 * is represented as 1y1w1d1h1m1s.
374 unsigned_relts_print(netdissect_options
*ndo
,
377 static const char *lengths
[] = {"y", "w", "d", "h", "m", "s"};
378 static const u_int seconds
[] = {31536000, 604800, 86400, 3600, 60, 1};
379 const char **l
= lengths
;
380 const u_int
*s
= seconds
;
388 ND_PRINT("%u%s", secs
/ *s
, *l
);
389 secs
-= (secs
/ *s
) * *s
;
397 * Print a signed relative number of seconds (e.g. hold time, prune timer)
398 * in the form 5m1s. This does no truncation, so 32230861 seconds
399 * is represented as 1y1w1d1h1m1s.
402 signed_relts_print(netdissect_options
*ndo
,
407 if (secs
== INT32_MIN
) {
409 * -2^31; you can't fit its absolute value into
410 * a 32-bit signed integer.
412 * Just directly pass said absolute value to
413 * unsigned_relts_print() directly.
415 * (XXX - does ISO C guarantee that -(-2^n),
416 * when calculated and cast to an n-bit unsigned
417 * integer type, will have the value 2^n?)
419 unsigned_relts_print(ndo
, 2147483648U);
422 * We now know -secs will fit into an int32_t;
423 * negate it and pass that to unsigned_relts_print().
425 unsigned_relts_print(ndo
, -secs
);
429 unsigned_relts_print(ndo
, secs
);
432 /* Print the truncated string */
433 void nd_print_trunc(netdissect_options
*ndo
)
435 ND_PRINT(" [|%s]", ndo
->ndo_protocol
);
439 * this is a generic routine for printing unknown data;
440 * we pass on the linefeed plus indentation string to
441 * get a proper output - returns 0 on error
445 print_unknown_data(netdissect_options
*ndo
, const u_char
*cp
,const char *ident
,int len
)
448 ND_PRINT("%sDissector error: print_unknown_data called with negative length",
452 if (ndo
->ndo_snapend
- cp
< len
)
453 len
= ndo
->ndo_snapend
- cp
;
455 ND_PRINT("%sDissector error: print_unknown_data called with pointer past end of packet",
459 hex_print(ndo
, ident
,cp
,len
);
460 return(1); /* everything is ok */
464 * Convert a token value to a string; use "fmt" if not found.
467 tok2strbuf(const struct tok
*lp
, const char *fmt
,
468 u_int v
, char *buf
, size_t bufsize
)
471 while (lp
->s
!= NULL
) {
480 (void)nd_snprintf(buf
, bufsize
, fmt
, v
);
481 return (const char *)buf
;
485 * Convert a token value to a string; use "fmt" if not found.
486 * Uses tok2strbuf() on one of four local static buffers of size TOKBUFSIZE
487 * in round-robin fashion.
490 tok2str(const struct tok
*lp
, const char *fmt
,
493 static char buf
[4][TOKBUFSIZE
];
499 return tok2strbuf(lp
, fmt
, v
, ret
, sizeof(buf
[0]));
503 * Convert a bit token value to a string; use "fmt" if not found.
504 * this is useful for parsing bitfields, the output strings are separated
505 * if the s field is positive.
508 bittok2str_internal(const struct tok
*lp
, const char *fmt
,
509 u_int v
, const char *sep
)
511 static char buf
[1024+1]; /* our string buffer */
513 size_t space_left
= sizeof(buf
), string_size
;
514 u_int rotbit
; /* this is the bit we rotate through all bitpositions */
516 const char * sepstr
= "";
518 while (lp
!= NULL
&& lp
->s
!= NULL
) {
519 tokval
=lp
->v
; /* load our first value */
521 while (rotbit
!= 0) {
523 * lets AND the rotating bit with our token value
524 * and see if we have got a match
526 if (tokval
== (v
&rotbit
)) {
527 /* ok we have found something */
529 return (buf
); /* only enough room left for NUL, if that */
530 string_size
= strlcpy(bufp
, sepstr
, space_left
);
531 if (string_size
>= space_left
)
532 return (buf
); /* we ran out of room */
534 space_left
-= string_size
;
536 return (buf
); /* only enough room left for NUL, if that */
537 string_size
= strlcpy(bufp
, lp
->s
, space_left
);
538 if (string_size
>= space_left
)
539 return (buf
); /* we ran out of room */
541 space_left
-= string_size
;
545 rotbit
=rotbit
<<1; /* no match - lets shift and try again */
551 /* bummer - lets print the "unknown" message as advised in the fmt string if we got one */
552 (void)nd_snprintf(buf
, sizeof(buf
), fmt
== NULL
? "#%08x" : fmt
, v
);
557 * Convert a bit token value to a string; use "fmt" if not found.
558 * this is useful for parsing bitfields, the output strings are not separated.
561 bittok2str_nosep(const struct tok
*lp
, const char *fmt
,
564 return (bittok2str_internal(lp
, fmt
, v
, ""));
568 * Convert a bit token value to a string; use "fmt" if not found.
569 * this is useful for parsing bitfields, the output strings are comma separated.
572 bittok2str(const struct tok
*lp
, const char *fmt
,
575 return (bittok2str_internal(lp
, fmt
, v
, ", "));
579 * Convert a value to a string using an array; the macro
580 * tok2strary() in <netdissect.h> is the public interface to
581 * this function and ensures that the second argument is
582 * correct for bounds-checking.
585 tok2strary_internal(const char **lp
, int n
, const char *fmt
,
588 static char buf
[TOKBUFSIZE
];
590 if (v
>= 0 && v
< n
&& lp
[v
] != NULL
)
594 (void)nd_snprintf(buf
, sizeof(buf
), fmt
, v
);
599 * Convert a 32-bit netmask to prefixlen if possible
600 * the function returns the prefix-len; if plen == -1
601 * then conversion was not possible;
605 mask2plen(uint32_t mask
)
607 uint32_t bitmasks
[33] = {
609 0x80000000, 0xc0000000, 0xe0000000, 0xf0000000,
610 0xf8000000, 0xfc000000, 0xfe000000, 0xff000000,
611 0xff800000, 0xffc00000, 0xffe00000, 0xfff00000,
612 0xfff80000, 0xfffc0000, 0xfffe0000, 0xffff0000,
613 0xffff8000, 0xffffc000, 0xffffe000, 0xfffff000,
614 0xfffff800, 0xfffffc00, 0xfffffe00, 0xffffff00,
615 0xffffff80, 0xffffffc0, 0xffffffe0, 0xfffffff0,
616 0xfffffff8, 0xfffffffc, 0xfffffffe, 0xffffffff
620 /* let's see if we can transform the mask into a prefixlen */
621 while (prefix_len
>= 0) {
622 if (bitmasks
[prefix_len
] == mask
)
630 mask62plen(const u_char
*mask
)
632 u_char bitmasks
[9] = {
634 0x80, 0xc0, 0xe0, 0xf0,
635 0xf8, 0xfc, 0xfe, 0xff
640 for (byte
= 0; byte
< 16; byte
++) {
643 for (bits
= 0; bits
< (sizeof (bitmasks
) / sizeof (bitmasks
[0])); bits
++) {
644 if (mask
[byte
] == bitmasks
[bits
]) {
650 if (mask
[byte
] != 0xff)
657 * Routine to print out information for text-based protocols such as FTP,
658 * HTTP, SMTP, RTSP, SIP, ....
660 #define MAX_TOKEN 128
663 * Fetch a token from a packet, starting at the specified index,
664 * and return the length of the token.
666 * Returns 0 on error; yes, this is indistinguishable from an empty
667 * token, but an "empty token" isn't a valid token - it just means
668 * either a space character at the beginning of the line (this
669 * includes a blank line) or no more tokens remaining on the line.
672 fetch_token(netdissect_options
*ndo
, const u_char
*pptr
, u_int idx
, u_int len
,
673 u_char
*tbuf
, size_t tbuflen
)
677 for (; idx
< len
; idx
++) {
678 if (!ND_TTEST_1(pptr
+ idx
)) {
679 /* ran past end of captured data */
682 if (!isascii(EXTRACT_U_1(pptr
+ idx
))) {
683 /* not an ASCII character */
686 if (isspace(EXTRACT_U_1(pptr
+ idx
))) {
690 if (!isprint(EXTRACT_U_1(pptr
+ idx
))) {
691 /* not part of a command token or response code */
694 if (toklen
+ 2 > tbuflen
) {
695 /* no room for this character and terminating '\0' */
698 tbuf
[toklen
] = EXTRACT_U_1(pptr
+ idx
);
708 * Skip past any white space after the token, until we see
709 * an end-of-line (CR or LF).
711 for (; idx
< len
; idx
++) {
712 if (!ND_TTEST_1(pptr
+ idx
)) {
713 /* ran past end of captured data */
716 if (EXTRACT_U_1(pptr
+ idx
) == '\r' || EXTRACT_U_1(pptr
+ idx
) == '\n') {
720 if (!isascii(EXTRACT_U_1(pptr
+ idx
)) || !isprint(EXTRACT_U_1(pptr
+ idx
))) {
721 /* not a printable ASCII character */
724 if (!isspace(EXTRACT_U_1(pptr
+ idx
))) {
725 /* beginning of next token */
733 * Scan a buffer looking for a line ending - LF or CR-LF.
734 * Return the index of the character after the line ending or 0 if
735 * we encounter a non-ASCII or non-printable character or don't find
739 print_txt_line(netdissect_options
*ndo
, const char *protoname
,
740 const char *prefix
, const u_char
*pptr
, u_int idx
, u_int len
)
747 ND_TCHECK_1(pptr
+ idx
);
748 if (EXTRACT_U_1(pptr
+ idx
) == '\n') {
750 * LF without CR; end of line.
751 * Skip the LF and print the line, with the
752 * exception of the LF.
754 linelen
= idx
- startidx
;
757 } else if (EXTRACT_U_1(pptr
+ idx
) == '\r') {
759 if ((idx
+1) >= len
) {
760 /* not in this packet */
763 ND_TCHECK_1(pptr
+ idx
+ 1);
764 if (EXTRACT_U_1(pptr
+ idx
+ 1) == '\n') {
766 * CR-LF; end of line.
767 * Skip the CR-LF and print the line, with
768 * the exception of the CR-LF.
770 linelen
= idx
- startidx
;
776 * CR followed by something else; treat this
777 * as if it were binary data, and don't print
781 } else if (!isascii(EXTRACT_U_1(pptr
+ idx
)) ||
782 (!isprint(EXTRACT_U_1(pptr
+ idx
)) &&
783 EXTRACT_U_1(pptr
+ idx
) != '\t')) {
785 * Not a printable ASCII character and not a tab;
786 * treat this as if it were binary data, and
795 * All printable ASCII, but no line ending after that point
796 * in the buffer; treat this as if it were truncated.
799 linelen
= idx
- startidx
;
800 ND_PRINT("%s%.*s[!%s]", prefix
, (int)linelen
, pptr
+ startidx
,
805 ND_PRINT("%s%.*s", prefix
, (int)linelen
, pptr
+ startidx
);
810 txtproto_print(netdissect_options
*ndo
, const u_char
*pptr
, u_int len
,
811 const char *protoname
, const char **cmds
, u_int flags
)
814 u_char token
[MAX_TOKEN
+1];
821 * This protocol has more than just request and
822 * response lines; see whether this looks like a
823 * request or response and, if so, print it and,
824 * in verbose mode, print everything after it.
826 * This is for HTTP-like protocols, where we
827 * want to print requests and responses, but
828 * don't want to print continuations of request
829 * or response bodies in packets that don't
830 * contain the request or response line.
832 idx
= fetch_token(ndo
, pptr
, 0, len
, token
, sizeof(token
));
834 /* Is this a valid request name? */
835 while ((cmd
= *cmds
++) != NULL
) {
836 if (ascii_strcasecmp((const char *)token
, cmd
) == 0) {
844 * No - is this a valid response code (3 digits)?
846 * Is this token the response code, or is the next
847 * token the response code?
849 if (flags
& RESP_CODE_SECOND_TOKEN
) {
851 * Next token - get it.
853 idx
= fetch_token(ndo
, pptr
, idx
, len
, token
,
857 if (isdigit(token
[0]) && isdigit(token
[1]) &&
858 isdigit(token
[2]) && token
[3] == '\0') {
868 * 1) This protocol has only request and response lines
869 * (e.g., FTP, where all the data goes over a different
870 * connection); assume the payload is a request or
875 * 2) This protocol is just text, so that we should
876 * always, at minimum, print the first line and,
877 * in verbose mode, print all lines.
882 /* Capitalize the protocol name */
883 for (pnp
= protoname
; *pnp
!= '\0'; pnp
++)
884 ND_PRINT("%c", toupper((u_char
)*pnp
));
888 * In non-verbose mode, just print the protocol, followed
891 * In verbose mode, print lines as text until we run out
892 * of characters or see something that's not a
893 * printable-ASCII line.
895 if (ndo
->ndo_vflag
) {
897 * We're going to print all the text lines in the
898 * request or response; just print the length
899 * on the first line of the output.
901 ND_PRINT(", length: %u", len
);
903 idx
< len
&& (eol
= print_txt_line(ndo
, protoname
, "\n\t", pptr
, idx
, len
)) != 0;
908 * Just print the first text line.
910 print_txt_line(ndo
, protoname
, ": ", pptr
, 0, len
);
915 #if (defined(__i386__) || defined(_M_IX86) || defined(__X86__) || defined(__x86_64__) || defined(_M_X64)) || \
916 (defined(__arm__) || defined(_M_ARM) || defined(__aarch64__)) || \
917 (defined(__m68k__) && (!defined(__mc68000__) && !defined(__mc68010__))) || \
918 (defined(__ppc__) || defined(__ppc64__) || defined(_M_PPC) || defined(_ARCH_PPC) || defined(_ARCH_PPC64)) || \
919 (defined(__s390__) || defined(__s390x__) || defined(__zarch__)) || \
922 * The procesor natively handles unaligned loads, so just use memcpy()
923 * and memcmp(), to enable those optimizations.
925 * XXX - are those all the x86 tests we need?
926 * XXX - do we need to worry about ARMv1 through ARMv5, which didn't
927 * support unaligned loads, and, if so, do we need to worry about all
928 * of them, or just some of them, e.g. ARMv5?
929 * XXX - are those the only 68k tests we need not to generated
930 * unaligned accesses if the target is the 68000 or 68010?
931 * XXX - are there any tests we don't need, because some definitions are for
932 * compilers that also predefine the GCC symbols?
933 * XXX - do we need to test for both 32-bit and 64-bit versions of those
934 * architectures in all cases?
938 * The processor doesn't natively handle unaligned loads,
939 * and the compiler might "helpfully" optimize memcpy()
940 * and memcmp(), when handed pointers that would normally
941 * be properly aligned, into sequences that assume proper
944 * Do copies and compares of possibly-unaligned data by
945 * calling routines that wrap memcpy() and memcmp(), to
946 * prevent that optimization.
949 unaligned_memcpy(void *p
, const void *q
, size_t l
)
954 /* As with memcpy(), so with memcmp(). */
956 unaligned_memcmp(const void *p
, const void *q
, size_t l
)
958 return (memcmp(p
, q
, l
));