X-Git-Url: https://git.tcpdump.org/tcpdump/blobdiff_plain/fe4ef2d22bcc1b89f16c30480f7bff4348d1a014..refs/heads/mcr-macro-update-1:/util-print.c diff --git a/util-print.c b/util-print.c index 82f450c6..e22e535e 100644 --- a/util-print.c +++ b/util-print.c @@ -46,29 +46,23 @@ #ifdef HAVE_FCNTL_H #include #endif -#include #include #include #include #include +#include "netdissect-ctype.h" + #include "netdissect.h" #include "extract.h" #include "ascii_strcasecmp.h" #include "timeval-operations.h" -int32_t thiszone; /* seconds offset from gmt to local time */ -/* invalid string to print '(invalid)' for malformed or corrupted packets */ -const char istr[] = " (invalid)"; - -/* - * timestamp display buffer size, the biggest size of both formats is needed - * sizeof("0000000000.000000000") > sizeof("00:00:00.000000000") - */ -#define TS_BUF_SIZE sizeof("0000000000.000000000") - #define TOKBUFSIZE 128 +enum date_flag { WITHOUT_DATE = 0, WITH_DATE = 1 }; +enum time_flag { UTC_TIME = 0, LOCAL_TIME = 1 }; + /* * Print out a character, filtering out the non-printable ones */ @@ -79,7 +73,7 @@ fn_print_char(netdissect_options *ndo, u_char c) c = ND_TOASCII(c); ND_PRINT("M-"); } - if (!ND_ISPRINT(c)) { + if (!ND_ASCII_ISPRINT(c)) { c ^= 0x40; /* DEL to ?, others to alpha */ ND_PRINT("^"); } @@ -87,13 +81,28 @@ fn_print_char(netdissect_options *ndo, u_char c) } /* - * Print out a null-terminated filename (or other ASCII string). + * Print a null-terminated string, filtering out non-printable characters. + * DON'T USE IT with a pointer on the packet buffer because there is no + * truncation check. For this use, see the nd_printX() functions below. + */ +void +fn_print_str(netdissect_options *ndo, const u_char *s) +{ + while (*s != '\0') { + fn_print_char(ndo, *s); + s++; + } +} + +/* + * Print out a null-terminated filename (or other ASCII string), part of + * the packet buffer. * If ep is NULL, assume no truncation check is needed. * Return true if truncated. * Stop at ep (if given) or before the null char, whichever is first. */ int -fn_print(netdissect_options *ndo, +nd_print(netdissect_options *ndo, const u_char *s, const u_char *ep) { int ret; @@ -101,34 +110,37 @@ fn_print(netdissect_options *ndo, ret = 1; /* assume truncated */ while (ep == NULL || s < ep) { - c = EXTRACT_U_1(s); + c = GET_U_1(s); s++; if (c == '\0') { ret = 0; break; } - if (!ND_ISASCII(c)) { - c = ND_TOASCII(c); - ND_PRINT("M-"); - } - if (!ND_ISPRINT(c)) { - c ^= 0x40; /* DEL to ?, others to alpha */ - ND_PRINT("^"); - } - ND_PRINT("%c", c); + fn_print_char(ndo, c); } return(ret); } /* * Print out a null-terminated filename (or other ASCII string) from - * a fixed-length buffer. - * If ep is NULL, assume no truncation check is needed. + * a fixed-length field in the packet buffer, or from what remains of + * the packet. + * + * n is the length of the fixed-length field, or the number of bytes + * remaining in the packet based on its on-the-network length. + * + * If ep is non-null, it should point just past the last captured byte + * of the packet, e.g. ndo->ndo_snapend. If ep is NULL, we assume no + * truncation check, other than the checks of the field length/remaining + * packet data length, is needed. + * * Return the number of bytes of string processed, including the - * terminating null, if not truncated. Return 0 if truncated. + * terminating null, if not truncated; as the terminating null is + * included in the count, and as there must be a terminating null, + * this will always be non-zero. Return 0 if truncated. */ u_int -fn_printztn(netdissect_options *ndo, +nd_printztn(netdissect_options *ndo, const u_char *s, u_int n, const u_char *ep) { u_int bytes; @@ -139,7 +151,8 @@ fn_printztn(netdissect_options *ndo, if (n == 0 || (ep != NULL && s >= ep)) { /* * Truncated. This includes "no null before we - * got to the end of the fixed-length buffer". + * got to the end of the fixed-length buffer or + * the end of the packet". * * XXX - BOOTP says "null-terminated", which * means the maximum length of the string, in @@ -150,7 +163,7 @@ fn_printztn(netdissect_options *ndo, break; } - c = EXTRACT_U_1(s); + c = GET_U_1(s); s++; bytes++; n--; @@ -158,57 +171,43 @@ fn_printztn(netdissect_options *ndo, /* End of string */ break; } - if (!ND_ISASCII(c)) { - c = ND_TOASCII(c); - ND_PRINT("M-"); - } - if (!ND_ISPRINT(c)) { - c ^= 0x40; /* DEL to ?, others to alpha */ - ND_PRINT("^"); - } - ND_PRINT("%c", c); + fn_print_char(ndo, c); } return(bytes); } /* - * Print out a counted filename (or other ASCII string). + * Print out a counted filename (or other ASCII string), part of + * the packet buffer. * If ep is NULL, assume no truncation check is needed. * Return true if truncated. * Stop at ep (if given) or after n bytes, whichever is first. */ int -fn_printn(netdissect_options *ndo, +nd_printn(netdissect_options *ndo, const u_char *s, u_int n, const u_char *ep) { u_char c; while (n > 0 && (ep == NULL || s < ep)) { n--; - c = EXTRACT_U_1(s); + c = GET_U_1(s); s++; - if (!ND_ISASCII(c)) { - c = ND_TOASCII(c); - ND_PRINT("M-"); - } - if (!ND_ISPRINT(c)) { - c ^= 0x40; /* DEL to ?, others to alpha */ - ND_PRINT("^"); - } - ND_PRINT("%c", c); + fn_print_char(ndo, c); } return (n == 0) ? 0 : 1; } /* - * Print out a null-padded filename (or other ASCII string). + * Print out a null-padded filename (or other ASCII string), part of + * the packet buffer. * If ep is NULL, assume no truncation check is needed. * Return true if truncated. * Stop at ep (if given) or after n bytes or before the null char, * whichever is first. */ int -fn_printzp(netdissect_options *ndo, +nd_printzp(netdissect_options *ndo, const u_char *s, u_int n, const u_char *ep) { @@ -218,97 +217,92 @@ fn_printzp(netdissect_options *ndo, ret = 1; /* assume truncated */ while (n > 0 && (ep == NULL || s < ep)) { n--; - c = EXTRACT_U_1(s); + c = GET_U_1(s); s++; if (c == '\0') { ret = 0; break; } - if (!ND_ISASCII(c)) { - c = ND_TOASCII(c); - ND_PRINT("M-"); - } - if (!ND_ISPRINT(c)) { - c ^= 0x40; /* DEL to ?, others to alpha */ - ND_PRINT("^"); - } - ND_PRINT("%c", c); + fn_print_char(ndo, c); } return (n == 0) ? 0 : ret; } /* - * Format the timestamp + * Print the timestamp .FRAC part (Microseconds/nanoseconds) */ -static char * -ts_format(netdissect_options *ndo -#ifndef HAVE_PCAP_SET_TSTAMP_PRECISION -_U_ -#endif -, int sec, int usec, char *buf) +static void +ts_frac_print(netdissect_options *ndo, long usec) { - const char *format; - #ifdef HAVE_PCAP_SET_TSTAMP_PRECISION switch (ndo->ndo_tstamp_precision) { case PCAP_TSTAMP_PRECISION_MICRO: - format = "%02d:%02d:%02d.%06u"; + ND_PRINT(".%06u", (unsigned)usec); break; case PCAP_TSTAMP_PRECISION_NANO: - format = "%02d:%02d:%02d.%09u"; + ND_PRINT(".%09u", (unsigned)usec); break; default: - format = "%02d:%02d:%02d.{unknown}"; + ND_PRINT(".{unknown}"); break; } #else - format = "%02d:%02d:%02d.%06u"; + ND_PRINT(".%06u", (unsigned)usec); #endif - - snprintf(buf, TS_BUF_SIZE, format, - sec / 3600, (sec % 3600) / 60, sec % 60, usec); - - return buf; } /* - * Format the timestamp - Unix timeval style + * Print the timestamp as [YY:MM:DD] HH:MM:SS.FRAC. + * if time_flag == LOCAL_TIME print local time else UTC/GMT time + * if date_flag == WITH_DATE print YY:MM:DD before HH:MM:SS.FRAC */ -static char * -ts_unix_format(netdissect_options *ndo -#ifndef HAVE_PCAP_SET_TSTAMP_PRECISION -_U_ -#endif -, int sec, int usec, char *buf) +static void +ts_date_hmsfrac_print(netdissect_options *ndo, long sec, long usec, + enum date_flag date_flag, enum time_flag time_flag) { - const char *format; - -#ifdef HAVE_PCAP_SET_TSTAMP_PRECISION - switch (ndo->ndo_tstamp_precision) { + time_t Time = sec; + struct tm *tm; + char timestr[32]; - case PCAP_TSTAMP_PRECISION_MICRO: - format = "%u.%06u"; - break; + if ((unsigned)sec & 0x80000000) { + ND_PRINT("[Error converting time]"); + return; + } - case PCAP_TSTAMP_PRECISION_NANO: - format = "%u.%09u"; - break; + if (time_flag == LOCAL_TIME) + tm = localtime(&Time); + else + tm = gmtime(&Time); - default: - format = "%u.{unknown}"; - break; + if (!tm) { + ND_PRINT("[Error converting time]"); + return; } -#else - format = "%u.%06u"; -#endif + if (date_flag == WITH_DATE) + strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S", tm); + else + strftime(timestr, sizeof(timestr), "%H:%M:%S", tm); + ND_PRINT("%s", timestr); + + ts_frac_print(ndo, usec); +} - snprintf(buf, TS_BUF_SIZE, format, - (unsigned)sec, (unsigned)usec); +/* + * Print the timestamp - Unix timeval style, as SECS.FRAC. + */ +static void +ts_unix_print(netdissect_options *ndo, long sec, long usec) +{ + if ((unsigned)sec & 0x80000000) { + ND_PRINT("[Error converting time]"); + return; + } - return buf; + ND_PRINT("%u", (unsigned)sec); + ts_frac_print(ndo, usec); } /* @@ -318,10 +312,6 @@ void ts_print(netdissect_options *ndo, const struct timeval *tvp) { - int s; - struct tm *tm; - time_t Time; - char buf[TS_BUF_SIZE]; static struct timeval tv_ref; struct timeval tv_result; int negative_offset; @@ -330,16 +320,17 @@ ts_print(netdissect_options *ndo, switch (ndo->ndo_tflag) { case 0: /* Default */ - s = (tvp->tv_sec + thiszone) % 86400; - ND_PRINT("%s ", ts_format(ndo, s, tvp->tv_usec, buf)); + ts_date_hmsfrac_print(ndo, tvp->tv_sec, tvp->tv_usec, + WITHOUT_DATE, LOCAL_TIME); + ND_PRINT(" "); break; case 1: /* No time stamp */ break; case 2: /* Unix timeval style */ - ND_PRINT("%s ", ts_unix_format(ndo, - tvp->tv_sec, tvp->tv_usec, buf)); + ts_unix_print(ndo, tvp->tv_sec, tvp->tv_usec); + ND_PRINT(" "); break; case 3: /* Microseconds/nanoseconds since previous packet */ @@ -369,24 +360,18 @@ ts_print(netdissect_options *ndo, netdissect_timevalsub(tvp, &tv_ref, &tv_result, nano_prec); ND_PRINT((negative_offset ? "-" : " ")); - - ND_PRINT("%s ", ts_format(ndo, - tv_result.tv_sec, tv_result.tv_usec, buf)); + ts_date_hmsfrac_print(ndo, tv_result.tv_sec, tv_result.tv_usec, + WITHOUT_DATE, UTC_TIME); + ND_PRINT(" "); if (ndo->ndo_tflag == 3) tv_ref = *tvp; /* set timestamp for previous packet */ break; - case 4: /* Default + Date */ - s = (tvp->tv_sec + thiszone) % 86400; - Time = (tvp->tv_sec + thiszone) - s; - tm = gmtime (&Time); - if (!tm) - ND_PRINT("Date fail "); - else - ND_PRINT("%04d-%02d-%02d %s ", - tm->tm_year+1900, tm->tm_mon+1, tm->tm_mday, - ts_format(ndo, s, tvp->tv_usec, buf)); + case 4: /* Date + Default */ + ts_date_hmsfrac_print(ndo, tvp->tv_sec, tvp->tv_usec, + WITH_DATE, LOCAL_TIME); + ND_PRINT(" "); break; } } @@ -455,6 +440,32 @@ signed_relts_print(netdissect_options *ndo, unsigned_relts_print(ndo, secs); } +/* Print the truncated string */ +void nd_print_trunc(netdissect_options *ndo) +{ + ND_PRINT(" [|%s]", ndo->ndo_protocol); +} + +/* Print the protocol name */ +void nd_print_protocol(netdissect_options *ndo) +{ + ND_PRINT("%s", ndo->ndo_protocol); +} + +/* Print the protocol name in caps (uppercases) */ +void nd_print_protocol_caps(netdissect_options *ndo) +{ + const char *p; + for (p = ndo->ndo_protocol; *p != '\0'; p++) + ND_PRINT("%c", ND_ASCII_TOUPPER(*p)); +} + +/* Print the invalid string */ +void nd_print_invalid(netdissect_options *ndo) +{ + ND_PRINT(" (invalid)"); +} + /* * this is a generic routine for printing unknown data; * we pass on the linefeed plus indentation string to @@ -462,21 +473,20 @@ signed_relts_print(netdissect_options *ndo, */ int -print_unknown_data(netdissect_options *ndo, const u_char *cp,const char *ident,int len) +print_unknown_data(netdissect_options *ndo, const u_char *cp, + const char *ident, u_int len) { - if (len < 0) { - ND_PRINT("%sDissector error: print_unknown_data called with negative length", - ident); - return(0); - } - if (ndo->ndo_snapend - cp < len) - len = ndo->ndo_snapend - cp; - if (len < 0) { - ND_PRINT("%sDissector error: print_unknown_data called with pointer past end of packet", + u_int len_to_print; + + len_to_print = len; + if (!ND_TTEST_LEN(cp, 0)) { + ND_PRINT("%sDissector error: print_unknown_data called with pointer past end of packet", ident); return(0); } - hex_print(ndo, ident,cp,len); + if (ND_BYTES_AVAILABLE_AFTER(cp) < len_to_print) + len_to_print = ND_BYTES_AVAILABLE_AFTER(cp); + hex_print(ndo, ident, cp, len_to_print); return(1); /* everything is ok */ } @@ -521,7 +531,7 @@ tok2str(const struct tok *lp, const char *fmt, /* * Convert a bit token value to a string; use "fmt" if not found. - * this is useful for parsing bitfields, the output strings are seperated + * this is useful for parsing bitfields, the output strings are separated * if the s field is positive. */ static char * @@ -575,7 +585,7 @@ bittok2str_internal(const struct tok *lp, const char *fmt, /* * Convert a bit token value to a string; use "fmt" if not found. - * this is useful for parsing bitfields, the output strings are not seperated. + * this is useful for parsing bitfields, the output strings are not separated. */ char * bittok2str_nosep(const struct tok *lp, const char *fmt, @@ -586,7 +596,7 @@ bittok2str_nosep(const struct tok *lp, const char *fmt, /* * Convert a bit token value to a string; use "fmt" if not found. - * this is useful for parsing bitfields, the output strings are comma seperated. + * this is useful for parsing bitfields, the output strings are comma separated. */ char * bittok2str(const struct tok *lp, const char *fmt, @@ -693,21 +703,23 @@ fetch_token(netdissect_options *ndo, const u_char *pptr, u_int idx, u_int len, u_char *tbuf, size_t tbuflen) { size_t toklen = 0; + u_char c; for (; idx < len; idx++) { if (!ND_TTEST_1(pptr + idx)) { /* ran past end of captured data */ return (0); } - if (!isascii(*(pptr + idx))) { + c = GET_U_1(pptr + idx); + if (!ND_ISASCII(c)) { /* not an ASCII character */ return (0); } - if (isspace(*(pptr + idx))) { + if (c == ' ' || c == '\t' || c == '\r' || c == '\n') { /* end of token */ break; } - if (!isprint(*(pptr + idx))) { + if (!ND_ASCII_ISPRINT(c)) { /* not part of a command token or response code */ return (0); } @@ -715,7 +727,7 @@ fetch_token(netdissect_options *ndo, const u_char *pptr, u_int idx, u_int len, /* no room for this character and terminating '\0' */ return (0); } - tbuf[toklen] = *(pptr + idx); + tbuf[toklen] = c; toklen++; } if (toklen == 0) { @@ -733,15 +745,16 @@ fetch_token(netdissect_options *ndo, const u_char *pptr, u_int idx, u_int len, /* ran past end of captured data */ break; } - if (*(pptr + idx) == '\r' || *(pptr + idx) == '\n') { + c = GET_U_1(pptr + idx); + if (c == '\r' || c == '\n') { /* end of line */ break; } - if (!isascii(*(pptr + idx)) || !isprint(*(pptr + idx))) { + if (!ND_ASCII_ISPRINT(c)) { /* not a printable ASCII character */ break; } - if (!isspace(*(pptr + idx))) { + if (c != ' ' && c != '\t' && c != '\r' && c != '\n') { /* beginning of next token */ break; } @@ -756,16 +769,17 @@ fetch_token(netdissect_options *ndo, const u_char *pptr, u_int idx, u_int len, * the line ending. */ static u_int -print_txt_line(netdissect_options *ndo, const char *protoname, - const char *prefix, const u_char *pptr, u_int idx, u_int len) +print_txt_line(netdissect_options *ndo, const char *prefix, + const u_char *pptr, u_int idx, u_int len) { u_int startidx; u_int linelen; + u_char c; startidx = idx; while (idx < len) { - ND_TCHECK_1(pptr + idx); - if (*(pptr+idx) == '\n') { + c = GET_U_1(pptr + idx); + if (c == '\n') { /* * LF without CR; end of line. * Skip the LF and print the line, with the @@ -774,14 +788,13 @@ print_txt_line(netdissect_options *ndo, const char *protoname, linelen = idx - startidx; idx++; goto print; - } else if (*(pptr+idx) == '\r') { + } else if (c == '\r') { /* CR - any LF? */ if ((idx+1) >= len) { /* not in this packet */ return (0); } - ND_TCHECK_1(pptr + idx + 1); - if (*(pptr+idx+1) == '\n') { + if (GET_U_1(pptr + idx + 1) == '\n') { /* * CR-LF; end of line. * Skip the CR-LF and print the line, with @@ -798,8 +811,7 @@ print_txt_line(netdissect_options *ndo, const char *protoname, * it. */ return (0); - } else if (!isascii(*(pptr+idx)) || - (!isprint(*(pptr+idx)) && *(pptr+idx) != '\t')) { + } else if (!ND_ASCII_ISPRINT(c) && c != '\t') { /* * Not a printable ASCII character and not a tab; * treat this as if it were binary data, and @@ -814,10 +826,9 @@ print_txt_line(netdissect_options *ndo, const char *protoname, * All printable ASCII, but no line ending after that point * in the buffer; treat this as if it were truncated. */ -trunc: linelen = idx - startidx; - ND_PRINT("%s%.*s[!%s]", prefix, (int)linelen, pptr + startidx, - protoname); + ND_PRINT("%s%.*s", prefix, (int)linelen, pptr + startidx); + nd_print_trunc(ndo); return (0); print: @@ -825,15 +836,15 @@ print: return (idx); } +/* Assign needed before calling txtproto_print(): ndo->ndo_protocol = "proto" */ void txtproto_print(netdissect_options *ndo, const u_char *pptr, u_int len, - const char *protoname, const char **cmds, u_int flags) + const char **cmds, u_int flags) { u_int idx, eol; u_char token[MAX_TOKEN+1]; const char *cmd; int print_this = 0; - const char *pnp; if (cmds != NULL) { /* @@ -873,8 +884,8 @@ txtproto_print(netdissect_options *ndo, const u_char *pptr, u_int len, sizeof(token)); } if (idx != 0) { - if (isdigit(token[0]) && isdigit(token[1]) && - isdigit(token[2]) && token[3] == '\0') { + if (ND_ASCII_ISDIGIT(token[0]) && ND_ASCII_ISDIGIT(token[1]) && + ND_ASCII_ISDIGIT(token[2]) && token[3] == '\0') { /* Yes. */ print_this = 1; } @@ -898,9 +909,7 @@ txtproto_print(netdissect_options *ndo, const u_char *pptr, u_int len, print_this = 1; } - /* Capitalize the protocol name */ - for (pnp = protoname; *pnp != '\0'; pnp++) - ND_PRINT("%c", toupper((u_char)*pnp)); + nd_print_protocol_caps(ndo); if (print_this) { /* @@ -919,38 +928,18 @@ txtproto_print(netdissect_options *ndo, const u_char *pptr, u_int len, */ ND_PRINT(", length: %u", len); for (idx = 0; - idx < len && (eol = print_txt_line(ndo, protoname, "\n\t", pptr, idx, len)) != 0; + idx < len && (eol = print_txt_line(ndo, "\n\t", pptr, idx, len)) != 0; idx = eol) ; } else { /* * Just print the first text line. */ - print_txt_line(ndo, protoname, ": ", pptr, 0, len); + print_txt_line(ndo, ": ", pptr, 0, len); } } } -void -safeputs(netdissect_options *ndo, - const u_char *s, const u_int maxlen) -{ - u_int idx = 0; - - while (idx < maxlen && EXTRACT_U_1(s)) { - safeputchar(ndo, EXTRACT_U_1(s)); - idx++; - s++; - } -} - -void -safeputchar(netdissect_options *ndo, - const u_char c) -{ - ND_PRINT((c < 0x80 && ND_ISPRINT(c)) ? "%c" : "\\0x%02x", c); -} - #if (defined(__i386__) || defined(_M_IX86) || defined(__X86__) || defined(__x86_64__) || defined(_M_X64)) || \ (defined(__arm__) || defined(_M_ARM) || defined(__aarch64__)) || \ (defined(__m68k__) && (!defined(__mc68000__) && !defined(__mc68010__))) || \