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 #define INVALID_OPTION 1
126 #define INVALID_DFILTER 2
128 #define FORMAT_ERROR 2
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");
206 fprintf(output, " -m virtual memory limit, in bytes \n");
208 fprintf(output, " -n disable all name resolution (def: all enabled)\n");
209 fprintf(output, " -N <name resolve flags> enable specific name resolution(s): \"mnNtd\"\n");
210 fprintf(output, " -p use the system's packet header format\n");
211 fprintf(output, " (which may have 64-bit timestamps)\n");
212 fprintf(output, " -R <read filter> packet filter in Wireshark display filter syntax\n");
213 fprintf(output, " -s skip PCAP header on input\n");
215 fprintf(output, "\n");
216 fprintf(output, "Output:\n");
217 fprintf(output, " -l flush output after each packet\n");
218 fprintf(output, " -S format string for fields\n");
219 fprintf(output, " (%%D - name, %%S - stringval, %%N numval)\n");
220 fprintf(output, " -t ad|a|r|d|dd|e output format of time stamps (def: r: rel. to first)\n");
222 fprintf(output, "\n");
223 fprintf(output, "Miscellaneous:\n");
224 fprintf(output, " -h display this help and exit\n");
225 fprintf(output, " -o <name>:<value> ... override preference setting\n");
226 fprintf(output, " -v display version info and exit\n");
230 log_func_ignore (const gchar *log_domain _U_, GLogLevelFlags log_level _U_,
231 const gchar *message _U_, gpointer user_data _U_)
236 * Open a pipe for raw input. This is a stripped-down version of
237 * pcap_loop.c:cap_pipe_open_live().
238 * We check if "pipe_name" is "-" (stdin) or a FIFO, and open it.
239 * @param pipe_name The name of the pipe or FIFO.
240 * @return A POSIX file descriptor on success, or -1 on failure.
243 raw_pipe_open(const char *pipe_name)
246 ws_statb64 pipe_stat;
248 char *pncopy, *pos = NULL;
255 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "open_raw_pipe: %s", pipe_name);
258 * XXX Rawshark blocks until we return
260 if (strcmp(pipe_name, "-") == 0) {
261 rfd = 0; /* read from stdin */
264 * This is needed to set the stdin pipe into binary mode, otherwise
265 * CR/LF are mangled...
267 _setmode(0, _O_BINARY);
271 if (ws_stat64(pipe_name, &pipe_stat) < 0) {
272 fprintf(stderr, "rawshark: The pipe %s could not be checked: %s\n",
273 pipe_name, g_strerror(errno));
276 if (! S_ISFIFO(pipe_stat.st_mode)) {
277 if (S_ISCHR(pipe_stat.st_mode)) {
279 * Assume the user specified an interface on a system where
280 * interfaces are in /dev. Pretend we haven't seen it.
284 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
289 rfd = ws_open(pipe_name, O_RDONLY | O_NONBLOCK, 0000 /* no creation so don't matter */);
291 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
292 pipe_name, g_strerror(errno));
296 #define PIPE_STR "\\pipe\\"
297 /* Under Windows, named pipes _must_ have the form
298 * "\\<server>\pipe\<pipe_name>". <server> may be "." for localhost.
300 pncopy = g_strdup(pipe_name);
301 if (strstr(pncopy, "\\\\") == pncopy) {
302 pos = strchr(pncopy + 3, '\\');
303 if (pos && g_ascii_strncasecmp(pos, PIPE_STR, strlen(PIPE_STR)) != 0)
310 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
315 /* Wait for the pipe to appear */
317 hPipe = CreateFile(utf_8to16(pipe_name), GENERIC_READ, 0, NULL,
318 OPEN_EXISTING, 0, NULL);
320 if (hPipe != INVALID_HANDLE_VALUE)
323 err = GetLastError();
324 if (err != ERROR_PIPE_BUSY) {
325 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
326 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
327 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s (error %lu)\n",
328 pipe_name, utf_16to8(err_str), err);
333 if (!WaitNamedPipe(utf_8to16(pipe_name), 30 * 1000)) {
334 err = GetLastError();
335 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
336 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
337 fprintf(stderr, "rawshark: \"%s\" could not be waited for: %s (error %lu)\n",
338 pipe_name, utf_16to8(err_str), err);
344 rfd = _open_osfhandle((intptr_t) hPipe, _O_RDONLY);
346 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
347 pipe_name, g_strerror(errno));
357 * Parse a link-type argument of the form "encap:<pcap linktype>" or
358 * "proto:<proto name>". "Pcap linktype" must be a name conforming to
359 * pcap_datalink_name_to_val() or an integer; the integer should be
360 * a LINKTYPE_ value supported by Wiretap. "Proto name" must be
361 * a protocol name, e.g. "http".
364 set_link_type(const char *lt_arg) {
365 char *spec_ptr = strchr(lt_arg, ':');
369 dissector_handle_t dhandle;
377 if (strncmp(lt_arg, "encap:", strlen("encap:")) == 0) {
378 dlt_val = linktype_name_to_val(spec_ptr);
381 val = strtol(spec_ptr, &p, 10);
382 if (p == spec_ptr || *p != '\0' || errno != 0 || val > INT_MAX) {
388 * In those cases where a given link-layer header type
389 * has different LINKTYPE_ and DLT_ values, linktype_name_to_val()
390 * will return the OS's DLT_ value for that link-layer header
391 * type, not its OS-independent LINKTYPE_ value.
393 * On a given OS, wtap_pcap_encap_to_wtap_encap() should
394 * be able to map either LINKTYPE_ values or DLT_ values
395 * for the OS to the appropriate Wiretap encapsulation.
397 encap = wtap_pcap_encap_to_wtap_encap(dlt_val);
398 if (encap == WTAP_ENCAP_UNKNOWN) {
402 } else if (strncmp(lt_arg, "proto:", strlen("proto:")) == 0) {
403 dhandle = find_dissector(spec_ptr);
405 encap = WTAP_ENCAP_USER0;
406 pref_str = g_string_new("uat:user_dlts:");
407 /* This must match the format used in the user_dlts file */
408 g_string_append_printf(pref_str,
409 "\"User 0 (DLT=147)\",\"%s\",\"0\",\"\",\"0\",\"\"",
411 if (prefs_set_pref(pref_str->str) != PREFS_SET_OK) {
412 g_string_free(pref_str, TRUE);
415 g_string_free(pref_str, TRUE);
423 main(int argc, char *argv[])
425 GString *comp_info_str;
426 GString *runtime_info_str;
427 char *init_progfile_dir_error;
429 gboolean arg_error = FALSE;
437 char *gpf_path, *pf_path;
438 char *gdp_path, *dp_path;
439 int gpf_open_errno, gpf_read_errno;
440 int pf_open_errno, pf_read_errno;
441 int gdp_open_errno, gdp_read_errno;
442 int dp_open_errno, dp_read_errno;
443 gchar *pipe_name = NULL;
448 GPtrArray *disp_fields = g_ptr_array_new();
450 gboolean skip_pcap_header = FALSE;
451 int ret = EXIT_SUCCESS;
452 static const struct option long_options[] = {
453 {"help", no_argument, NULL, 'h'},
454 {"version", no_argument, NULL, 'v'},
458 #define OPTSTRING_INIT "d:F:hlm:nN:o:pr:R:sS:t:v"
460 static const char optstring[] = OPTSTRING_INIT;
462 /* Set the C-language locale to the native environment. */
463 setlocale(LC_ALL, "");
465 cmdarg_err_init(rawshark_cmdarg_err, rawshark_cmdarg_err_cont);
467 /* Get the compile-time version information string */
468 comp_info_str = get_compiled_version_info(NULL, epan_get_compiled_version_info);
470 /* Get the run-time version information string */
471 runtime_info_str = get_runtime_version_info(NULL);
473 /* Add it to the information to be reported on a crash. */
474 ws_add_crash_info("Rawshark (Wireshark) %s\n"
479 get_ws_vcs_version_info(), comp_info_str->str, runtime_info_str->str);
482 arg_list_utf_16to8(argc, argv);
483 create_app_running_mutex();
487 * Get credential information for later use.
489 init_process_policies();
492 * Clear the filters arrays
494 memset(rfilters, 0, sizeof(rfilters));
495 memset(rfcodes, 0, sizeof(rfcodes));
500 * Initialize our string format
502 string_fmts = g_ptr_array_new();
505 * Attempt to get the pathname of the directory containing the
508 init_progfile_dir_error = init_progfile_dir(argv[0], main);
509 if (init_progfile_dir_error != NULL) {
510 fprintf(stderr, "rawshark: Can't get pathname of rawshark program: %s.\n",
511 init_progfile_dir_error);
514 /* nothing more than the standard GLib handler, but without a warning */
516 G_LOG_LEVEL_WARNING |
517 G_LOG_LEVEL_MESSAGE |
521 g_log_set_handler(NULL,
522 (GLogLevelFlags)log_flags,
523 log_func_ignore, NULL /* user_data */);
524 g_log_set_handler(LOG_DOMAIN_CAPTURE_CHILD,
525 (GLogLevelFlags)log_flags,
526 log_func_ignore, NULL /* user_data */);
528 init_report_err(failure_message, open_failure_message, read_failure_message,
529 write_failure_message);
531 timestamp_set_type(TS_RELATIVE);
532 timestamp_set_precision(TS_PREC_AUTO);
533 timestamp_set_seconds_type(TS_SECONDS_DEFAULT);
537 /* Register all dissectors; we must do this before checking for the
538 "-G" flag, as the "-G" flag dumps information registered by the
539 dissectors, and we must do it before we read the preferences, in
540 case any dissectors register preferences. */
541 if (!epan_init(register_all_protocols, register_all_protocol_handoffs,
547 prefs_p = read_prefs(&gpf_open_errno, &gpf_read_errno, &gpf_path,
548 &pf_open_errno, &pf_read_errno, &pf_path);
549 if (gpf_path != NULL) {
550 if (gpf_open_errno != 0) {
551 cmdarg_err("Can't open global preferences file \"%s\": %s.",
552 pf_path, g_strerror(gpf_open_errno));
554 if (gpf_read_errno != 0) {
555 cmdarg_err("I/O error reading global preferences file \"%s\": %s.",
556 pf_path, g_strerror(gpf_read_errno));
559 if (pf_path != NULL) {
560 if (pf_open_errno != 0) {
561 cmdarg_err("Can't open your preferences file \"%s\": %s.", pf_path,
562 g_strerror(pf_open_errno));
564 if (pf_read_errno != 0) {
565 cmdarg_err("I/O error reading your preferences file \"%s\": %s.",
566 pf_path, g_strerror(pf_read_errno));
572 /* Read the disabled protocols file. */
573 read_disabled_protos_list(&gdp_path, &gdp_open_errno, &gdp_read_errno,
574 &dp_path, &dp_open_errno, &dp_read_errno);
575 read_enabled_protos_list(&gdp_path, &gdp_open_errno, &gdp_read_errno,
576 &dp_path, &dp_open_errno, &dp_read_errno);
577 read_disabled_heur_dissector_list(&gdp_path, &gdp_open_errno, &gdp_read_errno,
578 &dp_path, &dp_open_errno, &dp_read_errno);
579 if (gdp_path != NULL) {
580 if (gdp_open_errno != 0) {
581 cmdarg_err("Could not open global disabled protocols file\n\"%s\": %s.",
582 gdp_path, g_strerror(gdp_open_errno));
584 if (gdp_read_errno != 0) {
585 cmdarg_err("I/O error reading global disabled protocols file\n\"%s\": %s.",
586 gdp_path, g_strerror(gdp_read_errno));
590 if (dp_path != NULL) {
591 if (dp_open_errno != 0) {
593 "Could not open your disabled protocols file\n\"%s\": %s.", dp_path,
594 g_strerror(dp_open_errno));
596 if (dp_read_errno != 0) {
598 "I/O error reading your disabled protocols file\n\"%s\": %s.", dp_path,
599 g_strerror(dp_read_errno));
605 ws_init_dll_search_path();
606 /* Load Wpcap, if possible */
610 cap_file_init(&cfile);
612 /* Print format defaults to this. */
613 print_format = PR_FMT_TEXT;
615 /* Initialize our encapsulation type */
616 encap = WTAP_ENCAP_UNKNOWN;
618 /* Now get our args */
619 /* XXX - We should probably have an option to dump libpcap link types */
620 while ((opt = getopt_long(argc, argv, optstring, long_options, NULL)) != -1) {
622 case 'd': /* Payload type */
623 if (!set_link_type(optarg)) {
624 cmdarg_err("Invalid link type or protocol \"%s\"", optarg);
625 ret = INVALID_OPTION;
629 case 'F': /* Read field to display */
630 g_ptr_array_add(disp_fields, g_strdup(optarg));
632 case 'h': /* Print help and exit */
633 printf("Rawshark (Wireshark) %s\n"
634 "Dump and analyze network traffic.\n"
635 "See https://www.wireshark.org for more information.\n",
636 get_ws_vcs_version_info());
640 case 'l': /* "Line-buffer" standard output */
641 /* This isn't line-buffering, strictly speaking, it's just
642 flushing the standard output after the information for
643 each packet is printed; however, that should be good
644 enough for all the purposes to which "-l" is put (and
645 is probably actually better for "-V", as it does fewer
648 See the comment in "process_packet()" for an explanation of
649 why we do that, and why we don't just use "setvbuf()" to
650 make the standard output line-buffered (short version: in
651 Windows, "line-buffered" is the same as "fully-buffered",
652 and the output buffer is only flushed when it fills up). */
653 line_buffered = TRUE;
657 limit.rlim_cur = get_positive_int(optarg, "memory limit");
658 limit.rlim_max = get_positive_int(optarg, "memory limit");
660 if(setrlimit(RLIMIT_AS, &limit) != 0) {
661 cmdarg_err("setrlimit() returned error");
662 ret = INVALID_OPTION;
667 case 'n': /* No name resolution */
668 disable_name_resolution();
670 case 'N': /* Select what types of addresses/port #s to resolve */
671 badopt = string_to_name_resolve(optarg, &gbl_resolv_flags);
672 if (badopt != '\0') {
673 cmdarg_err("-N specifies unknown resolving option '%c'; valid options are 'd', m', 'n', 'N', and 't'",
675 ret = INVALID_OPTION;
679 case 'o': /* Override preference from command line */
680 switch (prefs_set_pref(optarg)) {
685 case PREFS_SET_SYNTAX_ERR:
686 cmdarg_err("Invalid -o flag \"%s\"", optarg);
687 ret = INVALID_OPTION;
691 case PREFS_SET_NO_SUCH_PREF:
692 case PREFS_SET_OBSOLETE:
693 cmdarg_err("-o flag \"%s\" specifies unknown preference", optarg);
694 ret = INVALID_OPTION;
699 case 'p': /* Expect pcap_pkthdr packet headers, which may have 64-bit timestamps */
700 want_pcap_pkthdr = TRUE;
702 case 'r': /* Read capture file xxx */
703 pipe_name = g_strdup(optarg);
705 case 'R': /* Read file filter */
706 if(n_rfilters < (int) sizeof(rfilters) / (int) sizeof(rfilters[0])) {
707 rfilters[n_rfilters++] = optarg;
710 cmdarg_err("Too many display filters");
711 ret = INVALID_OPTION;
715 case 's': /* Skip PCAP header */
716 skip_pcap_header = TRUE;
718 case 'S': /* Print string representations */
719 if (!parse_field_string_format(optarg)) {
720 cmdarg_err("Invalid field string format");
721 ret = INVALID_OPTION;
725 case 't': /* Time stamp type */
726 if (strcmp(optarg, "r") == 0)
727 timestamp_set_type(TS_RELATIVE);
728 else if (strcmp(optarg, "a") == 0)
729 timestamp_set_type(TS_ABSOLUTE);
730 else if (strcmp(optarg, "ad") == 0)
731 timestamp_set_type(TS_ABSOLUTE_WITH_YMD);
732 else if (strcmp(optarg, "adoy") == 0)
733 timestamp_set_type(TS_ABSOLUTE_WITH_YDOY);
734 else if (strcmp(optarg, "d") == 0)
735 timestamp_set_type(TS_DELTA);
736 else if (strcmp(optarg, "dd") == 0)
737 timestamp_set_type(TS_DELTA_DIS);
738 else if (strcmp(optarg, "e") == 0)
739 timestamp_set_type(TS_EPOCH);
740 else if (strcmp(optarg, "u") == 0)
741 timestamp_set_type(TS_UTC);
742 else if (strcmp(optarg, "ud") == 0)
743 timestamp_set_type(TS_UTC_WITH_YMD);
744 else if (strcmp(optarg, "udoy") == 0)
745 timestamp_set_type(TS_UTC_WITH_YDOY);
747 cmdarg_err("Invalid time stamp type \"%s\"",
750 "It must be \"a\" for absolute, \"ad\" for absolute with YYYY-MM-DD date,");
752 "\"adoy\" for absolute with YYYY/DOY date, \"d\" for delta,");
754 "\"dd\" for delta displayed, \"e\" for epoch, \"r\" for relative,");
756 "\"u\" for absolute UTC, \"ud\" for absolute UTC with YYYY-MM-DD date,");
758 "or \"udoy\" for absolute UTC with YYYY/DOY date.");
759 ret = INVALID_OPTION;
763 case 'v': /* Show version and exit */
765 show_version("Rawshark (Wireshark)", comp_info_str, runtime_info_str);
766 g_string_free(comp_info_str, TRUE);
767 g_string_free(runtime_info_str, TRUE);
772 case '?': /* Bad flag - print usage message */
774 ret = INVALID_OPTION;
780 /* Notify all registered modules that have had any of their preferences
781 changed either from one of the preferences file or from the command
782 line that their preferences have changed.
783 Initialize preferences before display filters, otherwise modules
784 like MATE won't work. */
787 /* Initialize our display fields */
788 for (fc = 0; fc < disp_fields->len; fc++) {
789 protocolinfo_init((char *)g_ptr_array_index(disp_fields, fc));
791 g_ptr_array_free(disp_fields, TRUE);
795 /* If no capture filter or read filter has been specified, and there are
796 still command-line arguments, treat them as the tokens of a capture
797 filter (if no "-r" flag was specified) or a read filter (if a "-r"
798 flag was specified. */
800 if (pipe_name != NULL) {
801 if (n_rfilters != 0) {
802 cmdarg_err("Read filters were specified both with \"-R\" "
803 "and with additional command-line arguments");
804 ret = INVALID_OPTION;
807 rfilters[n_rfilters] = get_args_as_string(argc, argv, optind);
811 /* Make sure we got a dissector handle for our payload. */
812 if (encap == WTAP_ENCAP_UNKNOWN) {
813 cmdarg_err("No valid payload dissector specified.");
814 ret = INVALID_OPTION;
820 ret = INVALID_OPTION;
826 /* Start windows sockets */
827 WSAStartup( MAKEWORD( 1, 1 ), &wsaData );
830 /* At this point MATE will have registered its field array so we can
831 have a tap filter with one of MATE's late-registered fields as part
832 of the filter. We can now process all the "-z" arguments. */
833 start_requested_stats();
835 /* disabled protocols as per configuration file */
836 if (gdp_path == NULL && dp_path == NULL) {
837 set_disabled_protos_list();
838 set_enabled_protos_list();
839 set_disabled_heur_dissector_list();
842 /* Build the column format array */
843 build_column_format_array(&cfile.cinfo, prefs_p->num_cols, TRUE);
845 if (n_rfilters != 0) {
846 for (i = 0; i < n_rfilters; i++) {
849 if (!dfilter_compile(rfilters[i], &rfcodes[n_rfcodes], &err_msg)) {
850 cmdarg_err("%s", err_msg);
852 ret = INVALID_DFILTER;
861 * We're reading a pipe (or capture file).
865 * Immediately relinquish any special privileges we have; we must not
866 * be allowed to read any capture files the user running Rawshark
869 relinquish_special_privs_perm();
871 if (raw_cf_open(&cfile, pipe_name) != CF_OK) {
876 /* Do we need to PCAP header and magic? */
877 if (skip_pcap_header) {
878 unsigned int bytes_left = (unsigned int) sizeof(struct pcap_hdr) + sizeof(guint32);
879 gchar buf[sizeof(struct pcap_hdr) + sizeof(guint32)];
880 while (bytes_left != 0) {
881 ssize_t bytes = ws_read(fd, buf, bytes_left);
883 cmdarg_err("Not enough bytes for pcap header.");
891 /* Process the packets in the file */
892 if (!load_cap_file(&cfile)) {
897 /* If you want to capture live packets, use TShark. */
898 cmdarg_err("Input file or pipe name not specified.");
904 epan_free(cfile.epan);
914 * Read data from a raw pipe. The "raw" data consists of a libpcap
915 * packet header followed by the payload.
916 * @param pd [IN] A POSIX file descriptor. Because that's _exactly_ the sort
917 * of thing you want to use in Windows.
918 * @param phdr [OUT] Packet header information.
919 * @param err [OUT] Error indicator. Uses wiretap values.
920 * @param err_info [OUT] Error message.
921 * @param data_offset [OUT] data offset in the pipe.
922 * @return TRUE on success, FALSE on failure.
925 raw_pipe_read(struct wtap_pkthdr *phdr, guchar * pd, int *err, gchar **err_info, gint64 *data_offset) {
926 struct pcap_pkthdr mem_hdr;
927 struct pcaprec_hdr disk_hdr;
928 ssize_t bytes_read = 0;
929 unsigned int bytes_needed = (unsigned int) sizeof(disk_hdr);
930 guchar *ptr = (guchar*) &disk_hdr;
934 if (want_pcap_pkthdr) {
935 bytes_needed = sizeof(mem_hdr);
936 ptr = (guchar*) &mem_hdr;
940 * Newer versions of the VC runtime do parameter validation. If stdin
941 * has been closed, calls to _read, _get_osfhandle, et al will trigger
942 * the invalid parameter handler and crash.
943 * We could alternatively use ReadFile or set an invalid parameter
945 * We could also tell callers not to close stdin prematurely.
949 if (fd == 0 && GetHandleInformation(GetStdHandle(STD_INPUT_HANDLE), &ghi_flags) == 0) {
956 /* Copied from capture_loop.c */
957 while (bytes_needed > 0) {
958 bytes_read = ws_read(fd, ptr, bytes_needed);
959 if (bytes_read == 0) {
963 } else if (bytes_read < 0) {
968 bytes_needed -= bytes_read;
969 *data_offset += bytes_read;
973 if (want_pcap_pkthdr) {
974 phdr->ts.secs = mem_hdr.ts.tv_sec;
975 phdr->ts.nsecs = (gint32)mem_hdr.ts.tv_usec * 1000;
976 phdr->caplen = mem_hdr.caplen;
977 phdr->len = mem_hdr.len;
979 phdr->ts.secs = disk_hdr.ts_sec;
980 phdr->ts.nsecs = disk_hdr.ts_usec * 1000;
981 phdr->caplen = disk_hdr.incl_len;
982 phdr->len = disk_hdr.orig_len;
984 bytes_needed = phdr->caplen;
986 phdr->pkt_encap = encap;
989 printf("mem_hdr: %lu disk_hdr: %lu\n", sizeof(mem_hdr), sizeof(disk_hdr));
990 printf("tv_sec: %u (%04x)\n", (unsigned int) phdr->ts.secs, (unsigned int) phdr->ts.secs);
991 printf("tv_nsec: %d (%04x)\n", phdr->ts.nsecs, phdr->ts.nsecs);
992 printf("caplen: %d (%04x)\n", phdr->caplen, phdr->caplen);
993 printf("len: %d (%04x)\n", phdr->len, phdr->len);
995 if (bytes_needed > WTAP_MAX_PACKET_SIZE) {
996 *err = WTAP_ERR_BAD_FILE;
997 *err_info = g_strdup_printf("Bad packet length: %lu\n",
998 (unsigned long) bytes_needed);
1003 while (bytes_needed > 0) {
1004 bytes_read = ws_read(fd, ptr, bytes_needed);
1005 if (bytes_read == 0) {
1006 *err = WTAP_ERR_SHORT_READ;
1009 } else if (bytes_read < 0) {
1014 bytes_needed -= bytes_read;
1015 *data_offset += bytes_read;
1022 load_cap_file(capture_file *cf)
1025 gchar *err_info = NULL;
1026 gint64 data_offset = 0;
1028 guchar pd[WTAP_MAX_PACKET_SIZE];
1029 struct wtap_pkthdr phdr;
1032 wtap_phdr_init(&phdr);
1034 epan_dissect_init(&edt, cf->epan, TRUE, FALSE);
1036 while (raw_pipe_read(&phdr, pd, &err, &err_info, &data_offset)) {
1037 process_packet(cf, &edt, data_offset, &phdr, pd);
1040 epan_dissect_cleanup(&edt);
1042 wtap_phdr_cleanup(&phdr);
1045 /* Print a message noting that the read failed somewhere along the line. */
1048 case WTAP_ERR_UNSUPPORTED:
1049 cmdarg_err("The file \"%s\" contains record data that Rawshark doesn't support.\n(%s)",
1051 err_info != NULL ? err_info : "no information supplied");
1055 case WTAP_ERR_SHORT_READ:
1056 cmdarg_err("The file \"%s\" appears to have been cut short in the middle of a packet.",
1060 case WTAP_ERR_BAD_FILE:
1061 cmdarg_err("The file \"%s\" appears to be damaged or corrupt.\n(%s)",
1063 err_info != NULL ? err_info : "no information supplied");
1067 case WTAP_ERR_DECOMPRESS:
1068 cmdarg_err("The compressed file \"%s\" appears to be damaged or corrupt.\n(%s)",
1070 err_info != NULL ? err_info : "no information supplied");
1075 cmdarg_err("An error occurred while reading the file \"%s\": %s.",
1076 cf->filename, wtap_strerror(err));
1086 process_packet(capture_file *cf, epan_dissect_t *edt, gint64 offset,
1087 struct wtap_pkthdr *whdr, const guchar *pd)
1095 /* The user sends an empty packet when he wants to get output from us even if we don't currently have
1096 packets to process. We spit out a line with the timestamp and the text "void"
1098 printf("%lu %lu %lu void -\n", (unsigned long int)cf->count,
1099 (unsigned long int)whdr->ts.secs,
1100 (unsigned long int)whdr->ts.nsecs);
1107 /* Count this packet. */
1110 /* If we're going to print packet information, or we're going to
1111 run a read filter, or we're going to process taps, set up to
1112 do a dissection and do so. */
1113 frame_data_init(&fdata, cf->count, whdr, offset, cum_bytes);
1117 /* If we're running a read filter, prime the epan_dissect_t with that
1119 if (n_rfilters > 0) {
1120 for(i = 0; i < n_rfcodes; i++) {
1121 epan_dissect_prime_dfilter(edt, rfcodes[i]);
1125 printf("%lu", (unsigned long int) cf->count);
1127 frame_data_set_before_dissect(&fdata, &cf->elapsed_time,
1130 if (ref == &fdata) {
1135 /* We only need the columns if we're printing packet info but we're
1136 *not* verbose; in verbose mode, we print the protocol tree, not
1137 the protocol summary. */
1138 epan_dissect_run_with_taps(edt, cf->cd_t, whdr, frame_tvbuff_new(&fdata, pd), &fdata, &cf->cinfo);
1140 frame_data_set_after_dissect(&fdata, &cum_bytes);
1141 prev_dis_frame = fdata;
1142 prev_dis = &prev_dis_frame;
1144 prev_cap_frame = fdata;
1145 prev_cap = &prev_cap_frame;
1147 for(i = 0; i < n_rfilters; i++) {
1148 /* Run the read filter if we have one. */
1150 passed = dfilter_apply_edt(rfcodes[i], edt);
1154 /* Print a one-line summary */
1155 printf(" %d", passed ? 1 : 0);
1160 /* The ANSI C standard does not appear to *require* that a line-buffered
1161 stream be flushed to the host environment whenever a newline is
1162 written, it just says that, on such a stream, characters "are
1163 intended to be transmitted to or from the host environment as a
1164 block when a new-line character is encountered".
1166 The Visual C++ 6.0 C implementation doesn't do what is intended;
1167 even if you set a stream to be line-buffered, it still doesn't
1168 flush the buffer at the end of every line.
1170 So, if the "-l" flag was specified, we flush the standard output
1171 at the end of a packet. This will do the right thing if we're
1172 printing packet summary lines, and, as we print the entire protocol
1173 tree for a single packet without waiting for anything to happen,
1174 it should be as good as line-buffered mode if we're printing
1175 protocol trees. (The whole reason for the "-l" flag in either
1176 tcpdump or Rawshark is to allow the output of a live capture to
1177 be piped to a program or script and to have that script see the
1178 information for the packet as soon as it's printed, rather than
1179 having to wait until a standard I/O buffer fills up. */
1183 if (ferror(stdout)) {
1184 show_print_file_io_error(errno);
1188 epan_dissect_reset(edt);
1189 frame_data_destroy(&fdata);
1194 /****************************************************************************************
1195 * FIELD EXTRACTION ROUTINES
1196 ****************************************************************************************/
1197 typedef struct _pci_t {
1203 static const char* ftenum_to_string(header_field_info *hfi)
1210 if (string_fmts->len > 0 && hfi->strings) {
1214 str = ftype_name(hfi->type);
1222 static void field_display_to_string(header_field_info *hfi, char* buf, int size)
1224 if (hfi->type != FT_BOOLEAN)
1226 g_strlcpy(buf, proto_field_display_to_string(hfi->display), size);
1230 g_snprintf(buf, size, "(Bit count: %d)", hfi->display);
1235 * Copied from various parts of proto.c
1237 #define FIELD_STR_INIT_LEN 256
1238 #define cVALS(x) (const value_string*)(x)
1239 static gboolean print_field_value(field_info *finfo, int cmd_line_index)
1241 header_field_info *hfinfo;
1242 char *fs_buf = NULL;
1243 char *fs_ptr = NULL;
1244 static GString *label_s = NULL;
1252 const true_false_string *tfstring = &tfs_true_false;
1254 hfinfo = finfo->hfinfo;
1257 label_s = g_string_new("");
1260 if(finfo->value.ftype->val_to_string_repr)
1263 * this field has an associated value,
1266 fs_len = fvalue_string_repr_len(&finfo->value, FTREPR_DFILTER, finfo->hfinfo->display);
1267 fs_buf = fvalue_to_string_repr(NULL, &finfo->value,
1268 FTREPR_DFILTER, finfo->hfinfo->display);
1271 /* String types are quoted. Remove them. */
1272 if (IS_FT_STRING(finfo->value.ftype->ftype) && fs_len > 2) {
1273 fs_buf[fs_len - 1] = '\0';
1278 if (string_fmts->len > 0 && finfo->hfinfo->strings) {
1279 g_string_truncate(label_s, 0);
1280 for (i = 0; i < string_fmts->len; i++) {
1281 sf = (string_fmt_t *)g_ptr_array_index(string_fmts, i);
1283 g_string_append(label_s, sf->plain);
1285 switch (sf->format) {
1287 g_string_append(label_s, hfinfo->name);
1290 g_string_append(label_s, fs_ptr);
1293 switch(hfinfo->type) {
1295 uvalue64 = fvalue_get_uinteger64(&finfo->value);
1296 tfstring = (const struct true_false_string*) hfinfo->strings;
1297 g_string_append(label_s, uvalue64 ? tfstring->true_string : tfstring->false_string);
1303 DISSECTOR_ASSERT(!hfinfo->bitmask);
1304 svalue = fvalue_get_sinteger(&finfo->value);
1305 if (hfinfo->display & BASE_RANGE_STRING) {
1306 g_string_append(label_s, rval_to_str_const(svalue, RVALS(hfinfo->strings), "Unknown"));
1307 } else if (hfinfo->display & BASE_EXT_STRING) {
1308 g_string_append(label_s, val_to_str_ext_const(svalue, (value_string_ext *) hfinfo->strings, "Unknown"));
1310 g_string_append(label_s, val_to_str_const(svalue, cVALS(hfinfo->strings), "Unknown"));
1313 case FT_INT40: /* XXX: Shouldn't these be as smart as FT_INT{8,16,24,32}? */
1317 DISSECTOR_ASSERT(!hfinfo->bitmask);
1318 svalue64 = (gint64)fvalue_get_sinteger64(&finfo->value);
1319 if (hfinfo->display & BASE_VAL64_STRING) {
1320 g_string_append(label_s, val64_to_str_const(svalue64, (const val64_string *)(hfinfo->strings), "Unknown"));
1327 DISSECTOR_ASSERT(!hfinfo->bitmask);
1328 uvalue = fvalue_get_uinteger(&finfo->value);
1329 if (!hfinfo->bitmask && hfinfo->display & BASE_RANGE_STRING) {
1330 g_string_append(label_s, rval_to_str_const(uvalue, RVALS(hfinfo->strings), "Unknown"));
1331 } else if (hfinfo->display & BASE_EXT_STRING) {
1332 g_string_append(label_s, val_to_str_ext_const(uvalue, (value_string_ext *) hfinfo->strings, "Unknown"));
1334 g_string_append(label_s, val_to_str_const(uvalue, cVALS(hfinfo->strings), "Unknown"));
1337 case FT_UINT40: /* XXX: Shouldn't these be as smart as FT_INT{8,16,24,32}? */
1341 DISSECTOR_ASSERT(!hfinfo->bitmask);
1342 uvalue64 = fvalue_get_uinteger64(&finfo->value);
1343 if (hfinfo->display & BASE_VAL64_STRING) {
1344 g_string_append(label_s, val64_to_str_const(uvalue64, (const val64_string *)(hfinfo->strings), "Unknown"));
1356 printf(" %d=\"%s\"", cmd_line_index, label_s->str);
1357 wmem_free(NULL, fs_buf);
1361 if(finfo->value.ftype->val_to_string_repr)
1363 printf(" %d=\"%s\"", cmd_line_index, fs_ptr);
1364 wmem_free(NULL, fs_buf);
1369 * This field doesn't have an associated value,
1373 printf(" %d=\"n.a.\"", cmd_line_index);
1378 protocolinfo_packet(void *prs, packet_info *pinfo _U_, epan_dissect_t *edt, const void *dummy _U_)
1380 pci_t *rs=(pci_t *)prs;
1384 gp=proto_get_finfo_ptr_array(edt->tree, rs->hf_index);
1391 * Print each occurrence of the field
1393 for (i = 0; i < gp->len; i++) {
1394 print_field_value((field_info *)gp->pdata[i], rs->cmd_line_index);
1400 int g_cmd_line_index = 0;
1403 * field must be persistent - we don't g_strdup() it below
1406 protocolinfo_init(char *field)
1409 header_field_info *hfi;
1410 GString *error_string;
1413 hfi=proto_registrar_get_byname(field);
1415 fprintf(stderr, "rawshark: Field \"%s\" doesn't exist.\n", field);
1419 field_display_to_string(hfi, hfibuf, sizeof(hfibuf));
1420 printf("%d %s %s - ",
1422 ftenum_to_string(hfi),
1425 rs=(pci_t *)g_malloc(sizeof(pci_t));
1426 rs->hf_index=hfi->id;
1428 rs->cmd_line_index = g_cmd_line_index++;
1430 error_string=register_tap_listener("frame", rs, rs->filter, TL_REQUIRES_PROTO_TREE, NULL, protocolinfo_packet, NULL);
1432 /* error, we failed to attach to the tap. complain and clean up */
1433 fprintf(stderr, "rawshark: Couldn't register field extraction tap: %s\n",
1435 g_string_free(error_string, TRUE);
1446 * Given a format string, split it into a GPtrArray of string_fmt_t structs
1447 * and fill in string_fmt_parts.
1451 add_string_fmt(string_fmt_e format, gchar *plain) {
1452 string_fmt_t *sf = (string_fmt_t *)g_malloc(sizeof(string_fmt_t));
1454 sf->format = format;
1455 sf->plain = g_strdup(plain);
1457 g_ptr_array_add(string_fmts, sf);
1461 parse_field_string_format(gchar *format) {
1462 GString *plain_s = g_string_new("");
1470 len = strlen(format);
1471 g_ptr_array_set_size(string_fmts, 0);
1474 if (format[pos] == '%') {
1475 if (pos >= len) { /* There should always be a following character */
1479 if (plain_s->len > 0) {
1480 add_string_fmt(SF_NONE, plain_s->str);
1481 g_string_truncate(plain_s, 0);
1483 switch (format[pos]) {
1485 add_string_fmt(SF_NAME, NULL);
1488 add_string_fmt(SF_NUMVAL, NULL);
1491 add_string_fmt(SF_STRVAL, NULL);
1494 g_string_append_c(plain_s, '%');
1496 default: /* Invalid format */
1500 g_string_append_c(plain_s, format[pos]);
1505 if (plain_s->len > 0) {
1506 add_string_fmt(SF_NONE, plain_s->str);
1508 g_string_free(plain_s, TRUE);
1512 /****************************************************************************************
1513 * END OF FIELD EXTRACTION ROUTINES
1514 ****************************************************************************************/
1517 show_print_file_io_error(int err)
1522 cmdarg_err("Not all the packets could be printed because there is "
1523 "no space left on the file system.");
1528 cmdarg_err("Not all the packets could be printed because you are "
1529 "too close to, or over your disk quota.");
1534 cmdarg_err("An error occurred while printing packets: %s.",
1541 * Open/create errors are reported with an console message in Rawshark.
1544 open_failure_message(const char *filename, int err, gboolean for_writing)
1546 fprintf(stderr, "rawshark: ");
1547 fprintf(stderr, file_open_error_message(err, for_writing), filename);
1548 fprintf(stderr, "\n");
1551 static const nstime_t *
1552 raw_get_frame_ts(void *data _U_, guint32 frame_num)
1554 if (ref && ref->num == frame_num)
1555 return &ref->abs_ts;
1557 if (prev_dis && prev_dis->num == frame_num)
1558 return &prev_dis->abs_ts;
1560 if (prev_cap && prev_cap->num == frame_num)
1561 return &prev_cap->abs_ts;
1567 raw_epan_new(capture_file *cf)
1569 epan_t *epan = epan_new();
1572 epan->get_frame_ts = raw_get_frame_ts;
1573 epan->get_interface_name = cap_file_get_interface_name;
1574 epan->get_interface_description = cap_file_get_interface_description;
1575 epan->get_user_comment = NULL;
1581 raw_cf_open(capture_file *cf, const char *fname)
1583 if ((fd = raw_pipe_open(fname)) < 0)
1586 /* The open succeeded. Fill in the information for this file. */
1588 /* Create new epan session for dissection. */
1589 epan_free(cf->epan);
1590 cf->epan = raw_epan_new(cf);
1593 cf->f_datalen = 0; /* not used, but set it anyway */
1595 /* Set the file name because we need it to set the follow stream filter.
1596 XXX - is that still true? We need it for other reasons, though,
1598 cf->filename = g_strdup(fname);
1600 /* Indicate whether it's a permanent or temporary file. */
1601 cf->is_tempfile = FALSE;
1603 /* No user changes yet. */
1604 cf->unsaved_changes = FALSE;
1606 cf->cd_t = WTAP_FILE_TYPE_SUBTYPE_UNKNOWN;
1607 cf->open_type = WTAP_TYPE_AUTO;
1609 cf->drops_known = FALSE;
1611 cf->has_snap = FALSE;
1612 cf->snap = WTAP_MAX_PACKET_SIZE;
1613 nstime_set_zero(&cf->elapsed_time);
1623 * General errors are reported with an console message in Rawshark.
1626 failure_message(const char *msg_format, va_list ap)
1628 fprintf(stderr, "rawshark: ");
1629 vfprintf(stderr, msg_format, ap);
1630 fprintf(stderr, "\n");
1634 * Read errors are reported with an console message in Rawshark.
1637 read_failure_message(const char *filename, int err)
1639 cmdarg_err("An error occurred while reading from the file \"%s\": %s.",
1640 filename, g_strerror(err));
1644 * Write errors are reported with an console message in Rawshark.
1647 write_failure_message(const char *filename, int err)
1649 cmdarg_err("An error occurred while writing to the file \"%s\": %s.",
1650 filename, g_strerror(err));
1654 * Report an error in command-line arguments.
1657 rawshark_cmdarg_err(const char *fmt, va_list ap)
1659 fprintf(stderr, "rawshark: ");
1660 vfprintf(stderr, fmt, ap);
1661 fprintf(stderr, "\n");
1665 * Report additional information for an error in command-line arguments.
1668 rawshark_cmdarg_err_cont(const char *fmt, va_list ap)
1670 vfprintf(stderr, fmt, ap);
1671 fprintf(stderr, "\n");
1680 * indent-tabs-mode: nil
1683 * ex: set shiftwidth=4 tabstop=8 expandtab:
1684 * :indentSize=4:tabSize=8:noTabs=true: