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 * This is the template for the decode as option; it is shared between the
122 * various functions that output the usage for this parameter.
124 static const gchar decode_as_arg_template[] = "<layer_type>==<selector>,<decode_as_protocol>";
126 static guint32 cum_bytes;
127 static nstime_t first_ts;
128 static nstime_t prev_dis_ts;
129 static nstime_t prev_cap_ts;
132 * The way the packet decode is to be written.
135 WRITE_TEXT, /* summary or detail text */
136 WRITE_XML /* PDML or PSML */
137 /* Add CSV and the like here */
140 static gboolean line_buffered;
141 static print_format_e print_format = PR_FMT_TEXT;
143 static gboolean want_pcap_pkthdr;
145 cf_status_t raw_cf_open(capture_file *cf, const char *fname);
146 static int load_cap_file(capture_file *cf);
147 static gboolean process_packet(capture_file *cf, gint64 offset,
148 const struct wtap_pkthdr *whdr, const guchar *pd);
149 static void show_print_file_io_error(int err);
151 static void open_failure_message(const char *filename, int err,
152 gboolean for_writing);
153 static void failure_message(const char *msg_format, va_list ap);
154 static void read_failure_message(const char *filename, int err);
155 static void write_failure_message(const char *filename, int err);
156 static void protocolinfo_init(char *field);
157 static gboolean parse_field_string_format(char *format);
160 SF_NONE, /* No format (placeholder) */
161 SF_NAME, /* %D Field name / description */
162 SF_NUMVAL, /* %N Numeric value */
163 SF_STRVAL /* %S String value */
166 typedef struct string_fmt_s {
168 string_fmt_e format; /* Valid if plain is NULL */
174 dfilter_t *rfcodes[64];
176 dfilter_t *rfieldfcodes[64];
179 GPtrArray *string_fmts;
182 print_usage(gboolean print_ver)
189 "Rawshark " VERSION "%s\n"
190 "Dump and analyze network traffic.\n"
191 "See http://www.wireshark.org for more information.\n"
194 wireshark_svnversion, get_copyright_info());
198 fprintf(output, "\n");
199 fprintf(output, "Usage: rawshark [options] ...\n");
200 fprintf(output, "\n");
202 fprintf(output, "Input file:\n");
203 fprintf(output, " -r <infile> set the pipe or file name to read from\n");
205 fprintf(output, "\n");
206 fprintf(output, "Processing:\n");
207 fprintf(output, " -d <encap:dlt>|<proto:protoname>\n");
208 fprintf(output, " packet encapsulation or protocol\n");
209 fprintf(output, " -F <field> field to display\n");
210 fprintf(output, " -n disable all name resolution (def: all enabled)\n");
211 fprintf(output, " -N <name resolve flags> enable specific name resolution(s): \"mntC\"\n");
212 fprintf(output, " -p use the system's packet header format (which may have 64-bit timestamps)\n");
213 fprintf(output, " -R <read filter> packet filter in Wireshark display filter syntax\n");
214 fprintf(output, " -s skip PCAP header on input\n");
216 /*fprintf(output, "\n");*/
217 fprintf(output, "Output:\n");
218 fprintf(output, " -l flush output after each packet\n");
219 fprintf(output, " -S format string for fields (%%D - name, %%S - stringval, %%N numval)\n");
220 fprintf(output, " -t ad|a|r|d|dd|e output format of time stamps (def: r: rel. to first)\n");
222 fprintf(output, "\n");
223 fprintf(output, "Miscellaneous:\n");
224 fprintf(output, " -h display this help and exit\n");
225 fprintf(output, " -o <name>:<value> ... override preference setting\n");
226 fprintf(output, " -v display version info and exit\n");
230 log_func_ignore (const gchar *log_domain _U_, GLogLevelFlags log_level _U_,
231 const gchar *message _U_, gpointer user_data _U_)
236 * Open a pipe for raw input. This is a stripped-down version of
237 * pcap_loop.c:cap_pipe_open_live().
238 * We check if "pipe_name" is "-" (stdin) or a FIFO, and open it.
239 * @param pipe_name The name of the pipe or FIFO.
240 * @return A POSIX file descriptor on success, or -1 on failure.
243 raw_pipe_open(const char *pipe_name)
246 struct stat pipe_stat;
255 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "open_raw_pipe: %s", pipe_name);
258 * XXX Rawshark blocks until we return
260 if (strcmp(pipe_name, "-") == 0) {
261 rfd = 0; /* read from stdin */
264 * This is needed to set the stdin pipe into binary mode, otherwise
265 * CR/LF are mangled...
267 _setmode(0, _O_BINARY);
271 if (ws_stat(pipe_name, &pipe_stat) < 0) {
272 fprintf(stderr, "rawshark: The pipe %s could not be checked: %s\n",
273 pipe_name, strerror(errno));
276 if (! S_ISFIFO(pipe_stat.st_mode)) {
277 if (S_ISCHR(pipe_stat.st_mode)) {
279 * Assume the user specified an interface on a system where
280 * interfaces are in /dev. Pretend we haven't seen it.
284 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
289 rfd = ws_open(pipe_name, O_RDONLY | O_NONBLOCK, 0000 /* no creation so don't matter */);
291 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
292 pipe_name, strerror(errno));
296 #define PIPE_STR "\\pipe\\"
297 /* Under Windows, named pipes _must_ have the form
298 * "\\<server>\pipe\<pipe_name>". <server> may be "." for localhost.
300 pncopy = g_strdup(pipe_name);
301 if (strstr(pncopy, "\\\\") == pncopy) {
302 pos = strchr(pncopy + 3, '\\');
303 if (pos && g_ascii_strncasecmp(pos, PIPE_STR, strlen(PIPE_STR)) != 0)
310 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
315 /* Wait for the pipe to appear */
317 hPipe = CreateFile(utf_8to16(pipe_name), GENERIC_READ, 0, NULL,
318 OPEN_EXISTING, 0, NULL);
320 if (hPipe != INVALID_HANDLE_VALUE)
323 err = GetLastError();
324 if (err != ERROR_PIPE_BUSY) {
325 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER,
326 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
327 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s (error %d)\n",
328 pipe_name, utf_16to8(err_str), err);
333 if (!WaitNamedPipe(utf_8to16(pipe_name), 30 * 1000)) {
334 err = GetLastError();
335 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER,
336 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
337 fprintf(stderr, "rawshark: \"%s\" could not be waited for: %s (error %d)\n",
338 pipe_name, utf_16to8(err_str), err);
344 rfd = _open_osfhandle((long) hPipe, _O_RDONLY);
346 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
347 pipe_name, strerror(errno));
357 * Parse a link-type argument of the form "encap:<pcap dlt>" or
358 * "proto:<proto name>". "Pcap dlt" must be a name conforming to
359 * pcap_datalink_name_to_val() or an integer. "Proto name" must be
360 * a protocol name, e.g. "http".
363 set_link_type(const char *lt_arg) {
364 char *spec_ptr = strchr(lt_arg, ':');
368 dissector_handle_t dhandle;
376 if (strncmp(lt_arg, "encap:", strlen("encap:")) == 0) {
377 dlt_val = linktype_name_to_val(spec_ptr);
380 val = strtol(spec_ptr, &p, 10);
381 if (p == spec_ptr || *p != '\0' || errno != 0 || val > INT_MAX) {
386 encap = wtap_pcap_encap_to_wtap_encap(dlt_val);
387 if (encap == WTAP_ENCAP_UNKNOWN) {
391 } else if (strncmp(lt_arg, "proto:", strlen("proto:")) == 0) {
392 dhandle = find_dissector(spec_ptr);
394 encap = WTAP_ENCAP_USER0;
395 pref_str = g_string_new("uat:user_dlts:");
396 /* This must match the format used in the user_dlts file */
397 g_string_append_printf(pref_str,
398 "\"User 0 (DLT=147)\",\"%s\",\"0\",\"\",\"0\",\"\"",
400 if (prefs_set_pref(pref_str->str) != PREFS_SET_OK) {
401 g_string_free(pref_str, TRUE);
404 g_string_free(pref_str, TRUE);
412 show_version(GString *comp_info_str, GString *runtime_info_str)
414 printf("Rawshark " VERSION "%s\n"
421 wireshark_svnversion, get_copyright_info(), comp_info_str->str,
422 runtime_info_str->str);
426 main(int argc, char *argv[])
428 char *init_progfile_dir_error;
430 gboolean arg_error = FALSE;
436 char *gpf_path, *pf_path;
437 char *gdp_path, *dp_path;
438 int gpf_open_errno, gpf_read_errno;
439 int pf_open_errno, pf_read_errno;
440 int gdp_open_errno, gdp_read_errno;
441 int dp_open_errno, dp_read_errno;
443 gchar *pipe_name = NULL;
447 GLogLevelFlags log_flags;
448 GPtrArray *disp_fields = g_ptr_array_new();
450 gboolean skip_pcap_header = FALSE;
452 #define OPTSTRING_INIT "d:F:hlnN:o:pr:R:sS:t:v"
454 static const char optstring[] = OPTSTRING_INIT;
457 * Get credential information for later use.
459 init_process_policies();
462 * Clear the filters arrays
464 memset(rfilters, 0, sizeof(rfilters));
465 memset(rfcodes, 0, sizeof(rfcodes));
470 * Initialize our string format
472 string_fmts = g_ptr_array_new();
475 * Attempt to get the pathname of the executable file.
477 init_progfile_dir_error = init_progfile_dir(argv[0], main);
478 if (init_progfile_dir_error != NULL) {
479 fprintf(stderr, "rawshark: Can't get pathname of rawshark program: %s.\n",
480 init_progfile_dir_error);
484 * Get credential information for later use.
486 init_process_policies();
488 /* nothing more than the standard GLib handler, but without a warning */
490 G_LOG_LEVEL_WARNING |
491 G_LOG_LEVEL_MESSAGE |
495 g_log_set_handler(NULL,
497 log_func_ignore, NULL /* user_data */);
498 g_log_set_handler(LOG_DOMAIN_CAPTURE_CHILD,
500 log_func_ignore, NULL /* user_data */);
502 timestamp_set_type(TS_RELATIVE);
503 timestamp_set_precision(TS_PREC_AUTO);
504 timestamp_set_seconds_type(TS_SECONDS_DEFAULT);
506 /* Register all dissectors; we must do this before checking for the
507 "-G" flag, as the "-G" flag dumps information registered by the
508 dissectors, and we must do it before we read the preferences, in
509 case any dissectors register preferences. */
510 epan_init(register_all_protocols, register_all_protocol_handoffs, NULL, NULL,
511 failure_message, open_failure_message, read_failure_message,
512 write_failure_message);
514 /* Now register the preferences for any non-dissector modules.
515 We must do that before we read the preferences as well. */
516 prefs_register_modules();
518 /* Set the C-language locale to the native environment. */
519 setlocale(LC_ALL, "");
521 prefs_p = read_prefs(&gpf_open_errno, &gpf_read_errno, &gpf_path,
522 &pf_open_errno, &pf_read_errno, &pf_path);
523 if (gpf_path != NULL) {
524 if (gpf_open_errno != 0) {
525 cmdarg_err("Can't open global preferences file \"%s\": %s.",
526 pf_path, strerror(gpf_open_errno));
528 if (gpf_read_errno != 0) {
529 cmdarg_err("I/O error reading global preferences file \"%s\": %s.",
530 pf_path, strerror(gpf_read_errno));
533 if (pf_path != NULL) {
534 if (pf_open_errno != 0) {
535 cmdarg_err("Can't open your preferences file \"%s\": %s.", pf_path,
536 strerror(pf_open_errno));
538 if (pf_read_errno != 0) {
539 cmdarg_err("I/O error reading your preferences file \"%s\": %s.",
540 pf_path, strerror(pf_read_errno));
546 /* Set the name resolution code's flags from the preferences. */
547 gbl_resolv_flags = prefs_p->name_resolve;
549 /* Read the disabled protocols file. */
550 read_disabled_protos_list(&gdp_path, &gdp_open_errno, &gdp_read_errno,
551 &dp_path, &dp_open_errno, &dp_read_errno);
552 if (gdp_path != NULL) {
553 if (gdp_open_errno != 0) {
554 cmdarg_err("Could not open global disabled protocols file\n\"%s\": %s.",
555 gdp_path, strerror(gdp_open_errno));
557 if (gdp_read_errno != 0) {
558 cmdarg_err("I/O error reading global disabled protocols file\n\"%s\": %s.",
559 gdp_path, strerror(gdp_read_errno));
563 if (dp_path != NULL) {
564 if (dp_open_errno != 0) {
566 "Could not open your disabled protocols file\n\"%s\": %s.", dp_path,
567 strerror(dp_open_errno));
569 if (dp_read_errno != 0) {
571 "I/O error reading your disabled protocols file\n\"%s\": %s.", dp_path,
572 strerror(dp_read_errno));
578 /* Load Wpcap, if possible */
582 cap_file_init(&cfile);
584 /* Print format defaults to this. */
585 print_format = PR_FMT_TEXT;
587 /* Initialize our encapsulation type */
588 encap = WTAP_ENCAP_UNKNOWN;
590 /* Now get our args */
591 /* XXX - We should probably have an option to dump libpcap link types */
592 while ((opt = getopt(argc, argv, optstring)) != -1) {
594 case 'd': /* Payload type */
595 if (!set_link_type(optarg)) {
596 cmdarg_err("Invalid link type or protocol \"%s\"", optarg);
600 case 'F': /* Read field to display */
601 g_ptr_array_add(disp_fields, g_strdup(optarg));
603 case 'h': /* Print help and exit */
607 case 'l': /* "Line-buffer" standard output */
608 /* This isn't line-buffering, strictly speaking, it's just
609 flushing the standard output after the information for
610 each packet is printed; however, that should be good
611 enough for all the purposes to which "-l" is put (and
612 is probably actually better for "-V", as it does fewer
615 See the comment in "process_packet()" for an explanation of
616 why we do that, and why we don't just use "setvbuf()" to
617 make the standard output line-buffered (short version: in
618 Windows, "line-buffered" is the same as "fully-buffered",
619 and the output buffer is only flushed when it fills up). */
620 line_buffered = TRUE;
622 case 'n': /* No name resolution */
623 gbl_resolv_flags = RESOLV_NONE;
625 case 'N': /* Select what types of addresses/port #s to resolve */
626 if (gbl_resolv_flags == RESOLV_ALL)
627 gbl_resolv_flags = RESOLV_NONE;
628 badopt = string_to_name_resolve(optarg, &gbl_resolv_flags);
629 if (badopt != '\0') {
630 cmdarg_err("-N specifies unknown resolving option '%c'; valid options are 'm', 'n', and 't'",
635 case 'o': /* Override preference from command line */
636 switch (prefs_set_pref(optarg)) {
641 case PREFS_SET_SYNTAX_ERR:
642 cmdarg_err("Invalid -o flag \"%s\"", optarg);
646 case PREFS_SET_NO_SUCH_PREF:
647 case PREFS_SET_OBSOLETE:
648 cmdarg_err("-o flag \"%s\" specifies unknown preference", optarg);
653 case 'p': /* Expect pcap_pkthdr packet headers, which may have 64-bit timestamps */
654 want_pcap_pkthdr = TRUE;
656 case 'r': /* Read capture file xxx */
657 pipe_name = g_strdup(optarg);
659 case 'R': /* Read file filter */
660 if(n_rfilters < (int) sizeof(rfilters) / (int) sizeof(rfilters[0])) {
661 rfilters[n_rfilters++] = optarg;
664 cmdarg_err("Too many display filters");
668 case 's': /* Skip PCAP header */
669 skip_pcap_header = TRUE;
671 case 'S': /* Print string representations */
672 if (!parse_field_string_format(optarg)) {
673 cmdarg_err("Invalid field string format");
677 case 't': /* Time stamp type */
678 if (strcmp(optarg, "r") == 0)
679 timestamp_set_type(TS_RELATIVE);
680 else if (strcmp(optarg, "a") == 0)
681 timestamp_set_type(TS_ABSOLUTE);
682 else if (strcmp(optarg, "ad") == 0)
683 timestamp_set_type(TS_ABSOLUTE_WITH_DATE);
684 else if (strcmp(optarg, "d") == 0)
685 timestamp_set_type(TS_DELTA);
686 else if (strcmp(optarg, "dd") == 0)
687 timestamp_set_type(TS_DELTA_DIS);
688 else if (strcmp(optarg, "e") == 0)
689 timestamp_set_type(TS_EPOCH);
691 cmdarg_err("Invalid time stamp type \"%s\"",
693 cmdarg_err_cont("It must be \"r\" for relative, \"a\" for absolute,");
694 cmdarg_err_cont("\"ad\" for absolute with date, or \"d\" for delta.");
698 case 'v': /* Show version and exit */
700 GString *comp_info_str;
701 GString *runtime_info_str;
702 /* Assemble the compile-time version information string */
703 comp_info_str = g_string_new("Compiled ");
704 get_compiled_version_info(comp_info_str, NULL, epan_get_compiled_version_info);
706 /* Assemble the run-time version information string */
707 runtime_info_str = g_string_new("Running ");
708 get_runtime_version_info(runtime_info_str, NULL);
709 show_version(comp_info_str, runtime_info_str);
710 g_string_free(comp_info_str, TRUE);
711 g_string_free(runtime_info_str, TRUE);
716 case '?': /* Bad flag - print usage message */
723 /* Notify all registered modules that have had any of their preferences
724 changed either from one of the preferences file or from the command
725 line that their preferences have changed.
726 Initialize preferences before display filters, otherwise modules
727 like MATE won't work. */
730 /* Initialize our display fields */
731 for (fc = 0; fc < disp_fields->len; fc++) {
732 protocolinfo_init((char *)g_ptr_array_index(disp_fields, fc));
734 g_ptr_array_free(disp_fields, TRUE);
738 /* If no capture filter or read filter has been specified, and there are
739 still command-line arguments, treat them as the tokens of a capture
740 filter (if no "-r" flag was specified) or a read filter (if a "-r"
741 flag was specified. */
743 if (pipe_name != NULL) {
744 if (n_rfilters != 0) {
745 cmdarg_err("Read filters were specified both with \"-R\" "
746 "and with additional command-line arguments");
749 rfilters[n_rfilters] = get_args_as_string(argc, argv, optind);
753 /* Make sure we got a dissector handle for our payload. */
754 if (encap == WTAP_ENCAP_UNKNOWN) {
755 cmdarg_err("No valid payload dissector specified.");
766 /* Start windows sockets */
767 WSAStartup( MAKEWORD( 1, 1 ), &wsaData );
770 /* At this point MATE will have registered its field array so we can
771 have a tap filter with one of MATE's late-registered fields as part
772 of the filter. We can now process all the "-z" arguments. */
773 start_requested_stats();
775 /* disabled protocols as per configuration file */
776 if (gdp_path == NULL && dp_path == NULL) {
777 set_disabled_protos_list();
780 /* Build the column format array */
781 build_column_format_array(&cfile.cinfo, prefs_p->num_cols, TRUE);
783 if (n_rfilters != 0) {
784 for (i = 0; i < n_rfilters; i++) {
785 if (!dfilter_compile(rfilters[i], &rfcodes[n_rfcodes])) {
786 cmdarg_err("%s", dfilter_error_msg);
796 * We're reading a pipe (or capture file).
800 * Immediately relinquish any special privileges we have; we must not
801 * be allowed to read any capture files the user running Rawshark
804 relinquish_special_privs_perm();
806 if (raw_cf_open(&cfile, pipe_name) != CF_OK) {
811 /* Do we need to PCAP header and magic? */
812 if (skip_pcap_header) {
813 guint bytes_left = sizeof(struct pcap_hdr) + sizeof(guint32);
814 gchar buf[sizeof(struct pcap_hdr) + sizeof(guint32)];
815 while (bytes_left > 0) {
816 guint bytes = read(fd, buf, bytes_left);
818 cmdarg_err("Not enough bytes for pcap header.");
825 /* Set timestamp precision; there should arguably be a command-line
826 option to let the user set this. */
828 switch(wtap_file_tsprecision(cfile.wth)) {
829 case(WTAP_FILE_TSPREC_SEC):
830 timestamp_set_precision(TS_PREC_AUTO_SEC);
832 case(WTAP_FILE_TSPREC_DSEC):
833 timestamp_set_precision(TS_PREC_AUTO_DSEC);
835 case(WTAP_FILE_TSPREC_CSEC):
836 timestamp_set_precision(TS_PREC_AUTO_CSEC);
838 case(WTAP_FILE_TSPREC_MSEC):
839 timestamp_set_precision(TS_PREC_AUTO_MSEC);
841 case(WTAP_FILE_TSPREC_USEC):
842 timestamp_set_precision(TS_PREC_AUTO_USEC);
844 case(WTAP_FILE_TSPREC_NSEC):
845 timestamp_set_precision(TS_PREC_AUTO_NSEC);
848 g_assert_not_reached();
851 timestamp_set_precision(TS_PREC_AUTO_USEC);
854 /* Process the packets in the file */
855 err = load_cap_file(&cfile);
862 /* If you want to capture live packets, use TShark. */
863 cmdarg_err("Input file or pipe name not specified.");
873 * Read data from a raw pipe. The "raw" data consists of a libpcap
874 * packet header followed by the payload.
875 * @param fd [IN] A POSIX file descriptor. Because that's _exactly_ the sort
876 * of thing you want to use in Windows.
877 * @param phdr [OUT] Packet header information.
878 * @param err [OUT] Error indicator. Uses wiretap values.
879 * @param err_info [OUT] Error message.
880 * @param data_offset [OUT] data offset in the pipe.
881 * @return TRUE on success, FALSE on failure.
884 raw_pipe_read(struct wtap_pkthdr *phdr, guchar * pd, int *err, const gchar **err_info, gint64 *data_offset) {
885 struct pcap_pkthdr mem_hdr;
886 struct pcaprec_hdr disk_hdr;
888 int bytes_needed = sizeof(disk_hdr);
889 guchar *ptr = (guchar*) &disk_hdr;
890 static gchar err_str[100];
892 if (want_pcap_pkthdr) {
893 bytes_needed = sizeof(mem_hdr);
894 ptr = (guchar*) &mem_hdr;
897 /* Copied from capture_loop.c */
898 while (bytes_needed > 0) {
899 bytes_read = read(fd, ptr, bytes_needed);
900 if (bytes_read == 0) {
903 } else if (bytes_read < 0) {
904 *err = WTAP_ERR_CANT_READ;
905 *err_info = "Error reading header from pipe";
908 bytes_needed -= bytes_read;
909 *data_offset += bytes_read;
913 if (want_pcap_pkthdr) {
914 phdr->ts.secs = mem_hdr.ts.tv_sec;
915 phdr->ts.nsecs = mem_hdr.ts.tv_usec * 1000;
916 phdr->caplen = bytes_needed = mem_hdr.caplen;
917 phdr->len = mem_hdr.len;
919 phdr->ts.secs = disk_hdr.ts_sec;
920 phdr->ts.nsecs = disk_hdr.ts_usec * 1000;
921 phdr->caplen = bytes_needed = disk_hdr.incl_len;
922 phdr->len = disk_hdr.orig_len;
925 phdr->pkt_encap = encap;
928 printf("tv_sec: %d (%04x)\n", hdr.ts.tv_sec, hdr.ts.tv_sec);
929 printf("tv_usec: %d (%04x)\n", hdr.ts.tv_usec, hdr.ts.tv_usec);
930 printf("caplen: %d (%04x)\n", hdr.caplen, hdr.caplen);
931 printf("len: %d (%04x)\n", hdr.len, hdr.len);
933 if (bytes_needed > WTAP_MAX_PACKET_SIZE) {
934 *err = WTAP_ERR_BAD_RECORD;
935 g_snprintf(err_str, 100, "Bad packet length: %d (%04x)", bytes_needed, bytes_needed);
941 while (bytes_needed > 0) {
942 bytes_read = read(fd, ptr, bytes_needed);
943 if (bytes_read == 0) {
944 *err = WTAP_ERR_SHORT_READ;
945 *err_info = "Got zero bytes reading data from pipe";
947 } else if (bytes_read < 0) {
948 *err = WTAP_ERR_CANT_READ;
949 *err_info = "Error reading data from pipe";
952 bytes_needed -= bytes_read;
953 *data_offset += bytes_read;
960 load_cap_file(capture_file *cf)
963 const gchar *err_info;
964 gint64 data_offset = 0;
965 struct wtap_pkthdr phdr;
966 guchar pd[WTAP_MAX_PACKET_SIZE];
968 while (raw_pipe_read(&phdr, pd, &err, &err_info, &data_offset)) {
969 process_packet(cf, data_offset, &phdr, pd);
973 /* Print a message noting that the read failed somewhere along the line. */
976 case WTAP_ERR_UNSUPPORTED_ENCAP:
977 cmdarg_err("\"%s\" has a packet with a network type that Rawshark doesn't support.\n(%s)",
978 cf->filename, err_info);
981 case WTAP_ERR_CANT_READ:
982 cmdarg_err("An attempt to read from \"%s\" failed for some unknown reason.",
986 case WTAP_ERR_SHORT_READ:
987 cmdarg_err("\"%s\" appears to have been cut short in the middle of a packet.",
991 case WTAP_ERR_BAD_RECORD:
992 cmdarg_err("\"%s\" appears to be damaged or corrupt.\n(%s)",
993 cf->filename, err_info);
997 cmdarg_err("An error occurred while reading \"%s\": %s.",
998 cf->filename, wtap_strerror(err));
1007 process_packet(capture_file *cf, gint64 offset, const struct wtap_pkthdr *whdr,
1011 gboolean create_proto_tree;
1014 union wtap_pseudo_header pseudo_header;
1019 /* The user sends an empty packet when he wants to get output from us even if we don't currently have
1020 packets to process. We spit out a line with the timestamp and the text "void"
1022 printf("%lu %lu %lu void -\n", (unsigned long int)cf->count,
1023 (unsigned long int)whdr->ts.secs,
1024 (unsigned long int)whdr->ts.nsecs);
1031 memset(&pseudo_header, 0, sizeof(pseudo_header));
1033 /* Count this packet. */
1036 /* If we're going to print packet information, or we're going to
1037 run a read filter, or we're going to process taps, set up to
1038 do a dissection and do so. */
1039 frame_data_init(&fdata, cf->count, whdr, offset, cum_bytes);
1042 create_proto_tree = TRUE;
1044 /* The protocol tree will be "visible", i.e., printed, only if we're
1045 printing packet details, which is true if we're in verbose mode ("verbose"
1047 epan_dissect_init(&edt, create_proto_tree, FALSE);
1049 /* If we're running a read filter, prime the epan_dissect_t with that
1051 if (n_rfilters > 0) {
1052 for(i = 0; i < n_rfcodes; i++) {
1053 epan_dissect_prime_dfilter(&edt, rfcodes[i]);
1057 tap_queue_init(&edt);
1059 printf("%lu", (unsigned long int) cf->count);
1061 frame_data_set_before_dissect(&fdata, &cf->elapsed_time,
1062 &first_ts, &prev_dis_ts, &prev_cap_ts);
1064 /* We only need the columns if we're printing packet info but we're
1065 *not* verbose; in verbose mode, we print the protocol tree, not
1066 the protocol summary. */
1067 epan_dissect_run(&edt, &pseudo_header, pd, &fdata, &cf->cinfo);
1069 tap_push_tapped_queue(&edt);
1071 frame_data_set_after_dissect(&fdata, &cum_bytes, &prev_dis_ts);
1073 for(i = 0; i < n_rfilters; i++) {
1074 /* Run the read filter if we have one. */
1076 passed = dfilter_apply_edt(rfcodes[i], &edt);
1080 /* Print a one-line summary */
1081 printf(" %u", passed ? 1 : 0);
1086 /* The ANSI C standard does not appear to *require* that a line-buffered
1087 stream be flushed to the host environment whenever a newline is
1088 written, it just says that, on such a stream, characters "are
1089 intended to be transmitted to or from the host environment as a
1090 block when a new-line character is encountered".
1092 The Visual C++ 6.0 C implementation doesn't do what is intended;
1093 even if you set a stream to be line-buffered, it still doesn't
1094 flush the buffer at the end of every line.
1096 So, if the "-l" flag was specified, we flush the standard output
1097 at the end of a packet. This will do the right thing if we're
1098 printing packet summary lines, and, as we print the entire protocol
1099 tree for a single packet without waiting for anything to happen,
1100 it should be as good as line-buffered mode if we're printing
1101 protocol trees. (The whole reason for the "-l" flag in either
1102 tcpdump or Rawshark is to allow the output of a live capture to
1103 be piped to a program or script and to have that script see the
1104 information for the packet as soon as it's printed, rather than
1105 having to wait until a standard I/O buffer fills up. */
1109 if (ferror(stdout)) {
1110 show_print_file_io_error(errno);
1114 epan_dissect_cleanup(&edt);
1115 frame_data_cleanup(&fdata);
1120 /****************************************************************************************
1121 * FIELD EXTRACTION ROUTINES
1122 ****************************************************************************************/
1123 typedef struct _pci_t {
1129 static const char* ftenum_to_string(header_field_info *hfi)
1135 if (string_fmts->len > 0 && hfi->strings) {
1143 return "FT_PROTOCOL";
1145 return "FT_BOOLEAN";
1170 case FT_ABSOLUTE_TIME:
1171 return "FT_ABSOLUTE_TIME";
1172 case FT_RELATIVE_TIME:
1173 return "FT_RELATIVE_TIME";
1177 return "FT_STRINGZ";
1178 case FT_UINT_STRING:
1179 return "FT_UINT_STRING";
1185 return "FT_UINT_BYTES";
1193 return "FT_FRAMENUM";
1201 return "FT_NUM_TYPES";
1207 static const char* absolute_time_display_e_to_string(absolute_time_display_e atd)
1210 case ABSOLUTE_TIME_LOCAL:
1211 return "ABSOLUTE_TIME_LOCAL";
1212 case ABSOLUTE_TIME_UTC:
1213 return "ABSOLUTE_TIME_UTC";
1219 static const char* base_display_e_to_string(base_display_e bd)
1231 return "BASE_DEC_HEX";
1233 return "BASE_HEX_DEC";
1240 * Copied from various parts of proto.c
1242 #define FIELD_STR_INIT_LEN 256
1243 #define cVALS(x) (const value_string*)(x)
1244 static gboolean print_field_value(field_info *finfo, int cmd_line_index)
1246 header_field_info *hfinfo;
1247 static char *fs_buf = NULL;
1248 char *fs_ptr = fs_buf;
1249 static GString *label_s = NULL;
1250 int fs_buf_len = FIELD_STR_INIT_LEN, fs_len;
1255 const true_false_string *tfstring = &tfs_true_false;
1257 hfinfo = finfo->hfinfo;
1260 fs_buf = (char *)g_malloc(fs_buf_len + 1);
1265 label_s = g_string_new("");
1268 if(finfo->value.ftype->val_to_string_repr)
1271 * this field has an associated value,
1274 fs_len = fvalue_string_repr_len(&finfo->value, FTREPR_DFILTER);
1275 while (fs_buf_len < fs_len) {
1277 fs_buf = (char *)g_realloc(fs_buf, fs_buf_len + 1);
1280 fvalue_to_string_repr(&finfo->value,
1284 /* String types are quoted. Remove them. */
1285 if ((finfo->value.ftype->ftype == FT_STRING || finfo->value.ftype->ftype == FT_STRINGZ) && fs_len > 2) {
1286 fs_buf[fs_len - 1] = '\0';
1291 if (string_fmts->len > 0 && finfo->hfinfo->strings) {
1292 g_string_truncate(label_s, 0);
1293 for (i = 0; i < string_fmts->len; i++) {
1294 sf = (string_fmt_t *)g_ptr_array_index(string_fmts, i);
1296 g_string_append(label_s, sf->plain);
1298 switch (sf->format) {
1300 g_string_append(label_s, hfinfo->name);
1303 g_string_append(label_s, fs_ptr);
1306 switch(hfinfo->type) {
1308 uvalue = fvalue_get_uinteger(&finfo->value);
1309 tfstring = (const struct true_false_string*) hfinfo->strings;
1310 g_string_append(label_s, uvalue ? tfstring->true_string : tfstring->false_string);
1316 DISSECTOR_ASSERT(!hfinfo->bitmask);
1317 svalue = fvalue_get_sinteger(&finfo->value);
1318 if (hfinfo->display & BASE_RANGE_STRING) {
1319 g_string_append(label_s, rval_to_str(svalue, RVALS(hfinfo->strings), "Unknown"));
1321 g_string_append(label_s, val_to_str(svalue, cVALS(hfinfo->strings), "Unknown"));
1328 uvalue = fvalue_get_uinteger(&finfo->value);
1329 if (!hfinfo->bitmask && hfinfo->display & BASE_RANGE_STRING) {
1330 g_string_append(label_s, rval_to_str(uvalue, RVALS(hfinfo->strings), "Unknown"));
1332 g_string_append(label_s, val_to_str(uvalue, cVALS(hfinfo->strings), "Unknown"));
1344 printf(" %u=\"%s\"", cmd_line_index, label_s->str);
1348 if(finfo->value.ftype->val_to_string_repr)
1350 printf(" %u=\"%s\"", cmd_line_index, fs_ptr);
1355 * This field doesn't have an associated value,
1359 printf(" %u=\"n.a.\"", cmd_line_index);
1364 protocolinfo_packet(void *prs, packet_info *pinfo _U_, epan_dissect_t *edt, const void *dummy _U_)
1366 pci_t *rs=(pci_t *)prs;
1370 gp=proto_get_finfo_ptr_array(edt->tree, rs->hf_index);
1377 * Print each occurrence of the field
1379 for (i = 0; i < gp->len; i++) {
1380 print_field_value((field_info *)gp->pdata[i], rs->cmd_line_index);
1386 int g_cmd_line_index = 0;
1389 * field must be persistent - we don't g_strdup() it below
1392 protocolinfo_init(char *field)
1395 header_field_info *hfi;
1396 GString *error_string;
1398 hfi=proto_registrar_get_byname(field);
1400 fprintf(stderr, "rawshark: Field \"%s\" doesn't exist.\n", field);
1404 switch (hfi->type) {
1406 case FT_ABSOLUTE_TIME:
1407 printf("%u %s %s - ",
1409 ftenum_to_string(hfi),
1410 absolute_time_display_e_to_string(hfi->display));
1415 printf("%u %s %s - ",
1417 ftenum_to_string(hfi),
1418 base_display_e_to_string(hfi->display));
1422 rs=(pci_t *)g_malloc(sizeof(pci_t));
1423 rs->hf_index=hfi->id;
1425 rs->cmd_line_index = g_cmd_line_index++;
1427 error_string=register_tap_listener("frame", rs, rs->filter, TL_REQUIRES_PROTO_TREE, NULL, protocolinfo_packet, NULL);
1429 /* error, we failed to attach to the tap. complain and clean up */
1430 fprintf(stderr, "rawshark: Couldn't register field extraction tap: %s\n",
1432 g_string_free(error_string, TRUE);
1443 * Given a format string, split it into a GPtrArray of string_fmt_t structs
1444 * and fill in string_fmt_parts.
1448 add_string_fmt(string_fmt_e format, gchar *plain) {
1449 string_fmt_t *sf = (string_fmt_t *)g_malloc(sizeof(string_fmt_t));
1451 sf->format = format;
1452 sf->plain = g_strdup(plain);
1454 g_ptr_array_add(string_fmts, sf);
1458 parse_field_string_format(gchar *format) {
1459 GString *plain_s = g_string_new("");
1467 len = strlen(format);
1468 g_ptr_array_set_size(string_fmts, 0);
1471 if (format[pos] == '%') {
1472 if (pos >= len) { /* There should always be a following character */
1476 if (plain_s->len > 0) {
1477 add_string_fmt(SF_NONE, plain_s->str);
1478 g_string_truncate(plain_s, 0);
1480 switch (format[pos]) {
1482 add_string_fmt(SF_NAME, NULL);
1485 add_string_fmt(SF_NUMVAL, NULL);
1488 add_string_fmt(SF_STRVAL, NULL);
1491 g_string_append_c(plain_s, '%');
1493 default: /* Invalid format */
1497 g_string_append_c(plain_s, format[pos]);
1502 if (plain_s->len > 0) {
1503 add_string_fmt(SF_NONE, plain_s->str);
1505 g_string_free(plain_s, TRUE);
1509 /****************************************************************************************
1510 * END OF FIELD EXTRACTION ROUTINES
1511 ****************************************************************************************/
1514 show_print_file_io_error(int err)
1519 cmdarg_err("Not all the packets could be printed because there is "
1520 "no space left on the file system.");
1525 cmdarg_err("Not all the packets could be printed because you are "
1526 "too close to, or over your disk quota.");
1531 cmdarg_err("An error occurred while printing packets: %s.",
1538 * Open/create errors are reported with an console message in Rawshark.
1541 open_failure_message(const char *filename, int err, gboolean for_writing)
1543 fprintf(stderr, "rawshark: ");
1544 fprintf(stderr, file_open_error_message(err, for_writing), filename);
1545 fprintf(stderr, "\n");
1549 raw_cf_open(capture_file *cf, const char *fname)
1551 if ((fd = raw_pipe_open(fname)) < 0)
1554 /* The open succeeded. Fill in the information for this file. */
1556 /* Cleanup all data structures used for dissection. */
1557 cleanup_dissection();
1558 /* Initialize all data structures used for dissection. */
1562 cf->f_datalen = 0; /* not used, but set it anyway */
1564 /* Set the file name because we need it to set the follow stream filter.
1565 XXX - is that still true? We need it for other reasons, though,
1567 cf->filename = g_strdup(fname);
1569 /* Indicate whether it's a permanent or temporary file. */
1570 cf->is_tempfile = FALSE;
1572 /* If it's a temporary capture buffer file, mark it as not saved. */
1573 cf->user_saved = FALSE;
1575 cf->cd_t = WTAP_FILE_UNKNOWN;
1577 cf->drops_known = FALSE;
1579 cf->has_snap = FALSE;
1580 cf->snap = WTAP_MAX_PACKET_SIZE;
1581 nstime_set_zero(&cf->elapsed_time);
1582 nstime_set_unset(&first_ts);
1583 nstime_set_unset(&prev_dis_ts);
1584 nstime_set_unset(&prev_cap_ts);
1591 * General errors are reported with an console message in Rawshark.
1594 failure_message(const char *msg_format, va_list ap)
1596 fprintf(stderr, "rawshark: ");
1597 vfprintf(stderr, msg_format, ap);
1598 fprintf(stderr, "\n");
1602 * Read errors are reported with an console message in Rawshark.
1605 read_failure_message(const char *filename, int err)
1607 cmdarg_err("An error occurred while reading from the file \"%s\": %s.",
1608 filename, strerror(err));
1612 * Write errors are reported with an console message in Rawshark.
1615 write_failure_message(const char *filename, int err)
1617 cmdarg_err("An error occurred while writing to the file \"%s\": %s.",
1618 filename, strerror(err));
1622 * Report an error in command-line arguments.
1625 cmdarg_err(const char *fmt, ...)
1630 fprintf(stderr, "rawshark: ");
1631 vfprintf(stderr, fmt, ap);
1632 fprintf(stderr, "\n");
1637 * Report additional information for an error in command-line arguments.
1640 cmdarg_err_cont(const char *fmt, ...)
1645 vfprintf(stderr, fmt, ap);
1646 fprintf(stderr, "\n");
1657 * indent-tabs-mode: nil
1660 * ex: set shiftwidth=4 tabstop=8 expandtab
1661 * :indentSize=4:tabSize=8:noTabs=true: