5 * Wireshark - Network traffic analyzer
6 * By Gerald Combs <gerald@wireshark.org>
7 * Copyright 1998 Gerald Combs
9 * Rawshark - Raw field extractor by Gerald Combs <gerald@wireshark.org>
10 * and Loris Degioanni <loris.degioanni@cacetech.com>
11 * Based on TShark, by Gilbert Ramirez <gram@alumni.rice.edu> and Guy Harris
14 * This program is free software; you can redistribute it and/or
15 * modify it under the terms of the GNU General Public License
16 * as published by the Free Software Foundation; either version 2
17 * of the License, or (at your option) any later version.
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program; if not, write to the Free Software
26 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
30 * Rawshark does the following:
31 * - Opens a specified file or named pipe
32 * - Applies a specfied DLT or "decode as" encapsulation
33 * - Reads frames prepended with a libpcap packet header.
34 * - Prints a status line, followed by fields from a specified list.
58 #ifdef HAVE_SYS_STAT_H
59 # include <sys/stat.h>
63 #include "wsutil/wsgetopt.h"
67 #include <epan/epan-int.h>
68 #include <epan/epan.h>
69 #include <wsutil/crash_info.h>
70 #include <wsutil/privileges.h>
71 #include <wsutil/file_util.h>
72 #include <wsutil/filesystem.h>
73 #include <wsutil/plugins.h>
74 #include <wsutil/report_err.h>
77 #include <epan/packet.h>
78 #include <epan/ftypes/ftypes-int.h>
80 #include "frame_tvbuff.h"
81 #include <epan/disabled_protos.h>
82 #include <epan/prefs.h>
83 #include <epan/column.h>
84 #include <epan/print.h>
85 #include <epan/addr_resolv.h>
87 #include "clopts_common.h"
88 #include "cmdarg_err.h"
89 #include "version_info.h"
91 #include "conditions.h"
92 #include "capture_stop_conditions.h"
93 #include "capture_ui_utils.h"
94 #include <epan/epan_dissect.h>
95 #include <epan/stat_cmd_args.h>
96 #include <epan/timestamp.h>
97 #include <wsutil/unicode-utils.h>
98 #include "epan/column-utils.h"
99 #include "epan/proto.h"
100 #include <epan/tap.h>
102 #include <wiretap/wtap.h>
103 #include <wiretap/libpcap.h>
104 #include <wiretap/pcap-encap.h>
108 #include "capture-pcap-util.h"
110 #include "capture-wpcap.h"
112 #endif /* HAVE_LIBPCAP */
116 #include <wsutil/unicode-utils.h>
121 * This is the template for the decode as option; it is shared between the
122 * various functions that output the usage for this parameter.
124 static const gchar decode_as_arg_template[] = "<layer_type>==<selector>,<decode_as_protocol>";
127 static guint32 cum_bytes;
128 static const frame_data *ref;
129 static frame_data ref_frame;
130 static frame_data *prev_dis;
131 static frame_data prev_dis_frame;
132 static frame_data *prev_cap;
133 static frame_data prev_cap_frame;
136 * The way the packet decode is to be written.
139 WRITE_TEXT, /* summary or detail text */
140 WRITE_XML /* PDML or PSML */
141 /* Add CSV and the like here */
144 static gboolean line_buffered;
145 static print_format_e print_format = PR_FMT_TEXT;
147 static gboolean want_pcap_pkthdr;
149 cf_status_t raw_cf_open(capture_file *cf, const char *fname);
150 static int load_cap_file(capture_file *cf);
151 static gboolean process_packet(capture_file *cf, epan_dissect_t *edt, gint64 offset,
152 struct wtap_pkthdr *whdr, const guchar *pd);
153 static void show_print_file_io_error(int err);
155 static void open_failure_message(const char *filename, int err,
156 gboolean for_writing);
157 static void failure_message(const char *msg_format, va_list ap);
158 static void read_failure_message(const char *filename, int err);
159 static void write_failure_message(const char *filename, int err);
160 static void protocolinfo_init(char *field);
161 static gboolean parse_field_string_format(char *format);
164 SF_NONE, /* No format (placeholder) */
165 SF_NAME, /* %D Field name / description */
166 SF_NUMVAL, /* %N Numeric value */
167 SF_STRVAL /* %S String value */
170 typedef struct string_fmt_s {
172 string_fmt_e format; /* Valid if plain is NULL */
178 dfilter_t *rfcodes[64];
180 dfilter_t *rfieldfcodes[64];
183 GPtrArray *string_fmts;
186 print_usage(gboolean print_ver)
193 "Rawshark " VERSION "%s\n"
194 "Dump and analyze network traffic.\n"
195 "See http://www.wireshark.org for more information.\n"
198 wireshark_gitversion, get_copyright_info());
202 fprintf(output, "\n");
203 fprintf(output, "Usage: rawshark [options] ...\n");
204 fprintf(output, "\n");
206 fprintf(output, "Input file:\n");
207 fprintf(output, " -r <infile> set the pipe or file name to read from\n");
209 fprintf(output, "\n");
210 fprintf(output, "Processing:\n");
211 fprintf(output, " -d <encap:linktype>|<proto:protoname>\n");
212 fprintf(output, " packet encapsulation or protocol\n");
213 fprintf(output, " -F <field> field to display\n");
214 fprintf(output, " -n disable all name resolution (def: all enabled)\n");
215 fprintf(output, " -N <name resolve flags> enable specific name resolution(s): \"mntC\"\n");
216 fprintf(output, " -p use the system's packet header format\n");
217 fprintf(output, " (which may have 64-bit timestamps)\n");
218 fprintf(output, " -R <read filter> packet filter in Wireshark display filter syntax\n");
219 fprintf(output, " -s skip PCAP header on input\n");
221 fprintf(output, "\n");
222 fprintf(output, "Output:\n");
223 fprintf(output, " -l flush output after each packet\n");
224 fprintf(output, " -S format string for fields\n");
225 fprintf(output, " (%%D - name, %%S - stringval, %%N numval)\n");
226 fprintf(output, " -t ad|a|r|d|dd|e output format of time stamps (def: r: rel. to first)\n");
228 fprintf(output, "\n");
229 fprintf(output, "Miscellaneous:\n");
230 fprintf(output, " -h display this help and exit\n");
231 fprintf(output, " -o <name>:<value> ... override preference setting\n");
232 fprintf(output, " -v display version info and exit\n");
236 log_func_ignore (const gchar *log_domain _U_, GLogLevelFlags log_level _U_,
237 const gchar *message _U_, gpointer user_data _U_)
242 * Open a pipe for raw input. This is a stripped-down version of
243 * pcap_loop.c:cap_pipe_open_live().
244 * We check if "pipe_name" is "-" (stdin) or a FIFO, and open it.
245 * @param pipe_name The name of the pipe or FIFO.
246 * @return A POSIX file descriptor on success, or -1 on failure.
249 raw_pipe_open(const char *pipe_name)
252 ws_statb64 pipe_stat;
254 char *pncopy, *pos = NULL;
261 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "open_raw_pipe: %s", pipe_name);
264 * XXX Rawshark blocks until we return
266 if (strcmp(pipe_name, "-") == 0) {
267 rfd = 0; /* read from stdin */
270 * This is needed to set the stdin pipe into binary mode, otherwise
271 * CR/LF are mangled...
273 _setmode(0, _O_BINARY);
277 if (ws_stat64(pipe_name, &pipe_stat) < 0) {
278 fprintf(stderr, "rawshark: The pipe %s could not be checked: %s\n",
279 pipe_name, g_strerror(errno));
282 if (! S_ISFIFO(pipe_stat.st_mode)) {
283 if (S_ISCHR(pipe_stat.st_mode)) {
285 * Assume the user specified an interface on a system where
286 * interfaces are in /dev. Pretend we haven't seen it.
290 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
295 rfd = ws_open(pipe_name, O_RDONLY | O_NONBLOCK, 0000 /* no creation so don't matter */);
297 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
298 pipe_name, g_strerror(errno));
302 #define PIPE_STR "\\pipe\\"
303 /* Under Windows, named pipes _must_ have the form
304 * "\\<server>\pipe\<pipe_name>". <server> may be "." for localhost.
306 pncopy = g_strdup(pipe_name);
307 if (strstr(pncopy, "\\\\") == pncopy) {
308 pos = strchr(pncopy + 3, '\\');
309 if (pos && g_ascii_strncasecmp(pos, PIPE_STR, strlen(PIPE_STR)) != 0)
316 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
321 /* Wait for the pipe to appear */
323 hPipe = CreateFile(utf_8to16(pipe_name), GENERIC_READ, 0, NULL,
324 OPEN_EXISTING, 0, NULL);
326 if (hPipe != INVALID_HANDLE_VALUE)
329 err = GetLastError();
330 if (err != ERROR_PIPE_BUSY) {
331 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
332 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
333 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s (error %d)\n",
334 pipe_name, utf_16to8(err_str), err);
339 if (!WaitNamedPipe(utf_8to16(pipe_name), 30 * 1000)) {
340 err = GetLastError();
341 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
342 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
343 fprintf(stderr, "rawshark: \"%s\" could not be waited for: %s (error %d)\n",
344 pipe_name, utf_16to8(err_str), err);
350 rfd = _open_osfhandle((long) hPipe, _O_RDONLY);
352 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
353 pipe_name, g_strerror(errno));
363 * Parse a link-type argument of the form "encap:<pcap linktype>" or
364 * "proto:<proto name>". "Pcap linktype" must be a name conforming to
365 * pcap_datalink_name_to_val() or an integer; the integer should be
366 * a LINKTYPE_ value supported by Wiretap. "Proto name" must be
367 * a protocol name, e.g. "http".
370 set_link_type(const char *lt_arg) {
371 char *spec_ptr = strchr(lt_arg, ':');
375 dissector_handle_t dhandle;
383 if (strncmp(lt_arg, "encap:", strlen("encap:")) == 0) {
384 dlt_val = linktype_name_to_val(spec_ptr);
387 val = strtol(spec_ptr, &p, 10);
388 if (p == spec_ptr || *p != '\0' || errno != 0 || val > INT_MAX) {
394 * In those cases where a given link-layer header type
395 * has different LINKTYPE_ and DLT_ values, linktype_name_to_val()
396 * will return the OS's DLT_ value for that link-layer header
397 * type, not its OS-independent LINKTYPE_ value.
399 * On a given OS, wtap_pcap_encap_to_wtap_encap() should
400 * be able to map either LINKTYPE_ values or DLT_ values
401 * for the OS to the appropriate Wiretap encapsulation.
403 encap = wtap_pcap_encap_to_wtap_encap(dlt_val);
404 if (encap == WTAP_ENCAP_UNKNOWN) {
408 } else if (strncmp(lt_arg, "proto:", strlen("proto:")) == 0) {
409 dhandle = find_dissector(spec_ptr);
411 encap = WTAP_ENCAP_USER0;
412 pref_str = g_string_new("uat:user_dlts:");
413 /* This must match the format used in the user_dlts file */
414 g_string_append_printf(pref_str,
415 "\"User 0 (DLT=147)\",\"%s\",\"0\",\"\",\"0\",\"\"",
417 if (prefs_set_pref(pref_str->str) != PREFS_SET_OK) {
418 g_string_free(pref_str, TRUE);
421 g_string_free(pref_str, TRUE);
429 show_version(GString *comp_info_str, GString *runtime_info_str)
431 printf("Rawshark " VERSION "%s\n"
438 wireshark_gitversion, get_copyright_info(), comp_info_str->str,
439 runtime_info_str->str);
443 main(int argc, char *argv[])
445 GString *comp_info_str;
446 GString *runtime_info_str;
447 char *init_progfile_dir_error;
449 gboolean arg_error = FALSE;
455 char *gpf_path, *pf_path;
456 char *gdp_path, *dp_path;
457 int gpf_open_errno, gpf_read_errno;
458 int pf_open_errno, pf_read_errno;
459 int gdp_open_errno, gdp_read_errno;
460 int dp_open_errno, dp_read_errno;
462 gchar *pipe_name = NULL;
467 GPtrArray *disp_fields = g_ptr_array_new();
469 gboolean skip_pcap_header = FALSE;
471 #define OPTSTRING_INIT "d:F:hlnN:o:pr:R:sS:t:v"
473 static const char optstring[] = OPTSTRING_INIT;
475 /* Assemble the compile-time version information string */
476 comp_info_str = g_string_new("Compiled ");
477 get_compiled_version_info(comp_info_str, NULL, epan_get_compiled_version_info);
479 /* Assemble the run-time version information string */
480 runtime_info_str = g_string_new("Running ");
481 get_runtime_version_info(runtime_info_str, NULL);
483 /* Add it to the information to be reported on a crash. */
484 ws_add_crash_info("Rawshark " VERSION "%s\n"
489 wireshark_gitversion, comp_info_str->str, runtime_info_str->str);
492 arg_list_utf_16to8(argc, argv);
493 create_app_running_mutex();
497 * Get credential information for later use.
499 init_process_policies();
502 * Clear the filters arrays
504 memset(rfilters, 0, sizeof(rfilters));
505 memset(rfcodes, 0, sizeof(rfcodes));
510 * Initialize our string format
512 string_fmts = g_ptr_array_new();
515 * Attempt to get the pathname of the executable file.
517 init_progfile_dir_error = init_progfile_dir(argv[0], main);
518 if (init_progfile_dir_error != NULL) {
519 fprintf(stderr, "rawshark: Can't get pathname of rawshark program: %s.\n",
520 init_progfile_dir_error);
524 * Get credential information for later use.
526 init_process_policies();
528 /* nothing more than the standard GLib handler, but without a warning */
530 G_LOG_LEVEL_WARNING |
531 G_LOG_LEVEL_MESSAGE |
535 g_log_set_handler(NULL,
536 (GLogLevelFlags)log_flags,
537 log_func_ignore, NULL /* user_data */);
538 g_log_set_handler(LOG_DOMAIN_CAPTURE_CHILD,
539 (GLogLevelFlags)log_flags,
540 log_func_ignore, NULL /* user_data */);
542 init_report_err(failure_message, open_failure_message, read_failure_message,
543 write_failure_message);
545 timestamp_set_type(TS_RELATIVE);
546 timestamp_set_precision(TS_PREC_AUTO);
547 timestamp_set_seconds_type(TS_SECONDS_DEFAULT);
549 /* Register all dissectors; we must do this before checking for the
550 "-G" flag, as the "-G" flag dumps information registered by the
551 dissectors, and we must do it before we read the preferences, in
552 case any dissectors register preferences. */
553 epan_init(register_all_protocols, register_all_protocol_handoffs, NULL, NULL);
555 /* Set the C-language locale to the native environment. */
556 setlocale(LC_ALL, "");
558 prefs_p = read_prefs(&gpf_open_errno, &gpf_read_errno, &gpf_path,
559 &pf_open_errno, &pf_read_errno, &pf_path);
560 if (gpf_path != NULL) {
561 if (gpf_open_errno != 0) {
562 cmdarg_err("Can't open global preferences file \"%s\": %s.",
563 pf_path, g_strerror(gpf_open_errno));
565 if (gpf_read_errno != 0) {
566 cmdarg_err("I/O error reading global preferences file \"%s\": %s.",
567 pf_path, g_strerror(gpf_read_errno));
570 if (pf_path != NULL) {
571 if (pf_open_errno != 0) {
572 cmdarg_err("Can't open your preferences file \"%s\": %s.", pf_path,
573 g_strerror(pf_open_errno));
575 if (pf_read_errno != 0) {
576 cmdarg_err("I/O error reading your preferences file \"%s\": %s.",
577 pf_path, g_strerror(pf_read_errno));
583 /* Read the disabled protocols file. */
584 read_disabled_protos_list(&gdp_path, &gdp_open_errno, &gdp_read_errno,
585 &dp_path, &dp_open_errno, &dp_read_errno);
586 if (gdp_path != NULL) {
587 if (gdp_open_errno != 0) {
588 cmdarg_err("Could not open global disabled protocols file\n\"%s\": %s.",
589 gdp_path, g_strerror(gdp_open_errno));
591 if (gdp_read_errno != 0) {
592 cmdarg_err("I/O error reading global disabled protocols file\n\"%s\": %s.",
593 gdp_path, g_strerror(gdp_read_errno));
597 if (dp_path != NULL) {
598 if (dp_open_errno != 0) {
600 "Could not open your disabled protocols file\n\"%s\": %s.", dp_path,
601 g_strerror(dp_open_errno));
603 if (dp_read_errno != 0) {
605 "I/O error reading your disabled protocols file\n\"%s\": %s.", dp_path,
606 g_strerror(dp_read_errno));
612 /* Load Wpcap, if possible */
616 cap_file_init(&cfile);
618 /* Print format defaults to this. */
619 print_format = PR_FMT_TEXT;
621 /* Initialize our encapsulation type */
622 encap = WTAP_ENCAP_UNKNOWN;
624 /* Now get our args */
625 /* XXX - We should probably have an option to dump libpcap link types */
626 while ((opt = getopt(argc, argv, optstring)) != -1) {
628 case 'd': /* Payload type */
629 if (!set_link_type(optarg)) {
630 cmdarg_err("Invalid link type or protocol \"%s\"", optarg);
634 case 'F': /* Read field to display */
635 g_ptr_array_add(disp_fields, g_strdup(optarg));
637 case 'h': /* Print help and exit */
641 case 'l': /* "Line-buffer" standard output */
642 /* This isn't line-buffering, strictly speaking, it's just
643 flushing the standard output after the information for
644 each packet is printed; however, that should be good
645 enough for all the purposes to which "-l" is put (and
646 is probably actually better for "-V", as it does fewer
649 See the comment in "process_packet()" for an explanation of
650 why we do that, and why we don't just use "setvbuf()" to
651 make the standard output line-buffered (short version: in
652 Windows, "line-buffered" is the same as "fully-buffered",
653 and the output buffer is only flushed when it fills up). */
654 line_buffered = TRUE;
656 case 'n': /* No name resolution */
657 gbl_resolv_flags.mac_name = FALSE;
658 gbl_resolv_flags.network_name = FALSE;
659 gbl_resolv_flags.transport_name = FALSE;
660 gbl_resolv_flags.concurrent_dns = FALSE;
662 case 'N': /* Select what types of addresses/port #s to resolve */
663 badopt = string_to_name_resolve(optarg, &gbl_resolv_flags);
664 if (badopt != '\0') {
665 cmdarg_err("-N specifies unknown resolving option '%c'; valid options are 'm', 'n', and 't'",
670 case 'o': /* Override preference from command line */
671 switch (prefs_set_pref(optarg)) {
676 case PREFS_SET_SYNTAX_ERR:
677 cmdarg_err("Invalid -o flag \"%s\"", optarg);
681 case PREFS_SET_NO_SUCH_PREF:
682 case PREFS_SET_OBSOLETE:
683 cmdarg_err("-o flag \"%s\" specifies unknown preference", optarg);
688 case 'p': /* Expect pcap_pkthdr packet headers, which may have 64-bit timestamps */
689 want_pcap_pkthdr = TRUE;
691 case 'r': /* Read capture file xxx */
692 pipe_name = g_strdup(optarg);
694 case 'R': /* Read file filter */
695 if(n_rfilters < (int) sizeof(rfilters) / (int) sizeof(rfilters[0])) {
696 rfilters[n_rfilters++] = optarg;
699 cmdarg_err("Too many display filters");
703 case 's': /* Skip PCAP header */
704 skip_pcap_header = TRUE;
706 case 'S': /* Print string representations */
707 if (!parse_field_string_format(optarg)) {
708 cmdarg_err("Invalid field string format");
712 case 't': /* Time stamp type */
713 if (strcmp(optarg, "r") == 0)
714 timestamp_set_type(TS_RELATIVE);
715 else if (strcmp(optarg, "a") == 0)
716 timestamp_set_type(TS_ABSOLUTE);
717 else if (strcmp(optarg, "ad") == 0)
718 timestamp_set_type(TS_ABSOLUTE_WITH_YMD);
719 else if (strcmp(optarg, "adoy") == 0)
720 timestamp_set_type(TS_ABSOLUTE_WITH_YDOY);
721 else if (strcmp(optarg, "d") == 0)
722 timestamp_set_type(TS_DELTA);
723 else if (strcmp(optarg, "dd") == 0)
724 timestamp_set_type(TS_DELTA_DIS);
725 else if (strcmp(optarg, "e") == 0)
726 timestamp_set_type(TS_EPOCH);
727 else if (strcmp(optarg, "u") == 0)
728 timestamp_set_type(TS_UTC);
729 else if (strcmp(optarg, "ud") == 0)
730 timestamp_set_type(TS_UTC_WITH_YMD);
731 else if (strcmp(optarg, "udoy") == 0)
732 timestamp_set_type(TS_UTC_WITH_YDOY);
734 cmdarg_err("Invalid time stamp type \"%s\"",
737 "It must be \"a\" for absolute, \"ad\" for absolute with YYYY-MM-DD date,");
739 "\"adoy\" for absolute with YYYY/DOY date, \"d\" for delta,");
741 "\"dd\" for delta displayed, \"e\" for epoch, \"r\" for relative,");
743 "\"u\" for absolute UTC, \"ud\" for absolute UTC with YYYY-MM-DD date,");
745 "or \"udoy\" for absolute UTC with YYYY/DOY date.");
749 case 'v': /* Show version and exit */
751 show_version(comp_info_str, runtime_info_str);
752 g_string_free(comp_info_str, TRUE);
753 g_string_free(runtime_info_str, TRUE);
758 case '?': /* Bad flag - print usage message */
765 /* Notify all registered modules that have had any of their preferences
766 changed either from one of the preferences file or from the command
767 line that their preferences have changed.
768 Initialize preferences before display filters, otherwise modules
769 like MATE won't work. */
772 /* Initialize our display fields */
773 for (fc = 0; fc < disp_fields->len; fc++) {
774 protocolinfo_init((char *)g_ptr_array_index(disp_fields, fc));
776 g_ptr_array_free(disp_fields, TRUE);
780 /* If no capture filter or read filter has been specified, and there are
781 still command-line arguments, treat them as the tokens of a capture
782 filter (if no "-r" flag was specified) or a read filter (if a "-r"
783 flag was specified. */
785 if (pipe_name != NULL) {
786 if (n_rfilters != 0) {
787 cmdarg_err("Read filters were specified both with \"-R\" "
788 "and with additional command-line arguments");
791 rfilters[n_rfilters] = get_args_as_string(argc, argv, optind);
795 /* Make sure we got a dissector handle for our payload. */
796 if (encap == WTAP_ENCAP_UNKNOWN) {
797 cmdarg_err("No valid payload dissector specified.");
808 /* Start windows sockets */
809 WSAStartup( MAKEWORD( 1, 1 ), &wsaData );
812 /* At this point MATE will have registered its field array so we can
813 have a tap filter with one of MATE's late-registered fields as part
814 of the filter. We can now process all the "-z" arguments. */
815 start_requested_stats();
817 /* disabled protocols as per configuration file */
818 if (gdp_path == NULL && dp_path == NULL) {
819 set_disabled_protos_list();
822 /* Build the column format array */
823 build_column_format_array(&cfile.cinfo, prefs_p->num_cols, TRUE);
825 if (n_rfilters != 0) {
826 for (i = 0; i < n_rfilters; i++) {
827 if (!dfilter_compile(rfilters[i], &rfcodes[n_rfcodes])) {
828 cmdarg_err("%s", dfilter_error_msg);
829 epan_free(cfile.epan);
839 * We're reading a pipe (or capture file).
843 * Immediately relinquish any special privileges we have; we must not
844 * be allowed to read any capture files the user running Rawshark
847 relinquish_special_privs_perm();
849 if (raw_cf_open(&cfile, pipe_name) != CF_OK) {
850 epan_free(cfile.epan);
855 /* Do we need to PCAP header and magic? */
856 if (skip_pcap_header) {
857 size_t bytes_left = sizeof(struct pcap_hdr) + sizeof(guint32);
858 gchar buf[sizeof(struct pcap_hdr) + sizeof(guint32)];
859 while (bytes_left != 0) {
860 ssize_t bytes = read(fd, buf, (int)bytes_left);
862 cmdarg_err("Not enough bytes for pcap header.");
869 /* Set timestamp precision; there should arguably be a command-line
870 option to let the user set this. */
872 switch(wtap_file_tsprecision(cfile.wth)) {
873 case(WTAP_FILE_TSPREC_SEC):
874 timestamp_set_precision(TS_PREC_AUTO_SEC);
876 case(WTAP_FILE_TSPREC_DSEC):
877 timestamp_set_precision(TS_PREC_AUTO_DSEC);
879 case(WTAP_FILE_TSPREC_CSEC):
880 timestamp_set_precision(TS_PREC_AUTO_CSEC);
882 case(WTAP_FILE_TSPREC_MSEC):
883 timestamp_set_precision(TS_PREC_AUTO_MSEC);
885 case(WTAP_FILE_TSPREC_USEC):
886 timestamp_set_precision(TS_PREC_AUTO_USEC);
888 case(WTAP_FILE_TSPREC_NSEC):
889 timestamp_set_precision(TS_PREC_AUTO_NSEC);
892 g_assert_not_reached();
895 timestamp_set_precision(TS_PREC_AUTO_USEC);
898 /* Process the packets in the file */
899 err = load_cap_file(&cfile);
902 epan_free(cfile.epan);
907 /* If you want to capture live packets, use TShark. */
908 cmdarg_err("Input file or pipe name not specified.");
912 epan_free(cfile.epan);
919 * Read data from a raw pipe. The "raw" data consists of a libpcap
920 * packet header followed by the payload.
921 * @param pd [IN] A POSIX file descriptor. Because that's _exactly_ the sort
922 * of thing you want to use in Windows.
923 * @param phdr [OUT] Packet header information.
924 * @param err [OUT] Error indicator. Uses wiretap values.
925 * @param err_info [OUT] Error message.
926 * @param data_offset [OUT] data offset in the pipe.
927 * @return TRUE on success, FALSE on failure.
930 raw_pipe_read(struct wtap_pkthdr *phdr, guchar * pd, int *err, const gchar **err_info, gint64 *data_offset) {
931 struct pcap_pkthdr mem_hdr;
932 struct pcaprec_hdr disk_hdr;
933 ssize_t bytes_read = 0;
934 size_t bytes_needed = sizeof(disk_hdr);
935 guchar *ptr = (guchar*) &disk_hdr;
936 static gchar err_str[100];
938 if (want_pcap_pkthdr) {
939 bytes_needed = sizeof(mem_hdr);
940 ptr = (guchar*) &mem_hdr;
943 /* Copied from capture_loop.c */
944 while (bytes_needed > 0) {
945 bytes_read = read(fd, ptr, (int)bytes_needed);
946 if (bytes_read == 0) {
949 } else if (bytes_read < 0) {
950 *err = WTAP_ERR_CANT_READ;
951 *err_info = "Error reading header from pipe";
954 bytes_needed -= bytes_read;
955 *data_offset += bytes_read;
959 if (want_pcap_pkthdr) {
960 phdr->ts.secs = mem_hdr.ts.tv_sec;
961 phdr->ts.nsecs = (gint32)mem_hdr.ts.tv_usec * 1000;
962 phdr->caplen = mem_hdr.caplen;
963 phdr->len = mem_hdr.len;
965 phdr->ts.secs = disk_hdr.ts_sec;
966 phdr->ts.nsecs = disk_hdr.ts_usec * 1000;
967 phdr->caplen = disk_hdr.incl_len;
968 phdr->len = disk_hdr.orig_len;
970 bytes_needed = phdr->caplen;
972 phdr->pkt_encap = encap;
975 printf("mem_hdr: %lu disk_hdr: %lu\n", sizeof(mem_hdr), sizeof(disk_hdr));
976 printf("tv_sec: %u (%04x)\n", (unsigned int) phdr->ts.secs, (unsigned int) phdr->ts.secs);
977 printf("tv_nsec: %d (%04x)\n", phdr->ts.nsecs, phdr->ts.nsecs);
978 printf("caplen: %d (%04x)\n", phdr->caplen, phdr->caplen);
979 printf("len: %d (%04x)\n", phdr->len, phdr->len);
981 if (bytes_needed > WTAP_MAX_PACKET_SIZE) {
982 *err = WTAP_ERR_BAD_FILE;
983 g_snprintf(err_str, 100, "Bad packet length: %lu\n",
984 (unsigned long) bytes_needed);
990 while (bytes_needed > 0) {
991 bytes_read = read(fd, ptr, (int)bytes_needed);
992 if (bytes_read == 0) {
993 *err = WTAP_ERR_SHORT_READ;
994 *err_info = "Got zero bytes reading data from pipe";
996 } else if (bytes_read < 0) {
997 *err = WTAP_ERR_CANT_READ;
998 *err_info = "Error reading data from pipe";
1001 bytes_needed -= bytes_read;
1002 *data_offset += bytes_read;
1009 load_cap_file(capture_file *cf)
1012 const gchar *err_info;
1013 gint64 data_offset = 0;
1015 guchar pd[WTAP_MAX_PACKET_SIZE];
1016 struct wtap_pkthdr phdr;
1019 memset(&phdr, 0, sizeof(phdr));
1021 epan_dissect_init(&edt, cf->epan, TRUE, FALSE);
1023 while (raw_pipe_read(&phdr, pd, &err, &err_info, &data_offset)) {
1024 process_packet(cf, &edt, data_offset, &phdr, pd);
1027 epan_dissect_cleanup(&edt);
1030 /* Print a message noting that the read failed somewhere along the line. */
1033 case WTAP_ERR_UNSUPPORTED_ENCAP:
1034 cmdarg_err("The file \"%s\" has a packet with a network type that Rawshark doesn't support.\n(%s)",
1035 cf->filename, err_info);
1038 case WTAP_ERR_CANT_READ:
1039 cmdarg_err("An attempt to read from the file \"%s\" failed for some unknown reason.",
1043 case WTAP_ERR_SHORT_READ:
1044 cmdarg_err("The file \"%s\" appears to have been cut short in the middle of a packet.",
1048 case WTAP_ERR_BAD_FILE:
1049 cmdarg_err("The file \"%s\" appears to be damaged or corrupt.\n(%s)",
1050 cf->filename, err_info);
1053 case WTAP_ERR_DECOMPRESS:
1054 cmdarg_err("The compressed file \"%s\" appears to be damaged or corrupt.\n(%s)",
1055 cf->filename, err_info);
1059 cmdarg_err("An error occurred while reading the file \"%s\": %s.",
1060 cf->filename, wtap_strerror(err));
1069 process_packet(capture_file *cf, epan_dissect_t *edt, gint64 offset,
1070 struct wtap_pkthdr *whdr, const guchar *pd)
1078 /* The user sends an empty packet when he wants to get output from us even if we don't currently have
1079 packets to process. We spit out a line with the timestamp and the text "void"
1081 printf("%lu %lu %lu void -\n", (unsigned long int)cf->count,
1082 (unsigned long int)whdr->ts.secs,
1083 (unsigned long int)whdr->ts.nsecs);
1090 /* Count this packet. */
1093 /* If we're going to print packet information, or we're going to
1094 run a read filter, or we're going to process taps, set up to
1095 do a dissection and do so. */
1096 frame_data_init(&fdata, cf->count, whdr, offset, cum_bytes);
1100 /* If we're running a read filter, prime the epan_dissect_t with that
1102 if (n_rfilters > 0) {
1103 for(i = 0; i < n_rfcodes; i++) {
1104 epan_dissect_prime_dfilter(edt, rfcodes[i]);
1108 printf("%lu", (unsigned long int) cf->count);
1110 frame_data_set_before_dissect(&fdata, &cf->elapsed_time,
1113 if (ref == &fdata) {
1118 /* We only need the columns if we're printing packet info but we're
1119 *not* verbose; in verbose mode, we print the protocol tree, not
1120 the protocol summary. */
1121 epan_dissect_run_with_taps(edt, whdr, frame_tvbuff_new(&fdata, pd), &fdata, &cf->cinfo);
1123 frame_data_set_after_dissect(&fdata, &cum_bytes);
1124 prev_dis_frame = fdata;
1125 prev_dis = &prev_dis_frame;
1127 prev_cap_frame = fdata;
1128 prev_cap = &prev_cap_frame;
1130 for(i = 0; i < n_rfilters; i++) {
1131 /* Run the read filter if we have one. */
1133 passed = dfilter_apply_edt(rfcodes[i], edt);
1137 /* Print a one-line summary */
1138 printf(" %u", passed ? 1 : 0);
1143 /* The ANSI C standard does not appear to *require* that a line-buffered
1144 stream be flushed to the host environment whenever a newline is
1145 written, it just says that, on such a stream, characters "are
1146 intended to be transmitted to or from the host environment as a
1147 block when a new-line character is encountered".
1149 The Visual C++ 6.0 C implementation doesn't do what is intended;
1150 even if you set a stream to be line-buffered, it still doesn't
1151 flush the buffer at the end of every line.
1153 So, if the "-l" flag was specified, we flush the standard output
1154 at the end of a packet. This will do the right thing if we're
1155 printing packet summary lines, and, as we print the entire protocol
1156 tree for a single packet without waiting for anything to happen,
1157 it should be as good as line-buffered mode if we're printing
1158 protocol trees. (The whole reason for the "-l" flag in either
1159 tcpdump or Rawshark is to allow the output of a live capture to
1160 be piped to a program or script and to have that script see the
1161 information for the packet as soon as it's printed, rather than
1162 having to wait until a standard I/O buffer fills up. */
1166 if (ferror(stdout)) {
1167 show_print_file_io_error(errno);
1171 epan_dissect_reset(edt);
1172 frame_data_destroy(&fdata);
1177 /****************************************************************************************
1178 * FIELD EXTRACTION ROUTINES
1179 ****************************************************************************************/
1180 typedef struct _pci_t {
1186 static const char* ftenum_to_string(header_field_info *hfi)
1192 if (string_fmts->len > 0 && hfi->strings) {
1200 return "FT_PROTOCOL";
1202 return "FT_BOOLEAN";
1227 case FT_ABSOLUTE_TIME:
1228 return "FT_ABSOLUTE_TIME";
1229 case FT_RELATIVE_TIME:
1230 return "FT_RELATIVE_TIME";
1234 return "FT_STRINGZ";
1235 case FT_UINT_STRING:
1236 return "FT_UINT_STRING";
1242 return "FT_UINT_BYTES";
1250 return "FT_FRAMENUM";
1258 return "FT_REL_OID";
1260 return "FT_SYSTEM_ID";
1262 return "FT_NUM_TYPES";
1268 static const char* absolute_time_display_e_to_string(absolute_time_display_e atd)
1271 case ABSOLUTE_TIME_LOCAL:
1272 return "ABSOLUTE_TIME_LOCAL";
1273 case ABSOLUTE_TIME_UTC:
1274 return "ABSOLUTE_TIME_UTC";
1280 static const char* field_display_e_to_string(field_display_e bd)
1292 return "BASE_DEC_HEX";
1294 return "BASE_HEX_DEC";
1301 * Copied from various parts of proto.c
1303 #define FIELD_STR_INIT_LEN 256
1304 #define cVALS(x) (const value_string*)(x)
1305 static gboolean print_field_value(field_info *finfo, int cmd_line_index)
1307 header_field_info *hfinfo;
1308 static char *fs_buf = NULL;
1309 char *fs_ptr = fs_buf;
1310 static GString *label_s = NULL;
1311 int fs_buf_len = FIELD_STR_INIT_LEN, fs_len;
1318 const true_false_string *tfstring = &tfs_true_false;
1320 hfinfo = finfo->hfinfo;
1323 fs_buf = (char *)g_malloc(fs_buf_len + 1);
1328 label_s = g_string_new("");
1331 if(finfo->value.ftype->val_to_string_repr)
1334 * this field has an associated value,
1337 fs_len = fvalue_string_repr_len(&finfo->value, FTREPR_DFILTER);
1338 while (fs_buf_len < fs_len) {
1340 fs_buf = (char *)g_realloc(fs_buf, fs_buf_len + 1);
1343 fvalue_to_string_repr(&finfo->value,
1347 /* String types are quoted. Remove them. */
1348 if ((finfo->value.ftype->ftype == FT_STRING || finfo->value.ftype->ftype == FT_STRINGZ) && fs_len > 2) {
1349 fs_buf[fs_len - 1] = '\0';
1354 if (string_fmts->len > 0 && finfo->hfinfo->strings) {
1355 g_string_truncate(label_s, 0);
1356 for (i = 0; i < string_fmts->len; i++) {
1357 sf = (string_fmt_t *)g_ptr_array_index(string_fmts, i);
1359 g_string_append(label_s, sf->plain);
1361 switch (sf->format) {
1363 g_string_append(label_s, hfinfo->name);
1366 g_string_append(label_s, fs_ptr);
1369 switch(hfinfo->type) {
1371 uvalue = fvalue_get_uinteger(&finfo->value);
1372 tfstring = (const struct true_false_string*) hfinfo->strings;
1373 g_string_append(label_s, uvalue ? tfstring->true_string : tfstring->false_string);
1379 DISSECTOR_ASSERT(!hfinfo->bitmask);
1380 svalue = fvalue_get_sinteger(&finfo->value);
1381 if (hfinfo->display & BASE_RANGE_STRING) {
1382 g_string_append(label_s, rval_to_str_const(svalue, RVALS(hfinfo->strings), "Unknown"));
1383 } else if (hfinfo->display & BASE_EXT_STRING) {
1384 g_string_append(label_s, val_to_str_ext_const(svalue, (const value_string_ext *) hfinfo->strings, "Unknown"));
1386 g_string_append(label_s, val_to_str_const(svalue, cVALS(hfinfo->strings), "Unknown"));
1390 DISSECTOR_ASSERT(!hfinfo->bitmask);
1391 svalue64 = (gint64)fvalue_get_integer64(&finfo->value);
1392 if (hfinfo->display & BASE_VAL64_STRING) {
1393 g_string_append(label_s, val64_to_str_const(svalue64, (const val64_string *)(hfinfo->strings), "Unknown"));
1400 uvalue = fvalue_get_uinteger(&finfo->value);
1401 if (!hfinfo->bitmask && hfinfo->display & BASE_RANGE_STRING) {
1402 g_string_append(label_s, rval_to_str_const(uvalue, RVALS(hfinfo->strings), "Unknown"));
1403 } else if (hfinfo->display & BASE_EXT_STRING) {
1404 g_string_append(label_s, val_to_str_ext_const(uvalue, (const value_string_ext *) hfinfo->strings, "Unknown"));
1406 g_string_append(label_s, val_to_str_const(uvalue, cVALS(hfinfo->strings), "Unknown"));
1410 DISSECTOR_ASSERT(!hfinfo->bitmask);
1411 uvalue64 = fvalue_get_integer64(&finfo->value);
1412 if (hfinfo->display & BASE_VAL64_STRING) {
1413 g_string_append(label_s, val64_to_str_const(uvalue64, (const val64_string *)(hfinfo->strings), "Unknown"));
1425 printf(" %u=\"%s\"", cmd_line_index, label_s->str);
1429 if(finfo->value.ftype->val_to_string_repr)
1431 printf(" %u=\"%s\"", cmd_line_index, fs_ptr);
1436 * This field doesn't have an associated value,
1440 printf(" %u=\"n.a.\"", cmd_line_index);
1445 protocolinfo_packet(void *prs, packet_info *pinfo _U_, epan_dissect_t *edt, const void *dummy _U_)
1447 pci_t *rs=(pci_t *)prs;
1451 gp=proto_get_finfo_ptr_array(edt->tree, rs->hf_index);
1458 * Print each occurrence of the field
1460 for (i = 0; i < gp->len; i++) {
1461 print_field_value((field_info *)gp->pdata[i], rs->cmd_line_index);
1467 int g_cmd_line_index = 0;
1470 * field must be persistent - we don't g_strdup() it below
1473 protocolinfo_init(char *field)
1476 header_field_info *hfi;
1477 GString *error_string;
1479 hfi=proto_registrar_get_byname(field);
1481 fprintf(stderr, "rawshark: Field \"%s\" doesn't exist.\n", field);
1485 switch (hfi->type) {
1487 case FT_ABSOLUTE_TIME:
1488 printf("%u %s %s - ",
1490 ftenum_to_string(hfi),
1491 absolute_time_display_e_to_string((absolute_time_display_e)hfi->display));
1495 printf("%u %s %s - ",
1497 ftenum_to_string(hfi),
1498 field_display_e_to_string((field_display_e)hfi->display));
1502 rs=(pci_t *)g_malloc(sizeof(pci_t));
1503 rs->hf_index=hfi->id;
1505 rs->cmd_line_index = g_cmd_line_index++;
1507 error_string=register_tap_listener("frame", rs, rs->filter, TL_REQUIRES_PROTO_TREE, NULL, protocolinfo_packet, NULL);
1509 /* error, we failed to attach to the tap. complain and clean up */
1510 fprintf(stderr, "rawshark: Couldn't register field extraction tap: %s\n",
1512 g_string_free(error_string, TRUE);
1523 * Given a format string, split it into a GPtrArray of string_fmt_t structs
1524 * and fill in string_fmt_parts.
1528 add_string_fmt(string_fmt_e format, gchar *plain) {
1529 string_fmt_t *sf = (string_fmt_t *)g_malloc(sizeof(string_fmt_t));
1531 sf->format = format;
1532 sf->plain = g_strdup(plain);
1534 g_ptr_array_add(string_fmts, sf);
1538 parse_field_string_format(gchar *format) {
1539 GString *plain_s = g_string_new("");
1547 len = strlen(format);
1548 g_ptr_array_set_size(string_fmts, 0);
1551 if (format[pos] == '%') {
1552 if (pos >= len) { /* There should always be a following character */
1556 if (plain_s->len > 0) {
1557 add_string_fmt(SF_NONE, plain_s->str);
1558 g_string_truncate(plain_s, 0);
1560 switch (format[pos]) {
1562 add_string_fmt(SF_NAME, NULL);
1565 add_string_fmt(SF_NUMVAL, NULL);
1568 add_string_fmt(SF_STRVAL, NULL);
1571 g_string_append_c(plain_s, '%');
1573 default: /* Invalid format */
1577 g_string_append_c(plain_s, format[pos]);
1582 if (plain_s->len > 0) {
1583 add_string_fmt(SF_NONE, plain_s->str);
1585 g_string_free(plain_s, TRUE);
1589 /****************************************************************************************
1590 * END OF FIELD EXTRACTION ROUTINES
1591 ****************************************************************************************/
1594 show_print_file_io_error(int err)
1599 cmdarg_err("Not all the packets could be printed because there is "
1600 "no space left on the file system.");
1605 cmdarg_err("Not all the packets could be printed because you are "
1606 "too close to, or over your disk quota.");
1611 cmdarg_err("An error occurred while printing packets: %s.",
1618 * Open/create errors are reported with an console message in Rawshark.
1621 open_failure_message(const char *filename, int err, gboolean for_writing)
1623 fprintf(stderr, "rawshark: ");
1624 fprintf(stderr, file_open_error_message(err, for_writing), filename);
1625 fprintf(stderr, "\n");
1628 static const nstime_t *
1629 raw_get_frame_ts(void *data _U_, guint32 frame_num)
1631 if (ref && ref->num == frame_num)
1632 return &ref->abs_ts;
1634 if (prev_dis && prev_dis->num == frame_num)
1635 return &prev_dis->abs_ts;
1637 if (prev_cap && prev_cap->num == frame_num)
1638 return &prev_cap->abs_ts;
1644 raw_epan_new(capture_file *cf)
1646 epan_t *epan = epan_new();
1649 epan->get_frame_ts = raw_get_frame_ts;
1650 epan->get_interface_name = cap_file_get_interface_name;
1651 epan->get_user_comment = NULL;
1657 raw_cf_open(capture_file *cf, const char *fname)
1659 if ((fd = raw_pipe_open(fname)) < 0)
1662 /* The open succeeded. Fill in the information for this file. */
1664 /* Create new epan session for dissection. */
1665 epan_free(cf->epan);
1666 cf->epan = raw_epan_new(cf);
1669 cf->f_datalen = 0; /* not used, but set it anyway */
1671 /* Set the file name because we need it to set the follow stream filter.
1672 XXX - is that still true? We need it for other reasons, though,
1674 cf->filename = g_strdup(fname);
1676 /* Indicate whether it's a permanent or temporary file. */
1677 cf->is_tempfile = FALSE;
1679 /* No user changes yet. */
1680 cf->unsaved_changes = FALSE;
1682 cf->cd_t = WTAP_FILE_TYPE_SUBTYPE_UNKNOWN;
1684 cf->drops_known = FALSE;
1686 cf->has_snap = FALSE;
1687 cf->snap = WTAP_MAX_PACKET_SIZE;
1688 nstime_set_zero(&cf->elapsed_time);
1698 * General errors are reported with an console message in Rawshark.
1701 failure_message(const char *msg_format, va_list ap)
1703 fprintf(stderr, "rawshark: ");
1704 vfprintf(stderr, msg_format, ap);
1705 fprintf(stderr, "\n");
1709 * Read errors are reported with an console message in Rawshark.
1712 read_failure_message(const char *filename, int err)
1714 cmdarg_err("An error occurred while reading from the file \"%s\": %s.",
1715 filename, g_strerror(err));
1719 * Write errors are reported with an console message in Rawshark.
1722 write_failure_message(const char *filename, int err)
1724 cmdarg_err("An error occurred while writing to the file \"%s\": %s.",
1725 filename, g_strerror(err));
1729 * Report an error in command-line arguments.
1732 cmdarg_err(const char *fmt, ...)
1737 fprintf(stderr, "rawshark: ");
1738 vfprintf(stderr, fmt, ap);
1739 fprintf(stderr, "\n");
1744 * Report additional information for an error in command-line arguments.
1747 cmdarg_err_cont(const char *fmt, ...)
1752 vfprintf(stderr, fmt, ap);
1753 fprintf(stderr, "\n");
1764 * indent-tabs-mode: nil
1767 * ex: set shiftwidth=4 tabstop=8 expandtab:
1768 * :indentSize=4:tabSize=8:noTabs=true: