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.
49 #ifndef HAVE_GETOPT_LONG
50 #include "wsutil/wsgetopt.h"
54 #include <epan/epan-int.h>
55 #include <epan/epan.h>
57 #include <wsutil/cmdarg_err.h>
58 #include <wsutil/crash_info.h>
59 #include <wsutil/filesystem.h>
60 #include <wsutil/file_util.h>
61 #include <wsutil/plugins.h>
62 #include <wsutil/privileges.h>
63 #include <wsutil/report_err.h>
66 #include <epan/packet.h>
67 #include <epan/ftypes/ftypes-int.h>
69 #include "frame_tvbuff.h"
70 #include <epan/disabled_protos.h>
71 #include <epan/prefs.h>
72 #include <epan/column.h>
73 #include <epan/print.h>
74 #include <epan/addr_resolv.h>
76 #include "ui/capture_ui_utils.h"
80 #include "conditions.h"
81 #include "capture_stop_conditions.h"
82 #include <epan/epan_dissect.h>
83 #include <epan/stat_tap_ui.h>
84 #include <epan/timestamp.h>
85 #include <wsutil/unicode-utils.h>
86 #include "epan/column-utils.h"
87 #include "epan/proto.h"
90 #include <wiretap/wtap.h>
91 #include <wiretap/libpcap.h>
92 #include <wiretap/pcap-encap.h>
94 #include <wsutil/clopts_common.h>
95 #include <ws_version_info.h>
97 #include "caputils/capture-pcap-util.h"
102 #include "caputils/capture-wpcap.h"
104 #endif /* HAVE_LIBPCAP */
109 * This is the template for the decode as option; it is shared between the
110 * various functions that output the usage for this parameter.
112 static const gchar decode_as_arg_template[] = "<layer_type>==<selector>,<decode_as_protocol>";
115 static guint32 cum_bytes;
116 static const frame_data *ref;
117 static frame_data ref_frame;
118 static frame_data *prev_dis;
119 static frame_data prev_dis_frame;
120 static frame_data *prev_cap;
121 static frame_data prev_cap_frame;
124 * The way the packet decode is to be written.
127 WRITE_TEXT, /* summary or detail text */
128 WRITE_XML /* PDML or PSML */
129 /* Add CSV and the like here */
132 static gboolean line_buffered;
133 static print_format_e print_format = PR_FMT_TEXT;
135 static gboolean want_pcap_pkthdr;
137 cf_status_t raw_cf_open(capture_file *cf, const char *fname);
138 static gboolean load_cap_file(capture_file *cf);
139 static gboolean process_packet(capture_file *cf, epan_dissect_t *edt, gint64 offset,
140 struct wtap_pkthdr *whdr, const guchar *pd);
141 static void show_print_file_io_error(int err);
143 static void open_failure_message(const char *filename, int err,
144 gboolean for_writing);
145 static void failure_message(const char *msg_format, va_list ap);
146 static void read_failure_message(const char *filename, int err);
147 static void write_failure_message(const char *filename, int err);
148 static void rawshark_cmdarg_err(const char *fmt, va_list ap);
149 static void rawshark_cmdarg_err_cont(const char *fmt, va_list ap);
150 static void protocolinfo_init(char *field);
151 static gboolean parse_field_string_format(char *format);
154 SF_NONE, /* No format (placeholder) */
155 SF_NAME, /* %D Field name / description */
156 SF_NUMVAL, /* %N Numeric value */
157 SF_STRVAL /* %S String value */
160 typedef struct string_fmt_s {
162 string_fmt_e format; /* Valid if plain is NULL */
168 dfilter_t *rfcodes[64];
170 dfilter_t *rfieldfcodes[64];
173 GPtrArray *string_fmts;
176 print_usage(FILE *output)
178 fprintf(output, "\n");
179 fprintf(output, "Usage: rawshark [options] ...\n");
180 fprintf(output, "\n");
182 fprintf(output, "Input file:\n");
183 fprintf(output, " -r <infile> set the pipe or file name to read from\n");
185 fprintf(output, "\n");
186 fprintf(output, "Processing:\n");
187 fprintf(output, " -d <encap:linktype>|<proto:protoname>\n");
188 fprintf(output, " packet encapsulation or protocol\n");
189 fprintf(output, " -F <field> field to display\n");
190 fprintf(output, " -n disable all name resolution (def: all enabled)\n");
191 fprintf(output, " -N <name resolve flags> enable specific name resolution(s): \"mnNtd\"\n");
192 fprintf(output, " -p use the system's packet header format\n");
193 fprintf(output, " (which may have 64-bit timestamps)\n");
194 fprintf(output, " -R <read filter> packet filter in Wireshark display filter syntax\n");
195 fprintf(output, " -s skip PCAP header on input\n");
197 fprintf(output, "\n");
198 fprintf(output, "Output:\n");
199 fprintf(output, " -l flush output after each packet\n");
200 fprintf(output, " -S format string for fields\n");
201 fprintf(output, " (%%D - name, %%S - stringval, %%N numval)\n");
202 fprintf(output, " -t ad|a|r|d|dd|e output format of time stamps (def: r: rel. to first)\n");
204 fprintf(output, "\n");
205 fprintf(output, "Miscellaneous:\n");
206 fprintf(output, " -h display this help and exit\n");
207 fprintf(output, " -o <name>:<value> ... override preference setting\n");
208 fprintf(output, " -v display version info and exit\n");
212 log_func_ignore (const gchar *log_domain _U_, GLogLevelFlags log_level _U_,
213 const gchar *message _U_, gpointer user_data _U_)
218 * Open a pipe for raw input. This is a stripped-down version of
219 * pcap_loop.c:cap_pipe_open_live().
220 * We check if "pipe_name" is "-" (stdin) or a FIFO, and open it.
221 * @param pipe_name The name of the pipe or FIFO.
222 * @return A POSIX file descriptor on success, or -1 on failure.
225 raw_pipe_open(const char *pipe_name)
228 ws_statb64 pipe_stat;
230 char *pncopy, *pos = NULL;
237 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "open_raw_pipe: %s", pipe_name);
240 * XXX Rawshark blocks until we return
242 if (strcmp(pipe_name, "-") == 0) {
243 rfd = 0; /* read from stdin */
246 * This is needed to set the stdin pipe into binary mode, otherwise
247 * CR/LF are mangled...
249 _setmode(0, _O_BINARY);
253 if (ws_stat64(pipe_name, &pipe_stat) < 0) {
254 fprintf(stderr, "rawshark: The pipe %s could not be checked: %s\n",
255 pipe_name, g_strerror(errno));
258 if (! S_ISFIFO(pipe_stat.st_mode)) {
259 if (S_ISCHR(pipe_stat.st_mode)) {
261 * Assume the user specified an interface on a system where
262 * interfaces are in /dev. Pretend we haven't seen it.
266 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
271 rfd = ws_open(pipe_name, O_RDONLY | O_NONBLOCK, 0000 /* no creation so don't matter */);
273 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
274 pipe_name, g_strerror(errno));
278 #define PIPE_STR "\\pipe\\"
279 /* Under Windows, named pipes _must_ have the form
280 * "\\<server>\pipe\<pipe_name>". <server> may be "." for localhost.
282 pncopy = g_strdup(pipe_name);
283 if (strstr(pncopy, "\\\\") == pncopy) {
284 pos = strchr(pncopy + 3, '\\');
285 if (pos && g_ascii_strncasecmp(pos, PIPE_STR, strlen(PIPE_STR)) != 0)
292 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
297 /* Wait for the pipe to appear */
299 hPipe = CreateFile(utf_8to16(pipe_name), GENERIC_READ, 0, NULL,
300 OPEN_EXISTING, 0, NULL);
302 if (hPipe != INVALID_HANDLE_VALUE)
305 err = GetLastError();
306 if (err != ERROR_PIPE_BUSY) {
307 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
308 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
309 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s (error %lu)\n",
310 pipe_name, utf_16to8(err_str), err);
315 if (!WaitNamedPipe(utf_8to16(pipe_name), 30 * 1000)) {
316 err = GetLastError();
317 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
318 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
319 fprintf(stderr, "rawshark: \"%s\" could not be waited for: %s (error %lu)\n",
320 pipe_name, utf_16to8(err_str), err);
326 rfd = _open_osfhandle((intptr_t) hPipe, _O_RDONLY);
328 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
329 pipe_name, g_strerror(errno));
339 * Parse a link-type argument of the form "encap:<pcap linktype>" or
340 * "proto:<proto name>". "Pcap linktype" must be a name conforming to
341 * pcap_datalink_name_to_val() or an integer; the integer should be
342 * a LINKTYPE_ value supported by Wiretap. "Proto name" must be
343 * a protocol name, e.g. "http".
346 set_link_type(const char *lt_arg) {
347 char *spec_ptr = strchr(lt_arg, ':');
351 dissector_handle_t dhandle;
359 if (strncmp(lt_arg, "encap:", strlen("encap:")) == 0) {
360 dlt_val = linktype_name_to_val(spec_ptr);
363 val = strtol(spec_ptr, &p, 10);
364 if (p == spec_ptr || *p != '\0' || errno != 0 || val > INT_MAX) {
370 * In those cases where a given link-layer header type
371 * has different LINKTYPE_ and DLT_ values, linktype_name_to_val()
372 * will return the OS's DLT_ value for that link-layer header
373 * type, not its OS-independent LINKTYPE_ value.
375 * On a given OS, wtap_pcap_encap_to_wtap_encap() should
376 * be able to map either LINKTYPE_ values or DLT_ values
377 * for the OS to the appropriate Wiretap encapsulation.
379 encap = wtap_pcap_encap_to_wtap_encap(dlt_val);
380 if (encap == WTAP_ENCAP_UNKNOWN) {
384 } else if (strncmp(lt_arg, "proto:", strlen("proto:")) == 0) {
385 dhandle = find_dissector(spec_ptr);
387 encap = WTAP_ENCAP_USER0;
388 pref_str = g_string_new("uat:user_dlts:");
389 /* This must match the format used in the user_dlts file */
390 g_string_append_printf(pref_str,
391 "\"User 0 (DLT=147)\",\"%s\",\"0\",\"\",\"0\",\"\"",
393 if (prefs_set_pref(pref_str->str) != PREFS_SET_OK) {
394 g_string_free(pref_str, TRUE);
397 g_string_free(pref_str, TRUE);
405 main(int argc, char *argv[])
407 GString *comp_info_str;
408 GString *runtime_info_str;
409 char *init_progfile_dir_error;
411 gboolean arg_error = FALSE;
417 char *gpf_path, *pf_path;
418 char *gdp_path, *dp_path;
419 int gpf_open_errno, gpf_read_errno;
420 int pf_open_errno, pf_read_errno;
421 int gdp_open_errno, gdp_read_errno;
422 int dp_open_errno, dp_read_errno;
423 gchar *pipe_name = NULL;
428 GPtrArray *disp_fields = g_ptr_array_new();
430 gboolean skip_pcap_header = FALSE;
431 static const struct option long_options[] = {
432 {"help", no_argument, NULL, 'h'},
433 {"version", no_argument, NULL, 'v'},
437 #define OPTSTRING_INIT "d:F:hlnN:o:pr:R:sS:t:v"
439 static const char optstring[] = OPTSTRING_INIT;
441 /* Set the C-language locale to the native environment. */
442 setlocale(LC_ALL, "");
444 cmdarg_err_init(rawshark_cmdarg_err, rawshark_cmdarg_err_cont);
446 /* Get the compile-time version information string */
447 comp_info_str = get_compiled_version_info(NULL, epan_get_compiled_version_info);
449 /* Get the run-time version information string */
450 runtime_info_str = get_runtime_version_info(NULL);
452 /* Add it to the information to be reported on a crash. */
453 ws_add_crash_info("Rawshark (Wireshark) %s\n"
458 get_ws_vcs_version_info(), comp_info_str->str, runtime_info_str->str);
461 arg_list_utf_16to8(argc, argv);
462 create_app_running_mutex();
466 * Get credential information for later use.
468 init_process_policies();
471 * Clear the filters arrays
473 memset(rfilters, 0, sizeof(rfilters));
474 memset(rfcodes, 0, sizeof(rfcodes));
479 * Initialize our string format
481 string_fmts = g_ptr_array_new();
484 * Attempt to get the pathname of the executable file.
486 init_progfile_dir_error = init_progfile_dir(argv[0], main);
487 if (init_progfile_dir_error != NULL) {
488 fprintf(stderr, "rawshark: Can't get pathname of rawshark program: %s.\n",
489 init_progfile_dir_error);
492 /* nothing more than the standard GLib handler, but without a warning */
494 G_LOG_LEVEL_WARNING |
495 G_LOG_LEVEL_MESSAGE |
499 g_log_set_handler(NULL,
500 (GLogLevelFlags)log_flags,
501 log_func_ignore, NULL /* user_data */);
502 g_log_set_handler(LOG_DOMAIN_CAPTURE_CHILD,
503 (GLogLevelFlags)log_flags,
504 log_func_ignore, NULL /* user_data */);
506 init_report_err(failure_message, open_failure_message, read_failure_message,
507 write_failure_message);
509 timestamp_set_type(TS_RELATIVE);
510 timestamp_set_precision(TS_PREC_AUTO);
511 timestamp_set_seconds_type(TS_SECONDS_DEFAULT);
513 /* Register all dissectors; we must do this before checking for the
514 "-G" flag, as the "-G" flag dumps information registered by the
515 dissectors, and we must do it before we read the preferences, in
516 case any dissectors register preferences. */
517 if (!epan_init(register_all_protocols, register_all_protocol_handoffs,
521 prefs_p = read_prefs(&gpf_open_errno, &gpf_read_errno, &gpf_path,
522 &pf_open_errno, &pf_read_errno, &pf_path);
523 if (gpf_path != NULL) {
524 if (gpf_open_errno != 0) {
525 cmdarg_err("Can't open global preferences file \"%s\": %s.",
526 pf_path, g_strerror(gpf_open_errno));
528 if (gpf_read_errno != 0) {
529 cmdarg_err("I/O error reading global preferences file \"%s\": %s.",
530 pf_path, g_strerror(gpf_read_errno));
533 if (pf_path != NULL) {
534 if (pf_open_errno != 0) {
535 cmdarg_err("Can't open your preferences file \"%s\": %s.", pf_path,
536 g_strerror(pf_open_errno));
538 if (pf_read_errno != 0) {
539 cmdarg_err("I/O error reading your preferences file \"%s\": %s.",
540 pf_path, g_strerror(pf_read_errno));
546 /* Read the disabled protocols file. */
547 read_disabled_protos_list(&gdp_path, &gdp_open_errno, &gdp_read_errno,
548 &dp_path, &dp_open_errno, &dp_read_errno);
549 read_disabled_heur_dissector_list(&gdp_path, &gdp_open_errno, &gdp_read_errno,
550 &dp_path, &dp_open_errno, &dp_read_errno);
551 if (gdp_path != NULL) {
552 if (gdp_open_errno != 0) {
553 cmdarg_err("Could not open global disabled protocols file\n\"%s\": %s.",
554 gdp_path, g_strerror(gdp_open_errno));
556 if (gdp_read_errno != 0) {
557 cmdarg_err("I/O error reading global disabled protocols file\n\"%s\": %s.",
558 gdp_path, g_strerror(gdp_read_errno));
562 if (dp_path != NULL) {
563 if (dp_open_errno != 0) {
565 "Could not open your disabled protocols file\n\"%s\": %s.", dp_path,
566 g_strerror(dp_open_errno));
568 if (dp_read_errno != 0) {
570 "I/O error reading your disabled protocols file\n\"%s\": %s.", dp_path,
571 g_strerror(dp_read_errno));
577 ws_init_dll_search_path();
578 /* Load Wpcap, if possible */
582 cap_file_init(&cfile);
584 /* Print format defaults to this. */
585 print_format = PR_FMT_TEXT;
587 /* Initialize our encapsulation type */
588 encap = WTAP_ENCAP_UNKNOWN;
590 /* Now get our args */
591 /* XXX - We should probably have an option to dump libpcap link types */
592 while ((opt = getopt_long(argc, argv, optstring, long_options, NULL)) != -1) {
594 case 'd': /* Payload type */
595 if (!set_link_type(optarg)) {
596 cmdarg_err("Invalid link type or protocol \"%s\"", optarg);
600 case 'F': /* Read field to display */
601 g_ptr_array_add(disp_fields, g_strdup(optarg));
603 case 'h': /* Print help and exit */
604 printf("Rawshark (Wireshark) %s\n"
605 "Dump and analyze network traffic.\n"
606 "See https://www.wireshark.org for more information.\n",
607 get_ws_vcs_version_info());
611 case 'l': /* "Line-buffer" standard output */
612 /* This isn't line-buffering, strictly speaking, it's just
613 flushing the standard output after the information for
614 each packet is printed; however, that should be good
615 enough for all the purposes to which "-l" is put (and
616 is probably actually better for "-V", as it does fewer
619 See the comment in "process_packet()" for an explanation of
620 why we do that, and why we don't just use "setvbuf()" to
621 make the standard output line-buffered (short version: in
622 Windows, "line-buffered" is the same as "fully-buffered",
623 and the output buffer is only flushed when it fills up). */
624 line_buffered = TRUE;
626 case 'n': /* No name resolution */
627 disable_name_resolution();
629 case 'N': /* Select what types of addresses/port #s to resolve */
630 badopt = string_to_name_resolve(optarg, &gbl_resolv_flags);
631 if (badopt != '\0') {
632 cmdarg_err("-N specifies unknown resolving option '%c'; valid options are 'd', m', 'n', 'N', and 't'",
637 case 'o': /* Override preference from command line */
638 switch (prefs_set_pref(optarg)) {
643 case PREFS_SET_SYNTAX_ERR:
644 cmdarg_err("Invalid -o flag \"%s\"", optarg);
648 case PREFS_SET_NO_SUCH_PREF:
649 case PREFS_SET_OBSOLETE:
650 cmdarg_err("-o flag \"%s\" specifies unknown preference", optarg);
655 case 'p': /* Expect pcap_pkthdr packet headers, which may have 64-bit timestamps */
656 want_pcap_pkthdr = TRUE;
658 case 'r': /* Read capture file xxx */
659 pipe_name = g_strdup(optarg);
661 case 'R': /* Read file filter */
662 if(n_rfilters < (int) sizeof(rfilters) / (int) sizeof(rfilters[0])) {
663 rfilters[n_rfilters++] = optarg;
666 cmdarg_err("Too many display filters");
670 case 's': /* Skip PCAP header */
671 skip_pcap_header = TRUE;
673 case 'S': /* Print string representations */
674 if (!parse_field_string_format(optarg)) {
675 cmdarg_err("Invalid field string format");
679 case 't': /* Time stamp type */
680 if (strcmp(optarg, "r") == 0)
681 timestamp_set_type(TS_RELATIVE);
682 else if (strcmp(optarg, "a") == 0)
683 timestamp_set_type(TS_ABSOLUTE);
684 else if (strcmp(optarg, "ad") == 0)
685 timestamp_set_type(TS_ABSOLUTE_WITH_YMD);
686 else if (strcmp(optarg, "adoy") == 0)
687 timestamp_set_type(TS_ABSOLUTE_WITH_YDOY);
688 else if (strcmp(optarg, "d") == 0)
689 timestamp_set_type(TS_DELTA);
690 else if (strcmp(optarg, "dd") == 0)
691 timestamp_set_type(TS_DELTA_DIS);
692 else if (strcmp(optarg, "e") == 0)
693 timestamp_set_type(TS_EPOCH);
694 else if (strcmp(optarg, "u") == 0)
695 timestamp_set_type(TS_UTC);
696 else if (strcmp(optarg, "ud") == 0)
697 timestamp_set_type(TS_UTC_WITH_YMD);
698 else if (strcmp(optarg, "udoy") == 0)
699 timestamp_set_type(TS_UTC_WITH_YDOY);
701 cmdarg_err("Invalid time stamp type \"%s\"",
704 "It must be \"a\" for absolute, \"ad\" for absolute with YYYY-MM-DD date,");
706 "\"adoy\" for absolute with YYYY/DOY date, \"d\" for delta,");
708 "\"dd\" for delta displayed, \"e\" for epoch, \"r\" for relative,");
710 "\"u\" for absolute UTC, \"ud\" for absolute UTC with YYYY-MM-DD date,");
712 "or \"udoy\" for absolute UTC with YYYY/DOY date.");
716 case 'v': /* Show version and exit */
718 show_version("Rawshark (Wireshark)", comp_info_str, runtime_info_str);
719 g_string_free(comp_info_str, TRUE);
720 g_string_free(runtime_info_str, TRUE);
725 case '?': /* Bad flag - print usage message */
732 /* Notify all registered modules that have had any of their preferences
733 changed either from one of the preferences file or from the command
734 line that their preferences have changed.
735 Initialize preferences before display filters, otherwise modules
736 like MATE won't work. */
739 /* Initialize our display fields */
740 for (fc = 0; fc < disp_fields->len; fc++) {
741 protocolinfo_init((char *)g_ptr_array_index(disp_fields, fc));
743 g_ptr_array_free(disp_fields, TRUE);
747 /* If no capture filter or read filter has been specified, and there are
748 still command-line arguments, treat them as the tokens of a capture
749 filter (if no "-r" flag was specified) or a read filter (if a "-r"
750 flag was specified. */
752 if (pipe_name != NULL) {
753 if (n_rfilters != 0) {
754 cmdarg_err("Read filters were specified both with \"-R\" "
755 "and with additional command-line arguments");
758 rfilters[n_rfilters] = get_args_as_string(argc, argv, optind);
762 /* Make sure we got a dissector handle for our payload. */
763 if (encap == WTAP_ENCAP_UNKNOWN) {
764 cmdarg_err("No valid payload dissector specified.");
775 /* Start windows sockets */
776 WSAStartup( MAKEWORD( 1, 1 ), &wsaData );
779 /* At this point MATE will have registered its field array so we can
780 have a tap filter with one of MATE's late-registered fields as part
781 of the filter. We can now process all the "-z" arguments. */
782 start_requested_stats();
784 /* disabled protocols as per configuration file */
785 if (gdp_path == NULL && dp_path == NULL) {
786 set_disabled_protos_list();
787 set_disabled_heur_dissector_list();
790 /* Build the column format array */
791 build_column_format_array(&cfile.cinfo, prefs_p->num_cols, TRUE);
793 if (n_rfilters != 0) {
794 for (i = 0; i < n_rfilters; i++) {
797 if (!dfilter_compile(rfilters[i], &rfcodes[n_rfcodes], &err_msg)) {
798 cmdarg_err("%s", err_msg);
800 epan_free(cfile.epan);
810 * We're reading a pipe (or capture file).
814 * Immediately relinquish any special privileges we have; we must not
815 * be allowed to read any capture files the user running Rawshark
818 relinquish_special_privs_perm();
820 if (raw_cf_open(&cfile, pipe_name) != CF_OK) {
821 epan_free(cfile.epan);
826 /* Do we need to PCAP header and magic? */
827 if (skip_pcap_header) {
828 size_t bytes_left = sizeof(struct pcap_hdr) + sizeof(guint32);
829 gchar buf[sizeof(struct pcap_hdr) + sizeof(guint32)];
830 while (bytes_left != 0) {
831 ssize_t bytes = ws_read(fd, buf, (int)bytes_left);
833 cmdarg_err("Not enough bytes for pcap header.");
840 /* Process the packets in the file */
841 if (!load_cap_file(&cfile)) {
842 epan_free(cfile.epan);
847 /* If you want to capture live packets, use TShark. */
848 cmdarg_err("Input file or pipe name not specified.");
852 epan_free(cfile.epan);
859 * Read data from a raw pipe. The "raw" data consists of a libpcap
860 * packet header followed by the payload.
861 * @param pd [IN] A POSIX file descriptor. Because that's _exactly_ the sort
862 * of thing you want to use in Windows.
863 * @param phdr [OUT] Packet header information.
864 * @param err [OUT] Error indicator. Uses wiretap values.
865 * @param err_info [OUT] Error message.
866 * @param data_offset [OUT] data offset in the pipe.
867 * @return TRUE on success, FALSE on failure.
870 raw_pipe_read(struct wtap_pkthdr *phdr, guchar * pd, int *err, gchar **err_info, gint64 *data_offset) {
871 struct pcap_pkthdr mem_hdr;
872 struct pcaprec_hdr disk_hdr;
873 ssize_t bytes_read = 0;
874 size_t bytes_needed = sizeof(disk_hdr);
875 guchar *ptr = (guchar*) &disk_hdr;
877 if (want_pcap_pkthdr) {
878 bytes_needed = sizeof(mem_hdr);
879 ptr = (guchar*) &mem_hdr;
882 /* Copied from capture_loop.c */
883 while (bytes_needed > 0) {
884 bytes_read = ws_read(fd, ptr, (int)bytes_needed);
885 if (bytes_read == 0) {
889 } else if (bytes_read < 0) {
894 bytes_needed -= bytes_read;
895 *data_offset += bytes_read;
899 if (want_pcap_pkthdr) {
900 phdr->ts.secs = mem_hdr.ts.tv_sec;
901 phdr->ts.nsecs = (gint32)mem_hdr.ts.tv_usec * 1000;
902 phdr->caplen = mem_hdr.caplen;
903 phdr->len = mem_hdr.len;
905 phdr->ts.secs = disk_hdr.ts_sec;
906 phdr->ts.nsecs = disk_hdr.ts_usec * 1000;
907 phdr->caplen = disk_hdr.incl_len;
908 phdr->len = disk_hdr.orig_len;
910 bytes_needed = phdr->caplen;
912 phdr->pkt_encap = encap;
915 printf("mem_hdr: %lu disk_hdr: %lu\n", sizeof(mem_hdr), sizeof(disk_hdr));
916 printf("tv_sec: %u (%04x)\n", (unsigned int) phdr->ts.secs, (unsigned int) phdr->ts.secs);
917 printf("tv_nsec: %d (%04x)\n", phdr->ts.nsecs, phdr->ts.nsecs);
918 printf("caplen: %d (%04x)\n", phdr->caplen, phdr->caplen);
919 printf("len: %d (%04x)\n", phdr->len, phdr->len);
921 if (bytes_needed > WTAP_MAX_PACKET_SIZE) {
922 *err = WTAP_ERR_BAD_FILE;
923 *err_info = g_strdup_printf("Bad packet length: %lu\n",
924 (unsigned long) bytes_needed);
929 while (bytes_needed > 0) {
930 bytes_read = ws_read(fd, ptr, (int)bytes_needed);
931 if (bytes_read == 0) {
932 *err = WTAP_ERR_SHORT_READ;
935 } else if (bytes_read < 0) {
940 bytes_needed -= bytes_read;
941 *data_offset += bytes_read;
948 load_cap_file(capture_file *cf)
952 gint64 data_offset = 0;
954 guchar pd[WTAP_MAX_PACKET_SIZE];
955 struct wtap_pkthdr phdr;
958 wtap_phdr_init(&phdr);
960 epan_dissect_init(&edt, cf->epan, TRUE, FALSE);
962 while (raw_pipe_read(&phdr, pd, &err, &err_info, &data_offset)) {
963 process_packet(cf, &edt, data_offset, &phdr, pd);
966 epan_dissect_cleanup(&edt);
968 wtap_phdr_cleanup(&phdr);
971 /* Print a message noting that the read failed somewhere along the line. */
974 case WTAP_ERR_UNSUPPORTED:
975 cmdarg_err("The file \"%s\" contains record data that Rawshark doesn't support.\n(%s)",
977 err_info != NULL ? err_info : "no information supplied");
981 case WTAP_ERR_SHORT_READ:
982 cmdarg_err("The file \"%s\" appears to have been cut short in the middle of a packet.",
986 case WTAP_ERR_BAD_FILE:
987 cmdarg_err("The file \"%s\" appears to be damaged or corrupt.\n(%s)",
989 err_info != NULL ? err_info : "no information supplied");
993 case WTAP_ERR_DECOMPRESS:
994 cmdarg_err("The compressed file \"%s\" appears to be damaged or corrupt.\n(%s)",
996 err_info != NULL ? err_info : "no information supplied");
1001 cmdarg_err("An error occurred while reading the file \"%s\": %s.",
1002 cf->filename, wtap_strerror(err));
1012 process_packet(capture_file *cf, epan_dissect_t *edt, gint64 offset,
1013 struct wtap_pkthdr *whdr, const guchar *pd)
1021 /* The user sends an empty packet when he wants to get output from us even if we don't currently have
1022 packets to process. We spit out a line with the timestamp and the text "void"
1024 printf("%lu %lu %lu void -\n", (unsigned long int)cf->count,
1025 (unsigned long int)whdr->ts.secs,
1026 (unsigned long int)whdr->ts.nsecs);
1033 /* Count this packet. */
1036 /* If we're going to print packet information, or we're going to
1037 run a read filter, or we're going to process taps, set up to
1038 do a dissection and do so. */
1039 frame_data_init(&fdata, cf->count, whdr, offset, cum_bytes);
1043 /* If we're running a read filter, prime the epan_dissect_t with that
1045 if (n_rfilters > 0) {
1046 for(i = 0; i < n_rfcodes; i++) {
1047 epan_dissect_prime_dfilter(edt, rfcodes[i]);
1051 printf("%lu", (unsigned long int) cf->count);
1053 frame_data_set_before_dissect(&fdata, &cf->elapsed_time,
1056 if (ref == &fdata) {
1061 /* We only need the columns if we're printing packet info but we're
1062 *not* verbose; in verbose mode, we print the protocol tree, not
1063 the protocol summary. */
1064 epan_dissect_run_with_taps(edt, cf->cd_t, whdr, frame_tvbuff_new(&fdata, pd), &fdata, &cf->cinfo);
1066 frame_data_set_after_dissect(&fdata, &cum_bytes);
1067 prev_dis_frame = fdata;
1068 prev_dis = &prev_dis_frame;
1070 prev_cap_frame = fdata;
1071 prev_cap = &prev_cap_frame;
1073 for(i = 0; i < n_rfilters; i++) {
1074 /* Run the read filter if we have one. */
1076 passed = dfilter_apply_edt(rfcodes[i], edt);
1080 /* Print a one-line summary */
1081 printf(" %u", passed ? 1 : 0);
1086 /* The ANSI C standard does not appear to *require* that a line-buffered
1087 stream be flushed to the host environment whenever a newline is
1088 written, it just says that, on such a stream, characters "are
1089 intended to be transmitted to or from the host environment as a
1090 block when a new-line character is encountered".
1092 The Visual C++ 6.0 C implementation doesn't do what is intended;
1093 even if you set a stream to be line-buffered, it still doesn't
1094 flush the buffer at the end of every line.
1096 So, if the "-l" flag was specified, we flush the standard output
1097 at the end of a packet. This will do the right thing if we're
1098 printing packet summary lines, and, as we print the entire protocol
1099 tree for a single packet without waiting for anything to happen,
1100 it should be as good as line-buffered mode if we're printing
1101 protocol trees. (The whole reason for the "-l" flag in either
1102 tcpdump or Rawshark is to allow the output of a live capture to
1103 be piped to a program or script and to have that script see the
1104 information for the packet as soon as it's printed, rather than
1105 having to wait until a standard I/O buffer fills up. */
1109 if (ferror(stdout)) {
1110 show_print_file_io_error(errno);
1114 epan_dissect_reset(edt);
1115 frame_data_destroy(&fdata);
1120 /****************************************************************************************
1121 * FIELD EXTRACTION ROUTINES
1122 ****************************************************************************************/
1123 typedef struct _pci_t {
1129 static const char* ftenum_to_string(header_field_info *hfi)
1136 if (string_fmts->len > 0 && hfi->strings) {
1140 str = ftype_name(hfi->type);
1148 static void field_display_to_string(header_field_info *hfi, char* buf, int size)
1150 if (hfi->type != FT_BOOLEAN)
1152 g_strlcpy(buf, proto_field_display_to_string(hfi->display), size);
1156 g_snprintf(buf, size, "(Bit count: %d)", hfi->display);
1161 * Copied from various parts of proto.c
1163 #define FIELD_STR_INIT_LEN 256
1164 #define cVALS(x) (const value_string*)(x)
1165 static gboolean print_field_value(field_info *finfo, int cmd_line_index)
1167 header_field_info *hfinfo;
1168 char *fs_buf = NULL;
1169 char *fs_ptr = NULL;
1170 static GString *label_s = NULL;
1178 const true_false_string *tfstring = &tfs_true_false;
1180 hfinfo = finfo->hfinfo;
1183 label_s = g_string_new("");
1186 if(finfo->value.ftype->val_to_string_repr)
1189 * this field has an associated value,
1192 fs_len = fvalue_string_repr_len(&finfo->value, FTREPR_DFILTER, finfo->hfinfo->display);
1193 fs_buf = fvalue_to_string_repr(NULL, &finfo->value,
1194 FTREPR_DFILTER, finfo->hfinfo->display);
1197 /* String types are quoted. Remove them. */
1198 if (IS_FT_STRING(finfo->value.ftype->ftype) && fs_len > 2) {
1199 fs_buf[fs_len - 1] = '\0';
1204 if (string_fmts->len > 0 && finfo->hfinfo->strings) {
1205 g_string_truncate(label_s, 0);
1206 for (i = 0; i < string_fmts->len; i++) {
1207 sf = (string_fmt_t *)g_ptr_array_index(string_fmts, i);
1209 g_string_append(label_s, sf->plain);
1211 switch (sf->format) {
1213 g_string_append(label_s, hfinfo->name);
1216 g_string_append(label_s, fs_ptr);
1219 switch(hfinfo->type) {
1221 uvalue64 = fvalue_get_uinteger64(&finfo->value);
1222 tfstring = (const struct true_false_string*) hfinfo->strings;
1223 g_string_append(label_s, uvalue64 ? tfstring->true_string : tfstring->false_string);
1229 DISSECTOR_ASSERT(!hfinfo->bitmask);
1230 svalue = fvalue_get_sinteger(&finfo->value);
1231 if (hfinfo->display & BASE_RANGE_STRING) {
1232 g_string_append(label_s, rval_to_str_const(svalue, RVALS(hfinfo->strings), "Unknown"));
1233 } else if (hfinfo->display & BASE_EXT_STRING) {
1234 g_string_append(label_s, val_to_str_ext_const(svalue, (value_string_ext *) hfinfo->strings, "Unknown"));
1236 g_string_append(label_s, val_to_str_const(svalue, cVALS(hfinfo->strings), "Unknown"));
1239 case FT_INT40: /* XXX: Shouldn't these be as smart as FT_INT{8,16,24,32}? */
1243 DISSECTOR_ASSERT(!hfinfo->bitmask);
1244 svalue64 = (gint64)fvalue_get_sinteger64(&finfo->value);
1245 if (hfinfo->display & BASE_VAL64_STRING) {
1246 g_string_append(label_s, val64_to_str_const(svalue64, (const val64_string *)(hfinfo->strings), "Unknown"));
1253 DISSECTOR_ASSERT(!hfinfo->bitmask);
1254 uvalue = fvalue_get_uinteger(&finfo->value);
1255 if (!hfinfo->bitmask && hfinfo->display & BASE_RANGE_STRING) {
1256 g_string_append(label_s, rval_to_str_const(uvalue, RVALS(hfinfo->strings), "Unknown"));
1257 } else if (hfinfo->display & BASE_EXT_STRING) {
1258 g_string_append(label_s, val_to_str_ext_const(uvalue, (value_string_ext *) hfinfo->strings, "Unknown"));
1260 g_string_append(label_s, val_to_str_const(uvalue, cVALS(hfinfo->strings), "Unknown"));
1263 case FT_UINT40: /* XXX: Shouldn't these be as smart as FT_INT{8,16,24,32}? */
1267 DISSECTOR_ASSERT(!hfinfo->bitmask);
1268 uvalue64 = fvalue_get_uinteger64(&finfo->value);
1269 if (hfinfo->display & BASE_VAL64_STRING) {
1270 g_string_append(label_s, val64_to_str_const(uvalue64, (const val64_string *)(hfinfo->strings), "Unknown"));
1282 printf(" %d=\"%s\"", cmd_line_index, label_s->str);
1283 wmem_free(NULL, fs_buf);
1287 if(finfo->value.ftype->val_to_string_repr)
1289 printf(" %d=\"%s\"", cmd_line_index, fs_ptr);
1290 wmem_free(NULL, fs_buf);
1295 * This field doesn't have an associated value,
1299 printf(" %d=\"n.a.\"", cmd_line_index);
1304 protocolinfo_packet(void *prs, packet_info *pinfo _U_, epan_dissect_t *edt, const void *dummy _U_)
1306 pci_t *rs=(pci_t *)prs;
1310 gp=proto_get_finfo_ptr_array(edt->tree, rs->hf_index);
1317 * Print each occurrence of the field
1319 for (i = 0; i < gp->len; i++) {
1320 print_field_value((field_info *)gp->pdata[i], rs->cmd_line_index);
1326 int g_cmd_line_index = 0;
1329 * field must be persistent - we don't g_strdup() it below
1332 protocolinfo_init(char *field)
1335 header_field_info *hfi;
1336 GString *error_string;
1339 hfi=proto_registrar_get_byname(field);
1341 fprintf(stderr, "rawshark: Field \"%s\" doesn't exist.\n", field);
1345 field_display_to_string(hfi, hfibuf, sizeof(hfibuf));
1346 printf("%d %s %s - ",
1348 ftenum_to_string(hfi),
1351 rs=(pci_t *)g_malloc(sizeof(pci_t));
1352 rs->hf_index=hfi->id;
1354 rs->cmd_line_index = g_cmd_line_index++;
1356 error_string=register_tap_listener("frame", rs, rs->filter, TL_REQUIRES_PROTO_TREE, NULL, protocolinfo_packet, NULL);
1358 /* error, we failed to attach to the tap. complain and clean up */
1359 fprintf(stderr, "rawshark: Couldn't register field extraction tap: %s\n",
1361 g_string_free(error_string, TRUE);
1372 * Given a format string, split it into a GPtrArray of string_fmt_t structs
1373 * and fill in string_fmt_parts.
1377 add_string_fmt(string_fmt_e format, gchar *plain) {
1378 string_fmt_t *sf = (string_fmt_t *)g_malloc(sizeof(string_fmt_t));
1380 sf->format = format;
1381 sf->plain = g_strdup(plain);
1383 g_ptr_array_add(string_fmts, sf);
1387 parse_field_string_format(gchar *format) {
1388 GString *plain_s = g_string_new("");
1396 len = strlen(format);
1397 g_ptr_array_set_size(string_fmts, 0);
1400 if (format[pos] == '%') {
1401 if (pos >= len) { /* There should always be a following character */
1405 if (plain_s->len > 0) {
1406 add_string_fmt(SF_NONE, plain_s->str);
1407 g_string_truncate(plain_s, 0);
1409 switch (format[pos]) {
1411 add_string_fmt(SF_NAME, NULL);
1414 add_string_fmt(SF_NUMVAL, NULL);
1417 add_string_fmt(SF_STRVAL, NULL);
1420 g_string_append_c(plain_s, '%');
1422 default: /* Invalid format */
1426 g_string_append_c(plain_s, format[pos]);
1431 if (plain_s->len > 0) {
1432 add_string_fmt(SF_NONE, plain_s->str);
1434 g_string_free(plain_s, TRUE);
1438 /****************************************************************************************
1439 * END OF FIELD EXTRACTION ROUTINES
1440 ****************************************************************************************/
1443 show_print_file_io_error(int err)
1448 cmdarg_err("Not all the packets could be printed because there is "
1449 "no space left on the file system.");
1454 cmdarg_err("Not all the packets could be printed because you are "
1455 "too close to, or over your disk quota.");
1460 cmdarg_err("An error occurred while printing packets: %s.",
1467 * Open/create errors are reported with an console message in Rawshark.
1470 open_failure_message(const char *filename, int err, gboolean for_writing)
1472 fprintf(stderr, "rawshark: ");
1473 fprintf(stderr, file_open_error_message(err, for_writing), filename);
1474 fprintf(stderr, "\n");
1477 static const nstime_t *
1478 raw_get_frame_ts(void *data _U_, guint32 frame_num)
1480 if (ref && ref->num == frame_num)
1481 return &ref->abs_ts;
1483 if (prev_dis && prev_dis->num == frame_num)
1484 return &prev_dis->abs_ts;
1486 if (prev_cap && prev_cap->num == frame_num)
1487 return &prev_cap->abs_ts;
1493 raw_epan_new(capture_file *cf)
1495 epan_t *epan = epan_new();
1498 epan->get_frame_ts = raw_get_frame_ts;
1499 epan->get_interface_name = cap_file_get_interface_name;
1500 epan->get_user_comment = NULL;
1506 raw_cf_open(capture_file *cf, const char *fname)
1508 if ((fd = raw_pipe_open(fname)) < 0)
1511 /* The open succeeded. Fill in the information for this file. */
1513 /* Create new epan session for dissection. */
1514 epan_free(cf->epan);
1515 cf->epan = raw_epan_new(cf);
1518 cf->f_datalen = 0; /* not used, but set it anyway */
1520 /* Set the file name because we need it to set the follow stream filter.
1521 XXX - is that still true? We need it for other reasons, though,
1523 cf->filename = g_strdup(fname);
1525 /* Indicate whether it's a permanent or temporary file. */
1526 cf->is_tempfile = FALSE;
1528 /* No user changes yet. */
1529 cf->unsaved_changes = FALSE;
1531 cf->cd_t = WTAP_FILE_TYPE_SUBTYPE_UNKNOWN;
1532 cf->open_type = WTAP_TYPE_AUTO;
1534 cf->drops_known = FALSE;
1536 cf->has_snap = FALSE;
1537 cf->snap = WTAP_MAX_PACKET_SIZE;
1538 nstime_set_zero(&cf->elapsed_time);
1548 * General errors are reported with an console message in Rawshark.
1551 failure_message(const char *msg_format, va_list ap)
1553 fprintf(stderr, "rawshark: ");
1554 vfprintf(stderr, msg_format, ap);
1555 fprintf(stderr, "\n");
1559 * Read errors are reported with an console message in Rawshark.
1562 read_failure_message(const char *filename, int err)
1564 cmdarg_err("An error occurred while reading from the file \"%s\": %s.",
1565 filename, g_strerror(err));
1569 * Write errors are reported with an console message in Rawshark.
1572 write_failure_message(const char *filename, int err)
1574 cmdarg_err("An error occurred while writing to the file \"%s\": %s.",
1575 filename, g_strerror(err));
1579 * Report an error in command-line arguments.
1582 rawshark_cmdarg_err(const char *fmt, va_list ap)
1584 fprintf(stderr, "rawshark: ");
1585 vfprintf(stderr, fmt, ap);
1586 fprintf(stderr, "\n");
1590 * Report additional information for an error in command-line arguments.
1593 rawshark_cmdarg_err_cont(const char *fmt, va_list ap)
1595 vfprintf(stderr, fmt, ap);
1596 fprintf(stderr, "\n");
1605 * indent-tabs-mode: nil
1608 * ex: set shiftwidth=4 tabstop=8 expandtab:
1609 * :indentSize=4:tabSize=8:noTabs=true: