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>
63 #ifndef HAVE_GETOPT_LONG
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>
80 #include <epan/packet.h>
81 #include <epan/ftypes/ftypes-int.h>
83 #include "frame_tvbuff.h"
84 #include <epan/disabled_protos.h>
85 #include <epan/prefs.h>
86 #include <epan/column.h>
87 #include <epan/print.h>
88 #include <epan/addr_resolv.h>
90 #include "ui/capture_ui_utils.h"
93 #include "version_info.h"
95 #include "conditions.h"
96 #include "capture_stop_conditions.h"
97 #include <epan/epan_dissect.h>
98 #include <epan/stat_tap_ui.h>
99 #include <epan/timestamp.h>
100 #include <wsutil/unicode-utils.h>
101 #include "epan/column-utils.h"
102 #include "epan/proto.h"
103 #include <epan/tap.h>
105 #include <wiretap/wtap.h>
106 #include <wiretap/libpcap.h>
107 #include <wiretap/pcap-encap.h>
109 #include <wsutil/clopts_common.h>
110 #include <wsutil/ws_version_info.h>
112 #include "caputils/capture-pcap-util.h"
117 #include "caputils/capture-wpcap.h"
119 #endif /* HAVE_LIBPCAP */
123 #include <wsutil/unicode-utils.h>
128 * This is the template for the decode as option; it is shared between the
129 * various functions that output the usage for this parameter.
131 static const gchar decode_as_arg_template[] = "<layer_type>==<selector>,<decode_as_protocol>";
134 static guint32 cum_bytes;
135 static const frame_data *ref;
136 static frame_data ref_frame;
137 static frame_data *prev_dis;
138 static frame_data prev_dis_frame;
139 static frame_data *prev_cap;
140 static frame_data prev_cap_frame;
143 * The way the packet decode is to be written.
146 WRITE_TEXT, /* summary or detail text */
147 WRITE_XML /* PDML or PSML */
148 /* Add CSV and the like here */
151 static gboolean line_buffered;
152 static print_format_e print_format = PR_FMT_TEXT;
154 static gboolean want_pcap_pkthdr;
156 cf_status_t raw_cf_open(capture_file *cf, const char *fname);
157 static gboolean load_cap_file(capture_file *cf);
158 static gboolean process_packet(capture_file *cf, epan_dissect_t *edt, gint64 offset,
159 struct wtap_pkthdr *whdr, const guchar *pd);
160 static void show_print_file_io_error(int err);
162 static void open_failure_message(const char *filename, int err,
163 gboolean for_writing);
164 static void failure_message(const char *msg_format, va_list ap);
165 static void read_failure_message(const char *filename, int err);
166 static void write_failure_message(const char *filename, int err);
167 static void rawshark_cmdarg_err(const char *fmt, va_list ap);
168 static void rawshark_cmdarg_err_cont(const char *fmt, va_list ap);
169 static void protocolinfo_init(char *field);
170 static gboolean parse_field_string_format(char *format);
173 SF_NONE, /* No format (placeholder) */
174 SF_NAME, /* %D Field name / description */
175 SF_NUMVAL, /* %N Numeric value */
176 SF_STRVAL /* %S String value */
179 typedef struct string_fmt_s {
181 string_fmt_e format; /* Valid if plain is NULL */
187 dfilter_t *rfcodes[64];
189 dfilter_t *rfieldfcodes[64];
192 GPtrArray *string_fmts;
195 print_usage(FILE *output)
197 fprintf(output, "\n");
198 fprintf(output, "Usage: rawshark [options] ...\n");
199 fprintf(output, "\n");
201 fprintf(output, "Input file:\n");
202 fprintf(output, " -r <infile> set the pipe or file name to read from\n");
204 fprintf(output, "\n");
205 fprintf(output, "Processing:\n");
206 fprintf(output, " -d <encap:linktype>|<proto:protoname>\n");
207 fprintf(output, " packet encapsulation or protocol\n");
208 fprintf(output, " -F <field> field to display\n");
209 fprintf(output, " -n disable all name resolution (def: all enabled)\n");
210 fprintf(output, " -N <name resolve flags> enable specific name resolution(s): \"mntC\"\n");
211 fprintf(output, " -p use the system's packet header format\n");
212 fprintf(output, " (which may have 64-bit timestamps)\n");
213 fprintf(output, " -R <read filter> packet filter in Wireshark display filter syntax\n");
214 fprintf(output, " -s skip PCAP header on input\n");
216 fprintf(output, "\n");
217 fprintf(output, "Output:\n");
218 fprintf(output, " -l flush output after each packet\n");
219 fprintf(output, " -S format string for fields\n");
220 fprintf(output, " (%%D - name, %%S - stringval, %%N numval)\n");
221 fprintf(output, " -t ad|a|r|d|dd|e output format of time stamps (def: r: rel. to first)\n");
223 fprintf(output, "\n");
224 fprintf(output, "Miscellaneous:\n");
225 fprintf(output, " -h display this help and exit\n");
226 fprintf(output, " -o <name>:<value> ... override preference setting\n");
227 fprintf(output, " -v display version info and exit\n");
231 log_func_ignore (const gchar *log_domain _U_, GLogLevelFlags log_level _U_,
232 const gchar *message _U_, gpointer user_data _U_)
237 * Open a pipe for raw input. This is a stripped-down version of
238 * pcap_loop.c:cap_pipe_open_live().
239 * We check if "pipe_name" is "-" (stdin) or a FIFO, and open it.
240 * @param pipe_name The name of the pipe or FIFO.
241 * @return A POSIX file descriptor on success, or -1 on failure.
244 raw_pipe_open(const char *pipe_name)
247 ws_statb64 pipe_stat;
249 char *pncopy, *pos = NULL;
256 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "open_raw_pipe: %s", pipe_name);
259 * XXX Rawshark blocks until we return
261 if (strcmp(pipe_name, "-") == 0) {
262 rfd = 0; /* read from stdin */
265 * This is needed to set the stdin pipe into binary mode, otherwise
266 * CR/LF are mangled...
268 _setmode(0, _O_BINARY);
272 if (ws_stat64(pipe_name, &pipe_stat) < 0) {
273 fprintf(stderr, "rawshark: The pipe %s could not be checked: %s\n",
274 pipe_name, g_strerror(errno));
277 if (! S_ISFIFO(pipe_stat.st_mode)) {
278 if (S_ISCHR(pipe_stat.st_mode)) {
280 * Assume the user specified an interface on a system where
281 * interfaces are in /dev. Pretend we haven't seen it.
285 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
290 rfd = ws_open(pipe_name, O_RDONLY | O_NONBLOCK, 0000 /* no creation so don't matter */);
292 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
293 pipe_name, g_strerror(errno));
297 #define PIPE_STR "\\pipe\\"
298 /* Under Windows, named pipes _must_ have the form
299 * "\\<server>\pipe\<pipe_name>". <server> may be "." for localhost.
301 pncopy = g_strdup(pipe_name);
302 if (strstr(pncopy, "\\\\") == pncopy) {
303 pos = strchr(pncopy + 3, '\\');
304 if (pos && g_ascii_strncasecmp(pos, PIPE_STR, strlen(PIPE_STR)) != 0)
311 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
316 /* Wait for the pipe to appear */
318 hPipe = CreateFile(utf_8to16(pipe_name), GENERIC_READ, 0, NULL,
319 OPEN_EXISTING, 0, NULL);
321 if (hPipe != INVALID_HANDLE_VALUE)
324 err = GetLastError();
325 if (err != ERROR_PIPE_BUSY) {
326 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
327 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
328 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s (error %d)\n",
329 pipe_name, utf_16to8(err_str), err);
334 if (!WaitNamedPipe(utf_8to16(pipe_name), 30 * 1000)) {
335 err = GetLastError();
336 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
337 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
338 fprintf(stderr, "rawshark: \"%s\" could not be waited for: %s (error %d)\n",
339 pipe_name, utf_16to8(err_str), err);
345 rfd = _open_osfhandle((long) hPipe, _O_RDONLY);
347 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
348 pipe_name, g_strerror(errno));
358 * Parse a link-type argument of the form "encap:<pcap linktype>" or
359 * "proto:<proto name>". "Pcap linktype" must be a name conforming to
360 * pcap_datalink_name_to_val() or an integer; the integer should be
361 * a LINKTYPE_ value supported by Wiretap. "Proto name" must be
362 * a protocol name, e.g. "http".
365 set_link_type(const char *lt_arg) {
366 char *spec_ptr = strchr(lt_arg, ':');
370 dissector_handle_t dhandle;
378 if (strncmp(lt_arg, "encap:", strlen("encap:")) == 0) {
379 dlt_val = linktype_name_to_val(spec_ptr);
382 val = strtol(spec_ptr, &p, 10);
383 if (p == spec_ptr || *p != '\0' || errno != 0 || val > INT_MAX) {
389 * In those cases where a given link-layer header type
390 * has different LINKTYPE_ and DLT_ values, linktype_name_to_val()
391 * will return the OS's DLT_ value for that link-layer header
392 * type, not its OS-independent LINKTYPE_ value.
394 * On a given OS, wtap_pcap_encap_to_wtap_encap() should
395 * be able to map either LINKTYPE_ values or DLT_ values
396 * for the OS to the appropriate Wiretap encapsulation.
398 encap = wtap_pcap_encap_to_wtap_encap(dlt_val);
399 if (encap == WTAP_ENCAP_UNKNOWN) {
403 } else if (strncmp(lt_arg, "proto:", strlen("proto:")) == 0) {
404 dhandle = find_dissector(spec_ptr);
406 encap = WTAP_ENCAP_USER0;
407 pref_str = g_string_new("uat:user_dlts:");
408 /* This must match the format used in the user_dlts file */
409 g_string_append_printf(pref_str,
410 "\"User 0 (DLT=147)\",\"%s\",\"0\",\"\",\"0\",\"\"",
412 if (prefs_set_pref(pref_str->str) != PREFS_SET_OK) {
413 g_string_free(pref_str, TRUE);
416 g_string_free(pref_str, TRUE);
424 main(int argc, char *argv[])
426 GString *comp_info_str;
427 GString *runtime_info_str;
428 char *init_progfile_dir_error;
430 gboolean arg_error = FALSE;
436 char *gpf_path, *pf_path;
437 char *gdp_path, *dp_path;
438 int gpf_open_errno, gpf_read_errno;
439 int pf_open_errno, pf_read_errno;
440 int gdp_open_errno, gdp_read_errno;
441 int dp_open_errno, dp_read_errno;
442 gchar *pipe_name = NULL;
447 GPtrArray *disp_fields = g_ptr_array_new();
449 gboolean skip_pcap_header = FALSE;
450 static const struct option long_options[] = {
451 {(char *)"help", no_argument, NULL, 'h'},
452 {(char *)"version", no_argument, NULL, 'v'},
456 #define OPTSTRING_INIT "d:F:hlnN:o:pr:R:sS:t:v"
458 static const char optstring[] = OPTSTRING_INIT;
460 cmdarg_err_init(rawshark_cmdarg_err, rawshark_cmdarg_err_cont);
462 /* Assemble the compile-time version information string */
463 comp_info_str = g_string_new("Compiled ");
464 get_compiled_version_info(comp_info_str, NULL, epan_get_compiled_version_info);
466 /* Assemble the run-time version information string */
467 runtime_info_str = g_string_new("Running ");
468 get_runtime_version_info(runtime_info_str, NULL);
470 /* Add it to the information to be reported on a crash. */
471 ws_add_crash_info("Rawshark (Wireshark) %s\n"
476 get_ws_vcs_version_info(), comp_info_str->str, runtime_info_str->str);
479 arg_list_utf_16to8(argc, argv);
480 create_app_running_mutex();
484 * Get credential information for later use.
486 init_process_policies();
489 * Clear the filters arrays
491 memset(rfilters, 0, sizeof(rfilters));
492 memset(rfcodes, 0, sizeof(rfcodes));
497 * Initialize our string format
499 string_fmts = g_ptr_array_new();
502 * Attempt to get the pathname of the executable file.
504 init_progfile_dir_error = init_progfile_dir(argv[0], main);
505 if (init_progfile_dir_error != NULL) {
506 fprintf(stderr, "rawshark: Can't get pathname of rawshark program: %s.\n",
507 init_progfile_dir_error);
511 * Get credential information for later use.
513 init_process_policies();
515 /* nothing more than the standard GLib handler, but without a warning */
517 G_LOG_LEVEL_WARNING |
518 G_LOG_LEVEL_MESSAGE |
522 g_log_set_handler(NULL,
523 (GLogLevelFlags)log_flags,
524 log_func_ignore, NULL /* user_data */);
525 g_log_set_handler(LOG_DOMAIN_CAPTURE_CHILD,
526 (GLogLevelFlags)log_flags,
527 log_func_ignore, NULL /* user_data */);
529 init_report_err(failure_message, open_failure_message, read_failure_message,
530 write_failure_message);
532 timestamp_set_type(TS_RELATIVE);
533 timestamp_set_precision(TS_PREC_AUTO);
534 timestamp_set_seconds_type(TS_SECONDS_DEFAULT);
536 /* Register all dissectors; we must do this before checking for the
537 "-G" flag, as the "-G" flag dumps information registered by the
538 dissectors, and we must do it before we read the preferences, in
539 case any dissectors register preferences. */
540 epan_init(register_all_protocols, register_all_protocol_handoffs, NULL, NULL);
542 /* Set the C-language locale to the native environment. */
543 setlocale(LC_ALL, "");
545 prefs_p = read_prefs(&gpf_open_errno, &gpf_read_errno, &gpf_path,
546 &pf_open_errno, &pf_read_errno, &pf_path);
547 if (gpf_path != NULL) {
548 if (gpf_open_errno != 0) {
549 cmdarg_err("Can't open global preferences file \"%s\": %s.",
550 pf_path, g_strerror(gpf_open_errno));
552 if (gpf_read_errno != 0) {
553 cmdarg_err("I/O error reading global preferences file \"%s\": %s.",
554 pf_path, g_strerror(gpf_read_errno));
557 if (pf_path != NULL) {
558 if (pf_open_errno != 0) {
559 cmdarg_err("Can't open your preferences file \"%s\": %s.", pf_path,
560 g_strerror(pf_open_errno));
562 if (pf_read_errno != 0) {
563 cmdarg_err("I/O error reading your preferences file \"%s\": %s.",
564 pf_path, g_strerror(pf_read_errno));
570 /* Read the disabled protocols file. */
571 read_disabled_protos_list(&gdp_path, &gdp_open_errno, &gdp_read_errno,
572 &dp_path, &dp_open_errno, &dp_read_errno);
573 if (gdp_path != NULL) {
574 if (gdp_open_errno != 0) {
575 cmdarg_err("Could not open global disabled protocols file\n\"%s\": %s.",
576 gdp_path, g_strerror(gdp_open_errno));
578 if (gdp_read_errno != 0) {
579 cmdarg_err("I/O error reading global disabled protocols file\n\"%s\": %s.",
580 gdp_path, g_strerror(gdp_read_errno));
584 if (dp_path != NULL) {
585 if (dp_open_errno != 0) {
587 "Could not open your disabled protocols file\n\"%s\": %s.", dp_path,
588 g_strerror(dp_open_errno));
590 if (dp_read_errno != 0) {
592 "I/O error reading your disabled protocols file\n\"%s\": %s.", dp_path,
593 g_strerror(dp_read_errno));
599 /* Load Wpcap, if possible */
603 cap_file_init(&cfile);
605 /* Print format defaults to this. */
606 print_format = PR_FMT_TEXT;
608 /* Initialize our encapsulation type */
609 encap = WTAP_ENCAP_UNKNOWN;
611 /* Now get our args */
612 /* XXX - We should probably have an option to dump libpcap link types */
613 while ((opt = getopt_long(argc, argv, optstring, long_options, NULL)) != -1) {
615 case 'd': /* Payload type */
616 if (!set_link_type(optarg)) {
617 cmdarg_err("Invalid link type or protocol \"%s\"", optarg);
621 case 'F': /* Read field to display */
622 g_ptr_array_add(disp_fields, g_strdup(optarg));
624 case 'h': /* Print help and exit */
625 printf("Rawshark (Wireshark) %s\n"
626 "Dump and analyze network traffic.\n"
627 "See http://www.wireshark.org for more information.\n",
628 get_ws_vcs_version_info());
632 case 'l': /* "Line-buffer" standard output */
633 /* This isn't line-buffering, strictly speaking, it's just
634 flushing the standard output after the information for
635 each packet is printed; however, that should be good
636 enough for all the purposes to which "-l" is put (and
637 is probably actually better for "-V", as it does fewer
640 See the comment in "process_packet()" for an explanation of
641 why we do that, and why we don't just use "setvbuf()" to
642 make the standard output line-buffered (short version: in
643 Windows, "line-buffered" is the same as "fully-buffered",
644 and the output buffer is only flushed when it fills up). */
645 line_buffered = TRUE;
647 case 'n': /* No name resolution */
648 gbl_resolv_flags.mac_name = FALSE;
649 gbl_resolv_flags.network_name = FALSE;
650 gbl_resolv_flags.transport_name = FALSE;
651 gbl_resolv_flags.concurrent_dns = FALSE;
653 case 'N': /* Select what types of addresses/port #s to resolve */
654 badopt = string_to_name_resolve(optarg, &gbl_resolv_flags);
655 if (badopt != '\0') {
656 cmdarg_err("-N specifies unknown resolving option '%c'; valid options are 'm', 'n', and 't'",
661 case 'o': /* Override preference from command line */
662 switch (prefs_set_pref(optarg)) {
667 case PREFS_SET_SYNTAX_ERR:
668 cmdarg_err("Invalid -o flag \"%s\"", optarg);
672 case PREFS_SET_NO_SUCH_PREF:
673 case PREFS_SET_OBSOLETE:
674 cmdarg_err("-o flag \"%s\" specifies unknown preference", optarg);
679 case 'p': /* Expect pcap_pkthdr packet headers, which may have 64-bit timestamps */
680 want_pcap_pkthdr = TRUE;
682 case 'r': /* Read capture file xxx */
683 pipe_name = g_strdup(optarg);
685 case 'R': /* Read file filter */
686 if(n_rfilters < (int) sizeof(rfilters) / (int) sizeof(rfilters[0])) {
687 rfilters[n_rfilters++] = optarg;
690 cmdarg_err("Too many display filters");
694 case 's': /* Skip PCAP header */
695 skip_pcap_header = TRUE;
697 case 'S': /* Print string representations */
698 if (!parse_field_string_format(optarg)) {
699 cmdarg_err("Invalid field string format");
703 case 't': /* Time stamp type */
704 if (strcmp(optarg, "r") == 0)
705 timestamp_set_type(TS_RELATIVE);
706 else if (strcmp(optarg, "a") == 0)
707 timestamp_set_type(TS_ABSOLUTE);
708 else if (strcmp(optarg, "ad") == 0)
709 timestamp_set_type(TS_ABSOLUTE_WITH_YMD);
710 else if (strcmp(optarg, "adoy") == 0)
711 timestamp_set_type(TS_ABSOLUTE_WITH_YDOY);
712 else if (strcmp(optarg, "d") == 0)
713 timestamp_set_type(TS_DELTA);
714 else if (strcmp(optarg, "dd") == 0)
715 timestamp_set_type(TS_DELTA_DIS);
716 else if (strcmp(optarg, "e") == 0)
717 timestamp_set_type(TS_EPOCH);
718 else if (strcmp(optarg, "u") == 0)
719 timestamp_set_type(TS_UTC);
720 else if (strcmp(optarg, "ud") == 0)
721 timestamp_set_type(TS_UTC_WITH_YMD);
722 else if (strcmp(optarg, "udoy") == 0)
723 timestamp_set_type(TS_UTC_WITH_YDOY);
725 cmdarg_err("Invalid time stamp type \"%s\"",
728 "It must be \"a\" for absolute, \"ad\" for absolute with YYYY-MM-DD date,");
730 "\"adoy\" for absolute with YYYY/DOY date, \"d\" for delta,");
732 "\"dd\" for delta displayed, \"e\" for epoch, \"r\" for relative,");
734 "\"u\" for absolute UTC, \"ud\" for absolute UTC with YYYY-MM-DD date,");
736 "or \"udoy\" for absolute UTC with YYYY/DOY date.");
740 case 'v': /* Show version and exit */
742 show_version("Rawshark (Wireshark)", comp_info_str, runtime_info_str);
743 g_string_free(comp_info_str, TRUE);
744 g_string_free(runtime_info_str, TRUE);
749 case '?': /* Bad flag - print usage message */
756 /* Notify all registered modules that have had any of their preferences
757 changed either from one of the preferences file or from the command
758 line that their preferences have changed.
759 Initialize preferences before display filters, otherwise modules
760 like MATE won't work. */
763 /* Initialize our display fields */
764 for (fc = 0; fc < disp_fields->len; fc++) {
765 protocolinfo_init((char *)g_ptr_array_index(disp_fields, fc));
767 g_ptr_array_free(disp_fields, TRUE);
771 /* If no capture filter or read filter has been specified, and there are
772 still command-line arguments, treat them as the tokens of a capture
773 filter (if no "-r" flag was specified) or a read filter (if a "-r"
774 flag was specified. */
776 if (pipe_name != NULL) {
777 if (n_rfilters != 0) {
778 cmdarg_err("Read filters were specified both with \"-R\" "
779 "and with additional command-line arguments");
782 rfilters[n_rfilters] = get_args_as_string(argc, argv, optind);
786 /* Make sure we got a dissector handle for our payload. */
787 if (encap == WTAP_ENCAP_UNKNOWN) {
788 cmdarg_err("No valid payload dissector specified.");
799 /* Start windows sockets */
800 WSAStartup( MAKEWORD( 1, 1 ), &wsaData );
803 /* At this point MATE will have registered its field array so we can
804 have a tap filter with one of MATE's late-registered fields as part
805 of the filter. We can now process all the "-z" arguments. */
806 start_requested_stats();
808 /* disabled protocols as per configuration file */
809 if (gdp_path == NULL && dp_path == NULL) {
810 set_disabled_protos_list();
813 /* Build the column format array */
814 build_column_format_array(&cfile.cinfo, prefs_p->num_cols, TRUE);
816 if (n_rfilters != 0) {
817 for (i = 0; i < n_rfilters; i++) {
818 if (!dfilter_compile(rfilters[i], &rfcodes[n_rfcodes])) {
819 cmdarg_err("%s", dfilter_error_msg);
820 epan_free(cfile.epan);
830 * We're reading a pipe (or capture file).
834 * Immediately relinquish any special privileges we have; we must not
835 * be allowed to read any capture files the user running Rawshark
838 relinquish_special_privs_perm();
840 if (raw_cf_open(&cfile, pipe_name) != CF_OK) {
841 epan_free(cfile.epan);
846 /* Do we need to PCAP header and magic? */
847 if (skip_pcap_header) {
848 size_t bytes_left = sizeof(struct pcap_hdr) + sizeof(guint32);
849 gchar buf[sizeof(struct pcap_hdr) + sizeof(guint32)];
850 while (bytes_left != 0) {
851 ssize_t bytes = read(fd, buf, (int)bytes_left);
853 cmdarg_err("Not enough bytes for pcap header.");
860 /* Process the packets in the file */
861 if (!load_cap_file(&cfile)) {
862 epan_free(cfile.epan);
867 /* If you want to capture live packets, use TShark. */
868 cmdarg_err("Input file or pipe name not specified.");
872 epan_free(cfile.epan);
879 * Read data from a raw pipe. The "raw" data consists of a libpcap
880 * packet header followed by the payload.
881 * @param pd [IN] A POSIX file descriptor. Because that's _exactly_ the sort
882 * of thing you want to use in Windows.
883 * @param phdr [OUT] Packet header information.
884 * @param err [OUT] Error indicator. Uses wiretap values.
885 * @param err_info [OUT] Error message.
886 * @param data_offset [OUT] data offset in the pipe.
887 * @return TRUE on success, FALSE on failure.
890 raw_pipe_read(struct wtap_pkthdr *phdr, guchar * pd, int *err, gchar **err_info, gint64 *data_offset) {
891 struct pcap_pkthdr mem_hdr;
892 struct pcaprec_hdr disk_hdr;
893 ssize_t bytes_read = 0;
894 size_t bytes_needed = sizeof(disk_hdr);
895 guchar *ptr = (guchar*) &disk_hdr;
897 if (want_pcap_pkthdr) {
898 bytes_needed = sizeof(mem_hdr);
899 ptr = (guchar*) &mem_hdr;
902 /* Copied from capture_loop.c */
903 while (bytes_needed > 0) {
904 bytes_read = read(fd, ptr, (int)bytes_needed);
905 if (bytes_read == 0) {
909 } else if (bytes_read < 0) {
914 bytes_needed -= bytes_read;
915 *data_offset += bytes_read;
919 if (want_pcap_pkthdr) {
920 phdr->ts.secs = mem_hdr.ts.tv_sec;
921 phdr->ts.nsecs = (gint32)mem_hdr.ts.tv_usec * 1000;
922 phdr->caplen = mem_hdr.caplen;
923 phdr->len = mem_hdr.len;
925 phdr->ts.secs = disk_hdr.ts_sec;
926 phdr->ts.nsecs = disk_hdr.ts_usec * 1000;
927 phdr->caplen = disk_hdr.incl_len;
928 phdr->len = disk_hdr.orig_len;
930 bytes_needed = phdr->caplen;
932 phdr->pkt_encap = encap;
935 printf("mem_hdr: %lu disk_hdr: %lu\n", sizeof(mem_hdr), sizeof(disk_hdr));
936 printf("tv_sec: %u (%04x)\n", (unsigned int) phdr->ts.secs, (unsigned int) phdr->ts.secs);
937 printf("tv_nsec: %d (%04x)\n", phdr->ts.nsecs, phdr->ts.nsecs);
938 printf("caplen: %d (%04x)\n", phdr->caplen, phdr->caplen);
939 printf("len: %d (%04x)\n", phdr->len, phdr->len);
941 if (bytes_needed > WTAP_MAX_PACKET_SIZE) {
942 *err = WTAP_ERR_BAD_FILE;
943 *err_info = g_strdup_printf("Bad packet length: %lu\n",
944 (unsigned long) bytes_needed);
949 while (bytes_needed > 0) {
950 bytes_read = read(fd, ptr, (int)bytes_needed);
951 if (bytes_read == 0) {
952 *err = WTAP_ERR_SHORT_READ;
955 } else if (bytes_read < 0) {
960 bytes_needed -= bytes_read;
961 *data_offset += bytes_read;
968 load_cap_file(capture_file *cf)
972 gint64 data_offset = 0;
974 guchar pd[WTAP_MAX_PACKET_SIZE];
975 struct wtap_pkthdr phdr;
978 wtap_phdr_init(&phdr);
980 epan_dissect_init(&edt, cf->epan, TRUE, FALSE);
982 while (raw_pipe_read(&phdr, pd, &err, &err_info, &data_offset)) {
983 process_packet(cf, &edt, data_offset, &phdr, pd);
986 epan_dissect_cleanup(&edt);
988 wtap_phdr_cleanup(&phdr);
991 /* Print a message noting that the read failed somewhere along the line. */
994 case WTAP_ERR_UNSUPPORTED:
995 cmdarg_err("The file \"%s\" contains record data that Rawshark doesn't support.\n(%s)",
997 err_info != NULL ? err_info : "no information supplied");
1001 case WTAP_ERR_SHORT_READ:
1002 cmdarg_err("The file \"%s\" appears to have been cut short in the middle of a packet.",
1006 case WTAP_ERR_BAD_FILE:
1007 cmdarg_err("The file \"%s\" appears to be damaged or corrupt.\n(%s)",
1009 err_info != NULL ? err_info : "no information supplied");
1013 case WTAP_ERR_DECOMPRESS:
1014 cmdarg_err("The compressed file \"%s\" appears to be damaged or corrupt.\n(%s)",
1016 err_info != NULL ? err_info : "no information supplied");
1021 cmdarg_err("An error occurred while reading the file \"%s\": %s.",
1022 cf->filename, wtap_strerror(err));
1032 process_packet(capture_file *cf, epan_dissect_t *edt, gint64 offset,
1033 struct wtap_pkthdr *whdr, const guchar *pd)
1041 /* The user sends an empty packet when he wants to get output from us even if we don't currently have
1042 packets to process. We spit out a line with the timestamp and the text "void"
1044 printf("%lu %lu %lu void -\n", (unsigned long int)cf->count,
1045 (unsigned long int)whdr->ts.secs,
1046 (unsigned long int)whdr->ts.nsecs);
1053 /* Count this packet. */
1056 /* If we're going to print packet information, or we're going to
1057 run a read filter, or we're going to process taps, set up to
1058 do a dissection and do so. */
1059 frame_data_init(&fdata, cf->count, whdr, offset, cum_bytes);
1063 /* If we're running a read filter, prime the epan_dissect_t with that
1065 if (n_rfilters > 0) {
1066 for(i = 0; i < n_rfcodes; i++) {
1067 epan_dissect_prime_dfilter(edt, rfcodes[i]);
1071 printf("%lu", (unsigned long int) cf->count);
1073 frame_data_set_before_dissect(&fdata, &cf->elapsed_time,
1076 if (ref == &fdata) {
1081 /* We only need the columns if we're printing packet info but we're
1082 *not* verbose; in verbose mode, we print the protocol tree, not
1083 the protocol summary. */
1084 epan_dissect_run_with_taps(edt, cf->cd_t, whdr, frame_tvbuff_new(&fdata, pd), &fdata, &cf->cinfo);
1086 frame_data_set_after_dissect(&fdata, &cum_bytes);
1087 prev_dis_frame = fdata;
1088 prev_dis = &prev_dis_frame;
1090 prev_cap_frame = fdata;
1091 prev_cap = &prev_cap_frame;
1093 for(i = 0; i < n_rfilters; i++) {
1094 /* Run the read filter if we have one. */
1096 passed = dfilter_apply_edt(rfcodes[i], edt);
1100 /* Print a one-line summary */
1101 printf(" %u", passed ? 1 : 0);
1106 /* The ANSI C standard does not appear to *require* that a line-buffered
1107 stream be flushed to the host environment whenever a newline is
1108 written, it just says that, on such a stream, characters "are
1109 intended to be transmitted to or from the host environment as a
1110 block when a new-line character is encountered".
1112 The Visual C++ 6.0 C implementation doesn't do what is intended;
1113 even if you set a stream to be line-buffered, it still doesn't
1114 flush the buffer at the end of every line.
1116 So, if the "-l" flag was specified, we flush the standard output
1117 at the end of a packet. This will do the right thing if we're
1118 printing packet summary lines, and, as we print the entire protocol
1119 tree for a single packet without waiting for anything to happen,
1120 it should be as good as line-buffered mode if we're printing
1121 protocol trees. (The whole reason for the "-l" flag in either
1122 tcpdump or Rawshark is to allow the output of a live capture to
1123 be piped to a program or script and to have that script see the
1124 information for the packet as soon as it's printed, rather than
1125 having to wait until a standard I/O buffer fills up. */
1129 if (ferror(stdout)) {
1130 show_print_file_io_error(errno);
1134 epan_dissect_reset(edt);
1135 frame_data_destroy(&fdata);
1140 /****************************************************************************************
1141 * FIELD EXTRACTION ROUTINES
1142 ****************************************************************************************/
1143 typedef struct _pci_t {
1149 static const char* ftenum_to_string(header_field_info *hfi)
1155 if (string_fmts->len > 0 && hfi->strings) {
1163 return "FT_PROTOCOL";
1165 return "FT_BOOLEAN";
1190 case FT_ABSOLUTE_TIME:
1191 return "FT_ABSOLUTE_TIME";
1192 case FT_RELATIVE_TIME:
1193 return "FT_RELATIVE_TIME";
1197 return "FT_STRINGZ";
1198 case FT_UINT_STRING:
1199 return "FT_UINT_STRING";
1205 return "FT_UINT_BYTES";
1213 return "FT_FRAMENUM";
1221 return "FT_REL_OID";
1223 return "FT_SYSTEM_ID";
1225 return "FT_STRIGZPAD";
1227 return "FT_NUM_TYPES";
1233 static const char* absolute_time_display_e_to_string(absolute_time_display_e atd)
1236 case ABSOLUTE_TIME_LOCAL:
1237 return "ABSOLUTE_TIME_LOCAL";
1238 case ABSOLUTE_TIME_UTC:
1239 return "ABSOLUTE_TIME_UTC";
1245 static const char* field_display_e_to_string(field_display_e bd)
1257 return "BASE_DEC_HEX";
1259 return "BASE_HEX_DEC";
1266 * Copied from various parts of proto.c
1268 #define FIELD_STR_INIT_LEN 256
1269 #define cVALS(x) (const value_string*)(x)
1270 static gboolean print_field_value(field_info *finfo, int cmd_line_index)
1272 header_field_info *hfinfo;
1273 static char *fs_buf = NULL;
1274 char *fs_ptr = fs_buf;
1275 static GString *label_s = NULL;
1276 int fs_buf_len = FIELD_STR_INIT_LEN, fs_len;
1283 const true_false_string *tfstring = &tfs_true_false;
1285 hfinfo = finfo->hfinfo;
1288 fs_buf = (char *)g_malloc(fs_buf_len + 1);
1293 label_s = g_string_new("");
1296 if(finfo->value.ftype->val_to_string_repr)
1299 * this field has an associated value,
1302 fs_len = fvalue_string_repr_len(&finfo->value, FTREPR_DFILTER);
1303 while (fs_buf_len < fs_len) {
1305 fs_buf = (char *)g_realloc(fs_buf, fs_buf_len + 1);
1308 fvalue_to_string_repr(&finfo->value,
1312 /* String types are quoted. Remove them. */
1313 if (IS_FT_STRING(finfo->value.ftype->ftype) && fs_len > 2) {
1314 fs_buf[fs_len - 1] = '\0';
1319 if (string_fmts->len > 0 && finfo->hfinfo->strings) {
1320 g_string_truncate(label_s, 0);
1321 for (i = 0; i < string_fmts->len; i++) {
1322 sf = (string_fmt_t *)g_ptr_array_index(string_fmts, i);
1324 g_string_append(label_s, sf->plain);
1326 switch (sf->format) {
1328 g_string_append(label_s, hfinfo->name);
1331 g_string_append(label_s, fs_ptr);
1334 switch(hfinfo->type) {
1336 uvalue = fvalue_get_uinteger(&finfo->value);
1337 tfstring = (const struct true_false_string*) hfinfo->strings;
1338 g_string_append(label_s, uvalue ? tfstring->true_string : tfstring->false_string);
1344 DISSECTOR_ASSERT(!hfinfo->bitmask);
1345 svalue = fvalue_get_sinteger(&finfo->value);
1346 if (hfinfo->display & BASE_RANGE_STRING) {
1347 g_string_append(label_s, rval_to_str_const(svalue, RVALS(hfinfo->strings), "Unknown"));
1348 } else if (hfinfo->display & BASE_EXT_STRING) {
1349 g_string_append(label_s, val_to_str_ext_const(svalue, (value_string_ext *) hfinfo->strings, "Unknown"));
1351 g_string_append(label_s, val_to_str_const(svalue, cVALS(hfinfo->strings), "Unknown"));
1355 DISSECTOR_ASSERT(!hfinfo->bitmask);
1356 svalue64 = (gint64)fvalue_get_integer64(&finfo->value);
1357 if (hfinfo->display & BASE_VAL64_STRING) {
1358 g_string_append(label_s, val64_to_str_const(svalue64, (const val64_string *)(hfinfo->strings), "Unknown"));
1365 uvalue = fvalue_get_uinteger(&finfo->value);
1366 if (!hfinfo->bitmask && hfinfo->display & BASE_RANGE_STRING) {
1367 g_string_append(label_s, rval_to_str_const(uvalue, RVALS(hfinfo->strings), "Unknown"));
1368 } else if (hfinfo->display & BASE_EXT_STRING) {
1369 g_string_append(label_s, val_to_str_ext_const(uvalue, (value_string_ext *) hfinfo->strings, "Unknown"));
1371 g_string_append(label_s, val_to_str_const(uvalue, cVALS(hfinfo->strings), "Unknown"));
1375 DISSECTOR_ASSERT(!hfinfo->bitmask);
1376 uvalue64 = fvalue_get_integer64(&finfo->value);
1377 if (hfinfo->display & BASE_VAL64_STRING) {
1378 g_string_append(label_s, val64_to_str_const(uvalue64, (const val64_string *)(hfinfo->strings), "Unknown"));
1390 printf(" %u=\"%s\"", cmd_line_index, label_s->str);
1394 if(finfo->value.ftype->val_to_string_repr)
1396 printf(" %u=\"%s\"", cmd_line_index, fs_ptr);
1401 * This field doesn't have an associated value,
1405 printf(" %u=\"n.a.\"", cmd_line_index);
1410 protocolinfo_packet(void *prs, packet_info *pinfo _U_, epan_dissect_t *edt, const void *dummy _U_)
1412 pci_t *rs=(pci_t *)prs;
1416 gp=proto_get_finfo_ptr_array(edt->tree, rs->hf_index);
1423 * Print each occurrence of the field
1425 for (i = 0; i < gp->len; i++) {
1426 print_field_value((field_info *)gp->pdata[i], rs->cmd_line_index);
1432 int g_cmd_line_index = 0;
1435 * field must be persistent - we don't g_strdup() it below
1438 protocolinfo_init(char *field)
1441 header_field_info *hfi;
1442 GString *error_string;
1444 hfi=proto_registrar_get_byname(field);
1446 fprintf(stderr, "rawshark: Field \"%s\" doesn't exist.\n", field);
1450 switch (hfi->type) {
1452 case FT_ABSOLUTE_TIME:
1453 printf("%u %s %s - ",
1455 ftenum_to_string(hfi),
1456 absolute_time_display_e_to_string((absolute_time_display_e)hfi->display));
1460 printf("%u %s %s - ",
1462 ftenum_to_string(hfi),
1463 field_display_e_to_string((field_display_e)hfi->display));
1467 rs=(pci_t *)g_malloc(sizeof(pci_t));
1468 rs->hf_index=hfi->id;
1470 rs->cmd_line_index = g_cmd_line_index++;
1472 error_string=register_tap_listener("frame", rs, rs->filter, TL_REQUIRES_PROTO_TREE, NULL, protocolinfo_packet, NULL);
1474 /* error, we failed to attach to the tap. complain and clean up */
1475 fprintf(stderr, "rawshark: Couldn't register field extraction tap: %s\n",
1477 g_string_free(error_string, TRUE);
1488 * Given a format string, split it into a GPtrArray of string_fmt_t structs
1489 * and fill in string_fmt_parts.
1493 add_string_fmt(string_fmt_e format, gchar *plain) {
1494 string_fmt_t *sf = (string_fmt_t *)g_malloc(sizeof(string_fmt_t));
1496 sf->format = format;
1497 sf->plain = g_strdup(plain);
1499 g_ptr_array_add(string_fmts, sf);
1503 parse_field_string_format(gchar *format) {
1504 GString *plain_s = g_string_new("");
1512 len = strlen(format);
1513 g_ptr_array_set_size(string_fmts, 0);
1516 if (format[pos] == '%') {
1517 if (pos >= len) { /* There should always be a following character */
1521 if (plain_s->len > 0) {
1522 add_string_fmt(SF_NONE, plain_s->str);
1523 g_string_truncate(plain_s, 0);
1525 switch (format[pos]) {
1527 add_string_fmt(SF_NAME, NULL);
1530 add_string_fmt(SF_NUMVAL, NULL);
1533 add_string_fmt(SF_STRVAL, NULL);
1536 g_string_append_c(plain_s, '%');
1538 default: /* Invalid format */
1542 g_string_append_c(plain_s, format[pos]);
1547 if (plain_s->len > 0) {
1548 add_string_fmt(SF_NONE, plain_s->str);
1550 g_string_free(plain_s, TRUE);
1554 /****************************************************************************************
1555 * END OF FIELD EXTRACTION ROUTINES
1556 ****************************************************************************************/
1559 show_print_file_io_error(int err)
1564 cmdarg_err("Not all the packets could be printed because there is "
1565 "no space left on the file system.");
1570 cmdarg_err("Not all the packets could be printed because you are "
1571 "too close to, or over your disk quota.");
1576 cmdarg_err("An error occurred while printing packets: %s.",
1583 * Open/create errors are reported with an console message in Rawshark.
1586 open_failure_message(const char *filename, int err, gboolean for_writing)
1588 fprintf(stderr, "rawshark: ");
1589 fprintf(stderr, file_open_error_message(err, for_writing), filename);
1590 fprintf(stderr, "\n");
1593 static const nstime_t *
1594 raw_get_frame_ts(void *data _U_, guint32 frame_num)
1596 if (ref && ref->num == frame_num)
1597 return &ref->abs_ts;
1599 if (prev_dis && prev_dis->num == frame_num)
1600 return &prev_dis->abs_ts;
1602 if (prev_cap && prev_cap->num == frame_num)
1603 return &prev_cap->abs_ts;
1609 raw_epan_new(capture_file *cf)
1611 epan_t *epan = epan_new();
1614 epan->get_frame_ts = raw_get_frame_ts;
1615 epan->get_interface_name = cap_file_get_interface_name;
1616 epan->get_user_comment = NULL;
1622 raw_cf_open(capture_file *cf, const char *fname)
1624 if ((fd = raw_pipe_open(fname)) < 0)
1627 /* The open succeeded. Fill in the information for this file. */
1629 /* Create new epan session for dissection. */
1630 epan_free(cf->epan);
1631 cf->epan = raw_epan_new(cf);
1634 cf->f_datalen = 0; /* not used, but set it anyway */
1636 /* Set the file name because we need it to set the follow stream filter.
1637 XXX - is that still true? We need it for other reasons, though,
1639 cf->filename = g_strdup(fname);
1641 /* Indicate whether it's a permanent or temporary file. */
1642 cf->is_tempfile = FALSE;
1644 /* No user changes yet. */
1645 cf->unsaved_changes = FALSE;
1647 cf->cd_t = WTAP_FILE_TYPE_SUBTYPE_UNKNOWN;
1648 cf->open_type = WTAP_TYPE_AUTO;
1650 cf->drops_known = FALSE;
1652 cf->has_snap = FALSE;
1653 cf->snap = WTAP_MAX_PACKET_SIZE;
1654 nstime_set_zero(&cf->elapsed_time);
1664 * General errors are reported with an console message in Rawshark.
1667 failure_message(const char *msg_format, va_list ap)
1669 fprintf(stderr, "rawshark: ");
1670 vfprintf(stderr, msg_format, ap);
1671 fprintf(stderr, "\n");
1675 * Read errors are reported with an console message in Rawshark.
1678 read_failure_message(const char *filename, int err)
1680 cmdarg_err("An error occurred while reading from the file \"%s\": %s.",
1681 filename, g_strerror(err));
1685 * Write errors are reported with an console message in Rawshark.
1688 write_failure_message(const char *filename, int err)
1690 cmdarg_err("An error occurred while writing to the file \"%s\": %s.",
1691 filename, g_strerror(err));
1695 * Report an error in command-line arguments.
1698 rawshark_cmdarg_err(const char *fmt, va_list ap)
1700 fprintf(stderr, "rawshark: ");
1701 vfprintf(stderr, fmt, ap);
1702 fprintf(stderr, "\n");
1706 * Report additional information for an error in command-line arguments.
1709 rawshark_cmdarg_err_cont(const char *fmt, va_list ap)
1711 vfprintf(stderr, fmt, ap);
1712 fprintf(stderr, "\n");
1721 * indent-tabs-mode: nil
1724 * ex: set shiftwidth=4 tabstop=8 expandtab:
1725 * :indentSize=4:tabSize=8:noTabs=true: