Get rid of C++/C99-style comments.
[metze/wireshark/wip.git] / capture_opts.c
1 /* capture_opts.c
2  * Routines for capture options setting
3  *
4  * $Id$
5  *
6  * Wireshark - Network traffic analyzer
7  * By Gerald Combs <gerald@wireshark.org>
8  * Copyright 1998 Gerald Combs
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License
12  * as published by the Free Software Foundation; either version 2
13  * of the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23  */
24
25 #include "config.h"
26
27 #include <stdio.h>
28
29 #ifdef HAVE_LIBPCAP
30
31 #include <string.h>
32 #include <ctype.h>
33
34 #ifdef HAVE_UNISTD_H
35 #include <unistd.h>
36 #endif
37
38 #include <glib.h>
39
40 #include <epan/packet.h>
41 #include <epan/prefs.h>
42 #include "capture_ui_utils.h"
43
44 #include "capture_opts.h"
45 #include "ringbuffer.h"
46 #include "clopts_common.h"
47 #include "cmdarg_err.h"
48
49 #include "capture_ifinfo.h"
50 #include "capture-pcap-util.h"
51 #include <wsutil/file_util.h>
52
53 static gboolean capture_opts_output_to_pipe(const char *save_file, gboolean *is_pipe);
54
55
56 void
57 capture_opts_init(capture_options *capture_opts)
58 {
59   capture_opts->ifaces                          = g_array_new(FALSE, FALSE, sizeof(interface_options));
60   capture_opts->all_ifaces                      = g_array_new(FALSE, FALSE, sizeof(interface_t));
61   capture_opts->num_selected                    = 0;
62   capture_opts->default_options.name            = NULL;
63   capture_opts->default_options.descr           = NULL;
64   capture_opts->default_options.cfilter         = NULL;
65   capture_opts->default_options.has_snaplen     = FALSE;
66   capture_opts->default_options.snaplen         = WTAP_MAX_PACKET_SIZE;
67   capture_opts->default_options.linktype        = -1;
68   capture_opts->default_options.promisc_mode    = TRUE;
69 #if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
70   capture_opts->default_options.buffer_size     = DEFAULT_CAPTURE_BUFFER_SIZE;
71 #endif
72   capture_opts->default_options.monitor_mode    = FALSE;
73 #ifdef HAVE_PCAP_REMOTE
74   capture_opts->default_options.src_type        = CAPTURE_IFLOCAL;
75   capture_opts->default_options.remote_host     = NULL;
76   capture_opts->default_options.remote_port     = NULL;
77   capture_opts->default_options.auth_type       = CAPTURE_AUTH_NULL;
78   capture_opts->default_options.auth_username   = NULL;
79   capture_opts->default_options.auth_password   = NULL;
80   capture_opts->default_options.datatx_udp      = FALSE;
81   capture_opts->default_options.nocap_rpcap     = TRUE;
82   capture_opts->default_options.nocap_local     = FALSE;
83 #endif
84 #ifdef HAVE_PCAP_SETSAMPLING
85   capture_opts->default_options.sampling_method = CAPTURE_SAMP_NONE;
86   capture_opts->default_options.sampling_param  = 0;
87 #endif
88   capture_opts->saving_to_file                  = FALSE;
89   capture_opts->save_file                       = NULL;
90   capture_opts->group_read_access               = FALSE;
91 #ifdef PCAP_NG_DEFAULT
92   capture_opts->use_pcapng                      = TRUE;             /* Save as pcap-ng by default */
93 #else
94   capture_opts->use_pcapng                      = FALSE;            /* Save as pcap by default */
95 #endif
96   capture_opts->real_time_mode                  = TRUE;
97   capture_opts->show_info                       = TRUE;
98   capture_opts->quit_after_cap                  = getenv("WIRESHARK_QUIT_AFTER_CAPTURE") ? TRUE : FALSE;
99   capture_opts->restart                         = FALSE;
100
101   capture_opts->multi_files_on                  = FALSE;
102   capture_opts->has_file_duration               = FALSE;
103   capture_opts->file_duration                   = 60;               /* 1 min */
104   capture_opts->has_ring_num_files              = FALSE;
105   capture_opts->ring_num_files                  = RINGBUFFER_MIN_NUM_FILES;
106
107   capture_opts->has_autostop_files              = FALSE;
108   capture_opts->autostop_files                  = 1;
109   capture_opts->has_autostop_packets            = FALSE;
110   capture_opts->autostop_packets                = 0;
111   capture_opts->has_autostop_filesize           = FALSE;
112   capture_opts->autostop_filesize               = 1024;             /* 1 MB */
113   capture_opts->has_autostop_duration           = FALSE;
114   capture_opts->autostop_duration               = 60;               /* 1 min */
115
116   capture_opts->output_to_pipe                  = FALSE;
117 }
118
119
120 /* log content of capture_opts */
121 void
122 capture_opts_log(const char *log_domain, GLogLevelFlags log_level, capture_options *capture_opts) {
123     guint i;
124
125     g_log(log_domain, log_level, "CAPTURE OPTIONS     :");
126
127     for (i = 0; i < capture_opts->ifaces->len; i++) {
128         interface_options interface_opts;
129
130         interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
131         g_log(log_domain, log_level, "Interface name[%02d]  : %s", i, interface_opts.name ? interface_opts.name : "(unspecified)");
132         g_log(log_domain, log_level, "Interface description[%02d] : %s", i, interface_opts.descr ? interface_opts.descr : "(unspecified)");
133         g_log(log_domain, log_level, "Console display name[%02d]: %s", i, interface_opts.console_display_name ? interface_opts.console_display_name : "(unspecified)");
134         g_log(log_domain, log_level, "Capture filter[%02d]  : %s", i, interface_opts.cfilter ? interface_opts.cfilter : "(unspecified)");
135         g_log(log_domain, log_level, "Snap length[%02d] (%u) : %d", i, interface_opts.has_snaplen, interface_opts.snaplen);
136         g_log(log_domain, log_level, "Link Type[%02d]       : %d", i, interface_opts.linktype);
137         g_log(log_domain, log_level, "Promiscuous Mode[%02d]: %s", i, interface_opts.promisc_mode?"TRUE":"FALSE");
138 #if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
139         g_log(log_domain, log_level, "Buffer size[%02d]     : %d (MB)", i, interface_opts.buffer_size);
140 #endif
141         g_log(log_domain, log_level, "Monitor Mode[%02d]    : %s", i, interface_opts.monitor_mode?"TRUE":"FALSE");
142 #ifdef HAVE_PCAP_REMOTE
143         g_log(log_domain, log_level, "Capture source[%02d]  : %s", i,
144             interface_opts.src_type == CAPTURE_IFLOCAL ? "Local interface" :
145             interface_opts.src_type == CAPTURE_IFREMOTE ? "Remote interface" :
146             "Unknown");
147         if (interface_opts.src_type == CAPTURE_IFREMOTE) {
148             g_log(log_domain, log_level, "Remote host[%02d]     : %s", i, interface_opts.remote_host ? interface_opts.remote_host : "(unspecified)");
149             g_log(log_domain, log_level, "Remote port[%02d]     : %s", i, interface_opts.remote_port ? interface_opts.remote_port : "(unspecified)");
150         }
151         g_log(log_domain, log_level, "Authentication[%02d]  : %s", i,
152             interface_opts.auth_type == CAPTURE_AUTH_NULL ? "Null" :
153             interface_opts.auth_type == CAPTURE_AUTH_PWD ? "By username/password" :
154             "Unknown");
155         if (interface_opts.auth_type == CAPTURE_AUTH_PWD) {
156             g_log(log_domain, log_level, "Auth username[%02d]   : %s", i, interface_opts.auth_username ? interface_opts.auth_username : "(unspecified)");
157             g_log(log_domain, log_level, "Auth password[%02d]   : <hidden>", i);
158         }
159         g_log(log_domain, log_level, "UDP data tfer[%02d]   : %u", i, interface_opts.datatx_udp);
160         g_log(log_domain, log_level, "No cap. RPCAP[%02d]   : %u", i, interface_opts.nocap_rpcap);
161         g_log(log_domain, log_level, "No cap. local[%02d]   : %u", i, interface_opts.nocap_local);
162 #endif
163 #ifdef HAVE_PCAP_SETSAMPLING
164         g_log(log_domain, log_level, "Sampling meth.[%02d]  : %d", i, interface_opts.sampling_method);
165         g_log(log_domain, log_level, "Sampling param.[%02d] : %d", i, interface_opts.sampling_param);
166 #endif
167     }
168     g_log(log_domain, log_level, "Interface name[df]  : %s", capture_opts->default_options.name ? capture_opts->default_options.name : "(unspecified)");
169     g_log(log_domain, log_level, "Interface Descr[df] : %s", capture_opts->default_options.descr ? capture_opts->default_options.descr : "(unspecified)");
170     g_log(log_domain, log_level, "Capture filter[df]  : %s", capture_opts->default_options.cfilter ? capture_opts->default_options.cfilter : "(unspecified)");
171     g_log(log_domain, log_level, "Snap length[df] (%u) : %d", capture_opts->default_options.has_snaplen, capture_opts->default_options.snaplen);
172     g_log(log_domain, log_level, "Link Type[df]       : %d", capture_opts->default_options.linktype);
173     g_log(log_domain, log_level, "Promiscuous Mode[df]: %s", capture_opts->default_options.promisc_mode?"TRUE":"FALSE");
174 #if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
175     g_log(log_domain, log_level, "Buffer size[df]     : %d (MB)", capture_opts->default_options.buffer_size);
176 #endif
177     g_log(log_domain, log_level, "Monitor Mode[df]    : %s", capture_opts->default_options.monitor_mode?"TRUE":"FALSE");
178 #ifdef HAVE_PCAP_REMOTE
179     g_log(log_domain, log_level, "Capture source[df]  : %s",
180         capture_opts->default_options.src_type == CAPTURE_IFLOCAL ? "Local interface" :
181         capture_opts->default_options.src_type == CAPTURE_IFREMOTE ? "Remote interface" :
182         "Unknown");
183     if (capture_opts->default_options.src_type == CAPTURE_IFREMOTE) {
184         g_log(log_domain, log_level, "Remote host[df]     : %s", capture_opts->default_options.remote_host ? capture_opts->default_options.remote_host : "(unspecified)");
185         g_log(log_domain, log_level, "Remote port[df]     : %s", capture_opts->default_options.remote_port ? capture_opts->default_options.remote_port : "(unspecified)");
186     }
187     g_log(log_domain, log_level, "Authentication[df]  : %s",
188         capture_opts->default_options.auth_type == CAPTURE_AUTH_NULL ? "Null" :
189         capture_opts->default_options.auth_type == CAPTURE_AUTH_PWD ? "By username/password" :
190         "Unknown");
191     if (capture_opts->default_options.auth_type == CAPTURE_AUTH_PWD) {
192         g_log(log_domain, log_level, "Auth username[df]   : %s", capture_opts->default_options.auth_username ? capture_opts->default_options.auth_username : "(unspecified)");
193         g_log(log_domain, log_level, "Auth password[df]   : <hidden>");
194     }
195     g_log(log_domain, log_level, "UDP data tfer[df]   : %u", capture_opts->default_options.datatx_udp);
196     g_log(log_domain, log_level, "No cap. RPCAP[df]   : %u", capture_opts->default_options.nocap_rpcap);
197     g_log(log_domain, log_level, "No cap. local[df]   : %u", capture_opts->default_options.nocap_local);
198 #endif
199 #ifdef HAVE_PCAP_SETSAMPLING
200     g_log(log_domain, log_level, "Sampling meth. [df] : %d", capture_opts->default_options.sampling_method);
201     g_log(log_domain, log_level, "Sampling param.[df] : %d", capture_opts->default_options.sampling_param);
202 #endif
203     g_log(log_domain, log_level, "SavingToFile        : %u", capture_opts->saving_to_file);
204     g_log(log_domain, log_level, "SaveFile            : %s", (capture_opts->save_file) ? capture_opts->save_file : "");
205     g_log(log_domain, log_level, "GroupReadAccess     : %u", capture_opts->group_read_access);
206     g_log(log_domain, log_level, "Fileformat          : %s", (capture_opts->use_pcapng) ? "PCAPNG" : "PCAP");
207     g_log(log_domain, log_level, "RealTimeMode        : %u", capture_opts->real_time_mode);
208     g_log(log_domain, log_level, "ShowInfo            : %u", capture_opts->show_info);
209     g_log(log_domain, log_level, "QuitAfterCap        : %u", capture_opts->quit_after_cap);
210
211     g_log(log_domain, log_level, "MultiFilesOn        : %u", capture_opts->multi_files_on);
212     g_log(log_domain, log_level, "FileDuration    (%u) : %u", capture_opts->has_file_duration, capture_opts->file_duration);
213     g_log(log_domain, log_level, "RingNumFiles    (%u) : %u", capture_opts->has_ring_num_files, capture_opts->ring_num_files);
214
215     g_log(log_domain, log_level, "AutostopFiles   (%u) : %u", capture_opts->has_autostop_files, capture_opts->autostop_files);
216     g_log(log_domain, log_level, "AutostopPackets (%u) : %u", capture_opts->has_autostop_packets, capture_opts->autostop_packets);
217     g_log(log_domain, log_level, "AutostopFilesize(%u) : %u (KB)", capture_opts->has_autostop_filesize, capture_opts->autostop_filesize);
218     g_log(log_domain, log_level, "AutostopDuration(%u) : %u", capture_opts->has_autostop_duration, capture_opts->autostop_duration);
219 }
220
221 /*
222  * Given a string of the form "<autostop criterion>:<value>", as might appear
223  * as an argument to a "-a" option, parse it and set the criterion in
224  * question.  Return an indication of whether it succeeded or failed
225  * in some fashion.
226  */
227 static gboolean
228 set_autostop_criterion(capture_options *capture_opts, const char *autostoparg)
229 {
230   gchar *p, *colonp;
231
232   colonp = strchr(autostoparg, ':');
233   if (colonp == NULL)
234     return FALSE;
235
236   p = colonp;
237   *p++ = '\0';
238
239   /*
240    * Skip over any white space (there probably won't be any, but
241    * as we allow it in the preferences file, we might as well
242    * allow it here).
243    */
244   while (isspace((guchar)*p))
245     p++;
246   if (*p == '\0') {
247     /*
248      * Put the colon back, so if our caller uses, in an
249      * error message, the string they passed us, the message
250      * looks correct.
251      */
252     *colonp = ':';
253     return FALSE;
254   }
255   if (strcmp(autostoparg,"duration") == 0) {
256     capture_opts->has_autostop_duration = TRUE;
257     capture_opts->autostop_duration = get_positive_int(p,"autostop duration");
258   } else if (strcmp(autostoparg,"filesize") == 0) {
259     capture_opts->has_autostop_filesize = TRUE;
260     capture_opts->autostop_filesize = get_positive_int(p,"autostop filesize");
261   } else if (strcmp(autostoparg,"files") == 0) {
262     capture_opts->multi_files_on = TRUE;
263     capture_opts->has_autostop_files = TRUE;
264     capture_opts->autostop_files = get_positive_int(p,"autostop files");
265   } else {
266     return FALSE;
267   }
268   *colonp = ':'; /* put the colon back */
269   return TRUE;
270 }
271
272 /*
273  * Given a string of the form "<ring buffer file>:<duration>", as might appear
274  * as an argument to a "-b" option, parse it and set the arguments in
275  * question.  Return an indication of whether it succeeded or failed
276  * in some fashion.
277  */
278 static gboolean
279 get_ring_arguments(capture_options *capture_opts, const char *arg)
280 {
281   gchar *p = NULL, *colonp;
282
283   colonp = strchr(arg, ':');
284   if (colonp == NULL)
285     return FALSE;
286
287   p = colonp;
288   *p++ = '\0';
289
290   /*
291    * Skip over any white space (there probably won't be any, but
292    * as we allow it in the preferences file, we might as well
293    * allow it here).
294    */
295   while (isspace((guchar)*p))
296     p++;
297   if (*p == '\0') {
298     /*
299      * Put the colon back, so if our caller uses, in an
300      * error message, the string they passed us, the message
301      * looks correct.
302      */
303     *colonp = ':';
304     return FALSE;
305   }
306
307   if (strcmp(arg,"files") == 0) {
308     capture_opts->has_ring_num_files = TRUE;
309     capture_opts->ring_num_files = get_positive_int(p, "number of ring buffer files");
310   } else if (strcmp(arg,"filesize") == 0) {
311     capture_opts->has_autostop_filesize = TRUE;
312     capture_opts->autostop_filesize = get_positive_int(p, "ring buffer filesize");
313   } else if (strcmp(arg,"duration") == 0) {
314     capture_opts->has_file_duration = TRUE;
315     capture_opts->file_duration = get_positive_int(p, "ring buffer duration");
316   }
317
318   *colonp = ':';    /* put the colon back */
319   return TRUE;
320 }
321
322 #ifdef HAVE_PCAP_SETSAMPLING
323 /*
324  * Given a string of the form "<sampling type>:<value>", as might appear
325  * as an argument to a "-m" option, parse it and set the arguments in
326  * question.  Return an indication of whether it succeeded or failed
327  * in some fashion.
328  */
329 static gboolean
330 get_sampling_arguments(capture_options *capture_opts, const char *arg)
331 {
332     gchar *p = NULL, *colonp;
333
334     colonp = strchr(arg, ':');
335     if (colonp == NULL)
336         return FALSE;
337
338     p = colonp;
339     *p++ = '\0';
340
341     while (isspace((guchar)*p))
342         p++;
343     if (*p == '\0') {
344         *colonp = ':';
345         return FALSE;
346     }
347
348     if (strcmp(arg, "count") == 0) {
349         if (capture_opts->ifaces->len > 0) {
350             interface_options interface_opts;
351
352             interface_opts = g_array_index(capture_opts->ifaces, interface_options, capture_opts->ifaces->len - 1);
353             capture_opts->ifaces = g_array_remove_index(capture_opts->ifaces, capture_opts->ifaces->len - 1);
354             interface_opts.sampling_method = CAPTURE_SAMP_BY_COUNT;
355             interface_opts.sampling_param = get_positive_int(p, "sampling count");
356             g_array_append_val(capture_opts->ifaces, interface_opts);
357         } else {
358             capture_opts->default_options.sampling_method = CAPTURE_SAMP_BY_COUNT;
359             capture_opts->default_options.sampling_param = get_positive_int(p, "sampling count");
360         }
361     } else if (strcmp(arg, "timer") == 0) {
362         if (capture_opts->ifaces->len > 0) {
363             interface_options interface_opts;
364
365             interface_opts = g_array_index(capture_opts->ifaces, interface_options, capture_opts->ifaces->len - 1);
366             capture_opts->ifaces = g_array_remove_index(capture_opts->ifaces, capture_opts->ifaces->len - 1);
367             interface_opts.sampling_method = CAPTURE_SAMP_BY_TIMER;
368             interface_opts.sampling_param = get_positive_int(p, "sampling timer");
369             g_array_append_val(capture_opts->ifaces, interface_opts);
370         } else {
371             capture_opts->default_options.sampling_method = CAPTURE_SAMP_BY_TIMER;
372             capture_opts->default_options.sampling_param = get_positive_int(p, "sampling timer");
373         }
374     }
375     *colonp = ':';
376     return TRUE;
377 }
378 #endif
379
380 #ifdef HAVE_PCAP_REMOTE
381 /*
382  * Given a string of the form "<username>:<password>", as might appear
383  * as an argument to a "-A" option, parse it and set the arguments in
384  * question.  Return an indication of whether it succeeded or failed
385  * in some fashion.
386  */
387 static gboolean
388 get_auth_arguments(capture_options *capture_opts, const char *arg)
389 {
390     gchar *p = NULL, *colonp;
391
392     colonp = strchr(arg, ':');
393     if (colonp == NULL)
394         return FALSE;
395
396     p = colonp;
397     *p++ = '\0';
398
399     while (isspace((guchar)*p))
400         p++;
401
402     if (capture_opts->ifaces->len > 0) {
403         interface_options interface_opts;
404
405         interface_opts = g_array_index(capture_opts->ifaces, interface_options, capture_opts->ifaces->len - 1);
406         capture_opts->ifaces = g_array_remove_index(capture_opts->ifaces, capture_opts->ifaces->len - 1);
407         interface_opts.auth_type = CAPTURE_AUTH_PWD;
408         interface_opts.auth_username = g_strdup(arg);
409         interface_opts.auth_password = g_strdup(p);
410         g_array_append_val(capture_opts->ifaces, interface_opts);
411     } else {
412         capture_opts->default_options.auth_type = CAPTURE_AUTH_PWD;
413         capture_opts->default_options.auth_username = g_strdup(arg);
414         capture_opts->default_options.auth_password = g_strdup(p);
415     }
416     *colonp = ':';
417     return TRUE;
418 }
419 #endif
420
421 static int
422 capture_opts_add_iface_opt(capture_options *capture_opts, const char *optarg_str_p)
423 {
424     long        adapter_index;
425     char        *p;
426     GList       *if_list;
427     if_info_t   *if_info;
428     int         err;
429     gchar       *err_str;
430     interface_options interface_opts;
431
432     /*
433      * If the argument is a number, treat it as an index into the list
434      * of adapters, as printed by "tshark -D".
435      *
436      * This should be OK on UNIX systems, as interfaces shouldn't have
437      * names that begin with digits.  It can be useful on Windows, where
438      * more than one interface can have the same name.
439      */
440     adapter_index = strtol(optarg_str_p, &p, 10);
441     if (p != NULL && *p == '\0') {
442         if (adapter_index < 0) {
443             cmdarg_err("The specified adapter index is a negative number");
444             return 1;
445         }
446         if (adapter_index > INT_MAX) {
447             cmdarg_err("The specified adapter index is too large (greater than %d)",
448                        INT_MAX);
449             return 1;
450         }
451         if (adapter_index == 0) {
452             cmdarg_err("There is no interface with that adapter index");
453             return 1;
454         }
455         if_list = capture_interface_list(&err, &err_str);
456         if (if_list == NULL) {
457             switch (err) {
458
459             case CANT_GET_INTERFACE_LIST:
460             case DONT_HAVE_PCAP:
461                 cmdarg_err("%s", err_str);
462                 g_free(err_str);
463                 break;
464
465             case NO_INTERFACES_FOUND:
466                 cmdarg_err("There are no interfaces on which a capture can be done");
467                 break;
468             }
469             return 2;
470         }
471         if_info = (if_info_t *)g_list_nth_data(if_list, (int)(adapter_index - 1));
472         if (if_info == NULL) {
473             cmdarg_err("There is no interface with that adapter index");
474             return 1;
475         }
476         interface_opts.name = g_strdup(if_info->name);
477         if (if_info->friendly_name != NULL) {
478             /*
479              * We have a friendly name for the interface, so display that
480              * instead of the interface name/guid.
481              *
482              * XXX - on UN*X, the interface name is not quite so ugly,
483              * and might be more familiar to users; display them both?
484              */
485             interface_opts.console_display_name = g_strdup(if_info->friendly_name);
486         } else {
487             /* fallback to the interface name */
488             interface_opts.console_display_name = g_strdup(if_info->name);
489         }
490         free_interface_list(if_list);
491     } else {
492         /*
493          * Retrieve the interface list so that we can search for the
494          * specified option amongst both the interface names and the
495          * friendly names and so that we find the friendly name even
496          * if an interface name was specified.
497          *
498          * If we can't get the list, just use the specified option as
499          * the interface name, so that the user can try specifying an
500          * interface explicitly for testing purposes.
501          */
502         if_list = capture_interface_list(&err, NULL);
503         if (if_list != NULL) {
504             /* try and do an exact match (case insensitive) */
505             GList   *if_entry;
506             gboolean matched;
507
508             matched = FALSE;
509             for (if_entry = g_list_first(if_list); if_entry != NULL;
510                  if_entry = g_list_next(if_entry))
511             {
512                 if_info = (if_info_t *)if_entry->data;
513                 /* exact name check */
514                 if (g_ascii_strcasecmp(if_info->name, optarg_str_p) == 0) {
515                     /* exact match on the interface name, use that for displaying etc */
516                     interface_opts.name = g_strdup(if_info->name);
517
518                     if (if_info->friendly_name != NULL) {
519                         /*
520                          * If we have a friendly name, use that for the
521                          * console display name, as it is the basis for
522                          * the auto generated temp filename.
523                          */
524                         interface_opts.console_display_name = g_strdup(if_info->friendly_name);
525                     } else {
526                         interface_opts.console_display_name = g_strdup(if_info->name);
527                     }
528                     matched = TRUE;
529                     break;
530                 }
531
532                 /* exact friendly name check */
533                 if (if_info->friendly_name != NULL &&
534                     g_ascii_strcasecmp(if_info->friendly_name, optarg_str_p) == 0) {
535                     /* exact match - use the friendly name for display */
536                     interface_opts.name = g_strdup(if_info->name);
537                     interface_opts.console_display_name = g_strdup(if_info->friendly_name);
538                     matched = TRUE;
539                     break;
540                 }
541             }
542
543             /* didn't find, attempt a case insensitive prefix match of the friendly name*/
544             if (!matched) {
545                 size_t prefix_length;
546
547                 prefix_length = strlen(optarg_str_p);
548                 for (if_entry = g_list_first(if_list); if_entry != NULL;
549                      if_entry = g_list_next(if_entry))
550                 {
551                     if_info = (if_info_t *)if_entry->data;
552
553                     if (if_info->friendly_name != NULL &&
554                         g_ascii_strncasecmp(if_info->friendly_name, optarg_str_p, prefix_length) == 0) {
555                         /* prefix match - use the friendly name for display */
556                         interface_opts.name = g_strdup(if_info->name);
557                         interface_opts.console_display_name = g_strdup(if_info->friendly_name);
558                         matched = TRUE;
559                         break;
560                     }
561                 }
562             }
563             if (!matched) {
564                 /*
565                  * We didn't find the interface in the list; just use
566                  * the specified name, so that, for example, if an
567                  * interface doesn't show up in the list for some
568                  * reason, the user can try specifying it explicitly
569                  * for testing purposes.
570                  */
571                 interface_opts.name = g_strdup(optarg_str_p);
572                 interface_opts.console_display_name = g_strdup(optarg_str_p);
573             }
574             free_interface_list(if_list);
575         } else {
576             interface_opts.name = g_strdup(optarg_str_p);
577             interface_opts.console_display_name = g_strdup(optarg_str_p);
578         }
579     }
580
581     /*  We don't set iface_descr here because doing so requires
582      *  capture_ui_utils.c which requires epan/prefs.c which is
583      *  probably a bit too much dependency for here...
584      */
585     interface_opts.descr = g_strdup(capture_opts->default_options.descr);
586     interface_opts.cfilter = g_strdup(capture_opts->default_options.cfilter);
587     interface_opts.snaplen = capture_opts->default_options.snaplen;
588     interface_opts.has_snaplen = capture_opts->default_options.has_snaplen;
589     interface_opts.linktype = capture_opts->default_options.linktype;
590     interface_opts.promisc_mode = capture_opts->default_options.promisc_mode;
591 #if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
592     interface_opts.buffer_size = capture_opts->default_options.buffer_size;
593 #endif
594     interface_opts.monitor_mode = capture_opts->default_options.monitor_mode;
595 #ifdef HAVE_PCAP_REMOTE
596     interface_opts.src_type = capture_opts->default_options.src_type;
597     interface_opts.remote_host = g_strdup(capture_opts->default_options.remote_host);
598     interface_opts.remote_port = g_strdup(capture_opts->default_options.remote_port);
599     interface_opts.auth_type = capture_opts->default_options.auth_type;
600     interface_opts.auth_username = g_strdup(capture_opts->default_options.auth_username);
601     interface_opts.auth_password = g_strdup(capture_opts->default_options.auth_password);
602     interface_opts.datatx_udp = capture_opts->default_options.datatx_udp;
603     interface_opts.nocap_rpcap = capture_opts->default_options.nocap_rpcap;
604     interface_opts.nocap_local = capture_opts->default_options.nocap_local;
605 #endif
606 #ifdef HAVE_PCAP_SETSAMPLING
607     interface_opts.sampling_method = capture_opts->default_options.sampling_method;
608     interface_opts.sampling_param  = capture_opts->default_options.sampling_param;
609 #endif
610
611     g_array_append_val(capture_opts->ifaces, interface_opts);
612
613     return 0;
614 }
615
616
617 int
618 capture_opts_add_opt(capture_options *capture_opts, int opt, const char *optarg_str_p, gboolean *start_capture)
619 {
620     int status, snaplen;
621
622     switch(opt) {
623     case 'a':        /* autostop criteria */
624         if (set_autostop_criterion(capture_opts, optarg_str_p) == FALSE) {
625             cmdarg_err("Invalid or unknown -a flag \"%s\"", optarg_str_p);
626             return 1;
627         }
628         break;
629 #ifdef HAVE_PCAP_REMOTE
630     case 'A':
631         if (get_auth_arguments(capture_opts, optarg_str_p) == FALSE) {
632             cmdarg_err("Invalid or unknown -A arg \"%s\"", optarg_str_p);
633             return 1;
634         }
635         break;
636 #endif
637     case 'b':        /* Ringbuffer option */
638         capture_opts->multi_files_on = TRUE;
639         if (get_ring_arguments(capture_opts, optarg_str_p) == FALSE) {
640             cmdarg_err("Invalid or unknown -b arg \"%s\"", optarg_str_p);
641             return 1;
642         }
643         break;
644 #if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
645     case 'B':        /* Buffer size */
646         if (capture_opts->ifaces->len > 0) {
647             interface_options interface_opts;
648
649             interface_opts = g_array_index(capture_opts->ifaces, interface_options, capture_opts->ifaces->len - 1);
650             capture_opts->ifaces = g_array_remove_index(capture_opts->ifaces, capture_opts->ifaces->len - 1);
651             interface_opts.buffer_size = get_positive_int(optarg_str_p, "buffer size");
652             g_array_append_val(capture_opts->ifaces, interface_opts);
653         } else {
654             capture_opts->default_options.buffer_size = get_positive_int(optarg_str_p, "buffer size");
655         }
656         break;
657 #endif
658     case 'c':        /* Capture n packets */
659         capture_opts->has_autostop_packets = TRUE;
660         capture_opts->autostop_packets = get_positive_int(optarg_str_p, "packet count");
661         break;
662     case 'f':        /* capture filter */
663         if (capture_opts->ifaces->len > 0) {
664             interface_options interface_opts;
665
666             interface_opts = g_array_index(capture_opts->ifaces, interface_options, capture_opts->ifaces->len - 1);
667             capture_opts->ifaces = g_array_remove_index(capture_opts->ifaces, capture_opts->ifaces->len - 1);
668             g_free(interface_opts.cfilter);
669             interface_opts.cfilter = g_strdup(optarg_str_p);
670             g_array_append_val(capture_opts->ifaces, interface_opts);
671         } else {
672             g_free(capture_opts->default_options.cfilter);
673             capture_opts->default_options.cfilter = g_strdup(optarg_str_p);
674         }
675         break;
676     case 'g':        /* enable group read access on the capture file(s) */
677         capture_opts->group_read_access = TRUE;
678         break;
679     case 'H':        /* Hide capture info dialog box */
680         capture_opts->show_info = FALSE;
681         break;
682     case 'i':        /* Use interface x */
683         status = capture_opts_add_iface_opt(capture_opts, optarg_str_p);
684         if (status != 0) {
685             return status;
686         }
687         break;
688 #ifdef HAVE_PCAP_CREATE
689     case 'I':        /* Capture in monitor mode */
690         if (capture_opts->ifaces->len > 0) {
691             interface_options interface_opts;
692
693             interface_opts = g_array_index(capture_opts->ifaces, interface_options, capture_opts->ifaces->len - 1);
694             capture_opts->ifaces = g_array_remove_index(capture_opts->ifaces, capture_opts->ifaces->len - 1);
695             interface_opts.monitor_mode = TRUE;
696             g_array_append_val(capture_opts->ifaces, interface_opts);
697         } else {
698             capture_opts->default_options.monitor_mode = TRUE;
699         }
700         break;
701 #endif
702     case 'k':        /* Start capture immediately */
703         *start_capture = TRUE;
704         break;
705     /*case 'l':*/    /* Automatic scrolling in live capture mode */
706 #ifdef HAVE_PCAP_SETSAMPLING
707     case 'm':
708         if (get_sampling_arguments(capture_opts, optarg_str_p) == FALSE) {
709             cmdarg_err("Invalid or unknown -m arg \"%s\"", optarg_str_p);
710             return 1;
711         }
712         break;
713 #endif
714     case 'n':        /* Use pcapng format */
715         capture_opts->use_pcapng = TRUE;
716         break;
717     case 'p':        /* Don't capture in promiscuous mode */
718         if (capture_opts->ifaces->len > 0) {
719             interface_options interface_opts;
720
721             interface_opts = g_array_index(capture_opts->ifaces, interface_options, capture_opts->ifaces->len - 1);
722             capture_opts->ifaces = g_array_remove_index(capture_opts->ifaces, capture_opts->ifaces->len - 1);
723             interface_opts.promisc_mode = FALSE;
724             g_array_append_val(capture_opts->ifaces, interface_opts);
725         } else {
726             capture_opts->default_options.promisc_mode = FALSE;
727         }
728         break;
729     case 'P':        /* Use pcap format */
730         capture_opts->use_pcapng = FALSE;
731         break;
732 #ifdef HAVE_PCAP_REMOTE
733     case 'r':
734         if (capture_opts->ifaces->len > 0) {
735             interface_options interface_opts;
736
737             interface_opts = g_array_index(capture_opts->ifaces, interface_options, capture_opts->ifaces->len - 1);
738             capture_opts->ifaces = g_array_remove_index(capture_opts->ifaces, capture_opts->ifaces->len - 1);
739             interface_opts.nocap_rpcap = FALSE;
740             g_array_append_val(capture_opts->ifaces, interface_opts);
741         } else {
742             capture_opts->default_options.nocap_rpcap = FALSE;
743         }
744         break;
745 #endif
746     case 's':        /* Set the snapshot (capture) length */
747         snaplen = get_natural_int(optarg_str_p, "snapshot length");
748         /*
749          * Make a snapshot length of 0 equivalent to the maximum packet
750          * length, mirroring what tcpdump does.
751          */
752         if (snaplen == 0)
753             snaplen = WTAP_MAX_PACKET_SIZE;
754         if (capture_opts->ifaces->len > 0) {
755             interface_options interface_opts;
756
757             interface_opts = g_array_index(capture_opts->ifaces, interface_options, capture_opts->ifaces->len - 1);
758             capture_opts->ifaces = g_array_remove_index(capture_opts->ifaces, capture_opts->ifaces->len - 1);
759             interface_opts.has_snaplen = TRUE;
760             interface_opts.snaplen = snaplen;
761             g_array_append_val(capture_opts->ifaces, interface_opts);
762         } else {
763             capture_opts->default_options.snaplen = snaplen;
764             capture_opts->default_options.has_snaplen = TRUE;
765         }
766         break;
767     case 'S':        /* "Real-Time" mode: used for following file ala tail -f */
768         capture_opts->real_time_mode = TRUE;
769         break;
770 #ifdef HAVE_PCAP_REMOTE
771     case 'u':
772         if (capture_opts->ifaces->len > 0) {
773             interface_options interface_opts;
774
775             interface_opts = g_array_index(capture_opts->ifaces, interface_options, capture_opts->ifaces->len - 1);
776             capture_opts->ifaces = g_array_remove_index(capture_opts->ifaces, capture_opts->ifaces->len - 1);
777             interface_opts.datatx_udp = TRUE;
778             g_array_append_val(capture_opts->ifaces, interface_opts);
779         } else {
780             capture_opts->default_options.datatx_udp = TRUE;
781         }
782         break;
783 #endif
784     case 'w':        /* Write to capture file x */
785         capture_opts->saving_to_file = TRUE;
786         g_free(capture_opts->save_file);
787         capture_opts->save_file = g_strdup(optarg_str_p);
788         status = capture_opts_output_to_pipe(capture_opts->save_file, &capture_opts->output_to_pipe);
789         return status;
790     case 'y':        /* Set the pcap data link type */
791         if (capture_opts->ifaces->len > 0) {
792             interface_options interface_opts;
793
794             interface_opts = g_array_index(capture_opts->ifaces, interface_options, capture_opts->ifaces->len - 1);
795             capture_opts->ifaces = g_array_remove_index(capture_opts->ifaces, capture_opts->ifaces->len - 1);
796             interface_opts.linktype = linktype_name_to_val(optarg_str_p);
797             if (interface_opts.linktype == -1) {
798                 cmdarg_err("The specified data link type \"%s\" isn't valid",
799                            optarg_str_p);
800                 return 1;
801             }
802             g_array_append_val(capture_opts->ifaces, interface_opts);
803         } else {
804             capture_opts->default_options.linktype = linktype_name_to_val(optarg_str_p);
805             if (capture_opts->default_options.linktype == -1) {
806                 cmdarg_err("The specified data link type \"%s\" isn't valid",
807                            optarg_str_p);
808                 return 1;
809             }
810         }
811         break;
812     default:
813         /* the caller is responsible to send us only the right opt's */
814         g_assert_not_reached();
815     }
816
817     return 0;
818 }
819
820 void
821 capture_opts_print_if_capabilities(if_capabilities_t *caps, char *name,
822                                    gboolean monitor_mode)
823 {
824     GList *lt_entry;
825     data_link_info_t *data_link_info;
826
827     if (caps->can_set_rfmon)
828         printf("Data link types of interface %s when %sin monitor mode (use option -y to set):\n",
829                name, monitor_mode ? "" : "not ");
830     else
831         printf("Data link types of interface %s (use option -y to set):\n", name);
832     for (lt_entry = caps->data_link_types; lt_entry != NULL;
833          lt_entry = g_list_next(lt_entry)) {
834         data_link_info = (data_link_info_t *)lt_entry->data;
835         printf("  %s", data_link_info->name);
836         if (data_link_info->description != NULL)
837             printf(" (%s)", data_link_info->description);
838         else
839             printf(" (not supported)");
840         printf("\n");
841     }
842 }
843
844 /* Print an ASCII-formatted list of interfaces. */
845 void
846 capture_opts_print_interfaces(GList *if_list)
847 {
848     int         i;
849     GList       *if_entry;
850     if_info_t   *if_info;
851
852     i = 1;  /* Interface id number */
853     for (if_entry = g_list_first(if_list); if_entry != NULL;
854          if_entry = g_list_next(if_entry)) {
855         if_info = (if_info_t *)if_entry->data;
856         printf("%d. %s", i++, if_info->name);
857
858         /* Print the interface friendly name, if it exists;
859           if not fall back to vendor description, if it exists. */
860         if (if_info->friendly_name != NULL){
861             printf(" (%s)", if_info->friendly_name);
862         } else {
863             if (if_info->vendor_description != NULL)
864                 printf(" (%s)", if_info->vendor_description);
865         }
866         printf("\n");
867     }
868 }
869
870
871 void
872 capture_opts_trim_snaplen(capture_options *capture_opts, int snaplen_min)
873 {
874     guint i;
875     interface_options interface_opts;
876
877     if (capture_opts->ifaces->len > 0) {
878         for (i = 0; i < capture_opts->ifaces->len; i++) {
879             interface_opts = g_array_index(capture_opts->ifaces, interface_options, 0);
880             capture_opts->ifaces = g_array_remove_index(capture_opts->ifaces, 0);
881             if (interface_opts.snaplen < 1)
882                 interface_opts.snaplen = WTAP_MAX_PACKET_SIZE;
883             else if (interface_opts.snaplen < snaplen_min)
884                 interface_opts.snaplen = snaplen_min;
885             g_array_append_val(capture_opts->ifaces, interface_opts);
886         }
887     } else {
888         if (capture_opts->default_options.snaplen < 1)
889             capture_opts->default_options.snaplen = WTAP_MAX_PACKET_SIZE;
890         else if (capture_opts->default_options.snaplen < snaplen_min)
891             capture_opts->default_options.snaplen = snaplen_min;
892     }
893 }
894
895
896 void
897 capture_opts_trim_ring_num_files(capture_options *capture_opts)
898 {
899     /* Check the value range of the ring_num_files parameter */
900     if (capture_opts->ring_num_files > RINGBUFFER_MAX_NUM_FILES) {
901         cmdarg_err("Too many ring buffer files (%u). Reducing to %u.\n", capture_opts->ring_num_files, RINGBUFFER_MAX_NUM_FILES);
902         capture_opts->ring_num_files = RINGBUFFER_MAX_NUM_FILES;
903     } else if (capture_opts->ring_num_files > RINGBUFFER_WARN_NUM_FILES) {
904         cmdarg_err("%u is a lot of ring buffer files.\n", capture_opts->ring_num_files);
905     }
906 #if RINGBUFFER_MIN_NUM_FILES > 0
907     else if (capture_opts->ring_num_files < RINGBUFFER_MIN_NUM_FILES)
908         cmdarg_err("Too few ring buffer files (%u). Increasing to %u.\n", capture_opts->ring_num_files, RINGBUFFER_MIN_NUM_FILES);
909         capture_opts->ring_num_files = RINGBUFFER_MIN_NUM_FILES;
910 #endif
911 }
912
913 /*
914  * If no interface was specified explicitly, pick a default.
915  */
916 int
917 capture_opts_default_iface_if_necessary(capture_options *capture_opts,
918                                         const char *capture_device)
919 {
920     int status;
921
922     /* Did the user specify an interface to use? */
923     if (capture_opts->num_selected != 0 || capture_opts->ifaces->len != 0) {
924         /* yes they did, return immediately - nothing further to do here */
925         return 0;
926     }
927
928     /* No - is a default specified in the preferences file? */
929     if (capture_device != NULL) {
930         /* Yes - use it. */
931         status = capture_opts_add_iface_opt(capture_opts, capture_device);
932         return status;
933     }
934     /* No default in preferences file, just pick the first interface from the list of interfaces. */
935     return capture_opts_add_iface_opt(capture_opts, "1");
936 }
937
938 #ifndef S_IFIFO
939 #define S_IFIFO _S_IFIFO
940 #endif
941 #ifndef S_ISFIFO
942 #define S_ISFIFO(mode)  (((mode) & S_IFMT) == S_IFIFO)
943 #endif
944
945 /* copied from filesystem.c */
946 static int
947 capture_opts_test_for_fifo(const char *path)
948 {
949   ws_statb64 statb;
950
951   if (ws_stat64(path, &statb) < 0)
952     return errno;
953
954   if (S_ISFIFO(statb.st_mode))
955     return ESPIPE;
956   else
957     return 0;
958 }
959
960 static gboolean
961 capture_opts_output_to_pipe(const char *save_file, gboolean *is_pipe)
962 {
963   int err;
964
965   *is_pipe = FALSE;
966
967   if (save_file != NULL) {
968     /* We're writing to a capture file. */
969     if (strcmp(save_file, "-") == 0) {
970       /* Writing to stdout. */
971       /* XXX - should we check whether it's a pipe?  It's arguably
972          silly to do "-w - >output_file" rather than "-w output_file",
973          but by not checking we might be violating the Principle Of
974          Least Astonishment. */
975       *is_pipe = TRUE;
976     } else {
977       /* not writing to stdout, test for a FIFO (aka named pipe) */
978       err = capture_opts_test_for_fifo(save_file);
979       switch (err) {
980
981       case ENOENT:      /* it doesn't exist, so we'll be creating it,
982                            and it won't be a FIFO */
983       case 0:           /* found it, but it's not a FIFO */
984         break;
985
986       case ESPIPE:      /* it is a FIFO */
987         *is_pipe = TRUE;
988         break;
989
990       default:          /* couldn't stat it              */
991         break;          /* ignore: later attempt to open */
992                         /*  will generate a nice msg     */
993       }
994     }
995   }
996
997   return 0;
998 }
999
1000 /*
1001  * Add all non-hidden selected interfaces in the "all interfaces" list
1002  * to the list of interfaces for the capture.
1003  */
1004 void
1005 collect_ifaces(capture_options *capture_opts)
1006 {
1007   guint i;
1008   interface_t device;
1009   interface_options interface_opts;
1010
1011   /* Empty out the existing list of interfaces. */
1012   for (i = capture_opts->ifaces->len; i != 0; i--) {
1013     interface_opts = g_array_index(capture_opts->ifaces, interface_options, i - 1);
1014     g_free(interface_opts.name);
1015     g_free(interface_opts.descr);
1016     if (interface_opts.console_display_name != NULL)
1017         g_free(interface_opts.console_display_name);
1018     g_free(interface_opts.cfilter);
1019 #ifdef HAVE_PCAP_REMOTE
1020     if (interface_opts.src_type == CAPTURE_IFREMOTE) {
1021       g_free(interface_opts.remote_host);
1022       g_free(interface_opts.remote_port);
1023       g_free(interface_opts.auth_username);
1024       g_free(interface_opts.auth_password);
1025     }
1026 #endif
1027     capture_opts->ifaces = g_array_remove_index(capture_opts->ifaces, i - 1);
1028   }
1029
1030   /* Now fill the list up again. */
1031   for (i = 0; i < capture_opts->all_ifaces->len; i++) {
1032     device = g_array_index(capture_opts->all_ifaces, interface_t, i);
1033     if (!device.hidden && device.selected) {
1034       interface_opts.name = g_strdup(device.name);
1035       interface_opts.descr = g_strdup(device.display_name);
1036       interface_opts.console_display_name = g_strdup(device.name);
1037       interface_opts.linktype = device.active_dlt;
1038       interface_opts.cfilter = g_strdup(device.cfilter);
1039       interface_opts.snaplen = device.snaplen;
1040       interface_opts.has_snaplen = device.has_snaplen;
1041       interface_opts.promisc_mode = device.pmode;
1042 #if defined(_WIN32) || defined(HAVE_PCAP_CREATE)
1043       interface_opts.buffer_size =  device.buffer;
1044 #endif
1045 #ifdef HAVE_PCAP_CREATE
1046       interface_opts.monitor_mode = device.monitor_mode_enabled;
1047 #endif
1048 #ifdef HAVE_PCAP_REMOTE
1049       interface_opts.src_type = CAPTURE_IFREMOTE;
1050       interface_opts.remote_host = g_strdup(device.remote_opts.remote_host_opts.remote_host);
1051       interface_opts.remote_port = g_strdup(device.remote_opts.remote_host_opts.remote_port);
1052       interface_opts.auth_type = device.remote_opts.remote_host_opts.auth_type;
1053       interface_opts.auth_username = g_strdup(device.remote_opts.remote_host_opts.auth_username);
1054       interface_opts.auth_password = g_strdup(device.remote_opts.remote_host_opts.auth_password);
1055       interface_opts.datatx_udp = device.remote_opts.remote_host_opts.datatx_udp;
1056       interface_opts.nocap_rpcap = device.remote_opts.remote_host_opts.nocap_rpcap;
1057       interface_opts.nocap_local = device.remote_opts.remote_host_opts.nocap_local;
1058 #endif
1059 #ifdef HAVE_PCAP_SETSAMPLING
1060       interface_opts.sampling_method = device.remote_opts.sampling_method;
1061       interface_opts.sampling_param  = device.remote_opts.sampling_param;
1062 #endif
1063       g_array_append_val(capture_opts->ifaces, interface_opts);
1064     } else {
1065       continue;
1066     }
1067   }
1068 }
1069
1070
1071 #endif /* HAVE_LIBPCAP */