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