2 * Reports capture file information including # of packets, duration, others
4 * Copyright 2004 Ian Schorr
6 * Wireshark - Network traffic analyzer
7 * By Gerald Combs <gerald@wireshark.org>
8 * Copyright 1998 Gerald Combs
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
12 * as published by the Free Software Foundation; either version 2
13 * of the License, or (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
28 * New capinfos features
30 * Continue processing additional files after
31 * a wiretap open failure. The new -C option
32 * reverts to capinfos' original behavior which
33 * is to cancel any further file processing at
34 * first file open failure.
36 * Change the behavior of how the default display
37 * of all infos is initiated. This gets rid of a
38 * special post getopt() argument count test.
40 * Add new table output format (with related options)
41 * This feature allows outputting the various infos
42 * into a tab delimited text file, or to a comma
43 * separated variables file (*.csv) instead of the
44 * original "long" format.
47 * behaviour changed: Upon exit capinfos will return
48 * an error status if an error occurred at any
49 * point during "continuous" file processing.
50 * (Previously a success status was always
51 * returned if the -C option was not used).
74 #ifdef HAVE_SYS_TIME_H
81 #include <zlib.h> /* to get the libz version number */
84 #include <wsutil/privileges.h>
85 #include <wsutil/filesystem.h>
86 #include <wsutil/crash_info.h>
87 #include <wsutil/copyright_info.h>
88 #include <wsutil/os_version_info.h>
89 #include <wsutil/ws_version_info.h>
92 #include <wsutil/plugins.h>
96 #include <wsutil/report_err.h>
97 #include <wsutil/str_util.h>
98 #include <wsutil/file_util.h>
100 #ifdef HAVE_LIBGCRYPT
101 #include <wsutil/wsgcrypt.h>
105 #include "wsutil/wsgetopt.h"
109 #include <wsutil/unicode-utils.h>
112 #include "version_info.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 */
154 static gboolean cap_comment = TRUE; /* Display the capture comment */
156 static gboolean cap_data_size = TRUE; /* Report packet byte size */
157 static gboolean cap_duration = TRUE; /* Report capture duration */
158 static gboolean cap_start_time = TRUE; /* Report capture start time */
159 static gboolean cap_end_time = TRUE; /* Report capture end time */
160 static gboolean time_as_secs = FALSE; /* Report time values as raw seconds */
162 static gboolean cap_data_rate_byte = TRUE; /* Report data rate bytes/sec */
163 static gboolean cap_data_rate_bit = TRUE; /* Report data rate bites/sec */
164 static gboolean cap_packet_size = TRUE; /* Report average packet size */
165 static gboolean cap_packet_rate = TRUE; /* Report average packet rate */
166 static gboolean cap_order = TRUE; /* Report if packets are in chronological order (True/False) */
168 #ifdef HAVE_LIBGCRYPT
169 static gboolean cap_file_hashes = TRUE; /* Calculate file hashes */
173 static gboolean cap_help = FALSE;
174 static gboolean table_report = FALSE;
176 static GOptionEntry general_entries[] =
179 { "type", 't', 0, G_OPTION_ARG_NONE, &cap_file_type,
180 "display the capture file type", NULL },
181 { "Encapsulation", 'E', 0, G_OPTION_ARG_NONE, &cap_file_encap,
182 "display the capture file encapsulation", NULL },
183 #ifdef HAVE_LIBGCRYPT
184 { "Hash", 'H', 0, G_OPTION_ARG_NONE, &cap_file_hashes,
185 "display the SHA1, RMD160, and MD5 hashes of the file", NULL },
186 #endif /* HAVE_LIBGCRYPT */
187 { "capture-comment", 'k', 0, G_OPTION_ARG_NONE, &cap_comment,
188 "display the capture comment ", NULL },
189 { NULL,'\0',0,G_OPTION_ARG_NONE,NULL,NULL,NULL }
191 static GOptionEntry size_entries[] =
194 { "packets", 'c', 0, G_OPTION_ARG_NONE, &cap_packet_count,
195 "display the number of packets", NULL },
196 { "size", 's', 0, G_OPTION_ARG_NONE, &cap_file_size,
197 "display the size of the file (in bytes)", NULL },
198 { "tot-len-of-pkts", 'd', 0, G_OPTION_ARG_NONE, &cap_data_size,
199 "display the total length of all packets (in bytes)", NULL },
200 { "snap", 'l', 0, G_OPTION_ARG_NONE, &cap_snaplen,
201 "display the packet size limit (snapshot length)", NULL },
202 { NULL,'\0',0,G_OPTION_ARG_NONE,NULL,NULL,NULL }
204 static GOptionEntry time_entries[] =
207 { "duration", 'u', 0, G_OPTION_ARG_NONE, &cap_duration,
208 "display the capture duration (in seconds)", NULL },
209 { "start", 'a', 0, G_OPTION_ARG_NONE, &cap_start_time,
210 "display the capture start time", NULL },
211 { "end", 'e', 0, G_OPTION_ARG_NONE, &cap_end_time,
212 "display the capture end time", NULL },
213 { "cron", 'o', 0, G_OPTION_ARG_NONE, &cap_order,
214 "display the capture file chronological status (True/False)", NULL },
215 { "start-end-time-sec", 'S', 0, G_OPTION_ARG_NONE, &time_as_secs,
216 "display start and end times as seconds", NULL },
217 { NULL,'\0',0,G_OPTION_ARG_NONE,NULL,NULL,NULL }
220 static GOptionEntry stats_entries[] =
223 { "bytes", 'y', 0, G_OPTION_ARG_NONE, &cap_data_rate_byte,
224 "display average data rate (in bytes/s)", NULL },
225 { "bits", 'i', 0, G_OPTION_ARG_NONE, &cap_data_rate_bit,
226 "display average data rate (in bits/s)", NULL },
227 { "packet-bytes", 'z', 0, G_OPTION_ARG_NONE, &cap_packet_size,
228 "display average packet size (in bytes)", NULL },
229 { "packets", 'x', 0, G_OPTION_ARG_NONE, &cap_packet_rate,
230 "display average packet rate (in packets/s)", NULL },
231 { NULL,'\0',0,G_OPTION_ARG_NONE,NULL,NULL,NULL }
234 static GOptionEntry output_format_entries[] =
237 { "long", 'L', 0, G_OPTION_ARG_NONE, &long_report,
238 "generate long report (default)", NULL },
239 { "Table", 'T', 0, G_OPTION_ARG_NONE, &table_report,
240 "generate table report", NULL },
241 { "machine-readable", 'M', 0, G_OPTION_ARG_NONE, &machine_readable,
242 "display machine-readable (unabbreviated) values in long reports", NULL },
243 { NULL,'\0',0,G_OPTION_ARG_NONE,NULL,NULL,NULL }
246 static GOptionEntry table_report_entries[] =
249 { "header-rec", 'R', 0, G_OPTION_ARG_NONE, &table_report_header,
250 "generate header record (default)", NULL },
251 { "no-table", 'r', 0, G_OPTION_ARG_NONE, &table_report_header,
252 "do not generate header record", NULL },
253 { NULL,'\0',0,G_OPTION_ARG_NONE,NULL,NULL,NULL }
256 static GOptionEntry misc_entries[] =
258 { "helpcompat", 'h', 0, G_OPTION_ARG_NONE, &cap_help,
259 "display help", NULL },
260 { NULL,'\0',0,G_OPTION_ARG_NONE,NULL,NULL,NULL }
264 GOptionGroup *general_grp, *size_grp, *time_grp, *stats_grp, *output_grp, *table_report_grp;
265 GError *parse_err = NULL;
267 #endif /* USE_GOPTION */
269 #ifdef HAVE_LIBGCRYPT
270 #define HASH_SIZE_SHA1 20
271 #define HASH_SIZE_RMD160 20
272 #define HASH_SIZE_MD5 16
274 #define HASH_STR_SIZE (41) /* Max hash size * 2 + '\0' */
275 #define HASH_BUF_SIZE (1024 * 1024)
278 static gchar file_sha1[HASH_STR_SIZE];
279 static gchar file_rmd160[HASH_STR_SIZE];
280 static gchar file_md5[HASH_STR_SIZE];
282 #define FILE_HASH_OPT "H"
284 #define FILE_HASH_OPT ""
285 #endif /* HAVE_LIBGCRYPT */
288 * If we have at least two packets with time stamps, and they're not in
289 * order - i.e., the later packet has a time stamp older than the earlier
290 * packet - the time stamps are known not to be in order.
292 * If every packet has a time stamp, and they're all in order, the time
293 * stamp is known to be in order.
295 * Otherwise, we have no idea.
303 typedef struct _capture_info {
304 const char *filename;
306 gboolean iscompressed;
311 guint64 packet_bytes;
312 gboolean times_known;
315 guint32 packet_count;
316 gboolean snap_set; /* If set in capture file header */
317 guint32 snaplen; /* value from the capture file header */
318 guint32 snaplen_min_inferred; /* If caplen < len for 1 or more rcds */
319 guint32 snaplen_max_inferred; /* ... */
320 gboolean drops_known;
326 double data_rate; /* in bytes */
330 int *encap_counts; /* array of per_packet encap counts; array has one entry per wtap_encap type */
335 enable_all_infos(void)
337 report_all_infos = TRUE;
339 cap_file_type = TRUE;
340 cap_file_encap = TRUE;
342 cap_packet_count = TRUE;
343 cap_file_size = TRUE;
346 cap_data_size = TRUE;
348 cap_start_time = TRUE;
352 cap_data_rate_byte = TRUE;
353 cap_data_rate_bit = TRUE;
354 cap_packet_size = TRUE;
355 cap_packet_rate = TRUE;
357 #ifdef HAVE_LIBGCRYPT
358 cap_file_hashes = TRUE;
359 #endif /* HAVE_LIBGCRYPT */
363 disable_all_infos(void)
365 report_all_infos = FALSE;
367 cap_file_type = FALSE;
368 cap_file_encap = FALSE;
370 cap_packet_count = FALSE;
371 cap_file_size = FALSE;
374 cap_data_size = FALSE;
375 cap_duration = FALSE;
376 cap_start_time = FALSE;
377 cap_end_time = FALSE;
380 cap_data_rate_byte = FALSE;
381 cap_data_rate_bit = FALSE;
382 cap_packet_size = FALSE;
383 cap_packet_rate = FALSE;
385 #ifdef HAVE_LIBGCRYPT
386 cap_file_hashes = FALSE;
387 #endif /* HAVE_LIBGCRYPT */
391 order_string(order_t order)
405 return "???"; /* "cannot happen" (the next step is "Profit!") */
410 time_string(time_t timer, capture_info *cf_info, gboolean want_lf)
412 const gchar *lf = want_lf ? "\n" : "";
413 static gchar time_string_buf[20];
414 char *time_string_ctime;
416 if (cf_info->times_known && cf_info->packet_count > 0) {
418 /* XXX - Would it be useful to show sub-second precision? */
419 g_snprintf(time_string_buf, 20, "%lu%s", (unsigned long)timer, lf);
420 return time_string_buf;
422 time_string_ctime = ctime(&timer);
423 if (time_string_ctime == NULL) {
424 g_snprintf(time_string_buf, 20, "Not representable%s", lf);
425 return time_string_buf;
429 * The ctime() function returns a string formatted as:
430 * "Www Mmm dd hh:mm:ss yyyy\n"
431 * The unwanted '\n' is the 24th character.
433 time_string_ctime[24] = '\0';
435 return time_string_ctime;
439 g_snprintf(time_string_buf, 15, "n/a%s", lf);
440 return time_string_buf;
443 static void print_value(const gchar *text_p1, gint width, const gchar *text_p2, double value) {
445 printf("%s%.*f%s\n", text_p1, width, value, text_p2);
447 printf("%sn/a\n", text_p1);
451 print_stats(const gchar *filename, capture_info *cf_info)
453 const gchar *file_type_string, *file_encap_string;
458 /* Build printable strings for various stats */
459 file_type_string = wtap_file_type_subtype_string(cf_info->file_type);
460 file_encap_string = wtap_encap_string(cf_info->file_encap);
461 start_time_t = (time_t)cf_info->start_time;
462 stop_time_t = (time_t)cf_info->stop_time;
464 if (filename) printf ("File name: %s\n", filename);
465 if (cap_file_type) printf ("File type: %s%s\n",
467 cf_info->iscompressed ? " (gzip compressed)" : "");
468 if (cap_file_encap) printf ("File encapsulation: %s\n", file_encap_string);
469 if (cap_file_encap && (cf_info->file_encap == WTAP_ENCAP_PER_PACKET)) {
471 for (i=0; i<WTAP_NUM_ENCAP_TYPES; i++) {
472 if (cf_info->encap_counts[i] > 0)
473 printf(" %s\n", wtap_encap_string(i));
476 if (cap_snaplen && cf_info->snap_set)
477 printf ("Packet size limit: file hdr: %u bytes\n", cf_info->snaplen);
478 else if (cap_snaplen && !cf_info->snap_set)
479 printf ("Packet size limit: file hdr: (not set)\n");
480 if (cf_info->snaplen_max_inferred > 0) {
481 if (cf_info->snaplen_min_inferred == cf_info->snaplen_max_inferred)
482 printf ("Packet size limit: inferred: %u bytes\n", cf_info->snaplen_min_inferred);
484 printf ("Packet size limit: inferred: %u bytes - %u bytes (range)\n",
485 cf_info->snaplen_min_inferred, cf_info->snaplen_max_inferred);
487 if (cap_packet_count) {
488 printf ("Number of packets: ");
489 if (machine_readable) {
490 printf ("%u\n", cf_info->packet_count);
492 size_string = format_size(cf_info->packet_count, format_size_unit_none);
493 printf ("%s\n", size_string);
498 printf ("File size: ");
499 if (machine_readable) {
500 printf ("%" G_GINT64_MODIFIER "d bytes\n", cf_info->filesize);
502 size_string = format_size(cf_info->filesize, format_size_unit_bytes);
503 printf ("%s\n", size_string);
508 printf ("Data size: ");
509 if (machine_readable) {
510 printf ("%" G_GINT64_MODIFIER "u bytes\n", cf_info->packet_bytes);
512 size_string = format_size(cf_info->packet_bytes, format_size_unit_bytes);
513 printf ("%s\n", size_string);
517 if (cf_info->times_known) {
518 if (cap_duration) /* XXX - shorten to hh:mm:ss */
519 print_value("Capture duration: ", 0, " seconds", cf_info->duration);
521 printf ("Start time: %s", time_string(start_time_t, cf_info, TRUE));
523 printf ("End time: %s", time_string(stop_time_t, cf_info, TRUE));
524 if (cap_data_rate_byte) {
525 printf ("Data byte rate: ");
526 if (machine_readable) {
527 print_value("", 2, " bytes/sec", cf_info->data_rate);
529 size_string = format_size((gint64)cf_info->data_rate, format_size_unit_bytes_s);
530 printf ("%s\n", size_string);
534 if (cap_data_rate_bit) {
535 printf ("Data bit rate: ");
536 if (machine_readable) {
537 print_value("", 2, " bits/sec", cf_info->data_rate*8);
539 size_string = format_size((gint64)(cf_info->data_rate*8), format_size_unit_bits_s);
540 printf ("%s\n", size_string);
545 if (cap_packet_size) printf ("Average packet size: %.2f bytes\n", cf_info->packet_size);
546 if (cf_info->times_known) {
547 if (cap_packet_rate) {
548 printf ("Average packet rate: ");
549 if (machine_readable) {
550 print_value("", 2, " packets/sec", cf_info->packet_rate);
552 size_string = format_size((gint64)cf_info->packet_rate, format_size_unit_none);
553 printf ("%spackets/sec\n", size_string);
558 #ifdef HAVE_LIBGCRYPT
559 if (cap_file_hashes) {
560 printf ("SHA1: %s\n", file_sha1);
561 printf ("RIPEMD160: %s\n", file_rmd160);
562 printf ("MD5: %s\n", file_md5);
564 #endif /* HAVE_LIBGCRYPT */
565 if (cap_order) printf ("Strict time order: %s\n", order_string(cf_info->order));
566 if (cap_comment && cf_info->comment)
567 printf ("Capture comment: %s\n", cf_info->comment);
573 if (field_separator) putchar(field_separator);
579 if (quote_char) putchar(quote_char);
583 print_stats_table_header_label(const gchar *label)
592 print_stats_table_header(void)
598 if (cap_file_type) print_stats_table_header_label("File type");
599 if (cap_file_encap) print_stats_table_header_label("File encapsulation");
600 if (cap_snaplen) print_stats_table_header_label("Packet size limit");
601 if (cap_snaplen) print_stats_table_header_label("Packet size limit min (inferred)");
602 if (cap_snaplen) print_stats_table_header_label("Packet size limit max (inferred)");
603 if (cap_packet_count) print_stats_table_header_label("Number of packets");
604 if (cap_file_size) print_stats_table_header_label("File size (bytes)");
605 if (cap_data_size) print_stats_table_header_label("Data size (bytes)");
606 if (cap_duration) print_stats_table_header_label("Capture duration (seconds)");
607 if (cap_start_time) print_stats_table_header_label("Start time");
608 if (cap_end_time) print_stats_table_header_label("End time");
609 if (cap_data_rate_byte) print_stats_table_header_label("Data byte rate (bytes/sec)");
610 if (cap_data_rate_bit) print_stats_table_header_label("Data bit rate (bits/sec)");
611 if (cap_packet_size) print_stats_table_header_label("Average packet size (bytes)");
612 if (cap_packet_rate) print_stats_table_header_label("Average packet rate (packets/sec)");
613 #ifdef HAVE_LIBGCRYPT
614 if (cap_file_hashes) {
615 print_stats_table_header_label("SHA1");
616 print_stats_table_header_label("RIPEMD160");
617 print_stats_table_header_label("MD5");
619 #endif /* HAVE_LIBGCRYPT */
620 if (cap_order) print_stats_table_header_label("Strict time order");
621 if (cap_comment) print_stats_table_header_label("Capture comment");
627 print_stats_table(const gchar *filename, capture_info *cf_info)
629 const gchar *file_type_string, *file_encap_string;
633 /* Build printable strings for various stats */
634 file_type_string = wtap_file_type_subtype_string(cf_info->file_type);
635 file_encap_string = wtap_encap_string(cf_info->file_encap);
636 start_time_t = (time_t)cf_info->start_time;
637 stop_time_t = (time_t)cf_info->stop_time;
641 printf("%s", filename);
648 printf("%s", file_type_string);
652 /* ToDo: If WTAP_ENCAP_PER_PACKET, show the list of encapsulations encountered;
653 * Output a line for each different encap with all fields repeated except
654 * the encapsulation field which has "Per Packet: ..." for each
655 * encapsulation type seen ?
657 if (cap_file_encap) {
660 printf("%s", file_encap_string);
667 if (cf_info->snap_set)
668 printf("%u", cf_info->snaplen);
672 if (cf_info->snaplen_max_inferred > 0) {
675 printf("%u", cf_info->snaplen_min_inferred);
679 printf("%u", cf_info->snaplen_max_inferred);
694 if (cap_packet_count) {
697 printf("%u", cf_info->packet_count);
704 printf("%" G_GINT64_MODIFIER "d", cf_info->filesize);
711 printf("%" G_GINT64_MODIFIER "u", cf_info->packet_bytes);
718 if (cf_info->times_known)
719 printf("%f", cf_info->duration);
725 if (cap_start_time) {
728 printf("%s", time_string(start_time_t, cf_info, FALSE));
735 printf("%s", time_string(stop_time_t, cf_info, FALSE));
739 if (cap_data_rate_byte) {
742 if (cf_info->times_known)
743 printf("%.2f", cf_info->data_rate);
749 if (cap_data_rate_bit) {
752 if (cf_info->times_known)
753 printf("%.2f", cf_info->data_rate*8);
759 if (cap_packet_size) {
762 printf("%.2f", cf_info->packet_size);
766 if (cap_packet_rate) {
769 if (cf_info->times_known)
770 printf("%.2f", cf_info->packet_rate);
776 #ifdef HAVE_LIBGCRYPT
777 if (cap_file_hashes) {
780 printf("%s", file_sha1);
785 printf("%s", file_rmd160);
790 printf("%s", file_md5);
793 #endif /* HAVE_LIBGCRYPT */
798 printf("%s", order_string(cf_info->order));
805 printf("%s", cf_info->comment);
814 process_cap_file(wtap *wth, const char *filename)
824 guint32 snaplen_min_inferred = 0xffffffff;
825 guint32 snaplen_max_inferred = 0;
826 const struct wtap_pkthdr *phdr;
827 capture_info cf_info;
828 gboolean have_times = TRUE;
829 double start_time = 0;
830 double stop_time = 0;
832 double prev_time = 0;
833 gboolean know_order = FALSE;
834 order_t order = IN_ORDER;
835 wtapng_section_t *shb_inf;
839 cf_info.encap_counts = g_new0(int,WTAP_NUM_ENCAP_TYPES);
841 /* Tally up data that we need to parse through the file to find */
842 while (wtap_read(wth, &err, &err_info, &data_offset)) {
843 phdr = wtap_phdr(wth);
844 if (phdr->presence_flags & WTAP_HAS_TS) {
845 prev_time = cur_time;
846 cur_time = nstime_to_sec(&phdr->ts);
848 start_time = cur_time;
849 stop_time = cur_time;
850 prev_time = cur_time;
852 if (cur_time < prev_time) {
853 order = NOT_IN_ORDER;
855 if (cur_time < start_time) {
856 start_time = cur_time;
858 if (cur_time > stop_time) {
859 stop_time = cur_time;
862 have_times = FALSE; /* at least one packet has no time stamp */
863 if (order != NOT_IN_ORDER)
864 order = ORDER_UNKNOWN;
867 if (phdr->rec_type == REC_TYPE_PACKET) {
871 /* If caplen < len for a rcd, then presumably */
872 /* 'Limit packet capture length' was done for this rcd. */
873 /* Keep track as to the min/max actual snapshot lengths */
874 /* seen for this file. */
875 if (phdr->caplen < phdr->len) {
876 if (phdr->caplen < snaplen_min_inferred)
877 snaplen_min_inferred = phdr->caplen;
878 if (phdr->caplen > snaplen_max_inferred)
879 snaplen_max_inferred = phdr->caplen;
882 /* Per-packet encapsulation */
883 if (wtap_file_encap(wth) == WTAP_ENCAP_PER_PACKET) {
884 if ((phdr->pkt_encap > 0) && (phdr->pkt_encap < WTAP_NUM_ENCAP_TYPES)) {
885 cf_info.encap_counts[phdr->pkt_encap] += 1;
887 fprintf(stderr, "capinfos: Unknown per-packet encapsulation: %d [frame number: %d]\n", phdr->pkt_encap, packet);
896 "capinfos: An error occurred after reading %u packets from \"%s\": %s.\n",
897 packet, filename, wtap_strerror(err));
900 case WTAP_ERR_SHORT_READ:
903 " (will continue anyway, checksums might be incorrect)\n");
906 case WTAP_ERR_UNSUPPORTED:
907 case WTAP_ERR_UNSUPPORTED_ENCAP:
908 case WTAP_ERR_BAD_FILE:
909 case WTAP_ERR_DECOMPRESS:
910 fprintf(stderr, "(%s)\n", err_info);
915 g_free(cf_info.encap_counts);
921 size = wtap_file_size(wth, &err);
924 "capinfos: Can't get size of \"%s\": %s.\n",
925 filename, g_strerror(err));
926 g_free(cf_info.encap_counts);
930 cf_info.filesize = size;
933 cf_info.file_type = wtap_file_type_subtype(wth);
934 cf_info.iscompressed = wtap_iscompressed(wth);
936 /* File Encapsulation */
937 cf_info.file_encap = wtap_file_encap(wth);
939 /* Packet size limit (snaplen) */
940 cf_info.snaplen = wtap_snapshot_length(wth);
941 if (cf_info.snaplen > 0)
942 cf_info.snap_set = TRUE;
944 cf_info.snap_set = FALSE;
946 cf_info.snaplen_min_inferred = snaplen_min_inferred;
947 cf_info.snaplen_max_inferred = snaplen_max_inferred;
950 cf_info.packet_count = packet;
953 cf_info.times_known = have_times;
954 cf_info.start_time = start_time;
955 cf_info.stop_time = stop_time;
956 cf_info.duration = stop_time-start_time;
957 cf_info.know_order = know_order;
958 cf_info.order = order;
960 /* Number of packet bytes */
961 cf_info.packet_bytes = bytes;
963 cf_info.data_rate = 0.0;
964 cf_info.packet_rate = 0.0;
965 cf_info.packet_size = 0.0;
968 if (cf_info.duration > 0.0) {
969 cf_info.data_rate = (double)bytes / (stop_time-start_time); /* Data rate per second */
970 cf_info.packet_rate = (double)packet / (stop_time-start_time); /* packet rate per second */
972 cf_info.packet_size = (double)bytes / packet; /* Avg packet size */
975 cf_info.comment = NULL;
976 shb_inf = wtap_file_get_shb_info(wth);
978 /* opt_comment is always 0-terminated by pcapng_read_section_header_block */
979 cf_info.comment = g_strdup(shb_inf->opt_comment);
982 if (cf_info.comment) {
983 /* multi-line comments would conflict with the formatting that capinfos uses
984 we replace linefeeds with spaces */
994 print_stats(filename, &cf_info);
996 print_stats_table(filename, &cf_info);
999 g_free(cf_info.encap_counts);
1000 g_free(cf_info.comment);
1006 show_version(GString *comp_info_str, GString *runtime_info_str)
1008 printf("Capinfos (Wireshark) %s\n"
1015 get_ws_vcs_version_info(), get_copyright_info(),
1016 comp_info_str->str, runtime_info_str->str);
1020 print_usage(FILE *output)
1022 fprintf(output, "\n");
1023 fprintf(output, "Usage: capinfos [options] <infile> ...\n");
1024 fprintf(output, "\n");
1025 fprintf(output, "General infos:\n");
1026 fprintf(output, " -t display the capture file type\n");
1027 fprintf(output, " -E display the capture file encapsulation\n");
1028 #ifdef HAVE_LIBGCRYPT
1029 fprintf(output, " -H display the SHA1, RMD160, and MD5 hashes of the file\n");
1031 fprintf(output, " -k display the capture comment\n");
1032 fprintf(output, "\n");
1033 fprintf(output, "Size infos:\n");
1034 fprintf(output, " -c display the number of packets\n");
1035 fprintf(output, " -s display the size of the file (in bytes)\n");
1036 fprintf(output, " -d display the total length of all packets (in bytes)\n");
1037 fprintf(output, " -l display the packet size limit (snapshot length)\n");
1038 fprintf(output, "\n");
1039 fprintf(output, "Time infos:\n");
1040 fprintf(output, " -u display the capture duration (in seconds)\n");
1041 fprintf(output, " -a display the capture start time\n");
1042 fprintf(output, " -e display the capture end time\n");
1043 fprintf(output, " -o display the capture file chronological status (True/False)\n");
1044 fprintf(output, " -S display start and end times as seconds\n");
1045 fprintf(output, "\n");
1046 fprintf(output, "Statistic infos:\n");
1047 fprintf(output, " -y display average data rate (in bytes/sec)\n");
1048 fprintf(output, " -i display average data rate (in bits/sec)\n");
1049 fprintf(output, " -z display average packet size (in bytes)\n");
1050 fprintf(output, " -x display average packet rate (in packets/sec)\n");
1051 fprintf(output, "\n");
1052 fprintf(output, "Output format:\n");
1053 fprintf(output, " -L generate long report (default)\n");
1054 fprintf(output, " -T generate table report\n");
1055 fprintf(output, " -M display machine-readable values in long reports\n");
1056 fprintf(output, "\n");
1057 fprintf(output, "Table report options:\n");
1058 fprintf(output, " -R generate header record (default)\n");
1059 fprintf(output, " -r do not generate header record\n");
1060 fprintf(output, "\n");
1061 fprintf(output, " -B separate infos with TAB character (default)\n");
1062 fprintf(output, " -m separate infos with comma (,) character\n");
1063 fprintf(output, " -b separate infos with SPACE character\n");
1064 fprintf(output, "\n");
1065 fprintf(output, " -N do not quote infos (default)\n");
1066 fprintf(output, " -q quote infos with single quotes (')\n");
1067 fprintf(output, " -Q quote infos with double quotes (\")\n");
1068 fprintf(output, "\n");
1069 fprintf(output, "Miscellaneous:\n");
1070 fprintf(output, " -h display this help and exit\n");
1071 fprintf(output, " -C cancel processing if file open fails (default is to continue)\n");
1072 fprintf(output, " -A generate all infos (default)\n");
1073 fprintf(output, "\n");
1074 fprintf(output, "Options are processed from left to right order with later options superceding\n");
1075 fprintf(output, "or adding to earlier options.\n");
1076 fprintf(output, "\n");
1077 fprintf(output, "If no options are given the default is to display all infos in long report\n");
1078 fprintf(output, "output format.\n");
1079 #ifndef HAVE_LIBGCRYPT
1080 fprintf(output, "\nFile hashing support (-H) is not present.\n");
1086 * Don't report failures to load plugins because most (non-wiretap) plugins
1087 * *should* fail to load (because we're not linked against libwireshark and
1088 * dissector plugins need libwireshark).
1091 failure_message(const char *msg_format _U_, va_list ap _U_)
1097 #ifdef HAVE_LIBGCRYPT
1099 hash_to_str(const unsigned char *hash, size_t length, char *str) {
1102 for (i = 0; i < (int) length; i++) {
1103 g_snprintf(str+(i*2), 3, "%02x", hash[i]);
1106 #endif /* HAVE_LIBGCRYPT */
1109 get_capinfos_compiled_info(GString *str)
1112 g_string_append(str, ", ");
1114 g_string_append(str, "with libz ");
1116 g_string_append(str, ZLIB_VERSION);
1117 #else /* ZLIB_VERSION */
1118 g_string_append(str, "(version unknown)");
1119 #endif /* ZLIB_VERSION */
1120 #else /* HAVE_LIBZ */
1121 g_string_append(str, "without libz");
1122 #endif /* HAVE_LIBZ */
1126 get_capinfos_runtime_info(GString *str)
1129 #if defined(HAVE_LIBZ) && !defined(_WIN32)
1130 g_string_append_printf(str, ", with libz %s", zlibVersion());
1135 main(int argc, char *argv[])
1137 GString *comp_info_str;
1138 GString *runtime_info_str;
1143 int overall_error_status;
1144 static const struct option long_options[] = {
1145 {(char *)"help", no_argument, NULL, 'h'},
1146 {(char *)"version", no_argument, NULL, 'v'},
1152 char *init_progfile_dir_error;
1154 #ifdef HAVE_LIBGCRYPT
1156 char *hash_buf = NULL;
1157 gcry_md_hd_t hd = NULL;
1161 /* Assemble the compile-time version information string */
1162 comp_info_str = g_string_new("Compiled ");
1163 get_compiled_version_info(comp_info_str, NULL, get_capinfos_compiled_info);
1165 /* Assemble the run-time version information string */
1166 runtime_info_str = g_string_new("Running ");
1167 get_runtime_version_info(runtime_info_str, get_capinfos_runtime_info);
1169 /* Add it to the information to be reported on a crash. */
1170 ws_add_crash_info("Capinfos (Wireshark) %s\n"
1175 get_ws_vcs_version_info(), comp_info_str->str, runtime_info_str->str);
1178 arg_list_utf_16to8(argc, argv);
1179 create_app_running_mutex();
1183 * Get credential information for later use.
1185 init_process_policies();
1186 init_open_routines();
1189 if ((init_progfile_dir_error = init_progfile_dir(argv[0], main))) {
1190 g_warning("capinfos: init_progfile_dir(): %s", init_progfile_dir_error);
1191 g_free(init_progfile_dir_error);
1193 /* Register all the plugin types we have. */
1194 wtap_register_plugin_types(); /* Types known to libwiretap */
1196 init_report_err(failure_message, NULL, NULL, NULL);
1198 /* Scan for plugins. This does *not* call their registration routines;
1199 that's done later. */
1202 /* Register all libwiretap plugin modules. */
1203 register_all_wiretap_modules();
1207 /* Process the options */
1209 ctx = g_option_context_new(" <infile> ... - print information about capture file(s)");
1210 general_grp = g_option_group_new("gen", "General infos:",
1211 "Show general options", NULL, NULL);
1212 size_grp = g_option_group_new("size", "Size infos:",
1213 "Show size options", NULL, NULL);
1214 time_grp = g_option_group_new("time", "Time infos:",
1215 "Show time options", NULL, NULL);
1216 stats_grp = g_option_group_new("stats", "Statistics infos:",
1217 "Show statistics options", NULL, NULL);
1218 output_grp = g_option_group_new("output", "Output format:",
1219 "Show output format options", NULL, NULL);
1220 table_report_grp = g_option_group_new("table", "Table report options:",
1221 "Show table report options", NULL, NULL);
1222 g_option_group_add_entries(general_grp, general_entries);
1223 g_option_group_add_entries(size_grp, size_entries);
1224 g_option_group_add_entries(time_grp, time_entries);
1225 g_option_group_add_entries(stats_grp, stats_entries);
1226 g_option_group_add_entries(output_grp, output_format_entries);
1227 g_option_group_add_entries(table_report_grp, table_report_entries);
1228 g_option_context_add_main_entries(ctx, misc_entries, NULL);
1229 g_option_context_add_group(ctx, general_grp);
1230 g_option_context_add_group(ctx, size_grp);
1231 g_option_context_add_group(ctx, time_grp);
1232 g_option_context_add_group(ctx, stats_grp);
1233 g_option_context_add_group(ctx, output_grp);
1234 g_option_context_add_group(ctx, table_report_grp);
1235 /* There's probably a better way to do this, but this works for now.
1236 GOptions displays the name in argv[0] as the name of the
1237 application. This is reasonable, but because we actually have a
1238 script wrapper that calls the executable. The name that gets
1239 displayed is not exactly the same as the command the user used
1242 argv[0] = (char *)"capinfos";
1244 /* if we have at least one cmdline option, we disable printing all infos */
1245 if (argc > 2 && report_all_infos)
1246 disable_all_infos();
1248 if ( !g_option_context_parse(ctx, &argc, &argv, &parse_err) ) {
1250 g_printerr ("option parsing failed: %s\n", parse_err->message);
1251 g_printerr("%s", g_option_context_get_help (ctx, TRUE, NULL));
1255 g_print("%s", g_option_context_get_help (ctx, FALSE, NULL));
1259 g_printerr("%s", g_option_context_get_help (ctx, FALSE, NULL));
1262 g_option_context_free(ctx);
1264 #endif /* USE_GOPTION */
1265 while ((opt = getopt_long(argc, argv, "tEcs" FILE_HASH_OPT "dluaeyizvhxokCALTMRrSNqQBmb", long_options, NULL)) !=-1) {
1270 if (report_all_infos) disable_all_infos();
1271 cap_file_type = TRUE;
1275 if (report_all_infos) disable_all_infos();
1276 cap_file_encap = TRUE;
1280 if (report_all_infos) disable_all_infos();
1285 if (report_all_infos) disable_all_infos();
1286 cap_packet_count = TRUE;
1290 if (report_all_infos) disable_all_infos();
1291 cap_file_size = TRUE;
1295 if (report_all_infos) disable_all_infos();
1296 cap_data_size = TRUE;
1300 if (report_all_infos) disable_all_infos();
1301 cap_duration = TRUE;
1305 if (report_all_infos) disable_all_infos();
1306 cap_start_time = TRUE;
1310 if (report_all_infos) disable_all_infos();
1311 cap_end_time = TRUE;
1315 time_as_secs = TRUE;
1319 if (report_all_infos) disable_all_infos();
1320 cap_data_rate_byte = TRUE;
1324 if (report_all_infos) disable_all_infos();
1325 cap_data_rate_bit = TRUE;
1329 if (report_all_infos) disable_all_infos();
1330 cap_packet_size = TRUE;
1334 if (report_all_infos) disable_all_infos();
1335 cap_packet_rate = TRUE;
1338 #ifdef HAVE_LIBGCRYPT
1340 if (report_all_infos) disable_all_infos();
1341 cap_file_hashes = TRUE;
1346 if (report_all_infos) disable_all_infos();
1351 if (report_all_infos) disable_all_infos();
1356 continue_after_wtap_open_offline_failure = FALSE;
1368 long_report = FALSE;
1372 machine_readable = TRUE;
1376 table_report_header = TRUE;
1380 table_report_header = FALSE;
1396 field_separator = '\t';
1400 field_separator = ',';
1404 field_separator = ' ';
1408 printf("Capinfos (Wireshark) %s\n"
1409 "Print various information (infos) about capture files.\n"
1410 "See http://www.wireshark.org for more information.\n",
1411 get_ws_vcs_version_info());
1412 print_usage(stdout);
1417 show_version(comp_info_str, runtime_info_str);
1418 g_string_free(comp_info_str, TRUE);
1419 g_string_free(runtime_info_str, TRUE);
1423 case '?': /* Bad flag - print usage message */
1424 print_usage(stderr);
1430 /* Set the C-language locale to the native environment. */
1431 setlocale(LC_ALL, "");
1433 if ((argc - optind) < 1) {
1434 print_usage(stderr);
1438 if (!long_report && table_report_header) {
1439 print_stats_table_header();
1442 #ifdef HAVE_LIBGCRYPT
1443 if (cap_file_hashes) {
1444 gcry_check_version(NULL);
1445 gcry_md_open(&hd, GCRY_MD_SHA1, 0);
1447 gcry_md_enable(hd, GCRY_MD_RMD160);
1448 gcry_md_enable(hd, GCRY_MD_MD5);
1450 hash_buf = (char *)g_malloc(HASH_BUF_SIZE);
1454 overall_error_status = 0;
1456 for (opt = optind; opt < argc; opt++) {
1458 #ifdef HAVE_LIBGCRYPT
1459 g_strlcpy(file_sha1, "<unknown>", HASH_STR_SIZE);
1460 g_strlcpy(file_rmd160, "<unknown>", HASH_STR_SIZE);
1461 g_strlcpy(file_md5, "<unknown>", HASH_STR_SIZE);
1463 if (cap_file_hashes) {
1464 fh = ws_fopen(argv[opt], "rb");
1466 while((hash_bytes = fread(hash_buf, 1, HASH_BUF_SIZE, fh)) > 0) {
1467 gcry_md_write(hd, hash_buf, hash_bytes);
1470 hash_to_str(gcry_md_read(hd, GCRY_MD_SHA1), HASH_SIZE_SHA1, file_sha1);
1471 hash_to_str(gcry_md_read(hd, GCRY_MD_RMD160), HASH_SIZE_RMD160, file_rmd160);
1472 hash_to_str(gcry_md_read(hd, GCRY_MD_MD5), HASH_SIZE_MD5, file_md5);
1475 if (hd) gcry_md_reset(hd);
1477 #endif /* HAVE_LIBGCRYPT */
1479 wth = wtap_open_offline(argv[opt], WTAP_TYPE_AUTO, &err, &err_info, FALSE);
1482 fprintf(stderr, "capinfos: Can't open %s: %s\n", argv[opt],
1483 wtap_strerror(err));
1486 case WTAP_ERR_UNSUPPORTED:
1487 case WTAP_ERR_UNSUPPORTED_ENCAP:
1488 case WTAP_ERR_BAD_FILE:
1489 fprintf(stderr, "(%s)\n", err_info);
1493 overall_error_status = 1; /* remember that an error has occurred */
1494 if (!continue_after_wtap_open_offline_failure)
1495 exit(1); /* error status */
1499 if ((opt > optind) && (long_report))
1501 status = process_cap_file(wth, argv[opt]);
1509 return overall_error_status;
1513 * Editor modelines - http://www.wireshark.org/tools/modelines.html
1518 * indent-tabs-mode: nil
1521 * vi: set shiftwidth=2 tabstop=8 expandtab:
1522 * :indentSize=2:tabSize=8:noTabs=true: