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.
56 #ifdef HAVE_SYS_STAT_H
57 # include <sys/stat.h>
61 #include "wsutil/wsgetopt.h"
65 #include <epan/epan-int.h>
66 #include <epan/epan.h>
67 #include <wsutil/crash_info.h>
68 #include <wsutil/privileges.h>
69 #include <wsutil/file_util.h>
70 #include <wsutil/filesystem.h>
71 #include <wsutil/plugins.h>
72 #include <wsutil/report_err.h>
75 #include <epan/packet.h>
76 #include <epan/ftypes/ftypes-int.h>
78 #include "frame_tvbuff.h"
79 #include <epan/disabled_protos.h>
80 #include <epan/prefs.h>
81 #include <epan/column.h>
82 #include <epan/print.h>
83 #include <epan/addr_resolv.h>
85 #include "clopts_common.h"
86 #include "cmdarg_err.h"
87 #include "version_info.h"
89 #include "conditions.h"
90 #include "capture_stop_conditions.h"
91 #include "capture_ui_utils.h"
92 #include <epan/epan_dissect.h>
93 #include <epan/stat_cmd_args.h>
94 #include <epan/timestamp.h>
95 #include <wsutil/unicode-utils.h>
96 #include "epan/column-utils.h"
97 #include "epan/proto.h"
100 #include <wiretap/wtap.h>
101 #include <wiretap/libpcap.h>
102 #include <wiretap/pcap-encap.h>
106 #include "capture-pcap-util.h"
108 #include "capture-wpcap.h"
110 #endif /* HAVE_LIBPCAP */
114 #include <wsutil/unicode-utils.h>
119 * This is the template for the decode as option; it is shared between the
120 * various functions that output the usage for this parameter.
122 static const gchar decode_as_arg_template[] = "<layer_type>==<selector>,<decode_as_protocol>";
125 static guint32 cum_bytes;
126 static const frame_data *ref;
127 static frame_data ref_frame;
128 static frame_data *prev_dis;
129 static frame_data prev_dis_frame;
130 static frame_data *prev_cap;
131 static frame_data prev_cap_frame;
134 * The way the packet decode is to be written.
137 WRITE_TEXT, /* summary or detail text */
138 WRITE_XML /* PDML or PSML */
139 /* Add CSV and the like here */
142 static gboolean line_buffered;
143 static print_format_e print_format = PR_FMT_TEXT;
145 static gboolean want_pcap_pkthdr;
147 cf_status_t raw_cf_open(capture_file *cf, const char *fname);
148 static int load_cap_file(capture_file *cf);
149 static gboolean process_packet(capture_file *cf, epan_dissect_t *edt, gint64 offset,
150 struct wtap_pkthdr *whdr, const guchar *pd);
151 static void show_print_file_io_error(int err);
153 static void open_failure_message(const char *filename, int err,
154 gboolean for_writing);
155 static void failure_message(const char *msg_format, va_list ap);
156 static void read_failure_message(const char *filename, int err);
157 static void write_failure_message(const char *filename, int err);
158 static void protocolinfo_init(char *field);
159 static gboolean parse_field_string_format(char *format);
162 SF_NONE, /* No format (placeholder) */
163 SF_NAME, /* %D Field name / description */
164 SF_NUMVAL, /* %N Numeric value */
165 SF_STRVAL /* %S String value */
168 typedef struct string_fmt_s {
170 string_fmt_e format; /* Valid if plain is NULL */
176 dfilter_t *rfcodes[64];
178 dfilter_t *rfieldfcodes[64];
181 GPtrArray *string_fmts;
184 print_usage(gboolean print_ver)
191 "Rawshark " VERSION "%s\n"
192 "Dump and analyze network traffic.\n"
193 "See http://www.wireshark.org for more information.\n"
196 wireshark_gitversion, get_copyright_info());
200 fprintf(output, "\n");
201 fprintf(output, "Usage: rawshark [options] ...\n");
202 fprintf(output, "\n");
204 fprintf(output, "Input file:\n");
205 fprintf(output, " -r <infile> set the pipe or file name to read from\n");
207 fprintf(output, "\n");
208 fprintf(output, "Processing:\n");
209 fprintf(output, " -d <encap:linktype>|<proto:protoname>\n");
210 fprintf(output, " packet encapsulation or protocol\n");
211 fprintf(output, " -F <field> field to display\n");
212 fprintf(output, " -n disable all name resolution (def: all enabled)\n");
213 fprintf(output, " -N <name resolve flags> enable specific name resolution(s): \"mntC\"\n");
214 fprintf(output, " -p use the system's packet header format\n");
215 fprintf(output, " (which may have 64-bit timestamps)\n");
216 fprintf(output, " -R <read filter> packet filter in Wireshark display filter syntax\n");
217 fprintf(output, " -s skip PCAP header on input\n");
219 fprintf(output, "\n");
220 fprintf(output, "Output:\n");
221 fprintf(output, " -l flush output after each packet\n");
222 fprintf(output, " -S format string for fields\n");
223 fprintf(output, " (%%D - name, %%S - stringval, %%N numval)\n");
224 fprintf(output, " -t ad|a|r|d|dd|e output format of time stamps (def: r: rel. to first)\n");
226 fprintf(output, "\n");
227 fprintf(output, "Miscellaneous:\n");
228 fprintf(output, " -h display this help and exit\n");
229 fprintf(output, " -o <name>:<value> ... override preference setting\n");
230 fprintf(output, " -v display version info and exit\n");
234 log_func_ignore (const gchar *log_domain _U_, GLogLevelFlags log_level _U_,
235 const gchar *message _U_, gpointer user_data _U_)
240 * Open a pipe for raw input. This is a stripped-down version of
241 * pcap_loop.c:cap_pipe_open_live().
242 * We check if "pipe_name" is "-" (stdin) or a FIFO, and open it.
243 * @param pipe_name The name of the pipe or FIFO.
244 * @return A POSIX file descriptor on success, or -1 on failure.
247 raw_pipe_open(const char *pipe_name)
250 ws_statb64 pipe_stat;
252 char *pncopy, *pos = NULL;
259 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "open_raw_pipe: %s", pipe_name);
262 * XXX Rawshark blocks until we return
264 if (strcmp(pipe_name, "-") == 0) {
265 rfd = 0; /* read from stdin */
268 * This is needed to set the stdin pipe into binary mode, otherwise
269 * CR/LF are mangled...
271 _setmode(0, _O_BINARY);
275 if (ws_stat64(pipe_name, &pipe_stat) < 0) {
276 fprintf(stderr, "rawshark: The pipe %s could not be checked: %s\n",
277 pipe_name, g_strerror(errno));
280 if (! S_ISFIFO(pipe_stat.st_mode)) {
281 if (S_ISCHR(pipe_stat.st_mode)) {
283 * Assume the user specified an interface on a system where
284 * interfaces are in /dev. Pretend we haven't seen it.
288 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
293 rfd = ws_open(pipe_name, O_RDONLY | O_NONBLOCK, 0000 /* no creation so don't matter */);
295 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
296 pipe_name, g_strerror(errno));
300 #define PIPE_STR "\\pipe\\"
301 /* Under Windows, named pipes _must_ have the form
302 * "\\<server>\pipe\<pipe_name>". <server> may be "." for localhost.
304 pncopy = g_strdup(pipe_name);
305 if (strstr(pncopy, "\\\\") == pncopy) {
306 pos = strchr(pncopy + 3, '\\');
307 if (pos && g_ascii_strncasecmp(pos, PIPE_STR, strlen(PIPE_STR)) != 0)
314 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
319 /* Wait for the pipe to appear */
321 hPipe = CreateFile(utf_8to16(pipe_name), GENERIC_READ, 0, NULL,
322 OPEN_EXISTING, 0, NULL);
324 if (hPipe != INVALID_HANDLE_VALUE)
327 err = GetLastError();
328 if (err != ERROR_PIPE_BUSY) {
329 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
330 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
331 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s (error %d)\n",
332 pipe_name, utf_16to8(err_str), err);
337 if (!WaitNamedPipe(utf_8to16(pipe_name), 30 * 1000)) {
338 err = GetLastError();
339 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
340 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
341 fprintf(stderr, "rawshark: \"%s\" could not be waited for: %s (error %d)\n",
342 pipe_name, utf_16to8(err_str), err);
348 rfd = _open_osfhandle((long) hPipe, _O_RDONLY);
350 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
351 pipe_name, g_strerror(errno));
361 * Parse a link-type argument of the form "encap:<pcap linktype>" or
362 * "proto:<proto name>". "Pcap linktype" must be a name conforming to
363 * pcap_datalink_name_to_val() or an integer; the integer should be
364 * a LINKTYPE_ value supported by Wiretap. "Proto name" must be
365 * a protocol name, e.g. "http".
368 set_link_type(const char *lt_arg) {
369 char *spec_ptr = strchr(lt_arg, ':');
373 dissector_handle_t dhandle;
381 if (strncmp(lt_arg, "encap:", strlen("encap:")) == 0) {
382 dlt_val = linktype_name_to_val(spec_ptr);
385 val = strtol(spec_ptr, &p, 10);
386 if (p == spec_ptr || *p != '\0' || errno != 0 || val > INT_MAX) {
392 * In those cases where a given link-layer header type
393 * has different LINKTYPE_ and DLT_ values, linktype_name_to_val()
394 * will return the OS's DLT_ value for that link-layer header
395 * type, not its OS-independent LINKTYPE_ value.
397 * On a given OS, wtap_pcap_encap_to_wtap_encap() should
398 * be able to map either LINKTYPE_ values or DLT_ values
399 * for the OS to the appropriate Wiretap encapsulation.
401 encap = wtap_pcap_encap_to_wtap_encap(dlt_val);
402 if (encap == WTAP_ENCAP_UNKNOWN) {
406 } else if (strncmp(lt_arg, "proto:", strlen("proto:")) == 0) {
407 dhandle = find_dissector(spec_ptr);
409 encap = WTAP_ENCAP_USER0;
410 pref_str = g_string_new("uat:user_dlts:");
411 /* This must match the format used in the user_dlts file */
412 g_string_append_printf(pref_str,
413 "\"User 0 (DLT=147)\",\"%s\",\"0\",\"\",\"0\",\"\"",
415 if (prefs_set_pref(pref_str->str) != PREFS_SET_OK) {
416 g_string_free(pref_str, TRUE);
419 g_string_free(pref_str, TRUE);
427 show_version(GString *comp_info_str, GString *runtime_info_str)
429 printf("Rawshark " VERSION "%s\n"
436 wireshark_gitversion, get_copyright_info(), comp_info_str->str,
437 runtime_info_str->str);
441 main(int argc, char *argv[])
443 GString *comp_info_str;
444 GString *runtime_info_str;
445 char *init_progfile_dir_error;
447 gboolean arg_error = FALSE;
453 char *gpf_path, *pf_path;
454 char *gdp_path, *dp_path;
455 int gpf_open_errno, gpf_read_errno;
456 int pf_open_errno, pf_read_errno;
457 int gdp_open_errno, gdp_read_errno;
458 int dp_open_errno, dp_read_errno;
460 gchar *pipe_name = NULL;
465 GPtrArray *disp_fields = g_ptr_array_new();
467 gboolean skip_pcap_header = FALSE;
469 #define OPTSTRING_INIT "d:F:hlnN:o:pr:R:sS:t:v"
471 static const char optstring[] = OPTSTRING_INIT;
473 /* Assemble the compile-time version information string */
474 comp_info_str = g_string_new("Compiled ");
475 get_compiled_version_info(comp_info_str, NULL, epan_get_compiled_version_info);
477 /* Assemble the run-time version information string */
478 runtime_info_str = g_string_new("Running ");
479 get_runtime_version_info(runtime_info_str, NULL);
481 /* Add it to the information to be reported on a crash. */
482 ws_add_crash_info("Rawshark " VERSION "%s\n"
487 wireshark_gitversion, comp_info_str->str, runtime_info_str->str);
490 arg_list_utf_16to8(argc, argv);
491 create_app_running_mutex();
495 * Get credential information for later use.
497 init_process_policies();
500 * Clear the filters arrays
502 memset(rfilters, 0, sizeof(rfilters));
503 memset(rfcodes, 0, sizeof(rfcodes));
508 * Initialize our string format
510 string_fmts = g_ptr_array_new();
513 * Attempt to get the pathname of the executable file.
515 init_progfile_dir_error = init_progfile_dir(argv[0], main);
516 if (init_progfile_dir_error != NULL) {
517 fprintf(stderr, "rawshark: Can't get pathname of rawshark program: %s.\n",
518 init_progfile_dir_error);
522 * Get credential information for later use.
524 init_process_policies();
526 /* nothing more than the standard GLib handler, but without a warning */
528 G_LOG_LEVEL_WARNING |
529 G_LOG_LEVEL_MESSAGE |
533 g_log_set_handler(NULL,
534 (GLogLevelFlags)log_flags,
535 log_func_ignore, NULL /* user_data */);
536 g_log_set_handler(LOG_DOMAIN_CAPTURE_CHILD,
537 (GLogLevelFlags)log_flags,
538 log_func_ignore, NULL /* user_data */);
540 init_report_err(failure_message, open_failure_message, read_failure_message,
541 write_failure_message);
543 timestamp_set_type(TS_RELATIVE);
544 timestamp_set_precision(TS_PREC_AUTO);
545 timestamp_set_seconds_type(TS_SECONDS_DEFAULT);
547 /* Register all dissectors; we must do this before checking for the
548 "-G" flag, as the "-G" flag dumps information registered by the
549 dissectors, and we must do it before we read the preferences, in
550 case any dissectors register preferences. */
551 epan_init(register_all_protocols, register_all_protocol_handoffs, NULL, NULL);
553 /* Set the C-language locale to the native environment. */
554 setlocale(LC_ALL, "");
556 prefs_p = read_prefs(&gpf_open_errno, &gpf_read_errno, &gpf_path,
557 &pf_open_errno, &pf_read_errno, &pf_path);
558 if (gpf_path != NULL) {
559 if (gpf_open_errno != 0) {
560 cmdarg_err("Can't open global preferences file \"%s\": %s.",
561 pf_path, g_strerror(gpf_open_errno));
563 if (gpf_read_errno != 0) {
564 cmdarg_err("I/O error reading global preferences file \"%s\": %s.",
565 pf_path, g_strerror(gpf_read_errno));
568 if (pf_path != NULL) {
569 if (pf_open_errno != 0) {
570 cmdarg_err("Can't open your preferences file \"%s\": %s.", pf_path,
571 g_strerror(pf_open_errno));
573 if (pf_read_errno != 0) {
574 cmdarg_err("I/O error reading your preferences file \"%s\": %s.",
575 pf_path, g_strerror(pf_read_errno));
581 /* Read the disabled protocols file. */
582 read_disabled_protos_list(&gdp_path, &gdp_open_errno, &gdp_read_errno,
583 &dp_path, &dp_open_errno, &dp_read_errno);
584 if (gdp_path != NULL) {
585 if (gdp_open_errno != 0) {
586 cmdarg_err("Could not open global disabled protocols file\n\"%s\": %s.",
587 gdp_path, g_strerror(gdp_open_errno));
589 if (gdp_read_errno != 0) {
590 cmdarg_err("I/O error reading global disabled protocols file\n\"%s\": %s.",
591 gdp_path, g_strerror(gdp_read_errno));
595 if (dp_path != NULL) {
596 if (dp_open_errno != 0) {
598 "Could not open your disabled protocols file\n\"%s\": %s.", dp_path,
599 g_strerror(dp_open_errno));
601 if (dp_read_errno != 0) {
603 "I/O error reading your disabled protocols file\n\"%s\": %s.", dp_path,
604 g_strerror(dp_read_errno));
610 /* Load Wpcap, if possible */
614 cap_file_init(&cfile);
616 /* Print format defaults to this. */
617 print_format = PR_FMT_TEXT;
619 /* Initialize our encapsulation type */
620 encap = WTAP_ENCAP_UNKNOWN;
622 /* Now get our args */
623 /* XXX - We should probably have an option to dump libpcap link types */
624 while ((opt = getopt(argc, argv, optstring)) != -1) {
626 case 'd': /* Payload type */
627 if (!set_link_type(optarg)) {
628 cmdarg_err("Invalid link type or protocol \"%s\"", optarg);
632 case 'F': /* Read field to display */
633 g_ptr_array_add(disp_fields, g_strdup(optarg));
635 case 'h': /* Print help and exit */
639 case 'l': /* "Line-buffer" standard output */
640 /* This isn't line-buffering, strictly speaking, it's just
641 flushing the standard output after the information for
642 each packet is printed; however, that should be good
643 enough for all the purposes to which "-l" is put (and
644 is probably actually better for "-V", as it does fewer
647 See the comment in "process_packet()" for an explanation of
648 why we do that, and why we don't just use "setvbuf()" to
649 make the standard output line-buffered (short version: in
650 Windows, "line-buffered" is the same as "fully-buffered",
651 and the output buffer is only flushed when it fills up). */
652 line_buffered = TRUE;
654 case 'n': /* No name resolution */
655 gbl_resolv_flags.mac_name = FALSE;
656 gbl_resolv_flags.network_name = FALSE;
657 gbl_resolv_flags.transport_name = FALSE;
658 gbl_resolv_flags.concurrent_dns = FALSE;
660 case 'N': /* Select what types of addresses/port #s to resolve */
661 badopt = string_to_name_resolve(optarg, &gbl_resolv_flags);
662 if (badopt != '\0') {
663 cmdarg_err("-N specifies unknown resolving option '%c'; valid options are 'm', 'n', and 't'",
668 case 'o': /* Override preference from command line */
669 switch (prefs_set_pref(optarg)) {
674 case PREFS_SET_SYNTAX_ERR:
675 cmdarg_err("Invalid -o flag \"%s\"", optarg);
679 case PREFS_SET_NO_SUCH_PREF:
680 case PREFS_SET_OBSOLETE:
681 cmdarg_err("-o flag \"%s\" specifies unknown preference", optarg);
686 case 'p': /* Expect pcap_pkthdr packet headers, which may have 64-bit timestamps */
687 want_pcap_pkthdr = TRUE;
689 case 'r': /* Read capture file xxx */
690 pipe_name = g_strdup(optarg);
692 case 'R': /* Read file filter */
693 if(n_rfilters < (int) sizeof(rfilters) / (int) sizeof(rfilters[0])) {
694 rfilters[n_rfilters++] = optarg;
697 cmdarg_err("Too many display filters");
701 case 's': /* Skip PCAP header */
702 skip_pcap_header = TRUE;
704 case 'S': /* Print string representations */
705 if (!parse_field_string_format(optarg)) {
706 cmdarg_err("Invalid field string format");
710 case 't': /* Time stamp type */
711 if (strcmp(optarg, "r") == 0)
712 timestamp_set_type(TS_RELATIVE);
713 else if (strcmp(optarg, "a") == 0)
714 timestamp_set_type(TS_ABSOLUTE);
715 else if (strcmp(optarg, "ad") == 0)
716 timestamp_set_type(TS_ABSOLUTE_WITH_YMD);
717 else if (strcmp(optarg, "adoy") == 0)
718 timestamp_set_type(TS_ABSOLUTE_WITH_YDOY);
719 else if (strcmp(optarg, "d") == 0)
720 timestamp_set_type(TS_DELTA);
721 else if (strcmp(optarg, "dd") == 0)
722 timestamp_set_type(TS_DELTA_DIS);
723 else if (strcmp(optarg, "e") == 0)
724 timestamp_set_type(TS_EPOCH);
725 else if (strcmp(optarg, "u") == 0)
726 timestamp_set_type(TS_UTC);
727 else if (strcmp(optarg, "ud") == 0)
728 timestamp_set_type(TS_UTC_WITH_YMD);
729 else if (strcmp(optarg, "udoy") == 0)
730 timestamp_set_type(TS_UTC_WITH_YDOY);
732 cmdarg_err("Invalid time stamp type \"%s\"",
735 "It must be \"a\" for absolute, \"ad\" for absolute with YYYY-MM-DD date,");
737 "\"adoy\" for absolute with YYYY/DOY date, \"d\" for delta,");
739 "\"dd\" for delta displayed, \"e\" for epoch, \"r\" for relative,");
741 "\"u\" for absolute UTC, \"ud\" for absolute UTC with YYYY-MM-DD date,");
743 "or \"udoy\" for absolute UTC with YYYY/DOY date.");
747 case 'v': /* Show version and exit */
749 show_version(comp_info_str, runtime_info_str);
750 g_string_free(comp_info_str, TRUE);
751 g_string_free(runtime_info_str, TRUE);
756 case '?': /* Bad flag - print usage message */
763 /* Notify all registered modules that have had any of their preferences
764 changed either from one of the preferences file or from the command
765 line that their preferences have changed.
766 Initialize preferences before display filters, otherwise modules
767 like MATE won't work. */
770 /* Initialize our display fields */
771 for (fc = 0; fc < disp_fields->len; fc++) {
772 protocolinfo_init((char *)g_ptr_array_index(disp_fields, fc));
774 g_ptr_array_free(disp_fields, TRUE);
778 /* If no capture filter or read filter has been specified, and there are
779 still command-line arguments, treat them as the tokens of a capture
780 filter (if no "-r" flag was specified) or a read filter (if a "-r"
781 flag was specified. */
783 if (pipe_name != NULL) {
784 if (n_rfilters != 0) {
785 cmdarg_err("Read filters were specified both with \"-R\" "
786 "and with additional command-line arguments");
789 rfilters[n_rfilters] = get_args_as_string(argc, argv, optind);
793 /* Make sure we got a dissector handle for our payload. */
794 if (encap == WTAP_ENCAP_UNKNOWN) {
795 cmdarg_err("No valid payload dissector specified.");
806 /* Start windows sockets */
807 WSAStartup( MAKEWORD( 1, 1 ), &wsaData );
810 /* At this point MATE will have registered its field array so we can
811 have a tap filter with one of MATE's late-registered fields as part
812 of the filter. We can now process all the "-z" arguments. */
813 start_requested_stats();
815 /* disabled protocols as per configuration file */
816 if (gdp_path == NULL && dp_path == NULL) {
817 set_disabled_protos_list();
820 /* Build the column format array */
821 build_column_format_array(&cfile.cinfo, prefs_p->num_cols, TRUE);
823 if (n_rfilters != 0) {
824 for (i = 0; i < n_rfilters; i++) {
825 if (!dfilter_compile(rfilters[i], &rfcodes[n_rfcodes])) {
826 cmdarg_err("%s", dfilter_error_msg);
827 epan_free(cfile.epan);
837 * We're reading a pipe (or capture file).
841 * Immediately relinquish any special privileges we have; we must not
842 * be allowed to read any capture files the user running Rawshark
845 relinquish_special_privs_perm();
847 if (raw_cf_open(&cfile, pipe_name) != CF_OK) {
848 epan_free(cfile.epan);
853 /* Do we need to PCAP header and magic? */
854 if (skip_pcap_header) {
855 size_t bytes_left = sizeof(struct pcap_hdr) + sizeof(guint32);
856 gchar buf[sizeof(struct pcap_hdr) + sizeof(guint32)];
857 while (bytes_left != 0) {
858 ssize_t bytes = read(fd, buf, (int)bytes_left);
860 cmdarg_err("Not enough bytes for pcap header.");
867 /* Set timestamp precision; there should arguably be a command-line
868 option to let the user set this. */
870 switch(wtap_file_tsprecision(cfile.wth)) {
871 case(WTAP_FILE_TSPREC_SEC):
872 timestamp_set_precision(TS_PREC_AUTO_SEC);
874 case(WTAP_FILE_TSPREC_DSEC):
875 timestamp_set_precision(TS_PREC_AUTO_DSEC);
877 case(WTAP_FILE_TSPREC_CSEC):
878 timestamp_set_precision(TS_PREC_AUTO_CSEC);
880 case(WTAP_FILE_TSPREC_MSEC):
881 timestamp_set_precision(TS_PREC_AUTO_MSEC);
883 case(WTAP_FILE_TSPREC_USEC):
884 timestamp_set_precision(TS_PREC_AUTO_USEC);
886 case(WTAP_FILE_TSPREC_NSEC):
887 timestamp_set_precision(TS_PREC_AUTO_NSEC);
890 g_assert_not_reached();
893 timestamp_set_precision(TS_PREC_AUTO_USEC);
896 /* Process the packets in the file */
897 err = load_cap_file(&cfile);
900 epan_free(cfile.epan);
905 /* If you want to capture live packets, use TShark. */
906 cmdarg_err("Input file or pipe name not specified.");
910 epan_free(cfile.epan);
917 * Read data from a raw pipe. The "raw" data consists of a libpcap
918 * packet header followed by the payload.
919 * @param pd [IN] A POSIX file descriptor. Because that's _exactly_ the sort
920 * of thing you want to use in Windows.
921 * @param phdr [OUT] Packet header information.
922 * @param err [OUT] Error indicator. Uses wiretap values.
923 * @param err_info [OUT] Error message.
924 * @param data_offset [OUT] data offset in the pipe.
925 * @return TRUE on success, FALSE on failure.
928 raw_pipe_read(struct wtap_pkthdr *phdr, guchar * pd, int *err, const gchar **err_info, gint64 *data_offset) {
929 struct pcap_pkthdr mem_hdr;
930 struct pcaprec_hdr disk_hdr;
931 ssize_t bytes_read = 0;
932 size_t bytes_needed = sizeof(disk_hdr);
933 guchar *ptr = (guchar*) &disk_hdr;
934 static gchar err_str[100];
936 if (want_pcap_pkthdr) {
937 bytes_needed = sizeof(mem_hdr);
938 ptr = (guchar*) &mem_hdr;
941 /* Copied from capture_loop.c */
942 while (bytes_needed > 0) {
943 bytes_read = read(fd, ptr, (int)bytes_needed);
944 if (bytes_read == 0) {
947 } else if (bytes_read < 0) {
948 *err = WTAP_ERR_CANT_READ;
949 *err_info = "Error reading header from pipe";
952 bytes_needed -= bytes_read;
953 *data_offset += bytes_read;
957 if (want_pcap_pkthdr) {
958 phdr->ts.secs = mem_hdr.ts.tv_sec;
959 phdr->ts.nsecs = (gint32)mem_hdr.ts.tv_usec * 1000;
960 phdr->caplen = mem_hdr.caplen;
961 phdr->len = mem_hdr.len;
963 phdr->ts.secs = disk_hdr.ts_sec;
964 phdr->ts.nsecs = disk_hdr.ts_usec * 1000;
965 phdr->caplen = disk_hdr.incl_len;
966 phdr->len = disk_hdr.orig_len;
968 bytes_needed = phdr->caplen;
970 phdr->pkt_encap = encap;
973 printf("mem_hdr: %lu disk_hdr: %lu\n", sizeof(mem_hdr), sizeof(disk_hdr));
974 printf("tv_sec: %u (%04x)\n", (unsigned int) phdr->ts.secs, (unsigned int) phdr->ts.secs);
975 printf("tv_nsec: %d (%04x)\n", phdr->ts.nsecs, phdr->ts.nsecs);
976 printf("caplen: %d (%04x)\n", phdr->caplen, phdr->caplen);
977 printf("len: %d (%04x)\n", phdr->len, phdr->len);
979 if (bytes_needed > WTAP_MAX_PACKET_SIZE) {
980 *err = WTAP_ERR_BAD_FILE;
981 g_snprintf(err_str, 100, "Bad packet length: %lu\n",
982 (unsigned long) bytes_needed);
988 while (bytes_needed > 0) {
989 bytes_read = read(fd, ptr, (int)bytes_needed);
990 if (bytes_read == 0) {
991 *err = WTAP_ERR_SHORT_READ;
992 *err_info = "Got zero bytes reading data from pipe";
994 } else if (bytes_read < 0) {
995 *err = WTAP_ERR_CANT_READ;
996 *err_info = "Error reading data from pipe";
999 bytes_needed -= bytes_read;
1000 *data_offset += bytes_read;
1007 load_cap_file(capture_file *cf)
1010 const gchar *err_info;
1011 gint64 data_offset = 0;
1013 guchar pd[WTAP_MAX_PACKET_SIZE];
1014 struct wtap_pkthdr phdr;
1017 memset(&phdr, 0, sizeof(phdr));
1019 epan_dissect_init(&edt, cf->epan, TRUE, FALSE);
1021 while (raw_pipe_read(&phdr, pd, &err, &err_info, &data_offset)) {
1022 process_packet(cf, &edt, data_offset, &phdr, pd);
1025 epan_dissect_cleanup(&edt);
1028 /* Print a message noting that the read failed somewhere along the line. */
1031 case WTAP_ERR_UNSUPPORTED_ENCAP:
1032 cmdarg_err("The file \"%s\" has a packet with a network type that Rawshark doesn't support.\n(%s)",
1033 cf->filename, err_info);
1036 case WTAP_ERR_CANT_READ:
1037 cmdarg_err("An attempt to read from the file \"%s\" failed for some unknown reason.",
1041 case WTAP_ERR_SHORT_READ:
1042 cmdarg_err("The file \"%s\" appears to have been cut short in the middle of a packet.",
1046 case WTAP_ERR_BAD_FILE:
1047 cmdarg_err("The file \"%s\" appears to be damaged or corrupt.\n(%s)",
1048 cf->filename, err_info);
1051 case WTAP_ERR_DECOMPRESS:
1052 cmdarg_err("The compressed file \"%s\" appears to be damaged or corrupt.\n(%s)",
1053 cf->filename, err_info);
1057 cmdarg_err("An error occurred while reading the file \"%s\": %s.",
1058 cf->filename, wtap_strerror(err));
1067 process_packet(capture_file *cf, epan_dissect_t *edt, gint64 offset,
1068 struct wtap_pkthdr *whdr, const guchar *pd)
1076 /* The user sends an empty packet when he wants to get output from us even if we don't currently have
1077 packets to process. We spit out a line with the timestamp and the text "void"
1079 printf("%lu %lu %lu void -\n", (unsigned long int)cf->count,
1080 (unsigned long int)whdr->ts.secs,
1081 (unsigned long int)whdr->ts.nsecs);
1088 /* Count this packet. */
1091 /* If we're going to print packet information, or we're going to
1092 run a read filter, or we're going to process taps, set up to
1093 do a dissection and do so. */
1094 frame_data_init(&fdata, cf->count, whdr, offset, cum_bytes);
1098 /* If we're running a read filter, prime the epan_dissect_t with that
1100 if (n_rfilters > 0) {
1101 for(i = 0; i < n_rfcodes; i++) {
1102 epan_dissect_prime_dfilter(edt, rfcodes[i]);
1106 printf("%lu", (unsigned long int) cf->count);
1108 frame_data_set_before_dissect(&fdata, &cf->elapsed_time,
1111 if (ref == &fdata) {
1116 /* We only need the columns if we're printing packet info but we're
1117 *not* verbose; in verbose mode, we print the protocol tree, not
1118 the protocol summary. */
1119 epan_dissect_run_with_taps(edt, whdr, frame_tvbuff_new(&fdata, pd), &fdata, &cf->cinfo);
1121 frame_data_set_after_dissect(&fdata, &cum_bytes);
1122 prev_dis_frame = fdata;
1123 prev_dis = &prev_dis_frame;
1125 prev_cap_frame = fdata;
1126 prev_cap = &prev_cap_frame;
1128 for(i = 0; i < n_rfilters; i++) {
1129 /* Run the read filter if we have one. */
1131 passed = dfilter_apply_edt(rfcodes[i], edt);
1135 /* Print a one-line summary */
1136 printf(" %u", passed ? 1 : 0);
1141 /* The ANSI C standard does not appear to *require* that a line-buffered
1142 stream be flushed to the host environment whenever a newline is
1143 written, it just says that, on such a stream, characters "are
1144 intended to be transmitted to or from the host environment as a
1145 block when a new-line character is encountered".
1147 The Visual C++ 6.0 C implementation doesn't do what is intended;
1148 even if you set a stream to be line-buffered, it still doesn't
1149 flush the buffer at the end of every line.
1151 So, if the "-l" flag was specified, we flush the standard output
1152 at the end of a packet. This will do the right thing if we're
1153 printing packet summary lines, and, as we print the entire protocol
1154 tree for a single packet without waiting for anything to happen,
1155 it should be as good as line-buffered mode if we're printing
1156 protocol trees. (The whole reason for the "-l" flag in either
1157 tcpdump or Rawshark is to allow the output of a live capture to
1158 be piped to a program or script and to have that script see the
1159 information for the packet as soon as it's printed, rather than
1160 having to wait until a standard I/O buffer fills up. */
1164 if (ferror(stdout)) {
1165 show_print_file_io_error(errno);
1169 epan_dissect_reset(edt);
1170 frame_data_destroy(&fdata);
1175 /****************************************************************************************
1176 * FIELD EXTRACTION ROUTINES
1177 ****************************************************************************************/
1178 typedef struct _pci_t {
1184 static const char* ftenum_to_string(header_field_info *hfi)
1190 if (string_fmts->len > 0 && hfi->strings) {
1198 return "FT_PROTOCOL";
1200 return "FT_BOOLEAN";
1225 case FT_ABSOLUTE_TIME:
1226 return "FT_ABSOLUTE_TIME";
1227 case FT_RELATIVE_TIME:
1228 return "FT_RELATIVE_TIME";
1232 return "FT_STRINGZ";
1233 case FT_UINT_STRING:
1234 return "FT_UINT_STRING";
1240 return "FT_UINT_BYTES";
1248 return "FT_FRAMENUM";
1256 return "FT_REL_OID";
1258 return "FT_SYSTEM_ID";
1260 return "FT_NUM_TYPES";
1266 static const char* absolute_time_display_e_to_string(absolute_time_display_e atd)
1269 case ABSOLUTE_TIME_LOCAL:
1270 return "ABSOLUTE_TIME_LOCAL";
1271 case ABSOLUTE_TIME_UTC:
1272 return "ABSOLUTE_TIME_UTC";
1278 static const char* field_display_e_to_string(field_display_e bd)
1290 return "BASE_DEC_HEX";
1292 return "BASE_HEX_DEC";
1299 * Copied from various parts of proto.c
1301 #define FIELD_STR_INIT_LEN 256
1302 #define cVALS(x) (const value_string*)(x)
1303 static gboolean print_field_value(field_info *finfo, int cmd_line_index)
1305 header_field_info *hfinfo;
1306 static char *fs_buf = NULL;
1307 char *fs_ptr = fs_buf;
1308 static GString *label_s = NULL;
1309 int fs_buf_len = FIELD_STR_INIT_LEN, fs_len;
1316 const true_false_string *tfstring = &tfs_true_false;
1318 hfinfo = finfo->hfinfo;
1321 fs_buf = (char *)g_malloc(fs_buf_len + 1);
1326 label_s = g_string_new("");
1329 if(finfo->value.ftype->val_to_string_repr)
1332 * this field has an associated value,
1335 fs_len = fvalue_string_repr_len(&finfo->value, FTREPR_DFILTER);
1336 while (fs_buf_len < fs_len) {
1338 fs_buf = (char *)g_realloc(fs_buf, fs_buf_len + 1);
1341 fvalue_to_string_repr(&finfo->value,
1345 /* String types are quoted. Remove them. */
1346 if ((finfo->value.ftype->ftype == FT_STRING || finfo->value.ftype->ftype == FT_STRINGZ) && fs_len > 2) {
1347 fs_buf[fs_len - 1] = '\0';
1352 if (string_fmts->len > 0 && finfo->hfinfo->strings) {
1353 g_string_truncate(label_s, 0);
1354 for (i = 0; i < string_fmts->len; i++) {
1355 sf = (string_fmt_t *)g_ptr_array_index(string_fmts, i);
1357 g_string_append(label_s, sf->plain);
1359 switch (sf->format) {
1361 g_string_append(label_s, hfinfo->name);
1364 g_string_append(label_s, fs_ptr);
1367 switch(hfinfo->type) {
1369 uvalue = fvalue_get_uinteger(&finfo->value);
1370 tfstring = (const struct true_false_string*) hfinfo->strings;
1371 g_string_append(label_s, uvalue ? tfstring->true_string : tfstring->false_string);
1377 DISSECTOR_ASSERT(!hfinfo->bitmask);
1378 svalue = fvalue_get_sinteger(&finfo->value);
1379 if (hfinfo->display & BASE_RANGE_STRING) {
1380 g_string_append(label_s, rval_to_str_const(svalue, RVALS(hfinfo->strings), "Unknown"));
1381 } else if (hfinfo->display & BASE_EXT_STRING) {
1382 g_string_append(label_s, val_to_str_ext_const(svalue, (const value_string_ext *) hfinfo->strings, "Unknown"));
1384 g_string_append(label_s, val_to_str_const(svalue, cVALS(hfinfo->strings), "Unknown"));
1388 DISSECTOR_ASSERT(!hfinfo->bitmask);
1389 svalue64 = (gint64)fvalue_get_integer64(&finfo->value);
1390 if (hfinfo->display & BASE_VAL64_STRING) {
1391 g_string_append(label_s, val64_to_str_const(svalue64, (const val64_string *)(hfinfo->strings), "Unknown"));
1398 uvalue = fvalue_get_uinteger(&finfo->value);
1399 if (!hfinfo->bitmask && hfinfo->display & BASE_RANGE_STRING) {
1400 g_string_append(label_s, rval_to_str_const(uvalue, RVALS(hfinfo->strings), "Unknown"));
1401 } else if (hfinfo->display & BASE_EXT_STRING) {
1402 g_string_append(label_s, val_to_str_ext_const(uvalue, (const value_string_ext *) hfinfo->strings, "Unknown"));
1404 g_string_append(label_s, val_to_str_const(uvalue, cVALS(hfinfo->strings), "Unknown"));
1408 DISSECTOR_ASSERT(!hfinfo->bitmask);
1409 uvalue64 = fvalue_get_integer64(&finfo->value);
1410 if (hfinfo->display & BASE_VAL64_STRING) {
1411 g_string_append(label_s, val64_to_str_const(uvalue64, (const val64_string *)(hfinfo->strings), "Unknown"));
1423 printf(" %u=\"%s\"", cmd_line_index, label_s->str);
1427 if(finfo->value.ftype->val_to_string_repr)
1429 printf(" %u=\"%s\"", cmd_line_index, fs_ptr);
1434 * This field doesn't have an associated value,
1438 printf(" %u=\"n.a.\"", cmd_line_index);
1443 protocolinfo_packet(void *prs, packet_info *pinfo _U_, epan_dissect_t *edt, const void *dummy _U_)
1445 pci_t *rs=(pci_t *)prs;
1449 gp=proto_get_finfo_ptr_array(edt->tree, rs->hf_index);
1456 * Print each occurrence of the field
1458 for (i = 0; i < gp->len; i++) {
1459 print_field_value((field_info *)gp->pdata[i], rs->cmd_line_index);
1465 int g_cmd_line_index = 0;
1468 * field must be persistent - we don't g_strdup() it below
1471 protocolinfo_init(char *field)
1474 header_field_info *hfi;
1475 GString *error_string;
1477 hfi=proto_registrar_get_byname(field);
1479 fprintf(stderr, "rawshark: Field \"%s\" doesn't exist.\n", field);
1483 switch (hfi->type) {
1485 case FT_ABSOLUTE_TIME:
1486 printf("%u %s %s - ",
1488 ftenum_to_string(hfi),
1489 absolute_time_display_e_to_string((absolute_time_display_e)hfi->display));
1493 printf("%u %s %s - ",
1495 ftenum_to_string(hfi),
1496 field_display_e_to_string((field_display_e)hfi->display));
1500 rs=(pci_t *)g_malloc(sizeof(pci_t));
1501 rs->hf_index=hfi->id;
1503 rs->cmd_line_index = g_cmd_line_index++;
1505 error_string=register_tap_listener("frame", rs, rs->filter, TL_REQUIRES_PROTO_TREE, NULL, protocolinfo_packet, NULL);
1507 /* error, we failed to attach to the tap. complain and clean up */
1508 fprintf(stderr, "rawshark: Couldn't register field extraction tap: %s\n",
1510 g_string_free(error_string, TRUE);
1521 * Given a format string, split it into a GPtrArray of string_fmt_t structs
1522 * and fill in string_fmt_parts.
1526 add_string_fmt(string_fmt_e format, gchar *plain) {
1527 string_fmt_t *sf = (string_fmt_t *)g_malloc(sizeof(string_fmt_t));
1529 sf->format = format;
1530 sf->plain = g_strdup(plain);
1532 g_ptr_array_add(string_fmts, sf);
1536 parse_field_string_format(gchar *format) {
1537 GString *plain_s = g_string_new("");
1545 len = strlen(format);
1546 g_ptr_array_set_size(string_fmts, 0);
1549 if (format[pos] == '%') {
1550 if (pos >= len) { /* There should always be a following character */
1554 if (plain_s->len > 0) {
1555 add_string_fmt(SF_NONE, plain_s->str);
1556 g_string_truncate(plain_s, 0);
1558 switch (format[pos]) {
1560 add_string_fmt(SF_NAME, NULL);
1563 add_string_fmt(SF_NUMVAL, NULL);
1566 add_string_fmt(SF_STRVAL, NULL);
1569 g_string_append_c(plain_s, '%');
1571 default: /* Invalid format */
1575 g_string_append_c(plain_s, format[pos]);
1580 if (plain_s->len > 0) {
1581 add_string_fmt(SF_NONE, plain_s->str);
1583 g_string_free(plain_s, TRUE);
1587 /****************************************************************************************
1588 * END OF FIELD EXTRACTION ROUTINES
1589 ****************************************************************************************/
1592 show_print_file_io_error(int err)
1597 cmdarg_err("Not all the packets could be printed because there is "
1598 "no space left on the file system.");
1603 cmdarg_err("Not all the packets could be printed because you are "
1604 "too close to, or over your disk quota.");
1609 cmdarg_err("An error occurred while printing packets: %s.",
1616 * Open/create errors are reported with an console message in Rawshark.
1619 open_failure_message(const char *filename, int err, gboolean for_writing)
1621 fprintf(stderr, "rawshark: ");
1622 fprintf(stderr, file_open_error_message(err, for_writing), filename);
1623 fprintf(stderr, "\n");
1626 static const nstime_t *
1627 raw_get_frame_ts(void *data _U_, guint32 frame_num)
1629 if (ref && ref->num == frame_num)
1630 return &ref->abs_ts;
1632 if (prev_dis && prev_dis->num == frame_num)
1633 return &prev_dis->abs_ts;
1635 if (prev_cap && prev_cap->num == frame_num)
1636 return &prev_cap->abs_ts;
1642 raw_epan_new(capture_file *cf)
1644 epan_t *epan = epan_new();
1647 epan->get_frame_ts = raw_get_frame_ts;
1648 epan->get_interface_name = cap_file_get_interface_name;
1649 epan->get_user_comment = NULL;
1655 raw_cf_open(capture_file *cf, const char *fname)
1657 if ((fd = raw_pipe_open(fname)) < 0)
1660 /* The open succeeded. Fill in the information for this file. */
1662 /* Create new epan session for dissection. */
1663 epan_free(cf->epan);
1664 cf->epan = raw_epan_new(cf);
1667 cf->f_datalen = 0; /* not used, but set it anyway */
1669 /* Set the file name because we need it to set the follow stream filter.
1670 XXX - is that still true? We need it for other reasons, though,
1672 cf->filename = g_strdup(fname);
1674 /* Indicate whether it's a permanent or temporary file. */
1675 cf->is_tempfile = FALSE;
1677 /* No user changes yet. */
1678 cf->unsaved_changes = FALSE;
1680 cf->cd_t = WTAP_FILE_TYPE_SUBTYPE_UNKNOWN;
1681 cf->open_type = WTAP_TYPE_AUTO;
1683 cf->drops_known = FALSE;
1685 cf->has_snap = FALSE;
1686 cf->snap = WTAP_MAX_PACKET_SIZE;
1687 nstime_set_zero(&cf->elapsed_time);
1697 * General errors are reported with an console message in Rawshark.
1700 failure_message(const char *msg_format, va_list ap)
1702 fprintf(stderr, "rawshark: ");
1703 vfprintf(stderr, msg_format, ap);
1704 fprintf(stderr, "\n");
1708 * Read errors are reported with an console message in Rawshark.
1711 read_failure_message(const char *filename, int err)
1713 cmdarg_err("An error occurred while reading from the file \"%s\": %s.",
1714 filename, g_strerror(err));
1718 * Write errors are reported with an console message in Rawshark.
1721 write_failure_message(const char *filename, int err)
1723 cmdarg_err("An error occurred while writing to the file \"%s\": %s.",
1724 filename, g_strerror(err));
1728 * Report an error in command-line arguments.
1731 cmdarg_err(const char *fmt, ...)
1736 fprintf(stderr, "rawshark: ");
1737 vfprintf(stderr, fmt, ap);
1738 fprintf(stderr, "\n");
1743 * Report additional information for an error in command-line arguments.
1746 cmdarg_err_cont(const char *fmt, ...)
1751 vfprintf(stderr, fmt, ap);
1752 fprintf(stderr, "\n");
1763 * indent-tabs-mode: nil
1766 * ex: set shiftwidth=4 tabstop=8 expandtab:
1767 * :indentSize=4:tabSize=8:noTabs=true: