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 */
124 * This is the template for the decode as option; it is shared between the
125 * various functions that output the usage for this parameter.
127 static const gchar decode_as_arg_template[] = "<layer_type>==<selector>,<decode_as_protocol>";
130 static guint32 cum_bytes;
131 static const frame_data *ref;
132 static frame_data ref_frame;
133 static frame_data *prev_dis;
134 static frame_data prev_dis_frame;
135 static frame_data *prev_cap;
136 static frame_data prev_cap_frame;
139 * The way the packet decode is to be written.
142 WRITE_TEXT, /* summary or detail text */
143 WRITE_XML /* PDML or PSML */
144 /* Add CSV and the like here */
147 static gboolean line_buffered;
148 static print_format_e print_format = PR_FMT_TEXT;
150 static gboolean want_pcap_pkthdr;
152 cf_status_t raw_cf_open(capture_file *cf, const char *fname);
153 static gboolean load_cap_file(capture_file *cf);
154 static gboolean process_packet(capture_file *cf, epan_dissect_t *edt, gint64 offset,
155 struct wtap_pkthdr *whdr, const guchar *pd);
156 static void show_print_file_io_error(int err);
158 static void open_failure_message(const char *filename, int err,
159 gboolean for_writing);
160 static void failure_message(const char *msg_format, va_list ap);
161 static void read_failure_message(const char *filename, int err);
162 static void write_failure_message(const char *filename, int err);
163 static void rawshark_cmdarg_err(const char *fmt, va_list ap);
164 static void rawshark_cmdarg_err_cont(const char *fmt, va_list ap);
165 static void protocolinfo_init(char *field);
166 static gboolean parse_field_string_format(char *format);
169 SF_NONE, /* No format (placeholder) */
170 SF_NAME, /* %D Field name / description */
171 SF_NUMVAL, /* %N Numeric value */
172 SF_STRVAL /* %S String value */
175 typedef struct string_fmt_s {
177 string_fmt_e format; /* Valid if plain is NULL */
183 dfilter_t *rfcodes[64];
185 dfilter_t *rfieldfcodes[64];
188 GPtrArray *string_fmts;
191 print_usage(FILE *output)
193 fprintf(output, "\n");
194 fprintf(output, "Usage: rawshark [options] ...\n");
195 fprintf(output, "\n");
197 fprintf(output, "Input file:\n");
198 fprintf(output, " -r <infile> set the pipe or file name to read from\n");
200 fprintf(output, "\n");
201 fprintf(output, "Processing:\n");
202 fprintf(output, " -d <encap:linktype>|<proto:protoname>\n");
203 fprintf(output, " packet encapsulation or protocol\n");
204 fprintf(output, " -F <field> field to display\n");
205 fprintf(output, " -n disable all name resolution (def: all enabled)\n");
206 fprintf(output, " -N <name resolve flags> enable specific name resolution(s): \"mntC\"\n");
207 fprintf(output, " -p use the system's packet header format\n");
208 fprintf(output, " (which may have 64-bit timestamps)\n");
209 fprintf(output, " -R <read filter> packet filter in Wireshark display filter syntax\n");
210 fprintf(output, " -s skip PCAP header on input\n");
212 fprintf(output, "\n");
213 fprintf(output, "Output:\n");
214 fprintf(output, " -l flush output after each packet\n");
215 fprintf(output, " -S format string for fields\n");
216 fprintf(output, " (%%D - name, %%S - stringval, %%N numval)\n");
217 fprintf(output, " -t ad|a|r|d|dd|e output format of time stamps (def: r: rel. to first)\n");
219 fprintf(output, "\n");
220 fprintf(output, "Miscellaneous:\n");
221 fprintf(output, " -h display this help and exit\n");
222 fprintf(output, " -o <name>:<value> ... override preference setting\n");
223 fprintf(output, " -v display version info and exit\n");
227 log_func_ignore (const gchar *log_domain _U_, GLogLevelFlags log_level _U_,
228 const gchar *message _U_, gpointer user_data _U_)
233 * Open a pipe for raw input. This is a stripped-down version of
234 * pcap_loop.c:cap_pipe_open_live().
235 * We check if "pipe_name" is "-" (stdin) or a FIFO, and open it.
236 * @param pipe_name The name of the pipe or FIFO.
237 * @return A POSIX file descriptor on success, or -1 on failure.
240 raw_pipe_open(const char *pipe_name)
243 ws_statb64 pipe_stat;
245 char *pncopy, *pos = NULL;
252 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "open_raw_pipe: %s", pipe_name);
255 * XXX Rawshark blocks until we return
257 if (strcmp(pipe_name, "-") == 0) {
258 rfd = 0; /* read from stdin */
261 * This is needed to set the stdin pipe into binary mode, otherwise
262 * CR/LF are mangled...
264 _setmode(0, _O_BINARY);
268 if (ws_stat64(pipe_name, &pipe_stat) < 0) {
269 fprintf(stderr, "rawshark: The pipe %s could not be checked: %s\n",
270 pipe_name, g_strerror(errno));
273 if (! S_ISFIFO(pipe_stat.st_mode)) {
274 if (S_ISCHR(pipe_stat.st_mode)) {
276 * Assume the user specified an interface on a system where
277 * interfaces are in /dev. Pretend we haven't seen it.
281 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
286 rfd = ws_open(pipe_name, O_RDONLY | O_NONBLOCK, 0000 /* no creation so don't matter */);
288 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
289 pipe_name, g_strerror(errno));
293 #define PIPE_STR "\\pipe\\"
294 /* Under Windows, named pipes _must_ have the form
295 * "\\<server>\pipe\<pipe_name>". <server> may be "." for localhost.
297 pncopy = g_strdup(pipe_name);
298 if (strstr(pncopy, "\\\\") == pncopy) {
299 pos = strchr(pncopy + 3, '\\');
300 if (pos && g_ascii_strncasecmp(pos, PIPE_STR, strlen(PIPE_STR)) != 0)
307 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
312 /* Wait for the pipe to appear */
314 hPipe = CreateFile(utf_8to16(pipe_name), GENERIC_READ, 0, NULL,
315 OPEN_EXISTING, 0, NULL);
317 if (hPipe != INVALID_HANDLE_VALUE)
320 err = GetLastError();
321 if (err != ERROR_PIPE_BUSY) {
322 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
323 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
324 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s (error %d)\n",
325 pipe_name, utf_16to8(err_str), err);
330 if (!WaitNamedPipe(utf_8to16(pipe_name), 30 * 1000)) {
331 err = GetLastError();
332 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
333 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
334 fprintf(stderr, "rawshark: \"%s\" could not be waited for: %s (error %d)\n",
335 pipe_name, utf_16to8(err_str), err);
341 rfd = _open_osfhandle((long) hPipe, _O_RDONLY);
343 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
344 pipe_name, g_strerror(errno));
354 * Parse a link-type argument of the form "encap:<pcap linktype>" or
355 * "proto:<proto name>". "Pcap linktype" must be a name conforming to
356 * pcap_datalink_name_to_val() or an integer; the integer should be
357 * a LINKTYPE_ value supported by Wiretap. "Proto name" must be
358 * a protocol name, e.g. "http".
361 set_link_type(const char *lt_arg) {
362 char *spec_ptr = strchr(lt_arg, ':');
366 dissector_handle_t dhandle;
374 if (strncmp(lt_arg, "encap:", strlen("encap:")) == 0) {
375 dlt_val = linktype_name_to_val(spec_ptr);
378 val = strtol(spec_ptr, &p, 10);
379 if (p == spec_ptr || *p != '\0' || errno != 0 || val > INT_MAX) {
385 * In those cases where a given link-layer header type
386 * has different LINKTYPE_ and DLT_ values, linktype_name_to_val()
387 * will return the OS's DLT_ value for that link-layer header
388 * type, not its OS-independent LINKTYPE_ value.
390 * On a given OS, wtap_pcap_encap_to_wtap_encap() should
391 * be able to map either LINKTYPE_ values or DLT_ values
392 * for the OS to the appropriate Wiretap encapsulation.
394 encap = wtap_pcap_encap_to_wtap_encap(dlt_val);
395 if (encap == WTAP_ENCAP_UNKNOWN) {
399 } else if (strncmp(lt_arg, "proto:", strlen("proto:")) == 0) {
400 dhandle = find_dissector(spec_ptr);
402 encap = WTAP_ENCAP_USER0;
403 pref_str = g_string_new("uat:user_dlts:");
404 /* This must match the format used in the user_dlts file */
405 g_string_append_printf(pref_str,
406 "\"User 0 (DLT=147)\",\"%s\",\"0\",\"\",\"0\",\"\"",
408 if (prefs_set_pref(pref_str->str) != PREFS_SET_OK) {
409 g_string_free(pref_str, TRUE);
412 g_string_free(pref_str, TRUE);
420 main(int argc, char *argv[])
422 GString *comp_info_str;
423 GString *runtime_info_str;
424 char *init_progfile_dir_error;
426 gboolean arg_error = FALSE;
432 char *gpf_path, *pf_path;
433 char *gdp_path, *dp_path;
434 int gpf_open_errno, gpf_read_errno;
435 int pf_open_errno, pf_read_errno;
436 int gdp_open_errno, gdp_read_errno;
437 int dp_open_errno, dp_read_errno;
438 gchar *pipe_name = NULL;
443 GPtrArray *disp_fields = g_ptr_array_new();
445 gboolean skip_pcap_header = FALSE;
446 static const struct option long_options[] = {
447 {(char *)"help", no_argument, NULL, 'h'},
448 {(char *)"version", no_argument, NULL, 'v'},
452 #define OPTSTRING_INIT "d:F:hlnN:o:pr:R:sS:t:v"
454 static const char optstring[] = OPTSTRING_INIT;
456 cmdarg_err_init(rawshark_cmdarg_err, rawshark_cmdarg_err_cont);
458 /* Assemble the compile-time version information string */
459 comp_info_str = g_string_new("Compiled ");
460 get_compiled_version_info(comp_info_str, NULL, epan_get_compiled_version_info);
462 /* Assemble the run-time version information string */
463 runtime_info_str = g_string_new("Running ");
464 get_runtime_version_info(runtime_info_str, NULL);
466 /* Add it to the information to be reported on a crash. */
467 ws_add_crash_info("Rawshark (Wireshark) %s\n"
472 get_ws_vcs_version_info(), comp_info_str->str, runtime_info_str->str);
475 arg_list_utf_16to8(argc, argv);
476 create_app_running_mutex();
480 * Get credential information for later use.
482 init_process_policies();
485 * Clear the filters arrays
487 memset(rfilters, 0, sizeof(rfilters));
488 memset(rfcodes, 0, sizeof(rfcodes));
493 * Initialize our string format
495 string_fmts = g_ptr_array_new();
498 * Attempt to get the pathname of the executable file.
500 init_progfile_dir_error = init_progfile_dir(argv[0], main);
501 if (init_progfile_dir_error != NULL) {
502 fprintf(stderr, "rawshark: Can't get pathname of rawshark program: %s.\n",
503 init_progfile_dir_error);
507 * Get credential information for later use.
509 init_process_policies();
511 /* nothing more than the standard GLib handler, but without a warning */
513 G_LOG_LEVEL_WARNING |
514 G_LOG_LEVEL_MESSAGE |
518 g_log_set_handler(NULL,
519 (GLogLevelFlags)log_flags,
520 log_func_ignore, NULL /* user_data */);
521 g_log_set_handler(LOG_DOMAIN_CAPTURE_CHILD,
522 (GLogLevelFlags)log_flags,
523 log_func_ignore, NULL /* user_data */);
525 init_report_err(failure_message, open_failure_message, read_failure_message,
526 write_failure_message);
528 timestamp_set_type(TS_RELATIVE);
529 timestamp_set_precision(TS_PREC_AUTO);
530 timestamp_set_seconds_type(TS_SECONDS_DEFAULT);
532 /* Register all dissectors; we must do this before checking for the
533 "-G" flag, as the "-G" flag dumps information registered by the
534 dissectors, and we must do it before we read the preferences, in
535 case any dissectors register preferences. */
536 epan_init(register_all_protocols, register_all_protocol_handoffs, NULL, NULL);
538 /* Set the C-language locale to the native environment. */
539 setlocale(LC_ALL, "");
541 prefs_p = read_prefs(&gpf_open_errno, &gpf_read_errno, &gpf_path,
542 &pf_open_errno, &pf_read_errno, &pf_path);
543 if (gpf_path != NULL) {
544 if (gpf_open_errno != 0) {
545 cmdarg_err("Can't open global preferences file \"%s\": %s.",
546 pf_path, g_strerror(gpf_open_errno));
548 if (gpf_read_errno != 0) {
549 cmdarg_err("I/O error reading global preferences file \"%s\": %s.",
550 pf_path, g_strerror(gpf_read_errno));
553 if (pf_path != NULL) {
554 if (pf_open_errno != 0) {
555 cmdarg_err("Can't open your preferences file \"%s\": %s.", pf_path,
556 g_strerror(pf_open_errno));
558 if (pf_read_errno != 0) {
559 cmdarg_err("I/O error reading your preferences file \"%s\": %s.",
560 pf_path, g_strerror(pf_read_errno));
566 /* Read the disabled protocols file. */
567 read_disabled_protos_list(&gdp_path, &gdp_open_errno, &gdp_read_errno,
568 &dp_path, &dp_open_errno, &dp_read_errno);
569 if (gdp_path != NULL) {
570 if (gdp_open_errno != 0) {
571 cmdarg_err("Could not open global disabled protocols file\n\"%s\": %s.",
572 gdp_path, g_strerror(gdp_open_errno));
574 if (gdp_read_errno != 0) {
575 cmdarg_err("I/O error reading global disabled protocols file\n\"%s\": %s.",
576 gdp_path, g_strerror(gdp_read_errno));
580 if (dp_path != NULL) {
581 if (dp_open_errno != 0) {
583 "Could not open your disabled protocols file\n\"%s\": %s.", dp_path,
584 g_strerror(dp_open_errno));
586 if (dp_read_errno != 0) {
588 "I/O error reading your disabled protocols file\n\"%s\": %s.", dp_path,
589 g_strerror(dp_read_errno));
595 /* Load Wpcap, if possible */
599 cap_file_init(&cfile);
601 /* Print format defaults to this. */
602 print_format = PR_FMT_TEXT;
604 /* Initialize our encapsulation type */
605 encap = WTAP_ENCAP_UNKNOWN;
607 /* Now get our args */
608 /* XXX - We should probably have an option to dump libpcap link types */
609 while ((opt = getopt_long(argc, argv, optstring, long_options, NULL)) != -1) {
611 case 'd': /* Payload type */
612 if (!set_link_type(optarg)) {
613 cmdarg_err("Invalid link type or protocol \"%s\"", optarg);
617 case 'F': /* Read field to display */
618 g_ptr_array_add(disp_fields, g_strdup(optarg));
620 case 'h': /* Print help and exit */
621 printf("Rawshark (Wireshark) %s\n"
622 "Dump and analyze network traffic.\n"
623 "See http://www.wireshark.org for more information.\n",
624 get_ws_vcs_version_info());
628 case 'l': /* "Line-buffer" standard output */
629 /* This isn't line-buffering, strictly speaking, it's just
630 flushing the standard output after the information for
631 each packet is printed; however, that should be good
632 enough for all the purposes to which "-l" is put (and
633 is probably actually better for "-V", as it does fewer
636 See the comment in "process_packet()" for an explanation of
637 why we do that, and why we don't just use "setvbuf()" to
638 make the standard output line-buffered (short version: in
639 Windows, "line-buffered" is the same as "fully-buffered",
640 and the output buffer is only flushed when it fills up). */
641 line_buffered = TRUE;
643 case 'n': /* No name resolution */
644 gbl_resolv_flags.mac_name = FALSE;
645 gbl_resolv_flags.network_name = FALSE;
646 gbl_resolv_flags.transport_name = FALSE;
647 gbl_resolv_flags.concurrent_dns = FALSE;
649 case 'N': /* Select what types of addresses/port #s to resolve */
650 badopt = string_to_name_resolve(optarg, &gbl_resolv_flags);
651 if (badopt != '\0') {
652 cmdarg_err("-N specifies unknown resolving option '%c'; valid options are 'm', 'n', and 't'",
657 case 'o': /* Override preference from command line */
658 switch (prefs_set_pref(optarg)) {
663 case PREFS_SET_SYNTAX_ERR:
664 cmdarg_err("Invalid -o flag \"%s\"", optarg);
668 case PREFS_SET_NO_SUCH_PREF:
669 case PREFS_SET_OBSOLETE:
670 cmdarg_err("-o flag \"%s\" specifies unknown preference", optarg);
675 case 'p': /* Expect pcap_pkthdr packet headers, which may have 64-bit timestamps */
676 want_pcap_pkthdr = TRUE;
678 case 'r': /* Read capture file xxx */
679 pipe_name = g_strdup(optarg);
681 case 'R': /* Read file filter */
682 if(n_rfilters < (int) sizeof(rfilters) / (int) sizeof(rfilters[0])) {
683 rfilters[n_rfilters++] = optarg;
686 cmdarg_err("Too many display filters");
690 case 's': /* Skip PCAP header */
691 skip_pcap_header = TRUE;
693 case 'S': /* Print string representations */
694 if (!parse_field_string_format(optarg)) {
695 cmdarg_err("Invalid field string format");
699 case 't': /* Time stamp type */
700 if (strcmp(optarg, "r") == 0)
701 timestamp_set_type(TS_RELATIVE);
702 else if (strcmp(optarg, "a") == 0)
703 timestamp_set_type(TS_ABSOLUTE);
704 else if (strcmp(optarg, "ad") == 0)
705 timestamp_set_type(TS_ABSOLUTE_WITH_YMD);
706 else if (strcmp(optarg, "adoy") == 0)
707 timestamp_set_type(TS_ABSOLUTE_WITH_YDOY);
708 else if (strcmp(optarg, "d") == 0)
709 timestamp_set_type(TS_DELTA);
710 else if (strcmp(optarg, "dd") == 0)
711 timestamp_set_type(TS_DELTA_DIS);
712 else if (strcmp(optarg, "e") == 0)
713 timestamp_set_type(TS_EPOCH);
714 else if (strcmp(optarg, "u") == 0)
715 timestamp_set_type(TS_UTC);
716 else if (strcmp(optarg, "ud") == 0)
717 timestamp_set_type(TS_UTC_WITH_YMD);
718 else if (strcmp(optarg, "udoy") == 0)
719 timestamp_set_type(TS_UTC_WITH_YDOY);
721 cmdarg_err("Invalid time stamp type \"%s\"",
724 "It must be \"a\" for absolute, \"ad\" for absolute with YYYY-MM-DD date,");
726 "\"adoy\" for absolute with YYYY/DOY date, \"d\" for delta,");
728 "\"dd\" for delta displayed, \"e\" for epoch, \"r\" for relative,");
730 "\"u\" for absolute UTC, \"ud\" for absolute UTC with YYYY-MM-DD date,");
732 "or \"udoy\" for absolute UTC with YYYY/DOY date.");
736 case 'v': /* Show version and exit */
738 show_version("Rawshark (Wireshark)", comp_info_str, runtime_info_str);
739 g_string_free(comp_info_str, TRUE);
740 g_string_free(runtime_info_str, TRUE);
745 case '?': /* Bad flag - print usage message */
752 /* Notify all registered modules that have had any of their preferences
753 changed either from one of the preferences file or from the command
754 line that their preferences have changed.
755 Initialize preferences before display filters, otherwise modules
756 like MATE won't work. */
759 /* Initialize our display fields */
760 for (fc = 0; fc < disp_fields->len; fc++) {
761 protocolinfo_init((char *)g_ptr_array_index(disp_fields, fc));
763 g_ptr_array_free(disp_fields, TRUE);
767 /* If no capture filter or read filter has been specified, and there are
768 still command-line arguments, treat them as the tokens of a capture
769 filter (if no "-r" flag was specified) or a read filter (if a "-r"
770 flag was specified. */
772 if (pipe_name != NULL) {
773 if (n_rfilters != 0) {
774 cmdarg_err("Read filters were specified both with \"-R\" "
775 "and with additional command-line arguments");
778 rfilters[n_rfilters] = get_args_as_string(argc, argv, optind);
782 /* Make sure we got a dissector handle for our payload. */
783 if (encap == WTAP_ENCAP_UNKNOWN) {
784 cmdarg_err("No valid payload dissector specified.");
795 /* Start windows sockets */
796 WSAStartup( MAKEWORD( 1, 1 ), &wsaData );
799 /* At this point MATE will have registered its field array so we can
800 have a tap filter with one of MATE's late-registered fields as part
801 of the filter. We can now process all the "-z" arguments. */
802 start_requested_stats();
804 /* disabled protocols as per configuration file */
805 if (gdp_path == NULL && dp_path == NULL) {
806 set_disabled_protos_list();
809 /* Build the column format array */
810 build_column_format_array(&cfile.cinfo, prefs_p->num_cols, TRUE);
812 if (n_rfilters != 0) {
813 for (i = 0; i < n_rfilters; i++) {
814 if (!dfilter_compile(rfilters[i], &rfcodes[n_rfcodes])) {
815 cmdarg_err("%s", dfilter_error_msg);
816 epan_free(cfile.epan);
826 * We're reading a pipe (or capture file).
830 * Immediately relinquish any special privileges we have; we must not
831 * be allowed to read any capture files the user running Rawshark
834 relinquish_special_privs_perm();
836 if (raw_cf_open(&cfile, pipe_name) != CF_OK) {
837 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 = 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);
863 /* If you want to capture live packets, use TShark. */
864 cmdarg_err("Input file or pipe name not specified.");
868 epan_free(cfile.epan);
875 * Read data from a raw pipe. The "raw" data consists of a libpcap
876 * packet header followed by the payload.
877 * @param pd [IN] A POSIX file descriptor. Because that's _exactly_ the sort
878 * of thing you want to use in Windows.
879 * @param phdr [OUT] Packet header information.
880 * @param err [OUT] Error indicator. Uses wiretap values.
881 * @param err_info [OUT] Error message.
882 * @param data_offset [OUT] data offset in the pipe.
883 * @return TRUE on success, FALSE on failure.
886 raw_pipe_read(struct wtap_pkthdr *phdr, guchar * pd, int *err, gchar **err_info, gint64 *data_offset) {
887 struct pcap_pkthdr mem_hdr;
888 struct pcaprec_hdr disk_hdr;
889 ssize_t bytes_read = 0;
890 size_t bytes_needed = sizeof(disk_hdr);
891 guchar *ptr = (guchar*) &disk_hdr;
893 if (want_pcap_pkthdr) {
894 bytes_needed = sizeof(mem_hdr);
895 ptr = (guchar*) &mem_hdr;
898 /* Copied from capture_loop.c */
899 while (bytes_needed > 0) {
900 bytes_read = read(fd, ptr, (int)bytes_needed);
901 if (bytes_read == 0) {
905 } else if (bytes_read < 0) {
910 bytes_needed -= bytes_read;
911 *data_offset += bytes_read;
915 if (want_pcap_pkthdr) {
916 phdr->ts.secs = mem_hdr.ts.tv_sec;
917 phdr->ts.nsecs = (gint32)mem_hdr.ts.tv_usec * 1000;
918 phdr->caplen = mem_hdr.caplen;
919 phdr->len = mem_hdr.len;
921 phdr->ts.secs = disk_hdr.ts_sec;
922 phdr->ts.nsecs = disk_hdr.ts_usec * 1000;
923 phdr->caplen = disk_hdr.incl_len;
924 phdr->len = disk_hdr.orig_len;
926 bytes_needed = phdr->caplen;
928 phdr->pkt_encap = encap;
931 printf("mem_hdr: %lu disk_hdr: %lu\n", sizeof(mem_hdr), sizeof(disk_hdr));
932 printf("tv_sec: %u (%04x)\n", (unsigned int) phdr->ts.secs, (unsigned int) phdr->ts.secs);
933 printf("tv_nsec: %d (%04x)\n", phdr->ts.nsecs, phdr->ts.nsecs);
934 printf("caplen: %d (%04x)\n", phdr->caplen, phdr->caplen);
935 printf("len: %d (%04x)\n", phdr->len, phdr->len);
937 if (bytes_needed > WTAP_MAX_PACKET_SIZE) {
938 *err = WTAP_ERR_BAD_FILE;
939 *err_info = g_strdup_printf("Bad packet length: %lu\n",
940 (unsigned long) bytes_needed);
945 while (bytes_needed > 0) {
946 bytes_read = read(fd, ptr, (int)bytes_needed);
947 if (bytes_read == 0) {
948 *err = WTAP_ERR_SHORT_READ;
951 } else if (bytes_read < 0) {
956 bytes_needed -= bytes_read;
957 *data_offset += bytes_read;
964 load_cap_file(capture_file *cf)
968 gint64 data_offset = 0;
970 guchar pd[WTAP_MAX_PACKET_SIZE];
971 struct wtap_pkthdr phdr;
974 wtap_phdr_init(&phdr);
976 epan_dissect_init(&edt, cf->epan, TRUE, FALSE);
978 while (raw_pipe_read(&phdr, pd, &err, &err_info, &data_offset)) {
979 process_packet(cf, &edt, data_offset, &phdr, pd);
982 epan_dissect_cleanup(&edt);
984 wtap_phdr_cleanup(&phdr);
987 /* Print a message noting that the read failed somewhere along the line. */
990 case WTAP_ERR_UNSUPPORTED:
991 cmdarg_err("The file \"%s\" contains record data that Rawshark doesn't support.\n(%s)",
993 err_info != NULL ? err_info : "no information supplied");
997 case WTAP_ERR_SHORT_READ:
998 cmdarg_err("The file \"%s\" appears to have been cut short in the middle of a packet.",
1002 case WTAP_ERR_BAD_FILE:
1003 cmdarg_err("The file \"%s\" appears to be damaged or corrupt.\n(%s)",
1005 err_info != NULL ? err_info : "no information supplied");
1009 case WTAP_ERR_DECOMPRESS:
1010 cmdarg_err("The compressed file \"%s\" appears to be damaged or corrupt.\n(%s)",
1012 err_info != NULL ? err_info : "no information supplied");
1017 cmdarg_err("An error occurred while reading the file \"%s\": %s.",
1018 cf->filename, wtap_strerror(err));
1028 process_packet(capture_file *cf, epan_dissect_t *edt, gint64 offset,
1029 struct wtap_pkthdr *whdr, const guchar *pd)
1037 /* The user sends an empty packet when he wants to get output from us even if we don't currently have
1038 packets to process. We spit out a line with the timestamp and the text "void"
1040 printf("%lu %lu %lu void -\n", (unsigned long int)cf->count,
1041 (unsigned long int)whdr->ts.secs,
1042 (unsigned long int)whdr->ts.nsecs);
1049 /* Count this packet. */
1052 /* If we're going to print packet information, or we're going to
1053 run a read filter, or we're going to process taps, set up to
1054 do a dissection and do so. */
1055 frame_data_init(&fdata, cf->count, whdr, offset, cum_bytes);
1059 /* If we're running a read filter, prime the epan_dissect_t with that
1061 if (n_rfilters > 0) {
1062 for(i = 0; i < n_rfcodes; i++) {
1063 epan_dissect_prime_dfilter(edt, rfcodes[i]);
1067 printf("%lu", (unsigned long int) cf->count);
1069 frame_data_set_before_dissect(&fdata, &cf->elapsed_time,
1072 if (ref == &fdata) {
1077 /* We only need the columns if we're printing packet info but we're
1078 *not* verbose; in verbose mode, we print the protocol tree, not
1079 the protocol summary. */
1080 epan_dissect_run_with_taps(edt, cf->cd_t, whdr, frame_tvbuff_new(&fdata, pd), &fdata, &cf->cinfo);
1082 frame_data_set_after_dissect(&fdata, &cum_bytes);
1083 prev_dis_frame = fdata;
1084 prev_dis = &prev_dis_frame;
1086 prev_cap_frame = fdata;
1087 prev_cap = &prev_cap_frame;
1089 for(i = 0; i < n_rfilters; i++) {
1090 /* Run the read filter if we have one. */
1092 passed = dfilter_apply_edt(rfcodes[i], edt);
1096 /* Print a one-line summary */
1097 printf(" %u", passed ? 1 : 0);
1102 /* The ANSI C standard does not appear to *require* that a line-buffered
1103 stream be flushed to the host environment whenever a newline is
1104 written, it just says that, on such a stream, characters "are
1105 intended to be transmitted to or from the host environment as a
1106 block when a new-line character is encountered".
1108 The Visual C++ 6.0 C implementation doesn't do what is intended;
1109 even if you set a stream to be line-buffered, it still doesn't
1110 flush the buffer at the end of every line.
1112 So, if the "-l" flag was specified, we flush the standard output
1113 at the end of a packet. This will do the right thing if we're
1114 printing packet summary lines, and, as we print the entire protocol
1115 tree for a single packet without waiting for anything to happen,
1116 it should be as good as line-buffered mode if we're printing
1117 protocol trees. (The whole reason for the "-l" flag in either
1118 tcpdump or Rawshark is to allow the output of a live capture to
1119 be piped to a program or script and to have that script see the
1120 information for the packet as soon as it's printed, rather than
1121 having to wait until a standard I/O buffer fills up. */
1125 if (ferror(stdout)) {
1126 show_print_file_io_error(errno);
1130 epan_dissect_reset(edt);
1131 frame_data_destroy(&fdata);
1136 /****************************************************************************************
1137 * FIELD EXTRACTION ROUTINES
1138 ****************************************************************************************/
1139 typedef struct _pci_t {
1145 static const char* ftenum_to_string(header_field_info *hfi)
1151 if (string_fmts->len > 0 && hfi->strings) {
1159 return "FT_PROTOCOL";
1161 return "FT_BOOLEAN";
1186 case FT_ABSOLUTE_TIME:
1187 return "FT_ABSOLUTE_TIME";
1188 case FT_RELATIVE_TIME:
1189 return "FT_RELATIVE_TIME";
1193 return "FT_STRINGZ";
1194 case FT_UINT_STRING:
1195 return "FT_UINT_STRING";
1201 return "FT_UINT_BYTES";
1209 return "FT_FRAMENUM";
1217 return "FT_REL_OID";
1219 return "FT_SYSTEM_ID";
1221 return "FT_STRIGZPAD";
1223 return "FT_NUM_TYPES";
1229 static const char* absolute_time_display_e_to_string(absolute_time_display_e atd)
1232 case ABSOLUTE_TIME_LOCAL:
1233 return "ABSOLUTE_TIME_LOCAL";
1234 case ABSOLUTE_TIME_UTC:
1235 return "ABSOLUTE_TIME_UTC";
1241 static const char* field_display_e_to_string(field_display_e bd)
1253 return "BASE_DEC_HEX";
1255 return "BASE_HEX_DEC";
1262 * Copied from various parts of proto.c
1264 #define FIELD_STR_INIT_LEN 256
1265 #define cVALS(x) (const value_string*)(x)
1266 static gboolean print_field_value(field_info *finfo, int cmd_line_index)
1268 header_field_info *hfinfo;
1269 static char *fs_buf = NULL;
1270 char *fs_ptr = fs_buf;
1271 static GString *label_s = NULL;
1272 int fs_buf_len = FIELD_STR_INIT_LEN, fs_len;
1279 const true_false_string *tfstring = &tfs_true_false;
1281 hfinfo = finfo->hfinfo;
1284 fs_buf = (char *)g_malloc(fs_buf_len + 1);
1289 label_s = g_string_new("");
1292 if(finfo->value.ftype->val_to_string_repr)
1295 * this field has an associated value,
1298 fs_len = fvalue_string_repr_len(&finfo->value, FTREPR_DFILTER);
1299 while (fs_buf_len < fs_len) {
1301 fs_buf = (char *)g_realloc(fs_buf, fs_buf_len + 1);
1304 fvalue_to_string_repr(&finfo->value,
1308 /* String types are quoted. Remove them. */
1309 if (IS_FT_STRING(finfo->value.ftype->ftype) && fs_len > 2) {
1310 fs_buf[fs_len - 1] = '\0';
1315 if (string_fmts->len > 0 && finfo->hfinfo->strings) {
1316 g_string_truncate(label_s, 0);
1317 for (i = 0; i < string_fmts->len; i++) {
1318 sf = (string_fmt_t *)g_ptr_array_index(string_fmts, i);
1320 g_string_append(label_s, sf->plain);
1322 switch (sf->format) {
1324 g_string_append(label_s, hfinfo->name);
1327 g_string_append(label_s, fs_ptr);
1330 switch(hfinfo->type) {
1332 uvalue = fvalue_get_uinteger(&finfo->value);
1333 tfstring = (const struct true_false_string*) hfinfo->strings;
1334 g_string_append(label_s, uvalue ? tfstring->true_string : tfstring->false_string);
1340 DISSECTOR_ASSERT(!hfinfo->bitmask);
1341 svalue = fvalue_get_sinteger(&finfo->value);
1342 if (hfinfo->display & BASE_RANGE_STRING) {
1343 g_string_append(label_s, rval_to_str_const(svalue, RVALS(hfinfo->strings), "Unknown"));
1344 } else if (hfinfo->display & BASE_EXT_STRING) {
1345 g_string_append(label_s, val_to_str_ext_const(svalue, (value_string_ext *) hfinfo->strings, "Unknown"));
1347 g_string_append(label_s, val_to_str_const(svalue, cVALS(hfinfo->strings), "Unknown"));
1351 DISSECTOR_ASSERT(!hfinfo->bitmask);
1352 svalue64 = (gint64)fvalue_get_integer64(&finfo->value);
1353 if (hfinfo->display & BASE_VAL64_STRING) {
1354 g_string_append(label_s, val64_to_str_const(svalue64, (const val64_string *)(hfinfo->strings), "Unknown"));
1361 uvalue = fvalue_get_uinteger(&finfo->value);
1362 if (!hfinfo->bitmask && hfinfo->display & BASE_RANGE_STRING) {
1363 g_string_append(label_s, rval_to_str_const(uvalue, RVALS(hfinfo->strings), "Unknown"));
1364 } else if (hfinfo->display & BASE_EXT_STRING) {
1365 g_string_append(label_s, val_to_str_ext_const(uvalue, (value_string_ext *) hfinfo->strings, "Unknown"));
1367 g_string_append(label_s, val_to_str_const(uvalue, cVALS(hfinfo->strings), "Unknown"));
1371 DISSECTOR_ASSERT(!hfinfo->bitmask);
1372 uvalue64 = fvalue_get_integer64(&finfo->value);
1373 if (hfinfo->display & BASE_VAL64_STRING) {
1374 g_string_append(label_s, val64_to_str_const(uvalue64, (const val64_string *)(hfinfo->strings), "Unknown"));
1386 printf(" %u=\"%s\"", cmd_line_index, label_s->str);
1390 if(finfo->value.ftype->val_to_string_repr)
1392 printf(" %u=\"%s\"", cmd_line_index, fs_ptr);
1397 * This field doesn't have an associated value,
1401 printf(" %u=\"n.a.\"", cmd_line_index);
1406 protocolinfo_packet(void *prs, packet_info *pinfo _U_, epan_dissect_t *edt, const void *dummy _U_)
1408 pci_t *rs=(pci_t *)prs;
1412 gp=proto_get_finfo_ptr_array(edt->tree, rs->hf_index);
1419 * Print each occurrence of the field
1421 for (i = 0; i < gp->len; i++) {
1422 print_field_value((field_info *)gp->pdata[i], rs->cmd_line_index);
1428 int g_cmd_line_index = 0;
1431 * field must be persistent - we don't g_strdup() it below
1434 protocolinfo_init(char *field)
1437 header_field_info *hfi;
1438 GString *error_string;
1440 hfi=proto_registrar_get_byname(field);
1442 fprintf(stderr, "rawshark: Field \"%s\" doesn't exist.\n", field);
1446 switch (hfi->type) {
1448 case FT_ABSOLUTE_TIME:
1449 printf("%u %s %s - ",
1451 ftenum_to_string(hfi),
1452 absolute_time_display_e_to_string((absolute_time_display_e)hfi->display));
1456 printf("%u %s %s - ",
1458 ftenum_to_string(hfi),
1459 field_display_e_to_string((field_display_e)hfi->display));
1463 rs=(pci_t *)g_malloc(sizeof(pci_t));
1464 rs->hf_index=hfi->id;
1466 rs->cmd_line_index = g_cmd_line_index++;
1468 error_string=register_tap_listener("frame", rs, rs->filter, TL_REQUIRES_PROTO_TREE, NULL, protocolinfo_packet, NULL);
1470 /* error, we failed to attach to the tap. complain and clean up */
1471 fprintf(stderr, "rawshark: Couldn't register field extraction tap: %s\n",
1473 g_string_free(error_string, TRUE);
1484 * Given a format string, split it into a GPtrArray of string_fmt_t structs
1485 * and fill in string_fmt_parts.
1489 add_string_fmt(string_fmt_e format, gchar *plain) {
1490 string_fmt_t *sf = (string_fmt_t *)g_malloc(sizeof(string_fmt_t));
1492 sf->format = format;
1493 sf->plain = g_strdup(plain);
1495 g_ptr_array_add(string_fmts, sf);
1499 parse_field_string_format(gchar *format) {
1500 GString *plain_s = g_string_new("");
1508 len = strlen(format);
1509 g_ptr_array_set_size(string_fmts, 0);
1512 if (format[pos] == '%') {
1513 if (pos >= len) { /* There should always be a following character */
1517 if (plain_s->len > 0) {
1518 add_string_fmt(SF_NONE, plain_s->str);
1519 g_string_truncate(plain_s, 0);
1521 switch (format[pos]) {
1523 add_string_fmt(SF_NAME, NULL);
1526 add_string_fmt(SF_NUMVAL, NULL);
1529 add_string_fmt(SF_STRVAL, NULL);
1532 g_string_append_c(plain_s, '%');
1534 default: /* Invalid format */
1538 g_string_append_c(plain_s, format[pos]);
1543 if (plain_s->len > 0) {
1544 add_string_fmt(SF_NONE, plain_s->str);
1546 g_string_free(plain_s, TRUE);
1550 /****************************************************************************************
1551 * END OF FIELD EXTRACTION ROUTINES
1552 ****************************************************************************************/
1555 show_print_file_io_error(int err)
1560 cmdarg_err("Not all the packets could be printed because there is "
1561 "no space left on the file system.");
1566 cmdarg_err("Not all the packets could be printed because you are "
1567 "too close to, or over your disk quota.");
1572 cmdarg_err("An error occurred while printing packets: %s.",
1579 * Open/create errors are reported with an console message in Rawshark.
1582 open_failure_message(const char *filename, int err, gboolean for_writing)
1584 fprintf(stderr, "rawshark: ");
1585 fprintf(stderr, file_open_error_message(err, for_writing), filename);
1586 fprintf(stderr, "\n");
1589 static const nstime_t *
1590 raw_get_frame_ts(void *data _U_, guint32 frame_num)
1592 if (ref && ref->num == frame_num)
1593 return &ref->abs_ts;
1595 if (prev_dis && prev_dis->num == frame_num)
1596 return &prev_dis->abs_ts;
1598 if (prev_cap && prev_cap->num == frame_num)
1599 return &prev_cap->abs_ts;
1605 raw_epan_new(capture_file *cf)
1607 epan_t *epan = epan_new();
1610 epan->get_frame_ts = raw_get_frame_ts;
1611 epan->get_interface_name = cap_file_get_interface_name;
1612 epan->get_user_comment = NULL;
1618 raw_cf_open(capture_file *cf, const char *fname)
1620 if ((fd = raw_pipe_open(fname)) < 0)
1623 /* The open succeeded. Fill in the information for this file. */
1625 /* Create new epan session for dissection. */
1626 epan_free(cf->epan);
1627 cf->epan = raw_epan_new(cf);
1630 cf->f_datalen = 0; /* not used, but set it anyway */
1632 /* Set the file name because we need it to set the follow stream filter.
1633 XXX - is that still true? We need it for other reasons, though,
1635 cf->filename = g_strdup(fname);
1637 /* Indicate whether it's a permanent or temporary file. */
1638 cf->is_tempfile = FALSE;
1640 /* No user changes yet. */
1641 cf->unsaved_changes = FALSE;
1643 cf->cd_t = WTAP_FILE_TYPE_SUBTYPE_UNKNOWN;
1644 cf->open_type = WTAP_TYPE_AUTO;
1646 cf->drops_known = FALSE;
1648 cf->has_snap = FALSE;
1649 cf->snap = WTAP_MAX_PACKET_SIZE;
1650 nstime_set_zero(&cf->elapsed_time);
1660 * General errors are reported with an console message in Rawshark.
1663 failure_message(const char *msg_format, va_list ap)
1665 fprintf(stderr, "rawshark: ");
1666 vfprintf(stderr, msg_format, ap);
1667 fprintf(stderr, "\n");
1671 * Read errors are reported with an console message in Rawshark.
1674 read_failure_message(const char *filename, int err)
1676 cmdarg_err("An error occurred while reading from the file \"%s\": %s.",
1677 filename, g_strerror(err));
1681 * Write errors are reported with an console message in Rawshark.
1684 write_failure_message(const char *filename, int err)
1686 cmdarg_err("An error occurred while writing to the file \"%s\": %s.",
1687 filename, g_strerror(err));
1691 * Report an error in command-line arguments.
1694 rawshark_cmdarg_err(const char *fmt, va_list ap)
1696 fprintf(stderr, "rawshark: ");
1697 vfprintf(stderr, fmt, ap);
1698 fprintf(stderr, "\n");
1702 * Report additional information for an error in command-line arguments.
1705 rawshark_cmdarg_err_cont(const char *fmt, va_list ap)
1707 vfprintf(stderr, fmt, ap);
1708 fprintf(stderr, "\n");
1717 * indent-tabs-mode: nil
1720 * ex: set shiftwidth=4 tabstop=8 expandtab:
1721 * :indentSize=4:tabSize=8:noTabs=true: