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>
64 #ifdef NEED_STRERROR_H
65 #include "wsutil/strerror.h"
71 #include "wsutil/wsgetopt.h"
75 #include <epan/epan.h>
76 #include <epan/filesystem.h>
77 #include <wsutil/privileges.h>
78 #include <wsutil/file_util.h>
81 #include <epan/packet.h>
83 #include "disabled_protos.h"
84 #include <epan/prefs.h>
85 #include <epan/column.h>
87 #include <epan/addr_resolv.h>
89 #include "clopts_common.h"
90 #include "cmdarg_err.h"
91 #include "version_info.h"
92 #include <epan/plugins.h>
94 #include "conditions.h"
95 #include "capture_stop_conditions.h"
96 #include "capture_ui_utils.h"
97 #include <epan/epan_dissect.h>
98 #include <epan/stat_cmd_args.h>
99 #include <epan/timestamp.h>
100 #include <wsutil/unicode-utils.h>
101 #include "epan/column-utils.h"
102 #include "epan/proto.h"
103 #include <epan/tap.h>
105 #include <wiretap/wtap.h>
106 #include <wiretap/libpcap.h>
107 #include <wiretap/pcap-encap.h>
111 #include "capture-pcap-util.h"
114 #include "capture-wpcap.h"
115 #include "capture_errs.h"
117 #endif /* HAVE_LIBPCAP */
121 #include <wsutil/unicode-utils.h>
125 * This is the template for the decode as option; it is shared between the
126 * various functions that output the usage for this parameter.
128 static const gchar decode_as_arg_template[] = "<layer_type>==<selector>,<decode_as_protocol>";
130 static guint32 cum_bytes;
131 static nstime_t first_ts;
132 static nstime_t prev_dis_ts;
133 static nstime_t prev_cap_ts;
136 * The way the packet decode is to be written.
139 WRITE_TEXT, /* summary or detail text */
140 WRITE_XML /* PDML or PSML */
141 /* Add CSV and the like here */
144 static gboolean line_buffered;
145 static print_format_e print_format = PR_FMT_TEXT;
147 static gboolean want_pcap_pkthdr;
149 cf_status_t raw_cf_open(capture_file *cf, const char *fname);
150 static int load_cap_file(capture_file *cf);
151 static gboolean process_packet(capture_file *cf, gint64 offset,
152 const struct wtap_pkthdr *whdr, const guchar *pd);
153 static void show_print_file_io_error(int err);
155 static void open_failure_message(const char *filename, int err,
156 gboolean for_writing);
157 static void failure_message(const char *msg_format, va_list ap);
158 static void read_failure_message(const char *filename, int err);
159 static void write_failure_message(const char *filename, int err);
160 static void protocolinfo_init(char *field);
161 static gboolean parse_field_string_format(char *format);
164 SF_NONE, /* No format (placeholder) */
165 SF_NAME, /* %D Field name / description */
166 SF_NUMVAL, /* %N Numeric value */
167 SF_STRVAL /* %S String value */
170 typedef struct string_fmt_s {
172 string_fmt_e format; /* Valid if plain is NULL */
178 dfilter_t *rfcodes[64];
180 dfilter_t *rfieldfcodes[64];
183 GPtrArray *string_fmts;
186 print_usage(gboolean print_ver)
193 "Rawshark " VERSION "%s\n"
194 "Dump and analyze network traffic.\n"
195 "See http://www.wireshark.org for more information.\n"
198 wireshark_svnversion, get_copyright_info());
202 fprintf(output, "\n");
203 fprintf(output, "Usage: rawshark [options] ...\n");
204 fprintf(output, "\n");
206 fprintf(output, "Input file:\n");
207 fprintf(output, " -r <infile> set the pipe or file name to read from\n");
209 fprintf(output, "\n");
210 fprintf(output, "Processing:\n");
211 fprintf(output, " -d <encap:dlt>|<proto:protoname>\n");
212 fprintf(output, " packet encapsulation or protocol\n");
213 fprintf(output, " -F <field> field to display\n");
214 fprintf(output, " -n disable all name resolution (def: all enabled)\n");
215 fprintf(output, " -N <name resolve flags> enable specific name resolution(s): \"mntC\"\n");
216 fprintf(output, " -p use the system's packet header format (which may have 64-bit timestamps)\n");
217 fprintf(output, " -R <read filter> packet filter in Wireshark display filter syntax\n");
218 fprintf(output, " -s skip PCAP header on input\n");
220 /*fprintf(output, "\n");*/
221 fprintf(output, "Output:\n");
222 fprintf(output, " -l flush output after each packet\n");
223 fprintf(output, " -S format string for fields (%%D - name, %%S - stringval, %%N numval)\n");
224 fprintf(output, " -t ad|a|r|d|dd|e output format of time stamps (def: r: rel. to first)\n");
226 fprintf(output, "\n");
227 fprintf(output, "Miscellaneous:\n");
228 fprintf(output, " -h display this help and exit\n");
229 fprintf(output, " -o <name>:<value> ... override preference setting\n");
230 fprintf(output, " -v display version info and exit\n");
234 log_func_ignore (const gchar *log_domain _U_, GLogLevelFlags log_level _U_,
235 const gchar *message _U_, gpointer user_data _U_)
240 * Open a pipe for raw input. This is a stripped-down version of
241 * pcap_loop.c:cap_pipe_open_live().
242 * We check if "pipe_name" is "-" (stdin) or a FIFO, and open it.
243 * @param pipe_name The name of the pipe or FIFO.
244 * @return A POSIX file descriptor on success, or -1 on failure.
247 raw_pipe_open(const char *pipe_name)
250 ws_statb64 pipe_stat;
259 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "open_raw_pipe: %s", pipe_name);
262 * XXX Rawshark blocks until we return
264 if (strcmp(pipe_name, "-") == 0) {
265 rfd = 0; /* read from stdin */
268 * This is needed to set the stdin pipe into binary mode, otherwise
269 * CR/LF are mangled...
271 _setmode(0, _O_BINARY);
275 if (ws_stat64(pipe_name, &pipe_stat) < 0) {
276 fprintf(stderr, "rawshark: The pipe %s could not be checked: %s\n",
277 pipe_name, strerror(errno));
280 if (! S_ISFIFO(pipe_stat.st_mode)) {
281 if (S_ISCHR(pipe_stat.st_mode)) {
283 * Assume the user specified an interface on a system where
284 * interfaces are in /dev. Pretend we haven't seen it.
288 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
293 rfd = ws_open(pipe_name, O_RDONLY | O_NONBLOCK, 0000 /* no creation so don't matter */);
295 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
296 pipe_name, strerror(errno));
300 #define PIPE_STR "\\pipe\\"
301 /* Under Windows, named pipes _must_ have the form
302 * "\\<server>\pipe\<pipe_name>". <server> may be "." for localhost.
304 pncopy = g_strdup(pipe_name);
305 if (strstr(pncopy, "\\\\") == pncopy) {
306 pos = strchr(pncopy + 3, '\\');
307 if (pos && g_ascii_strncasecmp(pos, PIPE_STR, strlen(PIPE_STR)) != 0)
314 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
319 /* Wait for the pipe to appear */
321 hPipe = CreateFile(utf_8to16(pipe_name), GENERIC_READ, 0, NULL,
322 OPEN_EXISTING, 0, NULL);
324 if (hPipe != INVALID_HANDLE_VALUE)
327 err = GetLastError();
328 if (err != ERROR_PIPE_BUSY) {
329 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER,
330 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
331 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s (error %d)\n",
332 pipe_name, utf_16to8(err_str), err);
337 if (!WaitNamedPipe(utf_8to16(pipe_name), 30 * 1000)) {
338 err = GetLastError();
339 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER,
340 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
341 fprintf(stderr, "rawshark: \"%s\" could not be waited for: %s (error %d)\n",
342 pipe_name, utf_16to8(err_str), err);
348 rfd = _open_osfhandle((long) hPipe, _O_RDONLY);
350 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
351 pipe_name, strerror(errno));
361 * Parse a link-type argument of the form "encap:<pcap dlt>" or
362 * "proto:<proto name>". "Pcap dlt" must be a name conforming to
363 * pcap_datalink_name_to_val() or an integer. "Proto name" must be
364 * a protocol name, e.g. "http".
367 set_link_type(const char *lt_arg) {
368 char *spec_ptr = strchr(lt_arg, ':');
372 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) {
390 encap = wtap_pcap_encap_to_wtap_encap(dlt_val);
391 if (encap == WTAP_ENCAP_UNKNOWN) {
395 } else if (strncmp(lt_arg, "proto:", strlen("proto:")) == 0) {
396 dhandle = find_dissector(spec_ptr);
398 encap = WTAP_ENCAP_USER0;
399 pref_str = g_string_new("uat:user_dlts:");
400 /* This must match the format used in the user_dlts file */
401 g_string_append_printf(pref_str,
402 "\"User 0 (DLT=147)\",\"%s\",\"0\",\"\",\"0\",\"\"",
404 if (prefs_set_pref(pref_str->str) != PREFS_SET_OK) {
405 g_string_free(pref_str, TRUE);
408 g_string_free(pref_str, TRUE);
416 show_version(GString *comp_info_str, GString *runtime_info_str)
418 printf("Rawshark " VERSION "%s\n"
425 wireshark_svnversion, get_copyright_info(), comp_info_str->str,
426 runtime_info_str->str);
430 main(int argc, char *argv[])
432 char *init_progfile_dir_error;
434 gboolean arg_error = FALSE;
440 char *gpf_path, *pf_path;
441 char *gdp_path, *dp_path;
442 int gpf_open_errno, gpf_read_errno;
443 int pf_open_errno, pf_read_errno;
444 int gdp_open_errno, gdp_read_errno;
445 int dp_open_errno, dp_read_errno;
447 gchar *pipe_name = NULL;
451 GLogLevelFlags log_flags;
452 GPtrArray *disp_fields = g_ptr_array_new();
454 gboolean skip_pcap_header = FALSE;
456 #define OPTSTRING_INIT "d:F:hlnN:o:pr:R:sS:t:v"
458 static const char optstring[] = OPTSTRING_INIT;
461 arg_list_utf_16to8(argc, argv);
465 * Get credential information for later use.
467 init_process_policies();
470 * Clear the filters arrays
472 memset(rfilters, 0, sizeof(rfilters));
473 memset(rfcodes, 0, sizeof(rfcodes));
478 * Initialize our string format
480 string_fmts = g_ptr_array_new();
483 * Attempt to get the pathname of the executable file.
485 init_progfile_dir_error = init_progfile_dir(argv[0], main);
486 if (init_progfile_dir_error != NULL) {
487 fprintf(stderr, "rawshark: Can't get pathname of rawshark program: %s.\n",
488 init_progfile_dir_error);
492 * Get credential information for later use.
494 init_process_policies();
496 /* nothing more than the standard GLib handler, but without a warning */
498 G_LOG_LEVEL_WARNING |
499 G_LOG_LEVEL_MESSAGE |
503 g_log_set_handler(NULL,
505 log_func_ignore, NULL /* user_data */);
506 g_log_set_handler(LOG_DOMAIN_CAPTURE_CHILD,
508 log_func_ignore, NULL /* user_data */);
510 timestamp_set_type(TS_RELATIVE);
511 timestamp_set_precision(TS_PREC_AUTO);
512 timestamp_set_seconds_type(TS_SECONDS_DEFAULT);
514 /* Register all dissectors; we must do this before checking for the
515 "-G" flag, as the "-G" flag dumps information registered by the
516 dissectors, and we must do it before we read the preferences, in
517 case any dissectors register preferences. */
518 epan_init(register_all_protocols, register_all_protocol_handoffs, NULL, NULL,
519 failure_message, open_failure_message, read_failure_message,
520 write_failure_message);
522 /* Now register the preferences for any non-dissector modules.
523 We must do that before we read the preferences as well. */
524 prefs_register_modules();
526 /* Set the C-language locale to the native environment. */
527 setlocale(LC_ALL, "");
529 prefs_p = read_prefs(&gpf_open_errno, &gpf_read_errno, &gpf_path,
530 &pf_open_errno, &pf_read_errno, &pf_path);
531 if (gpf_path != NULL) {
532 if (gpf_open_errno != 0) {
533 cmdarg_err("Can't open global preferences file \"%s\": %s.",
534 pf_path, strerror(gpf_open_errno));
536 if (gpf_read_errno != 0) {
537 cmdarg_err("I/O error reading global preferences file \"%s\": %s.",
538 pf_path, strerror(gpf_read_errno));
541 if (pf_path != NULL) {
542 if (pf_open_errno != 0) {
543 cmdarg_err("Can't open your preferences file \"%s\": %s.", pf_path,
544 strerror(pf_open_errno));
546 if (pf_read_errno != 0) {
547 cmdarg_err("I/O error reading your preferences file \"%s\": %s.",
548 pf_path, strerror(pf_read_errno));
554 /* Set the name resolution code's flags from the preferences. */
555 gbl_resolv_flags = prefs_p->name_resolve;
557 /* Read the disabled protocols file. */
558 read_disabled_protos_list(&gdp_path, &gdp_open_errno, &gdp_read_errno,
559 &dp_path, &dp_open_errno, &dp_read_errno);
560 if (gdp_path != NULL) {
561 if (gdp_open_errno != 0) {
562 cmdarg_err("Could not open global disabled protocols file\n\"%s\": %s.",
563 gdp_path, strerror(gdp_open_errno));
565 if (gdp_read_errno != 0) {
566 cmdarg_err("I/O error reading global disabled protocols file\n\"%s\": %s.",
567 gdp_path, strerror(gdp_read_errno));
571 if (dp_path != NULL) {
572 if (dp_open_errno != 0) {
574 "Could not open your disabled protocols file\n\"%s\": %s.", dp_path,
575 strerror(dp_open_errno));
577 if (dp_read_errno != 0) {
579 "I/O error reading your disabled protocols file\n\"%s\": %s.", dp_path,
580 strerror(dp_read_errno));
586 /* Load Wpcap, if possible */
590 cap_file_init(&cfile);
592 /* Print format defaults to this. */
593 print_format = PR_FMT_TEXT;
595 /* Initialize our encapsulation type */
596 encap = WTAP_ENCAP_UNKNOWN;
598 /* Now get our args */
599 /* XXX - We should probably have an option to dump libpcap link types */
600 while ((opt = getopt(argc, argv, optstring)) != -1) {
602 case 'd': /* Payload type */
603 if (!set_link_type(optarg)) {
604 cmdarg_err("Invalid link type or protocol \"%s\"", optarg);
608 case 'F': /* Read field to display */
609 g_ptr_array_add(disp_fields, g_strdup(optarg));
611 case 'h': /* Print help and exit */
615 case 'l': /* "Line-buffer" standard output */
616 /* This isn't line-buffering, strictly speaking, it's just
617 flushing the standard output after the information for
618 each packet is printed; however, that should be good
619 enough for all the purposes to which "-l" is put (and
620 is probably actually better for "-V", as it does fewer
623 See the comment in "process_packet()" for an explanation of
624 why we do that, and why we don't just use "setvbuf()" to
625 make the standard output line-buffered (short version: in
626 Windows, "line-buffered" is the same as "fully-buffered",
627 and the output buffer is only flushed when it fills up). */
628 line_buffered = TRUE;
630 case 'n': /* No name resolution */
631 gbl_resolv_flags = RESOLV_NONE;
633 case 'N': /* Select what types of addresses/port #s to resolve */
634 if (gbl_resolv_flags == RESOLV_ALL)
635 gbl_resolv_flags = RESOLV_NONE;
636 badopt = string_to_name_resolve(optarg, &gbl_resolv_flags);
637 if (badopt != '\0') {
638 cmdarg_err("-N specifies unknown resolving option '%c'; valid options are 'm', 'n', and 't'",
643 case 'o': /* Override preference from command line */
644 switch (prefs_set_pref(optarg)) {
649 case PREFS_SET_SYNTAX_ERR:
650 cmdarg_err("Invalid -o flag \"%s\"", optarg);
654 case PREFS_SET_NO_SUCH_PREF:
655 case PREFS_SET_OBSOLETE:
656 cmdarg_err("-o flag \"%s\" specifies unknown preference", optarg);
661 case 'p': /* Expect pcap_pkthdr packet headers, which may have 64-bit timestamps */
662 want_pcap_pkthdr = TRUE;
664 case 'r': /* Read capture file xxx */
665 pipe_name = g_strdup(optarg);
667 case 'R': /* Read file filter */
668 if(n_rfilters < (int) sizeof(rfilters) / (int) sizeof(rfilters[0])) {
669 rfilters[n_rfilters++] = optarg;
672 cmdarg_err("Too many display filters");
676 case 's': /* Skip PCAP header */
677 skip_pcap_header = TRUE;
679 case 'S': /* Print string representations */
680 if (!parse_field_string_format(optarg)) {
681 cmdarg_err("Invalid field string format");
685 case 't': /* Time stamp type */
686 if (strcmp(optarg, "r") == 0)
687 timestamp_set_type(TS_RELATIVE);
688 else if (strcmp(optarg, "a") == 0)
689 timestamp_set_type(TS_ABSOLUTE);
690 else if (strcmp(optarg, "ad") == 0)
691 timestamp_set_type(TS_ABSOLUTE_WITH_DATE);
692 else if (strcmp(optarg, "d") == 0)
693 timestamp_set_type(TS_DELTA);
694 else if (strcmp(optarg, "dd") == 0)
695 timestamp_set_type(TS_DELTA_DIS);
696 else if (strcmp(optarg, "e") == 0)
697 timestamp_set_type(TS_EPOCH);
699 cmdarg_err("Invalid time stamp type \"%s\"",
701 cmdarg_err_cont("It must be \"r\" for relative, \"a\" for absolute,");
702 cmdarg_err_cont("\"ad\" for absolute with date, or \"d\" for delta.");
706 case 'v': /* Show version and exit */
708 GString *comp_info_str;
709 GString *runtime_info_str;
710 /* Assemble the compile-time version information string */
711 comp_info_str = g_string_new("Compiled ");
712 get_compiled_version_info(comp_info_str, NULL, epan_get_compiled_version_info);
714 /* Assemble the run-time version information string */
715 runtime_info_str = g_string_new("Running ");
716 get_runtime_version_info(runtime_info_str, NULL);
717 show_version(comp_info_str, runtime_info_str);
718 g_string_free(comp_info_str, TRUE);
719 g_string_free(runtime_info_str, TRUE);
724 case '?': /* Bad flag - print usage message */
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");
757 rfilters[n_rfilters] = get_args_as_string(argc, argv, optind);
761 /* Make sure we got a dissector handle for our payload. */
762 if (encap == WTAP_ENCAP_UNKNOWN) {
763 cmdarg_err("No valid payload dissector specified.");
774 /* Start windows sockets */
775 WSAStartup( MAKEWORD( 1, 1 ), &wsaData );
778 /* At this point MATE will have registered its field array so we can
779 have a tap filter with one of MATE's late-registered fields as part
780 of the filter. We can now process all the "-z" arguments. */
781 start_requested_stats();
783 /* disabled protocols as per configuration file */
784 if (gdp_path == NULL && dp_path == NULL) {
785 set_disabled_protos_list();
788 /* Build the column format array */
789 build_column_format_array(&cfile.cinfo, prefs_p->num_cols, TRUE);
791 if (n_rfilters != 0) {
792 for (i = 0; i < n_rfilters; i++) {
793 if (!dfilter_compile(rfilters[i], &rfcodes[n_rfcodes])) {
794 cmdarg_err("%s", dfilter_error_msg);
804 * We're reading a pipe (or capture file).
808 * Immediately relinquish any special privileges we have; we must not
809 * be allowed to read any capture files the user running Rawshark
812 relinquish_special_privs_perm();
814 if (raw_cf_open(&cfile, pipe_name) != CF_OK) {
819 /* Do we need to PCAP header and magic? */
820 if (skip_pcap_header) {
821 guint bytes_left = sizeof(struct pcap_hdr) + sizeof(guint32);
822 gchar buf[sizeof(struct pcap_hdr) + sizeof(guint32)];
823 while (bytes_left > 0) {
824 guint bytes = read(fd, buf, bytes_left);
826 cmdarg_err("Not enough bytes for pcap header.");
833 /* Set timestamp precision; there should arguably be a command-line
834 option to let the user set this. */
836 switch(wtap_file_tsprecision(cfile.wth)) {
837 case(WTAP_FILE_TSPREC_SEC):
838 timestamp_set_precision(TS_PREC_AUTO_SEC);
840 case(WTAP_FILE_TSPREC_DSEC):
841 timestamp_set_precision(TS_PREC_AUTO_DSEC);
843 case(WTAP_FILE_TSPREC_CSEC):
844 timestamp_set_precision(TS_PREC_AUTO_CSEC);
846 case(WTAP_FILE_TSPREC_MSEC):
847 timestamp_set_precision(TS_PREC_AUTO_MSEC);
849 case(WTAP_FILE_TSPREC_USEC):
850 timestamp_set_precision(TS_PREC_AUTO_USEC);
852 case(WTAP_FILE_TSPREC_NSEC):
853 timestamp_set_precision(TS_PREC_AUTO_NSEC);
856 g_assert_not_reached();
859 timestamp_set_precision(TS_PREC_AUTO_USEC);
862 /* Process the packets in the file */
863 err = load_cap_file(&cfile);
870 /* If you want to capture live packets, use TShark. */
871 cmdarg_err("Input file or pipe name not specified.");
881 * Read data from a raw pipe. The "raw" data consists of a libpcap
882 * packet header followed by the payload.
883 * @param fd [IN] A POSIX file descriptor. Because that's _exactly_ the sort
884 * of thing you want to use in Windows.
885 * @param phdr [OUT] Packet header information.
886 * @param err [OUT] Error indicator. Uses wiretap values.
887 * @param err_info [OUT] Error message.
888 * @param data_offset [OUT] data offset in the pipe.
889 * @return TRUE on success, FALSE on failure.
892 raw_pipe_read(struct wtap_pkthdr *phdr, guchar * pd, int *err, const gchar **err_info, gint64 *data_offset) {
893 struct pcap_pkthdr mem_hdr;
894 struct pcaprec_hdr disk_hdr;
896 int bytes_needed = sizeof(disk_hdr);
897 guchar *ptr = (guchar*) &disk_hdr;
898 static gchar err_str[100];
900 if (want_pcap_pkthdr) {
901 bytes_needed = sizeof(mem_hdr);
902 ptr = (guchar*) &mem_hdr;
905 /* Copied from capture_loop.c */
906 while (bytes_needed > 0) {
907 bytes_read = read(fd, ptr, bytes_needed);
908 if (bytes_read == 0) {
911 } else if (bytes_read < 0) {
912 *err = WTAP_ERR_CANT_READ;
913 *err_info = "Error reading header from pipe";
916 bytes_needed -= 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 = mem_hdr.ts.tv_usec * 1000;
924 phdr->caplen = bytes_needed = 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 = bytes_needed = disk_hdr.incl_len;
930 phdr->len = disk_hdr.orig_len;
933 phdr->pkt_encap = encap;
936 printf("tv_sec: %d (%04x)\n", hdr.ts.tv_sec, hdr.ts.tv_sec);
937 printf("tv_usec: %d (%04x)\n", hdr.ts.tv_usec, hdr.ts.tv_usec);
938 printf("caplen: %d (%04x)\n", hdr.caplen, hdr.caplen);
939 printf("len: %d (%04x)\n", hdr.len, hdr.len);
941 if (bytes_needed > WTAP_MAX_PACKET_SIZE) {
942 *err = WTAP_ERR_BAD_RECORD;
943 g_snprintf(err_str, 100, "Bad packet length: %d (%04x)", bytes_needed, bytes_needed);
949 while (bytes_needed > 0) {
950 bytes_read = read(fd, ptr, bytes_needed);
951 if (bytes_read == 0) {
952 *err = WTAP_ERR_SHORT_READ;
953 *err_info = "Got zero bytes reading data from pipe";
955 } else if (bytes_read < 0) {
956 *err = WTAP_ERR_CANT_READ;
957 *err_info = "Error reading data from pipe";
960 bytes_needed -= bytes_read;
961 *data_offset += bytes_read;
968 load_cap_file(capture_file *cf)
971 const gchar *err_info;
972 gint64 data_offset = 0;
973 struct wtap_pkthdr phdr;
974 guchar pd[WTAP_MAX_PACKET_SIZE];
976 while (raw_pipe_read(&phdr, pd, &err, &err_info, &data_offset)) {
977 process_packet(cf, data_offset, &phdr, pd);
981 /* Print a message noting that the read failed somewhere along the line. */
984 case WTAP_ERR_UNSUPPORTED_ENCAP:
985 cmdarg_err("The file \"%s\" has a packet with a network type that Rawshark doesn't support.\n(%s)",
986 cf->filename, err_info);
989 case WTAP_ERR_CANT_READ:
990 cmdarg_err("An attempt to read from the file \"%s\" failed for some unknown reason.",
994 case WTAP_ERR_SHORT_READ:
995 cmdarg_err("The file \"%s\" appears to have been cut short in the middle of a packet.",
999 case WTAP_ERR_BAD_RECORD:
1000 cmdarg_err("The file \"%s\" appears to be damaged or corrupt.\n(%s)",
1001 cf->filename, err_info);
1004 case WTAP_ERR_DECOMPRESS:
1005 cmdarg_err("The compressed file \"%s\" appears to be damaged or corrupt.\n(%s)",
1006 cf->filename, err_info);
1010 cmdarg_err("An error occurred while reading the file \"%s\": %s.",
1011 cf->filename, wtap_strerror(err));
1020 process_packet(capture_file *cf, gint64 offset, const struct wtap_pkthdr *whdr,
1024 gboolean create_proto_tree;
1027 union wtap_pseudo_header pseudo_header;
1032 /* The user sends an empty packet when he wants to get output from us even if we don't currently have
1033 packets to process. We spit out a line with the timestamp and the text "void"
1035 printf("%lu %lu %lu void -\n", (unsigned long int)cf->count,
1036 (unsigned long int)whdr->ts.secs,
1037 (unsigned long int)whdr->ts.nsecs);
1044 memset(&pseudo_header, 0, sizeof(pseudo_header));
1046 /* Count this packet. */
1049 /* If we're going to print packet information, or we're going to
1050 run a read filter, or we're going to process taps, set up to
1051 do a dissection and do so. */
1052 frame_data_init(&fdata, cf->count, whdr, offset, cum_bytes);
1055 create_proto_tree = TRUE;
1057 /* The protocol tree will be "visible", i.e., printed, only if we're
1058 printing packet details, which is true if we're in verbose mode ("verbose"
1060 epan_dissect_init(&edt, create_proto_tree, FALSE);
1062 /* If we're running a read filter, prime the epan_dissect_t with that
1064 if (n_rfilters > 0) {
1065 for(i = 0; i < n_rfcodes; i++) {
1066 epan_dissect_prime_dfilter(&edt, rfcodes[i]);
1070 tap_queue_init(&edt);
1072 printf("%lu", (unsigned long int) cf->count);
1074 frame_data_set_before_dissect(&fdata, &cf->elapsed_time,
1075 &first_ts, &prev_dis_ts, &prev_cap_ts);
1077 /* We only need the columns if we're printing packet info but we're
1078 *not* verbose; in verbose mode, we print the protocol tree, not
1079 the protocol summary. */
1080 epan_dissect_run(&edt, &pseudo_header, pd, &fdata, &cf->cinfo);
1082 tap_push_tapped_queue(&edt);
1084 frame_data_set_after_dissect(&fdata, &cum_bytes, &prev_dis_ts);
1086 for(i = 0; i < n_rfilters; i++) {
1087 /* Run the read filter if we have one. */
1089 passed = dfilter_apply_edt(rfcodes[i], &edt);
1093 /* Print a one-line summary */
1094 printf(" %u", passed ? 1 : 0);
1099 /* The ANSI C standard does not appear to *require* that a line-buffered
1100 stream be flushed to the host environment whenever a newline is
1101 written, it just says that, on such a stream, characters "are
1102 intended to be transmitted to or from the host environment as a
1103 block when a new-line character is encountered".
1105 The Visual C++ 6.0 C implementation doesn't do what is intended;
1106 even if you set a stream to be line-buffered, it still doesn't
1107 flush the buffer at the end of every line.
1109 So, if the "-l" flag was specified, we flush the standard output
1110 at the end of a packet. This will do the right thing if we're
1111 printing packet summary lines, and, as we print the entire protocol
1112 tree for a single packet without waiting for anything to happen,
1113 it should be as good as line-buffered mode if we're printing
1114 protocol trees. (The whole reason for the "-l" flag in either
1115 tcpdump or Rawshark is to allow the output of a live capture to
1116 be piped to a program or script and to have that script see the
1117 information for the packet as soon as it's printed, rather than
1118 having to wait until a standard I/O buffer fills up. */
1122 if (ferror(stdout)) {
1123 show_print_file_io_error(errno);
1127 epan_dissect_cleanup(&edt);
1128 frame_data_cleanup(&fdata);
1133 /****************************************************************************************
1134 * FIELD EXTRACTION ROUTINES
1135 ****************************************************************************************/
1136 typedef struct _pci_t {
1142 static const char* ftenum_to_string(header_field_info *hfi)
1148 if (string_fmts->len > 0 && hfi->strings) {
1156 return "FT_PROTOCOL";
1158 return "FT_BOOLEAN";
1183 case FT_ABSOLUTE_TIME:
1184 return "FT_ABSOLUTE_TIME";
1185 case FT_RELATIVE_TIME:
1186 return "FT_RELATIVE_TIME";
1190 return "FT_STRINGZ";
1191 case FT_UINT_STRING:
1192 return "FT_UINT_STRING";
1198 return "FT_UINT_BYTES";
1206 return "FT_FRAMENUM";
1214 return "FT_NUM_TYPES";
1220 static const char* absolute_time_display_e_to_string(absolute_time_display_e atd)
1223 case ABSOLUTE_TIME_LOCAL:
1224 return "ABSOLUTE_TIME_LOCAL";
1225 case ABSOLUTE_TIME_UTC:
1226 return "ABSOLUTE_TIME_UTC";
1232 static const char* base_display_e_to_string(base_display_e bd)
1244 return "BASE_DEC_HEX";
1246 return "BASE_HEX_DEC";
1253 * Copied from various parts of proto.c
1255 #define FIELD_STR_INIT_LEN 256
1256 #define cVALS(x) (const value_string*)(x)
1257 static gboolean print_field_value(field_info *finfo, int cmd_line_index)
1259 header_field_info *hfinfo;
1260 static char *fs_buf = NULL;
1261 char *fs_ptr = fs_buf;
1262 static GString *label_s = NULL;
1263 int fs_buf_len = FIELD_STR_INIT_LEN, fs_len;
1268 const true_false_string *tfstring = &tfs_true_false;
1270 hfinfo = finfo->hfinfo;
1273 fs_buf = (char *)g_malloc(fs_buf_len + 1);
1278 label_s = g_string_new("");
1281 if(finfo->value.ftype->val_to_string_repr)
1284 * this field has an associated value,
1287 fs_len = fvalue_string_repr_len(&finfo->value, FTREPR_DFILTER);
1288 while (fs_buf_len < fs_len) {
1290 fs_buf = (char *)g_realloc(fs_buf, fs_buf_len + 1);
1293 fvalue_to_string_repr(&finfo->value,
1297 /* String types are quoted. Remove them. */
1298 if ((finfo->value.ftype->ftype == FT_STRING || finfo->value.ftype->ftype == FT_STRINGZ) && fs_len > 2) {
1299 fs_buf[fs_len - 1] = '\0';
1304 if (string_fmts->len > 0 && finfo->hfinfo->strings) {
1305 g_string_truncate(label_s, 0);
1306 for (i = 0; i < string_fmts->len; i++) {
1307 sf = (string_fmt_t *)g_ptr_array_index(string_fmts, i);
1309 g_string_append(label_s, sf->plain);
1311 switch (sf->format) {
1313 g_string_append(label_s, hfinfo->name);
1316 g_string_append(label_s, fs_ptr);
1319 switch(hfinfo->type) {
1321 uvalue = fvalue_get_uinteger(&finfo->value);
1322 tfstring = (const struct true_false_string*) hfinfo->strings;
1323 g_string_append(label_s, uvalue ? tfstring->true_string : tfstring->false_string);
1329 DISSECTOR_ASSERT(!hfinfo->bitmask);
1330 svalue = fvalue_get_sinteger(&finfo->value);
1331 if (hfinfo->display & BASE_RANGE_STRING) {
1332 g_string_append(label_s, rval_to_str(svalue, RVALS(hfinfo->strings), "Unknown"));
1333 } else if (hfinfo->display & BASE_EXT_STRING) {
1334 g_string_append(label_s, val_to_str_ext(svalue, (value_string_ext *) hfinfo->strings, "Unknown"));
1336 g_string_append(label_s, val_to_str(svalue, cVALS(hfinfo->strings), "Unknown"));
1343 uvalue = fvalue_get_uinteger(&finfo->value);
1344 if (!hfinfo->bitmask && hfinfo->display & BASE_RANGE_STRING) {
1345 g_string_append(label_s, rval_to_str(uvalue, RVALS(hfinfo->strings), "Unknown"));
1346 } else if (hfinfo->display & BASE_EXT_STRING) {
1347 g_string_append(label_s, val_to_str_ext(uvalue, (value_string_ext *) hfinfo->strings, "Unknown"));
1349 g_string_append(label_s, val_to_str(uvalue, cVALS(hfinfo->strings), "Unknown"));
1361 printf(" %u=\"%s\"", cmd_line_index, label_s->str);
1365 if(finfo->value.ftype->val_to_string_repr)
1367 printf(" %u=\"%s\"", cmd_line_index, fs_ptr);
1372 * This field doesn't have an associated value,
1376 printf(" %u=\"n.a.\"", cmd_line_index);
1381 protocolinfo_packet(void *prs, packet_info *pinfo _U_, epan_dissect_t *edt, const void *dummy _U_)
1383 pci_t *rs=(pci_t *)prs;
1387 gp=proto_get_finfo_ptr_array(edt->tree, rs->hf_index);
1394 * Print each occurrence of the field
1396 for (i = 0; i < gp->len; i++) {
1397 print_field_value((field_info *)gp->pdata[i], rs->cmd_line_index);
1403 int g_cmd_line_index = 0;
1406 * field must be persistent - we don't g_strdup() it below
1409 protocolinfo_init(char *field)
1412 header_field_info *hfi;
1413 GString *error_string;
1415 hfi=proto_registrar_get_byname(field);
1417 fprintf(stderr, "rawshark: Field \"%s\" doesn't exist.\n", field);
1421 switch (hfi->type) {
1423 case FT_ABSOLUTE_TIME:
1424 printf("%u %s %s - ",
1426 ftenum_to_string(hfi),
1427 absolute_time_display_e_to_string(hfi->display));
1432 printf("%u %s %s - ",
1434 ftenum_to_string(hfi),
1435 base_display_e_to_string(hfi->display));
1439 rs=(pci_t *)g_malloc(sizeof(pci_t));
1440 rs->hf_index=hfi->id;
1442 rs->cmd_line_index = g_cmd_line_index++;
1444 error_string=register_tap_listener("frame", rs, rs->filter, TL_REQUIRES_PROTO_TREE, NULL, protocolinfo_packet, NULL);
1446 /* error, we failed to attach to the tap. complain and clean up */
1447 fprintf(stderr, "rawshark: Couldn't register field extraction tap: %s\n",
1449 g_string_free(error_string, TRUE);
1460 * Given a format string, split it into a GPtrArray of string_fmt_t structs
1461 * and fill in string_fmt_parts.
1465 add_string_fmt(string_fmt_e format, gchar *plain) {
1466 string_fmt_t *sf = (string_fmt_t *)g_malloc(sizeof(string_fmt_t));
1468 sf->format = format;
1469 sf->plain = g_strdup(plain);
1471 g_ptr_array_add(string_fmts, sf);
1475 parse_field_string_format(gchar *format) {
1476 GString *plain_s = g_string_new("");
1484 len = strlen(format);
1485 g_ptr_array_set_size(string_fmts, 0);
1488 if (format[pos] == '%') {
1489 if (pos >= len) { /* There should always be a following character */
1493 if (plain_s->len > 0) {
1494 add_string_fmt(SF_NONE, plain_s->str);
1495 g_string_truncate(plain_s, 0);
1497 switch (format[pos]) {
1499 add_string_fmt(SF_NAME, NULL);
1502 add_string_fmt(SF_NUMVAL, NULL);
1505 add_string_fmt(SF_STRVAL, NULL);
1508 g_string_append_c(plain_s, '%');
1510 default: /* Invalid format */
1514 g_string_append_c(plain_s, format[pos]);
1519 if (plain_s->len > 0) {
1520 add_string_fmt(SF_NONE, plain_s->str);
1522 g_string_free(plain_s, TRUE);
1526 /****************************************************************************************
1527 * END OF FIELD EXTRACTION ROUTINES
1528 ****************************************************************************************/
1531 show_print_file_io_error(int err)
1536 cmdarg_err("Not all the packets could be printed because there is "
1537 "no space left on the file system.");
1542 cmdarg_err("Not all the packets could be printed because you are "
1543 "too close to, or over your disk quota.");
1548 cmdarg_err("An error occurred while printing packets: %s.",
1555 * Open/create errors are reported with an console message in Rawshark.
1558 open_failure_message(const char *filename, int err, gboolean for_writing)
1560 fprintf(stderr, "rawshark: ");
1561 fprintf(stderr, file_open_error_message(err, for_writing), filename);
1562 fprintf(stderr, "\n");
1566 raw_cf_open(capture_file *cf, const char *fname)
1568 if ((fd = raw_pipe_open(fname)) < 0)
1571 /* The open succeeded. Fill in the information for this file. */
1573 /* Cleanup all data structures used for dissection. */
1574 cleanup_dissection();
1575 /* Initialize all data structures used for dissection. */
1579 cf->f_datalen = 0; /* not used, but set it anyway */
1581 /* Set the file name because we need it to set the follow stream filter.
1582 XXX - is that still true? We need it for other reasons, though,
1584 cf->filename = g_strdup(fname);
1586 /* Indicate whether it's a permanent or temporary file. */
1587 cf->is_tempfile = FALSE;
1589 /* If it's a temporary capture buffer file, mark it as not saved. */
1590 cf->user_saved = FALSE;
1592 cf->cd_t = WTAP_FILE_UNKNOWN;
1594 cf->drops_known = FALSE;
1596 cf->has_snap = FALSE;
1597 cf->snap = WTAP_MAX_PACKET_SIZE;
1598 nstime_set_zero(&cf->elapsed_time);
1599 nstime_set_unset(&first_ts);
1600 nstime_set_unset(&prev_dis_ts);
1601 nstime_set_unset(&prev_cap_ts);
1608 * General errors are reported with an console message in Rawshark.
1611 failure_message(const char *msg_format, va_list ap)
1613 fprintf(stderr, "rawshark: ");
1614 vfprintf(stderr, msg_format, ap);
1615 fprintf(stderr, "\n");
1619 * Read errors are reported with an console message in Rawshark.
1622 read_failure_message(const char *filename, int err)
1624 cmdarg_err("An error occurred while reading from the file \"%s\": %s.",
1625 filename, strerror(err));
1629 * Write errors are reported with an console message in Rawshark.
1632 write_failure_message(const char *filename, int err)
1634 cmdarg_err("An error occurred while writing to the file \"%s\": %s.",
1635 filename, strerror(err));
1639 * Report an error in command-line arguments.
1642 cmdarg_err(const char *fmt, ...)
1647 fprintf(stderr, "rawshark: ");
1648 vfprintf(stderr, fmt, ap);
1649 fprintf(stderr, "\n");
1654 * Report additional information for an error in command-line arguments.
1657 cmdarg_err_cont(const char *fmt, ...)
1662 vfprintf(stderr, fmt, ap);
1663 fprintf(stderr, "\n");
1674 * indent-tabs-mode: nil
1677 * ex: set shiftwidth=4 tabstop=8 expandtab
1678 * :indentSize=4:tabSize=8:noTabs=true: