3 * Wireshark - Network traffic analyzer
4 * By Gerald Combs <gerald@wireshark.org>
5 * Copyright 1998 Gerald Combs
7 * Rawshark - Raw field extractor by Gerald Combs <gerald@wireshark.org>
8 * and Loris Degioanni <loris.degioanni@cacetech.com>
9 * Based on TShark, by Gilbert Ramirez <gram@alumni.rice.edu> and Guy Harris
12 * SPDX-License-Identifier: GPL-2.0-or-later
16 * Rawshark does the following:
17 * - Opens a specified file or named pipe
18 * - Applies a specfied DLT or "decode as" encapsulation
19 * - Reads frames prepended with a libpcap packet header.
20 * - Prints a status line, followed by fields from a specified list.
33 #include <sys/resource.h>
42 #ifndef HAVE_GETOPT_LONG
43 #include "wsutil/wsgetopt.h"
47 #include <epan/epan.h>
49 #include <wsutil/cmdarg_err.h>
50 #include <wsutil/crash_info.h>
51 #include <wsutil/filesystem.h>
52 #include <wsutil/file_util.h>
53 #include <wsutil/plugins.h>
54 #include <wsutil/privileges.h>
55 #include <wsutil/report_message.h>
58 #include <epan/packet.h>
59 #include <epan/ftypes/ftypes-int.h>
61 #include "frame_tvbuff.h"
62 #include <epan/disabled_protos.h>
63 #include <epan/prefs.h>
64 #include <epan/column.h>
65 #include <epan/print.h>
66 #include <epan/addr_resolv.h>
68 #include "ui/capture_ui_utils.h"
71 #include "ui/dissect_opts.h"
72 #include "ui/failure_message.h"
73 #include "epan/register.h"
74 #include "conditions.h"
75 #include "capture_stop_conditions.h"
76 #include <epan/epan_dissect.h>
77 #include <epan/stat_tap_ui.h>
78 #include <epan/timestamp.h>
79 #include <wsutil/unicode-utils.h>
80 #include "epan/column-utils.h"
81 #include "epan/proto.h"
84 #include <wiretap/wtap.h>
85 #include <wiretap/libpcap.h>
86 #include <wiretap/pcap-encap.h>
88 #include <wsutil/clopts_common.h>
89 #include <version_info.h>
91 #include "caputils/capture-pcap-util.h"
98 #include "caputils/capture-wpcap.h"
100 #endif /* HAVE_LIBPCAP */
105 * This is the template for the decode as option; it is shared between the
106 * various functions that output the usage for this parameter.
108 static const gchar decode_as_arg_template[] = "<layer_type>==<selector>,<decode_as_protocol>";
111 #define INVALID_OPTION 1
113 #define INVALID_DFILTER 2
115 #define FORMAT_ERROR 2
119 static guint32 cum_bytes;
120 static frame_data ref_frame;
121 static frame_data prev_dis_frame;
122 static frame_data prev_cap_frame;
125 * The way the packet decode is to be written.
128 WRITE_TEXT, /* summary or detail text */
129 WRITE_XML /* PDML or PSML */
130 /* Add CSV and the like here */
133 static gboolean line_buffered;
134 static print_format_e print_format = PR_FMT_TEXT;
136 static gboolean want_pcap_pkthdr;
138 cf_status_t raw_cf_open(capture_file *cf, const char *fname);
139 static gboolean load_cap_file(capture_file *cf);
140 static gboolean process_packet(capture_file *cf, epan_dissect_t *edt, gint64 offset,
141 wtap_rec *rec, const guchar *pd);
142 static void show_print_file_io_error(int err);
144 static void failure_warning_message(const char *msg_format, va_list ap);
145 static void open_failure_message(const char *filename, int err,
146 gboolean for_writing);
147 static void read_failure_message(const char *filename, int err);
148 static void write_failure_message(const char *filename, int err);
149 static void rawshark_cmdarg_err(const char *fmt, va_list ap);
150 static void rawshark_cmdarg_err_cont(const char *fmt, va_list ap);
151 static void protocolinfo_init(char *field);
152 static gboolean parse_field_string_format(char *format);
155 SF_NONE, /* No format (placeholder) */
156 SF_NAME, /* %D Field name / description */
157 SF_NUMVAL, /* %N Numeric value */
158 SF_STRVAL /* %S String value */
161 typedef struct string_fmt_s {
163 string_fmt_e format; /* Valid if plain is NULL */
168 dfilter_t *rfcodes[64];
170 dfilter_t *rfieldfcodes[64];
173 GPtrArray *string_fmts;
176 print_usage(FILE *output)
178 fprintf(output, "\n");
179 fprintf(output, "Usage: rawshark [options] ...\n");
180 fprintf(output, "\n");
182 fprintf(output, "Input file:\n");
183 fprintf(output, " -r <infile> set the pipe or file name to read from\n");
185 fprintf(output, "\n");
186 fprintf(output, "Processing:\n");
187 fprintf(output, " -d <encap:linktype>|<proto:protoname>\n");
188 fprintf(output, " packet encapsulation or protocol\n");
189 fprintf(output, " -F <field> field to display\n");
191 fprintf(output, " -m virtual memory limit, in bytes\n");
193 fprintf(output, " -n disable all name resolution (def: all enabled)\n");
194 fprintf(output, " -N <name resolve flags> enable specific name resolution(s): \"mnNtd\"\n");
195 fprintf(output, " -p use the system's packet header format\n");
196 fprintf(output, " (which may have 64-bit timestamps)\n");
197 fprintf(output, " -R <read filter> packet filter in Wireshark display filter syntax\n");
198 fprintf(output, " -s skip PCAP header on input\n");
200 fprintf(output, "\n");
201 fprintf(output, "Output:\n");
202 fprintf(output, " -l flush output after each packet\n");
203 fprintf(output, " -S format string for fields\n");
204 fprintf(output, " (%%D - name, %%S - stringval, %%N numval)\n");
205 fprintf(output, " -t ad|a|r|d|dd|e output format of time stamps (def: r: rel. to first)\n");
207 fprintf(output, "\n");
208 fprintf(output, "Miscellaneous:\n");
209 fprintf(output, " -h display this help and exit\n");
210 fprintf(output, " -o <name>:<value> ... override preference setting\n");
211 fprintf(output, " -v display version info and exit\n");
215 log_func_ignore (const gchar *log_domain _U_, GLogLevelFlags log_level _U_,
216 const gchar *message _U_, gpointer user_data _U_)
221 * Open a pipe for raw input. This is a stripped-down version of
222 * pcap_loop.c:cap_pipe_open_live().
223 * We check if "pipe_name" is "-" (stdin) or a FIFO, and open it.
224 * @param pipe_name The name of the pipe or FIFO.
225 * @return A POSIX file descriptor on success, or -1 on failure.
228 raw_pipe_open(const char *pipe_name)
231 ws_statb64 pipe_stat;
233 char *pncopy, *pos = NULL;
240 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "open_raw_pipe: %s", pipe_name);
243 * XXX Rawshark blocks until we return
245 if (strcmp(pipe_name, "-") == 0) {
246 rfd = 0; /* read from stdin */
249 * This is needed to set the stdin pipe into binary mode, otherwise
250 * CR/LF are mangled...
252 _setmode(0, _O_BINARY);
256 if (ws_stat64(pipe_name, &pipe_stat) < 0) {
257 fprintf(stderr, "rawshark: The pipe %s could not be checked: %s\n",
258 pipe_name, g_strerror(errno));
261 if (! S_ISFIFO(pipe_stat.st_mode)) {
262 if (S_ISCHR(pipe_stat.st_mode)) {
264 * Assume the user specified an interface on a system where
265 * interfaces are in /dev. Pretend we haven't seen it.
269 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
274 rfd = ws_open(pipe_name, O_RDONLY | O_NONBLOCK, 0000 /* no creation so don't matter */);
276 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
277 pipe_name, g_strerror(errno));
281 #define PIPE_STR "\\pipe\\"
282 /* Under Windows, named pipes _must_ have the form
283 * "\\<server>\pipe\<pipe_name>". <server> may be "." for localhost.
285 pncopy = g_strdup(pipe_name);
286 if (strstr(pncopy, "\\\\") == pncopy) {
287 pos = strchr(pncopy + 3, '\\');
288 if (pos && g_ascii_strncasecmp(pos, PIPE_STR, strlen(PIPE_STR)) != 0)
295 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
300 /* Wait for the pipe to appear */
302 hPipe = CreateFile(utf_8to16(pipe_name), GENERIC_READ, 0, NULL,
303 OPEN_EXISTING, 0, NULL);
305 if (hPipe != INVALID_HANDLE_VALUE)
308 err = GetLastError();
309 if (err != ERROR_PIPE_BUSY) {
310 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
311 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
312 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s (error %lu)\n",
313 pipe_name, utf_16to8(err_str), err);
318 if (!WaitNamedPipe(utf_8to16(pipe_name), 30 * 1000)) {
319 err = GetLastError();
320 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
321 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
322 fprintf(stderr, "rawshark: \"%s\" could not be waited for: %s (error %lu)\n",
323 pipe_name, utf_16to8(err_str), err);
329 rfd = _open_osfhandle((intptr_t) hPipe, _O_RDONLY);
331 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
332 pipe_name, g_strerror(errno));
342 * Parse a link-type argument of the form "encap:<pcap linktype>" or
343 * "proto:<proto name>". "Pcap linktype" must be a name conforming to
344 * pcap_datalink_name_to_val() or an integer; the integer should be
345 * a LINKTYPE_ value supported by Wiretap. "Proto name" must be
346 * a protocol name, e.g. "http".
349 set_link_type(const char *lt_arg) {
350 char *spec_ptr = strchr(lt_arg, ':');
354 dissector_handle_t dhandle;
363 if (strncmp(lt_arg, "encap:", strlen("encap:")) == 0) {
364 dlt_val = linktype_name_to_val(spec_ptr);
367 val = strtol(spec_ptr, &p, 10);
368 if (p == spec_ptr || *p != '\0' || errno != 0 || val > INT_MAX) {
374 * In those cases where a given link-layer header type
375 * has different LINKTYPE_ and DLT_ values, linktype_name_to_val()
376 * will return the OS's DLT_ value for that link-layer header
377 * type, not its OS-independent LINKTYPE_ value.
379 * On a given OS, wtap_pcap_encap_to_wtap_encap() should
380 * be able to map either LINKTYPE_ values or DLT_ values
381 * for the OS to the appropriate Wiretap encapsulation.
383 encap = wtap_pcap_encap_to_wtap_encap(dlt_val);
384 if (encap == WTAP_ENCAP_UNKNOWN) {
388 } else if (strncmp(lt_arg, "proto:", strlen("proto:")) == 0) {
389 dhandle = find_dissector(spec_ptr);
391 encap = WTAP_ENCAP_USER0;
392 pref_str = g_string_new("uat:user_dlts:");
393 /* This must match the format used in the user_dlts file */
394 g_string_append_printf(pref_str,
395 "\"User 0 (DLT=147)\",\"%s\",\"0\",\"\",\"0\",\"\"",
397 if (prefs_set_pref(pref_str->str, &errmsg) != PREFS_SET_OK) {
398 g_string_free(pref_str, TRUE);
402 g_string_free(pref_str, TRUE);
410 main(int argc, char *argv[])
412 GString *comp_info_str;
413 GString *runtime_info_str;
414 char *init_progfile_dir_error;
424 gchar *pipe_name = NULL;
429 GPtrArray *disp_fields = g_ptr_array_new();
431 gboolean skip_pcap_header = FALSE;
432 int ret = EXIT_SUCCESS;
433 static const struct option long_options[] = {
434 {"help", no_argument, NULL, 'h'},
435 {"version", no_argument, NULL, 'v'},
439 #define OPTSTRING_INIT "d:F:hlm:nN:o:pr:R:sS:t:v"
441 static const char optstring[] = OPTSTRING_INIT;
443 /* Set the C-language locale to the native environment. */
444 setlocale(LC_ALL, "");
446 cmdarg_err_init(rawshark_cmdarg_err, rawshark_cmdarg_err_cont);
448 /* Get the compile-time version information string */
449 comp_info_str = get_compiled_version_info(NULL, epan_get_compiled_version_info);
451 /* Get the run-time version information string */
452 runtime_info_str = get_runtime_version_info(NULL);
454 /* Add it to the information to be reported on a crash. */
455 ws_add_crash_info("Rawshark (Wireshark) %s\n"
460 get_ws_vcs_version_info(), comp_info_str->str, runtime_info_str->str);
463 arg_list_utf_16to8(argc, argv);
464 create_app_running_mutex();
468 * Get credential information for later use.
470 init_process_policies();
473 * Clear the filters arrays
475 memset(rfilters, 0, sizeof(rfilters));
476 memset(rfcodes, 0, sizeof(rfcodes));
481 * Initialize our string format
483 string_fmts = g_ptr_array_new();
486 * Attempt to get the pathname of the directory containing the
489 init_progfile_dir_error = init_progfile_dir(argv[0], main);
490 if (init_progfile_dir_error != NULL) {
491 fprintf(stderr, "rawshark: Can't get pathname of rawshark program: %s.\n",
492 init_progfile_dir_error);
495 /* nothing more than the standard GLib handler, but without a warning */
497 G_LOG_LEVEL_WARNING |
498 G_LOG_LEVEL_MESSAGE |
502 g_log_set_handler(NULL,
503 (GLogLevelFlags)log_flags,
504 log_func_ignore, NULL /* user_data */);
505 g_log_set_handler(LOG_DOMAIN_CAPTURE_CHILD,
506 (GLogLevelFlags)log_flags,
507 log_func_ignore, NULL /* user_data */);
509 init_report_message(failure_warning_message, failure_warning_message,
510 open_failure_message, read_failure_message,
511 write_failure_message);
513 timestamp_set_type(TS_RELATIVE);
514 timestamp_set_precision(TS_PREC_AUTO);
515 timestamp_set_seconds_type(TS_SECONDS_DEFAULT);
519 /* Register all dissectors; we must do this before checking for the
520 "-G" flag, as the "-G" flag dumps information registered by the
521 dissectors, and we must do it before we read the preferences, in
522 case any dissectors register preferences. */
523 if (!epan_init(register_all_protocols, register_all_protocol_handoffs,
529 /* Load libwireshark settings from the current profile. */
530 prefs_p = epan_load_settings();
533 ws_init_dll_search_path();
534 /* Load Wpcap, if possible */
538 cap_file_init(&cfile);
540 /* Print format defaults to this. */
541 print_format = PR_FMT_TEXT;
543 /* Initialize our encapsulation type */
544 encap = WTAP_ENCAP_UNKNOWN;
546 /* Now get our args */
547 /* XXX - We should probably have an option to dump libpcap link types */
548 while ((opt = getopt_long(argc, argv, optstring, long_options, NULL)) != -1) {
550 case 'd': /* Payload type */
551 if (!set_link_type(optarg)) {
552 cmdarg_err("Invalid link type or protocol \"%s\"", optarg);
553 ret = INVALID_OPTION;
557 case 'F': /* Read field to display */
558 g_ptr_array_add(disp_fields, g_strdup(optarg));
560 case 'h': /* Print help and exit */
561 printf("Rawshark (Wireshark) %s\n"
562 "Dump and analyze network traffic.\n"
563 "See https://www.wireshark.org for more information.\n",
564 get_ws_vcs_version_info());
568 case 'l': /* "Line-buffer" standard output */
569 /* This isn't line-buffering, strictly speaking, it's just
570 flushing the standard output after the information for
571 each packet is printed; however, that should be good
572 enough for all the purposes to which "-l" is put (and
573 is probably actually better for "-V", as it does fewer
576 See the comment in "process_packet()" for an explanation of
577 why we do that, and why we don't just use "setvbuf()" to
578 make the standard output line-buffered (short version: in
579 Windows, "line-buffered" is the same as "fully-buffered",
580 and the output buffer is only flushed when it fills up). */
581 line_buffered = TRUE;
585 limit.rlim_cur = get_positive_int(optarg, "memory limit");
586 limit.rlim_max = get_positive_int(optarg, "memory limit");
588 if(setrlimit(RLIMIT_AS, &limit) != 0) {
589 cmdarg_err("setrlimit() returned error");
590 ret = INVALID_OPTION;
595 case 'n': /* No name resolution */
596 disable_name_resolution();
598 case 'N': /* Select what types of addresses/port #s to resolve */
599 badopt = string_to_name_resolve(optarg, &gbl_resolv_flags);
600 if (badopt != '\0') {
601 cmdarg_err("-N specifies unknown resolving option '%c'; valid options are 'd', m', 'n', 'N', and 't'",
603 ret = INVALID_OPTION;
607 case 'o': /* Override preference from command line */
611 switch (prefs_set_pref(optarg, &errmsg)) {
616 case PREFS_SET_SYNTAX_ERR:
617 cmdarg_err("Invalid -o flag \"%s\"%s%s", optarg,
618 errmsg ? ": " : "", errmsg ? errmsg : "");
620 ret = INVALID_OPTION;
624 case PREFS_SET_NO_SUCH_PREF:
625 case PREFS_SET_OBSOLETE:
626 cmdarg_err("-o flag \"%s\" specifies unknown preference", optarg);
627 ret = INVALID_OPTION;
633 case 'p': /* Expect pcap_pkthdr packet headers, which may have 64-bit timestamps */
634 want_pcap_pkthdr = TRUE;
636 case 'r': /* Read capture file xxx */
637 pipe_name = g_strdup(optarg);
639 case 'R': /* Read file filter */
640 if(n_rfilters < (int) sizeof(rfilters) / (int) sizeof(rfilters[0])) {
641 rfilters[n_rfilters++] = optarg;
644 cmdarg_err("Too many display filters");
645 ret = INVALID_OPTION;
649 case 's': /* Skip PCAP header */
650 skip_pcap_header = TRUE;
652 case 'S': /* Print string representations */
653 if (!parse_field_string_format(optarg)) {
654 cmdarg_err("Invalid field string format");
655 ret = INVALID_OPTION;
659 case 't': /* Time stamp type */
660 if (strcmp(optarg, "r") == 0)
661 timestamp_set_type(TS_RELATIVE);
662 else if (strcmp(optarg, "a") == 0)
663 timestamp_set_type(TS_ABSOLUTE);
664 else if (strcmp(optarg, "ad") == 0)
665 timestamp_set_type(TS_ABSOLUTE_WITH_YMD);
666 else if (strcmp(optarg, "adoy") == 0)
667 timestamp_set_type(TS_ABSOLUTE_WITH_YDOY);
668 else if (strcmp(optarg, "d") == 0)
669 timestamp_set_type(TS_DELTA);
670 else if (strcmp(optarg, "dd") == 0)
671 timestamp_set_type(TS_DELTA_DIS);
672 else if (strcmp(optarg, "e") == 0)
673 timestamp_set_type(TS_EPOCH);
674 else if (strcmp(optarg, "u") == 0)
675 timestamp_set_type(TS_UTC);
676 else if (strcmp(optarg, "ud") == 0)
677 timestamp_set_type(TS_UTC_WITH_YMD);
678 else if (strcmp(optarg, "udoy") == 0)
679 timestamp_set_type(TS_UTC_WITH_YDOY);
681 cmdarg_err("Invalid time stamp type \"%s\"",
684 "It must be \"a\" for absolute, \"ad\" for absolute with YYYY-MM-DD date,");
686 "\"adoy\" for absolute with YYYY/DOY date, \"d\" for delta,");
688 "\"dd\" for delta displayed, \"e\" for epoch, \"r\" for relative,");
690 "\"u\" for absolute UTC, \"ud\" for absolute UTC with YYYY-MM-DD date,");
692 "or \"udoy\" for absolute UTC with YYYY/DOY date.");
693 ret = INVALID_OPTION;
697 case 'v': /* Show version and exit */
699 show_version("Rawshark (Wireshark)", comp_info_str, runtime_info_str);
700 g_string_free(comp_info_str, TRUE);
701 g_string_free(runtime_info_str, TRUE);
706 case '?': /* Bad flag - print usage message */
708 ret = INVALID_OPTION;
714 /* Notify all registered modules that have had any of their preferences
715 changed either from one of the preferences file or from the command
716 line that their preferences have changed.
717 Initialize preferences before display filters, otherwise modules
718 like MATE won't work. */
721 /* Initialize our display fields */
722 for (fc = 0; fc < disp_fields->len; fc++) {
723 protocolinfo_init((char *)g_ptr_array_index(disp_fields, fc));
725 g_ptr_array_free(disp_fields, TRUE);
729 /* If no capture filter or read filter has been specified, and there are
730 still command-line arguments, treat them as the tokens of a capture
731 filter (if no "-r" flag was specified) or a read filter (if a "-r"
732 flag was specified. */
734 if (pipe_name != NULL) {
735 if (n_rfilters != 0) {
736 cmdarg_err("Read filters were specified both with \"-R\" "
737 "and with additional command-line arguments");
738 ret = INVALID_OPTION;
741 rfilters[n_rfilters] = get_args_as_string(argc, argv, optind);
745 /* Make sure we got a dissector handle for our payload. */
746 if (encap == WTAP_ENCAP_UNKNOWN) {
747 cmdarg_err("No valid payload dissector specified.");
748 ret = INVALID_OPTION;
753 /* Start windows sockets */
754 result = WSAStartup( MAKEWORD( 1, 1 ), &wsaData );
763 * Enabled and disabled protocols and heuristic dissectors as per
764 * command-line options.
766 setup_enabled_and_disabled_protocols();
768 /* Build the column format array */
769 build_column_format_array(&cfile.cinfo, prefs_p->num_cols, TRUE);
771 if (n_rfilters != 0) {
772 for (i = 0; i < n_rfilters; i++) {
775 if (!dfilter_compile(rfilters[i], &rfcodes[n_rfcodes], &err_msg)) {
776 cmdarg_err("%s", err_msg);
778 ret = INVALID_DFILTER;
787 * We're reading a pipe (or capture file).
791 * Immediately relinquish any special privileges we have; we must not
792 * be allowed to read any capture files the user running Rawshark
795 relinquish_special_privs_perm();
797 if (raw_cf_open(&cfile, pipe_name) != CF_OK) {
802 /* Do we need to PCAP header and magic? */
803 if (skip_pcap_header) {
804 unsigned int bytes_left = (unsigned int) sizeof(struct pcap_hdr) + sizeof(guint32);
805 gchar buf[sizeof(struct pcap_hdr) + sizeof(guint32)];
806 while (bytes_left != 0) {
807 ssize_t bytes = ws_read(fd, buf, bytes_left);
809 cmdarg_err("Not enough bytes for pcap header.");
813 bytes_left -= (unsigned int)bytes;
817 /* Process the packets in the file */
818 if (!load_cap_file(&cfile)) {
823 /* If you want to capture live packets, use TShark. */
824 cmdarg_err("Input file or pipe name not specified.");
830 epan_free(cfile.epan);
838 * Read data from a raw pipe. The "raw" data consists of a libpcap
839 * packet header followed by the payload.
840 * @param pd [IN] A POSIX file descriptor. Because that's _exactly_ the sort
841 * of thing you want to use in Windows.
842 * @param err [OUT] Error indicator. Uses wiretap values.
843 * @param err_info [OUT] Error message.
844 * @param data_offset [OUT] data offset in the pipe.
845 * @return TRUE on success, FALSE on failure.
848 raw_pipe_read(wtap_rec *rec, guchar * pd, int *err, gchar **err_info, gint64 *data_offset) {
849 struct pcap_pkthdr mem_hdr;
850 struct pcaprec_hdr disk_hdr;
851 ssize_t bytes_read = 0;
852 unsigned int bytes_needed = (unsigned int) sizeof(disk_hdr);
853 guchar *ptr = (guchar*) &disk_hdr;
857 if (want_pcap_pkthdr) {
858 bytes_needed = sizeof(mem_hdr);
859 ptr = (guchar*) &mem_hdr;
863 * Newer versions of the VC runtime do parameter validation. If stdin
864 * has been closed, calls to _read, _get_osfhandle, et al will trigger
865 * the invalid parameter handler and crash.
866 * We could alternatively use ReadFile or set an invalid parameter
868 * We could also tell callers not to close stdin prematurely.
872 if (fd == 0 && GetHandleInformation(GetStdHandle(STD_INPUT_HANDLE), &ghi_flags) == 0) {
879 /* Copied from capture_loop.c */
880 while (bytes_needed > 0) {
881 bytes_read = ws_read(fd, ptr, bytes_needed);
882 if (bytes_read == 0) {
886 } else if (bytes_read < 0) {
891 bytes_needed -= (unsigned int)bytes_read;
892 *data_offset += bytes_read;
896 rec->rec_type = REC_TYPE_PACKET;
897 rec->presence_flags = WTAP_HAS_TS|WTAP_HAS_CAP_LEN;
898 if (want_pcap_pkthdr) {
899 rec->ts.secs = mem_hdr.ts.tv_sec;
900 rec->ts.nsecs = (gint32)mem_hdr.ts.tv_usec * 1000;
901 rec->rec_header.packet_header.caplen = mem_hdr.caplen;
902 rec->rec_header.packet_header.len = mem_hdr.len;
904 rec->ts.secs = disk_hdr.ts_sec;
905 rec->ts.nsecs = disk_hdr.ts_usec * 1000;
906 rec->rec_header.packet_header.caplen = disk_hdr.incl_len;
907 rec->rec_header.packet_header.len = disk_hdr.orig_len;
909 bytes_needed = rec->rec_header.packet_header.caplen;
911 rec->rec_header.packet_header.pkt_encap = encap;
914 printf("mem_hdr: %lu disk_hdr: %lu\n", sizeof(mem_hdr), sizeof(disk_hdr));
915 printf("tv_sec: %u (%04x)\n", (unsigned int) rec->ts.secs, (unsigned int) rec->ts.secs);
916 printf("tv_nsec: %d (%04x)\n", rec->ts.nsecs, rec->ts.nsecs);
917 printf("caplen: %d (%04x)\n", rec->rec_header.packet_header.caplen, rec->rec_header.packet_header.caplen);
918 printf("len: %d (%04x)\n", rec->rec_header.packet_header.len, rec->rec_header.packet_header.len);
920 if (bytes_needed > WTAP_MAX_PACKET_SIZE_STANDARD) {
921 *err = WTAP_ERR_BAD_FILE;
922 *err_info = g_strdup_printf("Bad packet length: %lu\n",
923 (unsigned long) bytes_needed);
928 while (bytes_needed > 0) {
929 bytes_read = ws_read(fd, ptr, bytes_needed);
930 if (bytes_read == 0) {
931 *err = WTAP_ERR_SHORT_READ;
934 } else if (bytes_read < 0) {
939 bytes_needed -= (unsigned int)bytes_read;
940 *data_offset += bytes_read;
947 load_cap_file(capture_file *cf)
950 gchar *err_info = NULL;
951 gint64 data_offset = 0;
959 epan_dissect_init(&edt, cf->epan, TRUE, FALSE);
961 pd = (guchar*)g_malloc(WTAP_MAX_PACKET_SIZE_STANDARD);
962 while (raw_pipe_read(&rec, pd, &err, &err_info, &data_offset)) {
963 process_packet(cf, &edt, data_offset, &rec, pd);
966 epan_dissect_cleanup(&edt);
968 wtap_rec_cleanup(&rec);
971 /* Print a message noting that the read failed somewhere along the line. */
972 cfile_read_failure_message("Rawshark", cf->filename, err, err_info);
980 process_packet(capture_file *cf, epan_dissect_t *edt, gint64 offset,
981 wtap_rec *rec, const guchar *pd)
987 if(rec->rec_header.packet_header.len == 0)
989 /* The user sends an empty packet when he wants to get output from us even if we don't currently have
990 packets to process. We spit out a line with the timestamp and the text "void"
992 printf("%lu %lu %lu void -\n", (unsigned long int)cf->count,
993 (unsigned long int)rec->ts.secs,
994 (unsigned long int)rec->ts.nsecs);
1001 /* Count this packet. */
1004 /* If we're going to print packet information, or we're going to
1005 run a read filter, or we're going to process taps, set up to
1006 do a dissection and do so. */
1007 frame_data_init(&fdata, cf->count, rec, offset, cum_bytes);
1011 /* If we're running a read filter, prime the epan_dissect_t with that
1013 if (n_rfilters > 0) {
1014 for(i = 0; i < n_rfcodes; i++) {
1015 epan_dissect_prime_with_dfilter(edt, rfcodes[i]);
1019 printf("%lu", (unsigned long int) cf->count);
1021 frame_data_set_before_dissect(&fdata, &cf->elapsed_time,
1022 &cf->provider.ref, cf->provider.prev_dis);
1024 if (cf->provider.ref == &fdata) {
1026 cf->provider.ref = &ref_frame;
1029 /* We only need the columns if we're printing packet info but we're
1030 *not* verbose; in verbose mode, we print the protocol tree, not
1031 the protocol summary. */
1032 epan_dissect_run_with_taps(edt, cf->cd_t, rec,
1033 frame_tvbuff_new(&cf->provider, &fdata, pd),
1034 &fdata, &cf->cinfo);
1036 frame_data_set_after_dissect(&fdata, &cum_bytes);
1037 prev_dis_frame = fdata;
1038 cf->provider.prev_dis = &prev_dis_frame;
1040 prev_cap_frame = fdata;
1041 cf->provider.prev_cap = &prev_cap_frame;
1043 for(i = 0; i < n_rfilters; i++) {
1044 /* Run the read filter if we have one. */
1046 passed = dfilter_apply_edt(rfcodes[i], edt);
1050 /* Print a one-line summary */
1051 printf(" %d", passed ? 1 : 0);
1056 /* The ANSI C standard does not appear to *require* that a line-buffered
1057 stream be flushed to the host environment whenever a newline is
1058 written, it just says that, on such a stream, characters "are
1059 intended to be transmitted to or from the host environment as a
1060 block when a new-line character is encountered".
1062 The Visual C++ 6.0 C implementation doesn't do what is intended;
1063 even if you set a stream to be line-buffered, it still doesn't
1064 flush the buffer at the end of every line.
1066 So, if the "-l" flag was specified, we flush the standard output
1067 at the end of a packet. This will do the right thing if we're
1068 printing packet summary lines, and, as we print the entire protocol
1069 tree for a single packet without waiting for anything to happen,
1070 it should be as good as line-buffered mode if we're printing
1071 protocol trees. (The whole reason for the "-l" flag in either
1072 tcpdump or Rawshark is to allow the output of a live capture to
1073 be piped to a program or script and to have that script see the
1074 information for the packet as soon as it's printed, rather than
1075 having to wait until a standard I/O buffer fills up. */
1079 if (ferror(stdout)) {
1080 show_print_file_io_error(errno);
1084 epan_dissect_reset(edt);
1085 frame_data_destroy(&fdata);
1090 /****************************************************************************************
1091 * FIELD EXTRACTION ROUTINES
1092 ****************************************************************************************/
1093 typedef struct _pci_t {
1099 static const char* ftenum_to_string(header_field_info *hfi)
1106 if (string_fmts->len > 0 && hfi->strings) {
1110 str = ftype_name(hfi->type);
1118 static void field_display_to_string(header_field_info *hfi, char* buf, int size)
1120 if (hfi->type != FT_BOOLEAN)
1122 g_strlcpy(buf, proto_field_display_to_string(hfi->display), size);
1126 g_snprintf(buf, size, "(Bit count: %d)", hfi->display);
1131 * Copied from various parts of proto.c
1133 #define FIELD_STR_INIT_LEN 256
1134 #define cVALS(x) (const value_string*)(x)
1135 static gboolean print_field_value(field_info *finfo, int cmd_line_index)
1137 header_field_info *hfinfo;
1138 char *fs_buf = NULL;
1139 char *fs_ptr = NULL;
1140 static GString *label_s = NULL;
1148 const true_false_string *tfstring = &tfs_true_false;
1150 hfinfo = finfo->hfinfo;
1153 label_s = g_string_new("");
1156 if(finfo->value.ftype->val_to_string_repr)
1159 * this field has an associated value,
1162 fs_len = fvalue_string_repr_len(&finfo->value, FTREPR_DFILTER, finfo->hfinfo->display);
1163 fs_buf = fvalue_to_string_repr(NULL, &finfo->value,
1164 FTREPR_DFILTER, finfo->hfinfo->display);
1167 /* String types are quoted. Remove them. */
1168 if (IS_FT_STRING(finfo->value.ftype->ftype) && fs_len > 2) {
1169 fs_buf[fs_len - 1] = '\0';
1174 if (string_fmts->len > 0 && finfo->hfinfo->strings) {
1175 g_string_truncate(label_s, 0);
1176 for (i = 0; i < string_fmts->len; i++) {
1177 sf = (string_fmt_t *)g_ptr_array_index(string_fmts, i);
1179 g_string_append(label_s, sf->plain);
1181 switch (sf->format) {
1183 g_string_append(label_s, hfinfo->name);
1186 g_string_append(label_s, fs_ptr);
1189 switch(hfinfo->type) {
1191 uvalue64 = fvalue_get_uinteger64(&finfo->value);
1192 tfstring = (const struct true_false_string*) hfinfo->strings;
1193 g_string_append(label_s, uvalue64 ? tfstring->true_string : tfstring->false_string);
1199 DISSECTOR_ASSERT(!hfinfo->bitmask);
1200 svalue = fvalue_get_sinteger(&finfo->value);
1201 if (hfinfo->display & BASE_RANGE_STRING) {
1202 g_string_append(label_s, rval_to_str_const(svalue, RVALS(hfinfo->strings), "Unknown"));
1203 } else if (hfinfo->display & BASE_EXT_STRING) {
1204 g_string_append(label_s, val_to_str_ext_const(svalue, (value_string_ext *) hfinfo->strings, "Unknown"));
1206 g_string_append(label_s, val_to_str_const(svalue, cVALS(hfinfo->strings), "Unknown"));
1209 case FT_INT40: /* XXX: Shouldn't these be as smart as FT_INT{8,16,24,32}? */
1213 DISSECTOR_ASSERT(!hfinfo->bitmask);
1214 svalue64 = (gint64)fvalue_get_sinteger64(&finfo->value);
1215 if (hfinfo->display & BASE_VAL64_STRING) {
1216 g_string_append(label_s, val64_to_str_const(svalue64, (const val64_string *)(hfinfo->strings), "Unknown"));
1223 DISSECTOR_ASSERT(!hfinfo->bitmask);
1224 uvalue = fvalue_get_uinteger(&finfo->value);
1225 if (!hfinfo->bitmask && hfinfo->display & BASE_RANGE_STRING) {
1226 g_string_append(label_s, rval_to_str_const(uvalue, RVALS(hfinfo->strings), "Unknown"));
1227 } else if (hfinfo->display & BASE_EXT_STRING) {
1228 g_string_append(label_s, val_to_str_ext_const(uvalue, (value_string_ext *) hfinfo->strings, "Unknown"));
1230 g_string_append(label_s, val_to_str_const(uvalue, cVALS(hfinfo->strings), "Unknown"));
1233 case FT_UINT40: /* XXX: Shouldn't these be as smart as FT_INT{8,16,24,32}? */
1237 DISSECTOR_ASSERT(!hfinfo->bitmask);
1238 uvalue64 = fvalue_get_uinteger64(&finfo->value);
1239 if (hfinfo->display & BASE_VAL64_STRING) {
1240 g_string_append(label_s, val64_to_str_const(uvalue64, (const val64_string *)(hfinfo->strings), "Unknown"));
1252 printf(" %d=\"%s\"", cmd_line_index, label_s->str);
1253 wmem_free(NULL, fs_buf);
1257 if(finfo->value.ftype->val_to_string_repr)
1259 printf(" %d=\"%s\"", cmd_line_index, fs_ptr);
1260 wmem_free(NULL, fs_buf);
1265 * This field doesn't have an associated value,
1269 printf(" %d=\"n.a.\"", cmd_line_index);
1274 protocolinfo_packet(void *prs, packet_info *pinfo _U_, epan_dissect_t *edt, const void *dummy _U_)
1276 pci_t *rs=(pci_t *)prs;
1280 gp=proto_get_finfo_ptr_array(edt->tree, rs->hf_index);
1287 * Print each occurrence of the field
1289 for (i = 0; i < gp->len; i++) {
1290 print_field_value((field_info *)gp->pdata[i], rs->cmd_line_index);
1296 int g_cmd_line_index = 0;
1299 * field must be persistent - we don't g_strdup() it below
1302 protocolinfo_init(char *field)
1305 header_field_info *hfi;
1306 GString *error_string;
1309 hfi=proto_registrar_get_byname(field);
1311 fprintf(stderr, "rawshark: Field \"%s\" doesn't exist.\n", field);
1315 field_display_to_string(hfi, hfibuf, sizeof(hfibuf));
1316 printf("%d %s %s - ",
1318 ftenum_to_string(hfi),
1321 rs=(pci_t *)g_malloc(sizeof(pci_t));
1322 rs->hf_index=hfi->id;
1324 rs->cmd_line_index = g_cmd_line_index++;
1326 error_string=register_tap_listener("frame", rs, rs->filter, TL_REQUIRES_PROTO_TREE, NULL, protocolinfo_packet, NULL);
1328 /* error, we failed to attach to the tap. complain and clean up */
1329 fprintf(stderr, "rawshark: Couldn't register field extraction tap: %s\n",
1331 g_string_free(error_string, TRUE);
1342 * Given a format string, split it into a GPtrArray of string_fmt_t structs
1343 * and fill in string_fmt_parts.
1347 add_string_fmt(string_fmt_e format, gchar *plain) {
1348 string_fmt_t *sf = (string_fmt_t *)g_malloc(sizeof(string_fmt_t));
1350 sf->format = format;
1351 sf->plain = g_strdup(plain);
1353 g_ptr_array_add(string_fmts, sf);
1357 parse_field_string_format(gchar *format) {
1358 GString *plain_s = g_string_new("");
1366 len = strlen(format);
1367 g_ptr_array_set_size(string_fmts, 0);
1370 if (format[pos] == '%') {
1371 if (pos >= len) { /* There should always be a following character */
1375 if (plain_s->len > 0) {
1376 add_string_fmt(SF_NONE, plain_s->str);
1377 g_string_truncate(plain_s, 0);
1379 switch (format[pos]) {
1381 add_string_fmt(SF_NAME, NULL);
1384 add_string_fmt(SF_NUMVAL, NULL);
1387 add_string_fmt(SF_STRVAL, NULL);
1390 g_string_append_c(plain_s, '%');
1392 default: /* Invalid format */
1396 g_string_append_c(plain_s, format[pos]);
1401 if (plain_s->len > 0) {
1402 add_string_fmt(SF_NONE, plain_s->str);
1404 g_string_free(plain_s, TRUE);
1408 /****************************************************************************************
1409 * END OF FIELD EXTRACTION ROUTINES
1410 ****************************************************************************************/
1413 show_print_file_io_error(int err)
1418 cmdarg_err("Not all the packets could be printed because there is "
1419 "no space left on the file system.");
1424 cmdarg_err("Not all the packets could be printed because you are "
1425 "too close to, or over your disk quota.");
1430 cmdarg_err("An error occurred while printing packets: %s.",
1437 * General errors and warnings are reported with an console message
1441 failure_warning_message(const char *msg_format, va_list ap)
1443 fprintf(stderr, "rawshark: ");
1444 vfprintf(stderr, msg_format, ap);
1445 fprintf(stderr, "\n");
1449 * Open/create errors are reported with an console message in Rawshark.
1452 open_failure_message(const char *filename, int err, gboolean for_writing)
1454 fprintf(stderr, "rawshark: ");
1455 fprintf(stderr, file_open_error_message(err, for_writing), filename);
1456 fprintf(stderr, "\n");
1459 static const nstime_t *
1460 raw_get_frame_ts(struct packet_provider_data *prov, guint32 frame_num)
1462 if (prov->ref && prov->ref->num == frame_num)
1463 return &prov->ref->abs_ts;
1465 if (prov->prev_dis && prov->prev_dis->num == frame_num)
1466 return &prov->prev_dis->abs_ts;
1468 if (prov->prev_cap && prov->prev_cap->num == frame_num)
1469 return &prov->prev_cap->abs_ts;
1475 raw_epan_new(capture_file *cf)
1477 static const struct packet_provider_funcs funcs = {
1479 cap_file_provider_get_interface_name,
1480 cap_file_provider_get_interface_description,
1484 return epan_new(&cf->provider, &funcs);
1488 raw_cf_open(capture_file *cf, const char *fname)
1490 if ((fd = raw_pipe_open(fname)) < 0)
1493 /* The open succeeded. Fill in the information for this file. */
1495 /* Create new epan session for dissection. */
1496 epan_free(cf->epan);
1497 cf->epan = raw_epan_new(cf);
1499 cf->provider.wth = NULL;
1500 cf->f_datalen = 0; /* not used, but set it anyway */
1502 /* Set the file name because we need it to set the follow stream filter.
1503 XXX - is that still true? We need it for other reasons, though,
1505 cf->filename = g_strdup(fname);
1507 /* Indicate whether it's a permanent or temporary file. */
1508 cf->is_tempfile = FALSE;
1510 /* No user changes yet. */
1511 cf->unsaved_changes = FALSE;
1513 cf->cd_t = WTAP_FILE_TYPE_SUBTYPE_UNKNOWN;
1514 cf->open_type = WTAP_TYPE_AUTO;
1516 cf->drops_known = FALSE;
1519 nstime_set_zero(&cf->elapsed_time);
1520 cf->provider.ref = NULL;
1521 cf->provider.prev_dis = NULL;
1522 cf->provider.prev_cap = NULL;
1528 * Read errors are reported with an console message in Rawshark.
1531 read_failure_message(const char *filename, int err)
1533 cmdarg_err("An error occurred while reading from the file \"%s\": %s.",
1534 filename, g_strerror(err));
1538 * Write errors are reported with an console message in Rawshark.
1541 write_failure_message(const char *filename, int err)
1543 cmdarg_err("An error occurred while writing to the file \"%s\": %s.",
1544 filename, g_strerror(err));
1548 * Report an error in command-line arguments.
1551 rawshark_cmdarg_err(const char *fmt, va_list ap)
1553 fprintf(stderr, "rawshark: ");
1554 vfprintf(stderr, fmt, ap);
1555 fprintf(stderr, "\n");
1559 * Report additional information for an error in command-line arguments.
1562 rawshark_cmdarg_err_cont(const char *fmt, va_list ap)
1564 vfprintf(stderr, fmt, ap);
1565 fprintf(stderr, "\n");
1574 * indent-tabs-mode: nil
1577 * ex: set shiftwidth=4 tabstop=8 expandtab:
1578 * :indentSize=4:tabSize=8:noTabs=true: