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 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation; either version 2
15 * of the License, or (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
28 * Rawshark does the following:
29 * - Opens a specified file or named pipe
30 * - Applies a specfied DLT or "decode as" encapsulation
31 * - Reads frames prepended with a libpcap packet header.
32 * - Prints a status line, followed by fields from a specified list.
49 #ifndef HAVE_GETOPT_LONG
50 #include "wsutil/wsgetopt.h"
54 #include <epan/epan-int.h>
55 #include <epan/epan.h>
57 #include <wsutil/cmdarg_err.h>
58 #include <wsutil/crash_info.h>
59 #include <wsutil/filesystem.h>
60 #include <wsutil/file_util.h>
61 #include <wsutil/plugins.h>
62 #include <wsutil/privileges.h>
63 #include <wsutil/report_err.h>
66 #include <epan/packet.h>
67 #include <epan/ftypes/ftypes-int.h>
69 #include "frame_tvbuff.h"
70 #include <epan/disabled_protos.h>
71 #include <epan/prefs.h>
72 #include <epan/column.h>
73 #include <epan/print.h>
74 #include <epan/addr_resolv.h>
76 #include "ui/capture_ui_utils.h"
80 #include "conditions.h"
81 #include "capture_stop_conditions.h"
82 #include <epan/epan_dissect.h>
83 #include <epan/stat_tap_ui.h>
84 #include <epan/timestamp.h>
85 #include <wsutil/unicode-utils.h>
86 #include "epan/column-utils.h"
87 #include "epan/proto.h"
90 #include <wiretap/wtap.h>
91 #include <wiretap/libpcap.h>
92 #include <wiretap/pcap-encap.h>
94 #include <wsutil/clopts_common.h>
95 #include <ws_version_info.h>
97 #include "caputils/capture-pcap-util.h"
106 #include "caputils/capture-wpcap.h"
108 #endif /* HAVE_LIBPCAP */
113 * This is the template for the decode as option; it is shared between the
114 * various functions that output the usage for this parameter.
116 static const gchar decode_as_arg_template[] = "<layer_type>==<selector>,<decode_as_protocol>";
119 static guint32 cum_bytes;
120 static const frame_data *ref;
121 static frame_data ref_frame;
122 static frame_data *prev_dis;
123 static frame_data prev_dis_frame;
124 static frame_data *prev_cap;
125 static frame_data prev_cap_frame;
128 * The way the packet decode is to be written.
131 WRITE_TEXT, /* summary or detail text */
132 WRITE_XML /* PDML or PSML */
133 /* Add CSV and the like here */
136 static gboolean line_buffered;
137 static print_format_e print_format = PR_FMT_TEXT;
139 static gboolean want_pcap_pkthdr;
141 cf_status_t raw_cf_open(capture_file *cf, const char *fname);
142 static gboolean load_cap_file(capture_file *cf);
143 static gboolean process_packet(capture_file *cf, epan_dissect_t *edt, gint64 offset,
144 struct wtap_pkthdr *whdr, const guchar *pd);
145 static void show_print_file_io_error(int err);
147 static void open_failure_message(const char *filename, int err,
148 gboolean for_writing);
149 static void failure_message(const char *msg_format, va_list ap);
150 static void read_failure_message(const char *filename, int err);
151 static void write_failure_message(const char *filename, int err);
152 static void rawshark_cmdarg_err(const char *fmt, va_list ap);
153 static void rawshark_cmdarg_err_cont(const char *fmt, va_list ap);
154 static void protocolinfo_init(char *field);
155 static gboolean parse_field_string_format(char *format);
158 SF_NONE, /* No format (placeholder) */
159 SF_NAME, /* %D Field name / description */
160 SF_NUMVAL, /* %N Numeric value */
161 SF_STRVAL /* %S String value */
164 typedef struct string_fmt_s {
166 string_fmt_e format; /* Valid if plain is NULL */
172 dfilter_t *rfcodes[64];
174 dfilter_t *rfieldfcodes[64];
177 GPtrArray *string_fmts;
180 print_usage(FILE *output)
182 fprintf(output, "\n");
183 fprintf(output, "Usage: rawshark [options] ...\n");
184 fprintf(output, "\n");
186 fprintf(output, "Input file:\n");
187 fprintf(output, " -r <infile> set the pipe or file name to read from\n");
189 fprintf(output, "\n");
190 fprintf(output, "Processing:\n");
191 fprintf(output, " -d <encap:linktype>|<proto:protoname>\n");
192 fprintf(output, " packet encapsulation or protocol\n");
193 fprintf(output, " -F <field> field to display\n");
194 fprintf(output, " -n disable all name resolution (def: all enabled)\n");
195 fprintf(output, " -N <name resolve flags> enable specific name resolution(s): \"mnNtd\"\n");
196 fprintf(output, " -p use the system's packet header format\n");
197 fprintf(output, " (which may have 64-bit timestamps)\n");
198 fprintf(output, " -R <read filter> packet filter in Wireshark display filter syntax\n");
199 fprintf(output, " -s skip PCAP header on input\n");
201 fprintf(output, "\n");
202 fprintf(output, "Output:\n");
203 fprintf(output, " -l flush output after each packet\n");
204 fprintf(output, " -S format string for fields\n");
205 fprintf(output, " (%%D - name, %%S - stringval, %%N numval)\n");
206 fprintf(output, " -t ad|a|r|d|dd|e output format of time stamps (def: r: rel. to first)\n");
208 fprintf(output, "\n");
209 fprintf(output, "Miscellaneous:\n");
210 fprintf(output, " -h display this help and exit\n");
211 fprintf(output, " -o <name>:<value> ... override preference setting\n");
212 fprintf(output, " -v display version info and exit\n");
216 log_func_ignore (const gchar *log_domain _U_, GLogLevelFlags log_level _U_,
217 const gchar *message _U_, gpointer user_data _U_)
222 * Open a pipe for raw input. This is a stripped-down version of
223 * pcap_loop.c:cap_pipe_open_live().
224 * We check if "pipe_name" is "-" (stdin) or a FIFO, and open it.
225 * @param pipe_name The name of the pipe or FIFO.
226 * @return A POSIX file descriptor on success, or -1 on failure.
229 raw_pipe_open(const char *pipe_name)
232 ws_statb64 pipe_stat;
234 char *pncopy, *pos = NULL;
241 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "open_raw_pipe: %s", pipe_name);
244 * XXX Rawshark blocks until we return
246 if (strcmp(pipe_name, "-") == 0) {
247 rfd = 0; /* read from stdin */
250 * This is needed to set the stdin pipe into binary mode, otherwise
251 * CR/LF are mangled...
253 _setmode(0, _O_BINARY);
257 if (ws_stat64(pipe_name, &pipe_stat) < 0) {
258 fprintf(stderr, "rawshark: The pipe %s could not be checked: %s\n",
259 pipe_name, g_strerror(errno));
262 if (! S_ISFIFO(pipe_stat.st_mode)) {
263 if (S_ISCHR(pipe_stat.st_mode)) {
265 * Assume the user specified an interface on a system where
266 * interfaces are in /dev. Pretend we haven't seen it.
270 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
275 rfd = ws_open(pipe_name, O_RDONLY | O_NONBLOCK, 0000 /* no creation so don't matter */);
277 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
278 pipe_name, g_strerror(errno));
282 #define PIPE_STR "\\pipe\\"
283 /* Under Windows, named pipes _must_ have the form
284 * "\\<server>\pipe\<pipe_name>". <server> may be "." for localhost.
286 pncopy = g_strdup(pipe_name);
287 if (strstr(pncopy, "\\\\") == pncopy) {
288 pos = strchr(pncopy + 3, '\\');
289 if (pos && g_ascii_strncasecmp(pos, PIPE_STR, strlen(PIPE_STR)) != 0)
296 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
301 /* Wait for the pipe to appear */
303 hPipe = CreateFile(utf_8to16(pipe_name), GENERIC_READ, 0, NULL,
304 OPEN_EXISTING, 0, NULL);
306 if (hPipe != INVALID_HANDLE_VALUE)
309 err = GetLastError();
310 if (err != ERROR_PIPE_BUSY) {
311 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
312 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
313 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s (error %lu)\n",
314 pipe_name, utf_16to8(err_str), err);
319 if (!WaitNamedPipe(utf_8to16(pipe_name), 30 * 1000)) {
320 err = GetLastError();
321 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
322 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
323 fprintf(stderr, "rawshark: \"%s\" could not be waited for: %s (error %lu)\n",
324 pipe_name, utf_16to8(err_str), err);
330 rfd = _open_osfhandle((intptr_t) hPipe, _O_RDONLY);
332 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
333 pipe_name, g_strerror(errno));
343 * Parse a link-type argument of the form "encap:<pcap linktype>" or
344 * "proto:<proto name>". "Pcap linktype" must be a name conforming to
345 * pcap_datalink_name_to_val() or an integer; the integer should be
346 * a LINKTYPE_ value supported by Wiretap. "Proto name" must be
347 * a protocol name, e.g. "http".
350 set_link_type(const char *lt_arg) {
351 char *spec_ptr = strchr(lt_arg, ':');
355 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) != PREFS_SET_OK) {
398 g_string_free(pref_str, TRUE);
401 g_string_free(pref_str, TRUE);
409 main(int argc, char *argv[])
411 GString *comp_info_str;
412 GString *runtime_info_str;
413 char *init_progfile_dir_error;
415 gboolean arg_error = FALSE;
421 char *gpf_path, *pf_path;
422 char *gdp_path, *dp_path;
423 int gpf_open_errno, gpf_read_errno;
424 int pf_open_errno, pf_read_errno;
425 int gdp_open_errno, gdp_read_errno;
426 int dp_open_errno, dp_read_errno;
427 gchar *pipe_name = NULL;
432 GPtrArray *disp_fields = g_ptr_array_new();
434 gboolean skip_pcap_header = FALSE;
435 static const struct option long_options[] = {
436 {"help", no_argument, NULL, 'h'},
437 {"version", no_argument, NULL, 'v'},
441 #define OPTSTRING_INIT "d:F:hlnN:o:pr:R:sS:t:v"
443 static const char optstring[] = OPTSTRING_INIT;
445 /* Set the C-language locale to the native environment. */
446 setlocale(LC_ALL, "");
448 cmdarg_err_init(rawshark_cmdarg_err, rawshark_cmdarg_err_cont);
450 /* Get the compile-time version information string */
451 comp_info_str = get_compiled_version_info(NULL, epan_get_compiled_version_info);
453 /* Get the run-time version information string */
454 runtime_info_str = get_runtime_version_info(NULL);
456 /* Add it to the information to be reported on a crash. */
457 ws_add_crash_info("Rawshark (Wireshark) %s\n"
462 get_ws_vcs_version_info(), comp_info_str->str, runtime_info_str->str);
465 arg_list_utf_16to8(argc, argv);
466 create_app_running_mutex();
470 * Get credential information for later use.
472 init_process_policies();
475 * Clear the filters arrays
477 memset(rfilters, 0, sizeof(rfilters));
478 memset(rfcodes, 0, sizeof(rfcodes));
483 * Initialize our string format
485 string_fmts = g_ptr_array_new();
488 * Attempt to get the pathname of the executable file.
490 init_progfile_dir_error = init_progfile_dir(argv[0], main);
491 if (init_progfile_dir_error != NULL) {
492 fprintf(stderr, "rawshark: Can't get pathname of rawshark program: %s.\n",
493 init_progfile_dir_error);
496 /* nothing more than the standard GLib handler, but without a warning */
498 G_LOG_LEVEL_WARNING |
499 G_LOG_LEVEL_MESSAGE |
503 g_log_set_handler(NULL,
504 (GLogLevelFlags)log_flags,
505 log_func_ignore, NULL /* user_data */);
506 g_log_set_handler(LOG_DOMAIN_CAPTURE_CHILD,
507 (GLogLevelFlags)log_flags,
508 log_func_ignore, NULL /* user_data */);
510 init_report_err(failure_message, 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);
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(register_all_protocols, register_all_protocol_handoffs,
525 prefs_p = read_prefs(&gpf_open_errno, &gpf_read_errno, &gpf_path,
526 &pf_open_errno, &pf_read_errno, &pf_path);
527 if (gpf_path != NULL) {
528 if (gpf_open_errno != 0) {
529 cmdarg_err("Can't open global preferences file \"%s\": %s.",
530 pf_path, g_strerror(gpf_open_errno));
532 if (gpf_read_errno != 0) {
533 cmdarg_err("I/O error reading global preferences file \"%s\": %s.",
534 pf_path, g_strerror(gpf_read_errno));
537 if (pf_path != NULL) {
538 if (pf_open_errno != 0) {
539 cmdarg_err("Can't open your preferences file \"%s\": %s.", pf_path,
540 g_strerror(pf_open_errno));
542 if (pf_read_errno != 0) {
543 cmdarg_err("I/O error reading your preferences file \"%s\": %s.",
544 pf_path, g_strerror(pf_read_errno));
550 /* Read the disabled protocols file. */
551 read_disabled_protos_list(&gdp_path, &gdp_open_errno, &gdp_read_errno,
552 &dp_path, &dp_open_errno, &dp_read_errno);
553 read_disabled_heur_dissector_list(&gdp_path, &gdp_open_errno, &gdp_read_errno,
554 &dp_path, &dp_open_errno, &dp_read_errno);
555 if (gdp_path != NULL) {
556 if (gdp_open_errno != 0) {
557 cmdarg_err("Could not open global disabled protocols file\n\"%s\": %s.",
558 gdp_path, g_strerror(gdp_open_errno));
560 if (gdp_read_errno != 0) {
561 cmdarg_err("I/O error reading global disabled protocols file\n\"%s\": %s.",
562 gdp_path, g_strerror(gdp_read_errno));
566 if (dp_path != NULL) {
567 if (dp_open_errno != 0) {
569 "Could not open your disabled protocols file\n\"%s\": %s.", dp_path,
570 g_strerror(dp_open_errno));
572 if (dp_read_errno != 0) {
574 "I/O error reading your disabled protocols file\n\"%s\": %s.", dp_path,
575 g_strerror(dp_read_errno));
581 ws_init_dll_search_path();
582 /* Load Wpcap, if possible */
586 cap_file_init(&cfile);
588 /* Print format defaults to this. */
589 print_format = PR_FMT_TEXT;
591 /* Initialize our encapsulation type */
592 encap = WTAP_ENCAP_UNKNOWN;
594 /* Now get our args */
595 /* XXX - We should probably have an option to dump libpcap link types */
596 while ((opt = getopt_long(argc, argv, optstring, long_options, NULL)) != -1) {
598 case 'd': /* Payload type */
599 if (!set_link_type(optarg)) {
600 cmdarg_err("Invalid link type or protocol \"%s\"", optarg);
604 case 'F': /* Read field to display */
605 g_ptr_array_add(disp_fields, g_strdup(optarg));
607 case 'h': /* Print help and exit */
608 printf("Rawshark (Wireshark) %s\n"
609 "Dump and analyze network traffic.\n"
610 "See https://www.wireshark.org for more information.\n",
611 get_ws_vcs_version_info());
615 case 'l': /* "Line-buffer" standard output */
616 /* This isn't line-buffering, strictly speaking, it's just
617 flushing the standard output after the information for
618 each packet is printed; however, that should be good
619 enough for all the purposes to which "-l" is put (and
620 is probably actually better for "-V", as it does fewer
623 See the comment in "process_packet()" for an explanation of
624 why we do that, and why we don't just use "setvbuf()" to
625 make the standard output line-buffered (short version: in
626 Windows, "line-buffered" is the same as "fully-buffered",
627 and the output buffer is only flushed when it fills up). */
628 line_buffered = TRUE;
630 case 'n': /* No name resolution */
631 disable_name_resolution();
633 case 'N': /* Select what types of addresses/port #s to resolve */
634 badopt = string_to_name_resolve(optarg, &gbl_resolv_flags);
635 if (badopt != '\0') {
636 cmdarg_err("-N specifies unknown resolving option '%c'; valid options are 'd', m', 'n', 'N', and 't'",
641 case 'o': /* Override preference from command line */
642 switch (prefs_set_pref(optarg)) {
647 case PREFS_SET_SYNTAX_ERR:
648 cmdarg_err("Invalid -o flag \"%s\"", optarg);
652 case PREFS_SET_NO_SUCH_PREF:
653 case PREFS_SET_OBSOLETE:
654 cmdarg_err("-o flag \"%s\" specifies unknown preference", optarg);
659 case 'p': /* Expect pcap_pkthdr packet headers, which may have 64-bit timestamps */
660 want_pcap_pkthdr = TRUE;
662 case 'r': /* Read capture file xxx */
663 pipe_name = g_strdup(optarg);
665 case 'R': /* Read file filter */
666 if(n_rfilters < (int) sizeof(rfilters) / (int) sizeof(rfilters[0])) {
667 rfilters[n_rfilters++] = optarg;
670 cmdarg_err("Too many display filters");
674 case 's': /* Skip PCAP header */
675 skip_pcap_header = TRUE;
677 case 'S': /* Print string representations */
678 if (!parse_field_string_format(optarg)) {
679 cmdarg_err("Invalid field string format");
683 case 't': /* Time stamp type */
684 if (strcmp(optarg, "r") == 0)
685 timestamp_set_type(TS_RELATIVE);
686 else if (strcmp(optarg, "a") == 0)
687 timestamp_set_type(TS_ABSOLUTE);
688 else if (strcmp(optarg, "ad") == 0)
689 timestamp_set_type(TS_ABSOLUTE_WITH_YMD);
690 else if (strcmp(optarg, "adoy") == 0)
691 timestamp_set_type(TS_ABSOLUTE_WITH_YDOY);
692 else if (strcmp(optarg, "d") == 0)
693 timestamp_set_type(TS_DELTA);
694 else if (strcmp(optarg, "dd") == 0)
695 timestamp_set_type(TS_DELTA_DIS);
696 else if (strcmp(optarg, "e") == 0)
697 timestamp_set_type(TS_EPOCH);
698 else if (strcmp(optarg, "u") == 0)
699 timestamp_set_type(TS_UTC);
700 else if (strcmp(optarg, "ud") == 0)
701 timestamp_set_type(TS_UTC_WITH_YMD);
702 else if (strcmp(optarg, "udoy") == 0)
703 timestamp_set_type(TS_UTC_WITH_YDOY);
705 cmdarg_err("Invalid time stamp type \"%s\"",
708 "It must be \"a\" for absolute, \"ad\" for absolute with YYYY-MM-DD date,");
710 "\"adoy\" for absolute with YYYY/DOY date, \"d\" for delta,");
712 "\"dd\" for delta displayed, \"e\" for epoch, \"r\" for relative,");
714 "\"u\" for absolute UTC, \"ud\" for absolute UTC with YYYY-MM-DD date,");
716 "or \"udoy\" for absolute UTC with YYYY/DOY date.");
720 case 'v': /* Show version and exit */
722 show_version("Rawshark (Wireshark)", comp_info_str, runtime_info_str);
723 g_string_free(comp_info_str, TRUE);
724 g_string_free(runtime_info_str, TRUE);
729 case '?': /* Bad flag - print usage message */
736 /* Notify all registered modules that have had any of their preferences
737 changed either from one of the preferences file or from the command
738 line that their preferences have changed.
739 Initialize preferences before display filters, otherwise modules
740 like MATE won't work. */
743 /* Initialize our display fields */
744 for (fc = 0; fc < disp_fields->len; fc++) {
745 protocolinfo_init((char *)g_ptr_array_index(disp_fields, fc));
747 g_ptr_array_free(disp_fields, TRUE);
751 /* If no capture filter or read filter has been specified, and there are
752 still command-line arguments, treat them as the tokens of a capture
753 filter (if no "-r" flag was specified) or a read filter (if a "-r"
754 flag was specified. */
756 if (pipe_name != NULL) {
757 if (n_rfilters != 0) {
758 cmdarg_err("Read filters were specified both with \"-R\" "
759 "and with additional command-line arguments");
762 rfilters[n_rfilters] = get_args_as_string(argc, argv, optind);
766 /* Make sure we got a dissector handle for our payload. */
767 if (encap == WTAP_ENCAP_UNKNOWN) {
768 cmdarg_err("No valid payload dissector specified.");
779 /* Start windows sockets */
780 WSAStartup( MAKEWORD( 1, 1 ), &wsaData );
783 /* At this point MATE will have registered its field array so we can
784 have a tap filter with one of MATE's late-registered fields as part
785 of the filter. We can now process all the "-z" arguments. */
786 start_requested_stats();
788 /* disabled protocols as per configuration file */
789 if (gdp_path == NULL && dp_path == NULL) {
790 set_disabled_protos_list();
791 set_disabled_heur_dissector_list();
794 /* Build the column format array */
795 build_column_format_array(&cfile.cinfo, prefs_p->num_cols, TRUE);
797 if (n_rfilters != 0) {
798 for (i = 0; i < n_rfilters; i++) {
801 if (!dfilter_compile(rfilters[i], &rfcodes[n_rfcodes], &err_msg)) {
802 cmdarg_err("%s", err_msg);
804 epan_free(cfile.epan);
817 * We're reading a pipe (or capture file).
821 * Immediately relinquish any special privileges we have; we must not
822 * be allowed to read any capture files the user running Rawshark
825 relinquish_special_privs_perm();
827 if (raw_cf_open(&cfile, pipe_name) != CF_OK) {
828 epan_free(cfile.epan);
836 /* Do we need to PCAP header and magic? */
837 if (skip_pcap_header) {
838 size_t bytes_left = sizeof(struct pcap_hdr) + sizeof(guint32);
839 gchar buf[sizeof(struct pcap_hdr) + sizeof(guint32)];
840 while (bytes_left != 0) {
841 ssize_t bytes = ws_read(fd, buf, (int)bytes_left);
843 cmdarg_err("Not enough bytes for pcap header.");
850 /* Process the packets in the file */
851 if (!load_cap_file(&cfile)) {
852 epan_free(cfile.epan);
860 /* If you want to capture live packets, use TShark. */
861 cmdarg_err("Input file or pipe name not specified.");
865 epan_free(cfile.epan);
874 * Read data from a raw pipe. The "raw" data consists of a libpcap
875 * packet header followed by the payload.
876 * @param pd [IN] A POSIX file descriptor. Because that's _exactly_ the sort
877 * of thing you want to use in Windows.
878 * @param phdr [OUT] Packet header information.
879 * @param err [OUT] Error indicator. Uses wiretap values.
880 * @param err_info [OUT] Error message.
881 * @param data_offset [OUT] data offset in the pipe.
882 * @return TRUE on success, FALSE on failure.
885 raw_pipe_read(struct wtap_pkthdr *phdr, guchar * pd, int *err, gchar **err_info, gint64 *data_offset) {
886 struct pcap_pkthdr mem_hdr;
887 struct pcaprec_hdr disk_hdr;
888 ssize_t bytes_read = 0;
889 size_t bytes_needed = sizeof(disk_hdr);
890 guchar *ptr = (guchar*) &disk_hdr;
892 if (want_pcap_pkthdr) {
893 bytes_needed = sizeof(mem_hdr);
894 ptr = (guchar*) &mem_hdr;
897 /* Copied from capture_loop.c */
898 while (bytes_needed > 0) {
899 bytes_read = ws_read(fd, ptr, (int)bytes_needed);
900 if (bytes_read == 0) {
904 } else if (bytes_read < 0) {
909 bytes_needed -= bytes_read;
910 *data_offset += bytes_read;
914 if (want_pcap_pkthdr) {
915 phdr->ts.secs = mem_hdr.ts.tv_sec;
916 phdr->ts.nsecs = (gint32)mem_hdr.ts.tv_usec * 1000;
917 phdr->caplen = mem_hdr.caplen;
918 phdr->len = mem_hdr.len;
920 phdr->ts.secs = disk_hdr.ts_sec;
921 phdr->ts.nsecs = disk_hdr.ts_usec * 1000;
922 phdr->caplen = disk_hdr.incl_len;
923 phdr->len = disk_hdr.orig_len;
925 bytes_needed = phdr->caplen;
927 phdr->pkt_encap = encap;
930 printf("mem_hdr: %lu disk_hdr: %lu\n", sizeof(mem_hdr), sizeof(disk_hdr));
931 printf("tv_sec: %u (%04x)\n", (unsigned int) phdr->ts.secs, (unsigned int) phdr->ts.secs);
932 printf("tv_nsec: %d (%04x)\n", phdr->ts.nsecs, phdr->ts.nsecs);
933 printf("caplen: %d (%04x)\n", phdr->caplen, phdr->caplen);
934 printf("len: %d (%04x)\n", phdr->len, phdr->len);
936 if (bytes_needed > WTAP_MAX_PACKET_SIZE) {
937 *err = WTAP_ERR_BAD_FILE;
938 *err_info = g_strdup_printf("Bad packet length: %lu\n",
939 (unsigned long) bytes_needed);
944 while (bytes_needed > 0) {
945 bytes_read = ws_read(fd, ptr, (int)bytes_needed);
946 if (bytes_read == 0) {
947 *err = WTAP_ERR_SHORT_READ;
950 } else if (bytes_read < 0) {
955 bytes_needed -= bytes_read;
956 *data_offset += bytes_read;
963 load_cap_file(capture_file *cf)
967 gint64 data_offset = 0;
969 guchar pd[WTAP_MAX_PACKET_SIZE];
970 struct wtap_pkthdr phdr;
973 wtap_phdr_init(&phdr);
975 epan_dissect_init(&edt, cf->epan, TRUE, FALSE);
977 while (raw_pipe_read(&phdr, pd, &err, &err_info, &data_offset)) {
978 process_packet(cf, &edt, data_offset, &phdr, pd);
981 epan_dissect_cleanup(&edt);
983 wtap_phdr_cleanup(&phdr);
986 /* Print a message noting that the read failed somewhere along the line. */
989 case WTAP_ERR_UNSUPPORTED:
990 cmdarg_err("The file \"%s\" contains record data that Rawshark doesn't support.\n(%s)",
992 err_info != NULL ? err_info : "no information supplied");
996 case WTAP_ERR_SHORT_READ:
997 cmdarg_err("The file \"%s\" appears to have been cut short in the middle of a packet.",
1001 case WTAP_ERR_BAD_FILE:
1002 cmdarg_err("The file \"%s\" appears to be damaged or corrupt.\n(%s)",
1004 err_info != NULL ? err_info : "no information supplied");
1008 case WTAP_ERR_DECOMPRESS:
1009 cmdarg_err("The compressed file \"%s\" appears to be damaged or corrupt.\n(%s)",
1011 err_info != NULL ? err_info : "no information supplied");
1016 cmdarg_err("An error occurred while reading the file \"%s\": %s.",
1017 cf->filename, wtap_strerror(err));
1027 process_packet(capture_file *cf, epan_dissect_t *edt, gint64 offset,
1028 struct wtap_pkthdr *whdr, const guchar *pd)
1036 /* The user sends an empty packet when he wants to get output from us even if we don't currently have
1037 packets to process. We spit out a line with the timestamp and the text "void"
1039 printf("%lu %lu %lu void -\n", (unsigned long int)cf->count,
1040 (unsigned long int)whdr->ts.secs,
1041 (unsigned long int)whdr->ts.nsecs);
1048 /* Count this packet. */
1051 /* If we're going to print packet information, or we're going to
1052 run a read filter, or we're going to process taps, set up to
1053 do a dissection and do so. */
1054 frame_data_init(&fdata, cf->count, whdr, offset, cum_bytes);
1058 /* If we're running a read filter, prime the epan_dissect_t with that
1060 if (n_rfilters > 0) {
1061 for(i = 0; i < n_rfcodes; i++) {
1062 epan_dissect_prime_dfilter(edt, rfcodes[i]);
1066 printf("%lu", (unsigned long int) cf->count);
1068 frame_data_set_before_dissect(&fdata, &cf->elapsed_time,
1071 if (ref == &fdata) {
1076 /* We only need the columns if we're printing packet info but we're
1077 *not* verbose; in verbose mode, we print the protocol tree, not
1078 the protocol summary. */
1079 epan_dissect_run_with_taps(edt, cf->cd_t, whdr, frame_tvbuff_new(&fdata, pd), &fdata, &cf->cinfo);
1081 frame_data_set_after_dissect(&fdata, &cum_bytes);
1082 prev_dis_frame = fdata;
1083 prev_dis = &prev_dis_frame;
1085 prev_cap_frame = fdata;
1086 prev_cap = &prev_cap_frame;
1088 for(i = 0; i < n_rfilters; i++) {
1089 /* Run the read filter if we have one. */
1091 passed = dfilter_apply_edt(rfcodes[i], edt);
1095 /* Print a one-line summary */
1096 printf(" %d", passed ? 1 : 0);
1101 /* The ANSI C standard does not appear to *require* that a line-buffered
1102 stream be flushed to the host environment whenever a newline is
1103 written, it just says that, on such a stream, characters "are
1104 intended to be transmitted to or from the host environment as a
1105 block when a new-line character is encountered".
1107 The Visual C++ 6.0 C implementation doesn't do what is intended;
1108 even if you set a stream to be line-buffered, it still doesn't
1109 flush the buffer at the end of every line.
1111 So, if the "-l" flag was specified, we flush the standard output
1112 at the end of a packet. This will do the right thing if we're
1113 printing packet summary lines, and, as we print the entire protocol
1114 tree for a single packet without waiting for anything to happen,
1115 it should be as good as line-buffered mode if we're printing
1116 protocol trees. (The whole reason for the "-l" flag in either
1117 tcpdump or Rawshark is to allow the output of a live capture to
1118 be piped to a program or script and to have that script see the
1119 information for the packet as soon as it's printed, rather than
1120 having to wait until a standard I/O buffer fills up. */
1124 if (ferror(stdout)) {
1125 show_print_file_io_error(errno);
1129 epan_dissect_reset(edt);
1130 frame_data_destroy(&fdata);
1135 /****************************************************************************************
1136 * FIELD EXTRACTION ROUTINES
1137 ****************************************************************************************/
1138 typedef struct _pci_t {
1144 static const char* ftenum_to_string(header_field_info *hfi)
1151 if (string_fmts->len > 0 && hfi->strings) {
1155 str = ftype_name(hfi->type);
1163 static void field_display_to_string(header_field_info *hfi, char* buf, int size)
1165 if (hfi->type != FT_BOOLEAN)
1167 g_strlcpy(buf, proto_field_display_to_string(hfi->display), size);
1171 g_snprintf(buf, size, "(Bit count: %d)", hfi->display);
1176 * Copied from various parts of proto.c
1178 #define FIELD_STR_INIT_LEN 256
1179 #define cVALS(x) (const value_string*)(x)
1180 static gboolean print_field_value(field_info *finfo, int cmd_line_index)
1182 header_field_info *hfinfo;
1183 char *fs_buf = NULL;
1184 char *fs_ptr = NULL;
1185 static GString *label_s = NULL;
1193 const true_false_string *tfstring = &tfs_true_false;
1195 hfinfo = finfo->hfinfo;
1198 label_s = g_string_new("");
1201 if(finfo->value.ftype->val_to_string_repr)
1204 * this field has an associated value,
1207 fs_len = fvalue_string_repr_len(&finfo->value, FTREPR_DFILTER, finfo->hfinfo->display);
1208 fs_buf = fvalue_to_string_repr(NULL, &finfo->value,
1209 FTREPR_DFILTER, finfo->hfinfo->display);
1212 /* String types are quoted. Remove them. */
1213 if (IS_FT_STRING(finfo->value.ftype->ftype) && fs_len > 2) {
1214 fs_buf[fs_len - 1] = '\0';
1219 if (string_fmts->len > 0 && finfo->hfinfo->strings) {
1220 g_string_truncate(label_s, 0);
1221 for (i = 0; i < string_fmts->len; i++) {
1222 sf = (string_fmt_t *)g_ptr_array_index(string_fmts, i);
1224 g_string_append(label_s, sf->plain);
1226 switch (sf->format) {
1228 g_string_append(label_s, hfinfo->name);
1231 g_string_append(label_s, fs_ptr);
1234 switch(hfinfo->type) {
1236 uvalue64 = fvalue_get_uinteger64(&finfo->value);
1237 tfstring = (const struct true_false_string*) hfinfo->strings;
1238 g_string_append(label_s, uvalue64 ? tfstring->true_string : tfstring->false_string);
1244 DISSECTOR_ASSERT(!hfinfo->bitmask);
1245 svalue = fvalue_get_sinteger(&finfo->value);
1246 if (hfinfo->display & BASE_RANGE_STRING) {
1247 g_string_append(label_s, rval_to_str_const(svalue, RVALS(hfinfo->strings), "Unknown"));
1248 } else if (hfinfo->display & BASE_EXT_STRING) {
1249 g_string_append(label_s, val_to_str_ext_const(svalue, (value_string_ext *) hfinfo->strings, "Unknown"));
1251 g_string_append(label_s, val_to_str_const(svalue, cVALS(hfinfo->strings), "Unknown"));
1254 case FT_INT40: /* XXX: Shouldn't these be as smart as FT_INT{8,16,24,32}? */
1258 DISSECTOR_ASSERT(!hfinfo->bitmask);
1259 svalue64 = (gint64)fvalue_get_sinteger64(&finfo->value);
1260 if (hfinfo->display & BASE_VAL64_STRING) {
1261 g_string_append(label_s, val64_to_str_const(svalue64, (const val64_string *)(hfinfo->strings), "Unknown"));
1268 DISSECTOR_ASSERT(!hfinfo->bitmask);
1269 uvalue = fvalue_get_uinteger(&finfo->value);
1270 if (!hfinfo->bitmask && hfinfo->display & BASE_RANGE_STRING) {
1271 g_string_append(label_s, rval_to_str_const(uvalue, RVALS(hfinfo->strings), "Unknown"));
1272 } else if (hfinfo->display & BASE_EXT_STRING) {
1273 g_string_append(label_s, val_to_str_ext_const(uvalue, (value_string_ext *) hfinfo->strings, "Unknown"));
1275 g_string_append(label_s, val_to_str_const(uvalue, cVALS(hfinfo->strings), "Unknown"));
1278 case FT_UINT40: /* XXX: Shouldn't these be as smart as FT_INT{8,16,24,32}? */
1282 DISSECTOR_ASSERT(!hfinfo->bitmask);
1283 uvalue64 = fvalue_get_uinteger64(&finfo->value);
1284 if (hfinfo->display & BASE_VAL64_STRING) {
1285 g_string_append(label_s, val64_to_str_const(uvalue64, (const val64_string *)(hfinfo->strings), "Unknown"));
1297 printf(" %d=\"%s\"", cmd_line_index, label_s->str);
1298 wmem_free(NULL, fs_buf);
1302 if(finfo->value.ftype->val_to_string_repr)
1304 printf(" %d=\"%s\"", cmd_line_index, fs_ptr);
1305 wmem_free(NULL, fs_buf);
1310 * This field doesn't have an associated value,
1314 printf(" %d=\"n.a.\"", cmd_line_index);
1319 protocolinfo_packet(void *prs, packet_info *pinfo _U_, epan_dissect_t *edt, const void *dummy _U_)
1321 pci_t *rs=(pci_t *)prs;
1325 gp=proto_get_finfo_ptr_array(edt->tree, rs->hf_index);
1332 * Print each occurrence of the field
1334 for (i = 0; i < gp->len; i++) {
1335 print_field_value((field_info *)gp->pdata[i], rs->cmd_line_index);
1341 int g_cmd_line_index = 0;
1344 * field must be persistent - we don't g_strdup() it below
1347 protocolinfo_init(char *field)
1350 header_field_info *hfi;
1351 GString *error_string;
1354 hfi=proto_registrar_get_byname(field);
1356 fprintf(stderr, "rawshark: Field \"%s\" doesn't exist.\n", field);
1360 field_display_to_string(hfi, hfibuf, sizeof(hfibuf));
1361 printf("%d %s %s - ",
1363 ftenum_to_string(hfi),
1366 rs=(pci_t *)g_malloc(sizeof(pci_t));
1367 rs->hf_index=hfi->id;
1369 rs->cmd_line_index = g_cmd_line_index++;
1371 error_string=register_tap_listener("frame", rs, rs->filter, TL_REQUIRES_PROTO_TREE, NULL, protocolinfo_packet, NULL);
1373 /* error, we failed to attach to the tap. complain and clean up */
1374 fprintf(stderr, "rawshark: Couldn't register field extraction tap: %s\n",
1376 g_string_free(error_string, TRUE);
1387 * Given a format string, split it into a GPtrArray of string_fmt_t structs
1388 * and fill in string_fmt_parts.
1392 add_string_fmt(string_fmt_e format, gchar *plain) {
1393 string_fmt_t *sf = (string_fmt_t *)g_malloc(sizeof(string_fmt_t));
1395 sf->format = format;
1396 sf->plain = g_strdup(plain);
1398 g_ptr_array_add(string_fmts, sf);
1402 parse_field_string_format(gchar *format) {
1403 GString *plain_s = g_string_new("");
1411 len = strlen(format);
1412 g_ptr_array_set_size(string_fmts, 0);
1415 if (format[pos] == '%') {
1416 if (pos >= len) { /* There should always be a following character */
1420 if (plain_s->len > 0) {
1421 add_string_fmt(SF_NONE, plain_s->str);
1422 g_string_truncate(plain_s, 0);
1424 switch (format[pos]) {
1426 add_string_fmt(SF_NAME, NULL);
1429 add_string_fmt(SF_NUMVAL, NULL);
1432 add_string_fmt(SF_STRVAL, NULL);
1435 g_string_append_c(plain_s, '%');
1437 default: /* Invalid format */
1441 g_string_append_c(plain_s, format[pos]);
1446 if (plain_s->len > 0) {
1447 add_string_fmt(SF_NONE, plain_s->str);
1449 g_string_free(plain_s, TRUE);
1453 /****************************************************************************************
1454 * END OF FIELD EXTRACTION ROUTINES
1455 ****************************************************************************************/
1458 show_print_file_io_error(int err)
1463 cmdarg_err("Not all the packets could be printed because there is "
1464 "no space left on the file system.");
1469 cmdarg_err("Not all the packets could be printed because you are "
1470 "too close to, or over your disk quota.");
1475 cmdarg_err("An error occurred while printing packets: %s.",
1482 * Open/create errors are reported with an console message in Rawshark.
1485 open_failure_message(const char *filename, int err, gboolean for_writing)
1487 fprintf(stderr, "rawshark: ");
1488 fprintf(stderr, file_open_error_message(err, for_writing), filename);
1489 fprintf(stderr, "\n");
1492 static const nstime_t *
1493 raw_get_frame_ts(void *data _U_, guint32 frame_num)
1495 if (ref && ref->num == frame_num)
1496 return &ref->abs_ts;
1498 if (prev_dis && prev_dis->num == frame_num)
1499 return &prev_dis->abs_ts;
1501 if (prev_cap && prev_cap->num == frame_num)
1502 return &prev_cap->abs_ts;
1508 raw_epan_new(capture_file *cf)
1510 epan_t *epan = epan_new();
1513 epan->get_frame_ts = raw_get_frame_ts;
1514 epan->get_interface_name = cap_file_get_interface_name;
1515 epan->get_user_comment = NULL;
1521 raw_cf_open(capture_file *cf, const char *fname)
1523 if ((fd = raw_pipe_open(fname)) < 0)
1526 /* The open succeeded. Fill in the information for this file. */
1528 /* Create new epan session for dissection. */
1529 epan_free(cf->epan);
1530 cf->epan = raw_epan_new(cf);
1533 cf->f_datalen = 0; /* not used, but set it anyway */
1535 /* Set the file name because we need it to set the follow stream filter.
1536 XXX - is that still true? We need it for other reasons, though,
1538 cf->filename = g_strdup(fname);
1540 /* Indicate whether it's a permanent or temporary file. */
1541 cf->is_tempfile = FALSE;
1543 /* No user changes yet. */
1544 cf->unsaved_changes = FALSE;
1546 cf->cd_t = WTAP_FILE_TYPE_SUBTYPE_UNKNOWN;
1547 cf->open_type = WTAP_TYPE_AUTO;
1549 cf->drops_known = FALSE;
1551 cf->has_snap = FALSE;
1552 cf->snap = WTAP_MAX_PACKET_SIZE;
1553 nstime_set_zero(&cf->elapsed_time);
1563 * General errors are reported with an console message in Rawshark.
1566 failure_message(const char *msg_format, va_list ap)
1568 fprintf(stderr, "rawshark: ");
1569 vfprintf(stderr, msg_format, ap);
1570 fprintf(stderr, "\n");
1574 * Read errors are reported with an console message in Rawshark.
1577 read_failure_message(const char *filename, int err)
1579 cmdarg_err("An error occurred while reading from the file \"%s\": %s.",
1580 filename, g_strerror(err));
1584 * Write errors are reported with an console message in Rawshark.
1587 write_failure_message(const char *filename, int err)
1589 cmdarg_err("An error occurred while writing to the file \"%s\": %s.",
1590 filename, g_strerror(err));
1594 * Report an error in command-line arguments.
1597 rawshark_cmdarg_err(const char *fmt, va_list ap)
1599 fprintf(stderr, "rawshark: ");
1600 vfprintf(stderr, fmt, ap);
1601 fprintf(stderr, "\n");
1605 * Report additional information for an error in command-line arguments.
1608 rawshark_cmdarg_err_cont(const char *fmt, va_list ap)
1610 vfprintf(stderr, fmt, ap);
1611 fprintf(stderr, "\n");
1620 * indent-tabs-mode: nil
1623 * ex: set shiftwidth=4 tabstop=8 expandtab:
1624 * :indentSize=4:tabSize=8:noTabs=true: