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 /* Load Wpcap, if possible */
581 cap_file_init(&cfile);
583 /* Print format defaults to this. */
584 print_format = PR_FMT_TEXT;
586 /* Initialize our encapsulation type */
587 encap = WTAP_ENCAP_UNKNOWN;
589 /* Now get our args */
590 /* XXX - We should probably have an option to dump libpcap link types */
591 while ((opt = getopt_long(argc, argv, optstring, long_options, NULL)) != -1) {
593 case 'd': /* Payload type */
594 if (!set_link_type(optarg)) {
595 cmdarg_err("Invalid link type or protocol \"%s\"", optarg);
599 case 'F': /* Read field to display */
600 g_ptr_array_add(disp_fields, g_strdup(optarg));
602 case 'h': /* Print help and exit */
603 printf("Rawshark (Wireshark) %s\n"
604 "Dump and analyze network traffic.\n"
605 "See https://www.wireshark.org for more information.\n",
606 get_ws_vcs_version_info());
610 case 'l': /* "Line-buffer" standard output */
611 /* This isn't line-buffering, strictly speaking, it's just
612 flushing the standard output after the information for
613 each packet is printed; however, that should be good
614 enough for all the purposes to which "-l" is put (and
615 is probably actually better for "-V", as it does fewer
618 See the comment in "process_packet()" for an explanation of
619 why we do that, and why we don't just use "setvbuf()" to
620 make the standard output line-buffered (short version: in
621 Windows, "line-buffered" is the same as "fully-buffered",
622 and the output buffer is only flushed when it fills up). */
623 line_buffered = TRUE;
625 case 'n': /* No name resolution */
626 disable_name_resolution();
628 case 'N': /* Select what types of addresses/port #s to resolve */
629 badopt = string_to_name_resolve(optarg, &gbl_resolv_flags);
630 if (badopt != '\0') {
631 cmdarg_err("-N specifies unknown resolving option '%c'; valid options are 'd', m', 'n', 'N', and 't'",
636 case 'o': /* Override preference from command line */
637 switch (prefs_set_pref(optarg)) {
642 case PREFS_SET_SYNTAX_ERR:
643 cmdarg_err("Invalid -o flag \"%s\"", optarg);
647 case PREFS_SET_NO_SUCH_PREF:
648 case PREFS_SET_OBSOLETE:
649 cmdarg_err("-o flag \"%s\" specifies unknown preference", optarg);
654 case 'p': /* Expect pcap_pkthdr packet headers, which may have 64-bit timestamps */
655 want_pcap_pkthdr = TRUE;
657 case 'r': /* Read capture file xxx */
658 pipe_name = g_strdup(optarg);
660 case 'R': /* Read file filter */
661 if(n_rfilters < (int) sizeof(rfilters) / (int) sizeof(rfilters[0])) {
662 rfilters[n_rfilters++] = optarg;
665 cmdarg_err("Too many display filters");
669 case 's': /* Skip PCAP header */
670 skip_pcap_header = TRUE;
672 case 'S': /* Print string representations */
673 if (!parse_field_string_format(optarg)) {
674 cmdarg_err("Invalid field string format");
678 case 't': /* Time stamp type */
679 if (strcmp(optarg, "r") == 0)
680 timestamp_set_type(TS_RELATIVE);
681 else if (strcmp(optarg, "a") == 0)
682 timestamp_set_type(TS_ABSOLUTE);
683 else if (strcmp(optarg, "ad") == 0)
684 timestamp_set_type(TS_ABSOLUTE_WITH_YMD);
685 else if (strcmp(optarg, "adoy") == 0)
686 timestamp_set_type(TS_ABSOLUTE_WITH_YDOY);
687 else if (strcmp(optarg, "d") == 0)
688 timestamp_set_type(TS_DELTA);
689 else if (strcmp(optarg, "dd") == 0)
690 timestamp_set_type(TS_DELTA_DIS);
691 else if (strcmp(optarg, "e") == 0)
692 timestamp_set_type(TS_EPOCH);
693 else if (strcmp(optarg, "u") == 0)
694 timestamp_set_type(TS_UTC);
695 else if (strcmp(optarg, "ud") == 0)
696 timestamp_set_type(TS_UTC_WITH_YMD);
697 else if (strcmp(optarg, "udoy") == 0)
698 timestamp_set_type(TS_UTC_WITH_YDOY);
700 cmdarg_err("Invalid time stamp type \"%s\"",
703 "It must be \"a\" for absolute, \"ad\" for absolute with YYYY-MM-DD date,");
705 "\"adoy\" for absolute with YYYY/DOY date, \"d\" for delta,");
707 "\"dd\" for delta displayed, \"e\" for epoch, \"r\" for relative,");
709 "\"u\" for absolute UTC, \"ud\" for absolute UTC with YYYY-MM-DD date,");
711 "or \"udoy\" for absolute UTC with YYYY/DOY date.");
715 case 'v': /* Show version and exit */
717 show_version("Rawshark (Wireshark)", comp_info_str, runtime_info_str);
718 g_string_free(comp_info_str, TRUE);
719 g_string_free(runtime_info_str, TRUE);
724 case '?': /* Bad flag - print usage message */
731 /* Notify all registered modules that have had any of their preferences
732 changed either from one of the preferences file or from the command
733 line that their preferences have changed.
734 Initialize preferences before display filters, otherwise modules
735 like MATE won't work. */
738 /* Initialize our display fields */
739 for (fc = 0; fc < disp_fields->len; fc++) {
740 protocolinfo_init((char *)g_ptr_array_index(disp_fields, fc));
742 g_ptr_array_free(disp_fields, TRUE);
746 /* If no capture filter or read filter has been specified, and there are
747 still command-line arguments, treat them as the tokens of a capture
748 filter (if no "-r" flag was specified) or a read filter (if a "-r"
749 flag was specified. */
751 if (pipe_name != NULL) {
752 if (n_rfilters != 0) {
753 cmdarg_err("Read filters were specified both with \"-R\" "
754 "and with additional command-line arguments");
757 rfilters[n_rfilters] = get_args_as_string(argc, argv, optind);
761 /* Make sure we got a dissector handle for our payload. */
762 if (encap == WTAP_ENCAP_UNKNOWN) {
763 cmdarg_err("No valid payload dissector specified.");
774 /* Start windows sockets */
775 WSAStartup( MAKEWORD( 1, 1 ), &wsaData );
778 /* At this point MATE will have registered its field array so we can
779 have a tap filter with one of MATE's late-registered fields as part
780 of the filter. We can now process all the "-z" arguments. */
781 start_requested_stats();
783 /* disabled protocols as per configuration file */
784 if (gdp_path == NULL && dp_path == NULL) {
785 set_disabled_protos_list();
786 set_disabled_heur_dissector_list();
789 /* Build the column format array */
790 build_column_format_array(&cfile.cinfo, prefs_p->num_cols, TRUE);
792 if (n_rfilters != 0) {
793 for (i = 0; i < n_rfilters; i++) {
796 if (!dfilter_compile(rfilters[i], &rfcodes[n_rfcodes], &err_msg)) {
797 cmdarg_err("%s", err_msg);
799 epan_free(cfile.epan);
809 * We're reading a pipe (or capture file).
813 * Immediately relinquish any special privileges we have; we must not
814 * be allowed to read any capture files the user running Rawshark
817 relinquish_special_privs_perm();
819 if (raw_cf_open(&cfile, pipe_name) != CF_OK) {
820 epan_free(cfile.epan);
825 /* Do we need to PCAP header and magic? */
826 if (skip_pcap_header) {
827 size_t bytes_left = sizeof(struct pcap_hdr) + sizeof(guint32);
828 gchar buf[sizeof(struct pcap_hdr) + sizeof(guint32)];
829 while (bytes_left != 0) {
830 ssize_t bytes = ws_read(fd, buf, (int)bytes_left);
832 cmdarg_err("Not enough bytes for pcap header.");
839 /* Process the packets in the file */
840 if (!load_cap_file(&cfile)) {
841 epan_free(cfile.epan);
846 /* If you want to capture live packets, use TShark. */
847 cmdarg_err("Input file or pipe name not specified.");
851 epan_free(cfile.epan);
858 * Read data from a raw pipe. The "raw" data consists of a libpcap
859 * packet header followed by the payload.
860 * @param pd [IN] A POSIX file descriptor. Because that's _exactly_ the sort
861 * of thing you want to use in Windows.
862 * @param phdr [OUT] Packet header information.
863 * @param err [OUT] Error indicator. Uses wiretap values.
864 * @param err_info [OUT] Error message.
865 * @param data_offset [OUT] data offset in the pipe.
866 * @return TRUE on success, FALSE on failure.
869 raw_pipe_read(struct wtap_pkthdr *phdr, guchar * pd, int *err, gchar **err_info, gint64 *data_offset) {
870 struct pcap_pkthdr mem_hdr;
871 struct pcaprec_hdr disk_hdr;
872 ssize_t bytes_read = 0;
873 size_t bytes_needed = sizeof(disk_hdr);
874 guchar *ptr = (guchar*) &disk_hdr;
876 if (want_pcap_pkthdr) {
877 bytes_needed = sizeof(mem_hdr);
878 ptr = (guchar*) &mem_hdr;
881 /* Copied from capture_loop.c */
882 while (bytes_needed > 0) {
883 bytes_read = ws_read(fd, ptr, (int)bytes_needed);
884 if (bytes_read == 0) {
888 } else if (bytes_read < 0) {
893 bytes_needed -= bytes_read;
894 *data_offset += bytes_read;
898 if (want_pcap_pkthdr) {
899 phdr->ts.secs = mem_hdr.ts.tv_sec;
900 phdr->ts.nsecs = (gint32)mem_hdr.ts.tv_usec * 1000;
901 phdr->caplen = mem_hdr.caplen;
902 phdr->len = mem_hdr.len;
904 phdr->ts.secs = disk_hdr.ts_sec;
905 phdr->ts.nsecs = disk_hdr.ts_usec * 1000;
906 phdr->caplen = disk_hdr.incl_len;
907 phdr->len = disk_hdr.orig_len;
909 bytes_needed = phdr->caplen;
911 phdr->pkt_encap = encap;
914 printf("mem_hdr: %lu disk_hdr: %lu\n", sizeof(mem_hdr), sizeof(disk_hdr));
915 printf("tv_sec: %u (%04x)\n", (unsigned int) phdr->ts.secs, (unsigned int) phdr->ts.secs);
916 printf("tv_nsec: %d (%04x)\n", phdr->ts.nsecs, phdr->ts.nsecs);
917 printf("caplen: %d (%04x)\n", phdr->caplen, phdr->caplen);
918 printf("len: %d (%04x)\n", phdr->len, phdr->len);
920 if (bytes_needed > WTAP_MAX_PACKET_SIZE) {
921 *err = WTAP_ERR_BAD_FILE;
922 *err_info = g_strdup_printf("Bad packet length: %lu\n",
923 (unsigned long) bytes_needed);
928 while (bytes_needed > 0) {
929 bytes_read = ws_read(fd, ptr, (int)bytes_needed);
930 if (bytes_read == 0) {
931 *err = WTAP_ERR_SHORT_READ;
934 } else if (bytes_read < 0) {
939 bytes_needed -= bytes_read;
940 *data_offset += bytes_read;
947 load_cap_file(capture_file *cf)
951 gint64 data_offset = 0;
953 guchar pd[WTAP_MAX_PACKET_SIZE];
954 struct wtap_pkthdr phdr;
957 wtap_phdr_init(&phdr);
959 epan_dissect_init(&edt, cf->epan, TRUE, FALSE);
961 while (raw_pipe_read(&phdr, pd, &err, &err_info, &data_offset)) {
962 process_packet(cf, &edt, data_offset, &phdr, pd);
965 epan_dissect_cleanup(&edt);
967 wtap_phdr_cleanup(&phdr);
970 /* Print a message noting that the read failed somewhere along the line. */
973 case WTAP_ERR_UNSUPPORTED:
974 cmdarg_err("The file \"%s\" contains record data that Rawshark doesn't support.\n(%s)",
976 err_info != NULL ? err_info : "no information supplied");
980 case WTAP_ERR_SHORT_READ:
981 cmdarg_err("The file \"%s\" appears to have been cut short in the middle of a packet.",
985 case WTAP_ERR_BAD_FILE:
986 cmdarg_err("The file \"%s\" appears to be damaged or corrupt.\n(%s)",
988 err_info != NULL ? err_info : "no information supplied");
992 case WTAP_ERR_DECOMPRESS:
993 cmdarg_err("The compressed file \"%s\" appears to be damaged or corrupt.\n(%s)",
995 err_info != NULL ? err_info : "no information supplied");
1000 cmdarg_err("An error occurred while reading the file \"%s\": %s.",
1001 cf->filename, wtap_strerror(err));
1011 process_packet(capture_file *cf, epan_dissect_t *edt, gint64 offset,
1012 struct wtap_pkthdr *whdr, const guchar *pd)
1020 /* The user sends an empty packet when he wants to get output from us even if we don't currently have
1021 packets to process. We spit out a line with the timestamp and the text "void"
1023 printf("%lu %lu %lu void -\n", (unsigned long int)cf->count,
1024 (unsigned long int)whdr->ts.secs,
1025 (unsigned long int)whdr->ts.nsecs);
1032 /* Count this packet. */
1035 /* If we're going to print packet information, or we're going to
1036 run a read filter, or we're going to process taps, set up to
1037 do a dissection and do so. */
1038 frame_data_init(&fdata, cf->count, whdr, offset, cum_bytes);
1042 /* If we're running a read filter, prime the epan_dissect_t with that
1044 if (n_rfilters > 0) {
1045 for(i = 0; i < n_rfcodes; i++) {
1046 epan_dissect_prime_dfilter(edt, rfcodes[i]);
1050 printf("%lu", (unsigned long int) cf->count);
1052 frame_data_set_before_dissect(&fdata, &cf->elapsed_time,
1055 if (ref == &fdata) {
1060 /* We only need the columns if we're printing packet info but we're
1061 *not* verbose; in verbose mode, we print the protocol tree, not
1062 the protocol summary. */
1063 epan_dissect_run_with_taps(edt, cf->cd_t, whdr, frame_tvbuff_new(&fdata, pd), &fdata, &cf->cinfo);
1065 frame_data_set_after_dissect(&fdata, &cum_bytes);
1066 prev_dis_frame = fdata;
1067 prev_dis = &prev_dis_frame;
1069 prev_cap_frame = fdata;
1070 prev_cap = &prev_cap_frame;
1072 for(i = 0; i < n_rfilters; i++) {
1073 /* Run the read filter if we have one. */
1075 passed = dfilter_apply_edt(rfcodes[i], edt);
1079 /* Print a one-line summary */
1080 printf(" %u", passed ? 1 : 0);
1085 /* The ANSI C standard does not appear to *require* that a line-buffered
1086 stream be flushed to the host environment whenever a newline is
1087 written, it just says that, on such a stream, characters "are
1088 intended to be transmitted to or from the host environment as a
1089 block when a new-line character is encountered".
1091 The Visual C++ 6.0 C implementation doesn't do what is intended;
1092 even if you set a stream to be line-buffered, it still doesn't
1093 flush the buffer at the end of every line.
1095 So, if the "-l" flag was specified, we flush the standard output
1096 at the end of a packet. This will do the right thing if we're
1097 printing packet summary lines, and, as we print the entire protocol
1098 tree for a single packet without waiting for anything to happen,
1099 it should be as good as line-buffered mode if we're printing
1100 protocol trees. (The whole reason for the "-l" flag in either
1101 tcpdump or Rawshark is to allow the output of a live capture to
1102 be piped to a program or script and to have that script see the
1103 information for the packet as soon as it's printed, rather than
1104 having to wait until a standard I/O buffer fills up. */
1108 if (ferror(stdout)) {
1109 show_print_file_io_error(errno);
1113 epan_dissect_reset(edt);
1114 frame_data_destroy(&fdata);
1119 /****************************************************************************************
1120 * FIELD EXTRACTION ROUTINES
1121 ****************************************************************************************/
1122 typedef struct _pci_t {
1128 static const char* ftenum_to_string(header_field_info *hfi)
1135 if (string_fmts->len > 0 && hfi->strings) {
1139 str = ftype_name(hfi->type);
1147 static void field_display_to_string(header_field_info *hfi, char* buf, int size)
1149 if (hfi->type != FT_BOOLEAN)
1151 g_strlcpy(buf, proto_field_display_to_string(hfi->display), size);
1155 g_snprintf(buf, size, "(Bit count: %d)", hfi->display);
1160 * Copied from various parts of proto.c
1162 #define FIELD_STR_INIT_LEN 256
1163 #define cVALS(x) (const value_string*)(x)
1164 static gboolean print_field_value(field_info *finfo, int cmd_line_index)
1166 header_field_info *hfinfo;
1167 static char *fs_buf = NULL;
1168 char *fs_ptr = fs_buf;
1169 static GString *label_s = NULL;
1170 int fs_buf_len = FIELD_STR_INIT_LEN, fs_len;
1177 const true_false_string *tfstring = &tfs_true_false;
1179 hfinfo = finfo->hfinfo;
1182 fs_buf = (char *)g_malloc(fs_buf_len + 1);
1187 label_s = g_string_new("");
1190 if(finfo->value.ftype->val_to_string_repr)
1193 * this field has an associated value,
1196 fs_len = fvalue_string_repr_len(&finfo->value, FTREPR_DFILTER, finfo->hfinfo->display);
1197 while (fs_buf_len < fs_len) {
1199 fs_buf = (char *)g_realloc(fs_buf, fs_buf_len + 1);
1202 fvalue_to_string_repr(&finfo->value,
1203 FTREPR_DFILTER, finfo->hfinfo->display,
1206 /* String types are quoted. Remove them. */
1207 if (IS_FT_STRING(finfo->value.ftype->ftype) && fs_len > 2) {
1208 fs_buf[fs_len - 1] = '\0';
1213 if (string_fmts->len > 0 && finfo->hfinfo->strings) {
1214 g_string_truncate(label_s, 0);
1215 for (i = 0; i < string_fmts->len; i++) {
1216 sf = (string_fmt_t *)g_ptr_array_index(string_fmts, i);
1218 g_string_append(label_s, sf->plain);
1220 switch (sf->format) {
1222 g_string_append(label_s, hfinfo->name);
1225 g_string_append(label_s, fs_ptr);
1228 switch(hfinfo->type) {
1230 uvalue64 = fvalue_get_uinteger64(&finfo->value);
1231 tfstring = (const struct true_false_string*) hfinfo->strings;
1232 g_string_append(label_s, uvalue64 ? tfstring->true_string : tfstring->false_string);
1238 DISSECTOR_ASSERT(!hfinfo->bitmask);
1239 svalue = fvalue_get_sinteger(&finfo->value);
1240 if (hfinfo->display & BASE_RANGE_STRING) {
1241 g_string_append(label_s, rval_to_str_const(svalue, RVALS(hfinfo->strings), "Unknown"));
1242 } else if (hfinfo->display & BASE_EXT_STRING) {
1243 g_string_append(label_s, val_to_str_ext_const(svalue, (value_string_ext *) hfinfo->strings, "Unknown"));
1245 g_string_append(label_s, val_to_str_const(svalue, cVALS(hfinfo->strings), "Unknown"));
1248 case FT_INT40: /* XXX: Shouldn't these be as smart as FT_INT{8,16,24,32}? */
1252 DISSECTOR_ASSERT(!hfinfo->bitmask);
1253 svalue64 = (gint64)fvalue_get_sinteger64(&finfo->value);
1254 if (hfinfo->display & BASE_VAL64_STRING) {
1255 g_string_append(label_s, val64_to_str_const(svalue64, (const val64_string *)(hfinfo->strings), "Unknown"));
1262 DISSECTOR_ASSERT(!hfinfo->bitmask);
1263 uvalue = fvalue_get_uinteger(&finfo->value);
1264 if (!hfinfo->bitmask && hfinfo->display & BASE_RANGE_STRING) {
1265 g_string_append(label_s, rval_to_str_const(uvalue, RVALS(hfinfo->strings), "Unknown"));
1266 } else if (hfinfo->display & BASE_EXT_STRING) {
1267 g_string_append(label_s, val_to_str_ext_const(uvalue, (value_string_ext *) hfinfo->strings, "Unknown"));
1269 g_string_append(label_s, val_to_str_const(uvalue, cVALS(hfinfo->strings), "Unknown"));
1272 case FT_UINT40: /* XXX: Shouldn't these be as smart as FT_INT{8,16,24,32}? */
1276 DISSECTOR_ASSERT(!hfinfo->bitmask);
1277 uvalue64 = fvalue_get_uinteger64(&finfo->value);
1278 if (hfinfo->display & BASE_VAL64_STRING) {
1279 g_string_append(label_s, val64_to_str_const(uvalue64, (const val64_string *)(hfinfo->strings), "Unknown"));
1291 printf(" %d=\"%s\"", cmd_line_index, label_s->str);
1295 if(finfo->value.ftype->val_to_string_repr)
1297 printf(" %d=\"%s\"", cmd_line_index, fs_ptr);
1302 * This field doesn't have an associated value,
1306 printf(" %d=\"n.a.\"", cmd_line_index);
1311 protocolinfo_packet(void *prs, packet_info *pinfo _U_, epan_dissect_t *edt, const void *dummy _U_)
1313 pci_t *rs=(pci_t *)prs;
1317 gp=proto_get_finfo_ptr_array(edt->tree, rs->hf_index);
1324 * Print each occurrence of the field
1326 for (i = 0; i < gp->len; i++) {
1327 print_field_value((field_info *)gp->pdata[i], rs->cmd_line_index);
1333 int g_cmd_line_index = 0;
1336 * field must be persistent - we don't g_strdup() it below
1339 protocolinfo_init(char *field)
1342 header_field_info *hfi;
1343 GString *error_string;
1346 hfi=proto_registrar_get_byname(field);
1348 fprintf(stderr, "rawshark: Field \"%s\" doesn't exist.\n", field);
1352 field_display_to_string(hfi, hfibuf, sizeof(hfibuf));
1353 printf("%d %s %s - ",
1355 ftenum_to_string(hfi),
1358 rs=(pci_t *)g_malloc(sizeof(pci_t));
1359 rs->hf_index=hfi->id;
1361 rs->cmd_line_index = g_cmd_line_index++;
1363 error_string=register_tap_listener("frame", rs, rs->filter, TL_REQUIRES_PROTO_TREE, NULL, protocolinfo_packet, NULL);
1365 /* error, we failed to attach to the tap. complain and clean up */
1366 fprintf(stderr, "rawshark: Couldn't register field extraction tap: %s\n",
1368 g_string_free(error_string, TRUE);
1379 * Given a format string, split it into a GPtrArray of string_fmt_t structs
1380 * and fill in string_fmt_parts.
1384 add_string_fmt(string_fmt_e format, gchar *plain) {
1385 string_fmt_t *sf = (string_fmt_t *)g_malloc(sizeof(string_fmt_t));
1387 sf->format = format;
1388 sf->plain = g_strdup(plain);
1390 g_ptr_array_add(string_fmts, sf);
1394 parse_field_string_format(gchar *format) {
1395 GString *plain_s = g_string_new("");
1403 len = strlen(format);
1404 g_ptr_array_set_size(string_fmts, 0);
1407 if (format[pos] == '%') {
1408 if (pos >= len) { /* There should always be a following character */
1412 if (plain_s->len > 0) {
1413 add_string_fmt(SF_NONE, plain_s->str);
1414 g_string_truncate(plain_s, 0);
1416 switch (format[pos]) {
1418 add_string_fmt(SF_NAME, NULL);
1421 add_string_fmt(SF_NUMVAL, NULL);
1424 add_string_fmt(SF_STRVAL, NULL);
1427 g_string_append_c(plain_s, '%');
1429 default: /* Invalid format */
1433 g_string_append_c(plain_s, format[pos]);
1438 if (plain_s->len > 0) {
1439 add_string_fmt(SF_NONE, plain_s->str);
1441 g_string_free(plain_s, TRUE);
1445 /****************************************************************************************
1446 * END OF FIELD EXTRACTION ROUTINES
1447 ****************************************************************************************/
1450 show_print_file_io_error(int err)
1455 cmdarg_err("Not all the packets could be printed because there is "
1456 "no space left on the file system.");
1461 cmdarg_err("Not all the packets could be printed because you are "
1462 "too close to, or over your disk quota.");
1467 cmdarg_err("An error occurred while printing packets: %s.",
1474 * Open/create errors are reported with an console message in Rawshark.
1477 open_failure_message(const char *filename, int err, gboolean for_writing)
1479 fprintf(stderr, "rawshark: ");
1480 fprintf(stderr, file_open_error_message(err, for_writing), filename);
1481 fprintf(stderr, "\n");
1484 static const nstime_t *
1485 raw_get_frame_ts(void *data _U_, guint32 frame_num)
1487 if (ref && ref->num == frame_num)
1488 return &ref->abs_ts;
1490 if (prev_dis && prev_dis->num == frame_num)
1491 return &prev_dis->abs_ts;
1493 if (prev_cap && prev_cap->num == frame_num)
1494 return &prev_cap->abs_ts;
1500 raw_epan_new(capture_file *cf)
1502 epan_t *epan = epan_new();
1505 epan->get_frame_ts = raw_get_frame_ts;
1506 epan->get_interface_name = cap_file_get_interface_name;
1507 epan->get_user_comment = NULL;
1513 raw_cf_open(capture_file *cf, const char *fname)
1515 if ((fd = raw_pipe_open(fname)) < 0)
1518 /* The open succeeded. Fill in the information for this file. */
1520 /* Create new epan session for dissection. */
1521 epan_free(cf->epan);
1522 cf->epan = raw_epan_new(cf);
1525 cf->f_datalen = 0; /* not used, but set it anyway */
1527 /* Set the file name because we need it to set the follow stream filter.
1528 XXX - is that still true? We need it for other reasons, though,
1530 cf->filename = g_strdup(fname);
1532 /* Indicate whether it's a permanent or temporary file. */
1533 cf->is_tempfile = FALSE;
1535 /* No user changes yet. */
1536 cf->unsaved_changes = FALSE;
1538 cf->cd_t = WTAP_FILE_TYPE_SUBTYPE_UNKNOWN;
1539 cf->open_type = WTAP_TYPE_AUTO;
1541 cf->drops_known = FALSE;
1543 cf->has_snap = FALSE;
1544 cf->snap = WTAP_MAX_PACKET_SIZE;
1545 nstime_set_zero(&cf->elapsed_time);
1555 * General errors are reported with an console message in Rawshark.
1558 failure_message(const char *msg_format, va_list ap)
1560 fprintf(stderr, "rawshark: ");
1561 vfprintf(stderr, msg_format, ap);
1562 fprintf(stderr, "\n");
1566 * Read errors are reported with an console message in Rawshark.
1569 read_failure_message(const char *filename, int err)
1571 cmdarg_err("An error occurred while reading from the file \"%s\": %s.",
1572 filename, g_strerror(err));
1576 * Write errors are reported with an console message in Rawshark.
1579 write_failure_message(const char *filename, int err)
1581 cmdarg_err("An error occurred while writing to the file \"%s\": %s.",
1582 filename, g_strerror(err));
1586 * Report an error in command-line arguments.
1589 rawshark_cmdarg_err(const char *fmt, va_list ap)
1591 fprintf(stderr, "rawshark: ");
1592 vfprintf(stderr, fmt, ap);
1593 fprintf(stderr, "\n");
1597 * Report additional information for an error in command-line arguments.
1600 rawshark_cmdarg_err_cont(const char *fmt, va_list ap)
1602 vfprintf(stderr, fmt, ap);
1603 fprintf(stderr, "\n");
1612 * indent-tabs-mode: nil
1615 * ex: set shiftwidth=4 tabstop=8 expandtab:
1616 * :indentSize=4:tabSize=8:noTabs=true: