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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
27 #include <stdlib.h> /* for exit() */
33 #ifdef HAVE_SYS_TYPES_H
34 # include <sys/types.h>
37 #ifdef HAVE_SYS_SOCKET_H
38 #include <sys/socket.h>
41 #ifdef HAVE_NETINET_IN_H
42 #include <netinet/in.h>
45 #ifdef HAVE_SYS_STAT_H
46 # include <sys/stat.h>
61 #ifdef HAVE_ARPA_INET_H
62 #include <arpa/inet.h>
65 #if defined(__APPLE__) && defined(__LP64__)
66 #include <sys/utsname.h>
72 #include <wsutil/crash_info.h>
75 #include "wsutil/wsgetopt.h"
83 # include <sys/prctl.h>
84 # include <sys/capability.h>
87 #include "ringbuffer.h"
88 #include "clopts_common.h"
89 #include "cmdarg_err.h"
90 #include "version_info.h"
92 #include "capture-pcap-util.h"
94 #include "capture-wpcap.h"
100 #include "capture-wpcap.h"
101 #include <wsutil/unicode-utils.h>
108 #ifdef NEED_INET_V6DEFS_H
109 # include "wsutil/inet_v6defs.h"
112 #include <wsutil/privileges.h>
114 #include "sync_pipe.h"
116 #include "capture_opts.h"
117 #include "capture_session.h"
118 #include "capture_ifinfo.h"
119 #include "capture_sync.h"
121 #include "conditions.h"
122 #include "capture_stop_conditions.h"
124 #include "wsutil/tempfile.h"
126 #include "wsutil/file_util.h"
128 #include "ws80211_utils.h"
131 * Get information about libpcap format from "wiretap/libpcap.h".
132 * XXX - can we just use pcap_open_offline() to read the pipe?
134 #include "wiretap/libpcap.h"
136 /**#define DEBUG_DUMPCAP**/
137 /**#define DEBUG_CHILD_DUMPCAP**/
141 #include <conio.h> /* _getch() */
145 #ifdef DEBUG_CHILD_DUMPCAP
146 FILE *debug_log; /* for logging debug messages to */
147 /* a file if DEBUG_CHILD_DUMPCAP */
151 static GAsyncQueue *pcap_queue;
152 static gint64 pcap_queue_bytes;
153 static gint64 pcap_queue_packets;
154 static gint64 pcap_queue_byte_limit = 0;
155 static gint64 pcap_queue_packet_limit = 0;
157 static gboolean capture_child = FALSE; /* FALSE: standalone call, TRUE: this is an Wireshark capture child */
159 static gchar *sig_pipe_name = NULL;
160 static HANDLE sig_pipe_handle = NULL;
161 static gboolean signal_pipe_check_running(void);
165 static gboolean infodelay; /* if TRUE, don't print capture info in SIGINFO handler */
166 static gboolean infoprint; /* if TRUE, print capture info after clearing infodelay */
169 /** Stop a low-level capture (stops the capture child). */
170 static void capture_loop_stop(void);
171 /** Close a pipe, or socket if \a from_socket is TRUE */
172 static void cap_pipe_close(int pipe_fd, gboolean from_socket _U_);
176 * Enable kernel BPF JIT compiler if available.
177 * If any calls fail, just drive on - the JIT compiler might not be
178 * enabled, but filtering will still work, and it's not clear what
179 * we could do if the calls fail; should we just report the error
180 * and not continue to capture, should we report it as a warning, or
184 enable_kernel_bpf_jit_compiler(void)
188 static const char file[] = "/proc/sys/net/core/bpf_jit_enable";
190 fd = open(file, O_WRONLY);
194 written = write(fd, "1", strlen("1"));
200 #if !defined (__linux__)
201 #ifndef HAVE_PCAP_BREAKLOOP
203 * We don't have pcap_breakloop(), which is the only way to ensure that
204 * pcap_dispatch(), pcap_loop(), or even pcap_next() or pcap_next_ex()
205 * won't, if the call to read the next packet or batch of packets is
206 * is interrupted by a signal on UN*X, just go back and try again to
209 * On UN*X, we catch SIGINT as a "stop capturing" signal, and, in
210 * the signal handler, set a flag to stop capturing; however, without
211 * a guarantee of that sort, we can't guarantee that we'll stop capturing
212 * if the read will be retried and won't time out if no packets arrive.
214 * Therefore, on at least some platforms, we work around the lack of
215 * pcap_breakloop() by doing a select() on the pcap_t's file descriptor
216 * to wait for packets to arrive, so that we're probably going to be
217 * blocked in the select() when the signal arrives, and can just bail
218 * out of the loop at that point.
220 * However, we don't want to do that on BSD (because "select()" doesn't work
221 * correctly on BPF devices on at least some releases of some flavors of
222 * BSD), and we don't want to do it on Windows (because "select()" is
223 * something for sockets, not for arbitrary handles). (Note that "Windows"
224 * here includes Cygwin; even in its pretend-it's-UNIX environment, we're
225 * using WinPcap, not a UNIX libpcap.)
227 * Fortunately, we don't need to do it on BSD, because the libpcap timeout
228 * on BSD times out even if no packets have arrived, so we'll eventually
229 * exit pcap_dispatch() with an indication that no packets have arrived,
230 * and will break out of the capture loop at that point.
232 * On Windows, we can't send a SIGINT to stop capturing, so none of this
233 * applies in any case.
235 * XXX - the various BSDs appear to define BSD in <sys/param.h>; we don't
236 * want to include it if it's not present on this platform, however.
238 # if !defined(__FreeBSD__) && !defined(__NetBSD__) && !defined(__OpenBSD__) && \
239 !defined(__bsdi__) && !defined(__APPLE__) && !defined(_WIN32) && \
241 # define MUST_DO_SELECT
242 # endif /* avoid select */
243 #endif /* HAVE_PCAP_BREAKLOOP */
245 /* whatever the deal with pcap_breakloop, linux doesn't support timeouts
246 * in pcap_dispatch(); on the other hand, select() works just fine there.
247 * Hence we use a select for that come what may.
249 * XXX - with TPACKET_V1 and TPACKET_V2, it currently uses select()
250 * internally, and, with TPACKET_V3, once that's supported, it'll
251 * support timeouts, at least as I understand the way the code works.
253 #define MUST_DO_SELECT
256 /** init the capture filter */
259 INITFILTER_BAD_FILTER,
260 INITFILTER_OTHER_ERROR
261 } initfilter_status_t;
264 STATE_EXPECT_REC_HDR,
277 typedef struct _pcap_options {
282 #ifdef MUST_DO_SELECT
283 int pcap_fd; /**< pcap file descriptor */
290 gboolean ts_nsec; /**< TRUE if we're using nanosecond precision. */
291 /**< capture pipe (unix only "input file") */
292 gboolean from_cap_pipe; /**< TRUE if we are capturing data from a capture pipe */
293 gboolean from_cap_socket; /**< TRUE if we're capturing from socket */
294 struct pcap_hdr cap_pipe_hdr; /**< Pcap header when capturing from a pipe */
295 struct pcaprec_modified_hdr cap_pipe_rechdr; /**< Pcap record header when capturing from a pipe */
297 HANDLE cap_pipe_h; /**< The handle of the capture pipe */
299 int cap_pipe_fd; /**< the file descriptor of the capture pipe */
300 gboolean cap_pipe_modified; /**< TRUE if data in the pipe uses modified pcap headers */
301 gboolean cap_pipe_byte_swapped; /**< TRUE if data in the pipe is byte swapped */
303 char * cap_pipe_buf; /**< Pointer to the data buffer we read into */
304 DWORD cap_pipe_bytes_to_read; /**< Used by cap_pipe_dispatch */
305 DWORD cap_pipe_bytes_read; /**< Used by cap_pipe_dispatch */
307 size_t cap_pipe_bytes_to_read; /**< Used by cap_pipe_dispatch */
308 size_t cap_pipe_bytes_read; /**< Used by cap_pipe_dispatch */
310 cap_pipe_state_t cap_pipe_state;
311 cap_pipe_err_t cap_pipe_err;
314 GMutex *cap_pipe_read_mtx;
315 GAsyncQueue *cap_pipe_pending_q, *cap_pipe_done_q;
319 typedef struct _loop_data {
321 gboolean go; /**< TRUE as long as we're supposed to keep capturing */
322 int err; /**< if non-zero, error seen while capturing */
323 gint packet_count; /**< Number of packets we have already captured */
324 gint packet_max; /**< Number of packets we're supposed to capture - 0 means infinite */
325 guint inpkts_to_sync_pipe; /**< Packets not already send out to the sync_pipe */
327 gboolean report_packet_count; /**< Set by SIGINFO handler; print packet count */
333 guint64 bytes_written;
334 guint32 autostop_files;
337 typedef struct _pcap_queue_element {
338 pcap_options *pcap_opts;
339 struct pcap_pkthdr phdr;
341 } pcap_queue_element;
344 * Standard secondary message for unexpected errors.
346 static const char please_report[] =
347 "Please report this to the Wireshark developers.\n"
348 "http://bugs.wireshark.org/\n"
349 "(This is not a crash; please do not report it as such.)";
352 * This needs to be static, so that the SIGINT handler can clear the "go"
355 static loop_data global_ld;
359 * Timeout, in milliseconds, for reads from the stream of captured packets
360 * from a capture device.
362 * A bug in Mac OS X 10.6 and 10.6.1 causes calls to pcap_open_live(), in
363 * 64-bit applications, with sub-second timeouts not to work. The bug is
364 * fixed in 10.6.2, re-broken in 10.6.3, and again fixed in 10.6.5.
366 #if defined(__APPLE__) && defined(__LP64__)
367 static gboolean need_timeout_workaround;
369 #define CAP_READ_TIMEOUT (need_timeout_workaround ? 1000 : 250)
371 #define CAP_READ_TIMEOUT 250
375 * Timeout, in microseconds, for reads from the stream of captured packets
376 * from a pipe. Pipes don't have the same problem that BPF devices do
377 * in OS X 10.6, 10.6.1, 10.6.3, and 10.6.4, so we always use a timeout
378 * of 250ms, i.e. the same value as CAP_READ_TIMEOUT when not on one
379 * of the offending versions of Snow Leopard.
381 * On Windows this value is converted to milliseconds and passed to
382 * WaitForSingleObject. If it's less than 1000 WaitForSingleObject
383 * will return immediately.
386 #define PIPE_READ_TIMEOUT 100000
388 #define PIPE_READ_TIMEOUT 250000
391 #define WRITER_THREAD_TIMEOUT 100000 /* usecs */
394 console_log_handler(const char *log_domain, GLogLevelFlags log_level,
395 const char *message, gpointer user_data _U_);
397 /* capture related options */
398 static capture_options global_capture_opts;
399 static gboolean quiet = FALSE;
400 static gboolean use_threads = FALSE;
401 static guint64 start_time;
403 static void capture_loop_write_packet_cb(u_char *pcap_opts_p, const struct pcap_pkthdr *phdr,
405 static void capture_loop_queue_packet_cb(u_char *pcap_opts_p, const struct pcap_pkthdr *phdr,
407 static void capture_loop_get_errmsg(char *errmsg, int errmsglen, const char *fname,
408 int err, gboolean is_close);
410 static void WS_MSVC_NORETURN exit_main(int err) G_GNUC_NORETURN;
412 static void report_new_capture_file(const char *filename);
413 static void report_packet_count(unsigned int packet_count);
414 static void report_packet_drops(guint32 received, guint32 pcap_drops, guint32 drops, guint32 flushed, guint32 ps_ifdrop, gchar *name);
415 static void report_capture_error(const char *error_msg, const char *secondary_error_msg);
416 static void report_cfilter_error(capture_options *capture_opts, guint i, const char *errmsg);
418 #define MSG_MAX_LENGTH 4096
420 /* Copied from pcapio.c pcapng_write_interface_statistics_block()*/
422 create_timestamp(void) {
432 * Current time, represented as 100-nanosecond intervals since
433 * January 1, 1601, 00:00:00 UTC.
435 * I think DWORD might be signed, so cast both parts of "now"
436 * to guint32 so that the sign bit doesn't get treated specially.
438 * Windows 8 provides GetSystemTimePreciseAsFileTime which we
439 * might want to use instead.
441 GetSystemTimeAsFileTime(&now);
442 timestamp = (((guint64)(guint32)now.dwHighDateTime) << 32) +
443 (guint32)now.dwLowDateTime;
446 * Convert to same thing but as 1-microsecond, i.e. 1000-nanosecond,
452 * Subtract difference, in microseconds, between January 1, 1601
453 * 00:00:00 UTC and January 1, 1970, 00:00:00 UTC.
455 timestamp -= G_GUINT64_CONSTANT(11644473600000000);
458 * Current time, represented as seconds and microseconds since
459 * January 1, 1970, 00:00:00 UTC.
461 gettimeofday(&now, NULL);
464 * Convert to delta in microseconds.
466 timestamp = (guint64)(now.tv_sec) * 1000000 +
467 (guint64)(now.tv_usec);
473 print_usage(gboolean print_ver)
480 "Dumpcap " VERSION "%s\n"
481 "Capture network packets and dump them into a pcapng file.\n"
482 "See http://www.wireshark.org for more information.\n",
483 wireshark_svnversion);
487 fprintf(output, "\nUsage: dumpcap [options] ...\n");
488 fprintf(output, "\n");
489 fprintf(output, "Capture interface:\n");
490 fprintf(output, " -i <interface> name or idx of interface (def: first non-loopback),\n"
491 " or for remote capturing, use one of these formats:\n"
492 " rpcap://<host>/<interface>\n"
493 " TCP@<host>:<port>\n");
494 fprintf(output, " -f <capture filter> packet filter in libpcap filter syntax\n");
495 fprintf(output, " -s <snaplen> packet snapshot length (def: 65535)\n");
496 fprintf(output, " -p don't capture in promiscuous mode\n");
497 #ifdef HAVE_PCAP_CREATE
498 fprintf(output, " -I capture in monitor mode, if available\n");
500 #if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
501 fprintf(output, " -B <buffer size> size of kernel buffer in MiB (def: %dMiB)\n", DEFAULT_CAPTURE_BUFFER_SIZE);
503 fprintf(output, " -y <link type> link layer type (def: first appropriate)\n");
504 fprintf(output, " -D print list of interfaces and exit\n");
505 fprintf(output, " -L print list of link-layer types of iface and exit\n");
506 #ifdef HAVE_BPF_IMAGE
507 fprintf(output, " -d print generated BPF code for capture filter\n");
509 fprintf(output, " -k set channel on wifi interface <freq>,[<type>]\n");
510 fprintf(output, " -S print statistics for each interface once per second\n");
511 fprintf(output, " -M for -D, -L, and -S, produce machine-readable output\n");
512 fprintf(output, "\n");
513 #ifdef HAVE_PCAP_REMOTE
514 fprintf(output, "RPCAP options:\n");
515 fprintf(output, " -r don't ignore own RPCAP traffic in capture\n");
516 fprintf(output, " -u use UDP for RPCAP data transfer\n");
517 fprintf(output, " -A <user>:<password> use RPCAP password authentication\n");
518 #ifdef HAVE_PCAP_SETSAMPLING
519 fprintf(output, " -m <sampling type> use packet sampling\n");
520 fprintf(output, " count:NUM - capture one packet of every NUM\n");
521 fprintf(output, " timer:NUM - capture no more than 1 packet in NUM ms\n");
524 fprintf(output, "Stop conditions:\n");
525 fprintf(output, " -c <packet count> stop after n packets (def: infinite)\n");
526 fprintf(output, " -a <autostop cond.> ... duration:NUM - stop after NUM seconds\n");
527 fprintf(output, " filesize:NUM - stop this file after NUM KB\n");
528 fprintf(output, " files:NUM - stop after NUM files\n");
529 /*fprintf(output, "\n");*/
530 fprintf(output, "Output (files):\n");
531 fprintf(output, " -w <filename> name of file to save (def: tempfile)\n");
532 fprintf(output, " -g enable group read access on the output file(s)\n");
533 fprintf(output, " -b <ringbuffer opt.> ... duration:NUM - switch to next file after NUM secs\n");
534 fprintf(output, " filesize:NUM - switch to next file after NUM KB\n");
535 fprintf(output, " files:NUM - ringbuffer: replace after NUM files\n");
536 fprintf(output, " -n use pcapng format instead of pcap (default)\n");
537 fprintf(output, " -P use libpcap format instead of pcapng\n");
538 fprintf(output, " --capture-comment <comment>\n");
539 fprintf(output, " add a capture comment to the output file\n");
540 fprintf(output, " (only for pcapng)\n");
541 fprintf(output, "\n");
542 fprintf(output, "Miscellaneous:\n");
543 fprintf(output, " -N <packet_limit> maximum number of packets buffered within dumpcap\n");
544 fprintf(output, " -C <byte_limit> maximum number of bytes used for buffering packets\n");
545 fprintf(output, " within dumpcap\n");
546 fprintf(output, " -t use a separate thread per interface\n");
547 fprintf(output, " -q don't report packet capture counts\n");
548 fprintf(output, " -v print version information and exit\n");
549 fprintf(output, " -h display this help and exit\n");
550 fprintf(output, "\n");
552 fprintf(output, "WARNING: dumpcap will enable kernel BPF JIT compiler if available.\n");
553 fprintf(output, "You might want to reset it\n");
554 fprintf(output, "By doing \"echo 0 > /proc/sys/net/core/bpf_jit_enable\"\n");
555 fprintf(output, "\n");
557 fprintf(output, "Example: dumpcap -i eth0 -a duration:60 -w output.pcapng\n");
558 fprintf(output, "\"Capture packets from interface eth0 until 60s passed into output.pcapng\"\n");
559 fprintf(output, "\n");
560 fprintf(output, "Use Ctrl-C to stop capturing at any time.\n");
564 show_version(GString *comp_info_str, GString *runtime_info_str)
567 "Dumpcap " VERSION "%s\n"
572 "See http://www.wireshark.org for more information.\n",
573 wireshark_svnversion, get_copyright_info(), comp_info_str->str, runtime_info_str->str);
577 * Report an error in command-line arguments.
580 cmdarg_err(const char *fmt, ...)
586 /* Generate a 'special format' message back to parent */
588 msg = g_strdup_vprintf(fmt, ap);
589 sync_pipe_errmsg_to_parent(2, msg, "");
594 fprintf(stderr, "dumpcap: ");
595 vfprintf(stderr, fmt, ap);
596 fprintf(stderr, "\n");
602 * Report additional information for an error in command-line arguments.
605 cmdarg_err_cont(const char *fmt, ...)
612 msg = g_strdup_vprintf(fmt, ap);
613 sync_pipe_errmsg_to_parent(2, msg, "");
618 vfprintf(stderr, fmt, ap);
619 fprintf(stderr, "\n");
626 #if 0 /* Set to enable capability debugging */
627 /* see 'man cap_to_text()' for explanation of output */
628 /* '=' means 'all= ' ie: no capabilities */
629 /* '=ip' means 'all=ip' ie: all capabilities are permissible and inheritable */
631 print_caps(const char *pfx) {
632 cap_t caps = cap_get_proc();
633 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
634 "%s: EUID: %d Capabilities: %s", pfx,
635 geteuid(), cap_to_text(caps, NULL));
638 print_caps(const char *pfx _U_) {
643 relinquish_all_capabilities(void)
645 /* Drop any and all capabilities this process may have. */
646 /* Allowed whether or not process has any privileges. */
647 cap_t caps = cap_init(); /* all capabilities initialized to off */
648 print_caps("Pre-clear");
649 if (cap_set_proc(caps)) {
650 cmdarg_err("cap_set_proc() fail return: %s", g_strerror(errno));
652 print_caps("Post-clear");
658 open_capture_device(interface_options *interface_opts,
659 char (*open_err_str)[PCAP_ERRBUF_SIZE])
662 #ifdef HAVE_PCAP_CREATE
665 #if defined(HAVE_PCAP_OPEN) && defined(HAVE_PCAP_REMOTE)
666 struct pcap_rmtauth auth;
669 /* Open the network interface to capture from it.
670 Some versions of libpcap may put warnings into the error buffer
671 if they succeed; to tell if that's happened, we have to clear
672 the error buffer, and check if it's still a null string. */
673 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "Entering open_capture_device().");
674 (*open_err_str)[0] = '\0';
675 #if defined(HAVE_PCAP_OPEN) && defined(HAVE_PCAP_REMOTE)
677 * If we're opening a remote device, use pcap_open(); that's currently
678 * the only open routine that supports remote devices.
680 if (strncmp (interface_opts->name, "rpcap://", 8) == 0) {
681 auth.type = interface_opts->auth_type == CAPTURE_AUTH_PWD ?
682 RPCAP_RMTAUTH_PWD : RPCAP_RMTAUTH_NULL;
683 auth.username = interface_opts->auth_username;
684 auth.password = interface_opts->auth_password;
686 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
687 "Calling pcap_open() using name %s, snaplen %d, promisc_mode %d, datatx_udp %d, nocap_rpcap %d.",
688 interface_opts->name, interface_opts->snaplen, interface_opts->promisc_mode,
689 interface_opts->datatx_udp, interface_opts->nocap_rpcap);
690 pcap_h = pcap_open(interface_opts->name, interface_opts->snaplen,
692 (interface_opts->promisc_mode ? PCAP_OPENFLAG_PROMISCUOUS : 0) |
693 (interface_opts->datatx_udp ? PCAP_OPENFLAG_DATATX_UDP : 0) |
694 (interface_opts->nocap_rpcap ? PCAP_OPENFLAG_NOCAPTURE_RPCAP : 0),
695 CAP_READ_TIMEOUT, &auth, *open_err_str);
696 if (pcap_h == NULL) {
697 /* Error - did pcap actually supply an error message? */
698 if ((*open_err_str)[0] == '\0') {
699 /* Work around known WinPcap bug wherein no error message is
700 filled in on a failure to open an rpcap: URL. */
701 g_strlcpy(*open_err_str,
702 "Unknown error (pcap bug; actual error cause not reported)",
703 sizeof *open_err_str);
706 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
707 "pcap_open() returned %p.", (void *)pcap_h);
712 * If we're not opening a remote device, use pcap_create() and
713 * pcap_activate() if we have them, so that we can set the buffer
714 * size, otherwise use pcap_open_live().
716 #ifdef HAVE_PCAP_CREATE
717 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
718 "Calling pcap_create() using %s.", interface_opts->name);
719 pcap_h = pcap_create(interface_opts->name, *open_err_str);
720 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
721 "pcap_create() returned %p.", (void *)pcap_h);
722 if (pcap_h != NULL) {
723 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
724 "Calling pcap_set_snaplen() with snaplen %d.", interface_opts->snaplen);
725 pcap_set_snaplen(pcap_h, interface_opts->snaplen);
726 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
727 "Calling pcap_set_promisc() with promisc_mode %d.", interface_opts->promisc_mode);
728 pcap_set_promisc(pcap_h, interface_opts->promisc_mode);
729 pcap_set_timeout(pcap_h, CAP_READ_TIMEOUT);
731 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
732 "buffersize %d.", interface_opts->buffer_size);
733 if (interface_opts->buffer_size != 0) {
734 pcap_set_buffer_size(pcap_h, interface_opts->buffer_size * 1024 * 1024);
736 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
737 "monitor_mode %d.", interface_opts->monitor_mode);
738 if (interface_opts->monitor_mode)
739 pcap_set_rfmon(pcap_h, 1);
740 err = pcap_activate(pcap_h);
741 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
742 "pcap_activate() returned %d.", err);
744 /* Failed to activate, set to NULL */
745 if (err == PCAP_ERROR)
746 g_strlcpy(*open_err_str, pcap_geterr(pcap_h), sizeof *open_err_str);
748 g_strlcpy(*open_err_str, pcap_statustostr(err), sizeof *open_err_str);
754 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
755 "pcap_open_live() calling using name %s, snaplen %d, promisc_mode %d.",
756 interface_opts->name, interface_opts->snaplen, interface_opts->promisc_mode);
757 pcap_h = pcap_open_live(interface_opts->name, interface_opts->snaplen,
758 interface_opts->promisc_mode, CAP_READ_TIMEOUT,
760 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
761 "pcap_open_live() returned %p.", (void *)pcap_h);
764 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "open_capture_device %s : %s", pcap_h ? "SUCCESS" : "FAILURE", interface_opts->name);
769 get_capture_device_open_failure_messages(const char *open_err_str,
771 char *errmsg, size_t errmsg_len,
772 char *secondary_errmsg,
773 size_t secondary_errmsg_len)
776 const char *libpcap_warn;
777 static const char ppamsg[] = "can't find PPA for ";
780 g_snprintf(errmsg, (gulong) errmsg_len,
781 "The capture session could not be initiated on interface '%s' (%s).",
782 iface, open_err_str);
785 g_snprintf(secondary_errmsg, (gulong) secondary_errmsg_len,
787 "In order to capture packets, WinPcap must be installed; see\n"
789 " http://www.winpcap.org/\n"
793 " http://www.mirrors.wiretapped.net/security/packet-capture/winpcap/\n"
797 " http://winpcap.cs.pu.edu.tw/\n"
799 "for a downloadable version of WinPcap and for instructions on how to install\n"
802 g_snprintf(secondary_errmsg, (gulong) secondary_errmsg_len,
804 "Please check that \"%s\" is the proper interface.\n"
807 "Help can be found at:\n"
809 " http://wiki.wireshark.org/WinPcap\n"
810 " http://wiki.wireshark.org/CaptureSetup\n",
814 /* If we got a "can't find PPA for X" message, warn the user (who
815 is running dumpcap on HP-UX) that they don't have a version of
816 libpcap that properly handles HP-UX (libpcap 0.6.x and later
817 versions, which properly handle HP-UX, say "can't find /dev/dlpi
818 PPA for X" rather than "can't find PPA for X"). */
819 if (strncmp(open_err_str, ppamsg, sizeof ppamsg - 1) == 0)
822 "You are running (T)Wireshark with a version of the libpcap library\n"
823 "that doesn't handle HP-UX network devices well; this means that\n"
824 "(T)Wireshark may not be able to capture packets.\n"
826 "To fix this, you should install libpcap 0.6.2, or a later version\n"
827 "of libpcap, rather than libpcap 0.4 or 0.5.x. It is available in\n"
828 "packaged binary form from the Software Porting And Archive Centre\n"
829 "for HP-UX; the Centre is at http://hpux.connect.org.uk/ - the page\n"
830 "at the URL lists a number of mirror sites.";
834 g_snprintf(secondary_errmsg, (gulong) secondary_errmsg_len,
835 "Please check to make sure you have sufficient permissions, and that you have "
836 "the proper interface or pipe specified.%s", libpcap_warn);
840 /* Set the data link type on a pcap. */
842 set_pcap_linktype(pcap_t *pcap_h, int linktype, char *name,
843 char *errmsg, size_t errmsg_len,
844 char *secondary_errmsg, size_t secondary_errmsg_len)
846 char *set_linktype_err_str;
849 return TRUE; /* just use the default */
850 #ifdef HAVE_PCAP_SET_DATALINK
851 if (pcap_set_datalink(pcap_h, linktype) == 0)
852 return TRUE; /* no error */
853 set_linktype_err_str = pcap_geterr(pcap_h);
855 /* Let them set it to the type it is; reject any other request. */
856 if (get_pcap_linktype(pcap_h, name) == linktype)
857 return TRUE; /* no error */
858 set_linktype_err_str =
859 "That DLT isn't one of the DLTs supported by this device";
861 g_snprintf(errmsg, (gulong) errmsg_len, "Unable to set data link type on interface '%s' (%s).",
862 name, set_linktype_err_str);
864 * If the error isn't "XXX is not one of the DLTs supported by this device",
865 * tell the user to tell the Wireshark developers about it.
867 if (strstr(set_linktype_err_str, "is not one of the DLTs supported by this device") == NULL)
868 g_snprintf(secondary_errmsg, (gulong) secondary_errmsg_len, please_report);
870 secondary_errmsg[0] = '\0';
875 compile_capture_filter(const char *iface, pcap_t *pcap_h,
876 struct bpf_program *fcode, const char *cfilter)
878 bpf_u_int32 netnum, netmask;
879 gchar lookup_net_err_str[PCAP_ERRBUF_SIZE];
881 if (pcap_lookupnet(iface, &netnum, &netmask, lookup_net_err_str) < 0) {
883 * Well, we can't get the netmask for this interface; it's used
884 * only for filters that check for broadcast IP addresses, so
885 * we just punt and use 0. It might be nice to warn the user,
886 * but that's a pain in a GUI application, as it'd involve popping
887 * up a message box, and it's not clear how often this would make
888 * a difference (only filters that check for IP broadcast addresses
892 "Warning: Couldn't obtain netmask info (%s).", lookup_net_err_str);*/
897 * Sigh. Older versions of libpcap don't properly declare the
898 * third argument to pcap_compile() as a const pointer. Cast
901 if (pcap_compile(pcap_h, fcode, (char *)cfilter, 1, netmask) < 0)
906 #ifdef HAVE_BPF_IMAGE
908 show_filter_code(capture_options *capture_opts)
910 interface_options interface_opts;
912 gchar open_err_str[PCAP_ERRBUF_SIZE];
913 char errmsg[MSG_MAX_LENGTH+1];
914 char secondary_errmsg[MSG_MAX_LENGTH+1];
915 struct bpf_program fcode;
916 struct bpf_insn *insn;
920 for (j = 0; j < capture_opts->ifaces->len; j++) {
921 interface_opts = g_array_index(capture_opts->ifaces, interface_options, j);
922 pcap_h = open_capture_device(&interface_opts, &open_err_str);
923 if (pcap_h == NULL) {
924 /* Open failed; get messages */
925 get_capture_device_open_failure_messages(open_err_str,
927 errmsg, sizeof errmsg,
929 sizeof secondary_errmsg);
930 /* And report them */
931 report_capture_error(errmsg, secondary_errmsg);
935 /* Set the link-layer type. */
936 if (!set_pcap_linktype(pcap_h, interface_opts.linktype, interface_opts.name,
937 errmsg, sizeof errmsg,
938 secondary_errmsg, sizeof secondary_errmsg)) {
940 report_capture_error(errmsg, secondary_errmsg);
944 /* OK, try to compile the capture filter. */
945 if (!compile_capture_filter(interface_opts.name, pcap_h, &fcode,
946 interface_opts.cfilter)) {
948 report_cfilter_error(capture_opts, j, errmsg);
953 /* Now print the filter code. */
954 insn = fcode.bf_insns;
956 for (i = 0; i < fcode.bf_len; insn++, i++)
957 printf("%s\n", bpf_image(insn, i));
959 /* If not using libcap: we now can now set euid/egid to ruid/rgid */
960 /* to remove any suid privileges. */
961 /* If using libcap: we can now remove NET_RAW and NET_ADMIN capabilities */
962 /* (euid/egid have already previously been set to ruid/rgid. */
963 /* (See comment in main() for details) */
965 relinquish_special_privs_perm();
967 relinquish_all_capabilities();
970 /* Let our parent know we succeeded. */
971 pipe_write_block(2, SP_SUCCESS, NULL);
978 * capture_interface_list() is expected to do the right thing to get
979 * a list of interfaces.
981 * In most of the programs in the Wireshark suite, "the right thing"
982 * is to run dumpcap and ask it for the list, because dumpcap may
983 * be the only program in the suite with enough privileges to get
986 * In dumpcap itself, however, we obviously can't run dumpcap to
987 * ask for the list. Therefore, our capture_interface_list() should
988 * just call get_interface_list().
991 capture_interface_list(int *err, char **err_str, void(*update_cb)(void) _U_)
993 return get_interface_list(err, err_str);
997 * Get the data-link type for a libpcap device.
998 * This works around AIX 5.x's non-standard and incompatible-with-the-
999 * rest-of-the-universe libpcap.
1002 get_pcap_linktype(pcap_t *pch, const char *devicename
1010 const char *ifacename;
1013 linktype = pcap_datalink(pch);
1017 * The libpcap that comes with AIX 5.x uses RFC 1573 ifType values
1018 * rather than DLT_ values for link-layer types; the ifType values
1019 * for LAN devices are:
1026 * and the ifType value for a loopback device is 24.
1028 * The AIX names for LAN devices begin with:
1035 * and the AIX names for loopback devices begin with "lo".
1037 * (The difference between "Ethernet" and "802.3" is presumably
1038 * whether packets have an Ethernet header, with a packet type,
1039 * or an 802.3 header, with a packet length, followed by an 802.2
1040 * header and possibly a SNAP header.)
1042 * If the device name matches "linktype" interpreted as an ifType
1043 * value, rather than as a DLT_ value, we will assume this is AIX's
1044 * non-standard, incompatible libpcap, rather than a standard libpcap,
1045 * and will map the link-layer type to the standard DLT_ value for
1046 * that link-layer type, as that's what the rest of Wireshark expects.
1048 * (This means the capture files won't be readable by a tcpdump
1049 * linked with AIX's non-standard libpcap, but so it goes. They
1050 * *will* be readable by standard versions of tcpdump, Wireshark,
1053 * XXX - if we conclude we're using AIX libpcap, should we also
1054 * set a flag to cause us to assume the time stamps are in
1055 * seconds-and-nanoseconds form, and to convert them to
1056 * seconds-and-microseconds form before processing them and
1061 * Find the last component of the device name, which is the
1064 ifacename = strchr(devicename, '/');
1065 if (ifacename == NULL)
1066 ifacename = devicename;
1068 /* See if it matches any of the LAN device names. */
1069 if (strncmp(ifacename, "en", 2) == 0) {
1070 if (linktype == 6) {
1072 * That's the RFC 1573 value for Ethernet; map it to DLT_EN10MB.
1076 } else if (strncmp(ifacename, "et", 2) == 0) {
1077 if (linktype == 7) {
1079 * That's the RFC 1573 value for 802.3; map it to DLT_EN10MB.
1080 * (libpcap, tcpdump, Wireshark, etc. don't care if it's Ethernet
1085 } else if (strncmp(ifacename, "tr", 2) == 0) {
1086 if (linktype == 9) {
1088 * That's the RFC 1573 value for 802.5 (Token Ring); map it to
1089 * DLT_IEEE802, which is what's used for Token Ring.
1093 } else if (strncmp(ifacename, "fi", 2) == 0) {
1094 if (linktype == 15) {
1096 * That's the RFC 1573 value for FDDI; map it to DLT_FDDI.
1100 } else if (strncmp(ifacename, "lo", 2) == 0) {
1101 if (linktype == 24) {
1103 * That's the RFC 1573 value for "software loopback" devices; map it
1104 * to DLT_NULL, which is what's used for loopback devices on BSD.
1114 static data_link_info_t *
1115 create_data_link_info(int dlt)
1117 data_link_info_t *data_link_info;
1120 data_link_info = (data_link_info_t *)g_malloc(sizeof (data_link_info_t));
1121 data_link_info->dlt = dlt;
1122 text = pcap_datalink_val_to_name(dlt);
1124 data_link_info->name = g_strdup(text);
1126 data_link_info->name = g_strdup_printf("DLT %d", dlt);
1127 text = pcap_datalink_val_to_description(dlt);
1129 data_link_info->description = g_strdup(text);
1131 data_link_info->description = NULL;
1132 return data_link_info;
1136 * Get the capabilities of a network device.
1138 static if_capabilities_t *
1139 get_if_capabilities(const char *devicename, gboolean monitor_mode
1140 #ifndef HAVE_PCAP_CREATE
1145 if_capabilities_t *caps;
1146 char errbuf[PCAP_ERRBUF_SIZE];
1148 #ifdef HAVE_PCAP_CREATE
1152 #ifdef HAVE_PCAP_LIST_DATALINKS
1156 data_link_info_t *data_link_info;
1159 * Allocate the interface capabilities structure.
1161 caps = (if_capabilities_t *)g_malloc(sizeof *caps);
1164 * WinPcap 4.1.2, and possibly earlier versions, have a bug
1165 * wherein, when an open with an rpcap: URL fails, the error
1166 * message for the error is not copied to errbuf and whatever
1167 * on-the-stack junk is in errbuf is treated as the error
1170 * To work around that (and any other bugs of that sort, we
1171 * initialize errbuf to an empty string. If we get an error
1172 * and the string is empty, we report it as an unknown error.
1173 * (If we *don't* get an error, and the string is *non*-empty,
1174 * that could be a warning returned, such as "can't turn
1175 * promiscuous mode on"; we currently don't do so.)
1178 #ifdef HAVE_PCAP_OPEN
1179 pch = pcap_open(devicename, MIN_PACKET_SIZE, 0, 0, NULL, errbuf);
1180 caps->can_set_rfmon = FALSE;
1182 if (err_str != NULL)
1183 *err_str = g_strdup(errbuf[0] == '\0' ? "Unknown error (pcap bug; actual error cause not reported)" : errbuf);
1187 #elif defined(HAVE_PCAP_CREATE)
1188 pch = pcap_create(devicename, errbuf);
1190 if (err_str != NULL)
1191 *err_str = g_strdup(errbuf);
1195 status = pcap_can_set_rfmon(pch);
1198 if (status == PCAP_ERROR)
1199 *err_str = g_strdup_printf("pcap_can_set_rfmon() failed: %s",
1202 *err_str = g_strdup(pcap_statustostr(status));
1208 caps->can_set_rfmon = FALSE;
1209 else if (status == 1) {
1210 caps->can_set_rfmon = TRUE;
1212 pcap_set_rfmon(pch, 1);
1214 if (err_str != NULL) {
1215 *err_str = g_strdup_printf("pcap_can_set_rfmon() returned %d",
1223 status = pcap_activate(pch);
1225 /* Error. We ignore warnings (status > 0). */
1226 if (err_str != NULL) {
1227 if (status == PCAP_ERROR)
1228 *err_str = g_strdup_printf("pcap_activate() failed: %s",
1231 *err_str = g_strdup(pcap_statustostr(status));
1238 pch = pcap_open_live(devicename, MIN_PACKET_SIZE, 0, 0, errbuf);
1239 caps->can_set_rfmon = FALSE;
1241 if (err_str != NULL)
1242 *err_str = g_strdup(errbuf[0] == '\0' ? "Unknown error (pcap bug; actual error cause not reported)" : errbuf);
1247 deflt = get_pcap_linktype(pch, devicename);
1248 #ifdef HAVE_PCAP_LIST_DATALINKS
1249 nlt = pcap_list_datalinks(pch, &linktypes);
1250 if (nlt == 0 || linktypes == NULL) {
1252 if (err_str != NULL)
1253 *err_str = NULL; /* an empty list doesn't mean an error */
1257 caps->data_link_types = NULL;
1258 for (i = 0; i < nlt; i++) {
1259 data_link_info = create_data_link_info(linktypes[i]);
1262 * XXX - for 802.11, make the most detailed 802.11
1263 * version the default, rather than the one the
1264 * device has as the default?
1266 if (linktypes[i] == deflt)
1267 caps->data_link_types = g_list_prepend(caps->data_link_types,
1270 caps->data_link_types = g_list_append(caps->data_link_types,
1273 #ifdef HAVE_PCAP_FREE_DATALINKS
1274 pcap_free_datalinks(linktypes);
1277 * In Windows, there's no guarantee that if you have a library
1278 * built with one version of the MSVC++ run-time library, and
1279 * it returns a pointer to allocated data, you can free that
1280 * data from a program linked with another version of the
1281 * MSVC++ run-time library.
1283 * This is not an issue on UN*X.
1285 * See the mail threads starting at
1287 * http://www.winpcap.org/pipermail/winpcap-users/2006-September/001421.html
1291 * http://www.winpcap.org/pipermail/winpcap-users/2008-May/002498.html
1294 #define xx_free free /* hack so checkAPIs doesn't complain */
1297 #endif /* HAVE_PCAP_FREE_DATALINKS */
1298 #else /* HAVE_PCAP_LIST_DATALINKS */
1300 data_link_info = create_data_link_info(deflt);
1301 caps->data_link_types = g_list_append(caps->data_link_types,
1303 #endif /* HAVE_PCAP_LIST_DATALINKS */
1307 if (err_str != NULL)
1312 #define ADDRSTRLEN 46 /* Covers IPv4 & IPv6 */
1314 * Output a machine readable list of the interfaces
1315 * This list is retrieved by the sync_interface_list_open() function
1316 * The actual output of this function can be viewed with the command "dumpcap -D -Z none"
1319 print_machine_readable_interfaces(GList *if_list)
1326 char addr_str[ADDRSTRLEN];
1328 if (capture_child) {
1329 /* Let our parent know we succeeded. */
1330 pipe_write_block(2, SP_SUCCESS, NULL);
1333 i = 1; /* Interface id number */
1334 for (if_entry = g_list_first(if_list); if_entry != NULL;
1335 if_entry = g_list_next(if_entry)) {
1336 if_info = (if_info_t *)if_entry->data;
1337 printf("%d. %s\t", i++, if_info->name);
1340 * Print the contents of the if_entry struct in a parseable format.
1341 * Each if_entry element is tab-separated. Addresses are comma-
1344 /* XXX - Make sure our description doesn't contain a tab */
1345 if (if_info->vendor_description != NULL)
1346 printf("%s\t", if_info->vendor_description);
1350 /* XXX - Make sure our friendly name doesn't contain a tab */
1351 if (if_info->friendly_name != NULL)
1352 printf("%s\t", if_info->friendly_name);
1356 printf("%i\t", if_info->type);
1358 for (addr = g_slist_nth(if_info->addrs, 0); addr != NULL;
1359 addr = g_slist_next(addr)) {
1360 if (addr != g_slist_nth(if_info->addrs, 0))
1363 if_addr = (if_addr_t *)addr->data;
1364 switch(if_addr->ifat_type) {
1366 if (inet_ntop(AF_INET, &if_addr->addr.ip4_addr, addr_str,
1368 printf("%s", addr_str);
1370 printf("<unknown IPv4>");
1374 if (inet_ntop(AF_INET6, &if_addr->addr.ip6_addr,
1375 addr_str, ADDRSTRLEN)) {
1376 printf("%s", addr_str);
1378 printf("<unknown IPv6>");
1382 printf("<type unknown %i>", if_addr->ifat_type);
1386 if (if_info->loopback)
1387 printf("\tloopback");
1389 printf("\tnetwork");
1396 * If you change the machine-readable output format of this function,
1397 * you MUST update capture_ifinfo.c:capture_get_if_capabilities() accordingly!
1400 print_machine_readable_if_capabilities(if_capabilities_t *caps)
1403 data_link_info_t *data_link_info;
1404 const gchar *desc_str;
1406 if (capture_child) {
1407 /* Let our parent know we succeeded. */
1408 pipe_write_block(2, SP_SUCCESS, NULL);
1411 if (caps->can_set_rfmon)
1415 for (lt_entry = caps->data_link_types; lt_entry != NULL;
1416 lt_entry = g_list_next(lt_entry)) {
1417 data_link_info = (data_link_info_t *)lt_entry->data;
1418 if (data_link_info->description != NULL)
1419 desc_str = data_link_info->description;
1421 desc_str = "(not supported)";
1422 printf("%d\t%s\t%s\n", data_link_info->dlt, data_link_info->name,
1432 /* Print the number of packets captured for each interface until we're killed. */
1434 print_statistics_loop(gboolean machine_readable)
1436 GList *if_list, *if_entry, *stat_list = NULL, *stat_entry;
1442 char errbuf[PCAP_ERRBUF_SIZE];
1443 struct pcap_stat ps;
1445 if_list = get_interface_list(&err, &err_str);
1446 if (if_list == NULL) {
1448 case CANT_GET_INTERFACE_LIST:
1449 case DONT_HAVE_PCAP:
1450 cmdarg_err("%s", err_str);
1454 case NO_INTERFACES_FOUND:
1455 cmdarg_err("There are no interfaces on which a capture can be done");
1461 for (if_entry = g_list_first(if_list); if_entry != NULL; if_entry = g_list_next(if_entry)) {
1462 if_info = (if_info_t *)if_entry->data;
1463 #ifdef HAVE_PCAP_OPEN
1464 pch = pcap_open(if_info->name, MIN_PACKET_SIZE, 0, 0, NULL, errbuf);
1466 pch = pcap_open_live(if_info->name, MIN_PACKET_SIZE, 0, 0, errbuf);
1470 if_stat = (if_stat_t *)g_malloc(sizeof(if_stat_t));
1471 if_stat->name = g_strdup(if_info->name);
1473 stat_list = g_list_append(stat_list, if_stat);
1478 cmdarg_err("There are no interfaces on which a capture can be done");
1482 if (capture_child) {
1483 /* Let our parent know we succeeded. */
1484 pipe_write_block(2, SP_SUCCESS, NULL);
1487 if (!machine_readable) {
1488 printf("%-15s %10s %10s\n", "Interface", "Received",
1492 global_ld.go = TRUE;
1493 while (global_ld.go) {
1494 for (stat_entry = g_list_first(stat_list); stat_entry != NULL; stat_entry = g_list_next(stat_entry)) {
1495 if_stat = (if_stat_t *)stat_entry->data;
1496 pcap_stats(if_stat->pch, &ps);
1498 if (!machine_readable) {
1499 printf("%-15s %10u %10u\n", if_stat->name,
1500 ps.ps_recv, ps.ps_drop);
1502 printf("%s\t%u\t%u\n", if_stat->name,
1503 ps.ps_recv, ps.ps_drop);
1508 /* If we have a dummy signal pipe check it */
1509 if (!signal_pipe_check_running()) {
1510 global_ld.go = FALSE;
1518 /* XXX - Not reached. Should we look for 'q' in stdin? */
1519 for (stat_entry = g_list_first(stat_list); stat_entry != NULL; stat_entry = g_list_next(stat_entry)) {
1520 if_stat = (if_stat_t *)stat_entry->data;
1521 pcap_close(if_stat->pch);
1522 g_free(if_stat->name);
1525 g_list_free(stat_list);
1526 free_interface_list(if_list);
1534 capture_cleanup_handler(DWORD dwCtrlType)
1536 /* CTRL_C_EVENT is sort of like SIGINT, CTRL_BREAK_EVENT is unique to
1537 Windows, CTRL_CLOSE_EVENT is sort of like SIGHUP, CTRL_LOGOFF_EVENT
1538 is also sort of like SIGHUP, and CTRL_SHUTDOWN_EVENT is sort of
1539 like SIGTERM at least when the machine's shutting down.
1541 For now, if we're running as a command rather than a capture child,
1542 we handle all but CTRL_LOGOFF_EVENT as indications that we should
1543 clean up and quit, just as we handle SIGINT, SIGHUP, and SIGTERM
1544 in that way on UN*X.
1546 If we're not running as a capture child, we might be running as
1547 a service; ignore CTRL_LOGOFF_EVENT, so we keep running after the
1548 user logs out. (XXX - can we explicitly check whether we're
1549 running as a service?) */
1551 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
1552 "Console: Control signal");
1553 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
1554 "Console: Control signal, CtrlType: %u", dwCtrlType);
1556 /* Keep capture running if we're a service and a user logs off */
1557 if (capture_child || (dwCtrlType != CTRL_LOGOFF_EVENT)) {
1558 capture_loop_stop();
1566 capture_cleanup_handler(int signum _U_)
1568 /* On UN*X, we cleanly shut down the capture on SIGINT, SIGHUP, and
1569 SIGTERM. We assume that if the user wanted it to keep running
1570 after they logged out, they'd have nohupped it. */
1572 /* Note: don't call g_log() in the signal handler: if we happened to be in
1573 * g_log() in process context when the signal came in, g_log will detect
1574 * the "recursion" and abort.
1577 capture_loop_stop();
1583 report_capture_count(gboolean reportit)
1585 /* Don't print this if we're a capture child. */
1586 if (!capture_child && reportit) {
1587 fprintf(stderr, "\rPackets captured: %u\n", global_ld.packet_count);
1588 /* stderr could be line buffered */
1596 report_counts_for_siginfo(void)
1598 report_capture_count(quiet);
1599 infoprint = FALSE; /* we just reported it */
1603 report_counts_siginfo(int signum _U_)
1605 int sav_errno = errno;
1607 /* If we've been told to delay printing, just set a flag asking
1608 that we print counts (if we're supposed to), otherwise print
1609 the count of packets captured (if we're supposed to). */
1613 report_counts_for_siginfo();
1616 #endif /* SIGINFO */
1619 exit_main(int status)
1622 /* Shutdown windows sockets */
1625 /* can be helpful for debugging */
1626 #ifdef DEBUG_DUMPCAP
1627 printf("Press any key\n");
1638 * If we were linked with libcap (not related to libpcap), make sure we have
1639 * CAP_NET_ADMIN and CAP_NET_RAW, then relinquish our permissions.
1640 * (See comment in main() for details)
1643 relinquish_privs_except_capture(void)
1645 /* If 'started_with_special_privs' (ie: suid) then enable for
1646 * ourself the NET_ADMIN and NET_RAW capabilities and then
1647 * drop our suid privileges.
1649 * CAP_NET_ADMIN: Promiscuous mode and a truckload of other
1650 * stuff we don't need (and shouldn't have).
1651 * CAP_NET_RAW: Packet capture (raw sockets).
1654 if (started_with_special_privs()) {
1655 cap_value_t cap_list[2] = { CAP_NET_ADMIN, CAP_NET_RAW };
1656 int cl_len = sizeof(cap_list) / sizeof(cap_value_t);
1658 cap_t caps = cap_init(); /* all capabilities initialized to off */
1660 print_caps("Pre drop, pre set");
1662 if (prctl(PR_SET_KEEPCAPS, 1, 0, 0, 0) == -1) {
1663 cmdarg_err("prctl() fail return: %s", g_strerror(errno));
1666 cap_set_flag(caps, CAP_PERMITTED, cl_len, cap_list, CAP_SET);
1667 cap_set_flag(caps, CAP_INHERITABLE, cl_len, cap_list, CAP_SET);
1669 if (cap_set_proc(caps)) {
1670 cmdarg_err("cap_set_proc() fail return: %s", g_strerror(errno));
1672 print_caps("Pre drop, post set");
1674 relinquish_special_privs_perm();
1676 print_caps("Post drop, pre set");
1677 cap_set_flag(caps, CAP_EFFECTIVE, cl_len, cap_list, CAP_SET);
1678 if (cap_set_proc(caps)) {
1679 cmdarg_err("cap_set_proc() fail return: %s", g_strerror(errno));
1681 print_caps("Post drop, post set");
1687 #endif /* HAVE_LIBCAP */
1689 /* Take care of byte order in the libpcap headers read from pipes.
1690 * (function taken from wiretap/libpcap.c) */
1692 cap_pipe_adjust_header(gboolean byte_swapped, struct pcap_hdr *hdr, struct pcaprec_hdr *rechdr)
1695 /* Byte-swap the record header fields. */
1696 rechdr->ts_sec = GUINT32_SWAP_LE_BE(rechdr->ts_sec);
1697 rechdr->ts_usec = GUINT32_SWAP_LE_BE(rechdr->ts_usec);
1698 rechdr->incl_len = GUINT32_SWAP_LE_BE(rechdr->incl_len);
1699 rechdr->orig_len = GUINT32_SWAP_LE_BE(rechdr->orig_len);
1702 /* In file format version 2.3, the "incl_len" and "orig_len" fields were
1703 swapped, in order to match the BPF header layout.
1705 Unfortunately, some files were, according to a comment in the "libpcap"
1706 source, written with version 2.3 in their headers but without the
1707 interchanged fields, so if "incl_len" is greater than "orig_len" - which
1708 would make no sense - we assume that we need to swap them. */
1709 if (hdr->version_major == 2 &&
1710 (hdr->version_minor < 3 ||
1711 (hdr->version_minor == 3 && rechdr->incl_len > rechdr->orig_len))) {
1714 temp = rechdr->orig_len;
1715 rechdr->orig_len = rechdr->incl_len;
1716 rechdr->incl_len = temp;
1720 /* Wrapper: distinguish between recv/read if we're reading on Windows,
1724 cap_pipe_read(int pipe_fd, char *buf, size_t sz, gboolean from_socket _U_)
1728 return recv(pipe_fd, buf, (int)sz, 0);
1733 return ws_read(pipe_fd, buf, sz);
1739 * Thread function that reads from a pipe and pushes the data
1740 * to the main application thread.
1743 * XXX Right now we use async queues for basic signaling. The main thread
1744 * sets cap_pipe_buf and cap_bytes_to_read, then pushes an item onto
1745 * cap_pipe_pending_q which triggers a read in the cap_pipe_read thread.
1746 * Iff the read is successful cap_pipe_read pushes an item onto
1747 * cap_pipe_done_q, otherwise an error is signaled. No data is passed in
1748 * the queues themselves (yet).
1750 * We might want to move some of the cap_pipe_dispatch logic here so that
1751 * we can let cap_thread_read run independently, queuing up multiple reads
1752 * for the main thread (and possibly get rid of cap_pipe_read_mtx).
1754 static void *cap_thread_read(void *arg)
1756 pcap_options *pcap_opts;
1759 DWORD b, last_err, bytes_read;
1765 pcap_opts = (pcap_options *)arg;
1766 while (pcap_opts->cap_pipe_err == PIPOK) {
1767 g_async_queue_pop(pcap_opts->cap_pipe_pending_q); /* Wait for our cue (ahem) from the main thread */
1768 g_mutex_lock(pcap_opts->cap_pipe_read_mtx);
1770 while (bytes_read < pcap_opts->cap_pipe_bytes_to_read) {
1771 if ((pcap_opts->from_cap_socket)
1777 b = cap_pipe_read(pcap_opts->cap_pipe_fd, pcap_opts->cap_pipe_buf+bytes_read,
1778 pcap_opts->cap_pipe_bytes_to_read - bytes_read, pcap_opts->from_cap_socket);
1781 pcap_opts->cap_pipe_err = PIPEOF;
1785 pcap_opts->cap_pipe_err = PIPERR;
1796 /* If we try to use read() on a named pipe on Windows with partial
1797 * data it appears to return EOF.
1799 res = ReadFile(pcap_opts->cap_pipe_h, pcap_opts->cap_pipe_buf+bytes_read,
1800 pcap_opts->cap_pipe_bytes_to_read - bytes_read,
1805 last_err = GetLastError();
1806 if (last_err == ERROR_MORE_DATA) {
1808 } else if (last_err == ERROR_HANDLE_EOF || last_err == ERROR_BROKEN_PIPE || last_err == ERROR_PIPE_NOT_CONNECTED) {
1809 pcap_opts->cap_pipe_err = PIPEOF;
1813 pcap_opts->cap_pipe_err = PIPERR;
1816 } else if (b == 0 && pcap_opts->cap_pipe_bytes_to_read > 0) {
1817 pcap_opts->cap_pipe_err = PIPEOF;
1824 pcap_opts->cap_pipe_bytes_read = bytes_read;
1825 if (pcap_opts->cap_pipe_bytes_read >= pcap_opts->cap_pipe_bytes_to_read) {
1826 g_async_queue_push(pcap_opts->cap_pipe_done_q, pcap_opts->cap_pipe_buf); /* Any non-NULL value will do */
1828 g_mutex_unlock(pcap_opts->cap_pipe_read_mtx);
1834 /* Provide select() functionality for a single file descriptor
1835 * on UNIX/POSIX. Windows uses cap_pipe_read via a thread.
1837 * Returns the same values as select.
1840 cap_pipe_select(int pipe_fd)
1843 struct timeval timeout;
1846 FD_SET(pipe_fd, &rfds);
1848 timeout.tv_sec = PIPE_READ_TIMEOUT / 1000000;
1849 timeout.tv_usec = PIPE_READ_TIMEOUT % 1000000;
1851 return select(pipe_fd+1, &rfds, NULL, NULL, &timeout);
1854 #define DEF_TCP_PORT 19000
1857 cap_open_socket(char *pipename, pcap_options *pcap_opts, char *errmsg, int errmsgl)
1859 char *sockname = pipename + 4;
1860 struct sockaddr_in sa;
1867 memset(&sa, 0, sizeof(sa));
1869 p = strchr(sockname, ':');
1871 len = strlen(sockname);
1872 port = DEF_TCP_PORT;
1876 port = strtoul(p + 1, &p, 10);
1877 if (*p || port > 65535) {
1886 strncpy(buf, sockname, len);
1888 if (inet_pton(AF_INET, buf, &sa.sin_addr) <= 0) {
1892 sa.sin_family = AF_INET;
1893 sa.sin_port = htons((u_short)port);
1895 if (((fd = (int)socket(AF_INET, SOCK_STREAM, 0)) < 0) ||
1896 (connect(fd, (struct sockaddr *)&sa, sizeof(sa)) < 0)) {
1898 LPTSTR errorText = NULL;
1901 lastError = WSAGetLastError();
1902 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM |
1903 FORMAT_MESSAGE_ALLOCATE_BUFFER |
1904 FORMAT_MESSAGE_IGNORE_INSERTS,
1905 NULL, lastError, MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
1906 (LPTSTR)&errorText, 0, NULL);
1908 g_snprintf(errmsg, errmsgl,
1909 "The capture session could not be initiated due to the socket error: \n"
1911 " %d: %S", lastError, errorText ? (char *)errorText : "Unknown");
1913 LocalFree(errorText);
1915 " %d: %s", errno, strerror(errno));
1917 pcap_opts->cap_pipe_err = PIPERR;
1920 cap_pipe_close(fd, TRUE);
1924 pcap_opts->from_cap_socket = TRUE;
1928 g_snprintf(errmsg, errmsgl,
1929 "The capture session could not be initiated because\n"
1930 "\"%s\" is not a valid socket specification", pipename);
1931 pcap_opts->cap_pipe_err = PIPERR;
1935 /* Wrapper: distinguish between closesocket on Windows; use ws_close
1939 cap_pipe_close(int pipe_fd, gboolean from_socket _U_)
1943 closesocket(pipe_fd);
1950 /* Mimic pcap_open_live() for pipe captures
1952 * We check if "pipename" is "-" (stdin), a AF_UNIX socket, or a FIFO,
1953 * open it, and read the header.
1955 * N.B. : we can't read the libpcap formats used in RedHat 6.1 or SuSE 6.3
1956 * because we can't seek on pipes (see wiretap/libpcap.c for details) */
1958 cap_pipe_open_live(char *pipename,
1959 pcap_options *pcap_opts,
1960 struct pcap_hdr *hdr,
1961 char *errmsg, int errmsgl)
1964 ws_statb64 pipe_stat;
1965 struct sockaddr_un sa;
1975 pcap_opts->cap_pipe_fd = -1;
1977 pcap_opts->cap_pipe_h = INVALID_HANDLE_VALUE;
1979 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "cap_pipe_open_live: %s", pipename);
1982 * XXX - this blocks until a pcap per-file header has been written to
1983 * the pipe, so it could block indefinitely.
1985 if (strcmp(pipename, "-") == 0) {
1987 fd = 0; /* read from stdin */
1989 pcap_opts->cap_pipe_h = GetStdHandle(STD_INPUT_HANDLE);
1991 } else if (!strncmp(pipename, "TCP@", 4)) {
1992 if ((fd = cap_open_socket(pipename, pcap_opts, errmsg, errmsgl)) < 0) {
1997 if (ws_stat64(pipename, &pipe_stat) < 0) {
1998 if (errno == ENOENT || errno == ENOTDIR)
1999 pcap_opts->cap_pipe_err = PIPNEXIST;
2001 g_snprintf(errmsg, errmsgl,
2002 "The capture session could not be initiated "
2003 "due to error getting information on pipe/socket: %s", g_strerror(errno));
2004 pcap_opts->cap_pipe_err = PIPERR;
2008 if (S_ISFIFO(pipe_stat.st_mode)) {
2009 fd = ws_open(pipename, O_RDONLY | O_NONBLOCK, 0000 /* no creation so don't matter */);
2011 g_snprintf(errmsg, errmsgl,
2012 "The capture session could not be initiated "
2013 "due to error on pipe open: %s", g_strerror(errno));
2014 pcap_opts->cap_pipe_err = PIPERR;
2017 } else if (S_ISSOCK(pipe_stat.st_mode)) {
2018 fd = socket(AF_UNIX, SOCK_STREAM, 0);
2020 g_snprintf(errmsg, errmsgl,
2021 "The capture session could not be initiated "
2022 "due to error on socket create: %s", g_strerror(errno));
2023 pcap_opts->cap_pipe_err = PIPERR;
2026 sa.sun_family = AF_UNIX;
2028 * The Single UNIX Specification says:
2030 * The size of sun_path has intentionally been left undefined.
2031 * This is because different implementations use different sizes.
2032 * For example, 4.3 BSD uses a size of 108, and 4.4 BSD uses a size
2033 * of 104. Since most implementations originate from BSD versions,
2034 * the size is typically in the range 92 to 108.
2036 * Applications should not assume a particular length for sun_path
2037 * or assume that it can hold {_POSIX_PATH_MAX} bytes (256).
2041 * The <sys/un.h> header shall define the sockaddr_un structure,
2042 * which shall include at least the following members:
2044 * sa_family_t sun_family Address family.
2045 * char sun_path[] Socket pathname.
2047 * so we assume that it's an array, with a specified size,
2048 * and that the size reflects the maximum path length.
2050 if (g_strlcpy(sa.sun_path, pipename, sizeof sa.sun_path) > sizeof sa.sun_path) {
2051 /* Path name too long */
2052 g_snprintf(errmsg, errmsgl,
2053 "The capture session coud not be initiated "
2054 "due to error on socket connect: Path name too long");
2055 pcap_opts->cap_pipe_err = PIPERR;
2059 b = connect(fd, (struct sockaddr *)&sa, sizeof sa);
2061 g_snprintf(errmsg, errmsgl,
2062 "The capture session coud not be initiated "
2063 "due to error on socket connect: %s", g_strerror(errno));
2064 pcap_opts->cap_pipe_err = PIPERR;
2069 if (S_ISCHR(pipe_stat.st_mode)) {
2071 * Assume the user specified an interface on a system where
2072 * interfaces are in /dev. Pretend we haven't seen it.
2074 pcap_opts->cap_pipe_err = PIPNEXIST;
2076 g_snprintf(errmsg, errmsgl,
2077 "The capture session could not be initiated because\n"
2078 "\"%s\" is neither an interface nor a socket nor a pipe", pipename);
2079 pcap_opts->cap_pipe_err = PIPERR;
2084 #define PIPE_STR "\\pipe\\"
2085 /* Under Windows, named pipes _must_ have the form
2086 * "\\<server>\pipe\<pipename>". <server> may be "." for localhost.
2088 pncopy = g_strdup(pipename);
2089 if ( (pos=strstr(pncopy, "\\\\")) == pncopy) {
2090 pos = strchr(pncopy + 3, '\\');
2091 if (pos && g_ascii_strncasecmp(pos, PIPE_STR, strlen(PIPE_STR)) != 0)
2098 g_snprintf(errmsg, errmsgl,
2099 "The capture session could not be initiated because\n"
2100 "\"%s\" is neither an interface nor a pipe", pipename);
2101 pcap_opts->cap_pipe_err = PIPNEXIST;
2105 /* Wait for the pipe to appear */
2107 pcap_opts->cap_pipe_h = CreateFile(utf_8to16(pipename), GENERIC_READ, 0, NULL,
2108 OPEN_EXISTING, 0, NULL);
2110 if (pcap_opts->cap_pipe_h != INVALID_HANDLE_VALUE)
2113 if (GetLastError() != ERROR_PIPE_BUSY) {
2114 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
2115 NULL, GetLastError(), 0, (LPTSTR) &err_str, 0, NULL);
2116 g_snprintf(errmsg, errmsgl,
2117 "The capture session on \"%s\" could not be started "
2118 "due to error on pipe open: %s (error %d)",
2119 pipename, utf_16to8(err_str), GetLastError());
2121 pcap_opts->cap_pipe_err = PIPERR;
2125 if (!WaitNamedPipe(utf_8to16(pipename), 30 * 1000)) {
2126 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
2127 NULL, GetLastError(), 0, (LPTSTR) &err_str, 0, NULL);
2128 g_snprintf(errmsg, errmsgl,
2129 "The capture session on \"%s\" timed out during "
2130 "pipe open: %s (error %d)",
2131 pipename, utf_16to8(err_str), GetLastError());
2133 pcap_opts->cap_pipe_err = PIPERR;
2140 pcap_opts->from_cap_pipe = TRUE;
2143 if (pcap_opts->from_cap_socket)
2146 /* read the pcap header */
2148 while (bytes_read < sizeof magic) {
2149 sel_ret = cap_pipe_select(fd);
2151 g_snprintf(errmsg, errmsgl,
2152 "Unexpected error from select: %s", g_strerror(errno));
2154 } else if (sel_ret > 0) {
2155 b = cap_pipe_read(fd, ((char *)&magic)+bytes_read,
2156 sizeof magic-bytes_read,
2157 pcap_opts->from_cap_socket);
2160 g_snprintf(errmsg, errmsgl, "End of file on pipe magic during open");
2162 g_snprintf(errmsg, errmsgl, "Error on pipe magic during open: %s",
2172 #if GLIB_CHECK_VERSION(2,31,0)
2173 g_thread_new("cap_pipe_open_live", &cap_thread_read, pcap_opts);
2175 g_thread_create(&cap_thread_read, pcap_opts, FALSE, NULL);
2178 pcap_opts->cap_pipe_buf = (char *) &magic;
2179 pcap_opts->cap_pipe_bytes_read = 0;
2180 pcap_opts->cap_pipe_bytes_to_read = sizeof(magic);
2181 /* We don't have to worry about cap_pipe_read_mtx here */
2182 g_async_queue_push(pcap_opts->cap_pipe_pending_q, pcap_opts->cap_pipe_buf);
2183 g_async_queue_pop(pcap_opts->cap_pipe_done_q);
2184 if (pcap_opts->cap_pipe_bytes_read <= 0) {
2185 if (pcap_opts->cap_pipe_bytes_read == 0)
2186 g_snprintf(errmsg, errmsgl, "End of file on pipe magic during open");
2188 g_snprintf(errmsg, errmsgl, "Error on pipe magic during open: %s",
2197 case PCAP_NSEC_MAGIC:
2198 /* Host that wrote it has our byte order, and was running
2199 a program using either standard or ss990417 libpcap. */
2200 pcap_opts->cap_pipe_byte_swapped = FALSE;
2201 pcap_opts->cap_pipe_modified = FALSE;
2202 pcap_opts->ts_nsec = magic == PCAP_NSEC_MAGIC;
2204 case PCAP_MODIFIED_MAGIC:
2205 /* Host that wrote it has our byte order, but was running
2206 a program using either ss990915 or ss991029 libpcap. */
2207 pcap_opts->cap_pipe_byte_swapped = FALSE;
2208 pcap_opts->cap_pipe_modified = TRUE;
2210 case PCAP_SWAPPED_MAGIC:
2211 case PCAP_SWAPPED_NSEC_MAGIC:
2212 /* Host that wrote it has a byte order opposite to ours,
2213 and was running a program using either standard or
2214 ss990417 libpcap. */
2215 pcap_opts->cap_pipe_byte_swapped = TRUE;
2216 pcap_opts->cap_pipe_modified = FALSE;
2217 pcap_opts->ts_nsec = magic == PCAP_SWAPPED_NSEC_MAGIC;
2219 case PCAP_SWAPPED_MODIFIED_MAGIC:
2220 /* Host that wrote it out has a byte order opposite to
2221 ours, and was running a program using either ss990915
2222 or ss991029 libpcap. */
2223 pcap_opts->cap_pipe_byte_swapped = TRUE;
2224 pcap_opts->cap_pipe_modified = TRUE;
2227 /* Not a "libpcap" type we know about. */
2228 g_snprintf(errmsg, errmsgl, "Unrecognized libpcap format");
2233 if (pcap_opts->from_cap_socket)
2236 /* Read the rest of the header */
2238 while (bytes_read < sizeof(struct pcap_hdr)) {
2239 sel_ret = cap_pipe_select(fd);
2241 g_snprintf(errmsg, errmsgl,
2242 "Unexpected error from select: %s", g_strerror(errno));
2244 } else if (sel_ret > 0) {
2245 b = cap_pipe_read(fd, ((char *)hdr)+bytes_read,
2246 sizeof(struct pcap_hdr) - bytes_read,
2247 pcap_opts->from_cap_socket);
2250 g_snprintf(errmsg, errmsgl, "End of file on pipe header during open");
2252 g_snprintf(errmsg, errmsgl, "Error on pipe header during open: %s",
2262 pcap_opts->cap_pipe_buf = (char *) hdr;
2263 pcap_opts->cap_pipe_bytes_read = 0;
2264 pcap_opts->cap_pipe_bytes_to_read = sizeof(struct pcap_hdr);
2265 g_async_queue_push(pcap_opts->cap_pipe_pending_q, pcap_opts->cap_pipe_buf);
2266 g_async_queue_pop(pcap_opts->cap_pipe_done_q);
2267 if (pcap_opts->cap_pipe_bytes_read <= 0) {
2268 if (pcap_opts->cap_pipe_bytes_read == 0)
2269 g_snprintf(errmsg, errmsgl, "End of file on pipe header during open");
2271 g_snprintf(errmsg, errmsgl, "Error on pipe header header during open: %s",
2278 if (pcap_opts->cap_pipe_byte_swapped) {
2279 /* Byte-swap the header fields about which we care. */
2280 hdr->version_major = GUINT16_SWAP_LE_BE(hdr->version_major);
2281 hdr->version_minor = GUINT16_SWAP_LE_BE(hdr->version_minor);
2282 hdr->snaplen = GUINT32_SWAP_LE_BE(hdr->snaplen);
2283 hdr->network = GUINT32_SWAP_LE_BE(hdr->network);
2285 pcap_opts->linktype = hdr->network;
2287 if (hdr->version_major < 2) {
2288 g_snprintf(errmsg, errmsgl, "Unable to read old libpcap format");
2292 pcap_opts->cap_pipe_state = STATE_EXPECT_REC_HDR;
2293 pcap_opts->cap_pipe_err = PIPOK;
2294 pcap_opts->cap_pipe_fd = fd;
2298 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "cap_pipe_open_live: error %s", errmsg);
2299 pcap_opts->cap_pipe_err = PIPERR;
2300 cap_pipe_close(fd, pcap_opts->from_cap_socket);
2301 pcap_opts->cap_pipe_fd = -1;
2305 /* We read one record from the pipe, take care of byte order in the record
2306 * header, write the record to the capture file, and update capture statistics. */
2308 cap_pipe_dispatch(loop_data *ld, pcap_options *pcap_opts, guchar *data, char *errmsg, int errmsgl)
2310 struct pcap_pkthdr phdr;
2311 enum { PD_REC_HDR_READ, PD_DATA_READ, PD_PIPE_EOF, PD_PIPE_ERR,
2314 #if !GLIB_CHECK_VERSION(2,31,18)
2322 #ifdef LOG_CAPTURE_VERBOSE
2323 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "cap_pipe_dispatch");
2326 switch (pcap_opts->cap_pipe_state) {
2328 case STATE_EXPECT_REC_HDR:
2330 if (g_mutex_trylock(pcap_opts->cap_pipe_read_mtx)) {
2333 pcap_opts->cap_pipe_state = STATE_READ_REC_HDR;
2334 pcap_opts->cap_pipe_bytes_to_read = pcap_opts->cap_pipe_modified ?
2335 sizeof(struct pcaprec_modified_hdr) : sizeof(struct pcaprec_hdr);
2336 pcap_opts->cap_pipe_bytes_read = 0;
2339 pcap_opts->cap_pipe_buf = (char *) &pcap_opts->cap_pipe_rechdr;
2340 g_async_queue_push(pcap_opts->cap_pipe_pending_q, pcap_opts->cap_pipe_buf);
2341 g_mutex_unlock(pcap_opts->cap_pipe_read_mtx);
2346 case STATE_READ_REC_HDR:
2348 if (pcap_opts->from_cap_socket)
2351 b = cap_pipe_read(pcap_opts->cap_pipe_fd, ((char *)&pcap_opts->cap_pipe_rechdr)+pcap_opts->cap_pipe_bytes_read,
2352 pcap_opts->cap_pipe_bytes_to_read - pcap_opts->cap_pipe_bytes_read, pcap_opts->from_cap_socket);
2355 result = PD_PIPE_EOF;
2357 result = PD_PIPE_ERR;
2360 pcap_opts->cap_pipe_bytes_read += b;
2364 #if GLIB_CHECK_VERSION(2,31,18)
2365 q_status = g_async_queue_timeout_pop(pcap_opts->cap_pipe_done_q, PIPE_READ_TIMEOUT);
2367 g_get_current_time(&wait_time);
2368 g_time_val_add(&wait_time, PIPE_READ_TIMEOUT);
2369 q_status = g_async_queue_timed_pop(pcap_opts->cap_pipe_done_q, &wait_time);
2371 if (pcap_opts->cap_pipe_err == PIPEOF) {
2372 result = PD_PIPE_EOF;
2374 } else if (pcap_opts->cap_pipe_err == PIPERR) {
2375 result = PD_PIPE_ERR;
2383 if (pcap_opts->cap_pipe_bytes_read < pcap_opts->cap_pipe_bytes_to_read)
2385 result = PD_REC_HDR_READ;
2388 case STATE_EXPECT_DATA:
2390 if (g_mutex_trylock(pcap_opts->cap_pipe_read_mtx)) {
2393 pcap_opts->cap_pipe_state = STATE_READ_DATA;
2394 pcap_opts->cap_pipe_bytes_to_read = pcap_opts->cap_pipe_rechdr.hdr.incl_len;
2395 pcap_opts->cap_pipe_bytes_read = 0;
2398 pcap_opts->cap_pipe_buf = (char *) data;
2399 g_async_queue_push(pcap_opts->cap_pipe_pending_q, pcap_opts->cap_pipe_buf);
2400 g_mutex_unlock(pcap_opts->cap_pipe_read_mtx);
2405 case STATE_READ_DATA:
2407 if (pcap_opts->from_cap_socket)
2410 b = cap_pipe_read(pcap_opts->cap_pipe_fd,
2411 data+pcap_opts->cap_pipe_bytes_read,
2412 pcap_opts->cap_pipe_bytes_to_read - pcap_opts->cap_pipe_bytes_read,
2413 pcap_opts->from_cap_socket);
2416 result = PD_PIPE_EOF;
2418 result = PD_PIPE_ERR;
2421 pcap_opts->cap_pipe_bytes_read += b;
2426 #if GLIB_CHECK_VERSION(2,31,18)
2427 q_status = g_async_queue_timeout_pop(pcap_opts->cap_pipe_done_q, PIPE_READ_TIMEOUT);
2429 g_get_current_time(&wait_time);
2430 g_time_val_add(&wait_time, PIPE_READ_TIMEOUT);
2431 q_status = g_async_queue_timed_pop(pcap_opts->cap_pipe_done_q, &wait_time);
2432 #endif /* GLIB_CHECK_VERSION(2,31,18) */
2433 if (pcap_opts->cap_pipe_err == PIPEOF) {
2434 result = PD_PIPE_EOF;
2436 } else if (pcap_opts->cap_pipe_err == PIPERR) {
2437 result = PD_PIPE_ERR;
2445 if (pcap_opts->cap_pipe_bytes_read < pcap_opts->cap_pipe_bytes_to_read)
2447 result = PD_DATA_READ;
2451 g_snprintf(errmsg, errmsgl, "cap_pipe_dispatch: invalid state");
2454 } /* switch (pcap_opts->cap_pipe_state) */
2457 * We've now read as much data as we were expecting, so process it.
2461 case PD_REC_HDR_READ:
2462 /* We've read the header. Take care of byte order. */
2463 cap_pipe_adjust_header(pcap_opts->cap_pipe_byte_swapped, &pcap_opts->cap_pipe_hdr,
2464 &pcap_opts->cap_pipe_rechdr.hdr);
2465 if (pcap_opts->cap_pipe_rechdr.hdr.incl_len > WTAP_MAX_PACKET_SIZE) {
2466 g_snprintf(errmsg, errmsgl, "Frame %u too long (%d bytes)",
2467 ld->packet_count+1, pcap_opts->cap_pipe_rechdr.hdr.incl_len);
2471 if (pcap_opts->cap_pipe_rechdr.hdr.incl_len) {
2472 pcap_opts->cap_pipe_state = STATE_EXPECT_DATA;
2475 /* no data to read? fall through */
2478 /* Fill in a "struct pcap_pkthdr", and process the packet. */
2479 phdr.ts.tv_sec = pcap_opts->cap_pipe_rechdr.hdr.ts_sec;
2480 phdr.ts.tv_usec = pcap_opts->cap_pipe_rechdr.hdr.ts_usec;
2481 phdr.caplen = pcap_opts->cap_pipe_rechdr.hdr.incl_len;
2482 phdr.len = pcap_opts->cap_pipe_rechdr.hdr.orig_len;
2485 capture_loop_queue_packet_cb((u_char *)pcap_opts, &phdr, data);
2487 capture_loop_write_packet_cb((u_char *)pcap_opts, &phdr, data);
2489 pcap_opts->cap_pipe_state = STATE_EXPECT_REC_HDR;
2493 pcap_opts->cap_pipe_err = PIPEOF;
2498 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
2499 NULL, GetLastError(), 0, (LPTSTR) &err_str, 0, NULL);
2500 g_snprintf(errmsg, errmsgl,
2501 "Error reading from pipe: %s (error %d)",
2502 utf_16to8(err_str), GetLastError());
2505 g_snprintf(errmsg, errmsgl, "Error reading from pipe: %s",
2513 pcap_opts->cap_pipe_err = PIPERR;
2514 /* Return here rather than inside the switch to prevent GCC warning */
2519 /** Open the capture input file (pcap or capture pipe).
2520 * Returns TRUE if it succeeds, FALSE otherwise. */
2522 capture_loop_open_input(capture_options *capture_opts, loop_data *ld,
2523 char *errmsg, size_t errmsg_len,
2524 char *secondary_errmsg, size_t secondary_errmsg_len)
2526 gchar open_err_str[PCAP_ERRBUF_SIZE];
2527 gchar *sync_msg_str;
2528 interface_options interface_opts;
2529 pcap_options *pcap_opts;
2533 gchar *sync_secondary_msg_str;
2534 WORD wVersionRequested;
2538 /* XXX - opening Winsock on tshark? */
2540 /* Initialize Windows Socket if we are in a WIN32 OS
2541 This needs to be done before querying the interface for network/netmask */
2543 /* XXX - do we really require 1.1 or earlier?
2544 Are there any versions that support only 2.0 or higher? */
2545 wVersionRequested = MAKEWORD(1, 1);
2546 err = WSAStartup(wVersionRequested, &wsaData);
2550 case WSASYSNOTREADY:
2551 g_snprintf(errmsg, (gulong) errmsg_len,
2552 "Couldn't initialize Windows Sockets: Network system not ready for network communication");
2555 case WSAVERNOTSUPPORTED:
2556 g_snprintf(errmsg, (gulong) errmsg_len,
2557 "Couldn't initialize Windows Sockets: Windows Sockets version %u.%u not supported",
2558 LOBYTE(wVersionRequested), HIBYTE(wVersionRequested));
2561 case WSAEINPROGRESS:
2562 g_snprintf(errmsg, (gulong) errmsg_len,
2563 "Couldn't initialize Windows Sockets: Blocking operation is in progress");
2567 g_snprintf(errmsg, (gulong) errmsg_len,
2568 "Couldn't initialize Windows Sockets: Limit on the number of tasks supported by this WinSock implementation has been reached");
2572 g_snprintf(errmsg, (gulong) errmsg_len,
2573 "Couldn't initialize Windows Sockets: Bad pointer passed to WSAStartup");
2577 g_snprintf(errmsg, (gulong) errmsg_len,
2578 "Couldn't initialize Windows Sockets: error %d", err);
2581 g_snprintf(secondary_errmsg, (gulong) secondary_errmsg_len, please_report);
2585 if ((use_threads == FALSE) &&
2586 (capture_opts->ifaces->len > 1)) {
2587 g_snprintf(errmsg, (gulong) errmsg_len,
2588 "Using threads is required for capturing on multiple interfaces!");
2592 for (i = 0; i < capture_opts->ifaces->len; i++) {
2593 interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
2594 pcap_opts = (pcap_options *)g_malloc(sizeof (pcap_options));
2595 if (pcap_opts == NULL) {
2596 g_snprintf(errmsg, (gulong) errmsg_len,
2597 "Could not allocate memory.");
2600 pcap_opts->received = 0;
2601 pcap_opts->dropped = 0;
2602 pcap_opts->flushed = 0;
2603 pcap_opts->pcap_h = NULL;
2604 #ifdef MUST_DO_SELECT
2605 pcap_opts->pcap_fd = -1;
2607 pcap_opts->pcap_err = FALSE;
2608 pcap_opts->interface_id = i;
2609 pcap_opts->tid = NULL;
2610 pcap_opts->snaplen = 0;
2611 pcap_opts->linktype = -1;
2612 pcap_opts->ts_nsec = FALSE;
2613 pcap_opts->from_cap_pipe = FALSE;
2614 pcap_opts->from_cap_socket = FALSE;
2615 memset(&pcap_opts->cap_pipe_hdr, 0, sizeof(struct pcap_hdr));
2616 memset(&pcap_opts->cap_pipe_rechdr, 0, sizeof(struct pcaprec_modified_hdr));
2618 pcap_opts->cap_pipe_h = INVALID_HANDLE_VALUE;
2620 pcap_opts->cap_pipe_fd = -1;
2621 pcap_opts->cap_pipe_modified = FALSE;
2622 pcap_opts->cap_pipe_byte_swapped = FALSE;
2624 pcap_opts->cap_pipe_buf = NULL;
2626 pcap_opts->cap_pipe_bytes_to_read = 0;
2627 pcap_opts->cap_pipe_bytes_read = 0;
2628 pcap_opts->cap_pipe_state = STATE_EXPECT_REC_HDR;
2629 pcap_opts->cap_pipe_err = PIPOK;
2631 #if GLIB_CHECK_VERSION(2,31,0)
2632 pcap_opts->cap_pipe_read_mtx = g_malloc(sizeof(GMutex));
2633 g_mutex_init(pcap_opts->cap_pipe_read_mtx);
2635 pcap_opts->cap_pipe_read_mtx = g_mutex_new();
2637 pcap_opts->cap_pipe_pending_q = g_async_queue_new();
2638 pcap_opts->cap_pipe_done_q = g_async_queue_new();
2640 g_array_append_val(ld->pcaps, pcap_opts);
2642 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_open_input : %s", interface_opts.name);
2643 pcap_opts->pcap_h = open_capture_device(&interface_opts, &open_err_str);
2645 if (pcap_opts->pcap_h != NULL) {
2646 /* we've opened "iface" as a network device */
2648 /* try to set the capture buffer size */
2649 if (interface_opts.buffer_size > 1 &&
2650 pcap_setbuff(pcap_opts->pcap_h, interface_opts.buffer_size * 1024 * 1024) != 0) {
2651 sync_secondary_msg_str = g_strdup_printf(
2652 "The capture buffer size of %d MiB seems to be too high for your machine,\n"
2653 "the default of %d MiB will be used.\n"
2655 "Nonetheless, the capture is started.\n",
2656 interface_opts.buffer_size, DEFAULT_CAPTURE_BUFFER_SIZE);
2657 report_capture_error("Couldn't set the capture buffer size!",
2658 sync_secondary_msg_str);
2659 g_free(sync_secondary_msg_str);
2663 #if defined(HAVE_PCAP_SETSAMPLING)
2664 if (interface_opts.sampling_method != CAPTURE_SAMP_NONE) {
2665 struct pcap_samp *samp;
2667 if ((samp = pcap_setsampling(pcap_opts->pcap_h)) != NULL) {
2668 switch (interface_opts.sampling_method) {
2669 case CAPTURE_SAMP_BY_COUNT:
2670 samp->method = PCAP_SAMP_1_EVERY_N;
2673 case CAPTURE_SAMP_BY_TIMER:
2674 samp->method = PCAP_SAMP_FIRST_AFTER_N_MS;
2678 sync_msg_str = g_strdup_printf(
2679 "Unknown sampling method %d specified,\n"
2680 "continue without packet sampling",
2681 interface_opts.sampling_method);
2682 report_capture_error("Couldn't set the capture "
2683 "sampling", sync_msg_str);
2684 g_free(sync_msg_str);
2686 samp->value = interface_opts.sampling_param;
2688 report_capture_error("Couldn't set the capture sampling",
2689 "Cannot get packet sampling data structure");
2694 /* setting the data link type only works on real interfaces */
2695 if (!set_pcap_linktype(pcap_opts->pcap_h, interface_opts.linktype, interface_opts.name,
2697 secondary_errmsg, secondary_errmsg_len)) {
2700 pcap_opts->linktype = get_pcap_linktype(pcap_opts->pcap_h, interface_opts.name);
2702 /* We couldn't open "iface" as a network device. */
2703 /* Try to open it as a pipe */
2704 cap_pipe_open_live(interface_opts.name, pcap_opts, &pcap_opts->cap_pipe_hdr, errmsg, (int) errmsg_len);
2707 if (pcap_opts->cap_pipe_fd == -1) {
2709 if (pcap_opts->cap_pipe_h == INVALID_HANDLE_VALUE) {
2711 if (pcap_opts->cap_pipe_err == PIPNEXIST) {
2712 /* Pipe doesn't exist, so output message for interface */
2713 get_capture_device_open_failure_messages(open_err_str,
2714 interface_opts.name,
2718 secondary_errmsg_len);
2721 * Else pipe (or file) does exist and cap_pipe_open_live() has
2726 /* cap_pipe_open_live() succeeded; don't want
2727 error message from pcap_open_live() */
2728 open_err_str[0] = '\0';
2732 /* XXX - will this work for tshark? */
2733 #ifdef MUST_DO_SELECT
2734 if (!pcap_opts->from_cap_pipe) {
2735 #ifdef HAVE_PCAP_GET_SELECTABLE_FD
2736 pcap_opts->pcap_fd = pcap_get_selectable_fd(pcap_opts->pcap_h);
2738 pcap_opts->pcap_fd = pcap_fileno(pcap_opts->pcap_h);
2743 /* Does "open_err_str" contain a non-empty string? If so, "pcap_open_live()"
2744 returned a warning; print it, but keep capturing. */
2745 if (open_err_str[0] != '\0') {
2746 sync_msg_str = g_strdup_printf("%s.", open_err_str);
2747 report_capture_error(sync_msg_str, "");
2748 g_free(sync_msg_str);
2750 capture_opts->ifaces = g_array_remove_index(capture_opts->ifaces, i);
2751 g_array_insert_val(capture_opts->ifaces, i, interface_opts);
2754 /* If not using libcap: we now can now set euid/egid to ruid/rgid */
2755 /* to remove any suid privileges. */
2756 /* If using libcap: we can now remove NET_RAW and NET_ADMIN capabilities */
2757 /* (euid/egid have already previously been set to ruid/rgid. */
2758 /* (See comment in main() for details) */
2760 relinquish_special_privs_perm();
2762 relinquish_all_capabilities();
2767 /* close the capture input file (pcap or capture pipe) */
2768 static void capture_loop_close_input(loop_data *ld)
2771 pcap_options *pcap_opts;
2773 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_close_input");
2775 for (i = 0; i < ld->pcaps->len; i++) {
2776 pcap_opts = g_array_index(ld->pcaps, pcap_options *, i);
2777 /* if open, close the capture pipe "input file" */
2778 if (pcap_opts->cap_pipe_fd >= 0) {
2779 g_assert(pcap_opts->from_cap_pipe);
2780 cap_pipe_close(pcap_opts->cap_pipe_fd, pcap_opts->from_cap_socket);
2781 pcap_opts->cap_pipe_fd = -1;
2784 if (pcap_opts->cap_pipe_h != INVALID_HANDLE_VALUE) {
2785 CloseHandle(pcap_opts->cap_pipe_h);
2786 pcap_opts->cap_pipe_h = INVALID_HANDLE_VALUE;
2789 /* if open, close the pcap "input file" */
2790 if (pcap_opts->pcap_h != NULL) {
2791 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_close_input: closing %p", (void *)pcap_opts->pcap_h);
2792 pcap_close(pcap_opts->pcap_h);
2793 pcap_opts->pcap_h = NULL;
2800 /* Shut down windows sockets */
2806 /* init the capture filter */
2807 static initfilter_status_t
2808 capture_loop_init_filter(pcap_t *pcap_h, gboolean from_cap_pipe,
2809 const gchar * name, const gchar * cfilter)
2811 struct bpf_program fcode;
2813 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_init_filter: %s", cfilter);
2815 /* capture filters only work on real interfaces */
2816 if (cfilter && !from_cap_pipe) {
2817 /* A capture filter was specified; set it up. */
2818 if (!compile_capture_filter(name, pcap_h, &fcode, cfilter)) {
2819 /* Treat this specially - our caller might try to compile this
2820 as a display filter and, if that succeeds, warn the user that
2821 the display and capture filter syntaxes are different. */
2822 return INITFILTER_BAD_FILTER;
2824 if (pcap_setfilter(pcap_h, &fcode) < 0) {
2825 #ifdef HAVE_PCAP_FREECODE
2826 pcap_freecode(&fcode);
2828 return INITFILTER_OTHER_ERROR;
2830 #ifdef HAVE_PCAP_FREECODE
2831 pcap_freecode(&fcode);
2835 return INITFILTER_NO_ERROR;
2839 /* set up to write to the already-opened capture output file/files */
2841 capture_loop_init_output(capture_options *capture_opts, loop_data *ld, char *errmsg, int errmsg_len)
2845 pcap_options *pcap_opts;
2846 interface_options interface_opts;
2847 gboolean successful;
2849 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_init_output");
2851 if ((capture_opts->use_pcapng == FALSE) &&
2852 (capture_opts->ifaces->len > 1)) {
2853 g_snprintf(errmsg, errmsg_len,
2854 "Using PCAPNG is required for capturing on multiple interfaces! Use the -n option.");
2858 /* Set up to write to the capture file. */
2859 if (capture_opts->multi_files_on) {
2860 ld->pdh = ringbuf_init_libpcap_fdopen(&err);
2862 ld->pdh = ws_fdopen(ld->save_file_fd, "wb");
2863 if (ld->pdh == NULL) {
2868 if (capture_opts->use_pcapng) {
2870 GString *os_info_str;
2872 os_info_str = g_string_new("");
2873 get_os_version_info(os_info_str);
2875 g_snprintf(appname, sizeof(appname), "Dumpcap " VERSION "%s", wireshark_svnversion);
2876 successful = pcapng_write_session_header_block(ld->pdh,
2877 (const char *)capture_opts->capture_comment, /* Comment*/
2879 os_info_str->str, /* OS*/
2881 -1, /* section_length */
2885 for (i = 0; successful && (i < capture_opts->ifaces->len); i++) {
2886 interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
2887 pcap_opts = g_array_index(ld->pcaps, pcap_options *, i);
2888 if (pcap_opts->from_cap_pipe) {
2889 pcap_opts->snaplen = pcap_opts->cap_pipe_hdr.snaplen;
2891 pcap_opts->snaplen = pcap_snapshot(pcap_opts->pcap_h);
2893 successful = pcapng_write_interface_description_block(global_ld.pdh,
2894 NULL, /* OPT_COMMENT 1 */
2895 interface_opts.name, /* IDB_NAME 2 */
2896 interface_opts.descr, /* IDB_DESCRIPTION 3 */
2897 interface_opts.cfilter, /* IDB_FILTER 11 */
2898 os_info_str->str, /* IDB_OS 12 */
2899 pcap_opts->linktype,
2901 &(global_ld.bytes_written),
2902 0, /* IDB_IF_SPEED 8 */
2903 pcap_opts->ts_nsec ? 9 : 6, /* IDB_TSRESOL 9 */
2907 g_string_free(os_info_str, TRUE);
2910 pcap_opts = g_array_index(ld->pcaps, pcap_options *, 0);
2911 if (pcap_opts->from_cap_pipe) {
2912 pcap_opts->snaplen = pcap_opts->cap_pipe_hdr.snaplen;
2914 pcap_opts->snaplen = pcap_snapshot(pcap_opts->pcap_h);
2916 successful = libpcap_write_file_header(ld->pdh, pcap_opts->linktype, pcap_opts->snaplen,
2917 pcap_opts->ts_nsec, &ld->bytes_written, &err);
2925 if (ld->pdh == NULL) {
2926 /* We couldn't set up to write to the capture file. */
2927 /* XXX - use cf_open_error_message from tshark instead? */
2932 g_snprintf(errmsg, errmsg_len,
2933 "The file to which the capture would be"
2934 " saved (\"%s\") could not be opened: Error %d.",
2935 capture_opts->save_file, err);
2937 g_snprintf(errmsg, errmsg_len,
2938 "The file to which the capture would be"
2939 " saved (\"%s\") could not be opened: %s.",
2940 capture_opts->save_file, g_strerror(err));
2952 capture_loop_close_output(capture_options *capture_opts, loop_data *ld, int *err_close)
2956 pcap_options *pcap_opts;
2957 guint64 end_time = create_timestamp();
2959 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_close_output");
2961 if (capture_opts->multi_files_on) {
2962 return ringbuf_libpcap_dump_close(&capture_opts->save_file, err_close);
2964 if (capture_opts->use_pcapng) {
2965 for (i = 0; i < global_ld.pcaps->len; i++) {
2966 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, i);
2967 if (!pcap_opts->from_cap_pipe) {
2968 guint64 isb_ifrecv, isb_ifdrop;
2969 struct pcap_stat stats;
2971 if (pcap_stats(pcap_opts->pcap_h, &stats) >= 0) {
2972 isb_ifrecv = pcap_opts->received;
2973 isb_ifdrop = stats.ps_drop + pcap_opts->dropped + pcap_opts->flushed;
2975 isb_ifrecv = G_MAXUINT64;
2976 isb_ifdrop = G_MAXUINT64;
2978 pcapng_write_interface_statistics_block(ld->pdh,
2981 "Counters provided by dumpcap",
2990 if (fclose(ld->pdh) == EOF) {
2991 if (err_close != NULL) {
3001 /* dispatch incoming packets (pcap or capture pipe)
3003 * Waits for incoming packets to be available, and calls pcap_dispatch()
3004 * to cause them to be processed.
3006 * Returns the number of packets which were processed.
3008 * Times out (returning zero) after CAP_READ_TIMEOUT ms; this ensures that the
3009 * packet-batching behaviour does not cause packets to get held back
3013 capture_loop_dispatch(loop_data *ld,
3014 char *errmsg, int errmsg_len, pcap_options *pcap_opts)
3017 gint packet_count_before;
3018 guchar pcap_data[WTAP_MAX_PACKET_SIZE];
3023 packet_count_before = ld->packet_count;
3024 if (pcap_opts->from_cap_pipe) {
3025 /* dispatch from capture pipe */
3026 #ifdef LOG_CAPTURE_VERBOSE
3027 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_dispatch: from capture pipe");
3030 sel_ret = cap_pipe_select(pcap_opts->cap_pipe_fd);
3032 if (sel_ret < 0 && errno != EINTR) {
3033 g_snprintf(errmsg, errmsg_len,
3034 "Unexpected error from select: %s", g_strerror(errno));
3035 report_capture_error(errmsg, please_report);
3040 * "select()" says we can read from the pipe without blocking
3043 inpkts = cap_pipe_dispatch(ld, pcap_opts, pcap_data, errmsg, errmsg_len);
3053 /* dispatch from pcap */
3054 #ifdef MUST_DO_SELECT
3056 * If we have "pcap_get_selectable_fd()", we use it to get the
3057 * descriptor on which to select; if that's -1, it means there
3058 * is no descriptor on which you can do a "select()" (perhaps
3059 * because you're capturing on a special device, and that device's
3060 * driver unfortunately doesn't support "select()", in which case
3061 * we don't do the select - which means it might not be possible
3062 * to stop a capture until a packet arrives. If that's unacceptable,
3063 * plead with whoever supplies the software for that device to add
3064 * "select()" support, or upgrade to libpcap 0.8.1 or later, and
3065 * rebuild Wireshark or get a version built with libpcap 0.8.1 or
3066 * later, so it can use pcap_breakloop().
3068 #ifdef LOG_CAPTURE_VERBOSE
3069 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_dispatch: from pcap_dispatch with select");
3071 if (pcap_opts->pcap_fd != -1) {
3072 sel_ret = cap_pipe_select(pcap_opts->pcap_fd);
3075 * "select()" says we can read from it without blocking; go for
3078 * We don't have pcap_breakloop(), so we only process one packet
3079 * per pcap_dispatch() call, to allow a signal to stop the
3080 * processing immediately, rather than processing all packets
3081 * in a batch before quitting.
3084 inpkts = pcap_dispatch(pcap_opts->pcap_h, 1, capture_loop_queue_packet_cb, (u_char *)pcap_opts);
3086 inpkts = pcap_dispatch(pcap_opts->pcap_h, 1, capture_loop_write_packet_cb, (u_char *)pcap_opts);
3090 /* Error, rather than pcap_breakloop(). */
3091 pcap_opts->pcap_err = TRUE;
3093 ld->go = FALSE; /* error or pcap_breakloop() - stop capturing */
3096 if (sel_ret < 0 && errno != EINTR) {
3097 g_snprintf(errmsg, errmsg_len,
3098 "Unexpected error from select: %s", g_strerror(errno));
3099 report_capture_error(errmsg, please_report);
3105 #endif /* MUST_DO_SELECT */
3107 /* dispatch from pcap without select */
3109 #ifdef LOG_CAPTURE_VERBOSE
3110 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_dispatch: from pcap_dispatch");
3114 * On Windows, we don't support asynchronously telling a process to
3115 * stop capturing; instead, we check for an indication on a pipe
3116 * after processing packets. We therefore process only one packet
3117 * at a time, so that we can check the pipe after every packet.
3120 inpkts = pcap_dispatch(pcap_opts->pcap_h, 1, capture_loop_queue_packet_cb, (u_char *)pcap_opts);
3122 inpkts = pcap_dispatch(pcap_opts->pcap_h, 1, capture_loop_write_packet_cb, (u_char *)pcap_opts);
3126 inpkts = pcap_dispatch(pcap_opts->pcap_h, -1, capture_loop_queue_packet_cb, (u_char *)pcap_opts);
3128 inpkts = pcap_dispatch(pcap_opts->pcap_h, -1, capture_loop_write_packet_cb, (u_char *)pcap_opts);
3133 /* Error, rather than pcap_breakloop(). */
3134 pcap_opts->pcap_err = TRUE;
3136 ld->go = FALSE; /* error or pcap_breakloop() - stop capturing */
3138 #else /* pcap_next_ex */
3139 #ifdef LOG_CAPTURE_VERBOSE
3140 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_dispatch: from pcap_next_ex");
3142 /* XXX - this is currently unused, as there is some confusion with pcap_next_ex() vs. pcap_dispatch() */
3145 * WinPcap's remote capturing feature doesn't work with pcap_dispatch(),
3146 * see http://wiki.wireshark.org/CaptureSetup_2fWinPcapRemote
3147 * This should be fixed in the WinPcap 4.0 alpha release.
3149 * For reference, an example remote interface:
3150 * rpcap://[1.2.3.4]/\Device\NPF_{39993D68-7C9B-4439-A329-F2D888DA7C5C}
3153 /* emulate dispatch from pcap */
3156 struct pcap_pkthdr *pkt_header;
3161 (in = pcap_next_ex(pcap_opts->pcap_h, &pkt_header, &pkt_data)) == 1) {
3163 capture_loop_queue_packet_cb((u_char *)pcap_opts, pkt_header, pkt_data);
3165 capture_loop_write_packet_cb((u_char *)pcap_opts, pkt_header, pkt_data);
3170 pcap_opts->pcap_err = TRUE;
3174 #endif /* pcap_next_ex */
3178 #ifdef LOG_CAPTURE_VERBOSE
3179 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_dispatch: %d new packet%s", inpkts, plurality(inpkts, "", "s"));
3182 return ld->packet_count - packet_count_before;
3186 /* Isolate the Universally Unique Identifier from the interface. Basically, we
3187 * want to grab only the characters between the '{' and '}' delimiters.
3189 * Returns a GString that must be freed with g_string_free(). */
3191 isolate_uuid(const char *iface)
3196 ptr = strchr(iface, '{');
3198 return g_string_new(iface);
3199 gstr = g_string_new(ptr + 1);
3201 ptr = strchr(gstr->str, '}');
3205 gstr = g_string_truncate(gstr, ptr - gstr->str);
3210 /* open the output file (temporary/specified name/ringbuffer/named pipe/stdout) */
3211 /* Returns TRUE if the file opened successfully, FALSE otherwise. */
3213 capture_loop_open_output(capture_options *capture_opts, int *save_file_fd,
3214 char *errmsg, int errmsg_len)
3217 gchar *capfile_name;
3219 gboolean is_tempfile;
3221 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_open_output: %s",
3222 (capture_opts->save_file) ? capture_opts->save_file : "(not specified)");
3224 if (capture_opts->save_file != NULL) {
3225 /* We return to the caller while the capture is in progress.
3226 * Therefore we need to take a copy of save_file in
3227 * case the caller destroys it after we return.
3229 capfile_name = g_strdup(capture_opts->save_file);
3231 if (capture_opts->output_to_pipe == TRUE) { /* either "-" or named pipe */
3232 if (capture_opts->multi_files_on) {
3233 /* ringbuffer is enabled; that doesn't work with standard output or a named pipe */
3234 g_snprintf(errmsg, errmsg_len,
3235 "Ring buffer requested, but capture is being written to standard output or to a named pipe.");
3236 g_free(capfile_name);
3239 if (strcmp(capfile_name, "-") == 0) {
3240 /* write to stdout */
3243 /* set output pipe to binary mode to avoid Windows text-mode processing (eg: for CR/LF) */
3244 _setmode(1, O_BINARY);
3247 } /* if (...output_to_pipe ... */
3250 if (capture_opts->multi_files_on) {
3251 /* ringbuffer is enabled */
3252 *save_file_fd = ringbuf_init(capfile_name,
3253 (capture_opts->has_ring_num_files) ? capture_opts->ring_num_files : 0,
3254 capture_opts->group_read_access);
3256 /* we need the ringbuf name */
3257 if (*save_file_fd != -1) {
3258 g_free(capfile_name);
3259 capfile_name = g_strdup(ringbuf_current_filename());
3262 /* Try to open/create the specified file for use as a capture buffer. */
3263 *save_file_fd = ws_open(capfile_name, O_RDWR|O_BINARY|O_TRUNC|O_CREAT,
3264 (capture_opts->group_read_access) ? 0640 : 0600);
3267 is_tempfile = FALSE;
3269 /* Choose a random name for the temporary capture buffer */
3270 if (global_capture_opts.ifaces->len > 1) {
3271 prefix = g_strdup_printf("wireshark_%d_interfaces", global_capture_opts.ifaces->len);
3274 basename = g_path_get_basename(g_array_index(global_capture_opts.ifaces, interface_options, 0).console_display_name);
3276 /* use the generic portion of the interface guid to form the basis of the filename */
3277 if (strncmp("NPF_{", basename, 5)==0)
3279 /* we have a windows guid style device name, extract the guid digits as the basis of the filename */
3281 iface = isolate_uuid(basename);
3283 basename = g_strdup(iface->str);
3284 g_string_free(iface, TRUE);
3287 /* generate the temp file name prefix...
3288 * It would be nice if we could specify a pcapng/pcap filename suffix,
3289 * create_tempfile() however currently uses mkstemp() which doesn't allow this - one day perhaps*/
3290 if (capture_opts->use_pcapng) {
3291 prefix = g_strconcat("wireshark_pcapng_", basename, NULL);
3293 prefix = g_strconcat("wireshark_pcap_", basename, NULL);
3297 *save_file_fd = create_tempfile(&tmpname, prefix);
3299 capfile_name = g_strdup(tmpname);
3303 /* did we fail to open the output file? */
3304 if (*save_file_fd == -1) {
3306 g_snprintf(errmsg, errmsg_len,
3307 "The temporary file to which the capture would be saved (\"%s\") "
3308 "could not be opened: %s.", capfile_name, g_strerror(errno));
3310 if (capture_opts->multi_files_on) {
3311 ringbuf_error_cleanup();
3314 g_snprintf(errmsg, errmsg_len,
3315 "The file to which the capture would be saved (\"%s\") "
3316 "could not be opened: %s.", capfile_name,
3319 g_free(capfile_name);
3323 if (capture_opts->save_file != NULL) {
3324 g_free(capture_opts->save_file);
3326 capture_opts->save_file = capfile_name;
3327 /* capture_opts.save_file is "g_free"ed later, which is equivalent to
3328 "g_free(capfile_name)". */
3334 /* Do the work of handling either the file size or file duration capture
3335 conditions being reached, and switching files or stopping. */
3337 do_file_switch_or_stop(capture_options *capture_opts,
3338 condition *cnd_autostop_files,
3339 condition *cnd_autostop_size,
3340 condition *cnd_file_duration)
3343 pcap_options *pcap_opts;
3344 interface_options interface_opts;
3345 gboolean successful;
3347 if (capture_opts->multi_files_on) {
3348 if (cnd_autostop_files != NULL &&
3349 cnd_eval(cnd_autostop_files, ++global_ld.autostop_files)) {
3350 /* no files left: stop here */
3351 global_ld.go = FALSE;
3355 /* Switch to the next ringbuffer file */
3356 if (ringbuf_switch_file(&global_ld.pdh, &capture_opts->save_file,
3357 &global_ld.save_file_fd, &global_ld.err)) {
3359 /* File switch succeeded: reset the conditions */
3360 global_ld.bytes_written = 0;
3361 if (capture_opts->use_pcapng) {
3363 GString *os_info_str;
3365 os_info_str = g_string_new("");
3366 get_os_version_info(os_info_str);
3368 g_snprintf(appname, sizeof(appname), "Dumpcap " VERSION "%s", wireshark_svnversion);
3369 successful = pcapng_write_session_header_block(global_ld.pdh,
3372 os_info_str->str, /* OS */
3374 -1, /* section_length */
3375 &(global_ld.bytes_written),
3378 for (i = 0; successful && (i < capture_opts->ifaces->len); i++) {
3379 interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
3380 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, i);
3381 successful = pcapng_write_interface_description_block(global_ld.pdh,
3382 NULL, /* OPT_COMMENT 1 */
3383 interface_opts.name, /* IDB_NAME 2 */
3384 interface_opts.descr, /* IDB_DESCRIPTION 3 */
3385 interface_opts.cfilter, /* IDB_FILTER 11 */
3386 os_info_str->str, /* IDB_OS 12 */
3387 pcap_opts->linktype,
3389 &(global_ld.bytes_written),
3390 0, /* IDB_IF_SPEED 8 */
3391 pcap_opts->ts_nsec ? 9 : 6, /* IDB_TSRESOL 9 */
3395 g_string_free(os_info_str, TRUE);
3398 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, 0);
3399 successful = libpcap_write_file_header(global_ld.pdh, pcap_opts->linktype, pcap_opts->snaplen,
3400 pcap_opts->ts_nsec, &global_ld.bytes_written, &global_ld.err);
3403 fclose(global_ld.pdh);
3404 global_ld.pdh = NULL;
3405 global_ld.go = FALSE;
3408 if (cnd_autostop_size)
3409 cnd_reset(cnd_autostop_size);
3410 if (cnd_file_duration)
3411 cnd_reset(cnd_file_duration);
3412 fflush(global_ld.pdh);
3414 report_packet_count(global_ld.inpkts_to_sync_pipe);
3415 global_ld.inpkts_to_sync_pipe = 0;
3416 report_new_capture_file(capture_opts->save_file);
3418 /* File switch failed: stop here */
3419 global_ld.go = FALSE;
3423 /* single file, stop now */
3424 global_ld.go = FALSE;
3431 pcap_read_handler(void* arg)
3433 pcap_options *pcap_opts;
3434 char errmsg[MSG_MAX_LENGTH+1];
3436 pcap_opts = (pcap_options *)arg;
3438 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Started thread for interface %d.",
3439 pcap_opts->interface_id);
3441 while (global_ld.go) {
3442 /* dispatch incoming packets */
3443 capture_loop_dispatch(&global_ld, errmsg, sizeof(errmsg), pcap_opts);
3445 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Stopped thread for interface %d.",
3446 pcap_opts->interface_id);
3447 g_thread_exit(NULL);
3451 /* Do the low-level work of a capture.
3452 Returns TRUE if it succeeds, FALSE otherwise. */
3454 capture_loop_start(capture_options *capture_opts, gboolean *stats_known, struct pcap_stat *stats)
3457 DWORD upd_time, cur_time; /* GetTickCount() returns a "DWORD" (which is 'unsigned long') */
3459 struct timeval upd_time, cur_time;
3463 condition *cnd_file_duration = NULL;
3464 condition *cnd_autostop_files = NULL;
3465 condition *cnd_autostop_size = NULL;
3466 condition *cnd_autostop_duration = NULL;
3469 gboolean cfilter_error = FALSE;
3470 char errmsg[MSG_MAX_LENGTH+1];
3471 char secondary_errmsg[MSG_MAX_LENGTH+1];
3472 pcap_options *pcap_opts;
3473 interface_options interface_opts;
3474 guint i, error_index = 0;
3477 *secondary_errmsg = '\0';
3479 /* init the loop data */
3480 global_ld.go = TRUE;
3481 global_ld.packet_count = 0;
3483 global_ld.report_packet_count = FALSE;
3485 if (capture_opts->has_autostop_packets)
3486 global_ld.packet_max = capture_opts->autostop_packets;
3488 global_ld.packet_max = 0; /* no limit */
3489 global_ld.inpkts_to_sync_pipe = 0;
3490 global_ld.err = 0; /* no error seen yet */
3491 global_ld.pdh = NULL;
3492 global_ld.autostop_files = 0;
3493 global_ld.save_file_fd = -1;
3495 /* We haven't yet gotten the capture statistics. */
3496 *stats_known = FALSE;
3498 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Capture loop starting ...");
3499 capture_opts_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, capture_opts);
3501 /* open the "input file" from network interface or capture pipe */
3502 if (!capture_loop_open_input(capture_opts, &global_ld, errmsg, sizeof(errmsg),
3503 secondary_errmsg, sizeof(secondary_errmsg))) {
3506 for (i = 0; i < capture_opts->ifaces->len; i++) {
3507 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, i);
3508 interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
3509 /* init the input filter from the network interface (capture pipe will do nothing) */
3511 * When remote capturing WinPCap crashes when the capture filter
3512 * is NULL. This might be a bug in WPCap. Therefore we provide an empty
3515 switch (capture_loop_init_filter(pcap_opts->pcap_h, pcap_opts->from_cap_pipe,
3516 interface_opts.name,
3517 interface_opts.cfilter?interface_opts.cfilter:"")) {
3519 case INITFILTER_NO_ERROR:
3522 case INITFILTER_BAD_FILTER:
3523 cfilter_error = TRUE;
3525 g_snprintf(errmsg, sizeof(errmsg), "%s", pcap_geterr(pcap_opts->pcap_h));
3528 case INITFILTER_OTHER_ERROR:
3529 g_snprintf(errmsg, sizeof(errmsg), "Can't install filter (%s).",
3530 pcap_geterr(pcap_opts->pcap_h));
3531 g_snprintf(secondary_errmsg, sizeof(secondary_errmsg), "%s", please_report);
3536 /* If we're supposed to write to a capture file, open it for output
3537 (temporary/specified name/ringbuffer) */
3538 if (capture_opts->saving_to_file) {
3539 if (!capture_loop_open_output(capture_opts, &global_ld.save_file_fd,
3540 errmsg, sizeof(errmsg))) {
3544 /* set up to write to the already-opened capture output file/files */
3545 if (!capture_loop_init_output(capture_opts, &global_ld, errmsg,
3550 /* XXX - capture SIGTERM and close the capture, in case we're on a
3551 Linux 2.0[.x] system and you have to explicitly close the capture
3552 stream in order to turn promiscuous mode off? We need to do that
3553 in other places as well - and I don't think that works all the
3554 time in any case, due to libpcap bugs. */
3556 /* Well, we should be able to start capturing.
3558 Sync out the capture file, so the header makes it to the file system,
3559 and send a "capture started successfully and capture file created"
3560 message to our parent so that they'll open the capture file and
3561 update its windows to indicate that we have a live capture in
3563 fflush(global_ld.pdh);
3564 report_new_capture_file(capture_opts->save_file);
3567 /* initialize capture stop (and alike) conditions */
3568 init_capture_stop_conditions();
3569 /* create stop conditions */
3570 if (capture_opts->has_autostop_filesize) {
3571 if (capture_opts->autostop_filesize > (((guint32)INT_MAX + 1) / 1000)) {
3572 capture_opts->autostop_filesize = ((guint32)INT_MAX + 1) / 1000;
3575 cnd_new(CND_CLASS_CAPTURESIZE, (guint64)capture_opts->autostop_filesize * 1000);
3577 if (capture_opts->has_autostop_duration)
3578 cnd_autostop_duration =
3579 cnd_new(CND_CLASS_TIMEOUT,(gint32)capture_opts->autostop_duration);
3581 if (capture_opts->multi_files_on) {
3582 if (capture_opts->has_file_duration)
3584 cnd_new(CND_CLASS_TIMEOUT, capture_opts->file_duration);
3586 if (capture_opts->has_autostop_files)
3587 cnd_autostop_files =
3588 cnd_new(CND_CLASS_CAPTURESIZE, capture_opts->autostop_files);
3591 /* init the time values */
3593 upd_time = GetTickCount();
3595 gettimeofday(&upd_time, NULL);
3597 start_time = create_timestamp();
3598 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Capture loop running!");
3600 /* WOW, everything is prepared! */
3601 /* please fasten your seat belts, we will enter now the actual capture loop */
3603 pcap_queue = g_async_queue_new();
3604 pcap_queue_bytes = 0;
3605 pcap_queue_packets = 0;
3606 for (i = 0; i < global_ld.pcaps->len; i++) {
3607 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, i);
3608 #if GLIB_CHECK_VERSION(2,31,0)
3609 /* XXX - Add an interface name here? */
3610 pcap_opts->tid = g_thread_new("Capture read", pcap_read_handler, pcap_opts);
3612 pcap_opts->tid = g_thread_create(pcap_read_handler, pcap_opts, TRUE, NULL);
3616 while (global_ld.go) {
3617 /* dispatch incoming packets */
3619 pcap_queue_element *queue_element;
3620 #if GLIB_CHECK_VERSION(2,31,18)
3622 g_async_queue_lock(pcap_queue);
3623 queue_element = (pcap_queue_element *)g_async_queue_timeout_pop_unlocked(pcap_queue, WRITER_THREAD_TIMEOUT);
3625 GTimeVal write_thread_time;
3627 g_get_current_time(&write_thread_time);
3628 g_time_val_add(&write_thread_time, WRITER_THREAD_TIMEOUT);
3629 g_async_queue_lock(pcap_queue);
3630 queue_element = (pcap_queue_element *)g_async_queue_timed_pop_unlocked(pcap_queue, &write_thread_time);
3632 if (queue_element) {
3633 pcap_queue_bytes -= queue_element->phdr.caplen;
3634 pcap_queue_packets -= 1;
3636 g_async_queue_unlock(pcap_queue);
3637 if (queue_element) {
3638 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
3639 "Dequeued a packet of length %d captured on interface %d.",
3640 queue_element->phdr.caplen, queue_element->pcap_opts->interface_id);
3642 capture_loop_write_packet_cb((u_char *) queue_element->pcap_opts,
3643 &queue_element->phdr,
3645 g_free(queue_element->pd);
3646 g_free(queue_element);
3652 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, 0);
3653 inpkts = capture_loop_dispatch(&global_ld, errmsg,
3654 sizeof(errmsg), pcap_opts);
3657 /* Were we asked to print packet counts by the SIGINFO handler? */
3658 if (global_ld.report_packet_count) {
3659 fprintf(stderr, "%u packet%s captured\n", global_ld.packet_count,
3660 plurality(global_ld.packet_count, "", "s"));
3661 global_ld.report_packet_count = FALSE;
3666 /* any news from our parent (signal pipe)? -> just stop the capture */
3667 if (!signal_pipe_check_running()) {
3668 global_ld.go = FALSE;
3673 global_ld.inpkts_to_sync_pipe += inpkts;
3675 /* check capture size condition */
3676 if (cnd_autostop_size != NULL &&
3677 cnd_eval(cnd_autostop_size, global_ld.bytes_written)) {
3678 /* Capture size limit reached, do we have another file? */
3679 if (!do_file_switch_or_stop(capture_opts, cnd_autostop_files,
3680 cnd_autostop_size, cnd_file_duration))
3682 } /* cnd_autostop_size */
3683 if (capture_opts->output_to_pipe) {
3684 fflush(global_ld.pdh);
3688 /* Only update once every 500ms so as not to overload slow displays.
3689 * This also prevents too much context-switching between the dumpcap
3690 * and wireshark processes.
3692 #define DUMPCAP_UPD_TIME 500
3695 cur_time = GetTickCount(); /* Note: wraps to 0 if sys runs for 49.7 days */
3696 if ((cur_time - upd_time) > DUMPCAP_UPD_TIME) { /* wrap just causes an extra update */
3698 gettimeofday(&cur_time, NULL);
3699 if (((guint64)cur_time.tv_sec * 1000000 + cur_time.tv_usec) >
3700 ((guint64)upd_time.tv_sec * 1000000 + upd_time.tv_usec + DUMPCAP_UPD_TIME*1000)) {
3703 upd_time = cur_time;
3706 if (pcap_stats(pch, stats) >= 0) {
3707 *stats_known = TRUE;
3710 /* Let the parent process know. */
3711 if (global_ld.inpkts_to_sync_pipe) {
3713 fflush(global_ld.pdh);
3715 /* Send our parent a message saying we've written out
3716 "global_ld.inpkts_to_sync_pipe" packets to the capture file. */
3718 report_packet_count(global_ld.inpkts_to_sync_pipe);
3720 global_ld.inpkts_to_sync_pipe = 0;
3723 /* check capture duration condition */
3724 if (cnd_autostop_duration != NULL && cnd_eval(cnd_autostop_duration)) {
3725 /* The maximum capture time has elapsed; stop the capture. */
3726 global_ld.go = FALSE;
3730 /* check capture file duration condition */
3731 if (cnd_file_duration != NULL && cnd_eval(cnd_file_duration)) {
3732 /* duration limit reached, do we have another file? */
3733 if (!do_file_switch_or_stop(capture_opts, cnd_autostop_files,
3734 cnd_autostop_size, cnd_file_duration))
3736 } /* cnd_file_duration */
3740 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Capture loop stopping ...");
3742 pcap_queue_element *queue_element;
3744 for (i = 0; i < global_ld.pcaps->len; i++) {
3745 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, i);
3746 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Waiting for thread of interface %u...",
3747 pcap_opts->interface_id);
3748 g_thread_join(pcap_opts->tid);
3749 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Thread of interface %u terminated.",
3750 pcap_opts->interface_id);
3753 g_async_queue_lock(pcap_queue);
3754 queue_element = (pcap_queue_element *)g_async_queue_try_pop_unlocked(pcap_queue);
3755 if (queue_element) {
3756 pcap_queue_bytes -= queue_element->phdr.caplen;
3757 pcap_queue_packets -= 1;
3759 g_async_queue_unlock(pcap_queue);
3760 if (queue_element == NULL) {
3763 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
3764 "Dequeued a packet of length %d captured on interface %d.",
3765 queue_element->phdr.caplen, queue_element->pcap_opts->interface_id);
3766 capture_loop_write_packet_cb((u_char *)queue_element->pcap_opts,
3767 &queue_element->phdr,
3769 g_free(queue_element->pd);
3770 g_free(queue_element);
3771 global_ld.inpkts_to_sync_pipe += 1;
3772 if (capture_opts->output_to_pipe) {
3773 fflush(global_ld.pdh);
3779 /* delete stop conditions */
3780 if (cnd_file_duration != NULL)
3781 cnd_delete(cnd_file_duration);
3782 if (cnd_autostop_files != NULL)
3783 cnd_delete(cnd_autostop_files);
3784 if (cnd_autostop_size != NULL)
3785 cnd_delete(cnd_autostop_size);
3786 if (cnd_autostop_duration != NULL)
3787 cnd_delete(cnd_autostop_duration);
3789 /* did we have a pcap (input) error? */
3790 for (i = 0; i < capture_opts->ifaces->len; i++) {
3791 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, i);
3792 if (pcap_opts->pcap_err) {
3793 /* On Linux, if an interface goes down while you're capturing on it,
3794 you'll get a "recvfrom: Network is down" or
3795 "The interface went down" error (ENETDOWN).
3796 (At least you will if g_strerror() doesn't show a local translation
3799 On FreeBSD and OS X, if a network adapter disappears while
3800 you're capturing on it, you'll get a "read: Device not configured"
3801 error (ENXIO). (See previous parenthetical note.)
3803 On OpenBSD, you get "read: I/O error" (EIO) in the same case.
3805 These should *not* be reported to the Wireshark developers. */
3808 cap_err_str = pcap_geterr(pcap_opts->pcap_h);
3809 if (strcmp(cap_err_str, "recvfrom: Network is down") == 0 ||
3810 strcmp(cap_err_str, "The interface went down") == 0 ||
3811 strcmp(cap_err_str, "read: Device not configured") == 0 ||
3812 strcmp(cap_err_str, "read: I/O error") == 0 ||
3813 strcmp(cap_err_str, "read error: PacketReceivePacket failed") == 0) {
3814 report_capture_error("The network adapter on which the capture was being done "
3815 "is no longer running; the capture has stopped.",
3818 g_snprintf(errmsg, sizeof(errmsg), "Error while capturing packets: %s",
3820 report_capture_error(errmsg, please_report);
3823 } else if (pcap_opts->from_cap_pipe && pcap_opts->cap_pipe_err == PIPERR) {
3824 report_capture_error(errmsg, "");
3828 /* did we have an output error while capturing? */
3829 if (global_ld.err == 0) {
3832 capture_loop_get_errmsg(errmsg, sizeof(errmsg), capture_opts->save_file,
3833 global_ld.err, FALSE);
3834 report_capture_error(errmsg, please_report);
3838 if (capture_opts->saving_to_file) {
3839 /* close the output file */
3840 close_ok = capture_loop_close_output(capture_opts, &global_ld, &err_close);
3844 /* there might be packets not yet notified to the parent */
3845 /* (do this after closing the file, so all packets are already flushed) */
3846 if (global_ld.inpkts_to_sync_pipe) {
3848 report_packet_count(global_ld.inpkts_to_sync_pipe);
3849 global_ld.inpkts_to_sync_pipe = 0;
3852 /* If we've displayed a message about a write error, there's no point
3853 in displaying another message about an error on close. */
3854 if (!close_ok && write_ok) {
3855 capture_loop_get_errmsg(errmsg, sizeof(errmsg), capture_opts->save_file, err_close,
3857 report_capture_error(errmsg, "");
3861 * XXX We exhibit different behaviour between normal mode and sync mode
3862 * when the pipe is stdin and not already at EOF. If we're a child, the
3863 * parent's stdin isn't closed, so if the user starts another capture,
3864 * cap_pipe_open_live() will very likely not see the expected magic bytes and
3865 * will say "Unrecognized libpcap format". On the other hand, in normal
3866 * mode, cap_pipe_open_live() will say "End of file on pipe during open".
3869 report_capture_count(TRUE);
3871 /* get packet drop statistics from pcap */
3872 for (i = 0; i < capture_opts->ifaces->len; i++) {
3874 guint32 pcap_dropped = 0;
3876 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, i);
3877 interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
3878 received = pcap_opts->received;
3879 if (pcap_opts->pcap_h != NULL) {
3880 g_assert(!pcap_opts->from_cap_pipe);
3881 /* Get the capture statistics, so we know how many packets were dropped. */
3883 * Older versions of libpcap didn't set ps_ifdrop on some
3884 * platforms; initialize it to 0 to handle that.
3886 stats->ps_ifdrop = 0;
3887 if (pcap_stats(pcap_opts->pcap_h, stats) >= 0) {
3888 *stats_known = TRUE;
3889 /* Let the parent process know. */
3890 pcap_dropped += stats->ps_drop;
3892 g_snprintf(errmsg, sizeof(errmsg),
3893 "Can't get packet-drop statistics: %s",
3894 pcap_geterr(pcap_opts->pcap_h));
3895 report_capture_error(errmsg, please_report);
3898 report_packet_drops(received, pcap_dropped, pcap_opts->dropped, pcap_opts->flushed, stats->ps_ifdrop, interface_opts.console_display_name);
3901 /* close the input file (pcap or capture pipe) */
3902 capture_loop_close_input(&global_ld);
3904 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Capture loop stopped!");
3906 /* ok, if the write and the close were successful. */
3907 return write_ok && close_ok;
3910 if (capture_opts->multi_files_on) {
3911 /* cleanup ringbuffer */
3912 ringbuf_error_cleanup();
3914 /* We can't use the save file, and we have no FILE * for the stream
3915 to close in order to close it, so close the FD directly. */
3916 if (global_ld.save_file_fd != -1) {
3917 ws_close(global_ld.save_file_fd);
3920 /* We couldn't even start the capture, so get rid of the capture
3922 if (capture_opts->save_file != NULL) {
3923 ws_unlink(capture_opts->save_file);
3924 g_free(capture_opts->save_file);
3927 capture_opts->save_file = NULL;
3929 report_cfilter_error(capture_opts, error_index, errmsg);
3931 report_capture_error(errmsg, secondary_errmsg);
3933 /* close the input file (pcap or cap_pipe) */
3934 capture_loop_close_input(&global_ld);
3936 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Capture loop stopped with error");
3943 capture_loop_stop(void)
3945 #ifdef HAVE_PCAP_BREAKLOOP
3947 pcap_options *pcap_opts;
3949 for (i = 0; i < global_ld.pcaps->len; i++) {
3950 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, i);
3951 if (pcap_opts->pcap_h != NULL)
3952 pcap_breakloop(pcap_opts->pcap_h);
3955 global_ld.go = FALSE;
3960 capture_loop_get_errmsg(char *errmsg, int errmsglen, const char *fname,
3961 int err, gboolean is_close)
3966 g_snprintf(errmsg, errmsglen,
3967 "Not all the packets could be written to the file"
3968 " to which the capture was being saved\n"
3969 "(\"%s\") because there is no space left on the file system\n"
3970 "on which that file resides.",
3976 g_snprintf(errmsg, errmsglen,
3977 "Not all the packets could be written to the file"
3978 " to which the capture was being saved\n"
3979 "(\"%s\") because you are too close to, or over,"
3980 " your disk quota\n"
3981 "on the file system on which that file resides.",
3988 g_snprintf(errmsg, errmsglen,
3989 "The file to which the capture was being saved\n"
3990 "(\"%s\") could not be closed: %s.",
3991 fname, g_strerror(err));
3993 g_snprintf(errmsg, errmsglen,
3994 "An error occurred while writing to the file"
3995 " to which the capture was being saved\n"
3997 fname, g_strerror(err));
4004 /* one packet was captured, process it */
4006 capture_loop_write_packet_cb(u_char *pcap_opts_p, const struct pcap_pkthdr *phdr,
4009 pcap_options *pcap_opts = (pcap_options *) (void *) pcap_opts_p;
4011 guint ts_mul = pcap_opts->ts_nsec ? 1000000000 : 1000000;
4013 /* We may be called multiple times from pcap_dispatch(); if we've set
4014 the "stop capturing" flag, ignore this packet, as we're not
4015 supposed to be saving any more packets. */
4016 if (!global_ld.go) {
4017 pcap_opts->flushed++;
4021 if (global_ld.pdh) {
4022 gboolean successful;
4024 /* We're supposed to write the packet to a file; do so.
4025 If this fails, set "ld->go" to FALSE, to stop the capture, and set
4026 "ld->err" to the error. */
4027 if (global_capture_opts.use_pcapng) {
4028 successful = pcapng_write_enhanced_packet_block(global_ld.pdh,
4030 phdr->ts.tv_sec, (gint32)phdr->ts.tv_usec,
4031 phdr->caplen, phdr->len,
4032 pcap_opts->interface_id,
4035 &global_ld.bytes_written, &err);
4037 successful = libpcap_write_packet(global_ld.pdh,
4038 phdr->ts.tv_sec, (gint32)phdr->ts.tv_usec,
4039 phdr->caplen, phdr->len,
4041 &global_ld.bytes_written, &err);
4044 global_ld.go = FALSE;
4045 global_ld.err = err;
4046 pcap_opts->dropped++;
4048 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
4049 "Wrote a packet of length %d captured on interface %u.",
4050 phdr->caplen, pcap_opts->interface_id);
4051 global_ld.packet_count++;
4052 pcap_opts->received++;
4053 /* if the user told us to stop after x packets, do we already have enough? */
4054 if ((global_ld.packet_max > 0) && (global_ld.packet_count >= global_ld.packet_max)) {
4055 global_ld.go = FALSE;
4061 /* one packet was captured, queue it */
4063 capture_loop_queue_packet_cb(u_char *pcap_opts_p, const struct pcap_pkthdr *phdr,
4066 pcap_options *pcap_opts = (pcap_options *) (void *) pcap_opts_p;
4067 pcap_queue_element *queue_element;
4068 gboolean limit_reached;
4070 /* We may be called multiple times from pcap_dispatch(); if we've set
4071 the "stop capturing" flag, ignore this packet, as we're not
4072 supposed to be saving any more packets. */
4073 if (!global_ld.go) {
4074 pcap_opts->flushed++;
4078 queue_element = (pcap_queue_element *)g_malloc(sizeof(pcap_queue_element));
4079 if (queue_element == NULL) {
4080 pcap_opts->dropped++;
4083 queue_element->pcap_opts = pcap_opts;
4084 queue_element->phdr = *phdr;
4085 queue_element->pd = (u_char *)g_malloc(phdr->caplen);
4086 if (queue_element->pd == NULL) {
4087 pcap_opts->dropped++;
4088 g_free(queue_element);
4091 memcpy(queue_element->pd, pd, phdr->caplen);
4092 g_async_queue_lock(pcap_queue);
4093 if (((pcap_queue_byte_limit == 0) || (pcap_queue_bytes < pcap_queue_byte_limit)) &&
4094 ((pcap_queue_packet_limit == 0) || (pcap_queue_packets < pcap_queue_packet_limit))) {
4095 limit_reached = FALSE;
4096 g_async_queue_push_unlocked(pcap_queue, queue_element);
4097 pcap_queue_bytes += phdr->caplen;
4098 pcap_queue_packets += 1;
4100 limit_reached = TRUE;
4102 g_async_queue_unlock(pcap_queue);
4103 if (limit_reached) {
4104 pcap_opts->dropped++;
4105 g_free(queue_element->pd);
4106 g_free(queue_element);
4107 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
4108 "Dropped a packet of length %d captured on interface %u.",
4109 phdr->caplen, pcap_opts->interface_id);
4111 pcap_opts->received++;
4112 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
4113 "Queued a packet of length %d captured on interface %u.",
4114 phdr->caplen, pcap_opts->interface_id);
4116 /* I don't want to hold the mutex over the debug output. So the
4117 output may be wrong */
4118 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
4119 "Queue size is now %" G_GINT64_MODIFIER "d bytes (%" G_GINT64_MODIFIER "d packets)",
4120 pcap_queue_bytes, pcap_queue_packets);
4124 set_80211_channel(const char *iface, const char *opt)
4126 int freq = 0, type, ret;
4127 gchar **options = NULL;
4129 options = g_strsplit_set(opt, ",", 2);
4132 freq = atoi(options[0]);
4135 type = ws80211_str_to_chan_type(options[1]);
4144 ret = ws80211_init();
4146 cmdarg_err("%d: Failed to init ws80211: %s\n", abs(ret), g_strerror(abs(ret)));
4150 ret = ws80211_set_freq(iface, freq, type);
4153 cmdarg_err("%d: Failed to set channel: %s\n", abs(ret), g_strerror(abs(ret)));
4159 pipe_write_block(2, SP_SUCCESS, NULL);
4163 g_strfreev(options);
4167 /* And now our feature presentation... [ fade to music ] */
4169 main(int argc, char *argv[])
4171 GString *comp_info_str;
4172 GString *runtime_info_str;
4174 struct option long_options[] = {
4175 {(char *)"capture-comment", required_argument, NULL, LONGOPT_NUM_CAP_COMMENT },
4179 gboolean arg_error = FALSE;
4184 struct sigaction action, oldaction;
4187 gboolean start_capture = TRUE;
4188 gboolean stats_known;
4189 struct pcap_stat stats;
4190 GLogLevelFlags log_flags;
4191 gboolean list_interfaces = FALSE;
4192 gboolean list_link_layer_types = FALSE;
4193 #ifdef HAVE_BPF_IMAGE
4194 gboolean print_bpf_code = FALSE;
4196 gboolean set_chan = FALSE;
4197 gchar *set_chan_arg = NULL;
4198 gboolean machine_readable = FALSE;
4199 gboolean print_statistics = FALSE;
4200 int status, run_once_args = 0;
4203 #if defined(__APPLE__) && defined(__LP64__)
4204 struct utsname osinfo;
4208 /* Assemble the compile-time version information string */
4209 comp_info_str = g_string_new("Compiled ");
4210 get_compiled_version_info(comp_info_str, NULL, NULL);
4212 /* Assemble the run-time version information string */
4213 runtime_info_str = g_string_new("Running ");
4214 get_runtime_version_info(runtime_info_str, NULL);
4216 /* Add it to the information to be reported on a crash. */
4217 ws_add_crash_info("Dumpcap " VERSION "%s\n"
4222 wireshark_svnversion, comp_info_str->str, runtime_info_str->str);
4225 arg_list_utf_16to8(argc, argv);
4226 create_app_running_mutex();
4229 * Initialize our DLL search path. MUST be called before LoadLibrary
4232 ws_init_dll_search_path();
4235 #ifdef HAVE_PCAP_REMOTE
4236 #define OPTSTRING_A "A:"
4237 #define OPTSTRING_r "r"
4238 #define OPTSTRING_u "u"
4240 #define OPTSTRING_A ""
4241 #define OPTSTRING_r ""
4242 #define OPTSTRING_u ""
4245 #ifdef HAVE_PCAP_SETSAMPLING
4246 #define OPTSTRING_m "m:"
4248 #define OPTSTRING_m ""
4251 #if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
4252 #define OPTSTRING_B "B:"
4254 #define OPTSTRING_B ""
4255 #endif /* _WIN32 or HAVE_PCAP_CREATE */
4257 #ifdef HAVE_PCAP_CREATE
4258 #define OPTSTRING_I "I"
4260 #define OPTSTRING_I ""
4263 #ifdef HAVE_BPF_IMAGE
4264 #define OPTSTRING_d "d"
4266 #define OPTSTRING_d ""
4269 #define OPTSTRING "a:" OPTSTRING_A "b:" OPTSTRING_B "C:c:" OPTSTRING_d "Df:ghi:" OPTSTRING_I "k:L" OPTSTRING_m "MN:npPq" OPTSTRING_r "Ss:t" OPTSTRING_u "vw:y:Z:"
4271 #ifdef DEBUG_CHILD_DUMPCAP
4272 if ((debug_log = ws_fopen("dumpcap_debug_log.tmp","w")) == NULL) {
4273 fprintf (stderr, "Unable to open debug log file !\n");
4278 #if defined(__APPLE__) && defined(__LP64__)
4280 * Is this Mac OS X 10.6.0, 10.6.1, 10.6.3, or 10.6.4? If so, we need
4281 * a bug workaround - timeouts less than 1 second don't work with libpcap
4282 * in 64-bit code. (The bug was introduced in 10.6, fixed in 10.6.2,
4283 * re-introduced in 10.6.3, not fixed in 10.6.4, and fixed in 10.6.5.
4284 * The problem is extremely unlikely to be reintroduced in a future
4287 if (uname(&osinfo) == 0) {
4289 * Mac OS X 10.x uses Darwin {x+4}.0.0. Mac OS X 10.x.y uses Darwin
4290 * {x+4}.y.0 (except that 10.6.1 appears to have a uname version
4291 * number of 10.0.0, not 10.1.0 - go figure).
4293 if (strcmp(osinfo.release, "10.0.0") == 0 || /* 10.6, 10.6.1 */
4294 strcmp(osinfo.release, "10.3.0") == 0 || /* 10.6.3 */
4295 strcmp(osinfo.release, "10.4.0") == 0) /* 10.6.4 */
4296 need_timeout_workaround = TRUE;
4301 * Determine if dumpcap is being requested to run in a special
4302 * capture_child mode by going thru the command line args to see if
4303 * a -Z is present. (-Z is a hidden option).
4305 * The primary result of running in capture_child mode is that
4306 * all messages sent out on stderr are in a special type/len/string
4307 * format to allow message processing by type. These messages include
4308 * error messages if dumpcap fails to start the operation it was
4309 * requested to do, as well as various "status" messages which are sent
4310 * when an actual capture is in progress, and a "success" message sent
4311 * if dumpcap was requested to perform an operation other than a
4314 * Capture_child mode would normally be requested by a parent process
4315 * which invokes dumpcap and obtains dumpcap stderr output via a pipe
4316 * to which dumpcap stderr has been redirected. It might also have
4317 * another pipe to obtain dumpcap stdout output; for operations other
4318 * than a capture, that information is formatted specially for easier
4319 * parsing by the parent process.
4321 * Capture_child mode needs to be determined immediately upon
4322 * startup so that any messages generated by dumpcap in this mode
4323 * (eg: during initialization) will be formatted properly.
4326 for (i=1; i<argc; i++) {
4327 if (strcmp("-Z", argv[i]) == 0) {
4328 capture_child = TRUE;
4329 machine_readable = TRUE; /* request machine-readable output */
4331 /* set output pipe to binary mode, to avoid ugly text conversions */
4332 _setmode(2, O_BINARY);
4337 /* The default_log_handler will use stdout, which makes trouble in */
4338 /* capture child mode, as it uses stdout for its sync_pipe. */
4339 /* So: the filtering is done in the console_log_handler and not here.*/
4340 /* We set the log handlers right up front to make sure that any log */
4341 /* messages when running as child will be sent back to the parent */
4342 /* with the correct format. */
4347 G_LOG_LEVEL_CRITICAL|
4348 G_LOG_LEVEL_WARNING|
4349 G_LOG_LEVEL_MESSAGE|
4353 G_LOG_FLAG_RECURSION);
4355 g_log_set_handler(NULL,
4357 console_log_handler, NULL /* user_data */);
4358 g_log_set_handler(LOG_DOMAIN_MAIN,
4360 console_log_handler, NULL /* user_data */);
4361 g_log_set_handler(LOG_DOMAIN_CAPTURE,
4363 console_log_handler, NULL /* user_data */);
4364 g_log_set_handler(LOG_DOMAIN_CAPTURE_CHILD,
4366 console_log_handler, NULL /* user_data */);
4368 /* Initialize the pcaps list */
4369 global_ld.pcaps = g_array_new(FALSE, FALSE, sizeof(pcap_options *));
4371 #if !GLIB_CHECK_VERSION(2,31,0)
4372 /* Initialize the thread system */
4373 g_thread_init(NULL);
4377 /* Load wpcap if possible. Do this before collecting the run-time version information */
4380 /* ... and also load the packet.dll from wpcap */
4381 /* XXX - currently not required, may change later. */
4382 /*wpcap_packet_load();*/
4384 /* Start windows sockets */
4385 WSAStartup( MAKEWORD( 1, 1 ), &wsaData );
4387 /* Set handler for Ctrl+C key */
4388 SetConsoleCtrlHandler(capture_cleanup_handler, TRUE);
4390 /* Catch SIGINT and SIGTERM and, if we get either of them, clean up
4391 and exit. Do the same with SIGPIPE, in case, for example,
4392 we're writing to our standard output and it's a pipe.
4393 Do the same with SIGHUP if it's not being ignored (if we're
4394 being run under nohup, it might be ignored, in which case we
4395 should leave it ignored).
4397 XXX - apparently, Coverity complained that part of action
4398 wasn't initialized. Perhaps it's running on Linux, where
4399 struct sigaction has an ignored "sa_restorer" element and
4400 where "sa_handler" and "sa_sigaction" might not be two
4401 members of a union. */
4402 memset(&action, 0, sizeof(action));
4403 action.sa_handler = capture_cleanup_handler;
4405 * Arrange that system calls not get restarted, because when
4406 * our signal handler returns we don't want to restart
4407 * a call that was waiting for packets to arrive.
4409 action.sa_flags = 0;
4410 sigemptyset(&action.sa_mask);
4411 sigaction(SIGTERM, &action, NULL);
4412 sigaction(SIGINT, &action, NULL);
4413 sigaction(SIGPIPE, &action, NULL);
4414 sigaction(SIGHUP, NULL, &oldaction);
4415 if (oldaction.sa_handler == SIG_DFL)
4416 sigaction(SIGHUP, &action, NULL);
4419 /* Catch SIGINFO and, if we get it and we're capturing in
4420 quiet mode, report the number of packets we've captured. */
4421 action.sa_handler = report_counts_siginfo;
4422 action.sa_flags = SA_RESTART;
4423 sigemptyset(&action.sa_mask);
4424 sigaction(SIGINFO, &action, NULL);
4425 #endif /* SIGINFO */
4429 enable_kernel_bpf_jit_compiler();
4432 /* ----------------------------------------------------------------- */
4433 /* Privilege and capability handling */
4435 /* 1. Running not as root or suid root; no special capabilities. */
4438 /* 2. Running logged in as root (euid=0; ruid=0); Not using libcap. */
4441 /* 3. Running logged in as root (euid=0; ruid=0). Using libcap. */
4443 /* - Near start of program: Enable NET_RAW and NET_ADMIN */
4444 /* capabilities; Drop all other capabilities; */
4445 /* - If not -w (ie: doing -S or -D, etc) run to completion; */
4446 /* else: after pcap_open_live() in capture_loop_open_input() */
4447 /* drop all capabilities (NET_RAW and NET_ADMIN); */
4448 /* (Note: this means that the process, although logged in */
4449 /* as root, does not have various permissions such as the */
4450 /* ability to bypass file access permissions). */
4451 /* XXX: Should we just leave capabilities alone in this case */
4452 /* so that user gets expected effect that root can do */
4455 /* 4. Running as suid root (euid=0, ruid=n); Not using libcap. */
4457 /* - If not -w (ie: doing -S or -D, etc) run to completion; */
4458 /* else: after pcap_open_live() in capture_loop_open_input() */
4459 /* drop suid root (set euid=ruid).(ie: keep suid until after */
4460 /* pcap_open_live). */
4462 /* 5. Running as suid root (euid=0, ruid=n); Using libcap. */
4464 /* - Near start of program: Enable NET_RAW and NET_ADMIN */
4465 /* capabilities; Drop all other capabilities; */
4466 /* Drop suid privileges (euid=ruid); */
4467 /* - If not -w (ie: doing -S or -D, etc) run to completion; */
4468 /* else: after pcap_open_live() in capture_loop_open_input() */
4469 /* drop all capabilities (NET_RAW and NET_ADMIN). */
4471 /* XXX: For some Linux versions/distros with capabilities */
4472 /* a 'normal' process with any capabilities cannot be */
4473 /* 'killed' (signaled) from another (same uid) non-privileged */
4475 /* For example: If (non-suid) Wireshark forks a */
4476 /* child suid dumpcap which acts as described here (case 5), */
4477 /* Wireshark will be unable to kill (signal) the child */
4478 /* dumpcap process until the capabilities have been dropped */
4479 /* (after pcap_open_live()). */
4480 /* This behaviour will apparently be changed in the kernel */
4481 /* to allow the kill (signal) in this case. */
4482 /* See the following for details: */
4483 /* http://www.mail-archive.com/ [wrapped] */
4484 /* linux-security-module@vger.kernel.org/msg02913.html */
4486 /* It is therefore conceivable that if dumpcap somehow hangs */
4487 /* in pcap_open_live or before that wireshark will not */
4488 /* be able to stop dumpcap using a signal (INT, TERM, etc). */
4489 /* In this case, exiting wireshark will kill the child */
4490 /* dumpcap process. */
4492 /* 6. Not root or suid root; Running with NET_RAW & NET_ADMIN */
4493 /* capabilities; Using libcap. Note: capset cmd (which see) */
4494 /* used to assign capabilities to file. */
4496 /* - If not -w (ie: doing -S or -D, etc) run to completion; */
4497 /* else: after pcap_open_live() in capture_loop_open_input() */
4498 /* drop all capabilities (NET_RAW and NET_ADMIN) */
4500 /* ToDo: -S (stats) should drop privileges/capabilities when no */
4501 /* longer required (similar to capture). */
4503 /* ----------------------------------------------------------------- */
4505 init_process_policies();
4508 /* If 'started with special privileges' (and using libcap) */
4509 /* Set to keep only NET_RAW and NET_ADMIN capabilities; */
4510 /* Set euid/egid = ruid/rgid to remove suid privileges */
4511 relinquish_privs_except_capture();
4514 /* Set the initial values in the capture options. This might be overwritten
4515 by the command line parameters. */
4516 capture_opts_init(&global_capture_opts);
4518 /* We always save to a file - if no file was specified, we save to a
4520 global_capture_opts.saving_to_file = TRUE;
4521 global_capture_opts.has_ring_num_files = TRUE;
4523 /* Pass on capture_child mode for capture_opts */
4524 global_capture_opts.capture_child = capture_child;
4526 /* Now get our args */
4527 while ((opt = getopt_long(argc, argv, OPTSTRING, long_options, NULL)) != -1) {
4529 case 'h': /* Print help and exit */
4533 case 'v': /* Show version and exit */
4535 show_version(comp_info_str, runtime_info_str);
4536 g_string_free(comp_info_str, TRUE);
4537 g_string_free(runtime_info_str, TRUE);
4541 /*** capture option specific ***/
4542 case 'a': /* autostop criteria */
4543 case 'b': /* Ringbuffer option */
4544 case 'c': /* Capture x packets */
4545 case 'f': /* capture filter */
4546 case 'g': /* enable group read access on file(s) */
4547 case 'i': /* Use interface x */
4548 case 'n': /* Use pcapng format */
4549 case 'p': /* Don't capture in promiscuous mode */
4550 case 'P': /* Use pcap format */
4551 case 's': /* Set the snapshot (capture) length */
4552 case 'w': /* Write to capture file x */
4553 case 'y': /* Set the pcap data link type */
4554 case LONGOPT_NUM_CAP_COMMENT: /* add a capture comment */
4555 #ifdef HAVE_PCAP_REMOTE
4556 case 'u': /* Use UDP for data transfer */
4557 case 'r': /* Capture own RPCAP traffic too */
4558 case 'A': /* Authentication */
4560 #ifdef HAVE_PCAP_SETSAMPLING
4561 case 'm': /* Sampling */
4563 #if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
4564 case 'B': /* Buffer size */
4565 #endif /* _WIN32 or HAVE_PCAP_CREATE */
4566 #ifdef HAVE_PCAP_CREATE
4567 case 'I': /* Monitor mode */
4569 status = capture_opts_add_opt(&global_capture_opts, opt, optarg, &start_capture);
4574 /*** hidden option: Wireshark child mode (using binary output messages) ***/
4576 capture_child = TRUE;
4578 /* set output pipe to binary mode, to avoid ugly text conversions */
4579 _setmode(2, O_BINARY);
4581 * optarg = the control ID, aka the PPID, currently used for the
4584 if (strcmp(optarg, SIGNAL_PIPE_CTRL_ID_NONE) != 0) {
4585 sig_pipe_name = g_strdup_printf(SIGNAL_PIPE_FORMAT, optarg);
4586 sig_pipe_handle = CreateFile(utf_8to16(sig_pipe_name),
4587 GENERIC_READ, 0, NULL, OPEN_EXISTING, 0, NULL);
4589 if (sig_pipe_handle == INVALID_HANDLE_VALUE) {
4590 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
4591 "Signal pipe: Unable to open %s. Dead parent?",
4599 case 'q': /* Quiet */
4605 /*** all non capture option specific ***/
4606 case 'D': /* Print a list of capture devices and exit */
4607 list_interfaces = TRUE;
4610 case 'L': /* Print list of link-layer types and exit */
4611 list_link_layer_types = TRUE;
4614 #ifdef HAVE_BPF_IMAGE
4615 case 'd': /* Print BPF code for capture filter and exit */
4616 print_bpf_code = TRUE;
4620 case 'S': /* Print interface statistics once a second */
4621 print_statistics = TRUE;
4624 case 'k': /* Set wireless channel */
4626 set_chan_arg = optarg;
4629 case 'M': /* For -D, -L, and -S, print machine-readable output */
4630 machine_readable = TRUE;
4633 pcap_queue_byte_limit = get_positive_int(optarg, "byte_limit");
4636 pcap_queue_packet_limit = get_positive_int(optarg, "packet_limit");
4639 cmdarg_err("Invalid Option: %s", argv[optind-1]);
4641 case '?': /* Bad flag - print usage message */
4650 /* user specified file name as regular command-line argument */
4651 /* XXX - use it as the capture file name (or something else)? */
4657 * Extra command line arguments were specified; complain.
4658 * XXX - interpret as capture filter, as tcpdump and tshark do?
4660 cmdarg_err("Invalid argument: %s", argv[0]);
4665 if ((pcap_queue_byte_limit > 0) || (pcap_queue_packet_limit > 0)) {
4668 if ((pcap_queue_byte_limit == 0) && (pcap_queue_packet_limit == 0)) {
4669 /* Use some default if the user hasn't specified some */
4670 /* XXX: Are these defaults good enough? */
4671 pcap_queue_byte_limit = 1000 * 1000;
4672 pcap_queue_packet_limit = 1000;
4679 if (run_once_args > 1) {
4680 cmdarg_err("Only one of -D, -L, or -S may be supplied.");
4682 } else if (run_once_args == 1) {
4683 /* We're supposed to print some information, rather than
4684 to capture traffic; did they specify a ring buffer option? */
4685 if (global_capture_opts.multi_files_on) {
4686 cmdarg_err("Ring buffer requested, but a capture isn't being done.");
4690 /* We're supposed to capture traffic; */
4692 /* Are we capturing on multiple interface? If so, use threads and pcapng. */
4693 if (global_capture_opts.ifaces->len > 1) {
4695 global_capture_opts.use_pcapng = TRUE;
4698 if (global_capture_opts.capture_comment &&
4699 (!global_capture_opts.use_pcapng || global_capture_opts.multi_files_on)) {
4700 /* XXX - for ringbuffer, should we apply the comment to each file? */
4701 cmdarg_err("A capture comment can only be set if we capture into a single pcapng file.");
4705 /* Was the ring buffer option specified and, if so, does it make sense? */
4706 if (global_capture_opts.multi_files_on) {
4707 /* Ring buffer works only under certain conditions:
4708 a) ring buffer does not work with temporary files;
4709 b) it makes no sense to enable the ring buffer if the maximum
4710 file size is set to "infinite". */
4711 if (global_capture_opts.save_file == NULL) {
4712 cmdarg_err("Ring buffer requested, but capture isn't being saved to a permanent file.");
4713 global_capture_opts.multi_files_on = FALSE;
4715 if (!global_capture_opts.has_autostop_filesize && !global_capture_opts.has_file_duration) {
4716 cmdarg_err("Ring buffer requested, but no maximum capture file size or duration were specified.");
4718 /* XXX - this must be redesigned as the conditions changed */
4719 global_capture_opts.multi_files_on = FALSE;
4726 * "-D" requires no interface to be selected; it's supposed to list
4729 if (list_interfaces) {
4730 /* Get the list of interfaces */
4735 if_list = capture_interface_list(&err, &err_str,NULL);
4736 if (if_list == NULL) {
4738 case CANT_GET_INTERFACE_LIST:
4739 case DONT_HAVE_PCAP:
4740 cmdarg_err("%s", err_str);
4745 case NO_INTERFACES_FOUND:
4747 * If we're being run by another program, just give them
4748 * an empty list of interfaces, don't report this as
4749 * an error; that lets them decide whether to report
4750 * this as an error or not.
4752 if (!machine_readable) {
4753 cmdarg_err("There are no interfaces on which a capture can be done");
4760 if (machine_readable) /* tab-separated values to stdout */
4761 print_machine_readable_interfaces(if_list);
4763 capture_opts_print_interfaces(if_list);
4764 free_interface_list(if_list);
4769 * "-S" requires no interface to be selected; it gives statistics
4770 * for all interfaces.
4772 if (print_statistics) {
4773 status = print_statistics_loop(machine_readable);
4778 interface_options interface_opts;
4780 if (global_capture_opts.ifaces->len != 1) {
4781 cmdarg_err("Need one interface");
4785 interface_opts = g_array_index(global_capture_opts.ifaces, interface_options, 0);
4786 status = set_80211_channel(interface_opts.name, set_chan_arg);
4791 * "-L", "-d", and capturing act on a particular interface, so we have to
4792 * have an interface; if none was specified, pick a default.
4794 status = capture_opts_default_iface_if_necessary(&global_capture_opts, NULL);
4796 /* cmdarg_err() already called .... */
4800 /* Let the user know what interfaces were chosen. */
4801 if (capture_child) {
4802 for (j = 0; j < global_capture_opts.ifaces->len; j++) {
4803 interface_options interface_opts;
4805 interface_opts = g_array_index(global_capture_opts.ifaces, interface_options, j);
4806 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "Interface: %s\n",
4807 interface_opts.name);
4810 str = g_string_new("");
4812 if (global_capture_opts.ifaces->len < 2)
4814 if (global_capture_opts.ifaces->len < 4)
4817 for (j = 0; j < global_capture_opts.ifaces->len; j++) {
4818 interface_options interface_opts;
4820 interface_opts = g_array_index(global_capture_opts.ifaces, interface_options, j);
4822 if (global_capture_opts.ifaces->len > 2) {
4823 g_string_append_printf(str, ",");
4825 g_string_append_printf(str, " ");
4826 if (j == global_capture_opts.ifaces->len - 1) {
4827 g_string_append_printf(str, "and ");
4830 g_string_append_printf(str, "'%s'", interface_opts.console_display_name);
4833 g_string_append_printf(str, "%u interfaces", global_capture_opts.ifaces->len);
4835 fprintf(stderr, "Capturing on %s\n", str->str);
4836 g_string_free(str, TRUE);
4839 if (list_link_layer_types) {
4840 /* Get the list of link-layer types for the capture device. */
4841 if_capabilities_t *caps;
4845 for (ii = 0; ii < global_capture_opts.ifaces->len; ii++) {
4846 interface_options interface_opts;
4848 interface_opts = g_array_index(global_capture_opts.ifaces, interface_options, ii);
4849 caps = get_if_capabilities(interface_opts.name,
4850 interface_opts.monitor_mode, &err_str);
4852 cmdarg_err("The capabilities of the capture device \"%s\" could not be obtained (%s).\n"
4853 "Please check to make sure you have sufficient permissions, and that\n"
4854 "you have the proper interface or pipe specified.", interface_opts.name, err_str);
4858 if (caps->data_link_types == NULL) {
4859 cmdarg_err("The capture device \"%s\" has no data link types.", interface_opts.name);
4862 if (machine_readable) /* tab-separated values to stdout */
4863 /* XXX: We need to change the format and adopt consumers */
4864 print_machine_readable_if_capabilities(caps);
4866 /* XXX: We might want to print also the interface name */
4867 capture_opts_print_if_capabilities(caps, interface_opts.name,
4868 interface_opts.monitor_mode);
4869 free_if_capabilities(caps);
4874 /* We're supposed to do a capture, or print the BPF code for a filter.
4875 Process the snapshot length, as that affects the generated BPF code. */
4876 capture_opts_trim_snaplen(&global_capture_opts, MIN_PACKET_SIZE);
4878 #ifdef HAVE_BPF_IMAGE
4879 if (print_bpf_code) {
4880 show_filter_code(&global_capture_opts);
4885 /* We're supposed to do a capture. Process the ring buffer arguments. */
4886 capture_opts_trim_ring_num_files(&global_capture_opts);
4888 /* flush stderr prior to starting the main capture loop */
4891 /* Now start the capture. */
4893 if (capture_loop_start(&global_capture_opts, &stats_known, &stats) == TRUE) {
4897 /* capture failed */
4900 return 0; /* never here, make compiler happy */
4905 console_log_handler(const char *log_domain, GLogLevelFlags log_level,
4906 const char *message, gpointer user_data _U_)
4913 /* ignore log message, if log_level isn't interesting */
4914 if ( !(log_level & G_LOG_LEVEL_MASK & ~(G_LOG_LEVEL_DEBUG|G_LOG_LEVEL_INFO))) {
4915 #if !defined(DEBUG_DUMPCAP) && !defined(DEBUG_CHILD_DUMPCAP)
4920 /* create a "timestamp" */
4922 today = localtime(&curr);
4924 switch(log_level & G_LOG_LEVEL_MASK) {
4925 case G_LOG_LEVEL_ERROR:
4928 case G_LOG_LEVEL_CRITICAL:
4931 case G_LOG_LEVEL_WARNING:
4934 case G_LOG_LEVEL_MESSAGE:
4937 case G_LOG_LEVEL_INFO:
4940 case G_LOG_LEVEL_DEBUG:
4944 fprintf(stderr, "unknown log_level %u\n", log_level);
4946 g_assert_not_reached();
4949 /* Generate the output message */
4950 if (log_level & G_LOG_LEVEL_MESSAGE) {
4951 /* normal user messages without additional infos */
4952 msg = g_strdup_printf("%s\n", message);
4954 /* info/debug messages with additional infos */
4955 msg = g_strdup_printf("%02u:%02u:%02u %8s %s %s\n",
4956 today->tm_hour, today->tm_min, today->tm_sec,
4957 log_domain != NULL ? log_domain : "",
4961 /* DEBUG & INFO msgs (if we're debugging today) */
4962 #if defined(DEBUG_DUMPCAP) || defined(DEBUG_CHILD_DUMPCAP)
4963 if ( !(log_level & G_LOG_LEVEL_MASK & ~(G_LOG_LEVEL_DEBUG|G_LOG_LEVEL_INFO))) {
4964 #ifdef DEBUG_DUMPCAP
4965 fprintf(stderr, "%s", msg);
4968 #ifdef DEBUG_CHILD_DUMPCAP
4969 fprintf(debug_log, "%s", msg);
4977 /* ERROR, CRITICAL, WARNING, MESSAGE messages goto stderr or */
4978 /* to parent especially formatted if dumpcap running as child. */
4979 if (capture_child) {
4980 sync_pipe_errmsg_to_parent(2, msg, "");
4982 fprintf(stderr, "%s", msg);
4989 /****************************************************************************************************************/
4990 /* indication report routines */
4994 report_packet_count(unsigned int packet_count)
4996 char tmp[SP_DECISIZE+1+1];
4997 static unsigned int count = 0;
4999 if (capture_child) {
5000 g_snprintf(tmp, sizeof(tmp), "%u", packet_count);
5001 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "Packets: %s", tmp);
5002 pipe_write_block(2, SP_PACKET_COUNT, tmp);
5004 count += packet_count;
5005 fprintf(stderr, "\rPackets: %u ", count);
5006 /* stderr could be line buffered */
5012 report_new_capture_file(const char *filename)
5014 if (capture_child) {
5015 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "File: %s", filename);
5016 pipe_write_block(2, SP_FILE, filename);
5020 * Prevent a SIGINFO handler from writing to the standard error
5021 * while we're doing so; instead, have it just set a flag telling
5022 * us to print that information when we're done.
5025 #endif /* SIGINFO */
5026 fprintf(stderr, "File: %s\n", filename);
5027 /* stderr could be line buffered */
5032 * Allow SIGINFO handlers to write.
5037 * If a SIGINFO handler asked us to write out capture counts, do so.
5040 report_counts_for_siginfo();
5041 #endif /* SIGINFO */
5046 report_cfilter_error(capture_options *capture_opts, guint i, const char *errmsg)
5048 interface_options interface_opts;
5049 char tmp[MSG_MAX_LENGTH+1+6];
5051 if (i < capture_opts->ifaces->len) {
5052 if (capture_child) {
5053 g_snprintf(tmp, sizeof(tmp), "%u:%s", i, errmsg);
5054 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "Capture filter error: %s", errmsg);
5055 pipe_write_block(2, SP_BAD_FILTER, tmp);
5058 * clopts_step_invalid_capfilter in test/suite-clopts.sh MUST match
5059 * the error message below.
5061 interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
5063 "Invalid capture filter \"%s\" for interface '%s'!\n"
5065 "That string isn't a valid capture filter (%s).\n"
5066 "See the User's Guide for a description of the capture filter syntax.",
5067 interface_opts.cfilter, interface_opts.name, errmsg);
5073 report_capture_error(const char *error_msg, const char *secondary_error_msg)
5075 if (capture_child) {
5076 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
5077 "Primary Error: %s", error_msg);
5078 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
5079 "Secondary Error: %s", secondary_error_msg);
5080 sync_pipe_errmsg_to_parent(2, error_msg, secondary_error_msg);
5082 cmdarg_err("%s", error_msg);
5083 if (secondary_error_msg[0] != '\0')
5084 cmdarg_err_cont("%s", secondary_error_msg);
5089 report_packet_drops(guint32 received, guint32 pcap_drops, guint32 drops, guint32 flushed, guint32 ps_ifdrop, gchar *name)
5091 char tmp[SP_DECISIZE+1+1];
5092 guint32 total_drops = pcap_drops + drops + flushed;
5094 g_snprintf(tmp, sizeof(tmp), "%u", total_drops);
5096 if (capture_child) {
5097 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
5098 "Packets received/dropped on interface '%s': %u/%u (pcap:%u/dumpcap:%u/flushed:%u/ps_ifdrop:%u)",
5099 name, received, total_drops, pcap_drops, drops, flushed, ps_ifdrop);
5100 /* XXX: Need to provide interface id, changes to consumers required. */
5101 pipe_write_block(2, SP_DROPS, tmp);
5104 "Packets received/dropped on interface '%s': %u/%u (pcap:%u/dumpcap:%u/flushed:%u/ps_ifdrop:%u) (%.1f%%)\n",
5105 name, received, total_drops, pcap_drops, drops, flushed, ps_ifdrop,
5106 received ? 100.0 * received / (received + total_drops) : 0.0);
5107 /* stderr could be line buffered */
5113 /************************************************************************************************/
5114 /* signal_pipe handling */
5119 signal_pipe_check_running(void)
5121 /* any news from our parent? -> just stop the capture */
5125 /* if we are running standalone, no check required */
5126 if (!capture_child) {
5130 if (!sig_pipe_name || !sig_pipe_handle) {
5131 /* This shouldn't happen */
5132 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
5133 "Signal pipe: No name or handle");
5138 * XXX - We should have the process ID of the parent (from the "-Z" flag)
5139 * at this point. Should we check to see if the parent is still alive,
5140 * e.g. by using OpenProcess?
5143 result = PeekNamedPipe(sig_pipe_handle, NULL, 0, NULL, &avail, NULL);
5145 if (!result || avail > 0) {
5146 /* peek failed or some bytes really available */
5147 /* (if not piping from stdin this would fail) */
5148 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
5149 "Signal pipe: Stop capture: %s", sig_pipe_name);
5150 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
5151 "Signal pipe: %s (%p) result: %u avail: %u", sig_pipe_name,
5152 sig_pipe_handle, result, avail);
5155 /* pipe ok and no bytes available */
5166 * Editor modelines - http://www.wireshark.org/tools/modelines.html
5171 * indent-tabs-mode: nil
5174 * vi: set shiftwidth=4 tabstop=8 expandtab:
5175 * :indentSize=4:tabSize=8:noTabs=true: