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