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.
45 #include <sys/resource.h>
54 #ifndef HAVE_GETOPT_LONG
55 #include "wsutil/wsgetopt.h"
59 #include <epan/epan-int.h>
60 #include <epan/epan.h>
62 #include <wsutil/cmdarg_err.h>
63 #include <wsutil/crash_info.h>
64 #include <wsutil/filesystem.h>
65 #include <wsutil/file_util.h>
66 #include <wsutil/plugins.h>
67 #include <wsutil/privileges.h>
68 #include <wsutil/report_err.h>
71 #include <epan/packet.h>
72 #include <epan/ftypes/ftypes-int.h>
74 #include "frame_tvbuff.h"
75 #include <epan/disabled_protos.h>
76 #include <epan/prefs.h>
77 #include <epan/column.h>
78 #include <epan/print.h>
79 #include <epan/addr_resolv.h>
81 #include "ui/capture_ui_utils.h"
85 #include "conditions.h"
86 #include "capture_stop_conditions.h"
87 #include <epan/epan_dissect.h>
88 #include <epan/stat_tap_ui.h>
89 #include <epan/timestamp.h>
90 #include <wsutil/unicode-utils.h>
91 #include "epan/column-utils.h"
92 #include "epan/proto.h"
95 #include <wiretap/wtap.h>
96 #include <wiretap/libpcap.h>
97 #include <wiretap/pcap-encap.h>
99 #include <wsutil/clopts_common.h>
100 #include <ws_version_info.h>
102 #include "caputils/capture-pcap-util.h"
111 #include "caputils/capture-wpcap.h"
113 #endif /* HAVE_LIBPCAP */
118 * This is the template for the decode as option; it is shared between the
119 * various functions that output the usage for this parameter.
121 static const gchar decode_as_arg_template[] = "<layer_type>==<selector>,<decode_as_protocol>";
124 static guint32 cum_bytes;
125 static const frame_data *ref;
126 static frame_data ref_frame;
127 static frame_data *prev_dis;
128 static frame_data prev_dis_frame;
129 static frame_data *prev_cap;
130 static frame_data prev_cap_frame;
133 * The way the packet decode is to be written.
136 WRITE_TEXT, /* summary or detail text */
137 WRITE_XML /* PDML or PSML */
138 /* Add CSV and the like here */
141 static gboolean line_buffered;
142 static print_format_e print_format = PR_FMT_TEXT;
144 static gboolean want_pcap_pkthdr;
146 cf_status_t raw_cf_open(capture_file *cf, const char *fname);
147 static gboolean load_cap_file(capture_file *cf);
148 static gboolean process_packet(capture_file *cf, epan_dissect_t *edt, gint64 offset,
149 struct wtap_pkthdr *whdr, const guchar *pd);
150 static void show_print_file_io_error(int err);
152 static void open_failure_message(const char *filename, int err,
153 gboolean for_writing);
154 static void failure_message(const char *msg_format, va_list ap);
155 static void read_failure_message(const char *filename, int err);
156 static void write_failure_message(const char *filename, int err);
157 static void rawshark_cmdarg_err(const char *fmt, va_list ap);
158 static void rawshark_cmdarg_err_cont(const char *fmt, va_list ap);
159 static void protocolinfo_init(char *field);
160 static gboolean parse_field_string_format(char *format);
163 SF_NONE, /* No format (placeholder) */
164 SF_NAME, /* %D Field name / description */
165 SF_NUMVAL, /* %N Numeric value */
166 SF_STRVAL /* %S String value */
169 typedef struct string_fmt_s {
171 string_fmt_e format; /* Valid if plain is NULL */
177 dfilter_t *rfcodes[64];
179 dfilter_t *rfieldfcodes[64];
182 GPtrArray *string_fmts;
185 print_usage(FILE *output)
187 fprintf(output, "\n");
188 fprintf(output, "Usage: rawshark [options] ...\n");
189 fprintf(output, "\n");
191 fprintf(output, "Input file:\n");
192 fprintf(output, " -r <infile> set the pipe or file name to read from\n");
194 fprintf(output, "\n");
195 fprintf(output, "Processing:\n");
196 fprintf(output, " -d <encap:linktype>|<proto:protoname>\n");
197 fprintf(output, " packet encapsulation or protocol\n");
198 fprintf(output, " -F <field> field to display\n");
200 fprintf(output, " -m virtual memory limit, in bytes \n");
202 fprintf(output, " -n disable all name resolution (def: all enabled)\n");
203 fprintf(output, " -N <name resolve flags> enable specific name resolution(s): \"mnNtd\"\n");
204 fprintf(output, " -p use the system's packet header format\n");
205 fprintf(output, " (which may have 64-bit timestamps)\n");
206 fprintf(output, " -R <read filter> packet filter in Wireshark display filter syntax\n");
207 fprintf(output, " -s skip PCAP header on input\n");
209 fprintf(output, "\n");
210 fprintf(output, "Output:\n");
211 fprintf(output, " -l flush output after each packet\n");
212 fprintf(output, " -S format string for fields\n");
213 fprintf(output, " (%%D - name, %%S - stringval, %%N numval)\n");
214 fprintf(output, " -t ad|a|r|d|dd|e output format of time stamps (def: r: rel. to first)\n");
216 fprintf(output, "\n");
217 fprintf(output, "Miscellaneous:\n");
218 fprintf(output, " -h display this help and exit\n");
219 fprintf(output, " -o <name>:<value> ... override preference setting\n");
220 fprintf(output, " -v display version info and exit\n");
224 log_func_ignore (const gchar *log_domain _U_, GLogLevelFlags log_level _U_,
225 const gchar *message _U_, gpointer user_data _U_)
230 * Open a pipe for raw input. This is a stripped-down version of
231 * pcap_loop.c:cap_pipe_open_live().
232 * We check if "pipe_name" is "-" (stdin) or a FIFO, and open it.
233 * @param pipe_name The name of the pipe or FIFO.
234 * @return A POSIX file descriptor on success, or -1 on failure.
237 raw_pipe_open(const char *pipe_name)
240 ws_statb64 pipe_stat;
242 char *pncopy, *pos = NULL;
249 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "open_raw_pipe: %s", pipe_name);
252 * XXX Rawshark blocks until we return
254 if (strcmp(pipe_name, "-") == 0) {
255 rfd = 0; /* read from stdin */
258 * This is needed to set the stdin pipe into binary mode, otherwise
259 * CR/LF are mangled...
261 _setmode(0, _O_BINARY);
265 if (ws_stat64(pipe_name, &pipe_stat) < 0) {
266 fprintf(stderr, "rawshark: The pipe %s could not be checked: %s\n",
267 pipe_name, g_strerror(errno));
270 if (! S_ISFIFO(pipe_stat.st_mode)) {
271 if (S_ISCHR(pipe_stat.st_mode)) {
273 * Assume the user specified an interface on a system where
274 * interfaces are in /dev. Pretend we haven't seen it.
278 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
283 rfd = ws_open(pipe_name, O_RDONLY | O_NONBLOCK, 0000 /* no creation so don't matter */);
285 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
286 pipe_name, g_strerror(errno));
290 #define PIPE_STR "\\pipe\\"
291 /* Under Windows, named pipes _must_ have the form
292 * "\\<server>\pipe\<pipe_name>". <server> may be "." for localhost.
294 pncopy = g_strdup(pipe_name);
295 if (strstr(pncopy, "\\\\") == pncopy) {
296 pos = strchr(pncopy + 3, '\\');
297 if (pos && g_ascii_strncasecmp(pos, PIPE_STR, strlen(PIPE_STR)) != 0)
304 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
309 /* Wait for the pipe to appear */
311 hPipe = CreateFile(utf_8to16(pipe_name), GENERIC_READ, 0, NULL,
312 OPEN_EXISTING, 0, NULL);
314 if (hPipe != INVALID_HANDLE_VALUE)
317 err = GetLastError();
318 if (err != ERROR_PIPE_BUSY) {
319 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
320 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
321 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s (error %lu)\n",
322 pipe_name, utf_16to8(err_str), err);
327 if (!WaitNamedPipe(utf_8to16(pipe_name), 30 * 1000)) {
328 err = GetLastError();
329 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
330 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
331 fprintf(stderr, "rawshark: \"%s\" could not be waited for: %s (error %lu)\n",
332 pipe_name, utf_16to8(err_str), err);
338 rfd = _open_osfhandle((intptr_t) hPipe, _O_RDONLY);
340 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
341 pipe_name, g_strerror(errno));
351 * Parse a link-type argument of the form "encap:<pcap linktype>" or
352 * "proto:<proto name>". "Pcap linktype" must be a name conforming to
353 * pcap_datalink_name_to_val() or an integer; the integer should be
354 * a LINKTYPE_ value supported by Wiretap. "Proto name" must be
355 * a protocol name, e.g. "http".
358 set_link_type(const char *lt_arg) {
359 char *spec_ptr = strchr(lt_arg, ':');
363 dissector_handle_t dhandle;
371 if (strncmp(lt_arg, "encap:", strlen("encap:")) == 0) {
372 dlt_val = linktype_name_to_val(spec_ptr);
375 val = strtol(spec_ptr, &p, 10);
376 if (p == spec_ptr || *p != '\0' || errno != 0 || val > INT_MAX) {
382 * In those cases where a given link-layer header type
383 * has different LINKTYPE_ and DLT_ values, linktype_name_to_val()
384 * will return the OS's DLT_ value for that link-layer header
385 * type, not its OS-independent LINKTYPE_ value.
387 * On a given OS, wtap_pcap_encap_to_wtap_encap() should
388 * be able to map either LINKTYPE_ values or DLT_ values
389 * for the OS to the appropriate Wiretap encapsulation.
391 encap = wtap_pcap_encap_to_wtap_encap(dlt_val);
392 if (encap == WTAP_ENCAP_UNKNOWN) {
396 } else if (strncmp(lt_arg, "proto:", strlen("proto:")) == 0) {
397 dhandle = find_dissector(spec_ptr);
399 encap = WTAP_ENCAP_USER0;
400 pref_str = g_string_new("uat:user_dlts:");
401 /* This must match the format used in the user_dlts file */
402 g_string_append_printf(pref_str,
403 "\"User 0 (DLT=147)\",\"%s\",\"0\",\"\",\"0\",\"\"",
405 if (prefs_set_pref(pref_str->str) != PREFS_SET_OK) {
406 g_string_free(pref_str, TRUE);
409 g_string_free(pref_str, TRUE);
417 main(int argc, char *argv[])
419 GString *comp_info_str;
420 GString *runtime_info_str;
421 char *init_progfile_dir_error;
423 gboolean arg_error = FALSE;
431 char *gpf_path, *pf_path;
432 char *gdp_path, *dp_path;
433 int gpf_open_errno, gpf_read_errno;
434 int pf_open_errno, pf_read_errno;
435 int gdp_open_errno, gdp_read_errno;
436 int dp_open_errno, dp_read_errno;
437 gchar *pipe_name = NULL;
442 GPtrArray *disp_fields = g_ptr_array_new();
444 gboolean skip_pcap_header = FALSE;
445 static const struct option long_options[] = {
446 {"help", no_argument, NULL, 'h'},
447 {"version", no_argument, NULL, 'v'},
451 #define OPTSTRING_INIT "d:F:hlm:nN:o:pr:R:sS:t:v"
453 static const char optstring[] = OPTSTRING_INIT;
455 /* Set the C-language locale to the native environment. */
456 setlocale(LC_ALL, "");
458 cmdarg_err_init(rawshark_cmdarg_err, rawshark_cmdarg_err_cont);
460 /* Get the compile-time version information string */
461 comp_info_str = get_compiled_version_info(NULL, epan_get_compiled_version_info);
463 /* Get the run-time version information string */
464 runtime_info_str = get_runtime_version_info(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 directory containing the
501 init_progfile_dir_error = init_progfile_dir(argv[0], 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);
530 /* Register all dissectors; we must do this before checking for the
531 "-G" flag, as the "-G" flag dumps information registered by the
532 dissectors, and we must do it before we read the preferences, in
533 case any dissectors register preferences. */
534 if (!epan_init(register_all_protocols, register_all_protocol_handoffs,
538 prefs_p = read_prefs(&gpf_open_errno, &gpf_read_errno, &gpf_path,
539 &pf_open_errno, &pf_read_errno, &pf_path);
540 if (gpf_path != NULL) {
541 if (gpf_open_errno != 0) {
542 cmdarg_err("Can't open global preferences file \"%s\": %s.",
543 pf_path, g_strerror(gpf_open_errno));
545 if (gpf_read_errno != 0) {
546 cmdarg_err("I/O error reading global preferences file \"%s\": %s.",
547 pf_path, g_strerror(gpf_read_errno));
550 if (pf_path != NULL) {
551 if (pf_open_errno != 0) {
552 cmdarg_err("Can't open your preferences file \"%s\": %s.", pf_path,
553 g_strerror(pf_open_errno));
555 if (pf_read_errno != 0) {
556 cmdarg_err("I/O error reading your preferences file \"%s\": %s.",
557 pf_path, g_strerror(pf_read_errno));
563 /* Read the disabled protocols file. */
564 read_disabled_protos_list(&gdp_path, &gdp_open_errno, &gdp_read_errno,
565 &dp_path, &dp_open_errno, &dp_read_errno);
566 read_enabled_protos_list(&gdp_path, &gdp_open_errno, &gdp_read_errno,
567 &dp_path, &dp_open_errno, &dp_read_errno);
568 read_disabled_heur_dissector_list(&gdp_path, &gdp_open_errno, &gdp_read_errno,
569 &dp_path, &dp_open_errno, &dp_read_errno);
570 if (gdp_path != NULL) {
571 if (gdp_open_errno != 0) {
572 cmdarg_err("Could not open global disabled protocols file\n\"%s\": %s.",
573 gdp_path, g_strerror(gdp_open_errno));
575 if (gdp_read_errno != 0) {
576 cmdarg_err("I/O error reading global disabled protocols file\n\"%s\": %s.",
577 gdp_path, g_strerror(gdp_read_errno));
581 if (dp_path != NULL) {
582 if (dp_open_errno != 0) {
584 "Could not open your disabled protocols file\n\"%s\": %s.", dp_path,
585 g_strerror(dp_open_errno));
587 if (dp_read_errno != 0) {
589 "I/O error reading your disabled protocols file\n\"%s\": %s.", dp_path,
590 g_strerror(dp_read_errno));
596 ws_init_dll_search_path();
597 /* Load Wpcap, if possible */
601 cap_file_init(&cfile);
603 /* Print format defaults to this. */
604 print_format = PR_FMT_TEXT;
606 /* Initialize our encapsulation type */
607 encap = WTAP_ENCAP_UNKNOWN;
609 /* Now get our args */
610 /* XXX - We should probably have an option to dump libpcap link types */
611 while ((opt = getopt_long(argc, argv, optstring, long_options, NULL)) != -1) {
613 case 'd': /* Payload type */
614 if (!set_link_type(optarg)) {
615 cmdarg_err("Invalid link type or protocol \"%s\"", optarg);
619 case 'F': /* Read field to display */
620 g_ptr_array_add(disp_fields, g_strdup(optarg));
622 case 'h': /* Print help and exit */
623 printf("Rawshark (Wireshark) %s\n"
624 "Dump and analyze network traffic.\n"
625 "See https://www.wireshark.org for more information.\n",
626 get_ws_vcs_version_info());
630 case 'l': /* "Line-buffer" standard output */
631 /* This isn't line-buffering, strictly speaking, it's just
632 flushing the standard output after the information for
633 each packet is printed; however, that should be good
634 enough for all the purposes to which "-l" is put (and
635 is probably actually better for "-V", as it does fewer
638 See the comment in "process_packet()" for an explanation of
639 why we do that, and why we don't just use "setvbuf()" to
640 make the standard output line-buffered (short version: in
641 Windows, "line-buffered" is the same as "fully-buffered",
642 and the output buffer is only flushed when it fills up). */
643 line_buffered = TRUE;
647 limit.rlim_cur = get_positive_int(optarg, "memory limit");
648 limit.rlim_max = get_positive_int(optarg, "memory limit");
650 if(setrlimit(RLIMIT_AS, &limit) != 0)
652 cmdarg_err("setrlimit() returned error");
657 case 'n': /* No name resolution */
658 disable_name_resolution();
660 case 'N': /* Select what types of addresses/port #s to resolve */
661 badopt = string_to_name_resolve(optarg, &gbl_resolv_flags);
662 if (badopt != '\0') {
663 cmdarg_err("-N specifies unknown resolving option '%c'; valid options are 'd', m', 'n', 'N', and 't'",
668 case 'o': /* Override preference from command line */
669 switch (prefs_set_pref(optarg)) {
674 case PREFS_SET_SYNTAX_ERR:
675 cmdarg_err("Invalid -o flag \"%s\"", optarg);
679 case PREFS_SET_NO_SUCH_PREF:
680 case PREFS_SET_OBSOLETE:
681 cmdarg_err("-o flag \"%s\" specifies unknown preference", optarg);
686 case 'p': /* Expect pcap_pkthdr packet headers, which may have 64-bit timestamps */
687 want_pcap_pkthdr = TRUE;
689 case 'r': /* Read capture file xxx */
690 pipe_name = g_strdup(optarg);
692 case 'R': /* Read file filter */
693 if(n_rfilters < (int) sizeof(rfilters) / (int) sizeof(rfilters[0])) {
694 rfilters[n_rfilters++] = optarg;
697 cmdarg_err("Too many display filters");
701 case 's': /* Skip PCAP header */
702 skip_pcap_header = TRUE;
704 case 'S': /* Print string representations */
705 if (!parse_field_string_format(optarg)) {
706 cmdarg_err("Invalid field string format");
710 case 't': /* Time stamp type */
711 if (strcmp(optarg, "r") == 0)
712 timestamp_set_type(TS_RELATIVE);
713 else if (strcmp(optarg, "a") == 0)
714 timestamp_set_type(TS_ABSOLUTE);
715 else if (strcmp(optarg, "ad") == 0)
716 timestamp_set_type(TS_ABSOLUTE_WITH_YMD);
717 else if (strcmp(optarg, "adoy") == 0)
718 timestamp_set_type(TS_ABSOLUTE_WITH_YDOY);
719 else if (strcmp(optarg, "d") == 0)
720 timestamp_set_type(TS_DELTA);
721 else if (strcmp(optarg, "dd") == 0)
722 timestamp_set_type(TS_DELTA_DIS);
723 else if (strcmp(optarg, "e") == 0)
724 timestamp_set_type(TS_EPOCH);
725 else if (strcmp(optarg, "u") == 0)
726 timestamp_set_type(TS_UTC);
727 else if (strcmp(optarg, "ud") == 0)
728 timestamp_set_type(TS_UTC_WITH_YMD);
729 else if (strcmp(optarg, "udoy") == 0)
730 timestamp_set_type(TS_UTC_WITH_YDOY);
732 cmdarg_err("Invalid time stamp type \"%s\"",
735 "It must be \"a\" for absolute, \"ad\" for absolute with YYYY-MM-DD date,");
737 "\"adoy\" for absolute with YYYY/DOY date, \"d\" for delta,");
739 "\"dd\" for delta displayed, \"e\" for epoch, \"r\" for relative,");
741 "\"u\" for absolute UTC, \"ud\" for absolute UTC with YYYY-MM-DD date,");
743 "or \"udoy\" for absolute UTC with YYYY/DOY date.");
747 case 'v': /* Show version and exit */
749 show_version("Rawshark (Wireshark)", comp_info_str, runtime_info_str);
750 g_string_free(comp_info_str, TRUE);
751 g_string_free(runtime_info_str, TRUE);
756 case '?': /* Bad flag - print usage message */
763 /* Notify all registered modules that have had any of their preferences
764 changed either from one of the preferences file or from the command
765 line that their preferences have changed.
766 Initialize preferences before display filters, otherwise modules
767 like MATE won't work. */
770 /* Initialize our display fields */
771 for (fc = 0; fc < disp_fields->len; fc++) {
772 protocolinfo_init((char *)g_ptr_array_index(disp_fields, fc));
774 g_ptr_array_free(disp_fields, TRUE);
778 /* If no capture filter or read filter has been specified, and there are
779 still command-line arguments, treat them as the tokens of a capture
780 filter (if no "-r" flag was specified) or a read filter (if a "-r"
781 flag was specified. */
783 if (pipe_name != NULL) {
784 if (n_rfilters != 0) {
785 cmdarg_err("Read filters were specified both with \"-R\" "
786 "and with additional command-line arguments");
789 rfilters[n_rfilters] = get_args_as_string(argc, argv, optind);
793 /* Make sure we got a dissector handle for our payload. */
794 if (encap == WTAP_ENCAP_UNKNOWN) {
795 cmdarg_err("No valid payload dissector specified.");
806 /* Start windows sockets */
807 WSAStartup( MAKEWORD( 1, 1 ), &wsaData );
810 /* At this point MATE will have registered its field array so we can
811 have a tap filter with one of MATE's late-registered fields as part
812 of the filter. We can now process all the "-z" arguments. */
813 start_requested_stats();
815 /* disabled protocols as per configuration file */
816 if (gdp_path == NULL && dp_path == NULL) {
817 set_disabled_protos_list();
818 set_enabled_protos_list();
819 set_disabled_heur_dissector_list();
822 /* Build the column format array */
823 build_column_format_array(&cfile.cinfo, prefs_p->num_cols, TRUE);
825 if (n_rfilters != 0) {
826 for (i = 0; i < n_rfilters; i++) {
829 if (!dfilter_compile(rfilters[i], &rfcodes[n_rfcodes], &err_msg)) {
830 cmdarg_err("%s", err_msg);
832 epan_free(cfile.epan);
845 * We're reading a pipe (or capture file).
849 * Immediately relinquish any special privileges we have; we must not
850 * be allowed to read any capture files the user running Rawshark
853 relinquish_special_privs_perm();
855 if (raw_cf_open(&cfile, pipe_name) != CF_OK) {
856 epan_free(cfile.epan);
864 /* Do we need to PCAP header and magic? */
865 if (skip_pcap_header) {
866 size_t bytes_left = sizeof(struct pcap_hdr) + sizeof(guint32);
867 gchar buf[sizeof(struct pcap_hdr) + sizeof(guint32)];
868 while (bytes_left != 0) {
869 ssize_t bytes = ws_read(fd, buf, (int)bytes_left);
871 cmdarg_err("Not enough bytes for pcap header.");
878 /* Process the packets in the file */
879 if (!load_cap_file(&cfile)) {
880 epan_free(cfile.epan);
888 /* If you want to capture live packets, use TShark. */
889 cmdarg_err("Input file or pipe name not specified.");
893 epan_free(cfile.epan);
902 * Read data from a raw pipe. The "raw" data consists of a libpcap
903 * packet header followed by the payload.
904 * @param pd [IN] A POSIX file descriptor. Because that's _exactly_ the sort
905 * of thing you want to use in Windows.
906 * @param phdr [OUT] Packet header information.
907 * @param err [OUT] Error indicator. Uses wiretap values.
908 * @param err_info [OUT] Error message.
909 * @param data_offset [OUT] data offset in the pipe.
910 * @return TRUE on success, FALSE on failure.
913 raw_pipe_read(struct wtap_pkthdr *phdr, guchar * pd, int *err, gchar **err_info, gint64 *data_offset) {
914 struct pcap_pkthdr mem_hdr;
915 struct pcaprec_hdr disk_hdr;
916 ssize_t bytes_read = 0;
917 size_t bytes_needed = sizeof(disk_hdr);
918 guchar *ptr = (guchar*) &disk_hdr;
922 if (want_pcap_pkthdr) {
923 bytes_needed = sizeof(mem_hdr);
924 ptr = (guchar*) &mem_hdr;
927 /* Copied from capture_loop.c */
928 while (bytes_needed > 0) {
929 bytes_read = ws_read(fd, ptr, (int)bytes_needed);
930 if (bytes_read == 0) {
934 } else if (bytes_read < 0) {
939 bytes_needed -= bytes_read;
940 *data_offset += bytes_read;
944 if (want_pcap_pkthdr) {
945 phdr->ts.secs = mem_hdr.ts.tv_sec;
946 phdr->ts.nsecs = (gint32)mem_hdr.ts.tv_usec * 1000;
947 phdr->caplen = mem_hdr.caplen;
948 phdr->len = mem_hdr.len;
950 phdr->ts.secs = disk_hdr.ts_sec;
951 phdr->ts.nsecs = disk_hdr.ts_usec * 1000;
952 phdr->caplen = disk_hdr.incl_len;
953 phdr->len = disk_hdr.orig_len;
955 bytes_needed = phdr->caplen;
957 phdr->pkt_encap = encap;
960 printf("mem_hdr: %lu disk_hdr: %lu\n", sizeof(mem_hdr), sizeof(disk_hdr));
961 printf("tv_sec: %u (%04x)\n", (unsigned int) phdr->ts.secs, (unsigned int) phdr->ts.secs);
962 printf("tv_nsec: %d (%04x)\n", phdr->ts.nsecs, phdr->ts.nsecs);
963 printf("caplen: %d (%04x)\n", phdr->caplen, phdr->caplen);
964 printf("len: %d (%04x)\n", phdr->len, phdr->len);
966 if (bytes_needed > WTAP_MAX_PACKET_SIZE) {
967 *err = WTAP_ERR_BAD_FILE;
968 *err_info = g_strdup_printf("Bad packet length: %lu\n",
969 (unsigned long) bytes_needed);
974 while (bytes_needed > 0) {
975 bytes_read = ws_read(fd, ptr, (int)bytes_needed);
976 if (bytes_read == 0) {
977 *err = WTAP_ERR_SHORT_READ;
980 } else if (bytes_read < 0) {
985 bytes_needed -= bytes_read;
986 *data_offset += bytes_read;
993 load_cap_file(capture_file *cf)
997 gint64 data_offset = 0;
999 guchar pd[WTAP_MAX_PACKET_SIZE];
1000 struct wtap_pkthdr phdr;
1003 wtap_phdr_init(&phdr);
1005 epan_dissect_init(&edt, cf->epan, TRUE, FALSE);
1007 while (raw_pipe_read(&phdr, pd, &err, &err_info, &data_offset)) {
1008 process_packet(cf, &edt, data_offset, &phdr, pd);
1011 epan_dissect_cleanup(&edt);
1013 wtap_phdr_cleanup(&phdr);
1016 /* Print a message noting that the read failed somewhere along the line. */
1019 case WTAP_ERR_UNSUPPORTED:
1020 cmdarg_err("The file \"%s\" contains record data that Rawshark doesn't support.\n(%s)",
1022 err_info != NULL ? err_info : "no information supplied");
1026 case WTAP_ERR_SHORT_READ:
1027 cmdarg_err("The file \"%s\" appears to have been cut short in the middle of a packet.",
1031 case WTAP_ERR_BAD_FILE:
1032 cmdarg_err("The file \"%s\" appears to be damaged or corrupt.\n(%s)",
1034 err_info != NULL ? err_info : "no information supplied");
1038 case WTAP_ERR_DECOMPRESS:
1039 cmdarg_err("The compressed file \"%s\" appears to be damaged or corrupt.\n(%s)",
1041 err_info != NULL ? err_info : "no information supplied");
1046 cmdarg_err("An error occurred while reading the file \"%s\": %s.",
1047 cf->filename, wtap_strerror(err));
1057 process_packet(capture_file *cf, epan_dissect_t *edt, gint64 offset,
1058 struct wtap_pkthdr *whdr, const guchar *pd)
1066 /* The user sends an empty packet when he wants to get output from us even if we don't currently have
1067 packets to process. We spit out a line with the timestamp and the text "void"
1069 printf("%lu %lu %lu void -\n", (unsigned long int)cf->count,
1070 (unsigned long int)whdr->ts.secs,
1071 (unsigned long int)whdr->ts.nsecs);
1078 /* Count this packet. */
1081 /* If we're going to print packet information, or we're going to
1082 run a read filter, or we're going to process taps, set up to
1083 do a dissection and do so. */
1084 frame_data_init(&fdata, cf->count, whdr, offset, cum_bytes);
1088 /* If we're running a read filter, prime the epan_dissect_t with that
1090 if (n_rfilters > 0) {
1091 for(i = 0; i < n_rfcodes; i++) {
1092 epan_dissect_prime_dfilter(edt, rfcodes[i]);
1096 printf("%lu", (unsigned long int) cf->count);
1098 frame_data_set_before_dissect(&fdata, &cf->elapsed_time,
1101 if (ref == &fdata) {
1106 /* We only need the columns if we're printing packet info but we're
1107 *not* verbose; in verbose mode, we print the protocol tree, not
1108 the protocol summary. */
1109 epan_dissect_run_with_taps(edt, cf->cd_t, whdr, frame_tvbuff_new(&fdata, pd), &fdata, &cf->cinfo);
1111 frame_data_set_after_dissect(&fdata, &cum_bytes);
1112 prev_dis_frame = fdata;
1113 prev_dis = &prev_dis_frame;
1115 prev_cap_frame = fdata;
1116 prev_cap = &prev_cap_frame;
1118 for(i = 0; i < n_rfilters; i++) {
1119 /* Run the read filter if we have one. */
1121 passed = dfilter_apply_edt(rfcodes[i], edt);
1125 /* Print a one-line summary */
1126 printf(" %d", passed ? 1 : 0);
1131 /* The ANSI C standard does not appear to *require* that a line-buffered
1132 stream be flushed to the host environment whenever a newline is
1133 written, it just says that, on such a stream, characters "are
1134 intended to be transmitted to or from the host environment as a
1135 block when a new-line character is encountered".
1137 The Visual C++ 6.0 C implementation doesn't do what is intended;
1138 even if you set a stream to be line-buffered, it still doesn't
1139 flush the buffer at the end of every line.
1141 So, if the "-l" flag was specified, we flush the standard output
1142 at the end of a packet. This will do the right thing if we're
1143 printing packet summary lines, and, as we print the entire protocol
1144 tree for a single packet without waiting for anything to happen,
1145 it should be as good as line-buffered mode if we're printing
1146 protocol trees. (The whole reason for the "-l" flag in either
1147 tcpdump or Rawshark is to allow the output of a live capture to
1148 be piped to a program or script and to have that script see the
1149 information for the packet as soon as it's printed, rather than
1150 having to wait until a standard I/O buffer fills up. */
1154 if (ferror(stdout)) {
1155 show_print_file_io_error(errno);
1159 epan_dissect_reset(edt);
1160 frame_data_destroy(&fdata);
1165 /****************************************************************************************
1166 * FIELD EXTRACTION ROUTINES
1167 ****************************************************************************************/
1168 typedef struct _pci_t {
1174 static const char* ftenum_to_string(header_field_info *hfi)
1181 if (string_fmts->len > 0 && hfi->strings) {
1185 str = ftype_name(hfi->type);
1193 static void field_display_to_string(header_field_info *hfi, char* buf, int size)
1195 if (hfi->type != FT_BOOLEAN)
1197 g_strlcpy(buf, proto_field_display_to_string(hfi->display), size);
1201 g_snprintf(buf, size, "(Bit count: %d)", hfi->display);
1206 * Copied from various parts of proto.c
1208 #define FIELD_STR_INIT_LEN 256
1209 #define cVALS(x) (const value_string*)(x)
1210 static gboolean print_field_value(field_info *finfo, int cmd_line_index)
1212 header_field_info *hfinfo;
1213 char *fs_buf = NULL;
1214 char *fs_ptr = NULL;
1215 static GString *label_s = NULL;
1223 const true_false_string *tfstring = &tfs_true_false;
1225 hfinfo = finfo->hfinfo;
1228 label_s = g_string_new("");
1231 if(finfo->value.ftype->val_to_string_repr)
1234 * this field has an associated value,
1237 fs_len = fvalue_string_repr_len(&finfo->value, FTREPR_DFILTER, finfo->hfinfo->display);
1238 fs_buf = fvalue_to_string_repr(NULL, &finfo->value,
1239 FTREPR_DFILTER, finfo->hfinfo->display);
1242 /* String types are quoted. Remove them. */
1243 if (IS_FT_STRING(finfo->value.ftype->ftype) && fs_len > 2) {
1244 fs_buf[fs_len - 1] = '\0';
1249 if (string_fmts->len > 0 && finfo->hfinfo->strings) {
1250 g_string_truncate(label_s, 0);
1251 for (i = 0; i < string_fmts->len; i++) {
1252 sf = (string_fmt_t *)g_ptr_array_index(string_fmts, i);
1254 g_string_append(label_s, sf->plain);
1256 switch (sf->format) {
1258 g_string_append(label_s, hfinfo->name);
1261 g_string_append(label_s, fs_ptr);
1264 switch(hfinfo->type) {
1266 uvalue64 = fvalue_get_uinteger64(&finfo->value);
1267 tfstring = (const struct true_false_string*) hfinfo->strings;
1268 g_string_append(label_s, uvalue64 ? tfstring->true_string : tfstring->false_string);
1274 DISSECTOR_ASSERT(!hfinfo->bitmask);
1275 svalue = fvalue_get_sinteger(&finfo->value);
1276 if (hfinfo->display & BASE_RANGE_STRING) {
1277 g_string_append(label_s, rval_to_str_const(svalue, RVALS(hfinfo->strings), "Unknown"));
1278 } else if (hfinfo->display & BASE_EXT_STRING) {
1279 g_string_append(label_s, val_to_str_ext_const(svalue, (value_string_ext *) hfinfo->strings, "Unknown"));
1281 g_string_append(label_s, val_to_str_const(svalue, cVALS(hfinfo->strings), "Unknown"));
1284 case FT_INT40: /* XXX: Shouldn't these be as smart as FT_INT{8,16,24,32}? */
1288 DISSECTOR_ASSERT(!hfinfo->bitmask);
1289 svalue64 = (gint64)fvalue_get_sinteger64(&finfo->value);
1290 if (hfinfo->display & BASE_VAL64_STRING) {
1291 g_string_append(label_s, val64_to_str_const(svalue64, (const val64_string *)(hfinfo->strings), "Unknown"));
1298 DISSECTOR_ASSERT(!hfinfo->bitmask);
1299 uvalue = fvalue_get_uinteger(&finfo->value);
1300 if (!hfinfo->bitmask && hfinfo->display & BASE_RANGE_STRING) {
1301 g_string_append(label_s, rval_to_str_const(uvalue, RVALS(hfinfo->strings), "Unknown"));
1302 } else if (hfinfo->display & BASE_EXT_STRING) {
1303 g_string_append(label_s, val_to_str_ext_const(uvalue, (value_string_ext *) hfinfo->strings, "Unknown"));
1305 g_string_append(label_s, val_to_str_const(uvalue, cVALS(hfinfo->strings), "Unknown"));
1308 case FT_UINT40: /* XXX: Shouldn't these be as smart as FT_INT{8,16,24,32}? */
1312 DISSECTOR_ASSERT(!hfinfo->bitmask);
1313 uvalue64 = fvalue_get_uinteger64(&finfo->value);
1314 if (hfinfo->display & BASE_VAL64_STRING) {
1315 g_string_append(label_s, val64_to_str_const(uvalue64, (const val64_string *)(hfinfo->strings), "Unknown"));
1327 printf(" %d=\"%s\"", cmd_line_index, label_s->str);
1328 wmem_free(NULL, fs_buf);
1332 if(finfo->value.ftype->val_to_string_repr)
1334 printf(" %d=\"%s\"", cmd_line_index, fs_ptr);
1335 wmem_free(NULL, fs_buf);
1340 * This field doesn't have an associated value,
1344 printf(" %d=\"n.a.\"", cmd_line_index);
1349 protocolinfo_packet(void *prs, packet_info *pinfo _U_, epan_dissect_t *edt, const void *dummy _U_)
1351 pci_t *rs=(pci_t *)prs;
1355 gp=proto_get_finfo_ptr_array(edt->tree, rs->hf_index);
1362 * Print each occurrence of the field
1364 for (i = 0; i < gp->len; i++) {
1365 print_field_value((field_info *)gp->pdata[i], rs->cmd_line_index);
1371 int g_cmd_line_index = 0;
1374 * field must be persistent - we don't g_strdup() it below
1377 protocolinfo_init(char *field)
1380 header_field_info *hfi;
1381 GString *error_string;
1384 hfi=proto_registrar_get_byname(field);
1386 fprintf(stderr, "rawshark: Field \"%s\" doesn't exist.\n", field);
1390 field_display_to_string(hfi, hfibuf, sizeof(hfibuf));
1391 printf("%d %s %s - ",
1393 ftenum_to_string(hfi),
1396 rs=(pci_t *)g_malloc(sizeof(pci_t));
1397 rs->hf_index=hfi->id;
1399 rs->cmd_line_index = g_cmd_line_index++;
1401 error_string=register_tap_listener("frame", rs, rs->filter, TL_REQUIRES_PROTO_TREE, NULL, protocolinfo_packet, NULL);
1403 /* error, we failed to attach to the tap. complain and clean up */
1404 fprintf(stderr, "rawshark: Couldn't register field extraction tap: %s\n",
1406 g_string_free(error_string, TRUE);
1417 * Given a format string, split it into a GPtrArray of string_fmt_t structs
1418 * and fill in string_fmt_parts.
1422 add_string_fmt(string_fmt_e format, gchar *plain) {
1423 string_fmt_t *sf = (string_fmt_t *)g_malloc(sizeof(string_fmt_t));
1425 sf->format = format;
1426 sf->plain = g_strdup(plain);
1428 g_ptr_array_add(string_fmts, sf);
1432 parse_field_string_format(gchar *format) {
1433 GString *plain_s = g_string_new("");
1441 len = strlen(format);
1442 g_ptr_array_set_size(string_fmts, 0);
1445 if (format[pos] == '%') {
1446 if (pos >= len) { /* There should always be a following character */
1450 if (plain_s->len > 0) {
1451 add_string_fmt(SF_NONE, plain_s->str);
1452 g_string_truncate(plain_s, 0);
1454 switch (format[pos]) {
1456 add_string_fmt(SF_NAME, NULL);
1459 add_string_fmt(SF_NUMVAL, NULL);
1462 add_string_fmt(SF_STRVAL, NULL);
1465 g_string_append_c(plain_s, '%');
1467 default: /* Invalid format */
1471 g_string_append_c(plain_s, format[pos]);
1476 if (plain_s->len > 0) {
1477 add_string_fmt(SF_NONE, plain_s->str);
1479 g_string_free(plain_s, TRUE);
1483 /****************************************************************************************
1484 * END OF FIELD EXTRACTION ROUTINES
1485 ****************************************************************************************/
1488 show_print_file_io_error(int err)
1493 cmdarg_err("Not all the packets could be printed because there is "
1494 "no space left on the file system.");
1499 cmdarg_err("Not all the packets could be printed because you are "
1500 "too close to, or over your disk quota.");
1505 cmdarg_err("An error occurred while printing packets: %s.",
1512 * Open/create errors are reported with an console message in Rawshark.
1515 open_failure_message(const char *filename, int err, gboolean for_writing)
1517 fprintf(stderr, "rawshark: ");
1518 fprintf(stderr, file_open_error_message(err, for_writing), filename);
1519 fprintf(stderr, "\n");
1522 static const nstime_t *
1523 raw_get_frame_ts(void *data _U_, guint32 frame_num)
1525 if (ref && ref->num == frame_num)
1526 return &ref->abs_ts;
1528 if (prev_dis && prev_dis->num == frame_num)
1529 return &prev_dis->abs_ts;
1531 if (prev_cap && prev_cap->num == frame_num)
1532 return &prev_cap->abs_ts;
1538 raw_epan_new(capture_file *cf)
1540 epan_t *epan = epan_new();
1543 epan->get_frame_ts = raw_get_frame_ts;
1544 epan->get_interface_name = cap_file_get_interface_name;
1545 epan->get_interface_description = cap_file_get_interface_description;
1546 epan->get_user_comment = NULL;
1552 raw_cf_open(capture_file *cf, const char *fname)
1554 if ((fd = raw_pipe_open(fname)) < 0)
1557 /* The open succeeded. Fill in the information for this file. */
1559 /* Create new epan session for dissection. */
1560 epan_free(cf->epan);
1561 cf->epan = raw_epan_new(cf);
1564 cf->f_datalen = 0; /* not used, but set it anyway */
1566 /* Set the file name because we need it to set the follow stream filter.
1567 XXX - is that still true? We need it for other reasons, though,
1569 cf->filename = g_strdup(fname);
1571 /* Indicate whether it's a permanent or temporary file. */
1572 cf->is_tempfile = FALSE;
1574 /* No user changes yet. */
1575 cf->unsaved_changes = FALSE;
1577 cf->cd_t = WTAP_FILE_TYPE_SUBTYPE_UNKNOWN;
1578 cf->open_type = WTAP_TYPE_AUTO;
1580 cf->drops_known = FALSE;
1582 cf->has_snap = FALSE;
1583 cf->snap = WTAP_MAX_PACKET_SIZE;
1584 nstime_set_zero(&cf->elapsed_time);
1594 * General errors are reported with an console message in Rawshark.
1597 failure_message(const char *msg_format, va_list ap)
1599 fprintf(stderr, "rawshark: ");
1600 vfprintf(stderr, msg_format, ap);
1601 fprintf(stderr, "\n");
1605 * Read errors are reported with an console message in Rawshark.
1608 read_failure_message(const char *filename, int err)
1610 cmdarg_err("An error occurred while reading from the file \"%s\": %s.",
1611 filename, g_strerror(err));
1615 * Write errors are reported with an console message in Rawshark.
1618 write_failure_message(const char *filename, int err)
1620 cmdarg_err("An error occurred while writing to the file \"%s\": %s.",
1621 filename, g_strerror(err));
1625 * Report an error in command-line arguments.
1628 rawshark_cmdarg_err(const char *fmt, va_list ap)
1630 fprintf(stderr, "rawshark: ");
1631 vfprintf(stderr, fmt, ap);
1632 fprintf(stderr, "\n");
1636 * Report additional information for an error in command-line arguments.
1639 rawshark_cmdarg_err_cont(const char *fmt, va_list ap)
1641 vfprintf(stderr, fmt, ap);
1642 fprintf(stderr, "\n");
1651 * indent-tabs-mode: nil
1654 * ex: set shiftwidth=4 tabstop=8 expandtab:
1655 * :indentSize=4:tabSize=8:noTabs=true: