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>
57 #ifdef HAVE_ARPA_INET_H
58 #include <arpa/inet.h>
61 #if defined(__APPLE__) && defined(__LP64__)
62 #include <sys/utsname.h>
69 #include "wsutil/wsgetopt.h"
77 # include <sys/prctl.h>
78 # include <sys/capability.h>
81 #include "ringbuffer.h"
82 #include "clopts_common.h"
83 #include "console_io.h"
84 #include "cmdarg_err.h"
85 #include "version_info.h"
87 #include "capture-pcap-util.h"
89 #include "capture-wpcap.h"
95 #include "capture-wpcap.h"
96 #include <wsutil/unicode-utils.h>
103 #ifdef NEED_INET_V6DEFS_H
104 # include "wsutil/inet_v6defs.h"
107 #include <wsutil/privileges.h>
109 #include "sync_pipe.h"
111 #include "capture_opts.h"
112 #include "capture_ifinfo.h"
113 #include "capture_sync.h"
115 #include "conditions.h"
116 #include "capture_stop_conditions.h"
118 #include "tempfile.h"
120 #include "wsutil/file_util.h"
122 #include "ws80211_utils.h"
125 * Get information about libpcap format from "wiretap/libpcap.h".
126 * XXX - can we just use pcap_open_offline() to read the pipe?
128 #include "wiretap/libpcap.h"
130 /**#define DEBUG_DUMPCAP**/
131 /**#define DEBUG_CHILD_DUMPCAP**/
135 #include <conio.h> /* _getch() */
139 #ifdef DEBUG_CHILD_DUMPCAP
140 FILE *debug_log; /* for logging debug messages to */
141 /* a file if DEBUG_CHILD_DUMPCAP */
145 static GAsyncQueue *pcap_queue;
146 static gint64 pcap_queue_bytes;
147 static gint64 pcap_queue_packets;
148 static gint64 pcap_queue_byte_limit = 1024 * 1024;
149 static gint64 pcap_queue_packet_limit = 1000;
151 static gboolean capture_child = FALSE; /* FALSE: standalone call, TRUE: this is an Wireshark capture child */
153 static gchar *sig_pipe_name = NULL;
154 static HANDLE sig_pipe_handle = NULL;
155 static gboolean signal_pipe_check_running(void);
159 static gboolean infodelay; /* if TRUE, don't print capture info in SIGINFO handler */
160 static gboolean infoprint; /* if TRUE, print capture info after clearing infodelay */
163 /** Stop a low-level capture (stops the capture child). */
164 static void capture_loop_stop(void);
165 /** Close a pipe, or socket if \a from_socket is TRUE */
166 static void cap_pipe_close(int pipe_fd, gboolean from_socket _U_);
168 #if !defined (__linux__)
169 #ifndef HAVE_PCAP_BREAKLOOP
171 * We don't have pcap_breakloop(), which is the only way to ensure that
172 * pcap_dispatch(), pcap_loop(), or even pcap_next() or pcap_next_ex()
173 * won't, if the call to read the next packet or batch of packets is
174 * is interrupted by a signal on UN*X, just go back and try again to
177 * On UN*X, we catch SIGINT as a "stop capturing" signal, and, in
178 * the signal handler, set a flag to stop capturing; however, without
179 * a guarantee of that sort, we can't guarantee that we'll stop capturing
180 * if the read will be retried and won't time out if no packets arrive.
182 * Therefore, on at least some platforms, we work around the lack of
183 * pcap_breakloop() by doing a select() on the pcap_t's file descriptor
184 * to wait for packets to arrive, so that we're probably going to be
185 * blocked in the select() when the signal arrives, and can just bail
186 * out of the loop at that point.
188 * However, we don't want to do that on BSD (because "select()" doesn't work
189 * correctly on BPF devices on at least some releases of some flavors of
190 * BSD), and we don't want to do it on Windows (because "select()" is
191 * something for sockets, not for arbitrary handles). (Note that "Windows"
192 * here includes Cygwin; even in its pretend-it's-UNIX environment, we're
193 * using WinPcap, not a UNIX libpcap.)
195 * Fortunately, we don't need to do it on BSD, because the libpcap timeout
196 * on BSD times out even if no packets have arrived, so we'll eventually
197 * exit pcap_dispatch() with an indication that no packets have arrived,
198 * and will break out of the capture loop at that point.
200 * On Windows, we can't send a SIGINT to stop capturing, so none of this
201 * applies in any case.
203 * XXX - the various BSDs appear to define BSD in <sys/param.h>; we don't
204 * want to include it if it's not present on this platform, however.
206 # if !defined(__FreeBSD__) && !defined(__NetBSD__) && !defined(__OpenBSD__) && \
207 !defined(__bsdi__) && !defined(__APPLE__) && !defined(_WIN32) && \
209 # define MUST_DO_SELECT
210 # endif /* avoid select */
211 #endif /* HAVE_PCAP_BREAKLOOP */
213 /* whatever the deal with pcap_breakloop, linux doesn't support timeouts
214 * in pcap_dispatch(); on the other hand, select() works just fine there.
215 * Hence we use a select for that come what may.
217 #define MUST_DO_SELECT
220 /** init the capture filter */
223 INITFILTER_BAD_FILTER,
224 INITFILTER_OTHER_ERROR
225 } initfilter_status_t;
227 typedef struct _pcap_options {
231 #ifdef MUST_DO_SELECT
232 int pcap_fd; /* pcap file descriptor */
239 gboolean ts_nsec; /* TRUE if we're using nanosecond precision. */
240 /* capture pipe (unix only "input file") */
241 gboolean from_cap_pipe; /* TRUE if we are capturing data from a capture pipe */
242 gboolean from_cap_socket; /* TRUE if we're capturing from socket */
243 struct pcap_hdr cap_pipe_hdr; /* Pcap header when capturing from a pipe */
244 struct pcaprec_modified_hdr cap_pipe_rechdr; /* Pcap record header when capturing from a pipe */
246 HANDLE cap_pipe_h; /* The handle of the capture pipe */
248 int cap_pipe_fd; /* the file descriptor of the capture pipe */
249 gboolean cap_pipe_modified; /* TRUE if data in the pipe uses modified pcap headers */
250 gboolean cap_pipe_byte_swapped; /* TRUE if data in the pipe is byte swapped */
252 char * cap_pipe_buf; /* Pointer to the data buffer we read into */
254 int cap_pipe_bytes_to_read; /* Used by cap_pipe_dispatch */
255 int cap_pipe_bytes_read; /* Used by cap_pipe_dispatch */
257 STATE_EXPECT_REC_HDR,
262 enum { PIPOK, PIPEOF, PIPERR, PIPNEXIST } cap_pipe_err;
264 GMutex *cap_pipe_read_mtx;
265 GAsyncQueue *cap_pipe_pending_q, *cap_pipe_done_q;
269 typedef struct _loop_data {
271 gboolean go; /* TRUE as long as we're supposed to keep capturing */
272 int err; /* if non-zero, error seen while capturing */
273 gint packet_count; /* Number of packets we have already captured */
274 gint packet_max; /* Number of packets we're supposed to capture - 0 means infinite */
275 guint inpkts_to_sync_pipe; /* Packets not already send out to the sync_pipe */
277 gboolean report_packet_count; /* Set by SIGINFO handler; print packet count */
284 guint32 autostop_files;
287 typedef struct _pcap_queue_element {
288 pcap_options *pcap_opts;
289 struct pcap_pkthdr phdr;
291 } pcap_queue_element;
294 * Standard secondary message for unexpected errors.
296 static const char please_report[] =
297 "Please report this to the Wireshark developers.\n"
298 "(This is not a crash; please do not report it as such.)";
301 * This needs to be static, so that the SIGINT handler can clear the "go"
304 static loop_data global_ld;
308 * Timeout, in milliseconds, for reads from the stream of captured packets
309 * from a capture device.
311 * A bug in Mac OS X 10.6 and 10.6.1 causes calls to pcap_open_live(), in
312 * 64-bit applications, with sub-second timeouts not to work. The bug is
313 * fixed in 10.6.2, re-broken in 10.6.3, and again fixed in 10.6.5.
315 #if defined(__APPLE__) && defined(__LP64__)
316 static gboolean need_timeout_workaround;
318 #define CAP_READ_TIMEOUT (need_timeout_workaround ? 1000 : 250)
320 #define CAP_READ_TIMEOUT 250
324 * Timeout, in microseconds, for reads from the stream of captured packets
325 * from a pipe. Pipes don't have the same problem that BPF devices do
326 * in OS X 10.6, 10.6.1, 10.6.3, and 10.6.4, so we always use a timeout
327 * of 250ms, i.e. the same value as CAP_READ_TIMEOUT when not on one
328 * of the offending versions of Snow Leopard.
330 * On Windows this value is converted to milliseconds and passed to
331 * WaitForSingleObject. If it's less than 1000 WaitForSingleObject
332 * will return immediately.
335 #define PIPE_READ_TIMEOUT 100000
337 #define PIPE_READ_TIMEOUT 250000
340 #define WRITER_THREAD_TIMEOUT 100000 /* usecs */
343 console_log_handler(const char *log_domain, GLogLevelFlags log_level,
344 const char *message, gpointer user_data _U_);
346 /* capture related options */
347 static capture_options global_capture_opts;
348 static gboolean quiet = FALSE;
349 static gboolean use_threads = FALSE;
350 static guint64 start_time;
352 static void capture_loop_write_packet_cb(u_char *pcap_opts_p, const struct pcap_pkthdr *phdr,
354 static void capture_loop_queue_packet_cb(u_char *pcap_opts_p, const struct pcap_pkthdr *phdr,
356 static void capture_loop_get_errmsg(char *errmsg, int errmsglen, const char *fname,
357 int err, gboolean is_close);
359 static void WS_MSVC_NORETURN exit_main(int err) G_GNUC_NORETURN;
361 static void report_new_capture_file(const char *filename);
362 static void report_packet_count(unsigned int packet_count);
363 static void report_packet_drops(guint32 received, guint32 drops, gchar *name);
364 static void report_capture_error(const char *error_msg, const char *secondary_error_msg);
365 static void report_cfilter_error(capture_options *capture_opts, guint i, const char *errmsg);
367 #define MSG_MAX_LENGTH 4096
369 /* Copied from pcapio.c libpcap_write_interface_statistics_block()*/
371 create_timestamp(void) {
381 * Current time, represented as 100-nanosecond intervals since
382 * January 1, 1601, 00:00:00 UTC.
384 * I think DWORD might be signed, so cast both parts of "now"
385 * to guint32 so that the sign bit doesn't get treated specially.
387 * Windows 8 provides GetSystemTimePreciseAsFileTime which we
388 * might want to use instead.
390 GetSystemTimeAsFileTime(&now);
391 timestamp = (((guint64)(guint32)now.dwHighDateTime) << 32) +
392 (guint32)now.dwLowDateTime;
395 * Convert to same thing but as 1-microsecond, i.e. 1000-nanosecond,
401 * Subtract difference, in microseconds, between January 1, 1601
402 * 00:00:00 UTC and January 1, 1970, 00:00:00 UTC.
404 timestamp -= G_GINT64_CONSTANT(11644473600000000U);
407 * Current time, represented as seconds and microseconds since
408 * January 1, 1970, 00:00:00 UTC.
410 gettimeofday(&now, NULL);
413 * Convert to delta in microseconds.
415 timestamp = (guint64)(now.tv_sec) * 1000000 +
416 (guint64)(now.tv_usec);
422 print_usage(gboolean print_ver)
429 "Dumpcap " VERSION "%s\n"
430 "Capture network packets and dump them into a pcapng file.\n"
431 "See http://www.wireshark.org for more information.\n",
432 wireshark_svnversion);
436 fprintf(output, "\nUsage: dumpcap [options] ...\n");
437 fprintf(output, "\n");
438 fprintf(output, "Capture interface:\n");
439 fprintf(output, " -i <interface> name or idx of interface (def: first non-loopback),\n"
440 " or for remote capturing, use one of these formats:\n"
441 " rpcap://<host>/<interface>\n"
442 " TCP@<host>:<port>\n");
443 fprintf(output, " -f <capture filter> packet filter in libpcap filter syntax\n");
444 fprintf(output, " -s <snaplen> packet snapshot length (def: 65535)\n");
445 fprintf(output, " -p don't capture in promiscuous mode\n");
446 #ifdef HAVE_PCAP_CREATE
447 fprintf(output, " -I capture in monitor mode, if available\n");
449 #if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
450 fprintf(output, " -B <buffer size> size of kernel buffer (def: 1MB)\n");
452 fprintf(output, " -y <link type> link layer type (def: first appropriate)\n");
453 fprintf(output, " -D print list of interfaces and exit\n");
454 fprintf(output, " -L print list of link-layer types of iface and exit\n");
455 #ifdef HAVE_BPF_IMAGE
456 fprintf(output, " -d print generated BPF code for capture filter\n");
458 fprintf(output, " -k set channel on wifi interface <freq>,[<type>]\n");
459 fprintf(output, " -S print statistics for each interface once per second\n");
460 fprintf(output, " -M for -D, -L, and -S, produce machine-readable output\n");
461 fprintf(output, "\n");
462 #ifdef HAVE_PCAP_REMOTE
463 fprintf(output, "RPCAP options:\n");
464 fprintf(output, " -r don't ignore own RPCAP traffic in capture\n");
465 fprintf(output, " -u use UDP for RPCAP data transfer\n");
466 fprintf(output, " -A <user>:<password> use RPCAP password authentication\n");
467 #ifdef HAVE_PCAP_SETSAMPLING
468 fprintf(output, " -m <sampling type> use packet sampling\n");
469 fprintf(output, " count:NUM - capture one packet of every NUM\n");
470 fprintf(output, " timer:NUM - capture no more than 1 packet in NUM ms\n");
473 fprintf(output, "Stop conditions:\n");
474 fprintf(output, " -c <packet count> stop after n packets (def: infinite)\n");
475 fprintf(output, " -a <autostop cond.> ... duration:NUM - stop after NUM seconds\n");
476 fprintf(output, " filesize:NUM - stop this file after NUM KB\n");
477 fprintf(output, " files:NUM - stop after NUM files\n");
478 /*fprintf(output, "\n");*/
479 fprintf(output, "Output (files):\n");
480 fprintf(output, " -w <filename> name of file to save (def: tempfile)\n");
481 fprintf(output, " -g enable group read access on the output file(s)\n");
482 fprintf(output, " -b <ringbuffer opt.> ... duration:NUM - switch to next file after NUM secs\n");
483 fprintf(output, " filesize:NUM - switch to next file after NUM KB\n");
484 fprintf(output, " files:NUM - ringbuffer: replace after NUM files\n");
485 fprintf(output, " -n use pcapng format instead of pcap (default)\n");
486 fprintf(output, " -P use libpcap format instead of pcapng\n");
487 fprintf(output, "\n");
488 fprintf(output, "Miscellaneous:\n");
489 fprintf(output, " -t use a separate thread per interface\n");
490 fprintf(output, " -q don't report packet capture counts\n");
491 fprintf(output, " -v print version information and exit\n");
492 fprintf(output, " -h display this help and exit\n");
493 fprintf(output, "\n");
494 fprintf(output, "Example: dumpcap -i eth0 -a duration:60 -w output.pcapng\n");
495 fprintf(output, "\"Capture packets from interface eth0 until 60s passed into output.pcapng\"\n");
496 fprintf(output, "\n");
497 fprintf(output, "Use Ctrl-C to stop capturing at any time.\n");
501 show_version(GString *comp_info_str, GString *runtime_info_str)
504 "Dumpcap " VERSION "%s\n"
509 "See http://www.wireshark.org for more information.\n",
510 wireshark_svnversion, get_copyright_info() ,comp_info_str->str, runtime_info_str->str);
514 * Print to the standard error. This is a command-line tool, so there's
515 * no need to pop up a console.
518 vfprintf_stderr(const char *fmt, va_list ap)
520 vfprintf(stderr, fmt, ap);
524 fprintf_stderr(const char *fmt, ...)
529 vfprintf_stderr(fmt, ap);
534 * Report an error in command-line arguments.
537 cmdarg_err(const char *fmt, ...)
543 /* Generate a 'special format' message back to parent */
545 msg = g_strdup_vprintf(fmt, ap);
546 sync_pipe_errmsg_to_parent(2, msg, "");
551 fprintf(stderr, "dumpcap: ");
552 vfprintf(stderr, fmt, ap);
553 fprintf(stderr, "\n");
559 * Report additional information for an error in command-line arguments.
562 cmdarg_err_cont(const char *fmt, ...)
569 msg = g_strdup_vprintf(fmt, ap);
570 sync_pipe_errmsg_to_parent(2, msg, "");
575 vfprintf(stderr, fmt, ap);
576 fprintf(stderr, "\n");
583 #if 0 /* Set to enable capability debugging */
584 /* see 'man cap_to_text()' for explanation of output */
585 /* '=' means 'all= ' ie: no capabilities */
586 /* '=ip' means 'all=ip' ie: all capabilities are permissible and inheritable */
588 print_caps(const char *pfx) {
589 cap_t caps = cap_get_proc();
590 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
591 "%s: EUID: %d Capabilities: %s", pfx,
592 geteuid(), cap_to_text(caps, NULL));
595 print_caps(const char *pfx _U_) {
600 relinquish_all_capabilities(void)
602 /* Drop any and all capabilities this process may have. */
603 /* Allowed whether or not process has any privileges. */
604 cap_t caps = cap_init(); /* all capabilities initialized to off */
605 print_caps("Pre-clear");
606 if (cap_set_proc(caps)) {
607 cmdarg_err("cap_set_proc() fail return: %s", g_strerror(errno));
609 print_caps("Post-clear");
615 open_capture_device(interface_options *interface_opts,
616 char (*open_err_str)[PCAP_ERRBUF_SIZE])
619 #ifdef HAVE_PCAP_CREATE
622 #if defined(HAVE_PCAP_OPEN) && defined(HAVE_PCAP_REMOTE)
623 struct pcap_rmtauth auth;
626 /* Open the network interface to capture from it.
627 Some versions of libpcap may put warnings into the error buffer
628 if they succeed; to tell if that's happened, we have to clear
629 the error buffer, and check if it's still a null string. */
630 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "Entering open_capture_device().");
631 (*open_err_str)[0] = '\0';
632 #if defined(HAVE_PCAP_OPEN) && defined(HAVE_PCAP_REMOTE)
634 * If we're opening a remote device, use pcap_open(); that's currently
635 * the only open routine that supports remote devices.
637 if (strncmp (interface_opts->name, "rpcap://", 8) == 0) {
638 auth.type = interface_opts->auth_type == CAPTURE_AUTH_PWD ?
639 RPCAP_RMTAUTH_PWD : RPCAP_RMTAUTH_NULL;
640 auth.username = interface_opts->auth_username;
641 auth.password = interface_opts->auth_password;
643 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
644 "Calling pcap_open() using name %s, snaplen %d, promisc_mode %d, datatx_udp %d, nocap_rpcap %d.",
645 interface_opts->name, interface_opts->snaplen, interface_opts->promisc_mode,
646 interface_opts->datatx_udp, interface_opts->nocap_rpcap);
647 pcap_h = pcap_open(interface_opts->name, interface_opts->snaplen,
649 (interface_opts->promisc_mode ? PCAP_OPENFLAG_PROMISCUOUS : 0) |
650 (interface_opts->datatx_udp ? PCAP_OPENFLAG_DATATX_UDP : 0) |
651 (interface_opts->nocap_rpcap ? PCAP_OPENFLAG_NOCAPTURE_RPCAP : 0),
652 CAP_READ_TIMEOUT, &auth, *open_err_str);
653 if (pcap_h == NULL) {
654 /* Error - did pcap actually supply an error message? */
655 if ((*open_err_str)[0] == '\0') {
656 /* Work around known WinPcap bug wherein no error message is
657 filled in on a failure to open an rpcap: URL. */
658 g_strlcpy(*open_err_str,
659 "Unknown error (pcap bug; actual error cause not reported)",
660 sizeof *open_err_str);
663 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
664 "pcap_open() returned %p.", (void *)pcap_h);
669 * If we're not opening a remote device, use pcap_create() and
670 * pcap_activate() if we have them, so that we can set the buffer
671 * size, otherwise use pcap_open_live().
673 #ifdef HAVE_PCAP_CREATE
674 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
675 "Calling pcap_create() using %s.", interface_opts->name);
676 pcap_h = pcap_create(interface_opts->name, *open_err_str);
677 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
678 "pcap_create() returned %p.", (void *)pcap_h);
679 if (pcap_h != NULL) {
680 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
681 "Calling pcap_set_snaplen() with snaplen %d.", interface_opts->snaplen);
682 pcap_set_snaplen(pcap_h, interface_opts->snaplen);
683 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
684 "Calling pcap_set_promisc() with promisc_mode %d.", interface_opts->promisc_mode);
685 pcap_set_promisc(pcap_h, interface_opts->promisc_mode);
686 pcap_set_timeout(pcap_h, CAP_READ_TIMEOUT);
688 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
689 "buffersize %d.", interface_opts->buffer_size);
690 if (interface_opts->buffer_size != 0) {
691 pcap_set_buffer_size(pcap_h, interface_opts->buffer_size * 1024 * 1024);
693 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
694 "monitor_mode %d.", interface_opts->monitor_mode);
695 if (interface_opts->monitor_mode)
696 pcap_set_rfmon(pcap_h, 1);
697 err = pcap_activate(pcap_h);
698 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
699 "pcap_activate() returned %d.", err);
701 /* Failed to activate, set to NULL */
702 if (err == PCAP_ERROR)
703 g_strlcpy(*open_err_str, pcap_geterr(pcap_h), sizeof *open_err_str);
705 g_strlcpy(*open_err_str, pcap_statustostr(err), sizeof *open_err_str);
711 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
712 "pcap_open_live() calling using name %s, snaplen %d, promisc_mode %d.",
713 interface_opts->name, interface_opts->snaplen, interface_opts->promisc_mode);
714 pcap_h = pcap_open_live(interface_opts->name, interface_opts->snaplen,
715 interface_opts->promisc_mode, CAP_READ_TIMEOUT,
717 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
718 "pcap_open_live() returned %p.", (void *)pcap_h);
721 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "open_capture_device %s : %s", pcap_h ? "SUCCESS" : "FAILURE", interface_opts->name);
726 get_capture_device_open_failure_messages(const char *open_err_str,
732 char *errmsg, size_t errmsg_len,
733 char *secondary_errmsg,
734 size_t secondary_errmsg_len)
737 const char *libpcap_warn;
738 static const char ppamsg[] = "can't find PPA for ";
741 g_snprintf(errmsg, (gulong) errmsg_len,
742 "The capture session could not be initiated (%s).", open_err_str);
745 g_snprintf(secondary_errmsg, (gulong) secondary_errmsg_len,
747 "In order to capture packets, WinPcap must be installed; see\n"
749 " http://www.winpcap.org/\n"
753 " http://www.mirrors.wiretapped.net/security/packet-capture/winpcap/\n"
757 " http://winpcap.cs.pu.edu.tw/\n"
759 "for a downloadable version of WinPcap and for instructions on how to install\n"
762 g_snprintf(secondary_errmsg, (gulong) secondary_errmsg_len,
764 "Please check that \"%s\" is the proper interface.\n"
767 "Help can be found at:\n"
769 " http://wiki.wireshark.org/WinPcap\n"
770 " http://wiki.wireshark.org/CaptureSetup\n",
774 /* If we got a "can't find PPA for X" message, warn the user (who
775 is running dumpcap on HP-UX) that they don't have a version of
776 libpcap that properly handles HP-UX (libpcap 0.6.x and later
777 versions, which properly handle HP-UX, say "can't find /dev/dlpi
778 PPA for X" rather than "can't find PPA for X"). */
779 if (strncmp(open_err_str, ppamsg, sizeof ppamsg - 1) == 0)
782 "You are running (T)Wireshark with a version of the libpcap library\n"
783 "that doesn't handle HP-UX network devices well; this means that\n"
784 "(T)Wireshark may not be able to capture packets.\n"
786 "To fix this, you should install libpcap 0.6.2, or a later version\n"
787 "of libpcap, rather than libpcap 0.4 or 0.5.x. It is available in\n"
788 "packaged binary form from the Software Porting And Archive Centre\n"
789 "for HP-UX; the Centre is at http://hpux.connect.org.uk/ - the page\n"
790 "at the URL lists a number of mirror sites.";
794 g_snprintf(secondary_errmsg, (gulong) secondary_errmsg_len,
795 "Please check to make sure you have sufficient permissions, and that you have "
796 "the proper interface or pipe specified.%s", libpcap_warn);
800 /* Set the data link type on a pcap. */
802 set_pcap_linktype(pcap_t *pcap_h, int linktype,
803 #ifdef HAVE_PCAP_SET_DATALINK
808 char *errmsg, size_t errmsg_len,
809 char *secondary_errmsg, size_t secondary_errmsg_len)
811 char *set_linktype_err_str;
814 return TRUE; /* just use the default */
815 #ifdef HAVE_PCAP_SET_DATALINK
816 if (pcap_set_datalink(pcap_h, linktype) == 0)
817 return TRUE; /* no error */
818 set_linktype_err_str = pcap_geterr(pcap_h);
820 /* Let them set it to the type it is; reject any other request. */
821 if (get_pcap_linktype(pcap_h, name) == linktype)
822 return TRUE; /* no error */
823 set_linktype_err_str =
824 "That DLT isn't one of the DLTs supported by this device";
826 g_snprintf(errmsg, (gulong) errmsg_len, "Unable to set data link type (%s).",
827 set_linktype_err_str);
829 * If the error isn't "XXX is not one of the DLTs supported by this device",
830 * tell the user to tell the Wireshark developers about it.
832 if (strstr(set_linktype_err_str, "is not one of the DLTs supported by this device") == NULL)
833 g_snprintf(secondary_errmsg, (gulong) secondary_errmsg_len, please_report);
835 secondary_errmsg[0] = '\0';
840 compile_capture_filter(const char *iface, pcap_t *pcap_h,
841 struct bpf_program *fcode, const char *cfilter)
843 bpf_u_int32 netnum, netmask;
844 gchar lookup_net_err_str[PCAP_ERRBUF_SIZE];
846 if (pcap_lookupnet(iface, &netnum, &netmask, lookup_net_err_str) < 0) {
848 * Well, we can't get the netmask for this interface; it's used
849 * only for filters that check for broadcast IP addresses, so
850 * we just punt and use 0. It might be nice to warn the user,
851 * but that's a pain in a GUI application, as it'd involve popping
852 * up a message box, and it's not clear how often this would make
853 * a difference (only filters that check for IP broadcast addresses
857 "Warning: Couldn't obtain netmask info (%s).", lookup_net_err_str);*/
862 * Sigh. Older versions of libpcap don't properly declare the
863 * third argument to pcap_compile() as a const pointer. Cast
866 if (pcap_compile(pcap_h, fcode, (char *)cfilter, 1, netmask) < 0)
871 #ifdef HAVE_BPF_IMAGE
873 show_filter_code(capture_options *capture_opts)
875 interface_options interface_opts;
877 gchar open_err_str[PCAP_ERRBUF_SIZE];
878 char errmsg[MSG_MAX_LENGTH+1];
879 char secondary_errmsg[MSG_MAX_LENGTH+1];
880 struct bpf_program fcode;
881 struct bpf_insn *insn;
885 for (j = 0; j < capture_opts->ifaces->len; j++) {
886 interface_opts = g_array_index(capture_opts->ifaces, interface_options, j);
887 pcap_h = open_capture_device(&interface_opts, &open_err_str);
888 if (pcap_h == NULL) {
889 /* Open failed; get messages */
890 get_capture_device_open_failure_messages(open_err_str,
892 errmsg, sizeof errmsg,
894 sizeof secondary_errmsg);
895 /* And report them */
896 report_capture_error(errmsg, secondary_errmsg);
900 /* Set the link-layer type. */
901 if (!set_pcap_linktype(pcap_h, interface_opts.linktype, interface_opts.name,
902 errmsg, sizeof errmsg,
903 secondary_errmsg, sizeof secondary_errmsg)) {
905 report_capture_error(errmsg, secondary_errmsg);
909 /* OK, try to compile the capture filter. */
910 if (!compile_capture_filter(interface_opts.name, pcap_h, &fcode,
911 interface_opts.cfilter)) {
913 report_cfilter_error(capture_opts, j, errmsg);
918 /* Now print the filter code. */
919 insn = fcode.bf_insns;
921 for (i = 0; i < fcode.bf_len; insn++, i++)
922 printf("%s\n", bpf_image(insn, i));
924 /* If not using libcap: we now can now set euid/egid to ruid/rgid */
925 /* to remove any suid privileges. */
926 /* If using libcap: we can now remove NET_RAW and NET_ADMIN capabilities */
927 /* (euid/egid have already previously been set to ruid/rgid. */
928 /* (See comment in main() for details) */
930 relinquish_special_privs_perm();
932 relinquish_all_capabilities();
935 /* Let our parent know we succeeded. */
936 pipe_write_block(2, SP_SUCCESS, NULL);
943 * capture_interface_list() is expected to do the right thing to get
944 * a list of interfaces.
946 * In most of the programs in the Wireshark suite, "the right thing"
947 * is to run dumpcap and ask it for the list, because dumpcap may
948 * be the only program in the suite with enough privileges to get
951 * In dumpcap itself, however, we obviously can't run dumpcap to
952 * ask for the list. Therefore, our capture_interface_list() should
953 * just call get_interface_list().
956 capture_interface_list(int *err, char **err_str)
958 return get_interface_list(err, err_str);
962 * Get the data-link type for a libpcap device.
963 * This works around AIX 5.x's non-standard and incompatible-with-the-
964 * rest-of-the-universe libpcap.
967 get_pcap_linktype(pcap_t *pch, const char *devname
975 const char *ifacename;
978 linktype = pcap_datalink(pch);
982 * The libpcap that comes with AIX 5.x uses RFC 1573 ifType values
983 * rather than DLT_ values for link-layer types; the ifType values
984 * for LAN devices are:
991 * and the ifType value for a loopback device is 24.
993 * The AIX names for LAN devices begin with:
1000 * and the AIX names for loopback devices begin with "lo".
1002 * (The difference between "Ethernet" and "802.3" is presumably
1003 * whether packets have an Ethernet header, with a packet type,
1004 * or an 802.3 header, with a packet length, followed by an 802.2
1005 * header and possibly a SNAP header.)
1007 * If the device name matches "linktype" interpreted as an ifType
1008 * value, rather than as a DLT_ value, we will assume this is AIX's
1009 * non-standard, incompatible libpcap, rather than a standard libpcap,
1010 * and will map the link-layer type to the standard DLT_ value for
1011 * that link-layer type, as that's what the rest of Wireshark expects.
1013 * (This means the capture files won't be readable by a tcpdump
1014 * linked with AIX's non-standard libpcap, but so it goes. They
1015 * *will* be readable by standard versions of tcpdump, Wireshark,
1018 * XXX - if we conclude we're using AIX libpcap, should we also
1019 * set a flag to cause us to assume the time stamps are in
1020 * seconds-and-nanoseconds form, and to convert them to
1021 * seconds-and-microseconds form before processing them and
1026 * Find the last component of the device name, which is the
1029 ifacename = strchr(devname, '/');
1030 if (ifacename == NULL)
1031 ifacename = devname;
1033 /* See if it matches any of the LAN device names. */
1034 if (strncmp(ifacename, "en", 2) == 0) {
1035 if (linktype == 6) {
1037 * That's the RFC 1573 value for Ethernet; map it to DLT_EN10MB.
1041 } else if (strncmp(ifacename, "et", 2) == 0) {
1042 if (linktype == 7) {
1044 * That's the RFC 1573 value for 802.3; map it to DLT_EN10MB.
1045 * (libpcap, tcpdump, Wireshark, etc. don't care if it's Ethernet
1050 } else if (strncmp(ifacename, "tr", 2) == 0) {
1051 if (linktype == 9) {
1053 * That's the RFC 1573 value for 802.5 (Token Ring); map it to
1054 * DLT_IEEE802, which is what's used for Token Ring.
1058 } else if (strncmp(ifacename, "fi", 2) == 0) {
1059 if (linktype == 15) {
1061 * That's the RFC 1573 value for FDDI; map it to DLT_FDDI.
1065 } else if (strncmp(ifacename, "lo", 2) == 0) {
1066 if (linktype == 24) {
1068 * That's the RFC 1573 value for "software loopback" devices; map it
1069 * to DLT_NULL, which is what's used for loopback devices on BSD.
1079 static data_link_info_t *
1080 create_data_link_info(int dlt)
1082 data_link_info_t *data_link_info;
1085 data_link_info = (data_link_info_t *)g_malloc(sizeof (data_link_info_t));
1086 data_link_info->dlt = dlt;
1087 text = pcap_datalink_val_to_name(dlt);
1089 data_link_info->name = g_strdup(text);
1091 data_link_info->name = g_strdup_printf("DLT %d", dlt);
1092 text = pcap_datalink_val_to_description(dlt);
1094 data_link_info->description = g_strdup(text);
1096 data_link_info->description = NULL;
1097 return data_link_info;
1101 * Get the capabilities of a network device.
1103 static if_capabilities_t *
1104 get_if_capabilities(const char *devname, gboolean monitor_mode
1105 #ifndef HAVE_PCAP_CREATE
1110 if_capabilities_t *caps;
1111 char errbuf[PCAP_ERRBUF_SIZE];
1113 #ifdef HAVE_PCAP_CREATE
1117 #ifdef HAVE_PCAP_LIST_DATALINKS
1121 data_link_info_t *data_link_info;
1124 * Allocate the interface capabilities structure.
1126 caps = g_malloc(sizeof *caps);
1129 * WinPcap 4.1.2, and possibly earlier versions, have a bug
1130 * wherein, when an open with an rpcap: URL fails, the error
1131 * message for the error is not copied to errbuf and whatever
1132 * on-the-stack junk is in errbuf is treated as the error
1135 * To work around that (and any other bugs of that sort, we
1136 * initialize errbuf to an empty string. If we get an error
1137 * and the string is empty, we report it as an unknown error.
1138 * (If we *don't* get an error, and the string is *non*-empty,
1139 * that could be a warning returned, such as "can't turn
1140 * promiscuous mode on"; we currently don't do so.)
1143 #ifdef HAVE_PCAP_OPEN
1144 pch = pcap_open(devname, MIN_PACKET_SIZE, 0, 0, NULL, errbuf);
1145 caps->can_set_rfmon = FALSE;
1147 if (err_str != NULL)
1148 *err_str = g_strdup(errbuf[0] == '\0' ? "Unknown error (pcap bug; actual error cause not reported)" : errbuf);
1152 #elif defined(HAVE_PCAP_CREATE)
1153 pch = pcap_create(devname, errbuf);
1155 if (err_str != NULL)
1156 *err_str = g_strdup(errbuf);
1160 status = pcap_can_set_rfmon(pch);
1163 if (status == PCAP_ERROR)
1164 *err_str = g_strdup_printf("pcap_can_set_rfmon() failed: %s",
1167 *err_str = g_strdup(pcap_statustostr(status));
1173 caps->can_set_rfmon = FALSE;
1174 else if (status == 1) {
1175 caps->can_set_rfmon = TRUE;
1177 pcap_set_rfmon(pch, 1);
1179 if (err_str != NULL) {
1180 *err_str = g_strdup_printf("pcap_can_set_rfmon() returned %d",
1188 status = pcap_activate(pch);
1190 /* Error. We ignore warnings (status > 0). */
1191 if (err_str != NULL) {
1192 if (status == PCAP_ERROR)
1193 *err_str = g_strdup_printf("pcap_activate() failed: %s",
1196 *err_str = g_strdup(pcap_statustostr(status));
1203 pch = pcap_open_live(devname, MIN_PACKET_SIZE, 0, 0, errbuf);
1204 caps->can_set_rfmon = FALSE;
1206 if (err_str != NULL)
1207 *err_str = g_strdup(errbuf[0] == '\0' ? "Unknown error (pcap bug; actual error cause not reported)" : errbuf);
1212 deflt = get_pcap_linktype(pch, devname);
1213 #ifdef HAVE_PCAP_LIST_DATALINKS
1214 nlt = pcap_list_datalinks(pch, &linktypes);
1215 if (nlt == 0 || linktypes == NULL) {
1217 if (err_str != NULL)
1218 *err_str = NULL; /* an empty list doesn't mean an error */
1222 caps->data_link_types = NULL;
1223 for (i = 0; i < nlt; i++) {
1224 data_link_info = create_data_link_info(linktypes[i]);
1227 * XXX - for 802.11, make the most detailed 802.11
1228 * version the default, rather than the one the
1229 * device has as the default?
1231 if (linktypes[i] == deflt)
1232 caps->data_link_types = g_list_prepend(caps->data_link_types,
1235 caps->data_link_types = g_list_append(caps->data_link_types,
1238 #ifdef HAVE_PCAP_FREE_DATALINKS
1239 pcap_free_datalinks(linktypes);
1242 * In Windows, there's no guarantee that if you have a library
1243 * built with one version of the MSVC++ run-time library, and
1244 * it returns a pointer to allocated data, you can free that
1245 * data from a program linked with another version of the
1246 * MSVC++ run-time library.
1248 * This is not an issue on UN*X.
1250 * See the mail threads starting at
1252 * http://www.winpcap.org/pipermail/winpcap-users/2006-September/001421.html
1256 * http://www.winpcap.org/pipermail/winpcap-users/2008-May/002498.html
1259 #define xx_free free /* hack so checkAPIs doesn't complain */
1262 #endif /* HAVE_PCAP_FREE_DATALINKS */
1263 #else /* HAVE_PCAP_LIST_DATALINKS */
1265 data_link_info = create_data_link_info(deflt);
1266 caps->data_link_types = g_list_append(caps->data_link_types,
1268 #endif /* HAVE_PCAP_LIST_DATALINKS */
1272 if (err_str != NULL)
1277 #define ADDRSTRLEN 46 /* Covers IPv4 & IPv6 */
1279 * Output a machine readable list of the interfaces
1280 * This list is retrieved by the sync_interface_list_open() function
1281 * The actual output of this function can be viewed with the command "dumpcap -D -Z none"
1284 print_machine_readable_interfaces(GList *if_list)
1291 char addr_str[ADDRSTRLEN];
1293 if (capture_child) {
1294 /* Let our parent know we succeeded. */
1295 pipe_write_block(2, SP_SUCCESS, NULL);
1298 i = 1; /* Interface id number */
1299 for (if_entry = g_list_first(if_list); if_entry != NULL;
1300 if_entry = g_list_next(if_entry)) {
1301 if_info = (if_info_t *)if_entry->data;
1302 printf("%d. %s", i++, if_info->name);
1305 * Print the contents of the if_entry struct in a parseable format.
1306 * Each if_entry element is tab-separated. Addresses are comma-
1309 /* XXX - Make sure our description doesn't contain a tab */
1310 if (if_info->vendor_description != NULL)
1311 printf("\t%s\t", if_info->vendor_description);
1315 /* XXX - Make sure our friendly name doesn't contain a tab */
1316 if (if_info->friendly_name != NULL)
1317 printf("%s\t", if_info->friendly_name);
1321 for (addr = g_slist_nth(if_info->addrs, 0); addr != NULL;
1322 addr = g_slist_next(addr)) {
1323 if (addr != g_slist_nth(if_info->addrs, 0))
1326 if_addr = (if_addr_t *)addr->data;
1327 switch(if_addr->ifat_type) {
1329 if (inet_ntop(AF_INET, &if_addr->addr.ip4_addr, addr_str,
1331 printf("%s", addr_str);
1333 printf("<unknown IPv4>");
1337 if (inet_ntop(AF_INET6, &if_addr->addr.ip6_addr,
1338 addr_str, ADDRSTRLEN)) {
1339 printf("%s", addr_str);
1341 printf("<unknown IPv6>");
1345 printf("<type unknown %u>", if_addr->ifat_type);
1349 if (if_info->loopback)
1350 printf("\tloopback");
1352 printf("\tnetwork");
1359 * If you change the machine-readable output format of this function,
1360 * you MUST update capture_ifinfo.c:capture_get_if_capabilities() accordingly!
1363 print_machine_readable_if_capabilities(if_capabilities_t *caps)
1366 data_link_info_t *data_link_info;
1367 const gchar *desc_str;
1369 if (capture_child) {
1370 /* Let our parent know we succeeded. */
1371 pipe_write_block(2, SP_SUCCESS, NULL);
1374 if (caps->can_set_rfmon)
1378 for (lt_entry = caps->data_link_types; lt_entry != NULL;
1379 lt_entry = g_list_next(lt_entry)) {
1380 data_link_info = (data_link_info_t *)lt_entry->data;
1381 if (data_link_info->description != NULL)
1382 desc_str = data_link_info->description;
1384 desc_str = "(not supported)";
1385 printf("%d\t%s\t%s\n", data_link_info->dlt, data_link_info->name,
1395 /* Print the number of packets captured for each interface until we're killed. */
1397 print_statistics_loop(gboolean machine_readable)
1399 GList *if_list, *if_entry, *stat_list = NULL, *stat_entry;
1405 char errbuf[PCAP_ERRBUF_SIZE];
1406 struct pcap_stat ps;
1408 if_list = get_interface_list(&err, &err_str);
1409 if (if_list == NULL) {
1411 case CANT_GET_INTERFACE_LIST:
1412 case DONT_HAVE_PCAP:
1413 cmdarg_err("%s", err_str);
1417 case NO_INTERFACES_FOUND:
1418 cmdarg_err("There are no interfaces on which a capture can be done");
1424 for (if_entry = g_list_first(if_list); if_entry != NULL; if_entry = g_list_next(if_entry)) {
1425 if_info = (if_info_t *)if_entry->data;
1426 #ifdef HAVE_PCAP_OPEN
1427 pch = pcap_open(if_info->name, MIN_PACKET_SIZE, 0, 0, NULL, errbuf);
1429 pch = pcap_open_live(if_info->name, MIN_PACKET_SIZE, 0, 0, errbuf);
1433 if_stat = (if_stat_t *)g_malloc(sizeof(if_stat_t));
1434 if_stat->name = g_strdup(if_info->name);
1436 stat_list = g_list_append(stat_list, if_stat);
1441 cmdarg_err("There are no interfaces on which a capture can be done");
1445 if (capture_child) {
1446 /* Let our parent know we succeeded. */
1447 pipe_write_block(2, SP_SUCCESS, NULL);
1450 if (!machine_readable) {
1451 printf("%-15s %10s %10s\n", "Interface", "Received",
1455 global_ld.go = TRUE;
1456 while (global_ld.go) {
1457 for (stat_entry = g_list_first(stat_list); stat_entry != NULL; stat_entry = g_list_next(stat_entry)) {
1458 if_stat = (if_stat_t *)stat_entry->data;
1459 pcap_stats(if_stat->pch, &ps);
1461 if (!machine_readable) {
1462 printf("%-15s %10u %10u\n", if_stat->name,
1463 ps.ps_recv, ps.ps_drop);
1465 printf("%s\t%u\t%u\n", if_stat->name,
1466 ps.ps_recv, ps.ps_drop);
1477 /* XXX - Not reached. Should we look for 'q' in stdin? */
1478 for (stat_entry = g_list_first(stat_list); stat_entry != NULL; stat_entry = g_list_next(stat_entry)) {
1479 if_stat = (if_stat_t *)stat_entry->data;
1480 pcap_close(if_stat->pch);
1481 g_free(if_stat->name);
1484 g_list_free(stat_list);
1485 free_interface_list(if_list);
1493 capture_cleanup_handler(DWORD dwCtrlType)
1495 /* CTRL_C_EVENT is sort of like SIGINT, CTRL_BREAK_EVENT is unique to
1496 Windows, CTRL_CLOSE_EVENT is sort of like SIGHUP, CTRL_LOGOFF_EVENT
1497 is also sort of like SIGHUP, and CTRL_SHUTDOWN_EVENT is sort of
1498 like SIGTERM at least when the machine's shutting down.
1500 For now, if we're running as a command rather than a capture child,
1501 we handle all but CTRL_LOGOFF_EVENT as indications that we should
1502 clean up and quit, just as we handle SIGINT, SIGHUP, and SIGTERM
1503 in that way on UN*X.
1505 If we're not running as a capture child, we might be running as
1506 a service; ignore CTRL_LOGOFF_EVENT, so we keep running after the
1507 user logs out. (XXX - can we explicitly check whether we're
1508 running as a service?) */
1510 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
1511 "Console: Control signal");
1512 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
1513 "Console: Control signal, CtrlType: %u", dwCtrlType);
1515 /* Keep capture running if we're a service and a user logs off */
1516 if (capture_child || (dwCtrlType != CTRL_LOGOFF_EVENT)) {
1517 capture_loop_stop();
1525 capture_cleanup_handler(int signum _U_)
1527 /* On UN*X, we cleanly shut down the capture on SIGINT, SIGHUP, and
1528 SIGTERM. We assume that if the user wanted it to keep running
1529 after they logged out, they'd have nohupped it. */
1531 /* Note: don't call g_log() in the signal handler: if we happened to be in
1532 * g_log() in process context when the signal came in, g_log will detect
1533 * the "recursion" and abort.
1536 capture_loop_stop();
1542 report_capture_count(gboolean reportit)
1544 /* Don't print this if we're a capture child. */
1545 if (!capture_child && reportit) {
1546 fprintf(stderr, "\rPackets captured: %u\n", global_ld.packet_count);
1547 /* stderr could be line buffered */
1555 report_counts_for_siginfo(void)
1557 report_capture_count(quiet);
1558 infoprint = FALSE; /* we just reported it */
1562 report_counts_siginfo(int signum _U_)
1564 int sav_errno = errno;
1566 /* If we've been told to delay printing, just set a flag asking
1567 that we print counts (if we're supposed to), otherwise print
1568 the count of packets captured (if we're supposed to). */
1572 report_counts_for_siginfo();
1575 #endif /* SIGINFO */
1578 exit_main(int status)
1581 /* Shutdown windows sockets */
1584 /* can be helpful for debugging */
1585 #ifdef DEBUG_DUMPCAP
1586 printf("Press any key\n");
1597 * If we were linked with libcap (not related to libpcap), make sure we have
1598 * CAP_NET_ADMIN and CAP_NET_RAW, then relinquish our permissions.
1599 * (See comment in main() for details)
1602 relinquish_privs_except_capture(void)
1604 /* If 'started_with_special_privs' (ie: suid) then enable for
1605 * ourself the NET_ADMIN and NET_RAW capabilities and then
1606 * drop our suid privileges.
1608 * CAP_NET_ADMIN: Promiscuous mode and a truckload of other
1609 * stuff we don't need (and shouldn't have).
1610 * CAP_NET_RAW: Packet capture (raw sockets).
1613 if (started_with_special_privs()) {
1614 cap_value_t cap_list[2] = { CAP_NET_ADMIN, CAP_NET_RAW };
1615 int cl_len = sizeof(cap_list) / sizeof(cap_value_t);
1617 cap_t caps = cap_init(); /* all capabilities initialized to off */
1619 print_caps("Pre drop, pre set");
1621 if (prctl(PR_SET_KEEPCAPS, 1, 0, 0, 0) == -1) {
1622 cmdarg_err("prctl() fail return: %s", g_strerror(errno));
1625 cap_set_flag(caps, CAP_PERMITTED, cl_len, cap_list, CAP_SET);
1626 cap_set_flag(caps, CAP_INHERITABLE, cl_len, cap_list, CAP_SET);
1628 if (cap_set_proc(caps)) {
1629 cmdarg_err("cap_set_proc() fail return: %s", g_strerror(errno));
1631 print_caps("Pre drop, post set");
1633 relinquish_special_privs_perm();
1635 print_caps("Post drop, pre set");
1636 cap_set_flag(caps, CAP_EFFECTIVE, cl_len, cap_list, CAP_SET);
1637 if (cap_set_proc(caps)) {
1638 cmdarg_err("cap_set_proc() fail return: %s", g_strerror(errno));
1640 print_caps("Post drop, post set");
1646 #endif /* HAVE_LIBCAP */
1648 /* Take care of byte order in the libpcap headers read from pipes.
1649 * (function taken from wiretap/libpcap.c) */
1651 cap_pipe_adjust_header(gboolean byte_swapped, struct pcap_hdr *hdr, struct pcaprec_hdr *rechdr)
1654 /* Byte-swap the record header fields. */
1655 rechdr->ts_sec = BSWAP32(rechdr->ts_sec);
1656 rechdr->ts_usec = BSWAP32(rechdr->ts_usec);
1657 rechdr->incl_len = BSWAP32(rechdr->incl_len);
1658 rechdr->orig_len = BSWAP32(rechdr->orig_len);
1661 /* In file format version 2.3, the "incl_len" and "orig_len" fields were
1662 swapped, in order to match the BPF header layout.
1664 Unfortunately, some files were, according to a comment in the "libpcap"
1665 source, written with version 2.3 in their headers but without the
1666 interchanged fields, so if "incl_len" is greater than "orig_len" - which
1667 would make no sense - we assume that we need to swap them. */
1668 if (hdr->version_major == 2 &&
1669 (hdr->version_minor < 3 ||
1670 (hdr->version_minor == 3 && rechdr->incl_len > rechdr->orig_len))) {
1673 temp = rechdr->orig_len;
1674 rechdr->orig_len = rechdr->incl_len;
1675 rechdr->incl_len = temp;
1679 /* Wrapper: distinguish between recv/read if we're reading on Windows,
1683 cap_pipe_read(int pipe_fd, char *buf, size_t sz, gboolean from_socket _U_)
1687 return recv(pipe_fd, buf, (int)sz, 0);
1692 return ws_read(pipe_fd, buf, sz);
1698 * Thread function that reads from a pipe and pushes the data
1699 * to the main application thread.
1702 * XXX Right now we use async queues for basic signaling. The main thread
1703 * sets cap_pipe_buf and cap_bytes_to_read, then pushes an item onto
1704 * cap_pipe_pending_q which triggers a read in the cap_pipe_read thread.
1705 * Iff the read is successful cap_pipe_read pushes an item onto
1706 * cap_pipe_done_q, otherwise an error is signaled. No data is passed in
1707 * the queues themselves (yet).
1709 * We might want to move some of the cap_pipe_dispatch logic here so that
1710 * we can let cap_thread_read run independently, queuing up multiple reads
1711 * for the main thread (and possibly get rid of cap_pipe_read_mtx).
1713 static void *cap_thread_read(void *arg)
1715 pcap_options *pcap_opts;
1724 pcap_opts = (pcap_options *)arg;
1725 while (pcap_opts->cap_pipe_err == PIPOK) {
1726 g_async_queue_pop(pcap_opts->cap_pipe_pending_q); /* Wait for our cue (ahem) from the main thread */
1727 g_mutex_lock(pcap_opts->cap_pipe_read_mtx);
1729 while (bytes_read < (int) pcap_opts->cap_pipe_bytes_to_read) {
1730 if ((pcap_opts->from_cap_socket)
1736 b = cap_pipe_read(pcap_opts->cap_pipe_fd, pcap_opts->cap_pipe_buf+bytes_read,
1737 pcap_opts->cap_pipe_bytes_to_read - bytes_read, pcap_opts->from_cap_socket);
1740 pcap_opts->cap_pipe_err = PIPEOF;
1744 pcap_opts->cap_pipe_err = PIPERR;
1755 /* If we try to use read() on a named pipe on Windows with partial
1756 * data it appears to return EOF.
1758 res = ReadFile(pcap_opts->cap_pipe_h, pcap_opts->cap_pipe_buf+bytes_read,
1759 pcap_opts->cap_pipe_bytes_to_read - bytes_read,
1764 last_err = GetLastError();
1765 if (last_err == ERROR_MORE_DATA) {
1767 } else if (last_err == ERROR_HANDLE_EOF || last_err == ERROR_BROKEN_PIPE || last_err == ERROR_PIPE_NOT_CONNECTED) {
1768 pcap_opts->cap_pipe_err = PIPEOF;
1772 pcap_opts->cap_pipe_err = PIPERR;
1775 } else if (b == 0 && pcap_opts->cap_pipe_bytes_to_read > 0) {
1776 pcap_opts->cap_pipe_err = PIPEOF;
1783 pcap_opts->cap_pipe_bytes_read = bytes_read;
1784 if (pcap_opts->cap_pipe_bytes_read >= pcap_opts->cap_pipe_bytes_to_read) {
1785 g_async_queue_push(pcap_opts->cap_pipe_done_q, pcap_opts->cap_pipe_buf); /* Any non-NULL value will do */
1787 g_mutex_unlock(pcap_opts->cap_pipe_read_mtx);
1793 /* Provide select() functionality for a single file descriptor
1794 * on UNIX/POSIX. Windows uses cap_pipe_read via a thread.
1796 * Returns the same values as select.
1799 cap_pipe_select(int pipe_fd)
1802 struct timeval timeout;
1805 FD_SET(pipe_fd, &rfds);
1807 timeout.tv_sec = PIPE_READ_TIMEOUT / 1000000;
1808 timeout.tv_usec = PIPE_READ_TIMEOUT % 1000000;
1810 return select(pipe_fd+1, &rfds, NULL, NULL, &timeout);
1813 #define DEF_TCP_PORT 19000
1816 cap_open_socket(char *pipename, pcap_options *pcap_opts, char *errmsg, int errmsgl)
1818 char *sockname = pipename + 4;
1819 struct sockaddr_in sa;
1826 memset(&sa, 0, sizeof(sa));
1828 p = strchr(sockname, ':');
1830 len = strlen(sockname);
1831 port = DEF_TCP_PORT;
1835 port = strtoul(p + 1, &p, 10);
1836 if (*p || port > 65535) {
1845 strncpy(buf, sockname, len);
1847 if (!inet_pton(AF_INET, buf, &sa.sin_addr)) {
1851 sa.sin_family = AF_INET;
1852 sa.sin_port = htons((u_short)port);
1854 if (((fd = (int)socket(AF_INET, SOCK_STREAM, 0)) < 0) ||
1855 (connect(fd, (struct sockaddr *)&sa, sizeof(sa)) < 0)) {
1857 LPTSTR errorText = NULL;
1860 lastError = WSAGetLastError();
1861 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM |
1862 FORMAT_MESSAGE_ALLOCATE_BUFFER |
1863 FORMAT_MESSAGE_IGNORE_INSERTS,
1864 NULL, lastError, MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
1865 (LPTSTR)&errorText, 0, NULL);
1867 g_snprintf(errmsg, errmsgl,
1868 "The capture session could not be initiated due to the socket error: \n"
1870 " %d: %S", lastError, errorText ? (char *)errorText : "Unknown");
1872 LocalFree(errorText);
1874 " %d: %s", errno, strerror(errno));
1876 pcap_opts->cap_pipe_err = PIPERR;
1879 cap_pipe_close(fd, TRUE);
1883 pcap_opts->from_cap_socket = TRUE;
1887 g_snprintf(errmsg, errmsgl,
1888 "The capture session could not be initiated because\n"
1889 "\"%s\" is not a valid socket specification", pipename);
1890 pcap_opts->cap_pipe_err = PIPERR;
1894 /* Wrapper: distinguish between closesocket on Windows; use ws_close
1898 cap_pipe_close(int pipe_fd, gboolean from_socket _U_)
1902 closesocket(pipe_fd);
1909 /* Mimic pcap_open_live() for pipe captures
1911 * We check if "pipename" is "-" (stdin), a AF_UNIX socket, or a FIFO,
1912 * open it, and read the header.
1914 * N.B. : we can't read the libpcap formats used in RedHat 6.1 or SuSE 6.3
1915 * because we can't seek on pipes (see wiretap/libpcap.c for details) */
1917 cap_pipe_open_live(char *pipename,
1918 pcap_options *pcap_opts,
1919 struct pcap_hdr *hdr,
1920 char *errmsg, int errmsgl)
1923 ws_statb64 pipe_stat;
1924 struct sockaddr_un sa;
1930 unsigned int bytes_read;
1933 pcap_opts->cap_pipe_fd = -1;
1935 pcap_opts->cap_pipe_h = INVALID_HANDLE_VALUE;
1937 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "cap_pipe_open_live: %s", pipename);
1940 * XXX - this blocks until a pcap per-file header has been written to
1941 * the pipe, so it could block indefinitely.
1943 if (strcmp(pipename, "-") == 0) {
1945 fd = 0; /* read from stdin */
1947 pcap_opts->cap_pipe_h = GetStdHandle(STD_INPUT_HANDLE);
1949 } else if (!strncmp(pipename, "TCP@", 4)) {
1950 if ((fd = cap_open_socket(pipename, pcap_opts, errmsg, errmsgl)) < 0) {
1955 if (ws_stat64(pipename, &pipe_stat) < 0) {
1956 if (errno == ENOENT || errno == ENOTDIR)
1957 pcap_opts->cap_pipe_err = PIPNEXIST;
1959 g_snprintf(errmsg, errmsgl,
1960 "The capture session could not be initiated "
1961 "due to error getting information on pipe/socket: %s", g_strerror(errno));
1962 pcap_opts->cap_pipe_err = PIPERR;
1966 if (S_ISFIFO(pipe_stat.st_mode)) {
1967 fd = ws_open(pipename, O_RDONLY | O_NONBLOCK, 0000 /* no creation so don't matter */);
1969 g_snprintf(errmsg, errmsgl,
1970 "The capture session could not be initiated "
1971 "due to error on pipe open: %s", g_strerror(errno));
1972 pcap_opts->cap_pipe_err = PIPERR;
1975 } else if (S_ISSOCK(pipe_stat.st_mode)) {
1976 fd = socket(AF_UNIX, SOCK_STREAM, 0);
1978 g_snprintf(errmsg, errmsgl,
1979 "The capture session could not be initiated "
1980 "due to error on socket create: %s", g_strerror(errno));
1981 pcap_opts->cap_pipe_err = PIPERR;
1984 sa.sun_family = AF_UNIX;
1986 * The Single UNIX Specification says:
1988 * The size of sun_path has intentionally been left undefined.
1989 * This is because different implementations use different sizes.
1990 * For example, 4.3 BSD uses a size of 108, and 4.4 BSD uses a size
1991 * of 104. Since most implementations originate from BSD versions,
1992 * the size is typically in the range 92 to 108.
1994 * Applications should not assume a particular length for sun_path
1995 * or assume that it can hold {_POSIX_PATH_MAX} bytes (256).
1999 * The <sys/un.h> header shall define the sockaddr_un structure,
2000 * which shall include at least the following members:
2002 * sa_family_t sun_family Address family.
2003 * char sun_path[] Socket pathname.
2005 * so we assume that it's an array, with a specified size,
2006 * and that the size reflects the maximum path length.
2008 if (g_strlcpy(sa.sun_path, pipename, sizeof sa.sun_path) > sizeof sa.sun_path) {
2009 /* Path name too long */
2010 g_snprintf(errmsg, errmsgl,
2011 "The capture session coud not be initiated "
2012 "due to error on socket connect: Path name too long");
2013 pcap_opts->cap_pipe_err = PIPERR;
2017 b = connect(fd, (struct sockaddr *)&sa, sizeof sa);
2019 g_snprintf(errmsg, errmsgl,
2020 "The capture session coud not be initiated "
2021 "due to error on socket connect: %s", g_strerror(errno));
2022 pcap_opts->cap_pipe_err = PIPERR;
2027 if (S_ISCHR(pipe_stat.st_mode)) {
2029 * Assume the user specified an interface on a system where
2030 * interfaces are in /dev. Pretend we haven't seen it.
2032 pcap_opts->cap_pipe_err = PIPNEXIST;
2035 g_snprintf(errmsg, errmsgl,
2036 "The capture session could not be initiated because\n"
2037 "\"%s\" is neither an interface nor a socket nor a pipe", pipename);
2038 pcap_opts->cap_pipe_err = PIPERR;
2043 #define PIPE_STR "\\pipe\\"
2044 /* Under Windows, named pipes _must_ have the form
2045 * "\\<server>\pipe\<pipename>". <server> may be "." for localhost.
2047 pncopy = g_strdup(pipename);
2048 if ( (pos=strstr(pncopy, "\\\\")) == pncopy) {
2049 pos = strchr(pncopy + 3, '\\');
2050 if (pos && g_ascii_strncasecmp(pos, PIPE_STR, strlen(PIPE_STR)) != 0)
2057 g_snprintf(errmsg, errmsgl,
2058 "The capture session could not be initiated because\n"
2059 "\"%s\" is neither an interface nor a pipe", pipename);
2060 pcap_opts->cap_pipe_err = PIPNEXIST;
2064 /* Wait for the pipe to appear */
2066 pcap_opts->cap_pipe_h = CreateFile(utf_8to16(pipename), GENERIC_READ, 0, NULL,
2067 OPEN_EXISTING, 0, NULL);
2069 if (pcap_opts->cap_pipe_h != INVALID_HANDLE_VALUE)
2072 if (GetLastError() != ERROR_PIPE_BUSY) {
2073 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
2074 NULL, GetLastError(), 0, (LPTSTR) &err_str, 0, NULL);
2075 g_snprintf(errmsg, errmsgl,
2076 "The capture session on \"%s\" could not be started "
2077 "due to error on pipe open: %s (error %d)",
2078 pipename, utf_16to8(err_str), GetLastError());
2080 pcap_opts->cap_pipe_err = PIPERR;
2084 if (!WaitNamedPipe(utf_8to16(pipename), 30 * 1000)) {
2085 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
2086 NULL, GetLastError(), 0, (LPTSTR) &err_str, 0, NULL);
2087 g_snprintf(errmsg, errmsgl,
2088 "The capture session on \"%s\" timed out during "
2089 "pipe open: %s (error %d)",
2090 pipename, utf_16to8(err_str), GetLastError());
2092 pcap_opts->cap_pipe_err = PIPERR;
2099 pcap_opts->from_cap_pipe = TRUE;
2101 if ((pcap_opts->from_cap_socket)
2107 /* read the pcap header */
2109 while (bytes_read < sizeof magic) {
2110 sel_ret = cap_pipe_select(fd);
2112 g_snprintf(errmsg, errmsgl,
2113 "Unexpected error from select: %s", g_strerror(errno));
2115 } else if (sel_ret > 0) {
2116 b = cap_pipe_read(fd, ((char *)&magic)+bytes_read, sizeof magic-bytes_read, pcap_opts->from_cap_socket);
2119 g_snprintf(errmsg, errmsgl, "End of file on pipe magic during open");
2121 g_snprintf(errmsg, errmsgl, "Error on pipe magic during open: %s",
2131 g_thread_create(&cap_thread_read, pcap_opts, FALSE, NULL);
2133 pcap_opts->cap_pipe_buf = (char *) &magic;
2134 pcap_opts->cap_pipe_bytes_read = 0;
2135 pcap_opts->cap_pipe_bytes_to_read = sizeof(magic);
2136 /* We don't have to worry about cap_pipe_read_mtx here */
2137 g_async_queue_push(pcap_opts->cap_pipe_pending_q, pcap_opts->cap_pipe_buf);
2138 g_async_queue_pop(pcap_opts->cap_pipe_done_q);
2139 if (pcap_opts->cap_pipe_bytes_read <= 0) {
2140 if (pcap_opts->cap_pipe_bytes_read == 0)
2141 g_snprintf(errmsg, errmsgl, "End of file on pipe magic during open");
2143 g_snprintf(errmsg, errmsgl, "Error on pipe magic during open: %s",
2152 case PCAP_NSEC_MAGIC:
2153 /* Host that wrote it has our byte order, and was running
2154 a program using either standard or ss990417 libpcap. */
2155 pcap_opts->cap_pipe_byte_swapped = FALSE;
2156 pcap_opts->cap_pipe_modified = FALSE;
2157 pcap_opts->ts_nsec = magic == PCAP_NSEC_MAGIC;
2159 case PCAP_MODIFIED_MAGIC:
2160 /* Host that wrote it has our byte order, but was running
2161 a program using either ss990915 or ss991029 libpcap. */
2162 pcap_opts->cap_pipe_byte_swapped = FALSE;
2163 pcap_opts->cap_pipe_modified = TRUE;
2165 case PCAP_SWAPPED_MAGIC:
2166 case PCAP_SWAPPED_NSEC_MAGIC:
2167 /* Host that wrote it has a byte order opposite to ours,
2168 and was running a program using either standard or
2169 ss990417 libpcap. */
2170 pcap_opts->cap_pipe_byte_swapped = TRUE;
2171 pcap_opts->cap_pipe_modified = FALSE;
2172 pcap_opts->ts_nsec = magic == PCAP_SWAPPED_NSEC_MAGIC;
2174 case PCAP_SWAPPED_MODIFIED_MAGIC:
2175 /* Host that wrote it out has a byte order opposite to
2176 ours, and was running a program using either ss990915
2177 or ss991029 libpcap. */
2178 pcap_opts->cap_pipe_byte_swapped = TRUE;
2179 pcap_opts->cap_pipe_modified = TRUE;
2182 /* Not a "libpcap" type we know about. */
2183 g_snprintf(errmsg, errmsgl, "Unrecognized libpcap format");
2187 if ((pcap_opts->from_cap_socket)
2193 /* Read the rest of the header */
2195 while (bytes_read < sizeof(struct pcap_hdr)) {
2196 sel_ret = cap_pipe_select(fd);
2198 g_snprintf(errmsg, errmsgl,
2199 "Unexpected error from select: %s", g_strerror(errno));
2201 } else if (sel_ret > 0) {
2202 b = cap_pipe_read(fd, ((char *)hdr)+bytes_read,
2203 sizeof(struct pcap_hdr) - bytes_read, pcap_opts->from_cap_socket);
2206 g_snprintf(errmsg, errmsgl, "End of file on pipe header during open");
2208 g_snprintf(errmsg, errmsgl, "Error on pipe header during open: %s",
2218 pcap_opts->cap_pipe_buf = (char *) hdr;
2219 pcap_opts->cap_pipe_bytes_read = 0;
2220 pcap_opts->cap_pipe_bytes_to_read = sizeof(struct pcap_hdr);
2221 g_async_queue_push(pcap_opts->cap_pipe_pending_q, pcap_opts->cap_pipe_buf);
2222 g_async_queue_pop(pcap_opts->cap_pipe_done_q);
2223 if (pcap_opts->cap_pipe_bytes_read <= 0) {
2224 if (pcap_opts->cap_pipe_bytes_read == 0)
2225 g_snprintf(errmsg, errmsgl, "End of file on pipe header during open");
2227 g_snprintf(errmsg, errmsgl, "Error on pipe header header during open: %s",
2234 if (pcap_opts->cap_pipe_byte_swapped) {
2235 /* Byte-swap the header fields about which we care. */
2236 hdr->version_major = BSWAP16(hdr->version_major);
2237 hdr->version_minor = BSWAP16(hdr->version_minor);
2238 hdr->snaplen = BSWAP32(hdr->snaplen);
2239 hdr->network = BSWAP32(hdr->network);
2241 pcap_opts->linktype = hdr->network;
2243 if (hdr->version_major < 2) {
2244 g_snprintf(errmsg, errmsgl, "Unable to read old libpcap format");
2248 pcap_opts->cap_pipe_state = STATE_EXPECT_REC_HDR;
2249 pcap_opts->cap_pipe_err = PIPOK;
2250 pcap_opts->cap_pipe_fd = fd;
2254 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "cap_pipe_open_live: error %s", errmsg);
2255 pcap_opts->cap_pipe_err = PIPERR;
2256 cap_pipe_close(fd, pcap_opts->from_cap_socket);
2257 pcap_opts->cap_pipe_fd = -1;
2263 /* We read one record from the pipe, take care of byte order in the record
2264 * header, write the record to the capture file, and update capture statistics. */
2266 cap_pipe_dispatch(loop_data *ld, pcap_options *pcap_opts, guchar *data, char *errmsg, int errmsgl)
2268 struct pcap_pkthdr phdr;
2269 enum { PD_REC_HDR_READ, PD_DATA_READ, PD_PIPE_EOF, PD_PIPE_ERR,
2272 #if !GLIB_CHECK_VERSION(2,31,18)
2280 #ifdef LOG_CAPTURE_VERBOSE
2281 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "cap_pipe_dispatch");
2284 switch (pcap_opts->cap_pipe_state) {
2286 case STATE_EXPECT_REC_HDR:
2288 if (g_mutex_trylock(pcap_opts->cap_pipe_read_mtx)) {
2291 pcap_opts->cap_pipe_state = STATE_READ_REC_HDR;
2292 pcap_opts->cap_pipe_bytes_to_read = pcap_opts->cap_pipe_modified ?
2293 sizeof(struct pcaprec_modified_hdr) : sizeof(struct pcaprec_hdr);
2294 pcap_opts->cap_pipe_bytes_read = 0;
2297 pcap_opts->cap_pipe_buf = (char *) &pcap_opts->cap_pipe_rechdr;
2298 g_async_queue_push(pcap_opts->cap_pipe_pending_q, pcap_opts->cap_pipe_buf);
2299 g_mutex_unlock(pcap_opts->cap_pipe_read_mtx);
2304 case STATE_READ_REC_HDR:
2305 if ((pcap_opts->from_cap_socket)
2311 b = cap_pipe_read(pcap_opts->cap_pipe_fd, ((char *)&pcap_opts->cap_pipe_rechdr)+pcap_opts->cap_pipe_bytes_read,
2312 pcap_opts->cap_pipe_bytes_to_read - pcap_opts->cap_pipe_bytes_read, pcap_opts->from_cap_socket);
2315 result = PD_PIPE_EOF;
2317 result = PD_PIPE_ERR;
2320 pcap_opts->cap_pipe_bytes_read += b;
2325 #if GLIB_CHECK_VERSION(2,31,18)
2326 q_status = g_async_queue_timeout_pop(pcap_opts->cap_pipe_done_q, PIPE_READ_TIMEOUT);
2328 g_get_current_time(&wait_time);
2329 g_time_val_add(&wait_time, PIPE_READ_TIMEOUT);
2330 q_status = g_async_queue_timed_pop(pcap_opts->cap_pipe_done_q, &wait_time);
2332 if (pcap_opts->cap_pipe_err == PIPEOF) {
2333 result = PD_PIPE_EOF;
2335 } else if (pcap_opts->cap_pipe_err == PIPERR) {
2336 result = PD_PIPE_ERR;
2344 if ((pcap_opts->cap_pipe_bytes_read) < pcap_opts->cap_pipe_bytes_to_read)
2346 result = PD_REC_HDR_READ;
2349 case STATE_EXPECT_DATA:
2351 if (g_mutex_trylock(pcap_opts->cap_pipe_read_mtx)) {
2354 pcap_opts->cap_pipe_state = STATE_READ_DATA;
2355 pcap_opts->cap_pipe_bytes_to_read = pcap_opts->cap_pipe_rechdr.hdr.incl_len;
2356 pcap_opts->cap_pipe_bytes_read = 0;
2359 pcap_opts->cap_pipe_buf = (char *) data;
2360 g_async_queue_push(pcap_opts->cap_pipe_pending_q, pcap_opts->cap_pipe_buf);
2361 g_mutex_unlock(pcap_opts->cap_pipe_read_mtx);
2366 case STATE_READ_DATA:
2367 if ((pcap_opts->from_cap_socket)
2373 b = cap_pipe_read(pcap_opts->cap_pipe_fd, data+pcap_opts->cap_pipe_bytes_read,
2374 pcap_opts->cap_pipe_bytes_to_read - pcap_opts->cap_pipe_bytes_read, pcap_opts->from_cap_socket);
2377 result = PD_PIPE_EOF;
2379 result = PD_PIPE_ERR;
2382 pcap_opts->cap_pipe_bytes_read += b;
2388 #if GLIB_CHECK_VERSION(2,31,18)
2389 q_status = g_async_queue_timeout_pop(pcap_opts->cap_pipe_done_q, PIPE_READ_TIMEOUT);
2391 g_get_current_time(&wait_time);
2392 g_time_val_add(&wait_time, PIPE_READ_TIMEOUT);
2393 q_status = g_async_queue_timed_pop(pcap_opts->cap_pipe_done_q, &wait_time);
2395 if (pcap_opts->cap_pipe_err == PIPEOF) {
2396 result = PD_PIPE_EOF;
2398 } else if (pcap_opts->cap_pipe_err == PIPERR) {
2399 result = PD_PIPE_ERR;
2407 if ((pcap_opts->cap_pipe_bytes_read) < pcap_opts->cap_pipe_bytes_to_read)
2409 result = PD_DATA_READ;
2413 g_snprintf(errmsg, errmsgl, "cap_pipe_dispatch: invalid state");
2416 } /* switch (pcap_opts->cap_pipe_state) */
2419 * We've now read as much data as we were expecting, so process it.
2423 case PD_REC_HDR_READ:
2424 /* We've read the header. Take care of byte order. */
2425 cap_pipe_adjust_header(pcap_opts->cap_pipe_byte_swapped, &pcap_opts->cap_pipe_hdr,
2426 &pcap_opts->cap_pipe_rechdr.hdr);
2427 if (pcap_opts->cap_pipe_rechdr.hdr.incl_len > WTAP_MAX_PACKET_SIZE) {
2428 g_snprintf(errmsg, errmsgl, "Frame %u too long (%d bytes)",
2429 ld->packet_count+1, pcap_opts->cap_pipe_rechdr.hdr.incl_len);
2433 if (pcap_opts->cap_pipe_rechdr.hdr.incl_len) {
2434 pcap_opts->cap_pipe_state = STATE_EXPECT_DATA;
2437 /* no data to read? fall through */
2440 /* Fill in a "struct pcap_pkthdr", and process the packet. */
2441 phdr.ts.tv_sec = pcap_opts->cap_pipe_rechdr.hdr.ts_sec;
2442 phdr.ts.tv_usec = pcap_opts->cap_pipe_rechdr.hdr.ts_usec;
2443 phdr.caplen = pcap_opts->cap_pipe_rechdr.hdr.incl_len;
2444 phdr.len = pcap_opts->cap_pipe_rechdr.hdr.orig_len;
2447 capture_loop_queue_packet_cb((u_char *)pcap_opts, &phdr, data);
2449 capture_loop_write_packet_cb((u_char *)pcap_opts, &phdr, data);
2451 pcap_opts->cap_pipe_state = STATE_EXPECT_REC_HDR;
2455 pcap_opts->cap_pipe_err = PIPEOF;
2460 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_IGNORE_INSERTS,
2461 NULL, GetLastError(), 0, (LPTSTR) &err_str, 0, NULL);
2462 g_snprintf(errmsg, errmsgl,
2463 "Error reading from pipe: %s (error %d)",
2464 utf_16to8(err_str), GetLastError());
2467 g_snprintf(errmsg, errmsgl, "Error reading from pipe: %s",
2475 pcap_opts->cap_pipe_err = PIPERR;
2476 /* Return here rather than inside the switch to prevent GCC warning */
2481 /** Open the capture input file (pcap or capture pipe).
2482 * Returns TRUE if it succeeds, FALSE otherwise. */
2484 capture_loop_open_input(capture_options *capture_opts, loop_data *ld,
2485 char *errmsg, size_t errmsg_len,
2486 char *secondary_errmsg, size_t secondary_errmsg_len)
2488 gchar open_err_str[PCAP_ERRBUF_SIZE];
2489 gchar *sync_msg_str;
2490 interface_options interface_opts;
2491 pcap_options *pcap_opts;
2495 gchar *sync_secondary_msg_str;
2496 WORD wVersionRequested;
2500 /* XXX - opening Winsock on tshark? */
2502 /* Initialize Windows Socket if we are in a WIN32 OS
2503 This needs to be done before querying the interface for network/netmask */
2505 /* XXX - do we really require 1.1 or earlier?
2506 Are there any versions that support only 2.0 or higher? */
2507 wVersionRequested = MAKEWORD(1, 1);
2508 err = WSAStartup(wVersionRequested, &wsaData);
2512 case WSASYSNOTREADY:
2513 g_snprintf(errmsg, (gulong) errmsg_len,
2514 "Couldn't initialize Windows Sockets: Network system not ready for network communication");
2517 case WSAVERNOTSUPPORTED:
2518 g_snprintf(errmsg, (gulong) errmsg_len,
2519 "Couldn't initialize Windows Sockets: Windows Sockets version %u.%u not supported",
2520 LOBYTE(wVersionRequested), HIBYTE(wVersionRequested));
2523 case WSAEINPROGRESS:
2524 g_snprintf(errmsg, (gulong) errmsg_len,
2525 "Couldn't initialize Windows Sockets: Blocking operation is in progress");
2529 g_snprintf(errmsg, (gulong) errmsg_len,
2530 "Couldn't initialize Windows Sockets: Limit on the number of tasks supported by this WinSock implementation has been reached");
2534 g_snprintf(errmsg, (gulong) errmsg_len,
2535 "Couldn't initialize Windows Sockets: Bad pointer passed to WSAStartup");
2539 g_snprintf(errmsg, (gulong) errmsg_len,
2540 "Couldn't initialize Windows Sockets: error %d", err);
2543 g_snprintf(secondary_errmsg, (gulong) secondary_errmsg_len, please_report);
2547 if ((use_threads == FALSE) &&
2548 (capture_opts->ifaces->len > 1)) {
2549 g_snprintf(errmsg, (gulong) errmsg_len,
2550 "Using threads is required for capturing on multiple interfaces!");
2554 for (i = 0; i < capture_opts->ifaces->len; i++) {
2555 interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
2556 pcap_opts = (pcap_options *)g_malloc(sizeof (pcap_options));
2557 if (pcap_opts == NULL) {
2558 g_snprintf(errmsg, (gulong) errmsg_len,
2559 "Could not allocate memory.");
2562 pcap_opts->received = 0;
2563 pcap_opts->dropped = 0;
2564 pcap_opts->pcap_h = NULL;
2565 #ifdef MUST_DO_SELECT
2566 pcap_opts->pcap_fd = -1;
2568 pcap_opts->pcap_err = FALSE;
2569 pcap_opts->interface_id = i;
2570 pcap_opts->tid = NULL;
2571 pcap_opts->snaplen = 0;
2572 pcap_opts->linktype = -1;
2573 pcap_opts->ts_nsec = FALSE;
2574 pcap_opts->from_cap_pipe = FALSE;
2575 pcap_opts->from_cap_socket = FALSE;
2576 memset(&pcap_opts->cap_pipe_hdr, 0, sizeof(struct pcap_hdr));
2577 memset(&pcap_opts->cap_pipe_rechdr, 0, sizeof(struct pcaprec_modified_hdr));
2579 pcap_opts->cap_pipe_h = INVALID_HANDLE_VALUE;
2581 pcap_opts->cap_pipe_fd = -1;
2582 pcap_opts->cap_pipe_modified = FALSE;
2583 pcap_opts->cap_pipe_byte_swapped = FALSE;
2585 pcap_opts->cap_pipe_buf = NULL;
2587 pcap_opts->cap_pipe_bytes_to_read = 0;
2588 pcap_opts->cap_pipe_bytes_read = 0;
2589 pcap_opts->cap_pipe_state = 0;
2590 pcap_opts->cap_pipe_err = PIPOK;
2592 #if GLIB_CHECK_VERSION(2,31,0)
2593 pcap_opts->cap_pipe_read_mtx = g_malloc(sizeof(GMutex));
2594 g_mutex_init(pcap_opts->cap_pipe_read_mtx);
2596 pcap_opts->cap_pipe_read_mtx = g_mutex_new();
2598 pcap_opts->cap_pipe_pending_q = g_async_queue_new();
2599 pcap_opts->cap_pipe_done_q = g_async_queue_new();
2601 g_array_append_val(ld->pcaps, pcap_opts);
2603 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_open_input : %s", interface_opts.name);
2604 pcap_opts->pcap_h = open_capture_device(&interface_opts, &open_err_str);
2606 if (pcap_opts->pcap_h != NULL) {
2607 /* we've opened "iface" as a network device */
2609 /* try to set the capture buffer size */
2610 if (interface_opts.buffer_size > 1 &&
2611 pcap_setbuff(pcap_opts->pcap_h, interface_opts.buffer_size * 1024 * 1024) != 0) {
2612 sync_secondary_msg_str = g_strdup_printf(
2613 "The capture buffer size of %dMB seems to be too high for your machine,\n"
2614 "the default of 1MB will be used.\n"
2616 "Nonetheless, the capture is started.\n",
2617 interface_opts.buffer_size);
2618 report_capture_error("Couldn't set the capture buffer size!",
2619 sync_secondary_msg_str);
2620 g_free(sync_secondary_msg_str);
2624 #if defined(HAVE_PCAP_SETSAMPLING)
2625 if (interface_opts.sampling_method != CAPTURE_SAMP_NONE) {
2626 struct pcap_samp *samp;
2628 if ((samp = pcap_setsampling(pcap_opts->pcap_h)) != NULL) {
2629 switch (interface_opts.sampling_method) {
2630 case CAPTURE_SAMP_BY_COUNT:
2631 samp->method = PCAP_SAMP_1_EVERY_N;
2634 case CAPTURE_SAMP_BY_TIMER:
2635 samp->method = PCAP_SAMP_FIRST_AFTER_N_MS;
2639 sync_msg_str = g_strdup_printf(
2640 "Unknown sampling method %d specified,\n"
2641 "continue without packet sampling",
2642 interface_opts.sampling_method);
2643 report_capture_error("Couldn't set the capture "
2644 "sampling", sync_msg_str);
2645 g_free(sync_msg_str);
2647 samp->value = interface_opts.sampling_param;
2649 report_capture_error("Couldn't set the capture sampling",
2650 "Cannot get packet sampling data structure");
2655 /* setting the data link type only works on real interfaces */
2656 if (!set_pcap_linktype(pcap_opts->pcap_h, interface_opts.linktype, interface_opts.name,
2658 secondary_errmsg, secondary_errmsg_len)) {
2661 pcap_opts->linktype = get_pcap_linktype(pcap_opts->pcap_h, interface_opts.name);
2663 /* We couldn't open "iface" as a network device. */
2664 /* Try to open it as a pipe */
2665 cap_pipe_open_live(interface_opts.name, pcap_opts, &pcap_opts->cap_pipe_hdr, errmsg, (int) errmsg_len);
2668 if (pcap_opts->cap_pipe_fd == -1) {
2670 if (pcap_opts->cap_pipe_h == INVALID_HANDLE_VALUE) {
2672 if (pcap_opts->cap_pipe_err == PIPNEXIST) {
2673 /* Pipe doesn't exist, so output message for interface */
2674 get_capture_device_open_failure_messages(open_err_str,
2675 interface_opts.name,
2679 secondary_errmsg_len);
2682 * Else pipe (or file) does exist and cap_pipe_open_live() has
2687 /* cap_pipe_open_live() succeeded; don't want
2688 error message from pcap_open_live() */
2689 open_err_str[0] = '\0';
2693 /* XXX - will this work for tshark? */
2694 #ifdef MUST_DO_SELECT
2695 if (!pcap_opts->from_cap_pipe) {
2696 #ifdef HAVE_PCAP_GET_SELECTABLE_FD
2697 pcap_opts->pcap_fd = pcap_get_selectable_fd(pcap_opts->pcap_h);
2699 pcap_opts->pcap_fd = pcap_fileno(pcap_opts->pcap_h);
2704 /* Does "open_err_str" contain a non-empty string? If so, "pcap_open_live()"
2705 returned a warning; print it, but keep capturing. */
2706 if (open_err_str[0] != '\0') {
2707 sync_msg_str = g_strdup_printf("%s.", open_err_str);
2708 report_capture_error(sync_msg_str, "");
2709 g_free(sync_msg_str);
2711 capture_opts->ifaces = g_array_remove_index(capture_opts->ifaces, i);
2712 g_array_insert_val(capture_opts->ifaces, i, interface_opts);
2715 /* If not using libcap: we now can now set euid/egid to ruid/rgid */
2716 /* to remove any suid privileges. */
2717 /* If using libcap: we can now remove NET_RAW and NET_ADMIN capabilities */
2718 /* (euid/egid have already previously been set to ruid/rgid. */
2719 /* (See comment in main() for details) */
2721 relinquish_special_privs_perm();
2723 relinquish_all_capabilities();
2728 /* close the capture input file (pcap or capture pipe) */
2729 static void capture_loop_close_input(loop_data *ld)
2732 pcap_options *pcap_opts;
2734 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_close_input");
2736 for (i = 0; i < ld->pcaps->len; i++) {
2737 pcap_opts = g_array_index(ld->pcaps, pcap_options *, i);
2738 /* if open, close the capture pipe "input file" */
2739 if (pcap_opts->cap_pipe_fd >= 0) {
2740 g_assert(pcap_opts->from_cap_pipe);
2741 cap_pipe_close(pcap_opts->cap_pipe_fd, pcap_opts->from_cap_socket);
2742 pcap_opts->cap_pipe_fd = -1;
2745 if (pcap_opts->cap_pipe_h != INVALID_HANDLE_VALUE) {
2746 CloseHandle(pcap_opts->cap_pipe_h);
2747 pcap_opts->cap_pipe_h = INVALID_HANDLE_VALUE;
2750 /* if open, close the pcap "input file" */
2751 if (pcap_opts->pcap_h != NULL) {
2752 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_close_input: closing %p", (void *)pcap_opts->pcap_h);
2753 pcap_close(pcap_opts->pcap_h);
2754 pcap_opts->pcap_h = NULL;
2761 /* Shut down windows sockets */
2767 /* init the capture filter */
2768 static initfilter_status_t
2769 capture_loop_init_filter(pcap_t *pcap_h, gboolean from_cap_pipe,
2770 const gchar * name, const gchar * cfilter)
2772 struct bpf_program fcode;
2774 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_init_filter: %s", cfilter);
2776 /* capture filters only work on real interfaces */
2777 if (cfilter && !from_cap_pipe) {
2778 /* A capture filter was specified; set it up. */
2779 if (!compile_capture_filter(name, pcap_h, &fcode, cfilter)) {
2780 /* Treat this specially - our caller might try to compile this
2781 as a display filter and, if that succeeds, warn the user that
2782 the display and capture filter syntaxes are different. */
2783 return INITFILTER_BAD_FILTER;
2785 if (pcap_setfilter(pcap_h, &fcode) < 0) {
2786 #ifdef HAVE_PCAP_FREECODE
2787 pcap_freecode(&fcode);
2789 return INITFILTER_OTHER_ERROR;
2791 #ifdef HAVE_PCAP_FREECODE
2792 pcap_freecode(&fcode);
2796 return INITFILTER_NO_ERROR;
2800 /* set up to write to the already-opened capture output file/files */
2802 capture_loop_init_output(capture_options *capture_opts, loop_data *ld, char *errmsg, int errmsg_len)
2806 pcap_options *pcap_opts;
2807 interface_options interface_opts;
2808 gboolean successful;
2810 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_init_output");
2812 if ((capture_opts->use_pcapng == FALSE) &&
2813 (capture_opts->ifaces->len > 1)) {
2814 g_snprintf(errmsg, errmsg_len,
2815 "Using PCAPNG is required for capturing on multiple interfaces! Use the -n option.");
2819 /* Set up to write to the capture file. */
2820 if (capture_opts->multi_files_on) {
2821 ld->pdh = ringbuf_init_libpcap_fdopen(&err);
2823 ld->pdh = libpcap_fdopen(ld->save_file_fd, &err);
2826 if (capture_opts->use_pcapng) {
2828 GString *os_info_str;
2830 os_info_str = g_string_new("");
2831 get_os_version_info(os_info_str);
2833 g_snprintf(appname, sizeof(appname), "Dumpcap " VERSION "%s", wireshark_svnversion);
2834 successful = libpcap_write_session_header_block(ld->pdh,
2837 os_info_str->str, /* OS*/
2839 -1, /* section_length */
2843 for (i = 0; successful && (i < capture_opts->ifaces->len); i++) {
2844 interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
2845 pcap_opts = g_array_index(ld->pcaps, pcap_options *, i);
2846 if (pcap_opts->from_cap_pipe) {
2847 pcap_opts->snaplen = pcap_opts->cap_pipe_hdr.snaplen;
2849 pcap_opts->snaplen = pcap_snapshot(pcap_opts->pcap_h);
2851 successful = libpcap_write_interface_description_block(global_ld.pdh,
2852 NULL, /* OPT_COMMENT 1 */
2853 interface_opts.name, /* IDB_NAME 2 */
2854 interface_opts.descr, /* IDB_DESCRIPTION 3 */
2855 interface_opts.cfilter, /* IDB_FILTER 11 */
2856 os_info_str->str, /* IDB_OS 12 */
2857 pcap_opts->linktype,
2859 &(global_ld.bytes_written),
2860 0, /* IDB_IF_SPEED 8 */
2861 pcap_opts->ts_nsec ? 9 : 6, /* IDB_TSRESOL 9 */
2865 g_string_free(os_info_str, TRUE);
2868 pcap_opts = g_array_index(ld->pcaps, pcap_options *, 0);
2869 if (pcap_opts->from_cap_pipe) {
2870 pcap_opts->snaplen = pcap_opts->cap_pipe_hdr.snaplen;
2872 pcap_opts->snaplen = pcap_snapshot(pcap_opts->pcap_h);
2874 successful = libpcap_write_file_header(ld->pdh, pcap_opts->linktype, pcap_opts->snaplen,
2875 pcap_opts->ts_nsec, &ld->bytes_written, &err);
2883 if (ld->pdh == NULL) {
2884 /* We couldn't set up to write to the capture file. */
2885 /* XXX - use cf_open_error_message from tshark instead? */
2890 g_snprintf(errmsg, errmsg_len,
2891 "The file to which the capture would be"
2892 " saved (\"%s\") could not be opened: Error %d.",
2893 capture_opts->save_file, err);
2895 g_snprintf(errmsg, errmsg_len,
2896 "The file to which the capture would be"
2897 " saved (\"%s\") could not be opened: %s.",
2898 capture_opts->save_file, g_strerror(err));
2910 capture_loop_close_output(capture_options *capture_opts, loop_data *ld, int *err_close)
2914 pcap_options *pcap_opts;
2915 guint64 end_time = create_timestamp();
2917 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_close_output");
2919 if (capture_opts->multi_files_on) {
2920 return ringbuf_libpcap_dump_close(&capture_opts->save_file, err_close);
2922 if (capture_opts->use_pcapng) {
2923 for (i = 0; i < global_ld.pcaps->len; i++) {
2924 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, i);
2925 if (!pcap_opts->from_cap_pipe) {
2926 guint64 isb_ifrecv, isb_ifdrop;
2927 struct pcap_stat stats;
2929 if (pcap_stats(pcap_opts->pcap_h, &stats) >= 0) {
2930 isb_ifrecv = pcap_opts->received;
2931 isb_ifdrop = stats.ps_drop + pcap_opts->dropped;
2933 isb_ifrecv = G_MAXUINT64;
2934 isb_ifdrop = G_MAXUINT64;
2936 libpcap_write_interface_statistics_block(ld->pdh,
2939 "Counters provided by dumpcap",
2948 return libpcap_dump_close(ld->pdh, err_close);
2952 /* dispatch incoming packets (pcap or capture pipe)
2954 * Waits for incoming packets to be available, and calls pcap_dispatch()
2955 * to cause them to be processed.
2957 * Returns the number of packets which were processed.
2959 * Times out (returning zero) after CAP_READ_TIMEOUT ms; this ensures that the
2960 * packet-batching behaviour does not cause packets to get held back
2964 capture_loop_dispatch(loop_data *ld,
2965 char *errmsg, int errmsg_len, pcap_options *pcap_opts)
2968 gint packet_count_before;
2969 guchar pcap_data[WTAP_MAX_PACKET_SIZE];
2974 packet_count_before = ld->packet_count;
2975 if (pcap_opts->from_cap_pipe) {
2976 /* dispatch from capture pipe */
2977 #ifdef LOG_CAPTURE_VERBOSE
2978 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_dispatch: from capture pipe");
2981 sel_ret = cap_pipe_select(pcap_opts->cap_pipe_fd);
2983 if (sel_ret < 0 && errno != EINTR) {
2984 g_snprintf(errmsg, errmsg_len,
2985 "Unexpected error from select: %s", g_strerror(errno));
2986 report_capture_error(errmsg, please_report);
2991 * "select()" says we can read from the pipe without blocking
2994 inpkts = cap_pipe_dispatch(ld, pcap_opts, pcap_data, errmsg, errmsg_len);
3004 /* dispatch from pcap */
3005 #ifdef MUST_DO_SELECT
3007 * If we have "pcap_get_selectable_fd()", we use it to get the
3008 * descriptor on which to select; if that's -1, it means there
3009 * is no descriptor on which you can do a "select()" (perhaps
3010 * because you're capturing on a special device, and that device's
3011 * driver unfortunately doesn't support "select()", in which case
3012 * we don't do the select - which means it might not be possible
3013 * to stop a capture until a packet arrives. If that's unacceptable,
3014 * plead with whoever supplies the software for that device to add
3015 * "select()" support, or upgrade to libpcap 0.8.1 or later, and
3016 * rebuild Wireshark or get a version built with libpcap 0.8.1 or
3017 * later, so it can use pcap_breakloop().
3019 #ifdef LOG_CAPTURE_VERBOSE
3020 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_dispatch: from pcap_dispatch with select");
3022 if (pcap_opts->pcap_fd != -1) {
3023 sel_ret = cap_pipe_select(pcap_opts->pcap_fd);
3026 * "select()" says we can read from it without blocking; go for
3029 * We don't have pcap_breakloop(), so we only process one packet
3030 * per pcap_dispatch() call, to allow a signal to stop the
3031 * processing immediately, rather than processing all packets
3032 * in a batch before quitting.
3035 inpkts = pcap_dispatch(pcap_opts->pcap_h, 1, capture_loop_queue_packet_cb, (u_char *)pcap_opts);
3037 inpkts = pcap_dispatch(pcap_opts->pcap_h, 1, capture_loop_write_packet_cb, (u_char *)pcap_opts);
3041 /* Error, rather than pcap_breakloop(). */
3042 pcap_opts->pcap_err = TRUE;
3044 ld->go = FALSE; /* error or pcap_breakloop() - stop capturing */
3047 if (sel_ret < 0 && errno != EINTR) {
3048 g_snprintf(errmsg, errmsg_len,
3049 "Unexpected error from select: %s", g_strerror(errno));
3050 report_capture_error(errmsg, please_report);
3056 #endif /* MUST_DO_SELECT */
3058 /* dispatch from pcap without select */
3060 #ifdef LOG_CAPTURE_VERBOSE
3061 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_dispatch: from pcap_dispatch");
3065 * On Windows, we don't support asynchronously telling a process to
3066 * stop capturing; instead, we check for an indication on a pipe
3067 * after processing packets. We therefore process only one packet
3068 * at a time, so that we can check the pipe after every packet.
3071 inpkts = pcap_dispatch(pcap_opts->pcap_h, 1, capture_loop_queue_packet_cb, (u_char *)pcap_opts);
3073 inpkts = pcap_dispatch(pcap_opts->pcap_h, 1, capture_loop_write_packet_cb, (u_char *)pcap_opts);
3077 inpkts = pcap_dispatch(pcap_opts->pcap_h, -1, capture_loop_queue_packet_cb, (u_char *)pcap_opts);
3079 inpkts = pcap_dispatch(pcap_opts->pcap_h, -1, capture_loop_write_packet_cb, (u_char *)pcap_opts);
3084 /* Error, rather than pcap_breakloop(). */
3085 pcap_opts->pcap_err = TRUE;
3087 ld->go = FALSE; /* error or pcap_breakloop() - stop capturing */
3089 #else /* pcap_next_ex */
3090 #ifdef LOG_CAPTURE_VERBOSE
3091 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_dispatch: from pcap_next_ex");
3093 /* XXX - this is currently unused, as there is some confusion with pcap_next_ex() vs. pcap_dispatch() */
3096 * WinPcap's remote capturing feature doesn't work with pcap_dispatch(),
3097 * see http://wiki.wireshark.org/CaptureSetup_2fWinPcapRemote
3098 * This should be fixed in the WinPcap 4.0 alpha release.
3100 * For reference, an example remote interface:
3101 * rpcap://[1.2.3.4]/\Device\NPF_{39993D68-7C9B-4439-A329-F2D888DA7C5C}
3104 /* emulate dispatch from pcap */
3107 struct pcap_pkthdr *pkt_header;
3112 (in = pcap_next_ex(pcap_opts->pcap_h, &pkt_header, &pkt_data)) == 1) {
3114 capture_loop_queue_packet_cb((u_char *)pcap_opts, pkt_header, pkt_data);
3116 capture_loop_write_packet_cb((u_char *)pcap_opts, pkt_header, pkt_data);
3121 pcap_opts->pcap_err = TRUE;
3125 #endif /* pcap_next_ex */
3129 #ifdef LOG_CAPTURE_VERBOSE
3130 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_dispatch: %d new packet%s", inpkts, plurality(inpkts, "", "s"));
3133 return ld->packet_count - packet_count_before;
3137 /* Isolate the Universally Unique Identifier from the interface. Basically, we
3138 * want to grab only the characters between the '{' and '}' delimiters.
3140 * Returns a GString that must be freed with g_string_free(). */
3142 isolate_uuid(const char *iface)
3147 ptr = strchr(iface, '{');
3149 return g_string_new(iface);
3150 gstr = g_string_new(ptr + 1);
3152 ptr = strchr(gstr->str, '}');
3156 gstr = g_string_truncate(gstr, ptr - gstr->str);
3161 /* open the output file (temporary/specified name/ringbuffer/named pipe/stdout) */
3162 /* Returns TRUE if the file opened successfully, FALSE otherwise. */
3164 capture_loop_open_output(capture_options *capture_opts, int *save_file_fd,
3165 char *errmsg, int errmsg_len)
3168 gchar *capfile_name;
3170 gboolean is_tempfile;
3172 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "capture_loop_open_output: %s",
3173 (capture_opts->save_file) ? capture_opts->save_file : "(not specified)");
3175 if (capture_opts->save_file != NULL) {
3176 /* We return to the caller while the capture is in progress.
3177 * Therefore we need to take a copy of save_file in
3178 * case the caller destroys it after we return.
3180 capfile_name = g_strdup(capture_opts->save_file);
3182 if (capture_opts->output_to_pipe == TRUE) { /* either "-" or named pipe */
3183 if (capture_opts->multi_files_on) {
3184 /* ringbuffer is enabled; that doesn't work with standard output or a named pipe */
3185 g_snprintf(errmsg, errmsg_len,
3186 "Ring buffer requested, but capture is being written to standard output or to a named pipe.");
3187 g_free(capfile_name);
3190 if (strcmp(capfile_name, "-") == 0) {
3191 /* write to stdout */
3194 /* set output pipe to binary mode to avoid Windows text-mode processing (eg: for CR/LF) */
3195 _setmode(1, O_BINARY);
3198 } /* if (...output_to_pipe ... */
3201 if (capture_opts->multi_files_on) {
3202 /* ringbuffer is enabled */
3203 *save_file_fd = ringbuf_init(capfile_name,
3204 (capture_opts->has_ring_num_files) ? capture_opts->ring_num_files : 0,
3205 capture_opts->group_read_access);
3207 /* we need the ringbuf name */
3208 if (*save_file_fd != -1) {
3209 g_free(capfile_name);
3210 capfile_name = g_strdup(ringbuf_current_filename());
3213 /* Try to open/create the specified file for use as a capture buffer. */
3214 *save_file_fd = ws_open(capfile_name, O_RDWR|O_BINARY|O_TRUNC|O_CREAT,
3215 (capture_opts->group_read_access) ? 0640 : 0600);
3218 is_tempfile = FALSE;
3220 /* Choose a random name for the temporary capture buffer */
3221 if (global_capture_opts.ifaces->len > 1) {
3222 prefix = g_strdup_printf("wireshark_%d_interfaces", global_capture_opts.ifaces->len);
3225 basename = g_path_get_basename(g_array_index(global_capture_opts.ifaces, interface_options, 0).console_display_name);
3227 /* use the generic portion of the interface guid to form the basis of the filename */
3228 if (strncmp("NPF_{", basename, 5)==0)
3230 /* we have a windows guid style device name, extract the guid digits as the basis of the filename */
3232 iface = isolate_uuid(basename);
3234 basename = g_strdup(iface->str);
3235 g_string_free(iface, TRUE);
3238 /* generate the temp file name prefix...
3239 * It would be nice if we could specify a pcapng/pcap filename suffix,
3240 * create_tempfile() however currently uses mkstemp() which doesn't allow this - one day perhaps*/
3241 if (capture_opts->use_pcapng) {
3242 prefix = g_strconcat("wireshark_pcapng_", basename, NULL);
3244 prefix = g_strconcat("wireshark_pcap_", basename, NULL);
3248 *save_file_fd = create_tempfile(&tmpname, prefix);
3250 capfile_name = g_strdup(tmpname);
3254 /* did we fail to open the output file? */
3255 if (*save_file_fd == -1) {
3257 g_snprintf(errmsg, errmsg_len,
3258 "The temporary file to which the capture would be saved (\"%s\") "
3259 "could not be opened: %s.", capfile_name, g_strerror(errno));
3261 if (capture_opts->multi_files_on) {
3262 ringbuf_error_cleanup();
3265 g_snprintf(errmsg, errmsg_len,
3266 "The file to which the capture would be saved (\"%s\") "
3267 "could not be opened: %s.", capfile_name,
3270 g_free(capfile_name);
3274 if (capture_opts->save_file != NULL) {
3275 g_free(capture_opts->save_file);
3277 capture_opts->save_file = capfile_name;
3278 /* capture_opts.save_file is "g_free"ed later, which is equivalent to
3279 "g_free(capfile_name)". */
3285 /* Do the work of handling either the file size or file duration capture
3286 conditions being reached, and switching files or stopping. */
3288 do_file_switch_or_stop(capture_options *capture_opts,
3289 condition *cnd_autostop_files,
3290 condition *cnd_autostop_size,
3291 condition *cnd_file_duration)
3294 pcap_options *pcap_opts;
3295 interface_options interface_opts;
3296 gboolean successful;
3298 if (capture_opts->multi_files_on) {
3299 if (cnd_autostop_files != NULL &&
3300 cnd_eval(cnd_autostop_files, ++global_ld.autostop_files)) {
3301 /* no files left: stop here */
3302 global_ld.go = FALSE;
3306 /* Switch to the next ringbuffer file */
3307 if (ringbuf_switch_file(&global_ld.pdh, &capture_opts->save_file,
3308 &global_ld.save_file_fd, &global_ld.err)) {
3310 /* File switch succeeded: reset the conditions */
3311 global_ld.bytes_written = 0;
3312 if (capture_opts->use_pcapng) {
3314 GString *os_info_str;
3316 os_info_str = g_string_new("");
3317 get_os_version_info(os_info_str);
3319 g_snprintf(appname, sizeof(appname), "Dumpcap " VERSION "%s", wireshark_svnversion);
3320 successful = libpcap_write_session_header_block(global_ld.pdh,
3323 os_info_str->str, /* OS */
3325 -1, /* section_length */
3326 &(global_ld.bytes_written),
3329 for (i = 0; successful && (i < capture_opts->ifaces->len); i++) {
3330 interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
3331 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, i);
3332 successful = libpcap_write_interface_description_block(global_ld.pdh,
3333 NULL, /* OPT_COMMENT 1 */
3334 interface_opts.name, /* IDB_NAME 2 */
3335 interface_opts.descr, /* IDB_DESCRIPTION 3 */
3336 interface_opts.cfilter, /* IDB_FILTER 11 */
3337 os_info_str->str, /* IDB_OS 12 */
3338 pcap_opts->linktype,
3340 &(global_ld.bytes_written),
3341 0, /* IDB_IF_SPEED 8 */
3342 pcap_opts->ts_nsec ? 9 : 6, /* IDB_TSRESOL 9 */
3346 g_string_free(os_info_str, TRUE);
3349 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, 0);
3350 successful = libpcap_write_file_header(global_ld.pdh, pcap_opts->linktype, pcap_opts->snaplen,
3351 pcap_opts->ts_nsec, &global_ld.bytes_written, &global_ld.err);
3354 fclose(global_ld.pdh);
3355 global_ld.pdh = NULL;
3356 global_ld.go = FALSE;
3359 if (cnd_autostop_size)
3360 cnd_reset(cnd_autostop_size);
3361 if (cnd_file_duration)
3362 cnd_reset(cnd_file_duration);
3363 libpcap_dump_flush(global_ld.pdh, NULL);
3365 report_packet_count(global_ld.inpkts_to_sync_pipe);
3366 global_ld.inpkts_to_sync_pipe = 0;
3367 report_new_capture_file(capture_opts->save_file);
3369 /* File switch failed: stop here */
3370 global_ld.go = FALSE;
3374 /* single file, stop now */
3375 global_ld.go = FALSE;
3382 pcap_read_handler(void* arg)
3384 pcap_options *pcap_opts;
3385 char errmsg[MSG_MAX_LENGTH+1];
3387 pcap_opts = (pcap_options *)arg;
3389 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Started thread for interface %d.",
3390 pcap_opts->interface_id);
3392 while (global_ld.go) {
3393 /* dispatch incoming packets */
3394 capture_loop_dispatch(&global_ld, errmsg, sizeof(errmsg), pcap_opts);
3396 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Stopped thread for interface %d.",
3397 pcap_opts->interface_id);
3398 g_thread_exit(NULL);
3402 /* Do the low-level work of a capture.
3403 Returns TRUE if it succeeds, FALSE otherwise. */
3405 capture_loop_start(capture_options *capture_opts, gboolean *stats_known, struct pcap_stat *stats)
3408 DWORD upd_time, cur_time; /* GetTickCount() returns a "DWORD" (which is 'unsigned long') */
3410 struct timeval upd_time, cur_time;
3414 condition *cnd_file_duration = NULL;
3415 condition *cnd_autostop_files = NULL;
3416 condition *cnd_autostop_size = NULL;
3417 condition *cnd_autostop_duration = NULL;
3420 gboolean cfilter_error = FALSE;
3421 char errmsg[MSG_MAX_LENGTH+1];
3422 char secondary_errmsg[MSG_MAX_LENGTH+1];
3423 pcap_options *pcap_opts;
3424 interface_options interface_opts;
3425 guint i, error_index = 0;
3428 *secondary_errmsg = '\0';
3430 /* init the loop data */
3431 global_ld.go = TRUE;
3432 global_ld.packet_count = 0;
3434 global_ld.report_packet_count = FALSE;
3436 if (capture_opts->has_autostop_packets)
3437 global_ld.packet_max = capture_opts->autostop_packets;
3439 global_ld.packet_max = 0; /* no limit */
3440 global_ld.inpkts_to_sync_pipe = 0;
3441 global_ld.err = 0; /* no error seen yet */
3442 global_ld.pdh = NULL;
3443 global_ld.autostop_files = 0;
3444 global_ld.save_file_fd = -1;
3446 /* We haven't yet gotten the capture statistics. */
3447 *stats_known = FALSE;
3449 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Capture loop starting ...");
3450 capture_opts_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, capture_opts);
3452 /* open the "input file" from network interface or capture pipe */
3453 if (!capture_loop_open_input(capture_opts, &global_ld, errmsg, sizeof(errmsg),
3454 secondary_errmsg, sizeof(secondary_errmsg))) {
3457 for (i = 0; i < capture_opts->ifaces->len; i++) {
3458 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, i);
3459 interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
3460 /* init the input filter from the network interface (capture pipe will do nothing) */
3462 * When remote capturing WinPCap crashes when the capture filter
3463 * is NULL. This might be a bug in WPCap. Therefore we provide an empty
3466 switch (capture_loop_init_filter(pcap_opts->pcap_h, pcap_opts->from_cap_pipe,
3467 interface_opts.name,
3468 interface_opts.cfilter?interface_opts.cfilter:"")) {
3470 case INITFILTER_NO_ERROR:
3473 case INITFILTER_BAD_FILTER:
3474 cfilter_error = TRUE;
3476 g_snprintf(errmsg, sizeof(errmsg), "%s", pcap_geterr(pcap_opts->pcap_h));
3479 case INITFILTER_OTHER_ERROR:
3480 g_snprintf(errmsg, sizeof(errmsg), "Can't install filter (%s).",
3481 pcap_geterr(pcap_opts->pcap_h));
3482 g_snprintf(secondary_errmsg, sizeof(secondary_errmsg), "%s", please_report);
3487 /* If we're supposed to write to a capture file, open it for output
3488 (temporary/specified name/ringbuffer) */
3489 if (capture_opts->saving_to_file) {
3490 if (!capture_loop_open_output(capture_opts, &global_ld.save_file_fd,
3491 errmsg, sizeof(errmsg))) {
3495 /* set up to write to the already-opened capture output file/files */
3496 if (!capture_loop_init_output(capture_opts, &global_ld, errmsg,
3501 /* XXX - capture SIGTERM and close the capture, in case we're on a
3502 Linux 2.0[.x] system and you have to explicitly close the capture
3503 stream in order to turn promiscuous mode off? We need to do that
3504 in other places as well - and I don't think that works all the
3505 time in any case, due to libpcap bugs. */
3507 /* Well, we should be able to start capturing.
3509 Sync out the capture file, so the header makes it to the file system,
3510 and send a "capture started successfully and capture file created"
3511 message to our parent so that they'll open the capture file and
3512 update its windows to indicate that we have a live capture in
3514 libpcap_dump_flush(global_ld.pdh, NULL);
3515 report_new_capture_file(capture_opts->save_file);
3518 /* initialize capture stop (and alike) conditions */
3519 init_capture_stop_conditions();
3520 /* create stop conditions */
3521 if (capture_opts->has_autostop_filesize)
3523 cnd_new(CND_CLASS_CAPTURESIZE,(long)capture_opts->autostop_filesize * 1024);
3524 if (capture_opts->has_autostop_duration)
3525 cnd_autostop_duration =
3526 cnd_new(CND_CLASS_TIMEOUT,(gint32)capture_opts->autostop_duration);
3528 if (capture_opts->multi_files_on) {
3529 if (capture_opts->has_file_duration)
3531 cnd_new(CND_CLASS_TIMEOUT, capture_opts->file_duration);
3533 if (capture_opts->has_autostop_files)
3534 cnd_autostop_files =
3535 cnd_new(CND_CLASS_CAPTURESIZE, capture_opts->autostop_files);
3538 /* init the time values */
3540 upd_time = GetTickCount();
3542 gettimeofday(&upd_time, NULL);
3544 start_time = create_timestamp();
3545 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Capture loop running!");
3547 /* WOW, everything is prepared! */
3548 /* please fasten your seat belts, we will enter now the actual capture loop */
3550 pcap_queue = g_async_queue_new();
3551 pcap_queue_bytes = 0;
3552 pcap_queue_packets = 0;
3553 for (i = 0; i < global_ld.pcaps->len; i++) {
3554 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, i);
3555 #if GLIB_CHECK_VERSION(2,31,0)
3556 /* XXX - Add an interface name here? */
3557 pcap_opts->tid = g_thread_new("Capture read", pcap_read_handler, pcap_opts);
3559 pcap_opts->tid = g_thread_create(pcap_read_handler, pcap_opts, TRUE, NULL);
3563 while (global_ld.go) {
3564 /* dispatch incoming packets */
3566 pcap_queue_element *queue_element;
3567 #if GLIB_CHECK_VERSION(2,31,18)
3569 g_async_queue_lock(pcap_queue);
3570 queue_element = g_async_queue_timeout_pop_unlocked(pcap_queue, WRITER_THREAD_TIMEOUT);
3572 GTimeVal write_thread_time;
3574 g_get_current_time(&write_thread_time);
3575 g_time_val_add(&write_thread_time, WRITER_THREAD_TIMEOUT);
3576 g_async_queue_lock(pcap_queue);
3577 queue_element = g_async_queue_timed_pop_unlocked(pcap_queue, &write_thread_time);
3579 if (queue_element) {
3580 pcap_queue_bytes -= queue_element->phdr.caplen;
3581 pcap_queue_packets -= 1;
3583 g_async_queue_unlock(pcap_queue);
3584 if (queue_element) {
3585 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
3586 "Dequeued a packet of length %d captured on interface %d.",
3587 queue_element->phdr.caplen, queue_element->pcap_opts->interface_id);
3589 capture_loop_write_packet_cb((u_char *) queue_element->pcap_opts,
3590 &queue_element->phdr,
3592 g_free(queue_element->pd);
3593 g_free(queue_element);
3599 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, 0);
3600 inpkts = capture_loop_dispatch(&global_ld, errmsg,
3601 sizeof(errmsg), pcap_opts);
3604 /* Were we asked to print packet counts by the SIGINFO handler? */
3605 if (global_ld.report_packet_count) {
3606 fprintf(stderr, "%u packet%s captured\n", global_ld.packet_count,
3607 plurality(global_ld.packet_count, "", "s"));
3608 global_ld.report_packet_count = FALSE;
3613 /* any news from our parent (signal pipe)? -> just stop the capture */
3614 if (!signal_pipe_check_running()) {
3615 global_ld.go = FALSE;
3620 global_ld.inpkts_to_sync_pipe += inpkts;
3622 /* check capture size condition */
3623 if (cnd_autostop_size != NULL &&
3624 cnd_eval(cnd_autostop_size, (guint32)global_ld.bytes_written)) {
3625 /* Capture size limit reached, do we have another file? */
3626 if (!do_file_switch_or_stop(capture_opts, cnd_autostop_files,
3627 cnd_autostop_size, cnd_file_duration))
3629 } /* cnd_autostop_size */
3630 if (capture_opts->output_to_pipe) {
3631 libpcap_dump_flush(global_ld.pdh, NULL);
3635 /* Only update once every 500ms so as not to overload slow displays.
3636 * This also prevents too much context-switching between the dumpcap
3637 * and wireshark processes.
3639 #define DUMPCAP_UPD_TIME 500
3642 cur_time = GetTickCount(); /* Note: wraps to 0 if sys runs for 49.7 days */
3643 if ((cur_time - upd_time) > DUMPCAP_UPD_TIME) { /* wrap just causes an extra update */
3645 gettimeofday(&cur_time, NULL);
3646 if ((cur_time.tv_sec * 1000000 + cur_time.tv_usec) >
3647 (upd_time.tv_sec * 1000000 + upd_time.tv_usec + DUMPCAP_UPD_TIME*1000)) {
3650 upd_time = cur_time;
3653 if (pcap_stats(pch, stats) >= 0) {
3654 *stats_known = TRUE;
3657 /* Let the parent process know. */
3658 if (global_ld.inpkts_to_sync_pipe) {
3660 libpcap_dump_flush(global_ld.pdh, NULL);
3662 /* Send our parent a message saying we've written out
3663 "global_ld.inpkts_to_sync_pipe" packets to the capture file. */
3665 report_packet_count(global_ld.inpkts_to_sync_pipe);
3667 global_ld.inpkts_to_sync_pipe = 0;
3670 /* check capture duration condition */
3671 if (cnd_autostop_duration != NULL && cnd_eval(cnd_autostop_duration)) {
3672 /* The maximum capture time has elapsed; stop the capture. */
3673 global_ld.go = FALSE;
3677 /* check capture file duration condition */
3678 if (cnd_file_duration != NULL && cnd_eval(cnd_file_duration)) {
3679 /* duration limit reached, do we have another file? */
3680 if (!do_file_switch_or_stop(capture_opts, cnd_autostop_files,
3681 cnd_autostop_size, cnd_file_duration))
3683 } /* cnd_file_duration */
3687 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Capture loop stopping ...");
3689 pcap_queue_element *queue_element;
3691 for (i = 0; i < global_ld.pcaps->len; i++) {
3692 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, i);
3693 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Waiting for thread of interface %u...",
3694 pcap_opts->interface_id);
3695 g_thread_join(pcap_opts->tid);
3696 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Thread of interface %u terminated.",
3697 pcap_opts->interface_id);
3700 g_async_queue_lock(pcap_queue);
3701 queue_element = g_async_queue_try_pop_unlocked(pcap_queue);
3702 if (queue_element) {
3703 pcap_queue_bytes -= queue_element->phdr.caplen;
3704 pcap_queue_packets -= 1;
3706 g_async_queue_unlock(pcap_queue);
3707 if (queue_element == NULL) {
3710 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
3711 "Dequeued a packet of length %d captured on interface %d.",
3712 queue_element->phdr.caplen, queue_element->pcap_opts->interface_id);
3713 capture_loop_write_packet_cb((u_char *)queue_element->pcap_opts,
3714 &queue_element->phdr,
3716 g_free(queue_element->pd);
3717 g_free(queue_element);
3718 global_ld.inpkts_to_sync_pipe += 1;
3719 if (capture_opts->output_to_pipe) {
3720 libpcap_dump_flush(global_ld.pdh, NULL);
3726 /* delete stop conditions */
3727 if (cnd_file_duration != NULL)
3728 cnd_delete(cnd_file_duration);
3729 if (cnd_autostop_files != NULL)
3730 cnd_delete(cnd_autostop_files);
3731 if (cnd_autostop_size != NULL)
3732 cnd_delete(cnd_autostop_size);
3733 if (cnd_autostop_duration != NULL)
3734 cnd_delete(cnd_autostop_duration);
3736 /* did we have a pcap (input) error? */
3737 for (i = 0; i < capture_opts->ifaces->len; i++) {
3738 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, i);
3739 if (pcap_opts->pcap_err) {
3740 /* On Linux, if an interface goes down while you're capturing on it,
3741 you'll get a "recvfrom: Network is down" or
3742 "The interface went down" error (ENETDOWN).
3743 (At least you will if g_strerror() doesn't show a local translation
3746 On FreeBSD and OS X, if a network adapter disappears while
3747 you're capturing on it, you'll get a "read: Device not configured"
3748 error (ENXIO). (See previous parenthetical note.)
3750 On OpenBSD, you get "read: I/O error" (EIO) in the same case.
3752 These should *not* be reported to the Wireshark developers. */
3755 cap_err_str = pcap_geterr(pcap_opts->pcap_h);
3756 if (strcmp(cap_err_str, "recvfrom: Network is down") == 0 ||
3757 strcmp(cap_err_str, "The interface went down") == 0 ||
3758 strcmp(cap_err_str, "read: Device not configured") == 0 ||
3759 strcmp(cap_err_str, "read: I/O error") == 0 ||
3760 strcmp(cap_err_str, "read error: PacketReceivePacket failed") == 0) {
3761 report_capture_error("The network adapter on which the capture was being done "
3762 "is no longer running; the capture has stopped.",
3765 g_snprintf(errmsg, sizeof(errmsg), "Error while capturing packets: %s",
3767 report_capture_error(errmsg, please_report);
3770 } else if (pcap_opts->from_cap_pipe && pcap_opts->cap_pipe_err == PIPERR) {
3771 report_capture_error(errmsg, "");
3775 /* did we have an output error while capturing? */
3776 if (global_ld.err == 0) {
3779 capture_loop_get_errmsg(errmsg, sizeof(errmsg), capture_opts->save_file,
3780 global_ld.err, FALSE);
3781 report_capture_error(errmsg, please_report);
3785 if (capture_opts->saving_to_file) {
3786 /* close the output file */
3787 close_ok = capture_loop_close_output(capture_opts, &global_ld, &err_close);
3791 /* there might be packets not yet notified to the parent */
3792 /* (do this after closing the file, so all packets are already flushed) */
3793 if (global_ld.inpkts_to_sync_pipe) {
3795 report_packet_count(global_ld.inpkts_to_sync_pipe);
3796 global_ld.inpkts_to_sync_pipe = 0;
3799 /* If we've displayed a message about a write error, there's no point
3800 in displaying another message about an error on close. */
3801 if (!close_ok && write_ok) {
3802 capture_loop_get_errmsg(errmsg, sizeof(errmsg), capture_opts->save_file, err_close,
3804 report_capture_error(errmsg, "");
3808 * XXX We exhibit different behaviour between normal mode and sync mode
3809 * when the pipe is stdin and not already at EOF. If we're a child, the
3810 * parent's stdin isn't closed, so if the user starts another capture,
3811 * cap_pipe_open_live() will very likely not see the expected magic bytes and
3812 * will say "Unrecognized libpcap format". On the other hand, in normal
3813 * mode, cap_pipe_open_live() will say "End of file on pipe during open".
3816 report_capture_count(TRUE);
3818 /* get packet drop statistics from pcap */
3819 for (i = 0; i < capture_opts->ifaces->len; i++) {
3823 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, i);
3824 interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
3825 received = pcap_opts->received;
3826 dropped = pcap_opts->dropped;
3827 if (pcap_opts->pcap_h != NULL) {
3828 g_assert(!pcap_opts->from_cap_pipe);
3829 /* Get the capture statistics, so we know how many packets were dropped. */
3830 if (pcap_stats(pcap_opts->pcap_h, stats) >= 0) {
3831 *stats_known = TRUE;
3832 /* Let the parent process know. */
3833 dropped += stats->ps_drop;
3835 g_snprintf(errmsg, sizeof(errmsg),
3836 "Can't get packet-drop statistics: %s",
3837 pcap_geterr(pcap_opts->pcap_h));
3838 report_capture_error(errmsg, please_report);
3841 report_packet_drops(received, dropped, interface_opts.console_display_name);
3844 /* close the input file (pcap or capture pipe) */
3845 capture_loop_close_input(&global_ld);
3847 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Capture loop stopped!");
3849 /* ok, if the write and the close were successful. */
3850 return write_ok && close_ok;
3853 if (capture_opts->multi_files_on) {
3854 /* cleanup ringbuffer */
3855 ringbuf_error_cleanup();
3857 /* We can't use the save file, and we have no FILE * for the stream
3858 to close in order to close it, so close the FD directly. */
3859 if (global_ld.save_file_fd != -1) {
3860 ws_close(global_ld.save_file_fd);
3863 /* We couldn't even start the capture, so get rid of the capture
3865 if (capture_opts->save_file != NULL) {
3866 ws_unlink(capture_opts->save_file);
3867 g_free(capture_opts->save_file);
3870 capture_opts->save_file = NULL;
3872 report_cfilter_error(capture_opts, error_index, errmsg);
3874 report_capture_error(errmsg, secondary_errmsg);
3876 /* close the input file (pcap or cap_pipe) */
3877 capture_loop_close_input(&global_ld);
3879 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO, "Capture loop stopped with error");
3886 capture_loop_stop(void)
3888 #ifdef HAVE_PCAP_BREAKLOOP
3890 pcap_options *pcap_opts;
3892 for (i = 0; i < global_ld.pcaps->len; i++) {
3893 pcap_opts = g_array_index(global_ld.pcaps, pcap_options *, i);
3894 if (pcap_opts->pcap_h != NULL)
3895 pcap_breakloop(pcap_opts->pcap_h);
3898 global_ld.go = FALSE;
3903 capture_loop_get_errmsg(char *errmsg, int errmsglen, const char *fname,
3904 int err, gboolean is_close)
3909 g_snprintf(errmsg, errmsglen,
3910 "Not all the packets could be written to the file"
3911 " to which the capture was being saved\n"
3912 "(\"%s\") because there is no space left on the file system\n"
3913 "on which that file resides.",
3919 g_snprintf(errmsg, errmsglen,
3920 "Not all the packets could be written to the file"
3921 " to which the capture was being saved\n"
3922 "(\"%s\") because you are too close to, or over,"
3923 " your disk quota\n"
3924 "on the file system on which that file resides.",
3931 g_snprintf(errmsg, errmsglen,
3932 "The file to which the capture was being saved\n"
3933 "(\"%s\") could not be closed: %s.",
3934 fname, g_strerror(err));
3936 g_snprintf(errmsg, errmsglen,
3937 "An error occurred while writing to the file"
3938 " to which the capture was being saved\n"
3940 fname, g_strerror(err));
3947 /* one packet was captured, process it */
3949 capture_loop_write_packet_cb(u_char *pcap_opts_p, const struct pcap_pkthdr *phdr,
3952 pcap_options *pcap_opts = (pcap_options *) (void *) pcap_opts_p;
3954 guint ts_mul = pcap_opts->ts_nsec ? 1000000000 : 1000000;
3956 /* We may be called multiple times from pcap_dispatch(); if we've set
3957 the "stop capturing" flag, ignore this packet, as we're not
3958 supposed to be saving any more packets. */
3959 if (!global_ld.go) {
3960 pcap_opts->dropped++;
3964 if (global_ld.pdh) {
3965 gboolean successful;
3967 /* We're supposed to write the packet to a file; do so.
3968 If this fails, set "ld->go" to FALSE, to stop the capture, and set
3969 "ld->err" to the error. */
3970 if (global_capture_opts.use_pcapng) {
3971 successful = libpcap_write_enhanced_packet_block(global_ld.pdh, phdr, pcap_opts->interface_id, ts_mul, pd, &global_ld.bytes_written, &err);
3973 successful = libpcap_write_packet(global_ld.pdh, phdr, pd, &global_ld.bytes_written, &err);
3976 global_ld.go = FALSE;
3977 global_ld.err = err;
3978 pcap_opts->dropped++;
3980 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
3981 "Wrote a packet of length %d captured on interface %u.",
3982 phdr->caplen, pcap_opts->interface_id);
3983 global_ld.packet_count++;
3984 pcap_opts->received++;
3985 /* if the user told us to stop after x packets, do we already have enough? */
3986 if ((global_ld.packet_max > 0) && (global_ld.packet_count >= global_ld.packet_max)) {
3987 global_ld.go = FALSE;
3993 /* one packet was captured, queue it */
3995 capture_loop_queue_packet_cb(u_char *pcap_opts_p, const struct pcap_pkthdr *phdr,
3998 pcap_options *pcap_opts = (pcap_options *) (void *) pcap_opts_p;
3999 pcap_queue_element *queue_element;
4000 gboolean limit_reached;
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->dropped++;
4010 queue_element = (pcap_queue_element *)g_malloc(sizeof(pcap_queue_element));
4011 if (queue_element == NULL) {
4012 pcap_opts->dropped++;
4015 queue_element->pcap_opts = pcap_opts;
4016 queue_element->phdr = *phdr;
4017 queue_element->pd = (u_char *)g_malloc(phdr->caplen);
4018 if (queue_element->pd == NULL) {
4019 pcap_opts->dropped++;
4020 g_free(queue_element);
4023 memcpy(queue_element->pd, pd, phdr->caplen);
4024 g_async_queue_lock(pcap_queue);
4025 if (((pcap_queue_byte_limit > 0) && (pcap_queue_bytes < pcap_queue_byte_limit)) &&
4026 ((pcap_queue_packet_limit > 0) && (pcap_queue_packets < pcap_queue_packet_limit))) {
4027 limit_reached = FALSE;
4028 g_async_queue_push_unlocked(pcap_queue, queue_element);
4029 pcap_queue_bytes += phdr->caplen;
4030 pcap_queue_packets += 1;
4032 limit_reached = TRUE;
4034 g_async_queue_unlock(pcap_queue);
4035 if (limit_reached) {
4036 pcap_opts->dropped++;
4037 g_free(queue_element->pd);
4038 g_free(queue_element);
4039 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
4040 "Dropped a packet of length %d captured on interface %u.",
4041 phdr->caplen, pcap_opts->interface_id);
4043 pcap_opts->received++;
4044 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
4045 "Queued a packet of length %d captured on interface %u.",
4046 phdr->caplen, pcap_opts->interface_id);
4048 /* I don't want to hold the mutex over the debug output. So the
4049 output may be wrong */
4050 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
4051 "Queue size is now %" G_GINT64_MODIFIER "d bytes (%" G_GINT64_MODIFIER "d packets)",
4052 pcap_queue_bytes, pcap_queue_packets);
4056 set_80211_channel(const char *iface, const char *opt)
4058 int freq = 0, type, ret;
4059 gchar **options = NULL;
4061 options = g_strsplit_set(opt, ",", 2);
4064 freq = atoi(options[0]);
4067 type = ws80211_str_to_chan_type(options[1]);
4076 ret = ws80211_init();
4078 cmdarg_err("%d: Failed to init ws80211: %s\n", abs(ret), g_strerror(abs(ret)));
4082 ret = ws80211_set_freq(iface, freq, type);
4085 cmdarg_err("%d: Failed to set channel: %s\n", abs(ret), g_strerror(abs(ret)));
4091 pipe_write_block(2, SP_SUCCESS, NULL);
4095 g_strfreev(options);
4099 /* And now our feature presentation... [ fade to music ] */
4101 main(int argc, char *argv[])
4104 gboolean arg_error = FALSE;
4109 struct sigaction action, oldaction;
4112 gboolean start_capture = TRUE;
4113 gboolean stats_known;
4114 struct pcap_stat stats;
4115 GLogLevelFlags log_flags;
4116 gboolean list_interfaces = FALSE;
4117 gboolean list_link_layer_types = FALSE;
4118 #ifdef HAVE_BPF_IMAGE
4119 gboolean print_bpf_code = FALSE;
4121 gboolean set_chan = FALSE;
4122 gchar *set_chan_arg = NULL;
4123 gboolean machine_readable = FALSE;
4124 gboolean print_statistics = FALSE;
4125 int status, run_once_args = 0;
4128 #if defined(__APPLE__) && defined(__LP64__)
4129 struct utsname osinfo;
4134 arg_list_utf_16to8(argc, argv);
4139 * Initialize our DLL search path. MUST be called before LoadLibrary
4142 ws_init_dll_search_path();
4145 #ifdef HAVE_PCAP_REMOTE
4146 #define OPTSTRING_A "A:"
4147 #define OPTSTRING_r "r"
4148 #define OPTSTRING_u "u"
4150 #define OPTSTRING_A ""
4151 #define OPTSTRING_r ""
4152 #define OPTSTRING_u ""
4155 #ifdef HAVE_PCAP_SETSAMPLING
4156 #define OPTSTRING_m "m:"
4158 #define OPTSTRING_m ""
4161 #if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
4162 #define OPTSTRING_B "B:"
4164 #define OPTSTRING_B ""
4165 #endif /* _WIN32 or HAVE_PCAP_CREATE */
4167 #ifdef HAVE_PCAP_CREATE
4168 #define OPTSTRING_I "I"
4170 #define OPTSTRING_I ""
4173 #ifdef HAVE_BPF_IMAGE
4174 #define OPTSTRING_d "d"
4176 #define OPTSTRING_d ""
4179 #define OPTSTRING "a:" OPTSTRING_A "b:" OPTSTRING_B "c:" OPTSTRING_d "Df:ghi:" OPTSTRING_I "k:L" OPTSTRING_m "MnpPq" OPTSTRING_r "Ss:t" OPTSTRING_u "vw:y:Z:"
4181 #ifdef DEBUG_CHILD_DUMPCAP
4182 if ((debug_log = ws_fopen("dumpcap_debug_log.tmp","w")) == NULL) {
4183 fprintf (stderr, "Unable to open debug log file !\n");
4188 #if defined(__APPLE__) && defined(__LP64__)
4190 * Is this Mac OS X 10.6.0, 10.6.1, 10.6.3, or 10.6.4? If so, we need
4191 * a bug workaround - timeouts less than 1 second don't work with libpcap
4192 * in 64-bit code. (The bug was introduced in 10.6, fixed in 10.6.2,
4193 * re-introduced in 10.6.3, not fixed in 10.6.4, and fixed in 10.6.5.
4194 * The problem is extremely unlikely to be reintroduced in a future
4197 if (uname(&osinfo) == 0) {
4199 * Mac OS X 10.x uses Darwin {x+4}.0.0. Mac OS X 10.x.y uses Darwin
4200 * {x+4}.y.0 (except that 10.6.1 appears to have a uname version
4201 * number of 10.0.0, not 10.1.0 - go figure).
4203 if (strcmp(osinfo.release, "10.0.0") == 0 || /* 10.6, 10.6.1 */
4204 strcmp(osinfo.release, "10.3.0") == 0 || /* 10.6.3 */
4205 strcmp(osinfo.release, "10.4.0") == 0) /* 10.6.4 */
4206 need_timeout_workaround = TRUE;
4211 * Determine if dumpcap is being requested to run in a special
4212 * capture_child mode by going thru the command line args to see if
4213 * a -Z is present. (-Z is a hidden option).
4215 * The primary result of running in capture_child mode is that
4216 * all messages sent out on stderr are in a special type/len/string
4217 * format to allow message processing by type. These messages include
4218 * error messages if dumpcap fails to start the operation it was
4219 * requested to do, as well as various "status" messages which are sent
4220 * when an actual capture is in progress, and a "success" message sent
4221 * if dumpcap was requested to perform an operation other than a
4224 * Capture_child mode would normally be requested by a parent process
4225 * which invokes dumpcap and obtains dumpcap stderr output via a pipe
4226 * to which dumpcap stderr has been redirected. It might also have
4227 * another pipe to obtain dumpcap stdout output; for operations other
4228 * than a capture, that information is formatted specially for easier
4229 * parsing by the parent process.
4231 * Capture_child mode needs to be determined immediately upon
4232 * startup so that any messages generated by dumpcap in this mode
4233 * (eg: during initialization) will be formatted properly.
4236 for (i=1; i<argc; i++) {
4237 if (strcmp("-Z", argv[i]) == 0) {
4238 capture_child = TRUE;
4239 machine_readable = TRUE; /* request machine-readable output */
4241 /* set output pipe to binary mode, to avoid ugly text conversions */
4242 _setmode(2, O_BINARY);
4247 /* The default_log_handler will use stdout, which makes trouble in */
4248 /* capture child mode, as it uses stdout for it's sync_pipe. */
4249 /* So: the filtering is done in the console_log_handler and not here.*/
4250 /* We set the log handlers right up front to make sure that any log */
4251 /* messages when running as child will be sent back to the parent */
4252 /* with the correct format. */
4256 G_LOG_LEVEL_CRITICAL|
4257 G_LOG_LEVEL_WARNING|
4258 G_LOG_LEVEL_MESSAGE|
4261 G_LOG_FLAG_FATAL|G_LOG_FLAG_RECURSION;
4263 g_log_set_handler(NULL,
4265 console_log_handler, NULL /* user_data */);
4266 g_log_set_handler(LOG_DOMAIN_MAIN,
4268 console_log_handler, NULL /* user_data */);
4269 g_log_set_handler(LOG_DOMAIN_CAPTURE,
4271 console_log_handler, NULL /* user_data */);
4272 g_log_set_handler(LOG_DOMAIN_CAPTURE_CHILD,
4274 console_log_handler, NULL /* user_data */);
4276 /* Initialize the pcaps list */
4277 global_ld.pcaps = g_array_new(FALSE, FALSE, sizeof(pcap_options *));
4279 #if !GLIB_CHECK_VERSION(2,31,0)
4280 /* Initialize the thread system */
4281 g_thread_init(NULL);
4285 /* Load wpcap if possible. Do this before collecting the run-time version information */
4288 /* ... and also load the packet.dll from wpcap */
4289 /* XXX - currently not required, may change later. */
4290 /*wpcap_packet_load();*/
4292 /* Start windows sockets */
4293 WSAStartup( MAKEWORD( 1, 1 ), &wsaData );
4295 /* Set handler for Ctrl+C key */
4296 SetConsoleCtrlHandler(capture_cleanup_handler, TRUE);
4298 /* Catch SIGINT and SIGTERM and, if we get either of them, clean up
4299 and exit. Do the same with SIGPIPE, in case, for example,
4300 we're writing to our standard output and it's a pipe.
4301 Do the same with SIGHUP if it's not being ignored (if we're
4302 being run under nohup, it might be ignored, in which case we
4303 should leave it ignored).
4305 XXX - apparently, Coverity complained that part of action
4306 wasn't initialized. Perhaps it's running on Linux, where
4307 struct sigaction has an ignored "sa_restorer" element and
4308 where "sa_handler" and "sa_sigaction" might not be two
4309 members of a union. */
4310 memset(&action, 0, sizeof(action));
4311 action.sa_handler = capture_cleanup_handler;
4313 * Arrange that system calls not get restarted, because when
4314 * our signal handler returns we don't want to restart
4315 * a call that was waiting for packets to arrive.
4317 action.sa_flags = 0;
4318 sigemptyset(&action.sa_mask);
4319 sigaction(SIGTERM, &action, NULL);
4320 sigaction(SIGINT, &action, NULL);
4321 sigaction(SIGPIPE, &action, NULL);
4322 sigaction(SIGHUP, NULL, &oldaction);
4323 if (oldaction.sa_handler == SIG_DFL)
4324 sigaction(SIGHUP, &action, NULL);
4327 /* Catch SIGINFO and, if we get it and we're capturing in
4328 quiet mode, report the number of packets we've captured. */
4329 action.sa_handler = report_counts_siginfo;
4330 action.sa_flags = SA_RESTART;
4331 sigemptyset(&action.sa_mask);
4332 sigaction(SIGINFO, &action, NULL);
4333 #endif /* SIGINFO */
4336 /* ----------------------------------------------------------------- */
4337 /* Privilege and capability handling */
4339 /* 1. Running not as root or suid root; no special capabilities. */
4342 /* 2. Running logged in as root (euid=0; ruid=0); Not using libcap. */
4345 /* 3. Running logged in as root (euid=0; ruid=0). Using libcap. */
4347 /* - Near start of program: Enable NET_RAW and NET_ADMIN */
4348 /* capabilities; Drop all other capabilities; */
4349 /* - If not -w (ie: doing -S or -D, etc) run to completion; */
4350 /* else: after pcap_open_live() in capture_loop_open_input() */
4351 /* drop all capabilities (NET_RAW and NET_ADMIN); */
4352 /* (Note: this means that the process, although logged in */
4353 /* as root, does not have various permissions such as the */
4354 /* ability to bypass file access permissions). */
4355 /* XXX: Should we just leave capabilities alone in this case */
4356 /* so that user gets expected effect that root can do */
4359 /* 4. Running as suid root (euid=0, ruid=n); Not using libcap. */
4361 /* - If not -w (ie: doing -S or -D, etc) run to completion; */
4362 /* else: after pcap_open_live() in capture_loop_open_input() */
4363 /* drop suid root (set euid=ruid).(ie: keep suid until after */
4364 /* pcap_open_live). */
4366 /* 5. Running as suid root (euid=0, ruid=n); Using libcap. */
4368 /* - Near start of program: Enable NET_RAW and NET_ADMIN */
4369 /* capabilities; Drop all other capabilities; */
4370 /* Drop suid privileges (euid=ruid); */
4371 /* - If not -w (ie: doing -S or -D, etc) run to completion; */
4372 /* else: after pcap_open_live() in capture_loop_open_input() */
4373 /* drop all capabilities (NET_RAW and NET_ADMIN). */
4375 /* XXX: For some Linux versions/distros with capabilities */
4376 /* a 'normal' process with any capabilities cannot be */
4377 /* 'killed' (signaled) from another (same uid) non-privileged */
4379 /* For example: If (non-suid) Wireshark forks a */
4380 /* child suid dumpcap which acts as described here (case 5), */
4381 /* Wireshark will be unable to kill (signal) the child */
4382 /* dumpcap process until the capabilities have been dropped */
4383 /* (after pcap_open_live()). */
4384 /* This behaviour will apparently be changed in the kernel */
4385 /* to allow the kill (signal) in this case. */
4386 /* See the following for details: */
4387 /* http://www.mail-archive.com/ [wrapped] */
4388 /* linux-security-module@vger.kernel.org/msg02913.html */
4390 /* It is therefore conceivable that if dumpcap somehow hangs */
4391 /* in pcap_open_live or before that wireshark will not */
4392 /* be able to stop dumpcap using a signal (INT, TERM, etc). */
4393 /* In this case, exiting wireshark will kill the child */
4394 /* dumpcap process. */
4396 /* 6. Not root or suid root; Running with NET_RAW & NET_ADMIN */
4397 /* capabilities; Using libcap. Note: capset cmd (which see) */
4398 /* used to assign capabilities to file. */
4400 /* - If not -w (ie: doing -S or -D, etc) run to completion; */
4401 /* else: after pcap_open_live() in capture_loop_open_input() */
4402 /* drop all capabilities (NET_RAW and NET_ADMIN) */
4404 /* ToDo: -S (stats) should drop privileges/capabilities when no */
4405 /* longer required (similar to capture). */
4407 /* ----------------------------------------------------------------- */
4409 init_process_policies();
4412 /* If 'started with special privileges' (and using libcap) */
4413 /* Set to keep only NET_RAW and NET_ADMIN capabilities; */
4414 /* Set euid/egid = ruid/rgid to remove suid privileges */
4415 relinquish_privs_except_capture();
4418 /* Set the initial values in the capture options. This might be overwritten
4419 by the command line parameters. */
4420 capture_opts_init(&global_capture_opts, NULL);
4422 /* We always save to a file - if no file was specified, we save to a
4424 global_capture_opts.saving_to_file = TRUE;
4425 global_capture_opts.has_ring_num_files = TRUE;
4427 /* Now get our args */
4428 while ((opt = getopt(argc, argv, OPTSTRING)) != -1) {
4430 case 'h': /* Print help and exit */
4434 case 'v': /* Show version and exit */
4436 GString *comp_info_str;
4437 GString *runtime_info_str;
4438 /* Assemble the compile-time version information string */
4439 comp_info_str = g_string_new("Compiled ");
4440 get_compiled_version_info(comp_info_str, NULL, NULL);
4442 /* Assemble the run-time version information string */
4443 runtime_info_str = g_string_new("Running ");
4444 get_runtime_version_info(runtime_info_str, NULL);
4445 show_version(comp_info_str, runtime_info_str);
4446 g_string_free(comp_info_str, TRUE);
4447 g_string_free(runtime_info_str, TRUE);
4451 /*** capture option specific ***/
4452 case 'a': /* autostop criteria */
4453 case 'b': /* Ringbuffer option */
4454 case 'c': /* Capture x packets */
4455 case 'f': /* capture filter */
4456 case 'i': /* Use interface x */
4457 case 'n': /* Use pcapng format */
4458 case 'p': /* Don't capture in promiscuous mode */
4459 case 'P': /* Use pcap format */
4460 case 's': /* Set the snapshot (capture) length */
4461 case 'w': /* Write to capture file x */
4462 case 'g': /* enable group read accesson file(s) */
4463 case 'y': /* Set the pcap data link type */
4464 #ifdef HAVE_PCAP_REMOTE
4465 case 'u': /* Use UDP for data transfer */
4466 case 'r': /* Capture own RPCAP traffic too */
4467 case 'A': /* Authentication */
4469 #ifdef HAVE_PCAP_SETSAMPLING
4470 case 'm': /* Sampling */
4472 #if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
4473 case 'B': /* Buffer size */
4474 #endif /* _WIN32 or HAVE_PCAP_CREATE */
4475 #ifdef HAVE_PCAP_CREATE
4476 case 'I': /* Monitor mode */
4478 status = capture_opts_add_opt(&global_capture_opts, opt, optarg, &start_capture);
4483 /*** hidden option: Wireshark child mode (using binary output messages) ***/
4485 capture_child = TRUE;
4487 /* set output pipe to binary mode, to avoid ugly text conversions */
4488 _setmode(2, O_BINARY);
4490 * optarg = the control ID, aka the PPID, currently used for the
4493 if (strcmp(optarg, SIGNAL_PIPE_CTRL_ID_NONE) != 0) {
4494 sig_pipe_name = g_strdup_printf(SIGNAL_PIPE_FORMAT, optarg);
4495 sig_pipe_handle = CreateFile(utf_8to16(sig_pipe_name),
4496 GENERIC_READ, 0, NULL, OPEN_EXISTING, 0, NULL);
4498 if (sig_pipe_handle == INVALID_HANDLE_VALUE) {
4499 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
4500 "Signal pipe: Unable to open %s. Dead parent?",
4508 case 'q': /* Quiet */
4514 /*** all non capture option specific ***/
4515 case 'D': /* Print a list of capture devices and exit */
4516 list_interfaces = TRUE;
4519 case 'L': /* Print list of link-layer types and exit */
4520 list_link_layer_types = TRUE;
4523 #ifdef HAVE_BPF_IMAGE
4524 case 'd': /* Print BPF code for capture filter and exit */
4525 print_bpf_code = TRUE;
4529 case 'S': /* Print interface statistics once a second */
4530 print_statistics = TRUE;
4533 case 'k': /* Set wireless channel */
4535 set_chan_arg = optarg;
4538 case 'M': /* For -D, -L, and -S, print machine-readable output */
4539 machine_readable = TRUE;
4542 cmdarg_err("Invalid Option: %s", argv[optind-1]);
4544 case '?': /* Bad flag - print usage message */
4553 /* user specified file name as regular command-line argument */
4554 /* XXX - use it as the capture file name (or something else)? */
4560 * Extra command line arguments were specified; complain.
4561 * XXX - interpret as capture filter, as tcpdump and tshark do?
4563 cmdarg_err("Invalid argument: %s", argv[0]);
4573 if (run_once_args > 1) {
4574 cmdarg_err("Only one of -D, -L, or -S may be supplied.");
4576 } else if (run_once_args == 1) {
4577 /* We're supposed to print some information, rather than
4578 to capture traffic; did they specify a ring buffer option? */
4579 if (global_capture_opts.multi_files_on) {
4580 cmdarg_err("Ring buffer requested, but a capture isn't being done.");
4584 /* We're supposed to capture traffic; */
4585 /* Are we capturing on multiple interface? If so, use threads and pcapng. */
4586 if (global_capture_opts.ifaces->len > 1) {
4588 global_capture_opts.use_pcapng = TRUE;
4590 /* Was the ring buffer option specified and, if so, does it make sense? */
4591 if (global_capture_opts.multi_files_on) {
4592 /* Ring buffer works only under certain conditions:
4593 a) ring buffer does not work with temporary files;
4594 b) it makes no sense to enable the ring buffer if the maximum
4595 file size is set to "infinite". */
4596 if (global_capture_opts.save_file == NULL) {
4597 cmdarg_err("Ring buffer requested, but capture isn't being saved to a permanent file.");
4598 global_capture_opts.multi_files_on = FALSE;
4600 if (!global_capture_opts.has_autostop_filesize && !global_capture_opts.has_file_duration) {
4601 cmdarg_err("Ring buffer requested, but no maximum capture file size or duration were specified.");
4603 /* XXX - this must be redesigned as the conditions changed */
4604 global_capture_opts.multi_files_on = FALSE;
4611 * "-D" requires no interface to be selected; it's supposed to list
4614 if (list_interfaces) {
4615 /* Get the list of interfaces */
4620 if_list = capture_interface_list(&err, &err_str);
4621 if (if_list == NULL) {
4623 case CANT_GET_INTERFACE_LIST:
4624 case DONT_HAVE_PCAP:
4625 cmdarg_err("%s", err_str);
4630 case NO_INTERFACES_FOUND:
4632 * If we're being run by another program, just give them
4633 * an empty list of interfaces, don't report this as
4634 * an error; that lets them decide whether to report
4635 * this as an error or not.
4637 if (!machine_readable) {
4638 cmdarg_err("There are no interfaces on which a capture can be done");
4645 if (machine_readable) /* tab-separated values to stdout */
4646 print_machine_readable_interfaces(if_list);
4648 capture_opts_print_interfaces(if_list);
4649 free_interface_list(if_list);
4654 * "-S" requires no interface to be selected; it gives statistics
4655 * for all interfaces.
4657 if (print_statistics) {
4658 status = print_statistics_loop(machine_readable);
4663 interface_options interface_opts;
4665 if (global_capture_opts.ifaces->len != 1) {
4666 cmdarg_err("Need one interface");
4670 interface_opts = g_array_index(global_capture_opts.ifaces, interface_options, 0);
4671 status = set_80211_channel(interface_opts.name, set_chan_arg);
4676 * "-L", "-d", and capturing act on a particular interface, so we have to
4677 * have an interface; if none was specified, pick a default.
4679 status = capture_opts_trim_iface(&global_capture_opts, NULL);
4681 /* cmdarg_err() already called .... */
4685 /* Let the user know what interfaces were chosen. */
4686 if (capture_child) {
4687 for (j = 0; j < global_capture_opts.ifaces->len; j++) {
4688 interface_options interface_opts;
4690 interface_opts = g_array_index(global_capture_opts.ifaces, interface_options, j);
4691 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "Interface: %s\n",
4692 interface_opts.name);
4695 str = g_string_new("");
4697 if (global_capture_opts.ifaces->len < 2)
4699 if (global_capture_opts.ifaces->len < 4)
4702 for (j = 0; j < global_capture_opts.ifaces->len; j++) {
4703 interface_options interface_opts;
4705 interface_opts = g_array_index(global_capture_opts.ifaces, interface_options, j);
4707 if (global_capture_opts.ifaces->len > 2) {
4708 g_string_append_printf(str, ",");
4710 g_string_append_printf(str, " ");
4711 if (j == global_capture_opts.ifaces->len - 1) {
4712 g_string_append_printf(str, "and ");
4715 g_string_append_printf(str, "'%s'", interface_opts.console_display_name);
4718 g_string_append_printf(str, "%u interfaces", global_capture_opts.ifaces->len);
4720 fprintf(stderr, "Capturing on %s\n", str->str);
4721 g_string_free(str, TRUE);
4724 if (list_link_layer_types) {
4725 /* Get the list of link-layer types for the capture device. */
4726 if_capabilities_t *caps;
4730 for (ii = 0; ii < global_capture_opts.ifaces->len; ii++) {
4731 interface_options interface_opts;
4733 interface_opts = g_array_index(global_capture_opts.ifaces, interface_options, ii);
4734 caps = get_if_capabilities(interface_opts.name,
4735 interface_opts.monitor_mode, &err_str);
4737 cmdarg_err("The capabilities of the capture device \"%s\" could not be obtained (%s).\n"
4738 "Please check to make sure you have sufficient permissions, and that\n"
4739 "you have the proper interface or pipe specified.", interface_opts.name, err_str);
4743 if (caps->data_link_types == NULL) {
4744 cmdarg_err("The capture device \"%s\" has no data link types.", interface_opts.name);
4747 if (machine_readable) /* tab-separated values to stdout */
4748 /* XXX: We need to change the format and adopt consumers */
4749 print_machine_readable_if_capabilities(caps);
4751 /* XXX: We might want to print also the interface name */
4752 capture_opts_print_if_capabilities(caps, interface_opts.name,
4753 interface_opts.monitor_mode);
4754 free_if_capabilities(caps);
4759 /* We're supposed to do a capture, or print the BPF code for a filter.
4760 Process the snapshot length, as that affects the generated BPF code. */
4761 capture_opts_trim_snaplen(&global_capture_opts, MIN_PACKET_SIZE);
4763 #ifdef HAVE_BPF_IMAGE
4764 if (print_bpf_code) {
4765 show_filter_code(&global_capture_opts);
4770 /* We're supposed to do a capture. Process the ring buffer arguments. */
4771 capture_opts_trim_ring_num_files(&global_capture_opts);
4773 /* flush stderr prior to starting the main capture loop */
4776 /* Now start the capture. */
4778 if (capture_loop_start(&global_capture_opts, &stats_known, &stats) == TRUE) {
4782 /* capture failed */
4785 return 0; /* never here, make compiler happy */
4790 console_log_handler(const char *log_domain, GLogLevelFlags log_level,
4791 const char *message, gpointer user_data _U_)
4798 /* ignore log message, if log_level isn't interesting */
4799 if ( !(log_level & G_LOG_LEVEL_MASK & ~(G_LOG_LEVEL_DEBUG|G_LOG_LEVEL_INFO))) {
4800 #if !defined(DEBUG_DUMPCAP) && !defined(DEBUG_CHILD_DUMPCAP)
4805 /* create a "timestamp" */
4807 today = localtime(&curr);
4809 switch(log_level & G_LOG_LEVEL_MASK) {
4810 case G_LOG_LEVEL_ERROR:
4813 case G_LOG_LEVEL_CRITICAL:
4816 case G_LOG_LEVEL_WARNING:
4819 case G_LOG_LEVEL_MESSAGE:
4822 case G_LOG_LEVEL_INFO:
4825 case G_LOG_LEVEL_DEBUG:
4829 fprintf(stderr, "unknown log_level %u\n", log_level);
4831 g_assert_not_reached();
4834 /* Generate the output message */
4835 if (log_level & G_LOG_LEVEL_MESSAGE) {
4836 /* normal user messages without additional infos */
4837 msg = g_strdup_printf("%s\n", message);
4839 /* info/debug messages with additional infos */
4840 msg = g_strdup_printf("%02u:%02u:%02u %8s %s %s\n",
4841 today->tm_hour, today->tm_min, today->tm_sec,
4842 log_domain != NULL ? log_domain : "",
4846 /* DEBUG & INFO msgs (if we're debugging today) */
4847 #if defined(DEBUG_DUMPCAP) || defined(DEBUG_CHILD_DUMPCAP)
4848 if ( !(log_level & G_LOG_LEVEL_MASK & ~(G_LOG_LEVEL_DEBUG|G_LOG_LEVEL_INFO))) {
4849 #ifdef DEBUG_DUMPCAP
4850 fprintf(stderr, "%s", msg);
4853 #ifdef DEBUG_CHILD_DUMPCAP
4854 fprintf(debug_log, "%s", msg);
4862 /* ERROR, CRITICAL, WARNING, MESSAGE messages goto stderr or */
4863 /* to parent especially formatted if dumpcap running as child. */
4864 if (capture_child) {
4865 sync_pipe_errmsg_to_parent(2, msg, "");
4867 fprintf(stderr, "%s", msg);
4874 /****************************************************************************************************************/
4875 /* indication report routines */
4879 report_packet_count(unsigned int packet_count)
4881 char tmp[SP_DECISIZE+1+1];
4882 static unsigned int count = 0;
4884 if (capture_child) {
4885 g_snprintf(tmp, sizeof(tmp), "%u", packet_count);
4886 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "Packets: %s", tmp);
4887 pipe_write_block(2, SP_PACKET_COUNT, tmp);
4889 count += packet_count;
4890 fprintf(stderr, "\rPackets: %u ", count);
4891 /* stderr could be line buffered */
4897 report_new_capture_file(const char *filename)
4899 if (capture_child) {
4900 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "File: %s", filename);
4901 pipe_write_block(2, SP_FILE, filename);
4905 * Prevent a SIGINFO handler from writing to the standard error
4906 * while we're doing so; instead, have it just set a flag telling
4907 * us to print that information when we're done.
4910 #endif /* SIGINFO */
4911 fprintf(stderr, "File: %s\n", filename);
4912 /* stderr could be line buffered */
4917 * Allow SIGINFO handlers to write.
4922 * If a SIGINFO handler asked us to write out capture counts, do so.
4925 report_counts_for_siginfo();
4926 #endif /* SIGINFO */
4931 report_cfilter_error(capture_options *capture_opts, guint i, const char *errmsg)
4933 interface_options interface_opts;
4934 char tmp[MSG_MAX_LENGTH+1+6];
4936 if (i < capture_opts->ifaces->len) {
4937 if (capture_child) {
4938 g_snprintf(tmp, sizeof(tmp), "%u:%s", i, errmsg);
4939 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG, "Capture filter error: %s", errmsg);
4940 pipe_write_block(2, SP_BAD_FILTER, tmp);
4943 * clopts_step_invalid_capfilter in test/suite-clopts.sh MUST match
4944 * the error message below.
4946 interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
4948 "Invalid capture filter \"%s\" for interface %s!\n"
4950 "That string isn't a valid capture filter (%s).\n"
4951 "See the User's Guide for a description of the capture filter syntax.",
4952 interface_opts.cfilter, interface_opts.name, errmsg);
4958 report_capture_error(const char *error_msg, const char *secondary_error_msg)
4960 if (capture_child) {
4961 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
4962 "Primary Error: %s", error_msg);
4963 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
4964 "Secondary Error: %s", secondary_error_msg);
4965 sync_pipe_errmsg_to_parent(2, error_msg, secondary_error_msg);
4967 cmdarg_err("%s", error_msg);
4968 if (secondary_error_msg[0] != '\0')
4969 cmdarg_err_cont("%s", secondary_error_msg);
4974 report_packet_drops(guint32 received, guint32 drops, gchar *name)
4976 char tmp[SP_DECISIZE+1+1];
4978 g_snprintf(tmp, sizeof(tmp), "%u", drops);
4980 if (capture_child) {
4981 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
4982 "Packets received/dropped on interface %s: %u/%u",
4983 name, received, drops);
4984 /* XXX: Need to provide interface id, changes to consumers required. */
4985 pipe_write_block(2, SP_DROPS, tmp);
4988 "Packets received/dropped on interface '%s': %u/%u (%.1f%%)\n",
4989 name, received, drops,
4990 received ? 100.0 * received / (received + drops) : 0.0);
4991 /* stderr could be line buffered */
4997 /************************************************************************************************/
4998 /* signal_pipe handling */
5003 signal_pipe_check_running(void)
5005 /* any news from our parent? -> just stop the capture */
5009 /* if we are running standalone, no check required */
5010 if (!capture_child) {
5014 if (!sig_pipe_name || !sig_pipe_handle) {
5015 /* This shouldn't happen */
5016 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
5017 "Signal pipe: No name or handle");
5022 * XXX - We should have the process ID of the parent (from the "-Z" flag)
5023 * at this point. Should we check to see if the parent is still alive,
5024 * e.g. by using OpenProcess?
5027 result = PeekNamedPipe(sig_pipe_handle, NULL, 0, NULL, &avail, NULL);
5029 if (!result || avail > 0) {
5030 /* peek failed or some bytes really available */
5031 /* (if not piping from stdin this would fail) */
5032 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_INFO,
5033 "Signal pipe: Stop capture: %s", sig_pipe_name);
5034 g_log(LOG_DOMAIN_CAPTURE_CHILD, G_LOG_LEVEL_DEBUG,
5035 "Signal pipe: %s (%p) result: %u avail: %u", sig_pipe_name,
5036 sig_pipe_handle, result, avail);
5039 /* pipe ok and no bytes available */
5046 * Editor modelines - http://www.wireshark.org/tools/modelines.html
5051 * indent-tabs-mode: nil
5054 * vi: set shiftwidth=4 tabstop=8 expandtab:
5055 * :indentSize=4:tabSize=8:noTabs=true: