]> The Tcpdump Group git mirrors - tcpdump/blob - util-print.c
71674221d1dca55a422c7865e12dcb7fd5f8328e
[tcpdump] / util-print.c
1 /*
2 * Copyright (c) 1990, 1991, 1993, 1994, 1995, 1996, 1997
3 * The Regents of the University of California. All rights reserved.
4 *
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
16 * written permission.
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.
20 */
21
22 /*
23 * txtproto_print() derived from original code by Hannes Gredler
24 * (hannes@gredler.at):
25 *
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.
36 */
37
38 #include <config.h>
39
40 #include "netdissect-stdinc.h"
41
42 #include <sys/stat.h>
43
44 #include <stdio.h>
45 #include <stdarg.h>
46 #include <stdlib.h>
47 #include <string.h>
48
49 #include "netdissect-ctype.h"
50
51 #include "netdissect.h"
52 #include "extract.h"
53 #include "ascii_strcasecmp.h"
54 #include "timeval-operations.h"
55
56 #define TOKBUFSIZE 128
57
58 enum date_flag { WITHOUT_DATE = 0, WITH_DATE = 1 };
59 enum time_flag { UTC_TIME = 0, LOCAL_TIME = 1 };
60
61 /*
62 * Print out a character, filtering out the non-printable ones
63 */
64 void
65 fn_print_char(netdissect_options *ndo, u_char c)
66 {
67 if (!ND_ISASCII(c)) {
68 c = ND_TOASCII(c);
69 ND_PRINT("M-");
70 }
71 if (!ND_ASCII_ISPRINT(c)) {
72 c ^= 0x40; /* DEL to ?, others to alpha */
73 ND_PRINT("^");
74 }
75 ND_PRINT("%c", c);
76 }
77
78 /*
79 * Print a null-terminated string, filtering out non-printable characters.
80 * DON'T USE IT with a pointer on the packet buffer because there is no
81 * truncation check. For this use, see the nd_printX() functions below.
82 */
83 void
84 fn_print_str(netdissect_options *ndo, const u_char *s)
85 {
86 while (*s != '\0') {
87 fn_print_char(ndo, *s);
88 s++;
89 }
90 }
91
92 /*
93 * Print out a null-terminated filename (or other ASCII string) from
94 * a fixed-length field in the packet buffer, or from what remains of
95 * the packet.
96 *
97 * n is the length of the fixed-length field, or the number of bytes
98 * remaining in the packet based on its on-the-network length.
99 *
100 * If ep is non-null, it should point just past the last captured byte
101 * of the packet, e.g. ndo->ndo_snapend. If ep is NULL, we assume no
102 * truncation check, other than the checks of the field length/remaining
103 * packet data length, is needed.
104 *
105 * Return the number of bytes of string processed, including the
106 * terminating null, if not truncated; as the terminating null is
107 * included in the count, and as there must be a terminating null,
108 * this will always be non-zero. Return 0 if truncated.
109 */
110 u_int
111 nd_printztn(netdissect_options *ndo,
112 const u_char *s, u_int n, const u_char *ep)
113 {
114 u_int bytes;
115 u_char c;
116
117 bytes = 0;
118 for (;;) {
119 if (n == 0 || (ep != NULL && s >= ep)) {
120 /*
121 * Truncated. This includes "no null before we
122 * got to the end of the fixed-length buffer or
123 * the end of the packet".
124 *
125 * XXX - BOOTP says "null-terminated", which
126 * means the maximum length of the string, in
127 * bytes, is 1 less than the size of the buffer,
128 * as there must always be a terminating null.
129 */
130 bytes = 0;
131 break;
132 }
133
134 c = GET_U_1(s);
135 s++;
136 bytes++;
137 n--;
138 if (c == '\0') {
139 /* End of string */
140 break;
141 }
142 fn_print_char(ndo, c);
143 }
144 return(bytes);
145 }
146
147 /*
148 * Print out a counted filename (or other ASCII string), part of
149 * the packet buffer.
150 * If ep is NULL, assume no truncation check is needed.
151 * Return true if truncated.
152 * Stop at ep (if given) or after n bytes, whichever is first.
153 */
154 int
155 nd_printn(netdissect_options *ndo,
156 const u_char *s, u_int n, const u_char *ep)
157 {
158 u_char c;
159
160 while (n > 0 && (ep == NULL || s < ep)) {
161 n--;
162 c = GET_U_1(s);
163 s++;
164 fn_print_char(ndo, c);
165 }
166 return (n == 0) ? 0 : 1;
167 }
168
169 /*
170 * Print a counted filename (or other ASCII string), part of
171 * the packet buffer, filtering out non-printable characters.
172 * Stop if truncated (via GET_U_1/longjmp) or after n bytes,
173 * whichever is first.
174 * The suffix comes from: j:longJmp, n:after N bytes.
175 */
176 void
177 nd_printjn(netdissect_options *ndo, const u_char *s, u_int n)
178 {
179 while (n != 0) {
180 fn_print_char(ndo, GET_U_1(s));
181 n--;
182 s++;
183 }
184 }
185
186 /*
187 * Print a null-padded filename (or other ASCII string), part of
188 * the packet buffer, filtering out non-printable characters.
189 * Stop if truncated (via GET_U_1/longjmp) or after n bytes or before
190 * the null char, whichever occurs first.
191 * The suffix comes from: j:longJmp, n:after N bytes, p:null-Padded.
192 */
193 void
194 nd_printjnp(netdissect_options *ndo, const u_char *s, u_int n)
195 {
196 u_char c;
197
198 while (n != 0) {
199 c = GET_U_1(s);
200 if (c == '\0')
201 break;
202 fn_print_char(ndo, c);
203 n--;
204 s++;
205 }
206 }
207
208 /*
209 * Print the timestamp .FRAC part (Microseconds/nanoseconds)
210 */
211 static void
212 ts_frac_print(netdissect_options *ndo, const struct timeval *tv)
213 {
214 #ifdef HAVE_PCAP_SET_TSTAMP_PRECISION
215 switch (ndo->ndo_tstamp_precision) {
216
217 case PCAP_TSTAMP_PRECISION_MICRO:
218 ND_PRINT(".%06u", (unsigned)tv->tv_usec);
219 break;
220
221 case PCAP_TSTAMP_PRECISION_NANO:
222 ND_PRINT(".%09u", (unsigned)tv->tv_usec);
223 break;
224
225 default:
226 ND_PRINT(".{unknown}");
227 break;
228 }
229 #else
230 ND_PRINT(".%06u", (unsigned)tv->tv_usec);
231 #endif
232 }
233
234 /*
235 * Print the timestamp as [YY:MM:DD] HH:MM:SS.FRAC.
236 * if time_flag == LOCAL_TIME print local time else UTC/GMT time
237 * if date_flag == WITH_DATE print YY:MM:DD before HH:MM:SS.FRAC
238 */
239 static void
240 ts_date_hmsfrac_print(netdissect_options *ndo, const struct timeval *tv,
241 enum date_flag date_flag, enum time_flag time_flag)
242 {
243 struct tm *tm;
244 char timebuf[32];
245 const char *timestr;
246 #ifdef _WIN32
247 time_t sec;
248 #endif
249
250 if (tv->tv_sec < 0) {
251 ND_PRINT("[timestamp < 1970-01-01 00:00:00 UTC]");
252 return;
253 }
254
255 #ifdef _WIN32
256 /* on Windows tv->tv_sec is a long not a 64-bit time_t. */
257 sec = tv->tv_sec;
258 #endif
259
260 if (time_flag == LOCAL_TIME)
261 #ifdef _WIN32
262 tm = localtime(&sec);
263 #else
264 tm = localtime(&tv->tv_sec);
265 #endif
266 else
267 #ifdef _WIN32
268 tm = gmtime(&sec);
269 #else
270 tm = gmtime(&tv->tv_sec);
271 #endif
272
273 if (date_flag == WITH_DATE) {
274 timestr = nd_format_time(timebuf, sizeof(timebuf),
275 "%Y-%m-%d %H:%M:%S", tm);
276 } else {
277 timestr = nd_format_time(timebuf, sizeof(timebuf),
278 "%H:%M:%S", tm);
279 }
280 ND_PRINT("%s", timestr);
281
282 ts_frac_print(ndo, tv);
283 }
284
285 /*
286 * Print the timestamp - Unix timeval style, as SECS.FRAC.
287 */
288 static void
289 ts_unix_print(netdissect_options *ndo, const struct timeval *tv)
290 {
291 if (tv->tv_sec < 0) {
292 ND_PRINT("[timestamp < 1970-01-01 00:00:00 UTC]");
293 return;
294 }
295
296 ND_PRINT("%u", (unsigned)tv->tv_sec);
297 ts_frac_print(ndo, tv);
298 }
299
300 /*
301 * Print the timestamp
302 */
303 void
304 ts_print(netdissect_options *ndo,
305 const struct timeval *tvp)
306 {
307 static struct timeval tv_ref;
308 struct timeval tv_result;
309 int negative_offset;
310 int nano_prec;
311
312 switch (ndo->ndo_tflag) {
313
314 case 0: /* Default */
315 ts_date_hmsfrac_print(ndo, tvp, WITHOUT_DATE, LOCAL_TIME);
316 ND_PRINT(" ");
317 break;
318
319 case 1: /* No time stamp */
320 break;
321
322 case 2: /* Unix timeval style */
323 ts_unix_print(ndo, tvp);
324 ND_PRINT(" ");
325 break;
326
327 case 3: /* Microseconds/nanoseconds since previous packet */
328 case 5: /* Microseconds/nanoseconds since first packet */
329 #ifdef HAVE_PCAP_SET_TSTAMP_PRECISION
330 switch (ndo->ndo_tstamp_precision) {
331 case PCAP_TSTAMP_PRECISION_MICRO:
332 nano_prec = 0;
333 break;
334 case PCAP_TSTAMP_PRECISION_NANO:
335 nano_prec = 1;
336 break;
337 default:
338 nano_prec = 0;
339 break;
340 }
341 #else
342 nano_prec = 0;
343 #endif
344 if (!(netdissect_timevalisset(&tv_ref)))
345 tv_ref = *tvp; /* set timestamp for first packet */
346
347 negative_offset = netdissect_timevalcmp(tvp, &tv_ref, <);
348 if (negative_offset)
349 netdissect_timevalsub(&tv_ref, tvp, &tv_result, nano_prec);
350 else
351 netdissect_timevalsub(tvp, &tv_ref, &tv_result, nano_prec);
352
353 ND_PRINT((negative_offset ? "-" : " "));
354 ts_date_hmsfrac_print(ndo, &tv_result, WITHOUT_DATE, UTC_TIME);
355 ND_PRINT(" ");
356
357 if (ndo->ndo_tflag == 3)
358 tv_ref = *tvp; /* set timestamp for previous packet */
359 break;
360
361 case 4: /* Date + Default */
362 ts_date_hmsfrac_print(ndo, tvp, WITH_DATE, LOCAL_TIME);
363 ND_PRINT(" ");
364 break;
365 }
366 }
367
368 /*
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.
372 */
373 void
374 unsigned_relts_print(netdissect_options *ndo,
375 uint32_t secs)
376 {
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;
381
382 if (secs == 0) {
383 ND_PRINT("0s");
384 return;
385 }
386 while (secs != 0) {
387 if (secs >= *s) {
388 ND_PRINT("%u%s", secs / *s, *l);
389 secs -= (secs / *s) * *s;
390 }
391 s++;
392 l++;
393 }
394 }
395
396 /*
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.
400 */
401 void
402 signed_relts_print(netdissect_options *ndo,
403 int32_t secs)
404 {
405 if (secs < 0) {
406 ND_PRINT("-");
407 if (secs == INT32_MIN) {
408 /*
409 * -2^31; you can't fit its absolute value into
410 * a 32-bit signed integer.
411 *
412 * Just directly pass said absolute value to
413 * unsigned_relts_print() directly.
414 *
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?)
418 */
419 unsigned_relts_print(ndo, 2147483648U);
420 } else {
421 /*
422 * We now know -secs will fit into an int32_t;
423 * negate it and pass that to unsigned_relts_print().
424 */
425 unsigned_relts_print(ndo, -secs);
426 }
427 return;
428 }
429 unsigned_relts_print(ndo, secs);
430 }
431
432 /*
433 * Format a struct tm with strftime().
434 * If the pointer to the struct tm is null, that means that the
435 * routine to convert a time_t to a struct tm failed; the localtime()
436 * and gmtime() in the Microsoft Visual Studio C library will fail,
437 * returning null, if the value is before the UNIX Epoch.
438 */
439 const char *
440 nd_format_time(char *buf, size_t bufsize, const char *format,
441 const struct tm *timeptr)
442 {
443 if (timeptr != NULL) {
444 if (strftime(buf, bufsize, format, timeptr) != 0)
445 return (buf);
446 else
447 return ("[nd_format_time() buffer is too small]");
448 } else
449 return ("[localtime() or gmtime() couldn't convert the date and time]");
450 }
451
452 /* Print the truncated string */
453 void nd_print_trunc(netdissect_options *ndo)
454 {
455 ND_PRINT(" [|%s]", ndo->ndo_protocol);
456 }
457
458 /* Print the protocol name */
459 void nd_print_protocol(netdissect_options *ndo)
460 {
461 ND_PRINT("%s", ndo->ndo_protocol);
462 }
463
464 /* Print the protocol name in caps (uppercases) */
465 void nd_print_protocol_caps(netdissect_options *ndo)
466 {
467 const char *p;
468 for (p = ndo->ndo_protocol; *p != '\0'; p++)
469 ND_PRINT("%c", ND_ASCII_TOUPPER(*p));
470 }
471
472 /* Print the invalid string */
473 void nd_print_invalid(netdissect_options *ndo)
474 {
475 ND_PRINT(" (invalid)");
476 }
477
478 /*
479 * this is a generic routine for printing unknown data;
480 * we pass on the linefeed plus indentation string to
481 * get a proper output - returns 0 on error
482 */
483
484 int
485 print_unknown_data(netdissect_options *ndo, const u_char *cp,
486 const char *indent, u_int len)
487 {
488 if (!ND_TTEST_LEN(cp, 0)) {
489 ND_PRINT("%sDissector error: %s() called with pointer past end of packet",
490 indent, __func__);
491 return(0);
492 }
493 hex_print(ndo, indent, cp, ND_MIN(len, ND_BYTES_AVAILABLE_AFTER(cp)));
494 return(1); /* everything is ok */
495 }
496
497 /*
498 * Convert a token value to a string; use "fmt" if not found.
499 */
500 static const char *
501 tok2strbuf(const struct tok *lp, const char *fmt,
502 const u_int v, char *buf, const size_t bufsize)
503 {
504 if (lp != NULL) {
505 while (lp->s != NULL) {
506 if (lp->v == v)
507 return (lp->s);
508 ++lp;
509 }
510 }
511 if (fmt == NULL)
512 fmt = "#%d";
513
514 (void)snprintf(buf, bufsize, fmt, v);
515 return (const char *)buf;
516 }
517
518 /*
519 * Convert a token value to a string; use "fmt" if not found.
520 * Uses tok2strbuf() on one of four local static buffers of size TOKBUFSIZE
521 * in round-robin fashion.
522 */
523 const char *
524 tok2str(const struct tok *lp, const char *fmt, const u_int v)
525 {
526 static char buf[4][TOKBUFSIZE];
527 static int idx = 0;
528 char *ret;
529
530 ret = buf[idx];
531 idx = (idx+1) & 3;
532 return tok2strbuf(lp, fmt, v, ret, sizeof(buf[0]));
533 }
534
535 /*
536 * Convert a bit token value to a string; use "fmt" if not found.
537 * this is useful for parsing bitfields, the output strings are separated
538 * if the s field is positive.
539 *
540 * A token matches iff it has one or more bits set and every bit that is set
541 * in the token is set in v. Consequently, a 0 token never matches.
542 */
543 static char *
544 bittok2str_internal(const struct tok *lp, const char *fmt,
545 const u_int v, const char *sep)
546 {
547 static char buf[1024+1]; /* our string buffer */
548 char *bufp = buf;
549 size_t space_left = sizeof(buf), string_size;
550 const char * sepstr = "";
551
552 while (lp != NULL && lp->s != NULL) {
553 if (lp->v && (v & lp->v) == lp->v) {
554 /* ok we have found something */
555 if (space_left <= 1)
556 return (buf); /* only enough room left for NUL, if that */
557 string_size = strlcpy(bufp, sepstr, space_left);
558 if (string_size >= space_left)
559 return (buf); /* we ran out of room */
560 bufp += string_size;
561 space_left -= string_size;
562 if (space_left <= 1)
563 return (buf); /* only enough room left for NUL, if that */
564 string_size = strlcpy(bufp, lp->s, space_left);
565 if (string_size >= space_left)
566 return (buf); /* we ran out of room */
567 bufp += string_size;
568 space_left -= string_size;
569 sepstr = sep;
570 }
571 lp++;
572 }
573
574 if (bufp == buf)
575 /* bummer - lets print the "unknown" message as advised in the fmt string if we got one */
576 (void)snprintf(buf, sizeof(buf), fmt == NULL ? "#%08x" : fmt, v);
577 return (buf);
578 }
579
580 /*
581 * Convert a bit token value to a string; use "fmt" if not found.
582 * this is useful for parsing bitfields, the output strings are not separated.
583 */
584 char *
585 bittok2str_nosep(const struct tok *lp, const char *fmt, const u_int v)
586 {
587 return (bittok2str_internal(lp, fmt, v, ""));
588 }
589
590 /*
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 separated.
593 */
594 char *
595 bittok2str(const struct tok *lp, const char *fmt, const u_int v)
596 {
597 return (bittok2str_internal(lp, fmt, v, ", "));
598 }
599
600 /*
601 * Convert a value to a string using an array; the macro
602 * tok2strary() in <netdissect.h> is the public interface to
603 * this function and ensures that the second argument is
604 * correct for bounds-checking.
605 */
606 const char *
607 tok2strary_internal(const char **lp, int n, const char *fmt, const int v)
608 {
609 static char buf[TOKBUFSIZE];
610
611 if (v >= 0 && v < n && lp[v] != NULL)
612 return lp[v];
613 if (fmt == NULL)
614 fmt = "#%d";
615 (void)snprintf(buf, sizeof(buf), fmt, v);
616 return (buf);
617 }
618
619 const struct tok *
620 uint2tokary_internal(const struct uint_tokary dict[], const size_t size,
621 const u_int val)
622 {
623 size_t i;
624 /* Try a direct lookup before the full scan. */
625 if (val < size && dict[val].uintval == val)
626 return dict[val].tokary; /* OK if NULL */
627 for (i = 0; i < size; i++)
628 if (dict[i].uintval == val)
629 return dict[i].tokary; /* OK if NULL */
630 return NULL;
631 }
632
633 /*
634 * Convert a 32-bit netmask to prefixlen if possible
635 * the function returns the prefix-len; if plen == -1
636 * then conversion was not possible;
637 */
638
639 int
640 mask2plen(const uint32_t mask)
641 {
642 const uint32_t bitmasks[33] = {
643 0x00000000,
644 0x80000000, 0xc0000000, 0xe0000000, 0xf0000000,
645 0xf8000000, 0xfc000000, 0xfe000000, 0xff000000,
646 0xff800000, 0xffc00000, 0xffe00000, 0xfff00000,
647 0xfff80000, 0xfffc0000, 0xfffe0000, 0xffff0000,
648 0xffff8000, 0xffffc000, 0xffffe000, 0xfffff000,
649 0xfffff800, 0xfffffc00, 0xfffffe00, 0xffffff00,
650 0xffffff80, 0xffffffc0, 0xffffffe0, 0xfffffff0,
651 0xfffffff8, 0xfffffffc, 0xfffffffe, 0xffffffff
652 };
653 int prefix_len = 32;
654
655 /* let's see if we can transform the mask into a prefixlen */
656 while (prefix_len >= 0) {
657 if (bitmasks[prefix_len] == mask)
658 break;
659 prefix_len--;
660 }
661 return (prefix_len);
662 }
663
664 int
665 mask62plen(const u_char *mask)
666 {
667 u_char bitmasks[9] = {
668 0x00,
669 0x80, 0xc0, 0xe0, 0xf0,
670 0xf8, 0xfc, 0xfe, 0xff
671 };
672 int byte;
673 int cidr_len = 0;
674
675 for (byte = 0; byte < 16; byte++) {
676 u_int bits;
677
678 for (bits = 0; bits < (sizeof (bitmasks) / sizeof (bitmasks[0])); bits++) {
679 if (mask[byte] == bitmasks[bits]) {
680 cidr_len += bits;
681 break;
682 }
683 }
684
685 if (mask[byte] != 0xff)
686 break;
687 }
688 return (cidr_len);
689 }
690
691 /*
692 * Routine to print out information for text-based protocols such as FTP,
693 * HTTP, SMTP, RTSP, SIP, ....
694 */
695 #define MAX_TOKEN 128
696
697 /*
698 * Fetch a token from a packet, starting at the specified index,
699 * and return the length of the token.
700 *
701 * Returns 0 on error; yes, this is indistinguishable from an empty
702 * token, but an "empty token" isn't a valid token - it just means
703 * either a space character at the beginning of the line (this
704 * includes a blank line) or no more tokens remaining on the line.
705 */
706 static u_int
707 fetch_token(netdissect_options *ndo, const u_char *pptr, u_int idx, u_int len,
708 u_char *tbuf, size_t tbuflen)
709 {
710 size_t toklen = 0;
711 u_char c;
712
713 for (; idx < len; idx++) {
714 if (!ND_TTEST_1(pptr + idx)) {
715 /* ran past end of captured data */
716 return (0);
717 }
718 c = GET_U_1(pptr + idx);
719 if (!ND_ISASCII(c)) {
720 /* not an ASCII character */
721 return (0);
722 }
723 if (c == ' ' || c == '\t' || c == '\r' || c == '\n') {
724 /* end of token */
725 break;
726 }
727 if (!ND_ASCII_ISPRINT(c)) {
728 /* not part of a command token or response code */
729 return (0);
730 }
731 if (toklen + 2 > tbuflen) {
732 /* no room for this character and terminating '\0' */
733 return (0);
734 }
735 tbuf[toklen] = c;
736 toklen++;
737 }
738 if (toklen == 0) {
739 /* no token */
740 return (0);
741 }
742 tbuf[toklen] = '\0';
743
744 /*
745 * Skip past any white space after the token, until we see
746 * an end-of-line (CR or LF).
747 */
748 for (; idx < len; idx++) {
749 if (!ND_TTEST_1(pptr + idx)) {
750 /* ran past end of captured data */
751 break;
752 }
753 c = GET_U_1(pptr + idx);
754 if (c == '\r' || c == '\n') {
755 /* end of line */
756 break;
757 }
758 if (!ND_ASCII_ISPRINT(c)) {
759 /* not a printable ASCII character */
760 break;
761 }
762 if (c != ' ' && c != '\t' && c != '\r' && c != '\n') {
763 /* beginning of next token */
764 break;
765 }
766 }
767 return (idx);
768 }
769
770 /*
771 * Scan a buffer looking for a line ending - LF or CR-LF.
772 * Return the index of the character after the line ending or 0 if
773 * we encounter a non-ASCII or non-printable character or don't find
774 * the line ending.
775 */
776 static u_int
777 print_txt_line(netdissect_options *ndo, const char *prefix,
778 const u_char *pptr, u_int idx, u_int len)
779 {
780 u_int startidx;
781 u_int linelen;
782 u_char c;
783
784 startidx = idx;
785 while (idx < len) {
786 c = GET_U_1(pptr + idx);
787 if (c == '\n') {
788 /*
789 * LF without CR; end of line.
790 * Skip the LF and print the line, with the
791 * exception of the LF.
792 */
793 linelen = idx - startidx;
794 idx++;
795 goto print;
796 } else if (c == '\r') {
797 /* CR - any LF? */
798 if ((idx+1) >= len) {
799 /* not in this packet */
800 return (0);
801 }
802 if (GET_U_1(pptr + idx + 1) == '\n') {
803 /*
804 * CR-LF; end of line.
805 * Skip the CR-LF and print the line, with
806 * the exception of the CR-LF.
807 */
808 linelen = idx - startidx;
809 idx += 2;
810 goto print;
811 }
812
813 /*
814 * CR followed by something else; treat this
815 * as if it were binary data, and don't print
816 * it.
817 */
818 return (0);
819 } else if (!ND_ASCII_ISPRINT(c) && c != '\t') {
820 /*
821 * Not a printable ASCII character and not a tab;
822 * treat this as if it were binary data, and
823 * don't print it.
824 */
825 return (0);
826 }
827 idx++;
828 }
829
830 /*
831 * All printable ASCII, but no line ending after that point
832 * in the buffer.
833 */
834 linelen = idx - startidx;
835 ND_PRINT("%s%.*s", prefix, (int)linelen, pptr + startidx);
836 return (0);
837
838 print:
839 ND_PRINT("%s%.*s", prefix, (int)linelen, pptr + startidx);
840 return (idx);
841 }
842
843 /* Assign needed before calling txtproto_print(): ndo->ndo_protocol = "proto" */
844 void
845 txtproto_print(netdissect_options *ndo, const u_char *pptr, u_int len,
846 const char **cmds, u_int flags)
847 {
848 u_int idx, eol;
849 u_char token[MAX_TOKEN+1];
850 const char *cmd;
851 int print_this = 0;
852
853 if (cmds != NULL) {
854 /*
855 * This protocol has more than just request and
856 * response lines; see whether this looks like a
857 * request or response and, if so, print it and,
858 * in verbose mode, print everything after it.
859 *
860 * This is for HTTP-like protocols, where we
861 * want to print requests and responses, but
862 * don't want to print continuations of request
863 * or response bodies in packets that don't
864 * contain the request or response line.
865 */
866 idx = fetch_token(ndo, pptr, 0, len, token, sizeof(token));
867 if (idx != 0) {
868 /* Is this a valid request name? */
869 while ((cmd = *cmds++) != NULL) {
870 if (ascii_strcasecmp((const char *)token, cmd) == 0) {
871 /* Yes. */
872 print_this = 1;
873 break;
874 }
875 }
876
877 /*
878 * No - is this a valid response code (3 digits)?
879 *
880 * Is this token the response code, or is the next
881 * token the response code?
882 */
883 if (flags & RESP_CODE_SECOND_TOKEN) {
884 /*
885 * Next token - get it.
886 */
887 idx = fetch_token(ndo, pptr, idx, len, token,
888 sizeof(token));
889 }
890 if (idx != 0) {
891 if (ND_ASCII_ISDIGIT(token[0]) && ND_ASCII_ISDIGIT(token[1]) &&
892 ND_ASCII_ISDIGIT(token[2]) && token[3] == '\0') {
893 /* Yes. */
894 print_this = 1;
895 }
896 }
897 }
898 } else {
899 /*
900 * Either:
901 *
902 * 1) This protocol has only request and response lines
903 * (e.g., FTP, where all the data goes over a different
904 * connection); assume the payload is a request or
905 * response.
906 *
907 * or
908 *
909 * 2) This protocol is just text, so that we should
910 * always, at minimum, print the first line and,
911 * in verbose mode, print all lines.
912 */
913 print_this = 1;
914 }
915
916 nd_print_protocol_caps(ndo);
917
918 if (print_this) {
919 /*
920 * In non-verbose mode, just print the protocol, followed
921 * by the first line.
922 *
923 * In verbose mode, print lines as text until we run out
924 * of characters or see something that's not a
925 * printable-ASCII line.
926 */
927 if (ndo->ndo_vflag) {
928 /*
929 * We're going to print all the text lines in the
930 * request or response; just print the length
931 * on the first line of the output.
932 */
933 ND_PRINT(", length: %u", len);
934 for (idx = 0;
935 idx < len && (eol = print_txt_line(ndo, "\n\t", pptr, idx, len)) != 0;
936 idx = eol)
937 ;
938 } else {
939 /*
940 * Just print the first text line.
941 */
942 print_txt_line(ndo, ": ", pptr, 0, len);
943 }
944 }
945 }
946
947 #if (defined(__i386__) || defined(_M_IX86) || defined(__X86__) || defined(__x86_64__) || defined(_M_X64)) || \
948 (defined(__arm__) || defined(_M_ARM) || defined(__aarch64__)) || \
949 (defined(__m68k__) && (!defined(__mc68000__) && !defined(__mc68010__))) || \
950 (defined(__ppc__) || defined(__ppc64__) || defined(_M_PPC) || defined(_ARCH_PPC) || defined(_ARCH_PPC64)) || \
951 (defined(__s390__) || defined(__s390x__) || defined(__zarch__)) || \
952 defined(__vax__)
953 /*
954 * The processor natively handles unaligned loads, so just use memcpy()
955 * and memcmp(), to enable those optimizations.
956 *
957 * XXX - are those all the x86 tests we need?
958 * XXX - do we need to worry about ARMv1 through ARMv5, which didn't
959 * support unaligned loads, and, if so, do we need to worry about all
960 * of them, or just some of them, e.g. ARMv5?
961 * XXX - are those the only 68k tests we need not to generated
962 * unaligned accesses if the target is the 68000 or 68010?
963 * XXX - are there any tests we don't need, because some definitions are for
964 * compilers that also predefine the GCC symbols?
965 * XXX - do we need to test for both 32-bit and 64-bit versions of those
966 * architectures in all cases?
967 */
968 #else
969 /*
970 * The processor doesn't natively handle unaligned loads,
971 * and the compiler might "helpfully" optimize memcpy()
972 * and memcmp(), when handed pointers that would normally
973 * be properly aligned, into sequences that assume proper
974 * alignment.
975 *
976 * Do copies and compares of possibly-unaligned data by
977 * calling routines that wrap memcpy() and memcmp(), to
978 * prevent that optimization.
979 */
980 void
981 unaligned_memcpy(void *p, const void *q, size_t l)
982 {
983 memcpy(p, q, l);
984 }
985
986 /* As with memcpy(), so with memcmp(). */
987 int
988 unaligned_memcmp(const void *p, const void *q, size_t l)
989 {
990 return (memcmp(p, q, l));
991 }
992 #endif
993