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.
60 #ifdef HAVE_SYS_STAT_H
61 # include <sys/stat.h>
65 #include "wsutil/wsgetopt.h"
69 #include <epan/epan.h>
70 #include <epan/filesystem.h>
71 #include <wsutil/privileges.h>
72 #include <wsutil/file_util.h>
75 #include <epan/packet.h>
77 #include "disabled_protos.h"
78 #include <epan/prefs.h>
79 #include <epan/column.h>
81 #include <epan/addr_resolv.h>
83 #include "clopts_common.h"
84 #include "cmdarg_err.h"
85 #include "version_info.h"
86 #include <epan/plugins.h>
88 #include "conditions.h"
89 #include "capture_stop_conditions.h"
90 #include "capture_ui_utils.h"
91 #include <epan/epan_dissect.h>
92 #include <epan/stat_cmd_args.h>
93 #include <epan/timestamp.h>
94 #include <wsutil/unicode-utils.h>
95 #include "epan/column-utils.h"
96 #include "epan/proto.h"
99 #include <wiretap/wtap.h>
100 #include <wiretap/libpcap.h>
101 #include <wiretap/pcap-encap.h>
105 #include "capture-pcap-util.h"
108 #include "capture-wpcap.h"
110 #endif /* HAVE_LIBPCAP */
114 #include <wsutil/unicode-utils.h>
118 * This is the template for the decode as option; it is shared between the
119 * various functions that output the usage for this parameter.
121 static const gchar decode_as_arg_template[] = "<layer_type>==<selector>,<decode_as_protocol>";
123 static guint32 cum_bytes;
124 static nstime_t first_ts;
125 static nstime_t prev_dis_ts;
126 static nstime_t prev_cap_ts;
129 * The way the packet decode is to be written.
132 WRITE_TEXT, /* summary or detail text */
133 WRITE_XML /* PDML or PSML */
134 /* Add CSV and the like here */
137 static gboolean line_buffered;
138 static print_format_e print_format = PR_FMT_TEXT;
140 static gboolean want_pcap_pkthdr;
142 cf_status_t raw_cf_open(capture_file *cf, const char *fname);
143 static int load_cap_file(capture_file *cf);
144 static gboolean process_packet(capture_file *cf, gint64 offset,
145 const struct wtap_pkthdr *whdr, const guchar *pd);
146 static void show_print_file_io_error(int err);
148 static void open_failure_message(const char *filename, int err,
149 gboolean for_writing);
150 static void failure_message(const char *msg_format, va_list ap);
151 static void read_failure_message(const char *filename, int err);
152 static void write_failure_message(const char *filename, int err);
153 static void protocolinfo_init(char *field);
154 static gboolean parse_field_string_format(char *format);
157 SF_NONE, /* No format (placeholder) */
158 SF_NAME, /* %D Field name / description */
159 SF_NUMVAL, /* %N Numeric value */
160 SF_STRVAL /* %S String value */
163 typedef struct string_fmt_s {
165 string_fmt_e format; /* Valid if plain is NULL */
171 dfilter_t *rfcodes[64];
173 dfilter_t *rfieldfcodes[64];
176 GPtrArray *string_fmts;
179 print_usage(gboolean print_ver)
186 "Rawshark " VERSION "%s\n"
187 "Dump and analyze network traffic.\n"
188 "See http://www.wireshark.org for more information.\n"
191 wireshark_svnversion, get_copyright_info());
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:dlt>|<proto:protoname>\n");
205 fprintf(output, " packet encapsulation or protocol\n");
206 fprintf(output, " -F <field> field to display\n");
207 fprintf(output, " -n disable all name resolution (def: all enabled)\n");
208 fprintf(output, " -N <name resolve flags> enable specific name resolution(s): \"mntC\"\n");
209 fprintf(output, " -p use the system's packet header format\n");
210 fprintf(output, " (which may have 64-bit timestamps)\n");
211 fprintf(output, " -R <read filter> packet filter in Wireshark display filter syntax\n");
212 fprintf(output, " -s skip PCAP header on input\n");
214 fprintf(output, "\n");
215 fprintf(output, "Output:\n");
216 fprintf(output, " -l flush output after each packet\n");
217 fprintf(output, " -S format string for fields\n");
218 fprintf(output, " (%%D - name, %%S - stringval, %%N numval)\n");
219 fprintf(output, " -t ad|a|r|d|dd|e output format of time stamps (def: r: rel. to first)\n");
221 fprintf(output, "\n");
222 fprintf(output, "Miscellaneous:\n");
223 fprintf(output, " -h display this help and exit\n");
224 fprintf(output, " -o <name>:<value> ... override preference setting\n");
225 fprintf(output, " -v display version info and exit\n");
229 log_func_ignore (const gchar *log_domain _U_, GLogLevelFlags log_level _U_,
230 const gchar *message _U_, gpointer user_data _U_)
235 * Open a pipe for raw input. This is a stripped-down version of
236 * pcap_loop.c:cap_pipe_open_live().
237 * We check if "pipe_name" is "-" (stdin) or a FIFO, and open it.
238 * @param pipe_name The name of the pipe or FIFO.
239 * @return A POSIX file descriptor on success, or -1 on failure.
242 raw_pipe_open(const char *pipe_name)
245 ws_statb64 pipe_stat;
254 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "open_raw_pipe: %s", pipe_name);
257 * XXX Rawshark blocks until we return
259 if (strcmp(pipe_name, "-") == 0) {
260 rfd = 0; /* read from stdin */
263 * This is needed to set the stdin pipe into binary mode, otherwise
264 * CR/LF are mangled...
266 _setmode(0, _O_BINARY);
270 if (ws_stat64(pipe_name, &pipe_stat) < 0) {
271 fprintf(stderr, "rawshark: The pipe %s could not be checked: %s\n",
272 pipe_name, g_strerror(errno));
275 if (! S_ISFIFO(pipe_stat.st_mode)) {
276 if (S_ISCHR(pipe_stat.st_mode)) {
278 * Assume the user specified an interface on a system where
279 * interfaces are in /dev. Pretend we haven't seen it.
283 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
288 rfd = ws_open(pipe_name, O_RDONLY | O_NONBLOCK, 0000 /* no creation so don't matter */);
290 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
291 pipe_name, g_strerror(errno));
295 #define PIPE_STR "\\pipe\\"
296 /* Under Windows, named pipes _must_ have the form
297 * "\\<server>\pipe\<pipe_name>". <server> may be "." for localhost.
299 pncopy = g_strdup(pipe_name);
300 if (strstr(pncopy, "\\\\") == pncopy) {
301 pos = strchr(pncopy + 3, '\\');
302 if (pos && g_ascii_strncasecmp(pos, PIPE_STR, strlen(PIPE_STR)) != 0)
309 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
314 /* Wait for the pipe to appear */
316 hPipe = CreateFile(utf_8to16(pipe_name), GENERIC_READ, 0, NULL,
317 OPEN_EXISTING, 0, NULL);
319 if (hPipe != INVALID_HANDLE_VALUE)
322 err = GetLastError();
323 if (err != ERROR_PIPE_BUSY) {
324 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
325 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
326 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s (error %d)\n",
327 pipe_name, utf_16to8(err_str), err);
332 if (!WaitNamedPipe(utf_8to16(pipe_name), 30 * 1000)) {
333 err = GetLastError();
334 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
335 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
336 fprintf(stderr, "rawshark: \"%s\" could not be waited for: %s (error %d)\n",
337 pipe_name, utf_16to8(err_str), err);
343 rfd = _open_osfhandle((long) hPipe, _O_RDONLY);
345 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
346 pipe_name, g_strerror(errno));
356 * Parse a link-type argument of the form "encap:<pcap dlt>" or
357 * "proto:<proto name>". "Pcap dlt" must be a name conforming to
358 * pcap_datalink_name_to_val() or an integer. "Proto name" must be
359 * a protocol name, e.g. "http".
362 set_link_type(const char *lt_arg) {
363 char *spec_ptr = strchr(lt_arg, ':');
367 dissector_handle_t dhandle;
375 if (strncmp(lt_arg, "encap:", strlen("encap:")) == 0) {
376 dlt_val = linktype_name_to_val(spec_ptr);
379 val = strtol(spec_ptr, &p, 10);
380 if (p == spec_ptr || *p != '\0' || errno != 0 || val > INT_MAX) {
385 encap = wtap_pcap_encap_to_wtap_encap(dlt_val);
386 if (encap == WTAP_ENCAP_UNKNOWN) {
390 } else if (strncmp(lt_arg, "proto:", strlen("proto:")) == 0) {
391 dhandle = find_dissector(spec_ptr);
393 encap = WTAP_ENCAP_USER0;
394 pref_str = g_string_new("uat:user_dlts:");
395 /* This must match the format used in the user_dlts file */
396 g_string_append_printf(pref_str,
397 "\"User 0 (DLT=147)\",\"%s\",\"0\",\"\",\"0\",\"\"",
399 if (prefs_set_pref(pref_str->str) != PREFS_SET_OK) {
400 g_string_free(pref_str, TRUE);
403 g_string_free(pref_str, TRUE);
411 show_version(GString *comp_info_str, GString *runtime_info_str)
413 printf("Rawshark " VERSION "%s\n"
420 wireshark_svnversion, get_copyright_info(), comp_info_str->str,
421 runtime_info_str->str);
425 main(int argc, char *argv[])
427 char *init_progfile_dir_error;
429 gboolean arg_error = FALSE;
435 char *gpf_path, *pf_path;
436 char *gdp_path, *dp_path;
437 int gpf_open_errno, gpf_read_errno;
438 int pf_open_errno, pf_read_errno;
439 int gdp_open_errno, gdp_read_errno;
440 int dp_open_errno, dp_read_errno;
442 gchar *pipe_name = NULL;
446 GLogLevelFlags log_flags;
447 GPtrArray *disp_fields = g_ptr_array_new();
449 gboolean skip_pcap_header = FALSE;
451 #define OPTSTRING_INIT "d:F:hlnN:o:pr:R:sS:t:v"
453 static const char optstring[] = OPTSTRING_INIT;
456 arg_list_utf_16to8(argc, argv);
460 * Get credential information for later use.
462 init_process_policies();
465 * Clear the filters arrays
467 memset(rfilters, 0, sizeof(rfilters));
468 memset(rfcodes, 0, sizeof(rfcodes));
473 * Initialize our string format
475 string_fmts = g_ptr_array_new();
478 * Attempt to get the pathname of the executable file.
480 init_progfile_dir_error = init_progfile_dir(argv[0], main);
481 if (init_progfile_dir_error != NULL) {
482 fprintf(stderr, "rawshark: Can't get pathname of rawshark program: %s.\n",
483 init_progfile_dir_error);
487 * Get credential information for later use.
489 init_process_policies();
491 /* nothing more than the standard GLib handler, but without a warning */
493 G_LOG_LEVEL_WARNING |
494 G_LOG_LEVEL_MESSAGE |
498 g_log_set_handler(NULL,
500 log_func_ignore, NULL /* user_data */);
501 g_log_set_handler(LOG_DOMAIN_CAPTURE_CHILD,
503 log_func_ignore, NULL /* user_data */);
505 timestamp_set_type(TS_RELATIVE);
506 timestamp_set_precision(TS_PREC_AUTO);
507 timestamp_set_seconds_type(TS_SECONDS_DEFAULT);
509 /* Register all dissectors; we must do this before checking for the
510 "-G" flag, as the "-G" flag dumps information registered by the
511 dissectors, and we must do it before we read the preferences, in
512 case any dissectors register preferences. */
513 epan_init(register_all_protocols, register_all_protocol_handoffs, NULL, NULL,
514 failure_message, open_failure_message, read_failure_message,
515 write_failure_message);
517 /* Set the C-language locale to the native environment. */
518 setlocale(LC_ALL, "");
520 prefs_p = read_prefs(&gpf_open_errno, &gpf_read_errno, &gpf_path,
521 &pf_open_errno, &pf_read_errno, &pf_path);
522 if (gpf_path != NULL) {
523 if (gpf_open_errno != 0) {
524 cmdarg_err("Can't open global preferences file \"%s\": %s.",
525 pf_path, g_strerror(gpf_open_errno));
527 if (gpf_read_errno != 0) {
528 cmdarg_err("I/O error reading global preferences file \"%s\": %s.",
529 pf_path, g_strerror(gpf_read_errno));
532 if (pf_path != NULL) {
533 if (pf_open_errno != 0) {
534 cmdarg_err("Can't open your preferences file \"%s\": %s.", pf_path,
535 g_strerror(pf_open_errno));
537 if (pf_read_errno != 0) {
538 cmdarg_err("I/O error reading your preferences file \"%s\": %s.",
539 pf_path, g_strerror(pf_read_errno));
545 /* Read the disabled protocols file. */
546 read_disabled_protos_list(&gdp_path, &gdp_open_errno, &gdp_read_errno,
547 &dp_path, &dp_open_errno, &dp_read_errno);
548 if (gdp_path != NULL) {
549 if (gdp_open_errno != 0) {
550 cmdarg_err("Could not open global disabled protocols file\n\"%s\": %s.",
551 gdp_path, g_strerror(gdp_open_errno));
553 if (gdp_read_errno != 0) {
554 cmdarg_err("I/O error reading global disabled protocols file\n\"%s\": %s.",
555 gdp_path, g_strerror(gdp_read_errno));
559 if (dp_path != NULL) {
560 if (dp_open_errno != 0) {
562 "Could not open your disabled protocols file\n\"%s\": %s.", dp_path,
563 g_strerror(dp_open_errno));
565 if (dp_read_errno != 0) {
567 "I/O error reading your disabled protocols file\n\"%s\": %s.", dp_path,
568 g_strerror(dp_read_errno));
574 /* Load Wpcap, if possible */
578 cap_file_init(&cfile);
580 /* Print format defaults to this. */
581 print_format = PR_FMT_TEXT;
583 /* Initialize our encapsulation type */
584 encap = WTAP_ENCAP_UNKNOWN;
586 /* Now get our args */
587 /* XXX - We should probably have an option to dump libpcap link types */
588 while ((opt = getopt(argc, argv, optstring)) != -1) {
590 case 'd': /* Payload type */
591 if (!set_link_type(optarg)) {
592 cmdarg_err("Invalid link type or protocol \"%s\"", optarg);
596 case 'F': /* Read field to display */
597 g_ptr_array_add(disp_fields, g_strdup(optarg));
599 case 'h': /* Print help and exit */
603 case 'l': /* "Line-buffer" standard output */
604 /* This isn't line-buffering, strictly speaking, it's just
605 flushing the standard output after the information for
606 each packet is printed; however, that should be good
607 enough for all the purposes to which "-l" is put (and
608 is probably actually better for "-V", as it does fewer
611 See the comment in "process_packet()" for an explanation of
612 why we do that, and why we don't just use "setvbuf()" to
613 make the standard output line-buffered (short version: in
614 Windows, "line-buffered" is the same as "fully-buffered",
615 and the output buffer is only flushed when it fills up). */
616 line_buffered = TRUE;
618 case 'n': /* No name resolution */
619 gbl_resolv_flags.mac_name = FALSE;
620 gbl_resolv_flags.network_name = FALSE;
621 gbl_resolv_flags.transport_name = FALSE;
622 gbl_resolv_flags.concurrent_dns = FALSE;
624 case 'N': /* Select what types of addresses/port #s to resolve */
625 badopt = string_to_name_resolve(optarg, &gbl_resolv_flags);
626 if (badopt != '\0') {
627 cmdarg_err("-N specifies unknown resolving option '%c'; valid options are 'm', 'n', and 't'",
632 case 'o': /* Override preference from command line */
633 switch (prefs_set_pref(optarg)) {
638 case PREFS_SET_SYNTAX_ERR:
639 cmdarg_err("Invalid -o flag \"%s\"", optarg);
643 case PREFS_SET_NO_SUCH_PREF:
644 case PREFS_SET_OBSOLETE:
645 cmdarg_err("-o flag \"%s\" specifies unknown preference", optarg);
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");
665 case 's': /* Skip PCAP header */
666 skip_pcap_header = TRUE;
668 case 'S': /* Print string representations */
669 if (!parse_field_string_format(optarg)) {
670 cmdarg_err("Invalid field string format");
674 case 't': /* Time stamp type */
675 if (strcmp(optarg, "r") == 0)
676 timestamp_set_type(TS_RELATIVE);
677 else if (strcmp(optarg, "a") == 0)
678 timestamp_set_type(TS_ABSOLUTE);
679 else if (strcmp(optarg, "ad") == 0)
680 timestamp_set_type(TS_ABSOLUTE_WITH_DATE);
681 else if (strcmp(optarg, "d") == 0)
682 timestamp_set_type(TS_DELTA);
683 else if (strcmp(optarg, "dd") == 0)
684 timestamp_set_type(TS_DELTA_DIS);
685 else if (strcmp(optarg, "e") == 0)
686 timestamp_set_type(TS_EPOCH);
687 else if (strcmp(optarg, "u") == 0)
688 timestamp_set_type(TS_UTC);
689 else if (strcmp(optarg, "ud") == 0)
690 timestamp_set_type(TS_UTC_WITH_DATE);
692 cmdarg_err("Invalid time stamp type \"%s\"",
694 cmdarg_err_cont("It must be \"r\" for relative, \"a\" for absolute,");
695 cmdarg_err_cont("\"ad\" for absolute with date, or \"d\" for delta.");
699 case 'v': /* Show version and exit */
701 GString *comp_info_str;
702 GString *runtime_info_str;
703 /* Assemble the compile-time version information string */
704 comp_info_str = g_string_new("Compiled ");
705 get_compiled_version_info(comp_info_str, NULL, epan_get_compiled_version_info);
707 /* Assemble the run-time version information string */
708 runtime_info_str = g_string_new("Running ");
709 get_runtime_version_info(runtime_info_str, NULL);
710 show_version(comp_info_str, runtime_info_str);
711 g_string_free(comp_info_str, TRUE);
712 g_string_free(runtime_info_str, TRUE);
717 case '?': /* Bad flag - print usage message */
724 /* Notify all registered modules that have had any of their preferences
725 changed either from one of the preferences file or from the command
726 line that their preferences have changed.
727 Initialize preferences before display filters, otherwise modules
728 like MATE won't work. */
731 /* Initialize our display fields */
732 for (fc = 0; fc < disp_fields->len; fc++) {
733 protocolinfo_init((char *)g_ptr_array_index(disp_fields, fc));
735 g_ptr_array_free(disp_fields, TRUE);
739 /* If no capture filter or read filter has been specified, and there are
740 still command-line arguments, treat them as the tokens of a capture
741 filter (if no "-r" flag was specified) or a read filter (if a "-r"
742 flag was specified. */
744 if (pipe_name != NULL) {
745 if (n_rfilters != 0) {
746 cmdarg_err("Read filters were specified both with \"-R\" "
747 "and with additional command-line arguments");
750 rfilters[n_rfilters] = get_args_as_string(argc, argv, optind);
754 /* Make sure we got a dissector handle for our payload. */
755 if (encap == WTAP_ENCAP_UNKNOWN) {
756 cmdarg_err("No valid payload dissector specified.");
767 /* Start windows sockets */
768 WSAStartup( MAKEWORD( 1, 1 ), &wsaData );
771 /* At this point MATE will have registered its field array so we can
772 have a tap filter with one of MATE's late-registered fields as part
773 of the filter. We can now process all the "-z" arguments. */
774 start_requested_stats();
776 /* disabled protocols as per configuration file */
777 if (gdp_path == NULL && dp_path == NULL) {
778 set_disabled_protos_list();
781 /* Build the column format array */
782 build_column_format_array(&cfile.cinfo, prefs_p->num_cols, TRUE);
784 if (n_rfilters != 0) {
785 for (i = 0; i < n_rfilters; i++) {
786 if (!dfilter_compile(rfilters[i], &rfcodes[n_rfcodes])) {
787 cmdarg_err("%s", dfilter_error_msg);
797 * We're reading a pipe (or capture file).
801 * Immediately relinquish any special privileges we have; we must not
802 * be allowed to read any capture files the user running Rawshark
805 relinquish_special_privs_perm();
807 if (raw_cf_open(&cfile, pipe_name) != CF_OK) {
812 /* Do we need to PCAP header and magic? */
813 if (skip_pcap_header) {
814 guint bytes_left = sizeof(struct pcap_hdr) + sizeof(guint32);
815 gchar buf[sizeof(struct pcap_hdr) + sizeof(guint32)];
816 while (bytes_left > 0) {
817 guint bytes = read(fd, buf, bytes_left);
819 cmdarg_err("Not enough bytes for pcap header.");
826 /* Set timestamp precision; there should arguably be a command-line
827 option to let the user set this. */
829 switch(wtap_file_tsprecision(cfile.wth)) {
830 case(WTAP_FILE_TSPREC_SEC):
831 timestamp_set_precision(TS_PREC_AUTO_SEC);
833 case(WTAP_FILE_TSPREC_DSEC):
834 timestamp_set_precision(TS_PREC_AUTO_DSEC);
836 case(WTAP_FILE_TSPREC_CSEC):
837 timestamp_set_precision(TS_PREC_AUTO_CSEC);
839 case(WTAP_FILE_TSPREC_MSEC):
840 timestamp_set_precision(TS_PREC_AUTO_MSEC);
842 case(WTAP_FILE_TSPREC_USEC):
843 timestamp_set_precision(TS_PREC_AUTO_USEC);
845 case(WTAP_FILE_TSPREC_NSEC):
846 timestamp_set_precision(TS_PREC_AUTO_NSEC);
849 g_assert_not_reached();
852 timestamp_set_precision(TS_PREC_AUTO_USEC);
855 /* Process the packets in the file */
856 err = load_cap_file(&cfile);
863 /* If you want to capture live packets, use TShark. */
864 cmdarg_err("Input file or pipe name not specified.");
874 * Read data from a raw pipe. The "raw" data consists of a libpcap
875 * packet header followed by the payload.
876 * @param fd [IN] A POSIX file descriptor. Because that's _exactly_ the sort
877 * of thing you want to use in Windows.
878 * @param phdr [OUT] Packet header information.
879 * @param err [OUT] Error indicator. Uses wiretap values.
880 * @param err_info [OUT] Error message.
881 * @param data_offset [OUT] data offset in the pipe.
882 * @return TRUE on success, FALSE on failure.
885 raw_pipe_read(struct wtap_pkthdr *phdr, guchar * pd, int *err, const gchar **err_info, gint64 *data_offset) {
886 struct pcap_pkthdr mem_hdr;
887 struct pcaprec_hdr disk_hdr;
889 int bytes_needed = sizeof(disk_hdr);
890 guchar *ptr = (guchar*) &disk_hdr;
891 static gchar err_str[100];
893 if (want_pcap_pkthdr) {
894 bytes_needed = sizeof(mem_hdr);
895 ptr = (guchar*) &mem_hdr;
898 /* Copied from capture_loop.c */
899 while (bytes_needed > 0) {
900 bytes_read = read(fd, ptr, bytes_needed);
901 if (bytes_read == 0) {
904 } else if (bytes_read < 0) {
905 *err = WTAP_ERR_CANT_READ;
906 *err_info = "Error reading header from pipe";
909 bytes_needed -= bytes_read;
910 *data_offset += bytes_read;
914 if (want_pcap_pkthdr) {
915 phdr->ts.secs = mem_hdr.ts.tv_sec;
916 phdr->ts.nsecs = mem_hdr.ts.tv_usec * 1000;
917 phdr->caplen = bytes_needed = mem_hdr.caplen;
918 phdr->len = mem_hdr.len;
920 phdr->ts.secs = disk_hdr.ts_sec;
921 phdr->ts.nsecs = disk_hdr.ts_usec * 1000;
922 phdr->caplen = bytes_needed = disk_hdr.incl_len;
923 phdr->len = disk_hdr.orig_len;
926 phdr->pkt_encap = encap;
929 printf("tv_sec: %d (%04x)\n", hdr.ts.tv_sec, hdr.ts.tv_sec);
930 printf("tv_usec: %d (%04x)\n", hdr.ts.tv_usec, hdr.ts.tv_usec);
931 printf("caplen: %d (%04x)\n", hdr.caplen, hdr.caplen);
932 printf("len: %d (%04x)\n", hdr.len, hdr.len);
934 if (bytes_needed > WTAP_MAX_PACKET_SIZE) {
935 *err = WTAP_ERR_BAD_FILE;
936 g_snprintf(err_str, 100, "Bad packet length: %d (%04x)", bytes_needed, bytes_needed);
942 while (bytes_needed > 0) {
943 bytes_read = read(fd, ptr, bytes_needed);
944 if (bytes_read == 0) {
945 *err = WTAP_ERR_SHORT_READ;
946 *err_info = "Got zero bytes reading data from pipe";
948 } else if (bytes_read < 0) {
949 *err = WTAP_ERR_CANT_READ;
950 *err_info = "Error reading data from pipe";
953 bytes_needed -= bytes_read;
954 *data_offset += bytes_read;
961 load_cap_file(capture_file *cf)
964 const gchar *err_info;
965 gint64 data_offset = 0;
966 struct wtap_pkthdr phdr;
967 guchar pd[WTAP_MAX_PACKET_SIZE];
969 while (raw_pipe_read(&phdr, pd, &err, &err_info, &data_offset)) {
970 process_packet(cf, data_offset, &phdr, pd);
974 /* Print a message noting that the read failed somewhere along the line. */
977 case WTAP_ERR_UNSUPPORTED_ENCAP:
978 cmdarg_err("The file \"%s\" has a packet with a network type that Rawshark doesn't support.\n(%s)",
979 cf->filename, err_info);
982 case WTAP_ERR_CANT_READ:
983 cmdarg_err("An attempt to read from the file \"%s\" failed for some unknown reason.",
987 case WTAP_ERR_SHORT_READ:
988 cmdarg_err("The file \"%s\" appears to have been cut short in the middle of a packet.",
992 case WTAP_ERR_BAD_FILE:
993 cmdarg_err("The file \"%s\" appears to be damaged or corrupt.\n(%s)",
994 cf->filename, err_info);
997 case WTAP_ERR_DECOMPRESS:
998 cmdarg_err("The compressed file \"%s\" appears to be damaged or corrupt.\n(%s)",
999 cf->filename, err_info);
1003 cmdarg_err("An error occurred while reading the file \"%s\": %s.",
1004 cf->filename, wtap_strerror(err));
1013 process_packet(capture_file *cf, gint64 offset, const struct wtap_pkthdr *whdr,
1017 gboolean create_proto_tree;
1020 union wtap_pseudo_header pseudo_header;
1025 /* The user sends an empty packet when he wants to get output from us even if we don't currently have
1026 packets to process. We spit out a line with the timestamp and the text "void"
1028 printf("%lu %lu %lu void -\n", (unsigned long int)cf->count,
1029 (unsigned long int)whdr->ts.secs,
1030 (unsigned long int)whdr->ts.nsecs);
1037 memset(&pseudo_header, 0, sizeof(pseudo_header));
1039 /* Count this packet. */
1042 /* If we're going to print packet information, or we're going to
1043 run a read filter, or we're going to process taps, set up to
1044 do a dissection and do so. */
1045 frame_data_init(&fdata, cf->count, whdr, offset, cum_bytes);
1048 create_proto_tree = TRUE;
1050 /* The protocol tree will be "visible", i.e., printed, only if we're
1051 printing packet details, which is true if we're in verbose mode ("verbose"
1053 epan_dissect_init(&edt, create_proto_tree, FALSE);
1055 /* If we're running a read filter, prime the epan_dissect_t with that
1057 if (n_rfilters > 0) {
1058 for(i = 0; i < n_rfcodes; i++) {
1059 epan_dissect_prime_dfilter(&edt, rfcodes[i]);
1063 tap_queue_init(&edt);
1065 printf("%lu", (unsigned long int) cf->count);
1067 frame_data_set_before_dissect(&fdata, &cf->elapsed_time,
1068 &first_ts, &prev_dis_ts, &prev_cap_ts);
1070 /* We only need the columns if we're printing packet info but we're
1071 *not* verbose; in verbose mode, we print the protocol tree, not
1072 the protocol summary. */
1073 epan_dissect_run(&edt, &pseudo_header, pd, &fdata, &cf->cinfo);
1075 tap_push_tapped_queue(&edt);
1077 frame_data_set_after_dissect(&fdata, &cum_bytes, &prev_dis_ts);
1079 for(i = 0; i < n_rfilters; i++) {
1080 /* Run the read filter if we have one. */
1082 passed = dfilter_apply_edt(rfcodes[i], &edt);
1086 /* Print a one-line summary */
1087 printf(" %u", passed ? 1 : 0);
1092 /* The ANSI C standard does not appear to *require* that a line-buffered
1093 stream be flushed to the host environment whenever a newline is
1094 written, it just says that, on such a stream, characters "are
1095 intended to be transmitted to or from the host environment as a
1096 block when a new-line character is encountered".
1098 The Visual C++ 6.0 C implementation doesn't do what is intended;
1099 even if you set a stream to be line-buffered, it still doesn't
1100 flush the buffer at the end of every line.
1102 So, if the "-l" flag was specified, we flush the standard output
1103 at the end of a packet. This will do the right thing if we're
1104 printing packet summary lines, and, as we print the entire protocol
1105 tree for a single packet without waiting for anything to happen,
1106 it should be as good as line-buffered mode if we're printing
1107 protocol trees. (The whole reason for the "-l" flag in either
1108 tcpdump or Rawshark is to allow the output of a live capture to
1109 be piped to a program or script and to have that script see the
1110 information for the packet as soon as it's printed, rather than
1111 having to wait until a standard I/O buffer fills up. */
1115 if (ferror(stdout)) {
1116 show_print_file_io_error(errno);
1120 epan_dissect_cleanup(&edt);
1121 frame_data_cleanup(&fdata);
1126 /****************************************************************************************
1127 * FIELD EXTRACTION ROUTINES
1128 ****************************************************************************************/
1129 typedef struct _pci_t {
1135 static const char* ftenum_to_string(header_field_info *hfi)
1141 if (string_fmts->len > 0 && hfi->strings) {
1149 return "FT_PROTOCOL";
1151 return "FT_BOOLEAN";
1176 case FT_ABSOLUTE_TIME:
1177 return "FT_ABSOLUTE_TIME";
1178 case FT_RELATIVE_TIME:
1179 return "FT_RELATIVE_TIME";
1183 return "FT_STRINGZ";
1184 case FT_UINT_STRING:
1185 return "FT_UINT_STRING";
1191 return "FT_UINT_BYTES";
1199 return "FT_FRAMENUM";
1207 return "FT_NUM_TYPES";
1213 static const char* absolute_time_display_e_to_string(absolute_time_display_e atd)
1216 case ABSOLUTE_TIME_LOCAL:
1217 return "ABSOLUTE_TIME_LOCAL";
1218 case ABSOLUTE_TIME_UTC:
1219 return "ABSOLUTE_TIME_UTC";
1225 static const char* base_display_e_to_string(base_display_e bd)
1237 return "BASE_DEC_HEX";
1239 return "BASE_HEX_DEC";
1246 * Copied from various parts of proto.c
1248 #define FIELD_STR_INIT_LEN 256
1249 #define cVALS(x) (const value_string*)(x)
1250 static gboolean print_field_value(field_info *finfo, int cmd_line_index)
1252 header_field_info *hfinfo;
1253 static char *fs_buf = NULL;
1254 char *fs_ptr = fs_buf;
1255 static GString *label_s = NULL;
1256 int fs_buf_len = FIELD_STR_INIT_LEN, fs_len;
1261 const true_false_string *tfstring = &tfs_true_false;
1263 hfinfo = finfo->hfinfo;
1266 fs_buf = (char *)g_malloc(fs_buf_len + 1);
1271 label_s = g_string_new("");
1274 if(finfo->value.ftype->val_to_string_repr)
1277 * this field has an associated value,
1280 fs_len = fvalue_string_repr_len(&finfo->value, FTREPR_DFILTER);
1281 while (fs_buf_len < fs_len) {
1283 fs_buf = (char *)g_realloc(fs_buf, fs_buf_len + 1);
1286 fvalue_to_string_repr(&finfo->value,
1290 /* String types are quoted. Remove them. */
1291 if ((finfo->value.ftype->ftype == FT_STRING || finfo->value.ftype->ftype == FT_STRINGZ) && fs_len > 2) {
1292 fs_buf[fs_len - 1] = '\0';
1297 if (string_fmts->len > 0 && finfo->hfinfo->strings) {
1298 g_string_truncate(label_s, 0);
1299 for (i = 0; i < string_fmts->len; i++) {
1300 sf = (string_fmt_t *)g_ptr_array_index(string_fmts, i);
1302 g_string_append(label_s, sf->plain);
1304 switch (sf->format) {
1306 g_string_append(label_s, hfinfo->name);
1309 g_string_append(label_s, fs_ptr);
1312 switch(hfinfo->type) {
1314 uvalue = fvalue_get_uinteger(&finfo->value);
1315 tfstring = (const struct true_false_string*) hfinfo->strings;
1316 g_string_append(label_s, uvalue ? tfstring->true_string : tfstring->false_string);
1322 DISSECTOR_ASSERT(!hfinfo->bitmask);
1323 svalue = fvalue_get_sinteger(&finfo->value);
1324 if (hfinfo->display & BASE_RANGE_STRING) {
1325 g_string_append(label_s, rval_to_str(svalue, RVALS(hfinfo->strings), "Unknown"));
1326 } else if (hfinfo->display & BASE_EXT_STRING) {
1327 g_string_append(label_s, val_to_str_ext(svalue, (const value_string_ext *) hfinfo->strings, "Unknown"));
1329 g_string_append(label_s, val_to_str(svalue, cVALS(hfinfo->strings), "Unknown"));
1336 uvalue = fvalue_get_uinteger(&finfo->value);
1337 if (!hfinfo->bitmask && hfinfo->display & BASE_RANGE_STRING) {
1338 g_string_append(label_s, rval_to_str(uvalue, RVALS(hfinfo->strings), "Unknown"));
1339 } else if (hfinfo->display & BASE_EXT_STRING) {
1340 g_string_append(label_s, val_to_str_ext(uvalue, (const value_string_ext *) hfinfo->strings, "Unknown"));
1342 g_string_append(label_s, val_to_str(uvalue, cVALS(hfinfo->strings), "Unknown"));
1354 printf(" %u=\"%s\"", cmd_line_index, label_s->str);
1358 if(finfo->value.ftype->val_to_string_repr)
1360 printf(" %u=\"%s\"", cmd_line_index, fs_ptr);
1365 * This field doesn't have an associated value,
1369 printf(" %u=\"n.a.\"", cmd_line_index);
1374 protocolinfo_packet(void *prs, packet_info *pinfo _U_, epan_dissect_t *edt, const void *dummy _U_)
1376 pci_t *rs=(pci_t *)prs;
1380 gp=proto_get_finfo_ptr_array(edt->tree, rs->hf_index);
1387 * Print each occurrence of the field
1389 for (i = 0; i < gp->len; i++) {
1390 print_field_value((field_info *)gp->pdata[i], rs->cmd_line_index);
1396 int g_cmd_line_index = 0;
1399 * field must be persistent - we don't g_strdup() it below
1402 protocolinfo_init(char *field)
1405 header_field_info *hfi;
1406 GString *error_string;
1408 hfi=proto_registrar_get_byname(field);
1410 fprintf(stderr, "rawshark: Field \"%s\" doesn't exist.\n", field);
1414 switch (hfi->type) {
1416 case FT_ABSOLUTE_TIME:
1417 printf("%u %s %s - ",
1419 ftenum_to_string(hfi),
1420 absolute_time_display_e_to_string(hfi->display));
1424 printf("%u %s %s - ",
1426 ftenum_to_string(hfi),
1427 base_display_e_to_string(hfi->display));
1431 rs=(pci_t *)g_malloc(sizeof(pci_t));
1432 rs->hf_index=hfi->id;
1434 rs->cmd_line_index = g_cmd_line_index++;
1436 error_string=register_tap_listener("frame", rs, rs->filter, TL_REQUIRES_PROTO_TREE, NULL, protocolinfo_packet, NULL);
1438 /* error, we failed to attach to the tap. complain and clean up */
1439 fprintf(stderr, "rawshark: Couldn't register field extraction tap: %s\n",
1441 g_string_free(error_string, TRUE);
1452 * Given a format string, split it into a GPtrArray of string_fmt_t structs
1453 * and fill in string_fmt_parts.
1457 add_string_fmt(string_fmt_e format, gchar *plain) {
1458 string_fmt_t *sf = (string_fmt_t *)g_malloc(sizeof(string_fmt_t));
1460 sf->format = format;
1461 sf->plain = g_strdup(plain);
1463 g_ptr_array_add(string_fmts, sf);
1467 parse_field_string_format(gchar *format) {
1468 GString *plain_s = g_string_new("");
1476 len = strlen(format);
1477 g_ptr_array_set_size(string_fmts, 0);
1480 if (format[pos] == '%') {
1481 if (pos >= len) { /* There should always be a following character */
1485 if (plain_s->len > 0) {
1486 add_string_fmt(SF_NONE, plain_s->str);
1487 g_string_truncate(plain_s, 0);
1489 switch (format[pos]) {
1491 add_string_fmt(SF_NAME, NULL);
1494 add_string_fmt(SF_NUMVAL, NULL);
1497 add_string_fmt(SF_STRVAL, NULL);
1500 g_string_append_c(plain_s, '%');
1502 default: /* Invalid format */
1506 g_string_append_c(plain_s, format[pos]);
1511 if (plain_s->len > 0) {
1512 add_string_fmt(SF_NONE, plain_s->str);
1514 g_string_free(plain_s, TRUE);
1518 /****************************************************************************************
1519 * END OF FIELD EXTRACTION ROUTINES
1520 ****************************************************************************************/
1523 show_print_file_io_error(int err)
1528 cmdarg_err("Not all the packets could be printed because there is "
1529 "no space left on the file system.");
1534 cmdarg_err("Not all the packets could be printed because you are "
1535 "too close to, or over your disk quota.");
1540 cmdarg_err("An error occurred while printing packets: %s.",
1547 * Open/create errors are reported with an console message in Rawshark.
1550 open_failure_message(const char *filename, int err, gboolean for_writing)
1552 fprintf(stderr, "rawshark: ");
1553 fprintf(stderr, file_open_error_message(err, for_writing), filename);
1554 fprintf(stderr, "\n");
1558 raw_cf_open(capture_file *cf, const char *fname)
1560 if ((fd = raw_pipe_open(fname)) < 0)
1563 /* The open succeeded. Fill in the information for this file. */
1565 /* Cleanup all data structures used for dissection. */
1566 cleanup_dissection();
1567 /* Initialize all data structures used for dissection. */
1571 cf->f_datalen = 0; /* not used, but set it anyway */
1573 /* Set the file name because we need it to set the follow stream filter.
1574 XXX - is that still true? We need it for other reasons, though,
1576 cf->filename = g_strdup(fname);
1578 /* Indicate whether it's a permanent or temporary file. */
1579 cf->is_tempfile = FALSE;
1581 /* No user changes yet. */
1582 cf->unsaved_changes = FALSE;
1584 cf->cd_t = WTAP_FILE_UNKNOWN;
1586 cf->drops_known = FALSE;
1588 cf->has_snap = FALSE;
1589 cf->snap = WTAP_MAX_PACKET_SIZE;
1590 nstime_set_zero(&cf->elapsed_time);
1591 nstime_set_unset(&first_ts);
1592 nstime_set_unset(&prev_dis_ts);
1593 nstime_set_unset(&prev_cap_ts);
1600 * General errors are reported with an console message in Rawshark.
1603 failure_message(const char *msg_format, va_list ap)
1605 fprintf(stderr, "rawshark: ");
1606 vfprintf(stderr, msg_format, ap);
1607 fprintf(stderr, "\n");
1611 * Read errors are reported with an console message in Rawshark.
1614 read_failure_message(const char *filename, int err)
1616 cmdarg_err("An error occurred while reading from the file \"%s\": %s.",
1617 filename, g_strerror(err));
1621 * Write errors are reported with an console message in Rawshark.
1624 write_failure_message(const char *filename, int err)
1626 cmdarg_err("An error occurred while writing to the file \"%s\": %s.",
1627 filename, g_strerror(err));
1631 * Report an error in command-line arguments.
1634 cmdarg_err(const char *fmt, ...)
1639 fprintf(stderr, "rawshark: ");
1640 vfprintf(stderr, fmt, ap);
1641 fprintf(stderr, "\n");
1646 * Report additional information for an error in command-line arguments.
1649 cmdarg_err_cont(const char *fmt, ...)
1654 vfprintf(stderr, fmt, ap);
1655 fprintf(stderr, "\n");
1666 * indent-tabs-mode: nil
1669 * ex: set shiftwidth=4 tabstop=8 expandtab:
1670 * :indentSize=4:tabSize=8:noTabs=true: