wireshark/tshark.c

4655 lines
177 KiB
C

/* tshark.c
*
* Text-mode variant of Wireshark, along the lines of tcpdump and snoop,
* by Gilbert Ramirez <gram@alumni.rice.edu> and Guy Harris <guy@alum.mit.edu>.
*
* Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org>
* Copyright 1998 Gerald Combs
*
* SPDX-License-Identifier: GPL-2.0-or-later
*/
#include <config.h>
#define WS_LOG_DOMAIN LOG_DOMAIN_MAIN
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <locale.h>
#include <limits.h>
#include <wsutil/ws_getopt.h>
#include <errno.h>
#ifdef _WIN32
# include <winsock2.h>
#endif
#ifndef _WIN32
#include <signal.h>
#endif
#include <glib.h>
#include <epan/exceptions.h>
#include <epan/epan.h>
#include <ws_exit_codes.h>
#include <wsutil/clopts_common.h>
#include <wsutil/cmdarg_err.h>
#include <ui/urls.h>
#include <wsutil/filesystem.h>
#include <wsutil/file_util.h>
#include <wsutil/socket.h>
#include <wsutil/privileges.h>
#include <wsutil/report_message.h>
#include <wsutil/please_report_bug.h>
#include <wsutil/wslog.h>
#include <wsutil/ws_assert.h>
#include <wsutil/strtoi.h>
#include <cli_main.h>
#include <wsutil/version_info.h>
#include <wiretap/wtap_opttypes.h>
#include "globals.h"
#include <epan/timestamp.h>
#include <epan/packet.h>
#ifdef HAVE_LUA
#include <epan/wslua/init_wslua.h>
#endif
#include "frame_tvbuff.h"
#include <epan/disabled_protos.h>
#include <epan/prefs.h>
#include <epan/column.h>
#include <epan/decode_as.h>
#include <epan/print.h>
#include <epan/addr_resolv.h>
#ifdef HAVE_LIBPCAP
#include "ui/capture_ui_utils.h"
#endif
#include "ui/taps.h"
#include "ui/util.h"
#include "ui/ws_ui_util.h"
#include "ui/decode_as_utils.h"
#include "wsutil/filter_files.h"
#include "ui/cli/tshark-tap.h"
#include "ui/cli/tap-exportobject.h"
#include "ui/tap_export_pdu.h"
#include "ui/dissect_opts.h"
#include "ui/ssl_key_export.h"
#include "ui/failure_message.h"
#if defined(HAVE_LIBSMI)
#include "epan/oids.h"
#endif
#include "epan/maxmind_db.h"
#include <epan/epan_dissect.h>
#include <epan/tap.h>
#include <epan/stat_tap_ui.h>
#include <epan/conversation_table.h>
#include <epan/srt_table.h>
#include <epan/rtd_table.h>
#include <epan/ex-opt.h>
#include <epan/exported_pdu.h>
#include <epan/secrets.h>
#include "capture_opts.h"
#include "capture/capture-pcap-util.h"
#ifdef HAVE_LIBPCAP
#include "capture/capture_ifinfo.h"
#ifdef _WIN32
#include "capture/capture-wpcap.h"
#endif /* _WIN32 */
#include <capture/capture_session.h>
#include <capture/capture_sync.h>
#include <ui/capture_info.h>
#endif /* HAVE_LIBPCAP */
#include <epan/funnel.h>
#include <wsutil/str_util.h>
#include <wsutil/utf8_entities.h>
#include <wsutil/json_dumper.h>
#include <wsutil/wslog.h>
#ifdef _WIN32
#include <wsutil/win32-utils.h>
#endif
#include "extcap.h"
#ifdef HAVE_PLUGINS
#include <wsutil/codecs.h>
#include <wsutil/plugins.h>
#endif
/* Additional exit codes */
#define INVALID_EXPORT 2
#define INVALID_TAP 2
#define INVALID_CAPTURE 2
#define LONGOPT_EXPORT_OBJECTS LONGOPT_BASE_APPLICATION+1
#define LONGOPT_COLOR LONGOPT_BASE_APPLICATION+2
#define LONGOPT_NO_DUPLICATE_KEYS LONGOPT_BASE_APPLICATION+3
#define LONGOPT_ELASTIC_MAPPING_FILTER LONGOPT_BASE_APPLICATION+4
#define LONGOPT_EXPORT_TLS_SESSION_KEYS LONGOPT_BASE_APPLICATION+5
#define LONGOPT_CAPTURE_COMMENT LONGOPT_BASE_APPLICATION+6
#define LONGOPT_HEXDUMP LONGOPT_BASE_APPLICATION+7
#define LONGOPT_SELECTED_FRAME LONGOPT_BASE_APPLICATION+8
capture_file cfile;
static guint32 cum_bytes;
static frame_data ref_frame;
static frame_data prev_dis_frame;
static frame_data prev_cap_frame;
static gboolean perform_two_pass_analysis;
static guint32 epan_auto_reset_count = 0;
static gboolean epan_auto_reset = FALSE;
static guint32 selected_frame_number = 0;
/*
* The way the packet decode is to be written.
*/
typedef enum {
WRITE_NONE, /* dummy initial state */
WRITE_TEXT, /* summary or detail text */
WRITE_XML, /* PDML or PSML */
WRITE_FIELDS, /* User defined list of fields */
WRITE_JSON, /* JSON */
WRITE_JSON_RAW, /* JSON only raw hex */
WRITE_EK /* JSON bulk insert to Elasticsearch */
/* Add CSV and the like here */
} output_action_e;
static output_action_e output_action;
static gboolean do_dissection; /* TRUE if we have to dissect each packet */
static gboolean print_packet_info; /* TRUE if we're to print packet information */
static gboolean print_summary; /* TRUE if we're to print packet summary information */
static gboolean print_details; /* TRUE if we're to print packet details information */
static gboolean print_hex; /* TRUE if we're to print hex/ascii information */
static gboolean line_buffered;
static gboolean quiet = FALSE;
static gboolean really_quiet = FALSE;
static gchar* delimiter_char = " ";
static gboolean dissect_color = FALSE;
static guint hexdump_source_option = HEXDUMP_SOURCE_MULTI; /* Default - Enable legacy multi-source mode */
static guint hexdump_ascii_option = HEXDUMP_ASCII_INCLUDE; /* Default - Enable legacy undelimited ASCII dump */
static print_format_e print_format = PR_FMT_TEXT;
static print_stream_t *print_stream = NULL;
static char *output_file_name;
static output_fields_t* output_fields = NULL;
static wmem_map_t *protocolfilter = NULL;
static gboolean no_duplicate_keys = FALSE;
static proto_node_children_grouper_func node_children_grouper = proto_node_group_children_by_unique;
static json_dumper jdumper;
/* The line separator used between packets, changeable via the -S option */
static const char *separator = "";
/* Per-file comments to be added to the output file. */
static GPtrArray *capture_comments = NULL;
static gboolean prefs_loaded = FALSE;
#ifdef HAVE_LIBPCAP
/*
* TRUE if we're to print packet counts to keep track of captured packets.
*/
static gboolean print_packet_counts;
static capture_options global_capture_opts;
static capture_session global_capture_session;
static info_data_t global_info_data;
#ifdef SIGINFO
static gboolean infodelay; /* if TRUE, don't print capture info in SIGINFO handler */
static gboolean infoprint; /* if TRUE, print capture info after clearing infodelay */
#endif /* SIGINFO */
static gboolean capture(void);
static gboolean capture_input_new_file(capture_session *cap_session,
gchar *new_file);
static void capture_input_new_packets(capture_session *cap_session,
int to_read);
static void capture_input_drops(capture_session *cap_session, guint32 dropped,
const char* interface_name);
static void capture_input_error(capture_session *cap_session,
char *error_msg, char *secondary_error_msg);
static void capture_input_cfilter_error(capture_session *cap_session,
guint i, const char *error_message);
static void capture_input_closed(capture_session *cap_session, gchar *msg);
static void report_counts(void);
#ifdef _WIN32
static BOOL WINAPI capture_cleanup(DWORD);
#else /* _WIN32 */
static void capture_cleanup(int);
#ifdef SIGINFO
static void report_counts_siginfo(int);
#endif /* SIGINFO */
#endif /* _WIN32 */
#endif /* HAVE_LIBPCAP */
static void reset_epan_mem(capture_file *cf, epan_dissect_t *edt, gboolean tree, gboolean visual);
typedef enum {
PROCESS_FILE_SUCCEEDED,
PROCESS_FILE_NO_FILE_PROCESSED,
PROCESS_FILE_ERROR,
PROCESS_FILE_INTERRUPTED
} process_file_status_t;
static process_file_status_t process_cap_file(capture_file *, char *, int, gboolean, int, gint64, int);
static gboolean process_packet_single_pass(capture_file *cf,
epan_dissect_t *edt, gint64 offset, wtap_rec *rec, Buffer *buf,
guint tap_flags);
static void show_print_file_io_error(void);
static gboolean write_preamble(capture_file *cf);
static gboolean print_packet(capture_file *cf, epan_dissect_t *edt);
static gboolean write_finale(void);
static void tshark_cmdarg_err(const char *msg_format, va_list ap);
static void tshark_cmdarg_err_cont(const char *msg_format, va_list ap);
static GHashTable *output_only_tables = NULL;
static void
list_capture_types(void)
{
GArray *writable_type_subtypes;
fprintf(stderr, "tshark: The available capture file types for the \"-F\" flag are:\n");
writable_type_subtypes = wtap_get_writable_file_types_subtypes(FT_SORT_BY_NAME);
for (guint i = 0; i < writable_type_subtypes->len; i++) {
int ft = g_array_index(writable_type_subtypes, int, i);
fprintf(stderr, " %s - %s\n", wtap_file_type_subtype_name(ft),
wtap_file_type_subtype_description(ft));
}
g_array_free(writable_type_subtypes, TRUE);
}
struct string_elem {
const char *sstr; /* The short string */
const char *lstr; /* The long string */
};
static gint
string_compare(gconstpointer a, gconstpointer b)
{
return strcmp(((const struct string_elem *)a)->sstr,
((const struct string_elem *)b)->sstr);
}
static void
string_elem_print(gpointer data)
{
fprintf(stderr, " %s - %s\n",
((struct string_elem *)data)->sstr,
((struct string_elem *)data)->lstr);
}
static void
list_read_capture_types(void)
{
guint i;
size_t num_file_types;
struct string_elem *captypes;
GSList *list = NULL;
const char *magic = "Magic-value-based";
const char *heuristic = "Heuristics-based";
/* How many readable file types are there? */
num_file_types = 0;
for (i = 0; open_routines[i].name != NULL; i++)
num_file_types++;
captypes = g_new(struct string_elem, num_file_types);
fprintf(stderr, "tshark: The available read file types for the \"-X read_format:\" option are:\n");
for (i = 0; i < num_file_types && open_routines[i].name != NULL; i++) {
captypes[i].sstr = open_routines[i].name;
captypes[i].lstr = (open_routines[i].type == OPEN_INFO_MAGIC) ? magic : heuristic;
list = g_slist_insert_sorted(list, &captypes[i], string_compare);
}
g_slist_free_full(list, string_elem_print);
g_free(captypes);
}
static void
list_export_pdu_taps(void)
{
fprintf(stderr, "tshark: The available export tap names and the encapsulation types they produce for the \"-U tap_name\" option are:\n");
for (GSList *export_pdu_tap_name_list = get_export_pdu_tap_list();
export_pdu_tap_name_list != NULL;
export_pdu_tap_name_list = g_slist_next(export_pdu_tap_name_list)) {
fprintf(stderr, " %s - %s\n", (const char*)(export_pdu_tap_name_list->data), wtap_encap_description(export_pdu_tap_get_encap((const char*)export_pdu_tap_name_list->data)));
}
}
static void
print_usage(FILE *output)
{
fprintf(output, "\n");
fprintf(output, "Usage: tshark [options] ...\n");
fprintf(output, "\n");
#ifdef HAVE_LIBPCAP
fprintf(output, "Capture interface:\n");
fprintf(output, " -i <interface>, --interface <interface>\n");
fprintf(output, " name or idx of interface (def: first non-loopback)\n");
fprintf(output, " -f <capture filter> packet filter in libpcap filter syntax\n");
fprintf(output, " -s <snaplen>, --snapshot-length <snaplen>\n");
#ifdef HAVE_PCAP_CREATE
fprintf(output, " packet snapshot length (def: appropriate maximum)\n");
#else
fprintf(output, " packet snapshot length (def: %u)\n", WTAP_MAX_PACKET_SIZE_STANDARD);
#endif
fprintf(output, " -p, --no-promiscuous-mode\n");
fprintf(output, " don't capture in promiscuous mode\n");
#ifdef HAVE_PCAP_CREATE
fprintf(output, " -I, --monitor-mode capture in monitor mode, if available\n");
#endif
#ifdef CAN_SET_CAPTURE_BUFFER_SIZE
fprintf(output, " -B <buffer size>, --buffer-size <buffer size>\n");
fprintf(output, " size of kernel buffer (def: %dMB)\n", DEFAULT_CAPTURE_BUFFER_SIZE);
#endif
fprintf(output, " -y <link type>, --linktype <link type>\n");
fprintf(output, " link layer type (def: first appropriate)\n");
fprintf(output, " --time-stamp-type <type> timestamp method for interface\n");
fprintf(output, " -D, --list-interfaces print list of interfaces and exit\n");
fprintf(output, " -L, --list-data-link-types\n");
fprintf(output, " print list of link-layer types of iface and exit\n");
fprintf(output, " --list-time-stamp-types print list of timestamp types for iface and exit\n");
fprintf(output, "\n");
fprintf(output, "Capture stop conditions:\n");
fprintf(output, " -c <packet count> stop after n packets (def: infinite)\n");
fprintf(output, " -a <autostop cond.> ..., --autostop <autostop cond.> ...\n");
fprintf(output, " duration:NUM - stop after NUM seconds\n");
fprintf(output, " filesize:NUM - stop this file after NUM KB\n");
fprintf(output, " files:NUM - stop after NUM files\n");
fprintf(output, " packets:NUM - stop after NUM packets\n");
/*fprintf(output, "\n");*/
fprintf(output, "Capture output:\n");
fprintf(output, " -b <ringbuffer opt.> ..., --ring-buffer <ringbuffer opt.>\n");
fprintf(output, " duration:NUM - switch to next file after NUM secs\n");
fprintf(output, " filesize:NUM - switch to next file after NUM KB\n");
fprintf(output, " files:NUM - ringbuffer: replace after NUM files\n");
fprintf(output, " packets:NUM - switch to next file after NUM packets\n");
fprintf(output, " interval:NUM - switch to next file when the time is\n");
fprintf(output, " an exact multiple of NUM secs\n");
#endif /* HAVE_LIBPCAP */
#ifdef HAVE_PCAP_REMOTE
fprintf(output, "RPCAP options:\n");
fprintf(output, " -A <user>:<password> use RPCAP password authentication\n");
#endif
/*fprintf(output, "\n");*/
fprintf(output, "Input file:\n");
fprintf(output, " -r <infile>, --read-file <infile>\n");
fprintf(output, " set the filename to read from (or '-' for stdin)\n");
fprintf(output, "\n");
fprintf(output, "Processing:\n");
fprintf(output, " -2 perform a two-pass analysis\n");
fprintf(output, " -M <packet count> perform session auto reset\n");
fprintf(output, " -R <read filter>, --read-filter <read filter>\n");
fprintf(output, " packet Read filter in Wireshark display filter syntax\n");
fprintf(output, " (requires -2)\n");
fprintf(output, " -Y <display filter>, --display-filter <display filter>\n");
fprintf(output, " packet displaY filter in Wireshark display filter\n");
fprintf(output, " syntax\n");
fprintf(output, " -n disable all name resolutions (def: \"mNd\" enabled, or\n");
fprintf(output, " as set in preferences)\n");
fprintf(output, " -N <name resolve flags> enable specific name resolution(s): \"mnNtdv\"\n");
fprintf(output, " -d %s ...\n", DECODE_AS_ARG_TEMPLATE);
fprintf(output, " \"Decode As\", see the man page for details\n");
fprintf(output, " Example: tcp.port==8888,http\n");
fprintf(output, " -H <hosts file> read a list of entries from a hosts file, which will\n");
fprintf(output, " then be written to a capture file. (Implies -W n)\n");
fprintf(output, " --enable-protocol <proto_name>\n");
fprintf(output, " enable dissection of proto_name\n");
fprintf(output, " --disable-protocol <proto_name>\n");
fprintf(output, " disable dissection of proto_name\n");
fprintf(output, " --enable-heuristic <short_name>\n");
fprintf(output, " enable dissection of heuristic protocol\n");
fprintf(output, " --disable-heuristic <short_name>\n");
fprintf(output, " disable dissection of heuristic protocol\n");
/*fprintf(output, "\n");*/
fprintf(output, "Output:\n");
fprintf(output, " -w <outfile|-> write packets to a pcapng-format file named \"outfile\"\n");
fprintf(output, " (or '-' for stdout)\n");
fprintf(output, " --capture-comment <comment>\n");
fprintf(output, " add a capture file comment, if supported\n");
fprintf(output, " -C <config profile> start with specified configuration profile\n");
fprintf(output, " -F <output file type> set the output file type, default is pcapng\n");
fprintf(output, " an empty \"-F\" option will list the file types\n");
fprintf(output, " -V add output of packet tree (Packet Details)\n");
fprintf(output, " -O <protocols> Only show packet details of these protocols, comma\n");
fprintf(output, " separated\n");
fprintf(output, " -P, --print print packet summary even when writing to a file\n");
fprintf(output, " -S <separator> the line separator to print between packets\n");
fprintf(output, " -x add output of hex and ASCII dump (Packet Bytes)\n");
fprintf(output, " --hexdump <hexoption> add hexdump, set options for data source and ASCII dump\n");
fprintf(output, " all dump all data sources (-x default)\n");
fprintf(output, " frames dump only frame data source\n");
fprintf(output, " ascii include ASCII dump text (-x default)\n");
fprintf(output, " delimit delimit ASCII dump text with '|' characters\n");
fprintf(output, " noascii exclude ASCII dump text\n");
fprintf(output, " help display help for --hexdump and exit\n");
fprintf(output, " -T pdml|ps|psml|json|jsonraw|ek|tabs|text|fields|?\n");
fprintf(output, " format of text output (def: text)\n");
fprintf(output, " -j <protocolfilter> protocols layers filter if -T ek|pdml|json selected\n");
fprintf(output, " (e.g. \"ip ip.flags text\", filter does not expand child\n");
fprintf(output, " nodes, unless child is specified also in the filter)\n");
fprintf(output, " -J <protocolfilter> top level protocol filter if -T ek|pdml|json selected\n");
fprintf(output, " (e.g. \"http tcp\", filter which expands all child nodes)\n");
fprintf(output, " -e <field> field to print if -Tfields selected (e.g. tcp.port,\n");
fprintf(output, " _ws.col.Info)\n");
fprintf(output, " this option can be repeated to print multiple fields\n");
fprintf(output, " -E<fieldsoption>=<value> set options for output when -Tfields selected:\n");
fprintf(output, " bom=y|n print a UTF-8 BOM\n");
fprintf(output, " header=y|n switch headers on and off\n");
fprintf(output, " separator=/t|/s|<char> select tab, space, printable character as separator\n");
fprintf(output, " occurrence=f|l|a print first, last or all occurrences of each field\n");
fprintf(output, " aggregator=,|/s|<char> select comma, space, printable character as\n");
fprintf(output, " aggregator\n");
fprintf(output, " quote=d|s|n select double, single, no quotes for values\n");
fprintf(output, " -t a|ad|adoy|d|dd|e|r|u|ud|udoy\n");
fprintf(output, " output format of time stamps (def: r: rel. to first)\n");
fprintf(output, " -u s|hms output format of seconds (def: s: seconds)\n");
fprintf(output, " -l flush standard output after each packet\n");
fprintf(output, " -q be more quiet on stdout (e.g. when using statistics)\n");
fprintf(output, " -Q only log true errors to stderr (quieter than -q)\n");
fprintf(output, " -g enable group read access on the output file(s)\n");
fprintf(output, " -W n Save extra information in the file, if supported.\n");
fprintf(output, " n = write network address resolution information\n");
fprintf(output, " -X <key>:<value> eXtension options, see the man page for details\n");
fprintf(output, " -U tap_name PDUs export mode, see the man page for details\n");
fprintf(output, " -z <statistics> various statistics, see the man page for details\n");
fprintf(output, " --export-objects <protocol>,<destdir>\n");
fprintf(output, " save exported objects for a protocol to a directory\n");
fprintf(output, " named \"destdir\"\n");
fprintf(output, " --export-tls-session-keys <keyfile>\n");
fprintf(output, " export TLS Session Keys to a file named \"keyfile\"\n");
fprintf(output, " --color color output text similarly to the Wireshark GUI,\n");
fprintf(output, " requires a terminal with 24-bit color support\n");
fprintf(output, " Also supplies color attributes to pdml and psml formats\n");
fprintf(output, " (Note that attributes are nonstandard)\n");
fprintf(output, " --no-duplicate-keys If -T json is specified, merge duplicate keys in an object\n");
fprintf(output, " into a single key with as value a json array containing all\n");
fprintf(output, " values\n");
fprintf(output, " --elastic-mapping-filter <protocols> If -G elastic-mapping is specified, put only the\n");
fprintf(output, " specified protocols within the mapping file\n");
fprintf(output, " --temp-dir <directory> write temporary files to this directory\n");
fprintf(output, " (default: %s)\n", g_get_tmp_dir());
fprintf(output, "\n");
ws_log_print_usage(output);
fprintf(output, "\n");
fprintf(output, "Miscellaneous:\n");
fprintf(output, " -h, --help display this help and exit\n");
fprintf(output, " -v, --version display version info and exit\n");
fprintf(output, " -o <name>:<value> ... override preference setting\n");
fprintf(output, " -K <keytab> keytab file to use for kerberos decryption\n");
fprintf(output, " -G [report] dump one of several available reports and exit\n");
fprintf(output, " default report=\"fields\"\n");
fprintf(output, " use \"-G help\" for more help\n");
#ifdef __linux__
fprintf(output, "\n");
fprintf(output, "Dumpcap can benefit from an enabled BPF JIT compiler if available.\n");
fprintf(output, "You might want to enable it by executing:\n");
fprintf(output, " \"echo 1 > /proc/sys/net/core/bpf_jit_enable\"\n");
fprintf(output, "Note that this can make your system less secure!\n");
#endif
}
static void
glossary_option_help(void)
{
FILE *output;
output = stdout;
fprintf(output, "%s\n", get_appname_and_version());
fprintf(output, "\n");
fprintf(output, "Usage: tshark -G [report]\n");
fprintf(output, "\n");
fprintf(output, "Glossary table reports:\n");
fprintf(output, " -G column-formats dump column format codes and exit\n");
fprintf(output, " -G decodes dump \"layer type\"/\"decode as\" associations and exit\n");
fprintf(output, " -G dissector-tables dump dissector table names, types, and properties\n");
fprintf(output, " -G elastic-mapping dump ElasticSearch mapping file\n");
fprintf(output, " -G fieldcount dump count of header fields and exit\n");
fprintf(output, " -G fields dump fields glossary and exit\n");
fprintf(output, " -G ftypes dump field type basic and descriptive names\n");
fprintf(output, " -G heuristic-decodes dump heuristic dissector tables\n");
fprintf(output, " -G plugins dump installed plugins and exit\n");
fprintf(output, " -G protocols dump protocols in registration database and exit\n");
fprintf(output, " -G values dump value, range, true/false strings and exit\n");
fprintf(output, "\n");
fprintf(output, "Preference reports:\n");
fprintf(output, " -G currentprefs dump current preferences and exit\n");
fprintf(output, " -G defaultprefs dump default preferences and exit\n");
fprintf(output, " -G folders dump about:folders\n");
fprintf(output, "\n");
}
static void
hexdump_option_help(FILE *output)
{
fprintf(output, "%s\n", get_appname_and_version());
fprintf(output, "\n");
fprintf(output, "tshark: Valid --hexdump <hexoption> values include:\n");
fprintf(output, "\n");
fprintf(output, "Data source options:\n");
fprintf(output, " all add hexdump, dump all data sources (-x default)\n");
fprintf(output, " frames add hexdump, dump only frame data source\n");
fprintf(output, "\n");
fprintf(output, "ASCII options:\n");
fprintf(output, " ascii add hexdump, include ASCII dump text (-x default)\n");
fprintf(output, " delimit add hexdump, delimit ASCII dump text with '|' characters\n");
fprintf(output, " noascii add hexdump, exclude ASCII dump text\n");
fprintf(output, "\n");
fprintf(output, "Miscellaneous:\n");
fprintf(output, " help display this help and exit\n");
fprintf(output, "\n");
fprintf(output, "Example:\n");
fprintf(output, "\n");
fprintf(output, " $ tshark ... --hexdump frames --hexdump delimit ...\n");
fprintf(output, "\n");
}
static void
protocolfilter_add_opt(const char* arg, pf_flags filter_flags)
{
void* value;
gchar **newfilter = NULL;
for (newfilter = wmem_strsplit(wmem_epan_scope(), arg, " ", -1); *newfilter; newfilter++) {
if (strcmp(*newfilter, "") == 0) {
/* Don't treat the empty string as an intended field abbreviation
* to output, consecutive spaces on the command line probably
* aren't intentional.
*/
continue;
}
if (!protocolfilter) {
protocolfilter = wmem_map_new(wmem_epan_scope(), wmem_str_hash, g_str_equal);
}
if (wmem_map_lookup_extended(protocolfilter, *newfilter, NULL, &value)) {
if (GPOINTER_TO_UINT(value) != (guint)filter_flags) {
cmdarg_err("%s was already specified with different filter flags. Overwriting previous protocol filter.", *newfilter);
}
}
wmem_map_insert(protocolfilter, *newfilter, GINT_TO_POINTER(filter_flags));
}
}
static void
print_current_user(void)
{
gchar *cur_user, *cur_group;
if (started_with_special_privs()) {
cur_user = get_cur_username();
cur_group = get_cur_groupname();
fprintf(stderr, "Running as user \"%s\" and group \"%s\".",
cur_user, cur_group);
g_free(cur_user);
g_free(cur_group);
if (running_with_special_privs()) {
fprintf(stderr, " This could be dangerous.");
}
fprintf(stderr, "\n");
}
}
static void
gather_tshark_compile_info(feature_list l)
{
/* Capture libraries */
gather_caplibs_compile_info(l);
epan_gather_compile_info(l);
}
static void
gather_tshark_runtime_info(feature_list l)
{
#ifdef HAVE_LIBPCAP
gather_caplibs_runtime_info(l);
#endif
/* stuff used by libwireshark */
epan_gather_runtime_info(l);
}
static gboolean
_compile_dfilter(const char *text, dfilter_t **dfp, const char *caller)
{
gboolean ok;
char *err_msg = NULL;
df_error_t *df_err;
char *err_off;
char *expanded;
expanded = dfilter_expand(text, &err_msg);
if (expanded == NULL) {
cmdarg_err("%s", err_msg);
g_free(err_msg);
return FALSE;
}
ok = dfilter_compile_real(expanded, dfp, &df_err, DF_OPTIMIZE, caller);
if (!ok ) {
cmdarg_err("%s", df_err->msg);
if (df_err->loc.col_start >= 0) {
err_off = ws_strdup_underline(NULL, df_err->loc.col_start, df_err->loc.col_len);
cmdarg_err_cont(" %s", expanded);
cmdarg_err_cont(" %s", err_off);
g_free(err_off);
}
dfilter_error_free(df_err);
}
g_free(expanded);
return ok;
}
#define compile_dfilter(text, dfp) _compile_dfilter(text, dfp, __func__)
static void
about_folders(void)
{
const char *constpath;
char *path;
gint i;
gchar **resultArray;
/* "file open" */
/*
* Fetching the "File" dialogs folder not implemented.
* This is arguably just a pwd for a ui/cli .
*/
/* temp */
constpath = g_get_tmp_dir();
#ifdef HAVE_LIBPCAP
/* global_capture_opts only exists in this case */
if (global_capture_opts.temp_dir)
constpath = global_capture_opts.temp_dir;
#endif
printf("%-21s\t%s\n", "Temp:", constpath);
/* pers conf */
path = get_persconffile_path("", FALSE);
printf("%-21s\t%s\n", "Personal configuration:", path);
g_free(path);
/* global conf */
constpath = get_datafile_dir();
if (constpath != NULL) {
printf("%-21s\t%s\n", "Global configuration:", constpath);
}
/* system */
constpath = get_systemfile_dir();
printf("%-21s\t%s\n", "System:", constpath);
/* program */
constpath = get_progfile_dir();
printf("%-21s\t%s\n", "Program:", constpath);
#ifdef HAVE_PLUGINS
/* pers plugins */
printf("%-21s\t%s\n", "Personal Plugins:", get_plugins_pers_dir_with_version());
/* global plugins */
printf("%-21s\t%s\n", "Global Plugins:", get_plugins_dir_with_version());
#endif
#ifdef HAVE_LUA
/* pers lua plugins */
printf("%-21s\t%s\n", "Personal Lua Plugins:", get_plugins_pers_dir());
/* global lua plugins */
printf("%-21s\t%s\n", "Global Lua Plugins:", get_plugins_dir());
#endif
/* Extcap */
constpath = get_extcap_dir();
resultArray = g_strsplit(constpath, G_SEARCHPATH_SEPARATOR_S, 10);
for(i = 0; resultArray[i]; i++)
printf("%-21s\t%s\n", "Extcap path:", g_strstrip(resultArray[i]));
g_strfreev(resultArray);
/* MaxMindDB */
path = maxmind_db_get_paths();
resultArray = g_strsplit(path, G_SEARCHPATH_SEPARATOR_S, 10);
for(i = 0; resultArray[i]; i++)
printf("%-21s\t%s\n", "MaxMind database path:", g_strstrip(resultArray[i]));
g_strfreev(resultArray);
g_free(path);
#ifdef HAVE_LIBSMI
/* SMI MIBs/PIBs */
path = oid_get_default_mib_path();
resultArray = g_strsplit(path, G_SEARCHPATH_SEPARATOR_S, 20);
for(i = 0; resultArray[i]; i++)
printf("%-21s\t%s\n", "MIB/PIB path:", g_strstrip(resultArray[i]));
g_strfreev(resultArray);
g_free(path);
#endif
}
static gboolean
must_do_dissection(dfilter_t *rfcode, dfilter_t *dfcode,
gchar *volatile pdu_export_arg)
{
/* We have to dissect each packet if:
we're printing information about each packet;
we're using a read filter on the packets;
we're using a display filter on the packets;
we're exporting PDUs;
we're using any taps that need dissection. */
return print_packet_info || rfcode || dfcode || pdu_export_arg ||
tap_listeners_require_dissection() || dissect_color;
}
#ifdef HAVE_LIBPCAP
/*
* Check whether a purported *shark packet-matching expression (display
* or read filter) looks like a capture filter and, if so, print a
* warning.
*
* Used, for example, if the string in question isn't a valid packet-
* matching expression.
*/
static void
warn_about_capture_filter(const char *rfilter)
{
struct bpf_program fcode;
pcap_t *pc;
pc = pcap_open_dead(DLT_EN10MB, MIN_PACKET_SIZE);
if (pc != NULL) {
if (pcap_compile(pc, &fcode, rfilter, 0, 0) != -1) {
pcap_freecode(&fcode);
cmdarg_err_cont(
" Note: That read filter code looks like a valid capture filter;\n"
" maybe you mixed them up?");
}
pcap_close(pc);
}
}
#endif
int
main(int argc, char *argv[])
{
char *err_msg;
static const struct report_message_routines tshark_report_routines = {
failure_message,
failure_message,
open_failure_message,
read_failure_message,
write_failure_message,
cfile_open_failure_message,
cfile_dump_open_failure_message,
cfile_read_failure_message,
cfile_write_failure_message,
cfile_close_failure_message
};
int opt;
static const struct ws_option long_options[] = {
{"help", ws_no_argument, NULL, 'h'},
{"version", ws_no_argument, NULL, 'v'},
LONGOPT_CAPTURE_COMMON
LONGOPT_DISSECT_COMMON
{"print", ws_no_argument, NULL, 'P'},
{"export-objects", ws_required_argument, NULL, LONGOPT_EXPORT_OBJECTS},
{"export-tls-session-keys", ws_required_argument, NULL, LONGOPT_EXPORT_TLS_SESSION_KEYS},
{"color", ws_no_argument, NULL, LONGOPT_COLOR},
{"no-duplicate-keys", ws_no_argument, NULL, LONGOPT_NO_DUPLICATE_KEYS},
{"elastic-mapping-filter", ws_required_argument, NULL, LONGOPT_ELASTIC_MAPPING_FILTER},
{"capture-comment", ws_required_argument, NULL, LONGOPT_CAPTURE_COMMENT},
{"hexdump", ws_required_argument, NULL, LONGOPT_HEXDUMP},
{"selected-frame", ws_required_argument, NULL, LONGOPT_SELECTED_FRAME},
{0, 0, 0, 0}
};
gboolean arg_error = FALSE;
gboolean has_extcap_options = FALSE;
int err;
gchar *err_info;
gboolean exp_pdu_status;
volatile process_file_status_t status;
volatile gboolean draw_taps = FALSE;
volatile int exit_status = EXIT_SUCCESS;
#ifdef HAVE_LIBPCAP
int caps_queries = 0;
GList *if_list;
gchar *err_str, *err_str_secondary;
#else
gboolean capture_option_specified = FALSE;
volatile int max_packet_count = 0;
#endif
volatile int out_file_type = WTAP_FILE_TYPE_SUBTYPE_UNKNOWN;
volatile gboolean out_file_name_res = FALSE;
volatile int in_file_type = WTAP_TYPE_AUTO;
gchar *volatile cf_name = NULL;
gchar *rfilter = NULL;
gchar *volatile dfilter = NULL;
dfilter_t *rfcode = NULL;
dfilter_t *dfcode = NULL;
e_prefs *prefs_p;
gchar *output_only = NULL;
gchar *volatile pdu_export_arg = NULL;
char *volatile exp_pdu_filename = NULL;
const gchar *volatile tls_session_keys_file = NULL;
exp_pdu_t exp_pdu_tap_data;
const gchar* elastic_mapping_filter = NULL;
const char *endptr;
/*
* The leading + ensures that getopt_long() does not permute the argv[]
* entries.
*
* We have to make sure that the first getopt_long() preserves the content
* of argv[] for the subsequent getopt_long() call.
*
* We use getopt_long() in both cases to ensure that we're using a routine
* whose permutation behavior we can control in the same fashion on all
* platforms, and so that, if we ever need to process a long argument before
* doing further initialization, we can do so.
*
* Glibc and Solaris libc document that a leading + disables permutation
* of options, regardless of whether POSIXLY_CORRECT is set or not; *BSD
* and macOS don't document it, but do so anyway.
*
* We do *not* use a leading - because the behavior of a leading - is
* platform-dependent.
*/
#define OPTSTRING "+2" OPTSTRING_CAPTURE_COMMON OPTSTRING_DISSECT_COMMON "M:C:e:E:F:gG:hH:j:J:lo:O:PqQr:R:S:T:U:vVw:W:xX:Y:z:"
static const char optstring[] = OPTSTRING;
/*
* Set the C-language locale to the native environment and set the
* code page to UTF-8 on Windows.
*/
#ifdef _WIN32
setlocale(LC_ALL, ".UTF-8");
#else
setlocale(LC_ALL, "");
#endif
cmdarg_err_init(tshark_cmdarg_err, tshark_cmdarg_err_cont);
/* Initialize log handler early so we can have proper logging during startup. */
ws_log_init("tshark", vcmdarg_err);
/* Early logging command-line initialization. */
ws_log_parse_args(&argc, argv, vcmdarg_err, WS_EXIT_INVALID_OPTION);
ws_noisy("Finished log init and parsing command line log arguments");
ws_debug("tshark started with %d args", argc);
#ifdef _WIN32
create_app_running_mutex();
#endif /* _WIN32 */
/*
* Get credential information for later use, and drop privileges
* before doing anything else.
* Let the user know if anything happened.
*/
init_process_policies();
relinquish_special_privs_perm();
print_current_user();
/*
* Attempt to get the pathname of the directory containing the
* executable file.
*/
err_msg = configuration_init(argv[0], NULL);
if (err_msg != NULL) {
fprintf(stderr,
"tshark: Can't get pathname of directory containing the tshark program: %s.\n"
"It won't be possible to capture traffic.\n"
"Report this to the Wireshark developers.",
err_msg);
g_free(err_msg);
}
initialize_funnel_ops();
#ifdef _WIN32
ws_init_dll_search_path();
#ifdef HAVE_LIBPCAP
/* Load wpcap if possible. Do this before collecting the run-time version information */
load_wpcap();
#endif /* HAVE_LIBPCAP */
#endif /* _WIN32 */
/* Initialize the version information. */
ws_init_version_info("TShark",
gather_tshark_compile_info, gather_tshark_runtime_info);
/* Fail sometimes. Useful for testing fuzz scripts. */
/* if (g_random_int_range(0, 100) < 5) abort(); */
/*
* In order to have the -X opts assigned before the wslua machine starts
* we need to call getopt_long before epan_init() gets called.
*
* In order to handle, for example, -o options, we also need to call it
* *after* epan_init() gets called, so that the dissectors have had a
* chance to register their preferences.
*
* Spawning a bunch of extcap processes can delay program startup,
* particularly on Windows. Check to see if we have any options that
* might require extcap and set has_extcap_options = TRUE if that's
* the case.
*
* XXX - can we do this all with one getopt_long() call, saving the
* arguments we can't handle until after initializing libwireshark,
* and then process them after initializing libwireshark?
*/
ws_opterr = 0;
while ((opt = ws_getopt_long(argc, argv, optstring, long_options, NULL)) != -1) {
switch (opt) {
case 'C': /* Configuration Profile */
if (profile_exists (ws_optarg, FALSE)) {
set_profile_name (ws_optarg);
} else if (profile_exists (ws_optarg, TRUE)) {
char *pf_dir_path, *pf_dir_path2, *pf_filename;
/* Copy from global profile */
if (create_persconffile_profile(ws_optarg, &pf_dir_path) == -1) {
cmdarg_err("Can't create directory\n\"%s\":\n%s.",
pf_dir_path, g_strerror(errno));
g_free(pf_dir_path);
exit_status = WS_EXIT_INVALID_FILE;
goto clean_exit;
}
if (copy_persconffile_profile(ws_optarg, ws_optarg, TRUE, &pf_filename,
&pf_dir_path, &pf_dir_path2) == -1) {
cmdarg_err("Can't copy file \"%s\" in directory\n\"%s\" to\n\"%s\":\n%s.",
pf_filename, pf_dir_path2, pf_dir_path, g_strerror(errno));
g_free(pf_filename);
g_free(pf_dir_path);
g_free(pf_dir_path2);
exit_status = WS_EXIT_INVALID_FILE;
goto clean_exit;
}
set_profile_name (ws_optarg);
} else {
cmdarg_err("Configuration Profile \"%s\" does not exist", ws_optarg);
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
break;
case 'G':
if (g_str_has_suffix(ws_optarg, "prefs") || strcmp(ws_optarg, "folders") == 0) {
has_extcap_options = TRUE;
}
break;
case 'i':
has_extcap_options = TRUE;
break;
case 'o':
if (g_str_has_prefix(ws_optarg, "extcap.")) {
has_extcap_options = TRUE;
}
break;
case 'P': /* Print packet summary info even when writing to a file */
print_packet_info = TRUE;
print_summary = TRUE;
break;
case 'r': /* Read capture file x */
cf_name = g_strdup(ws_optarg);
break;
case 'O': /* Only output these protocols */
output_only = g_strdup(ws_optarg);
/* FALLTHROUGH */
case 'V': /* Verbose */
print_details = TRUE;
print_packet_info = TRUE;
break;
case 'x': /* Print packet data in hex (and ASCII) */
print_hex = TRUE;
/* The user asked for hex output, so let's ensure they get it,
* even if they're writing to a file.
*/
print_packet_info = TRUE;
break;
case 'X':
ex_opt_add(ws_optarg);
break;
case LONGOPT_ELASTIC_MAPPING_FILTER:
elastic_mapping_filter = ws_optarg;
break;
default:
break;
}
}
#ifndef HAVE_LUA
if (ex_opt_count("lua_script") > 0) {
cmdarg_err("This version of TShark was not built with support for Lua scripting.");
exit_status = WS_EXIT_INIT_FAILED;
goto clean_exit;
}
#endif /* HAVE_LUA */
init_report_message("TShark", &tshark_report_routines);
#ifdef HAVE_LIBPCAP
capture_opts_init(&global_capture_opts);
capture_session_init(&global_capture_session, &cfile,
capture_input_new_file, capture_input_new_packets,
capture_input_drops, capture_input_error,
capture_input_cfilter_error, capture_input_closed);
#endif
timestamp_set_type(TS_RELATIVE);
timestamp_set_precision(TS_PREC_AUTO);
timestamp_set_seconds_type(TS_SECONDS_DEFAULT);
/*
* Libwiretap must be initialized before libwireshark is, so that
* dissection-time handlers for file-type-dependent blocks can
* register using the file type/subtype value for the file type.
*/
wtap_init(TRUE);
/* Register all dissectors; we must do this before checking for the
"-G" flag, as the "-G" flag dumps information registered by the
dissectors, and we must do it before we read the preferences, in
case any dissectors register preferences. */
if (!epan_init(NULL, NULL, TRUE)) {
exit_status = WS_EXIT_INIT_FAILED;
goto clean_exit;
}
/* Register all tap listeners; we do this before we parse the arguments,
as the "-z" argument can specify a registered tap. */
register_all_tap_listeners(tap_reg_listener);
/*
* An empty cf_name indicates that we're capturing, and we might
* be doing so on an extcap interface.
*/
if (has_extcap_options || !cf_name) {
extcap_register_preferences();
}
conversation_table_set_gui_info(init_iousers);
endpoint_table_set_gui_info(init_endpoints);
srt_table_iterate_tables(register_srt_tables, NULL);
rtd_table_iterate_tables(register_rtd_tables, NULL);
stat_tap_iterate_tables(register_simple_stat_tables, NULL);
/* If invoked with the "-G" flag, we dump out information based on
the argument to the "-G" flag; if no argument is specified,
for backwards compatibility we dump out a glossary of display
filter symbols.
XXX - we do this here, for now, to support "-G" with no arguments.
If none of our build or other processes uses "-G" with no arguments,
we can just process it with the other arguments. */
if (argc >= 2 && strcmp(argv[1], "-G") == 0) {
proto_initialize_all_prefixes();
if (argc == 2)
proto_registrar_dump_fields();
else {
if (strcmp(argv[2], "column-formats") == 0)
column_dump_column_formats();
else if (strcmp(argv[2], "currentprefs") == 0) {
epan_load_settings();
write_prefs(NULL);
}
else if (strcmp(argv[2], "decodes") == 0)
dissector_dump_decodes();
else if (strcmp(argv[2], "defaultprefs") == 0)
write_prefs(NULL);
else if (strcmp(argv[2], "dissector-tables") == 0)
dissector_dump_dissector_tables();
else if (strcmp(argv[2], "elastic-mapping") == 0)
proto_registrar_dump_elastic(elastic_mapping_filter);
else if (strcmp(argv[2], "fieldcount") == 0) {
/* return value for the test suite */
exit_status = proto_registrar_dump_fieldcount();
goto clean_exit;
} else if (strcmp(argv[2], "fields") == 0)
proto_registrar_dump_fields();
else if (strcmp(argv[2], "folders") == 0) {
epan_load_settings();
about_folders();
} else if (strcmp(argv[2], "ftypes") == 0)
proto_registrar_dump_ftypes();
else if (strcmp(argv[2], "heuristic-decodes") == 0)
dissector_dump_heur_decodes();
else if (strcmp(argv[2], "plugins") == 0) {
#ifdef HAVE_PLUGINS
codecs_init();
plugins_dump_all();
#endif
#ifdef HAVE_LUA
wslua_plugins_dump_all();
#endif
extcap_dump_all();
}
else if (strcmp(argv[2], "protocols") == 0)
proto_registrar_dump_protocols();
else if (strcmp(argv[2], "values") == 0)
proto_registrar_dump_values();
else if (strcmp(argv[2], "help") == 0)
glossary_option_help();
/* These are supported only for backwards compatibility and may or may not work
* for a given user in a given directory on a given operating system with a given
* command-line interpreter.
*/
else if (strcmp(argv[2], "?") == 0)
glossary_option_help();
else if (strcmp(argv[2], "-?") == 0)
glossary_option_help();
else {
cmdarg_err("Invalid \"%s\" option for -G flag, enter -G help for more help.", argv[2]);
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
}
exit_status = EXIT_SUCCESS;
goto clean_exit;
}
ws_debug("tshark reading settings");
/* Load libwireshark settings from the current profile. */
prefs_p = epan_load_settings();
prefs_loaded = TRUE;
read_filter_list(CFILTER_LIST);
cap_file_init(&cfile);
/* Print format defaults to this. */
print_format = PR_FMT_TEXT;
delimiter_char = " ";
output_fields = output_fields_new();
/*
* To reset the options parser, set ws_optreset to 1 and set ws_optind to 1.
*
* Also reset ws_opterr to 1, so that error messages are printed by
* getopt_long().
*/
ws_optreset = 1;
ws_optind = 1;
ws_opterr = 1;
/* Now get our args */
while ((opt = ws_getopt_long(argc, argv, optstring, long_options, NULL)) != -1) {
switch (opt) {
case '2': /* Perform two-pass analysis */
if(epan_auto_reset){
cmdarg_err("-2 does not support auto session reset.");
arg_error=TRUE;
}
perform_two_pass_analysis = TRUE;
break;
case 'M':
if(perform_two_pass_analysis){
cmdarg_err("-M does not support two-pass analysis.");
arg_error=TRUE;
}
epan_auto_reset_count = get_positive_int(ws_optarg, "epan reset count");
epan_auto_reset = TRUE;
break;
case 'a': /* autostop criteria */
case 'b': /* Ringbuffer option */
case 'f': /* capture filter */
case 'g': /* enable group read access on file(s) */
case 'i': /* Use interface x */
case LONGOPT_SET_TSTAMP_TYPE: /* Set capture timestamp type */
case 'p': /* Don't capture in promiscuous mode */
#ifdef HAVE_PCAP_REMOTE
case 'A': /* Authentication */
#endif
#ifdef HAVE_PCAP_CREATE
case 'I': /* Capture in monitor mode, if available */
#endif
case 's': /* Set the snapshot (capture) length */
case 'y': /* Set the pcap data link type */
#ifdef CAN_SET_CAPTURE_BUFFER_SIZE
case 'B': /* Buffer size */
#endif
case LONGOPT_COMPRESS_TYPE: /* compress type */
case LONGOPT_CAPTURE_TMPDIR: /* capture temp directory */
/* These are options only for packet capture. */
#ifdef HAVE_LIBPCAP
exit_status = capture_opts_add_opt(&global_capture_opts, opt, ws_optarg);
if (exit_status != 0) {
goto clean_exit;
}
#else
capture_option_specified = TRUE;
arg_error = TRUE;
#endif
break;
case 'c': /* Stop after x packets */
#ifdef HAVE_LIBPCAP
exit_status = capture_opts_add_opt(&global_capture_opts, opt, ws_optarg);
if (exit_status != 0) {
goto clean_exit;
}
#else
max_packet_count = get_positive_int(ws_optarg, "packet count");
#endif
break;
case 'w': /* Write to file x */
output_file_name = g_strdup(ws_optarg);
#ifdef HAVE_LIBPCAP
exit_status = capture_opts_add_opt(&global_capture_opts, opt, ws_optarg);
if (exit_status != 0) {
goto clean_exit;
}
#endif
break;
case 'C':
/* already processed; just ignore it now */
break;
case 'D': /* Print a list of capture devices and exit */
#ifdef HAVE_LIBPCAP
if_list = capture_interface_list(&err, &err_str,NULL);
if (if_list == NULL) {
if (err == 0)
cmdarg_err("There are no interfaces on which a capture can be done");
else {
cmdarg_err("%s", err_str);
g_free(err_str);
}
exit_status = WS_EXIT_INVALID_INTERFACE;
goto clean_exit;
}
capture_opts_print_interfaces(if_list);
free_interface_list(if_list);
exit_status = EXIT_SUCCESS;
goto clean_exit;
#else
capture_option_specified = TRUE;
arg_error = TRUE;
#endif
break;
case 'e':
/* Field entry */
output_fields_add(output_fields, ws_optarg);
break;
case 'E':
/* Field option */
if (!output_fields_set_option(output_fields, ws_optarg)) {
cmdarg_err("\"%s\" is not a valid field output option=value pair.", ws_optarg);
output_fields_list_options(stderr);
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
break;
case 'F':
out_file_type = wtap_name_to_file_type_subtype(ws_optarg);
if (out_file_type < 0) {
cmdarg_err("\"%s\" isn't a valid capture file type", ws_optarg);
list_capture_types();
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
break;
case 'G':
cmdarg_err("-G only valid as first option");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
break;
case 'j':
protocolfilter_add_opt(ws_optarg, PF_NONE);
break;
case 'J':
protocolfilter_add_opt(ws_optarg, PF_INCLUDE_CHILDREN);
break;
case 'W': /* Select extra information to save in our capture file */
/* This is patterned after the -N flag which may not be the best idea. */
if (strchr(ws_optarg, 'n')) {
out_file_name_res = TRUE;
} else {
cmdarg_err("Invalid -W argument \"%s\"; it must be one of:", ws_optarg);
cmdarg_err_cont("\t'n' write network address resolution information (pcapng only)");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
break;
case 'H': /* Read address to name mappings from a hosts file */
if (! add_hosts_file(ws_optarg))
{
cmdarg_err("Can't read host entries from \"%s\"", ws_optarg);
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
out_file_name_res = TRUE;
break;
case 'h': /* Print help and exit */
show_help_header("Dump and analyze network traffic.");
print_usage(stdout);
exit_status = EXIT_SUCCESS;
goto clean_exit;
break;
case 'l': /* "Line-buffer" standard output */
/* The ANSI C standard does not appear to *require* that a line-buffered
stream be flushed to the host environment whenever a newline is
written, it just says that, on such a stream, characters "are
intended to be transmitted to or from the host environment as a
block when a new-line character is encountered".
The Visual C++ 6.0 C implementation doesn't do what is intended;
even if you set a stream to be line-buffered, it still doesn't
flush the buffer at the end of every line.
The whole reason for the "-l" flag in either tcpdump or TShark
is to allow the output of a live capture to be piped to a program
or script and to have that script see the information for the
packet as soon as it's printed, rather than having to wait until
a standard I/O buffer fills up.
So, if the "-l" flag is specified, we flush the standard output
at the end of a packet. This will do the right thing if we're
printing packet summary lines, and, as we print the entire protocol
tree for a single packet without waiting for anything to happen,
it should be as good as line-buffered mode if we're printing
protocol trees - arguably even better, as it may do fewer
writes. */
line_buffered = TRUE;
break;
case 'L': /* Print list of link-layer types and exit */
#ifdef HAVE_LIBPCAP
caps_queries |= CAPS_QUERY_LINK_TYPES;
#else
capture_option_specified = TRUE;
arg_error = TRUE;
#endif
break;
case LONGOPT_LIST_TSTAMP_TYPES: /* List possible timestamp types */
#ifdef HAVE_LIBPCAP
caps_queries |= CAPS_QUERY_TIMESTAMP_TYPES;
#else
capture_option_specified = TRUE;
arg_error = TRUE;
#endif
break;
case 'o': /* Override preference from command line */
{
char *errmsg = NULL;
switch (prefs_set_pref(ws_optarg, &errmsg)) {
case PREFS_SET_OK:
break;
case PREFS_SET_SYNTAX_ERR:
cmdarg_err("Invalid -o flag \"%s\"%s%s", ws_optarg,
errmsg ? ": " : "", errmsg ? errmsg : "");
g_free(errmsg);
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
break;
case PREFS_SET_NO_SUCH_PREF:
cmdarg_err("-o flag \"%s\" specifies unknown preference", ws_optarg);
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
break;
case PREFS_SET_OBSOLETE:
cmdarg_err("-o flag \"%s\" specifies obsolete preference", ws_optarg);
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
break;
}
break;
}
case 'q': /* Quiet */
quiet = TRUE;
break;
case 'Q': /* Really quiet */
quiet = TRUE;
really_quiet = TRUE;
break;
case 'r':
/* already processed; just ignore it now */
break;
case 'R': /* Read file filter */
rfilter = ws_optarg;
break;
case 'P':
/* already processed; just ignore it now */
break;
case 'S': /* Set the line Separator to be printed between packets */
separator = ws_optarg;
break;
case 'T': /* printing Type */
/* output_action has been already set. It means multiple -T. */
if (output_action > WRITE_NONE) {
cmdarg_err("Multiple -T parameters are unsupported");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
print_packet_info = TRUE;
if (strcmp(ws_optarg, "text") == 0) {
output_action = WRITE_TEXT;
print_format = PR_FMT_TEXT;
} else if (strcmp(ws_optarg, "tabs") == 0) {
output_action = WRITE_TEXT;
print_format = PR_FMT_TEXT;
delimiter_char = "\t";
} else if (strcmp(ws_optarg, "ps") == 0) {
output_action = WRITE_TEXT;
print_format = PR_FMT_PS;
} else if (strcmp(ws_optarg, "pdml") == 0) {
output_action = WRITE_XML;
print_details = TRUE; /* Need details */
print_summary = FALSE; /* Don't allow summary */
} else if (strcmp(ws_optarg, "psml") == 0) {
output_action = WRITE_XML;
print_details = FALSE; /* Don't allow details */
print_summary = TRUE; /* Need summary */
} else if (strcmp(ws_optarg, "fields") == 0) {
output_action = WRITE_FIELDS;
print_details = TRUE; /* Need full tree info */
print_summary = FALSE; /* Don't allow summary */
} else if (strcmp(ws_optarg, "json") == 0) {
output_action = WRITE_JSON;
print_details = TRUE; /* Need details */
print_summary = FALSE; /* Don't allow summary */
} else if (strcmp(ws_optarg, "ek") == 0) {
output_action = WRITE_EK;
if (!print_summary)
print_details = TRUE;
} else if (strcmp(ws_optarg, "jsonraw") == 0) {
output_action = WRITE_JSON_RAW;
print_details = TRUE; /* Need details */
print_summary = FALSE; /* Don't allow summary */
}
else {
cmdarg_err("Invalid -T parameter \"%s\"; it must be one of:", ws_optarg); /* x */
cmdarg_err_cont("\t\"fields\" The values of fields specified with the -e option, in a form\n"
"\t specified by the -E option.\n"
"\t\"pdml\" Packet Details Markup Language, an XML-based format for the\n"
"\t details of a decoded packet. This information is equivalent to\n"
"\t the packet details printed with the -V flag.\n"
"\t\"ps\" PostScript for a human-readable one-line summary of each of\n"
"\t the packets, or a multi-line view of the details of each of\n"
"\t the packets, depending on whether the -V flag was specified.\n"
"\t\"psml\" Packet Summary Markup Language, an XML-based format for the\n"
"\t summary information of a decoded packet. This information is\n"
"\t equivalent to the information shown in the one-line summary\n"
"\t printed by default.\n"
"\t\"json\" Packet Summary, an JSON-based format for the details\n"
"\t summary information of a decoded packet. This information is \n"
"\t equivalent to the packet details printed with the -V flag.\n"
"\t\"jsonraw\" Packet Details, a JSON-based format for machine parsing\n"
"\t including only raw hex decoded fields (same as -T json -x but\n"
"\t without text decoding, only raw fields included). \n"
"\t\"ek\" Packet Details, an EK JSON-based format for the bulk insert \n"
"\t into elastic search cluster. This information is \n"
"\t equivalent to the packet details printed with the -V flag.\n"
"\t\"text\" Text of a human-readable one-line summary of each of the\n"
"\t packets, or a multi-line view of the details of each of the\n"
"\t packets, depending on whether the -V flag was specified.\n"
"\t This is the default.\n"
"\t\"tabs\" Similar to the text report except that each column of the\n"
"\t human-readable one-line summary is delimited with an ASCII\n"
"\t horizontal tab character.");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
break;
case 'U': /* Export PDUs to file */
if (strcmp(ws_optarg, "") == 0 || strcmp(ws_optarg, "?") == 0) {
list_export_pdu_taps();
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
pdu_export_arg = g_strdup(ws_optarg);
break;
case 'v': /* Show version and exit */
show_version();
/* We don't really have to cleanup here, but it's a convenient way to test
* start-up and shut-down of the epan library without any UI-specific
* cruft getting in the way. Makes the results of running
* $ ./tools/valgrind-wireshark -n
* much more useful. */
epan_cleanup();
extcap_cleanup();
exit_status = EXIT_SUCCESS;
goto clean_exit;
case 'O': /* Only output these protocols */
/* already processed; just ignore it now */
break;
case 'V': /* Verbose */
/* already processed; just ignore it now */
break;
case 'x': /* Print packet data in hex (and ASCII) */
/* already processed; just ignore it now */
break;
case 'X':
/* already processed; just ignore it now */
break;
case 'Y':
dfilter = g_strdup(ws_optarg);
break;
case 'z':
/* We won't call the init function for the stat this soon
as it would disallow MATE's fields (which are registered
by the preferences set callback) from being used as
part of a tap filter. Instead, we just add the argument
to a list of stat arguments. */
if (strcmp("help", ws_optarg) == 0) {
fprintf(stderr, "tshark: The available statistics for the \"-z\" option are:\n");
list_stat_cmd_args();
exit_status = EXIT_SUCCESS;
goto clean_exit;
}
if (!process_stat_cmd_arg(ws_optarg)) {
cmdarg_err("Invalid -z argument \"%s\"; it must be one of:", ws_optarg);
list_stat_cmd_args();
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
break;
case 'd': /* Decode as rule */
case 'K': /* Kerberos keytab file */
case 'n': /* No name resolution */
case 'N': /* Select what types of addresses/port #s to resolve */
case 't': /* Time stamp type */
case 'u': /* Seconds type */
case LONGOPT_DISABLE_PROTOCOL: /* disable dissection of protocol */
case LONGOPT_ENABLE_HEURISTIC: /* enable heuristic dissection of protocol */
case LONGOPT_DISABLE_HEURISTIC: /* disable heuristic dissection of protocol */
case LONGOPT_ENABLE_PROTOCOL: /* enable dissection of protocol (that is disabled by default) */
if (!dissect_opts_handle_opt(opt, ws_optarg)) {
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
break;
case LONGOPT_EXPORT_OBJECTS: /* --export-objects */
if (strcmp("help", ws_optarg) == 0) {
fprintf(stderr, "tshark: The available export object types for the \"--export-objects\" option are:\n");
eo_list_object_types();
exit_status = EXIT_SUCCESS;
goto clean_exit;
}
if (!eo_tap_opt_add(ws_optarg)) {
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
break;
case LONGOPT_EXPORT_TLS_SESSION_KEYS: /* --export-tls-session-keys */
tls_session_keys_file = ws_optarg;
break;
case LONGOPT_COLOR: /* print in color where appropriate */
dissect_color = TRUE;
break;
case LONGOPT_NO_DUPLICATE_KEYS:
no_duplicate_keys = TRUE;
node_children_grouper = proto_node_group_children_by_json_key;
break;
case LONGOPT_CAPTURE_COMMENT: /* capture comment */
if (capture_comments == NULL) {
capture_comments = g_ptr_array_new_with_free_func(g_free);
}
g_ptr_array_add(capture_comments, g_strdup(ws_optarg));
break;
case LONGOPT_HEXDUMP:
print_hex = TRUE;
print_packet_info = TRUE;
if (strcmp(ws_optarg, "all") == 0)
hexdump_source_option = HEXDUMP_SOURCE_MULTI;
else if (strcmp(ws_optarg, "frames") == 0)
hexdump_source_option = HEXDUMP_SOURCE_PRIMARY;
else if (strcmp(ws_optarg, "ascii") == 0)
hexdump_ascii_option = HEXDUMP_ASCII_INCLUDE;
else if (strcmp(ws_optarg, "delimit") == 0)
hexdump_ascii_option = HEXDUMP_ASCII_DELIMIT;
else if (strcmp(ws_optarg, "noascii") == 0)
hexdump_ascii_option = HEXDUMP_ASCII_EXCLUDE;
else if (strcmp("help", ws_optarg) == 0) {
hexdump_option_help(stdout);
exit_status = EXIT_SUCCESS;
goto clean_exit;
} else {
fprintf(stderr, "tshark: \"%s\" is an invalid value for --hexdump <hexoption>\n", ws_optarg);
fprintf(stderr, "For valid <hexoption> values enter: tshark --hexdump help\n");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
break;
case LONGOPT_SELECTED_FRAME:
/* Hidden option to mark a frame as "selected". Used for testing and debugging.
* Only active in two-pass mode. */
if (!ws_strtou32(ws_optarg, &endptr, &selected_frame_number) || *endptr != '\0') {
fprintf(stderr, "tshark: \"%s\" is not a valid frame number\n", ws_optarg);
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
break;
default:
case '?': /* Bad flag - print usage message */
switch(ws_optopt) {
case 'F':
list_capture_types();
break;
default:
print_usage(stderr);
}
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
break;
}
}
/* set the default output action to TEXT */
if (output_action == WRITE_NONE)
output_action = WRITE_TEXT;
/* set the default file type to pcapng */
if (out_file_type == WTAP_FILE_TYPE_SUBTYPE_UNKNOWN)
out_file_type = wtap_pcapng_file_type_subtype();
/*
* Print packet summary information is the default if neither -V or -x
* were specified. Note that this is new behavior, which allows for the
* possibility of printing only hex/ascii output without necessarily
* requiring that either the summary or details be printed too.
*/
if (!print_summary && !print_details && !print_hex)
print_summary = TRUE;
if (no_duplicate_keys && output_action != WRITE_JSON && output_action != WRITE_JSON_RAW) {
cmdarg_err("--no-duplicate-keys can only be used with \"-T json\" and \"-T jsonraw\"");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
/* If we specified output fields, but not the output field type... */
if ((WRITE_FIELDS != output_action && WRITE_XML != output_action && WRITE_JSON != output_action && WRITE_EK != output_action) && 0 != output_fields_num_fields(output_fields)) {
cmdarg_err("Output fields were specified with \"-e\", "
"but \"-Tek, -Tfields, -Tjson or -Tpdml\" was not specified.");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
} else if (WRITE_FIELDS == output_action && 0 == output_fields_num_fields(output_fields)) {
cmdarg_err("\"-Tfields\" was specified, but no fields were "
"specified with \"-e\".");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
if (dissect_color) {
if (!color_filters_init(&err_msg, NULL)) {
fprintf(stderr, "%s\n", err_msg);
g_free(err_msg);
}
}
/* If no capture filter or display filter has been specified, and there are
still command-line arguments, treat them as the tokens of a capture
filter (if no "-r" flag was specified) or a display filter (if a "-r"
flag was specified. */
if (ws_optind < argc) {
if (cf_name != NULL) {
if (dfilter != NULL) {
cmdarg_err("Display filters were specified both with \"-Y\" "
"and with additional command-line arguments.");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
dfilter = get_args_as_string(argc, argv, ws_optind);
} else {
#ifdef HAVE_LIBPCAP
guint i;
if (global_capture_opts.default_options.cfilter) {
cmdarg_err("A default capture filter was specified both with \"-f\""
" and with additional command-line arguments.");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
for (i = 0; i < global_capture_opts.ifaces->len; i++) {
interface_options *interface_opts;
interface_opts = &g_array_index(global_capture_opts.ifaces, interface_options, i);
if (interface_opts->cfilter == NULL) {
interface_opts->cfilter = get_args_as_string(argc, argv, ws_optind);
} else {
cmdarg_err("A capture filter was specified both with \"-f\""
" and with additional command-line arguments.");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
}
global_capture_opts.default_options.cfilter = get_args_as_string(argc, argv, ws_optind);
#else
capture_option_specified = TRUE;
#endif
}
}
if (!output_file_name) {
/* We're not saving the capture to a file; if "-q" wasn't specified,
we should print packet information */
if (!quiet)
print_packet_info = TRUE;
} else {
const char *save_file = output_file_name;
/* We're saving to a file; if we're writing to the standard output.
and we'll also be writing dissected packets to the standard
output, reject the request. At best, we could redirect that
to the standard error; we *can't* write both to the standard
output and have either of them be useful. */
if (strcmp(save_file, "-") == 0 && print_packet_info) {
cmdarg_err("You can't write both raw packet data and dissected packets"
" to the standard output.");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
}
#ifndef HAVE_LIBPCAP
if (capture_option_specified)
cmdarg_err("This version of TShark was not built with support for capturing packets.");
#endif
if (arg_error) {
print_usage(stderr);
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
if (print_hex) {
if (output_action != WRITE_TEXT && output_action != WRITE_JSON && output_action != WRITE_JSON_RAW && output_action != WRITE_EK) {
cmdarg_err("Raw packet hex data can only be printed as text, PostScript, JSON, JSONRAW or EK JSON");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
}
if (output_only != NULL) {
char *ps;
if (!print_details) {
cmdarg_err("-O requires -V");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
output_only_tables = g_hash_table_new (g_str_hash, g_str_equal);
for (ps = strtok (output_only, ","); ps; ps = strtok (NULL, ",")) {
const char *name = ps;
header_field_info *hfi = proto_registrar_get_byalias(name);
if (hfi) {
name = hfi->abbrev;
}
g_hash_table_insert(output_only_tables, (gpointer)name, (gpointer)name);
}
}
if (rfilter != NULL && !perform_two_pass_analysis) {
cmdarg_err("-R without -2 is deprecated. For single-pass filtering use -Y.");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
#ifdef HAVE_LIBPCAP
if (caps_queries) {
/* We're supposed to list the link-layer/timestamp types for an interface;
did the user also specify a capture file to be read? */
if (cf_name) {
/* Yes - that's bogus. */
cmdarg_err("You can't specify %s and a capture file to be read.",
caps_queries & CAPS_QUERY_LINK_TYPES ? "-L" : "--list-time-stamp-types");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
/* No - did they specify a ring buffer option? */
if (global_capture_opts.multi_files_on) {
cmdarg_err("Ring buffer requested, but a capture isn't being done.");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
} else {
if (cf_name) {
/*
* "-r" was specified, so we're reading a capture file.
* Capture options don't apply here.
*/
/* We don't support capture filters when reading from a capture file
(the BPF compiler doesn't support all link-layer types that we
support in capture files we read). */
if (global_capture_opts.default_options.cfilter) {
cmdarg_err("Only read filters, not capture filters, "
"can be specified when reading a capture file.");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
if (global_capture_opts.multi_files_on) {
cmdarg_err("Multiple capture files requested, but "
"a capture isn't being done.");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
if (global_capture_opts.has_file_duration) {
cmdarg_err("Switching capture files after a time period was specified, but "
"a capture isn't being done.");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
if (global_capture_opts.has_file_interval) {
cmdarg_err("Switching capture files after a time interval was specified, but "
"a capture isn't being done.");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
if (global_capture_opts.has_ring_num_files) {
cmdarg_err("A ring buffer of capture files was specified, but "
"a capture isn't being done.");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
if (global_capture_opts.has_autostop_files) {
cmdarg_err("A maximum number of capture files was specified, but "
"a capture isn't being done.");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
/* Note: TShark now allows the restriction of a _read_ file by packet count
* and byte count as well as a write file. Other autostop options remain valid
* only for a write file.
*/
if (global_capture_opts.has_autostop_duration) {
cmdarg_err("A maximum capture time was specified, but "
"a capture isn't being done.");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
} else {
/*
* "-r" wasn't specified, so we're doing a live capture.
*/
gboolean use_pcapng = TRUE;
if (perform_two_pass_analysis) {
/* Two-pass analysis doesn't work with live capture since it requires us
* to buffer packets until we've read all of them, but a live capture
* has no useful/meaningful definition of "all" */
cmdarg_err("Live captures do not support two-pass analysis.");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
if (global_capture_opts.saving_to_file) {
/* They specified a "-w" flag, so we'll be saving to a capture file. */
/* When capturing, we only support writing pcap or pcapng format. */
if (out_file_type == wtap_pcapng_file_type_subtype()) {
use_pcapng = TRUE;
} else if (out_file_type == wtap_pcap_file_type_subtype()) {
use_pcapng = FALSE;
} else {
cmdarg_err("Live captures can only be saved in pcap or pcapng format.");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
if (capture_comments != NULL && !use_pcapng) {
cmdarg_err("Capture comments can only be written to a pcapng file.");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
if (global_capture_opts.multi_files_on) {
/* Multiple-file mode doesn't work under certain conditions:
a) it doesn't work if you're writing to the standard output;
b) it doesn't work if you're writing to a pipe;
*/
if (strcmp(global_capture_opts.save_file, "-") == 0) {
cmdarg_err("Multiple capture files requested, but "
"the capture is being written to the standard output.");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
if (global_capture_opts.output_to_pipe) {
cmdarg_err("Multiple capture files requested, but "
"the capture file is a pipe.");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
if (!global_capture_opts.has_autostop_filesize &&
!global_capture_opts.has_file_duration &&
!global_capture_opts.has_file_interval &&
!global_capture_opts.has_file_packets) {
cmdarg_err("Multiple capture files requested, but "
"no maximum capture file size, duration, interval or packets were specified.");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
}
/* Currently, we don't support read or display filters when capturing
and saving the packets. */
if (rfilter != NULL) {
cmdarg_err("Read filters aren't supported when capturing and saving the captured packets.");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
if (dfilter != NULL) {
cmdarg_err("Display filters aren't supported when capturing and saving the captured packets.");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
global_capture_opts.use_pcapng = use_pcapng;
} else {
/* They didn't specify a "-w" flag, so we won't be saving to a
capture file. Check for options that only make sense if
we're saving to a file. */
if (global_capture_opts.has_autostop_filesize) {
cmdarg_err("Maximum capture file size specified, but "
"capture isn't being saved to a file.");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
if (global_capture_opts.multi_files_on) {
cmdarg_err("Multiple capture files requested, but "
"the capture isn't being saved to a file.");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
if (capture_comments != NULL) {
cmdarg_err("Capture comments were specified, but "
"the capture isn't being saved to a file.");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
}
}
}
#endif
/*
* If capture comments were specified, -w also has to have been specified.
*/
if (capture_comments != NULL) {
if (output_file_name) {
/* They specified a "-w" flag, so we'll be saving to a capture file.
* This is fine if they're writing in a format that supports
* section block comments.
*/
if (wtap_file_type_subtype_supports_option(out_file_type,
WTAP_BLOCK_SECTION,
OPT_COMMENT) == OPTION_NOT_SUPPORTED) {
GArray *writable_type_subtypes;
cmdarg_err("Capture comments can only be written to files of the following types:");
writable_type_subtypes = wtap_get_writable_file_types_subtypes(FT_SORT_BY_NAME);
for (guint i = 0; i < writable_type_subtypes->len; i++) {
int ft = g_array_index(writable_type_subtypes, int, i);
if (wtap_file_type_subtype_supports_option(ft, WTAP_BLOCK_SECTION,
OPT_COMMENT) != OPTION_NOT_SUPPORTED)
cmdarg_err_cont(" %s - %s", wtap_file_type_subtype_name(ft),
wtap_file_type_subtype_description(ft));
}
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
}
else {
cmdarg_err("Capture comments were specified, but you aren't writing a capture file.");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
}
err_msg = ws_init_sockets();
if (err_msg != NULL)
{
cmdarg_err("%s", err_msg);
g_free(err_msg);
cmdarg_err_cont("%s", please_report_bug());
exit_status = WS_EXIT_INIT_FAILED;
goto clean_exit;
}
/* Notify all registered modules that have had any of their preferences
changed either from one of the preferences file or from the command
line that their preferences have changed. */
prefs_apply_all();
/* We can also enable specified taps for export object */
start_exportobjects();
/* At this point MATE will have registered its field array so we can
check if the fields specified by the user are all good.
*/
{
GSList* it = NULL;
GSList *invalid_fields = output_fields_valid(output_fields);
if (invalid_fields != NULL) {
cmdarg_err("Some fields aren't valid:");
for (it=invalid_fields; it != NULL; it = g_slist_next(it)) {
cmdarg_err_cont("\t%s", (gchar *)it->data);
}
g_slist_free(invalid_fields);
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
}
#ifdef HAVE_LIBPCAP
/* We currently don't support taps, or printing dissected packets,
if we're writing to a pipe. */
if (global_capture_opts.saving_to_file &&
global_capture_opts.output_to_pipe) {
if (tap_listeners_require_dissection()) {
cmdarg_err("Taps aren't supported when saving to a pipe.");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
if (print_packet_info) {
cmdarg_err("Printing dissected packets isn't supported when saving to a pipe.");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
}
#endif
if (ex_opt_count("read_format") > 0) {
const gchar* name = ex_opt_get_next("read_format");
in_file_type = open_info_name_to_type(name);
if (in_file_type == WTAP_TYPE_AUTO) {
cmdarg_err("\"%s\" isn't a valid read file format type", name? name : "");
list_read_capture_types();
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
}
timestamp_set_type(global_dissect_options.time_format);
/*
* Enabled and disabled protocols and heuristic dissectors as per
* command-line options.
*/
if (!setup_enabled_and_disabled_protocols()) {
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
/* Build the column format array */
build_column_format_array(&cfile.cinfo, prefs_p->num_cols, TRUE);
#ifdef HAVE_LIBPCAP
capture_opts_trim_snaplen(&global_capture_opts, MIN_PACKET_SIZE);
capture_opts_trim_ring_num_files(&global_capture_opts);
#endif
if (rfilter != NULL) {
ws_debug("Compiling read filter: '%s'", rfilter);
if (!compile_dfilter(rfilter, &rfcode)) {
epan_cleanup();
extcap_cleanup();
#ifdef HAVE_LIBPCAP
warn_about_capture_filter(rfilter);
#endif
exit_status = WS_EXIT_INVALID_INTERFACE;
goto clean_exit;
}
}
cfile.rfcode = rfcode;
if (dfilter != NULL) {
ws_debug("Compiling display filter: '%s'", dfilter);
if (!compile_dfilter(dfilter, &dfcode)) {
epan_cleanup();
extcap_cleanup();
#ifdef HAVE_LIBPCAP
warn_about_capture_filter(dfilter);
#endif
exit_status = WS_EXIT_INVALID_FILTER;
goto clean_exit;
}
}
cfile.dfcode = dfcode;
if (print_packet_info) {
/* If we're printing as text or PostScript, we have
to create a print stream. */
if (output_action == WRITE_TEXT) {
switch (print_format) {
case PR_FMT_TEXT:
print_stream = print_stream_text_stdio_new(stdout);
break;
case PR_FMT_PS:
print_stream = print_stream_ps_stdio_new(stdout);
break;
default:
ws_assert_not_reached();
}
}
}
/* PDU export requested. Take the ownership of the '-w' file, apply tap
* filters and start tapping. */
if (pdu_export_arg) {
const char *exp_pdu_tap_name = pdu_export_arg;
const char *exp_pdu_filter = dfilter; /* may be NULL to disable filter */
char *exp_pdu_error;
int exp_fd;
char *comment;
if (!cf_name) {
cmdarg_err("PDUs export requires a capture file (specify with -r).");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
/* Take ownership of the '-w' output file. */
exp_pdu_filename = output_file_name;
output_file_name = NULL;
#ifdef HAVE_LIBPCAP
global_capture_opts.save_file = NULL;
#endif
if (exp_pdu_filename == NULL) {
cmdarg_err("PDUs export requires an output file (-w).");
exit_status = WS_EXIT_INVALID_OPTION;
goto clean_exit;
}
exp_pdu_error = exp_pdu_pre_open(exp_pdu_tap_name, exp_pdu_filter,
&exp_pdu_tap_data);
if (exp_pdu_error) {
cmdarg_err("Cannot register tap: %s", exp_pdu_error);
g_free(exp_pdu_error);
list_export_pdu_taps();
exit_status = INVALID_TAP;
goto clean_exit;
}
if (strcmp(exp_pdu_filename, "-") == 0) {
/* Write to the standard output. */
exp_fd = 1;
} else {
exp_fd = ws_open(exp_pdu_filename, O_WRONLY | O_CREAT | O_TRUNC | O_BINARY, 0644);
if (exp_fd == -1) {
cmdarg_err("%s: %s", exp_pdu_filename, file_open_error_message(errno, TRUE));
exit_status = WS_EXIT_INVALID_FILE;
goto clean_exit;
}
}
/* Activate the export PDU tap */
/* Write to our output file with this comment (if the type supports it,
* otherwise exp_pdu_open() will ignore the comment) */
comment = ws_strdup_printf("Dump of PDUs from %s", cf_name);
exp_pdu_status = exp_pdu_open(&exp_pdu_tap_data, exp_pdu_filename,
out_file_type, exp_fd, comment,
&err, &err_info);
g_free(comment);
if (!exp_pdu_status) {
cfile_dump_open_failure_message(exp_pdu_filename, err, err_info,
out_file_type);
exit_status = INVALID_EXPORT;
goto clean_exit;
}
}
ws_debug("tshark: do_dissection = %s", do_dissection ? "TRUE" : "FALSE");
if (cf_name) {
ws_debug("tshark: Opening capture file: %s", cf_name);
/*
* We're reading a capture file.
*/
if (cf_open(&cfile, cf_name, in_file_type, FALSE, &err) != CF_OK) {
epan_cleanup();
extcap_cleanup();
exit_status = WS_EXIT_INVALID_FILE;
goto clean_exit;
}
/* Start statistics taps; we do so after successfully opening the
capture file, so we know we have something to compute stats
on, and after registering all dissectors, so that MATE will
have registered its field array so we can have a tap filter
with one of MATE's late-registered fields as part of the
filter. */
start_requested_stats();
/* Do we need to do dissection of packets? That depends on, among
other things, what taps are listening, so determine that after
starting the statistics taps. */
do_dissection = must_do_dissection(rfcode, dfcode, pdu_export_arg);
/* Process the packets in the file */
ws_debug("tshark: invoking process_cap_file() to process the packets");
TRY {
status = process_cap_file(&cfile, output_file_name, out_file_type, out_file_name_res,
#ifdef HAVE_LIBPCAP
global_capture_opts.has_autostop_packets ? global_capture_opts.autostop_packets : 0,
global_capture_opts.has_autostop_filesize ? global_capture_opts.autostop_filesize : 0,
global_capture_opts.has_autostop_written_packets ? global_capture_opts.autostop_written_packets : 0);
#else
max_packet_count,
0,
0);
#endif
}
CATCH(OutOfMemoryError) {
fprintf(stderr,
"Out Of Memory.\n"
"\n"
"Sorry, but TShark has to terminate now.\n"
"\n"
"More information and workarounds can be found at\n"
WS_WIKI_URL("KnownBugs/OutOfMemory") "\n");
status = PROCESS_FILE_ERROR;
}
ENDTRY;
switch (status) {
case PROCESS_FILE_SUCCEEDED:
/* Everything worked OK; draw the taps. */
draw_taps = TRUE;
break;
case PROCESS_FILE_NO_FILE_PROCESSED:
/* We never got to try to read the file, so there are no tap
results to dump. Exit with an error status. */
exit_status = 2;
break;
case PROCESS_FILE_ERROR:
/* We still dump out the results of taps, etc., as we might have
read some packets; however, we exit with an error status. */
draw_taps = TRUE;
exit_status = 2;
break;
case PROCESS_FILE_INTERRUPTED:
/* The user interrupted the read process; Don't dump out the
result of taps, etc., and exit with an error status. */
exit_status = 2;
break;
}
if (pdu_export_arg) {
if (!exp_pdu_close(&exp_pdu_tap_data, &err, &err_info)) {
cfile_close_failure_message(exp_pdu_filename, err, err_info);
exit_status = 2;
}
g_free(pdu_export_arg);
g_free(exp_pdu_filename);
}
} else {
ws_debug("tshark: no capture file specified");
/* No capture file specified, so we're supposed to do a live capture
or get a list of link-layer types for a live capture device;
do we have support for live captures? */
#ifdef HAVE_LIBPCAP
#ifdef _WIN32
/* Warn the user if npf.sys isn't loaded. */
if (!npf_sys_is_running()) {
fprintf(stderr, "The NPF driver isn't running. You may have trouble "
"capturing or\nlisting interfaces.\n");
}
#endif /* _WIN32 */
/* if no interface was specified, pick a default */
exit_status = capture_opts_default_iface_if_necessary(&global_capture_opts,
((prefs_p->capture_device) && (*prefs_p->capture_device != '\0')) ? get_if_name(prefs_p->capture_device) : NULL);
if (exit_status != 0) {
goto clean_exit;
}
/*
* If requested, list the link layer types and/or time stamp types
* and exit.
*/
if (caps_queries) {
guint i;
/* Get the list of link-layer types for the capture devices. */
exit_status = EXIT_SUCCESS;
for (i = 0; i < global_capture_opts.ifaces->len; i++) {
interface_options *interface_opts;
if_capabilities_t *caps;
char *auth_str = NULL;
interface_opts = &g_array_index(global_capture_opts.ifaces, interface_options, i);
#ifdef HAVE_PCAP_REMOTE
if (interface_opts->auth_type == CAPTURE_AUTH_PWD) {
auth_str = ws_strdup_printf("%s:%s", interface_opts->auth_username, interface_opts->auth_password);
}
#endif
caps = capture_get_if_capabilities(interface_opts->name, interface_opts->monitor_mode,
auth_str, &err_str, &err_str_secondary, NULL);
g_free(auth_str);
if (caps == NULL) {
cmdarg_err("%s%s%s", err_str, err_str_secondary ? "\n" : "", err_str_secondary ? err_str_secondary : "");
g_free(err_str);
g_free(err_str_secondary);
exit_status = WS_EXIT_INVALID_CAPABILITY;
break;
}
exit_status = capture_opts_print_if_capabilities(caps, interface_opts,
caps_queries);
free_if_capabilities(caps);
if (exit_status != EXIT_SUCCESS) {
break;
}
}
goto clean_exit;
}
/*
* If the standard error isn't a terminal, don't print packet counts,
* as they won't show up on the user's terminal and they'll get in
* the way of error messages in the file (to which we assume the
* standard error was redirected; if it's redirected to the null
* device, there's no point in printing packet counts anyway).
*
* Otherwise, if we're printing packet information and the standard
* output is a terminal (which we assume means the standard output and
* error are going to the same terminal), don't print packet counts,
* as they'll get in the way of the packet information.
*
* Otherwise, if the user specified -q, don't print packet counts.
*
* Otherwise, print packet counts.
*
* XXX - what if the user wants to do a live capture, doesn't want
* to save it to a file, doesn't want information printed for each
* packet, does want some "-z" statistic, and wants packet counts
* so they know whether they're seeing any packets? -q will
* suppress the information printed for each packet, but it'll
* also suppress the packet counts.
*/
if (!ws_isatty(ws_fileno(stderr)))
print_packet_counts = FALSE;
else if (print_packet_info && ws_isatty(ws_fileno(stdout)))
print_packet_counts = FALSE;
else if (quiet)
print_packet_counts = FALSE;
else
print_packet_counts = TRUE;
if (print_packet_info) {
if (!write_preamble(&cfile)) {
show_print_file_io_error();
exit_status = WS_EXIT_INVALID_FILE;
goto clean_exit;
}
}
ws_debug("tshark: performing live capture");
/* Start statistics taps; we should only do so after the capture
started successfully, so we know we have something to compute
stats, but we currently don't check for that - see below.
We do so after registering all dissectors, so that MATE will
have registered its field array so we can have a tap filter
with one of MATE's late-registered fields as part of the
filter. */
start_requested_stats();
/* Do we need to do dissection of packets? That depends on, among
other things, what taps are listening, so determine that after
starting the statistics taps. */
do_dissection = must_do_dissection(rfcode, dfcode, pdu_export_arg);
/*
* XXX - this returns FALSE if an error occurred, but it also
* returns FALSE if the capture stops because a time limit
* was reached (and possibly other limits), so we can't assume
* it means an error.
*
* The capture code is a bit twisty, so it doesn't appear to
* be an easy fix. We just ignore the return value for now.
* Instead, pass on the exit status from the capture child.
*/
capture();
exit_status = global_capture_session.fork_child_status;
if (print_packet_info) {
if (!write_finale()) {
show_print_file_io_error();
}
}
/*
* If we never got a capture file, don't draw the taps; we not only
* didn't capture any packets, we never even did any capturing.
*/
if (cfile.filename != NULL)
draw_taps = TRUE;
#else
/* No - complain. */
cmdarg_err("This version of TShark was not built with support for capturing packets.");
exit_status = INVALID_CAPTURE;
goto clean_exit;
#endif
}
if (cfile.provider.frames != NULL) {
free_frame_data_sequence(cfile.provider.frames);
cfile.provider.frames = NULL;
}
if (draw_taps)
draw_tap_listeners(TRUE);
if (tls_session_keys_file) {
gsize keylist_length;
gchar *keylist = ssl_export_sessions(&keylist_length);
write_file_binary_mode(tls_session_keys_file, keylist, keylist_length);
g_free(keylist);
}
/* Memory cleanup */
reset_tap_listeners();
funnel_dump_all_text_windows();
epan_free(cfile.epan);
epan_cleanup();
extcap_cleanup();
output_fields_free(output_fields);
output_fields = NULL;
clean_exit:
cf_close(&cfile);
g_free(cf_name);
destroy_print_stream(print_stream);
g_free(output_file_name);
#ifdef HAVE_LIBPCAP
capture_opts_cleanup(&global_capture_opts);
#endif
col_cleanup(&cfile.cinfo);
free_filter_lists();
wtap_cleanup();
free_progdirs();
dfilter_free(dfcode);
g_free(dfilter);
return exit_status;
}
gboolean loop_running = FALSE;
guint32 packet_count = 0;
static const nstime_t *
tshark_get_frame_ts(struct packet_provider_data *prov, guint32 frame_num)
{
if (prov->ref && prov->ref->num == frame_num)
return &prov->ref->abs_ts;
if (prov->prev_dis && prov->prev_dis->num == frame_num)
return &prov->prev_dis->abs_ts;
if (prov->prev_cap && prov->prev_cap->num == frame_num)
return &prov->prev_cap->abs_ts;
if (prov->frames) {
frame_data *fd = frame_data_sequence_find(prov->frames, frame_num);
return (fd) ? &fd->abs_ts : NULL;
}
return NULL;
}
static epan_t *
tshark_epan_new(capture_file *cf)
{
static const struct packet_provider_funcs funcs = {
tshark_get_frame_ts,
cap_file_provider_get_interface_name,
cap_file_provider_get_interface_description,
NULL,
};
return epan_new(&cf->provider, &funcs);
}
#ifdef HAVE_LIBPCAP
static gboolean
capture(void)
{
volatile gboolean ret = TRUE;
guint i;
GString *str;
GMainContext *ctx;
#ifndef _WIN32
struct sigaction action, oldaction;
#endif
/* Create new dissection section. */
epan_free(cfile.epan);
cfile.epan = tshark_epan_new(&cfile);
#ifdef _WIN32
/* Catch a CTRL+C event and, if we get it, clean up and exit. */
SetConsoleCtrlHandler(capture_cleanup, TRUE);
#else /* _WIN32 */
/* Catch SIGINT and SIGTERM and, if we get either of them,
clean up and exit. If SIGHUP isn't being ignored, catch
it too and, if we get it, clean up and exit.
We restart any read that was in progress, so that it doesn't
disrupt reading from the sync pipe. The signal handler tells
the capture child to finish; it will report that it finished,
or will exit abnormally, so we'll stop reading from the sync
pipe, pick up the exit status, and quit. */
memset(&action, 0, sizeof(action));
action.sa_handler = capture_cleanup;
action.sa_flags = SA_RESTART;
sigemptyset(&action.sa_mask);
sigaction(SIGTERM, &action, NULL);
sigaction(SIGINT, &action, NULL);
sigaction(SIGHUP, NULL, &oldaction);
if (oldaction.sa_handler == SIG_DFL)
sigaction(SIGHUP, &action, NULL);
#ifdef SIGINFO
/* Catch SIGINFO and, if we get it and we're capturing to a file in
quiet mode, report the number of packets we've captured.
Again, restart any read that was in progress, so that it doesn't
disrupt reading from the sync pipe. */
action.sa_handler = report_counts_siginfo;
action.sa_flags = SA_RESTART;
sigemptyset(&action.sa_mask);
sigaction(SIGINFO, &action, NULL);
#endif /* SIGINFO */
#endif /* _WIN32 */
global_capture_session.state = CAPTURE_PREPARING;
/* Let the user know which interfaces were chosen. */
for (i = 0; i < global_capture_opts.ifaces->len; i++) {
interface_options *interface_opts;
interface_opts = &g_array_index(global_capture_opts.ifaces, interface_options, i);
g_free(interface_opts->descr);
interface_opts->descr = get_interface_descriptive_name(interface_opts->name);
}
str = get_iface_list_string(&global_capture_opts, IFLIST_QUOTE_IF_DESCRIPTION);
if (really_quiet == FALSE)
fprintf(stderr, "Capturing on %s\n", str->str);
fflush(stderr);
g_string_free(str, TRUE);
ret = sync_pipe_start(&global_capture_opts, capture_comments,
&global_capture_session, &global_info_data, NULL);
if (!ret)
return FALSE;
/*
* Force synchronous resolution of IP addresses; we're doing only
* one pass, so we can't do it in the background and fix up past
* dissections.
*/
set_resolution_synchrony(TRUE);
/* the actual capture loop */
ctx = g_main_context_default();
loop_running = TRUE;
TRY
{
while (loop_running)
{
g_main_context_iteration(ctx, TRUE);
}
}
CATCH(OutOfMemoryError) {
fprintf(stderr,
"Out Of Memory.\n"
"\n"
"Sorry, but TShark has to terminate now.\n"
"\n"
"More information and workarounds can be found at\n"
WS_WIKI_URL("KnownBugs/OutOfMemory") "\n");
abort();
}
ENDTRY;