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.
59 #ifdef HAVE_SYS_STAT_H
60 # include <sys/stat.h>
64 #include "wsutil/wsgetopt.h"
68 #include <epan/epan-int.h>
69 #include <epan/epan.h>
71 #include <wsutil/cmdarg_err.h>
72 #include <wsutil/crash_info.h>
73 #include <wsutil/privileges.h>
74 #include <wsutil/file_util.h>
75 #include <wsutil/filesystem.h>
76 #include <wsutil/plugins.h>
77 #include <wsutil/report_err.h>
78 #include <wsutil/copyright_info.h>
81 #include <epan/packet.h>
82 #include <epan/ftypes/ftypes-int.h>
84 #include "frame_tvbuff.h"
85 #include <epan/disabled_protos.h>
86 #include <epan/prefs.h>
87 #include <epan/column.h>
88 #include <epan/print.h>
89 #include <epan/addr_resolv.h>
91 #include "ui/capture_ui_utils.h"
94 #include "version_info.h"
96 #include "conditions.h"
97 #include "capture_stop_conditions.h"
98 #include <epan/epan_dissect.h>
99 #include <epan/stat_tap_ui.h>
100 #include <epan/timestamp.h>
101 #include <wsutil/unicode-utils.h>
102 #include "epan/column-utils.h"
103 #include "epan/proto.h"
104 #include <epan/tap.h>
106 #include <wiretap/wtap.h>
107 #include <wiretap/libpcap.h>
108 #include <wiretap/pcap-encap.h>
110 #include <wsutil/clopts_common.h>
111 #include <wsutil/ws_version_info.h>
113 #include "caputils/capture-pcap-util.h"
118 #include "caputils/capture-wpcap.h"
120 #endif /* HAVE_LIBPCAP */
124 #include <wsutil/unicode-utils.h>
129 * This is the template for the decode as option; it is shared between the
130 * various functions that output the usage for this parameter.
132 static const gchar decode_as_arg_template[] = "<layer_type>==<selector>,<decode_as_protocol>";
135 static guint32 cum_bytes;
136 static const frame_data *ref;
137 static frame_data ref_frame;
138 static frame_data *prev_dis;
139 static frame_data prev_dis_frame;
140 static frame_data *prev_cap;
141 static frame_data prev_cap_frame;
144 * The way the packet decode is to be written.
147 WRITE_TEXT, /* summary or detail text */
148 WRITE_XML /* PDML or PSML */
149 /* Add CSV and the like here */
152 static gboolean line_buffered;
153 static print_format_e print_format = PR_FMT_TEXT;
155 static gboolean want_pcap_pkthdr;
157 cf_status_t raw_cf_open(capture_file *cf, const char *fname);
158 static gboolean load_cap_file(capture_file *cf);
159 static gboolean process_packet(capture_file *cf, epan_dissect_t *edt, gint64 offset,
160 struct wtap_pkthdr *whdr, const guchar *pd);
161 static void show_print_file_io_error(int err);
163 static void open_failure_message(const char *filename, int err,
164 gboolean for_writing);
165 static void failure_message(const char *msg_format, va_list ap);
166 static void read_failure_message(const char *filename, int err);
167 static void write_failure_message(const char *filename, int err);
168 static void rawshark_cmdarg_err(const char *fmt, va_list ap);
169 static void rawshark_cmdarg_err_cont(const char *fmt, va_list ap);
170 static void protocolinfo_init(char *field);
171 static gboolean parse_field_string_format(char *format);
174 SF_NONE, /* No format (placeholder) */
175 SF_NAME, /* %D Field name / description */
176 SF_NUMVAL, /* %N Numeric value */
177 SF_STRVAL /* %S String value */
180 typedef struct string_fmt_s {
182 string_fmt_e format; /* Valid if plain is NULL */
188 dfilter_t *rfcodes[64];
190 dfilter_t *rfieldfcodes[64];
193 GPtrArray *string_fmts;
196 print_usage(FILE *output)
198 fprintf(output, "\n");
199 fprintf(output, "Usage: rawshark [options] ...\n");
200 fprintf(output, "\n");
202 fprintf(output, "Input file:\n");
203 fprintf(output, " -r <infile> set the pipe or file name to read from\n");
205 fprintf(output, "\n");
206 fprintf(output, "Processing:\n");
207 fprintf(output, " -d <encap:linktype>|<proto:protoname>\n");
208 fprintf(output, " packet encapsulation or protocol\n");
209 fprintf(output, " -F <field> field to display\n");
210 fprintf(output, " -n disable all name resolution (def: all enabled)\n");
211 fprintf(output, " -N <name resolve flags> enable specific name resolution(s): \"mntC\"\n");
212 fprintf(output, " -p use the system's packet header format\n");
213 fprintf(output, " (which may have 64-bit timestamps)\n");
214 fprintf(output, " -R <read filter> packet filter in Wireshark display filter syntax\n");
215 fprintf(output, " -s skip PCAP header on input\n");
217 fprintf(output, "\n");
218 fprintf(output, "Output:\n");
219 fprintf(output, " -l flush output after each packet\n");
220 fprintf(output, " -S format string for fields\n");
221 fprintf(output, " (%%D - name, %%S - stringval, %%N numval)\n");
222 fprintf(output, " -t ad|a|r|d|dd|e output format of time stamps (def: r: rel. to first)\n");
224 fprintf(output, "\n");
225 fprintf(output, "Miscellaneous:\n");
226 fprintf(output, " -h display this help and exit\n");
227 fprintf(output, " -o <name>:<value> ... override preference setting\n");
228 fprintf(output, " -v display version info and exit\n");
232 log_func_ignore (const gchar *log_domain _U_, GLogLevelFlags log_level _U_,
233 const gchar *message _U_, gpointer user_data _U_)
238 * Open a pipe for raw input. This is a stripped-down version of
239 * pcap_loop.c:cap_pipe_open_live().
240 * We check if "pipe_name" is "-" (stdin) or a FIFO, and open it.
241 * @param pipe_name The name of the pipe or FIFO.
242 * @return A POSIX file descriptor on success, or -1 on failure.
245 raw_pipe_open(const char *pipe_name)
248 ws_statb64 pipe_stat;
250 char *pncopy, *pos = NULL;
257 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "open_raw_pipe: %s", pipe_name);
260 * XXX Rawshark blocks until we return
262 if (strcmp(pipe_name, "-") == 0) {
263 rfd = 0; /* read from stdin */
266 * This is needed to set the stdin pipe into binary mode, otherwise
267 * CR/LF are mangled...
269 _setmode(0, _O_BINARY);
273 if (ws_stat64(pipe_name, &pipe_stat) < 0) {
274 fprintf(stderr, "rawshark: The pipe %s could not be checked: %s\n",
275 pipe_name, g_strerror(errno));
278 if (! S_ISFIFO(pipe_stat.st_mode)) {
279 if (S_ISCHR(pipe_stat.st_mode)) {
281 * Assume the user specified an interface on a system where
282 * interfaces are in /dev. Pretend we haven't seen it.
286 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
291 rfd = ws_open(pipe_name, O_RDONLY | O_NONBLOCK, 0000 /* no creation so don't matter */);
293 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
294 pipe_name, g_strerror(errno));
298 #define PIPE_STR "\\pipe\\"
299 /* Under Windows, named pipes _must_ have the form
300 * "\\<server>\pipe\<pipe_name>". <server> may be "." for localhost.
302 pncopy = g_strdup(pipe_name);
303 if (strstr(pncopy, "\\\\") == pncopy) {
304 pos = strchr(pncopy + 3, '\\');
305 if (pos && g_ascii_strncasecmp(pos, PIPE_STR, strlen(PIPE_STR)) != 0)
312 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
317 /* Wait for the pipe to appear */
319 hPipe = CreateFile(utf_8to16(pipe_name), GENERIC_READ, 0, NULL,
320 OPEN_EXISTING, 0, NULL);
322 if (hPipe != INVALID_HANDLE_VALUE)
325 err = GetLastError();
326 if (err != ERROR_PIPE_BUSY) {
327 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
328 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
329 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s (error %d)\n",
330 pipe_name, utf_16to8(err_str), err);
335 if (!WaitNamedPipe(utf_8to16(pipe_name), 30 * 1000)) {
336 err = GetLastError();
337 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
338 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
339 fprintf(stderr, "rawshark: \"%s\" could not be waited for: %s (error %d)\n",
340 pipe_name, utf_16to8(err_str), err);
346 rfd = _open_osfhandle((long) hPipe, _O_RDONLY);
348 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
349 pipe_name, g_strerror(errno));
359 * Parse a link-type argument of the form "encap:<pcap linktype>" or
360 * "proto:<proto name>". "Pcap linktype" must be a name conforming to
361 * pcap_datalink_name_to_val() or an integer; the integer should be
362 * a LINKTYPE_ value supported by Wiretap. "Proto name" must be
363 * a protocol name, e.g. "http".
366 set_link_type(const char *lt_arg) {
367 char *spec_ptr = strchr(lt_arg, ':');
371 dissector_handle_t dhandle;
379 if (strncmp(lt_arg, "encap:", strlen("encap:")) == 0) {
380 dlt_val = linktype_name_to_val(spec_ptr);
383 val = strtol(spec_ptr, &p, 10);
384 if (p == spec_ptr || *p != '\0' || errno != 0 || val > INT_MAX) {
390 * In those cases where a given link-layer header type
391 * has different LINKTYPE_ and DLT_ values, linktype_name_to_val()
392 * will return the OS's DLT_ value for that link-layer header
393 * type, not its OS-independent LINKTYPE_ value.
395 * On a given OS, wtap_pcap_encap_to_wtap_encap() should
396 * be able to map either LINKTYPE_ values or DLT_ values
397 * for the OS to the appropriate Wiretap encapsulation.
399 encap = wtap_pcap_encap_to_wtap_encap(dlt_val);
400 if (encap == WTAP_ENCAP_UNKNOWN) {
404 } else if (strncmp(lt_arg, "proto:", strlen("proto:")) == 0) {
405 dhandle = find_dissector(spec_ptr);
407 encap = WTAP_ENCAP_USER0;
408 pref_str = g_string_new("uat:user_dlts:");
409 /* This must match the format used in the user_dlts file */
410 g_string_append_printf(pref_str,
411 "\"User 0 (DLT=147)\",\"%s\",\"0\",\"\",\"0\",\"\"",
413 if (prefs_set_pref(pref_str->str) != PREFS_SET_OK) {
414 g_string_free(pref_str, TRUE);
417 g_string_free(pref_str, TRUE);
425 show_version(GString *comp_info_str, GString *runtime_info_str)
427 printf("Rawshark (Wireshark) %s\n"
434 get_ws_vcs_version_info(), get_copyright_info(), comp_info_str->str,
435 runtime_info_str->str);
439 main(int argc, char *argv[])
441 GString *comp_info_str;
442 GString *runtime_info_str;
443 char *init_progfile_dir_error;
445 gboolean arg_error = FALSE;
451 char *gpf_path, *pf_path;
452 char *gdp_path, *dp_path;
453 int gpf_open_errno, gpf_read_errno;
454 int pf_open_errno, pf_read_errno;
455 int gdp_open_errno, gdp_read_errno;
456 int dp_open_errno, dp_read_errno;
457 gchar *pipe_name = NULL;
462 GPtrArray *disp_fields = g_ptr_array_new();
464 gboolean skip_pcap_header = FALSE;
465 static const struct option long_options[] = {
466 {(char *)"help", no_argument, NULL, 'h'},
467 {(char *)"version", no_argument, NULL, 'v'},
471 #define OPTSTRING_INIT "d:F:hlnN:o:pr:R:sS:t:v"
473 static const char optstring[] = OPTSTRING_INIT;
475 cmdarg_err_init(rawshark_cmdarg_err, rawshark_cmdarg_err_cont);
477 /* Assemble the compile-time version information string */
478 comp_info_str = g_string_new("Compiled ");
479 get_compiled_version_info(comp_info_str, NULL, epan_get_compiled_version_info);
481 /* Assemble the run-time version information string */
482 runtime_info_str = g_string_new("Running ");
483 get_runtime_version_info(runtime_info_str, NULL);
485 /* Add it to the information to be reported on a crash. */
486 ws_add_crash_info("Rawshark (Wireshark) %s\n"
491 get_ws_vcs_version_info(), comp_info_str->str, runtime_info_str->str);
494 arg_list_utf_16to8(argc, argv);
495 create_app_running_mutex();
499 * Get credential information for later use.
501 init_process_policies();
504 * Clear the filters arrays
506 memset(rfilters, 0, sizeof(rfilters));
507 memset(rfcodes, 0, sizeof(rfcodes));
512 * Initialize our string format
514 string_fmts = g_ptr_array_new();
517 * Attempt to get the pathname of the executable file.
519 init_progfile_dir_error = init_progfile_dir(argv[0], main);
520 if (init_progfile_dir_error != NULL) {
521 fprintf(stderr, "rawshark: Can't get pathname of rawshark program: %s.\n",
522 init_progfile_dir_error);
526 * Get credential information for later use.
528 init_process_policies();
530 /* nothing more than the standard GLib handler, but without a warning */
532 G_LOG_LEVEL_WARNING |
533 G_LOG_LEVEL_MESSAGE |
537 g_log_set_handler(NULL,
538 (GLogLevelFlags)log_flags,
539 log_func_ignore, NULL /* user_data */);
540 g_log_set_handler(LOG_DOMAIN_CAPTURE_CHILD,
541 (GLogLevelFlags)log_flags,
542 log_func_ignore, NULL /* user_data */);
544 init_report_err(failure_message, open_failure_message, read_failure_message,
545 write_failure_message);
547 timestamp_set_type(TS_RELATIVE);
548 timestamp_set_precision(TS_PREC_AUTO);
549 timestamp_set_seconds_type(TS_SECONDS_DEFAULT);
551 /* Register all dissectors; we must do this before checking for the
552 "-G" flag, as the "-G" flag dumps information registered by the
553 dissectors, and we must do it before we read the preferences, in
554 case any dissectors register preferences. */
555 epan_init(register_all_protocols, register_all_protocol_handoffs, NULL, NULL);
557 /* Set the C-language locale to the native environment. */
558 setlocale(LC_ALL, "");
560 prefs_p = read_prefs(&gpf_open_errno, &gpf_read_errno, &gpf_path,
561 &pf_open_errno, &pf_read_errno, &pf_path);
562 if (gpf_path != NULL) {
563 if (gpf_open_errno != 0) {
564 cmdarg_err("Can't open global preferences file \"%s\": %s.",
565 pf_path, g_strerror(gpf_open_errno));
567 if (gpf_read_errno != 0) {
568 cmdarg_err("I/O error reading global preferences file \"%s\": %s.",
569 pf_path, g_strerror(gpf_read_errno));
572 if (pf_path != NULL) {
573 if (pf_open_errno != 0) {
574 cmdarg_err("Can't open your preferences file \"%s\": %s.", pf_path,
575 g_strerror(pf_open_errno));
577 if (pf_read_errno != 0) {
578 cmdarg_err("I/O error reading your preferences file \"%s\": %s.",
579 pf_path, g_strerror(pf_read_errno));
585 /* Read the disabled protocols file. */
586 read_disabled_protos_list(&gdp_path, &gdp_open_errno, &gdp_read_errno,
587 &dp_path, &dp_open_errno, &dp_read_errno);
588 if (gdp_path != NULL) {
589 if (gdp_open_errno != 0) {
590 cmdarg_err("Could not open global disabled protocols file\n\"%s\": %s.",
591 gdp_path, g_strerror(gdp_open_errno));
593 if (gdp_read_errno != 0) {
594 cmdarg_err("I/O error reading global disabled protocols file\n\"%s\": %s.",
595 gdp_path, g_strerror(gdp_read_errno));
599 if (dp_path != NULL) {
600 if (dp_open_errno != 0) {
602 "Could not open your disabled protocols file\n\"%s\": %s.", dp_path,
603 g_strerror(dp_open_errno));
605 if (dp_read_errno != 0) {
607 "I/O error reading your disabled protocols file\n\"%s\": %s.", dp_path,
608 g_strerror(dp_read_errno));
614 /* Load Wpcap, if possible */
618 cap_file_init(&cfile);
620 /* Print format defaults to this. */
621 print_format = PR_FMT_TEXT;
623 /* Initialize our encapsulation type */
624 encap = WTAP_ENCAP_UNKNOWN;
626 /* Now get our args */
627 /* XXX - We should probably have an option to dump libpcap link types */
628 while ((opt = getopt_long(argc, argv, optstring, long_options, NULL)) != -1) {
630 case 'd': /* Payload type */
631 if (!set_link_type(optarg)) {
632 cmdarg_err("Invalid link type or protocol \"%s\"", optarg);
636 case 'F': /* Read field to display */
637 g_ptr_array_add(disp_fields, g_strdup(optarg));
639 case 'h': /* Print help and exit */
640 printf("Rawshark (Wireshark) %s\n"
641 "Dump and analyze network traffic.\n"
642 "See http://www.wireshark.org for more information.\n",
643 get_ws_vcs_version_info());
647 case 'l': /* "Line-buffer" standard output */
648 /* This isn't line-buffering, strictly speaking, it's just
649 flushing the standard output after the information for
650 each packet is printed; however, that should be good
651 enough for all the purposes to which "-l" is put (and
652 is probably actually better for "-V", as it does fewer
655 See the comment in "process_packet()" for an explanation of
656 why we do that, and why we don't just use "setvbuf()" to
657 make the standard output line-buffered (short version: in
658 Windows, "line-buffered" is the same as "fully-buffered",
659 and the output buffer is only flushed when it fills up). */
660 line_buffered = TRUE;
662 case 'n': /* No name resolution */
663 gbl_resolv_flags.mac_name = FALSE;
664 gbl_resolv_flags.network_name = FALSE;
665 gbl_resolv_flags.transport_name = FALSE;
666 gbl_resolv_flags.concurrent_dns = FALSE;
668 case 'N': /* Select what types of addresses/port #s to resolve */
669 badopt = string_to_name_resolve(optarg, &gbl_resolv_flags);
670 if (badopt != '\0') {
671 cmdarg_err("-N specifies unknown resolving option '%c'; valid options are 'm', 'n', and 't'",
676 case 'o': /* Override preference from command line */
677 switch (prefs_set_pref(optarg)) {
682 case PREFS_SET_SYNTAX_ERR:
683 cmdarg_err("Invalid -o flag \"%s\"", optarg);
687 case PREFS_SET_NO_SUCH_PREF:
688 case PREFS_SET_OBSOLETE:
689 cmdarg_err("-o flag \"%s\" specifies unknown preference", optarg);
694 case 'p': /* Expect pcap_pkthdr packet headers, which may have 64-bit timestamps */
695 want_pcap_pkthdr = TRUE;
697 case 'r': /* Read capture file xxx */
698 pipe_name = g_strdup(optarg);
700 case 'R': /* Read file filter */
701 if(n_rfilters < (int) sizeof(rfilters) / (int) sizeof(rfilters[0])) {
702 rfilters[n_rfilters++] = optarg;
705 cmdarg_err("Too many display filters");
709 case 's': /* Skip PCAP header */
710 skip_pcap_header = TRUE;
712 case 'S': /* Print string representations */
713 if (!parse_field_string_format(optarg)) {
714 cmdarg_err("Invalid field string format");
718 case 't': /* Time stamp type */
719 if (strcmp(optarg, "r") == 0)
720 timestamp_set_type(TS_RELATIVE);
721 else if (strcmp(optarg, "a") == 0)
722 timestamp_set_type(TS_ABSOLUTE);
723 else if (strcmp(optarg, "ad") == 0)
724 timestamp_set_type(TS_ABSOLUTE_WITH_YMD);
725 else if (strcmp(optarg, "adoy") == 0)
726 timestamp_set_type(TS_ABSOLUTE_WITH_YDOY);
727 else if (strcmp(optarg, "d") == 0)
728 timestamp_set_type(TS_DELTA);
729 else if (strcmp(optarg, "dd") == 0)
730 timestamp_set_type(TS_DELTA_DIS);
731 else if (strcmp(optarg, "e") == 0)
732 timestamp_set_type(TS_EPOCH);
733 else if (strcmp(optarg, "u") == 0)
734 timestamp_set_type(TS_UTC);
735 else if (strcmp(optarg, "ud") == 0)
736 timestamp_set_type(TS_UTC_WITH_YMD);
737 else if (strcmp(optarg, "udoy") == 0)
738 timestamp_set_type(TS_UTC_WITH_YDOY);
740 cmdarg_err("Invalid time stamp type \"%s\"",
743 "It must be \"a\" for absolute, \"ad\" for absolute with YYYY-MM-DD date,");
745 "\"adoy\" for absolute with YYYY/DOY date, \"d\" for delta,");
747 "\"dd\" for delta displayed, \"e\" for epoch, \"r\" for relative,");
749 "\"u\" for absolute UTC, \"ud\" for absolute UTC with YYYY-MM-DD date,");
751 "or \"udoy\" for absolute UTC with YYYY/DOY date.");
755 case 'v': /* Show version and exit */
757 show_version(comp_info_str, runtime_info_str);
758 g_string_free(comp_info_str, TRUE);
759 g_string_free(runtime_info_str, TRUE);
764 case '?': /* Bad flag - print usage message */
771 /* Notify all registered modules that have had any of their preferences
772 changed either from one of the preferences file or from the command
773 line that their preferences have changed.
774 Initialize preferences before display filters, otherwise modules
775 like MATE won't work. */
778 /* Initialize our display fields */
779 for (fc = 0; fc < disp_fields->len; fc++) {
780 protocolinfo_init((char *)g_ptr_array_index(disp_fields, fc));
782 g_ptr_array_free(disp_fields, TRUE);
786 /* If no capture filter or read filter has been specified, and there are
787 still command-line arguments, treat them as the tokens of a capture
788 filter (if no "-r" flag was specified) or a read filter (if a "-r"
789 flag was specified. */
791 if (pipe_name != NULL) {
792 if (n_rfilters != 0) {
793 cmdarg_err("Read filters were specified both with \"-R\" "
794 "and with additional command-line arguments");
797 rfilters[n_rfilters] = get_args_as_string(argc, argv, optind);
801 /* Make sure we got a dissector handle for our payload. */
802 if (encap == WTAP_ENCAP_UNKNOWN) {
803 cmdarg_err("No valid payload dissector specified.");
814 /* Start windows sockets */
815 WSAStartup( MAKEWORD( 1, 1 ), &wsaData );
818 /* At this point MATE will have registered its field array so we can
819 have a tap filter with one of MATE's late-registered fields as part
820 of the filter. We can now process all the "-z" arguments. */
821 start_requested_stats();
823 /* disabled protocols as per configuration file */
824 if (gdp_path == NULL && dp_path == NULL) {
825 set_disabled_protos_list();
828 /* Build the column format array */
829 build_column_format_array(&cfile.cinfo, prefs_p->num_cols, TRUE);
831 if (n_rfilters != 0) {
832 for (i = 0; i < n_rfilters; i++) {
833 if (!dfilter_compile(rfilters[i], &rfcodes[n_rfcodes])) {
834 cmdarg_err("%s", dfilter_error_msg);
835 epan_free(cfile.epan);
845 * We're reading a pipe (or capture file).
849 * Immediately relinquish any special privileges we have; we must not
850 * be allowed to read any capture files the user running Rawshark
853 relinquish_special_privs_perm();
855 if (raw_cf_open(&cfile, pipe_name) != CF_OK) {
856 epan_free(cfile.epan);
861 /* Do we need to PCAP header and magic? */
862 if (skip_pcap_header) {
863 size_t bytes_left = sizeof(struct pcap_hdr) + sizeof(guint32);
864 gchar buf[sizeof(struct pcap_hdr) + sizeof(guint32)];
865 while (bytes_left != 0) {
866 ssize_t bytes = read(fd, buf, (int)bytes_left);
868 cmdarg_err("Not enough bytes for pcap header.");
875 /* Process the packets in the file */
876 if (!load_cap_file(&cfile)) {
877 epan_free(cfile.epan);
882 /* If you want to capture live packets, use TShark. */
883 cmdarg_err("Input file or pipe name not specified.");
887 epan_free(cfile.epan);
894 * Read data from a raw pipe. The "raw" data consists of a libpcap
895 * packet header followed by the payload.
896 * @param pd [IN] A POSIX file descriptor. Because that's _exactly_ the sort
897 * of thing you want to use in Windows.
898 * @param phdr [OUT] Packet header information.
899 * @param err [OUT] Error indicator. Uses wiretap values.
900 * @param err_info [OUT] Error message.
901 * @param data_offset [OUT] data offset in the pipe.
902 * @return TRUE on success, FALSE on failure.
905 raw_pipe_read(struct wtap_pkthdr *phdr, guchar * pd, int *err, gchar **err_info, gint64 *data_offset) {
906 struct pcap_pkthdr mem_hdr;
907 struct pcaprec_hdr disk_hdr;
908 ssize_t bytes_read = 0;
909 size_t bytes_needed = sizeof(disk_hdr);
910 guchar *ptr = (guchar*) &disk_hdr;
912 if (want_pcap_pkthdr) {
913 bytes_needed = sizeof(mem_hdr);
914 ptr = (guchar*) &mem_hdr;
917 /* Copied from capture_loop.c */
918 while (bytes_needed > 0) {
919 bytes_read = read(fd, ptr, (int)bytes_needed);
920 if (bytes_read == 0) {
924 } else if (bytes_read < 0) {
929 bytes_needed -= bytes_read;
930 *data_offset += bytes_read;
934 if (want_pcap_pkthdr) {
935 phdr->ts.secs = mem_hdr.ts.tv_sec;
936 phdr->ts.nsecs = (gint32)mem_hdr.ts.tv_usec * 1000;
937 phdr->caplen = mem_hdr.caplen;
938 phdr->len = mem_hdr.len;
940 phdr->ts.secs = disk_hdr.ts_sec;
941 phdr->ts.nsecs = disk_hdr.ts_usec * 1000;
942 phdr->caplen = disk_hdr.incl_len;
943 phdr->len = disk_hdr.orig_len;
945 bytes_needed = phdr->caplen;
947 phdr->pkt_encap = encap;
950 printf("mem_hdr: %lu disk_hdr: %lu\n", sizeof(mem_hdr), sizeof(disk_hdr));
951 printf("tv_sec: %u (%04x)\n", (unsigned int) phdr->ts.secs, (unsigned int) phdr->ts.secs);
952 printf("tv_nsec: %d (%04x)\n", phdr->ts.nsecs, phdr->ts.nsecs);
953 printf("caplen: %d (%04x)\n", phdr->caplen, phdr->caplen);
954 printf("len: %d (%04x)\n", phdr->len, phdr->len);
956 if (bytes_needed > WTAP_MAX_PACKET_SIZE) {
957 *err = WTAP_ERR_BAD_FILE;
958 *err_info = g_strdup_printf("Bad packet length: %lu\n",
959 (unsigned long) bytes_needed);
964 while (bytes_needed > 0) {
965 bytes_read = read(fd, ptr, (int)bytes_needed);
966 if (bytes_read == 0) {
967 *err = WTAP_ERR_SHORT_READ;
970 } else if (bytes_read < 0) {
975 bytes_needed -= bytes_read;
976 *data_offset += bytes_read;
983 load_cap_file(capture_file *cf)
987 gint64 data_offset = 0;
989 guchar pd[WTAP_MAX_PACKET_SIZE];
990 struct wtap_pkthdr phdr;
993 wtap_phdr_init(&phdr);
995 epan_dissect_init(&edt, cf->epan, TRUE, FALSE);
997 while (raw_pipe_read(&phdr, pd, &err, &err_info, &data_offset)) {
998 process_packet(cf, &edt, data_offset, &phdr, pd);
1001 epan_dissect_cleanup(&edt);
1003 wtap_phdr_cleanup(&phdr);
1006 /* Print a message noting that the read failed somewhere along the line. */
1009 case WTAP_ERR_UNSUPPORTED:
1010 cmdarg_err("The file \"%s\" contains record data that Rawshark doesn't support.\n(%s)",
1011 cf->filename, err_info);
1015 case WTAP_ERR_UNWRITABLE_ENCAP:
1016 cmdarg_err("The file \"%s\" has a packet with a network type that Rawshark doesn't support.\n(%s)",
1017 cf->filename, err_info);
1021 case WTAP_ERR_SHORT_READ:
1022 cmdarg_err("The file \"%s\" appears to have been cut short in the middle of a packet.",
1026 case WTAP_ERR_BAD_FILE:
1027 cmdarg_err("The file \"%s\" appears to be damaged or corrupt.\n(%s)",
1028 cf->filename, err_info);
1032 case WTAP_ERR_DECOMPRESS:
1033 cmdarg_err("The compressed file \"%s\" appears to be damaged or corrupt.\n(%s)",
1034 cf->filename, err_info);
1039 cmdarg_err("An error occurred while reading the file \"%s\": %s.",
1040 cf->filename, wtap_strerror(err));
1050 process_packet(capture_file *cf, epan_dissect_t *edt, gint64 offset,
1051 struct wtap_pkthdr *whdr, const guchar *pd)
1059 /* The user sends an empty packet when he wants to get output from us even if we don't currently have
1060 packets to process. We spit out a line with the timestamp and the text "void"
1062 printf("%lu %lu %lu void -\n", (unsigned long int)cf->count,
1063 (unsigned long int)whdr->ts.secs,
1064 (unsigned long int)whdr->ts.nsecs);
1071 /* Count this packet. */
1074 /* If we're going to print packet information, or we're going to
1075 run a read filter, or we're going to process taps, set up to
1076 do a dissection and do so. */
1077 frame_data_init(&fdata, cf->count, whdr, offset, cum_bytes);
1081 /* If we're running a read filter, prime the epan_dissect_t with that
1083 if (n_rfilters > 0) {
1084 for(i = 0; i < n_rfcodes; i++) {
1085 epan_dissect_prime_dfilter(edt, rfcodes[i]);
1089 printf("%lu", (unsigned long int) cf->count);
1091 frame_data_set_before_dissect(&fdata, &cf->elapsed_time,
1094 if (ref == &fdata) {
1099 /* We only need the columns if we're printing packet info but we're
1100 *not* verbose; in verbose mode, we print the protocol tree, not
1101 the protocol summary. */
1102 epan_dissect_run_with_taps(edt, cf->cd_t, whdr, frame_tvbuff_new(&fdata, pd), &fdata, &cf->cinfo);
1104 frame_data_set_after_dissect(&fdata, &cum_bytes);
1105 prev_dis_frame = fdata;
1106 prev_dis = &prev_dis_frame;
1108 prev_cap_frame = fdata;
1109 prev_cap = &prev_cap_frame;
1111 for(i = 0; i < n_rfilters; i++) {
1112 /* Run the read filter if we have one. */
1114 passed = dfilter_apply_edt(rfcodes[i], edt);
1118 /* Print a one-line summary */
1119 printf(" %u", passed ? 1 : 0);
1124 /* The ANSI C standard does not appear to *require* that a line-buffered
1125 stream be flushed to the host environment whenever a newline is
1126 written, it just says that, on such a stream, characters "are
1127 intended to be transmitted to or from the host environment as a
1128 block when a new-line character is encountered".
1130 The Visual C++ 6.0 C implementation doesn't do what is intended;
1131 even if you set a stream to be line-buffered, it still doesn't
1132 flush the buffer at the end of every line.
1134 So, if the "-l" flag was specified, we flush the standard output
1135 at the end of a packet. This will do the right thing if we're
1136 printing packet summary lines, and, as we print the entire protocol
1137 tree for a single packet without waiting for anything to happen,
1138 it should be as good as line-buffered mode if we're printing
1139 protocol trees. (The whole reason for the "-l" flag in either
1140 tcpdump or Rawshark is to allow the output of a live capture to
1141 be piped to a program or script and to have that script see the
1142 information for the packet as soon as it's printed, rather than
1143 having to wait until a standard I/O buffer fills up. */
1147 if (ferror(stdout)) {
1148 show_print_file_io_error(errno);
1152 epan_dissect_reset(edt);
1153 frame_data_destroy(&fdata);
1158 /****************************************************************************************
1159 * FIELD EXTRACTION ROUTINES
1160 ****************************************************************************************/
1161 typedef struct _pci_t {
1167 static const char* ftenum_to_string(header_field_info *hfi)
1173 if (string_fmts->len > 0 && hfi->strings) {
1181 return "FT_PROTOCOL";
1183 return "FT_BOOLEAN";
1208 case FT_ABSOLUTE_TIME:
1209 return "FT_ABSOLUTE_TIME";
1210 case FT_RELATIVE_TIME:
1211 return "FT_RELATIVE_TIME";
1215 return "FT_STRINGZ";
1216 case FT_UINT_STRING:
1217 return "FT_UINT_STRING";
1223 return "FT_UINT_BYTES";
1231 return "FT_FRAMENUM";
1239 return "FT_REL_OID";
1241 return "FT_SYSTEM_ID";
1243 return "FT_STRIGZPAD";
1245 return "FT_NUM_TYPES";
1251 static const char* absolute_time_display_e_to_string(absolute_time_display_e atd)
1254 case ABSOLUTE_TIME_LOCAL:
1255 return "ABSOLUTE_TIME_LOCAL";
1256 case ABSOLUTE_TIME_UTC:
1257 return "ABSOLUTE_TIME_UTC";
1263 static const char* field_display_e_to_string(field_display_e bd)
1275 return "BASE_DEC_HEX";
1277 return "BASE_HEX_DEC";
1284 * Copied from various parts of proto.c
1286 #define FIELD_STR_INIT_LEN 256
1287 #define cVALS(x) (const value_string*)(x)
1288 static gboolean print_field_value(field_info *finfo, int cmd_line_index)
1290 header_field_info *hfinfo;
1291 static char *fs_buf = NULL;
1292 char *fs_ptr = fs_buf;
1293 static GString *label_s = NULL;
1294 int fs_buf_len = FIELD_STR_INIT_LEN, fs_len;
1301 const true_false_string *tfstring = &tfs_true_false;
1303 hfinfo = finfo->hfinfo;
1306 fs_buf = (char *)g_malloc(fs_buf_len + 1);
1311 label_s = g_string_new("");
1314 if(finfo->value.ftype->val_to_string_repr)
1317 * this field has an associated value,
1320 fs_len = fvalue_string_repr_len(&finfo->value, FTREPR_DFILTER);
1321 while (fs_buf_len < fs_len) {
1323 fs_buf = (char *)g_realloc(fs_buf, fs_buf_len + 1);
1326 fvalue_to_string_repr(&finfo->value,
1330 /* String types are quoted. Remove them. */
1331 if (IS_FT_STRING(finfo->value.ftype->ftype) && fs_len > 2) {
1332 fs_buf[fs_len - 1] = '\0';
1337 if (string_fmts->len > 0 && finfo->hfinfo->strings) {
1338 g_string_truncate(label_s, 0);
1339 for (i = 0; i < string_fmts->len; i++) {
1340 sf = (string_fmt_t *)g_ptr_array_index(string_fmts, i);
1342 g_string_append(label_s, sf->plain);
1344 switch (sf->format) {
1346 g_string_append(label_s, hfinfo->name);
1349 g_string_append(label_s, fs_ptr);
1352 switch(hfinfo->type) {
1354 uvalue = fvalue_get_uinteger(&finfo->value);
1355 tfstring = (const struct true_false_string*) hfinfo->strings;
1356 g_string_append(label_s, uvalue ? tfstring->true_string : tfstring->false_string);
1362 DISSECTOR_ASSERT(!hfinfo->bitmask);
1363 svalue = fvalue_get_sinteger(&finfo->value);
1364 if (hfinfo->display & BASE_RANGE_STRING) {
1365 g_string_append(label_s, rval_to_str_const(svalue, RVALS(hfinfo->strings), "Unknown"));
1366 } else if (hfinfo->display & BASE_EXT_STRING) {
1367 g_string_append(label_s, val_to_str_ext_const(svalue, (value_string_ext *) hfinfo->strings, "Unknown"));
1369 g_string_append(label_s, val_to_str_const(svalue, cVALS(hfinfo->strings), "Unknown"));
1373 DISSECTOR_ASSERT(!hfinfo->bitmask);
1374 svalue64 = (gint64)fvalue_get_integer64(&finfo->value);
1375 if (hfinfo->display & BASE_VAL64_STRING) {
1376 g_string_append(label_s, val64_to_str_const(svalue64, (const val64_string *)(hfinfo->strings), "Unknown"));
1383 uvalue = fvalue_get_uinteger(&finfo->value);
1384 if (!hfinfo->bitmask && hfinfo->display & BASE_RANGE_STRING) {
1385 g_string_append(label_s, rval_to_str_const(uvalue, RVALS(hfinfo->strings), "Unknown"));
1386 } else if (hfinfo->display & BASE_EXT_STRING) {
1387 g_string_append(label_s, val_to_str_ext_const(uvalue, (value_string_ext *) hfinfo->strings, "Unknown"));
1389 g_string_append(label_s, val_to_str_const(uvalue, cVALS(hfinfo->strings), "Unknown"));
1393 DISSECTOR_ASSERT(!hfinfo->bitmask);
1394 uvalue64 = fvalue_get_integer64(&finfo->value);
1395 if (hfinfo->display & BASE_VAL64_STRING) {
1396 g_string_append(label_s, val64_to_str_const(uvalue64, (const val64_string *)(hfinfo->strings), "Unknown"));
1408 printf(" %u=\"%s\"", cmd_line_index, label_s->str);
1412 if(finfo->value.ftype->val_to_string_repr)
1414 printf(" %u=\"%s\"", cmd_line_index, fs_ptr);
1419 * This field doesn't have an associated value,
1423 printf(" %u=\"n.a.\"", cmd_line_index);
1428 protocolinfo_packet(void *prs, packet_info *pinfo _U_, epan_dissect_t *edt, const void *dummy _U_)
1430 pci_t *rs=(pci_t *)prs;
1434 gp=proto_get_finfo_ptr_array(edt->tree, rs->hf_index);
1441 * Print each occurrence of the field
1443 for (i = 0; i < gp->len; i++) {
1444 print_field_value((field_info *)gp->pdata[i], rs->cmd_line_index);
1450 int g_cmd_line_index = 0;
1453 * field must be persistent - we don't g_strdup() it below
1456 protocolinfo_init(char *field)
1459 header_field_info *hfi;
1460 GString *error_string;
1462 hfi=proto_registrar_get_byname(field);
1464 fprintf(stderr, "rawshark: Field \"%s\" doesn't exist.\n", field);
1468 switch (hfi->type) {
1470 case FT_ABSOLUTE_TIME:
1471 printf("%u %s %s - ",
1473 ftenum_to_string(hfi),
1474 absolute_time_display_e_to_string((absolute_time_display_e)hfi->display));
1478 printf("%u %s %s - ",
1480 ftenum_to_string(hfi),
1481 field_display_e_to_string((field_display_e)hfi->display));
1485 rs=(pci_t *)g_malloc(sizeof(pci_t));
1486 rs->hf_index=hfi->id;
1488 rs->cmd_line_index = g_cmd_line_index++;
1490 error_string=register_tap_listener("frame", rs, rs->filter, TL_REQUIRES_PROTO_TREE, NULL, protocolinfo_packet, NULL);
1492 /* error, we failed to attach to the tap. complain and clean up */
1493 fprintf(stderr, "rawshark: Couldn't register field extraction tap: %s\n",
1495 g_string_free(error_string, TRUE);
1506 * Given a format string, split it into a GPtrArray of string_fmt_t structs
1507 * and fill in string_fmt_parts.
1511 add_string_fmt(string_fmt_e format, gchar *plain) {
1512 string_fmt_t *sf = (string_fmt_t *)g_malloc(sizeof(string_fmt_t));
1514 sf->format = format;
1515 sf->plain = g_strdup(plain);
1517 g_ptr_array_add(string_fmts, sf);
1521 parse_field_string_format(gchar *format) {
1522 GString *plain_s = g_string_new("");
1530 len = strlen(format);
1531 g_ptr_array_set_size(string_fmts, 0);
1534 if (format[pos] == '%') {
1535 if (pos >= len) { /* There should always be a following character */
1539 if (plain_s->len > 0) {
1540 add_string_fmt(SF_NONE, plain_s->str);
1541 g_string_truncate(plain_s, 0);
1543 switch (format[pos]) {
1545 add_string_fmt(SF_NAME, NULL);
1548 add_string_fmt(SF_NUMVAL, NULL);
1551 add_string_fmt(SF_STRVAL, NULL);
1554 g_string_append_c(plain_s, '%');
1556 default: /* Invalid format */
1560 g_string_append_c(plain_s, format[pos]);
1565 if (plain_s->len > 0) {
1566 add_string_fmt(SF_NONE, plain_s->str);
1568 g_string_free(plain_s, TRUE);
1572 /****************************************************************************************
1573 * END OF FIELD EXTRACTION ROUTINES
1574 ****************************************************************************************/
1577 show_print_file_io_error(int err)
1582 cmdarg_err("Not all the packets could be printed because there is "
1583 "no space left on the file system.");
1588 cmdarg_err("Not all the packets could be printed because you are "
1589 "too close to, or over your disk quota.");
1594 cmdarg_err("An error occurred while printing packets: %s.",
1601 * Open/create errors are reported with an console message in Rawshark.
1604 open_failure_message(const char *filename, int err, gboolean for_writing)
1606 fprintf(stderr, "rawshark: ");
1607 fprintf(stderr, file_open_error_message(err, for_writing), filename);
1608 fprintf(stderr, "\n");
1611 static const nstime_t *
1612 raw_get_frame_ts(void *data _U_, guint32 frame_num)
1614 if (ref && ref->num == frame_num)
1615 return &ref->abs_ts;
1617 if (prev_dis && prev_dis->num == frame_num)
1618 return &prev_dis->abs_ts;
1620 if (prev_cap && prev_cap->num == frame_num)
1621 return &prev_cap->abs_ts;
1627 raw_epan_new(capture_file *cf)
1629 epan_t *epan = epan_new();
1632 epan->get_frame_ts = raw_get_frame_ts;
1633 epan->get_interface_name = cap_file_get_interface_name;
1634 epan->get_user_comment = NULL;
1640 raw_cf_open(capture_file *cf, const char *fname)
1642 if ((fd = raw_pipe_open(fname)) < 0)
1645 /* The open succeeded. Fill in the information for this file. */
1647 /* Create new epan session for dissection. */
1648 epan_free(cf->epan);
1649 cf->epan = raw_epan_new(cf);
1652 cf->f_datalen = 0; /* not used, but set it anyway */
1654 /* Set the file name because we need it to set the follow stream filter.
1655 XXX - is that still true? We need it for other reasons, though,
1657 cf->filename = g_strdup(fname);
1659 /* Indicate whether it's a permanent or temporary file. */
1660 cf->is_tempfile = FALSE;
1662 /* No user changes yet. */
1663 cf->unsaved_changes = FALSE;
1665 cf->cd_t = WTAP_FILE_TYPE_SUBTYPE_UNKNOWN;
1666 cf->open_type = WTAP_TYPE_AUTO;
1668 cf->drops_known = FALSE;
1670 cf->has_snap = FALSE;
1671 cf->snap = WTAP_MAX_PACKET_SIZE;
1672 nstime_set_zero(&cf->elapsed_time);
1682 * General errors are reported with an console message in Rawshark.
1685 failure_message(const char *msg_format, va_list ap)
1687 fprintf(stderr, "rawshark: ");
1688 vfprintf(stderr, msg_format, ap);
1689 fprintf(stderr, "\n");
1693 * Read errors are reported with an console message in Rawshark.
1696 read_failure_message(const char *filename, int err)
1698 cmdarg_err("An error occurred while reading from the file \"%s\": %s.",
1699 filename, g_strerror(err));
1703 * Write errors are reported with an console message in Rawshark.
1706 write_failure_message(const char *filename, int err)
1708 cmdarg_err("An error occurred while writing to the file \"%s\": %s.",
1709 filename, g_strerror(err));
1713 * Report an error in command-line arguments.
1716 rawshark_cmdarg_err(const char *fmt, va_list ap)
1718 fprintf(stderr, "rawshark: ");
1719 vfprintf(stderr, fmt, ap);
1720 fprintf(stderr, "\n");
1724 * Report additional information for an error in command-line arguments.
1727 rawshark_cmdarg_err_cont(const char *fmt, va_list ap)
1729 vfprintf(stderr, fmt, ap);
1730 fprintf(stderr, "\n");
1739 * indent-tabs-mode: nil
1742 * ex: set shiftwidth=4 tabstop=8 expandtab:
1743 * :indentSize=4:tabSize=8:noTabs=true: