X-Git-Url: https://git.tcpdump.org/tcpdump/blobdiff_plain/e2982e7f6f0b624a773ec5a58885ee80fab46d34..a8abce5c5e2dce2ba6dbccd5d3829da104b80f9c:/util-print.c diff --git a/util-print.c b/util-print.c index 75165e51..7f23a4b0 100644 --- a/util-print.c +++ b/util-print.c @@ -36,10 +36,10 @@ */ #ifdef HAVE_CONFIG_H -#include "config.h" +#include #endif -#include +#include "netdissect-stdinc.h" #include @@ -61,12 +61,6 @@ 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 /* @@ -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,33 +110,37 @@ fn_print(netdissect_options *ndo, ret = 1; /* assume truncated */ while (ep == NULL || s < ep) { - c = *s++; + c = EXTRACT_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; @@ -138,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 @@ -149,63 +163,51 @@ fn_printztn(netdissect_options *ndo, break; } - c = *s++; + c = EXTRACT_U_1(s); + s++; bytes++; n--; if (c == '\0') { /* 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 = *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); + c = EXTRACT_U_1(s); + s++; + 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) { @@ -215,96 +217,71 @@ fn_printzp(netdissect_options *ndo, ret = 1; /* assume truncated */ while (n > 0 && (ep == NULL || s < ep)) { n--; - c = *s++; + c = EXTRACT_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 as HH:MM:SS.FRAC. */ -static char * -ts_format(netdissect_options *ndo -#ifndef HAVE_PCAP_SET_TSTAMP_PRECISION -_U_ -#endif -, int sec, int usec, char *buf) +static void +ts_hmsfrac_print(netdissect_options *ndo, int sec, int 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("%02d:%02d:%02d.%06u", sec / 3600, (sec % 3600) / 60, + sec % 60, usec); break; case PCAP_TSTAMP_PRECISION_NANO: - format = "%02d:%02d:%02d.%09u"; + ND_PRINT("%02d:%02d:%02d.%09u", sec / 3600, (sec % 3600) / 60, + sec % 60, usec); break; default: - format = "%02d:%02d:%02d.{unknown}"; + ND_PRINT("%02d:%02d:%02d.{unknown}", sec / 3600, (sec % 3600) / 60, + sec % 60); break; } #else - format = "%02d:%02d:%02d.%06u"; + ND_PRINT("%02d:%02d:%02d.%06u", sec / 3600, (sec % 3600) / 60, + sec % 60, 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 - Unix timeval style, as SECS.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_unix_print(netdissect_options *ndo, int sec, int usec) { - const char *format; - #ifdef HAVE_PCAP_SET_TSTAMP_PRECISION switch (ndo->ndo_tstamp_precision) { case PCAP_TSTAMP_PRECISION_MICRO: - format = "%u.%06u"; + ND_PRINT("%u.%06u", (unsigned)sec, (unsigned)usec); break; case PCAP_TSTAMP_PRECISION_NANO: - format = "%u.%09u"; + ND_PRINT("%u.%09u", (unsigned)sec, (unsigned)usec); break; default: - format = "%u.{unknown}"; + ND_PRINT("%u.{unknown}", (unsigned)sec); break; } #else - format = "%u.%06u"; + ND_PRINT("%u.%06u", (unsigned)sec, (unsigned)usec); #endif - - snprintf(buf, TS_BUF_SIZE, format, - (unsigned)sec, (unsigned)usec); - - return buf; } /* @@ -317,7 +294,6 @@ ts_print(netdissect_options *ndo, 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; @@ -327,15 +303,16 @@ ts_print(netdissect_options *ndo, case 0: /* Default */ s = (tvp->tv_sec + thiszone) % 86400; - ND_PRINT("%s ", ts_format(ndo, s, tvp->tv_usec, buf)); + ts_hmsfrac_print(ndo, s, tvp->tv_usec); + 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 */ @@ -365,9 +342,8 @@ 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_hmsfrac_print(ndo, tv_result.tv_sec, tv_result.tv_usec); + ND_PRINT(" "); if (ndo->ndo_tflag == 3) tv_ref = *tvp; /* set timestamp for previous packet */ @@ -378,11 +354,13 @@ ts_print(netdissect_options *ndo, 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)); + ND_PRINT("Date fail "); + else { + ND_PRINT("%04d-%02d-%02d ", + tm->tm_year+1900, tm->tm_mon+1, tm->tm_mday); + ts_hmsfrac_print(ndo, s, tvp->tv_usec); + ND_PRINT(" "); + } break; } } @@ -407,7 +385,7 @@ unsigned_relts_print(netdissect_options *ndo, } while (secs > 0) { if (secs >= *s) { - ND_PRINT("%d%s", secs / *s, *l); + ND_PRINT("%u%s", secs / *s, *l); secs -= (secs / *s) * *s; } s++; @@ -451,6 +429,12 @@ 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); +} + /* * this is a generic routine for printing unknown data; * we pass on the linefeed plus indentation string to @@ -493,7 +477,7 @@ tok2strbuf(const struct tok *lp, const char *fmt, if (fmt == NULL) fmt = "#%d"; - (void)snprintf(buf, bufsize, fmt, v); + (void)nd_snprintf(buf, bufsize, fmt, v); return (const char *)buf; } @@ -517,7 +501,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 * @@ -565,13 +549,13 @@ bittok2str_internal(const struct tok *lp, const char *fmt, if (bufp == buf) /* bummer - lets print the "unknown" message as advised in the fmt string if we got one */ - (void)snprintf(buf, sizeof(buf), fmt == NULL ? "#%08x" : fmt, v); + (void)nd_snprintf(buf, sizeof(buf), fmt == NULL ? "#%08x" : fmt, v); return (buf); } /* * 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, @@ -582,7 +566,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, @@ -607,7 +591,7 @@ tok2strary_internal(const char **lp, int n, const char *fmt, return lp[v]; if (fmt == NULL) fmt = "#%d"; - (void)snprintf(buf, sizeof(buf), fmt, v); + (void)nd_snprintf(buf, sizeof(buf), fmt, v); return (buf); } @@ -695,15 +679,15 @@ fetch_token(netdissect_options *ndo, const u_char *pptr, u_int idx, u_int len, /* ran past end of captured data */ return (0); } - if (!isascii(*(pptr + idx))) { + if (!isascii(EXTRACT_U_1(pptr + idx))) { /* not an ASCII character */ return (0); } - if (isspace(*(pptr + idx))) { + if (isspace(EXTRACT_U_1(pptr + idx))) { /* end of token */ break; } - if (!isprint(*(pptr + idx))) { + if (!isprint(EXTRACT_U_1(pptr + idx))) { /* not part of a command token or response code */ return (0); } @@ -711,7 +695,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] = EXTRACT_U_1(pptr + idx); toklen++; } if (toklen == 0) { @@ -729,15 +713,15 @@ 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') { + if (EXTRACT_U_1(pptr + idx) == '\r' || EXTRACT_U_1(pptr + idx) == '\n') { /* end of line */ break; } - if (!isascii(*(pptr + idx)) || !isprint(*(pptr + idx))) { + if (!isascii(EXTRACT_U_1(pptr + idx)) || !isprint(EXTRACT_U_1(pptr + idx))) { /* not a printable ASCII character */ break; } - if (!isspace(*(pptr + idx))) { + if (!isspace(EXTRACT_U_1(pptr + idx))) { /* beginning of next token */ break; } @@ -761,7 +745,7 @@ print_txt_line(netdissect_options *ndo, const char *protoname, startidx = idx; while (idx < len) { ND_TCHECK_1(pptr + idx); - if (*(pptr+idx) == '\n') { + if (EXTRACT_U_1(pptr + idx) == '\n') { /* * LF without CR; end of line. * Skip the LF and print the line, with the @@ -770,14 +754,14 @@ print_txt_line(netdissect_options *ndo, const char *protoname, linelen = idx - startidx; idx++; goto print; - } else if (*(pptr+idx) == '\r') { + } else if (EXTRACT_U_1(pptr + idx) == '\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 (EXTRACT_U_1(pptr + idx + 1) == '\n') { /* * CR-LF; end of line. * Skip the CR-LF and print the line, with @@ -794,8 +778,9 @@ 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 (!isascii(EXTRACT_U_1(pptr + idx)) || + (!isprint(EXTRACT_U_1(pptr + idx)) && + EXTRACT_U_1(pptr + idx) != '\t')) { /* * Not a printable ASCII character and not a tab; * treat this as if it were binary data, and @@ -927,26 +912,6 @@ txtproto_print(netdissect_options *ndo, const u_char *pptr, u_int len, } } -void -safeputs(netdissect_options *ndo, - const u_char *s, const u_int maxlen) -{ - u_int idx = 0; - - while (idx < maxlen && *s) { - safeputchar(ndo, *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__))) || \