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>
79 #include <wsutil/filesystem.h>
82 #include <wsutil/plugins.h>
86 #include <wsutil/report_err.h>
87 #include <wsutil/privileges.h>
88 #include <wsutil/str_util.h>
91 #include <wsutil/wsgcrypt.h>
92 #include <wsutil/file_util.h>
96 #include "wsutil/wsgetopt.h"
100 #include <wsutil/unicode-utils.h>
106 * By default capinfos now continues processing
107 * the next filename if and when wiretap detects
108 * a problem opening a file.
109 * Use the '-C' option to revert back to original
110 * capinfos behavior which is to abort any
111 * additional file processing at first open file
115 static gboolean continue_after_wtap_open_offline_failure = TRUE;
118 * table report variables
121 static gboolean long_report = TRUE; /* By default generate long report */
122 static gchar table_report_header = TRUE; /* Generate column header by default */
123 static gchar field_separator = '\t'; /* Use TAB as field separator by default */
124 static gchar quote_char = '\0'; /* Do NOT quote fields by default */
125 static gboolean machine_readable = FALSE; /* Display machine-readable numbers */
128 * capinfos has the ability to report on a number of
129 * various characteristics ("infos") for each input file.
131 * By default reporting of all info fields is enabled.
133 * Optionally the reporting of any specific info field
134 * or combination of info fields can be enabled with
135 * individual options.
138 static gboolean report_all_infos = TRUE; /* Report all infos */
140 static gboolean cap_file_type = TRUE; /* Report capture type */
141 static gboolean cap_file_encap = TRUE; /* Report encapsulation */
142 static gboolean cap_snaplen = TRUE; /* Packet size limit (snaplen)*/
143 static gboolean cap_packet_count = TRUE; /* Report packet count */
144 static gboolean cap_file_size = TRUE; /* Report file size */
145 static gboolean cap_comment = TRUE; /* Display the capture comment */
147 static gboolean cap_data_size = TRUE; /* Report packet byte size */
148 static gboolean cap_duration = TRUE; /* Report capture duration */
149 static gboolean cap_start_time = TRUE; /* Report capture start time */
150 static gboolean cap_end_time = TRUE; /* Report capture end time */
151 static gboolean time_as_secs = FALSE; /* Report time values as raw seconds */
153 static gboolean cap_data_rate_byte = TRUE; /* Report data rate bytes/sec */
154 static gboolean cap_data_rate_bit = TRUE; /* Report data rate bites/sec */
155 static gboolean cap_packet_size = TRUE; /* Report average packet size */
156 static gboolean cap_packet_rate = TRUE; /* Report average packet rate */
157 static gboolean cap_order = TRUE; /* Report if packets are in chronological order (True/False) */
159 #ifdef HAVE_LIBGCRYPT
160 static gboolean cap_file_hashes = TRUE; /* Calculate file hashes */
164 static gboolean cap_help = FALSE;
165 static gboolean table_report = FALSE;
167 static GOptionEntry general_entries[] =
170 { "type", 't', 0, G_OPTION_ARG_NONE, &cap_file_type,
171 "display the capture file type", NULL },
172 { "Encapsulation", 'E', 0, G_OPTION_ARG_NONE, &cap_file_encap,
173 "display the capture file encapsulation", NULL },
174 #ifdef HAVE_LIBGCRYPT
175 { "Hash", 'H', 0, G_OPTION_ARG_NONE, &cap_file_hashes,
176 "display the SHA1, RMD160, and MD5 hashes of the file", NULL },
177 #endif /* HAVE_LIBGCRYPT */
178 { "capture-comment", 'k', 0, G_OPTION_ARG_NONE, &cap_comment,
179 "display the capture comment ", NULL },
180 { NULL,'\0',0,G_OPTION_ARG_NONE,NULL,NULL,NULL }
182 static GOptionEntry size_entries[] =
185 { "packets", 'c', 0, G_OPTION_ARG_NONE, &cap_packet_count,
186 "display the number of packets", NULL },
187 { "size", 's', 0, G_OPTION_ARG_NONE, &cap_file_size,
188 "display the size of the file (in bytes)", NULL },
189 { "tot-len-of-pkts", 'd', 0, G_OPTION_ARG_NONE, &cap_data_size,
190 "display the total length of all packets (in bytes)", NULL },
191 { "snap", 'l', 0, G_OPTION_ARG_NONE, &cap_snaplen,
192 "display the packet size limit (snapshot length)", NULL },
193 { NULL,'\0',0,G_OPTION_ARG_NONE,NULL,NULL,NULL }
195 static GOptionEntry time_entries[] =
198 { "duration", 'u', 0, G_OPTION_ARG_NONE, &cap_duration,
199 "display the capture duration (in seconds)", NULL },
200 { "start", 'a', 0, G_OPTION_ARG_NONE, &cap_start_time,
201 "display the capture start time", NULL },
202 { "end", 'e', 0, G_OPTION_ARG_NONE, &cap_end_time,
203 "display the capture end time", NULL },
204 { "cron", 'o', 0, G_OPTION_ARG_NONE, &cap_order,
205 "display the capture file chronological status (True/False)", NULL },
206 { "start-end-time-sec", 'S', 0, G_OPTION_ARG_NONE, &time_as_secs,
207 "display start and end times as seconds", NULL },
208 { NULL,'\0',0,G_OPTION_ARG_NONE,NULL,NULL,NULL }
211 static GOptionEntry stats_entries[] =
214 { "bytes", 'y', 0, G_OPTION_ARG_NONE, &cap_data_rate_byte,
215 "display average data rate (in bytes/s)", NULL },
216 { "bits", 'i', 0, G_OPTION_ARG_NONE, &cap_data_rate_bit,
217 "display average data rate (in bits/s)", NULL },
218 { "packet-bytes", 'z', 0, G_OPTION_ARG_NONE, &cap_packet_size,
219 "display average packet size (in bytes)", NULL },
220 { "packets", 'x', 0, G_OPTION_ARG_NONE, &cap_packet_rate,
221 "display average packet rate (in packets/s)", NULL },
222 { NULL,'\0',0,G_OPTION_ARG_NONE,NULL,NULL,NULL }
225 static GOptionEntry output_format_entries[] =
228 { "long", 'L', 0, G_OPTION_ARG_NONE, &long_report,
229 "generate long report (default)", NULL },
230 { "Table", 'T', 0, G_OPTION_ARG_NONE, &table_report,
231 "generate table report", NULL },
232 { "machine-readable", 'M', 0, G_OPTION_ARG_NONE, &machine_readable,
233 "display machine-readable (unabbreviated) values in long reports", NULL },
234 { NULL,'\0',0,G_OPTION_ARG_NONE,NULL,NULL,NULL }
237 static GOptionEntry table_report_entries[] =
240 { "header-rec", 'R', 0, G_OPTION_ARG_NONE, &table_report_header,
241 "generate header record (default)", NULL },
242 { "no-table", 'r', 0, G_OPTION_ARG_NONE, &table_report_header,
243 "do not generate header record", NULL },
244 { NULL,'\0',0,G_OPTION_ARG_NONE,NULL,NULL,NULL }
247 static GOptionEntry misc_entries[] =
249 { "helpcompat", 'h', 0, G_OPTION_ARG_NONE, &cap_help,
250 "display help", NULL },
251 { NULL,'\0',0,G_OPTION_ARG_NONE,NULL,NULL,NULL }
255 GOptionGroup *general_grp, *size_grp, *time_grp, *stats_grp, *output_grp, *table_report_grp;
256 GError *parse_err = NULL;
258 #endif /* USE_GOPTION */
260 #ifdef HAVE_LIBGCRYPT
261 #define HASH_SIZE_SHA1 20
262 #define HASH_SIZE_RMD160 20
263 #define HASH_SIZE_MD5 16
265 #define HASH_STR_SIZE (41) /* Max hash size * 2 + '\0' */
266 #define HASH_BUF_SIZE (1024 * 1024)
269 static gchar file_sha1[HASH_STR_SIZE];
270 static gchar file_rmd160[HASH_STR_SIZE];
271 static gchar file_md5[HASH_STR_SIZE];
273 #define FILE_HASH_OPT "H"
275 #define FILE_HASH_OPT ""
276 #endif /* HAVE_LIBGCRYPT */
279 * If we have at least two packets with time stamps, and they're not in
280 * order - i.e., the later packet has a time stamp older than the earlier
281 * packet - the time stamps are known not to be in order.
283 * If every packet has a time stamp, and they're all in order, the time
284 * stamp is known to be in order.
286 * Otherwise, we have no idea.
294 typedef struct _capture_info {
295 const char *filename;
297 gboolean iscompressed;
302 guint64 packet_bytes;
303 gboolean times_known;
306 guint32 packet_count;
307 gboolean snap_set; /* If set in capture file header */
308 guint32 snaplen; /* value from the capture file header */
309 guint32 snaplen_min_inferred; /* If caplen < len for 1 or more rcds */
310 guint32 snaplen_max_inferred; /* ... */
311 gboolean drops_known;
317 double data_rate; /* in bytes */
321 int *encap_counts; /* array of per_packet encap counts; array has one entry per wtap_encap type */
326 enable_all_infos(void)
328 report_all_infos = TRUE;
330 cap_file_type = TRUE;
331 cap_file_encap = TRUE;
333 cap_packet_count = TRUE;
334 cap_file_size = TRUE;
337 cap_data_size = TRUE;
339 cap_start_time = TRUE;
343 cap_data_rate_byte = TRUE;
344 cap_data_rate_bit = TRUE;
345 cap_packet_size = TRUE;
346 cap_packet_rate = TRUE;
348 #ifdef HAVE_LIBGCRYPT
349 cap_file_hashes = TRUE;
350 #endif /* HAVE_LIBGCRYPT */
354 disable_all_infos(void)
356 report_all_infos = FALSE;
358 cap_file_type = FALSE;
359 cap_file_encap = FALSE;
361 cap_packet_count = FALSE;
362 cap_file_size = FALSE;
365 cap_data_size = FALSE;
366 cap_duration = FALSE;
367 cap_start_time = FALSE;
368 cap_end_time = FALSE;
371 cap_data_rate_byte = FALSE;
372 cap_data_rate_bit = FALSE;
373 cap_packet_size = FALSE;
374 cap_packet_rate = FALSE;
376 #ifdef HAVE_LIBGCRYPT
377 cap_file_hashes = FALSE;
378 #endif /* HAVE_LIBGCRYPT */
382 order_string(order_t order)
396 return "???"; /* "cannot happen" (the next step is "Profit!") */
401 time_string(time_t timer, capture_info *cf_info, gboolean want_lf)
403 const gchar *lf = want_lf ? "\n" : "";
404 static gchar time_string_buf[20];
405 char *time_string_ctime;
407 if (cf_info->times_known && cf_info->packet_count > 0) {
409 /* XXX - Would it be useful to show sub-second precision? */
410 g_snprintf(time_string_buf, 20, "%lu%s", (unsigned long)timer, lf);
411 return time_string_buf;
413 time_string_ctime = ctime(&timer);
414 if (time_string_ctime == NULL) {
415 g_snprintf(time_string_buf, 20, "Not representable%s", lf);
416 return time_string_buf;
420 * The ctime() function returns a string formatted as:
421 * "Www Mmm dd hh:mm:ss yyyy\n"
422 * The unwanted '\n' is the 24th character.
424 time_string_ctime[24] = '\0';
426 return time_string_ctime;
430 g_snprintf(time_string_buf, 15, "n/a%s", lf);
431 return time_string_buf;
434 static void print_value(const gchar *text_p1, gint width, const gchar *text_p2, double value) {
436 printf("%s%.*f%s\n", text_p1, width, value, text_p2);
438 printf("%sn/a\n", text_p1);
442 print_stats(const gchar *filename, capture_info *cf_info)
444 const gchar *file_type_string, *file_encap_string;
449 /* Build printable strings for various stats */
450 file_type_string = wtap_file_type_subtype_string(cf_info->file_type);
451 file_encap_string = wtap_encap_string(cf_info->file_encap);
452 start_time_t = (time_t)cf_info->start_time;
453 stop_time_t = (time_t)cf_info->stop_time;
455 if (filename) printf ("File name: %s\n", filename);
456 if (cap_file_type) printf ("File type: %s%s\n",
458 cf_info->iscompressed ? " (gzip compressed)" : "");
459 if (cap_file_encap) printf ("File encapsulation: %s\n", file_encap_string);
460 if (cap_file_encap && (cf_info->file_encap == WTAP_ENCAP_PER_PACKET)) {
462 for (i=0; i<WTAP_NUM_ENCAP_TYPES; i++) {
463 if (cf_info->encap_counts[i] > 0)
464 printf(" %s\n", wtap_encap_string(i));
467 if (cap_snaplen && cf_info->snap_set)
468 printf ("Packet size limit: file hdr: %u bytes\n", cf_info->snaplen);
469 else if (cap_snaplen && !cf_info->snap_set)
470 printf ("Packet size limit: file hdr: (not set)\n");
471 if (cf_info->snaplen_max_inferred > 0) {
472 if (cf_info->snaplen_min_inferred == cf_info->snaplen_max_inferred)
473 printf ("Packet size limit: inferred: %u bytes\n", cf_info->snaplen_min_inferred);
475 printf ("Packet size limit: inferred: %u bytes - %u bytes (range)\n",
476 cf_info->snaplen_min_inferred, cf_info->snaplen_max_inferred);
478 if (cap_packet_count) {
479 printf ("Number of packets: ");
480 if (machine_readable) {
481 printf ("%u\n", cf_info->packet_count);
483 size_string = format_size(cf_info->packet_count, format_size_unit_none);
484 printf ("%s\n", size_string);
489 printf ("File size: ");
490 if (machine_readable) {
491 printf ("%" G_GINT64_MODIFIER "d bytes\n", cf_info->filesize);
493 size_string = format_size(cf_info->filesize, format_size_unit_bytes);
494 printf ("%s\n", size_string);
499 printf ("Data size: ");
500 if (machine_readable) {
501 printf ("%" G_GINT64_MODIFIER "u bytes\n", cf_info->packet_bytes);
503 size_string = format_size(cf_info->packet_bytes, format_size_unit_bytes);
504 printf ("%s\n", size_string);
508 if (cf_info->times_known) {
509 if (cap_duration) /* XXX - shorten to hh:mm:ss */
510 print_value("Capture duration: ", 0, " seconds", cf_info->duration);
512 printf ("Start time: %s", time_string(start_time_t, cf_info, TRUE));
514 printf ("End time: %s", time_string(stop_time_t, cf_info, TRUE));
515 if (cap_data_rate_byte) {
516 printf ("Data byte rate: ");
517 if (machine_readable) {
518 print_value("", 2, " bytes/sec", cf_info->data_rate);
520 size_string = format_size((gint64)cf_info->data_rate, format_size_unit_bytes_s);
521 printf ("%s\n", size_string);
525 if (cap_data_rate_bit) {
526 printf ("Data bit rate: ");
527 if (machine_readable) {
528 print_value("", 2, " bits/sec", cf_info->data_rate*8);
530 size_string = format_size((gint64)(cf_info->data_rate*8), format_size_unit_bits_s);
531 printf ("%s\n", size_string);
536 if (cap_packet_size) printf ("Average packet size: %.2f bytes\n", cf_info->packet_size);
537 if (cf_info->times_known) {
538 if (cap_packet_rate) {
539 printf ("Average packet rate: ");
540 if (machine_readable) {
541 print_value("", 2, " packets/sec", cf_info->packet_rate);
543 size_string = format_size((gint64)cf_info->packet_rate, format_size_unit_none);
544 printf ("%spackets/sec\n", size_string);
549 #ifdef HAVE_LIBGCRYPT
550 if (cap_file_hashes) {
551 printf ("SHA1: %s\n", file_sha1);
552 printf ("RIPEMD160: %s\n", file_rmd160);
553 printf ("MD5: %s\n", file_md5);
555 #endif /* HAVE_LIBGCRYPT */
556 if (cap_order) printf ("Strict time order: %s\n", order_string(cf_info->order));
557 if (cap_comment && cf_info->comment)
558 printf ("Capture comment: %s\n", cf_info->comment);
564 if (field_separator) putchar(field_separator);
570 if (quote_char) putchar(quote_char);
574 print_stats_table_header_label(const gchar *label)
583 print_stats_table_header(void)
589 if (cap_file_type) print_stats_table_header_label("File type");
590 if (cap_file_encap) print_stats_table_header_label("File encapsulation");
591 if (cap_snaplen) print_stats_table_header_label("Packet size limit");
592 if (cap_snaplen) print_stats_table_header_label("Packet size limit min (inferred)");
593 if (cap_snaplen) print_stats_table_header_label("Packet size limit max (inferred)");
594 if (cap_packet_count) print_stats_table_header_label("Number of packets");
595 if (cap_file_size) print_stats_table_header_label("File size (bytes)");
596 if (cap_data_size) print_stats_table_header_label("Data size (bytes)");
597 if (cap_duration) print_stats_table_header_label("Capture duration (seconds)");
598 if (cap_start_time) print_stats_table_header_label("Start time");
599 if (cap_end_time) print_stats_table_header_label("End time");
600 if (cap_data_rate_byte) print_stats_table_header_label("Data byte rate (bytes/sec)");
601 if (cap_data_rate_bit) print_stats_table_header_label("Data bit rate (bits/sec)");
602 if (cap_packet_size) print_stats_table_header_label("Average packet size (bytes)");
603 if (cap_packet_rate) print_stats_table_header_label("Average packet rate (packets/sec)");
604 #ifdef HAVE_LIBGCRYPT
605 if (cap_file_hashes) {
606 print_stats_table_header_label("SHA1");
607 print_stats_table_header_label("RIPEMD160");
608 print_stats_table_header_label("MD5");
610 #endif /* HAVE_LIBGCRYPT */
611 if (cap_order) print_stats_table_header_label("Strict time order");
612 if (cap_comment) print_stats_table_header_label("Capture comment");
618 print_stats_table(const gchar *filename, capture_info *cf_info)
620 const gchar *file_type_string, *file_encap_string;
624 /* Build printable strings for various stats */
625 file_type_string = wtap_file_type_subtype_string(cf_info->file_type);
626 file_encap_string = wtap_encap_string(cf_info->file_encap);
627 start_time_t = (time_t)cf_info->start_time;
628 stop_time_t = (time_t)cf_info->stop_time;
632 printf("%s", filename);
639 printf("%s", file_type_string);
643 /* ToDo: If WTAP_ENCAP_PER_PACKET, show the list of encapsulations encountered;
644 * Output a line for each different encap with all fields repeated except
645 * the encapsulation field which has "Per Packet: ..." for each
646 * encapsulation type seen ?
648 if (cap_file_encap) {
651 printf("%s", file_encap_string);
658 if (cf_info->snap_set)
659 printf("%u", cf_info->snaplen);
663 if (cf_info->snaplen_max_inferred > 0) {
666 printf("%u", cf_info->snaplen_min_inferred);
670 printf("%u", cf_info->snaplen_max_inferred);
685 if (cap_packet_count) {
688 printf("%u", cf_info->packet_count);
695 printf("%" G_GINT64_MODIFIER "d", cf_info->filesize);
702 printf("%" G_GINT64_MODIFIER "u", cf_info->packet_bytes);
709 if (cf_info->times_known)
710 printf("%f", cf_info->duration);
716 if (cap_start_time) {
719 printf("%s", time_string(start_time_t, cf_info, FALSE));
726 printf("%s", time_string(stop_time_t, cf_info, FALSE));
730 if (cap_data_rate_byte) {
733 if (cf_info->times_known)
734 printf("%.2f", cf_info->data_rate);
740 if (cap_data_rate_bit) {
743 if (cf_info->times_known)
744 printf("%.2f", cf_info->data_rate*8);
750 if (cap_packet_size) {
753 printf("%.2f", cf_info->packet_size);
757 if (cap_packet_rate) {
760 if (cf_info->times_known)
761 printf("%.2f", cf_info->packet_rate);
767 #ifdef HAVE_LIBGCRYPT
768 if (cap_file_hashes) {
771 printf("%s", file_sha1);
776 printf("%s", file_rmd160);
781 printf("%s", file_md5);
784 #endif /* HAVE_LIBGCRYPT */
789 printf("%s", order_string(cf_info->order));
796 printf("%s", cf_info->comment);
805 process_cap_file(wtap *wth, const char *filename)
815 guint32 snaplen_min_inferred = 0xffffffff;
816 guint32 snaplen_max_inferred = 0;
817 const struct wtap_pkthdr *phdr;
818 capture_info cf_info;
819 gboolean have_times = TRUE;
820 double start_time = 0;
821 double stop_time = 0;
823 double prev_time = 0;
824 gboolean know_order = FALSE;
825 order_t order = IN_ORDER;
826 wtapng_section_t *shb_inf;
830 cf_info.encap_counts = g_new0(int,WTAP_NUM_ENCAP_TYPES);
832 /* Tally up data that we need to parse through the file to find */
833 while (wtap_read(wth, &err, &err_info, &data_offset)) {
834 phdr = wtap_phdr(wth);
835 if (phdr->presence_flags & WTAP_HAS_TS) {
836 prev_time = cur_time;
837 cur_time = nstime_to_sec(&phdr->ts);
839 start_time = cur_time;
840 stop_time = cur_time;
841 prev_time = cur_time;
843 if (cur_time < prev_time) {
844 order = NOT_IN_ORDER;
846 if (cur_time < start_time) {
847 start_time = cur_time;
849 if (cur_time > stop_time) {
850 stop_time = cur_time;
853 have_times = FALSE; /* at least one packet has no time stamp */
854 if (order != NOT_IN_ORDER)
855 order = ORDER_UNKNOWN;
861 /* If caplen < len for a rcd, then presumably */
862 /* 'Limit packet capture length' was done for this rcd. */
863 /* Keep track as to the min/max actual snapshot lengths */
864 /* seen for this file. */
865 if (phdr->caplen < phdr->len) {
866 if (phdr->caplen < snaplen_min_inferred)
867 snaplen_min_inferred = phdr->caplen;
868 if (phdr->caplen > snaplen_max_inferred)
869 snaplen_max_inferred = phdr->caplen;
872 /* Per-packet encapsulation */
873 if (wtap_file_encap(wth) == WTAP_ENCAP_PER_PACKET) {
874 if ((phdr->pkt_encap > 0) && (phdr->pkt_encap < WTAP_NUM_ENCAP_TYPES)) {
875 cf_info.encap_counts[phdr->pkt_encap] += 1;
877 fprintf(stderr, "capinfos: Unknown per-packet encapsulation: %d [frame number: %d]\n", phdr->pkt_encap, packet);
885 "capinfos: An error occurred after reading %u packets from \"%s\": %s.\n",
886 packet, filename, wtap_strerror(err));
889 case WTAP_ERR_SHORT_READ:
892 " (will continue anyway, checksums might be incorrect)\n");
895 case WTAP_ERR_UNSUPPORTED:
896 case WTAP_ERR_UNSUPPORTED_ENCAP:
897 case WTAP_ERR_BAD_FILE:
898 case WTAP_ERR_DECOMPRESS:
899 fprintf(stderr, "(%s)\n", err_info);
904 g_free(cf_info.encap_counts);
910 size = wtap_file_size(wth, &err);
913 "capinfos: Can't get size of \"%s\": %s.\n",
914 filename, g_strerror(err));
915 g_free(cf_info.encap_counts);
919 cf_info.filesize = size;
922 cf_info.file_type = wtap_file_type_subtype(wth);
923 cf_info.iscompressed = wtap_iscompressed(wth);
925 /* File Encapsulation */
926 cf_info.file_encap = wtap_file_encap(wth);
928 /* Packet size limit (snaplen) */
929 cf_info.snaplen = wtap_snapshot_length(wth);
930 if (cf_info.snaplen > 0)
931 cf_info.snap_set = TRUE;
933 cf_info.snap_set = FALSE;
935 cf_info.snaplen_min_inferred = snaplen_min_inferred;
936 cf_info.snaplen_max_inferred = snaplen_max_inferred;
939 cf_info.packet_count = packet;
942 cf_info.times_known = have_times;
943 cf_info.start_time = start_time;
944 cf_info.stop_time = stop_time;
945 cf_info.duration = stop_time-start_time;
946 cf_info.know_order = know_order;
947 cf_info.order = order;
949 /* Number of packet bytes */
950 cf_info.packet_bytes = bytes;
952 cf_info.data_rate = 0.0;
953 cf_info.packet_rate = 0.0;
954 cf_info.packet_size = 0.0;
957 if (cf_info.duration > 0.0) {
958 cf_info.data_rate = (double)bytes / (stop_time-start_time); /* Data rate per second */
959 cf_info.packet_rate = (double)packet / (stop_time-start_time); /* packet rate per second */
961 cf_info.packet_size = (double)bytes / packet; /* Avg packet size */
964 cf_info.comment = NULL;
965 shb_inf = wtap_file_get_shb_info(wth);
967 /* opt_comment is always 0-terminated by pcapng_read_section_header_block */
968 cf_info.comment = g_strdup(shb_inf->opt_comment);
971 if (cf_info.comment) {
972 /* multi-line comments would conflict with the formatting that capinfos uses
973 we replace linefeeds with spaces */
983 print_stats(filename, &cf_info);
985 print_stats_table(filename, &cf_info);
988 g_free(cf_info.encap_counts);
989 g_free(cf_info.comment);
995 usage(gboolean is_error)
1001 /* XXX - add capinfos header info here */
1007 fprintf(output, "Capinfos %s"
1009 " (" GITVERSION " from " GITBRANCH ")"
1012 fprintf(output, "Prints various information (infos) about capture files.\n");
1013 fprintf(output, "See http://www.wireshark.org for more information.\n");
1014 fprintf(output, "\n");
1015 fprintf(output, "Usage: capinfos [options] <infile> ...\n");
1016 fprintf(output, "\n");
1017 fprintf(output, "General infos:\n");
1018 fprintf(output, " -t display the capture file type\n");
1019 fprintf(output, " -E display the capture file encapsulation\n");
1020 #ifdef HAVE_LIBGCRYPT
1021 fprintf(output, " -H display the SHA1, RMD160, and MD5 hashes of the file\n");
1023 fprintf(output, " -k display the capture comment\n");
1024 fprintf(output, "\n");
1025 fprintf(output, "Size infos:\n");
1026 fprintf(output, " -c display the number of packets\n");
1027 fprintf(output, " -s display the size of the file (in bytes)\n");
1028 fprintf(output, " -d display the total length of all packets (in bytes)\n");
1029 fprintf(output, " -l display the packet size limit (snapshot length)\n");
1030 fprintf(output, "\n");
1031 fprintf(output, "Time infos:\n");
1032 fprintf(output, " -u display the capture duration (in seconds)\n");
1033 fprintf(output, " -a display the capture start time\n");
1034 fprintf(output, " -e display the capture end time\n");
1035 fprintf(output, " -o display the capture file chronological status (True/False)\n");
1036 fprintf(output, " -S display start and end times as seconds\n");
1037 fprintf(output, "\n");
1038 fprintf(output, "Statistic infos:\n");
1039 fprintf(output, " -y display average data rate (in bytes/sec)\n");
1040 fprintf(output, " -i display average data rate (in bits/sec)\n");
1041 fprintf(output, " -z display average packet size (in bytes)\n");
1042 fprintf(output, " -x display average packet rate (in packets/sec)\n");
1043 fprintf(output, "\n");
1044 fprintf(output, "Output format:\n");
1045 fprintf(output, " -L generate long report (default)\n");
1046 fprintf(output, " -T generate table report\n");
1047 fprintf(output, " -M display machine-readable values in long reports\n");
1048 fprintf(output, "\n");
1049 fprintf(output, "Table report options:\n");
1050 fprintf(output, " -R generate header record (default)\n");
1051 fprintf(output, " -r do not generate header record\n");
1052 fprintf(output, "\n");
1053 fprintf(output, " -B separate infos with TAB character (default)\n");
1054 fprintf(output, " -m separate infos with comma (,) character\n");
1055 fprintf(output, " -b separate infos with SPACE character\n");
1056 fprintf(output, "\n");
1057 fprintf(output, " -N do not quote infos (default)\n");
1058 fprintf(output, " -q quote infos with single quotes (')\n");
1059 fprintf(output, " -Q quote infos with double quotes (\")\n");
1060 fprintf(output, "\n");
1061 fprintf(output, "Miscellaneous:\n");
1062 fprintf(output, " -h display this help and exit\n");
1063 fprintf(output, " -C cancel processing if file open fails (default is to continue)\n");
1064 fprintf(output, " -A generate all infos (default)\n");
1065 fprintf(output, "\n");
1066 fprintf(output, "Options are processed from left to right order with later options superceding\n");
1067 fprintf(output, "or adding to earlier options.\n");
1068 fprintf(output, "\n");
1069 fprintf(output, "If no options are given the default is to display all infos in long report\n");
1070 fprintf(output, "output format.\n");
1071 #ifndef HAVE_LIBGCRYPT
1072 fprintf(output, "\nFile hashing support (-H) is not present.\n");
1078 * Don't report failures to load plugins because most (non-wiretap) plugins
1079 * *should* fail to load (because we're not linked against libwireshark and
1080 * dissector plugins need libwireshark).
1083 failure_message(const char *msg_format _U_, va_list ap _U_)
1089 #ifdef HAVE_LIBGCRYPT
1091 hash_to_str(const unsigned char *hash, size_t length, char *str) {
1094 for (i = 0; i < (int) length; i++) {
1095 g_snprintf(str+(i*2), 3, "%02x", hash[i]);
1098 #endif /* HAVE_LIBGCRYPT */
1101 main(int argc, char *argv[])
1107 int overall_error_status;
1111 char *init_progfile_dir_error;
1113 #ifdef HAVE_LIBGCRYPT
1115 char *hash_buf = NULL;
1116 gcry_md_hd_t hd = NULL;
1121 arg_list_utf_16to8(argc, argv);
1122 create_app_running_mutex();
1126 * Get credential information for later use.
1128 init_process_policies();
1129 init_open_routines();
1132 if ((init_progfile_dir_error = init_progfile_dir(argv[0], main))) {
1133 g_warning("capinfos: init_progfile_dir(): %s", init_progfile_dir_error);
1134 g_free(init_progfile_dir_error);
1136 /* Register all the plugin types we have. */
1137 wtap_register_plugin_types(); /* Types known to libwiretap */
1139 init_report_err(failure_message, NULL, NULL, NULL);
1141 /* Scan for plugins. This does *not* call their registration routines;
1142 that's done later. */
1145 /* Register all libwiretap plugin modules. */
1146 register_all_wiretap_modules();
1150 /* Process the options */
1152 ctx = g_option_context_new(" <infile> ... - print information about capture file(s)");
1153 general_grp = g_option_group_new("gen", "General infos:",
1154 "Show general options", NULL, NULL);
1155 size_grp = g_option_group_new("size", "Size infos:",
1156 "Show size options", NULL, NULL);
1157 time_grp = g_option_group_new("time", "Time infos:",
1158 "Show time options", NULL, NULL);
1159 stats_grp = g_option_group_new("stats", "Statistics infos:",
1160 "Show statistics options", NULL, NULL);
1161 output_grp = g_option_group_new("output", "Output format:",
1162 "Show output format options", NULL, NULL);
1163 table_report_grp = g_option_group_new("table", "Table report options:",
1164 "Show table report options", NULL, NULL);
1165 g_option_group_add_entries(general_grp, general_entries);
1166 g_option_group_add_entries(size_grp, size_entries);
1167 g_option_group_add_entries(time_grp, time_entries);
1168 g_option_group_add_entries(stats_grp, stats_entries);
1169 g_option_group_add_entries(output_grp, output_format_entries);
1170 g_option_group_add_entries(table_report_grp, table_report_entries);
1171 g_option_context_add_main_entries(ctx, misc_entries, NULL);
1172 g_option_context_add_group(ctx, general_grp);
1173 g_option_context_add_group(ctx, size_grp);
1174 g_option_context_add_group(ctx, time_grp);
1175 g_option_context_add_group(ctx, stats_grp);
1176 g_option_context_add_group(ctx, output_grp);
1177 g_option_context_add_group(ctx, table_report_grp);
1178 /* There's probably a better way to do this, but this works for now.
1179 GOptions displays the name in argv[0] as the name of the
1180 application. This is reasonable, but because we actually have a
1181 script wrapper that calls the executable. The name that gets
1182 displayed is not exactly the same as the command the user used
1185 argv[0] = (char *)"capinfos";
1187 /* if we have at least one cmdline option, we disable printing all infos */
1188 if (argc > 2 && report_all_infos)
1189 disable_all_infos();
1191 if ( !g_option_context_parse(ctx, &argc, &argv, &parse_err) ) {
1193 g_printerr ("option parsing failed: %s\n", parse_err->message);
1194 g_printerr("%s", g_option_context_get_help (ctx, TRUE, NULL));
1198 g_print("%s", g_option_context_get_help (ctx, FALSE, NULL));
1202 g_printerr("%s", g_option_context_get_help (ctx, FALSE, NULL));
1205 g_option_context_free(ctx);
1207 #endif /* USE_GOPTION */
1208 while ((opt = getopt(argc, argv, "tEcs" FILE_HASH_OPT "dluaeyizvhxokCALTMRrSNqQBmb")) !=-1) {
1213 if (report_all_infos) disable_all_infos();
1214 cap_file_type = TRUE;
1218 if (report_all_infos) disable_all_infos();
1219 cap_file_encap = TRUE;
1223 if (report_all_infos) disable_all_infos();
1228 if (report_all_infos) disable_all_infos();
1229 cap_packet_count = TRUE;
1233 if (report_all_infos) disable_all_infos();
1234 cap_file_size = TRUE;
1238 if (report_all_infos) disable_all_infos();
1239 cap_data_size = TRUE;
1243 if (report_all_infos) disable_all_infos();
1244 cap_duration = TRUE;
1248 if (report_all_infos) disable_all_infos();
1249 cap_start_time = TRUE;
1253 if (report_all_infos) disable_all_infos();
1254 cap_end_time = TRUE;
1258 time_as_secs = TRUE;
1262 if (report_all_infos) disable_all_infos();
1263 cap_data_rate_byte = TRUE;
1267 if (report_all_infos) disable_all_infos();
1268 cap_data_rate_bit = TRUE;
1272 if (report_all_infos) disable_all_infos();
1273 cap_packet_size = TRUE;
1277 if (report_all_infos) disable_all_infos();
1278 cap_packet_rate = TRUE;
1281 #ifdef HAVE_LIBGCRYPT
1283 if (report_all_infos) disable_all_infos();
1284 cap_file_hashes = TRUE;
1289 if (report_all_infos) disable_all_infos();
1294 if (report_all_infos) disable_all_infos();
1299 continue_after_wtap_open_offline_failure = FALSE;
1311 long_report = FALSE;
1315 machine_readable = TRUE;
1319 table_report_header = TRUE;
1323 table_report_header = FALSE;
1339 field_separator = '\t';
1343 field_separator = ',';
1347 field_separator = ' ';
1355 case '?': /* Bad flag - print usage message */
1362 /* Set the C-language locale to the native environment. */
1363 setlocale(LC_ALL, "");
1365 if ((argc - optind) < 1) {
1370 if (!long_report && table_report_header) {
1371 print_stats_table_header();
1374 #ifdef HAVE_LIBGCRYPT
1375 if (cap_file_hashes) {
1376 gcry_check_version(NULL);
1377 gcry_md_open(&hd, GCRY_MD_SHA1, 0);
1379 gcry_md_enable(hd, GCRY_MD_RMD160);
1380 gcry_md_enable(hd, GCRY_MD_MD5);
1382 hash_buf = (char *)g_malloc(HASH_BUF_SIZE);
1386 overall_error_status = 0;
1388 for (opt = optind; opt < argc; opt++) {
1390 #ifdef HAVE_LIBGCRYPT
1391 g_strlcpy(file_sha1, "<unknown>", HASH_STR_SIZE);
1392 g_strlcpy(file_rmd160, "<unknown>", HASH_STR_SIZE);
1393 g_strlcpy(file_md5, "<unknown>", HASH_STR_SIZE);
1395 if (cap_file_hashes) {
1396 fh = ws_fopen(argv[opt], "rb");
1398 while((hash_bytes = fread(hash_buf, 1, HASH_BUF_SIZE, fh)) > 0) {
1399 gcry_md_write(hd, hash_buf, hash_bytes);
1402 hash_to_str(gcry_md_read(hd, GCRY_MD_SHA1), HASH_SIZE_SHA1, file_sha1);
1403 hash_to_str(gcry_md_read(hd, GCRY_MD_RMD160), HASH_SIZE_RMD160, file_rmd160);
1404 hash_to_str(gcry_md_read(hd, GCRY_MD_MD5), HASH_SIZE_MD5, file_md5);
1407 if (hd) gcry_md_reset(hd);
1409 #endif /* HAVE_LIBGCRYPT */
1411 wth = wtap_open_offline(argv[opt], WTAP_TYPE_AUTO, &err, &err_info, FALSE);
1414 fprintf(stderr, "capinfos: Can't open %s: %s\n", argv[opt],
1415 wtap_strerror(err));
1418 case WTAP_ERR_UNSUPPORTED:
1419 case WTAP_ERR_UNSUPPORTED_ENCAP:
1420 case WTAP_ERR_BAD_FILE:
1421 fprintf(stderr, "(%s)\n", err_info);
1425 overall_error_status = 1; /* remember that an error has occurred */
1426 if (!continue_after_wtap_open_offline_failure)
1427 exit(1); /* error status */
1431 if ((opt > optind) && (long_report))
1433 status = process_cap_file(wth, argv[opt]);
1441 return overall_error_status;
1445 * Editor modelines - http://www.wireshark.org/tools/modelines.html
1450 * indent-tabs-mode: nil
1453 * vi: set shiftwidth=2 tabstop=8 expandtab:
1454 * :indentSize=2:tabSize=8:noTabs=true: