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
73 #include <epan/epan.h>
74 #include <epan/filesystem.h>
75 #include <wsutil/privileges.h>
76 #include <wsutil/file_util.h>
79 #include <epan/packet.h>
81 #include "disabled_protos.h"
82 #include <epan/prefs.h>
83 #include <epan/column.h>
85 #include <epan/addr_resolv.h>
87 #include "clopts_common.h"
88 #include "cmdarg_err.h"
89 #include "version_info.h"
90 #include <epan/plugins.h>
92 #include "conditions.h"
93 #include "capture_stop_conditions.h"
94 #include "capture_ui_utils.h"
95 #include <epan/epan_dissect.h>
96 #include <epan/stat_cmd_args.h>
97 #include <epan/timestamp.h>
98 #include <wsutil/unicode-utils.h>
99 #include "epan/column-utils.h"
100 #include "epan/proto.h"
101 #include <epan/tap.h>
109 #include "capture-pcap-util.h"
112 #include "capture-wpcap.h"
113 #include "capture_errs.h"
115 #endif /* HAVE_LIBPCAP */
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 = 0;
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;
142 * Standard secondary message for unexpected errors.
144 static const char please_report[] =
145 "Please report this to the Wireshark developers";
147 cf_status_t raw_cf_open(capture_file *cf, const char *fname);
148 static int load_cap_file(capture_file *cf);
149 static gboolean process_packet(capture_file *cf, gint64 offset,
150 const struct wtap_pkthdr *whdr, const guchar *pd);
151 static void show_print_file_io_error(int err);
153 static void open_failure_message(const char *filename, int err,
154 gboolean for_writing);
155 static void failure_message(const char *msg_format, va_list ap);
156 static void read_failure_message(const char *filename, int err);
157 static void write_failure_message(const char *filename, int err);
158 static void protocolinfo_init(char *field);
159 static gboolean parse_field_string_format(char *format);
161 extern void frame_data_init(frame_data *fdata, capture_file *cf,
162 const struct wtap_pkthdr *phdr, gint64 offset,
165 nstime_t *prev_dis_ts,
166 nstime_t *prev_cap_ts);
169 SF_NONE, /* No format (placeholder) */
170 SF_NAME, /* %D Field name / description */
171 SF_NUMVAL, /* %N Numeric value */
172 SF_STRVAL /* %S String value */
175 typedef struct string_fmt_s {
177 string_fmt_e format; /* Valid if plain is NULL */
183 dfilter_t *rfcodes[64];
185 dfilter_t *rfieldfcodes[64];
188 GPtrArray *string_fmts;
191 print_usage(gboolean print_ver)
198 "Rawshark " VERSION "%s\n"
199 "Dump and analyze network traffic.\n"
200 "See http://www.wireshark.org for more information.\n"
203 wireshark_svnversion, get_copyright_info());
207 fprintf(output, "\n");
208 fprintf(output, "Usage: rawshark [options] ...\n");
209 fprintf(output, "\n");
211 fprintf(output, "Input file:\n");
212 fprintf(output, " -r <infile> set the pipe or file name to read from\n");
214 fprintf(output, "\n");
215 fprintf(output, "Processing:\n");
216 fprintf(output, " -R <read filter> packet filter in Wireshark display filter syntax\n");
217 fprintf(output, " -F <field> field to display\n");
218 fprintf(output, " -s skip PCAP header on input\n");
219 fprintf(output, " -n disable all name resolution (def: all enabled)\n");
220 fprintf(output, " -N <name resolve flags> enable specific name resolution(s): \"mntC\"\n");
221 fprintf(output, " -d <encap:dlt>|<proto:protoname>\n");
222 fprintf(output, " packet encapsulation or protocol\n");
224 /*fprintf(output, "\n");*/
225 fprintf(output, "Output:\n");
226 fprintf(output, " -S format string for fields (%%D - name, %%S - stringval, %%N numval)\n");
227 fprintf(output, " -t ad|a|r|d|dd|e output format of time stamps (def: r: rel. to first)\n");
228 fprintf(output, " -l flush output after each packet\n");
230 fprintf(output, "\n");
231 fprintf(output, "Miscellaneous:\n");
232 fprintf(output, " -h display this help and exit\n");
233 fprintf(output, " -v display version info and exit\n");
234 fprintf(output, " -o <name>:<value> ... override preference setting\n");
238 log_func_ignore (const gchar *log_domain _U_, GLogLevelFlags log_level _U_,
239 const gchar *message _U_, gpointer user_data _U_)
244 * Open a pipe for raw input. This is a stripped-down version of
245 * pcap_loop.c:cap_pipe_open_live().
246 * We check if "pipe_name" is "-" (stdin) or a FIFO, and open it.
247 * @param pipe_name The name of the pipe or FIFO.
248 * @return A POSIX file descriptor on success, or -1 on failure.
251 raw_pipe_open(const char *pipe_name)
254 struct stat pipe_stat;
263 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "open_raw_pipe: %s", pipe_name);
266 * XXX Rawshark blocks until we return
268 if (strcmp(pipe_name, "-") == 0) {
269 rfd = 0; /* read from stdin */
272 * This is needed to set the stdin pipe into binary mode, otherwise
273 * CR/LF are mangled...
275 _setmode(0, _O_BINARY);
279 if (ws_stat(pipe_name, &pipe_stat) < 0) {
280 fprintf(stderr, "rawshark: The pipe %s could not be checked: %s\n",
281 pipe_name, strerror(errno));
284 if (! S_ISFIFO(pipe_stat.st_mode)) {
285 if (S_ISCHR(pipe_stat.st_mode)) {
287 * Assume the user specified an interface on a system where
288 * interfaces are in /dev. Pretend we haven't seen it.
292 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
297 rfd = ws_open(pipe_name, O_RDONLY | O_NONBLOCK, 0000 /* no creation so don't matter */);
299 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
300 pipe_name, strerror(errno));
304 #define PIPE_STR "\\pipe\\"
305 /* Under Windows, named pipes _must_ have the form
306 * "\\<server>\pipe\<pipe_name>". <server> may be "." for localhost.
308 pncopy = g_strdup(pipe_name);
309 if (strstr(pncopy, "\\\\") == pncopy) {
310 pos = strchr(pncopy + 3, '\\');
311 if (pos && g_ascii_strncasecmp(pos, PIPE_STR, strlen(PIPE_STR)) != 0)
318 fprintf(stderr, "rawshark: \"%s\" is neither an interface nor a pipe\n",
323 /* Wait for the pipe to appear */
325 hPipe = CreateFile(utf_8to16(pipe_name), GENERIC_READ, 0, NULL,
326 OPEN_EXISTING, 0, NULL);
328 if (hPipe != INVALID_HANDLE_VALUE)
331 err = GetLastError();
332 if (err != ERROR_PIPE_BUSY) {
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 opened: %s (error %d)\n",
336 pipe_name, utf_16to8(err_str), err);
341 if (!WaitNamedPipe(utf_8to16(pipe_name), 30 * 1000)) {
342 err = GetLastError();
343 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER,
344 NULL, err, 0, (LPTSTR) &err_str, 0, NULL);
345 fprintf(stderr, "rawshark: \"%s\" could not be waited for: %s (error %d)\n",
346 pipe_name, utf_16to8(err_str), err);
352 rfd = _open_osfhandle((long) hPipe, _O_RDONLY);
354 fprintf(stderr, "rawshark: \"%s\" could not be opened: %s\n",
355 pipe_name, strerror(errno));
365 * Parse a link-type argument of the form "encap:<pcap dlt>" or
366 * "proto:<proto name>". "Pcap dlt" must be a name conforming to
367 * pcap_datalink_name_to_val() or an integer. "Proto name" must be
368 * a protocol name, e.g. "http".
371 set_link_type(const char *lt_arg) {
372 char *spec_ptr = strchr(lt_arg, ':');
376 dissector_handle_t dhandle;
384 if (strncmp(lt_arg, "encap:", strlen("encap:")) == 0) {
385 dlt_val = linktype_name_to_val(spec_ptr);
388 val = strtol(spec_ptr, &p, 10);
389 if (p == spec_ptr || *p != '\0' || errno != 0 || val > INT_MAX) {
394 encap = wtap_pcap_encap_to_wtap_encap(dlt_val);
395 if (encap == WTAP_ENCAP_UNKNOWN) {
399 } else if (strncmp(lt_arg, "proto:", strlen("proto:")) == 0) {
400 dhandle = find_dissector(spec_ptr);
402 encap = WTAP_ENCAP_USER0;
403 pref_str = g_string_new("uat:user_dlts:");
404 /* This must match the format used in the user_dlts file */
405 g_string_append_printf(pref_str,
406 "\"User 0 (DLT=147)\",\"%s\",\"0\",\"\",\"0\",\"\"",
408 if (prefs_set_pref(pref_str->str) != PREFS_SET_OK) {
409 g_string_free(pref_str, TRUE);
412 g_string_free(pref_str, TRUE);
420 show_version(GString *comp_info_str, GString *runtime_info_str)
422 printf("Rawshark " VERSION "%s\n"
429 wireshark_svnversion, get_copyright_info(), comp_info_str->str,
430 runtime_info_str->str);
434 main(int argc, char *argv[])
436 char *init_progfile_dir_error;
439 gboolean arg_error = FALSE;
445 char *gpf_path, *pf_path;
446 char *gdp_path, *dp_path;
447 int gpf_open_errno, gpf_read_errno;
448 int pf_open_errno, pf_read_errno;
449 int gdp_open_errno, gdp_read_errno;
450 int dp_open_errno, dp_read_errno;
452 gchar *pipe_name = NULL;
456 GLogLevelFlags log_flags;
457 GPtrArray *disp_fields = g_ptr_array_new();
459 gboolean skip_pcap_header = FALSE;
461 #define OPTSTRING_INIT "d:F:hlnN:o:r:R:sS:t:v"
463 static const char optstring[] = OPTSTRING_INIT;
466 * Get credential information for later use.
468 get_credential_info();
471 * Clear the filters arrays
473 memset(rfilters, 0, sizeof(rfilters));
474 memset(rfcodes, 0, sizeof(rfcodes));
479 * Initialize our string format
481 string_fmts = g_ptr_array_new();
484 * Attempt to get the pathname of the executable file.
486 init_progfile_dir_error = init_progfile_dir(argv[0], main);
487 if (init_progfile_dir_error != NULL) {
488 fprintf(stderr, "rawshark: Can't get pathname of rawshark program: %s.\n",
489 init_progfile_dir_error);
493 * Get credential information for later use.
495 get_credential_info();
497 /* nothing more than the standard GLib handler, but without a warning */
499 G_LOG_LEVEL_WARNING |
500 G_LOG_LEVEL_MESSAGE |
504 g_log_set_handler(NULL,
506 log_func_ignore, NULL /* user_data */);
507 g_log_set_handler(LOG_DOMAIN_CAPTURE_CHILD,
509 log_func_ignore, NULL /* user_data */);
511 timestamp_set_type(TS_RELATIVE);
512 timestamp_set_precision(TS_PREC_AUTO);
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 = 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 g_resolv_flags = prefs->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 init_cap_file(&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 g_resolv_flags = RESOLV_NONE;
633 case 'N': /* Select what types of addresses/port #s to resolve */
634 if (g_resolv_flags == RESOLV_ALL)
635 g_resolv_flags = RESOLV_NONE;
636 badopt = string_to_name_resolve(optarg, &g_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 'r': /* Read capture file xxx */
662 pipe_name = g_strdup(optarg);
664 case 'R': /* Read file filter */
665 if(n_rfilters < (int) sizeof(rfilters) / (int) sizeof(rfilters[0])) {
666 rfilters[n_rfilters++] = optarg;
669 cmdarg_err("Too many display filters");
673 case 's': /* Skip PCAP header */
674 skip_pcap_header = TRUE;
676 case 'S': /* Print string representations */
677 if (!parse_field_string_format(optarg)) {
678 cmdarg_err("Invalid field string format");
682 case 't': /* Time stamp type */
683 if (strcmp(optarg, "r") == 0)
684 timestamp_set_type(TS_RELATIVE);
685 else if (strcmp(optarg, "a") == 0)
686 timestamp_set_type(TS_ABSOLUTE);
687 else if (strcmp(optarg, "ad") == 0)
688 timestamp_set_type(TS_ABSOLUTE_WITH_DATE);
689 else if (strcmp(optarg, "d") == 0)
690 timestamp_set_type(TS_DELTA);
691 else if (strcmp(optarg, "dd") == 0)
692 timestamp_set_type(TS_DELTA_DIS);
693 else if (strcmp(optarg, "e") == 0)
694 timestamp_set_type(TS_EPOCH);
696 cmdarg_err("Invalid time stamp type \"%s\"",
698 cmdarg_err_cont("It must be \"r\" for relative, \"a\" for absolute,");
699 cmdarg_err_cont("\"ad\" for absolute with date, or \"d\" for delta.");
703 case 'v': /* Show version and exit */
705 GString *comp_info_str;
706 GString *runtime_info_str;
707 /* Assemble the compile-time version information string */
708 comp_info_str = g_string_new("Compiled ");
709 get_compiled_version_info(comp_info_str, get_epan_compiled_version_info);
711 /* Assemble the run-time version information string */
712 runtime_info_str = g_string_new("Running ");
713 get_runtime_version_info(runtime_info_str, NULL);
714 show_version(comp_info_str, runtime_info_str);
715 g_string_free(comp_info_str, TRUE);
716 g_string_free(runtime_info_str, TRUE);
721 case '?': /* Bad flag - print usage message */
728 /* Notify all registered modules that have had any of their preferences
729 changed either from one of the preferences file or from the command
730 line that their preferences have changed.
731 Initialize preferences before display filters, otherwise modules
732 like MATE won't work. */
735 /* Initialize our display fields */
736 for (fc = 0; fc < disp_fields->len; fc++) {
737 protocolinfo_init(g_ptr_array_index(disp_fields, fc));
739 g_ptr_array_free(disp_fields, TRUE);
743 /* If no capture filter or read filter has been specified, and there are
744 still command-line arguments, treat them as the tokens of a capture
745 filter (if no "-r" flag was specified) or a read filter (if a "-r"
746 flag was specified. */
748 if (pipe_name != NULL) {
749 if (n_rfilters != 0) {
750 cmdarg_err("Read filters were specified both with \"-R\" "
751 "and with additional command-line arguments");
754 rfilters[n_rfilters] = get_args_as_string(argc, argv, optind);
758 /* Make sure we got a dissector handle for our payload. */
759 if (encap == WTAP_ENCAP_UNKNOWN) {
760 cmdarg_err("No valid payload dissector specified.");
771 /* Start windows sockets */
772 WSAStartup( MAKEWORD( 1, 1 ), &wsaData );
775 /* At this point MATE will have registered its field array so we can
776 have a tap filter with one of MATE's late-registered fields as part
777 of the filter. We can now process all the "-z" arguments. */
778 start_requested_stats();
780 /* disabled protocols as per configuration file */
781 if (gdp_path == NULL && dp_path == NULL) {
782 set_disabled_protos_list();
785 /* Build the column format array */
786 build_column_format_array(&cfile.cinfo, prefs->num_cols, TRUE);
788 if (n_rfilters != 0) {
789 for (i = 0; i < n_rfilters; i++) {
790 if (!dfilter_compile(rfilters[i], &rfcodes[n_rfcodes])) {
791 cmdarg_err("%s", dfilter_error_msg);
801 * We're reading a pipe (or capture file).
805 * Immediately relinquish any special privileges we have; we must not
806 * be allowed to read any capture files the user running Rawshark
809 relinquish_special_privs_perm();
811 if (raw_cf_open(&cfile, pipe_name) != CF_OK) {
816 /* Do we need to PCAP header and magic? */
817 if (skip_pcap_header) {
818 guint bytes_left = sizeof(struct pcap_hdr) + sizeof(guint32);
819 gchar buf[sizeof(struct pcap_hdr) + sizeof(guint32)];
820 while (bytes_left > 0) {
821 guint bytes = read(fd, buf, bytes_left);
823 cmdarg_err("Not enough bytes for pcap header.");
830 /* Set timestamp precision; there should arguably be a command-line
831 option to let the user set this. */
833 switch(wtap_file_tsprecision(cfile.wth)) {
834 case(WTAP_FILE_TSPREC_SEC):
835 timestamp_set_precision(TS_PREC_AUTO_SEC);
837 case(WTAP_FILE_TSPREC_DSEC):
838 timestamp_set_precision(TS_PREC_AUTO_DSEC);
840 case(WTAP_FILE_TSPREC_CSEC):
841 timestamp_set_precision(TS_PREC_AUTO_CSEC);
843 case(WTAP_FILE_TSPREC_MSEC):
844 timestamp_set_precision(TS_PREC_AUTO_MSEC);
846 case(WTAP_FILE_TSPREC_USEC):
847 timestamp_set_precision(TS_PREC_AUTO_USEC);
849 case(WTAP_FILE_TSPREC_NSEC):
850 timestamp_set_precision(TS_PREC_AUTO_NSEC);
853 g_assert_not_reached();
856 timestamp_set_precision(TS_PREC_AUTO_USEC);
859 /* Process the packets in the file */
860 err = load_cap_file(&cfile);
867 /* If you want to capture live packets, use TShark. */
868 cmdarg_err("Input file or pipe name not specified.");
878 * Read data from a raw pipe. The "raw" data consists of a libpcap
879 * packet header followed by the payload.
880 * @param fd [IN] A POSIX file descriptor. Because that's _exactly_ the sort
881 * of thing you want to use in Windows.
882 * @param phdr [OUT] Packet header information.
883 * @param err [OUT] Error indicator. Uses wiretap values.
884 * @param err_info [OUT] Error message.
885 * @param data_offset [OUT] data offset in the pipe.
886 * @return TRUE on success, FALSE on failure.
889 raw_pipe_read(struct wtap_pkthdr *phdr, guchar * pd, int *err, gchar **err_info, gint64 *data_offset) {
890 struct pcaprec_hdr hdr;
892 int bytes_needed = sizeof(struct pcaprec_hdr);
893 guchar *ptr = (guchar*)&hdr;
894 static gchar err_str[100];
896 /* Copied from capture_loop.c */
897 while (bytes_needed > 0) {
898 bytes_read = read(fd, ptr, bytes_needed);
899 if (bytes_read == 0) {
902 } else if (bytes_read < 0) {
903 *err = WTAP_ERR_CANT_READ;
904 *err_info = "Error reading header from pipe";
907 bytes_needed -= bytes_read;
908 *data_offset += bytes_read;
913 phdr->ts.secs = hdr.ts_sec;
914 phdr->ts.nsecs = hdr.ts_usec * 1000;
915 phdr->caplen = bytes_needed = hdr.incl_len;
916 phdr->len = hdr.orig_len;
917 phdr->pkt_encap = encap;
920 printf("tv_sec: %d (%04x)\n", hdr.ts.tv_sec, hdr.ts.tv_sec);
921 printf("tv_usec: %d (%04x)\n", hdr.ts.tv_usec, hdr.ts.tv_usec);
922 printf("caplen: %d (%04x)\n", hdr.caplen, hdr.caplen);
923 printf("len: %d (%04x)\n", hdr.len, hdr.len);
925 if (bytes_needed > WTAP_MAX_PACKET_SIZE) {
926 *err = WTAP_ERR_BAD_RECORD;
927 g_snprintf(err_str, 100, "Bad packet length: %d (%04x)", bytes_needed, bytes_needed);
933 while (bytes_needed > 0) {
934 bytes_read = read(fd, ptr, bytes_needed);
935 if (bytes_read == 0) {
936 *err = WTAP_ERR_SHORT_READ;
937 *err_info = "Got zero bytes reading data from pipe";
939 } else if (bytes_read < 0) {
940 *err = WTAP_ERR_CANT_READ;
941 *err_info = "Error reading data from pipe";
944 bytes_needed -= bytes_read;
945 *data_offset += bytes_read;
952 load_cap_file(capture_file *cf)
956 gint64 data_offset = 0;
957 struct wtap_pkthdr phdr;
958 guchar pd[WTAP_MAX_PACKET_SIZE];
960 while (raw_pipe_read(&phdr, pd, &err, &err_info, &data_offset)) {
961 process_packet(cf, data_offset, &phdr, pd);
965 /* Print a message noting that the read failed somewhere along the line. */
968 case WTAP_ERR_UNSUPPORTED_ENCAP:
969 cmdarg_err("\"%s\" has a packet with a network type that Rawshark doesn't support.\n(%s)",
970 cf->filename, err_info);
973 case WTAP_ERR_CANT_READ:
974 cmdarg_err("An attempt to read from \"%s\" failed for some unknown reason.",
978 case WTAP_ERR_SHORT_READ:
979 cmdarg_err("\"%s\" appears to have been cut short in the middle of a packet.",
983 case WTAP_ERR_BAD_RECORD:
984 cmdarg_err("\"%s\" appears to be damaged or corrupt.\n(%s)",
985 cf->filename, err_info);
989 cmdarg_err("An error occurred while reading \"%s\": %s.",
990 cf->filename, wtap_strerror(err));
999 process_packet(capture_file *cf, gint64 offset, const struct wtap_pkthdr *whdr,
1003 gboolean create_proto_tree;
1006 union wtap_pseudo_header pseudo_header;
1011 /* The user sends an empty packet when he wants to get output from us even if we don't currently have
1012 packets to process. We spit out a line with the timestamp and the text "void"
1014 printf("%lu %lu %lu void -\n", (unsigned long int)cf->count,
1015 (unsigned long int)whdr->ts.secs,
1016 (unsigned long int)whdr->ts.nsecs);
1023 memset(&pseudo_header, 0, sizeof(pseudo_header));
1025 /* Count this packet. */
1028 /* If we're going to print packet information, or we're going to
1029 run a read filter, or we're going to process taps, set up to
1030 do a dissection and do so. */
1031 frame_data_init(&fdata, cf, whdr, offset,
1032 &cum_bytes, &first_ts, &prev_dis_ts, &prev_cap_ts);
1035 create_proto_tree = TRUE;
1037 /* The protocol tree will be "visible", i.e., printed, only if we're
1038 printing packet details, which is true if we're in verbose mode ("verbose"
1040 epan_dissect_init(&edt, create_proto_tree, FALSE);
1042 /* If we're running a read filter, prime the epan_dissect_t with that
1044 if (n_rfilters > 0) {
1045 for(i = 0; i < n_rfcodes; i++) {
1046 epan_dissect_prime_dfilter(&edt, rfcodes[i]);
1050 tap_queue_init(&edt);
1052 printf("%lu", (unsigned long int)cf->count);
1054 /* We only need the columns if we're printing packet info but we're
1055 *not* verbose; in verbose mode, we print the protocol tree, not
1056 the protocol summary. */
1057 epan_dissect_run(&edt, &pseudo_header, pd, &fdata, &cf->cinfo);
1059 tap_push_tapped_queue(&edt);
1061 for(i = 0; i < n_rfilters; i++) {
1062 /* Run the read filter if we have one. */
1064 passed = dfilter_apply_edt(rfcodes[i], &edt);
1068 /* Print a one-line summary */
1069 printf(" %u", passed ? 1 : 0);
1074 /* The ANSI C standard does not appear to *require* that a line-buffered
1075 stream be flushed to the host environment whenever a newline is
1076 written, it just says that, on such a stream, characters "are
1077 intended to be transmitted to or from the host environment as a
1078 block when a new-line character is encountered".
1080 The Visual C++ 6.0 C implementation doesn't do what is intended;
1081 even if you set a stream to be line-buffered, it still doesn't
1082 flush the buffer at the end of every line.
1084 So, if the "-l" flag was specified, we flush the standard output
1085 at the end of a packet. This will do the right thing if we're
1086 printing packet summary lines, and, as we print the entire protocol
1087 tree for a single packet without waiting for anything to happen,
1088 it should be as good as line-buffered mode if we're printing
1089 protocol trees. (The whole reason for the "-l" flag in either
1090 tcpdump or Rawshark is to allow the output of a live capture to
1091 be piped to a program or script and to have that script see the
1092 information for the packet as soon as it's printed, rather than
1093 having to wait until a standard I/O buffer fills up. */
1097 if (ferror(stdout)) {
1098 show_print_file_io_error(errno);
1102 epan_dissect_cleanup(&edt);
1103 frame_data_cleanup(&fdata);
1108 /****************************************************************************************
1109 * FIELD EXTRACTION ROUTINES
1110 ****************************************************************************************/
1111 typedef struct _pci_t {
1117 char* ftenum_to_string(header_field_info *hfi)
1123 if (string_fmts->len > 0 && hfi->strings) {
1131 return "FT_PROTOCOL";
1133 return "FT_BOOLEAN";
1158 case FT_ABSOLUTE_TIME:
1159 return "FT_ABSOLUTE_TIME";
1160 case FT_RELATIVE_TIME:
1161 return "FT_RELATIVE_TIME";
1165 return "FT_STRINGZ";
1166 case FT_UINT_STRING:
1167 return "FT_UINT_STRING";
1173 return "FT_UINT_BYTES";
1181 return "FT_FRAMENUM";
1189 return "FT_NUM_TYPES";
1195 char* base_display_e_to_string(base_display_e bd)
1207 return "BASE_DEC_HEX";
1209 return "BASE_HEX_DEC";
1216 * Copied from various parts of proto.c
1218 #define FIELD_STR_INIT_LEN 256
1219 #define cVALS(x) (const value_string*)(x)
1220 static gboolean print_field_value(field_info *finfo, int cmd_line_index)
1222 header_field_info *hfinfo;
1223 static char *fs_buf = NULL;
1224 char *fs_ptr = fs_buf;
1225 static GString *label_s = NULL;
1226 int fs_buf_len = FIELD_STR_INIT_LEN, fs_len;
1231 const true_false_string *tfstring = &tfs_true_false;
1233 hfinfo = finfo->hfinfo;
1236 fs_buf = g_malloc(fs_buf_len + 1);
1241 label_s = g_string_new("");
1244 if(finfo->value.ftype->val_to_string_repr)
1247 * this field has an associated value,
1250 fs_len = fvalue_string_repr_len(&finfo->value, FTREPR_DFILTER);
1251 while (fs_buf_len < fs_len) {
1253 fs_buf = g_realloc(fs_buf, fs_buf_len + 1);
1256 fvalue_to_string_repr(&finfo->value,
1260 /* String types are quoted. Remove them. */
1261 if ((finfo->value.ftype->ftype == FT_STRING || finfo->value.ftype->ftype == FT_STRINGZ) && fs_len > 2) {
1262 fs_buf[fs_len - 1] = '\0';
1267 if (string_fmts->len > 0 && finfo->hfinfo->strings) {
1268 g_string_truncate(label_s, 0);
1269 for (i = 0; i < string_fmts->len; i++) {
1270 sf = g_ptr_array_index(string_fmts, i);
1272 g_string_append(label_s, sf->plain);
1274 switch (sf->format) {
1276 g_string_append(label_s, hfinfo->name);
1279 g_string_append(label_s, fs_ptr);
1282 switch(hfinfo->type) {
1284 uvalue = fvalue_get_uinteger(&finfo->value);
1285 tfstring = (const struct true_false_string*) hfinfo->strings;
1286 g_string_append(label_s, uvalue ? tfstring->true_string : tfstring->false_string);
1292 DISSECTOR_ASSERT(!hfinfo->bitmask);
1293 svalue = fvalue_get_sinteger(&finfo->value);
1294 if (hfinfo->display & BASE_RANGE_STRING) {
1295 g_string_append(label_s, rval_to_str(svalue, hfinfo->strings, "Unknown"));
1297 g_string_append(label_s, val_to_str(svalue, cVALS(hfinfo->strings), "Unknown"));
1303 uvalue = fvalue_get_uinteger(&finfo->value);
1304 if (!hfinfo->bitmask && hfinfo->display & BASE_RANGE_STRING) {
1305 g_string_append(label_s, rval_to_str(uvalue, hfinfo->strings, "Unknown"));
1307 g_string_append(label_s, val_to_str(uvalue, cVALS(hfinfo->strings), "Unknown"));
1319 printf(" %u=\"%s\"", cmd_line_index, label_s->str);
1323 if(finfo->value.ftype->val_to_string_repr)
1325 printf(" %u=\"%s\"", cmd_line_index, fs_ptr);
1330 * This field doesn't have an associated value,
1334 printf(" %u=\"n.a.\"", cmd_line_index);
1339 protocolinfo_packet(void *prs, packet_info *pinfo _U_, epan_dissect_t *edt, const void *dummy _U_)
1345 gp=proto_get_finfo_ptr_array(edt->tree, rs->hf_index);
1352 * Print each occurrence of the field
1354 for (i = 0; i < gp->len; i++) {
1355 print_field_value(gp->pdata[i], rs->cmd_line_index);
1361 int g_cmd_line_index = 0;
1364 * field must be persistent - we don't g_strdup() it below
1367 protocolinfo_init(char *field)
1370 header_field_info *hfi;
1371 GString *error_string;
1373 hfi=proto_registrar_get_byname(field);
1375 fprintf(stderr, "rawshark: Field \"%s\" doesn't exist.\n", field);
1379 printf("%u %s %s - ",
1381 ftenum_to_string(hfi),
1382 base_display_e_to_string(hfi->display));
1384 rs=g_malloc(sizeof(pci_t));
1385 rs->hf_index=hfi->id;
1387 rs->cmd_line_index = g_cmd_line_index++;
1389 error_string=register_tap_listener("frame", rs, rs->filter, TL_REQUIRES_PROTO_TREE, NULL, protocolinfo_packet, NULL);
1391 /* error, we failed to attach to the tap. complain and clean up */
1392 fprintf(stderr, "rawshark: Couldn't register field extraction tap: %s\n",
1394 g_string_free(error_string, TRUE);
1405 * Given a format string, split it into a GPtrArray of string_fmt_t structs
1406 * and fill in string_fmt_parts.
1410 add_string_fmt(string_fmt_e format, gchar *plain) {
1411 string_fmt_t *sf = g_malloc(sizeof(string_fmt_t));
1413 sf->format = format;
1414 sf->plain = g_strdup(plain);
1416 g_ptr_array_add(string_fmts, sf);
1420 parse_field_string_format(gchar *format) {
1421 GString *plain_s = g_string_new("");
1429 len = strlen(format);
1430 g_ptr_array_set_size(string_fmts, 0);
1433 if (format[pos] == '%') {
1434 if (pos >= len) { /* There should always be a following character */
1438 if (plain_s->len > 0) {
1439 add_string_fmt(SF_NONE, plain_s->str);
1440 g_string_truncate(plain_s, 0);
1442 switch (format[pos]) {
1444 add_string_fmt(SF_NAME, NULL);
1447 add_string_fmt(SF_NUMVAL, NULL);
1450 add_string_fmt(SF_STRVAL, NULL);
1453 g_string_append_c(plain_s, '%');
1455 default: /* Invalid format */
1459 g_string_append_c(plain_s, format[pos]);
1464 if (plain_s->len > 0) {
1465 add_string_fmt(SF_NONE, plain_s->str);
1467 g_string_free(plain_s, TRUE);
1471 /****************************************************************************************
1472 * END OF FIELD EXTRACTION ROUTINES
1473 ****************************************************************************************/
1476 show_print_file_io_error(int err)
1481 cmdarg_err("Not all the packets could be printed because there is "
1482 "no space left on the file system.");
1487 cmdarg_err("Not all the packets could be printed because you are "
1488 "too close to, or over your disk quota.");
1493 cmdarg_err("An error occurred while printing packets: %s.",
1500 * Open/create errors are reported with an console message in Rawshark.
1503 open_failure_message(const char *filename, int err, gboolean for_writing)
1505 fprintf(stderr, "rawshark: ");
1506 fprintf(stderr, file_open_error_message(err, for_writing), filename);
1507 fprintf(stderr, "\n");
1511 raw_cf_open(capture_file *cf, const char *fname)
1513 if ((fd = raw_pipe_open(fname)) < 0)
1516 /* The open succeeded. Fill in the information for this file. */
1518 /* Cleanup all data structures used for dissection. */
1519 cleanup_dissection();
1520 /* Initialize all data structures used for dissection. */
1524 cf->f_datalen = 0; /* not used, but set it anyway */
1526 /* Set the file name because we need it to set the follow stream filter.
1527 XXX - is that still true? We need it for other reasons, though,
1529 cf->filename = g_strdup(fname);
1531 /* Indicate whether it's a permanent or temporary file. */
1532 cf->is_tempfile = FALSE;
1534 /* If it's a temporary capture buffer file, mark it as not saved. */
1535 cf->user_saved = FALSE;
1537 cf->cd_t = WTAP_FILE_UNKNOWN;
1539 cf->drops_known = FALSE;
1541 cf->has_snap = FALSE;
1542 cf->snap = WTAP_MAX_PACKET_SIZE;
1543 nstime_set_zero(&cf->elapsed_time);
1544 nstime_set_unset(&first_ts);
1545 nstime_set_unset(&prev_dis_ts);
1546 nstime_set_unset(&prev_cap_ts);
1553 * General errors are reported with an console message in Rawshark.
1556 failure_message(const char *msg_format, va_list ap)
1558 fprintf(stderr, "rawshark: ");
1559 vfprintf(stderr, msg_format, ap);
1560 fprintf(stderr, "\n");
1564 * Read errors are reported with an console message in Rawshark.
1567 read_failure_message(const char *filename, int err)
1569 cmdarg_err("An error occurred while reading from the file \"%s\": %s.",
1570 filename, strerror(err));
1574 * Write errors are reported with an console message in Rawshark.
1577 write_failure_message(const char *filename, int err)
1579 cmdarg_err("An error occurred while writing to the file \"%s\": %s.",
1580 filename, strerror(err));
1584 * Report an error in command-line arguments.
1587 cmdarg_err(const char *fmt, ...)
1592 fprintf(stderr, "rawshark: ");
1593 vfprintf(stderr, fmt, ap);
1594 fprintf(stderr, "\n");
1599 * Report additional information for an error in command-line arguments.
1602 cmdarg_err_cont(const char *fmt, ...)
1607 vfprintf(stderr, fmt, ap);
1608 fprintf(stderr, "\n");
1613 /****************************************************************************************************************/
1614 /* other "dummies" */
1616 cf_mark_frame(capture_file *cf _U_, frame_data *frame _U_)
1618 /* shouldn't happen */
1619 g_assert_not_reached();
1628 * indent-tabs-mode: t
1631 * ex: set shiftwidth=4 tabstop=4 noexpandtab
1632 * :indentSize=4:tabSize=4:noTabs=false: