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 "conditions.h"
74 #include "capture_stop_conditions.h"
75 #include <epan/epan_dissect.h>
76 #include <epan/stat_tap_ui.h>
77 #include <epan/timestamp.h>
78 #include <wsutil/unicode-utils.h>
79 #include "epan/column-utils.h"
80 #include "epan/proto.h"
83 #include <wiretap/wtap.h>
84 #include <wiretap/libpcap.h>
85 #include <wiretap/pcap-encap.h>
87 #include <wsutil/clopts_common.h>
88 #include <version_info.h>
90 #include "caputils/capture-pcap-util.h"
97 #include "caputils/capture-wpcap.h"
99 #endif /* HAVE_LIBPCAP */
104 * This is the template for the decode as option; it is shared between the
105 * various functions that output the usage for this parameter.
107 static const gchar decode_as_arg_template[] = "<layer_type>==<selector>,<decode_as_protocol>";
110 #define INVALID_OPTION 1
112 #define INVALID_DFILTER 2
114 #define FORMAT_ERROR 2
118 static guint32 cum_bytes;
119 static frame_data ref_frame;
120 static frame_data prev_dis_frame;
121 static frame_data prev_cap_frame;
124 * The way the packet decode is to be written.
127 WRITE_TEXT, /* summary or detail text */
128 WRITE_XML /* PDML or PSML */
129 /* Add CSV and the like here */
132 static gboolean line_buffered;
133 static print_format_e print_format = PR_FMT_TEXT;
135 static gboolean want_pcap_pkthdr;
137 cf_status_t raw_cf_open(capture_file *cf, const char *fname);
138 static gboolean load_cap_file(capture_file *cf);
139 static gboolean process_packet(capture_file *cf, epan_dissect_t *edt, gint64 offset,
140 wtap_rec *rec, const guchar *pd);
141 static void show_print_file_io_error(int err);
143 static void failure_warning_message(const char *msg_format, va_list ap);
144 static void open_failure_message(const char *filename, int err,
145 gboolean for_writing);
146 static void read_failure_message(const char *filename, int err);
147 static void write_failure_message(const char *filename, int err);
148 static void rawshark_cmdarg_err(const char *fmt, va_list ap);
149 static void rawshark_cmdarg_err_cont(const char *fmt, va_list ap);
150 static void protocolinfo_init(char *field);
151 static gboolean parse_field_string_format(char *format);
154 SF_NONE, /* No format (placeholder) */
155 SF_NAME, /* %D Field name / description */
156 SF_NUMVAL, /* %N Numeric value */
157 SF_STRVAL /* %S String value */
160 typedef struct string_fmt_s {
162 string_fmt_e format; /* Valid if plain is NULL */
167 dfilter_t *rfcodes[64];
169 dfilter_t *rfieldfcodes[64];
172 GPtrArray *string_fmts;
175 print_usage(FILE *output)
177 fprintf(output, "\n");
178 fprintf(output, "Usage: rawshark [options] ...\n");
179 fprintf(output, "\n");
181 fprintf(output, "Input file:\n");
182 fprintf(output, " -r <infile> set the pipe or file name to read from\n");
184 fprintf(output, "\n");
185 fprintf(output, "Processing:\n");
186 fprintf(output, " -d <encap:linktype>|<proto:protoname>\n");
187 fprintf(output, " packet encapsulation or protocol\n");
188 fprintf(output, " -F <field> field to display\n");
190 fprintf(output, " -m virtual memory limit, in bytes\n");
192 fprintf(output, " -n disable all name resolution (def: all enabled)\n");
193 fprintf(output, " -N <name resolve flags> enable specific name resolution(s): \"mnNtdv\"\n");
194 fprintf(output, " -p use the system's packet header format\n");
195 fprintf(output, " (which may have 64-bit timestamps)\n");
196 fprintf(output, " -R <read filter> packet filter in Wireshark display filter syntax\n");
197 fprintf(output, " -s skip PCAP header on input\n");
199 fprintf(output, "\n");
200 fprintf(output, "Output:\n");
201 fprintf(output, " -l flush output after each packet\n");
202 fprintf(output, " -S format string for fields\n");
203 fprintf(output, " (%%D - name, %%S - stringval, %%N numval)\n");
204 fprintf(output, " -t ad|a|r|d|dd|e output format of time stamps (def: r: rel. to first)\n");
206 fprintf(output, "\n");
207 fprintf(output, "Miscellaneous:\n");
208 fprintf(output, " -h display this help and exit\n");
209 fprintf(output, " -o <name>:<value> ... override preference setting\n");
210 fprintf(output, " -v display version info and exit\n");
214 log_func_ignore (const gchar *log_domain _U_, GLogLevelFlags log_level _U_,
215 const gchar *message _U_, gpointer user_data _U_)
220 * Open a pipe for raw input. This is a stripped-down version of
221 * pcap_loop.c:cap_pipe_open_live().
222 * We check if "pipe_name" is "-" (stdin) or a FIFO, and open it.
223 * @param pipe_name The name of the pipe or FIFO.
224 * @return A POSIX file descriptor on success, or -1 on failure.
227 raw_pipe_open(const char *pipe_name)
230 ws_statb64 pipe_stat;
232 char *pncopy, *pos = NULL;
239 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "open_raw_pipe: %s", pipe_name);
242 * XXX Rawshark blocks until we return
244 if (strcmp(pipe_name, "-") == 0) {
245 rfd = 0; /* read from stdin */
248 * This is needed to set the stdin pipe into binary mode, otherwise
249 * CR/LF are mangled...
251 _setmode(0, _O_BINARY);
255 if (ws_stat64(pipe_name, &pipe_stat) < 0) {
256 fprintf(stderr, "rawshark: The pipe %s could not be checked: %s\n",
257 pipe_name, g_strerror(errno));
260 if (! S_ISFIFO(pipe_stat.st_mode)) {
261 if (S_ISCHR(pipe_stat.st_mode)) {
263 * Assume the user specified an interface on a system where
264 * interfaces are in /dev. Pretend we haven't seen it.
268 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
273 rfd = ws_open(pipe_name, O_RDONLY | O_NONBLOCK, 0000 /* no creation so don't matter */);
275 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
276 pipe_name, g_strerror(errno));
280 #define PIPE_STR "\\pipe\\"
281 /* Under Windows, named pipes _must_ have the form
282 * "\\<server>\pipe\<pipe_name>". <server> may be "." for localhost.
284 pncopy = g_strdup(pipe_name);
285 if (strstr(pncopy, "\\\\") == pncopy) {
286 pos = strchr(pncopy + 3, '\\');
287 if (pos && g_ascii_strncasecmp(pos, PIPE_STR, strlen(PIPE_STR)) != 0)
294 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
299 /* Wait for the pipe to appear */
301 hPipe = CreateFile(utf_8to16(pipe_name), GENERIC_READ, 0, NULL,
302 OPEN_EXISTING, 0, NULL);
304 if (hPipe != INVALID_HANDLE_VALUE)
307 err = GetLastError();
308 if (err != ERROR_PIPE_BUSY) {
309 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
310 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
311 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s (error %lu)\n",
312 pipe_name, utf_16to8(err_str), err);
317 if (!WaitNamedPipe(utf_8to16(pipe_name), 30 * 1000)) {
318 err = GetLastError();
319 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
320 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
321 fprintf(stderr, "rawshark: \"%s\" could not be waited for: %s (error %lu)\n",
322 pipe_name, utf_16to8(err_str), err);
328 rfd = _open_osfhandle((intptr_t) hPipe, _O_RDONLY);
330 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
331 pipe_name, g_strerror(errno));
341 * Parse a link-type argument of the form "encap:<pcap linktype>" or
342 * "proto:<proto name>". "Pcap linktype" must be a name conforming to
343 * pcap_datalink_name_to_val() or an integer; the integer should be
344 * a LINKTYPE_ value supported by Wiretap. "Proto name" must be
345 * a protocol name, e.g. "http".
348 set_link_type(const char *lt_arg) {
349 char *spec_ptr = strchr(lt_arg, ':');
353 dissector_handle_t dhandle;
362 if (strncmp(lt_arg, "encap:", strlen("encap:")) == 0) {
363 dlt_val = linktype_name_to_val(spec_ptr);
366 val = strtol(spec_ptr, &p, 10);
367 if (p == spec_ptr || *p != '\0' || errno != 0 || val > INT_MAX) {
373 * In those cases where a given link-layer header type
374 * has different LINKTYPE_ and DLT_ values, linktype_name_to_val()
375 * will return the OS's DLT_ value for that link-layer header
376 * type, not its OS-independent LINKTYPE_ value.
378 * On a given OS, wtap_pcap_encap_to_wtap_encap() should
379 * be able to map either LINKTYPE_ values or DLT_ values
380 * for the OS to the appropriate Wiretap encapsulation.
382 encap = wtap_pcap_encap_to_wtap_encap(dlt_val);
383 if (encap == WTAP_ENCAP_UNKNOWN) {
387 } else if (strncmp(lt_arg, "proto:", strlen("proto:")) == 0) {
388 dhandle = find_dissector(spec_ptr);
390 encap = WTAP_ENCAP_USER0;
391 pref_str = g_string_new("uat:user_dlts:");
392 /* This must match the format used in the user_dlts file */
393 g_string_append_printf(pref_str,
394 "\"User 0 (DLT=147)\",\"%s\",\"0\",\"\",\"0\",\"\"",
396 if (prefs_set_pref(pref_str->str, &errmsg) != PREFS_SET_OK) {
397 g_string_free(pref_str, TRUE);
401 g_string_free(pref_str, TRUE);
409 real_main(int argc, char *argv[])
411 GString *comp_info_str;
412 GString *runtime_info_str;
413 char *init_progfile_dir_error;
423 gchar *pipe_name = NULL;
428 GPtrArray *disp_fields = g_ptr_array_new();
430 gboolean skip_pcap_header = FALSE;
431 int ret = EXIT_SUCCESS;
432 static const struct option long_options[] = {
433 {"help", no_argument, NULL, 'h'},
434 {"version", no_argument, NULL, 'v'},
438 #define OPTSTRING_INIT "d:F:hlm:nN:o:pr:R:sS:t:v"
440 static const char optstring[] = OPTSTRING_INIT;
442 /* Set the C-language locale to the native environment. */
443 setlocale(LC_ALL, "");
445 cmdarg_err_init(rawshark_cmdarg_err, rawshark_cmdarg_err_cont);
447 /* Get the compile-time version information string */
448 comp_info_str = get_compiled_version_info(NULL, epan_get_compiled_version_info);
450 /* Get the run-time version information string */
451 runtime_info_str = get_runtime_version_info(NULL);
453 /* Add it to the information to be reported on a crash. */
454 ws_add_crash_info("Rawshark (Wireshark) %s\n"
459 get_ws_vcs_version_info(), comp_info_str->str, runtime_info_str->str);
462 create_app_running_mutex();
466 * Get credential information for later use.
468 init_process_policies();
471 * Clear the filters arrays
473 memset(rfilters, 0, sizeof(rfilters));
474 memset(rfcodes, 0, sizeof(rfcodes));
479 * Initialize our string format
481 string_fmts = g_ptr_array_new();
484 * Attempt to get the pathname of the directory containing the
487 init_progfile_dir_error = init_progfile_dir(argv[0]);
488 if (init_progfile_dir_error != NULL) {
489 fprintf(stderr, "rawshark: Can't get pathname of rawshark program: %s.\n",
490 init_progfile_dir_error);
493 /* nothing more than the standard GLib handler, but without a warning */
495 G_LOG_LEVEL_WARNING |
496 G_LOG_LEVEL_MESSAGE |
500 g_log_set_handler(NULL,
501 (GLogLevelFlags)log_flags,
502 log_func_ignore, NULL /* user_data */);
503 g_log_set_handler(LOG_DOMAIN_CAPTURE_CHILD,
504 (GLogLevelFlags)log_flags,
505 log_func_ignore, NULL /* user_data */);
507 init_report_message(failure_warning_message, failure_warning_message,
508 open_failure_message, read_failure_message,
509 write_failure_message);
511 timestamp_set_type(TS_RELATIVE);
512 timestamp_set_precision(TS_PREC_AUTO);
513 timestamp_set_seconds_type(TS_SECONDS_DEFAULT);
517 /* Register all dissectors; we must do this before checking for the
518 "-G" flag, as the "-G" flag dumps information registered by the
519 dissectors, and we must do it before we read the preferences, in
520 case any dissectors register preferences. */
521 if (!epan_init(NULL, NULL, TRUE)) {
526 /* Load libwireshark settings from the current profile. */
527 prefs_p = epan_load_settings();
530 ws_init_dll_search_path();
531 /* Load Wpcap, if possible */
535 cap_file_init(&cfile);
537 /* Print format defaults to this. */
538 print_format = PR_FMT_TEXT;
540 /* Initialize our encapsulation type */
541 encap = WTAP_ENCAP_UNKNOWN;
543 /* Now get our args */
544 /* XXX - We should probably have an option to dump libpcap link types */
545 while ((opt = getopt_long(argc, argv, optstring, long_options, NULL)) != -1) {
547 case 'd': /* Payload type */
548 if (!set_link_type(optarg)) {
549 cmdarg_err("Invalid link type or protocol \"%s\"", optarg);
550 ret = INVALID_OPTION;
554 case 'F': /* Read field to display */
555 g_ptr_array_add(disp_fields, g_strdup(optarg));
557 case 'h': /* Print help and exit */
558 printf("Rawshark (Wireshark) %s\n"
559 "Dump and analyze network traffic.\n"
560 "See https://www.wireshark.org for more information.\n",
561 get_ws_vcs_version_info());
565 case 'l': /* "Line-buffer" standard output */
566 /* This isn't line-buffering, strictly speaking, it's just
567 flushing the standard output after the information for
568 each packet is printed; however, that should be good
569 enough for all the purposes to which "-l" is put (and
570 is probably actually better for "-V", as it does fewer
573 See the comment in "process_packet()" for an explanation of
574 why we do that, and why we don't just use "setvbuf()" to
575 make the standard output line-buffered (short version: in
576 Windows, "line-buffered" is the same as "fully-buffered",
577 and the output buffer is only flushed when it fills up). */
578 line_buffered = TRUE;
582 limit.rlim_cur = get_positive_int(optarg, "memory limit");
583 limit.rlim_max = get_positive_int(optarg, "memory limit");
585 if(setrlimit(RLIMIT_AS, &limit) != 0) {
586 cmdarg_err("setrlimit() returned error");
587 ret = INVALID_OPTION;
592 case 'n': /* No name resolution */
593 disable_name_resolution();
595 case 'N': /* Select what types of addresses/port #s to resolve */
596 badopt = string_to_name_resolve(optarg, &gbl_resolv_flags);
597 if (badopt != '\0') {
598 cmdarg_err("-N specifies unknown resolving option '%c'; valid options are 'd', m', 'n', 'N', and 't'",
600 ret = INVALID_OPTION;
604 case 'o': /* Override preference from command line */
608 switch (prefs_set_pref(optarg, &errmsg)) {
613 case PREFS_SET_SYNTAX_ERR:
614 cmdarg_err("Invalid -o flag \"%s\"%s%s", optarg,
615 errmsg ? ": " : "", errmsg ? errmsg : "");
617 ret = INVALID_OPTION;
621 case PREFS_SET_NO_SUCH_PREF:
622 case PREFS_SET_OBSOLETE:
623 cmdarg_err("-o flag \"%s\" specifies unknown preference", optarg);
624 ret = INVALID_OPTION;
630 case 'p': /* Expect pcap_pkthdr packet headers, which may have 64-bit timestamps */
631 want_pcap_pkthdr = TRUE;
633 case 'r': /* Read capture file xxx */
634 pipe_name = g_strdup(optarg);
636 case 'R': /* Read file filter */
637 if(n_rfilters < (int) sizeof(rfilters) / (int) sizeof(rfilters[0])) {
638 rfilters[n_rfilters++] = optarg;
641 cmdarg_err("Too many display filters");
642 ret = INVALID_OPTION;
646 case 's': /* Skip PCAP header */
647 skip_pcap_header = TRUE;
649 case 'S': /* Print string representations */
650 if (!parse_field_string_format(optarg)) {
651 cmdarg_err("Invalid field string format");
652 ret = INVALID_OPTION;
656 case 't': /* Time stamp type */
657 if (strcmp(optarg, "r") == 0)
658 timestamp_set_type(TS_RELATIVE);
659 else if (strcmp(optarg, "a") == 0)
660 timestamp_set_type(TS_ABSOLUTE);
661 else if (strcmp(optarg, "ad") == 0)
662 timestamp_set_type(TS_ABSOLUTE_WITH_YMD);
663 else if (strcmp(optarg, "adoy") == 0)
664 timestamp_set_type(TS_ABSOLUTE_WITH_YDOY);
665 else if (strcmp(optarg, "d") == 0)
666 timestamp_set_type(TS_DELTA);
667 else if (strcmp(optarg, "dd") == 0)
668 timestamp_set_type(TS_DELTA_DIS);
669 else if (strcmp(optarg, "e") == 0)
670 timestamp_set_type(TS_EPOCH);
671 else if (strcmp(optarg, "u") == 0)
672 timestamp_set_type(TS_UTC);
673 else if (strcmp(optarg, "ud") == 0)
674 timestamp_set_type(TS_UTC_WITH_YMD);
675 else if (strcmp(optarg, "udoy") == 0)
676 timestamp_set_type(TS_UTC_WITH_YDOY);
678 cmdarg_err("Invalid time stamp type \"%s\"",
681 "It must be \"a\" for absolute, \"ad\" for absolute with YYYY-MM-DD date,");
683 "\"adoy\" for absolute with YYYY/DOY date, \"d\" for delta,");
685 "\"dd\" for delta displayed, \"e\" for epoch, \"r\" for relative,");
687 "\"u\" for absolute UTC, \"ud\" for absolute UTC with YYYY-MM-DD date,");
689 "or \"udoy\" for absolute UTC with YYYY/DOY date.");
690 ret = INVALID_OPTION;
694 case 'v': /* Show version and exit */
696 show_version("Rawshark (Wireshark)", comp_info_str, runtime_info_str);
700 case '?': /* Bad flag - print usage message */
702 ret = INVALID_OPTION;
707 /* Notify all registered modules that have had any of their preferences
708 changed either from one of the preferences file or from the command
709 line that their preferences have changed.
710 Initialize preferences before display filters, otherwise modules
711 like MATE won't work. */
714 /* Initialize our display fields */
715 for (fc = 0; fc < disp_fields->len; fc++) {
716 protocolinfo_init((char *)g_ptr_array_index(disp_fields, fc));
718 g_ptr_array_free(disp_fields, TRUE);
722 /* If no capture filter or read filter has been specified, and there are
723 still command-line arguments, treat them as the tokens of a capture
724 filter (if no "-r" flag was specified) or a read filter (if a "-r"
725 flag was specified. */
727 if (pipe_name != NULL) {
728 if (n_rfilters != 0) {
729 cmdarg_err("Read filters were specified both with \"-R\" "
730 "and with additional command-line arguments");
731 ret = INVALID_OPTION;
734 rfilters[n_rfilters] = get_args_as_string(argc, argv, optind);
738 /* Make sure we got a dissector handle for our payload. */
739 if (encap == WTAP_ENCAP_UNKNOWN) {
740 cmdarg_err("No valid payload dissector specified.");
741 ret = INVALID_OPTION;
746 /* Start windows sockets */
747 result = WSAStartup( MAKEWORD( 1, 1 ), &wsaData );
756 * Enabled and disabled protocols and heuristic dissectors as per
757 * command-line options.
759 setup_enabled_and_disabled_protocols();
761 /* Build the column format array */
762 build_column_format_array(&cfile.cinfo, prefs_p->num_cols, TRUE);
764 if (n_rfilters != 0) {
765 for (i = 0; i < n_rfilters; i++) {
768 if (!dfilter_compile(rfilters[i], &rfcodes[n_rfcodes], &err_msg)) {
769 cmdarg_err("%s", err_msg);
771 ret = INVALID_DFILTER;
780 * We're reading a pipe (or capture file).
784 * Immediately relinquish any special privileges we have; we must not
785 * be allowed to read any capture files the user running Rawshark
788 relinquish_special_privs_perm();
790 if (raw_cf_open(&cfile, pipe_name) != CF_OK) {
795 /* Do we need to PCAP header and magic? */
796 if (skip_pcap_header) {
797 unsigned int bytes_left = (unsigned int) sizeof(struct pcap_hdr) + sizeof(guint32);
798 gchar buf[sizeof(struct pcap_hdr) + sizeof(guint32)];
799 while (bytes_left != 0) {
800 ssize_t bytes = ws_read(fd, buf, bytes_left);
802 cmdarg_err("Not enough bytes for pcap header.");
806 bytes_left -= (unsigned int)bytes;
810 /* Process the packets in the file */
811 if (!load_cap_file(&cfile)) {
816 /* If you want to capture live packets, use TShark. */
817 cmdarg_err("Input file or pipe name not specified.");
824 g_string_free(comp_info_str, TRUE);
825 g_string_free(runtime_info_str, TRUE);
826 epan_free(cfile.epan);
835 wmain(int argc, wchar_t *wc_argv[])
839 argv = arg_list_utf_16to8(argc, wc_argv);
840 return real_main(argc, argv);
844 main(int argc, char *argv[])
846 return real_main(argc, argv);
851 * Read data from a raw pipe. The "raw" data consists of a libpcap
852 * packet header followed by the payload.
853 * @param pd [IN] A POSIX file descriptor. Because that's _exactly_ the sort
854 * of thing you want to use in Windows.
855 * @param err [OUT] Error indicator. Uses wiretap values.
856 * @param err_info [OUT] Error message.
857 * @param data_offset [OUT] data offset in the pipe.
858 * @return TRUE on success, FALSE on failure.
861 raw_pipe_read(wtap_rec *rec, guchar * pd, int *err, gchar **err_info, gint64 *data_offset) {
862 struct pcap_pkthdr mem_hdr;
863 struct pcaprec_hdr disk_hdr;
864 ssize_t bytes_read = 0;
865 unsigned int bytes_needed = (unsigned int) sizeof(disk_hdr);
866 guchar *ptr = (guchar*) &disk_hdr;
870 if (want_pcap_pkthdr) {
871 bytes_needed = sizeof(mem_hdr);
872 ptr = (guchar*) &mem_hdr;
876 * Newer versions of the VC runtime do parameter validation. If stdin
877 * has been closed, calls to _read, _get_osfhandle, et al will trigger
878 * the invalid parameter handler and crash.
879 * We could alternatively use ReadFile or set an invalid parameter
881 * We could also tell callers not to close stdin prematurely.
885 if (fd == 0 && GetHandleInformation(GetStdHandle(STD_INPUT_HANDLE), &ghi_flags) == 0) {
892 /* Copied from capture_loop.c */
893 while (bytes_needed > 0) {
894 bytes_read = ws_read(fd, ptr, bytes_needed);
895 if (bytes_read == 0) {
899 } else if (bytes_read < 0) {
904 bytes_needed -= (unsigned int)bytes_read;
905 *data_offset += bytes_read;
909 rec->rec_type = REC_TYPE_PACKET;
910 rec->presence_flags = WTAP_HAS_TS|WTAP_HAS_CAP_LEN;
911 if (want_pcap_pkthdr) {
912 rec->ts.secs = mem_hdr.ts.tv_sec;
913 rec->ts.nsecs = (gint32)mem_hdr.ts.tv_usec * 1000;
914 rec->rec_header.packet_header.caplen = mem_hdr.caplen;
915 rec->rec_header.packet_header.len = mem_hdr.len;
917 rec->ts.secs = disk_hdr.ts_sec;
918 rec->ts.nsecs = disk_hdr.ts_usec * 1000;
919 rec->rec_header.packet_header.caplen = disk_hdr.incl_len;
920 rec->rec_header.packet_header.len = disk_hdr.orig_len;
922 bytes_needed = rec->rec_header.packet_header.caplen;
924 rec->rec_header.packet_header.pkt_encap = encap;
927 printf("mem_hdr: %lu disk_hdr: %lu\n", sizeof(mem_hdr), sizeof(disk_hdr));
928 printf("tv_sec: %u (%04x)\n", (unsigned int) rec->ts.secs, (unsigned int) rec->ts.secs);
929 printf("tv_nsec: %d (%04x)\n", rec->ts.nsecs, rec->ts.nsecs);
930 printf("caplen: %d (%04x)\n", rec->rec_header.packet_header.caplen, rec->rec_header.packet_header.caplen);
931 printf("len: %d (%04x)\n", rec->rec_header.packet_header.len, rec->rec_header.packet_header.len);
933 if (bytes_needed > WTAP_MAX_PACKET_SIZE_STANDARD) {
934 *err = WTAP_ERR_BAD_FILE;
935 *err_info = g_strdup_printf("Bad packet length: %lu\n",
936 (unsigned long) bytes_needed);
941 while (bytes_needed > 0) {
942 bytes_read = ws_read(fd, ptr, bytes_needed);
943 if (bytes_read == 0) {
944 *err = WTAP_ERR_SHORT_READ;
947 } else if (bytes_read < 0) {
952 bytes_needed -= (unsigned int)bytes_read;
953 *data_offset += bytes_read;
960 load_cap_file(capture_file *cf)
963 gchar *err_info = NULL;
964 gint64 data_offset = 0;
972 epan_dissect_init(&edt, cf->epan, TRUE, FALSE);
974 pd = (guchar*)g_malloc(WTAP_MAX_PACKET_SIZE_STANDARD);
975 while (raw_pipe_read(&rec, pd, &err, &err_info, &data_offset)) {
976 process_packet(cf, &edt, data_offset, &rec, pd);
979 epan_dissect_cleanup(&edt);
981 wtap_rec_cleanup(&rec);
984 /* Print a message noting that the read failed somewhere along the line. */
985 cfile_read_failure_message("Rawshark", cf->filename, err, err_info);
993 process_packet(capture_file *cf, epan_dissect_t *edt, gint64 offset,
994 wtap_rec *rec, const guchar *pd)
1000 if(rec->rec_header.packet_header.len == 0)
1002 /* The user sends an empty packet when he wants to get output from us even if we don't currently have
1003 packets to process. We spit out a line with the timestamp and the text "void"
1005 printf("%lu %lu %lu void -\n", (unsigned long int)cf->count,
1006 (unsigned long int)rec->ts.secs,
1007 (unsigned long int)rec->ts.nsecs);
1014 /* Count this packet. */
1017 /* If we're going to print packet information, or we're going to
1018 run a read filter, or we're going to process taps, set up to
1019 do a dissection and do so. */
1020 frame_data_init(&fdata, cf->count, rec, offset, cum_bytes);
1024 /* If we're running a read filter, prime the epan_dissect_t with that
1026 if (n_rfilters > 0) {
1027 for(i = 0; i < n_rfcodes; i++) {
1028 epan_dissect_prime_with_dfilter(edt, rfcodes[i]);
1032 printf("%lu", (unsigned long int) cf->count);
1034 frame_data_set_before_dissect(&fdata, &cf->elapsed_time,
1035 &cf->provider.ref, cf->provider.prev_dis);
1037 if (cf->provider.ref == &fdata) {
1039 cf->provider.ref = &ref_frame;
1042 /* We only need the columns if we're printing packet info but we're
1043 *not* verbose; in verbose mode, we print the protocol tree, not
1044 the protocol summary. */
1045 epan_dissect_run_with_taps(edt, cf->cd_t, rec,
1046 frame_tvbuff_new(&cf->provider, &fdata, pd),
1047 &fdata, &cf->cinfo);
1049 frame_data_set_after_dissect(&fdata, &cum_bytes);
1050 prev_dis_frame = fdata;
1051 cf->provider.prev_dis = &prev_dis_frame;
1053 prev_cap_frame = fdata;
1054 cf->provider.prev_cap = &prev_cap_frame;
1056 for(i = 0; i < n_rfilters; i++) {
1057 /* Run the read filter if we have one. */
1059 passed = dfilter_apply_edt(rfcodes[i], edt);
1063 /* Print a one-line summary */
1064 printf(" %d", passed ? 1 : 0);
1069 /* The ANSI C standard does not appear to *require* that a line-buffered
1070 stream be flushed to the host environment whenever a newline is
1071 written, it just says that, on such a stream, characters "are
1072 intended to be transmitted to or from the host environment as a
1073 block when a new-line character is encountered".
1075 The Visual C++ 6.0 C implementation doesn't do what is intended;
1076 even if you set a stream to be line-buffered, it still doesn't
1077 flush the buffer at the end of every line.
1079 So, if the "-l" flag was specified, we flush the standard output
1080 at the end of a packet. This will do the right thing if we're
1081 printing packet summary lines, and, as we print the entire protocol
1082 tree for a single packet without waiting for anything to happen,
1083 it should be as good as line-buffered mode if we're printing
1084 protocol trees. (The whole reason for the "-l" flag in either
1085 tcpdump or Rawshark is to allow the output of a live capture to
1086 be piped to a program or script and to have that script see the
1087 information for the packet as soon as it's printed, rather than
1088 having to wait until a standard I/O buffer fills up. */
1092 if (ferror(stdout)) {
1093 show_print_file_io_error(errno);
1097 epan_dissect_reset(edt);
1098 frame_data_destroy(&fdata);
1103 /****************************************************************************************
1104 * FIELD EXTRACTION ROUTINES
1105 ****************************************************************************************/
1106 typedef struct _pci_t {
1112 static const char* ftenum_to_string(header_field_info *hfi)
1119 if (string_fmts->len > 0 && hfi->strings) {
1123 str = ftype_name(hfi->type);
1131 static void field_display_to_string(header_field_info *hfi, char* buf, int size)
1133 if (hfi->type != FT_BOOLEAN)
1135 g_strlcpy(buf, proto_field_display_to_string(hfi->display), size);
1139 g_snprintf(buf, size, "(Bit count: %d)", hfi->display);
1144 * Copied from various parts of proto.c
1146 #define FIELD_STR_INIT_LEN 256
1147 #define cVALS(x) (const value_string*)(x)
1148 static gboolean print_field_value(field_info *finfo, int cmd_line_index)
1150 header_field_info *hfinfo;
1151 char *fs_buf = NULL;
1152 char *fs_ptr = NULL;
1153 static GString *label_s = NULL;
1161 const true_false_string *tfstring = &tfs_true_false;
1163 hfinfo = finfo->hfinfo;
1166 label_s = g_string_new("");
1169 if(finfo->value.ftype->val_to_string_repr)
1172 * this field has an associated value,
1175 fs_len = fvalue_string_repr_len(&finfo->value, FTREPR_DFILTER, finfo->hfinfo->display);
1176 fs_buf = fvalue_to_string_repr(NULL, &finfo->value,
1177 FTREPR_DFILTER, finfo->hfinfo->display);
1180 /* String types are quoted. Remove them. */
1181 if (IS_FT_STRING(finfo->value.ftype->ftype) && fs_len > 2) {
1182 fs_buf[fs_len - 1] = '\0';
1187 if (string_fmts->len > 0 && finfo->hfinfo->strings) {
1188 g_string_truncate(label_s, 0);
1189 for (i = 0; i < string_fmts->len; i++) {
1190 sf = (string_fmt_t *)g_ptr_array_index(string_fmts, i);
1192 g_string_append(label_s, sf->plain);
1194 switch (sf->format) {
1196 g_string_append(label_s, hfinfo->name);
1199 g_string_append(label_s, fs_ptr);
1202 switch(hfinfo->type) {
1204 uvalue64 = fvalue_get_uinteger64(&finfo->value);
1205 tfstring = (const struct true_false_string*) hfinfo->strings;
1206 g_string_append(label_s, uvalue64 ? tfstring->true_string : tfstring->false_string);
1212 DISSECTOR_ASSERT(!hfinfo->bitmask);
1213 svalue = fvalue_get_sinteger(&finfo->value);
1214 if (hfinfo->display & BASE_RANGE_STRING) {
1215 g_string_append(label_s, rval_to_str_const(svalue, (const range_string *) hfinfo->strings, "Unknown"));
1216 } else if (hfinfo->display & BASE_EXT_STRING) {
1217 g_string_append(label_s, val_to_str_ext_const(svalue, (value_string_ext *) hfinfo->strings, "Unknown"));
1219 g_string_append(label_s, val_to_str_const(svalue, cVALS(hfinfo->strings), "Unknown"));
1222 case FT_INT40: /* XXX: Shouldn't these be as smart as FT_INT{8,16,24,32}? */
1226 DISSECTOR_ASSERT(!hfinfo->bitmask);
1227 svalue64 = (gint64)fvalue_get_sinteger64(&finfo->value);
1228 if (hfinfo->display & BASE_VAL64_STRING) {
1229 g_string_append(label_s, val64_to_str_const(svalue64, (const val64_string *)(hfinfo->strings), "Unknown"));
1236 DISSECTOR_ASSERT(!hfinfo->bitmask);
1237 uvalue = fvalue_get_uinteger(&finfo->value);
1238 if (!hfinfo->bitmask && hfinfo->display & BASE_RANGE_STRING) {
1239 g_string_append(label_s, rval_to_str_const(uvalue, (const range_string *) hfinfo->strings, "Unknown"));
1240 } else if (hfinfo->display & BASE_EXT_STRING) {
1241 g_string_append(label_s, val_to_str_ext_const(uvalue, (value_string_ext *) hfinfo->strings, "Unknown"));
1243 g_string_append(label_s, val_to_str_const(uvalue, cVALS(hfinfo->strings), "Unknown"));
1246 case FT_UINT40: /* XXX: Shouldn't these be as smart as FT_INT{8,16,24,32}? */
1250 DISSECTOR_ASSERT(!hfinfo->bitmask);
1251 uvalue64 = fvalue_get_uinteger64(&finfo->value);
1252 if (hfinfo->display & BASE_VAL64_STRING) {
1253 g_string_append(label_s, val64_to_str_const(uvalue64, (const val64_string *)(hfinfo->strings), "Unknown"));
1265 printf(" %d=\"%s\"", cmd_line_index, label_s->str);
1266 wmem_free(NULL, fs_buf);
1270 if(finfo->value.ftype->val_to_string_repr)
1272 printf(" %d=\"%s\"", cmd_line_index, fs_ptr);
1273 wmem_free(NULL, fs_buf);
1278 * This field doesn't have an associated value,
1282 printf(" %d=\"n.a.\"", cmd_line_index);
1287 protocolinfo_packet(void *prs, packet_info *pinfo _U_, epan_dissect_t *edt, const void *dummy _U_)
1289 pci_t *rs=(pci_t *)prs;
1293 gp=proto_get_finfo_ptr_array(edt->tree, rs->hf_index);
1300 * Print each occurrence of the field
1302 for (i = 0; i < gp->len; i++) {
1303 print_field_value((field_info *)gp->pdata[i], rs->cmd_line_index);
1309 int g_cmd_line_index = 0;
1312 * field must be persistent - we don't g_strdup() it below
1315 protocolinfo_init(char *field)
1318 header_field_info *hfi;
1319 GString *error_string;
1322 hfi=proto_registrar_get_byname(field);
1324 fprintf(stderr, "rawshark: Field \"%s\" doesn't exist.\n", field);
1328 field_display_to_string(hfi, hfibuf, sizeof(hfibuf));
1329 printf("%d %s %s - ",
1331 ftenum_to_string(hfi),
1334 rs=(pci_t *)g_malloc(sizeof(pci_t));
1335 rs->hf_index=hfi->id;
1337 rs->cmd_line_index = g_cmd_line_index++;
1339 error_string=register_tap_listener("frame", rs, rs->filter, TL_REQUIRES_PROTO_TREE, NULL, protocolinfo_packet, NULL, NULL);
1341 /* error, we failed to attach to the tap. complain and clean up */
1342 fprintf(stderr, "rawshark: Couldn't register field extraction tap: %s\n",
1344 g_string_free(error_string, TRUE);
1355 * Given a format string, split it into a GPtrArray of string_fmt_t structs
1356 * and fill in string_fmt_parts.
1360 add_string_fmt(string_fmt_e format, gchar *plain) {
1361 string_fmt_t *sf = (string_fmt_t *)g_malloc(sizeof(string_fmt_t));
1363 sf->format = format;
1364 sf->plain = g_strdup(plain);
1366 g_ptr_array_add(string_fmts, sf);
1370 parse_field_string_format(gchar *format) {
1371 GString *plain_s = g_string_new("");
1379 len = strlen(format);
1380 g_ptr_array_set_size(string_fmts, 0);
1383 if (format[pos] == '%') {
1384 if (pos >= len) { /* There should always be a following character */
1388 if (plain_s->len > 0) {
1389 add_string_fmt(SF_NONE, plain_s->str);
1390 g_string_truncate(plain_s, 0);
1392 switch (format[pos]) {
1394 add_string_fmt(SF_NAME, NULL);
1397 add_string_fmt(SF_NUMVAL, NULL);
1400 add_string_fmt(SF_STRVAL, NULL);
1403 g_string_append_c(plain_s, '%');
1405 default: /* Invalid format */
1409 g_string_append_c(plain_s, format[pos]);
1414 if (plain_s->len > 0) {
1415 add_string_fmt(SF_NONE, plain_s->str);
1417 g_string_free(plain_s, TRUE);
1421 /****************************************************************************************
1422 * END OF FIELD EXTRACTION ROUTINES
1423 ****************************************************************************************/
1426 show_print_file_io_error(int err)
1431 cmdarg_err("Not all the packets could be printed because there is "
1432 "no space left on the file system.");
1437 cmdarg_err("Not all the packets could be printed because you are "
1438 "too close to, or over your disk quota.");
1443 cmdarg_err("An error occurred while printing packets: %s.",
1450 * General errors and warnings are reported with an console message
1454 failure_warning_message(const char *msg_format, va_list ap)
1456 fprintf(stderr, "rawshark: ");
1457 vfprintf(stderr, msg_format, ap);
1458 fprintf(stderr, "\n");
1462 * Open/create errors are reported with an console message in Rawshark.
1465 open_failure_message(const char *filename, int err, gboolean for_writing)
1467 fprintf(stderr, "rawshark: ");
1468 fprintf(stderr, file_open_error_message(err, for_writing), filename);
1469 fprintf(stderr, "\n");
1472 static const nstime_t *
1473 raw_get_frame_ts(struct packet_provider_data *prov, guint32 frame_num)
1475 if (prov->ref && prov->ref->num == frame_num)
1476 return &prov->ref->abs_ts;
1478 if (prov->prev_dis && prov->prev_dis->num == frame_num)
1479 return &prov->prev_dis->abs_ts;
1481 if (prov->prev_cap && prov->prev_cap->num == frame_num)
1482 return &prov->prev_cap->abs_ts;
1488 raw_epan_new(capture_file *cf)
1490 static const struct packet_provider_funcs funcs = {
1492 cap_file_provider_get_interface_name,
1493 cap_file_provider_get_interface_description,
1497 return epan_new(&cf->provider, &funcs);
1501 raw_cf_open(capture_file *cf, const char *fname)
1503 if ((fd = raw_pipe_open(fname)) < 0)
1506 /* The open succeeded. Fill in the information for this file. */
1508 /* Create new epan session for dissection. */
1509 epan_free(cf->epan);
1510 cf->epan = raw_epan_new(cf);
1512 cf->provider.wth = NULL;
1513 cf->f_datalen = 0; /* not used, but set it anyway */
1515 /* Set the file name because we need it to set the follow stream filter.
1516 XXX - is that still true? We need it for other reasons, though,
1518 cf->filename = g_strdup(fname);
1520 /* Indicate whether it's a permanent or temporary file. */
1521 cf->is_tempfile = FALSE;
1523 /* No user changes yet. */
1524 cf->unsaved_changes = FALSE;
1526 cf->cd_t = WTAP_FILE_TYPE_SUBTYPE_UNKNOWN;
1527 cf->open_type = WTAP_TYPE_AUTO;
1529 cf->drops_known = FALSE;
1532 nstime_set_zero(&cf->elapsed_time);
1533 cf->provider.ref = NULL;
1534 cf->provider.prev_dis = NULL;
1535 cf->provider.prev_cap = NULL;
1541 * Read errors are reported with an console message in Rawshark.
1544 read_failure_message(const char *filename, int err)
1546 cmdarg_err("An error occurred while reading from the file \"%s\": %s.",
1547 filename, g_strerror(err));
1551 * Write errors are reported with an console message in Rawshark.
1554 write_failure_message(const char *filename, int err)
1556 cmdarg_err("An error occurred while writing to the file \"%s\": %s.",
1557 filename, g_strerror(err));
1561 * Report an error in command-line arguments.
1564 rawshark_cmdarg_err(const char *fmt, va_list ap)
1566 fprintf(stderr, "rawshark: ");
1567 vfprintf(stderr, fmt, ap);
1568 fprintf(stderr, "\n");
1572 * Report additional information for an error in command-line arguments.
1575 rawshark_cmdarg_err_cont(const char *fmt, va_list ap)
1577 vfprintf(stderr, fmt, ap);
1578 fprintf(stderr, "\n");
1587 * indent-tabs-mode: nil
1590 * ex: set shiftwidth=4 tabstop=8 expandtab:
1591 * :indentSize=4:tabSize=8:noTabs=true: