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 directory containing the
491 init_progfile_dir_error = init_progfile_dir(argv[0], main);
492 if (init_progfile_dir_error != NULL) {
493 fprintf(stderr, "rawshark: Can't get pathname of rawshark program: %s.\n",
494 init_progfile_dir_error);
497 /* nothing more than the standard GLib handler, but without a warning */
499 G_LOG_LEVEL_WARNING |
500 G_LOG_LEVEL_MESSAGE |
504 g_log_set_handler(NULL,
505 (GLogLevelFlags)log_flags,
506 log_func_ignore, NULL /* user_data */);
507 g_log_set_handler(LOG_DOMAIN_CAPTURE_CHILD,
508 (GLogLevelFlags)log_flags,
509 log_func_ignore, NULL /* user_data */);
511 init_report_err(failure_message, open_failure_message, read_failure_message,
512 write_failure_message);
514 timestamp_set_type(TS_RELATIVE);
515 timestamp_set_precision(TS_PREC_AUTO);
516 timestamp_set_seconds_type(TS_SECONDS_DEFAULT);
520 /* Register all dissectors; we must do this before checking for the
521 "-G" flag, as the "-G" flag dumps information registered by the
522 dissectors, and we must do it before we read the preferences, in
523 case any dissectors register preferences. */
524 if (!epan_init(register_all_protocols, register_all_protocol_handoffs,
528 prefs_p = read_prefs(&gpf_open_errno, &gpf_read_errno, &gpf_path,
529 &pf_open_errno, &pf_read_errno, &pf_path);
530 if (gpf_path != NULL) {
531 if (gpf_open_errno != 0) {
532 cmdarg_err("Can't open global preferences file \"%s\": %s.",
533 pf_path, g_strerror(gpf_open_errno));
535 if (gpf_read_errno != 0) {
536 cmdarg_err("I/O error reading global preferences file \"%s\": %s.",
537 pf_path, g_strerror(gpf_read_errno));
540 if (pf_path != NULL) {
541 if (pf_open_errno != 0) {
542 cmdarg_err("Can't open your preferences file \"%s\": %s.", pf_path,
543 g_strerror(pf_open_errno));
545 if (pf_read_errno != 0) {
546 cmdarg_err("I/O error reading your preferences file \"%s\": %s.",
547 pf_path, g_strerror(pf_read_errno));
553 /* Read the disabled protocols file. */
554 read_disabled_protos_list(&gdp_path, &gdp_open_errno, &gdp_read_errno,
555 &dp_path, &dp_open_errno, &dp_read_errno);
556 read_enabled_protos_list(&gdp_path, &gdp_open_errno, &gdp_read_errno,
557 &dp_path, &dp_open_errno, &dp_read_errno);
558 read_disabled_heur_dissector_list(&gdp_path, &gdp_open_errno, &gdp_read_errno,
559 &dp_path, &dp_open_errno, &dp_read_errno);
560 if (gdp_path != NULL) {
561 if (gdp_open_errno != 0) {
562 cmdarg_err("Could not open global disabled protocols file\n\"%s\": %s.",
563 gdp_path, g_strerror(gdp_open_errno));
565 if (gdp_read_errno != 0) {
566 cmdarg_err("I/O error reading global disabled protocols file\n\"%s\": %s.",
567 gdp_path, g_strerror(gdp_read_errno));
571 if (dp_path != NULL) {
572 if (dp_open_errno != 0) {
574 "Could not open your disabled protocols file\n\"%s\": %s.", dp_path,
575 g_strerror(dp_open_errno));
577 if (dp_read_errno != 0) {
579 "I/O error reading your disabled protocols file\n\"%s\": %s.", dp_path,
580 g_strerror(dp_read_errno));
586 ws_init_dll_search_path();
587 /* Load Wpcap, if possible */
591 cap_file_init(&cfile);
593 /* Print format defaults to this. */
594 print_format = PR_FMT_TEXT;
596 /* Initialize our encapsulation type */
597 encap = WTAP_ENCAP_UNKNOWN;
599 /* Now get our args */
600 /* XXX - We should probably have an option to dump libpcap link types */
601 while ((opt = getopt_long(argc, argv, optstring, long_options, NULL)) != -1) {
603 case 'd': /* Payload type */
604 if (!set_link_type(optarg)) {
605 cmdarg_err("Invalid link type or protocol \"%s\"", optarg);
609 case 'F': /* Read field to display */
610 g_ptr_array_add(disp_fields, g_strdup(optarg));
612 case 'h': /* Print help and exit */
613 printf("Rawshark (Wireshark) %s\n"
614 "Dump and analyze network traffic.\n"
615 "See https://www.wireshark.org for more information.\n",
616 get_ws_vcs_version_info());
620 case 'l': /* "Line-buffer" standard output */
621 /* This isn't line-buffering, strictly speaking, it's just
622 flushing the standard output after the information for
623 each packet is printed; however, that should be good
624 enough for all the purposes to which "-l" is put (and
625 is probably actually better for "-V", as it does fewer
628 See the comment in "process_packet()" for an explanation of
629 why we do that, and why we don't just use "setvbuf()" to
630 make the standard output line-buffered (short version: in
631 Windows, "line-buffered" is the same as "fully-buffered",
632 and the output buffer is only flushed when it fills up). */
633 line_buffered = TRUE;
635 case 'n': /* No name resolution */
636 disable_name_resolution();
638 case 'N': /* Select what types of addresses/port #s to resolve */
639 badopt = string_to_name_resolve(optarg, &gbl_resolv_flags);
640 if (badopt != '\0') {
641 cmdarg_err("-N specifies unknown resolving option '%c'; valid options are 'd', m', 'n', 'N', and 't'",
646 case 'o': /* Override preference from command line */
647 switch (prefs_set_pref(optarg)) {
652 case PREFS_SET_SYNTAX_ERR:
653 cmdarg_err("Invalid -o flag \"%s\"", optarg);
657 case PREFS_SET_NO_SUCH_PREF:
658 case PREFS_SET_OBSOLETE:
659 cmdarg_err("-o flag \"%s\" specifies unknown preference", optarg);
664 case 'p': /* Expect pcap_pkthdr packet headers, which may have 64-bit timestamps */
665 want_pcap_pkthdr = TRUE;
667 case 'r': /* Read capture file xxx */
668 pipe_name = g_strdup(optarg);
670 case 'R': /* Read file filter */
671 if(n_rfilters < (int) sizeof(rfilters) / (int) sizeof(rfilters[0])) {
672 rfilters[n_rfilters++] = optarg;
675 cmdarg_err("Too many display filters");
679 case 's': /* Skip PCAP header */
680 skip_pcap_header = TRUE;
682 case 'S': /* Print string representations */
683 if (!parse_field_string_format(optarg)) {
684 cmdarg_err("Invalid field string format");
688 case 't': /* Time stamp type */
689 if (strcmp(optarg, "r") == 0)
690 timestamp_set_type(TS_RELATIVE);
691 else if (strcmp(optarg, "a") == 0)
692 timestamp_set_type(TS_ABSOLUTE);
693 else if (strcmp(optarg, "ad") == 0)
694 timestamp_set_type(TS_ABSOLUTE_WITH_YMD);
695 else if (strcmp(optarg, "adoy") == 0)
696 timestamp_set_type(TS_ABSOLUTE_WITH_YDOY);
697 else if (strcmp(optarg, "d") == 0)
698 timestamp_set_type(TS_DELTA);
699 else if (strcmp(optarg, "dd") == 0)
700 timestamp_set_type(TS_DELTA_DIS);
701 else if (strcmp(optarg, "e") == 0)
702 timestamp_set_type(TS_EPOCH);
703 else if (strcmp(optarg, "u") == 0)
704 timestamp_set_type(TS_UTC);
705 else if (strcmp(optarg, "ud") == 0)
706 timestamp_set_type(TS_UTC_WITH_YMD);
707 else if (strcmp(optarg, "udoy") == 0)
708 timestamp_set_type(TS_UTC_WITH_YDOY);
710 cmdarg_err("Invalid time stamp type \"%s\"",
713 "It must be \"a\" for absolute, \"ad\" for absolute with YYYY-MM-DD date,");
715 "\"adoy\" for absolute with YYYY/DOY date, \"d\" for delta,");
717 "\"dd\" for delta displayed, \"e\" for epoch, \"r\" for relative,");
719 "\"u\" for absolute UTC, \"ud\" for absolute UTC with YYYY-MM-DD date,");
721 "or \"udoy\" for absolute UTC with YYYY/DOY date.");
725 case 'v': /* Show version and exit */
727 show_version("Rawshark (Wireshark)", comp_info_str, runtime_info_str);
728 g_string_free(comp_info_str, TRUE);
729 g_string_free(runtime_info_str, TRUE);
734 case '?': /* Bad flag - print usage message */
741 /* Notify all registered modules that have had any of their preferences
742 changed either from one of the preferences file or from the command
743 line that their preferences have changed.
744 Initialize preferences before display filters, otherwise modules
745 like MATE won't work. */
748 /* Initialize our display fields */
749 for (fc = 0; fc < disp_fields->len; fc++) {
750 protocolinfo_init((char *)g_ptr_array_index(disp_fields, fc));
752 g_ptr_array_free(disp_fields, TRUE);
756 /* If no capture filter or read filter has been specified, and there are
757 still command-line arguments, treat them as the tokens of a capture
758 filter (if no "-r" flag was specified) or a read filter (if a "-r"
759 flag was specified. */
761 if (pipe_name != NULL) {
762 if (n_rfilters != 0) {
763 cmdarg_err("Read filters were specified both with \"-R\" "
764 "and with additional command-line arguments");
767 rfilters[n_rfilters] = get_args_as_string(argc, argv, optind);
771 /* Make sure we got a dissector handle for our payload. */
772 if (encap == WTAP_ENCAP_UNKNOWN) {
773 cmdarg_err("No valid payload dissector specified.");
784 /* Start windows sockets */
785 WSAStartup( MAKEWORD( 1, 1 ), &wsaData );
788 /* At this point MATE will have registered its field array so we can
789 have a tap filter with one of MATE's late-registered fields as part
790 of the filter. We can now process all the "-z" arguments. */
791 start_requested_stats();
793 /* disabled protocols as per configuration file */
794 if (gdp_path == NULL && dp_path == NULL) {
795 set_disabled_protos_list();
796 set_enabled_protos_list();
797 set_disabled_heur_dissector_list();
800 /* Build the column format array */
801 build_column_format_array(&cfile.cinfo, prefs_p->num_cols, TRUE);
803 if (n_rfilters != 0) {
804 for (i = 0; i < n_rfilters; i++) {
807 if (!dfilter_compile(rfilters[i], &rfcodes[n_rfcodes], &err_msg)) {
808 cmdarg_err("%s", err_msg);
810 epan_free(cfile.epan);
823 * We're reading a pipe (or capture file).
827 * Immediately relinquish any special privileges we have; we must not
828 * be allowed to read any capture files the user running Rawshark
831 relinquish_special_privs_perm();
833 if (raw_cf_open(&cfile, pipe_name) != CF_OK) {
834 epan_free(cfile.epan);
842 /* Do we need to PCAP header and magic? */
843 if (skip_pcap_header) {
844 size_t bytes_left = sizeof(struct pcap_hdr) + sizeof(guint32);
845 gchar buf[sizeof(struct pcap_hdr) + sizeof(guint32)];
846 while (bytes_left != 0) {
847 ssize_t bytes = ws_read(fd, buf, (int)bytes_left);
849 cmdarg_err("Not enough bytes for pcap header.");
856 /* Process the packets in the file */
857 if (!load_cap_file(&cfile)) {
858 epan_free(cfile.epan);
866 /* If you want to capture live packets, use TShark. */
867 cmdarg_err("Input file or pipe name not specified.");
871 epan_free(cfile.epan);
880 * Read data from a raw pipe. The "raw" data consists of a libpcap
881 * packet header followed by the payload.
882 * @param pd [IN] A POSIX file descriptor. Because that's _exactly_ the sort
883 * of thing you want to use in Windows.
884 * @param phdr [OUT] Packet header information.
885 * @param err [OUT] Error indicator. Uses wiretap values.
886 * @param err_info [OUT] Error message.
887 * @param data_offset [OUT] data offset in the pipe.
888 * @return TRUE on success, FALSE on failure.
891 raw_pipe_read(struct wtap_pkthdr *phdr, guchar * pd, int *err, gchar **err_info, gint64 *data_offset) {
892 struct pcap_pkthdr mem_hdr;
893 struct pcaprec_hdr disk_hdr;
894 ssize_t bytes_read = 0;
895 size_t bytes_needed = sizeof(disk_hdr);
896 guchar *ptr = (guchar*) &disk_hdr;
898 if (want_pcap_pkthdr) {
899 bytes_needed = sizeof(mem_hdr);
900 ptr = (guchar*) &mem_hdr;
903 /* Copied from capture_loop.c */
904 while (bytes_needed > 0) {
905 bytes_read = ws_read(fd, ptr, (int)bytes_needed);
906 if (bytes_read == 0) {
910 } else if (bytes_read < 0) {
915 bytes_needed -= bytes_read;
916 *data_offset += bytes_read;
920 if (want_pcap_pkthdr) {
921 phdr->ts.secs = mem_hdr.ts.tv_sec;
922 phdr->ts.nsecs = (gint32)mem_hdr.ts.tv_usec * 1000;
923 phdr->caplen = mem_hdr.caplen;
924 phdr->len = mem_hdr.len;
926 phdr->ts.secs = disk_hdr.ts_sec;
927 phdr->ts.nsecs = disk_hdr.ts_usec * 1000;
928 phdr->caplen = disk_hdr.incl_len;
929 phdr->len = disk_hdr.orig_len;
931 bytes_needed = phdr->caplen;
933 phdr->pkt_encap = encap;
936 printf("mem_hdr: %lu disk_hdr: %lu\n", sizeof(mem_hdr), sizeof(disk_hdr));
937 printf("tv_sec: %u (%04x)\n", (unsigned int) phdr->ts.secs, (unsigned int) phdr->ts.secs);
938 printf("tv_nsec: %d (%04x)\n", phdr->ts.nsecs, phdr->ts.nsecs);
939 printf("caplen: %d (%04x)\n", phdr->caplen, phdr->caplen);
940 printf("len: %d (%04x)\n", phdr->len, phdr->len);
942 if (bytes_needed > WTAP_MAX_PACKET_SIZE) {
943 *err = WTAP_ERR_BAD_FILE;
944 *err_info = g_strdup_printf("Bad packet length: %lu\n",
945 (unsigned long) bytes_needed);
950 while (bytes_needed > 0) {
951 bytes_read = ws_read(fd, ptr, (int)bytes_needed);
952 if (bytes_read == 0) {
953 *err = WTAP_ERR_SHORT_READ;
956 } else if (bytes_read < 0) {
961 bytes_needed -= bytes_read;
962 *data_offset += bytes_read;
969 load_cap_file(capture_file *cf)
973 gint64 data_offset = 0;
975 guchar pd[WTAP_MAX_PACKET_SIZE];
976 struct wtap_pkthdr phdr;
979 wtap_phdr_init(&phdr);
981 epan_dissect_init(&edt, cf->epan, TRUE, FALSE);
983 while (raw_pipe_read(&phdr, pd, &err, &err_info, &data_offset)) {
984 process_packet(cf, &edt, data_offset, &phdr, pd);
987 epan_dissect_cleanup(&edt);
989 wtap_phdr_cleanup(&phdr);
992 /* Print a message noting that the read failed somewhere along the line. */
995 case WTAP_ERR_UNSUPPORTED:
996 cmdarg_err("The file \"%s\" contains record data that Rawshark doesn't support.\n(%s)",
998 err_info != NULL ? err_info : "no information supplied");
1002 case WTAP_ERR_SHORT_READ:
1003 cmdarg_err("The file \"%s\" appears to have been cut short in the middle of a packet.",
1007 case WTAP_ERR_BAD_FILE:
1008 cmdarg_err("The file \"%s\" appears to be damaged or corrupt.\n(%s)",
1010 err_info != NULL ? err_info : "no information supplied");
1014 case WTAP_ERR_DECOMPRESS:
1015 cmdarg_err("The compressed file \"%s\" appears to be damaged or corrupt.\n(%s)",
1017 err_info != NULL ? err_info : "no information supplied");
1022 cmdarg_err("An error occurred while reading the file \"%s\": %s.",
1023 cf->filename, wtap_strerror(err));
1033 process_packet(capture_file *cf, epan_dissect_t *edt, gint64 offset,
1034 struct wtap_pkthdr *whdr, const guchar *pd)
1042 /* The user sends an empty packet when he wants to get output from us even if we don't currently have
1043 packets to process. We spit out a line with the timestamp and the text "void"
1045 printf("%lu %lu %lu void -\n", (unsigned long int)cf->count,
1046 (unsigned long int)whdr->ts.secs,
1047 (unsigned long int)whdr->ts.nsecs);
1054 /* Count this packet. */
1057 /* If we're going to print packet information, or we're going to
1058 run a read filter, or we're going to process taps, set up to
1059 do a dissection and do so. */
1060 frame_data_init(&fdata, cf->count, whdr, offset, cum_bytes);
1064 /* If we're running a read filter, prime the epan_dissect_t with that
1066 if (n_rfilters > 0) {
1067 for(i = 0; i < n_rfcodes; i++) {
1068 epan_dissect_prime_dfilter(edt, rfcodes[i]);
1072 printf("%lu", (unsigned long int) cf->count);
1074 frame_data_set_before_dissect(&fdata, &cf->elapsed_time,
1077 if (ref == &fdata) {
1082 /* We only need the columns if we're printing packet info but we're
1083 *not* verbose; in verbose mode, we print the protocol tree, not
1084 the protocol summary. */
1085 epan_dissect_run_with_taps(edt, cf->cd_t, whdr, frame_tvbuff_new(&fdata, pd), &fdata, &cf->cinfo);
1087 frame_data_set_after_dissect(&fdata, &cum_bytes);
1088 prev_dis_frame = fdata;
1089 prev_dis = &prev_dis_frame;
1091 prev_cap_frame = fdata;
1092 prev_cap = &prev_cap_frame;
1094 for(i = 0; i < n_rfilters; i++) {
1095 /* Run the read filter if we have one. */
1097 passed = dfilter_apply_edt(rfcodes[i], edt);
1101 /* Print a one-line summary */
1102 printf(" %d", passed ? 1 : 0);
1107 /* The ANSI C standard does not appear to *require* that a line-buffered
1108 stream be flushed to the host environment whenever a newline is
1109 written, it just says that, on such a stream, characters "are
1110 intended to be transmitted to or from the host environment as a
1111 block when a new-line character is encountered".
1113 The Visual C++ 6.0 C implementation doesn't do what is intended;
1114 even if you set a stream to be line-buffered, it still doesn't
1115 flush the buffer at the end of every line.
1117 So, if the "-l" flag was specified, we flush the standard output
1118 at the end of a packet. This will do the right thing if we're
1119 printing packet summary lines, and, as we print the entire protocol
1120 tree for a single packet without waiting for anything to happen,
1121 it should be as good as line-buffered mode if we're printing
1122 protocol trees. (The whole reason for the "-l" flag in either
1123 tcpdump or Rawshark is to allow the output of a live capture to
1124 be piped to a program or script and to have that script see the
1125 information for the packet as soon as it's printed, rather than
1126 having to wait until a standard I/O buffer fills up. */
1130 if (ferror(stdout)) {
1131 show_print_file_io_error(errno);
1135 epan_dissect_reset(edt);
1136 frame_data_destroy(&fdata);
1141 /****************************************************************************************
1142 * FIELD EXTRACTION ROUTINES
1143 ****************************************************************************************/
1144 typedef struct _pci_t {
1150 static const char* ftenum_to_string(header_field_info *hfi)
1157 if (string_fmts->len > 0 && hfi->strings) {
1161 str = ftype_name(hfi->type);
1169 static void field_display_to_string(header_field_info *hfi, char* buf, int size)
1171 if (hfi->type != FT_BOOLEAN)
1173 g_strlcpy(buf, proto_field_display_to_string(hfi->display), size);
1177 g_snprintf(buf, size, "(Bit count: %d)", hfi->display);
1182 * Copied from various parts of proto.c
1184 #define FIELD_STR_INIT_LEN 256
1185 #define cVALS(x) (const value_string*)(x)
1186 static gboolean print_field_value(field_info *finfo, int cmd_line_index)
1188 header_field_info *hfinfo;
1189 char *fs_buf = NULL;
1190 char *fs_ptr = NULL;
1191 static GString *label_s = NULL;
1199 const true_false_string *tfstring = &tfs_true_false;
1201 hfinfo = finfo->hfinfo;
1204 label_s = g_string_new("");
1207 if(finfo->value.ftype->val_to_string_repr)
1210 * this field has an associated value,
1213 fs_len = fvalue_string_repr_len(&finfo->value, FTREPR_DFILTER, finfo->hfinfo->display);
1214 fs_buf = fvalue_to_string_repr(NULL, &finfo->value,
1215 FTREPR_DFILTER, finfo->hfinfo->display);
1218 /* String types are quoted. Remove them. */
1219 if (IS_FT_STRING(finfo->value.ftype->ftype) && fs_len > 2) {
1220 fs_buf[fs_len - 1] = '\0';
1225 if (string_fmts->len > 0 && finfo->hfinfo->strings) {
1226 g_string_truncate(label_s, 0);
1227 for (i = 0; i < string_fmts->len; i++) {
1228 sf = (string_fmt_t *)g_ptr_array_index(string_fmts, i);
1230 g_string_append(label_s, sf->plain);
1232 switch (sf->format) {
1234 g_string_append(label_s, hfinfo->name);
1237 g_string_append(label_s, fs_ptr);
1240 switch(hfinfo->type) {
1242 uvalue64 = fvalue_get_uinteger64(&finfo->value);
1243 tfstring = (const struct true_false_string*) hfinfo->strings;
1244 g_string_append(label_s, uvalue64 ? tfstring->true_string : tfstring->false_string);
1250 DISSECTOR_ASSERT(!hfinfo->bitmask);
1251 svalue = fvalue_get_sinteger(&finfo->value);
1252 if (hfinfo->display & BASE_RANGE_STRING) {
1253 g_string_append(label_s, rval_to_str_const(svalue, RVALS(hfinfo->strings), "Unknown"));
1254 } else if (hfinfo->display & BASE_EXT_STRING) {
1255 g_string_append(label_s, val_to_str_ext_const(svalue, (value_string_ext *) hfinfo->strings, "Unknown"));
1257 g_string_append(label_s, val_to_str_const(svalue, cVALS(hfinfo->strings), "Unknown"));
1260 case FT_INT40: /* XXX: Shouldn't these be as smart as FT_INT{8,16,24,32}? */
1264 DISSECTOR_ASSERT(!hfinfo->bitmask);
1265 svalue64 = (gint64)fvalue_get_sinteger64(&finfo->value);
1266 if (hfinfo->display & BASE_VAL64_STRING) {
1267 g_string_append(label_s, val64_to_str_const(svalue64, (const val64_string *)(hfinfo->strings), "Unknown"));
1274 DISSECTOR_ASSERT(!hfinfo->bitmask);
1275 uvalue = fvalue_get_uinteger(&finfo->value);
1276 if (!hfinfo->bitmask && hfinfo->display & BASE_RANGE_STRING) {
1277 g_string_append(label_s, rval_to_str_const(uvalue, RVALS(hfinfo->strings), "Unknown"));
1278 } else if (hfinfo->display & BASE_EXT_STRING) {
1279 g_string_append(label_s, val_to_str_ext_const(uvalue, (value_string_ext *) hfinfo->strings, "Unknown"));
1281 g_string_append(label_s, val_to_str_const(uvalue, cVALS(hfinfo->strings), "Unknown"));
1284 case FT_UINT40: /* XXX: Shouldn't these be as smart as FT_INT{8,16,24,32}? */
1288 DISSECTOR_ASSERT(!hfinfo->bitmask);
1289 uvalue64 = fvalue_get_uinteger64(&finfo->value);
1290 if (hfinfo->display & BASE_VAL64_STRING) {
1291 g_string_append(label_s, val64_to_str_const(uvalue64, (const val64_string *)(hfinfo->strings), "Unknown"));
1303 printf(" %d=\"%s\"", cmd_line_index, label_s->str);
1304 wmem_free(NULL, fs_buf);
1308 if(finfo->value.ftype->val_to_string_repr)
1310 printf(" %d=\"%s\"", cmd_line_index, fs_ptr);
1311 wmem_free(NULL, fs_buf);
1316 * This field doesn't have an associated value,
1320 printf(" %d=\"n.a.\"", cmd_line_index);
1325 protocolinfo_packet(void *prs, packet_info *pinfo _U_, epan_dissect_t *edt, const void *dummy _U_)
1327 pci_t *rs=(pci_t *)prs;
1331 gp=proto_get_finfo_ptr_array(edt->tree, rs->hf_index);
1338 * Print each occurrence of the field
1340 for (i = 0; i < gp->len; i++) {
1341 print_field_value((field_info *)gp->pdata[i], rs->cmd_line_index);
1347 int g_cmd_line_index = 0;
1350 * field must be persistent - we don't g_strdup() it below
1353 protocolinfo_init(char *field)
1356 header_field_info *hfi;
1357 GString *error_string;
1360 hfi=proto_registrar_get_byname(field);
1362 fprintf(stderr, "rawshark: Field \"%s\" doesn't exist.\n", field);
1366 field_display_to_string(hfi, hfibuf, sizeof(hfibuf));
1367 printf("%d %s %s - ",
1369 ftenum_to_string(hfi),
1372 rs=(pci_t *)g_malloc(sizeof(pci_t));
1373 rs->hf_index=hfi->id;
1375 rs->cmd_line_index = g_cmd_line_index++;
1377 error_string=register_tap_listener("frame", rs, rs->filter, TL_REQUIRES_PROTO_TREE, NULL, protocolinfo_packet, NULL);
1379 /* error, we failed to attach to the tap. complain and clean up */
1380 fprintf(stderr, "rawshark: Couldn't register field extraction tap: %s\n",
1382 g_string_free(error_string, TRUE);
1393 * Given a format string, split it into a GPtrArray of string_fmt_t structs
1394 * and fill in string_fmt_parts.
1398 add_string_fmt(string_fmt_e format, gchar *plain) {
1399 string_fmt_t *sf = (string_fmt_t *)g_malloc(sizeof(string_fmt_t));
1401 sf->format = format;
1402 sf->plain = g_strdup(plain);
1404 g_ptr_array_add(string_fmts, sf);
1408 parse_field_string_format(gchar *format) {
1409 GString *plain_s = g_string_new("");
1417 len = strlen(format);
1418 g_ptr_array_set_size(string_fmts, 0);
1421 if (format[pos] == '%') {
1422 if (pos >= len) { /* There should always be a following character */
1426 if (plain_s->len > 0) {
1427 add_string_fmt(SF_NONE, plain_s->str);
1428 g_string_truncate(plain_s, 0);
1430 switch (format[pos]) {
1432 add_string_fmt(SF_NAME, NULL);
1435 add_string_fmt(SF_NUMVAL, NULL);
1438 add_string_fmt(SF_STRVAL, NULL);
1441 g_string_append_c(plain_s, '%');
1443 default: /* Invalid format */
1447 g_string_append_c(plain_s, format[pos]);
1452 if (plain_s->len > 0) {
1453 add_string_fmt(SF_NONE, plain_s->str);
1455 g_string_free(plain_s, TRUE);
1459 /****************************************************************************************
1460 * END OF FIELD EXTRACTION ROUTINES
1461 ****************************************************************************************/
1464 show_print_file_io_error(int err)
1469 cmdarg_err("Not all the packets could be printed because there is "
1470 "no space left on the file system.");
1475 cmdarg_err("Not all the packets could be printed because you are "
1476 "too close to, or over your disk quota.");
1481 cmdarg_err("An error occurred while printing packets: %s.",
1488 * Open/create errors are reported with an console message in Rawshark.
1491 open_failure_message(const char *filename, int err, gboolean for_writing)
1493 fprintf(stderr, "rawshark: ");
1494 fprintf(stderr, file_open_error_message(err, for_writing), filename);
1495 fprintf(stderr, "\n");
1498 static const nstime_t *
1499 raw_get_frame_ts(void *data _U_, guint32 frame_num)
1501 if (ref && ref->num == frame_num)
1502 return &ref->abs_ts;
1504 if (prev_dis && prev_dis->num == frame_num)
1505 return &prev_dis->abs_ts;
1507 if (prev_cap && prev_cap->num == frame_num)
1508 return &prev_cap->abs_ts;
1514 raw_epan_new(capture_file *cf)
1516 epan_t *epan = epan_new();
1519 epan->get_frame_ts = raw_get_frame_ts;
1520 epan->get_interface_name = cap_file_get_interface_name;
1521 epan->get_user_comment = NULL;
1527 raw_cf_open(capture_file *cf, const char *fname)
1529 if ((fd = raw_pipe_open(fname)) < 0)
1532 /* The open succeeded. Fill in the information for this file. */
1534 /* Create new epan session for dissection. */
1535 epan_free(cf->epan);
1536 cf->epan = raw_epan_new(cf);
1539 cf->f_datalen = 0; /* not used, but set it anyway */
1541 /* Set the file name because we need it to set the follow stream filter.
1542 XXX - is that still true? We need it for other reasons, though,
1544 cf->filename = g_strdup(fname);
1546 /* Indicate whether it's a permanent or temporary file. */
1547 cf->is_tempfile = FALSE;
1549 /* No user changes yet. */
1550 cf->unsaved_changes = FALSE;
1552 cf->cd_t = WTAP_FILE_TYPE_SUBTYPE_UNKNOWN;
1553 cf->open_type = WTAP_TYPE_AUTO;
1555 cf->drops_known = FALSE;
1557 cf->has_snap = FALSE;
1558 cf->snap = WTAP_MAX_PACKET_SIZE;
1559 nstime_set_zero(&cf->elapsed_time);
1569 * General errors are reported with an console message in Rawshark.
1572 failure_message(const char *msg_format, va_list ap)
1574 fprintf(stderr, "rawshark: ");
1575 vfprintf(stderr, msg_format, ap);
1576 fprintf(stderr, "\n");
1580 * Read errors are reported with an console message in Rawshark.
1583 read_failure_message(const char *filename, int err)
1585 cmdarg_err("An error occurred while reading from the file \"%s\": %s.",
1586 filename, g_strerror(err));
1590 * Write errors are reported with an console message in Rawshark.
1593 write_failure_message(const char *filename, int err)
1595 cmdarg_err("An error occurred while writing to the file \"%s\": %s.",
1596 filename, g_strerror(err));
1600 * Report an error in command-line arguments.
1603 rawshark_cmdarg_err(const char *fmt, va_list ap)
1605 fprintf(stderr, "rawshark: ");
1606 vfprintf(stderr, fmt, ap);
1607 fprintf(stderr, "\n");
1611 * Report additional information for an error in command-line arguments.
1614 rawshark_cmdarg_err_cont(const char *fmt, va_list ap)
1616 vfprintf(stderr, fmt, ap);
1617 fprintf(stderr, "\n");
1626 * indent-tabs-mode: nil
1629 * ex: set shiftwidth=4 tabstop=8 expandtab:
1630 * :indentSize=4:tabSize=8:noTabs=true: