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, 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 libpcap_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_GINT64_CONSTANT(11644473600000000U);
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 MB (def: %dMB)\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");
551 fprintf(output, "Example: dumpcap -i eth0 -a duration:60 -w output.pcapng\n");
552 fprintf(output, "\"Capture packets from interface eth0 until 60s passed into output.pcapng\"\n");
553 fprintf(output, "\n");
554 fprintf(output, "Use Ctrl-C to stop capturing at any time.\n");
558 show_version(GString *comp_info_str, GString *runtime_info_str)
561 "Dumpcap " VERSION "%s\n"
566 "See http://www.wireshark.org for more information.\n",
567 wireshark_svnversion, get_copyright_info(), comp_info_str->str, runtime_info_str->str);
571 * Report an error in command-line arguments.
574 cmdarg_err(const char *fmt, ...)
580 /* Generate a 'special format' message back to parent */
582 msg = g_strdup_vprintf(fmt, ap);
583 sync_pipe_errmsg_to_parent(2, msg, "");
588 fprintf(stderr, "dumpcap: ");
589 vfprintf(stderr, fmt, ap);
590 fprintf(stderr, "\n");
596 * Report additional information for an error in command-line arguments.
599 cmdarg_err_cont(const char *fmt, ...)
606 msg = g_strdup_vprintf(fmt, ap);
607 sync_pipe_errmsg_to_parent(2, msg, "");
612 vfprintf(stderr, fmt, ap);
613 fprintf(stderr, "\n");
620 #if 0 /* Set to enable capability debugging */
621 /* see 'man cap_to_text()' for explanation of output */
622 /* '=' means 'all= ' ie: no capabilities */
623 /* '=ip' means 'all=ip' ie: all capabilities are permissible and inheritable */
625 print_caps(const char *pfx) {
626 cap_t caps = cap_get_proc();
627 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
628 "%s: EUID: %d Capabilities: %s", pfx,
629 geteuid(), cap_to_text(caps, NULL));
632 print_caps(const char *pfx _U_) {
637 relinquish_all_capabilities(void)
639 /* Drop any and all capabilities this process may have. */
640 /* Allowed whether or not process has any privileges. */
641 cap_t caps = cap_init(); /* all capabilities initialized to off */
642 print_caps("Pre-clear");
643 if (cap_set_proc(caps)) {
644 cmdarg_err("cap_set_proc() fail return: %s", g_strerror(errno));
646 print_caps("Post-clear");
652 open_capture_device(interface_options *interface_opts,
653 char (*open_err_str)[PCAP_ERRBUF_SIZE])
656 #ifdef HAVE_PCAP_CREATE
659 #if defined(HAVE_PCAP_OPEN) && defined(HAVE_PCAP_REMOTE)
660 struct pcap_rmtauth auth;
663 /* Open the network interface to capture from it.
664 Some versions of libpcap may put warnings into the error buffer
665 if they succeed; to tell if that's happened, we have to clear
666 the error buffer, and check if it's still a null string. */
667 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "Entering open_capture_device().");
668 (*open_err_str)[0] = '\0';
669 #if defined(HAVE_PCAP_OPEN) && defined(HAVE_PCAP_REMOTE)
671 * If we're opening a remote device, use pcap_open(); that's currently
672 * the only open routine that supports remote devices.
674 if (strncmp (interface_opts->name, "rpcap://", 8) == 0) {
675 auth.type = interface_opts->auth_type == CAPTURE_AUTH_PWD ?
676 RPCAP_RMTAUTH_PWD : RPCAP_RMTAUTH_NULL;
677 auth.username = interface_opts->auth_username;
678 auth.password = interface_opts->auth_password;
680 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
681 "Calling pcap_open() using name %s, snaplen %d, promisc_mode %d, datatx_udp %d, nocap_rpcap %d.",
682 interface_opts->name, interface_opts->snaplen, interface_opts->promisc_mode,
683 interface_opts->datatx_udp, interface_opts->nocap_rpcap);
684 pcap_h = pcap_open(interface_opts->name, interface_opts->snaplen,
686 (interface_opts->promisc_mode ? PCAP_OPENFLAG_PROMISCUOUS : 0) |
687 (interface_opts->datatx_udp ? PCAP_OPENFLAG_DATATX_UDP : 0) |
688 (interface_opts->nocap_rpcap ? PCAP_OPENFLAG_NOCAPTURE_RPCAP : 0),
689 CAP_READ_TIMEOUT, &auth, *open_err_str);
690 if (pcap_h == NULL) {
691 /* Error - did pcap actually supply an error message? */
692 if ((*open_err_str)[0] == '\0') {
693 /* Work around known WinPcap bug wherein no error message is
694 filled in on a failure to open an rpcap: URL. */
695 g_strlcpy(*open_err_str,
696 "Unknown error (pcap bug; actual error cause not reported)",
697 sizeof *open_err_str);
700 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
701 "pcap_open() returned %p.", (void *)pcap_h);
706 * If we're not opening a remote device, use pcap_create() and
707 * pcap_activate() if we have them, so that we can set the buffer
708 * size, otherwise use pcap_open_live().
710 #ifdef HAVE_PCAP_CREATE
711 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
712 "Calling pcap_create() using %s.", interface_opts->name);
713 pcap_h = pcap_create(interface_opts->name, *open_err_str);
714 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
715 "pcap_create() returned %p.", (void *)pcap_h);
716 if (pcap_h != NULL) {
717 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
718 "Calling pcap_set_snaplen() with snaplen %d.", interface_opts->snaplen);
719 pcap_set_snaplen(pcap_h, interface_opts->snaplen);
720 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
721 "Calling pcap_set_promisc() with promisc_mode %d.", interface_opts->promisc_mode);
722 pcap_set_promisc(pcap_h, interface_opts->promisc_mode);
723 pcap_set_timeout(pcap_h, CAP_READ_TIMEOUT);
725 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
726 "buffersize %d.", interface_opts->buffer_size);
727 if (interface_opts->buffer_size != 0) {
728 pcap_set_buffer_size(pcap_h, interface_opts->buffer_size * 1024 * 1024);
730 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
731 "monitor_mode %d.", interface_opts->monitor_mode);
732 if (interface_opts->monitor_mode)
733 pcap_set_rfmon(pcap_h, 1);
734 err = pcap_activate(pcap_h);
735 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
736 "pcap_activate() returned %d.", err);
738 /* Failed to activate, set to NULL */
739 if (err == PCAP_ERROR)
740 g_strlcpy(*open_err_str, pcap_geterr(pcap_h), sizeof *open_err_str);
742 g_strlcpy(*open_err_str, pcap_statustostr(err), sizeof *open_err_str);
748 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
749 "pcap_open_live() calling using name %s, snaplen %d, promisc_mode %d.",
750 interface_opts->name, interface_opts->snaplen, interface_opts->promisc_mode);
751 pcap_h = pcap_open_live(interface_opts->name, interface_opts->snaplen,
752 interface_opts->promisc_mode, CAP_READ_TIMEOUT,
754 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
755 "pcap_open_live() returned %p.", (void *)pcap_h);
758 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "open_capture_device %s : %s", pcap_h ? "SUCCESS" : "FAILURE", interface_opts->name);
763 get_capture_device_open_failure_messages(const char *open_err_str,
769 char *errmsg, size_t errmsg_len,
770 char *secondary_errmsg,
771 size_t secondary_errmsg_len)
774 const char *libpcap_warn;
775 static const char ppamsg[] = "can't find PPA for ";
778 g_snprintf(errmsg, (gulong) errmsg_len,
779 "The capture session could not be initiated (%s).", open_err_str);
782 g_snprintf(secondary_errmsg, (gulong) secondary_errmsg_len,
784 "In order to capture packets, WinPcap must be installed; see\n"
786 " http://www.winpcap.org/\n"
790 " http://www.mirrors.wiretapped.net/security/packet-capture/winpcap/\n"
794 " http://winpcap.cs.pu.edu.tw/\n"
796 "for a downloadable version of WinPcap and for instructions on how to install\n"
799 g_snprintf(secondary_errmsg, (gulong) secondary_errmsg_len,
801 "Please check that \"%s\" is the proper interface.\n"
804 "Help can be found at:\n"
806 " http://wiki.wireshark.org/WinPcap\n"
807 " http://wiki.wireshark.org/CaptureSetup\n",
811 /* If we got a "can't find PPA for X" message, warn the user (who
812 is running dumpcap on HP-UX) that they don't have a version of
813 libpcap that properly handles HP-UX (libpcap 0.6.x and later
814 versions, which properly handle HP-UX, say "can't find /dev/dlpi
815 PPA for X" rather than "can't find PPA for X"). */
816 if (strncmp(open_err_str, ppamsg, sizeof ppamsg - 1) == 0)
819 "You are running (T)Wireshark with a version of the libpcap library\n"
820 "that doesn't handle HP-UX network devices well; this means that\n"
821 "(T)Wireshark may not be able to capture packets.\n"
823 "To fix this, you should install libpcap 0.6.2, or a later version\n"
824 "of libpcap, rather than libpcap 0.4 or 0.5.x. It is available in\n"
825 "packaged binary form from the Software Porting And Archive Centre\n"
826 "for HP-UX; the Centre is at http://hpux.connect.org.uk/ - the page\n"
827 "at the URL lists a number of mirror sites.";
831 g_snprintf(secondary_errmsg, (gulong) secondary_errmsg_len,
832 "Please check to make sure you have sufficient permissions, and that you have "
833 "the proper interface or pipe specified.%s", libpcap_warn);
837 /* Set the data link type on a pcap. */
839 set_pcap_linktype(pcap_t *pcap_h, int linktype,
840 #ifdef HAVE_PCAP_SET_DATALINK
845 char *errmsg, size_t errmsg_len,
846 char *secondary_errmsg, size_t secondary_errmsg_len)
848 char *set_linktype_err_str;
851 return TRUE; /* just use the default */
852 #ifdef HAVE_PCAP_SET_DATALINK
853 if (pcap_set_datalink(pcap_h, linktype) == 0)
854 return TRUE; /* no error */
855 set_linktype_err_str = pcap_geterr(pcap_h);
857 /* Let them set it to the type it is; reject any other request. */
858 if (get_pcap_linktype(pcap_h, name) == linktype)
859 return TRUE; /* no error */
860 set_linktype_err_str =
861 "That DLT isn't one of the DLTs supported by this device";
863 g_snprintf(errmsg, (gulong) errmsg_len, "Unable to set data link type (%s).",
864 set_linktype_err_str);
866 * If the error isn't "XXX is not one of the DLTs supported by this device",
867 * tell the user to tell the Wireshark developers about it.
869 if (strstr(set_linktype_err_str, "is not one of the DLTs supported by this device") == NULL)
870 g_snprintf(secondary_errmsg, (gulong) secondary_errmsg_len, please_report);
872 secondary_errmsg[0] = '\0';
877 compile_capture_filter(const char *iface, pcap_t *pcap_h,
878 struct bpf_program *fcode, const char *cfilter)
880 bpf_u_int32 netnum, netmask;
881 gchar lookup_net_err_str[PCAP_ERRBUF_SIZE];
883 if (pcap_lookupnet(iface, &netnum, &netmask, lookup_net_err_str) < 0) {
885 * Well, we can't get the netmask for this interface; it's used
886 * only for filters that check for broadcast IP addresses, so
887 * we just punt and use 0. It might be nice to warn the user,
888 * but that's a pain in a GUI application, as it'd involve popping
889 * up a message box, and it's not clear how often this would make
890 * a difference (only filters that check for IP broadcast addresses
894 "Warning: Couldn't obtain netmask info (%s).", lookup_net_err_str);*/
899 * Sigh. Older versions of libpcap don't properly declare the
900 * third argument to pcap_compile() as a const pointer. Cast
903 if (pcap_compile(pcap_h, fcode, (char *)cfilter, 1, netmask) < 0)
908 #ifdef HAVE_BPF_IMAGE
910 show_filter_code(capture_options *capture_opts)
912 interface_options interface_opts;
914 gchar open_err_str[PCAP_ERRBUF_SIZE];
915 char errmsg[MSG_MAX_LENGTH+1];
916 char secondary_errmsg[MSG_MAX_LENGTH+1];
917 struct bpf_program fcode;
918 struct bpf_insn *insn;
922 for (j = 0; j < capture_opts->ifaces->len; j++) {
923 interface_opts = g_array_index(capture_opts->ifaces, interface_options, j);
924 pcap_h = open_capture_device(&interface_opts, &open_err_str);
925 if (pcap_h == NULL) {
926 /* Open failed; get messages */
927 get_capture_device_open_failure_messages(open_err_str,
929 errmsg, sizeof errmsg,
931 sizeof secondary_errmsg);
932 /* And report them */
933 report_capture_error(errmsg, secondary_errmsg);
937 /* Set the link-layer type. */
938 if (!set_pcap_linktype(pcap_h, interface_opts.linktype, interface_opts.name,
939 errmsg, sizeof errmsg,
940 secondary_errmsg, sizeof secondary_errmsg)) {
942 report_capture_error(errmsg, secondary_errmsg);
946 /* OK, try to compile the capture filter. */
947 if (!compile_capture_filter(interface_opts.name, pcap_h, &fcode,
948 interface_opts.cfilter)) {
950 report_cfilter_error(capture_opts, j, errmsg);
955 /* Now print the filter code. */
956 insn = fcode.bf_insns;
958 for (i = 0; i < fcode.bf_len; insn++, i++)
959 printf("%s\n", bpf_image(insn, i));
961 /* If not using libcap: we now can now set euid/egid to ruid/rgid */
962 /* to remove any suid privileges. */
963 /* If using libcap: we can now remove NET_RAW and NET_ADMIN capabilities */
964 /* (euid/egid have already previously been set to ruid/rgid. */
965 /* (See comment in main() for details) */
967 relinquish_special_privs_perm();
969 relinquish_all_capabilities();
972 /* Let our parent know we succeeded. */
973 pipe_write_block(2, SP_SUCCESS, NULL);
980 * capture_interface_list() is expected to do the right thing to get
981 * a list of interfaces.
983 * In most of the programs in the Wireshark suite, "the right thing"
984 * is to run dumpcap and ask it for the list, because dumpcap may
985 * be the only program in the suite with enough privileges to get
988 * In dumpcap itself, however, we obviously can't run dumpcap to
989 * ask for the list. Therefore, our capture_interface_list() should
990 * just call get_interface_list().
993 capture_interface_list(int *err, char **err_str, void(*update_cb)(void) _U_)
995 return get_interface_list(err, err_str);
999 * Get the data-link type for a libpcap device.
1000 * This works around AIX 5.x's non-standard and incompatible-with-the-
1001 * rest-of-the-universe libpcap.
1004 get_pcap_linktype(pcap_t *pch, const char *devicename
1012 const char *ifacename;
1015 linktype = pcap_datalink(pch);
1019 * The libpcap that comes with AIX 5.x uses RFC 1573 ifType values
1020 * rather than DLT_ values for link-layer types; the ifType values
1021 * for LAN devices are:
1028 * and the ifType value for a loopback device is 24.
1030 * The AIX names for LAN devices begin with:
1037 * and the AIX names for loopback devices begin with "lo".
1039 * (The difference between "Ethernet" and "802.3" is presumably
1040 * whether packets have an Ethernet header, with a packet type,
1041 * or an 802.3 header, with a packet length, followed by an 802.2
1042 * header and possibly a SNAP header.)
1044 * If the device name matches "linktype" interpreted as an ifType
1045 * value, rather than as a DLT_ value, we will assume this is AIX's
1046 * non-standard, incompatible libpcap, rather than a standard libpcap,
1047 * and will map the link-layer type to the standard DLT_ value for
1048 * that link-layer type, as that's what the rest of Wireshark expects.
1050 * (This means the capture files won't be readable by a tcpdump
1051 * linked with AIX's non-standard libpcap, but so it goes. They
1052 * *will* be readable by standard versions of tcpdump, Wireshark,
1055 * XXX - if we conclude we're using AIX libpcap, should we also
1056 * set a flag to cause us to assume the time stamps are in
1057 * seconds-and-nanoseconds form, and to convert them to
1058 * seconds-and-microseconds form before processing them and
1063 * Find the last component of the device name, which is the
1066 ifacename = strchr(devicename, '/');
1067 if (ifacename == NULL)
1068 ifacename = devicename;
1070 /* See if it matches any of the LAN device names. */
1071 if (strncmp(ifacename, "en", 2) == 0) {
1072 if (linktype == 6) {
1074 * That's the RFC 1573 value for Ethernet; map it to DLT_EN10MB.
1078 } else if (strncmp(ifacename, "et", 2) == 0) {
1079 if (linktype == 7) {
1081 * That's the RFC 1573 value for 802.3; map it to DLT_EN10MB.
1082 * (libpcap, tcpdump, Wireshark, etc. don't care if it's Ethernet
1087 } else if (strncmp(ifacename, "tr", 2) == 0) {
1088 if (linktype == 9) {
1090 * That's the RFC 1573 value for 802.5 (Token Ring); map it to
1091 * DLT_IEEE802, which is what's used for Token Ring.
1095 } else if (strncmp(ifacename, "fi", 2) == 0) {
1096 if (linktype == 15) {
1098 * That's the RFC 1573 value for FDDI; map it to DLT_FDDI.
1102 } else if (strncmp(ifacename, "lo", 2) == 0) {
1103 if (linktype == 24) {
1105 * That's the RFC 1573 value for "software loopback" devices; map it
1106 * to DLT_NULL, which is what's used for loopback devices on BSD.
1116 static data_link_info_t *
1117 create_data_link_info(int dlt)
1119 data_link_info_t *data_link_info;
1122 data_link_info = (data_link_info_t *)g_malloc(sizeof (data_link_info_t));
1123 data_link_info->dlt = dlt;
1124 text = pcap_datalink_val_to_name(dlt);
1126 data_link_info->name = g_strdup(text);
1128 data_link_info->name = g_strdup_printf("DLT %d", dlt);
1129 text = pcap_datalink_val_to_description(dlt);
1131 data_link_info->description = g_strdup(text);
1133 data_link_info->description = NULL;
1134 return data_link_info;
1138 * Get the capabilities of a network device.
1140 static if_capabilities_t *
1141 get_if_capabilities(const char *devicename, gboolean monitor_mode
1142 #ifndef HAVE_PCAP_CREATE
1147 if_capabilities_t *caps;
1148 char errbuf[PCAP_ERRBUF_SIZE];
1150 #ifdef HAVE_PCAP_CREATE
1154 #ifdef HAVE_PCAP_LIST_DATALINKS
1158 data_link_info_t *data_link_info;
1161 * Allocate the interface capabilities structure.
1163 caps = (if_capabilities_t *)g_malloc(sizeof *caps);
1166 * WinPcap 4.1.2, and possibly earlier versions, have a bug
1167 * wherein, when an open with an rpcap: URL fails, the error
1168 * message for the error is not copied to errbuf and whatever
1169 * on-the-stack junk is in errbuf is treated as the error
1172 * To work around that (and any other bugs of that sort, we
1173 * initialize errbuf to an empty string. If we get an error
1174 * and the string is empty, we report it as an unknown error.
1175 * (If we *don't* get an error, and the string is *non*-empty,
1176 * that could be a warning returned, such as "can't turn
1177 * promiscuous mode on"; we currently don't do so.)
1180 #ifdef HAVE_PCAP_OPEN
1181 pch = pcap_open(devicename, MIN_PACKET_SIZE, 0, 0, NULL, errbuf);
1182 caps->can_set_rfmon = FALSE;
1184 if (err_str != NULL)
1185 *err_str = g_strdup(errbuf[0] == '\0' ? "Unknown error (pcap bug; actual error cause not reported)" : errbuf);
1189 #elif defined(HAVE_PCAP_CREATE)
1190 pch = pcap_create(devicename, errbuf);
1192 if (err_str != NULL)
1193 *err_str = g_strdup(errbuf);
1197 status = pcap_can_set_rfmon(pch);
1200 if (status == PCAP_ERROR)
1201 *err_str = g_strdup_printf("pcap_can_set_rfmon() failed: %s",
1204 *err_str = g_strdup(pcap_statustostr(status));
1210 caps->can_set_rfmon = FALSE;
1211 else if (status == 1) {
1212 caps->can_set_rfmon = TRUE;
1214 pcap_set_rfmon(pch, 1);
1216 if (err_str != NULL) {
1217 *err_str = g_strdup_printf("pcap_can_set_rfmon() returned %d",
1225 status = pcap_activate(pch);
1227 /* Error. We ignore warnings (status > 0). */
1228 if (err_str != NULL) {
1229 if (status == PCAP_ERROR)
1230 *err_str = g_strdup_printf("pcap_activate() failed: %s",
1233 *err_str = g_strdup(pcap_statustostr(status));
1240 pch = pcap_open_live(devicename, MIN_PACKET_SIZE, 0, 0, errbuf);
1241 caps->can_set_rfmon = FALSE;
1243 if (err_str != NULL)
1244 *err_str = g_strdup(errbuf[0] == '\0' ? "Unknown error (pcap bug; actual error cause not reported)" : errbuf);
1249 deflt = get_pcap_linktype(pch, devicename);
1250 #ifdef HAVE_PCAP_LIST_DATALINKS
1251 nlt = pcap_list_datalinks(pch, &linktypes);
1252 if (nlt == 0 || linktypes == NULL) {
1254 if (err_str != NULL)
1255 *err_str = NULL; /* an empty list doesn't mean an error */
1259 caps->data_link_types = NULL;
1260 for (i = 0; i < nlt; i++) {
1261 data_link_info = create_data_link_info(linktypes[i]);
1264 * XXX - for 802.11, make the most detailed 802.11
1265 * version the default, rather than the one the
1266 * device has as the default?
1268 if (linktypes[i] == deflt)
1269 caps->data_link_types = g_list_prepend(caps->data_link_types,
1272 caps->data_link_types = g_list_append(caps->data_link_types,
1275 #ifdef HAVE_PCAP_FREE_DATALINKS
1276 pcap_free_datalinks(linktypes);
1279 * In Windows, there's no guarantee that if you have a library
1280 * built with one version of the MSVC++ run-time library, and
1281 * it returns a pointer to allocated data, you can free that
1282 * data from a program linked with another version of the
1283 * MSVC++ run-time library.
1285 * This is not an issue on UN*X.
1287 * See the mail threads starting at
1289 * http://www.winpcap.org/pipermail/winpcap-users/2006-September/001421.html
1293 * http://www.winpcap.org/pipermail/winpcap-users/2008-May/002498.html
1296 #define xx_free free /* hack so checkAPIs doesn't complain */
1299 #endif /* HAVE_PCAP_FREE_DATALINKS */
1300 #else /* HAVE_PCAP_LIST_DATALINKS */
1302 data_link_info = create_data_link_info(deflt);
1303 caps->data_link_types = g_list_append(caps->data_link_types,
1305 #endif /* HAVE_PCAP_LIST_DATALINKS */
1309 if (err_str != NULL)
1314 #define ADDRSTRLEN 46 /* Covers IPv4 & IPv6 */
1316 * Output a machine readable list of the interfaces
1317 * This list is retrieved by the sync_interface_list_open() function
1318 * The actual output of this function can be viewed with the command "dumpcap -D -Z none"
1321 print_machine_readable_interfaces(GList *if_list)
1328 char addr_str[ADDRSTRLEN];
1330 if (capture_child) {
1331 /* Let our parent know we succeeded. */
1332 pipe_write_block(2, SP_SUCCESS, NULL);
1335 i = 1; /* Interface id number */
1336 for (if_entry = g_list_first(if_list); if_entry != NULL;
1337 if_entry = g_list_next(if_entry)) {
1338 if_info = (if_info_t *)if_entry->data;
1339 printf("%d. %s\t", i++, if_info->name);
1342 * Print the contents of the if_entry struct in a parseable format.
1343 * Each if_entry element is tab-separated. Addresses are comma-
1346 /* XXX - Make sure our description doesn't contain a tab */
1347 if (if_info->vendor_description != NULL)
1348 printf("%s\t", if_info->vendor_description);
1352 /* XXX - Make sure our friendly name doesn't contain a tab */
1353 if (if_info->friendly_name != NULL)
1354 printf("%s\t", if_info->friendly_name);
1358 printf("%u\t", if_info->type);
1360 for (addr = g_slist_nth(if_info->addrs, 0); addr != NULL;
1361 addr = g_slist_next(addr)) {
1362 if (addr != g_slist_nth(if_info->addrs, 0))
1365 if_addr = (if_addr_t *)addr->data;
1366 switch(if_addr->ifat_type) {
1368 if (inet_ntop(AF_INET, &if_addr->addr.ip4_addr, addr_str,
1370 printf("%s", addr_str);
1372 printf("<unknown IPv4>");
1376 if (inet_ntop(AF_INET6, &if_addr->addr.ip6_addr,
1377 addr_str, ADDRSTRLEN)) {
1378 printf("%s", addr_str);
1380 printf("<unknown IPv6>");
1384 printf("<type unknown %u>", if_addr->ifat_type);
1388 if (if_info->loopback)
1389 printf("\tloopback");
1391 printf("\tnetwork");
1398 * If you change the machine-readable output format of this function,
1399 * you MUST update capture_ifinfo.c:capture_get_if_capabilities() accordingly!
1402 print_machine_readable_if_capabilities(if_capabilities_t *caps)
1405 data_link_info_t *data_link_info;
1406 const gchar *desc_str;
1408 if (capture_child) {
1409 /* Let our parent know we succeeded. */
1410 pipe_write_block(2, SP_SUCCESS, NULL);
1413 if (caps->can_set_rfmon)
1417 for (lt_entry = caps->data_link_types; lt_entry != NULL;
1418 lt_entry = g_list_next(lt_entry)) {
1419 data_link_info = (data_link_info_t *)lt_entry->data;
1420 if (data_link_info->description != NULL)
1421 desc_str = data_link_info->description;
1423 desc_str = "(not supported)";
1424 printf("%d\t%s\t%s\n", data_link_info->dlt, data_link_info->name,
1434 /* Print the number of packets captured for each interface until we're killed. */
1436 print_statistics_loop(gboolean machine_readable)
1438 GList *if_list, *if_entry, *stat_list = NULL, *stat_entry;
1444 char errbuf[PCAP_ERRBUF_SIZE];
1445 struct pcap_stat ps;
1447 if_list = get_interface_list(&err, &err_str);
1448 if (if_list == NULL) {
1450 case CANT_GET_INTERFACE_LIST:
1451 case DONT_HAVE_PCAP:
1452 cmdarg_err("%s", err_str);
1456 case NO_INTERFACES_FOUND:
1457 cmdarg_err("There are no interfaces on which a capture can be done");
1463 for (if_entry = g_list_first(if_list); if_entry != NULL; if_entry = g_list_next(if_entry)) {
1464 if_info = (if_info_t *)if_entry->data;
1465 #ifdef HAVE_PCAP_OPEN
1466 pch = pcap_open(if_info->name, MIN_PACKET_SIZE, 0, 0, NULL, errbuf);
1468 pch = pcap_open_live(if_info->name, MIN_PACKET_SIZE, 0, 0, errbuf);
1472 if_stat = (if_stat_t *)g_malloc(sizeof(if_stat_t));
1473 if_stat->name = g_strdup(if_info->name);
1475 stat_list = g_list_append(stat_list, if_stat);
1480 cmdarg_err("There are no interfaces on which a capture can be done");
1484 if (capture_child) {
1485 /* Let our parent know we succeeded. */
1486 pipe_write_block(2, SP_SUCCESS, NULL);
1489 if (!machine_readable) {
1490 printf("%-15s %10s %10s\n", "Interface", "Received",
1494 global_ld.go = TRUE;
1495 while (global_ld.go) {
1496 for (stat_entry = g_list_first(stat_list); stat_entry != NULL; stat_entry = g_list_next(stat_entry)) {
1497 if_stat = (if_stat_t *)stat_entry->data;
1498 pcap_stats(if_stat->pch, &ps);
1500 if (!machine_readable) {
1501 printf("%-15s %10u %10u\n", if_stat->name,
1502 ps.ps_recv, ps.ps_drop);
1504 printf("%s\t%u\t%u\n", if_stat->name,
1505 ps.ps_recv, ps.ps_drop);
1516 /* XXX - Not reached. Should we look for 'q' in stdin? */
1517 for (stat_entry = g_list_first(stat_list); stat_entry != NULL; stat_entry = g_list_next(stat_entry)) {
1518 if_stat = (if_stat_t *)stat_entry->data;
1519 pcap_close(if_stat->pch);
1520 g_free(if_stat->name);
1523 g_list_free(stat_list);
1524 free_interface_list(if_list);
1532 capture_cleanup_handler(DWORD dwCtrlType)
1534 /* CTRL_C_EVENT is sort of like SIGINT, CTRL_BREAK_EVENT is unique to
1535 Windows, CTRL_CLOSE_EVENT is sort of like SIGHUP, CTRL_LOGOFF_EVENT
1536 is also sort of like SIGHUP, and CTRL_SHUTDOWN_EVENT is sort of
1537 like SIGTERM at least when the machine's shutting down.
1539 For now, if we're running as a command rather than a capture child,
1540 we handle all but CTRL_LOGOFF_EVENT as indications that we should
1541 clean up and quit, just as we handle SIGINT, SIGHUP, and SIGTERM
1542 in that way on UN*X.
1544 If we're not running as a capture child, we might be running as
1545 a service; ignore CTRL_LOGOFF_EVENT, so we keep running after the
1546 user logs out. (XXX - can we explicitly check whether we're
1547 running as a service?) */
1549 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
1550 "Console: Control signal");
1551 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
1552 "Console: Control signal, CtrlType: %u", dwCtrlType);
1554 /* Keep capture running if we're a service and a user logs off */
1555 if (capture_child || (dwCtrlType != CTRL_LOGOFF_EVENT)) {
1556 capture_loop_stop();
1564 capture_cleanup_handler(int signum _U_)
1566 /* On UN*X, we cleanly shut down the capture on SIGINT, SIGHUP, and
1567 SIGTERM. We assume that if the user wanted it to keep running
1568 after they logged out, they'd have nohupped it. */
1570 /* Note: don't call g_log() in the signal handler: if we happened to be in
1571 * g_log() in process context when the signal came in, g_log will detect
1572 * the "recursion" and abort.
1575 capture_loop_stop();
1581 report_capture_count(gboolean reportit)
1583 /* Don't print this if we're a capture child. */
1584 if (!capture_child && reportit) {
1585 fprintf(stderr, "\rPackets captured: %u\n", global_ld.packet_count);
1586 /* stderr could be line buffered */
1594 report_counts_for_siginfo(void)
1596 report_capture_count(quiet);
1597 infoprint = FALSE; /* we just reported it */
1601 report_counts_siginfo(int signum _U_)
1603 int sav_errno = errno;
1605 /* If we've been told to delay printing, just set a flag asking
1606 that we print counts (if we're supposed to), otherwise print
1607 the count of packets captured (if we're supposed to). */
1611 report_counts_for_siginfo();
1614 #endif /* SIGINFO */
1617 exit_main(int status)
1620 /* Shutdown windows sockets */
1623 /* can be helpful for debugging */
1624 #ifdef DEBUG_DUMPCAP
1625 printf("Press any key\n");
1636 * If we were linked with libcap (not related to libpcap), make sure we have
1637 * CAP_NET_ADMIN and CAP_NET_RAW, then relinquish our permissions.
1638 * (See comment in main() for details)
1641 relinquish_privs_except_capture(void)
1643 /* If 'started_with_special_privs' (ie: suid) then enable for
1644 * ourself the NET_ADMIN and NET_RAW capabilities and then
1645 * drop our suid privileges.
1647 * CAP_NET_ADMIN: Promiscuous mode and a truckload of other
1648 * stuff we don't need (and shouldn't have).
1649 * CAP_NET_RAW: Packet capture (raw sockets).
1652 if (started_with_special_privs()) {
1653 cap_value_t cap_list[2] = { CAP_NET_ADMIN, CAP_NET_RAW };
1654 int cl_len = sizeof(cap_list) / sizeof(cap_value_t);
1656 cap_t caps = cap_init(); /* all capabilities initialized to off */
1658 print_caps("Pre drop, pre set");
1660 if (prctl(PR_SET_KEEPCAPS, 1, 0, 0, 0) == -1) {
1661 cmdarg_err("prctl() fail return: %s", g_strerror(errno));
1664 cap_set_flag(caps, CAP_PERMITTED, cl_len, cap_list, CAP_SET);
1665 cap_set_flag(caps, CAP_INHERITABLE, cl_len, cap_list, CAP_SET);
1667 if (cap_set_proc(caps)) {
1668 cmdarg_err("cap_set_proc() fail return: %s", g_strerror(errno));
1670 print_caps("Pre drop, post set");
1672 relinquish_special_privs_perm();
1674 print_caps("Post drop, pre set");
1675 cap_set_flag(caps, CAP_EFFECTIVE, cl_len, cap_list, CAP_SET);
1676 if (cap_set_proc(caps)) {
1677 cmdarg_err("cap_set_proc() fail return: %s", g_strerror(errno));
1679 print_caps("Post drop, post set");
1685 #endif /* HAVE_LIBCAP */
1687 /* Take care of byte order in the libpcap headers read from pipes.
1688 * (function taken from wiretap/libpcap.c) */
1690 cap_pipe_adjust_header(gboolean byte_swapped, struct pcap_hdr *hdr, struct pcaprec_hdr *rechdr)
1693 /* Byte-swap the record header fields. */
1694 rechdr->ts_sec = BSWAP32(rechdr->ts_sec);
1695 rechdr->ts_usec = BSWAP32(rechdr->ts_usec);
1696 rechdr->incl_len = BSWAP32(rechdr->incl_len);
1697 rechdr->orig_len = BSWAP32(rechdr->orig_len);
1700 /* In file format version 2.3, the "incl_len" and "orig_len" fields were
1701 swapped, in order to match the BPF header layout.
1703 Unfortunately, some files were, according to a comment in the "libpcap"
1704 source, written with version 2.3 in their headers but without the
1705 interchanged fields, so if "incl_len" is greater than "orig_len" - which
1706 would make no sense - we assume that we need to swap them. */
1707 if (hdr->version_major == 2 &&
1708 (hdr->version_minor < 3 ||
1709 (hdr->version_minor == 3 && rechdr->incl_len > rechdr->orig_len))) {
1712 temp = rechdr->orig_len;
1713 rechdr->orig_len = rechdr->incl_len;
1714 rechdr->incl_len = temp;
1718 /* Wrapper: distinguish between recv/read if we're reading on Windows,
1722 cap_pipe_read(int pipe_fd, char *buf, size_t sz, gboolean from_socket _U_)
1726 return recv(pipe_fd, buf, (int)sz, 0);
1731 return ws_read(pipe_fd, buf, sz);
1737 * Thread function that reads from a pipe and pushes the data
1738 * to the main application thread.
1741 * XXX Right now we use async queues for basic signaling. The main thread
1742 * sets cap_pipe_buf and cap_bytes_to_read, then pushes an item onto
1743 * cap_pipe_pending_q which triggers a read in the cap_pipe_read thread.
1744 * Iff the read is successful cap_pipe_read pushes an item onto
1745 * cap_pipe_done_q, otherwise an error is signaled. No data is passed in
1746 * the queues themselves (yet).
1748 * We might want to move some of the cap_pipe_dispatch logic here so that
1749 * we can let cap_thread_read run independently, queuing up multiple reads
1750 * for the main thread (and possibly get rid of cap_pipe_read_mtx).
1752 static void *cap_thread_read(void *arg)
1754 pcap_options *pcap_opts;
1757 DWORD b, last_err, bytes_read;
1763 pcap_opts = (pcap_options *)arg;
1764 while (pcap_opts->cap_pipe_err == PIPOK) {
1765 g_async_queue_pop(pcap_opts->cap_pipe_pending_q); /* Wait for our cue (ahem) from the main thread */
1766 g_mutex_lock(pcap_opts->cap_pipe_read_mtx);
1768 while (bytes_read < pcap_opts->cap_pipe_bytes_to_read) {
1769 if ((pcap_opts->from_cap_socket)
1775 b = cap_pipe_read(pcap_opts->cap_pipe_fd, pcap_opts->cap_pipe_buf+bytes_read,
1776 pcap_opts->cap_pipe_bytes_to_read - bytes_read, pcap_opts->from_cap_socket);
1779 pcap_opts->cap_pipe_err = PIPEOF;
1783 pcap_opts->cap_pipe_err = PIPERR;
1794 /* If we try to use read() on a named pipe on Windows with partial
1795 * data it appears to return EOF.
1797 res = ReadFile(pcap_opts->cap_pipe_h, pcap_opts->cap_pipe_buf+bytes_read,
1798 pcap_opts->cap_pipe_bytes_to_read - bytes_read,
1803 last_err = GetLastError();
1804 if (last_err == ERROR_MORE_DATA) {
1806 } else if (last_err == ERROR_HANDLE_EOF || last_err == ERROR_BROKEN_PIPE || last_err == ERROR_PIPE_NOT_CONNECTED) {
1807 pcap_opts->cap_pipe_err = PIPEOF;
1811 pcap_opts->cap_pipe_err = PIPERR;
1814 } else if (b == 0 && pcap_opts->cap_pipe_bytes_to_read > 0) {
1815 pcap_opts->cap_pipe_err = PIPEOF;
1822 pcap_opts->cap_pipe_bytes_read = bytes_read;
1823 if (pcap_opts->cap_pipe_bytes_read >= pcap_opts->cap_pipe_bytes_to_read) {
1824 g_async_queue_push(pcap_opts->cap_pipe_done_q, pcap_opts->cap_pipe_buf); /* Any non-NULL value will do */
1826 g_mutex_unlock(pcap_opts->cap_pipe_read_mtx);
1832 /* Provide select() functionality for a single file descriptor
1833 * on UNIX/POSIX. Windows uses cap_pipe_read via a thread.
1835 * Returns the same values as select.
1838 cap_pipe_select(int pipe_fd)
1841 struct timeval timeout;
1844 FD_SET(pipe_fd, &rfds);
1846 timeout.tv_sec = PIPE_READ_TIMEOUT / 1000000;
1847 timeout.tv_usec = PIPE_READ_TIMEOUT % 1000000;
1849 return select(pipe_fd+1, &rfds, NULL, NULL, &timeout);
1852 #define DEF_TCP_PORT 19000
1855 cap_open_socket(char *pipename, pcap_options *pcap_opts, char *errmsg, int errmsgl)
1857 char *sockname = pipename + 4;
1858 struct sockaddr_in sa;
1865 memset(&sa, 0, sizeof(sa));
1867 p = strchr(sockname, ':');
1869 len = strlen(sockname);
1870 port = DEF_TCP_PORT;
1874 port = strtoul(p + 1, &p, 10);
1875 if (*p || port > 65535) {
1884 strncpy(buf, sockname, len);
1886 if (inet_pton(AF_INET, buf, &sa.sin_addr) <= 0) {
1890 sa.sin_family = AF_INET;
1891 sa.sin_port = htons((u_short)port);
1893 if (((fd = (int)socket(AF_INET, SOCK_STREAM, 0)) < 0) ||
1894 (connect(fd, (struct sockaddr *)&sa, sizeof(sa)) < 0)) {
1896 LPTSTR errorText = NULL;
1899 lastError = WSAGetLastError();
1900 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM |
1901 FORMAT_MESSAGE_ALLOCATE_BUFFER |
1902 FORMAT_MESSAGE_IGNORE_INSERTS,
1903 NULL, lastError, MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
1904 (LPTSTR)&errorText, 0, NULL);
1906 g_snprintf(errmsg, errmsgl,
1907 "The capture session could not be initiated due to the socket error: \n"
1909 " %d: %S", lastError, errorText ? (char *)errorText : "Unknown");
1911 LocalFree(errorText);
1913 " %d: %s", errno, strerror(errno));
1915 pcap_opts->cap_pipe_err = PIPERR;
1918 cap_pipe_close(fd, TRUE);
1922 pcap_opts->from_cap_socket = TRUE;
1926 g_snprintf(errmsg, errmsgl,
1927 "The capture session could not be initiated because\n"
1928 "\"%s\" is not a valid socket specification", pipename);
1929 pcap_opts->cap_pipe_err = PIPERR;
1933 /* Wrapper: distinguish between closesocket on Windows; use ws_close
1937 cap_pipe_close(int pipe_fd, gboolean from_socket _U_)
1941 closesocket(pipe_fd);
1948 /* Mimic pcap_open_live() for pipe captures
1950 * We check if "pipename" is "-" (stdin), a AF_UNIX socket, or a FIFO,
1951 * open it, and read the header.
1953 * N.B. : we can't read the libpcap formats used in RedHat 6.1 or SuSE 6.3
1954 * because we can't seek on pipes (see wiretap/libpcap.c for details) */
1956 cap_pipe_open_live(char *pipename,
1957 pcap_options *pcap_opts,
1958 struct pcap_hdr *hdr,
1959 char *errmsg, int errmsgl)
1962 ws_statb64 pipe_stat;
1963 struct sockaddr_un sa;
1973 pcap_opts->cap_pipe_fd = -1;
1975 pcap_opts->cap_pipe_h = INVALID_HANDLE_VALUE;
1977 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "cap_pipe_open_live: %s", pipename);
1980 * XXX - this blocks until a pcap per-file header has been written to
1981 * the pipe, so it could block indefinitely.
1983 if (strcmp(pipename, "-") == 0) {
1985 fd = 0; /* read from stdin */
1987 pcap_opts->cap_pipe_h = GetStdHandle(STD_INPUT_HANDLE);
1989 } else if (!strncmp(pipename, "TCP@", 4)) {
1990 if ((fd = cap_open_socket(pipename, pcap_opts, errmsg, errmsgl)) < 0) {
1995 if (ws_stat64(pipename, &pipe_stat) < 0) {
1996 if (errno == ENOENT || errno == ENOTDIR)
1997 pcap_opts->cap_pipe_err = PIPNEXIST;
1999 g_snprintf(errmsg, errmsgl,
2000 "The capture session could not be initiated "
2001 "due to error getting information on pipe/socket: %s", g_strerror(errno));
2002 pcap_opts->cap_pipe_err = PIPERR;
2006 if (S_ISFIFO(pipe_stat.st_mode)) {
2007 fd = ws_open(pipename, O_RDONLY | O_NONBLOCK, 0000 /* no creation so don't matter */);
2009 g_snprintf(errmsg, errmsgl,
2010 "The capture session could not be initiated "
2011 "due to error on pipe open: %s", g_strerror(errno));
2012 pcap_opts->cap_pipe_err = PIPERR;
2015 } else if (S_ISSOCK(pipe_stat.st_mode)) {
2016 fd = socket(AF_UNIX, SOCK_STREAM, 0);
2018 g_snprintf(errmsg, errmsgl,
2019 "The capture session could not be initiated "
2020 "due to error on socket create: %s", g_strerror(errno));
2021 pcap_opts->cap_pipe_err = PIPERR;
2024 sa.sun_family = AF_UNIX;
2026 * The Single UNIX Specification says:
2028 * The size of sun_path has intentionally been left undefined.
2029 * This is because different implementations use different sizes.
2030 * For example, 4.3 BSD uses a size of 108, and 4.4 BSD uses a size
2031 * of 104. Since most implementations originate from BSD versions,
2032 * the size is typically in the range 92 to 108.
2034 * Applications should not assume a particular length for sun_path
2035 * or assume that it can hold {_POSIX_PATH_MAX} bytes (256).
2039 * The <sys/un.h> header shall define the sockaddr_un structure,
2040 * which shall include at least the following members:
2042 * sa_family_t sun_family Address family.
2043 * char sun_path[] Socket pathname.
2045 * so we assume that it's an array, with a specified size,
2046 * and that the size reflects the maximum path length.
2048 if (g_strlcpy(sa.sun_path, pipename, sizeof sa.sun_path) > sizeof sa.sun_path) {
2049 /* Path name too long */
2050 g_snprintf(errmsg, errmsgl,
2051 "The capture session coud not be initiated "
2052 "due to error on socket connect: Path name too long");
2053 pcap_opts->cap_pipe_err = PIPERR;
2057 b = connect(fd, (struct sockaddr *)&sa, sizeof sa);
2059 g_snprintf(errmsg, errmsgl,
2060 "The capture session coud not be initiated "
2061 "due to error on socket connect: %s", g_strerror(errno));
2062 pcap_opts->cap_pipe_err = PIPERR;
2067 if (S_ISCHR(pipe_stat.st_mode)) {
2069 * Assume the user specified an interface on a system where
2070 * interfaces are in /dev. Pretend we haven't seen it.
2072 pcap_opts->cap_pipe_err = PIPNEXIST;
2074 g_snprintf(errmsg, errmsgl,
2075 "The capture session could not be initiated because\n"
2076 "\"%s\" is neither an interface nor a socket nor a pipe", pipename);
2077 pcap_opts->cap_pipe_err = PIPERR;
2082 #define PIPE_STR "\\pipe\\"
2083 /* Under Windows, named pipes _must_ have the form
2084 * "\\<server>\pipe\<pipename>". <server> may be "." for localhost.
2086 pncopy = g_strdup(pipename);
2087 if ( (pos=strstr(pncopy, "\\\\")) == pncopy) {
2088 pos = strchr(pncopy + 3, '\\');
2089 if (pos && g_ascii_strncasecmp(pos, PIPE_STR, strlen(PIPE_STR)) != 0)
2096 g_snprintf(errmsg, errmsgl,
2097 "The capture session could not be initiated because\n"
2098 "\"%s\" is neither an interface nor a pipe", pipename);
2099 pcap_opts->cap_pipe_err = PIPNEXIST;
2103 /* Wait for the pipe to appear */
2105 pcap_opts->cap_pipe_h = CreateFile(utf_8to16(pipename), GENERIC_READ, 0, NULL,
2106 OPEN_EXISTING, 0, NULL);
2108 if (pcap_opts->cap_pipe_h != INVALID_HANDLE_VALUE)
2111 if (GetLastError() != ERROR_PIPE_BUSY) {
2112 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
2113 NULL, GetLastError(), 0, (LPTSTR) &err_str, 0, NULL);
2114 g_snprintf(errmsg, errmsgl,
2115 "The capture session on \"%s\" could not be started "
2116 "due to error on pipe open: %s (error %d)",
2117 pipename, utf_16to8(err_str), GetLastError());
2119 pcap_opts->cap_pipe_err = PIPERR;
2123 if (!WaitNamedPipe(utf_8to16(pipename), 30 * 1000)) {
2124 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
2125 NULL, GetLastError(), 0, (LPTSTR) &err_str, 0, NULL);
2126 g_snprintf(errmsg, errmsgl,
2127 "The capture session on \"%s\" timed out during "
2128 "pipe open: %s (error %d)",
2129 pipename, utf_16to8(err_str), GetLastError());
2131 pcap_opts->cap_pipe_err = PIPERR;
2138 pcap_opts->from_cap_pipe = TRUE;
2141 if (pcap_opts->from_cap_socket)
2144 /* read the pcap header */
2146 while (bytes_read < sizeof magic) {
2147 sel_ret = cap_pipe_select(fd);
2149 g_snprintf(errmsg, errmsgl,
2150 "Unexpected error from select: %s", g_strerror(errno));
2152 } else if (sel_ret > 0) {
2153 b = cap_pipe_read(fd, ((char *)&magic)+bytes_read,
2154 sizeof magic-bytes_read,
2155 pcap_opts->from_cap_socket);
2158 g_snprintf(errmsg, errmsgl, "End of file on pipe magic during open");
2160 g_snprintf(errmsg, errmsgl, "Error on pipe magic during open: %s",
2170 #if GLIB_CHECK_VERSION(2,31,0)
2171 g_thread_new("cap_pipe_open_live", &cap_thread_read, pcap_opts);
2173 g_thread_create(&cap_thread_read, pcap_opts, FALSE, NULL);
2176 pcap_opts->cap_pipe_buf = (char *) &magic;
2177 pcap_opts->cap_pipe_bytes_read = 0;
2178 pcap_opts->cap_pipe_bytes_to_read = sizeof(magic);
2179 /* We don't have to worry about cap_pipe_read_mtx here */
2180 g_async_queue_push(pcap_opts->cap_pipe_pending_q, pcap_opts->cap_pipe_buf);
2181 g_async_queue_pop(pcap_opts->cap_pipe_done_q);
2182 if (pcap_opts->cap_pipe_bytes_read <= 0) {
2183 if (pcap_opts->cap_pipe_bytes_read == 0)
2184 g_snprintf(errmsg, errmsgl, "End of file on pipe magic during open");
2186 g_snprintf(errmsg, errmsgl, "Error on pipe magic during open: %s",
2195 case PCAP_NSEC_MAGIC:
2196 /* Host that wrote it has our byte order, and was running
2197 a program using either standard or ss990417 libpcap. */
2198 pcap_opts->cap_pipe_byte_swapped = FALSE;
2199 pcap_opts->cap_pipe_modified = FALSE;
2200 pcap_opts->ts_nsec = magic == PCAP_NSEC_MAGIC;
2202 case PCAP_MODIFIED_MAGIC:
2203 /* Host that wrote it has our byte order, but was running
2204 a program using either ss990915 or ss991029 libpcap. */
2205 pcap_opts->cap_pipe_byte_swapped = FALSE;
2206 pcap_opts->cap_pipe_modified = TRUE;
2208 case PCAP_SWAPPED_MAGIC:
2209 case PCAP_SWAPPED_NSEC_MAGIC:
2210 /* Host that wrote it has a byte order opposite to ours,
2211 and was running a program using either standard or
2212 ss990417 libpcap. */
2213 pcap_opts->cap_pipe_byte_swapped = TRUE;
2214 pcap_opts->cap_pipe_modified = FALSE;
2215 pcap_opts->ts_nsec = magic == PCAP_SWAPPED_NSEC_MAGIC;
2217 case PCAP_SWAPPED_MODIFIED_MAGIC:
2218 /* Host that wrote it out has a byte order opposite to
2219 ours, and was running a program using either ss990915
2220 or ss991029 libpcap. */
2221 pcap_opts->cap_pipe_byte_swapped = TRUE;
2222 pcap_opts->cap_pipe_modified = TRUE;
2225 /* Not a "libpcap" type we know about. */
2226 g_snprintf(errmsg, errmsgl, "Unrecognized libpcap format");
2231 if (pcap_opts->from_cap_socket)
2234 /* Read the rest of the header */
2236 while (bytes_read < sizeof(struct pcap_hdr)) {
2237 sel_ret = cap_pipe_select(fd);
2239 g_snprintf(errmsg, errmsgl,
2240 "Unexpected error from select: %s", g_strerror(errno));
2242 } else if (sel_ret > 0) {
2243 b = cap_pipe_read(fd, ((char *)hdr)+bytes_read,
2244 sizeof(struct pcap_hdr) - bytes_read,
2245 pcap_opts->from_cap_socket);
2248 g_snprintf(errmsg, errmsgl, "End of file on pipe header during open");
2250 g_snprintf(errmsg, errmsgl, "Error on pipe header during open: %s",
2260 pcap_opts->cap_pipe_buf = (char *) hdr;
2261 pcap_opts->cap_pipe_bytes_read = 0;
2262 pcap_opts->cap_pipe_bytes_to_read = sizeof(struct pcap_hdr);
2263 g_async_queue_push(pcap_opts->cap_pipe_pending_q, pcap_opts->cap_pipe_buf);
2264 g_async_queue_pop(pcap_opts->cap_pipe_done_q);
2265 if (pcap_opts->cap_pipe_bytes_read <= 0) {
2266 if (pcap_opts->cap_pipe_bytes_read == 0)
2267 g_snprintf(errmsg, errmsgl, "End of file on pipe header during open");
2269 g_snprintf(errmsg, errmsgl, "Error on pipe header header during open: %s",
2276 if (pcap_opts->cap_pipe_byte_swapped) {
2277 /* Byte-swap the header fields about which we care. */
2278 hdr->version_major = BSWAP16(hdr->version_major);
2279 hdr->version_minor = BSWAP16(hdr->version_minor);
2280 hdr->snaplen = BSWAP32(hdr->snaplen);
2281 hdr->network = BSWAP32(hdr->network);
2283 pcap_opts->linktype = hdr->network;
2285 if (hdr->version_major < 2) {
2286 g_snprintf(errmsg, errmsgl, "Unable to read old libpcap format");
2290 pcap_opts->cap_pipe_state = STATE_EXPECT_REC_HDR;
2291 pcap_opts->cap_pipe_err = PIPOK;
2292 pcap_opts->cap_pipe_fd = fd;
2296 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "cap_pipe_open_live: error %s", errmsg);
2297 pcap_opts->cap_pipe_err = PIPERR;
2298 cap_pipe_close(fd, pcap_opts->from_cap_socket);
2299 pcap_opts->cap_pipe_fd = -1;
2303 /* We read one record from the pipe, take care of byte order in the record
2304 * header, write the record to the capture file, and update capture statistics. */
2306 cap_pipe_dispatch(loop_data *ld, pcap_options *pcap_opts, guchar *data, char *errmsg, int errmsgl)
2308 struct pcap_pkthdr phdr;
2309 enum { PD_REC_HDR_READ, PD_DATA_READ, PD_PIPE_EOF, PD_PIPE_ERR,
2312 #if !GLIB_CHECK_VERSION(2,31,18)
2320 #ifdef LOG_CAPTURE_VERBOSE
2321 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "cap_pipe_dispatch");
2324 switch (pcap_opts->cap_pipe_state) {
2326 case STATE_EXPECT_REC_HDR:
2328 if (g_mutex_trylock(pcap_opts->cap_pipe_read_mtx)) {
2331 pcap_opts->cap_pipe_state = STATE_READ_REC_HDR;
2332 pcap_opts->cap_pipe_bytes_to_read = pcap_opts->cap_pipe_modified ?
2333 sizeof(struct pcaprec_modified_hdr) : sizeof(struct pcaprec_hdr);
2334 pcap_opts->cap_pipe_bytes_read = 0;
2337 pcap_opts->cap_pipe_buf = (char *) &pcap_opts->cap_pipe_rechdr;
2338 g_async_queue_push(pcap_opts->cap_pipe_pending_q, pcap_opts->cap_pipe_buf);
2339 g_mutex_unlock(pcap_opts->cap_pipe_read_mtx);
2344 case STATE_READ_REC_HDR:
2346 if (pcap_opts->from_cap_socket)
2349 b = cap_pipe_read(pcap_opts->cap_pipe_fd, ((char *)&pcap_opts->cap_pipe_rechdr)+pcap_opts->cap_pipe_bytes_read,
2350 pcap_opts->cap_pipe_bytes_to_read - pcap_opts->cap_pipe_bytes_read, pcap_opts->from_cap_socket);
2353 result = PD_PIPE_EOF;
2355 result = PD_PIPE_ERR;
2358 pcap_opts->cap_pipe_bytes_read += b;
2362 #if GLIB_CHECK_VERSION(2,31,18)
2363 q_status = g_async_queue_timeout_pop(pcap_opts->cap_pipe_done_q, PIPE_READ_TIMEOUT);
2365 g_get_current_time(&wait_time);
2366 g_time_val_add(&wait_time, PIPE_READ_TIMEOUT);
2367 q_status = g_async_queue_timed_pop(pcap_opts->cap_pipe_done_q, &wait_time);
2369 if (pcap_opts->cap_pipe_err == PIPEOF) {
2370 result = PD_PIPE_EOF;
2372 } else if (pcap_opts->cap_pipe_err == PIPERR) {
2373 result = PD_PIPE_ERR;
2381 if (pcap_opts->cap_pipe_bytes_read < pcap_opts->cap_pipe_bytes_to_read)
2383 result = PD_REC_HDR_READ;
2386 case STATE_EXPECT_DATA:
2388 if (g_mutex_trylock(pcap_opts->cap_pipe_read_mtx)) {
2391 pcap_opts->cap_pipe_state = STATE_READ_DATA;
2392 pcap_opts->cap_pipe_bytes_to_read = pcap_opts->cap_pipe_rechdr.hdr.incl_len;
2393 pcap_opts->cap_pipe_bytes_read = 0;
2396 pcap_opts->cap_pipe_buf = (char *) data;
2397 g_async_queue_push(pcap_opts->cap_pipe_pending_q, pcap_opts->cap_pipe_buf);
2398 g_mutex_unlock(pcap_opts->cap_pipe_read_mtx);
2403 case STATE_READ_DATA:
2405 if (pcap_opts->from_cap_socket)
2408 b = cap_pipe_read(pcap_opts->cap_pipe_fd,
2409 data+pcap_opts->cap_pipe_bytes_read,
2410 pcap_opts->cap_pipe_bytes_to_read - pcap_opts->cap_pipe_bytes_read,
2411 pcap_opts->from_cap_socket);
2414 result = PD_PIPE_EOF;
2416 result = PD_PIPE_ERR;
2419 pcap_opts->cap_pipe_bytes_read += b;
2424 #if GLIB_CHECK_VERSION(2,31,18)
2425 q_status = g_async_queue_timeout_pop(pcap_opts->cap_pipe_done_q, PIPE_READ_TIMEOUT);
2427 g_get_current_time(&wait_time);
2428 g_time_val_add(&wait_time, PIPE_READ_TIMEOUT);
2429 q_status = g_async_queue_timed_pop(pcap_opts->cap_pipe_done_q, &wait_time);
2430 #endif /* GLIB_CHECK_VERSION(2,31,18) */
2431 if (pcap_opts->cap_pipe_err == PIPEOF) {
2432 result = PD_PIPE_EOF;
2434 } else if (pcap_opts->cap_pipe_err == PIPERR) {
2435 result = PD_PIPE_ERR;
2443 if (pcap_opts->cap_pipe_bytes_read < pcap_opts->cap_pipe_bytes_to_read)
2445 result = PD_DATA_READ;
2449 g_snprintf(errmsg, errmsgl, "cap_pipe_dispatch: invalid state");
2452 } /* switch (pcap_opts->cap_pipe_state) */
2455 * We've now read as much data as we were expecting, so process it.
2459 case PD_REC_HDR_READ:
2460 /* We've read the header. Take care of byte order. */
2461 cap_pipe_adjust_header(pcap_opts->cap_pipe_byte_swapped, &pcap_opts->cap_pipe_hdr,
2462 &pcap_opts->cap_pipe_rechdr.hdr);
2463 if (pcap_opts->cap_pipe_rechdr.hdr.incl_len > WTAP_MAX_PACKET_SIZE) {
2464 g_snprintf(errmsg, errmsgl, "Frame %u too long (%d bytes)",
2465 ld->packet_count+1, pcap_opts->cap_pipe_rechdr.hdr.incl_len);
2469 if (pcap_opts->cap_pipe_rechdr.hdr.incl_len) {
2470 pcap_opts->cap_pipe_state = STATE_EXPECT_DATA;
2473 /* no data to read? fall through */
2476 /* Fill in a "struct pcap_pkthdr", and process the packet. */
2477 phdr.ts.tv_sec = pcap_opts->cap_pipe_rechdr.hdr.ts_sec;
2478 phdr.ts.tv_usec = pcap_opts->cap_pipe_rechdr.hdr.ts_usec;
2479 phdr.caplen = pcap_opts->cap_pipe_rechdr.hdr.incl_len;
2480 phdr.len = pcap_opts->cap_pipe_rechdr.hdr.orig_len;
2483 capture_loop_queue_packet_cb((u_char *)pcap_opts, &phdr, data);
2485 capture_loop_write_packet_cb((u_char *)pcap_opts, &phdr, data);
2487 pcap_opts->cap_pipe_state = STATE_EXPECT_REC_HDR;
2491 pcap_opts->cap_pipe_err = PIPEOF;
2496 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
2497 NULL, GetLastError(), 0, (LPTSTR) &err_str, 0, NULL);
2498 g_snprintf(errmsg, errmsgl,
2499 "Error reading from pipe: %s (error %d)",
2500 utf_16to8(err_str), GetLastError());
2503 g_snprintf(errmsg, errmsgl, "Error reading from pipe: %s",
2511 pcap_opts->cap_pipe_err = PIPERR;
2512 /* Return here rather than inside the switch to prevent GCC warning */
2517 /** Open the capture input file (pcap or capture pipe).
2518 * Returns TRUE if it succeeds, FALSE otherwise. */
2520 capture_loop_open_input(capture_options *capture_opts, loop_data *ld,
2521 char *errmsg, size_t errmsg_len,
2522 char *secondary_errmsg, size_t secondary_errmsg_len)
2524 gchar open_err_str[PCAP_ERRBUF_SIZE];
2525 gchar *sync_msg_str;
2526 interface_options interface_opts;
2527 pcap_options *pcap_opts;
2531 gchar *sync_secondary_msg_str;
2532 WORD wVersionRequested;
2536 /* XXX - opening Winsock on tshark? */
2538 /* Initialize Windows Socket if we are in a WIN32 OS
2539 This needs to be done before querying the interface for network/netmask */
2541 /* XXX - do we really require 1.1 or earlier?
2542 Are there any versions that support only 2.0 or higher? */
2543 wVersionRequested = MAKEWORD(1, 1);
2544 err = WSAStartup(wVersionRequested, &wsaData);
2548 case WSASYSNOTREADY:
2549 g_snprintf(errmsg, (gulong) errmsg_len,
2550 "Couldn't initialize Windows Sockets: Network system not ready for network communication");
2553 case WSAVERNOTSUPPORTED:
2554 g_snprintf(errmsg, (gulong) errmsg_len,
2555 "Couldn't initialize Windows Sockets: Windows Sockets version %u.%u not supported",
2556 LOBYTE(wVersionRequested), HIBYTE(wVersionRequested));
2559 case WSAEINPROGRESS:
2560 g_snprintf(errmsg, (gulong) errmsg_len,
2561 "Couldn't initialize Windows Sockets: Blocking operation is in progress");
2565 g_snprintf(errmsg, (gulong) errmsg_len,
2566 "Couldn't initialize Windows Sockets: Limit on the number of tasks supported by this WinSock implementation has been reached");
2570 g_snprintf(errmsg, (gulong) errmsg_len,
2571 "Couldn't initialize Windows Sockets: Bad pointer passed to WSAStartup");
2575 g_snprintf(errmsg, (gulong) errmsg_len,
2576 "Couldn't initialize Windows Sockets: error %d", err);
2579 g_snprintf(secondary_errmsg, (gulong) secondary_errmsg_len, please_report);
2583 if ((use_threads == FALSE) &&
2584 (capture_opts->ifaces->len > 1)) {
2585 g_snprintf(errmsg, (gulong) errmsg_len,
2586 "Using threads is required for capturing on multiple interfaces!");
2590 for (i = 0; i < capture_opts->ifaces->len; i++) {
2591 interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
2592 pcap_opts = (pcap_options *)g_malloc(sizeof (pcap_options));
2593 if (pcap_opts == NULL) {
2594 g_snprintf(errmsg, (gulong) errmsg_len,
2595 "Could not allocate memory.");
2598 pcap_opts->received = 0;
2599 pcap_opts->dropped = 0;
2600 pcap_opts->flushed = 0;
2601 pcap_opts->pcap_h = NULL;
2602 #ifdef MUST_DO_SELECT
2603 pcap_opts->pcap_fd = -1;
2605 pcap_opts->pcap_err = FALSE;
2606 pcap_opts->interface_id = i;
2607 pcap_opts->tid = NULL;
2608 pcap_opts->snaplen = 0;
2609 pcap_opts->linktype = -1;
2610 pcap_opts->ts_nsec = FALSE;
2611 pcap_opts->from_cap_pipe = FALSE;
2612 pcap_opts->from_cap_socket = FALSE;
2613 memset(&pcap_opts->cap_pipe_hdr, 0, sizeof(struct pcap_hdr));
2614 memset(&pcap_opts->cap_pipe_rechdr, 0, sizeof(struct pcaprec_modified_hdr));
2616 pcap_opts->cap_pipe_h = INVALID_HANDLE_VALUE;
2618 pcap_opts->cap_pipe_fd = -1;
2619 pcap_opts->cap_pipe_modified = FALSE;
2620 pcap_opts->cap_pipe_byte_swapped = FALSE;
2622 pcap_opts->cap_pipe_buf = NULL;
2624 pcap_opts->cap_pipe_bytes_to_read = 0;
2625 pcap_opts->cap_pipe_bytes_read = 0;
2626 pcap_opts->cap_pipe_state = STATE_EXPECT_REC_HDR;
2627 pcap_opts->cap_pipe_err = PIPOK;
2629 #if GLIB_CHECK_VERSION(2,31,0)
2630 pcap_opts->cap_pipe_read_mtx = g_malloc(sizeof(GMutex));
2631 g_mutex_init(pcap_opts->cap_pipe_read_mtx);
2633 pcap_opts->cap_pipe_read_mtx = g_mutex_new();
2635 pcap_opts->cap_pipe_pending_q = g_async_queue_new();
2636 pcap_opts->cap_pipe_done_q = g_async_queue_new();
2638 g_array_append_val(ld->pcaps, pcap_opts);
2640 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_open_input : %s", interface_opts.name);
2641 pcap_opts->pcap_h = open_capture_device(&interface_opts, &open_err_str);
2643 if (pcap_opts->pcap_h != NULL) {
2644 /* we've opened "iface" as a network device */
2646 /* try to set the capture buffer size */
2647 if (interface_opts.buffer_size > 1 &&
2648 pcap_setbuff(pcap_opts->pcap_h, interface_opts.buffer_size * 1024 * 1024) != 0) {
2649 sync_secondary_msg_str = g_strdup_printf(
2650 "The capture buffer size of %dMB seems to be too high for your machine,\n"
2651 "the default of 1MB will be used.\n"
2653 "Nonetheless, the capture is started.\n",
2654 interface_opts.buffer_size);
2655 report_capture_error("Couldn't set the capture buffer size!",
2656 sync_secondary_msg_str);
2657 g_free(sync_secondary_msg_str);
2661 #if defined(HAVE_PCAP_SETSAMPLING)
2662 if (interface_opts.sampling_method != CAPTURE_SAMP_NONE) {
2663 struct pcap_samp *samp;
2665 if ((samp = pcap_setsampling(pcap_opts->pcap_h)) != NULL) {
2666 switch (interface_opts.sampling_method) {
2667 case CAPTURE_SAMP_BY_COUNT:
2668 samp->method = PCAP_SAMP_1_EVERY_N;
2671 case CAPTURE_SAMP_BY_TIMER:
2672 samp->method = PCAP_SAMP_FIRST_AFTER_N_MS;
2676 sync_msg_str = g_strdup_printf(
2677 "Unknown sampling method %d specified,\n"
2678 "continue without packet sampling",
2679 interface_opts.sampling_method);
2680 report_capture_error("Couldn't set the capture "
2681 "sampling", sync_msg_str);
2682 g_free(sync_msg_str);
2684 samp->value = interface_opts.sampling_param;
2686 report_capture_error("Couldn't set the capture sampling",
2687 "Cannot get packet sampling data structure");
2692 /* setting the data link type only works on real interfaces */
2693 if (!set_pcap_linktype(pcap_opts->pcap_h, interface_opts.linktype, interface_opts.name,
2695 secondary_errmsg, secondary_errmsg_len)) {
2698 pcap_opts->linktype = get_pcap_linktype(pcap_opts->pcap_h, interface_opts.name);
2700 /* We couldn't open "iface" as a network device. */
2701 /* Try to open it as a pipe */
2702 cap_pipe_open_live(interface_opts.name, pcap_opts, &pcap_opts->cap_pipe_hdr, errmsg, (int) errmsg_len);
2705 if (pcap_opts->cap_pipe_fd == -1) {
2707 if (pcap_opts->cap_pipe_h == INVALID_HANDLE_VALUE) {
2709 if (pcap_opts->cap_pipe_err == PIPNEXIST) {
2710 /* Pipe doesn't exist, so output message for interface */
2711 get_capture_device_open_failure_messages(open_err_str,
2712 interface_opts.name,
2716 secondary_errmsg_len);
2719 * Else pipe (or file) does exist and cap_pipe_open_live() has
2724 /* cap_pipe_open_live() succeeded; don't want
2725 error message from pcap_open_live() */
2726 open_err_str[0] = '\0';
2730 /* XXX - will this work for tshark? */
2731 #ifdef MUST_DO_SELECT
2732 if (!pcap_opts->from_cap_pipe) {
2733 #ifdef HAVE_PCAP_GET_SELECTABLE_FD
2734 pcap_opts->pcap_fd = pcap_get_selectable_fd(pcap_opts->pcap_h);
2736 pcap_opts->pcap_fd = pcap_fileno(pcap_opts->pcap_h);
2741 /* Does "open_err_str" contain a non-empty string? If so, "pcap_open_live()"
2742 returned a warning; print it, but keep capturing. */
2743 if (open_err_str[0] != '\0') {
2744 sync_msg_str = g_strdup_printf("%s.", open_err_str);
2745 report_capture_error(sync_msg_str, "");
2746 g_free(sync_msg_str);
2748 capture_opts->ifaces = g_array_remove_index(capture_opts->ifaces, i);
2749 g_array_insert_val(capture_opts->ifaces, i, interface_opts);
2752 /* If not using libcap: we now can now set euid/egid to ruid/rgid */
2753 /* to remove any suid privileges. */
2754 /* If using libcap: we can now remove NET_RAW and NET_ADMIN capabilities */
2755 /* (euid/egid have already previously been set to ruid/rgid. */
2756 /* (See comment in main() for details) */
2758 relinquish_special_privs_perm();
2760 relinquish_all_capabilities();
2765 /* close the capture input file (pcap or capture pipe) */
2766 static void capture_loop_close_input(loop_data *ld)
2769 pcap_options *pcap_opts;
2771 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_close_input");
2773 for (i = 0; i < ld->pcaps->len; i++) {
2774 pcap_opts = g_array_index(ld->pcaps, pcap_options *, i);
2775 /* if open, close the capture pipe "input file" */
2776 if (pcap_opts->cap_pipe_fd >= 0) {
2777 g_assert(pcap_opts->from_cap_pipe);
2778 cap_pipe_close(pcap_opts->cap_pipe_fd, pcap_opts->from_cap_socket);
2779 pcap_opts->cap_pipe_fd = -1;
2782 if (pcap_opts->cap_pipe_h != INVALID_HANDLE_VALUE) {
2783 CloseHandle(pcap_opts->cap_pipe_h);
2784 pcap_opts->cap_pipe_h = INVALID_HANDLE_VALUE;
2787 /* if open, close the pcap "input file" */
2788 if (pcap_opts->pcap_h != NULL) {
2789 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_close_input: closing %p", (void *)pcap_opts->pcap_h);
2790 pcap_close(pcap_opts->pcap_h);
2791 pcap_opts->pcap_h = NULL;
2798 /* Shut down windows sockets */
2804 /* init the capture filter */
2805 static initfilter_status_t
2806 capture_loop_init_filter(pcap_t *pcap_h, gboolean from_cap_pipe,
2807 const gchar * name, const gchar * cfilter)
2809 struct bpf_program fcode;
2811 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_init_filter: %s", cfilter);
2813 /* capture filters only work on real interfaces */
2814 if (cfilter && !from_cap_pipe) {
2815 /* A capture filter was specified; set it up. */
2816 if (!compile_capture_filter(name, pcap_h, &fcode, cfilter)) {
2817 /* Treat this specially - our caller might try to compile this
2818 as a display filter and, if that succeeds, warn the user that
2819 the display and capture filter syntaxes are different. */
2820 return INITFILTER_BAD_FILTER;
2822 if (pcap_setfilter(pcap_h, &fcode) < 0) {
2823 #ifdef HAVE_PCAP_FREECODE
2824 pcap_freecode(&fcode);
2826 return INITFILTER_OTHER_ERROR;
2828 #ifdef HAVE_PCAP_FREECODE
2829 pcap_freecode(&fcode);
2833 return INITFILTER_NO_ERROR;
2837 /* set up to write to the already-opened capture output file/files */
2839 capture_loop_init_output(capture_options *capture_opts, loop_data *ld, char *errmsg, int errmsg_len)
2843 pcap_options *pcap_opts;
2844 interface_options interface_opts;
2845 gboolean successful;
2847 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_init_output");
2849 if ((capture_opts->use_pcapng == FALSE) &&
2850 (capture_opts->ifaces->len > 1)) {
2851 g_snprintf(errmsg, errmsg_len,
2852 "Using PCAPNG is required for capturing on multiple interfaces! Use the -n option.");
2856 /* Set up to write to the capture file. */
2857 if (capture_opts->multi_files_on) {
2858 ld->pdh = ringbuf_init_libpcap_fdopen(&err);
2860 ld->pdh = ws_fdopen(ld->save_file_fd, "wb");
2861 if (ld->pdh == NULL) {
2866 if (capture_opts->use_pcapng) {
2868 GString *os_info_str;
2870 os_info_str = g_string_new("");
2871 get_os_version_info(os_info_str);
2873 g_snprintf(appname, sizeof(appname), "Dumpcap " VERSION "%s", wireshark_svnversion);
2874 successful = libpcap_write_session_header_block(libpcap_write_to_file, ld->pdh,
2875 (const char *)capture_opts->capture_comment, /* Comment*/
2877 os_info_str->str, /* OS*/
2879 -1, /* section_length */
2883 for (i = 0; successful && (i < capture_opts->ifaces->len); i++) {
2884 interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
2885 pcap_opts = g_array_index(ld->pcaps, pcap_options *, i);
2886 if (pcap_opts->from_cap_pipe) {
2887 pcap_opts->snaplen = pcap_opts->cap_pipe_hdr.snaplen;
2889 pcap_opts->snaplen = pcap_snapshot(pcap_opts->pcap_h);
2891 successful = libpcap_write_interface_description_block(libpcap_write_to_file, global_ld.pdh,
2892 NULL, /* OPT_COMMENT 1 */
2893 interface_opts.name, /* IDB_NAME 2 */
2894 interface_opts.descr, /* IDB_DESCRIPTION 3 */
2895 interface_opts.cfilter, /* IDB_FILTER 11 */
2896 os_info_str->str, /* IDB_OS 12 */
2897 pcap_opts->linktype,
2899 &(global_ld.bytes_written),
2900 0, /* IDB_IF_SPEED 8 */
2901 pcap_opts->ts_nsec ? 9 : 6, /* IDB_TSRESOL 9 */
2905 g_string_free(os_info_str, TRUE);
2908 pcap_opts = g_array_index(ld->pcaps, pcap_options *, 0);
2909 if (pcap_opts->from_cap_pipe) {
2910 pcap_opts->snaplen = pcap_opts->cap_pipe_hdr.snaplen;
2912 pcap_opts->snaplen = pcap_snapshot(pcap_opts->pcap_h);
2914 successful = libpcap_write_file_header(libpcap_write_to_file, ld->pdh, pcap_opts->linktype, pcap_opts->snaplen,
2915 pcap_opts->ts_nsec, &ld->bytes_written, &err);
2923 if (ld->pdh == NULL) {
2924 /* We couldn't set up to write to the capture file. */
2925 /* XXX - use cf_open_error_message from tshark instead? */
2930 g_snprintf(errmsg, errmsg_len,
2931 "The file to which the capture would be"
2932 " saved (\"%s\") could not be opened: Error %d.",
2933 capture_opts->save_file, err);
2935 g_snprintf(errmsg, errmsg_len,
2936 "The file to which the capture would be"
2937 " saved (\"%s\") could not be opened: %s.",
2938 capture_opts->save_file, g_strerror(err));
2950 capture_loop_close_output(capture_options *capture_opts, loop_data *ld, int *err_close)
2954 pcap_options *pcap_opts;
2955 guint64 end_time = create_timestamp();
2957 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_close_output");
2959 if (capture_opts->multi_files_on) {
2960 return ringbuf_libpcap_dump_close(&capture_opts->save_file, err_close);
2962 if (capture_opts->use_pcapng) {
2963 for (i = 0; i < global_ld.pcaps->len; i++) {
2964 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, i);
2965 if (!pcap_opts->from_cap_pipe) {
2966 guint64 isb_ifrecv, isb_ifdrop;
2967 struct pcap_stat stats;
2969 if (pcap_stats(pcap_opts->pcap_h, &stats) >= 0) {
2970 isb_ifrecv = pcap_opts->received;
2971 isb_ifdrop = stats.ps_drop + pcap_opts->dropped + pcap_opts->flushed;
2973 isb_ifrecv = G_MAXUINT64;
2974 isb_ifdrop = G_MAXUINT64;
2976 libpcap_write_interface_statistics_block(libpcap_write_to_file, ld->pdh,
2979 "Counters provided by dumpcap",
2988 if (fclose(ld->pdh) == EOF) {
2989 if (err_close != NULL) {
2999 /* dispatch incoming packets (pcap or capture pipe)
3001 * Waits for incoming packets to be available, and calls pcap_dispatch()
3002 * to cause them to be processed.
3004 * Returns the number of packets which were processed.
3006 * Times out (returning zero) after CAP_READ_TIMEOUT ms; this ensures that the
3007 * packet-batching behaviour does not cause packets to get held back
3011 capture_loop_dispatch(loop_data *ld,
3012 char *errmsg, int errmsg_len, pcap_options *pcap_opts)
3015 gint packet_count_before;
3016 guchar pcap_data[WTAP_MAX_PACKET_SIZE];
3021 packet_count_before = ld->packet_count;
3022 if (pcap_opts->from_cap_pipe) {
3023 /* dispatch from capture pipe */
3024 #ifdef LOG_CAPTURE_VERBOSE
3025 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_dispatch: from capture pipe");
3028 sel_ret = cap_pipe_select(pcap_opts->cap_pipe_fd);
3030 if (sel_ret < 0 && errno != EINTR) {
3031 g_snprintf(errmsg, errmsg_len,
3032 "Unexpected error from select: %s", g_strerror(errno));
3033 report_capture_error(errmsg, please_report);
3038 * "select()" says we can read from the pipe without blocking
3041 inpkts = cap_pipe_dispatch(ld, pcap_opts, pcap_data, errmsg, errmsg_len);
3051 /* dispatch from pcap */
3052 #ifdef MUST_DO_SELECT
3054 * If we have "pcap_get_selectable_fd()", we use it to get the
3055 * descriptor on which to select; if that's -1, it means there
3056 * is no descriptor on which you can do a "select()" (perhaps
3057 * because you're capturing on a special device, and that device's
3058 * driver unfortunately doesn't support "select()", in which case
3059 * we don't do the select - which means it might not be possible
3060 * to stop a capture until a packet arrives. If that's unacceptable,
3061 * plead with whoever supplies the software for that device to add
3062 * "select()" support, or upgrade to libpcap 0.8.1 or later, and
3063 * rebuild Wireshark or get a version built with libpcap 0.8.1 or
3064 * later, so it can use pcap_breakloop().
3066 #ifdef LOG_CAPTURE_VERBOSE
3067 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_dispatch: from pcap_dispatch with select");
3069 if (pcap_opts->pcap_fd != -1) {
3070 sel_ret = cap_pipe_select(pcap_opts->pcap_fd);
3073 * "select()" says we can read from it without blocking; go for
3076 * We don't have pcap_breakloop(), so we only process one packet
3077 * per pcap_dispatch() call, to allow a signal to stop the
3078 * processing immediately, rather than processing all packets
3079 * in a batch before quitting.
3082 inpkts = pcap_dispatch(pcap_opts->pcap_h, 1, capture_loop_queue_packet_cb, (u_char *)pcap_opts);
3084 inpkts = pcap_dispatch(pcap_opts->pcap_h, 1, capture_loop_write_packet_cb, (u_char *)pcap_opts);
3088 /* Error, rather than pcap_breakloop(). */
3089 pcap_opts->pcap_err = TRUE;
3091 ld->go = FALSE; /* error or pcap_breakloop() - stop capturing */
3094 if (sel_ret < 0 && errno != EINTR) {
3095 g_snprintf(errmsg, errmsg_len,
3096 "Unexpected error from select: %s", g_strerror(errno));
3097 report_capture_error(errmsg, please_report);
3103 #endif /* MUST_DO_SELECT */
3105 /* dispatch from pcap without select */
3107 #ifdef LOG_CAPTURE_VERBOSE
3108 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_dispatch: from pcap_dispatch");
3112 * On Windows, we don't support asynchronously telling a process to
3113 * stop capturing; instead, we check for an indication on a pipe
3114 * after processing packets. We therefore process only one packet
3115 * at a time, so that we can check the pipe after every packet.
3118 inpkts = pcap_dispatch(pcap_opts->pcap_h, 1, capture_loop_queue_packet_cb, (u_char *)pcap_opts);
3120 inpkts = pcap_dispatch(pcap_opts->pcap_h, 1, capture_loop_write_packet_cb, (u_char *)pcap_opts);
3124 inpkts = pcap_dispatch(pcap_opts->pcap_h, -1, capture_loop_queue_packet_cb, (u_char *)pcap_opts);
3126 inpkts = pcap_dispatch(pcap_opts->pcap_h, -1, capture_loop_write_packet_cb, (u_char *)pcap_opts);
3131 /* Error, rather than pcap_breakloop(). */
3132 pcap_opts->pcap_err = TRUE;
3134 ld->go = FALSE; /* error or pcap_breakloop() - stop capturing */
3136 #else /* pcap_next_ex */
3137 #ifdef LOG_CAPTURE_VERBOSE
3138 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_dispatch: from pcap_next_ex");
3140 /* XXX - this is currently unused, as there is some confusion with pcap_next_ex() vs. pcap_dispatch() */
3143 * WinPcap's remote capturing feature doesn't work with pcap_dispatch(),
3144 * see http://wiki.wireshark.org/CaptureSetup_2fWinPcapRemote
3145 * This should be fixed in the WinPcap 4.0 alpha release.
3147 * For reference, an example remote interface:
3148 * rpcap://[1.2.3.4]/\Device\NPF_{39993D68-7C9B-4439-A329-F2D888DA7C5C}
3151 /* emulate dispatch from pcap */
3154 struct pcap_pkthdr *pkt_header;
3159 (in = pcap_next_ex(pcap_opts->pcap_h, &pkt_header, &pkt_data)) == 1) {
3161 capture_loop_queue_packet_cb((u_char *)pcap_opts, pkt_header, pkt_data);
3163 capture_loop_write_packet_cb((u_char *)pcap_opts, pkt_header, pkt_data);
3168 pcap_opts->pcap_err = TRUE;
3172 #endif /* pcap_next_ex */
3176 #ifdef LOG_CAPTURE_VERBOSE
3177 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_dispatch: %d new packet%s", inpkts, plurality(inpkts, "", "s"));
3180 return ld->packet_count - packet_count_before;
3184 /* Isolate the Universally Unique Identifier from the interface. Basically, we
3185 * want to grab only the characters between the '{' and '}' delimiters.
3187 * Returns a GString that must be freed with g_string_free(). */
3189 isolate_uuid(const char *iface)
3194 ptr = strchr(iface, '{');
3196 return g_string_new(iface);
3197 gstr = g_string_new(ptr + 1);
3199 ptr = strchr(gstr->str, '}');
3203 gstr = g_string_truncate(gstr, ptr - gstr->str);
3208 /* open the output file (temporary/specified name/ringbuffer/named pipe/stdout) */
3209 /* Returns TRUE if the file opened successfully, FALSE otherwise. */
3211 capture_loop_open_output(capture_options *capture_opts, int *save_file_fd,
3212 char *errmsg, int errmsg_len)
3215 gchar *capfile_name;
3217 gboolean is_tempfile;
3219 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_open_output: %s",
3220 (capture_opts->save_file) ? capture_opts->save_file : "(not specified)");
3222 if (capture_opts->save_file != NULL) {
3223 /* We return to the caller while the capture is in progress.
3224 * Therefore we need to take a copy of save_file in
3225 * case the caller destroys it after we return.
3227 capfile_name = g_strdup(capture_opts->save_file);
3229 if (capture_opts->output_to_pipe == TRUE) { /* either "-" or named pipe */
3230 if (capture_opts->multi_files_on) {
3231 /* ringbuffer is enabled; that doesn't work with standard output or a named pipe */
3232 g_snprintf(errmsg, errmsg_len,
3233 "Ring buffer requested, but capture is being written to standard output or to a named pipe.");
3234 g_free(capfile_name);
3237 if (strcmp(capfile_name, "-") == 0) {
3238 /* write to stdout */
3241 /* set output pipe to binary mode to avoid Windows text-mode processing (eg: for CR/LF) */
3242 _setmode(1, O_BINARY);
3245 } /* if (...output_to_pipe ... */
3248 if (capture_opts->multi_files_on) {
3249 /* ringbuffer is enabled */
3250 *save_file_fd = ringbuf_init(capfile_name,
3251 (capture_opts->has_ring_num_files) ? capture_opts->ring_num_files : 0,
3252 capture_opts->group_read_access);
3254 /* we need the ringbuf name */
3255 if (*save_file_fd != -1) {
3256 g_free(capfile_name);
3257 capfile_name = g_strdup(ringbuf_current_filename());
3260 /* Try to open/create the specified file for use as a capture buffer. */
3261 *save_file_fd = ws_open(capfile_name, O_RDWR|O_BINARY|O_TRUNC|O_CREAT,
3262 (capture_opts->group_read_access) ? 0640 : 0600);
3265 is_tempfile = FALSE;
3267 /* Choose a random name for the temporary capture buffer */
3268 if (global_capture_opts.ifaces->len > 1) {
3269 prefix = g_strdup_printf("wireshark_%d_interfaces", global_capture_opts.ifaces->len);
3272 basename = g_path_get_basename(g_array_index(global_capture_opts.ifaces, interface_options, 0).console_display_name);
3274 /* use the generic portion of the interface guid to form the basis of the filename */
3275 if (strncmp("NPF_{", basename, 5)==0)
3277 /* we have a windows guid style device name, extract the guid digits as the basis of the filename */
3279 iface = isolate_uuid(basename);
3281 basename = g_strdup(iface->str);
3282 g_string_free(iface, TRUE);
3285 /* generate the temp file name prefix...
3286 * It would be nice if we could specify a pcapng/pcap filename suffix,
3287 * create_tempfile() however currently uses mkstemp() which doesn't allow this - one day perhaps*/
3288 if (capture_opts->use_pcapng) {
3289 prefix = g_strconcat("wireshark_pcapng_", basename, NULL);
3291 prefix = g_strconcat("wireshark_pcap_", basename, NULL);
3295 *save_file_fd = create_tempfile(&tmpname, prefix);
3297 capfile_name = g_strdup(tmpname);
3301 /* did we fail to open the output file? */
3302 if (*save_file_fd == -1) {
3304 g_snprintf(errmsg, errmsg_len,
3305 "The temporary file to which the capture would be saved (\"%s\") "
3306 "could not be opened: %s.", capfile_name, g_strerror(errno));
3308 if (capture_opts->multi_files_on) {
3309 ringbuf_error_cleanup();
3312 g_snprintf(errmsg, errmsg_len,
3313 "The file to which the capture would be saved (\"%s\") "
3314 "could not be opened: %s.", capfile_name,
3317 g_free(capfile_name);
3321 if (capture_opts->save_file != NULL) {
3322 g_free(capture_opts->save_file);
3324 capture_opts->save_file = capfile_name;
3325 /* capture_opts.save_file is "g_free"ed later, which is equivalent to
3326 "g_free(capfile_name)". */
3332 /* Do the work of handling either the file size or file duration capture
3333 conditions being reached, and switching files or stopping. */
3335 do_file_switch_or_stop(capture_options *capture_opts,
3336 condition *cnd_autostop_files,
3337 condition *cnd_autostop_size,
3338 condition *cnd_file_duration)
3341 pcap_options *pcap_opts;
3342 interface_options interface_opts;
3343 gboolean successful;
3345 if (capture_opts->multi_files_on) {
3346 if (cnd_autostop_files != NULL &&
3347 cnd_eval(cnd_autostop_files, ++global_ld.autostop_files)) {
3348 /* no files left: stop here */
3349 global_ld.go = FALSE;
3353 /* Switch to the next ringbuffer file */
3354 if (ringbuf_switch_file(&global_ld.pdh, &capture_opts->save_file,
3355 &global_ld.save_file_fd, &global_ld.err)) {
3357 /* File switch succeeded: reset the conditions */
3358 global_ld.bytes_written = 0;
3359 if (capture_opts->use_pcapng) {
3361 GString *os_info_str;
3363 os_info_str = g_string_new("");
3364 get_os_version_info(os_info_str);
3366 g_snprintf(appname, sizeof(appname), "Dumpcap " VERSION "%s", wireshark_svnversion);
3367 successful = libpcap_write_session_header_block(libpcap_write_to_file, global_ld.pdh,
3370 os_info_str->str, /* OS */
3372 -1, /* section_length */
3373 &(global_ld.bytes_written),
3376 for (i = 0; successful && (i < capture_opts->ifaces->len); i++) {
3377 interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
3378 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, i);
3379 successful = libpcap_write_interface_description_block(libpcap_write_to_file, global_ld.pdh,
3380 NULL, /* OPT_COMMENT 1 */
3381 interface_opts.name, /* IDB_NAME 2 */
3382 interface_opts.descr, /* IDB_DESCRIPTION 3 */
3383 interface_opts.cfilter, /* IDB_FILTER 11 */
3384 os_info_str->str, /* IDB_OS 12 */
3385 pcap_opts->linktype,
3387 &(global_ld.bytes_written),
3388 0, /* IDB_IF_SPEED 8 */
3389 pcap_opts->ts_nsec ? 9 : 6, /* IDB_TSRESOL 9 */
3393 g_string_free(os_info_str, TRUE);
3396 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, 0);
3397 successful = libpcap_write_file_header(libpcap_write_to_file, global_ld.pdh, pcap_opts->linktype, pcap_opts->snaplen,
3398 pcap_opts->ts_nsec, &global_ld.bytes_written, &global_ld.err);
3401 fclose(global_ld.pdh);
3402 global_ld.pdh = NULL;
3403 global_ld.go = FALSE;
3406 if (cnd_autostop_size)
3407 cnd_reset(cnd_autostop_size);
3408 if (cnd_file_duration)
3409 cnd_reset(cnd_file_duration);
3410 fflush(global_ld.pdh);
3412 report_packet_count(global_ld.inpkts_to_sync_pipe);
3413 global_ld.inpkts_to_sync_pipe = 0;
3414 report_new_capture_file(capture_opts->save_file);
3416 /* File switch failed: stop here */
3417 global_ld.go = FALSE;
3421 /* single file, stop now */
3422 global_ld.go = FALSE;
3429 pcap_read_handler(void* arg)
3431 pcap_options *pcap_opts;
3432 char errmsg[MSG_MAX_LENGTH+1];
3434 pcap_opts = (pcap_options *)arg;
3436 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Started thread for interface %d.",
3437 pcap_opts->interface_id);
3439 while (global_ld.go) {
3440 /* dispatch incoming packets */
3441 capture_loop_dispatch(&global_ld, errmsg, sizeof(errmsg), pcap_opts);
3443 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Stopped thread for interface %d.",
3444 pcap_opts->interface_id);
3445 g_thread_exit(NULL);
3449 /* Do the low-level work of a capture.
3450 Returns TRUE if it succeeds, FALSE otherwise. */
3452 capture_loop_start(capture_options *capture_opts, gboolean *stats_known, struct pcap_stat *stats)
3455 DWORD upd_time, cur_time; /* GetTickCount() returns a "DWORD" (which is 'unsigned long') */
3457 struct timeval upd_time, cur_time;
3461 condition *cnd_file_duration = NULL;
3462 condition *cnd_autostop_files = NULL;
3463 condition *cnd_autostop_size = NULL;
3464 condition *cnd_autostop_duration = NULL;
3467 gboolean cfilter_error = FALSE;
3468 char errmsg[MSG_MAX_LENGTH+1];
3469 char secondary_errmsg[MSG_MAX_LENGTH+1];
3470 pcap_options *pcap_opts;
3471 interface_options interface_opts;
3472 guint i, error_index = 0;
3475 *secondary_errmsg = '\0';
3477 /* init the loop data */
3478 global_ld.go = TRUE;
3479 global_ld.packet_count = 0;
3481 global_ld.report_packet_count = FALSE;
3483 if (capture_opts->has_autostop_packets)
3484 global_ld.packet_max = capture_opts->autostop_packets;
3486 global_ld.packet_max = 0; /* no limit */
3487 global_ld.inpkts_to_sync_pipe = 0;
3488 global_ld.err = 0; /* no error seen yet */
3489 global_ld.pdh = NULL;
3490 global_ld.autostop_files = 0;
3491 global_ld.save_file_fd = -1;
3493 /* We haven't yet gotten the capture statistics. */
3494 *stats_known = FALSE;
3496 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Capture loop starting ...");
3497 capture_opts_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, capture_opts);
3499 /* open the "input file" from network interface or capture pipe */
3500 if (!capture_loop_open_input(capture_opts, &global_ld, errmsg, sizeof(errmsg),
3501 secondary_errmsg, sizeof(secondary_errmsg))) {
3504 for (i = 0; i < capture_opts->ifaces->len; i++) {
3505 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, i);
3506 interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
3507 /* init the input filter from the network interface (capture pipe will do nothing) */
3509 * When remote capturing WinPCap crashes when the capture filter
3510 * is NULL. This might be a bug in WPCap. Therefore we provide an empty
3513 switch (capture_loop_init_filter(pcap_opts->pcap_h, pcap_opts->from_cap_pipe,
3514 interface_opts.name,
3515 interface_opts.cfilter?interface_opts.cfilter:"")) {
3517 case INITFILTER_NO_ERROR:
3520 case INITFILTER_BAD_FILTER:
3521 cfilter_error = TRUE;
3523 g_snprintf(errmsg, sizeof(errmsg), "%s", pcap_geterr(pcap_opts->pcap_h));
3526 case INITFILTER_OTHER_ERROR:
3527 g_snprintf(errmsg, sizeof(errmsg), "Can't install filter (%s).",
3528 pcap_geterr(pcap_opts->pcap_h));
3529 g_snprintf(secondary_errmsg, sizeof(secondary_errmsg), "%s", please_report);
3534 /* If we're supposed to write to a capture file, open it for output
3535 (temporary/specified name/ringbuffer) */
3536 if (capture_opts->saving_to_file) {
3537 if (!capture_loop_open_output(capture_opts, &global_ld.save_file_fd,
3538 errmsg, sizeof(errmsg))) {
3542 /* set up to write to the already-opened capture output file/files */
3543 if (!capture_loop_init_output(capture_opts, &global_ld, errmsg,
3548 /* XXX - capture SIGTERM and close the capture, in case we're on a
3549 Linux 2.0[.x] system and you have to explicitly close the capture
3550 stream in order to turn promiscuous mode off? We need to do that
3551 in other places as well - and I don't think that works all the
3552 time in any case, due to libpcap bugs. */
3554 /* Well, we should be able to start capturing.
3556 Sync out the capture file, so the header makes it to the file system,
3557 and send a "capture started successfully and capture file created"
3558 message to our parent so that they'll open the capture file and
3559 update its windows to indicate that we have a live capture in
3561 fflush(global_ld.pdh);
3562 report_new_capture_file(capture_opts->save_file);
3565 /* initialize capture stop (and alike) conditions */
3566 init_capture_stop_conditions();
3567 /* create stop conditions */
3568 if (capture_opts->has_autostop_filesize)
3570 cnd_new(CND_CLASS_CAPTURESIZE,(long)capture_opts->autostop_filesize * 1024);
3571 if (capture_opts->has_autostop_duration)
3572 cnd_autostop_duration =
3573 cnd_new(CND_CLASS_TIMEOUT,(gint32)capture_opts->autostop_duration);
3575 if (capture_opts->multi_files_on) {
3576 if (capture_opts->has_file_duration)
3578 cnd_new(CND_CLASS_TIMEOUT, capture_opts->file_duration);
3580 if (capture_opts->has_autostop_files)
3581 cnd_autostop_files =
3582 cnd_new(CND_CLASS_CAPTURESIZE, capture_opts->autostop_files);
3585 /* init the time values */
3587 upd_time = GetTickCount();
3589 gettimeofday(&upd_time, NULL);
3591 start_time = create_timestamp();
3592 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Capture loop running!");
3594 /* WOW, everything is prepared! */
3595 /* please fasten your seat belts, we will enter now the actual capture loop */
3597 pcap_queue = g_async_queue_new();
3598 pcap_queue_bytes = 0;
3599 pcap_queue_packets = 0;
3600 for (i = 0; i < global_ld.pcaps->len; i++) {
3601 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, i);
3602 #if GLIB_CHECK_VERSION(2,31,0)
3603 /* XXX - Add an interface name here? */
3604 pcap_opts->tid = g_thread_new("Capture read", pcap_read_handler, pcap_opts);
3606 pcap_opts->tid = g_thread_create(pcap_read_handler, pcap_opts, TRUE, NULL);
3610 while (global_ld.go) {
3611 /* dispatch incoming packets */
3613 pcap_queue_element *queue_element;
3614 #if GLIB_CHECK_VERSION(2,31,18)
3616 g_async_queue_lock(pcap_queue);
3617 queue_element = (pcap_queue_element *)g_async_queue_timeout_pop_unlocked(pcap_queue, WRITER_THREAD_TIMEOUT);
3619 GTimeVal write_thread_time;
3621 g_get_current_time(&write_thread_time);
3622 g_time_val_add(&write_thread_time, WRITER_THREAD_TIMEOUT);
3623 g_async_queue_lock(pcap_queue);
3624 queue_element = (pcap_queue_element *)g_async_queue_timed_pop_unlocked(pcap_queue, &write_thread_time);
3626 if (queue_element) {
3627 pcap_queue_bytes -= queue_element->phdr.caplen;
3628 pcap_queue_packets -= 1;
3630 g_async_queue_unlock(pcap_queue);
3631 if (queue_element) {
3632 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
3633 "Dequeued a packet of length %d captured on interface %d.",
3634 queue_element->phdr.caplen, queue_element->pcap_opts->interface_id);
3636 capture_loop_write_packet_cb((u_char *) queue_element->pcap_opts,
3637 &queue_element->phdr,
3639 g_free(queue_element->pd);
3640 g_free(queue_element);
3646 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, 0);
3647 inpkts = capture_loop_dispatch(&global_ld, errmsg,
3648 sizeof(errmsg), pcap_opts);
3651 /* Were we asked to print packet counts by the SIGINFO handler? */
3652 if (global_ld.report_packet_count) {
3653 fprintf(stderr, "%u packet%s captured\n", global_ld.packet_count,
3654 plurality(global_ld.packet_count, "", "s"));
3655 global_ld.report_packet_count = FALSE;
3660 /* any news from our parent (signal pipe)? -> just stop the capture */
3661 if (!signal_pipe_check_running()) {
3662 global_ld.go = FALSE;
3667 global_ld.inpkts_to_sync_pipe += inpkts;
3669 /* check capture size condition */
3670 if (cnd_autostop_size != NULL &&
3671 cnd_eval(cnd_autostop_size, (guint32)global_ld.bytes_written)) {
3672 /* Capture size limit reached, do we have another file? */
3673 if (!do_file_switch_or_stop(capture_opts, cnd_autostop_files,
3674 cnd_autostop_size, cnd_file_duration))
3676 } /* cnd_autostop_size */
3677 if (capture_opts->output_to_pipe) {
3678 fflush(global_ld.pdh);
3682 /* Only update once every 500ms so as not to overload slow displays.
3683 * This also prevents too much context-switching between the dumpcap
3684 * and wireshark processes.
3686 #define DUMPCAP_UPD_TIME 500
3689 cur_time = GetTickCount(); /* Note: wraps to 0 if sys runs for 49.7 days */
3690 if ((cur_time - upd_time) > DUMPCAP_UPD_TIME) { /* wrap just causes an extra update */
3692 gettimeofday(&cur_time, NULL);
3693 if ((cur_time.tv_sec * 1000000 + cur_time.tv_usec) >
3694 (upd_time.tv_sec * 1000000 + upd_time.tv_usec + DUMPCAP_UPD_TIME*1000)) {
3697 upd_time = cur_time;
3700 if (pcap_stats(pch, stats) >= 0) {
3701 *stats_known = TRUE;
3704 /* Let the parent process know. */
3705 if (global_ld.inpkts_to_sync_pipe) {
3707 fflush(global_ld.pdh);
3709 /* Send our parent a message saying we've written out
3710 "global_ld.inpkts_to_sync_pipe" packets to the capture file. */
3712 report_packet_count(global_ld.inpkts_to_sync_pipe);
3714 global_ld.inpkts_to_sync_pipe = 0;
3717 /* check capture duration condition */
3718 if (cnd_autostop_duration != NULL && cnd_eval(cnd_autostop_duration)) {
3719 /* The maximum capture time has elapsed; stop the capture. */
3720 global_ld.go = FALSE;
3724 /* check capture file duration condition */
3725 if (cnd_file_duration != NULL && cnd_eval(cnd_file_duration)) {
3726 /* duration limit reached, do we have another file? */
3727 if (!do_file_switch_or_stop(capture_opts, cnd_autostop_files,
3728 cnd_autostop_size, cnd_file_duration))
3730 } /* cnd_file_duration */
3734 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Capture loop stopping ...");
3736 pcap_queue_element *queue_element;
3738 for (i = 0; i < global_ld.pcaps->len; i++) {
3739 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, i);
3740 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Waiting for thread of interface %u...",
3741 pcap_opts->interface_id);
3742 g_thread_join(pcap_opts->tid);
3743 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Thread of interface %u terminated.",
3744 pcap_opts->interface_id);
3747 g_async_queue_lock(pcap_queue);
3748 queue_element = (pcap_queue_element *)g_async_queue_try_pop_unlocked(pcap_queue);
3749 if (queue_element) {
3750 pcap_queue_bytes -= queue_element->phdr.caplen;
3751 pcap_queue_packets -= 1;
3753 g_async_queue_unlock(pcap_queue);
3754 if (queue_element == NULL) {
3757 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
3758 "Dequeued a packet of length %d captured on interface %d.",
3759 queue_element->phdr.caplen, queue_element->pcap_opts->interface_id);
3760 capture_loop_write_packet_cb((u_char *)queue_element->pcap_opts,
3761 &queue_element->phdr,
3763 g_free(queue_element->pd);
3764 g_free(queue_element);
3765 global_ld.inpkts_to_sync_pipe += 1;
3766 if (capture_opts->output_to_pipe) {
3767 fflush(global_ld.pdh);
3773 /* delete stop conditions */
3774 if (cnd_file_duration != NULL)
3775 cnd_delete(cnd_file_duration);
3776 if (cnd_autostop_files != NULL)
3777 cnd_delete(cnd_autostop_files);
3778 if (cnd_autostop_size != NULL)
3779 cnd_delete(cnd_autostop_size);
3780 if (cnd_autostop_duration != NULL)
3781 cnd_delete(cnd_autostop_duration);
3783 /* did we have a pcap (input) error? */
3784 for (i = 0; i < capture_opts->ifaces->len; i++) {
3785 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, i);
3786 if (pcap_opts->pcap_err) {
3787 /* On Linux, if an interface goes down while you're capturing on it,
3788 you'll get a "recvfrom: Network is down" or
3789 "The interface went down" error (ENETDOWN).
3790 (At least you will if g_strerror() doesn't show a local translation
3793 On FreeBSD and OS X, if a network adapter disappears while
3794 you're capturing on it, you'll get a "read: Device not configured"
3795 error (ENXIO). (See previous parenthetical note.)
3797 On OpenBSD, you get "read: I/O error" (EIO) in the same case.
3799 These should *not* be reported to the Wireshark developers. */
3802 cap_err_str = pcap_geterr(pcap_opts->pcap_h);
3803 if (strcmp(cap_err_str, "recvfrom: Network is down") == 0 ||
3804 strcmp(cap_err_str, "The interface went down") == 0 ||
3805 strcmp(cap_err_str, "read: Device not configured") == 0 ||
3806 strcmp(cap_err_str, "read: I/O error") == 0 ||
3807 strcmp(cap_err_str, "read error: PacketReceivePacket failed") == 0) {
3808 report_capture_error("The network adapter on which the capture was being done "
3809 "is no longer running; the capture has stopped.",
3812 g_snprintf(errmsg, sizeof(errmsg), "Error while capturing packets: %s",
3814 report_capture_error(errmsg, please_report);
3817 } else if (pcap_opts->from_cap_pipe && pcap_opts->cap_pipe_err == PIPERR) {
3818 report_capture_error(errmsg, "");
3822 /* did we have an output error while capturing? */
3823 if (global_ld.err == 0) {
3826 capture_loop_get_errmsg(errmsg, sizeof(errmsg), capture_opts->save_file,
3827 global_ld.err, FALSE);
3828 report_capture_error(errmsg, please_report);
3832 if (capture_opts->saving_to_file) {
3833 /* close the output file */
3834 close_ok = capture_loop_close_output(capture_opts, &global_ld, &err_close);
3838 /* there might be packets not yet notified to the parent */
3839 /* (do this after closing the file, so all packets are already flushed) */
3840 if (global_ld.inpkts_to_sync_pipe) {
3842 report_packet_count(global_ld.inpkts_to_sync_pipe);
3843 global_ld.inpkts_to_sync_pipe = 0;
3846 /* If we've displayed a message about a write error, there's no point
3847 in displaying another message about an error on close. */
3848 if (!close_ok && write_ok) {
3849 capture_loop_get_errmsg(errmsg, sizeof(errmsg), capture_opts->save_file, err_close,
3851 report_capture_error(errmsg, "");
3855 * XXX We exhibit different behaviour between normal mode and sync mode
3856 * when the pipe is stdin and not already at EOF. If we're a child, the
3857 * parent's stdin isn't closed, so if the user starts another capture,
3858 * cap_pipe_open_live() will very likely not see the expected magic bytes and
3859 * will say "Unrecognized libpcap format". On the other hand, in normal
3860 * mode, cap_pipe_open_live() will say "End of file on pipe during open".
3863 report_capture_count(TRUE);
3865 /* get packet drop statistics from pcap */
3866 for (i = 0; i < capture_opts->ifaces->len; i++) {
3868 guint32 pcap_dropped = 0;
3870 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, i);
3871 interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
3872 received = pcap_opts->received;
3873 if (pcap_opts->pcap_h != NULL) {
3874 g_assert(!pcap_opts->from_cap_pipe);
3875 /* Get the capture statistics, so we know how many packets were dropped. */
3876 if (pcap_stats(pcap_opts->pcap_h, stats) >= 0) {
3877 *stats_known = TRUE;
3878 /* Let the parent process know. */
3879 pcap_dropped += stats->ps_drop;
3881 g_snprintf(errmsg, sizeof(errmsg),
3882 "Can't get packet-drop statistics: %s",
3883 pcap_geterr(pcap_opts->pcap_h));
3884 report_capture_error(errmsg, please_report);
3887 report_packet_drops(received, pcap_dropped, pcap_opts->dropped, pcap_opts->flushed, interface_opts.console_display_name);
3890 /* close the input file (pcap or capture pipe) */
3891 capture_loop_close_input(&global_ld);
3893 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Capture loop stopped!");
3895 /* ok, if the write and the close were successful. */
3896 return write_ok && close_ok;
3899 if (capture_opts->multi_files_on) {
3900 /* cleanup ringbuffer */
3901 ringbuf_error_cleanup();
3903 /* We can't use the save file, and we have no FILE * for the stream
3904 to close in order to close it, so close the FD directly. */
3905 if (global_ld.save_file_fd != -1) {
3906 ws_close(global_ld.save_file_fd);
3909 /* We couldn't even start the capture, so get rid of the capture
3911 if (capture_opts->save_file != NULL) {
3912 ws_unlink(capture_opts->save_file);
3913 g_free(capture_opts->save_file);
3916 capture_opts->save_file = NULL;
3918 report_cfilter_error(capture_opts, error_index, errmsg);
3920 report_capture_error(errmsg, secondary_errmsg);
3922 /* close the input file (pcap or cap_pipe) */
3923 capture_loop_close_input(&global_ld);
3925 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Capture loop stopped with error");
3932 capture_loop_stop(void)
3934 #ifdef HAVE_PCAP_BREAKLOOP
3936 pcap_options *pcap_opts;
3938 for (i = 0; i < global_ld.pcaps->len; i++) {
3939 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, i);
3940 if (pcap_opts->pcap_h != NULL)
3941 pcap_breakloop(pcap_opts->pcap_h);
3944 global_ld.go = FALSE;
3949 capture_loop_get_errmsg(char *errmsg, int errmsglen, const char *fname,
3950 int err, gboolean is_close)
3955 g_snprintf(errmsg, errmsglen,
3956 "Not all the packets could be written to the file"
3957 " to which the capture was being saved\n"
3958 "(\"%s\") because there is no space left on the file system\n"
3959 "on which that file resides.",
3965 g_snprintf(errmsg, errmsglen,
3966 "Not all the packets could be written to the file"
3967 " to which the capture was being saved\n"
3968 "(\"%s\") because you are too close to, or over,"
3969 " your disk quota\n"
3970 "on the file system on which that file resides.",
3977 g_snprintf(errmsg, errmsglen,
3978 "The file to which the capture was being saved\n"
3979 "(\"%s\") could not be closed: %s.",
3980 fname, g_strerror(err));
3982 g_snprintf(errmsg, errmsglen,
3983 "An error occurred while writing to the file"
3984 " to which the capture was being saved\n"
3986 fname, g_strerror(err));
3993 /* one packet was captured, process it */
3995 capture_loop_write_packet_cb(u_char *pcap_opts_p, const struct pcap_pkthdr *phdr,
3998 pcap_options *pcap_opts = (pcap_options *) (void *) pcap_opts_p;
4000 guint ts_mul = pcap_opts->ts_nsec ? 1000000000 : 1000000;
4002 /* We may be called multiple times from pcap_dispatch(); if we've set
4003 the "stop capturing" flag, ignore this packet, as we're not
4004 supposed to be saving any more packets. */
4005 if (!global_ld.go) {
4006 pcap_opts->flushed++;
4010 if (global_ld.pdh) {
4011 gboolean successful;
4013 /* We're supposed to write the packet to a file; do so.
4014 If this fails, set "ld->go" to FALSE, to stop the capture, and set
4015 "ld->err" to the error. */
4016 if (global_capture_opts.use_pcapng) {
4017 successful = libpcap_write_enhanced_packet_block(libpcap_write_to_file, global_ld.pdh,
4019 phdr->ts.tv_sec, (gint32)phdr->ts.tv_usec,
4020 phdr->caplen, phdr->len,
4021 pcap_opts->interface_id,
4024 &global_ld.bytes_written, &err);
4026 successful = libpcap_write_packet(libpcap_write_to_file, global_ld.pdh,
4027 phdr->ts.tv_sec, (gint32)phdr->ts.tv_usec,
4028 phdr->caplen, phdr->len,
4030 &global_ld.bytes_written, &err);
4033 global_ld.go = FALSE;
4034 global_ld.err = err;
4035 pcap_opts->dropped++;
4037 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
4038 "Wrote a packet of length %d captured on interface %u.",
4039 phdr->caplen, pcap_opts->interface_id);
4040 global_ld.packet_count++;
4041 pcap_opts->received++;
4042 /* if the user told us to stop after x packets, do we already have enough? */
4043 if ((global_ld.packet_max > 0) && (global_ld.packet_count >= global_ld.packet_max)) {
4044 global_ld.go = FALSE;
4050 /* one packet was captured, queue it */
4052 capture_loop_queue_packet_cb(u_char *pcap_opts_p, const struct pcap_pkthdr *phdr,
4055 pcap_options *pcap_opts = (pcap_options *) (void *) pcap_opts_p;
4056 pcap_queue_element *queue_element;
4057 gboolean limit_reached;
4059 /* We may be called multiple times from pcap_dispatch(); if we've set
4060 the "stop capturing" flag, ignore this packet, as we're not
4061 supposed to be saving any more packets. */
4062 if (!global_ld.go) {
4063 pcap_opts->flushed++;
4067 queue_element = (pcap_queue_element *)g_malloc(sizeof(pcap_queue_element));
4068 if (queue_element == NULL) {
4069 pcap_opts->dropped++;
4072 queue_element->pcap_opts = pcap_opts;
4073 queue_element->phdr = *phdr;
4074 queue_element->pd = (u_char *)g_malloc(phdr->caplen);
4075 if (queue_element->pd == NULL) {
4076 pcap_opts->dropped++;
4077 g_free(queue_element);
4080 memcpy(queue_element->pd, pd, phdr->caplen);
4081 g_async_queue_lock(pcap_queue);
4082 if (((pcap_queue_byte_limit == 0) || (pcap_queue_bytes < pcap_queue_byte_limit)) &&
4083 ((pcap_queue_packet_limit == 0) || (pcap_queue_packets < pcap_queue_packet_limit))) {
4084 limit_reached = FALSE;
4085 g_async_queue_push_unlocked(pcap_queue, queue_element);
4086 pcap_queue_bytes += phdr->caplen;
4087 pcap_queue_packets += 1;
4089 limit_reached = TRUE;
4091 g_async_queue_unlock(pcap_queue);
4092 if (limit_reached) {
4093 pcap_opts->dropped++;
4094 g_free(queue_element->pd);
4095 g_free(queue_element);
4096 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
4097 "Dropped a packet of length %d captured on interface %u.",
4098 phdr->caplen, pcap_opts->interface_id);
4100 pcap_opts->received++;
4101 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
4102 "Queued a packet of length %d captured on interface %u.",
4103 phdr->caplen, pcap_opts->interface_id);
4105 /* I don't want to hold the mutex over the debug output. So the
4106 output may be wrong */
4107 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
4108 "Queue size is now %" G_GINT64_MODIFIER "d bytes (%" G_GINT64_MODIFIER "d packets)",
4109 pcap_queue_bytes, pcap_queue_packets);
4113 set_80211_channel(const char *iface, const char *opt)
4115 int freq = 0, type, ret;
4116 gchar **options = NULL;
4118 options = g_strsplit_set(opt, ",", 2);
4121 freq = atoi(options[0]);
4124 type = ws80211_str_to_chan_type(options[1]);
4133 ret = ws80211_init();
4135 cmdarg_err("%d: Failed to init ws80211: %s\n", abs(ret), g_strerror(abs(ret)));
4139 ret = ws80211_set_freq(iface, freq, type);
4142 cmdarg_err("%d: Failed to set channel: %s\n", abs(ret), g_strerror(abs(ret)));
4148 pipe_write_block(2, SP_SUCCESS, NULL);
4152 g_strfreev(options);
4156 /* And now our feature presentation... [ fade to music ] */
4158 main(int argc, char *argv[])
4160 GString *comp_info_str;
4161 GString *runtime_info_str;
4163 struct option long_options[] = {
4164 {(char *)"capture-comment", required_argument, NULL, LONGOPT_NUM_CAP_COMMENT },
4168 gboolean arg_error = FALSE;
4173 struct sigaction action, oldaction;
4176 gboolean start_capture = TRUE;
4177 gboolean stats_known;
4178 struct pcap_stat stats;
4179 GLogLevelFlags log_flags;
4180 gboolean list_interfaces = FALSE;
4181 gboolean list_link_layer_types = FALSE;
4182 #ifdef HAVE_BPF_IMAGE
4183 gboolean print_bpf_code = FALSE;
4185 gboolean set_chan = FALSE;
4186 gchar *set_chan_arg = NULL;
4187 gboolean machine_readable = FALSE;
4188 gboolean print_statistics = FALSE;
4189 int status, run_once_args = 0;
4192 #if defined(__APPLE__) && defined(__LP64__)
4193 struct utsname osinfo;
4197 /* Assemble the compile-time version information string */
4198 comp_info_str = g_string_new("Compiled ");
4199 get_compiled_version_info(comp_info_str, NULL, NULL);
4201 /* Assemble the run-time version information string */
4202 runtime_info_str = g_string_new("Running ");
4203 get_runtime_version_info(runtime_info_str, NULL);
4205 /* Add it to the information to be reported on a crash. */
4206 ws_add_crash_info("Dumpcap " VERSION "%s\n"
4211 wireshark_svnversion, comp_info_str->str, runtime_info_str->str);
4214 arg_list_utf_16to8(argc, argv);
4215 create_app_running_mutex();
4218 * Initialize our DLL search path. MUST be called before LoadLibrary
4221 ws_init_dll_search_path();
4224 #ifdef HAVE_PCAP_REMOTE
4225 #define OPTSTRING_A "A:"
4226 #define OPTSTRING_r "r"
4227 #define OPTSTRING_u "u"
4229 #define OPTSTRING_A ""
4230 #define OPTSTRING_r ""
4231 #define OPTSTRING_u ""
4234 #ifdef HAVE_PCAP_SETSAMPLING
4235 #define OPTSTRING_m "m:"
4237 #define OPTSTRING_m ""
4240 #if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
4241 #define OPTSTRING_B "B:"
4243 #define OPTSTRING_B ""
4244 #endif /* _WIN32 or HAVE_PCAP_CREATE */
4246 #ifdef HAVE_PCAP_CREATE
4247 #define OPTSTRING_I "I"
4249 #define OPTSTRING_I ""
4252 #ifdef HAVE_BPF_IMAGE
4253 #define OPTSTRING_d "d"
4255 #define OPTSTRING_d ""
4258 #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:"
4260 #ifdef DEBUG_CHILD_DUMPCAP
4261 if ((debug_log = ws_fopen("dumpcap_debug_log.tmp","w")) == NULL) {
4262 fprintf (stderr, "Unable to open debug log file !\n");
4267 #if defined(__APPLE__) && defined(__LP64__)
4269 * Is this Mac OS X 10.6.0, 10.6.1, 10.6.3, or 10.6.4? If so, we need
4270 * a bug workaround - timeouts less than 1 second don't work with libpcap
4271 * in 64-bit code. (The bug was introduced in 10.6, fixed in 10.6.2,
4272 * re-introduced in 10.6.3, not fixed in 10.6.4, and fixed in 10.6.5.
4273 * The problem is extremely unlikely to be reintroduced in a future
4276 if (uname(&osinfo) == 0) {
4278 * Mac OS X 10.x uses Darwin {x+4}.0.0. Mac OS X 10.x.y uses Darwin
4279 * {x+4}.y.0 (except that 10.6.1 appears to have a uname version
4280 * number of 10.0.0, not 10.1.0 - go figure).
4282 if (strcmp(osinfo.release, "10.0.0") == 0 || /* 10.6, 10.6.1 */
4283 strcmp(osinfo.release, "10.3.0") == 0 || /* 10.6.3 */
4284 strcmp(osinfo.release, "10.4.0") == 0) /* 10.6.4 */
4285 need_timeout_workaround = TRUE;
4290 * Determine if dumpcap is being requested to run in a special
4291 * capture_child mode by going thru the command line args to see if
4292 * a -Z is present. (-Z is a hidden option).
4294 * The primary result of running in capture_child mode is that
4295 * all messages sent out on stderr are in a special type/len/string
4296 * format to allow message processing by type. These messages include
4297 * error messages if dumpcap fails to start the operation it was
4298 * requested to do, as well as various "status" messages which are sent
4299 * when an actual capture is in progress, and a "success" message sent
4300 * if dumpcap was requested to perform an operation other than a
4303 * Capture_child mode would normally be requested by a parent process
4304 * which invokes dumpcap and obtains dumpcap stderr output via a pipe
4305 * to which dumpcap stderr has been redirected. It might also have
4306 * another pipe to obtain dumpcap stdout output; for operations other
4307 * than a capture, that information is formatted specially for easier
4308 * parsing by the parent process.
4310 * Capture_child mode needs to be determined immediately upon
4311 * startup so that any messages generated by dumpcap in this mode
4312 * (eg: during initialization) will be formatted properly.
4315 for (i=1; i<argc; i++) {
4316 if (strcmp("-Z", argv[i]) == 0) {
4317 capture_child = TRUE;
4318 machine_readable = TRUE; /* request machine-readable output */
4320 /* set output pipe to binary mode, to avoid ugly text conversions */
4321 _setmode(2, O_BINARY);
4326 /* The default_log_handler will use stdout, which makes trouble in */
4327 /* capture child mode, as it uses stdout for its sync_pipe. */
4328 /* So: the filtering is done in the console_log_handler and not here.*/
4329 /* We set the log handlers right up front to make sure that any log */
4330 /* messages when running as child will be sent back to the parent */
4331 /* with the correct format. */
4336 G_LOG_LEVEL_CRITICAL|
4337 G_LOG_LEVEL_WARNING|
4338 G_LOG_LEVEL_MESSAGE|
4342 G_LOG_FLAG_RECURSION);
4344 g_log_set_handler(NULL,
4346 console_log_handler, NULL /* user_data */);
4347 g_log_set_handler(LOG_DOMAIN_MAIN,
4349 console_log_handler, NULL /* user_data */);
4350 g_log_set_handler(LOG_DOMAIN_CAPTURE,
4352 console_log_handler, NULL /* user_data */);
4353 g_log_set_handler(LOG_DOMAIN_CAPTURE_CHILD,
4355 console_log_handler, NULL /* user_data */);
4357 /* Initialize the pcaps list */
4358 global_ld.pcaps = g_array_new(FALSE, FALSE, sizeof(pcap_options *));
4360 #if !GLIB_CHECK_VERSION(2,31,0)
4361 /* Initialize the thread system */
4362 g_thread_init(NULL);
4366 /* Load wpcap if possible. Do this before collecting the run-time version information */
4369 /* ... and also load the packet.dll from wpcap */
4370 /* XXX - currently not required, may change later. */
4371 /*wpcap_packet_load();*/
4373 /* Start windows sockets */
4374 WSAStartup( MAKEWORD( 1, 1 ), &wsaData );
4376 /* Set handler for Ctrl+C key */
4377 SetConsoleCtrlHandler(capture_cleanup_handler, TRUE);
4379 /* Catch SIGINT and SIGTERM and, if we get either of them, clean up
4380 and exit. Do the same with SIGPIPE, in case, for example,
4381 we're writing to our standard output and it's a pipe.
4382 Do the same with SIGHUP if it's not being ignored (if we're
4383 being run under nohup, it might be ignored, in which case we
4384 should leave it ignored).
4386 XXX - apparently, Coverity complained that part of action
4387 wasn't initialized. Perhaps it's running on Linux, where
4388 struct sigaction has an ignored "sa_restorer" element and
4389 where "sa_handler" and "sa_sigaction" might not be two
4390 members of a union. */
4391 memset(&action, 0, sizeof(action));
4392 action.sa_handler = capture_cleanup_handler;
4394 * Arrange that system calls not get restarted, because when
4395 * our signal handler returns we don't want to restart
4396 * a call that was waiting for packets to arrive.
4398 action.sa_flags = 0;
4399 sigemptyset(&action.sa_mask);
4400 sigaction(SIGTERM, &action, NULL);
4401 sigaction(SIGINT, &action, NULL);
4402 sigaction(SIGPIPE, &action, NULL);
4403 sigaction(SIGHUP, NULL, &oldaction);
4404 if (oldaction.sa_handler == SIG_DFL)
4405 sigaction(SIGHUP, &action, NULL);
4408 /* Catch SIGINFO and, if we get it and we're capturing in
4409 quiet mode, report the number of packets we've captured. */
4410 action.sa_handler = report_counts_siginfo;
4411 action.sa_flags = SA_RESTART;
4412 sigemptyset(&action.sa_mask);
4413 sigaction(SIGINFO, &action, NULL);
4414 #endif /* SIGINFO */
4418 enable_kernel_bpf_jit_compiler();
4421 /* ----------------------------------------------------------------- */
4422 /* Privilege and capability handling */
4424 /* 1. Running not as root or suid root; no special capabilities. */
4427 /* 2. Running logged in as root (euid=0; ruid=0); Not using libcap. */
4430 /* 3. Running logged in as root (euid=0; ruid=0). Using libcap. */
4432 /* - Near start of program: Enable NET_RAW and NET_ADMIN */
4433 /* capabilities; Drop all other capabilities; */
4434 /* - If not -w (ie: doing -S or -D, etc) run to completion; */
4435 /* else: after pcap_open_live() in capture_loop_open_input() */
4436 /* drop all capabilities (NET_RAW and NET_ADMIN); */
4437 /* (Note: this means that the process, although logged in */
4438 /* as root, does not have various permissions such as the */
4439 /* ability to bypass file access permissions). */
4440 /* XXX: Should we just leave capabilities alone in this case */
4441 /* so that user gets expected effect that root can do */
4444 /* 4. Running as suid root (euid=0, ruid=n); Not using libcap. */
4446 /* - If not -w (ie: doing -S or -D, etc) run to completion; */
4447 /* else: after pcap_open_live() in capture_loop_open_input() */
4448 /* drop suid root (set euid=ruid).(ie: keep suid until after */
4449 /* pcap_open_live). */
4451 /* 5. Running as suid root (euid=0, ruid=n); Using libcap. */
4453 /* - Near start of program: Enable NET_RAW and NET_ADMIN */
4454 /* capabilities; Drop all other capabilities; */
4455 /* Drop suid privileges (euid=ruid); */
4456 /* - If not -w (ie: doing -S or -D, etc) run to completion; */
4457 /* else: after pcap_open_live() in capture_loop_open_input() */
4458 /* drop all capabilities (NET_RAW and NET_ADMIN). */
4460 /* XXX: For some Linux versions/distros with capabilities */
4461 /* a 'normal' process with any capabilities cannot be */
4462 /* 'killed' (signaled) from another (same uid) non-privileged */
4464 /* For example: If (non-suid) Wireshark forks a */
4465 /* child suid dumpcap which acts as described here (case 5), */
4466 /* Wireshark will be unable to kill (signal) the child */
4467 /* dumpcap process until the capabilities have been dropped */
4468 /* (after pcap_open_live()). */
4469 /* This behaviour will apparently be changed in the kernel */
4470 /* to allow the kill (signal) in this case. */
4471 /* See the following for details: */
4472 /* http://www.mail-archive.com/ [wrapped] */
4473 /* linux-security-module@vger.kernel.org/msg02913.html */
4475 /* It is therefore conceivable that if dumpcap somehow hangs */
4476 /* in pcap_open_live or before that wireshark will not */
4477 /* be able to stop dumpcap using a signal (INT, TERM, etc). */
4478 /* In this case, exiting wireshark will kill the child */
4479 /* dumpcap process. */
4481 /* 6. Not root or suid root; Running with NET_RAW & NET_ADMIN */
4482 /* capabilities; Using libcap. Note: capset cmd (which see) */
4483 /* used to assign capabilities to file. */
4485 /* - If not -w (ie: doing -S or -D, etc) run to completion; */
4486 /* else: after pcap_open_live() in capture_loop_open_input() */
4487 /* drop all capabilities (NET_RAW and NET_ADMIN) */
4489 /* ToDo: -S (stats) should drop privileges/capabilities when no */
4490 /* longer required (similar to capture). */
4492 /* ----------------------------------------------------------------- */
4494 init_process_policies();
4497 /* If 'started with special privileges' (and using libcap) */
4498 /* Set to keep only NET_RAW and NET_ADMIN capabilities; */
4499 /* Set euid/egid = ruid/rgid to remove suid privileges */
4500 relinquish_privs_except_capture();
4503 /* Set the initial values in the capture options. This might be overwritten
4504 by the command line parameters. */
4505 capture_opts_init(&global_capture_opts);
4507 /* We always save to a file - if no file was specified, we save to a
4509 global_capture_opts.saving_to_file = TRUE;
4510 global_capture_opts.has_ring_num_files = TRUE;
4512 /* Pass on capture_child mode for capture_opts */
4513 global_capture_opts.capture_child = capture_child;
4515 /* Now get our args */
4516 while ((opt = getopt_long(argc, argv, OPTSTRING, long_options, NULL)) != -1) {
4518 case 'h': /* Print help and exit */
4522 case 'v': /* Show version and exit */
4524 show_version(comp_info_str, runtime_info_str);
4525 g_string_free(comp_info_str, TRUE);
4526 g_string_free(runtime_info_str, TRUE);
4530 /*** capture option specific ***/
4531 case 'a': /* autostop criteria */
4532 case 'b': /* Ringbuffer option */
4533 case 'c': /* Capture x packets */
4534 case 'f': /* capture filter */
4535 case 'g': /* enable group read access on file(s) */
4536 case 'i': /* Use interface x */
4537 case 'n': /* Use pcapng format */
4538 case 'p': /* Don't capture in promiscuous mode */
4539 case 'P': /* Use pcap format */
4540 case 's': /* Set the snapshot (capture) length */
4541 case 'w': /* Write to capture file x */
4542 case 'y': /* Set the pcap data link type */
4543 case LONGOPT_NUM_CAP_COMMENT: /* add a capture comment */
4544 #ifdef HAVE_PCAP_REMOTE
4545 case 'u': /* Use UDP for data transfer */
4546 case 'r': /* Capture own RPCAP traffic too */
4547 case 'A': /* Authentication */
4549 #ifdef HAVE_PCAP_SETSAMPLING
4550 case 'm': /* Sampling */
4552 #if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
4553 case 'B': /* Buffer size */
4554 #endif /* _WIN32 or HAVE_PCAP_CREATE */
4555 #ifdef HAVE_PCAP_CREATE
4556 case 'I': /* Monitor mode */
4558 status = capture_opts_add_opt(&global_capture_opts, opt, optarg, &start_capture);
4563 /*** hidden option: Wireshark child mode (using binary output messages) ***/
4565 capture_child = TRUE;
4567 /* set output pipe to binary mode, to avoid ugly text conversions */
4568 _setmode(2, O_BINARY);
4570 * optarg = the control ID, aka the PPID, currently used for the
4573 if (strcmp(optarg, SIGNAL_PIPE_CTRL_ID_NONE) != 0) {
4574 sig_pipe_name = g_strdup_printf(SIGNAL_PIPE_FORMAT, optarg);
4575 sig_pipe_handle = CreateFile(utf_8to16(sig_pipe_name),
4576 GENERIC_READ, 0, NULL, OPEN_EXISTING, 0, NULL);
4578 if (sig_pipe_handle == INVALID_HANDLE_VALUE) {
4579 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
4580 "Signal pipe: Unable to open %s. Dead parent?",
4588 case 'q': /* Quiet */
4594 /*** all non capture option specific ***/
4595 case 'D': /* Print a list of capture devices and exit */
4596 list_interfaces = TRUE;
4599 case 'L': /* Print list of link-layer types and exit */
4600 list_link_layer_types = TRUE;
4603 #ifdef HAVE_BPF_IMAGE
4604 case 'd': /* Print BPF code for capture filter and exit */
4605 print_bpf_code = TRUE;
4609 case 'S': /* Print interface statistics once a second */
4610 print_statistics = TRUE;
4613 case 'k': /* Set wireless channel */
4615 set_chan_arg = optarg;
4618 case 'M': /* For -D, -L, and -S, print machine-readable output */
4619 machine_readable = TRUE;
4622 pcap_queue_byte_limit = get_positive_int(optarg, "byte_limit");
4625 pcap_queue_packet_limit = get_positive_int(optarg, "packet_limit");
4628 cmdarg_err("Invalid Option: %s", argv[optind-1]);
4630 case '?': /* Bad flag - print usage message */
4639 /* user specified file name as regular command-line argument */
4640 /* XXX - use it as the capture file name (or something else)? */
4646 * Extra command line arguments were specified; complain.
4647 * XXX - interpret as capture filter, as tcpdump and tshark do?
4649 cmdarg_err("Invalid argument: %s", argv[0]);
4654 if ((pcap_queue_byte_limit > 0) || (pcap_queue_packet_limit > 0)) {
4657 if ((pcap_queue_byte_limit == 0) && (pcap_queue_packet_limit == 0)) {
4658 /* Use some default if the user hasn't specified some */
4659 /* XXX: Are these defaults good enough? */
4660 pcap_queue_byte_limit = 1000 * 1000;
4661 pcap_queue_packet_limit = 1000;
4668 if (run_once_args > 1) {
4669 cmdarg_err("Only one of -D, -L, or -S may be supplied.");
4671 } else if (run_once_args == 1) {
4672 /* We're supposed to print some information, rather than
4673 to capture traffic; did they specify a ring buffer option? */
4674 if (global_capture_opts.multi_files_on) {
4675 cmdarg_err("Ring buffer requested, but a capture isn't being done.");
4679 /* We're supposed to capture traffic; */
4681 /* Are we capturing on multiple interface? If so, use threads and pcapng. */
4682 if (global_capture_opts.ifaces->len > 1) {
4684 global_capture_opts.use_pcapng = TRUE;
4687 if (global_capture_opts.capture_comment &&
4688 (!global_capture_opts.use_pcapng || global_capture_opts.multi_files_on)) {
4689 /* XXX - for ringbuffer, should we apply the comment to each file? */
4690 cmdarg_err("A capture comment can only be set if we capture into a single pcapng file.");
4694 /* Was the ring buffer option specified and, if so, does it make sense? */
4695 if (global_capture_opts.multi_files_on) {
4696 /* Ring buffer works only under certain conditions:
4697 a) ring buffer does not work with temporary files;
4698 b) it makes no sense to enable the ring buffer if the maximum
4699 file size is set to "infinite". */
4700 if (global_capture_opts.save_file == NULL) {
4701 cmdarg_err("Ring buffer requested, but capture isn't being saved to a permanent file.");
4702 global_capture_opts.multi_files_on = FALSE;
4704 if (!global_capture_opts.has_autostop_filesize && !global_capture_opts.has_file_duration) {
4705 cmdarg_err("Ring buffer requested, but no maximum capture file size or duration were specified.");
4707 /* XXX - this must be redesigned as the conditions changed */
4708 global_capture_opts.multi_files_on = FALSE;
4715 * "-D" requires no interface to be selected; it's supposed to list
4718 if (list_interfaces) {
4719 /* Get the list of interfaces */
4724 if_list = capture_interface_list(&err, &err_str,NULL);
4725 if (if_list == NULL) {
4727 case CANT_GET_INTERFACE_LIST:
4728 case DONT_HAVE_PCAP:
4729 cmdarg_err("%s", err_str);
4734 case NO_INTERFACES_FOUND:
4736 * If we're being run by another program, just give them
4737 * an empty list of interfaces, don't report this as
4738 * an error; that lets them decide whether to report
4739 * this as an error or not.
4741 if (!machine_readable) {
4742 cmdarg_err("There are no interfaces on which a capture can be done");
4749 if (machine_readable) /* tab-separated values to stdout */
4750 print_machine_readable_interfaces(if_list);
4752 capture_opts_print_interfaces(if_list);
4753 free_interface_list(if_list);
4758 * "-S" requires no interface to be selected; it gives statistics
4759 * for all interfaces.
4761 if (print_statistics) {
4762 status = print_statistics_loop(machine_readable);
4767 interface_options interface_opts;
4769 if (global_capture_opts.ifaces->len != 1) {
4770 cmdarg_err("Need one interface");
4774 interface_opts = g_array_index(global_capture_opts.ifaces, interface_options, 0);
4775 status = set_80211_channel(interface_opts.name, set_chan_arg);
4780 * "-L", "-d", and capturing act on a particular interface, so we have to
4781 * have an interface; if none was specified, pick a default.
4783 status = capture_opts_default_iface_if_necessary(&global_capture_opts, NULL);
4785 /* cmdarg_err() already called .... */
4789 /* Let the user know what interfaces were chosen. */
4790 if (capture_child) {
4791 for (j = 0; j < global_capture_opts.ifaces->len; j++) {
4792 interface_options interface_opts;
4794 interface_opts = g_array_index(global_capture_opts.ifaces, interface_options, j);
4795 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "Interface: %s\n",
4796 interface_opts.name);
4799 str = g_string_new("");
4801 if (global_capture_opts.ifaces->len < 2)
4803 if (global_capture_opts.ifaces->len < 4)
4806 for (j = 0; j < global_capture_opts.ifaces->len; j++) {
4807 interface_options interface_opts;
4809 interface_opts = g_array_index(global_capture_opts.ifaces, interface_options, j);
4811 if (global_capture_opts.ifaces->len > 2) {
4812 g_string_append_printf(str, ",");
4814 g_string_append_printf(str, " ");
4815 if (j == global_capture_opts.ifaces->len - 1) {
4816 g_string_append_printf(str, "and ");
4819 g_string_append_printf(str, "'%s'", interface_opts.console_display_name);
4822 g_string_append_printf(str, "%u interfaces", global_capture_opts.ifaces->len);
4824 fprintf(stderr, "Capturing on %s\n", str->str);
4825 g_string_free(str, TRUE);
4828 if (list_link_layer_types) {
4829 /* Get the list of link-layer types for the capture device. */
4830 if_capabilities_t *caps;
4834 for (ii = 0; ii < global_capture_opts.ifaces->len; ii++) {
4835 interface_options interface_opts;
4837 interface_opts = g_array_index(global_capture_opts.ifaces, interface_options, ii);
4838 caps = get_if_capabilities(interface_opts.name,
4839 interface_opts.monitor_mode, &err_str);
4841 cmdarg_err("The capabilities of the capture device \"%s\" could not be obtained (%s).\n"
4842 "Please check to make sure you have sufficient permissions, and that\n"
4843 "you have the proper interface or pipe specified.", interface_opts.name, err_str);
4847 if (caps->data_link_types == NULL) {
4848 cmdarg_err("The capture device \"%s\" has no data link types.", interface_opts.name);
4851 if (machine_readable) /* tab-separated values to stdout */
4852 /* XXX: We need to change the format and adopt consumers */
4853 print_machine_readable_if_capabilities(caps);
4855 /* XXX: We might want to print also the interface name */
4856 capture_opts_print_if_capabilities(caps, interface_opts.name,
4857 interface_opts.monitor_mode);
4858 free_if_capabilities(caps);
4863 /* We're supposed to do a capture, or print the BPF code for a filter.
4864 Process the snapshot length, as that affects the generated BPF code. */
4865 capture_opts_trim_snaplen(&global_capture_opts, MIN_PACKET_SIZE);
4867 #ifdef HAVE_BPF_IMAGE
4868 if (print_bpf_code) {
4869 show_filter_code(&global_capture_opts);
4874 /* We're supposed to do a capture. Process the ring buffer arguments. */
4875 capture_opts_trim_ring_num_files(&global_capture_opts);
4877 /* flush stderr prior to starting the main capture loop */
4880 /* Now start the capture. */
4882 if (capture_loop_start(&global_capture_opts, &stats_known, &stats) == TRUE) {
4886 /* capture failed */
4889 return 0; /* never here, make compiler happy */
4894 console_log_handler(const char *log_domain, GLogLevelFlags log_level,
4895 const char *message, gpointer user_data _U_)
4902 /* ignore log message, if log_level isn't interesting */
4903 if ( !(log_level & G_LOG_LEVEL_MASK & ~(G_LOG_LEVEL_DEBUG|G_LOG_LEVEL_INFO))) {
4904 #if !defined(DEBUG_DUMPCAP) && !defined(DEBUG_CHILD_DUMPCAP)
4909 /* create a "timestamp" */
4911 today = localtime(&curr);
4913 switch(log_level & G_LOG_LEVEL_MASK) {
4914 case G_LOG_LEVEL_ERROR:
4917 case G_LOG_LEVEL_CRITICAL:
4920 case G_LOG_LEVEL_WARNING:
4923 case G_LOG_LEVEL_MESSAGE:
4926 case G_LOG_LEVEL_INFO:
4929 case G_LOG_LEVEL_DEBUG:
4933 fprintf(stderr, "unknown log_level %u\n", log_level);
4935 g_assert_not_reached();
4938 /* Generate the output message */
4939 if (log_level & G_LOG_LEVEL_MESSAGE) {
4940 /* normal user messages without additional infos */
4941 msg = g_strdup_printf("%s\n", message);
4943 /* info/debug messages with additional infos */
4944 msg = g_strdup_printf("%02u:%02u:%02u %8s %s %s\n",
4945 today->tm_hour, today->tm_min, today->tm_sec,
4946 log_domain != NULL ? log_domain : "",
4950 /* DEBUG & INFO msgs (if we're debugging today) */
4951 #if defined(DEBUG_DUMPCAP) || defined(DEBUG_CHILD_DUMPCAP)
4952 if ( !(log_level & G_LOG_LEVEL_MASK & ~(G_LOG_LEVEL_DEBUG|G_LOG_LEVEL_INFO))) {
4953 #ifdef DEBUG_DUMPCAP
4954 fprintf(stderr, "%s", msg);
4957 #ifdef DEBUG_CHILD_DUMPCAP
4958 fprintf(debug_log, "%s", msg);
4966 /* ERROR, CRITICAL, WARNING, MESSAGE messages goto stderr or */
4967 /* to parent especially formatted if dumpcap running as child. */
4968 if (capture_child) {
4969 sync_pipe_errmsg_to_parent(2, msg, "");
4971 fprintf(stderr, "%s", msg);
4978 /****************************************************************************************************************/
4979 /* indication report routines */
4983 report_packet_count(unsigned int packet_count)
4985 char tmp[SP_DECISIZE+1+1];
4986 static unsigned int count = 0;
4988 if (capture_child) {
4989 g_snprintf(tmp, sizeof(tmp), "%u", packet_count);
4990 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "Packets: %s", tmp);
4991 pipe_write_block(2, SP_PACKET_COUNT, tmp);
4993 count += packet_count;
4994 fprintf(stderr, "\rPackets: %u ", count);
4995 /* stderr could be line buffered */
5001 report_new_capture_file(const char *filename)
5003 if (capture_child) {
5004 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "File: %s", filename);
5005 pipe_write_block(2, SP_FILE, filename);
5009 * Prevent a SIGINFO handler from writing to the standard error
5010 * while we're doing so; instead, have it just set a flag telling
5011 * us to print that information when we're done.
5014 #endif /* SIGINFO */
5015 fprintf(stderr, "File: %s\n", filename);
5016 /* stderr could be line buffered */
5021 * Allow SIGINFO handlers to write.
5026 * If a SIGINFO handler asked us to write out capture counts, do so.
5029 report_counts_for_siginfo();
5030 #endif /* SIGINFO */
5035 report_cfilter_error(capture_options *capture_opts, guint i, const char *errmsg)
5037 interface_options interface_opts;
5038 char tmp[MSG_MAX_LENGTH+1+6];
5040 if (i < capture_opts->ifaces->len) {
5041 if (capture_child) {
5042 g_snprintf(tmp, sizeof(tmp), "%u:%s", i, errmsg);
5043 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "Capture filter error: %s", errmsg);
5044 pipe_write_block(2, SP_BAD_FILTER, tmp);
5047 * clopts_step_invalid_capfilter in test/suite-clopts.sh MUST match
5048 * the error message below.
5050 interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
5052 "Invalid capture filter \"%s\" for interface %s!\n"
5054 "That string isn't a valid capture filter (%s).\n"
5055 "See the User's Guide for a description of the capture filter syntax.",
5056 interface_opts.cfilter, interface_opts.name, errmsg);
5062 report_capture_error(const char *error_msg, const char *secondary_error_msg)
5064 if (capture_child) {
5065 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
5066 "Primary Error: %s", error_msg);
5067 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
5068 "Secondary Error: %s", secondary_error_msg);
5069 sync_pipe_errmsg_to_parent(2, error_msg, secondary_error_msg);
5071 cmdarg_err("%s", error_msg);
5072 if (secondary_error_msg[0] != '\0')
5073 cmdarg_err_cont("%s", secondary_error_msg);
5078 report_packet_drops(guint32 received, guint32 pcap_drops, guint32 drops, guint32 flushed, gchar *name)
5080 char tmp[SP_DECISIZE+1+1];
5081 guint32 total_drops = pcap_drops + drops + flushed;
5083 g_snprintf(tmp, sizeof(tmp), "%u", total_drops);
5085 if (capture_child) {
5086 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
5087 "Packets received/dropped on interface %s: %u/%u (pcap:%u/dumpcap:%u/flushed:%u)",
5088 name, received, total_drops, pcap_drops, drops, flushed);
5089 /* XXX: Need to provide interface id, changes to consumers required. */
5090 pipe_write_block(2, SP_DROPS, tmp);
5093 "Packets received/dropped on interface '%s': %u/%u (pcap:%u/dumpcap:%u/flushed:%u) (%.1f%%)\n",
5094 name, received, total_drops, pcap_drops, drops, flushed,
5095 received ? 100.0 * received / (received + total_drops) : 0.0);
5096 /* stderr could be line buffered */
5102 /************************************************************************************************/
5103 /* signal_pipe handling */
5108 signal_pipe_check_running(void)
5110 /* any news from our parent? -> just stop the capture */
5114 /* if we are running standalone, no check required */
5115 if (!capture_child) {
5119 if (!sig_pipe_name || !sig_pipe_handle) {
5120 /* This shouldn't happen */
5121 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
5122 "Signal pipe: No name or handle");
5127 * XXX - We should have the process ID of the parent (from the "-Z" flag)
5128 * at this point. Should we check to see if the parent is still alive,
5129 * e.g. by using OpenProcess?
5132 result = PeekNamedPipe(sig_pipe_handle, NULL, 0, NULL, &avail, NULL);
5134 if (!result || avail > 0) {
5135 /* peek failed or some bytes really available */
5136 /* (if not piping from stdin this would fail) */
5137 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
5138 "Signal pipe: Stop capture: %s", sig_pipe_name);
5139 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
5140 "Signal pipe: %s (%p) result: %u avail: %u", sig_pipe_name,
5141 sig_pipe_handle, result, avail);
5144 /* pipe ok and no bytes available */
5155 * Editor modelines - http://www.wireshark.org/tools/modelines.html
5160 * indent-tabs-mode: nil
5163 * vi: set shiftwidth=4 tabstop=8 expandtab:
5164 * :indentSize=4:tabSize=8:noTabs=true: