5 * Wireshark - Network traffic analyzer
6 * By Gerald Combs <gerald@wireshark.org>
7 * Copyright 1998 Gerald Combs
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
29 #include <stdlib.h> /* for exit() */
35 #ifdef HAVE_SYS_TYPES_H
36 # include <sys/types.h>
39 #ifdef HAVE_SYS_STAT_H
40 # include <sys/stat.h>
51 #ifdef HAVE_ARPA_INET_H
52 #include <arpa/inet.h>
55 #if defined(__APPLE__) && defined(__LP64__)
56 #include <sys/utsname.h>
63 #include "wsutil/wsgetopt.h"
71 # include <sys/prctl.h>
72 # include <sys/capability.h>
75 #include "ringbuffer.h"
76 #include "clopts_common.h"
77 #include "console_io.h"
78 #include "cmdarg_err.h"
79 #include "version_info.h"
81 #include "capture-pcap-util.h"
83 #include "capture-wpcap.h"
89 #include "capture-wpcap.h"
90 #include <wsutil/unicode-utils.h>
94 #include <sys/socket.h>
98 #ifdef NEED_INET_V6DEFS_H
99 # include "wsutil/inet_v6defs.h"
102 #include <wsutil/privileges.h>
104 #include "sync_pipe.h"
106 #include "capture_opts.h"
107 #include "capture_ifinfo.h"
108 #include "capture_sync.h"
110 #include "conditions.h"
111 #include "capture_stop_conditions.h"
113 #include "tempfile.h"
115 #include "wsutil/file_util.h"
118 * Get information about libpcap format from "wiretap/libpcap.h".
119 * XXX - can we just use pcap_open_offline() to read the pipe?
121 #include "wiretap/libpcap.h"
123 /**#define DEBUG_DUMPCAP**/
124 /**#define DEBUG_CHILD_DUMPCAP**/
128 #include <conio.h> /* _getch() */
132 #ifdef DEBUG_CHILD_DUMPCAP
133 FILE *debug_log; /* for logging debug messages to */
134 /* a file if DEBUG_CHILD_DUMPCAP */
138 static GAsyncQueue *pcap_queue;
139 static gint64 pcap_queue_bytes;
140 static gint64 pcap_queue_packets;
141 static gint64 pcap_queue_byte_limit = 1024 * 1024;
142 static gint64 pcap_queue_packet_limit = 1000;
144 static gboolean capture_child = FALSE; /* FALSE: standalone call, TRUE: this is an Wireshark capture child */
146 static gchar *sig_pipe_name = NULL;
147 static HANDLE sig_pipe_handle = NULL;
148 static gboolean signal_pipe_check_running(void);
152 static gboolean infodelay; /* if TRUE, don't print capture info in SIGINFO handler */
153 static gboolean infoprint; /* if TRUE, print capture info after clearing infodelay */
156 /** Stop a low-level capture (stops the capture child). */
157 static void capture_loop_stop(void);
159 #if !defined (__linux__)
160 #ifndef HAVE_PCAP_BREAKLOOP
162 * We don't have pcap_breakloop(), which is the only way to ensure that
163 * pcap_dispatch(), pcap_loop(), or even pcap_next() or pcap_next_ex()
164 * won't, if the call to read the next packet or batch of packets is
165 * is interrupted by a signal on UN*X, just go back and try again to
168 * On UN*X, we catch SIGINT as a "stop capturing" signal, and, in
169 * the signal handler, set a flag to stop capturing; however, without
170 * a guarantee of that sort, we can't guarantee that we'll stop capturing
171 * if the read will be retried and won't time out if no packets arrive.
173 * Therefore, on at least some platforms, we work around the lack of
174 * pcap_breakloop() by doing a select() on the pcap_t's file descriptor
175 * to wait for packets to arrive, so that we're probably going to be
176 * blocked in the select() when the signal arrives, and can just bail
177 * out of the loop at that point.
179 * However, we don't want to do that on BSD (because "select()" doesn't work
180 * correctly on BPF devices on at least some releases of some flavors of
181 * BSD), and we don't want to do it on Windows (because "select()" is
182 * something for sockets, not for arbitrary handles). (Note that "Windows"
183 * here includes Cygwin; even in its pretend-it's-UNIX environment, we're
184 * using WinPcap, not a UNIX libpcap.)
186 * Fortunately, we don't need to do it on BSD, because the libpcap timeout
187 * on BSD times out even if no packets have arrived, so we'll eventually
188 * exit pcap_dispatch() with an indication that no packets have arrived,
189 * and will break out of the capture loop at that point.
191 * On Windows, we can't send a SIGINT to stop capturing, so none of this
192 * applies in any case.
194 * XXX - the various BSDs appear to define BSD in <sys/param.h>; we don't
195 * want to include it if it's not present on this platform, however.
197 # if !defined(__FreeBSD__) && !defined(__NetBSD__) && !defined(__OpenBSD__) && \
198 !defined(__bsdi__) && !defined(__APPLE__) && !defined(_WIN32) && \
200 # define MUST_DO_SELECT
201 # endif /* avoid select */
202 #endif /* HAVE_PCAP_BREAKLOOP */
204 /* whatever the deal with pcap_breakloop, linux doesn't support timeouts
205 * in pcap_dispatch(); on the other hand, select() works just fine there.
206 * Hence we use a select for that come what may.
208 #define MUST_DO_SELECT
211 /** init the capture filter */
214 INITFILTER_BAD_FILTER,
215 INITFILTER_OTHER_ERROR
216 } initfilter_status_t;
218 typedef struct _pcap_options {
222 #ifdef MUST_DO_SELECT
223 int pcap_fd; /* pcap file descriptor */
230 gboolean ts_nsec; /* TRUE if we're using nanosecond precision. */
231 /* capture pipe (unix only "input file") */
232 gboolean from_cap_pipe; /* TRUE if we are capturing data from a capture pipe */
233 struct pcap_hdr cap_pipe_hdr; /* Pcap header when capturing from a pipe */
234 struct pcaprec_modified_hdr cap_pipe_rechdr; /* Pcap record header when capturing from a pipe */
236 HANDLE cap_pipe_h; /* The handle of the capture pipe */
238 int cap_pipe_fd; /* the file descriptor of the capture pipe */
240 gboolean cap_pipe_modified; /* TRUE if data in the pipe uses modified pcap headers */
241 gboolean cap_pipe_byte_swapped; /* TRUE if data in the pipe is byte swapped */
243 char * cap_pipe_buf; /* Pointer to the data buffer we read into */
245 int cap_pipe_bytes_to_read;/* Used by cap_pipe_dispatch */
246 int cap_pipe_bytes_read; /* Used by cap_pipe_dispatch */
248 STATE_EXPECT_REC_HDR,
253 enum { PIPOK, PIPEOF, PIPERR, PIPNEXIST } cap_pipe_err;
255 GMutex *cap_pipe_read_mtx;
256 GAsyncQueue *cap_pipe_pending_q, *cap_pipe_done_q;
260 typedef struct _loop_data {
262 gboolean go; /* TRUE as long as we're supposed to keep capturing */
263 int err; /* if non-zero, error seen while capturing */
264 gint packet_count; /* Number of packets we have already captured */
265 gint packet_max; /* Number of packets we're supposed to capture - 0 means infinite */
266 gint inpkts_to_sync_pipe; /* Packets not already send out to the sync_pipe */
268 gboolean report_packet_count; /* Set by SIGINFO handler; print packet count */
275 guint32 autostop_files;
278 typedef struct _pcap_queue_element {
279 pcap_options *pcap_opts;
280 struct pcap_pkthdr phdr;
282 } pcap_queue_element;
285 * Standard secondary message for unexpected errors.
287 static const char please_report[] =
288 "Please report this to the Wireshark developers.\n"
289 "(This is not a crash; please do not report it as such.)";
292 * This needs to be static, so that the SIGINT handler can clear the "go"
295 static loop_data global_ld;
299 * Timeout, in milliseconds, for reads from the stream of captured packets
300 * from a capture device.
302 * A bug in Mac OS X 10.6 and 10.6.1 causes calls to pcap_open_live(), in
303 * 64-bit applications, with sub-second timeouts not to work. The bug is
304 * fixed in 10.6.2, re-broken in 10.6.3, and again fixed in 10.6.5.
306 #if defined(__APPLE__) && defined(__LP64__)
307 static gboolean need_timeout_workaround;
309 #define CAP_READ_TIMEOUT (need_timeout_workaround ? 1000 : 250)
311 #define CAP_READ_TIMEOUT 250
315 * Timeout, in microseconds, for reads from the stream of captured packets
316 * from a pipe. Pipes don't have the same problem that BPF devices do
317 * in OS X 10.6, 10.6.1, 10.6.3, and 10.6.4, so we always use a timeout
318 * of 250ms, i.e. the same value as CAP_READ_TIMEOUT when not on one
319 * of the offending versions of Snow Leopard.
321 * On Windows this value is converted to milliseconds and passed to
322 * WaitForSingleObject. If it's less than 1000 WaitForSingleObject
323 * will return immediately.
326 #define PIPE_READ_TIMEOUT 100000
328 #define PIPE_READ_TIMEOUT 250000
331 #define WRITER_THREAD_TIMEOUT 100000 /* usecs */
334 console_log_handler(const char *log_domain, GLogLevelFlags log_level,
335 const char *message, gpointer user_data _U_);
337 /* capture related options */
338 static capture_options global_capture_opts;
339 static gboolean quiet = FALSE;
340 static gboolean use_threads = FALSE;
341 static guint64 start_time;
343 static void capture_loop_write_packet_cb(u_char *pcap_opts_p, const struct pcap_pkthdr *phdr,
345 static void capture_loop_queue_packet_cb(u_char *pcap_opts_p, const struct pcap_pkthdr *phdr,
347 static void capture_loop_get_errmsg(char *errmsg, int errmsglen, const char *fname,
348 int err, gboolean is_close);
350 static void WS_MSVC_NORETURN exit_main(int err) G_GNUC_NORETURN;
352 static void report_new_capture_file(const char *filename);
353 static void report_packet_count(int packet_count);
354 static void report_packet_drops(guint32 received, guint32 drops, gchar *name);
355 static void report_capture_error(const char *error_msg, const char *secondary_error_msg);
356 static void report_cfilter_error(capture_options *capture_opts, guint i, const char *errmsg);
358 #define MSG_MAX_LENGTH 4096
360 /* Copied from pcapio.c libpcap_write_interface_statistics_block()*/
362 create_timestamp(void) {
372 * Current time, represented as 100-nanosecond intervals since
373 * January 1, 1601, 00:00:00 UTC.
375 * I think DWORD might be signed, so cast both parts of "now"
376 * to guint32 so that the sign bit doesn't get treated specially.
378 * Windows 8 provides GetSystemTimePreciseAsFileTime which we
379 * might want to use instead.
381 GetSystemTimeAsFileTime(&now);
382 timestamp = (((guint64)(guint32)now.dwHighDateTime) << 32) +
383 (guint32)now.dwLowDateTime;
386 * Convert to same thing but as 1-microsecond, i.e. 1000-nanosecond,
392 * Subtract difference, in microseconds, between January 1, 1601
393 * 00:00:00 UTC and January 1, 1970, 00:00:00 UTC.
395 timestamp -= G_GINT64_CONSTANT(11644473600000000U);
398 * Current time, represented as seconds and microseconds since
399 * January 1, 1970, 00:00:00 UTC.
401 gettimeofday(&now, NULL);
404 * Convert to delta in microseconds.
406 timestamp = (guint64)(now.tv_sec) * 1000000 +
407 (guint64)(now.tv_usec);
413 print_usage(gboolean print_ver)
420 "Dumpcap " VERSION "%s\n"
421 "Capture network packets and dump them into a pcapng file.\n"
422 "See http://www.wireshark.org for more information.\n",
423 wireshark_svnversion);
427 fprintf(output, "\nUsage: dumpcap [options] ...\n");
428 fprintf(output, "\n");
429 fprintf(output, "Capture interface:\n");
430 fprintf(output, " -i <interface> name or idx of interface (def: first non-loopback)\n");
431 fprintf(output, " -f <capture filter> packet filter in libpcap filter syntax\n");
432 fprintf(output, " -s <snaplen> packet snapshot length (def: 65535)\n");
433 fprintf(output, " -p don't capture in promiscuous mode\n");
434 #ifdef HAVE_PCAP_CREATE
435 fprintf(output, " -I capture in monitor mode, if available\n");
437 #if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
438 fprintf(output, " -B <buffer size> size of kernel buffer (def: 1MB)\n");
440 fprintf(output, " -y <link type> link layer type (def: first appropriate)\n");
441 fprintf(output, " -D print list of interfaces and exit\n");
442 fprintf(output, " -L print list of link-layer types of iface and exit\n");
443 #ifdef HAVE_BPF_IMAGE
444 fprintf(output, " -d print generated BPF code for capture filter\n");
446 fprintf(output, " -S print statistics for each interface once per second\n");
447 fprintf(output, " -M for -D, -L, and -S, produce machine-readable output\n");
448 fprintf(output, "\n");
449 #ifdef HAVE_PCAP_REMOTE
450 fprintf(output, "RPCAP options:\n");
451 fprintf(output, " -r don't ignore own RPCAP traffic in capture\n");
452 fprintf(output, " -u use UDP for RPCAP data transfer\n");
453 fprintf(output, " -A <user>:<password> use RPCAP password authentication\n");
454 #ifdef HAVE_PCAP_SETSAMPLING
455 fprintf(output, " -m <sampling type> use packet sampling\n");
456 fprintf(output, " count:NUM - capture one packet of every NUM\n");
457 fprintf(output, " timer:NUM - capture no more than 1 packet in NUM ms\n");
460 fprintf(output, "Stop conditions:\n");
461 fprintf(output, " -c <packet count> stop after n packets (def: infinite)\n");
462 fprintf(output, " -a <autostop cond.> ... duration:NUM - stop after NUM seconds\n");
463 fprintf(output, " filesize:NUM - stop this file after NUM KB\n");
464 fprintf(output, " files:NUM - stop after NUM files\n");
465 /*fprintf(output, "\n");*/
466 fprintf(output, "Output (files):\n");
467 fprintf(output, " -w <filename> name of file to save (def: tempfile)\n");
468 fprintf(output, " -g enable group read access on the output file(s)\n");
469 fprintf(output, " -b <ringbuffer opt.> ... duration:NUM - switch to next file after NUM secs\n");
470 fprintf(output, " filesize:NUM - switch to next file after NUM KB\n");
471 fprintf(output, " files:NUM - ringbuffer: replace after NUM files\n");
472 fprintf(output, " -n use pcapng format instead of pcap (default)\n");
473 fprintf(output, " -P use libpcap format instead of pcapng\n");
474 fprintf(output, "\n");
475 fprintf(output, "Miscellaneous:\n");
476 fprintf(output, " -t use a separate thread per interface\n");
477 fprintf(output, " -q don't report packet capture counts\n");
478 fprintf(output, " -v print version information and exit\n");
479 fprintf(output, " -h display this help and exit\n");
480 fprintf(output, "\n");
481 fprintf(output, "Example: dumpcap -i eth0 -a duration:60 -w output.pcapng\n");
482 fprintf(output, "\"Capture network packets from interface eth0 until 60s passed into output.pcapng\"\n");
483 fprintf(output, "\n");
484 fprintf(output, "Use Ctrl-C to stop capturing at any time.\n");
488 show_version(GString *comp_info_str, GString *runtime_info_str)
491 "Dumpcap " VERSION "%s\n"
496 "See http://www.wireshark.org for more information.\n",
497 wireshark_svnversion, get_copyright_info() ,comp_info_str->str, runtime_info_str->str);
501 * Print to the standard error. This is a command-line tool, so there's
502 * no need to pop up a console.
505 vfprintf_stderr(const char *fmt, va_list ap)
507 vfprintf(stderr, fmt, ap);
511 fprintf_stderr(const char *fmt, ...)
516 vfprintf_stderr(fmt, ap);
521 * Report an error in command-line arguments.
524 cmdarg_err(const char *fmt, ...)
530 /* Generate a 'special format' message back to parent */
532 msg = g_strdup_vprintf(fmt, ap);
533 sync_pipe_errmsg_to_parent(2, msg, "");
538 fprintf(stderr, "dumpcap: ");
539 vfprintf(stderr, fmt, ap);
540 fprintf(stderr, "\n");
546 * Report additional information for an error in command-line arguments.
549 cmdarg_err_cont(const char *fmt, ...)
556 msg = g_strdup_vprintf(fmt, ap);
557 sync_pipe_errmsg_to_parent(2, msg, "");
562 vfprintf(stderr, fmt, ap);
563 fprintf(stderr, "\n");
570 #if 0 /* Set to enable capability debugging */
571 /* see 'man cap_to_text()' for explanation of output */
572 /* '=' means 'all= ' ie: no capabilities */
573 /* '=ip' means 'all=ip' ie: all capabilities are permissible and inheritable */
575 print_caps(const char *pfx) {
576 cap_t caps = cap_get_proc();
577 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
578 "%s: EUID: %d Capabilities: %s", pfx,
579 geteuid(), cap_to_text(caps, NULL));
582 print_caps(const char *pfx _U_) {
587 relinquish_all_capabilities(void)
589 /* Drop any and all capabilities this process may have. */
590 /* Allowed whether or not process has any privileges. */
591 cap_t caps = cap_init(); /* all capabilities initialized to off */
592 print_caps("Pre-clear");
593 if (cap_set_proc(caps)) {
594 cmdarg_err("cap_set_proc() fail return: %s", g_strerror(errno));
596 print_caps("Post-clear");
602 open_capture_device(interface_options *interface_opts,
603 char (*open_err_str)[PCAP_ERRBUF_SIZE])
606 #ifdef HAVE_PCAP_CREATE
609 #if defined(HAVE_PCAP_OPEN) && defined(HAVE_PCAP_REMOTE)
610 struct pcap_rmtauth auth;
613 /* Open the network interface to capture from it.
614 Some versions of libpcap may put warnings into the error buffer
615 if they succeed; to tell if that's happened, we have to clear
616 the error buffer, and check if it's still a null string. */
617 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "Entering open_capture_device().");
618 (*open_err_str)[0] = '\0';
619 #if defined(HAVE_PCAP_OPEN) && defined(HAVE_PCAP_REMOTE)
621 * If we're opening a remote device, use pcap_open(); that's currently
622 * the only open routine that supports remote devices.
624 if (strncmp (interface_opts->name, "rpcap://", 8) == 0) {
625 auth.type = interface_opts->auth_type == CAPTURE_AUTH_PWD ?
626 RPCAP_RMTAUTH_PWD : RPCAP_RMTAUTH_NULL;
627 auth.username = interface_opts->auth_username;
628 auth.password = interface_opts->auth_password;
630 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
631 "Calling pcap_open() using name %s, snaplen %d, promisc_mode %d, datatx_udp %d, nocap_rpcap %d.",
632 interface_opts->name, interface_opts->snaplen, interface_opts->promisc_mode,
633 interface_opts->datatx_udp, interface_opts->nocap_rpcap);
634 pcap_h = pcap_open(interface_opts->name, interface_opts->snaplen,
636 (interface_opts->promisc_mode ? PCAP_OPENFLAG_PROMISCUOUS : 0) |
637 (interface_opts->datatx_udp ? PCAP_OPENFLAG_DATATX_UDP : 0) |
638 (interface_opts->nocap_rpcap ? PCAP_OPENFLAG_NOCAPTURE_RPCAP : 0),
639 CAP_READ_TIMEOUT, &auth, *open_err_str);
640 if ((*open_err_str)[0] == '\0') {
641 /* Work around known WinPcap bug wherein no error message is
642 filled in on a failure to open an rpcap: URL. */
643 g_strlcpy(*open_err_str,
644 "Unknown error (pcap bug; actual error cause not reported)",
645 sizeof *open_err_str);
647 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
648 "pcap_open() returned %p.", (void *)pcap_h);
653 * If we're not opening a remote device, use pcap_create() and
654 * pcap_activate() if we have them, so that we can set the buffer
655 * size, otherwise use pcap_open_live().
657 #ifdef HAVE_PCAP_CREATE
658 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
659 "Calling pcap_create() using %s.", interface_opts->name);
660 pcap_h = pcap_create(interface_opts->name, *open_err_str);
661 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
662 "pcap_create() returned %p.", (void *)pcap_h);
663 if (pcap_h != NULL) {
664 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
665 "Calling pcap_set_snaplen() with snaplen %d.", interface_opts->snaplen);
666 pcap_set_snaplen(pcap_h, interface_opts->snaplen);
667 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
668 "Calling pcap_set_promisc() with promisc_mode %d.", interface_opts->promisc_mode);
669 pcap_set_promisc(pcap_h, interface_opts->promisc_mode);
670 pcap_set_timeout(pcap_h, CAP_READ_TIMEOUT);
672 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
673 "buffersize %d.", interface_opts->buffer_size);
674 if (interface_opts->buffer_size != 0) {
675 pcap_set_buffer_size(pcap_h, interface_opts->buffer_size * 1024 * 1024);
677 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
678 "monitor_mode %d.", interface_opts->monitor_mode);
679 if (interface_opts->monitor_mode)
680 pcap_set_rfmon(pcap_h, 1);
681 err = pcap_activate(pcap_h);
682 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
683 "pcap_activate() returned %d.", err);
685 /* Failed to activate, set to NULL */
686 if (err == PCAP_ERROR)
687 g_strlcpy(*open_err_str, pcap_geterr(pcap_h), sizeof *open_err_str);
689 g_strlcpy(*open_err_str, pcap_statustostr(err), sizeof *open_err_str);
695 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
696 "pcap_open_live() calling using name %s, snaplen %d, promisc_mode %d.",
697 interface_opts->name, interface_opts->snaplen, interface_opts->promisc_mode);
698 pcap_h = pcap_open_live(interface_opts->name, interface_opts->snaplen,
699 interface_opts->promisc_mode, CAP_READ_TIMEOUT,
701 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
702 "pcap_open_live() returned %p.", (void *)pcap_h);
705 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "open_capture_device %s : %s", pcap_h ? "SUCCESS" : "FAILURE", interface_opts->name);
710 get_capture_device_open_failure_messages(const char *open_err_str,
716 char *errmsg, size_t errmsg_len,
717 char *secondary_errmsg,
718 size_t secondary_errmsg_len)
721 const char *libpcap_warn;
722 static const char ppamsg[] = "can't find PPA for ";
725 g_snprintf(errmsg, (gulong) errmsg_len,
726 "The capture session could not be initiated (%s).", open_err_str);
729 g_snprintf(secondary_errmsg, (gulong) secondary_errmsg_len,
731 "In order to capture packets, WinPcap must be installed; see\n"
733 " http://www.winpcap.org/\n"
737 " http://www.mirrors.wiretapped.net/security/packet-capture/winpcap/\n"
741 " http://winpcap.cs.pu.edu.tw/\n"
743 "for a downloadable version of WinPcap and for instructions on how to install\n"
746 g_snprintf(secondary_errmsg, (gulong) secondary_errmsg_len,
748 "Please check that \"%s\" is the proper interface.\n"
751 "Help can be found at:\n"
753 " http://wiki.wireshark.org/WinPcap\n"
754 " http://wiki.wireshark.org/CaptureSetup\n",
758 /* If we got a "can't find PPA for X" message, warn the user (who
759 is running dumpcap on HP-UX) that they don't have a version of
760 libpcap that properly handles HP-UX (libpcap 0.6.x and later
761 versions, which properly handle HP-UX, say "can't find /dev/dlpi
762 PPA for X" rather than "can't find PPA for X"). */
763 if (strncmp(open_err_str, ppamsg, sizeof ppamsg - 1) == 0)
766 "You are running (T)Wireshark with a version of the libpcap library\n"
767 "that doesn't handle HP-UX network devices well; this means that\n"
768 "(T)Wireshark may not be able to capture packets.\n"
770 "To fix this, you should install libpcap 0.6.2, or a later version\n"
771 "of libpcap, rather than libpcap 0.4 or 0.5.x. It is available in\n"
772 "packaged binary form from the Software Porting And Archive Centre\n"
773 "for HP-UX; the Centre is at http://hpux.connect.org.uk/ - the page\n"
774 "at the URL lists a number of mirror sites.";
778 g_snprintf(secondary_errmsg, (gulong) secondary_errmsg_len,
779 "Please check to make sure you have sufficient permissions, and that you have "
780 "the proper interface or pipe specified.%s", libpcap_warn);
784 /* Set the data link type on a pcap. */
786 set_pcap_linktype(pcap_t *pcap_h, int linktype,
787 #ifdef HAVE_PCAP_SET_DATALINK
792 char *errmsg, size_t errmsg_len,
793 char *secondary_errmsg, size_t secondary_errmsg_len)
795 char *set_linktype_err_str;
798 return TRUE; /* just use the default */
799 #ifdef HAVE_PCAP_SET_DATALINK
800 if (pcap_set_datalink(pcap_h, linktype) == 0)
801 return TRUE; /* no error */
802 set_linktype_err_str = pcap_geterr(pcap_h);
804 /* Let them set it to the type it is; reject any other request. */
805 if (get_pcap_linktype(pcap_h, name) == linktype)
806 return TRUE; /* no error */
807 set_linktype_err_str =
808 "That DLT isn't one of the DLTs supported by this device";
810 g_snprintf(errmsg, (gulong) errmsg_len, "Unable to set data link type (%s).",
811 set_linktype_err_str);
813 * If the error isn't "XXX is not one of the DLTs supported by this device",
814 * tell the user to tell the Wireshark developers about it.
816 if (strstr(set_linktype_err_str, "is not one of the DLTs supported by this device") == NULL)
817 g_snprintf(secondary_errmsg, (gulong) secondary_errmsg_len, please_report);
819 secondary_errmsg[0] = '\0';
824 compile_capture_filter(const char *iface, pcap_t *pcap_h,
825 struct bpf_program *fcode, const char *cfilter)
827 bpf_u_int32 netnum, netmask;
828 gchar lookup_net_err_str[PCAP_ERRBUF_SIZE];
830 if (pcap_lookupnet(iface, &netnum, &netmask, lookup_net_err_str) < 0) {
832 * Well, we can't get the netmask for this interface; it's used
833 * only for filters that check for broadcast IP addresses, so
834 * we just punt and use 0. It might be nice to warn the user,
835 * but that's a pain in a GUI application, as it'd involve popping
836 * up a message box, and it's not clear how often this would make
837 * a difference (only filters that check for IP broadcast addresses
841 "Warning: Couldn't obtain netmask info (%s).", lookup_net_err_str);*/
846 * Sigh. Older versions of libpcap don't properly declare the
847 * third argument to pcap_compile() as a const pointer. Cast
850 if (pcap_compile(pcap_h, fcode, (char *)cfilter, 1, netmask) < 0)
855 #ifdef HAVE_BPF_IMAGE
857 show_filter_code(capture_options *capture_opts)
859 interface_options interface_opts;
861 gchar open_err_str[PCAP_ERRBUF_SIZE];
862 char errmsg[MSG_MAX_LENGTH+1];
863 char secondary_errmsg[MSG_MAX_LENGTH+1];
864 struct bpf_program fcode;
865 struct bpf_insn *insn;
869 for (j = 0; j < capture_opts->ifaces->len; j++) {
870 interface_opts = g_array_index(capture_opts->ifaces, interface_options, j);
871 pcap_h = open_capture_device(&interface_opts, &open_err_str);
872 if (pcap_h == NULL) {
873 /* Open failed; get messages */
874 get_capture_device_open_failure_messages(open_err_str,
876 errmsg, sizeof errmsg,
878 sizeof secondary_errmsg);
879 /* And report them */
880 report_capture_error(errmsg, secondary_errmsg);
884 /* Set the link-layer type. */
885 if (!set_pcap_linktype(pcap_h, interface_opts.linktype, interface_opts.name,
886 errmsg, sizeof errmsg,
887 secondary_errmsg, sizeof secondary_errmsg)) {
889 report_capture_error(errmsg, secondary_errmsg);
893 /* OK, try to compile the capture filter. */
894 if (!compile_capture_filter(interface_opts.name, pcap_h, &fcode,
895 interface_opts.cfilter)) {
897 report_cfilter_error(capture_opts, j, errmsg);
902 /* Now print the filter code. */
903 insn = fcode.bf_insns;
905 for (i = 0; i < fcode.bf_len; insn++, i++)
906 printf("%s\n", bpf_image(insn, i));
908 /* If not using libcap: we now can now set euid/egid to ruid/rgid */
909 /* to remove any suid privileges. */
910 /* If using libcap: we can now remove NET_RAW and NET_ADMIN capabilities */
911 /* (euid/egid have already previously been set to ruid/rgid. */
912 /* (See comment in main() for details) */
914 relinquish_special_privs_perm();
916 relinquish_all_capabilities();
919 /* Let our parent know we succeeded. */
920 pipe_write_block(2, SP_SUCCESS, NULL);
927 * capture_interface_list() is expected to do the right thing to get
928 * a list of interfaces.
930 * In most of the programs in the Wireshark suite, "the right thing"
931 * is to run dumpcap and ask it for the list, because dumpcap may
932 * be the only program in the suite with enough privileges to get
935 * In dumpcap itself, however, we obviously can't run dumpcap to
936 * ask for the list. Therefore, our capture_interface_list() should
937 * just call get_interface_list().
940 capture_interface_list(int *err, char **err_str)
942 return get_interface_list(err, err_str);
946 * Get the data-link type for a libpcap device.
947 * This works around AIX 5.x's non-standard and incompatible-with-the-
948 * rest-of-the-universe libpcap.
951 get_pcap_linktype(pcap_t *pch, const char *devname
959 const char *ifacename;
962 linktype = pcap_datalink(pch);
966 * The libpcap that comes with AIX 5.x uses RFC 1573 ifType values
967 * rather than DLT_ values for link-layer types; the ifType values
968 * for LAN devices are:
975 * and the ifType value for a loopback device is 24.
977 * The AIX names for LAN devices begin with:
984 * and the AIX names for loopback devices begin with "lo".
986 * (The difference between "Ethernet" and "802.3" is presumably
987 * whether packets have an Ethernet header, with a packet type,
988 * or an 802.3 header, with a packet length, followed by an 802.2
989 * header and possibly a SNAP header.)
991 * If the device name matches "linktype" interpreted as an ifType
992 * value, rather than as a DLT_ value, we will assume this is AIX's
993 * non-standard, incompatible libpcap, rather than a standard libpcap,
994 * and will map the link-layer type to the standard DLT_ value for
995 * that link-layer type, as that's what the rest of Wireshark expects.
997 * (This means the capture files won't be readable by a tcpdump
998 * linked with AIX's non-standard libpcap, but so it goes. They
999 * *will* be readable by standard versions of tcpdump, Wireshark,
1002 * XXX - if we conclude we're using AIX libpcap, should we also
1003 * set a flag to cause us to assume the time stamps are in
1004 * seconds-and-nanoseconds form, and to convert them to
1005 * seconds-and-microseconds form before processing them and
1010 * Find the last component of the device name, which is the
1013 ifacename = strchr(devname, '/');
1014 if (ifacename == NULL)
1015 ifacename = devname;
1017 /* See if it matches any of the LAN device names. */
1018 if (strncmp(ifacename, "en", 2) == 0) {
1019 if (linktype == 6) {
1021 * That's the RFC 1573 value for Ethernet; map it to DLT_EN10MB.
1025 } else if (strncmp(ifacename, "et", 2) == 0) {
1026 if (linktype == 7) {
1028 * That's the RFC 1573 value for 802.3; map it to DLT_EN10MB.
1029 * (libpcap, tcpdump, Wireshark, etc. don't care if it's Ethernet
1034 } else if (strncmp(ifacename, "tr", 2) == 0) {
1035 if (linktype == 9) {
1037 * That's the RFC 1573 value for 802.5 (Token Ring); map it to
1038 * DLT_IEEE802, which is what's used for Token Ring.
1042 } else if (strncmp(ifacename, "fi", 2) == 0) {
1043 if (linktype == 15) {
1045 * That's the RFC 1573 value for FDDI; map it to DLT_FDDI.
1049 } else if (strncmp(ifacename, "lo", 2) == 0) {
1050 if (linktype == 24) {
1052 * That's the RFC 1573 value for "software loopback" devices; map it
1053 * to DLT_NULL, which is what's used for loopback devices on BSD.
1063 static data_link_info_t *
1064 create_data_link_info(int dlt)
1066 data_link_info_t *data_link_info;
1069 data_link_info = (data_link_info_t *)g_malloc(sizeof (data_link_info_t));
1070 data_link_info->dlt = dlt;
1071 text = pcap_datalink_val_to_name(dlt);
1073 data_link_info->name = g_strdup(text);
1075 data_link_info->name = g_strdup_printf("DLT %d", dlt);
1076 text = pcap_datalink_val_to_description(dlt);
1078 data_link_info->description = g_strdup(text);
1080 data_link_info->description = NULL;
1081 return data_link_info;
1085 * Get the capabilities of a network device.
1087 static if_capabilities_t *
1088 get_if_capabilities(const char *devname, gboolean monitor_mode
1089 #ifndef HAVE_PCAP_CREATE
1094 if_capabilities_t *caps;
1095 char errbuf[PCAP_ERRBUF_SIZE];
1097 #ifdef HAVE_PCAP_CREATE
1101 #ifdef HAVE_PCAP_LIST_DATALINKS
1105 data_link_info_t *data_link_info;
1108 * Allocate the interface capabilities structure.
1110 caps = g_malloc(sizeof *caps);
1113 * WinPcap 4.1.2, and possibly earlier versions, have a bug
1114 * wherein, when an open with an rpcap: URL fails, the error
1115 * message for the error is not copied to errbuf and whatever
1116 * on-the-stack junk is in errbuf is treated as the error
1119 * To work around that (and any other bugs of that sort, we
1120 * initialize errbuf to an empty string. If we get an error
1121 * and the string is empty, we report it as an unknown error.
1122 * (If we *don't* get an error, and the string is *non*-empty,
1123 * that could be a warning returned, such as "can't turn
1124 * promiscuous mode on"; we currently don't do so.)
1127 #ifdef HAVE_PCAP_OPEN
1128 pch = pcap_open(devname, MIN_PACKET_SIZE, 0, 0, NULL, errbuf);
1129 caps->can_set_rfmon = FALSE;
1131 if (err_str != NULL)
1132 *err_str = g_strdup(errbuf[0] == '\0' ? "Unknown error (pcap bug; actual error cause not reported)" : errbuf);
1136 #elif defined(HAVE_PCAP_CREATE)
1137 pch = pcap_create(devname, errbuf);
1139 if (err_str != NULL)
1140 *err_str = g_strdup(errbuf);
1144 status = pcap_can_set_rfmon(pch);
1147 if (status == PCAP_ERROR)
1148 *err_str = g_strdup_printf("pcap_can_set_rfmon() failed: %s",
1151 *err_str = g_strdup(pcap_statustostr(status));
1157 caps->can_set_rfmon = FALSE;
1158 else if (status == 1) {
1159 caps->can_set_rfmon = TRUE;
1161 pcap_set_rfmon(pch, 1);
1163 if (err_str != NULL) {
1164 *err_str = g_strdup_printf("pcap_can_set_rfmon() returned %d",
1172 status = pcap_activate(pch);
1174 /* Error. We ignore warnings (status > 0). */
1175 if (err_str != NULL) {
1176 if (status == PCAP_ERROR)
1177 *err_str = g_strdup_printf("pcap_activate() failed: %s",
1180 *err_str = g_strdup(pcap_statustostr(status));
1187 pch = pcap_open_live(devname, MIN_PACKET_SIZE, 0, 0, errbuf);
1188 caps->can_set_rfmon = FALSE;
1190 if (err_str != NULL)
1191 *err_str = g_strdup(errbuf[0] == '\0' ? "Unknown error (pcap bug; actual error cause not reported)" : errbuf);
1196 deflt = get_pcap_linktype(pch, devname);
1197 #ifdef HAVE_PCAP_LIST_DATALINKS
1198 nlt = pcap_list_datalinks(pch, &linktypes);
1199 if (nlt == 0 || linktypes == NULL) {
1201 if (err_str != NULL)
1202 *err_str = NULL; /* an empty list doesn't mean an error */
1206 caps->data_link_types = NULL;
1207 for (i = 0; i < nlt; i++) {
1208 data_link_info = create_data_link_info(linktypes[i]);
1211 * XXX - for 802.11, make the most detailed 802.11
1212 * version the default, rather than the one the
1213 * device has as the default?
1215 if (linktypes[i] == deflt)
1216 caps->data_link_types = g_list_prepend(caps->data_link_types,
1219 caps->data_link_types = g_list_append(caps->data_link_types,
1222 #ifdef HAVE_PCAP_FREE_DATALINKS
1223 pcap_free_datalinks(linktypes);
1226 * In Windows, there's no guarantee that if you have a library
1227 * built with one version of the MSVC++ run-time library, and
1228 * it returns a pointer to allocated data, you can free that
1229 * data from a program linked with another version of the
1230 * MSVC++ run-time library.
1232 * This is not an issue on UN*X.
1234 * See the mail threads starting at
1236 * http://www.winpcap.org/pipermail/winpcap-users/2006-September/001421.html
1240 * http://www.winpcap.org/pipermail/winpcap-users/2008-May/002498.html
1243 #define xx_free free /* hack so checkAPIs doesn't complain */
1246 #endif /* HAVE_PCAP_FREE_DATALINKS */
1247 #else /* HAVE_PCAP_LIST_DATALINKS */
1249 data_link_info = create_data_link_info(deflt);
1250 caps->data_link_types = g_list_append(caps->data_link_types,
1252 #endif /* HAVE_PCAP_LIST_DATALINKS */
1256 if (err_str != NULL)
1261 #define ADDRSTRLEN 46 /* Covers IPv4 & IPv6 */
1263 print_machine_readable_interfaces(GList *if_list)
1270 char addr_str[ADDRSTRLEN];
1272 if (capture_child) {
1273 /* Let our parent know we succeeded. */
1274 pipe_write_block(2, SP_SUCCESS, NULL);
1277 i = 1; /* Interface id number */
1278 for (if_entry = g_list_first(if_list); if_entry != NULL;
1279 if_entry = g_list_next(if_entry)) {
1280 if_info = (if_info_t *)if_entry->data;
1281 printf("%d. %s", i++, if_info->name);
1284 * Print the contents of the if_entry struct in a parseable format.
1285 * Each if_entry element is tab-separated. Addresses are comma-
1288 /* XXX - Make sure our description doesn't contain a tab */
1289 if (if_info->description != NULL)
1290 printf("\t%s\t", if_info->description);
1294 for(addr = g_slist_nth(if_info->addrs, 0); addr != NULL;
1295 addr = g_slist_next(addr)) {
1296 if (addr != g_slist_nth(if_info->addrs, 0))
1299 if_addr = (if_addr_t *)addr->data;
1300 switch(if_addr->ifat_type) {
1302 if (inet_ntop(AF_INET, &if_addr->addr.ip4_addr, addr_str,
1304 printf("%s", addr_str);
1306 printf("<unknown IPv4>");
1310 if (inet_ntop(AF_INET6, &if_addr->addr.ip6_addr,
1311 addr_str, ADDRSTRLEN)) {
1312 printf("%s", addr_str);
1314 printf("<unknown IPv6>");
1318 printf("<type unknown %u>", if_addr->ifat_type);
1322 if (if_info->loopback)
1323 printf("\tloopback");
1325 printf("\tnetwork");
1332 * If you change the machine-readable output format of this function,
1333 * you MUST update capture_ifinfo.c:capture_get_if_capabilities() accordingly!
1336 print_machine_readable_if_capabilities(if_capabilities_t *caps)
1339 data_link_info_t *data_link_info;
1340 const gchar *desc_str;
1342 if (capture_child) {
1343 /* Let our parent know we succeeded. */
1344 pipe_write_block(2, SP_SUCCESS, NULL);
1347 if (caps->can_set_rfmon)
1351 for (lt_entry = caps->data_link_types; lt_entry != NULL;
1352 lt_entry = g_list_next(lt_entry)) {
1353 data_link_info = (data_link_info_t *)lt_entry->data;
1354 if (data_link_info->description != NULL)
1355 desc_str = data_link_info->description;
1357 desc_str = "(not supported)";
1358 printf("%d\t%s\t%s\n", data_link_info->dlt, data_link_info->name,
1368 /* Print the number of packets captured for each interface until we're killed. */
1370 print_statistics_loop(gboolean machine_readable)
1372 GList *if_list, *if_entry, *stat_list = NULL, *stat_entry;
1378 char errbuf[PCAP_ERRBUF_SIZE];
1379 struct pcap_stat ps;
1381 if_list = get_interface_list(&err, &err_str);
1382 if (if_list == NULL) {
1384 case CANT_GET_INTERFACE_LIST:
1385 case DONT_HAVE_PCAP:
1386 cmdarg_err("%s", err_str);
1390 case NO_INTERFACES_FOUND:
1391 cmdarg_err("There are no interfaces on which a capture can be done");
1397 for (if_entry = g_list_first(if_list); if_entry != NULL; if_entry = g_list_next(if_entry)) {
1398 if_info = (if_info_t *)if_entry->data;
1399 #ifdef HAVE_PCAP_OPEN
1400 pch = pcap_open(if_info->name, MIN_PACKET_SIZE, 0, 0, NULL, errbuf);
1402 pch = pcap_open_live(if_info->name, MIN_PACKET_SIZE, 0, 0, errbuf);
1406 if_stat = (if_stat_t *)g_malloc(sizeof(if_stat_t));
1407 if_stat->name = g_strdup(if_info->name);
1409 stat_list = g_list_append(stat_list, if_stat);
1414 cmdarg_err("There are no interfaces on which a capture can be done");
1418 if (capture_child) {
1419 /* Let our parent know we succeeded. */
1420 pipe_write_block(2, SP_SUCCESS, NULL);
1423 if (!machine_readable) {
1424 printf("%-15s %10s %10s\n", "Interface", "Received",
1428 global_ld.go = TRUE;
1429 while (global_ld.go) {
1430 for (stat_entry = g_list_first(stat_list); stat_entry != NULL; stat_entry = g_list_next(stat_entry)) {
1431 if_stat = (if_stat_t *)stat_entry->data;
1432 pcap_stats(if_stat->pch, &ps);
1434 if (!machine_readable) {
1435 printf("%-15s %10u %10u\n", if_stat->name,
1436 ps.ps_recv, ps.ps_drop);
1438 printf("%s\t%u\t%u\n", if_stat->name,
1439 ps.ps_recv, ps.ps_drop);
1450 /* XXX - Not reached. Should we look for 'q' in stdin? */
1451 for (stat_entry = g_list_first(stat_list); stat_entry != NULL; stat_entry = g_list_next(stat_entry)) {
1452 if_stat = (if_stat_t *)stat_entry->data;
1453 pcap_close(if_stat->pch);
1454 g_free(if_stat->name);
1457 g_list_free(stat_list);
1458 free_interface_list(if_list);
1466 capture_cleanup_handler(DWORD dwCtrlType)
1468 /* CTRL_C_EVENT is sort of like SIGINT, CTRL_BREAK_EVENT is unique to
1469 Windows, CTRL_CLOSE_EVENT is sort of like SIGHUP, CTRL_LOGOFF_EVENT
1470 is also sort of like SIGHUP, and CTRL_SHUTDOWN_EVENT is sort of
1471 like SIGTERM at least when the machine's shutting down.
1473 For now, if we're running as a command rather than a capture child,
1474 we handle all but CTRL_LOGOFF_EVENT as indications that we should
1475 clean up and quit, just as we handle SIGINT, SIGHUP, and SIGTERM
1476 in that way on UN*X.
1478 If we're not running as a capture child, we might be running as
1479 a service; ignore CTRL_LOGOFF_EVENT, so we keep running after the
1480 user logs out. (XXX - can we explicitly check whether we're
1481 running as a service?) */
1483 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
1484 "Console: Control signal");
1485 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
1486 "Console: Control signal, CtrlType: %u", dwCtrlType);
1488 /* Keep capture running if we're a service and a user logs off */
1489 if (capture_child || (dwCtrlType != CTRL_LOGOFF_EVENT)) {
1490 capture_loop_stop();
1498 capture_cleanup_handler(int signum _U_)
1500 /* On UN*X, we cleanly shut down the capture on SIGINT, SIGHUP, and
1501 SIGTERM. We assume that if the user wanted it to keep running
1502 after they logged out, they'd have nohupped it. */
1504 /* Note: don't call g_log() in the signal handler: if we happened to be in
1505 * g_log() in process context when the signal came in, g_log will detect
1506 * the "recursion" and abort.
1509 capture_loop_stop();
1515 report_capture_count(gboolean reportit)
1517 /* Don't print this if we're a capture child. */
1518 if (!capture_child && reportit) {
1519 fprintf(stderr, "\rPackets captured: %u\n", global_ld.packet_count);
1520 /* stderr could be line buffered */
1528 report_counts_for_siginfo(void)
1530 report_capture_count(quiet);
1531 infoprint = FALSE; /* we just reported it */
1535 report_counts_siginfo(int signum _U_)
1537 int sav_errno = errno;
1539 /* If we've been told to delay printing, just set a flag asking
1540 that we print counts (if we're supposed to), otherwise print
1541 the count of packets captured (if we're supposed to). */
1545 report_counts_for_siginfo();
1548 #endif /* SIGINFO */
1551 exit_main(int status)
1554 /* Shutdown windows sockets */
1557 /* can be helpful for debugging */
1558 #ifdef DEBUG_DUMPCAP
1559 printf("Press any key\n");
1570 * If we were linked with libcap (not libpcap), make sure we have
1571 * CAP_NET_ADMIN and CAP_NET_RAW, then relinquish our permissions.
1572 * (See comment in main() for details)
1575 relinquish_privs_except_capture(void)
1577 /* If 'started_with_special_privs' (ie: suid) then enable for
1578 * ourself the NET_ADMIN and NET_RAW capabilities and then
1579 * drop our suid privileges.
1581 * CAP_NET_ADMIN: Promiscuous mode and a truckload of other
1582 * stuff we don't need (and shouldn't have).
1583 * CAP_NET_RAW: Packet capture (raw sockets).
1586 if (started_with_special_privs()) {
1587 cap_value_t cap_list[2] = { CAP_NET_ADMIN, CAP_NET_RAW };
1588 int cl_len = sizeof(cap_list) / sizeof(cap_value_t);
1590 cap_t caps = cap_init(); /* all capabilities initialized to off */
1592 print_caps("Pre drop, pre set");
1594 if (prctl(PR_SET_KEEPCAPS, 1, 0, 0, 0) == -1) {
1595 cmdarg_err("prctl() fail return: %s", g_strerror(errno));
1598 cap_set_flag(caps, CAP_PERMITTED, cl_len, cap_list, CAP_SET);
1599 cap_set_flag(caps, CAP_INHERITABLE, cl_len, cap_list, CAP_SET);
1601 if (cap_set_proc(caps)) {
1602 cmdarg_err("cap_set_proc() fail return: %s", g_strerror(errno));
1604 print_caps("Pre drop, post set");
1606 relinquish_special_privs_perm();
1608 print_caps("Post drop, pre set");
1609 cap_set_flag(caps, CAP_EFFECTIVE, cl_len, cap_list, CAP_SET);
1610 if (cap_set_proc(caps)) {
1611 cmdarg_err("cap_set_proc() fail return: %s", g_strerror(errno));
1613 print_caps("Post drop, post set");
1619 #endif /* HAVE_LIBCAP */
1621 /* Take care of byte order in the libpcap headers read from pipes.
1622 * (function taken from wiretap/libpcap.c) */
1624 cap_pipe_adjust_header(gboolean byte_swapped, struct pcap_hdr *hdr, struct pcaprec_hdr *rechdr)
1627 /* Byte-swap the record header fields. */
1628 rechdr->ts_sec = BSWAP32(rechdr->ts_sec);
1629 rechdr->ts_usec = BSWAP32(rechdr->ts_usec);
1630 rechdr->incl_len = BSWAP32(rechdr->incl_len);
1631 rechdr->orig_len = BSWAP32(rechdr->orig_len);
1634 /* In file format version 2.3, the "incl_len" and "orig_len" fields were
1635 swapped, in order to match the BPF header layout.
1637 Unfortunately, some files were, according to a comment in the "libpcap"
1638 source, written with version 2.3 in their headers but without the
1639 interchanged fields, so if "incl_len" is greater than "orig_len" - which
1640 would make no sense - we assume that we need to swap them. */
1641 if (hdr->version_major == 2 &&
1642 (hdr->version_minor < 3 ||
1643 (hdr->version_minor == 3 && rechdr->incl_len > rechdr->orig_len))) {
1646 temp = rechdr->orig_len;
1647 rechdr->orig_len = rechdr->incl_len;
1648 rechdr->incl_len = temp;
1654 * Thread function that reads from a pipe and pushes the data
1655 * to the main application thread.
1658 * XXX Right now we use async queues for basic signaling. The main thread
1659 * sets cap_pipe_buf and cap_bytes_to_read, then pushes an item onto
1660 * cap_pipe_pending_q which triggers a read in the cap_pipe_read thread.
1661 * Iff the read is successful cap_pipe_read pushes an item onto
1662 * cap_pipe_done_q, otherwise an error is signaled. No data is passed in
1663 * the queues themselves (yet).
1665 * We might want to move some of the cap_pipe_dispatch logic here so that
1666 * we can let cap_pipe_read run independently, queuing up multiple reads
1667 * for the main thread (and possibly get rid of cap_pipe_read_mtx).
1669 static void *cap_pipe_read(void *arg)
1671 pcap_options *pcap_opts;
1680 pcap_opts = (pcap_options *)arg;
1681 while (pcap_opts->cap_pipe_err == PIPOK) {
1682 g_async_queue_pop(pcap_opts->cap_pipe_pending_q); /* Wait for our cue (ahem) from the main thread */
1683 g_mutex_lock(pcap_opts->cap_pipe_read_mtx);
1685 while (bytes_read < (int) pcap_opts->cap_pipe_bytes_to_read) {
1687 /* If we try to use read() on a named pipe on Windows with partial
1688 * data it appears to return EOF.
1690 res = ReadFile(pcap_opts->cap_pipe_h, pcap_opts->cap_pipe_buf+bytes_read,
1691 pcap_opts->cap_pipe_bytes_to_read - bytes_read,
1696 last_err = GetLastError();
1697 if (last_err == ERROR_MORE_DATA) {
1699 } else if (last_err == ERROR_HANDLE_EOF || last_err == ERROR_BROKEN_PIPE || last_err == ERROR_PIPE_NOT_CONNECTED) {
1700 pcap_opts->cap_pipe_err = PIPEOF;
1704 pcap_opts->cap_pipe_err = PIPERR;
1707 } else if (b == 0 && pcap_opts->cap_pipe_bytes_to_read > 0) {
1708 pcap_opts->cap_pipe_err = PIPEOF;
1713 b = read(pcap_opts->cap_pipe_fd, pcap_opts->cap_pipe_buf+bytes_read,
1714 pcap_opts->cap_pipe_bytes_to_read - bytes_read);
1717 pcap_opts->cap_pipe_err = PIPEOF;
1721 pcap_opts->cap_pipe_err = PIPERR;
1730 pcap_opts->cap_pipe_bytes_read = bytes_read;
1731 if (pcap_opts->cap_pipe_bytes_read >= pcap_opts->cap_pipe_bytes_to_read) {
1732 g_async_queue_push(pcap_opts->cap_pipe_done_q, pcap_opts->cap_pipe_buf); /* Any non-NULL value will do */
1734 g_mutex_unlock(pcap_opts->cap_pipe_read_mtx);
1740 #if !defined(_WIN32) || defined(MUST_DO_SELECT)
1741 /* Provide select() functionality for a single file descriptor
1742 * on UNIX/POSIX. Windows uses cap_pipe_read via a thread.
1744 * Returns the same values as select.
1747 cap_pipe_select(int pipe_fd)
1750 struct timeval timeout;
1753 FD_SET(pipe_fd, &rfds);
1755 timeout.tv_sec = PIPE_READ_TIMEOUT / 1000000;
1756 timeout.tv_usec = PIPE_READ_TIMEOUT % 1000000;
1758 return select(pipe_fd+1, &rfds, NULL, NULL, &timeout);
1763 /* Mimic pcap_open_live() for pipe captures
1765 * We check if "pipename" is "-" (stdin), a AF_UNIX socket, or a FIFO,
1766 * open it, and read the header.
1768 * N.B. : we can't read the libpcap formats used in RedHat 6.1 or SuSE 6.3
1769 * because we can't seek on pipes (see wiretap/libpcap.c for details) */
1771 cap_pipe_open_live(char *pipename,
1772 pcap_options *pcap_opts,
1773 struct pcap_hdr *hdr,
1774 char *errmsg, int errmsgl)
1777 ws_statb64 pipe_stat;
1778 struct sockaddr_un sa;
1789 unsigned int bytes_read;
1794 pcap_opts->cap_pipe_fd = -1;
1796 pcap_opts->cap_pipe_h = INVALID_HANDLE_VALUE;
1798 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "cap_pipe_open_live: %s", pipename);
1801 * XXX - this blocks until a pcap per-file header has been written to
1802 * the pipe, so it could block indefinitely.
1804 if (strcmp(pipename, "-") == 0) {
1806 fd = 0; /* read from stdin */
1808 pcap_opts->cap_pipe_h = GetStdHandle(STD_INPUT_HANDLE);
1812 if (ws_stat64(pipename, &pipe_stat) < 0) {
1813 if (errno == ENOENT || errno == ENOTDIR)
1814 pcap_opts->cap_pipe_err = PIPNEXIST;
1816 g_snprintf(errmsg, errmsgl,
1817 "The capture session could not be initiated "
1818 "due to error getting information on pipe/socket: %s", g_strerror(errno));
1819 pcap_opts->cap_pipe_err = PIPERR;
1823 if (S_ISFIFO(pipe_stat.st_mode)) {
1824 fd = ws_open(pipename, O_RDONLY | O_NONBLOCK, 0000 /* no creation so don't matter */);
1826 g_snprintf(errmsg, errmsgl,
1827 "The capture session could not be initiated "
1828 "due to error on pipe open: %s", g_strerror(errno));
1829 pcap_opts->cap_pipe_err = PIPERR;
1832 } else if (S_ISSOCK(pipe_stat.st_mode)) {
1833 fd = socket(AF_UNIX, SOCK_STREAM, 0);
1835 g_snprintf(errmsg, errmsgl,
1836 "The capture session could not be initiated "
1837 "due to error on socket create: %s", g_strerror(errno));
1838 pcap_opts->cap_pipe_err = PIPERR;
1841 sa.sun_family = AF_UNIX;
1843 * The Single UNIX Specification says:
1845 * The size of sun_path has intentionally been left undefined.
1846 * This is because different implementations use different sizes.
1847 * For example, 4.3 BSD uses a size of 108, and 4.4 BSD uses a size
1848 * of 104. Since most implementations originate from BSD versions,
1849 * the size is typically in the range 92 to 108.
1851 * Applications should not assume a particular length for sun_path
1852 * or assume that it can hold {_POSIX_PATH_MAX} bytes (256).
1856 * The <sys/un.h> header shall define the sockaddr_un structure,
1857 * which shall include at least the following members:
1859 * sa_family_t sun_family Address family.
1860 * char sun_path[] Socket pathname.
1862 * so we assume that it's an array, with a specified size,
1863 * and that the size reflects the maximum path length.
1865 if (g_strlcpy(sa.sun_path, pipename, sizeof sa.sun_path) > sizeof sa.sun_path) {
1866 /* Path name too long */
1867 g_snprintf(errmsg, errmsgl,
1868 "The capture session coud not be initiated "
1869 "due to error on socket connect: Path name too long");
1870 pcap_opts->cap_pipe_err = PIPERR;
1873 b = connect(fd, (struct sockaddr *)&sa, sizeof sa);
1875 g_snprintf(errmsg, errmsgl,
1876 "The capture session coud not be initiated "
1877 "due to error on socket connect: %s", g_strerror(errno));
1878 pcap_opts->cap_pipe_err = PIPERR;
1882 if (S_ISCHR(pipe_stat.st_mode)) {
1884 * Assume the user specified an interface on a system where
1885 * interfaces are in /dev. Pretend we haven't seen it.
1887 pcap_opts->cap_pipe_err = PIPNEXIST;
1890 g_snprintf(errmsg, errmsgl,
1891 "The capture session could not be initiated because\n"
1892 "\"%s\" is neither an interface nor a socket nor a pipe", pipename);
1893 pcap_opts->cap_pipe_err = PIPERR;
1898 #define PIPE_STR "\\pipe\\"
1899 /* Under Windows, named pipes _must_ have the form
1900 * "\\<server>\pipe\<pipename>". <server> may be "." for localhost.
1902 pncopy = g_strdup(pipename);
1903 if ( (pos=strstr(pncopy, "\\\\")) == pncopy) {
1904 pos = strchr(pncopy + 3, '\\');
1905 if (pos && g_ascii_strncasecmp(pos, PIPE_STR, strlen(PIPE_STR)) != 0)
1912 g_snprintf(errmsg, errmsgl,
1913 "The capture session could not be initiated because\n"
1914 "\"%s\" is neither an interface nor a pipe", pipename);
1915 pcap_opts->cap_pipe_err = PIPNEXIST;
1919 /* Wait for the pipe to appear */
1921 pcap_opts->cap_pipe_h = CreateFile(utf_8to16(pipename), GENERIC_READ, 0, NULL,
1922 OPEN_EXISTING, 0, NULL);
1924 if (pcap_opts->cap_pipe_h != INVALID_HANDLE_VALUE)
1927 if (GetLastError() != ERROR_PIPE_BUSY) {
1928 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER,
1929 NULL, GetLastError(), 0, (LPTSTR) &err_str, 0, NULL);
1930 g_snprintf(errmsg, errmsgl,
1931 "The capture session on \"%s\" could not be started "
1932 "due to error on pipe open: %s (error %d)",
1933 pipename, utf_16to8(err_str), GetLastError());
1935 pcap_opts->cap_pipe_err = PIPERR;
1939 if (!WaitNamedPipe(utf_8to16(pipename), 30 * 1000)) {
1940 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER,
1941 NULL, GetLastError(), 0, (LPTSTR) &err_str, 0, NULL);
1942 g_snprintf(errmsg, errmsgl,
1943 "The capture session on \"%s\" timed out during "
1944 "pipe open: %s (error %d)",
1945 pipename, utf_16to8(err_str), GetLastError());
1947 pcap_opts->cap_pipe_err = PIPERR;
1954 pcap_opts->from_cap_pipe = TRUE;
1957 /* read the pcap header */
1959 while (bytes_read < sizeof magic) {
1960 sel_ret = cap_pipe_select(fd);
1962 g_snprintf(errmsg, errmsgl,
1963 "Unexpected error from select: %s", g_strerror(errno));
1965 } else if (sel_ret > 0) {
1966 b = read(fd, ((char *)&magic)+bytes_read, sizeof magic-bytes_read);
1969 g_snprintf(errmsg, errmsgl, "End of file on pipe magic during open");
1971 g_snprintf(errmsg, errmsgl, "Error on pipe magic during open: %s",
1979 g_thread_create(&cap_pipe_read, pcap_opts, FALSE, NULL);
1981 pcap_opts->cap_pipe_buf = (char *) &magic;
1982 pcap_opts->cap_pipe_bytes_read = 0;
1983 pcap_opts->cap_pipe_bytes_to_read = sizeof(magic);
1984 /* We don't have to worry about cap_pipe_read_mtx here */
1985 g_async_queue_push(pcap_opts->cap_pipe_pending_q, pcap_opts->cap_pipe_buf);
1986 g_async_queue_pop(pcap_opts->cap_pipe_done_q);
1987 if (pcap_opts->cap_pipe_bytes_read <= 0) {
1988 if (pcap_opts->cap_pipe_bytes_read == 0)
1989 g_snprintf(errmsg, errmsgl, "End of file on pipe magic during open");
1991 g_snprintf(errmsg, errmsgl, "Error on pipe magic during open: %s",
2000 case PCAP_NSEC_MAGIC:
2001 /* Host that wrote it has our byte order, and was running
2002 a program using either standard or ss990417 libpcap. */
2003 pcap_opts->cap_pipe_byte_swapped = FALSE;
2004 pcap_opts->cap_pipe_modified = FALSE;
2005 pcap_opts->ts_nsec = magic == PCAP_NSEC_MAGIC;
2007 case PCAP_MODIFIED_MAGIC:
2008 /* Host that wrote it has our byte order, but was running
2009 a program using either ss990915 or ss991029 libpcap. */
2010 pcap_opts->cap_pipe_byte_swapped = FALSE;
2011 pcap_opts->cap_pipe_modified = TRUE;
2013 case PCAP_SWAPPED_MAGIC:
2014 case PCAP_SWAPPED_NSEC_MAGIC:
2015 /* Host that wrote it has a byte order opposite to ours,
2016 and was running a program using either standard or
2017 ss990417 libpcap. */
2018 pcap_opts->cap_pipe_byte_swapped = TRUE;
2019 pcap_opts->cap_pipe_modified = FALSE;
2020 pcap_opts->ts_nsec = magic == PCAP_SWAPPED_NSEC_MAGIC;
2022 case PCAP_SWAPPED_MODIFIED_MAGIC:
2023 /* Host that wrote it out has a byte order opposite to
2024 ours, and was running a program using either ss990915
2025 or ss991029 libpcap. */
2026 pcap_opts->cap_pipe_byte_swapped = TRUE;
2027 pcap_opts->cap_pipe_modified = TRUE;
2030 /* Not a "libpcap" type we know about. */
2031 g_snprintf(errmsg, errmsgl, "Unrecognized libpcap format");
2036 /* Read the rest of the header */
2038 while (bytes_read < sizeof(struct pcap_hdr)) {
2039 sel_ret = cap_pipe_select(fd);
2041 g_snprintf(errmsg, errmsgl,
2042 "Unexpected error from select: %s", g_strerror(errno));
2044 } else if (sel_ret > 0) {
2045 b = read(fd, ((char *)hdr)+bytes_read,
2046 sizeof(struct pcap_hdr) - bytes_read);
2049 g_snprintf(errmsg, errmsgl, "End of file on pipe header during open");
2051 g_snprintf(errmsg, errmsgl, "Error on pipe header during open: %s",
2059 pcap_opts->cap_pipe_buf = (char *) hdr;
2060 pcap_opts->cap_pipe_bytes_read = 0;
2061 pcap_opts->cap_pipe_bytes_to_read = sizeof(struct pcap_hdr);
2062 g_async_queue_push(pcap_opts->cap_pipe_pending_q, pcap_opts->cap_pipe_buf);
2063 g_async_queue_pop(pcap_opts->cap_pipe_done_q);
2064 if (pcap_opts->cap_pipe_bytes_read <= 0) {
2065 if (pcap_opts->cap_pipe_bytes_read == 0)
2066 g_snprintf(errmsg, errmsgl, "End of file on pipe header during open");
2068 g_snprintf(errmsg, errmsgl, "Error on pipe header header during open: %s",
2074 if (pcap_opts->cap_pipe_byte_swapped) {
2075 /* Byte-swap the header fields about which we care. */
2076 hdr->version_major = BSWAP16(hdr->version_major);
2077 hdr->version_minor = BSWAP16(hdr->version_minor);
2078 hdr->snaplen = BSWAP32(hdr->snaplen);
2079 hdr->network = BSWAP32(hdr->network);
2081 pcap_opts->linktype = hdr->network;
2083 if (hdr->version_major < 2) {
2084 g_snprintf(errmsg, errmsgl, "Unable to read old libpcap format");
2088 pcap_opts->cap_pipe_state = STATE_EXPECT_REC_HDR;
2089 pcap_opts->cap_pipe_err = PIPOK;
2091 pcap_opts->cap_pipe_fd = fd;
2096 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "cap_pipe_open_live: error %s", errmsg);
2097 pcap_opts->cap_pipe_err = PIPERR;
2100 pcap_opts->cap_pipe_fd = -1;
2107 /* We read one record from the pipe, take care of byte order in the record
2108 * header, write the record to the capture file, and update capture statistics. */
2110 cap_pipe_dispatch(loop_data *ld, pcap_options *pcap_opts, guchar *data, char *errmsg, int errmsgl)
2112 struct pcap_pkthdr phdr;
2113 enum { PD_REC_HDR_READ, PD_DATA_READ, PD_PIPE_EOF, PD_PIPE_ERR,
2116 #if !GLIB_CHECK_VERSION(2,31,18)
2127 #ifdef LOG_CAPTURE_VERBOSE
2128 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "cap_pipe_dispatch");
2131 switch (pcap_opts->cap_pipe_state) {
2133 case STATE_EXPECT_REC_HDR:
2135 if (g_mutex_trylock(pcap_opts->cap_pipe_read_mtx)) {
2138 pcap_opts->cap_pipe_state = STATE_READ_REC_HDR;
2139 pcap_opts->cap_pipe_bytes_to_read = pcap_opts->cap_pipe_modified ?
2140 sizeof(struct pcaprec_modified_hdr) : sizeof(struct pcaprec_hdr);
2141 pcap_opts->cap_pipe_bytes_read = 0;
2144 pcap_opts->cap_pipe_buf = (char *) &pcap_opts->cap_pipe_rechdr;
2145 g_async_queue_push(pcap_opts->cap_pipe_pending_q, pcap_opts->cap_pipe_buf);
2146 g_mutex_unlock(pcap_opts->cap_pipe_read_mtx);
2151 case STATE_READ_REC_HDR:
2153 b = read(pcap_opts->cap_pipe_fd, ((char *)&pcap_opts->cap_pipe_rechdr)+pcap_opts->cap_pipe_bytes_read,
2154 pcap_opts->cap_pipe_bytes_to_read - pcap_opts->cap_pipe_bytes_read);
2157 result = PD_PIPE_EOF;
2159 result = PD_PIPE_ERR;
2162 pcap_opts->cap_pipe_bytes_read += b;
2164 #if GLIB_CHECK_VERSION(2,31,18)
2165 q_status = g_async_queue_timeout_pop(pcap_opts->cap_pipe_done_q, PIPE_READ_TIMEOUT);
2167 g_get_current_time(&wait_time);
2168 g_time_val_add(&wait_time, PIPE_READ_TIMEOUT);
2169 q_status = g_async_queue_timed_pop(pcap_opts->cap_pipe_done_q, &wait_time);
2171 if (pcap_opts->cap_pipe_err == PIPEOF) {
2172 result = PD_PIPE_EOF;
2174 } else if (pcap_opts->cap_pipe_err == PIPERR) {
2175 result = PD_PIPE_ERR;
2182 if ((pcap_opts->cap_pipe_bytes_read) < pcap_opts->cap_pipe_bytes_to_read)
2184 result = PD_REC_HDR_READ;
2187 case STATE_EXPECT_DATA:
2189 if (g_mutex_trylock(pcap_opts->cap_pipe_read_mtx)) {
2192 pcap_opts->cap_pipe_state = STATE_READ_DATA;
2193 pcap_opts->cap_pipe_bytes_to_read = pcap_opts->cap_pipe_rechdr.hdr.incl_len;
2194 pcap_opts->cap_pipe_bytes_read = 0;
2197 pcap_opts->cap_pipe_buf = (char *) data;
2198 g_async_queue_push(pcap_opts->cap_pipe_pending_q, pcap_opts->cap_pipe_buf);
2199 g_mutex_unlock(pcap_opts->cap_pipe_read_mtx);
2204 case STATE_READ_DATA:
2206 b = read(pcap_opts->cap_pipe_fd, data+pcap_opts->cap_pipe_bytes_read,
2207 pcap_opts->cap_pipe_bytes_to_read - pcap_opts->cap_pipe_bytes_read);
2210 result = PD_PIPE_EOF;
2212 result = PD_PIPE_ERR;
2215 pcap_opts->cap_pipe_bytes_read += b;
2217 #if GLIB_CHECK_VERSION(2,31,18)
2218 q_status = g_async_queue_timeout_pop(pcap_opts->cap_pipe_done_q, PIPE_READ_TIMEOUT);
2220 g_get_current_time(&wait_time);
2221 g_time_val_add(&wait_time, PIPE_READ_TIMEOUT);
2222 q_status = g_async_queue_timed_pop(pcap_opts->cap_pipe_done_q, &wait_time);
2224 if (pcap_opts->cap_pipe_err == PIPEOF) {
2225 result = PD_PIPE_EOF;
2227 } else if (pcap_opts->cap_pipe_err == PIPERR) {
2228 result = PD_PIPE_ERR;
2235 if ((pcap_opts->cap_pipe_bytes_read) < pcap_opts->cap_pipe_bytes_to_read)
2237 result = PD_DATA_READ;
2241 g_snprintf(errmsg, errmsgl, "cap_pipe_dispatch: invalid state");
2244 } /* switch (pcap_opts->cap_pipe_state) */
2247 * We've now read as much data as we were expecting, so process it.
2251 case PD_REC_HDR_READ:
2252 /* We've read the header. Take care of byte order. */
2253 cap_pipe_adjust_header(pcap_opts->cap_pipe_byte_swapped, &pcap_opts->cap_pipe_hdr,
2254 &pcap_opts->cap_pipe_rechdr.hdr);
2255 if (pcap_opts->cap_pipe_rechdr.hdr.incl_len > WTAP_MAX_PACKET_SIZE) {
2256 g_snprintf(errmsg, errmsgl, "Frame %u too long (%d bytes)",
2257 ld->packet_count+1, pcap_opts->cap_pipe_rechdr.hdr.incl_len);
2261 if (pcap_opts->cap_pipe_rechdr.hdr.incl_len) {
2262 pcap_opts->cap_pipe_state = STATE_EXPECT_DATA;
2265 /* no data to read? fall through */
2268 /* Fill in a "struct pcap_pkthdr", and process the packet. */
2269 phdr.ts.tv_sec = pcap_opts->cap_pipe_rechdr.hdr.ts_sec;
2270 phdr.ts.tv_usec = pcap_opts->cap_pipe_rechdr.hdr.ts_usec;
2271 phdr.caplen = pcap_opts->cap_pipe_rechdr.hdr.incl_len;
2272 phdr.len = pcap_opts->cap_pipe_rechdr.hdr.orig_len;
2275 capture_loop_queue_packet_cb((u_char *)pcap_opts, &phdr, data);
2277 capture_loop_write_packet_cb((u_char *)pcap_opts, &phdr, data);
2279 pcap_opts->cap_pipe_state = STATE_EXPECT_REC_HDR;
2283 pcap_opts->cap_pipe_err = PIPEOF;
2288 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER,
2289 NULL, GetLastError(), 0, (LPTSTR) &err_str, 0, NULL);
2290 g_snprintf(errmsg, errmsgl,
2291 "Error reading from pipe: %s (error %d)",
2292 utf_16to8(err_str), GetLastError());
2295 g_snprintf(errmsg, errmsgl, "Error reading from pipe: %s",
2303 pcap_opts->cap_pipe_err = PIPERR;
2304 /* Return here rather than inside the switch to prevent GCC warning */
2309 /** Open the capture input file (pcap or capture pipe).
2310 * Returns TRUE if it succeeds, FALSE otherwise. */
2312 capture_loop_open_input(capture_options *capture_opts, loop_data *ld,
2313 char *errmsg, size_t errmsg_len,
2314 char *secondary_errmsg, size_t secondary_errmsg_len)
2316 gchar open_err_str[PCAP_ERRBUF_SIZE];
2317 gchar *sync_msg_str;
2318 interface_options interface_opts;
2319 pcap_options *pcap_opts;
2323 gchar *sync_secondary_msg_str;
2324 WORD wVersionRequested;
2328 /* XXX - opening Winsock on tshark? */
2330 /* Initialize Windows Socket if we are in a WIN32 OS
2331 This needs to be done before querying the interface for network/netmask */
2333 /* XXX - do we really require 1.1 or earlier?
2334 Are there any versions that support only 2.0 or higher? */
2335 wVersionRequested = MAKEWORD(1, 1);
2336 err = WSAStartup(wVersionRequested, &wsaData);
2340 case WSASYSNOTREADY:
2341 g_snprintf(errmsg, (gulong) errmsg_len,
2342 "Couldn't initialize Windows Sockets: Network system not ready for network communication");
2345 case WSAVERNOTSUPPORTED:
2346 g_snprintf(errmsg, (gulong) errmsg_len,
2347 "Couldn't initialize Windows Sockets: Windows Sockets version %u.%u not supported",
2348 LOBYTE(wVersionRequested), HIBYTE(wVersionRequested));
2351 case WSAEINPROGRESS:
2352 g_snprintf(errmsg, (gulong) errmsg_len,
2353 "Couldn't initialize Windows Sockets: Blocking operation is in progress");
2357 g_snprintf(errmsg, (gulong) errmsg_len,
2358 "Couldn't initialize Windows Sockets: Limit on the number of tasks supported by this WinSock implementation has been reached");
2362 g_snprintf(errmsg, (gulong) errmsg_len,
2363 "Couldn't initialize Windows Sockets: Bad pointer passed to WSAStartup");
2367 g_snprintf(errmsg, (gulong) errmsg_len,
2368 "Couldn't initialize Windows Sockets: error %d", err);
2371 g_snprintf(secondary_errmsg, (gulong) secondary_errmsg_len, please_report);
2375 if ((use_threads == FALSE) &&
2376 (capture_opts->ifaces->len > 1)) {
2377 g_snprintf(errmsg, (gulong) errmsg_len,
2378 "Using threads is required for capturing on multiple interfaces!");
2382 for (i = 0; i < capture_opts->ifaces->len; i++) {
2383 interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
2384 pcap_opts = (pcap_options *)g_malloc(sizeof (pcap_options));
2385 if (pcap_opts == NULL) {
2386 g_snprintf(errmsg, (gulong) errmsg_len,
2387 "Could not allocate memory.");
2390 pcap_opts->received = 0;
2391 pcap_opts->dropped = 0;
2392 pcap_opts->pcap_h = NULL;
2393 #ifdef MUST_DO_SELECT
2394 pcap_opts->pcap_fd = -1;
2396 pcap_opts->pcap_err = FALSE;
2397 pcap_opts->interface_id = i;
2398 pcap_opts->tid = NULL;
2399 pcap_opts->snaplen = 0;
2400 pcap_opts->linktype = -1;
2401 pcap_opts->ts_nsec = FALSE;
2402 pcap_opts->from_cap_pipe = FALSE;
2403 memset(&pcap_opts->cap_pipe_hdr, 0, sizeof(struct pcap_hdr));
2404 memset(&pcap_opts->cap_pipe_rechdr, 0, sizeof(struct pcaprec_modified_hdr));
2406 pcap_opts->cap_pipe_h = INVALID_HANDLE_VALUE;
2408 pcap_opts->cap_pipe_fd = -1;
2410 pcap_opts->cap_pipe_modified = FALSE;
2411 pcap_opts->cap_pipe_byte_swapped = FALSE;
2413 pcap_opts->cap_pipe_buf = NULL;
2415 pcap_opts->cap_pipe_bytes_to_read = 0;
2416 pcap_opts->cap_pipe_bytes_read = 0;
2417 pcap_opts->cap_pipe_state = 0;
2418 pcap_opts->cap_pipe_err = PIPOK;
2420 #if GLIB_CHECK_VERSION(2,31,0)
2421 pcap_opts->cap_pipe_read_mtx = g_malloc(sizeof(GMutex));
2422 g_mutex_init(pcap_opts->cap_pipe_read_mtx);
2424 pcap_opts->cap_pipe_read_mtx = g_mutex_new();
2426 pcap_opts->cap_pipe_pending_q = g_async_queue_new();
2427 pcap_opts->cap_pipe_done_q = g_async_queue_new();
2429 g_array_append_val(ld->pcaps, pcap_opts);
2431 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_open_input : %s", interface_opts.name);
2432 pcap_opts->pcap_h = open_capture_device(&interface_opts, &open_err_str);
2434 if (pcap_opts->pcap_h != NULL) {
2435 /* we've opened "iface" as a network device */
2437 /* try to set the capture buffer size */
2438 if (interface_opts.buffer_size > 1 &&
2439 pcap_setbuff(pcap_opts->pcap_h, interface_opts.buffer_size * 1024 * 1024) != 0) {
2440 sync_secondary_msg_str = g_strdup_printf(
2441 "The capture buffer size of %dMB seems to be too high for your machine,\n"
2442 "the default of 1MB will be used.\n"
2444 "Nonetheless, the capture is started.\n",
2445 interface_opts.buffer_size);
2446 report_capture_error("Couldn't set the capture buffer size!",
2447 sync_secondary_msg_str);
2448 g_free(sync_secondary_msg_str);
2452 #if defined(HAVE_PCAP_SETSAMPLING)
2453 if (interface_opts.sampling_method != CAPTURE_SAMP_NONE) {
2454 struct pcap_samp *samp;
2456 if ((samp = pcap_setsampling(pcap_opts->pcap_h)) != NULL) {
2457 switch (interface_opts.sampling_method) {
2458 case CAPTURE_SAMP_BY_COUNT:
2459 samp->method = PCAP_SAMP_1_EVERY_N;
2462 case CAPTURE_SAMP_BY_TIMER:
2463 samp->method = PCAP_SAMP_FIRST_AFTER_N_MS;
2467 sync_msg_str = g_strdup_printf(
2468 "Unknown sampling method %d specified,\n"
2469 "continue without packet sampling",
2470 interface_opts.sampling_method);
2471 report_capture_error("Couldn't set the capture "
2472 "sampling", sync_msg_str);
2473 g_free(sync_msg_str);
2475 samp->value = interface_opts.sampling_param;
2477 report_capture_error("Couldn't set the capture sampling",
2478 "Cannot get packet sampling data structure");
2483 /* setting the data link type only works on real interfaces */
2484 if (!set_pcap_linktype(pcap_opts->pcap_h, interface_opts.linktype, interface_opts.name,
2486 secondary_errmsg, secondary_errmsg_len)) {
2489 pcap_opts->linktype = get_pcap_linktype(pcap_opts->pcap_h, interface_opts.name);
2491 /* We couldn't open "iface" as a network device. */
2492 /* Try to open it as a pipe */
2493 cap_pipe_open_live(interface_opts.name, pcap_opts, &pcap_opts->cap_pipe_hdr, errmsg, (int) errmsg_len);
2496 if (pcap_opts->cap_pipe_fd == -1) {
2498 if (pcap_opts->cap_pipe_h == INVALID_HANDLE_VALUE) {
2500 if (pcap_opts->cap_pipe_err == PIPNEXIST) {
2501 /* Pipe doesn't exist, so output message for interface */
2502 get_capture_device_open_failure_messages(open_err_str,
2503 interface_opts.name,
2507 secondary_errmsg_len);
2510 * Else pipe (or file) does exist and cap_pipe_open_live() has
2515 /* cap_pipe_open_live() succeeded; don't want
2516 error message from pcap_open_live() */
2517 open_err_str[0] = '\0';
2521 /* XXX - will this work for tshark? */
2522 #ifdef MUST_DO_SELECT
2523 if (!pcap_opts->from_cap_pipe) {
2524 #ifdef HAVE_PCAP_GET_SELECTABLE_FD
2525 pcap_opts->pcap_fd = pcap_get_selectable_fd(pcap_opts->pcap_h);
2527 pcap_opts->pcap_fd = pcap_fileno(pcap_opts->pcap_h);
2532 /* Does "open_err_str" contain a non-empty string? If so, "pcap_open_live()"
2533 returned a warning; print it, but keep capturing. */
2534 if (open_err_str[0] != '\0') {
2535 sync_msg_str = g_strdup_printf("%s.", open_err_str);
2536 report_capture_error(sync_msg_str, "");
2537 g_free(sync_msg_str);
2539 capture_opts->ifaces = g_array_remove_index(capture_opts->ifaces, i);
2540 g_array_insert_val(capture_opts->ifaces, i, interface_opts);
2543 /* If not using libcap: we now can now set euid/egid to ruid/rgid */
2544 /* to remove any suid privileges. */
2545 /* If using libcap: we can now remove NET_RAW and NET_ADMIN capabilities */
2546 /* (euid/egid have already previously been set to ruid/rgid. */
2547 /* (See comment in main() for details) */
2549 relinquish_special_privs_perm();
2551 relinquish_all_capabilities();
2556 /* close the capture input file (pcap or capture pipe) */
2557 static void capture_loop_close_input(loop_data *ld)
2560 pcap_options *pcap_opts;
2562 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_close_input");
2564 for (i = 0; i < ld->pcaps->len; i++) {
2565 pcap_opts = g_array_index(ld->pcaps, pcap_options *, i);
2566 /* if open, close the capture pipe "input file" */
2568 if (pcap_opts->cap_pipe_fd >= 0) {
2569 g_assert(pcap_opts->from_cap_pipe);
2570 ws_close(pcap_opts->cap_pipe_fd);
2571 pcap_opts->cap_pipe_fd = -1;
2574 if (pcap_opts->cap_pipe_h != INVALID_HANDLE_VALUE) {
2575 CloseHandle(pcap_opts->cap_pipe_h);
2576 pcap_opts->cap_pipe_h = INVALID_HANDLE_VALUE;
2579 /* if open, close the pcap "input file" */
2580 if (pcap_opts->pcap_h != NULL) {
2581 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_close_input: closing %p", (void *)pcap_opts->pcap_h);
2582 pcap_close(pcap_opts->pcap_h);
2583 pcap_opts->pcap_h = NULL;
2590 /* Shut down windows sockets */
2596 /* init the capture filter */
2597 static initfilter_status_t
2598 capture_loop_init_filter(pcap_t *pcap_h, gboolean from_cap_pipe,
2599 const gchar * name, const gchar * cfilter)
2601 struct bpf_program fcode;
2603 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_init_filter: %s", cfilter);
2605 /* capture filters only work on real interfaces */
2606 if (cfilter && !from_cap_pipe) {
2607 /* A capture filter was specified; set it up. */
2608 if (!compile_capture_filter(name, pcap_h, &fcode, cfilter)) {
2609 /* Treat this specially - our caller might try to compile this
2610 as a display filter and, if that succeeds, warn the user that
2611 the display and capture filter syntaxes are different. */
2612 return INITFILTER_BAD_FILTER;
2614 if (pcap_setfilter(pcap_h, &fcode) < 0) {
2615 #ifdef HAVE_PCAP_FREECODE
2616 pcap_freecode(&fcode);
2618 return INITFILTER_OTHER_ERROR;
2620 #ifdef HAVE_PCAP_FREECODE
2621 pcap_freecode(&fcode);
2625 return INITFILTER_NO_ERROR;
2629 /* set up to write to the already-opened capture output file/files */
2631 capture_loop_init_output(capture_options *capture_opts, loop_data *ld, char *errmsg, int errmsg_len)
2635 pcap_options *pcap_opts;
2636 interface_options interface_opts;
2637 gboolean successful;
2639 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_init_output");
2641 if ((capture_opts->use_pcapng == FALSE) &&
2642 (capture_opts->ifaces->len > 1)) {
2643 g_snprintf(errmsg, errmsg_len,
2644 "Using PCAPNG is required for capturing on multiple interfaces! Use the -n option.");
2648 /* Set up to write to the capture file. */
2649 if (capture_opts->multi_files_on) {
2650 ld->pdh = ringbuf_init_libpcap_fdopen(&err);
2652 ld->pdh = libpcap_fdopen(ld->save_file_fd, &err);
2655 if (capture_opts->use_pcapng) {
2657 GString *os_info_str;
2659 os_info_str = g_string_new("");
2660 get_os_version_info(os_info_str);
2662 g_snprintf(appname, sizeof(appname), "Dumpcap " VERSION "%s", wireshark_svnversion);
2663 successful = libpcap_write_session_header_block(ld->pdh,
2666 os_info_str->str, /* OS*/
2668 -1, /* section_length */
2672 for (i = 0; successful && (i < capture_opts->ifaces->len); i++) {
2673 interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
2674 pcap_opts = g_array_index(ld->pcaps, pcap_options *, i);
2675 if (pcap_opts->from_cap_pipe) {
2676 pcap_opts->snaplen = pcap_opts->cap_pipe_hdr.snaplen;
2678 pcap_opts->snaplen = pcap_snapshot(pcap_opts->pcap_h);
2680 successful = libpcap_write_interface_description_block(global_ld.pdh,
2681 NULL, /* OPT_COMMENT 1 */
2682 interface_opts.name, /* IDB_NAME 2 */
2683 interface_opts.descr, /* IDB_DESCRIPTION 3 */
2684 interface_opts.cfilter, /* IDB_FILTER 11 */
2685 os_info_str->str, /* IDB_OS 12 */
2686 pcap_opts->linktype,
2688 &(global_ld.bytes_written),
2689 0, /* IDB_IF_SPEED 8 */
2690 pcap_opts->ts_nsec ? 9 : 6, /* IDB_TSRESOL 9 */
2694 g_string_free(os_info_str, TRUE);
2697 pcap_opts = g_array_index(ld->pcaps, pcap_options *, 0);
2698 if (pcap_opts->from_cap_pipe) {
2699 pcap_opts->snaplen = pcap_opts->cap_pipe_hdr.snaplen;
2701 pcap_opts->snaplen = pcap_snapshot(pcap_opts->pcap_h);
2703 successful = libpcap_write_file_header(ld->pdh, pcap_opts->linktype, pcap_opts->snaplen,
2704 pcap_opts->ts_nsec, &ld->bytes_written, &err);
2712 if (ld->pdh == NULL) {
2713 /* We couldn't set up to write to the capture file. */
2714 /* XXX - use cf_open_error_message from tshark instead? */
2719 g_snprintf(errmsg, errmsg_len,
2720 "The file to which the capture would be"
2721 " saved (\"%s\") could not be opened: Error %d.",
2722 capture_opts->save_file, err);
2724 g_snprintf(errmsg, errmsg_len,
2725 "The file to which the capture would be"
2726 " saved (\"%s\") could not be opened: %s.",
2727 capture_opts->save_file, g_strerror(err));
2739 capture_loop_close_output(capture_options *capture_opts, loop_data *ld, int *err_close)
2743 pcap_options *pcap_opts;
2744 guint64 end_time = create_timestamp();
2746 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_close_output");
2748 if (capture_opts->multi_files_on) {
2749 return ringbuf_libpcap_dump_close(&capture_opts->save_file, err_close);
2751 if (capture_opts->use_pcapng) {
2752 for (i = 0; i < global_ld.pcaps->len; i++) {
2753 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, i);
2754 if (!pcap_opts->from_cap_pipe) {
2755 guint64 isb_ifrecv, isb_ifdrop;
2756 struct pcap_stat stats;
2758 if (pcap_stats(pcap_opts->pcap_h, &stats) >= 0) {
2759 isb_ifrecv = pcap_opts->received;
2760 isb_ifdrop = stats.ps_drop + pcap_opts->dropped;
2762 isb_ifrecv = G_MAXUINT64;
2763 isb_ifdrop = G_MAXUINT64;
2765 libpcap_write_interface_statistics_block(ld->pdh,
2768 "Counters provided by dumpcap",
2777 return libpcap_dump_close(ld->pdh, err_close);
2781 /* dispatch incoming packets (pcap or capture pipe)
2783 * Waits for incoming packets to be available, and calls pcap_dispatch()
2784 * to cause them to be processed.
2786 * Returns the number of packets which were processed.
2788 * Times out (returning zero) after CAP_READ_TIMEOUT ms; this ensures that the
2789 * packet-batching behaviour does not cause packets to get held back
2793 capture_loop_dispatch(loop_data *ld,
2794 char *errmsg, int errmsg_len, pcap_options *pcap_opts)
2797 gint packet_count_before;
2798 guchar pcap_data[WTAP_MAX_PACKET_SIZE];
2803 packet_count_before = ld->packet_count;
2804 if (pcap_opts->from_cap_pipe) {
2805 /* dispatch from capture pipe */
2806 #ifdef LOG_CAPTURE_VERBOSE
2807 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_dispatch: from capture pipe");
2810 sel_ret = cap_pipe_select(pcap_opts->cap_pipe_fd);
2812 if (sel_ret < 0 && errno != EINTR) {
2813 g_snprintf(errmsg, errmsg_len,
2814 "Unexpected error from select: %s", g_strerror(errno));
2815 report_capture_error(errmsg, please_report);
2820 * "select()" says we can read from the pipe without blocking
2823 inpkts = cap_pipe_dispatch(ld, pcap_opts, pcap_data, errmsg, errmsg_len);
2833 /* dispatch from pcap */
2834 #ifdef MUST_DO_SELECT
2836 * If we have "pcap_get_selectable_fd()", we use it to get the
2837 * descriptor on which to select; if that's -1, it means there
2838 * is no descriptor on which you can do a "select()" (perhaps
2839 * because you're capturing on a special device, and that device's
2840 * driver unfortunately doesn't support "select()", in which case
2841 * we don't do the select - which means it might not be possible
2842 * to stop a capture until a packet arrives. If that's unacceptable,
2843 * plead with whoever supplies the software for that device to add
2844 * "select()" support, or upgrade to libpcap 0.8.1 or later, and
2845 * rebuild Wireshark or get a version built with libpcap 0.8.1 or
2846 * later, so it can use pcap_breakloop().
2848 #ifdef LOG_CAPTURE_VERBOSE
2849 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_dispatch: from pcap_dispatch with select");
2851 if (pcap_opts->pcap_fd != -1) {
2852 sel_ret = cap_pipe_select(pcap_opts->pcap_fd);
2855 * "select()" says we can read from it without blocking; go for
2858 * We don't have pcap_breakloop(), so we only process one packet
2859 * per pcap_dispatch() call, to allow a signal to stop the
2860 * processing immediately, rather than processing all packets
2861 * in a batch before quitting.
2864 inpkts = pcap_dispatch(pcap_opts->pcap_h, 1, capture_loop_queue_packet_cb, (u_char *)pcap_opts);
2866 inpkts = pcap_dispatch(pcap_opts->pcap_h, 1, capture_loop_write_packet_cb, (u_char *)pcap_opts);
2870 /* Error, rather than pcap_breakloop(). */
2871 pcap_opts->pcap_err = TRUE;
2873 ld->go = FALSE; /* error or pcap_breakloop() - stop capturing */
2876 if (sel_ret < 0 && errno != EINTR) {
2877 g_snprintf(errmsg, errmsg_len,
2878 "Unexpected error from select: %s", g_strerror(errno));
2879 report_capture_error(errmsg, please_report);
2885 #endif /* MUST_DO_SELECT */
2887 /* dispatch from pcap without select */
2889 #ifdef LOG_CAPTURE_VERBOSE
2890 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_dispatch: from pcap_dispatch");
2894 * On Windows, we don't support asynchronously telling a process to
2895 * stop capturing; instead, we check for an indication on a pipe
2896 * after processing packets. We therefore process only one packet
2897 * at a time, so that we can check the pipe after every packet.
2900 inpkts = pcap_dispatch(pcap_opts->pcap_h, 1, capture_loop_queue_packet_cb, (u_char *)pcap_opts);
2902 inpkts = pcap_dispatch(pcap_opts->pcap_h, 1, capture_loop_write_packet_cb, (u_char *)pcap_opts);
2906 inpkts = pcap_dispatch(pcap_opts->pcap_h, -1, capture_loop_queue_packet_cb, (u_char *)pcap_opts);
2908 inpkts = pcap_dispatch(pcap_opts->pcap_h, -1, capture_loop_write_packet_cb, (u_char *)pcap_opts);
2913 /* Error, rather than pcap_breakloop(). */
2914 pcap_opts->pcap_err = TRUE;
2916 ld->go = FALSE; /* error or pcap_breakloop() - stop capturing */
2918 #else /* pcap_next_ex */
2919 #ifdef LOG_CAPTURE_VERBOSE
2920 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_dispatch: from pcap_next_ex");
2922 /* XXX - this is currently unused, as there is some confusion with pcap_next_ex() vs. pcap_dispatch() */
2925 * WinPcap's remote capturing feature doesn't work with pcap_dispatch(),
2926 * see http://wiki.wireshark.org/CaptureSetup_2fWinPcapRemote
2927 * This should be fixed in the WinPcap 4.0 alpha release.
2929 * For reference, an example remote interface:
2930 * rpcap://[1.2.3.4]/\Device\NPF_{39993D68-7C9B-4439-A329-F2D888DA7C5C}
2933 /* emulate dispatch from pcap */
2936 struct pcap_pkthdr *pkt_header;
2941 (in = pcap_next_ex(pcap_opts->pcap_h, &pkt_header, &pkt_data)) == 1) {
2943 capture_loop_queue_packet_cb((u_char *)pcap_opts, pkt_header, pkt_data);
2945 capture_loop_write_packet_cb((u_char *)pcap_opts, pkt_header, pkt_data);
2950 pcap_opts->pcap_err = TRUE;
2954 #endif /* pcap_next_ex */
2958 #ifdef LOG_CAPTURE_VERBOSE
2959 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_dispatch: %d new packet%s", inpkts, plurality(inpkts, "", "s"));
2962 return ld->packet_count - packet_count_before;
2966 /* Isolate the Universally Unique Identifier from the interface. Basically, we
2967 * want to grab only the characters between the '{' and '}' delimiters.
2969 * Returns a GString that must be freed with g_string_free(). */
2971 isolate_uuid(const char *iface)
2976 ptr = strchr(iface, '{');
2978 return g_string_new(iface);
2979 gstr = g_string_new(ptr + 1);
2981 ptr = strchr(gstr->str, '}');
2985 gstr = g_string_truncate(gstr, ptr - gstr->str);
2990 /* open the output file (temporary/specified name/ringbuffer/named pipe/stdout) */
2991 /* Returns TRUE if the file opened successfully, FALSE otherwise. */
2993 capture_loop_open_output(capture_options *capture_opts, int *save_file_fd,
2994 char *errmsg, int errmsg_len)
2997 gchar *capfile_name;
2999 gboolean is_tempfile;
3001 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_open_output: %s",
3002 (capture_opts->save_file) ? capture_opts->save_file : "(not specified)");
3004 if (capture_opts->save_file != NULL) {
3005 /* We return to the caller while the capture is in progress.
3006 * Therefore we need to take a copy of save_file in
3007 * case the caller destroys it after we return.
3009 capfile_name = g_strdup(capture_opts->save_file);
3011 if (capture_opts->output_to_pipe == TRUE) { /* either "-" or named pipe */
3012 if (capture_opts->multi_files_on) {
3013 /* ringbuffer is enabled; that doesn't work with standard output or a named pipe */
3014 g_snprintf(errmsg, errmsg_len,
3015 "Ring buffer requested, but capture is being written to standard output or to a named pipe.");
3016 g_free(capfile_name);
3019 if (strcmp(capfile_name, "-") == 0) {
3020 /* write to stdout */
3023 /* set output pipe to binary mode to avoid Windows text-mode processing (eg: for CR/LF) */
3024 _setmode(1, O_BINARY);
3027 } /* if (...output_to_pipe ... */
3030 if (capture_opts->multi_files_on) {
3031 /* ringbuffer is enabled */
3032 *save_file_fd = ringbuf_init(capfile_name,
3033 (capture_opts->has_ring_num_files) ? capture_opts->ring_num_files : 0,
3034 capture_opts->group_read_access);
3036 /* we need the ringbuf name */
3037 if(*save_file_fd != -1) {
3038 g_free(capfile_name);
3039 capfile_name = g_strdup(ringbuf_current_filename());
3042 /* Try to open/create the specified file for use as a capture buffer. */
3043 *save_file_fd = ws_open(capfile_name, O_RDWR|O_BINARY|O_TRUNC|O_CREAT,
3044 (capture_opts->group_read_access) ? 0640 : 0600);
3047 is_tempfile = FALSE;
3049 /* Choose a random name for the temporary capture buffer */
3050 if (global_capture_opts.ifaces->len > 1) {
3051 prefix = g_strdup_printf("wireshark_%d_interfaces", global_capture_opts.ifaces->len);
3056 iface = isolate_uuid(g_array_index(global_capture_opts.ifaces, interface_options, 0).name);
3057 basename = g_path_get_basename(iface->str);
3058 g_string_free(iface, TRUE);
3060 basename = g_path_get_basename(g_array_index(global_capture_opts.ifaces, interface_options, 0).name);
3062 prefix = g_strconcat("wireshark_", basename, NULL);
3065 *save_file_fd = create_tempfile(&tmpname, prefix);
3067 capfile_name = g_strdup(tmpname);
3071 /* did we fail to open the output file? */
3072 if (*save_file_fd == -1) {
3074 g_snprintf(errmsg, errmsg_len,
3075 "The temporary file to which the capture would be saved (\"%s\") "
3076 "could not be opened: %s.", capfile_name, g_strerror(errno));
3078 if (capture_opts->multi_files_on) {
3079 ringbuf_error_cleanup();
3082 g_snprintf(errmsg, errmsg_len,
3083 "The file to which the capture would be saved (\"%s\") "
3084 "could not be opened: %s.", capfile_name,
3087 g_free(capfile_name);
3091 if(capture_opts->save_file != NULL) {
3092 g_free(capture_opts->save_file);
3094 capture_opts->save_file = capfile_name;
3095 /* capture_opts.save_file is "g_free"ed later, which is equivalent to
3096 "g_free(capfile_name)". */
3102 /* Do the work of handling either the file size or file duration capture
3103 conditions being reached, and switching files or stopping. */
3105 do_file_switch_or_stop(capture_options *capture_opts,
3106 condition *cnd_autostop_files,
3107 condition *cnd_autostop_size,
3108 condition *cnd_file_duration)
3111 pcap_options *pcap_opts;
3112 interface_options interface_opts;
3113 gboolean successful;
3115 if (capture_opts->multi_files_on) {
3116 if (cnd_autostop_files != NULL &&
3117 cnd_eval(cnd_autostop_files, ++global_ld.autostop_files)) {
3118 /* no files left: stop here */
3119 global_ld.go = FALSE;
3123 /* Switch to the next ringbuffer file */
3124 if (ringbuf_switch_file(&global_ld.pdh, &capture_opts->save_file,
3125 &global_ld.save_file_fd, &global_ld.err)) {
3127 /* File switch succeeded: reset the conditions */
3128 global_ld.bytes_written = 0;
3129 if (capture_opts->use_pcapng) {
3131 GString *os_info_str;
3133 os_info_str = g_string_new("");
3134 get_os_version_info(os_info_str);
3136 g_snprintf(appname, sizeof(appname), "Dumpcap " VERSION "%s", wireshark_svnversion);
3137 successful = libpcap_write_session_header_block(global_ld.pdh,
3140 os_info_str->str, /* OS */
3142 -1, /* section_length */
3143 &(global_ld.bytes_written),
3146 for (i = 0; successful && (i < capture_opts->ifaces->len); i++) {
3147 interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
3148 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, i);
3149 successful = libpcap_write_interface_description_block(global_ld.pdh,
3150 NULL, /* OPT_COMMENT 1 */
3151 interface_opts.name, /* IDB_NAME 2 */
3152 interface_opts.descr, /* IDB_DESCRIPTION 3 */
3153 interface_opts.cfilter, /* IDB_FILTER 11 */
3154 os_info_str->str, /* IDB_OS 12 */
3155 pcap_opts->linktype,
3157 &(global_ld.bytes_written),
3158 0, /* IDB_IF_SPEED 8 */
3159 pcap_opts->ts_nsec ? 9 : 6, /* IDB_TSRESOL 9 */
3163 g_string_free(os_info_str, TRUE);
3166 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, 0);
3167 successful = libpcap_write_file_header(global_ld.pdh, pcap_opts->linktype, pcap_opts->snaplen,
3168 pcap_opts->ts_nsec, &global_ld.bytes_written, &global_ld.err);
3171 fclose(global_ld.pdh);
3172 global_ld.pdh = NULL;
3173 global_ld.go = FALSE;
3176 if (cnd_autostop_size)
3177 cnd_reset(cnd_autostop_size);
3178 if (cnd_file_duration)
3179 cnd_reset(cnd_file_duration);
3180 libpcap_dump_flush(global_ld.pdh, NULL);
3182 report_packet_count(global_ld.inpkts_to_sync_pipe);
3183 global_ld.inpkts_to_sync_pipe = 0;
3184 report_new_capture_file(capture_opts->save_file);
3186 /* File switch failed: stop here */
3187 global_ld.go = FALSE;
3191 /* single file, stop now */
3192 global_ld.go = FALSE;
3199 pcap_read_handler(void* arg)
3201 pcap_options *pcap_opts;
3202 char errmsg[MSG_MAX_LENGTH+1];
3204 pcap_opts = (pcap_options *)arg;
3206 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Started thread for interface %d.",
3207 pcap_opts->interface_id);
3209 while (global_ld.go) {
3210 /* dispatch incoming packets */
3211 capture_loop_dispatch(&global_ld, errmsg, sizeof(errmsg), pcap_opts);
3213 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Stopped thread for interface %d.",
3214 pcap_opts->interface_id);
3215 g_thread_exit(NULL);
3219 /* Do the low-level work of a capture.
3220 Returns TRUE if it succeeds, FALSE otherwise. */
3222 capture_loop_start(capture_options *capture_opts, gboolean *stats_known, struct pcap_stat *stats)
3225 DWORD upd_time, cur_time; /* GetTickCount() returns a "DWORD" (which is 'unsigned long') */
3227 struct timeval upd_time, cur_time;
3231 condition *cnd_file_duration = NULL;
3232 condition *cnd_autostop_files = NULL;
3233 condition *cnd_autostop_size = NULL;
3234 condition *cnd_autostop_duration = NULL;
3237 gboolean cfilter_error = FALSE;
3238 char errmsg[MSG_MAX_LENGTH+1];
3239 char secondary_errmsg[MSG_MAX_LENGTH+1];
3240 pcap_options *pcap_opts;
3241 interface_options interface_opts;
3242 guint i, error_index = 0;
3245 *secondary_errmsg = '\0';
3247 /* init the loop data */
3248 global_ld.go = TRUE;
3249 global_ld.packet_count = 0;
3251 global_ld.report_packet_count = FALSE;
3253 if (capture_opts->has_autostop_packets)
3254 global_ld.packet_max = capture_opts->autostop_packets;
3256 global_ld.packet_max = 0; /* no limit */
3257 global_ld.inpkts_to_sync_pipe = 0;
3258 global_ld.err = 0; /* no error seen yet */
3259 global_ld.pdh = NULL;
3260 global_ld.autostop_files = 0;
3261 global_ld.save_file_fd = -1;
3263 /* We haven't yet gotten the capture statistics. */
3264 *stats_known = FALSE;
3266 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Capture loop starting ...");
3267 capture_opts_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, capture_opts);
3269 /* open the "input file" from network interface or capture pipe */
3270 if (!capture_loop_open_input(capture_opts, &global_ld, errmsg, sizeof(errmsg),
3271 secondary_errmsg, sizeof(secondary_errmsg))) {
3274 for (i = 0; i < capture_opts->ifaces->len; i++) {
3275 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, i);
3276 interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
3277 /* init the input filter from the network interface (capture pipe will do nothing) */
3279 * When remote capturing WinPCap crashes when the capture filter
3280 * is NULL. This might be a bug in WPCap. Therefore we provide an empty
3283 switch (capture_loop_init_filter(pcap_opts->pcap_h, pcap_opts->from_cap_pipe,
3284 interface_opts.name,
3285 interface_opts.cfilter?interface_opts.cfilter:"")) {
3287 case INITFILTER_NO_ERROR:
3290 case INITFILTER_BAD_FILTER:
3291 cfilter_error = TRUE;
3293 g_snprintf(errmsg, sizeof(errmsg), "%s", pcap_geterr(pcap_opts->pcap_h));
3296 case INITFILTER_OTHER_ERROR:
3297 g_snprintf(errmsg, sizeof(errmsg), "Can't install filter (%s).",
3298 pcap_geterr(pcap_opts->pcap_h));
3299 g_snprintf(secondary_errmsg, sizeof(secondary_errmsg), "%s", please_report);
3304 /* If we're supposed to write to a capture file, open it for output
3305 (temporary/specified name/ringbuffer) */
3306 if (capture_opts->saving_to_file) {
3307 if (!capture_loop_open_output(capture_opts, &global_ld.save_file_fd,
3308 errmsg, sizeof(errmsg))) {
3312 /* set up to write to the already-opened capture output file/files */
3313 if (!capture_loop_init_output(capture_opts, &global_ld, errmsg,
3318 /* XXX - capture SIGTERM and close the capture, in case we're on a
3319 Linux 2.0[.x] system and you have to explicitly close the capture
3320 stream in order to turn promiscuous mode off? We need to do that
3321 in other places as well - and I don't think that works all the
3322 time in any case, due to libpcap bugs. */
3324 /* Well, we should be able to start capturing.
3326 Sync out the capture file, so the header makes it to the file system,
3327 and send a "capture started successfully and capture file created"
3328 message to our parent so that they'll open the capture file and
3329 update its windows to indicate that we have a live capture in
3331 libpcap_dump_flush(global_ld.pdh, NULL);
3332 report_new_capture_file(capture_opts->save_file);
3335 /* initialize capture stop (and alike) conditions */
3336 init_capture_stop_conditions();
3337 /* create stop conditions */
3338 if (capture_opts->has_autostop_filesize)
3340 cnd_new(CND_CLASS_CAPTURESIZE,(long)capture_opts->autostop_filesize * 1024);
3341 if (capture_opts->has_autostop_duration)
3342 cnd_autostop_duration =
3343 cnd_new(CND_CLASS_TIMEOUT,(gint32)capture_opts->autostop_duration);
3345 if (capture_opts->multi_files_on) {
3346 if (capture_opts->has_file_duration)
3348 cnd_new(CND_CLASS_TIMEOUT, capture_opts->file_duration);
3350 if (capture_opts->has_autostop_files)
3351 cnd_autostop_files =
3352 cnd_new(CND_CLASS_CAPTURESIZE, capture_opts->autostop_files);
3355 /* init the time values */
3357 upd_time = GetTickCount();
3359 gettimeofday(&upd_time, NULL);
3361 start_time = create_timestamp();
3362 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Capture loop running!");
3364 /* WOW, everything is prepared! */
3365 /* please fasten your seat belts, we will enter now the actual capture loop */
3367 pcap_queue = g_async_queue_new();
3368 pcap_queue_bytes = 0;
3369 pcap_queue_packets = 0;
3370 for (i = 0; i < global_ld.pcaps->len; i++) {
3371 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, i);
3372 #if GLIB_CHECK_VERSION(2,31,0)
3373 /* XXX - Add an interface name here? */
3374 pcap_opts->tid = g_thread_new("Capture read", pcap_read_handler, pcap_opts);
3376 pcap_opts->tid = g_thread_create(pcap_read_handler, pcap_opts, TRUE, NULL);
3380 while (global_ld.go) {
3381 /* dispatch incoming packets */
3383 pcap_queue_element *queue_element;
3384 #if GLIB_CHECK_VERSION(2,31,18)
3386 g_async_queue_lock(pcap_queue);
3387 queue_element = g_async_queue_timeout_pop_unlocked(pcap_queue, WRITER_THREAD_TIMEOUT);
3389 GTimeVal write_thread_time;
3391 g_get_current_time(&write_thread_time);
3392 g_time_val_add(&write_thread_time, WRITER_THREAD_TIMEOUT);
3393 g_async_queue_lock(pcap_queue);
3394 queue_element = g_async_queue_timed_pop_unlocked(pcap_queue, &write_thread_time);
3396 if (queue_element) {
3397 pcap_queue_bytes -= queue_element->phdr.caplen;
3398 pcap_queue_packets -= 1;
3400 g_async_queue_unlock(pcap_queue);
3401 if (queue_element) {
3402 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
3403 "Dequeued a packet of length %d captured on interface %d.",
3404 queue_element->phdr.caplen, queue_element->pcap_opts->interface_id);
3406 capture_loop_write_packet_cb((u_char *) queue_element->pcap_opts,
3407 &queue_element->phdr,
3409 g_free(queue_element->pd);
3410 g_free(queue_element);
3416 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, 0);
3417 inpkts = capture_loop_dispatch(&global_ld, errmsg,
3418 sizeof(errmsg), pcap_opts);
3421 /* Were we asked to print packet counts by the SIGINFO handler? */
3422 if (global_ld.report_packet_count) {
3423 fprintf(stderr, "%u packet%s captured\n", global_ld.packet_count,
3424 plurality(global_ld.packet_count, "", "s"));
3425 global_ld.report_packet_count = FALSE;
3430 /* any news from our parent (signal pipe)? -> just stop the capture */
3431 if (!signal_pipe_check_running()) {
3432 global_ld.go = FALSE;
3437 global_ld.inpkts_to_sync_pipe += inpkts;
3439 /* check capture size condition */
3440 if (cnd_autostop_size != NULL &&
3441 cnd_eval(cnd_autostop_size, (guint32)global_ld.bytes_written)) {
3442 /* Capture size limit reached, do we have another file? */
3443 if (!do_file_switch_or_stop(capture_opts, cnd_autostop_files,
3444 cnd_autostop_size, cnd_file_duration))
3446 } /* cnd_autostop_size */
3447 if (capture_opts->output_to_pipe) {
3448 libpcap_dump_flush(global_ld.pdh, NULL);
3452 /* Only update once every 500ms so as not to overload slow displays.
3453 * This also prevents too much context-switching between the dumpcap
3454 * and wireshark processes.
3456 #define DUMPCAP_UPD_TIME 500
3459 cur_time = GetTickCount(); /* Note: wraps to 0 if sys runs for 49.7 days */
3460 if ((cur_time - upd_time) > DUMPCAP_UPD_TIME) { /* wrap just causes an extra update */
3462 gettimeofday(&cur_time, NULL);
3463 if ((cur_time.tv_sec * 1000000 + cur_time.tv_usec) >
3464 (upd_time.tv_sec * 1000000 + upd_time.tv_usec + DUMPCAP_UPD_TIME*1000)) {
3467 upd_time = cur_time;
3470 if (pcap_stats(pch, stats) >= 0) {
3471 *stats_known = TRUE;
3474 /* Let the parent process know. */
3475 if (global_ld.inpkts_to_sync_pipe) {
3477 libpcap_dump_flush(global_ld.pdh, NULL);
3479 /* Send our parent a message saying we've written out
3480 "global_ld.inpkts_to_sync_pipe" packets to the capture file. */
3482 report_packet_count(global_ld.inpkts_to_sync_pipe);
3484 global_ld.inpkts_to_sync_pipe = 0;
3487 /* check capture duration condition */
3488 if (cnd_autostop_duration != NULL && cnd_eval(cnd_autostop_duration)) {
3489 /* The maximum capture time has elapsed; stop the capture. */
3490 global_ld.go = FALSE;
3494 /* check capture file duration condition */
3495 if (cnd_file_duration != NULL && cnd_eval(cnd_file_duration)) {
3496 /* duration limit reached, do we have another file? */
3497 if (!do_file_switch_or_stop(capture_opts, cnd_autostop_files,
3498 cnd_autostop_size, cnd_file_duration))
3500 } /* cnd_file_duration */
3504 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Capture loop stopping ...");
3506 pcap_queue_element *queue_element;
3508 for (i = 0; i < global_ld.pcaps->len; i++) {
3509 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, i);
3510 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Waiting for thread of interface %u...",
3511 pcap_opts->interface_id);
3512 g_thread_join(pcap_opts->tid);
3513 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Thread of interface %u terminated.",
3514 pcap_opts->interface_id);
3517 g_async_queue_lock(pcap_queue);
3518 queue_element = g_async_queue_try_pop_unlocked(pcap_queue);
3519 if (queue_element) {
3520 pcap_queue_bytes -= queue_element->phdr.caplen;
3521 pcap_queue_packets -= 1;
3523 g_async_queue_unlock(pcap_queue);
3524 if (queue_element == NULL) {
3527 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
3528 "Dequeued a packet of length %d captured on interface %d.",
3529 queue_element->phdr.caplen, queue_element->pcap_opts->interface_id);
3530 capture_loop_write_packet_cb((u_char *)queue_element->pcap_opts,
3531 &queue_element->phdr,
3533 g_free(queue_element->pd);
3534 g_free(queue_element);
3535 global_ld.inpkts_to_sync_pipe += 1;
3536 if (capture_opts->output_to_pipe) {
3537 libpcap_dump_flush(global_ld.pdh, NULL);
3543 /* delete stop conditions */
3544 if (cnd_file_duration != NULL)
3545 cnd_delete(cnd_file_duration);
3546 if (cnd_autostop_files != NULL)
3547 cnd_delete(cnd_autostop_files);
3548 if (cnd_autostop_size != NULL)
3549 cnd_delete(cnd_autostop_size);
3550 if (cnd_autostop_duration != NULL)
3551 cnd_delete(cnd_autostop_duration);
3553 /* did we have a pcap (input) error? */
3554 for (i = 0; i < capture_opts->ifaces->len; i++) {
3555 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, i);
3556 if (pcap_opts->pcap_err) {
3557 /* On Linux, if an interface goes down while you're capturing on it,
3558 you'll get a "recvfrom: Network is down" or
3559 "The interface went down" error (ENETDOWN).
3560 (At least you will if g_strerror() doesn't show a local translation
3563 On FreeBSD and OS X, if a network adapter disappears while
3564 you're capturing on it, you'll get a "read: Device not configured"
3565 error (ENXIO). (See previous parenthetical note.)
3567 On OpenBSD, you get "read: I/O error" (EIO) in the same case.
3569 These should *not* be reported to the Wireshark developers. */
3572 cap_err_str = pcap_geterr(pcap_opts->pcap_h);
3573 if (strcmp(cap_err_str, "recvfrom: Network is down") == 0 ||
3574 strcmp(cap_err_str, "The interface went down") == 0 ||
3575 strcmp(cap_err_str, "read: Device not configured") == 0 ||
3576 strcmp(cap_err_str, "read: I/O error") == 0 ||
3577 strcmp(cap_err_str, "read error: PacketReceivePacket failed") == 0) {
3578 report_capture_error("The network adapter on which the capture was being done "
3579 "is no longer running; the capture has stopped.",
3582 g_snprintf(errmsg, sizeof(errmsg), "Error while capturing packets: %s",
3584 report_capture_error(errmsg, please_report);
3587 } else if (pcap_opts->from_cap_pipe && pcap_opts->cap_pipe_err == PIPERR) {
3588 report_capture_error(errmsg, "");
3592 /* did we have an output error while capturing? */
3593 if (global_ld.err == 0) {
3596 capture_loop_get_errmsg(errmsg, sizeof(errmsg), capture_opts->save_file,
3597 global_ld.err, FALSE);
3598 report_capture_error(errmsg, please_report);
3602 if (capture_opts->saving_to_file) {
3603 /* close the output file */
3604 close_ok = capture_loop_close_output(capture_opts, &global_ld, &err_close);
3608 /* there might be packets not yet notified to the parent */
3609 /* (do this after closing the file, so all packets are already flushed) */
3610 if(global_ld.inpkts_to_sync_pipe) {
3612 report_packet_count(global_ld.inpkts_to_sync_pipe);
3613 global_ld.inpkts_to_sync_pipe = 0;
3616 /* If we've displayed a message about a write error, there's no point
3617 in displaying another message about an error on close. */
3618 if (!close_ok && write_ok) {
3619 capture_loop_get_errmsg(errmsg, sizeof(errmsg), capture_opts->save_file, err_close,
3621 report_capture_error(errmsg, "");
3625 * XXX We exhibit different behaviour between normal mode and sync mode
3626 * when the pipe is stdin and not already at EOF. If we're a child, the
3627 * parent's stdin isn't closed, so if the user starts another capture,
3628 * cap_pipe_open_live() will very likely not see the expected magic bytes and
3629 * will say "Unrecognized libpcap format". On the other hand, in normal
3630 * mode, cap_pipe_open_live() will say "End of file on pipe during open".
3633 report_capture_count(TRUE);
3635 /* get packet drop statistics from pcap */
3636 for (i = 0; i < capture_opts->ifaces->len; i++) {
3640 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, i);
3641 interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
3642 received = pcap_opts->received;
3643 dropped = pcap_opts->dropped;
3644 if (pcap_opts->pcap_h != NULL) {
3645 g_assert(!pcap_opts->from_cap_pipe);
3646 /* Get the capture statistics, so we know how many packets were dropped. */
3647 if (pcap_stats(pcap_opts->pcap_h, stats) >= 0) {
3648 *stats_known = TRUE;
3649 /* Let the parent process know. */
3650 dropped += stats->ps_drop;
3652 g_snprintf(errmsg, sizeof(errmsg),
3653 "Can't get packet-drop statistics: %s",
3654 pcap_geterr(pcap_opts->pcap_h));
3655 report_capture_error(errmsg, please_report);
3658 report_packet_drops(received, dropped, interface_opts.name);
3661 /* close the input file (pcap or capture pipe) */
3662 capture_loop_close_input(&global_ld);
3664 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Capture loop stopped!");
3666 /* ok, if the write and the close were successful. */
3667 return write_ok && close_ok;
3670 if (capture_opts->multi_files_on) {
3671 /* cleanup ringbuffer */
3672 ringbuf_error_cleanup();
3674 /* We can't use the save file, and we have no FILE * for the stream
3675 to close in order to close it, so close the FD directly. */
3676 if (global_ld.save_file_fd != -1) {
3677 ws_close(global_ld.save_file_fd);
3680 /* We couldn't even start the capture, so get rid of the capture
3682 if (capture_opts->save_file != NULL) {
3683 ws_unlink(capture_opts->save_file);
3684 g_free(capture_opts->save_file);
3687 capture_opts->save_file = NULL;
3689 report_cfilter_error(capture_opts, error_index, errmsg);
3691 report_capture_error(errmsg, secondary_errmsg);
3693 /* close the input file (pcap or cap_pipe) */
3694 capture_loop_close_input(&global_ld);
3696 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Capture loop stopped with error");
3702 static void capture_loop_stop(void)
3704 #ifdef HAVE_PCAP_BREAKLOOP
3706 pcap_options *pcap_opts;
3708 for (i = 0; i < global_ld.pcaps->len; i++) {
3709 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, i);
3710 if (pcap_opts->pcap_h != NULL)
3711 pcap_breakloop(pcap_opts->pcap_h);
3714 global_ld.go = FALSE;
3719 capture_loop_get_errmsg(char *errmsg, int errmsglen, const char *fname,
3720 int err, gboolean is_close)
3725 g_snprintf(errmsg, errmsglen,
3726 "Not all the packets could be written to the file"
3727 " to which the capture was being saved\n"
3728 "(\"%s\") because there is no space left on the file system\n"
3729 "on which that file resides.",
3735 g_snprintf(errmsg, errmsglen,
3736 "Not all the packets could be written to the file"
3737 " to which the capture was being saved\n"
3738 "(\"%s\") because you are too close to, or over,"
3739 " your disk quota\n"
3740 "on the file system on which that file resides.",
3747 g_snprintf(errmsg, errmsglen,
3748 "The file to which the capture was being saved\n"
3749 "(\"%s\") could not be closed: %s.",
3750 fname, g_strerror(err));
3752 g_snprintf(errmsg, errmsglen,
3753 "An error occurred while writing to the file"
3754 " to which the capture was being saved\n"
3756 fname, g_strerror(err));
3763 /* one packet was captured, process it */
3765 capture_loop_write_packet_cb(u_char *pcap_opts_p, const struct pcap_pkthdr *phdr,
3768 pcap_options *pcap_opts = (pcap_options *) (void *) pcap_opts_p;
3770 guint ts_mul = pcap_opts->ts_nsec ? 1000000000 : 1000000;
3772 /* We may be called multiple times from pcap_dispatch(); if we've set
3773 the "stop capturing" flag, ignore this packet, as we're not
3774 supposed to be saving any more packets. */
3778 if (global_ld.pdh) {
3779 gboolean successful;
3781 /* We're supposed to write the packet to a file; do so.
3782 If this fails, set "ld->go" to FALSE, to stop the capture, and set
3783 "ld->err" to the error. */
3784 if (global_capture_opts.use_pcapng) {
3785 successful = libpcap_write_enhanced_packet_block(global_ld.pdh, phdr, pcap_opts->interface_id, ts_mul, pd, &global_ld.bytes_written, &err);
3787 successful = libpcap_write_packet(global_ld.pdh, phdr, pd, &global_ld.bytes_written, &err);
3790 global_ld.go = FALSE;
3791 global_ld.err = err;
3793 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
3794 "Wrote a packet of length %d captured on interface %u.",
3795 phdr->caplen, pcap_opts->interface_id);
3796 global_ld.packet_count++;
3797 /* if the user told us to stop after x packets, do we already have enough? */
3798 if ((global_ld.packet_max > 0) && (global_ld.packet_count >= global_ld.packet_max)) {
3799 global_ld.go = FALSE;
3805 /* one packet was captured, queue it */
3807 capture_loop_queue_packet_cb(u_char *pcap_opts_p, const struct pcap_pkthdr *phdr,
3810 pcap_options *pcap_opts = (pcap_options *) (void *) pcap_opts_p;
3811 pcap_queue_element *queue_element;
3812 gboolean limit_reached;
3814 /* We may be called multiple times from pcap_dispatch(); if we've set
3815 the "stop capturing" flag, ignore this packet, as we're not
3816 supposed to be saving any more packets. */
3817 if (!global_ld.go) {
3818 pcap_opts->dropped++;
3822 queue_element = (pcap_queue_element *)g_malloc(sizeof(pcap_queue_element));
3823 if (queue_element == NULL) {
3824 pcap_opts->dropped++;
3827 queue_element->pcap_opts = pcap_opts;
3828 queue_element->phdr = *phdr;
3829 queue_element->pd = (u_char *)g_malloc(phdr->caplen);
3830 if (queue_element->pd == NULL) {
3831 pcap_opts->dropped++;
3832 g_free(queue_element);
3835 memcpy(queue_element->pd, pd, phdr->caplen);
3836 g_async_queue_lock(pcap_queue);
3837 if (((pcap_queue_byte_limit > 0) && (pcap_queue_bytes < pcap_queue_byte_limit)) &&
3838 ((pcap_queue_packet_limit > 0) && (pcap_queue_packets < pcap_queue_packet_limit))) {
3839 limit_reached = FALSE;
3840 g_async_queue_push_unlocked(pcap_queue, queue_element);
3841 pcap_queue_bytes += phdr->caplen;
3842 pcap_queue_packets += 1;
3844 limit_reached = TRUE;
3846 g_async_queue_unlock(pcap_queue);
3847 if (limit_reached) {
3848 pcap_opts->dropped++;
3849 g_free(queue_element->pd);
3850 g_free(queue_element);
3851 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
3852 "Dropped a packet of length %d captured on interface %u.",
3853 phdr->caplen, pcap_opts->interface_id);
3855 pcap_opts->received++;
3856 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
3857 "Queued a packet of length %d captured on interface %u.",
3858 phdr->caplen, pcap_opts->interface_id);
3860 /* I don't want to hold the mutex over the debug output. So the
3861 output may be wrong */
3862 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
3863 "Queue size is now %" G_GINT64_MODIFIER "d bytes (%" G_GINT64_MODIFIER "d packets)",
3864 pcap_queue_bytes, pcap_queue_packets);
3867 /* And now our feature presentation... [ fade to music ] */
3869 main(int argc, char *argv[])
3872 gboolean arg_error = FALSE;
3877 struct sigaction action, oldaction;
3880 gboolean start_capture = TRUE;
3881 gboolean stats_known;
3882 struct pcap_stat stats;
3883 GLogLevelFlags log_flags;
3884 gboolean list_interfaces = FALSE;
3885 gboolean list_link_layer_types = FALSE;
3886 #ifdef HAVE_BPF_IMAGE
3887 gboolean print_bpf_code = FALSE;
3889 gboolean machine_readable = FALSE;
3890 gboolean print_statistics = FALSE;
3891 int status, run_once_args = 0;
3894 #if defined(__APPLE__) && defined(__LP64__)
3895 struct utsname osinfo;
3900 arg_list_utf_16to8(argc, argv);
3905 * Initialize our DLL search path. MUST be called before LoadLibrary
3908 ws_init_dll_search_path();
3911 #ifdef HAVE_PCAP_REMOTE
3912 #define OPTSTRING_A "A:"
3913 #define OPTSTRING_r "r"
3914 #define OPTSTRING_u "u"
3916 #define OPTSTRING_A ""
3917 #define OPTSTRING_r ""
3918 #define OPTSTRING_u ""
3921 #ifdef HAVE_PCAP_SETSAMPLING
3922 #define OPTSTRING_m "m:"
3924 #define OPTSTRING_m ""
3927 #if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
3928 #define OPTSTRING_B "B:"
3930 #define OPTSTRING_B ""
3931 #endif /* _WIN32 or HAVE_PCAP_CREATE */
3933 #ifdef HAVE_PCAP_CREATE
3934 #define OPTSTRING_I "I"
3936 #define OPTSTRING_I ""
3939 #ifdef HAVE_BPF_IMAGE
3940 #define OPTSTRING_d "d"
3942 #define OPTSTRING_d ""
3945 #define OPTSTRING "a:" OPTSTRING_A "b:" OPTSTRING_B "c:" OPTSTRING_d "Df:ghi:" OPTSTRING_I "L" OPTSTRING_m "MnpPq" OPTSTRING_r "Ss:t" OPTSTRING_u "vw:y:Z:"
3947 #ifdef DEBUG_CHILD_DUMPCAP
3948 if ((debug_log = ws_fopen("dumpcap_debug_log.tmp","w")) == NULL) {
3949 fprintf (stderr, "Unable to open debug log file !\n");
3954 #if defined(__APPLE__) && defined(__LP64__)
3956 * Is this Mac OS X 10.6.0, 10.6.1, 10.6.3, or 10.6.4? If so, we need
3957 * a bug workaround - timeouts less than 1 second don't work with libpcap
3958 * in 64-bit code. (The bug was introduced in 10.6, fixed in 10.6.2,
3959 * re-introduced in 10.6.3, not fixed in 10.6.4, and fixed in 10.6.5.
3960 * The problem is extremely unlikely to be reintroduced in a future
3963 if (uname(&osinfo) == 0) {
3965 * Mac OS X 10.x uses Darwin {x+4}.0.0. Mac OS X 10.x.y uses Darwin
3966 * {x+4}.y.0 (except that 10.6.1 appears to have a uname version
3967 * number of 10.0.0, not 10.1.0 - go figure).
3969 if (strcmp(osinfo.release, "10.0.0") == 0 || /* 10.6, 10.6.1 */
3970 strcmp(osinfo.release, "10.3.0") == 0 || /* 10.6.3 */
3971 strcmp(osinfo.release, "10.4.0") == 0) /* 10.6.4 */
3972 need_timeout_workaround = TRUE;
3977 * Determine if dumpcap is being requested to run in a special
3978 * capture_child mode by going thru the command line args to see if
3979 * a -Z is present. (-Z is a hidden option).
3981 * The primary result of running in capture_child mode is that
3982 * all messages sent out on stderr are in a special type/len/string
3983 * format to allow message processing by type. These messages include
3984 * error messages if dumpcap fails to start the operation it was
3985 * requested to do, as well as various "status" messages which are sent
3986 * when an actual capture is in progress, and a "success" message sent
3987 * if dumpcap was requested to perform an operation other than a
3990 * Capture_child mode would normally be requested by a parent process
3991 * which invokes dumpcap and obtains dumpcap stderr output via a pipe
3992 * to which dumpcap stderr has been redirected. It might also have
3993 * another pipe to obtain dumpcap stdout output; for operations other
3994 * than a capture, that information is formatted specially for easier
3995 * parsing by the parent process.
3997 * Capture_child mode needs to be determined immediately upon
3998 * startup so that any messages generated by dumpcap in this mode
3999 * (eg: during initialization) will be formatted properly.
4002 for (i=1; i<argc; i++) {
4003 if (strcmp("-Z", argv[i]) == 0) {
4004 capture_child = TRUE;
4005 machine_readable = TRUE; /* request machine-readable output */
4007 /* set output pipe to binary mode, to avoid ugly text conversions */
4008 _setmode(2, O_BINARY);
4013 /* The default_log_handler will use stdout, which makes trouble in */
4014 /* capture child mode, as it uses stdout for it's sync_pipe. */
4015 /* So: the filtering is done in the console_log_handler and not here.*/
4016 /* We set the log handlers right up front to make sure that any log */
4017 /* messages when running as child will be sent back to the parent */
4018 /* with the correct format. */
4022 G_LOG_LEVEL_CRITICAL|
4023 G_LOG_LEVEL_WARNING|
4024 G_LOG_LEVEL_MESSAGE|
4027 G_LOG_FLAG_FATAL|G_LOG_FLAG_RECURSION;
4029 g_log_set_handler(NULL,
4031 console_log_handler, NULL /* user_data */);
4032 g_log_set_handler(LOG_DOMAIN_MAIN,
4034 console_log_handler, NULL /* user_data */);
4035 g_log_set_handler(LOG_DOMAIN_CAPTURE,
4037 console_log_handler, NULL /* user_data */);
4038 g_log_set_handler(LOG_DOMAIN_CAPTURE_CHILD,
4040 console_log_handler, NULL /* user_data */);
4042 /* Initialize the pcaps list */
4043 global_ld.pcaps = g_array_new(FALSE, FALSE, sizeof(pcap_options *));
4045 #if !GLIB_CHECK_VERSION(2,31,0)
4046 /* Initialize the thread system */
4047 g_thread_init(NULL);
4051 /* Load wpcap if possible. Do this before collecting the run-time version information */
4054 /* ... and also load the packet.dll from wpcap */
4055 /* XXX - currently not required, may change later. */
4056 /*wpcap_packet_load();*/
4058 /* Start windows sockets */
4059 WSAStartup( MAKEWORD( 1, 1 ), &wsaData );
4061 /* Set handler for Ctrl+C key */
4062 SetConsoleCtrlHandler(capture_cleanup_handler, TRUE);
4064 /* Catch SIGINT and SIGTERM and, if we get either of them, clean up
4065 and exit. Do the same with SIGPIPE, in case, for example,
4066 we're writing to our standard output and it's a pipe.
4067 Do the same with SIGHUP if it's not being ignored (if we're
4068 being run under nohup, it might be ignored, in which case we
4069 should leave it ignored).
4071 XXX - apparently, Coverity complained that part of action
4072 wasn't initialized. Perhaps it's running on Linux, where
4073 struct sigaction has an ignored "sa_restorer" element and
4074 where "sa_handler" and "sa_sigaction" might not be two
4075 members of a union. */
4076 memset(&action, 0, sizeof(action));
4077 action.sa_handler = capture_cleanup_handler;
4079 * Arrange that system calls not get restarted, because when
4080 * our signal handler returns we don't want to restart
4081 * a call that was waiting for packets to arrive.
4083 action.sa_flags = 0;
4084 sigemptyset(&action.sa_mask);
4085 sigaction(SIGTERM, &action, NULL);
4086 sigaction(SIGINT, &action, NULL);
4087 sigaction(SIGPIPE, &action, NULL);
4088 sigaction(SIGHUP, NULL, &oldaction);
4089 if (oldaction.sa_handler == SIG_DFL)
4090 sigaction(SIGHUP, &action, NULL);
4093 /* Catch SIGINFO and, if we get it and we're capturing in
4094 quiet mode, report the number of packets we've captured. */
4095 action.sa_handler = report_counts_siginfo;
4096 action.sa_flags = SA_RESTART;
4097 sigemptyset(&action.sa_mask);
4098 sigaction(SIGINFO, &action, NULL);
4099 #endif /* SIGINFO */
4102 /* ----------------------------------------------------------------- */
4103 /* Privilege and capability handling */
4105 /* 1. Running not as root or suid root; no special capabilities. */
4108 /* 2. Running logged in as root (euid=0; ruid=0); Not using libcap. */
4111 /* 3. Running logged in as root (euid=0; ruid=0). Using libcap. */
4113 /* - Near start of program: Enable NET_RAW and NET_ADMIN */
4114 /* capabilities; Drop all other capabilities; */
4115 /* - If not -w (ie: doing -S or -D, etc) run to completion; */
4116 /* else: after pcap_open_live() in capture_loop_open_input() */
4117 /* drop all capabilities (NET_RAW and NET_ADMIN); */
4118 /* (Note: this means that the process, although logged in */
4119 /* as root, does not have various permissions such as the */
4120 /* ability to bypass file access permissions). */
4121 /* XXX: Should we just leave capabilities alone in this case */
4122 /* so that user gets expected effect that root can do */
4125 /* 4. Running as suid root (euid=0, ruid=n); Not using libcap. */
4127 /* - If not -w (ie: doing -S or -D, etc) run to completion; */
4128 /* else: after pcap_open_live() in capture_loop_open_input() */
4129 /* drop suid root (set euid=ruid).(ie: keep suid until after */
4130 /* pcap_open_live). */
4132 /* 5. Running as suid root (euid=0, ruid=n); Using libcap. */
4134 /* - Near start of program: Enable NET_RAW and NET_ADMIN */
4135 /* capabilities; Drop all other capabilities; */
4136 /* Drop suid privileges (euid=ruid); */
4137 /* - If not -w (ie: doing -S or -D, etc) run to completion; */
4138 /* else: after pcap_open_live() in capture_loop_open_input() */
4139 /* drop all capabilities (NET_RAW and NET_ADMIN). */
4141 /* XXX: For some Linux versions/distros with capabilities */
4142 /* a 'normal' process with any capabilities cannot be */
4143 /* 'killed' (signaled) from another (same uid) non-privileged */
4145 /* For example: If (non-suid) Wireshark forks a */
4146 /* child suid dumpcap which acts as described here (case 5), */
4147 /* Wireshark will be unable to kill (signal) the child */
4148 /* dumpcap process until the capabilities have been dropped */
4149 /* (after pcap_open_live()). */
4150 /* This behaviour will apparently be changed in the kernel */
4151 /* to allow the kill (signal) in this case. */
4152 /* See the following for details: */
4153 /* http://www.mail-archive.com/ [wrapped] */
4154 /* linux-security-module@vger.kernel.org/msg02913.html */
4156 /* It is therefore conceivable that if dumpcap somehow hangs */
4157 /* in pcap_open_live or before that wireshark will not */
4158 /* be able to stop dumpcap using a signal (INT, TERM, etc). */
4159 /* In this case, exiting wireshark will kill the child */
4160 /* dumpcap process. */
4162 /* 6. Not root or suid root; Running with NET_RAW & NET_ADMIN */
4163 /* capabilities; Using libcap. Note: capset cmd (which see) */
4164 /* used to assign capabilities to file. */
4166 /* - If not -w (ie: doing -S or -D, etc) run to completion; */
4167 /* else: after pcap_open_live() in capture_loop_open_input() */
4168 /* drop all capabilities (NET_RAW and NET_ADMIN) */
4170 /* ToDo: -S (stats) should drop privileges/capabilities when no */
4171 /* longer required (similar to capture). */
4173 /* ----------------------------------------------------------------- */
4175 init_process_policies();
4178 /* If 'started with special privileges' (and using libcap) */
4179 /* Set to keep only NET_RAW and NET_ADMIN capabilities; */
4180 /* Set euid/egid = ruid/rgid to remove suid privileges */
4181 relinquish_privs_except_capture();
4184 /* Set the initial values in the capture options. This might be overwritten
4185 by the command line parameters. */
4186 capture_opts_init(&global_capture_opts, NULL);
4188 /* We always save to a file - if no file was specified, we save to a
4190 global_capture_opts.saving_to_file = TRUE;
4191 global_capture_opts.has_ring_num_files = TRUE;
4193 /* Now get our args */
4194 while ((opt = getopt(argc, argv, OPTSTRING)) != -1) {
4196 case 'h': /* Print help and exit */
4200 case 'v': /* Show version and exit */
4202 GString *comp_info_str;
4203 GString *runtime_info_str;
4204 /* Assemble the compile-time version information string */
4205 comp_info_str = g_string_new("Compiled ");
4206 get_compiled_version_info(comp_info_str, NULL, NULL);
4208 /* Assemble the run-time version information string */
4209 runtime_info_str = g_string_new("Running ");
4210 get_runtime_version_info(runtime_info_str, NULL);
4211 show_version(comp_info_str, runtime_info_str);
4212 g_string_free(comp_info_str, TRUE);
4213 g_string_free(runtime_info_str, TRUE);
4217 /*** capture option specific ***/
4218 case 'a': /* autostop criteria */
4219 case 'b': /* Ringbuffer option */
4220 case 'c': /* Capture x packets */
4221 case 'f': /* capture filter */
4222 case 'i': /* Use interface x */
4223 case 'n': /* Use pcapng format */
4224 case 'p': /* Don't capture in promiscuous mode */
4225 case 'P': /* Use pcap format */
4226 case 's': /* Set the snapshot (capture) length */
4227 case 'w': /* Write to capture file x */
4228 case 'g': /* enable group read accesson file(s) */
4229 case 'y': /* Set the pcap data link type */
4230 #ifdef HAVE_PCAP_REMOTE
4231 case 'u': /* Use UDP for data transfer */
4232 case 'r': /* Capture own RPCAP traffic too */
4233 case 'A': /* Authentication */
4235 #ifdef HAVE_PCAP_SETSAMPLING
4236 case 'm': /* Sampling */
4238 #if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
4239 case 'B': /* Buffer size */
4240 #endif /* _WIN32 or HAVE_PCAP_CREATE */
4241 #ifdef HAVE_PCAP_CREATE
4242 case 'I': /* Monitor mode */
4244 status = capture_opts_add_opt(&global_capture_opts, opt, optarg, &start_capture);
4249 /*** hidden option: Wireshark child mode (using binary output messages) ***/
4251 capture_child = TRUE;
4253 /* set output pipe to binary mode, to avoid ugly text conversions */
4254 _setmode(2, O_BINARY);
4256 * optarg = the control ID, aka the PPID, currently used for the
4259 if (strcmp(optarg, SIGNAL_PIPE_CTRL_ID_NONE) != 0) {
4260 sig_pipe_name = g_strdup_printf(SIGNAL_PIPE_FORMAT, optarg);
4261 sig_pipe_handle = CreateFile(utf_8to16(sig_pipe_name),
4262 GENERIC_READ, 0, NULL, OPEN_EXISTING, 0, NULL);
4264 if (sig_pipe_handle == INVALID_HANDLE_VALUE) {
4265 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
4266 "Signal pipe: Unable to open %s. Dead parent?",
4274 case 'q': /* Quiet */
4280 /*** all non capture option specific ***/
4281 case 'D': /* Print a list of capture devices and exit */
4282 list_interfaces = TRUE;
4285 case 'L': /* Print list of link-layer types and exit */
4286 list_link_layer_types = TRUE;
4289 #ifdef HAVE_BPF_IMAGE
4290 case 'd': /* Print BPF code for capture filter and exit */
4291 print_bpf_code = TRUE;
4295 case 'S': /* Print interface statistics once a second */
4296 print_statistics = TRUE;
4299 case 'M': /* For -D, -L, and -S, print machine-readable output */
4300 machine_readable = TRUE;
4303 cmdarg_err("Invalid Option: %s", argv[optind-1]);
4305 case '?': /* Bad flag - print usage message */
4314 /* user specified file name as regular command-line argument */
4315 /* XXX - use it as the capture file name (or something else)? */
4321 * Extra command line arguments were specified; complain.
4322 * XXX - interpret as capture filter, as tcpdump and tshark do?
4324 cmdarg_err("Invalid argument: %s", argv[0]);
4334 if (run_once_args > 1) {
4335 cmdarg_err("Only one of -D, -L, or -S may be supplied.");
4337 } else if (run_once_args == 1) {
4338 /* We're supposed to print some information, rather than
4339 to capture traffic; did they specify a ring buffer option? */
4340 if (global_capture_opts.multi_files_on) {
4341 cmdarg_err("Ring buffer requested, but a capture isn't being done.");
4345 /* We're supposed to capture traffic; */
4346 /* Are we capturing on multiple interface? If so, use threads and pcapng. */
4347 if (global_capture_opts.ifaces->len > 1) {
4349 global_capture_opts.use_pcapng = TRUE;
4351 /* Was the ring buffer option specified and, if so, does it make sense? */
4352 if (global_capture_opts.multi_files_on) {
4353 /* Ring buffer works only under certain conditions:
4354 a) ring buffer does not work with temporary files;
4355 b) it makes no sense to enable the ring buffer if the maximum
4356 file size is set to "infinite". */
4357 if (global_capture_opts.save_file == NULL) {
4358 cmdarg_err("Ring buffer requested, but capture isn't being saved to a permanent file.");
4359 global_capture_opts.multi_files_on = FALSE;
4361 if (!global_capture_opts.has_autostop_filesize && !global_capture_opts.has_file_duration) {
4362 cmdarg_err("Ring buffer requested, but no maximum capture file size or duration were specified.");
4364 /* XXX - this must be redesigned as the conditions changed */
4365 global_capture_opts.multi_files_on = FALSE;
4372 * "-D" requires no interface to be selected; it's supposed to list
4375 if (list_interfaces) {
4376 /* Get the list of interfaces */
4381 if_list = capture_interface_list(&err, &err_str);
4382 if (if_list == NULL) {
4384 case CANT_GET_INTERFACE_LIST:
4385 case DONT_HAVE_PCAP:
4386 cmdarg_err("%s", err_str);
4391 case NO_INTERFACES_FOUND:
4393 * If we're being run by another program, just give them
4394 * an empty list of interfaces, don't report this as
4395 * an error; that lets them decide whether to report
4396 * this as an error or not.
4398 if (!machine_readable) {
4399 cmdarg_err("There are no interfaces on which a capture can be done");
4406 if (machine_readable) /* tab-separated values to stdout */
4407 print_machine_readable_interfaces(if_list);
4409 capture_opts_print_interfaces(if_list);
4410 free_interface_list(if_list);
4415 * "-S" requires no interface to be selected; it gives statistics
4416 * for all interfaces.
4418 if (print_statistics) {
4419 status = print_statistics_loop(machine_readable);
4424 * "-L", "-d", and capturing act on a particular interface, so we have to
4425 * have an interface; if none was specified, pick a default.
4427 if (capture_opts_trim_iface(&global_capture_opts, NULL) == FALSE) {
4428 /* cmdarg_err() already called .... */
4432 /* Let the user know what interfaces were chosen. */
4433 /* get_interface_descriptive_name() is not available! */
4434 if (capture_child) {
4435 for (j = 0; j < global_capture_opts.ifaces->len; j++) {
4436 interface_options interface_opts;
4438 interface_opts = g_array_index(global_capture_opts.ifaces, interface_options, j);
4439 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "Interface: %s\n",
4440 interface_opts.name);
4443 str = g_string_new("");
4445 if (global_capture_opts.ifaces->len < 2) {
4447 if (global_capture_opts.ifaces->len < 4) {
4449 for (j = 0; j < global_capture_opts.ifaces->len; j++) {
4450 interface_options interface_opts;
4452 interface_opts = g_array_index(global_capture_opts.ifaces, interface_options, j);
4454 if (global_capture_opts.ifaces->len > 2) {
4455 g_string_append_printf(str, ",");
4457 g_string_append_printf(str, " ");
4458 if (j == global_capture_opts.ifaces->len - 1) {
4459 g_string_append_printf(str, "and ");
4462 g_string_append_printf(str, "%s", interface_opts.name);
4465 g_string_append_printf(str, "%u interfaces", global_capture_opts.ifaces->len);
4467 fprintf(stderr, "Capturing on %s\n", str->str);
4468 g_string_free(str, TRUE);
4471 if (list_link_layer_types) {
4472 /* Get the list of link-layer types for the capture device. */
4473 if_capabilities_t *caps;
4477 for (i = 0; i < global_capture_opts.ifaces->len; i++) {
4478 interface_options interface_opts;
4480 interface_opts = g_array_index(global_capture_opts.ifaces, interface_options, i);
4481 caps = get_if_capabilities(interface_opts.name,
4482 interface_opts.monitor_mode, &err_str);
4484 cmdarg_err("The capabilities of the capture device \"%s\" could not be obtained (%s).\n"
4485 "Please check to make sure you have sufficient permissions, and that\n"
4486 "you have the proper interface or pipe specified.", interface_opts.name, err_str);
4490 if (caps->data_link_types == NULL) {
4491 cmdarg_err("The capture device \"%s\" has no data link types.", interface_opts.name);
4494 if (machine_readable) /* tab-separated values to stdout */
4495 /* XXX: We need to change the format and adopt consumers */
4496 print_machine_readable_if_capabilities(caps);
4498 /* XXX: We might want to print also the interface name */
4499 capture_opts_print_if_capabilities(caps, interface_opts.name,
4500 interface_opts.monitor_mode);
4501 free_if_capabilities(caps);
4506 /* We're supposed to do a capture, or print the BPF code for a filter.
4507 Process the snapshot length, as that affects the generated BPF code. */
4508 capture_opts_trim_snaplen(&global_capture_opts, MIN_PACKET_SIZE);
4510 #ifdef HAVE_BPF_IMAGE
4511 if (print_bpf_code) {
4512 show_filter_code(&global_capture_opts);
4517 /* We're supposed to do a capture. Process the ring buffer arguments. */
4518 capture_opts_trim_ring_num_files(&global_capture_opts);
4520 /* Now start the capture. */
4522 if(capture_loop_start(&global_capture_opts, &stats_known, &stats) == TRUE) {
4526 /* capture failed */
4529 return 0; /* never here, make compiler happy */
4534 console_log_handler(const char *log_domain, GLogLevelFlags log_level,
4535 const char *message, gpointer user_data _U_)
4542 /* ignore log message, if log_level isn't interesting */
4543 if( !(log_level & G_LOG_LEVEL_MASK & ~(G_LOG_LEVEL_DEBUG|G_LOG_LEVEL_INFO))) {
4544 #if !defined(DEBUG_DUMPCAP) && !defined(DEBUG_CHILD_DUMPCAP)
4549 /* create a "timestamp" */
4551 today = localtime(&curr);
4553 switch(log_level & G_LOG_LEVEL_MASK) {
4554 case G_LOG_LEVEL_ERROR:
4557 case G_LOG_LEVEL_CRITICAL:
4560 case G_LOG_LEVEL_WARNING:
4563 case G_LOG_LEVEL_MESSAGE:
4566 case G_LOG_LEVEL_INFO:
4569 case G_LOG_LEVEL_DEBUG:
4573 fprintf(stderr, "unknown log_level %u\n", log_level);
4575 g_assert_not_reached();
4578 /* Generate the output message */
4579 if(log_level & G_LOG_LEVEL_MESSAGE) {
4580 /* normal user messages without additional infos */
4581 msg = g_strdup_printf("%s\n", message);
4583 /* info/debug messages with additional infos */
4584 msg = g_strdup_printf("%02u:%02u:%02u %8s %s %s\n",
4585 today->tm_hour, today->tm_min, today->tm_sec,
4586 log_domain != NULL ? log_domain : "",
4590 /* DEBUG & INFO msgs (if we're debugging today) */
4591 #if defined(DEBUG_DUMPCAP) || defined(DEBUG_CHILD_DUMPCAP)
4592 if( !(log_level & G_LOG_LEVEL_MASK & ~(G_LOG_LEVEL_DEBUG|G_LOG_LEVEL_INFO))) {
4593 #ifdef DEBUG_DUMPCAP
4594 fprintf(stderr, "%s", msg);
4597 #ifdef DEBUG_CHILD_DUMPCAP
4598 fprintf(debug_log, "%s", msg);
4606 /* ERROR, CRITICAL, WARNING, MESSAGE messages goto stderr or */
4607 /* to parent especially formatted if dumpcap running as child. */
4608 if (capture_child) {
4609 sync_pipe_errmsg_to_parent(2, msg, "");
4611 fprintf(stderr, "%s", msg);
4618 /****************************************************************************************************************/
4619 /* indication report routines */
4623 report_packet_count(int packet_count)
4625 char tmp[SP_DECISIZE+1+1];
4626 static int count = 0;
4629 g_snprintf(tmp, sizeof(tmp), "%d", packet_count);
4630 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "Packets: %s", tmp);
4631 pipe_write_block(2, SP_PACKET_COUNT, tmp);
4633 count += packet_count;
4634 fprintf(stderr, "\rPackets: %u ", count);
4635 /* stderr could be line buffered */
4641 report_new_capture_file(const char *filename)
4644 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "File: %s", filename);
4645 pipe_write_block(2, SP_FILE, filename);
4649 * Prevent a SIGINFO handler from writing to the standard error
4650 * while we're doing so; instead, have it just set a flag telling
4651 * us to print that information when we're done.
4654 #endif /* SIGINFO */
4655 fprintf(stderr, "File: %s\n", filename);
4656 /* stderr could be line buffered */
4661 * Allow SIGINFO handlers to write.
4666 * If a SIGINFO handler asked us to write out capture counts, do so.
4669 report_counts_for_siginfo();
4670 #endif /* SIGINFO */
4675 report_cfilter_error(capture_options *capture_opts, guint i, const char *errmsg)
4677 interface_options interface_opts;
4678 char tmp[MSG_MAX_LENGTH+1+6];
4680 if (i < capture_opts->ifaces->len) {
4681 if (capture_child) {
4682 g_snprintf(tmp, sizeof(tmp), "%u:%s", i, errmsg);
4683 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "Capture filter error: %s", errmsg);
4684 pipe_write_block(2, SP_BAD_FILTER, tmp);
4687 * clopts_step_invalid_capfilter in test/suite-clopts.sh MUST match
4688 * the error message below.
4690 interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
4692 "Invalid capture filter: \"%s\" for interface %s!\n"
4694 "That string isn't a valid capture filter (%s).\n"
4695 "See the User's Guide for a description of the capture filter syntax.",
4696 interface_opts.cfilter, interface_opts.name, errmsg);
4702 report_capture_error(const char *error_msg, const char *secondary_error_msg)
4705 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
4706 "Primary Error: %s", error_msg);
4707 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
4708 "Secondary Error: %s", secondary_error_msg);
4709 sync_pipe_errmsg_to_parent(2, error_msg, secondary_error_msg);
4711 cmdarg_err("%s", error_msg);
4712 if (secondary_error_msg[0] != '\0')
4713 cmdarg_err_cont("%s", secondary_error_msg);
4718 report_packet_drops(guint32 received, guint32 drops, gchar *name)
4720 char tmp[SP_DECISIZE+1+1];
4722 g_snprintf(tmp, sizeof(tmp), "%u", drops);
4725 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
4726 "Packets received/dropped on interface %s: %u/%u",
4727 name, received, drops);
4728 /* XXX: Need to provide interface id, changes to consumers required. */
4729 pipe_write_block(2, SP_DROPS, tmp);
4732 "Packets received/dropped on interface %s: %u/%u (%.1f%%)\n",
4733 name, received, drops,
4734 received ? 100.0 * received / (received + drops) : 0.0);
4735 /* stderr could be line buffered */
4741 /****************************************************************************************************************/
4742 /* signal_pipe handling */
4747 signal_pipe_check_running(void)
4749 /* any news from our parent? -> just stop the capture */
4753 /* if we are running standalone, no check required */
4754 if(!capture_child) {
4758 if(!sig_pipe_name || !sig_pipe_handle) {
4759 /* This shouldn't happen */
4760 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
4761 "Signal pipe: No name or handle");
4766 * XXX - We should have the process ID of the parent (from the "-Z" flag)
4767 * at this point. Should we check to see if the parent is still alive,
4768 * e.g. by using OpenProcess?
4771 result = PeekNamedPipe(sig_pipe_handle, NULL, 0, NULL, &avail, NULL);
4773 if(!result || avail > 0) {
4774 /* peek failed or some bytes really available */
4775 /* (if not piping from stdin this would fail) */
4776 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
4777 "Signal pipe: Stop capture: %s", sig_pipe_name);
4778 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
4779 "Signal pipe: %s (%p) result: %u avail: %u", sig_pipe_name,
4780 sig_pipe_handle, result, avail);
4783 /* pipe ok and no bytes available */
4790 * Editor modelines - http://www.wireshark.org/tools/modelines.html
4795 * indent-tabs-mode: nil
4798 * vi: set shiftwidth=4 tabstop=8 expandtab:
4799 * :indentSize=4:tabSize=8:noTabs=true: