2 * Reports capture file information including # of packets, duration, others
4 * Copyright 2004 Ian Schorr
8 * Wireshark - Network traffic analyzer
9 * By Gerald Combs <gerald@wireshark.org>
10 * Copyright 1998 Gerald Combs
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation; either version 2
15 * of the License, or (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
30 * New capinfos features
32 * Continue processing additional files after
33 * a wiretap open failure. The new -C option
34 * reverts to capinfos' original behavior which
35 * is to cancel any further file processing at
36 * first file open failure.
38 * Change the behavior of how the default display
39 * of all infos is initiated. This gets rid of a
40 * special post getopt() argument count test.
42 * Add new table output format (with related options)
43 * This feature allows outputting the various infos
44 * into a tab delimited text file, or to a comma
45 * separated variables file (*.csv) instead of the
46 * original "long" format.
49 * behaviour changed: Upon exit capinfos will return
50 * an error status if an error occurred at any
51 * point during "continuous" file processing.
52 * (Previously a success status was always
53 * returned if the -C option was not used).
72 #ifdef HAVE_SYS_TIME_H
78 #include <wsutil/privileges.h>
81 * The symbols declared in the below are exported from libwireshark,
82 * but we don't want to link whole libwireshark to editcap.
83 * We link the object directly instead and this needs a little trick
84 * with the WS_BUILD_DLL #define.
87 #define RESET_SYMBOL_EXPORT
88 #include <epan/packet.h>
89 #include <epan/filesystem.h>
90 #include <epan/plugins.h>
91 #include <epan/report_err.h>
93 #define RESET_SYMBOL_EXPORT
96 #include <wsutil/privileges.h>
97 #include <wsutil/str_util.h>
100 #include <wsutil/wsgcrypt.h>
101 #include <wsutil/file_util.h>
105 #include "wsutil/wsgetopt.h"
109 #include <wsutil/unicode-utils.h>
112 #include "svnversion.h"
115 * By default capinfos now continues processing
116 * the next filename if and when wiretap detects
117 * a problem opening a file.
118 * Use the '-C' option to revert back to original
119 * capinfos behavior which is to abort any
120 * additional file processing at first open file
124 static gboolean continue_after_wtap_open_offline_failure = TRUE;
127 * table report variables
130 static gboolean long_report = TRUE; /* By default generate long report */
131 static gchar table_report_header = TRUE; /* Generate column header by default */
132 static gchar field_separator = '\t'; /* Use TAB as field separator by default */
133 static gchar quote_char = '\0'; /* Do NOT quote fields by default */
134 static gboolean machine_readable = FALSE; /* Display machine-readable numbers */
137 * capinfos has the ability to report on a number of
138 * various characteristics ("infos") for each input file.
140 * By default reporting of all info fields is enabled.
142 * Optionally the reporting of any specific info field
143 * or combination of info fields can be enabled with
144 * individual options.
147 static gboolean report_all_infos = TRUE; /* Report all infos */
149 static gboolean cap_file_type = TRUE; /* Report capture type */
150 static gboolean cap_file_encap = TRUE; /* Report encapsulation */
151 static gboolean cap_snaplen = TRUE; /* Packet size limit (snaplen)*/
152 static gboolean cap_packet_count = TRUE; /* Report packet count */
153 static gboolean cap_file_size = TRUE; /* Report file size */
155 static gboolean cap_data_size = TRUE; /* Report packet byte size */
156 static gboolean cap_duration = TRUE; /* Report capture duration */
157 static gboolean cap_start_time = TRUE; /* Report capture start time */
158 static gboolean cap_end_time = TRUE; /* Report capture end time */
159 static gboolean time_as_secs = FALSE; /* Report time values as raw seconds */
161 static gboolean cap_data_rate_byte = TRUE; /* Report data rate bytes/sec */
162 static gboolean cap_data_rate_bit = TRUE; /* Report data rate bites/sec */
163 static gboolean cap_packet_size = TRUE; /* Report average packet size */
164 static gboolean cap_packet_rate = TRUE; /* Report average packet rate */
165 static gboolean cap_order = TRUE; /* Report if packets are in chronological order (True/False) */
167 #ifdef HAVE_LIBGCRYPT
168 static gboolean cap_file_hashes = TRUE; /* Calculate file hashes */
172 static gboolean cap_help = FALSE;
173 static gboolean table_report = FALSE;
175 static GOptionEntry general_entries[] =
178 { "type", 't', 0, G_OPTION_ARG_NONE, &cap_file_type,
179 "display the capture file type", NULL },
180 { "Encapsulation", 'E', 0, G_OPTION_ARG_NONE, &cap_file_encap,
181 "display the capture file encapsulation", NULL },
182 #ifdef HAVE_LIBGCRYPT
183 { "Hash", 'H', 0, G_OPTION_ARG_NONE, &cap_file_hashes,
184 "display the SHA1, RMD160, and MD5 hashes of the file", NULL },
185 #endif /* HAVE_LIBGCRYPT */
186 { NULL,'\0',0,G_OPTION_ARG_NONE,NULL,NULL,NULL }
188 static GOptionEntry size_entries[] =
191 { "packets", 'c', 0, G_OPTION_ARG_NONE, &cap_packet_count,
192 "display the number of packets", NULL },
193 { "size", 's', 0, G_OPTION_ARG_NONE, &cap_file_size,
194 "display the size of the file (in bytes)", NULL },
195 { "tot-len-of-pkts", 'd', 0, G_OPTION_ARG_NONE, &cap_data_size,
196 "display the total length of all packets (in bytes)", NULL },
197 { "snap", 'l', 0, G_OPTION_ARG_NONE, &cap_snaplen,
198 "display the packet size limit (snapshot length)", NULL },
199 { NULL,'\0',0,G_OPTION_ARG_NONE,NULL,NULL,NULL }
201 static GOptionEntry time_entries[] =
204 { "duration", 'u', 0, G_OPTION_ARG_NONE, &cap_duration,
205 "display the capture duration (in seconds)", NULL },
206 { "start", 'a', 0, G_OPTION_ARG_NONE, &cap_start_time,
207 "display the capture start time", NULL },
208 { "end", 'e', 0, G_OPTION_ARG_NONE, &cap_end_time,
209 "display the capture end time", NULL },
210 { "cron", 'o', 0, G_OPTION_ARG_NONE, &cap_order,
211 "display the capture file chronological status (True/False)", NULL },
212 { "start-end-time-sec", 'S', 0, G_OPTION_ARG_NONE, &time_as_secs,
213 "display start and end times as seconds", NULL },
214 { NULL,'\0',0,G_OPTION_ARG_NONE,NULL,NULL,NULL }
217 static GOptionEntry stats_entries[] =
220 { "bytes", 'y', 0, G_OPTION_ARG_NONE, &cap_data_rate_byte,
221 "display average data rate (in bytes/s)", NULL },
222 { "bits", 'i', 0, G_OPTION_ARG_NONE, &cap_data_rate_bit,
223 "display average data rate (in bits/s)", NULL },
224 { "packet-bytes", 'z', 0, G_OPTION_ARG_NONE, &cap_packet_size,
225 "display average packet size (in bytes)", NULL },
226 { "packets", 'x', 0, G_OPTION_ARG_NONE, &cap_packet_rate,
227 "display average packet rate (in packets/s)", NULL },
228 { NULL,'\0',0,G_OPTION_ARG_NONE,NULL,NULL,NULL }
231 static GOptionEntry output_format_entries[] =
234 { "long", 'L', 0, G_OPTION_ARG_NONE, &long_report,
235 "generate long report (default)", NULL },
236 { "Table", 'T', 0, G_OPTION_ARG_NONE, &table_report,
237 "generate table report", NULL },
238 { "machine-readable", 'M', 0, G_OPTION_ARG_NONE, &machine_readable,
239 "display machine-readable (unabbreviated) values in long reports", NULL },
240 { NULL,'\0',0,G_OPTION_ARG_NONE,NULL,NULL,NULL }
243 static GOptionEntry table_report_entries[] =
246 { "header-rec", 'R', 0, G_OPTION_ARG_NONE, &table_report_header,
247 "generate header record (default)", NULL },
248 { "no-table", 'r', 0, G_OPTION_ARG_NONE, &table_report_header,
249 "do not generate header record", NULL },
250 { NULL,'\0',0,G_OPTION_ARG_NONE,NULL,NULL,NULL }
253 static GOptionEntry misc_entries[] =
255 { "helpcompat", 'h', 0, G_OPTION_ARG_NONE, &cap_help,
256 "display help", NULL },
257 { NULL,'\0',0,G_OPTION_ARG_NONE,NULL,NULL,NULL }
261 GOptionGroup *general_grp, *size_grp, *time_grp, *stats_grp, *output_grp, *table_report_grp;
262 GError *parse_err = NULL;
264 #endif /* USE_GOPTION */
266 #ifdef HAVE_LIBGCRYPT
267 #define HASH_SIZE_SHA1 20
268 #define HASH_SIZE_RMD160 20
269 #define HASH_SIZE_MD5 16
271 #define HASH_STR_SIZE (41) /* Max hash size * 2 + '\0' */
272 #define HASH_BUF_SIZE (1024 * 1024)
275 static gchar file_sha1[HASH_STR_SIZE];
276 static gchar file_rmd160[HASH_STR_SIZE];
277 static gchar file_md5[HASH_STR_SIZE];
279 #define FILE_HASH_OPT "H"
281 #define FILE_HASH_OPT ""
282 #endif /* HAVE_LIBGCRYPT */
285 * If we have at least two packets with time stamps, and they're not in
286 * order - i.e., the later packet has a time stamp older than the earlier
287 * packet - the time stamps are known not to be in order.
289 * If every packet has a time stamp, and they're all in order, the time
290 * stamp is known to be in order.
292 * Otherwise, we have no idea.
300 typedef struct _capture_info {
301 const char *filename;
303 gboolean iscompressed;
307 guint64 packet_bytes;
308 gboolean times_known;
311 guint32 packet_count;
312 gboolean snap_set; /* If set in capture file header */
313 guint32 snaplen; /* value from the capture file header */
314 guint32 snaplen_min_inferred; /* If caplen < len for 1 or more rcds */
315 guint32 snaplen_max_inferred; /* ... */
316 gboolean drops_known;
322 double data_rate; /* in bytes */
326 int *encap_counts; /* array of per_packet encap counts; array has one entry per wtap_encap type */
331 enable_all_infos(void)
333 report_all_infos = TRUE;
335 cap_file_type = TRUE;
336 cap_file_encap = TRUE;
338 cap_packet_count = TRUE;
339 cap_file_size = TRUE;
341 cap_data_size = TRUE;
343 cap_start_time = TRUE;
347 cap_data_rate_byte = TRUE;
348 cap_data_rate_bit = TRUE;
349 cap_packet_size = TRUE;
350 cap_packet_rate = TRUE;
352 #ifdef HAVE_LIBGCRYPT
353 cap_file_hashes = TRUE;
354 #endif /* HAVE_LIBGCRYPT */
358 disable_all_infos(void)
360 report_all_infos = FALSE;
362 cap_file_type = FALSE;
363 cap_file_encap = FALSE;
365 cap_packet_count = FALSE;
366 cap_file_size = FALSE;
368 cap_data_size = FALSE;
369 cap_duration = FALSE;
370 cap_start_time = FALSE;
371 cap_end_time = FALSE;
374 cap_data_rate_byte = FALSE;
375 cap_data_rate_bit = FALSE;
376 cap_packet_size = FALSE;
377 cap_packet_rate = FALSE;
379 #ifdef HAVE_LIBGCRYPT
380 cap_file_hashes = FALSE;
381 #endif /* HAVE_LIBGCRYPT */
385 order_string(order_t order)
399 return "???"; /* "cannot happen" (the next step is "Profit!") */
404 time_string(time_t timer, capture_info *cf_info, gboolean want_lf)
406 const gchar *lf = want_lf ? "\n" : "";
407 static gchar time_string_buf[20];
408 char *time_string_ctime;
410 if (cf_info->times_known && cf_info->packet_count > 0) {
412 /* XXX - Would it be useful to show sub-second precision? */
413 g_snprintf(time_string_buf, 20, "%lu%s", (unsigned long)timer, lf);
414 return time_string_buf;
416 #if (defined _WIN32) && (_MSC_VER < 1500)
417 /* calling localtime(), and thus ctime(), on MSVC 2005 with huge values causes it to crash */
418 /* XXX - find the exact value that still does work */
419 /* XXX - using _USE_32BIT_TIME_T might be another way to circumvent this problem */
420 if (timer > 2000000000) {
421 time_string_ctime = NULL;
424 time_string_ctime = ctime(&timer);
425 if (time_string_ctime == NULL) {
426 g_snprintf(time_string_buf, 20, "Not representable%s", lf);
427 return time_string_buf;
431 * The ctime() function returns a string formatted as:
432 * "Www Mmm dd hh:mm:ss yyyy\n"
433 * The unwanted '\n' is the 24th character.
435 time_string_ctime[24] = '\0';
437 return time_string_ctime;
441 g_snprintf(time_string_buf, 15, "n/a%s", lf);
442 return time_string_buf;
446 secs_nsecs(const struct wtap_nstime * nstime)
448 return (nstime->nsecs / 1000000000.0) + (double)nstime->secs;
451 static void print_value(const gchar *text_p1, gint width, const gchar *text_p2, double value) {
453 printf("%s%.*f%s\n", text_p1, width, value, text_p2);
455 printf("%sn/a\n", text_p1);
459 print_stats(const gchar *filename, capture_info *cf_info)
461 const gchar *file_type_string, *file_encap_string;
466 /* Build printable strings for various stats */
467 file_type_string = wtap_file_type_string(cf_info->file_type);
468 file_encap_string = wtap_encap_string(cf_info->file_encap);
469 start_time_t = (time_t)cf_info->start_time;
470 stop_time_t = (time_t)cf_info->stop_time;
472 if (filename) printf ("File name: %s\n", filename);
473 if (cap_file_type) printf ("File type: %s%s\n",
475 cf_info->iscompressed ? " (gzip compressed)" : "");
476 if (cap_file_encap) printf ("File encapsulation: %s\n", file_encap_string);
477 if (cap_file_encap && (cf_info->file_encap == WTAP_ENCAP_PER_PACKET)) {
479 for (i=0; i<WTAP_NUM_ENCAP_TYPES; i++) {
480 if (cf_info->encap_counts[i] > 0)
481 printf(" %s\n", wtap_encap_string(i));
484 if (cap_snaplen && cf_info->snap_set)
485 printf ("Packet size limit: file hdr: %u bytes\n", cf_info->snaplen);
486 else if(cap_snaplen && !cf_info->snap_set)
487 printf ("Packet size limit: file hdr: (not set)\n");
488 if (cf_info->snaplen_max_inferred > 0) {
489 if (cf_info->snaplen_min_inferred == cf_info->snaplen_max_inferred)
490 printf ("Packet size limit: inferred: %u bytes\n", cf_info->snaplen_min_inferred);
492 printf ("Packet size limit: inferred: %u bytes - %u bytes (range)\n",
493 cf_info->snaplen_min_inferred, cf_info->snaplen_max_inferred);
495 if (cap_packet_count) {
496 printf ("Number of packets: ");
497 if (machine_readable) {
498 printf ("%u\n", cf_info->packet_count);
500 size_string = format_size(cf_info->packet_count, format_size_unit_none);
501 printf ("%s\n", size_string);
506 printf ("File size: ");
507 if (machine_readable) {
508 printf ("%" G_GINT64_MODIFIER "d bytes\n", cf_info->filesize);
510 size_string = format_size(cf_info->filesize, format_size_unit_bytes);
511 printf ("%s\n", size_string);
516 printf ("Data size: ");
517 if (machine_readable) {
518 printf ("%" G_GINT64_MODIFIER "u bytes\n", cf_info->packet_bytes);
520 size_string = format_size(cf_info->packet_bytes, format_size_unit_bytes);
521 printf ("%s\n", size_string);
525 if (cf_info->times_known) {
526 if (cap_duration) /* XXX - shorten to hh:mm:ss */
527 print_value("Capture duration: ", 0, " seconds", cf_info->duration);
529 printf ("Start time: %s", time_string(start_time_t, cf_info, TRUE));
531 printf ("End time: %s", time_string(stop_time_t, cf_info, TRUE));
532 if (cap_data_rate_byte) {
533 printf ("Data byte rate: ");
534 if (machine_readable) {
535 print_value("", 2, " bytes/sec", cf_info->data_rate);
537 size_string = format_size((gint64)cf_info->data_rate, format_size_unit_bytes_s);
538 printf ("%s\n", size_string);
542 if (cap_data_rate_bit) {
543 printf ("Data bit rate: ");
544 if (machine_readable) {
545 print_value("", 2, " bits/sec", cf_info->data_rate*8);
547 size_string = format_size((gint64)(cf_info->data_rate*8), format_size_unit_bits_s);
548 printf ("%s\n", size_string);
553 if (cap_packet_size) printf ("Average packet size: %.2f bytes\n", cf_info->packet_size);
554 if (cf_info->times_known) {
555 if (cap_packet_rate) {
556 printf ("Average packet rate: ");
557 if (machine_readable) {
558 print_value("", 2, " packets/sec", cf_info->packet_rate);
560 size_string = format_size((gint64)cf_info->packet_rate, format_size_unit_none);
561 printf ("%spackets/sec\n", size_string);
566 #ifdef HAVE_LIBGCRYPT
567 if (cap_file_hashes) {
568 printf ("SHA1: %s\n", file_sha1);
569 printf ("RIPEMD160: %s\n", file_rmd160);
570 printf ("MD5: %s\n", file_md5);
572 #endif /* HAVE_LIBGCRYPT */
573 if (cap_order) printf ("Strict time order: %s\n", order_string(cf_info->order));
579 if (field_separator) putchar(field_separator);
585 if (quote_char) putchar(quote_char);
589 print_stats_table_header_label(const gchar *label)
598 print_stats_table_header(void)
604 if (cap_file_type) print_stats_table_header_label("File type");
605 if (cap_file_encap) print_stats_table_header_label("File encapsulation");
606 if (cap_snaplen) print_stats_table_header_label("Packet size limit");
607 if (cap_snaplen) print_stats_table_header_label("Packet size limit min (inferred)");
608 if (cap_snaplen) print_stats_table_header_label("Packet size limit max (inferred)");
609 if (cap_packet_count) print_stats_table_header_label("Number of packets");
610 if (cap_file_size) print_stats_table_header_label("File size (bytes)");
611 if (cap_data_size) print_stats_table_header_label("Data size (bytes)");
612 if (cap_duration) print_stats_table_header_label("Capture duration (seconds)");
613 if (cap_start_time) print_stats_table_header_label("Start time");
614 if (cap_end_time) print_stats_table_header_label("End time");
615 if (cap_data_rate_byte) print_stats_table_header_label("Data byte rate (bytes/sec)");
616 if (cap_data_rate_bit) print_stats_table_header_label("Data bit rate (bits/sec)");
617 if (cap_packet_size) print_stats_table_header_label("Average packet size (bytes)");
618 if (cap_packet_rate) print_stats_table_header_label("Average packet rate (packets/sec)");
619 #ifdef HAVE_LIBGCRYPT
620 if (cap_file_hashes) {
621 print_stats_table_header_label("SHA1");
622 print_stats_table_header_label("RIPEMD160");
623 print_stats_table_header_label("MD5");
625 #endif /* HAVE_LIBGCRYPT */
626 if (cap_order) print_stats_table_header_label("Strict time order");
632 print_stats_table(const gchar *filename, capture_info *cf_info)
634 const gchar *file_type_string, *file_encap_string;
638 /* Build printable strings for various stats */
639 file_type_string = wtap_file_type_string(cf_info->file_type);
640 file_encap_string = wtap_encap_string(cf_info->file_encap);
641 start_time_t = (time_t)cf_info->start_time;
642 stop_time_t = (time_t)cf_info->stop_time;
646 printf("%s", filename);
653 printf("%s", file_type_string);
657 /* ToDo: If WTAP_ENCAP_PER_PACKET, show the list of encapsulations encountered;
658 * Output a line for each different encap with all fields repeated except
659 * the encapsulation field which has "Per Packet: ..." for each
660 * encapsulation type seen ?
662 if (cap_file_encap) {
665 printf("%s", file_encap_string);
672 if(cf_info->snap_set)
673 printf("%u", cf_info->snaplen);
677 if (cf_info->snaplen_max_inferred > 0) {
680 printf("%u", cf_info->snaplen_min_inferred);
684 printf("%u", cf_info->snaplen_max_inferred);
699 if (cap_packet_count) {
702 printf("%u", cf_info->packet_count);
709 printf("%" G_GINT64_MODIFIER "d", cf_info->filesize);
716 printf("%" G_GINT64_MODIFIER "u", cf_info->packet_bytes);
723 if (cf_info->times_known)
724 printf("%f", cf_info->duration);
730 if (cap_start_time) {
733 printf("%s", time_string(start_time_t, cf_info, FALSE));
740 printf("%s", time_string(stop_time_t, cf_info, FALSE));
744 if (cap_data_rate_byte) {
747 if (cf_info->times_known)
748 printf("%.2f", cf_info->data_rate);
754 if (cap_data_rate_bit) {
757 if (cf_info->times_known)
758 printf("%.2f", cf_info->data_rate*8);
764 if (cap_packet_size) {
767 printf("%.2f", cf_info->packet_size);
771 if (cap_packet_rate) {
774 if (cf_info->times_known)
775 printf("%.2f", cf_info->packet_rate);
781 #ifdef HAVE_LIBGCRYPT
782 if (cap_file_hashes) {
785 printf("%s", file_sha1);
790 printf("%s", file_rmd160);
795 printf("%s", file_md5);
798 #endif /* HAVE_LIBGCRYPT */
803 printf("%s", order_string(cf_info->order));
811 process_cap_file(wtap *wth, const char *filename)
820 guint32 snaplen_min_inferred = 0xffffffff;
821 guint32 snaplen_max_inferred = 0;
822 const struct wtap_pkthdr *phdr;
823 capture_info cf_info;
824 gboolean have_times = TRUE;
825 double start_time = 0;
826 double stop_time = 0;
828 double prev_time = 0;
829 gboolean know_order = FALSE;
830 order_t order = IN_ORDER;
832 cf_info.encap_counts = g_new0(int,WTAP_NUM_ENCAP_TYPES);
834 /* Tally up data that we need to parse through the file to find */
835 while (wtap_read(wth, &err, &err_info, &data_offset)) {
836 phdr = wtap_phdr(wth);
837 if (phdr->presence_flags & WTAP_HAS_TS) {
838 prev_time = cur_time;
839 cur_time = secs_nsecs(&phdr->ts);
841 start_time = cur_time;
842 stop_time = cur_time;
843 prev_time = cur_time;
845 if (cur_time < prev_time) {
846 order = NOT_IN_ORDER;
848 if (cur_time < start_time) {
849 start_time = cur_time;
851 if (cur_time > stop_time) {
852 stop_time = cur_time;
855 have_times = FALSE; /* at least one packet has no time stamp */
856 if (order != NOT_IN_ORDER)
857 order = ORDER_UNKNOWN;
863 /* If caplen < len for a rcd, then presumably */
864 /* 'Limit packet capture length' was done for this rcd. */
865 /* Keep track as to the min/max actual snapshot lengths */
866 /* seen for this file. */
867 if (phdr->caplen < phdr->len) {
868 if (phdr->caplen < snaplen_min_inferred)
869 snaplen_min_inferred = phdr->caplen;
870 if (phdr->caplen > snaplen_max_inferred)
871 snaplen_max_inferred = phdr->caplen;
874 /* Per-packet encapsulation */
875 if (wtap_file_encap(wth) == WTAP_ENCAP_PER_PACKET) {
876 if ((phdr->pkt_encap > 0) && (phdr->pkt_encap < WTAP_NUM_ENCAP_TYPES)) {
877 cf_info.encap_counts[phdr->pkt_encap] += 1;
879 fprintf(stderr, "capinfos: Unknown per-packet encapsulation: %d [frame number: %d]\n", phdr->pkt_encap, packet);
887 "capinfos: An error occurred after reading %u packets from \"%s\": %s.\n",
888 packet, filename, wtap_strerror(err));
891 case WTAP_ERR_UNSUPPORTED:
892 case WTAP_ERR_UNSUPPORTED_ENCAP:
893 case WTAP_ERR_BAD_FILE:
894 case WTAP_ERR_DECOMPRESS:
895 fprintf(stderr, "(%s)\n", err_info);
899 g_free(cf_info.encap_counts);
904 size = wtap_file_size(wth, &err);
907 "capinfos: Can't get size of \"%s\": %s.\n",
908 filename, g_strerror(err));
909 g_free(cf_info.encap_counts);
913 cf_info.filesize = size;
916 cf_info.file_type = wtap_file_type(wth);
917 cf_info.iscompressed = wtap_iscompressed(wth);
919 /* File Encapsulation */
920 cf_info.file_encap = wtap_file_encap(wth);
922 /* Packet size limit (snaplen) */
923 cf_info.snaplen = wtap_snapshot_length(wth);
924 if(cf_info.snaplen > 0)
925 cf_info.snap_set = TRUE;
927 cf_info.snap_set = FALSE;
929 cf_info.snaplen_min_inferred = snaplen_min_inferred;
930 cf_info.snaplen_max_inferred = snaplen_max_inferred;
933 cf_info.packet_count = packet;
936 cf_info.times_known = have_times;
937 cf_info.start_time = start_time;
938 cf_info.stop_time = stop_time;
939 cf_info.duration = stop_time-start_time;
940 cf_info.know_order = know_order;
941 cf_info.order = order;
943 /* Number of packet bytes */
944 cf_info.packet_bytes = bytes;
946 cf_info.data_rate = 0.0;
947 cf_info.packet_rate = 0.0;
948 cf_info.packet_size = 0.0;
951 if (cf_info.duration > 0.0) {
952 cf_info.data_rate = (double)bytes / (stop_time-start_time); /* Data rate per second */
953 cf_info.packet_rate = (double)packet / (stop_time-start_time); /* packet rate per second */
955 cf_info.packet_size = (double)bytes / packet; /* Avg packet size */
959 print_stats(filename, &cf_info);
961 print_stats_table(filename, &cf_info);
964 g_free(cf_info.encap_counts);
970 usage(gboolean is_error)
976 /* XXX - add capinfos header info here */
982 fprintf(output, "Capinfos %s"
984 " (" SVNVERSION " from " SVNPATH ")"
987 fprintf(output, "Prints various information (infos) about capture files.\n");
988 fprintf(output, "See http://www.wireshark.org for more information.\n");
989 fprintf(output, "\n");
990 fprintf(output, "Usage: capinfos [options] <infile> ...\n");
991 fprintf(output, "\n");
992 fprintf(output, "General infos:\n");
993 fprintf(output, " -t display the capture file type\n");
994 fprintf(output, " -E display the capture file encapsulation\n");
995 #ifdef HAVE_LIBGCRYPT
996 fprintf(output, " -H display the SHA1, RMD160, and MD5 hashes of the file\n");
998 fprintf(output, "\n");
999 fprintf(output, "Size infos:\n");
1000 fprintf(output, " -c display the number of packets\n");
1001 fprintf(output, " -s display the size of the file (in bytes)\n");
1002 fprintf(output, " -d display the total length of all packets (in bytes)\n");
1003 fprintf(output, " -l display the packet size limit (snapshot length)\n");
1004 fprintf(output, "\n");
1005 fprintf(output, "Time infos:\n");
1006 fprintf(output, " -u display the capture duration (in seconds)\n");
1007 fprintf(output, " -a display the capture start time\n");
1008 fprintf(output, " -e display the capture end time\n");
1009 fprintf(output, " -o display the capture file chronological status (True/False)\n");
1010 fprintf(output, " -S display start and end times as seconds\n");
1011 fprintf(output, "\n");
1012 fprintf(output, "Statistic infos:\n");
1013 fprintf(output, " -y display average data rate (in bytes/sec)\n");
1014 fprintf(output, " -i display average data rate (in bits/sec)\n");
1015 fprintf(output, " -z display average packet size (in bytes)\n");
1016 fprintf(output, " -x display average packet rate (in packets/sec)\n");
1017 fprintf(output, "\n");
1018 fprintf(output, "Output format:\n");
1019 fprintf(output, " -L generate long report (default)\n");
1020 fprintf(output, " -T generate table report\n");
1021 fprintf(output, " -M display machine-readable values in long reports\n");
1022 fprintf(output, "\n");
1023 fprintf(output, "Table report options:\n");
1024 fprintf(output, " -R generate header record (default)\n");
1025 fprintf(output, " -r do not generate header record\n");
1026 fprintf(output, "\n");
1027 fprintf(output, " -B separate infos with TAB character (default)\n");
1028 fprintf(output, " -m separate infos with comma (,) character\n");
1029 fprintf(output, " -b separate infos with SPACE character\n");
1030 fprintf(output, "\n");
1031 fprintf(output, " -N do not quote infos (default)\n");
1032 fprintf(output, " -q quote infos with single quotes (')\n");
1033 fprintf(output, " -Q quote infos with double quotes (\")\n");
1034 fprintf(output, "\n");
1035 fprintf(output, "Miscellaneous:\n");
1036 fprintf(output, " -h display this help and exit\n");
1037 fprintf(output, " -C cancel processing if file open fails (default is to continue)\n");
1038 fprintf(output, " -A generate all infos (default)\n");
1039 fprintf(output, "\n");
1040 fprintf(output, "Options are processed from left to right order with later options superceeding\n");
1041 fprintf(output, "or adding to earlier options.\n");
1042 fprintf(output, "\n");
1043 fprintf(output, "If no options are given the default is to display all infos in long report\n");
1044 fprintf(output, "output format.\n");
1045 #ifndef HAVE_LIBGCRYPT
1046 fprintf(output, "\nFile hashing support (-H) is not present.\n");
1052 * Don't report failures to load plugins because most (non-wiretap) plugins
1053 * *should* fail to load (because we're not linked against libwireshark and
1054 * dissector plugins need libwireshark).
1057 failure_message(const char *msg_format _U_, va_list ap _U_)
1063 #ifdef HAVE_LIBGCRYPT
1065 hash_to_str(const unsigned char *hash, size_t length, char *str) {
1068 for (i = 0; i < (int) length; i++) {
1069 g_snprintf(str+(i*2), 3, "%02x", hash[i]);
1072 #endif /* HAVE_LIBGCRYPT */
1075 main(int argc, char *argv[])
1081 int overall_error_status;
1085 char *init_progfile_dir_error;
1087 #ifdef HAVE_LIBGCRYPT
1089 char *hash_buf = NULL;
1090 gcry_md_hd_t hd = NULL;
1095 arg_list_utf_16to8(argc, argv);
1096 create_app_running_mutex();
1100 * Get credential information for later use.
1102 init_process_policies();
1105 /* Register wiretap plugins */
1107 if ((init_progfile_dir_error = init_progfile_dir(argv[0], main))) {
1108 g_warning("capinfos: init_progfile_dir(): %s", init_progfile_dir_error);
1109 g_free(init_progfile_dir_error);
1111 init_report_err(failure_message,NULL,NULL,NULL);
1116 /* Process the options */
1118 ctx = g_option_context_new(" <infile> ... - print information about capture file(s)");
1119 general_grp = g_option_group_new("gen", "General infos:",
1120 "Show general options", NULL, NULL);
1121 size_grp = g_option_group_new("size", "Size infos:",
1122 "Show size options", NULL, NULL);
1123 time_grp = g_option_group_new("time", "Time infos:",
1124 "Show time options", NULL, NULL);
1125 stats_grp = g_option_group_new("stats", "Statistics infos:",
1126 "Show statistics options", NULL, NULL);
1127 output_grp = g_option_group_new("output", "Output format:",
1128 "Show output format options", NULL, NULL);
1129 table_report_grp = g_option_group_new("table", "Table report options:",
1130 "Show table report options", NULL, NULL);
1131 g_option_group_add_entries(general_grp, general_entries);
1132 g_option_group_add_entries(size_grp, size_entries);
1133 g_option_group_add_entries(time_grp, time_entries);
1134 g_option_group_add_entries(stats_grp, stats_entries);
1135 g_option_group_add_entries(output_grp, output_format_entries);
1136 g_option_group_add_entries(table_report_grp, table_report_entries);
1137 g_option_context_add_main_entries(ctx, misc_entries, NULL);
1138 g_option_context_add_group(ctx, general_grp);
1139 g_option_context_add_group(ctx, size_grp);
1140 g_option_context_add_group(ctx, time_grp);
1141 g_option_context_add_group(ctx, stats_grp);
1142 g_option_context_add_group(ctx, output_grp);
1143 g_option_context_add_group(ctx, table_report_grp);
1144 /* There's probably a better way to do this, but this works for now.
1145 GOptions displays the name in argv[0] as the name of the
1146 application. This is reasonable, but because we actually have a
1147 script wrapper that calls the executable. The name that gets
1148 displayed is not exactly the same as the command the user used
1151 argv[0] = "capinfos";
1153 if( !g_option_context_parse(ctx, &argc, &argv, &parse_err) ) {
1154 if(parse_err) g_print ("option parsing failed: %s\n", parse_err->message);
1155 g_print("%s", g_option_context_get_help (ctx, TRUE, NULL));
1158 if( cap_help || (argc < 2) ) {
1159 g_print("%s", g_option_context_get_help (ctx, FALSE, NULL));
1162 g_option_context_free(ctx);
1164 #endif /* USE_GOPTION */
1165 while ((opt = getopt(argc, argv, "tEcs" FILE_HASH_OPT "dluaeyizvhxoCALTMRrSNqQBmb")) !=-1) {
1170 if (report_all_infos) disable_all_infos();
1171 cap_file_type = TRUE;
1175 if (report_all_infos) disable_all_infos();
1176 cap_file_encap = TRUE;
1180 if (report_all_infos) disable_all_infos();
1185 if (report_all_infos) disable_all_infos();
1186 cap_packet_count = TRUE;
1190 if (report_all_infos) disable_all_infos();
1191 cap_file_size = TRUE;
1195 if (report_all_infos) disable_all_infos();
1196 cap_data_size = TRUE;
1200 if (report_all_infos) disable_all_infos();
1201 cap_duration = TRUE;
1205 if (report_all_infos) disable_all_infos();
1206 cap_start_time = TRUE;
1210 if (report_all_infos) disable_all_infos();
1211 cap_end_time = TRUE;
1215 time_as_secs = TRUE;
1219 if (report_all_infos) disable_all_infos();
1220 cap_data_rate_byte = TRUE;
1224 if (report_all_infos) disable_all_infos();
1225 cap_data_rate_bit = TRUE;
1229 if (report_all_infos) disable_all_infos();
1230 cap_packet_size = TRUE;
1234 if (report_all_infos) disable_all_infos();
1235 cap_packet_rate = TRUE;
1238 #ifdef HAVE_LIBGCRYPT
1240 if (report_all_infos) disable_all_infos();
1241 cap_file_hashes = TRUE;
1246 if (report_all_infos) disable_all_infos();
1251 continue_after_wtap_open_offline_failure = FALSE;
1263 long_report = FALSE;
1267 machine_readable = TRUE;
1271 table_report_header = TRUE;
1275 table_report_header = FALSE;
1291 field_separator = '\t';
1295 field_separator = ',';
1299 field_separator = ' ';
1307 case '?': /* Bad flag - print usage message */
1314 /* Set the C-language locale to the native environment. */
1315 setlocale(LC_ALL, "");
1317 if ((argc - optind) < 1) {
1322 if(!long_report && table_report_header) {
1323 print_stats_table_header();
1326 #ifdef HAVE_LIBGCRYPT
1327 if (cap_file_hashes) {
1328 gcry_check_version(NULL);
1329 gcry_md_open(&hd, GCRY_MD_SHA1, 0);
1331 gcry_md_enable(hd, GCRY_MD_RMD160);
1332 gcry_md_enable(hd, GCRY_MD_MD5);
1334 hash_buf = (char *)g_malloc(HASH_BUF_SIZE);
1338 overall_error_status = 0;
1340 for (opt = optind; opt < argc; opt++) {
1342 #ifdef HAVE_LIBGCRYPT
1343 g_strlcpy(file_sha1, "<unknown>", HASH_STR_SIZE);
1344 g_strlcpy(file_rmd160, "<unknown>", HASH_STR_SIZE);
1345 g_strlcpy(file_md5, "<unknown>", HASH_STR_SIZE);
1347 if (cap_file_hashes) {
1348 fh = ws_fopen(argv[opt], "rb");
1350 while((hash_bytes = fread(hash_buf, 1, HASH_BUF_SIZE, fh)) > 0) {
1351 gcry_md_write(hd, hash_buf, hash_bytes);
1354 hash_to_str(gcry_md_read(hd, GCRY_MD_SHA1), HASH_SIZE_SHA1, file_sha1);
1355 hash_to_str(gcry_md_read(hd, GCRY_MD_RMD160), HASH_SIZE_RMD160, file_rmd160);
1356 hash_to_str(gcry_md_read(hd, GCRY_MD_MD5), HASH_SIZE_MD5, file_md5);
1359 if (hd) gcry_md_reset(hd);
1361 #endif /* HAVE_LIBGCRYPT */
1363 wth = wtap_open_offline(argv[opt], &err, &err_info, FALSE);
1366 fprintf(stderr, "capinfos: Can't open %s: %s\n", argv[opt],
1367 wtap_strerror(err));
1370 case WTAP_ERR_UNSUPPORTED:
1371 case WTAP_ERR_UNSUPPORTED_ENCAP:
1372 case WTAP_ERR_BAD_FILE:
1373 fprintf(stderr, "(%s)\n", err_info);
1377 overall_error_status = 1; /* remember that an error has occurred */
1378 if(!continue_after_wtap_open_offline_failure)
1379 exit(1); /* error status */
1383 if ((opt > optind) && (long_report))
1385 status = process_cap_file(wth, argv[opt]);
1393 return overall_error_status;