3 * Wireshark - Network traffic analyzer
4 * By Gerald Combs <gerald@wireshark.org>
5 * Copyright 1998 Gerald Combs
7 * Rawshark - Raw field extractor by Gerald Combs <gerald@wireshark.org>
8 * and Loris Degioanni <loris.degioanni@cacetech.com>
9 * Based on TShark, by Gilbert Ramirez <gram@alumni.rice.edu> and Guy Harris
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation; either version 2
15 * of the License, or (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
28 * Rawshark does the following:
29 * - Opens a specified file or named pipe
30 * - Applies a specfied DLT or "decode as" encapsulation
31 * - Reads frames prepended with a libpcap packet header.
32 * - Prints a status line, followed by fields from a specified list.
45 #include <sys/resource.h>
54 #ifndef HAVE_GETOPT_LONG
55 #include "wsutil/wsgetopt.h"
59 #include <epan/epan-int.h>
60 #include <epan/epan.h>
62 #include <wsutil/cmdarg_err.h>
63 #include <wsutil/crash_info.h>
64 #include <wsutil/filesystem.h>
65 #include <wsutil/file_util.h>
66 #include <wsutil/plugins.h>
67 #include <wsutil/privileges.h>
68 #include <wsutil/report_message.h>
71 #include <epan/packet.h>
72 #include <epan/ftypes/ftypes-int.h>
74 #include "frame_tvbuff.h"
75 #include <epan/disabled_protos.h>
76 #include <epan/prefs.h>
77 #include <epan/column.h>
78 #include <epan/print.h>
79 #include <epan/addr_resolv.h>
81 #include "ui/capture_ui_utils.h"
84 #include "ui/dissect_opts.h"
85 #include "ui/failure_message.h"
87 #include "conditions.h"
88 #include "capture_stop_conditions.h"
89 #include <epan/epan_dissect.h>
90 #include <epan/stat_tap_ui.h>
91 #include <epan/timestamp.h>
92 #include <wsutil/unicode-utils.h>
93 #include "epan/column-utils.h"
94 #include "epan/proto.h"
97 #include <wiretap/wtap.h>
98 #include <wiretap/libpcap.h>
99 #include <wiretap/pcap-encap.h>
101 #include <wsutil/clopts_common.h>
102 #include <ws_version_info.h>
104 #include "caputils/capture-pcap-util.h"
113 #include "caputils/capture-wpcap.h"
115 #endif /* HAVE_LIBPCAP */
120 * This is the template for the decode as option; it is shared between the
121 * various functions that output the usage for this parameter.
123 static const gchar decode_as_arg_template[] = "<layer_type>==<selector>,<decode_as_protocol>";
126 #define INVALID_OPTION 1
128 #define INVALID_DFILTER 2
130 #define FORMAT_ERROR 2
132 static guint32 cum_bytes;
133 static const frame_data *ref;
134 static frame_data ref_frame;
135 static frame_data *prev_dis;
136 static frame_data prev_dis_frame;
137 static frame_data *prev_cap;
138 static frame_data prev_cap_frame;
141 * The way the packet decode is to be written.
144 WRITE_TEXT, /* summary or detail text */
145 WRITE_XML /* PDML or PSML */
146 /* Add CSV and the like here */
149 static gboolean line_buffered;
150 static print_format_e print_format = PR_FMT_TEXT;
152 static gboolean want_pcap_pkthdr;
154 cf_status_t raw_cf_open(capture_file *cf, const char *fname);
155 static gboolean load_cap_file(capture_file *cf);
156 static gboolean process_packet(capture_file *cf, epan_dissect_t *edt, gint64 offset,
157 struct wtap_pkthdr *whdr, const guchar *pd);
158 static void show_print_file_io_error(int err);
160 static void failure_warning_message(const char *msg_format, va_list ap);
161 static void open_failure_message(const char *filename, int err,
162 gboolean for_writing);
163 static void read_failure_message(const char *filename, int err);
164 static void write_failure_message(const char *filename, int err);
165 static void rawshark_cmdarg_err(const char *fmt, va_list ap);
166 static void rawshark_cmdarg_err_cont(const char *fmt, va_list ap);
167 static void protocolinfo_init(char *field);
168 static gboolean parse_field_string_format(char *format);
171 SF_NONE, /* No format (placeholder) */
172 SF_NAME, /* %D Field name / description */
173 SF_NUMVAL, /* %N Numeric value */
174 SF_STRVAL /* %S String value */
177 typedef struct string_fmt_s {
179 string_fmt_e format; /* Valid if plain is NULL */
185 dfilter_t *rfcodes[64];
187 dfilter_t *rfieldfcodes[64];
190 GPtrArray *string_fmts;
193 print_usage(FILE *output)
195 fprintf(output, "\n");
196 fprintf(output, "Usage: rawshark [options] ...\n");
197 fprintf(output, "\n");
199 fprintf(output, "Input file:\n");
200 fprintf(output, " -r <infile> set the pipe or file name to read from\n");
202 fprintf(output, "\n");
203 fprintf(output, "Processing:\n");
204 fprintf(output, " -d <encap:linktype>|<proto:protoname>\n");
205 fprintf(output, " packet encapsulation or protocol\n");
206 fprintf(output, " -F <field> field to display\n");
208 fprintf(output, " -m virtual memory limit, in bytes \n");
210 fprintf(output, " -n disable all name resolution (def: all enabled)\n");
211 fprintf(output, " -N <name resolve flags> enable specific name resolution(s): \"mnNtd\"\n");
212 fprintf(output, " -p use the system's packet header format\n");
213 fprintf(output, " (which may have 64-bit timestamps)\n");
214 fprintf(output, " -R <read filter> packet filter in Wireshark display filter syntax\n");
215 fprintf(output, " -s skip PCAP header on input\n");
217 fprintf(output, "\n");
218 fprintf(output, "Output:\n");
219 fprintf(output, " -l flush output after each packet\n");
220 fprintf(output, " -S format string for fields\n");
221 fprintf(output, " (%%D - name, %%S - stringval, %%N numval)\n");
222 fprintf(output, " -t ad|a|r|d|dd|e output format of time stamps (def: r: rel. to first)\n");
224 fprintf(output, "\n");
225 fprintf(output, "Miscellaneous:\n");
226 fprintf(output, " -h display this help and exit\n");
227 fprintf(output, " -o <name>:<value> ... override preference setting\n");
228 fprintf(output, " -v display version info and exit\n");
232 log_func_ignore (const gchar *log_domain _U_, GLogLevelFlags log_level _U_,
233 const gchar *message _U_, gpointer user_data _U_)
238 * Open a pipe for raw input. This is a stripped-down version of
239 * pcap_loop.c:cap_pipe_open_live().
240 * We check if "pipe_name" is "-" (stdin) or a FIFO, and open it.
241 * @param pipe_name The name of the pipe or FIFO.
242 * @return A POSIX file descriptor on success, or -1 on failure.
245 raw_pipe_open(const char *pipe_name)
248 ws_statb64 pipe_stat;
250 char *pncopy, *pos = NULL;
257 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "open_raw_pipe: %s", pipe_name);
260 * XXX Rawshark blocks until we return
262 if (strcmp(pipe_name, "-") == 0) {
263 rfd = 0; /* read from stdin */
266 * This is needed to set the stdin pipe into binary mode, otherwise
267 * CR/LF are mangled...
269 _setmode(0, _O_BINARY);
273 if (ws_stat64(pipe_name, &pipe_stat) < 0) {
274 fprintf(stderr, "rawshark: The pipe %s could not be checked: %s\n",
275 pipe_name, g_strerror(errno));
278 if (! S_ISFIFO(pipe_stat.st_mode)) {
279 if (S_ISCHR(pipe_stat.st_mode)) {
281 * Assume the user specified an interface on a system where
282 * interfaces are in /dev. Pretend we haven't seen it.
286 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
291 rfd = ws_open(pipe_name, O_RDONLY | O_NONBLOCK, 0000 /* no creation so don't matter */);
293 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
294 pipe_name, g_strerror(errno));
298 #define PIPE_STR "\\pipe\\"
299 /* Under Windows, named pipes _must_ have the form
300 * "\\<server>\pipe\<pipe_name>". <server> may be "." for localhost.
302 pncopy = g_strdup(pipe_name);
303 if (strstr(pncopy, "\\\\") == pncopy) {
304 pos = strchr(pncopy + 3, '\\');
305 if (pos && g_ascii_strncasecmp(pos, PIPE_STR, strlen(PIPE_STR)) != 0)
312 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
317 /* Wait for the pipe to appear */
319 hPipe = CreateFile(utf_8to16(pipe_name), GENERIC_READ, 0, NULL,
320 OPEN_EXISTING, 0, NULL);
322 if (hPipe != INVALID_HANDLE_VALUE)
325 err = GetLastError();
326 if (err != ERROR_PIPE_BUSY) {
327 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
328 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
329 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s (error %lu)\n",
330 pipe_name, utf_16to8(err_str), err);
335 if (!WaitNamedPipe(utf_8to16(pipe_name), 30 * 1000)) {
336 err = GetLastError();
337 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
338 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
339 fprintf(stderr, "rawshark: \"%s\" could not be waited for: %s (error %lu)\n",
340 pipe_name, utf_16to8(err_str), err);
346 rfd = _open_osfhandle((intptr_t) hPipe, _O_RDONLY);
348 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
349 pipe_name, g_strerror(errno));
359 * Parse a link-type argument of the form "encap:<pcap linktype>" or
360 * "proto:<proto name>". "Pcap linktype" must be a name conforming to
361 * pcap_datalink_name_to_val() or an integer; the integer should be
362 * a LINKTYPE_ value supported by Wiretap. "Proto name" must be
363 * a protocol name, e.g. "http".
366 set_link_type(const char *lt_arg) {
367 char *spec_ptr = strchr(lt_arg, ':');
371 dissector_handle_t dhandle;
380 if (strncmp(lt_arg, "encap:", strlen("encap:")) == 0) {
381 dlt_val = linktype_name_to_val(spec_ptr);
384 val = strtol(spec_ptr, &p, 10);
385 if (p == spec_ptr || *p != '\0' || errno != 0 || val > INT_MAX) {
391 * In those cases where a given link-layer header type
392 * has different LINKTYPE_ and DLT_ values, linktype_name_to_val()
393 * will return the OS's DLT_ value for that link-layer header
394 * type, not its OS-independent LINKTYPE_ value.
396 * On a given OS, wtap_pcap_encap_to_wtap_encap() should
397 * be able to map either LINKTYPE_ values or DLT_ values
398 * for the OS to the appropriate Wiretap encapsulation.
400 encap = wtap_pcap_encap_to_wtap_encap(dlt_val);
401 if (encap == WTAP_ENCAP_UNKNOWN) {
405 } else if (strncmp(lt_arg, "proto:", strlen("proto:")) == 0) {
406 dhandle = find_dissector(spec_ptr);
408 encap = WTAP_ENCAP_USER0;
409 pref_str = g_string_new("uat:user_dlts:");
410 /* This must match the format used in the user_dlts file */
411 g_string_append_printf(pref_str,
412 "\"User 0 (DLT=147)\",\"%s\",\"0\",\"\",\"0\",\"\"",
414 if (prefs_set_pref(pref_str->str, &errmsg) != PREFS_SET_OK) {
415 g_string_free(pref_str, TRUE);
419 g_string_free(pref_str, TRUE);
427 main(int argc, char *argv[])
429 GString *comp_info_str;
430 GString *runtime_info_str;
431 char *init_progfile_dir_error;
441 gchar *pipe_name = NULL;
446 GPtrArray *disp_fields = g_ptr_array_new();
448 gboolean skip_pcap_header = FALSE;
449 int ret = EXIT_SUCCESS;
450 static const struct option long_options[] = {
451 {"help", no_argument, NULL, 'h'},
452 {"version", no_argument, NULL, 'v'},
456 #define OPTSTRING_INIT "d:F:hlm:nN:o:pr:R:sS:t:v"
458 static const char optstring[] = OPTSTRING_INIT;
460 /* Set the C-language locale to the native environment. */
461 setlocale(LC_ALL, "");
463 cmdarg_err_init(rawshark_cmdarg_err, rawshark_cmdarg_err_cont);
465 /* Get the compile-time version information string */
466 comp_info_str = get_compiled_version_info(NULL, epan_get_compiled_version_info);
468 /* Get the run-time version information string */
469 runtime_info_str = get_runtime_version_info(NULL);
471 /* Add it to the information to be reported on a crash. */
472 ws_add_crash_info("Rawshark (Wireshark) %s\n"
477 get_ws_vcs_version_info(), comp_info_str->str, runtime_info_str->str);
480 arg_list_utf_16to8(argc, argv);
481 create_app_running_mutex();
485 * Get credential information for later use.
487 init_process_policies();
490 * Clear the filters arrays
492 memset(rfilters, 0, sizeof(rfilters));
493 memset(rfcodes, 0, sizeof(rfcodes));
498 * Initialize our string format
500 string_fmts = g_ptr_array_new();
503 * Attempt to get the pathname of the directory containing the
506 init_progfile_dir_error = init_progfile_dir(argv[0], main);
507 if (init_progfile_dir_error != NULL) {
508 fprintf(stderr, "rawshark: Can't get pathname of rawshark program: %s.\n",
509 init_progfile_dir_error);
512 /* nothing more than the standard GLib handler, but without a warning */
514 G_LOG_LEVEL_WARNING |
515 G_LOG_LEVEL_MESSAGE |
519 g_log_set_handler(NULL,
520 (GLogLevelFlags)log_flags,
521 log_func_ignore, NULL /* user_data */);
522 g_log_set_handler(LOG_DOMAIN_CAPTURE_CHILD,
523 (GLogLevelFlags)log_flags,
524 log_func_ignore, NULL /* user_data */);
526 init_report_message(failure_warning_message, failure_warning_message,
527 open_failure_message, read_failure_message,
528 write_failure_message);
530 timestamp_set_type(TS_RELATIVE);
531 timestamp_set_precision(TS_PREC_AUTO);
532 timestamp_set_seconds_type(TS_SECONDS_DEFAULT);
536 /* Register all dissectors; we must do this before checking for the
537 "-G" flag, as the "-G" flag dumps information registered by the
538 dissectors, and we must do it before we read the preferences, in
539 case any dissectors register preferences. */
540 if (!epan_init(register_all_protocols, register_all_protocol_handoffs,
546 /* Load libwireshark settings from the current profile. */
547 prefs_p = epan_load_settings();
550 ws_init_dll_search_path();
551 /* Load Wpcap, if possible */
555 cap_file_init(&cfile);
557 /* Print format defaults to this. */
558 print_format = PR_FMT_TEXT;
560 /* Initialize our encapsulation type */
561 encap = WTAP_ENCAP_UNKNOWN;
563 /* Now get our args */
564 /* XXX - We should probably have an option to dump libpcap link types */
565 while ((opt = getopt_long(argc, argv, optstring, long_options, NULL)) != -1) {
567 case 'd': /* Payload type */
568 if (!set_link_type(optarg)) {
569 cmdarg_err("Invalid link type or protocol \"%s\"", optarg);
570 ret = INVALID_OPTION;
574 case 'F': /* Read field to display */
575 g_ptr_array_add(disp_fields, g_strdup(optarg));
577 case 'h': /* Print help and exit */
578 printf("Rawshark (Wireshark) %s\n"
579 "Dump and analyze network traffic.\n"
580 "See https://www.wireshark.org for more information.\n",
581 get_ws_vcs_version_info());
585 case 'l': /* "Line-buffer" standard output */
586 /* This isn't line-buffering, strictly speaking, it's just
587 flushing the standard output after the information for
588 each packet is printed; however, that should be good
589 enough for all the purposes to which "-l" is put (and
590 is probably actually better for "-V", as it does fewer
593 See the comment in "process_packet()" for an explanation of
594 why we do that, and why we don't just use "setvbuf()" to
595 make the standard output line-buffered (short version: in
596 Windows, "line-buffered" is the same as "fully-buffered",
597 and the output buffer is only flushed when it fills up). */
598 line_buffered = TRUE;
602 limit.rlim_cur = get_positive_int(optarg, "memory limit");
603 limit.rlim_max = get_positive_int(optarg, "memory limit");
605 if(setrlimit(RLIMIT_AS, &limit) != 0) {
606 cmdarg_err("setrlimit() returned error");
607 ret = INVALID_OPTION;
612 case 'n': /* No name resolution */
613 disable_name_resolution();
615 case 'N': /* Select what types of addresses/port #s to resolve */
616 badopt = string_to_name_resolve(optarg, &gbl_resolv_flags);
617 if (badopt != '\0') {
618 cmdarg_err("-N specifies unknown resolving option '%c'; valid options are 'd', m', 'n', 'N', and 't'",
620 ret = INVALID_OPTION;
624 case 'o': /* Override preference from command line */
628 switch (prefs_set_pref(optarg, &errmsg)) {
633 case PREFS_SET_SYNTAX_ERR:
634 cmdarg_err("Invalid -o flag \"%s\"%s%s", optarg,
635 errmsg ? ": " : "", errmsg ? errmsg : "");
637 ret = INVALID_OPTION;
641 case PREFS_SET_NO_SUCH_PREF:
642 case PREFS_SET_OBSOLETE:
643 cmdarg_err("-o flag \"%s\" specifies unknown preference", optarg);
644 ret = INVALID_OPTION;
650 case 'p': /* Expect pcap_pkthdr packet headers, which may have 64-bit timestamps */
651 want_pcap_pkthdr = TRUE;
653 case 'r': /* Read capture file xxx */
654 pipe_name = g_strdup(optarg);
656 case 'R': /* Read file filter */
657 if(n_rfilters < (int) sizeof(rfilters) / (int) sizeof(rfilters[0])) {
658 rfilters[n_rfilters++] = optarg;
661 cmdarg_err("Too many display filters");
662 ret = INVALID_OPTION;
666 case 's': /* Skip PCAP header */
667 skip_pcap_header = TRUE;
669 case 'S': /* Print string representations */
670 if (!parse_field_string_format(optarg)) {
671 cmdarg_err("Invalid field string format");
672 ret = INVALID_OPTION;
676 case 't': /* Time stamp type */
677 if (strcmp(optarg, "r") == 0)
678 timestamp_set_type(TS_RELATIVE);
679 else if (strcmp(optarg, "a") == 0)
680 timestamp_set_type(TS_ABSOLUTE);
681 else if (strcmp(optarg, "ad") == 0)
682 timestamp_set_type(TS_ABSOLUTE_WITH_YMD);
683 else if (strcmp(optarg, "adoy") == 0)
684 timestamp_set_type(TS_ABSOLUTE_WITH_YDOY);
685 else if (strcmp(optarg, "d") == 0)
686 timestamp_set_type(TS_DELTA);
687 else if (strcmp(optarg, "dd") == 0)
688 timestamp_set_type(TS_DELTA_DIS);
689 else if (strcmp(optarg, "e") == 0)
690 timestamp_set_type(TS_EPOCH);
691 else if (strcmp(optarg, "u") == 0)
692 timestamp_set_type(TS_UTC);
693 else if (strcmp(optarg, "ud") == 0)
694 timestamp_set_type(TS_UTC_WITH_YMD);
695 else if (strcmp(optarg, "udoy") == 0)
696 timestamp_set_type(TS_UTC_WITH_YDOY);
698 cmdarg_err("Invalid time stamp type \"%s\"",
701 "It must be \"a\" for absolute, \"ad\" for absolute with YYYY-MM-DD date,");
703 "\"adoy\" for absolute with YYYY/DOY date, \"d\" for delta,");
705 "\"dd\" for delta displayed, \"e\" for epoch, \"r\" for relative,");
707 "\"u\" for absolute UTC, \"ud\" for absolute UTC with YYYY-MM-DD date,");
709 "or \"udoy\" for absolute UTC with YYYY/DOY date.");
710 ret = INVALID_OPTION;
714 case 'v': /* Show version and exit */
716 show_version("Rawshark (Wireshark)", comp_info_str, runtime_info_str);
717 g_string_free(comp_info_str, TRUE);
718 g_string_free(runtime_info_str, TRUE);
723 case '?': /* Bad flag - print usage message */
725 ret = INVALID_OPTION;
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");
755 ret = INVALID_OPTION;
758 rfilters[n_rfilters] = get_args_as_string(argc, argv, optind);
762 /* Make sure we got a dissector handle for our payload. */
763 if (encap == WTAP_ENCAP_UNKNOWN) {
764 cmdarg_err("No valid payload dissector specified.");
765 ret = INVALID_OPTION;
770 /* Start windows sockets */
771 result = WSAStartup( MAKEWORD( 1, 1 ), &wsaData );
779 /* At this point MATE will have registered its field array so we can
780 have a tap filter with one of MATE's late-registered fields as part
781 of the filter. We can now process all the "-z" arguments. */
782 start_requested_stats();
785 * Enabled and disabled protocols and heuristic dissectors as per
786 * command-line options.
788 setup_enabled_and_disabled_protocols();
790 /* Build the column format array */
791 build_column_format_array(&cfile.cinfo, prefs_p->num_cols, TRUE);
793 if (n_rfilters != 0) {
794 for (i = 0; i < n_rfilters; i++) {
797 if (!dfilter_compile(rfilters[i], &rfcodes[n_rfcodes], &err_msg)) {
798 cmdarg_err("%s", err_msg);
800 ret = INVALID_DFILTER;
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) {
824 /* Do we need to PCAP header and magic? */
825 if (skip_pcap_header) {
826 unsigned int bytes_left = (unsigned int) sizeof(struct pcap_hdr) + sizeof(guint32);
827 gchar buf[sizeof(struct pcap_hdr) + sizeof(guint32)];
828 while (bytes_left != 0) {
829 ssize_t bytes = ws_read(fd, buf, bytes_left);
831 cmdarg_err("Not enough bytes for pcap header.");
835 bytes_left -= (unsigned int)bytes;
839 /* Process the packets in the file */
840 if (!load_cap_file(&cfile)) {
845 /* If you want to capture live packets, use TShark. */
846 cmdarg_err("Input file or pipe name not specified.");
852 epan_free(cfile.epan);
862 * Read data from a raw pipe. The "raw" data consists of a libpcap
863 * packet header followed by the payload.
864 * @param pd [IN] A POSIX file descriptor. Because that's _exactly_ the sort
865 * of thing you want to use in Windows.
866 * @param phdr [OUT] Packet header information.
867 * @param err [OUT] Error indicator. Uses wiretap values.
868 * @param err_info [OUT] Error message.
869 * @param data_offset [OUT] data offset in the pipe.
870 * @return TRUE on success, FALSE on failure.
873 raw_pipe_read(struct wtap_pkthdr *phdr, guchar * pd, int *err, gchar **err_info, gint64 *data_offset) {
874 struct pcap_pkthdr mem_hdr;
875 struct pcaprec_hdr disk_hdr;
876 ssize_t bytes_read = 0;
877 unsigned int bytes_needed = (unsigned int) sizeof(disk_hdr);
878 guchar *ptr = (guchar*) &disk_hdr;
882 if (want_pcap_pkthdr) {
883 bytes_needed = sizeof(mem_hdr);
884 ptr = (guchar*) &mem_hdr;
888 * Newer versions of the VC runtime do parameter validation. If stdin
889 * has been closed, calls to _read, _get_osfhandle, et al will trigger
890 * the invalid parameter handler and crash.
891 * We could alternatively use ReadFile or set an invalid parameter
893 * We could also tell callers not to close stdin prematurely.
897 if (fd == 0 && GetHandleInformation(GetStdHandle(STD_INPUT_HANDLE), &ghi_flags) == 0) {
904 /* Copied from capture_loop.c */
905 while (bytes_needed > 0) {
906 bytes_read = ws_read(fd, ptr, bytes_needed);
907 if (bytes_read == 0) {
911 } else if (bytes_read < 0) {
916 bytes_needed -= (unsigned int)bytes_read;
917 *data_offset += bytes_read;
921 if (want_pcap_pkthdr) {
922 phdr->ts.secs = mem_hdr.ts.tv_sec;
923 phdr->ts.nsecs = (gint32)mem_hdr.ts.tv_usec * 1000;
924 phdr->caplen = mem_hdr.caplen;
925 phdr->len = mem_hdr.len;
927 phdr->ts.secs = disk_hdr.ts_sec;
928 phdr->ts.nsecs = disk_hdr.ts_usec * 1000;
929 phdr->caplen = disk_hdr.incl_len;
930 phdr->len = disk_hdr.orig_len;
932 bytes_needed = phdr->caplen;
934 phdr->pkt_encap = encap;
937 printf("mem_hdr: %lu disk_hdr: %lu\n", sizeof(mem_hdr), sizeof(disk_hdr));
938 printf("tv_sec: %u (%04x)\n", (unsigned int) phdr->ts.secs, (unsigned int) phdr->ts.secs);
939 printf("tv_nsec: %d (%04x)\n", phdr->ts.nsecs, phdr->ts.nsecs);
940 printf("caplen: %d (%04x)\n", phdr->caplen, phdr->caplen);
941 printf("len: %d (%04x)\n", phdr->len, phdr->len);
943 if (bytes_needed > WTAP_MAX_PACKET_SIZE) {
944 *err = WTAP_ERR_BAD_FILE;
945 *err_info = g_strdup_printf("Bad packet length: %lu\n",
946 (unsigned long) bytes_needed);
951 while (bytes_needed > 0) {
952 bytes_read = ws_read(fd, ptr, bytes_needed);
953 if (bytes_read == 0) {
954 *err = WTAP_ERR_SHORT_READ;
957 } else if (bytes_read < 0) {
962 bytes_needed -= (unsigned int)bytes_read;
963 *data_offset += bytes_read;
970 load_cap_file(capture_file *cf)
973 gchar *err_info = NULL;
974 gint64 data_offset = 0;
977 struct wtap_pkthdr phdr;
980 wtap_phdr_init(&phdr);
982 epan_dissect_init(&edt, cf->epan, TRUE, FALSE);
984 pd = (guchar*)g_malloc(WTAP_MAX_PACKET_SIZE);
985 while (raw_pipe_read(&phdr, pd, &err, &err_info, &data_offset)) {
986 process_packet(cf, &edt, data_offset, &phdr, pd);
989 epan_dissect_cleanup(&edt);
991 wtap_phdr_cleanup(&phdr);
994 /* Print a message noting that the read failed somewhere along the line. */
995 cfile_read_failure_message("Rawshark", cf->filename, err, err_info);
1003 process_packet(capture_file *cf, epan_dissect_t *edt, gint64 offset,
1004 struct wtap_pkthdr *whdr, const guchar *pd)
1012 /* The user sends an empty packet when he wants to get output from us even if we don't currently have
1013 packets to process. We spit out a line with the timestamp and the text "void"
1015 printf("%lu %lu %lu void -\n", (unsigned long int)cf->count,
1016 (unsigned long int)whdr->ts.secs,
1017 (unsigned long int)whdr->ts.nsecs);
1024 /* Count this packet. */
1027 /* If we're going to print packet information, or we're going to
1028 run a read filter, or we're going to process taps, set up to
1029 do a dissection and do so. */
1030 frame_data_init(&fdata, cf->count, whdr, offset, cum_bytes);
1034 /* If we're running a read filter, prime the epan_dissect_t with that
1036 if (n_rfilters > 0) {
1037 for(i = 0; i < n_rfcodes; i++) {
1038 epan_dissect_prime_with_dfilter(edt, rfcodes[i]);
1042 printf("%lu", (unsigned long int) cf->count);
1044 frame_data_set_before_dissect(&fdata, &cf->elapsed_time,
1047 if (ref == &fdata) {
1052 /* We only need the columns if we're printing packet info but we're
1053 *not* verbose; in verbose mode, we print the protocol tree, not
1054 the protocol summary. */
1055 epan_dissect_run_with_taps(edt, cf->cd_t, whdr, frame_tvbuff_new(&fdata, pd), &fdata, &cf->cinfo);
1057 frame_data_set_after_dissect(&fdata, &cum_bytes);
1058 prev_dis_frame = fdata;
1059 prev_dis = &prev_dis_frame;
1061 prev_cap_frame = fdata;
1062 prev_cap = &prev_cap_frame;
1064 for(i = 0; i < n_rfilters; i++) {
1065 /* Run the read filter if we have one. */
1067 passed = dfilter_apply_edt(rfcodes[i], edt);
1071 /* Print a one-line summary */
1072 printf(" %d", passed ? 1 : 0);
1077 /* The ANSI C standard does not appear to *require* that a line-buffered
1078 stream be flushed to the host environment whenever a newline is
1079 written, it just says that, on such a stream, characters "are
1080 intended to be transmitted to or from the host environment as a
1081 block when a new-line character is encountered".
1083 The Visual C++ 6.0 C implementation doesn't do what is intended;
1084 even if you set a stream to be line-buffered, it still doesn't
1085 flush the buffer at the end of every line.
1087 So, if the "-l" flag was specified, we flush the standard output
1088 at the end of a packet. This will do the right thing if we're
1089 printing packet summary lines, and, as we print the entire protocol
1090 tree for a single packet without waiting for anything to happen,
1091 it should be as good as line-buffered mode if we're printing
1092 protocol trees. (The whole reason for the "-l" flag in either
1093 tcpdump or Rawshark is to allow the output of a live capture to
1094 be piped to a program or script and to have that script see the
1095 information for the packet as soon as it's printed, rather than
1096 having to wait until a standard I/O buffer fills up. */
1100 if (ferror(stdout)) {
1101 show_print_file_io_error(errno);
1105 epan_dissect_reset(edt);
1106 frame_data_destroy(&fdata);
1111 /****************************************************************************************
1112 * FIELD EXTRACTION ROUTINES
1113 ****************************************************************************************/
1114 typedef struct _pci_t {
1120 static const char* ftenum_to_string(header_field_info *hfi)
1127 if (string_fmts->len > 0 && hfi->strings) {
1131 str = ftype_name(hfi->type);
1139 static void field_display_to_string(header_field_info *hfi, char* buf, int size)
1141 if (hfi->type != FT_BOOLEAN)
1143 g_strlcpy(buf, proto_field_display_to_string(hfi->display), size);
1147 g_snprintf(buf, size, "(Bit count: %d)", hfi->display);
1152 * Copied from various parts of proto.c
1154 #define FIELD_STR_INIT_LEN 256
1155 #define cVALS(x) (const value_string*)(x)
1156 static gboolean print_field_value(field_info *finfo, int cmd_line_index)
1158 header_field_info *hfinfo;
1159 char *fs_buf = NULL;
1160 char *fs_ptr = NULL;
1161 static GString *label_s = NULL;
1169 const true_false_string *tfstring = &tfs_true_false;
1171 hfinfo = finfo->hfinfo;
1174 label_s = g_string_new("");
1177 if(finfo->value.ftype->val_to_string_repr)
1180 * this field has an associated value,
1183 fs_len = fvalue_string_repr_len(&finfo->value, FTREPR_DFILTER, finfo->hfinfo->display);
1184 fs_buf = fvalue_to_string_repr(NULL, &finfo->value,
1185 FTREPR_DFILTER, finfo->hfinfo->display);
1188 /* String types are quoted. Remove them. */
1189 if (IS_FT_STRING(finfo->value.ftype->ftype) && fs_len > 2) {
1190 fs_buf[fs_len - 1] = '\0';
1195 if (string_fmts->len > 0 && finfo->hfinfo->strings) {
1196 g_string_truncate(label_s, 0);
1197 for (i = 0; i < string_fmts->len; i++) {
1198 sf = (string_fmt_t *)g_ptr_array_index(string_fmts, i);
1200 g_string_append(label_s, sf->plain);
1202 switch (sf->format) {
1204 g_string_append(label_s, hfinfo->name);
1207 g_string_append(label_s, fs_ptr);
1210 switch(hfinfo->type) {
1212 uvalue64 = fvalue_get_uinteger64(&finfo->value);
1213 tfstring = (const struct true_false_string*) hfinfo->strings;
1214 g_string_append(label_s, uvalue64 ? tfstring->true_string : tfstring->false_string);
1220 DISSECTOR_ASSERT(!hfinfo->bitmask);
1221 svalue = fvalue_get_sinteger(&finfo->value);
1222 if (hfinfo->display & BASE_RANGE_STRING) {
1223 g_string_append(label_s, rval_to_str_const(svalue, RVALS(hfinfo->strings), "Unknown"));
1224 } else if (hfinfo->display & BASE_EXT_STRING) {
1225 g_string_append(label_s, val_to_str_ext_const(svalue, (value_string_ext *) hfinfo->strings, "Unknown"));
1227 g_string_append(label_s, val_to_str_const(svalue, cVALS(hfinfo->strings), "Unknown"));
1230 case FT_INT40: /* XXX: Shouldn't these be as smart as FT_INT{8,16,24,32}? */
1234 DISSECTOR_ASSERT(!hfinfo->bitmask);
1235 svalue64 = (gint64)fvalue_get_sinteger64(&finfo->value);
1236 if (hfinfo->display & BASE_VAL64_STRING) {
1237 g_string_append(label_s, val64_to_str_const(svalue64, (const val64_string *)(hfinfo->strings), "Unknown"));
1244 DISSECTOR_ASSERT(!hfinfo->bitmask);
1245 uvalue = fvalue_get_uinteger(&finfo->value);
1246 if (!hfinfo->bitmask && hfinfo->display & BASE_RANGE_STRING) {
1247 g_string_append(label_s, rval_to_str_const(uvalue, RVALS(hfinfo->strings), "Unknown"));
1248 } else if (hfinfo->display & BASE_EXT_STRING) {
1249 g_string_append(label_s, val_to_str_ext_const(uvalue, (value_string_ext *) hfinfo->strings, "Unknown"));
1251 g_string_append(label_s, val_to_str_const(uvalue, cVALS(hfinfo->strings), "Unknown"));
1254 case FT_UINT40: /* XXX: Shouldn't these be as smart as FT_INT{8,16,24,32}? */
1258 DISSECTOR_ASSERT(!hfinfo->bitmask);
1259 uvalue64 = fvalue_get_uinteger64(&finfo->value);
1260 if (hfinfo->display & BASE_VAL64_STRING) {
1261 g_string_append(label_s, val64_to_str_const(uvalue64, (const val64_string *)(hfinfo->strings), "Unknown"));
1273 printf(" %d=\"%s\"", cmd_line_index, label_s->str);
1274 wmem_free(NULL, fs_buf);
1278 if(finfo->value.ftype->val_to_string_repr)
1280 printf(" %d=\"%s\"", cmd_line_index, fs_ptr);
1281 wmem_free(NULL, fs_buf);
1286 * This field doesn't have an associated value,
1290 printf(" %d=\"n.a.\"", cmd_line_index);
1295 protocolinfo_packet(void *prs, packet_info *pinfo _U_, epan_dissect_t *edt, const void *dummy _U_)
1297 pci_t *rs=(pci_t *)prs;
1301 gp=proto_get_finfo_ptr_array(edt->tree, rs->hf_index);
1308 * Print each occurrence of the field
1310 for (i = 0; i < gp->len; i++) {
1311 print_field_value((field_info *)gp->pdata[i], rs->cmd_line_index);
1317 int g_cmd_line_index = 0;
1320 * field must be persistent - we don't g_strdup() it below
1323 protocolinfo_init(char *field)
1326 header_field_info *hfi;
1327 GString *error_string;
1330 hfi=proto_registrar_get_byname(field);
1332 fprintf(stderr, "rawshark: Field \"%s\" doesn't exist.\n", field);
1336 field_display_to_string(hfi, hfibuf, sizeof(hfibuf));
1337 printf("%d %s %s - ",
1339 ftenum_to_string(hfi),
1342 rs=(pci_t *)g_malloc(sizeof(pci_t));
1343 rs->hf_index=hfi->id;
1345 rs->cmd_line_index = g_cmd_line_index++;
1347 error_string=register_tap_listener("frame", rs, rs->filter, TL_REQUIRES_PROTO_TREE, NULL, protocolinfo_packet, NULL);
1349 /* error, we failed to attach to the tap. complain and clean up */
1350 fprintf(stderr, "rawshark: Couldn't register field extraction tap: %s\n",
1352 g_string_free(error_string, TRUE);
1363 * Given a format string, split it into a GPtrArray of string_fmt_t structs
1364 * and fill in string_fmt_parts.
1368 add_string_fmt(string_fmt_e format, gchar *plain) {
1369 string_fmt_t *sf = (string_fmt_t *)g_malloc(sizeof(string_fmt_t));
1371 sf->format = format;
1372 sf->plain = g_strdup(plain);
1374 g_ptr_array_add(string_fmts, sf);
1378 parse_field_string_format(gchar *format) {
1379 GString *plain_s = g_string_new("");
1387 len = strlen(format);
1388 g_ptr_array_set_size(string_fmts, 0);
1391 if (format[pos] == '%') {
1392 if (pos >= len) { /* There should always be a following character */
1396 if (plain_s->len > 0) {
1397 add_string_fmt(SF_NONE, plain_s->str);
1398 g_string_truncate(plain_s, 0);
1400 switch (format[pos]) {
1402 add_string_fmt(SF_NAME, NULL);
1405 add_string_fmt(SF_NUMVAL, NULL);
1408 add_string_fmt(SF_STRVAL, NULL);
1411 g_string_append_c(plain_s, '%');
1413 default: /* Invalid format */
1417 g_string_append_c(plain_s, format[pos]);
1422 if (plain_s->len > 0) {
1423 add_string_fmt(SF_NONE, plain_s->str);
1425 g_string_free(plain_s, TRUE);
1429 /****************************************************************************************
1430 * END OF FIELD EXTRACTION ROUTINES
1431 ****************************************************************************************/
1434 show_print_file_io_error(int err)
1439 cmdarg_err("Not all the packets could be printed because there is "
1440 "no space left on the file system.");
1445 cmdarg_err("Not all the packets could be printed because you are "
1446 "too close to, or over your disk quota.");
1451 cmdarg_err("An error occurred while printing packets: %s.",
1458 * General errors and warnings are reported with an console message
1462 failure_warning_message(const char *msg_format, va_list ap)
1464 fprintf(stderr, "rawshark: ");
1465 vfprintf(stderr, msg_format, ap);
1466 fprintf(stderr, "\n");
1470 * Open/create errors are reported with an console message in Rawshark.
1473 open_failure_message(const char *filename, int err, gboolean for_writing)
1475 fprintf(stderr, "rawshark: ");
1476 fprintf(stderr, file_open_error_message(err, for_writing), filename);
1477 fprintf(stderr, "\n");
1480 static const nstime_t *
1481 raw_get_frame_ts(void *data _U_, guint32 frame_num)
1483 if (ref && ref->num == frame_num)
1484 return &ref->abs_ts;
1486 if (prev_dis && prev_dis->num == frame_num)
1487 return &prev_dis->abs_ts;
1489 if (prev_cap && prev_cap->num == frame_num)
1490 return &prev_cap->abs_ts;
1496 raw_epan_new(capture_file *cf)
1498 epan_t *epan = epan_new();
1501 epan->get_frame_ts = raw_get_frame_ts;
1502 epan->get_interface_name = cap_file_get_interface_name;
1503 epan->get_interface_description = cap_file_get_interface_description;
1504 epan->get_user_comment = NULL;
1510 raw_cf_open(capture_file *cf, const char *fname)
1512 if ((fd = raw_pipe_open(fname)) < 0)
1515 /* The open succeeded. Fill in the information for this file. */
1517 /* Create new epan session for dissection. */
1518 epan_free(cf->epan);
1519 cf->epan = raw_epan_new(cf);
1522 cf->f_datalen = 0; /* not used, but set it anyway */
1524 /* Set the file name because we need it to set the follow stream filter.
1525 XXX - is that still true? We need it for other reasons, though,
1527 cf->filename = g_strdup(fname);
1529 /* Indicate whether it's a permanent or temporary file. */
1530 cf->is_tempfile = FALSE;
1532 /* No user changes yet. */
1533 cf->unsaved_changes = FALSE;
1535 cf->cd_t = WTAP_FILE_TYPE_SUBTYPE_UNKNOWN;
1536 cf->open_type = WTAP_TYPE_AUTO;
1538 cf->drops_known = FALSE;
1540 cf->has_snap = FALSE;
1541 cf->snap = WTAP_MAX_PACKET_SIZE;
1542 nstime_set_zero(&cf->elapsed_time);
1551 * Read errors are reported with an console message in Rawshark.
1554 read_failure_message(const char *filename, int err)
1556 cmdarg_err("An error occurred while reading from the file \"%s\": %s.",
1557 filename, g_strerror(err));
1561 * Write errors are reported with an console message in Rawshark.
1564 write_failure_message(const char *filename, int err)
1566 cmdarg_err("An error occurred while writing to the file \"%s\": %s.",
1567 filename, g_strerror(err));
1571 * Report an error in command-line arguments.
1574 rawshark_cmdarg_err(const char *fmt, va_list ap)
1576 fprintf(stderr, "rawshark: ");
1577 vfprintf(stderr, fmt, ap);
1578 fprintf(stderr, "\n");
1582 * Report additional information for an error in command-line arguments.
1585 rawshark_cmdarg_err_cont(const char *fmt, va_list ap)
1587 vfprintf(stderr, fmt, ap);
1588 fprintf(stderr, "\n");
1597 * indent-tabs-mode: nil
1600 * ex: set shiftwidth=4 tabstop=8 expandtab:
1601 * :indentSize=4:tabSize=8:noTabs=true: