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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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"
109 #include "capture_errs.h"
111 #endif /* HAVE_LIBPCAP */
115 #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>";
124 static guint32 cum_bytes;
125 static nstime_t first_ts;
126 static nstime_t prev_dis_ts;
127 static nstime_t prev_cap_ts;
130 * The way the packet decode is to be written.
133 WRITE_TEXT, /* summary or detail text */
134 WRITE_XML /* PDML or PSML */
135 /* Add CSV and the like here */
138 static gboolean line_buffered;
139 static print_format_e print_format = PR_FMT_TEXT;
141 static gboolean want_pcap_pkthdr;
143 cf_status_t raw_cf_open(capture_file *cf, const char *fname);
144 static int load_cap_file(capture_file *cf);
145 static gboolean process_packet(capture_file *cf, gint64 offset,
146 const struct wtap_pkthdr *whdr, const guchar *pd);
147 static void show_print_file_io_error(int err);
149 static void open_failure_message(const char *filename, int err,
150 gboolean for_writing);
151 static void failure_message(const char *msg_format, va_list ap);
152 static void read_failure_message(const char *filename, int err);
153 static void write_failure_message(const char *filename, int err);
154 static void protocolinfo_init(char *field);
155 static gboolean parse_field_string_format(char *format);
158 SF_NONE, /* No format (placeholder) */
159 SF_NAME, /* %D Field name / description */
160 SF_NUMVAL, /* %N Numeric value */
161 SF_STRVAL /* %S String value */
164 typedef struct string_fmt_s {
166 string_fmt_e format; /* Valid if plain is NULL */
172 dfilter_t *rfcodes[64];
174 dfilter_t *rfieldfcodes[64];
177 GPtrArray *string_fmts;
180 print_usage(gboolean print_ver)
187 "Rawshark " VERSION "%s\n"
188 "Dump and analyze network traffic.\n"
189 "See http://www.wireshark.org for more information.\n"
192 wireshark_svnversion, get_copyright_info());
196 fprintf(output, "\n");
197 fprintf(output, "Usage: rawshark [options] ...\n");
198 fprintf(output, "\n");
200 fprintf(output, "Input file:\n");
201 fprintf(output, " -r <infile> set the pipe or file name to read from\n");
203 fprintf(output, "\n");
204 fprintf(output, "Processing:\n");
205 fprintf(output, " -d <encap:dlt>|<proto:protoname>\n");
206 fprintf(output, " packet encapsulation or protocol\n");
207 fprintf(output, " -F <field> field to display\n");
208 fprintf(output, " -n disable all name resolution (def: all enabled)\n");
209 fprintf(output, " -N <name resolve flags> enable specific name resolution(s): \"mntC\"\n");
210 fprintf(output, " -p use the system's packet header format (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 (%%D - name, %%S - stringval, %%N numval)\n");
218 fprintf(output, " -t ad|a|r|d|dd|e output format of time stamps (def: r: rel. to first)\n");
220 fprintf(output, "\n");
221 fprintf(output, "Miscellaneous:\n");
222 fprintf(output, " -h display this help and exit\n");
223 fprintf(output, " -o <name>:<value> ... override preference setting\n");
224 fprintf(output, " -v display version info and exit\n");
228 log_func_ignore (const gchar *log_domain _U_, GLogLevelFlags log_level _U_,
229 const gchar *message _U_, gpointer user_data _U_)
234 * Open a pipe for raw input. This is a stripped-down version of
235 * pcap_loop.c:cap_pipe_open_live().
236 * We check if "pipe_name" is "-" (stdin) or a FIFO, and open it.
237 * @param pipe_name The name of the pipe or FIFO.
238 * @return A POSIX file descriptor on success, or -1 on failure.
241 raw_pipe_open(const char *pipe_name)
244 ws_statb64 pipe_stat;
253 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "open_raw_pipe: %s", pipe_name);
256 * XXX Rawshark blocks until we return
258 if (strcmp(pipe_name, "-") == 0) {
259 rfd = 0; /* read from stdin */
262 * This is needed to set the stdin pipe into binary mode, otherwise
263 * CR/LF are mangled...
265 _setmode(0, _O_BINARY);
269 if (ws_stat64(pipe_name, &pipe_stat) < 0) {
270 fprintf(stderr, "rawshark: The pipe %s could not be checked: %s\n",
271 pipe_name, g_strerror(errno));
274 if (! S_ISFIFO(pipe_stat.st_mode)) {
275 if (S_ISCHR(pipe_stat.st_mode)) {
277 * Assume the user specified an interface on a system where
278 * interfaces are in /dev. Pretend we haven't seen it.
282 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
287 rfd = ws_open(pipe_name, O_RDONLY | O_NONBLOCK, 0000 /* no creation so don't matter */);
289 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
290 pipe_name, g_strerror(errno));
294 #define PIPE_STR "\\pipe\\"
295 /* Under Windows, named pipes _must_ have the form
296 * "\\<server>\pipe\<pipe_name>". <server> may be "." for localhost.
298 pncopy = g_strdup(pipe_name);
299 if (strstr(pncopy, "\\\\") == pncopy) {
300 pos = strchr(pncopy + 3, '\\');
301 if (pos && g_ascii_strncasecmp(pos, PIPE_STR, strlen(PIPE_STR)) != 0)
308 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
313 /* Wait for the pipe to appear */
315 hPipe = CreateFile(utf_8to16(pipe_name), GENERIC_READ, 0, NULL,
316 OPEN_EXISTING, 0, NULL);
318 if (hPipe != INVALID_HANDLE_VALUE)
321 err = GetLastError();
322 if (err != ERROR_PIPE_BUSY) {
323 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER,
324 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
325 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s (error %d)\n",
326 pipe_name, utf_16to8(err_str), err);
331 if (!WaitNamedPipe(utf_8to16(pipe_name), 30 * 1000)) {
332 err = GetLastError();
333 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER,
334 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
335 fprintf(stderr, "rawshark: \"%s\" could not be waited for: %s (error %d)\n",
336 pipe_name, utf_16to8(err_str), err);
342 rfd = _open_osfhandle((long) hPipe, _O_RDONLY);
344 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
345 pipe_name, g_strerror(errno));
355 * Parse a link-type argument of the form "encap:<pcap dlt>" or
356 * "proto:<proto name>". "Pcap dlt" must be a name conforming to
357 * pcap_datalink_name_to_val() or an integer. "Proto name" must be
358 * a protocol name, e.g. "http".
361 set_link_type(const char *lt_arg) {
362 char *spec_ptr = strchr(lt_arg, ':');
366 dissector_handle_t dhandle;
374 if (strncmp(lt_arg, "encap:", strlen("encap:")) == 0) {
375 dlt_val = linktype_name_to_val(spec_ptr);
378 val = strtol(spec_ptr, &p, 10);
379 if (p == spec_ptr || *p != '\0' || errno != 0 || val > INT_MAX) {
384 encap = wtap_pcap_encap_to_wtap_encap(dlt_val);
385 if (encap == WTAP_ENCAP_UNKNOWN) {
389 } else if (strncmp(lt_arg, "proto:", strlen("proto:")) == 0) {
390 dhandle = find_dissector(spec_ptr);
392 encap = WTAP_ENCAP_USER0;
393 pref_str = g_string_new("uat:user_dlts:");
394 /* This must match the format used in the user_dlts file */
395 g_string_append_printf(pref_str,
396 "\"User 0 (DLT=147)\",\"%s\",\"0\",\"\",\"0\",\"\"",
398 if (prefs_set_pref(pref_str->str) != PREFS_SET_OK) {
399 g_string_free(pref_str, TRUE);
402 g_string_free(pref_str, TRUE);
410 show_version(GString *comp_info_str, GString *runtime_info_str)
412 printf("Rawshark " VERSION "%s\n"
419 wireshark_svnversion, get_copyright_info(), comp_info_str->str,
420 runtime_info_str->str);
424 main(int argc, char *argv[])
426 char *init_progfile_dir_error;
428 gboolean arg_error = FALSE;
434 char *gpf_path, *pf_path;
435 char *gdp_path, *dp_path;
436 int gpf_open_errno, gpf_read_errno;
437 int pf_open_errno, pf_read_errno;
438 int gdp_open_errno, gdp_read_errno;
439 int dp_open_errno, dp_read_errno;
441 gchar *pipe_name = NULL;
445 GLogLevelFlags log_flags;
446 GPtrArray *disp_fields = g_ptr_array_new();
448 gboolean skip_pcap_header = FALSE;
450 #define OPTSTRING_INIT "d:F:hlnN:o:pr:R:sS:t:v"
452 static const char optstring[] = OPTSTRING_INIT;
455 arg_list_utf_16to8(argc, argv);
459 * Get credential information for later use.
461 init_process_policies();
464 * Clear the filters arrays
466 memset(rfilters, 0, sizeof(rfilters));
467 memset(rfcodes, 0, sizeof(rfcodes));
472 * Initialize our string format
474 string_fmts = g_ptr_array_new();
477 * Attempt to get the pathname of the executable file.
479 init_progfile_dir_error = init_progfile_dir(argv[0], main);
480 if (init_progfile_dir_error != NULL) {
481 fprintf(stderr, "rawshark: Can't get pathname of rawshark program: %s.\n",
482 init_progfile_dir_error);
486 * Get credential information for later use.
488 init_process_policies();
490 /* nothing more than the standard GLib handler, but without a warning */
492 G_LOG_LEVEL_WARNING |
493 G_LOG_LEVEL_MESSAGE |
497 g_log_set_handler(NULL,
499 log_func_ignore, NULL /* user_data */);
500 g_log_set_handler(LOG_DOMAIN_CAPTURE_CHILD,
502 log_func_ignore, NULL /* user_data */);
504 timestamp_set_type(TS_RELATIVE);
505 timestamp_set_precision(TS_PREC_AUTO);
506 timestamp_set_seconds_type(TS_SECONDS_DEFAULT);
508 /* Register all dissectors; we must do this before checking for the
509 "-G" flag, as the "-G" flag dumps information registered by the
510 dissectors, and we must do it before we read the preferences, in
511 case any dissectors register preferences. */
512 epan_init(register_all_protocols, register_all_protocol_handoffs, NULL, NULL,
513 failure_message, open_failure_message, read_failure_message,
514 write_failure_message);
516 /* Now register the preferences for any non-dissector modules.
517 We must do that before we read the preferences as well. */
518 prefs_register_modules();
520 /* Set the C-language locale to the native environment. */
521 setlocale(LC_ALL, "");
523 prefs_p = read_prefs(&gpf_open_errno, &gpf_read_errno, &gpf_path,
524 &pf_open_errno, &pf_read_errno, &pf_path);
525 if (gpf_path != NULL) {
526 if (gpf_open_errno != 0) {
527 cmdarg_err("Can't open global preferences file \"%s\": %s.",
528 pf_path, g_strerror(gpf_open_errno));
530 if (gpf_read_errno != 0) {
531 cmdarg_err("I/O error reading global preferences file \"%s\": %s.",
532 pf_path, g_strerror(gpf_read_errno));
535 if (pf_path != NULL) {
536 if (pf_open_errno != 0) {
537 cmdarg_err("Can't open your preferences file \"%s\": %s.", pf_path,
538 g_strerror(pf_open_errno));
540 if (pf_read_errno != 0) {
541 cmdarg_err("I/O error reading your preferences file \"%s\": %s.",
542 pf_path, g_strerror(pf_read_errno));
548 /* Set the name resolution code's flags from the preferences. */
549 gbl_resolv_flags = prefs_p->name_resolve;
551 /* Read the disabled protocols file. */
552 read_disabled_protos_list(&gdp_path, &gdp_open_errno, &gdp_read_errno,
553 &dp_path, &dp_open_errno, &dp_read_errno);
554 if (gdp_path != NULL) {
555 if (gdp_open_errno != 0) {
556 cmdarg_err("Could not open global disabled protocols file\n\"%s\": %s.",
557 gdp_path, g_strerror(gdp_open_errno));
559 if (gdp_read_errno != 0) {
560 cmdarg_err("I/O error reading global disabled protocols file\n\"%s\": %s.",
561 gdp_path, g_strerror(gdp_read_errno));
565 if (dp_path != NULL) {
566 if (dp_open_errno != 0) {
568 "Could not open your disabled protocols file\n\"%s\": %s.", dp_path,
569 g_strerror(dp_open_errno));
571 if (dp_read_errno != 0) {
573 "I/O error reading your disabled protocols file\n\"%s\": %s.", dp_path,
574 g_strerror(dp_read_errno));
580 /* Load Wpcap, if possible */
584 cap_file_init(&cfile);
586 /* Print format defaults to this. */
587 print_format = PR_FMT_TEXT;
589 /* Initialize our encapsulation type */
590 encap = WTAP_ENCAP_UNKNOWN;
592 /* Now get our args */
593 /* XXX - We should probably have an option to dump libpcap link types */
594 while ((opt = getopt(argc, argv, optstring)) != -1) {
596 case 'd': /* Payload type */
597 if (!set_link_type(optarg)) {
598 cmdarg_err("Invalid link type or protocol \"%s\"", optarg);
602 case 'F': /* Read field to display */
603 g_ptr_array_add(disp_fields, g_strdup(optarg));
605 case 'h': /* Print help and exit */
609 case 'l': /* "Line-buffer" standard output */
610 /* This isn't line-buffering, strictly speaking, it's just
611 flushing the standard output after the information for
612 each packet is printed; however, that should be good
613 enough for all the purposes to which "-l" is put (and
614 is probably actually better for "-V", as it does fewer
617 See the comment in "process_packet()" for an explanation of
618 why we do that, and why we don't just use "setvbuf()" to
619 make the standard output line-buffered (short version: in
620 Windows, "line-buffered" is the same as "fully-buffered",
621 and the output buffer is only flushed when it fills up). */
622 line_buffered = TRUE;
624 case 'n': /* No name resolution */
625 gbl_resolv_flags = RESOLV_NONE;
627 case 'N': /* Select what types of addresses/port #s to resolve */
628 if (gbl_resolv_flags == RESOLV_ALL)
629 gbl_resolv_flags = RESOLV_NONE;
630 badopt = string_to_name_resolve(optarg, &gbl_resolv_flags);
631 if (badopt != '\0') {
632 cmdarg_err("-N specifies unknown resolving option '%c'; valid options are 'm', 'n', and 't'",
637 case 'o': /* Override preference from command line */
638 switch (prefs_set_pref(optarg)) {
643 case PREFS_SET_SYNTAX_ERR:
644 cmdarg_err("Invalid -o flag \"%s\"", optarg);
648 case PREFS_SET_NO_SUCH_PREF:
649 case PREFS_SET_OBSOLETE:
650 cmdarg_err("-o flag \"%s\" specifies unknown preference", optarg);
655 case 'p': /* Expect pcap_pkthdr packet headers, which may have 64-bit timestamps */
656 want_pcap_pkthdr = TRUE;
658 case 'r': /* Read capture file xxx */
659 pipe_name = g_strdup(optarg);
661 case 'R': /* Read file filter */
662 if(n_rfilters < (int) sizeof(rfilters) / (int) sizeof(rfilters[0])) {
663 rfilters[n_rfilters++] = optarg;
666 cmdarg_err("Too many display filters");
670 case 's': /* Skip PCAP header */
671 skip_pcap_header = TRUE;
673 case 'S': /* Print string representations */
674 if (!parse_field_string_format(optarg)) {
675 cmdarg_err("Invalid field string format");
679 case 't': /* Time stamp type */
680 if (strcmp(optarg, "r") == 0)
681 timestamp_set_type(TS_RELATIVE);
682 else if (strcmp(optarg, "a") == 0)
683 timestamp_set_type(TS_ABSOLUTE);
684 else if (strcmp(optarg, "ad") == 0)
685 timestamp_set_type(TS_ABSOLUTE_WITH_DATE);
686 else if (strcmp(optarg, "d") == 0)
687 timestamp_set_type(TS_DELTA);
688 else if (strcmp(optarg, "dd") == 0)
689 timestamp_set_type(TS_DELTA_DIS);
690 else if (strcmp(optarg, "e") == 0)
691 timestamp_set_type(TS_EPOCH);
692 else if (strcmp(optarg, "u") == 0)
693 timestamp_set_type(TS_UTC);
694 else if (strcmp(optarg, "ud") == 0)
695 timestamp_set_type(TS_UTC_WITH_DATE);
697 cmdarg_err("Invalid time stamp type \"%s\"",
699 cmdarg_err_cont("It must be \"r\" for relative, \"a\" for absolute,");
700 cmdarg_err_cont("\"ad\" for absolute with date, or \"d\" for delta.");
704 case 'v': /* Show version and exit */
706 GString *comp_info_str;
707 GString *runtime_info_str;
708 /* Assemble the compile-time version information string */
709 comp_info_str = g_string_new("Compiled ");
710 get_compiled_version_info(comp_info_str, NULL, epan_get_compiled_version_info);
712 /* Assemble the run-time version information string */
713 runtime_info_str = g_string_new("Running ");
714 get_runtime_version_info(runtime_info_str, NULL);
715 show_version(comp_info_str, runtime_info_str);
716 g_string_free(comp_info_str, TRUE);
717 g_string_free(runtime_info_str, TRUE);
722 case '?': /* Bad flag - print usage message */
729 /* Notify all registered modules that have had any of their preferences
730 changed either from one of the preferences file or from the command
731 line that their preferences have changed.
732 Initialize preferences before display filters, otherwise modules
733 like MATE won't work. */
736 /* Initialize our display fields */
737 for (fc = 0; fc < disp_fields->len; fc++) {
738 protocolinfo_init((char *)g_ptr_array_index(disp_fields, fc));
740 g_ptr_array_free(disp_fields, TRUE);
744 /* If no capture filter or read filter has been specified, and there are
745 still command-line arguments, treat them as the tokens of a capture
746 filter (if no "-r" flag was specified) or a read filter (if a "-r"
747 flag was specified. */
749 if (pipe_name != NULL) {
750 if (n_rfilters != 0) {
751 cmdarg_err("Read filters were specified both with \"-R\" "
752 "and with additional command-line arguments");
755 rfilters[n_rfilters] = get_args_as_string(argc, argv, optind);
759 /* Make sure we got a dissector handle for our payload. */
760 if (encap == WTAP_ENCAP_UNKNOWN) {
761 cmdarg_err("No valid payload dissector specified.");
772 /* Start windows sockets */
773 WSAStartup( MAKEWORD( 1, 1 ), &wsaData );
776 /* At this point MATE will have registered its field array so we can
777 have a tap filter with one of MATE's late-registered fields as part
778 of the filter. We can now process all the "-z" arguments. */
779 start_requested_stats();
781 /* disabled protocols as per configuration file */
782 if (gdp_path == NULL && dp_path == NULL) {
783 set_disabled_protos_list();
786 /* Build the column format array */
787 build_column_format_array(&cfile.cinfo, prefs_p->num_cols, TRUE);
789 if (n_rfilters != 0) {
790 for (i = 0; i < n_rfilters; i++) {
791 if (!dfilter_compile(rfilters[i], &rfcodes[n_rfcodes])) {
792 cmdarg_err("%s", dfilter_error_msg);
802 * We're reading a pipe (or capture file).
806 * Immediately relinquish any special privileges we have; we must not
807 * be allowed to read any capture files the user running Rawshark
810 relinquish_special_privs_perm();
812 if (raw_cf_open(&cfile, pipe_name) != CF_OK) {
817 /* Do we need to PCAP header and magic? */
818 if (skip_pcap_header) {
819 guint bytes_left = sizeof(struct pcap_hdr) + sizeof(guint32);
820 gchar buf[sizeof(struct pcap_hdr) + sizeof(guint32)];
821 while (bytes_left > 0) {
822 guint bytes = read(fd, buf, bytes_left);
824 cmdarg_err("Not enough bytes for pcap header.");
831 /* Set timestamp precision; there should arguably be a command-line
832 option to let the user set this. */
834 switch(wtap_file_tsprecision(cfile.wth)) {
835 case(WTAP_FILE_TSPREC_SEC):
836 timestamp_set_precision(TS_PREC_AUTO_SEC);
838 case(WTAP_FILE_TSPREC_DSEC):
839 timestamp_set_precision(TS_PREC_AUTO_DSEC);
841 case(WTAP_FILE_TSPREC_CSEC):
842 timestamp_set_precision(TS_PREC_AUTO_CSEC);
844 case(WTAP_FILE_TSPREC_MSEC):
845 timestamp_set_precision(TS_PREC_AUTO_MSEC);
847 case(WTAP_FILE_TSPREC_USEC):
848 timestamp_set_precision(TS_PREC_AUTO_USEC);
850 case(WTAP_FILE_TSPREC_NSEC):
851 timestamp_set_precision(TS_PREC_AUTO_NSEC);
854 g_assert_not_reached();
857 timestamp_set_precision(TS_PREC_AUTO_USEC);
860 /* Process the packets in the file */
861 err = load_cap_file(&cfile);
868 /* If you want to capture live packets, use TShark. */
869 cmdarg_err("Input file or pipe name not specified.");
879 * Read data from a raw pipe. The "raw" data consists of a libpcap
880 * packet header followed by the payload.
881 * @param fd [IN] A POSIX file descriptor. Because that's _exactly_ the sort
882 * of thing you want to use in Windows.
883 * @param phdr [OUT] Packet header information.
884 * @param err [OUT] Error indicator. Uses wiretap values.
885 * @param err_info [OUT] Error message.
886 * @param data_offset [OUT] data offset in the pipe.
887 * @return TRUE on success, FALSE on failure.
890 raw_pipe_read(struct wtap_pkthdr *phdr, guchar * pd, int *err, const gchar **err_info, gint64 *data_offset) {
891 struct pcap_pkthdr mem_hdr;
892 struct pcaprec_hdr disk_hdr;
894 int bytes_needed = sizeof(disk_hdr);
895 guchar *ptr = (guchar*) &disk_hdr;
896 static gchar err_str[100];
898 if (want_pcap_pkthdr) {
899 bytes_needed = sizeof(mem_hdr);
900 ptr = (guchar*) &mem_hdr;
903 /* Copied from capture_loop.c */
904 while (bytes_needed > 0) {
905 bytes_read = read(fd, ptr, bytes_needed);
906 if (bytes_read == 0) {
909 } else if (bytes_read < 0) {
910 *err = WTAP_ERR_CANT_READ;
911 *err_info = "Error reading header from pipe";
914 bytes_needed -= bytes_read;
915 *data_offset += bytes_read;
919 if (want_pcap_pkthdr) {
920 phdr->ts.secs = mem_hdr.ts.tv_sec;
921 phdr->ts.nsecs = mem_hdr.ts.tv_usec * 1000;
922 phdr->caplen = bytes_needed = mem_hdr.caplen;
923 phdr->len = mem_hdr.len;
925 phdr->ts.secs = disk_hdr.ts_sec;
926 phdr->ts.nsecs = disk_hdr.ts_usec * 1000;
927 phdr->caplen = bytes_needed = disk_hdr.incl_len;
928 phdr->len = disk_hdr.orig_len;
931 phdr->pkt_encap = encap;
934 printf("tv_sec: %d (%04x)\n", hdr.ts.tv_sec, hdr.ts.tv_sec);
935 printf("tv_usec: %d (%04x)\n", hdr.ts.tv_usec, hdr.ts.tv_usec);
936 printf("caplen: %d (%04x)\n", hdr.caplen, hdr.caplen);
937 printf("len: %d (%04x)\n", hdr.len, hdr.len);
939 if (bytes_needed > WTAP_MAX_PACKET_SIZE) {
940 *err = WTAP_ERR_BAD_RECORD;
941 g_snprintf(err_str, 100, "Bad packet length: %d (%04x)", bytes_needed, bytes_needed);
947 while (bytes_needed > 0) {
948 bytes_read = read(fd, ptr, bytes_needed);
949 if (bytes_read == 0) {
950 *err = WTAP_ERR_SHORT_READ;
951 *err_info = "Got zero bytes reading data from pipe";
953 } else if (bytes_read < 0) {
954 *err = WTAP_ERR_CANT_READ;
955 *err_info = "Error reading data from pipe";
958 bytes_needed -= bytes_read;
959 *data_offset += bytes_read;
966 load_cap_file(capture_file *cf)
969 const gchar *err_info;
970 gint64 data_offset = 0;
971 struct wtap_pkthdr phdr;
972 guchar pd[WTAP_MAX_PACKET_SIZE];
974 while (raw_pipe_read(&phdr, pd, &err, &err_info, &data_offset)) {
975 process_packet(cf, data_offset, &phdr, pd);
979 /* Print a message noting that the read failed somewhere along the line. */
982 case WTAP_ERR_UNSUPPORTED_ENCAP:
983 cmdarg_err("The file \"%s\" has a packet with a network type that Rawshark doesn't support.\n(%s)",
984 cf->filename, err_info);
987 case WTAP_ERR_CANT_READ:
988 cmdarg_err("An attempt to read from the file \"%s\" failed for some unknown reason.",
992 case WTAP_ERR_SHORT_READ:
993 cmdarg_err("The file \"%s\" appears to have been cut short in the middle of a packet.",
997 case WTAP_ERR_BAD_RECORD:
998 cmdarg_err("The file \"%s\" appears to be damaged or corrupt.\n(%s)",
999 cf->filename, err_info);
1002 case WTAP_ERR_DECOMPRESS:
1003 cmdarg_err("The compressed file \"%s\" appears to be damaged or corrupt.\n(%s)",
1004 cf->filename, err_info);
1008 cmdarg_err("An error occurred while reading the file \"%s\": %s.",
1009 cf->filename, wtap_strerror(err));
1018 process_packet(capture_file *cf, gint64 offset, const struct wtap_pkthdr *whdr,
1022 gboolean create_proto_tree;
1025 union wtap_pseudo_header pseudo_header;
1030 /* The user sends an empty packet when he wants to get output from us even if we don't currently have
1031 packets to process. We spit out a line with the timestamp and the text "void"
1033 printf("%lu %lu %lu void -\n", (unsigned long int)cf->count,
1034 (unsigned long int)whdr->ts.secs,
1035 (unsigned long int)whdr->ts.nsecs);
1042 memset(&pseudo_header, 0, sizeof(pseudo_header));
1044 /* Count this packet. */
1047 /* If we're going to print packet information, or we're going to
1048 run a read filter, or we're going to process taps, set up to
1049 do a dissection and do so. */
1050 frame_data_init(&fdata, cf->count, whdr, offset, cum_bytes);
1053 create_proto_tree = TRUE;
1055 /* The protocol tree will be "visible", i.e., printed, only if we're
1056 printing packet details, which is true if we're in verbose mode ("verbose"
1058 epan_dissect_init(&edt, create_proto_tree, FALSE);
1060 /* If we're running a read filter, prime the epan_dissect_t with that
1062 if (n_rfilters > 0) {
1063 for(i = 0; i < n_rfcodes; i++) {
1064 epan_dissect_prime_dfilter(&edt, rfcodes[i]);
1068 tap_queue_init(&edt);
1070 printf("%lu", (unsigned long int) cf->count);
1072 frame_data_set_before_dissect(&fdata, &cf->elapsed_time,
1073 &first_ts, &prev_dis_ts, &prev_cap_ts);
1075 /* We only need the columns if we're printing packet info but we're
1076 *not* verbose; in verbose mode, we print the protocol tree, not
1077 the protocol summary. */
1078 epan_dissect_run(&edt, &pseudo_header, pd, &fdata, &cf->cinfo);
1080 tap_push_tapped_queue(&edt);
1082 frame_data_set_after_dissect(&fdata, &cum_bytes, &prev_dis_ts);
1084 for(i = 0; i < n_rfilters; i++) {
1085 /* Run the read filter if we have one. */
1087 passed = dfilter_apply_edt(rfcodes[i], &edt);
1091 /* Print a one-line summary */
1092 printf(" %u", passed ? 1 : 0);
1097 /* The ANSI C standard does not appear to *require* that a line-buffered
1098 stream be flushed to the host environment whenever a newline is
1099 written, it just says that, on such a stream, characters "are
1100 intended to be transmitted to or from the host environment as a
1101 block when a new-line character is encountered".
1103 The Visual C++ 6.0 C implementation doesn't do what is intended;
1104 even if you set a stream to be line-buffered, it still doesn't
1105 flush the buffer at the end of every line.
1107 So, if the "-l" flag was specified, we flush the standard output
1108 at the end of a packet. This will do the right thing if we're
1109 printing packet summary lines, and, as we print the entire protocol
1110 tree for a single packet without waiting for anything to happen,
1111 it should be as good as line-buffered mode if we're printing
1112 protocol trees. (The whole reason for the "-l" flag in either
1113 tcpdump or Rawshark is to allow the output of a live capture to
1114 be piped to a program or script and to have that script see the
1115 information for the packet as soon as it's printed, rather than
1116 having to wait until a standard I/O buffer fills up. */
1120 if (ferror(stdout)) {
1121 show_print_file_io_error(errno);
1125 epan_dissect_cleanup(&edt);
1126 frame_data_cleanup(&fdata);
1131 /****************************************************************************************
1132 * FIELD EXTRACTION ROUTINES
1133 ****************************************************************************************/
1134 typedef struct _pci_t {
1140 static const char* ftenum_to_string(header_field_info *hfi)
1146 if (string_fmts->len > 0 && hfi->strings) {
1154 return "FT_PROTOCOL";
1156 return "FT_BOOLEAN";
1181 case FT_ABSOLUTE_TIME:
1182 return "FT_ABSOLUTE_TIME";
1183 case FT_RELATIVE_TIME:
1184 return "FT_RELATIVE_TIME";
1188 return "FT_STRINGZ";
1189 case FT_UINT_STRING:
1190 return "FT_UINT_STRING";
1196 return "FT_UINT_BYTES";
1204 return "FT_FRAMENUM";
1212 return "FT_NUM_TYPES";
1218 static const char* absolute_time_display_e_to_string(absolute_time_display_e atd)
1221 case ABSOLUTE_TIME_LOCAL:
1222 return "ABSOLUTE_TIME_LOCAL";
1223 case ABSOLUTE_TIME_UTC:
1224 return "ABSOLUTE_TIME_UTC";
1230 static const char* base_display_e_to_string(base_display_e bd)
1242 return "BASE_DEC_HEX";
1244 return "BASE_HEX_DEC";
1251 * Copied from various parts of proto.c
1253 #define FIELD_STR_INIT_LEN 256
1254 #define cVALS(x) (const value_string*)(x)
1255 static gboolean print_field_value(field_info *finfo, int cmd_line_index)
1257 header_field_info *hfinfo;
1258 static char *fs_buf = NULL;
1259 char *fs_ptr = fs_buf;
1260 static GString *label_s = NULL;
1261 int fs_buf_len = FIELD_STR_INIT_LEN, fs_len;
1266 const true_false_string *tfstring = &tfs_true_false;
1268 hfinfo = finfo->hfinfo;
1271 fs_buf = (char *)g_malloc(fs_buf_len + 1);
1276 label_s = g_string_new("");
1279 if(finfo->value.ftype->val_to_string_repr)
1282 * this field has an associated value,
1285 fs_len = fvalue_string_repr_len(&finfo->value, FTREPR_DFILTER);
1286 while (fs_buf_len < fs_len) {
1288 fs_buf = (char *)g_realloc(fs_buf, fs_buf_len + 1);
1291 fvalue_to_string_repr(&finfo->value,
1295 /* String types are quoted. Remove them. */
1296 if ((finfo->value.ftype->ftype == FT_STRING || finfo->value.ftype->ftype == FT_STRINGZ) && fs_len > 2) {
1297 fs_buf[fs_len - 1] = '\0';
1302 if (string_fmts->len > 0 && finfo->hfinfo->strings) {
1303 g_string_truncate(label_s, 0);
1304 for (i = 0; i < string_fmts->len; i++) {
1305 sf = (string_fmt_t *)g_ptr_array_index(string_fmts, i);
1307 g_string_append(label_s, sf->plain);
1309 switch (sf->format) {
1311 g_string_append(label_s, hfinfo->name);
1314 g_string_append(label_s, fs_ptr);
1317 switch(hfinfo->type) {
1319 uvalue = fvalue_get_uinteger(&finfo->value);
1320 tfstring = (const struct true_false_string*) hfinfo->strings;
1321 g_string_append(label_s, uvalue ? tfstring->true_string : tfstring->false_string);
1327 DISSECTOR_ASSERT(!hfinfo->bitmask);
1328 svalue = fvalue_get_sinteger(&finfo->value);
1329 if (hfinfo->display & BASE_RANGE_STRING) {
1330 g_string_append(label_s, rval_to_str(svalue, RVALS(hfinfo->strings), "Unknown"));
1331 } else if (hfinfo->display & BASE_EXT_STRING) {
1332 g_string_append(label_s, val_to_str_ext(svalue, (value_string_ext *) hfinfo->strings, "Unknown"));
1334 g_string_append(label_s, val_to_str(svalue, cVALS(hfinfo->strings), "Unknown"));
1341 uvalue = fvalue_get_uinteger(&finfo->value);
1342 if (!hfinfo->bitmask && hfinfo->display & BASE_RANGE_STRING) {
1343 g_string_append(label_s, rval_to_str(uvalue, RVALS(hfinfo->strings), "Unknown"));
1344 } else if (hfinfo->display & BASE_EXT_STRING) {
1345 g_string_append(label_s, val_to_str_ext(uvalue, (value_string_ext *) hfinfo->strings, "Unknown"));
1347 g_string_append(label_s, val_to_str(uvalue, cVALS(hfinfo->strings), "Unknown"));
1359 printf(" %u=\"%s\"", cmd_line_index, label_s->str);
1363 if(finfo->value.ftype->val_to_string_repr)
1365 printf(" %u=\"%s\"", cmd_line_index, fs_ptr);
1370 * This field doesn't have an associated value,
1374 printf(" %u=\"n.a.\"", cmd_line_index);
1379 protocolinfo_packet(void *prs, packet_info *pinfo _U_, epan_dissect_t *edt, const void *dummy _U_)
1381 pci_t *rs=(pci_t *)prs;
1385 gp=proto_get_finfo_ptr_array(edt->tree, rs->hf_index);
1392 * Print each occurrence of the field
1394 for (i = 0; i < gp->len; i++) {
1395 print_field_value((field_info *)gp->pdata[i], rs->cmd_line_index);
1401 int g_cmd_line_index = 0;
1404 * field must be persistent - we don't g_strdup() it below
1407 protocolinfo_init(char *field)
1410 header_field_info *hfi;
1411 GString *error_string;
1413 hfi=proto_registrar_get_byname(field);
1415 fprintf(stderr, "rawshark: Field \"%s\" doesn't exist.\n", field);
1419 switch (hfi->type) {
1421 case FT_ABSOLUTE_TIME:
1422 printf("%u %s %s - ",
1424 ftenum_to_string(hfi),
1425 absolute_time_display_e_to_string(hfi->display));
1430 printf("%u %s %s - ",
1432 ftenum_to_string(hfi),
1433 base_display_e_to_string(hfi->display));
1437 rs=(pci_t *)g_malloc(sizeof(pci_t));
1438 rs->hf_index=hfi->id;
1440 rs->cmd_line_index = g_cmd_line_index++;
1442 error_string=register_tap_listener("frame", rs, rs->filter, TL_REQUIRES_PROTO_TREE, NULL, protocolinfo_packet, NULL);
1444 /* error, we failed to attach to the tap. complain and clean up */
1445 fprintf(stderr, "rawshark: Couldn't register field extraction tap: %s\n",
1447 g_string_free(error_string, TRUE);
1458 * Given a format string, split it into a GPtrArray of string_fmt_t structs
1459 * and fill in string_fmt_parts.
1463 add_string_fmt(string_fmt_e format, gchar *plain) {
1464 string_fmt_t *sf = (string_fmt_t *)g_malloc(sizeof(string_fmt_t));
1466 sf->format = format;
1467 sf->plain = g_strdup(plain);
1469 g_ptr_array_add(string_fmts, sf);
1473 parse_field_string_format(gchar *format) {
1474 GString *plain_s = g_string_new("");
1482 len = strlen(format);
1483 g_ptr_array_set_size(string_fmts, 0);
1486 if (format[pos] == '%') {
1487 if (pos >= len) { /* There should always be a following character */
1491 if (plain_s->len > 0) {
1492 add_string_fmt(SF_NONE, plain_s->str);
1493 g_string_truncate(plain_s, 0);
1495 switch (format[pos]) {
1497 add_string_fmt(SF_NAME, NULL);
1500 add_string_fmt(SF_NUMVAL, NULL);
1503 add_string_fmt(SF_STRVAL, NULL);
1506 g_string_append_c(plain_s, '%');
1508 default: /* Invalid format */
1512 g_string_append_c(plain_s, format[pos]);
1517 if (plain_s->len > 0) {
1518 add_string_fmt(SF_NONE, plain_s->str);
1520 g_string_free(plain_s, TRUE);
1524 /****************************************************************************************
1525 * END OF FIELD EXTRACTION ROUTINES
1526 ****************************************************************************************/
1529 show_print_file_io_error(int err)
1534 cmdarg_err("Not all the packets could be printed because there is "
1535 "no space left on the file system.");
1540 cmdarg_err("Not all the packets could be printed because you are "
1541 "too close to, or over your disk quota.");
1546 cmdarg_err("An error occurred while printing packets: %s.",
1553 * Open/create errors are reported with an console message in Rawshark.
1556 open_failure_message(const char *filename, int err, gboolean for_writing)
1558 fprintf(stderr, "rawshark: ");
1559 fprintf(stderr, file_open_error_message(err, for_writing), filename);
1560 fprintf(stderr, "\n");
1564 raw_cf_open(capture_file *cf, const char *fname)
1566 if ((fd = raw_pipe_open(fname)) < 0)
1569 /* The open succeeded. Fill in the information for this file. */
1571 /* Cleanup all data structures used for dissection. */
1572 cleanup_dissection();
1573 /* Initialize all data structures used for dissection. */
1577 cf->f_datalen = 0; /* not used, but set it anyway */
1579 /* Set the file name because we need it to set the follow stream filter.
1580 XXX - is that still true? We need it for other reasons, though,
1582 cf->filename = g_strdup(fname);
1584 /* Indicate whether it's a permanent or temporary file. */
1585 cf->is_tempfile = FALSE;
1587 /* If it's a temporary capture buffer file, mark it as not saved. */
1588 cf->user_saved = FALSE;
1590 cf->cd_t = WTAP_FILE_UNKNOWN;
1592 cf->drops_known = FALSE;
1594 cf->has_snap = FALSE;
1595 cf->snap = WTAP_MAX_PACKET_SIZE;
1596 nstime_set_zero(&cf->elapsed_time);
1597 nstime_set_unset(&first_ts);
1598 nstime_set_unset(&prev_dis_ts);
1599 nstime_set_unset(&prev_cap_ts);
1606 * General errors are reported with an console message in Rawshark.
1609 failure_message(const char *msg_format, va_list ap)
1611 fprintf(stderr, "rawshark: ");
1612 vfprintf(stderr, msg_format, ap);
1613 fprintf(stderr, "\n");
1617 * Read errors are reported with an console message in Rawshark.
1620 read_failure_message(const char *filename, int err)
1622 cmdarg_err("An error occurred while reading from the file \"%s\": %s.",
1623 filename, g_strerror(err));
1627 * Write errors are reported with an console message in Rawshark.
1630 write_failure_message(const char *filename, int err)
1632 cmdarg_err("An error occurred while writing to the file \"%s\": %s.",
1633 filename, g_strerror(err));
1637 * Report an error in command-line arguments.
1640 cmdarg_err(const char *fmt, ...)
1645 fprintf(stderr, "rawshark: ");
1646 vfprintf(stderr, fmt, ap);
1647 fprintf(stderr, "\n");
1652 * Report additional information for an error in command-line arguments.
1655 cmdarg_err_cont(const char *fmt, ...)
1660 vfprintf(stderr, fmt, ap);
1661 fprintf(stderr, "\n");
1672 * indent-tabs-mode: nil
1675 * ex: set shiftwidth=4 tabstop=8 expandtab
1676 * :indentSize=4:tabSize=8:noTabs=true: