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.
57 #ifdef HAVE_SYS_STAT_H
58 # include <sys/stat.h>
61 #ifndef HAVE_GETOPT_LONG
62 #include "wsutil/wsgetopt.h"
66 #include <epan/epan-int.h>
67 #include <epan/epan.h>
69 #include <wsutil/cmdarg_err.h>
70 #include <wsutil/crash_info.h>
71 #include <wsutil/filesystem.h>
72 #include <wsutil/file_util.h>
73 #include <wsutil/plugins.h>
74 #include <wsutil/privileges.h>
75 #include <wsutil/report_err.h>
76 #include <wsutil/ws_diag_control.h>
79 #include <epan/packet.h>
80 #include <epan/ftypes/ftypes-int.h>
82 #include "frame_tvbuff.h"
83 #include <epan/disabled_protos.h>
84 #include <epan/prefs.h>
85 #include <epan/column.h>
86 #include <epan/print.h>
87 #include <epan/addr_resolv.h>
89 #include "ui/capture_ui_utils.h"
93 #include "conditions.h"
94 #include "capture_stop_conditions.h"
95 #include <epan/epan_dissect.h>
96 #include <epan/stat_tap_ui.h>
97 #include <epan/timestamp.h>
98 #include <wsutil/unicode-utils.h>
99 #include "epan/column-utils.h"
100 #include "epan/proto.h"
101 #include <epan/tap.h>
103 #include <wiretap/wtap.h>
104 #include <wiretap/libpcap.h>
105 #include <wiretap/pcap-encap.h>
107 #include <wsutil/clopts_common.h>
108 #include <wsutil/ws_version_info.h>
110 #include "caputils/capture-pcap-util.h"
115 #include "caputils/capture-wpcap.h"
117 #endif /* HAVE_LIBPCAP */
122 * This is the template for the decode as option; it is shared between the
123 * various functions that output the usage for this parameter.
125 static const gchar decode_as_arg_template[] = "<layer_type>==<selector>,<decode_as_protocol>";
128 static guint32 cum_bytes;
129 static const frame_data *ref;
130 static frame_data ref_frame;
131 static frame_data *prev_dis;
132 static frame_data prev_dis_frame;
133 static frame_data *prev_cap;
134 static frame_data prev_cap_frame;
137 * The way the packet decode is to be written.
140 WRITE_TEXT, /* summary or detail text */
141 WRITE_XML /* PDML or PSML */
142 /* Add CSV and the like here */
145 static gboolean line_buffered;
146 static print_format_e print_format = PR_FMT_TEXT;
148 static gboolean want_pcap_pkthdr;
150 cf_status_t raw_cf_open(capture_file *cf, const char *fname);
151 static gboolean load_cap_file(capture_file *cf);
152 static gboolean process_packet(capture_file *cf, epan_dissect_t *edt, gint64 offset,
153 struct wtap_pkthdr *whdr, const guchar *pd);
154 static void show_print_file_io_error(int err);
156 static void open_failure_message(const char *filename, int err,
157 gboolean for_writing);
158 static void failure_message(const char *msg_format, va_list ap);
159 static void read_failure_message(const char *filename, int err);
160 static void write_failure_message(const char *filename, int err);
161 static void rawshark_cmdarg_err(const char *fmt, va_list ap);
162 static void rawshark_cmdarg_err_cont(const char *fmt, va_list ap);
163 static void protocolinfo_init(char *field);
164 static gboolean parse_field_string_format(char *format);
167 SF_NONE, /* No format (placeholder) */
168 SF_NAME, /* %D Field name / description */
169 SF_NUMVAL, /* %N Numeric value */
170 SF_STRVAL /* %S String value */
173 typedef struct string_fmt_s {
175 string_fmt_e format; /* Valid if plain is NULL */
181 dfilter_t *rfcodes[64];
183 dfilter_t *rfieldfcodes[64];
186 GPtrArray *string_fmts;
189 print_usage(FILE *output)
191 fprintf(output, "\n");
192 fprintf(output, "Usage: rawshark [options] ...\n");
193 fprintf(output, "\n");
195 fprintf(output, "Input file:\n");
196 fprintf(output, " -r <infile> set the pipe or file name to read from\n");
198 fprintf(output, "\n");
199 fprintf(output, "Processing:\n");
200 fprintf(output, " -d <encap:linktype>|<proto:protoname>\n");
201 fprintf(output, " packet encapsulation or protocol\n");
202 fprintf(output, " -F <field> field to display\n");
203 fprintf(output, " -n disable all name resolution (def: all enabled)\n");
204 fprintf(output, " -N <name resolve flags> enable specific name resolution(s): \"mnNtCd\"\n");
205 fprintf(output, " -p use the system's packet header format\n");
206 fprintf(output, " (which may have 64-bit timestamps)\n");
207 fprintf(output, " -R <read filter> packet filter in Wireshark display filter syntax\n");
208 fprintf(output, " -s skip PCAP header on input\n");
210 fprintf(output, "\n");
211 fprintf(output, "Output:\n");
212 fprintf(output, " -l flush output after each packet\n");
213 fprintf(output, " -S format string for fields\n");
214 fprintf(output, " (%%D - name, %%S - stringval, %%N numval)\n");
215 fprintf(output, " -t ad|a|r|d|dd|e output format of time stamps (def: r: rel. to first)\n");
217 fprintf(output, "\n");
218 fprintf(output, "Miscellaneous:\n");
219 fprintf(output, " -h display this help and exit\n");
220 fprintf(output, " -o <name>:<value> ... override preference setting\n");
221 fprintf(output, " -v display version info and exit\n");
225 log_func_ignore (const gchar *log_domain _U_, GLogLevelFlags log_level _U_,
226 const gchar *message _U_, gpointer user_data _U_)
231 * Open a pipe for raw input. This is a stripped-down version of
232 * pcap_loop.c:cap_pipe_open_live().
233 * We check if "pipe_name" is "-" (stdin) or a FIFO, and open it.
234 * @param pipe_name The name of the pipe or FIFO.
235 * @return A POSIX file descriptor on success, or -1 on failure.
238 raw_pipe_open(const char *pipe_name)
241 ws_statb64 pipe_stat;
243 char *pncopy, *pos = NULL;
250 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "open_raw_pipe: %s", pipe_name);
253 * XXX Rawshark blocks until we return
255 if (strcmp(pipe_name, "-") == 0) {
256 rfd = 0; /* read from stdin */
259 * This is needed to set the stdin pipe into binary mode, otherwise
260 * CR/LF are mangled...
262 _setmode(0, _O_BINARY);
266 if (ws_stat64(pipe_name, &pipe_stat) < 0) {
267 fprintf(stderr, "rawshark: The pipe %s could not be checked: %s\n",
268 pipe_name, g_strerror(errno));
271 if (! S_ISFIFO(pipe_stat.st_mode)) {
272 if (S_ISCHR(pipe_stat.st_mode)) {
274 * Assume the user specified an interface on a system where
275 * interfaces are in /dev. Pretend we haven't seen it.
279 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
284 rfd = ws_open(pipe_name, O_RDONLY | O_NONBLOCK, 0000 /* no creation so don't matter */);
286 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
287 pipe_name, g_strerror(errno));
291 #define PIPE_STR "\\pipe\\"
292 /* Under Windows, named pipes _must_ have the form
293 * "\\<server>\pipe\<pipe_name>". <server> may be "." for localhost.
295 pncopy = g_strdup(pipe_name);
296 if (strstr(pncopy, "\\\\") == pncopy) {
297 pos = strchr(pncopy + 3, '\\');
298 if (pos && g_ascii_strncasecmp(pos, PIPE_STR, strlen(PIPE_STR)) != 0)
305 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
310 /* Wait for the pipe to appear */
312 hPipe = CreateFile(utf_8to16(pipe_name), GENERIC_READ, 0, NULL,
313 OPEN_EXISTING, 0, NULL);
315 if (hPipe != INVALID_HANDLE_VALUE)
318 err = GetLastError();
319 if (err != ERROR_PIPE_BUSY) {
320 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
321 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
322 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s (error %lu)\n",
323 pipe_name, utf_16to8(err_str), err);
328 if (!WaitNamedPipe(utf_8to16(pipe_name), 30 * 1000)) {
329 err = GetLastError();
330 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
331 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
332 fprintf(stderr, "rawshark: \"%s\" could not be waited for: %s (error %lu)\n",
333 pipe_name, utf_16to8(err_str), err);
339 rfd = _open_osfhandle((intptr_t) hPipe, _O_RDONLY);
341 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
342 pipe_name, g_strerror(errno));
352 * Parse a link-type argument of the form "encap:<pcap linktype>" or
353 * "proto:<proto name>". "Pcap linktype" must be a name conforming to
354 * pcap_datalink_name_to_val() or an integer; the integer should be
355 * a LINKTYPE_ value supported by Wiretap. "Proto name" must be
356 * a protocol name, e.g. "http".
359 set_link_type(const char *lt_arg) {
360 char *spec_ptr = strchr(lt_arg, ':');
364 dissector_handle_t dhandle;
372 if (strncmp(lt_arg, "encap:", strlen("encap:")) == 0) {
373 dlt_val = linktype_name_to_val(spec_ptr);
376 val = strtol(spec_ptr, &p, 10);
377 if (p == spec_ptr || *p != '\0' || errno != 0 || val > INT_MAX) {
383 * In those cases where a given link-layer header type
384 * has different LINKTYPE_ and DLT_ values, linktype_name_to_val()
385 * will return the OS's DLT_ value for that link-layer header
386 * type, not its OS-independent LINKTYPE_ value.
388 * On a given OS, wtap_pcap_encap_to_wtap_encap() should
389 * be able to map either LINKTYPE_ values or DLT_ values
390 * for the OS to the appropriate Wiretap encapsulation.
392 encap = wtap_pcap_encap_to_wtap_encap(dlt_val);
393 if (encap == WTAP_ENCAP_UNKNOWN) {
397 } else if (strncmp(lt_arg, "proto:", strlen("proto:")) == 0) {
398 dhandle = find_dissector(spec_ptr);
400 encap = WTAP_ENCAP_USER0;
401 pref_str = g_string_new("uat:user_dlts:");
402 /* This must match the format used in the user_dlts file */
403 g_string_append_printf(pref_str,
404 "\"User 0 (DLT=147)\",\"%s\",\"0\",\"\",\"0\",\"\"",
406 if (prefs_set_pref(pref_str->str) != PREFS_SET_OK) {
407 g_string_free(pref_str, TRUE);
410 g_string_free(pref_str, TRUE);
418 main(int argc, char *argv[])
420 GString *comp_info_str;
421 GString *runtime_info_str;
422 char *init_progfile_dir_error;
424 gboolean arg_error = FALSE;
430 char *gpf_path, *pf_path;
431 char *gdp_path, *dp_path;
432 int gpf_open_errno, gpf_read_errno;
433 int pf_open_errno, pf_read_errno;
434 int gdp_open_errno, gdp_read_errno;
435 int dp_open_errno, dp_read_errno;
436 gchar *pipe_name = NULL;
441 GPtrArray *disp_fields = g_ptr_array_new();
443 gboolean skip_pcap_header = FALSE;
445 static const struct option long_options[] = {
446 {(char *)"help", no_argument, NULL, 'h'},
447 {(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 /* Set the C-language locale to the native environment. */
457 setlocale(LC_ALL, "");
459 cmdarg_err_init(rawshark_cmdarg_err, rawshark_cmdarg_err_cont);
461 /* Get the compile-time version information string */
462 comp_info_str = get_compiled_version_info(NULL, epan_get_compiled_version_info);
464 /* Get the run-time version information string */
465 runtime_info_str = get_runtime_version_info(NULL);
467 /* Add it to the information to be reported on a crash. */
468 ws_add_crash_info("Rawshark (Wireshark) %s\n"
473 get_ws_vcs_version_info(), comp_info_str->str, runtime_info_str->str);
476 arg_list_utf_16to8(argc, argv);
477 create_app_running_mutex();
481 * Get credential information for later use.
483 init_process_policies();
486 * Clear the filters arrays
488 memset(rfilters, 0, sizeof(rfilters));
489 memset(rfcodes, 0, sizeof(rfcodes));
494 * Initialize our string format
496 string_fmts = g_ptr_array_new();
499 * Attempt to get the pathname of the executable file.
501 init_progfile_dir_error = init_progfile_dir(argv[0], (void *)main);
502 if (init_progfile_dir_error != NULL) {
503 fprintf(stderr, "rawshark: Can't get pathname of rawshark program: %s.\n",
504 init_progfile_dir_error);
507 /* nothing more than the standard GLib handler, but without a warning */
509 G_LOG_LEVEL_WARNING |
510 G_LOG_LEVEL_MESSAGE |
514 g_log_set_handler(NULL,
515 (GLogLevelFlags)log_flags,
516 log_func_ignore, NULL /* user_data */);
517 g_log_set_handler(LOG_DOMAIN_CAPTURE_CHILD,
518 (GLogLevelFlags)log_flags,
519 log_func_ignore, NULL /* user_data */);
521 init_report_err(failure_message, open_failure_message, read_failure_message,
522 write_failure_message);
524 timestamp_set_type(TS_RELATIVE);
525 timestamp_set_precision(TS_PREC_AUTO);
526 timestamp_set_seconds_type(TS_SECONDS_DEFAULT);
528 /* Register all dissectors; we must do this before checking for the
529 "-G" flag, as the "-G" flag dumps information registered by the
530 dissectors, and we must do it before we read the preferences, in
531 case any dissectors register preferences. */
532 epan_init(register_all_protocols, register_all_protocol_handoffs, NULL, NULL);
534 prefs_p = read_prefs(&gpf_open_errno, &gpf_read_errno, &gpf_path,
535 &pf_open_errno, &pf_read_errno, &pf_path);
536 if (gpf_path != NULL) {
537 if (gpf_open_errno != 0) {
538 cmdarg_err("Can't open global preferences file \"%s\": %s.",
539 pf_path, g_strerror(gpf_open_errno));
541 if (gpf_read_errno != 0) {
542 cmdarg_err("I/O error reading global preferences file \"%s\": %s.",
543 pf_path, g_strerror(gpf_read_errno));
546 if (pf_path != NULL) {
547 if (pf_open_errno != 0) {
548 cmdarg_err("Can't open your preferences file \"%s\": %s.", pf_path,
549 g_strerror(pf_open_errno));
551 if (pf_read_errno != 0) {
552 cmdarg_err("I/O error reading your preferences file \"%s\": %s.",
553 pf_path, g_strerror(pf_read_errno));
559 /* Read the disabled protocols file. */
560 read_disabled_protos_list(&gdp_path, &gdp_open_errno, &gdp_read_errno,
561 &dp_path, &dp_open_errno, &dp_read_errno);
562 read_disabled_heur_dissector_list(&gdp_path, &gdp_open_errno, &gdp_read_errno,
563 &dp_path, &dp_open_errno, &dp_read_errno);
564 if (gdp_path != NULL) {
565 if (gdp_open_errno != 0) {
566 cmdarg_err("Could not open global disabled protocols file\n\"%s\": %s.",
567 gdp_path, g_strerror(gdp_open_errno));
569 if (gdp_read_errno != 0) {
570 cmdarg_err("I/O error reading global disabled protocols file\n\"%s\": %s.",
571 gdp_path, g_strerror(gdp_read_errno));
575 if (dp_path != NULL) {
576 if (dp_open_errno != 0) {
578 "Could not open your disabled protocols file\n\"%s\": %s.", dp_path,
579 g_strerror(dp_open_errno));
581 if (dp_read_errno != 0) {
583 "I/O error reading your disabled protocols file\n\"%s\": %s.", dp_path,
584 g_strerror(dp_read_errno));
590 /* Load Wpcap, if possible */
594 cap_file_init(&cfile);
596 /* Print format defaults to this. */
597 print_format = PR_FMT_TEXT;
599 /* Initialize our encapsulation type */
600 encap = WTAP_ENCAP_UNKNOWN;
602 /* Now get our args */
603 /* XXX - We should probably have an option to dump libpcap link types */
604 while ((opt = getopt_long(argc, argv, optstring, long_options, NULL)) != -1) {
606 case 'd': /* Payload type */
607 if (!set_link_type(optarg)) {
608 cmdarg_err("Invalid link type or protocol \"%s\"", optarg);
612 case 'F': /* Read field to display */
613 g_ptr_array_add(disp_fields, g_strdup(optarg));
615 case 'h': /* Print help and exit */
616 printf("Rawshark (Wireshark) %s\n"
617 "Dump and analyze network traffic.\n"
618 "See http://www.wireshark.org for more information.\n",
619 get_ws_vcs_version_info());
623 case 'l': /* "Line-buffer" standard output */
624 /* This isn't line-buffering, strictly speaking, it's just
625 flushing the standard output after the information for
626 each packet is printed; however, that should be good
627 enough for all the purposes to which "-l" is put (and
628 is probably actually better for "-V", as it does fewer
631 See the comment in "process_packet()" for an explanation of
632 why we do that, and why we don't just use "setvbuf()" to
633 make the standard output line-buffered (short version: in
634 Windows, "line-buffered" is the same as "fully-buffered",
635 and the output buffer is only flushed when it fills up). */
636 line_buffered = TRUE;
638 case 'n': /* No name resolution */
639 disable_name_resolution();
641 case 'N': /* Select what types of addresses/port #s to resolve */
642 badopt = string_to_name_resolve(optarg, &gbl_resolv_flags);
643 if (badopt != '\0') {
644 cmdarg_err("-N specifies unknown resolving option '%c'; valid options are 'C', 'd', m', 'n', 'N', and 't'",
649 case 'o': /* Override preference from command line */
650 switch (prefs_set_pref(optarg)) {
655 case PREFS_SET_SYNTAX_ERR:
656 cmdarg_err("Invalid -o flag \"%s\"", optarg);
660 case PREFS_SET_NO_SUCH_PREF:
661 case PREFS_SET_OBSOLETE:
662 cmdarg_err("-o flag \"%s\" specifies unknown preference", optarg);
667 case 'p': /* Expect pcap_pkthdr packet headers, which may have 64-bit timestamps */
668 want_pcap_pkthdr = TRUE;
670 case 'r': /* Read capture file xxx */
671 pipe_name = g_strdup(optarg);
673 case 'R': /* Read file filter */
674 if(n_rfilters < (int) sizeof(rfilters) / (int) sizeof(rfilters[0])) {
675 rfilters[n_rfilters++] = optarg;
678 cmdarg_err("Too many display filters");
682 case 's': /* Skip PCAP header */
683 skip_pcap_header = TRUE;
685 case 'S': /* Print string representations */
686 if (!parse_field_string_format(optarg)) {
687 cmdarg_err("Invalid field string format");
691 case 't': /* Time stamp type */
692 if (strcmp(optarg, "r") == 0)
693 timestamp_set_type(TS_RELATIVE);
694 else if (strcmp(optarg, "a") == 0)
695 timestamp_set_type(TS_ABSOLUTE);
696 else if (strcmp(optarg, "ad") == 0)
697 timestamp_set_type(TS_ABSOLUTE_WITH_YMD);
698 else if (strcmp(optarg, "adoy") == 0)
699 timestamp_set_type(TS_ABSOLUTE_WITH_YDOY);
700 else if (strcmp(optarg, "d") == 0)
701 timestamp_set_type(TS_DELTA);
702 else if (strcmp(optarg, "dd") == 0)
703 timestamp_set_type(TS_DELTA_DIS);
704 else if (strcmp(optarg, "e") == 0)
705 timestamp_set_type(TS_EPOCH);
706 else if (strcmp(optarg, "u") == 0)
707 timestamp_set_type(TS_UTC);
708 else if (strcmp(optarg, "ud") == 0)
709 timestamp_set_type(TS_UTC_WITH_YMD);
710 else if (strcmp(optarg, "udoy") == 0)
711 timestamp_set_type(TS_UTC_WITH_YDOY);
713 cmdarg_err("Invalid time stamp type \"%s\"",
716 "It must be \"a\" for absolute, \"ad\" for absolute with YYYY-MM-DD date,");
718 "\"adoy\" for absolute with YYYY/DOY date, \"d\" for delta,");
720 "\"dd\" for delta displayed, \"e\" for epoch, \"r\" for relative,");
722 "\"u\" for absolute UTC, \"ud\" for absolute UTC with YYYY-MM-DD date,");
724 "or \"udoy\" for absolute UTC with YYYY/DOY date.");
728 case 'v': /* Show version and exit */
730 show_version("Rawshark (Wireshark)", comp_info_str, runtime_info_str);
731 g_string_free(comp_info_str, TRUE);
732 g_string_free(runtime_info_str, TRUE);
737 case '?': /* Bad flag - print usage message */
744 /* Notify all registered modules that have had any of their preferences
745 changed either from one of the preferences file or from the command
746 line that their preferences have changed.
747 Initialize preferences before display filters, otherwise modules
748 like MATE won't work. */
751 /* Initialize our display fields */
752 for (fc = 0; fc < disp_fields->len; fc++) {
753 protocolinfo_init((char *)g_ptr_array_index(disp_fields, fc));
755 g_ptr_array_free(disp_fields, TRUE);
759 /* If no capture filter or read filter has been specified, and there are
760 still command-line arguments, treat them as the tokens of a capture
761 filter (if no "-r" flag was specified) or a read filter (if a "-r"
762 flag was specified. */
764 if (pipe_name != NULL) {
765 if (n_rfilters != 0) {
766 cmdarg_err("Read filters were specified both with \"-R\" "
767 "and with additional command-line arguments");
770 rfilters[n_rfilters] = get_args_as_string(argc, argv, optind);
774 /* Make sure we got a dissector handle for our payload. */
775 if (encap == WTAP_ENCAP_UNKNOWN) {
776 cmdarg_err("No valid payload dissector specified.");
787 /* Start windows sockets */
788 WSAStartup( MAKEWORD( 1, 1 ), &wsaData );
791 /* At this point MATE will have registered its field array so we can
792 have a tap filter with one of MATE's late-registered fields as part
793 of the filter. We can now process all the "-z" arguments. */
794 start_requested_stats();
796 /* disabled protocols as per configuration file */
797 if (gdp_path == NULL && dp_path == NULL) {
798 set_disabled_protos_list();
799 set_disabled_heur_dissector_list();
802 /* Build the column format array */
803 build_column_format_array(&cfile.cinfo, prefs_p->num_cols, TRUE);
805 if (n_rfilters != 0) {
806 for (i = 0; i < n_rfilters; i++) {
809 if (!dfilter_compile(rfilters[i], &rfcodes[n_rfcodes], &err_msg)) {
810 cmdarg_err("%s", err_msg);
812 epan_free(cfile.epan);
822 * We're reading a pipe (or capture file).
826 * Immediately relinquish any special privileges we have; we must not
827 * be allowed to read any capture files the user running Rawshark
830 relinquish_special_privs_perm();
832 if (raw_cf_open(&cfile, pipe_name) != CF_OK) {
833 epan_free(cfile.epan);
838 /* Do we need to PCAP header and magic? */
839 if (skip_pcap_header) {
840 size_t bytes_left = sizeof(struct pcap_hdr) + sizeof(guint32);
841 gchar buf[sizeof(struct pcap_hdr) + sizeof(guint32)];
842 while (bytes_left != 0) {
843 ssize_t bytes = read(fd, buf, (int)bytes_left);
845 cmdarg_err("Not enough bytes for pcap header.");
852 /* Process the packets in the file */
853 if (!load_cap_file(&cfile)) {
854 epan_free(cfile.epan);
859 /* If you want to capture live packets, use TShark. */
860 cmdarg_err("Input file or pipe name not specified.");
864 epan_free(cfile.epan);
871 * Read data from a raw pipe. The "raw" data consists of a libpcap
872 * packet header followed by the payload.
873 * @param pd [IN] A POSIX file descriptor. Because that's _exactly_ the sort
874 * of thing you want to use in Windows.
875 * @param phdr [OUT] Packet header information.
876 * @param err [OUT] Error indicator. Uses wiretap values.
877 * @param err_info [OUT] Error message.
878 * @param data_offset [OUT] data offset in the pipe.
879 * @return TRUE on success, FALSE on failure.
882 raw_pipe_read(struct wtap_pkthdr *phdr, guchar * pd, int *err, gchar **err_info, gint64 *data_offset) {
883 struct pcap_pkthdr mem_hdr;
884 struct pcaprec_hdr disk_hdr;
885 ssize_t bytes_read = 0;
886 size_t bytes_needed = sizeof(disk_hdr);
887 guchar *ptr = (guchar*) &disk_hdr;
889 if (want_pcap_pkthdr) {
890 bytes_needed = sizeof(mem_hdr);
891 ptr = (guchar*) &mem_hdr;
894 /* Copied from capture_loop.c */
895 while (bytes_needed > 0) {
896 bytes_read = read(fd, ptr, (int)bytes_needed);
897 if (bytes_read == 0) {
901 } else if (bytes_read < 0) {
906 bytes_needed -= bytes_read;
907 *data_offset += bytes_read;
911 if (want_pcap_pkthdr) {
912 phdr->ts.secs = mem_hdr.ts.tv_sec;
913 phdr->ts.nsecs = (gint32)mem_hdr.ts.tv_usec * 1000;
914 phdr->caplen = mem_hdr.caplen;
915 phdr->len = mem_hdr.len;
917 phdr->ts.secs = disk_hdr.ts_sec;
918 phdr->ts.nsecs = disk_hdr.ts_usec * 1000;
919 phdr->caplen = disk_hdr.incl_len;
920 phdr->len = disk_hdr.orig_len;
922 bytes_needed = phdr->caplen;
924 phdr->pkt_encap = encap;
927 printf("mem_hdr: %lu disk_hdr: %lu\n", sizeof(mem_hdr), sizeof(disk_hdr));
928 printf("tv_sec: %u (%04x)\n", (unsigned int) phdr->ts.secs, (unsigned int) phdr->ts.secs);
929 printf("tv_nsec: %d (%04x)\n", phdr->ts.nsecs, phdr->ts.nsecs);
930 printf("caplen: %d (%04x)\n", phdr->caplen, phdr->caplen);
931 printf("len: %d (%04x)\n", phdr->len, phdr->len);
933 if (bytes_needed > WTAP_MAX_PACKET_SIZE) {
934 *err = WTAP_ERR_BAD_FILE;
935 *err_info = g_strdup_printf("Bad packet length: %lu\n",
936 (unsigned long) bytes_needed);
941 while (bytes_needed > 0) {
942 bytes_read = read(fd, ptr, (int)bytes_needed);
943 if (bytes_read == 0) {
944 *err = WTAP_ERR_SHORT_READ;
947 } else if (bytes_read < 0) {
952 bytes_needed -= bytes_read;
953 *data_offset += bytes_read;
960 load_cap_file(capture_file *cf)
964 gint64 data_offset = 0;
966 guchar pd[WTAP_MAX_PACKET_SIZE];
967 struct wtap_pkthdr phdr;
970 wtap_phdr_init(&phdr);
972 epan_dissect_init(&edt, cf->epan, TRUE, FALSE);
974 while (raw_pipe_read(&phdr, pd, &err, &err_info, &data_offset)) {
975 process_packet(cf, &edt, data_offset, &phdr, pd);
978 epan_dissect_cleanup(&edt);
980 wtap_phdr_cleanup(&phdr);
983 /* Print a message noting that the read failed somewhere along the line. */
986 case WTAP_ERR_UNSUPPORTED:
987 cmdarg_err("The file \"%s\" contains record data that Rawshark doesn't support.\n(%s)",
989 err_info != NULL ? err_info : "no information supplied");
993 case WTAP_ERR_SHORT_READ:
994 cmdarg_err("The file \"%s\" appears to have been cut short in the middle of a packet.",
998 case WTAP_ERR_BAD_FILE:
999 cmdarg_err("The file \"%s\" appears to be damaged or corrupt.\n(%s)",
1001 err_info != NULL ? err_info : "no information supplied");
1005 case WTAP_ERR_DECOMPRESS:
1006 cmdarg_err("The compressed file \"%s\" appears to be damaged or corrupt.\n(%s)",
1008 err_info != NULL ? err_info : "no information supplied");
1013 cmdarg_err("An error occurred while reading the file \"%s\": %s.",
1014 cf->filename, wtap_strerror(err));
1024 process_packet(capture_file *cf, epan_dissect_t *edt, gint64 offset,
1025 struct wtap_pkthdr *whdr, const guchar *pd)
1033 /* The user sends an empty packet when he wants to get output from us even if we don't currently have
1034 packets to process. We spit out a line with the timestamp and the text "void"
1036 printf("%lu %lu %lu void -\n", (unsigned long int)cf->count,
1037 (unsigned long int)whdr->ts.secs,
1038 (unsigned long int)whdr->ts.nsecs);
1045 /* Count this packet. */
1048 /* If we're going to print packet information, or we're going to
1049 run a read filter, or we're going to process taps, set up to
1050 do a dissection and do so. */
1051 frame_data_init(&fdata, cf->count, whdr, offset, cum_bytes);
1055 /* If we're running a read filter, prime the epan_dissect_t with that
1057 if (n_rfilters > 0) {
1058 for(i = 0; i < n_rfcodes; i++) {
1059 epan_dissect_prime_dfilter(edt, rfcodes[i]);
1063 printf("%lu", (unsigned long int) cf->count);
1065 frame_data_set_before_dissect(&fdata, &cf->elapsed_time,
1068 if (ref == &fdata) {
1073 /* We only need the columns if we're printing packet info but we're
1074 *not* verbose; in verbose mode, we print the protocol tree, not
1075 the protocol summary. */
1076 epan_dissect_run_with_taps(edt, cf->cd_t, whdr, frame_tvbuff_new(&fdata, pd), &fdata, &cf->cinfo);
1078 frame_data_set_after_dissect(&fdata, &cum_bytes);
1079 prev_dis_frame = fdata;
1080 prev_dis = &prev_dis_frame;
1082 prev_cap_frame = fdata;
1083 prev_cap = &prev_cap_frame;
1085 for(i = 0; i < n_rfilters; i++) {
1086 /* Run the read filter if we have one. */
1088 passed = dfilter_apply_edt(rfcodes[i], edt);
1092 /* Print a one-line summary */
1093 printf(" %u", passed ? 1 : 0);
1098 /* The ANSI C standard does not appear to *require* that a line-buffered
1099 stream be flushed to the host environment whenever a newline is
1100 written, it just says that, on such a stream, characters "are
1101 intended to be transmitted to or from the host environment as a
1102 block when a new-line character is encountered".
1104 The Visual C++ 6.0 C implementation doesn't do what is intended;
1105 even if you set a stream to be line-buffered, it still doesn't
1106 flush the buffer at the end of every line.
1108 So, if the "-l" flag was specified, we flush the standard output
1109 at the end of a packet. This will do the right thing if we're
1110 printing packet summary lines, and, as we print the entire protocol
1111 tree for a single packet without waiting for anything to happen,
1112 it should be as good as line-buffered mode if we're printing
1113 protocol trees. (The whole reason for the "-l" flag in either
1114 tcpdump or Rawshark is to allow the output of a live capture to
1115 be piped to a program or script and to have that script see the
1116 information for the packet as soon as it's printed, rather than
1117 having to wait until a standard I/O buffer fills up. */
1121 if (ferror(stdout)) {
1122 show_print_file_io_error(errno);
1126 epan_dissect_reset(edt);
1127 frame_data_destroy(&fdata);
1132 /****************************************************************************************
1133 * FIELD EXTRACTION ROUTINES
1134 ****************************************************************************************/
1135 typedef struct _pci_t {
1141 static const char* ftenum_to_string(header_field_info *hfi)
1147 if (string_fmts->len > 0 && hfi->strings) {
1155 return "FT_PROTOCOL";
1157 return "FT_BOOLEAN";
1182 case FT_ABSOLUTE_TIME:
1183 return "FT_ABSOLUTE_TIME";
1184 case FT_RELATIVE_TIME:
1185 return "FT_RELATIVE_TIME";
1189 return "FT_STRINGZ";
1190 case FT_UINT_STRING:
1191 return "FT_UINT_STRING";
1197 return "FT_UINT_BYTES";
1205 return "FT_FRAMENUM";
1213 return "FT_REL_OID";
1215 return "FT_SYSTEM_ID";
1217 return "FT_STRIGZPAD";
1219 return "FT_NUM_TYPES";
1225 static const char* absolute_time_display_e_to_string(absolute_time_display_e atd)
1228 case ABSOLUTE_TIME_LOCAL:
1229 return "ABSOLUTE_TIME_LOCAL";
1230 case ABSOLUTE_TIME_UTC:
1231 return "ABSOLUTE_TIME_UTC";
1237 static const char* field_display_e_to_string(field_display_e bd)
1249 return "BASE_DEC_HEX";
1251 return "BASE_HEX_DEC";
1258 * Copied from various parts of proto.c
1260 #define FIELD_STR_INIT_LEN 256
1261 #define cVALS(x) (const value_string*)(x)
1262 static gboolean print_field_value(field_info *finfo, int cmd_line_index)
1264 header_field_info *hfinfo;
1265 static char *fs_buf = NULL;
1266 char *fs_ptr = fs_buf;
1267 static GString *label_s = NULL;
1268 int fs_buf_len = FIELD_STR_INIT_LEN, fs_len;
1275 const true_false_string *tfstring = &tfs_true_false;
1277 hfinfo = finfo->hfinfo;
1280 fs_buf = (char *)g_malloc(fs_buf_len + 1);
1285 label_s = g_string_new("");
1288 if(finfo->value.ftype->val_to_string_repr)
1291 * this field has an associated value,
1294 fs_len = fvalue_string_repr_len(&finfo->value, FTREPR_DFILTER, finfo->hfinfo->display);
1295 while (fs_buf_len < fs_len) {
1297 fs_buf = (char *)g_realloc(fs_buf, fs_buf_len + 1);
1300 fvalue_to_string_repr(&finfo->value,
1301 FTREPR_DFILTER, finfo->hfinfo->display,
1304 /* String types are quoted. Remove them. */
1305 if (IS_FT_STRING(finfo->value.ftype->ftype) && fs_len > 2) {
1306 fs_buf[fs_len - 1] = '\0';
1311 if (string_fmts->len > 0 && finfo->hfinfo->strings) {
1312 g_string_truncate(label_s, 0);
1313 for (i = 0; i < string_fmts->len; i++) {
1314 sf = (string_fmt_t *)g_ptr_array_index(string_fmts, i);
1316 g_string_append(label_s, sf->plain);
1318 switch (sf->format) {
1320 g_string_append(label_s, hfinfo->name);
1323 g_string_append(label_s, fs_ptr);
1326 switch(hfinfo->type) {
1328 uvalue = fvalue_get_uinteger(&finfo->value);
1329 tfstring = (const struct true_false_string*) hfinfo->strings;
1330 g_string_append(label_s, uvalue ? tfstring->true_string : tfstring->false_string);
1336 DISSECTOR_ASSERT(!hfinfo->bitmask);
1337 svalue = fvalue_get_sinteger(&finfo->value);
1338 if (hfinfo->display & BASE_RANGE_STRING) {
1339 g_string_append(label_s, rval_to_str_const(svalue, RVALS(hfinfo->strings), "Unknown"));
1340 } else if (hfinfo->display & BASE_EXT_STRING) {
1341 g_string_append(label_s, val_to_str_ext_const(svalue, (value_string_ext *) hfinfo->strings, "Unknown"));
1343 g_string_append(label_s, val_to_str_const(svalue, cVALS(hfinfo->strings), "Unknown"));
1346 case FT_INT40: /* XXX: Shouldn't these be as smart as FT_INT{8,16,24,32}? */
1350 DISSECTOR_ASSERT(!hfinfo->bitmask);
1351 svalue64 = (gint64)fvalue_get_sinteger64(&finfo->value);
1352 if (hfinfo->display & BASE_VAL64_STRING) {
1353 g_string_append(label_s, val64_to_str_const(svalue64, (const val64_string *)(hfinfo->strings), "Unknown"));
1360 DISSECTOR_ASSERT(!hfinfo->bitmask);
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"));
1370 case FT_UINT40: /* XXX: Shouldn't these be as smart as FT_INT{8,16,24,32}? */
1374 DISSECTOR_ASSERT(!hfinfo->bitmask);
1375 uvalue64 = fvalue_get_uinteger64(&finfo->value);
1376 if (hfinfo->display & BASE_VAL64_STRING) {
1377 g_string_append(label_s, val64_to_str_const(uvalue64, (const val64_string *)(hfinfo->strings), "Unknown"));
1389 printf(" %d=\"%s\"", cmd_line_index, label_s->str);
1393 if(finfo->value.ftype->val_to_string_repr)
1395 printf(" %d=\"%s\"", cmd_line_index, fs_ptr);
1400 * This field doesn't have an associated value,
1404 printf(" %d=\"n.a.\"", cmd_line_index);
1409 protocolinfo_packet(void *prs, packet_info *pinfo _U_, epan_dissect_t *edt, const void *dummy _U_)
1411 pci_t *rs=(pci_t *)prs;
1415 gp=proto_get_finfo_ptr_array(edt->tree, rs->hf_index);
1422 * Print each occurrence of the field
1424 for (i = 0; i < gp->len; i++) {
1425 print_field_value((field_info *)gp->pdata[i], rs->cmd_line_index);
1431 int g_cmd_line_index = 0;
1434 * field must be persistent - we don't g_strdup() it below
1437 protocolinfo_init(char *field)
1440 header_field_info *hfi;
1441 GString *error_string;
1443 hfi=proto_registrar_get_byname(field);
1445 fprintf(stderr, "rawshark: Field \"%s\" doesn't exist.\n", field);
1449 switch (hfi->type) {
1451 case FT_ABSOLUTE_TIME:
1452 printf("%d %s %s - ",
1454 ftenum_to_string(hfi),
1455 absolute_time_display_e_to_string((absolute_time_display_e)hfi->display));
1459 printf("%d %s %s - ",
1461 ftenum_to_string(hfi),
1462 field_display_e_to_string((field_display_e)hfi->display));
1466 rs=(pci_t *)g_malloc(sizeof(pci_t));
1467 rs->hf_index=hfi->id;
1469 rs->cmd_line_index = g_cmd_line_index++;
1471 error_string=register_tap_listener("frame", rs, rs->filter, TL_REQUIRES_PROTO_TREE, NULL, protocolinfo_packet, NULL);
1473 /* error, we failed to attach to the tap. complain and clean up */
1474 fprintf(stderr, "rawshark: Couldn't register field extraction tap: %s\n",
1476 g_string_free(error_string, TRUE);
1487 * Given a format string, split it into a GPtrArray of string_fmt_t structs
1488 * and fill in string_fmt_parts.
1492 add_string_fmt(string_fmt_e format, gchar *plain) {
1493 string_fmt_t *sf = (string_fmt_t *)g_malloc(sizeof(string_fmt_t));
1495 sf->format = format;
1496 sf->plain = g_strdup(plain);
1498 g_ptr_array_add(string_fmts, sf);
1502 parse_field_string_format(gchar *format) {
1503 GString *plain_s = g_string_new("");
1511 len = strlen(format);
1512 g_ptr_array_set_size(string_fmts, 0);
1515 if (format[pos] == '%') {
1516 if (pos >= len) { /* There should always be a following character */
1520 if (plain_s->len > 0) {
1521 add_string_fmt(SF_NONE, plain_s->str);
1522 g_string_truncate(plain_s, 0);
1524 switch (format[pos]) {
1526 add_string_fmt(SF_NAME, NULL);
1529 add_string_fmt(SF_NUMVAL, NULL);
1532 add_string_fmt(SF_STRVAL, NULL);
1535 g_string_append_c(plain_s, '%');
1537 default: /* Invalid format */
1541 g_string_append_c(plain_s, format[pos]);
1546 if (plain_s->len > 0) {
1547 add_string_fmt(SF_NONE, plain_s->str);
1549 g_string_free(plain_s, TRUE);
1553 /****************************************************************************************
1554 * END OF FIELD EXTRACTION ROUTINES
1555 ****************************************************************************************/
1558 show_print_file_io_error(int err)
1563 cmdarg_err("Not all the packets could be printed because there is "
1564 "no space left on the file system.");
1569 cmdarg_err("Not all the packets could be printed because you are "
1570 "too close to, or over your disk quota.");
1575 cmdarg_err("An error occurred while printing packets: %s.",
1582 * Open/create errors are reported with an console message in Rawshark.
1585 open_failure_message(const char *filename, int err, gboolean for_writing)
1587 fprintf(stderr, "rawshark: ");
1588 fprintf(stderr, file_open_error_message(err, for_writing), filename);
1589 fprintf(stderr, "\n");
1592 static const nstime_t *
1593 raw_get_frame_ts(void *data _U_, guint32 frame_num)
1595 if (ref && ref->num == frame_num)
1596 return &ref->abs_ts;
1598 if (prev_dis && prev_dis->num == frame_num)
1599 return &prev_dis->abs_ts;
1601 if (prev_cap && prev_cap->num == frame_num)
1602 return &prev_cap->abs_ts;
1608 raw_epan_new(capture_file *cf)
1610 epan_t *epan = epan_new();
1613 epan->get_frame_ts = raw_get_frame_ts;
1614 epan->get_interface_name = cap_file_get_interface_name;
1615 epan->get_user_comment = NULL;
1621 raw_cf_open(capture_file *cf, const char *fname)
1623 if ((fd = raw_pipe_open(fname)) < 0)
1626 /* The open succeeded. Fill in the information for this file. */
1628 /* Create new epan session for dissection. */
1629 epan_free(cf->epan);
1630 cf->epan = raw_epan_new(cf);
1633 cf->f_datalen = 0; /* not used, but set it anyway */
1635 /* Set the file name because we need it to set the follow stream filter.
1636 XXX - is that still true? We need it for other reasons, though,
1638 cf->filename = g_strdup(fname);
1640 /* Indicate whether it's a permanent or temporary file. */
1641 cf->is_tempfile = FALSE;
1643 /* No user changes yet. */
1644 cf->unsaved_changes = FALSE;
1646 cf->cd_t = WTAP_FILE_TYPE_SUBTYPE_UNKNOWN;
1647 cf->open_type = WTAP_TYPE_AUTO;
1649 cf->drops_known = FALSE;
1651 cf->has_snap = FALSE;
1652 cf->snap = WTAP_MAX_PACKET_SIZE;
1653 nstime_set_zero(&cf->elapsed_time);
1663 * General errors are reported with an console message in Rawshark.
1666 failure_message(const char *msg_format, va_list ap)
1668 fprintf(stderr, "rawshark: ");
1669 vfprintf(stderr, msg_format, ap);
1670 fprintf(stderr, "\n");
1674 * Read errors are reported with an console message in Rawshark.
1677 read_failure_message(const char *filename, int err)
1679 cmdarg_err("An error occurred while reading from the file \"%s\": %s.",
1680 filename, g_strerror(err));
1684 * Write errors are reported with an console message in Rawshark.
1687 write_failure_message(const char *filename, int err)
1689 cmdarg_err("An error occurred while writing to the file \"%s\": %s.",
1690 filename, g_strerror(err));
1694 * Report an error in command-line arguments.
1697 rawshark_cmdarg_err(const char *fmt, va_list ap)
1699 fprintf(stderr, "rawshark: ");
1700 vfprintf(stderr, fmt, ap);
1701 fprintf(stderr, "\n");
1705 * Report additional information for an error in command-line arguments.
1708 rawshark_cmdarg_err_cont(const char *fmt, va_list ap)
1710 vfprintf(stderr, fmt, ap);
1711 fprintf(stderr, "\n");
1720 * indent-tabs-mode: nil
1723 * ex: set shiftwidth=4 tabstop=8 expandtab:
1724 * :indentSize=4:tabSize=8:noTabs=true: