extcap_child_watch_cb() always uses the status argument.
[metze/wireshark/wip.git] / extcap.c
1 /* extcap.h
2  *
3  * Routines for extcap external capture
4  * Copyright 2013, Mike Ryan <mikeryan@lacklustre.net>
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 #include <stdlib.h>
29 #include <string.h>
30
31 #ifdef _WIN32
32 #include <windows.h>
33 #include <process.h>
34 #include <time.h>
35 #else
36 /* Include for unlink */
37 #include <unistd.h>
38 #endif
39
40 #ifdef HAVE_SYS_TYPES_H
41 #include <sys/types.h>
42 #endif
43 #ifdef HAVE_SYS_WAIT_H
44 #include <sys/wait.h>
45 #endif
46
47 #include <glib.h>
48 #include <log.h>
49
50 #include <epan/prefs.h>
51 #include <epan/prefs-int.h>
52
53 #include <wsutil/file_util.h>
54 #include <wsutil/filesystem.h>
55 #include <wsutil/tempfile.h>
56
57 #include "capture_opts.h"
58
59 #include "extcap.h"
60 #include "extcap_parser.h"
61 #include "extcap_spawn.h"
62
63 #ifdef _WIN32
64 static HANDLE pipe_h = NULL;
65 #endif
66
67 #define EXTCAP_PREF_SIZE 256
68 static void extcap_child_watch_cb(GPid pid, gint status, gpointer user_data);
69
70 /* internal container, for all the extcap interfaces that have been found.
71  * will be resetted by every call to extcap_interface_list() and is being
72  * used in extcap_get_if_* as well as extcap_init_interfaces to ensure,
73  * that only extcap interfaces are being given to underlying extcap programs
74  */
75 static GHashTable *ifaces = NULL;
76
77 /* internal container, for all the extcap executables that have been found.
78  * will be resetted by every call to extcap_interface_list() and is being
79  * used for printing information about all extcap interfaces found
80  */
81 static GHashTable *tools = NULL;
82
83 /* internal container, to map preferences for extcap utilities to dynamic
84  * memory content, which survives extcap if garbage collection, and does
85  * not lead to dangling pointers
86  */
87 static GHashTable *extcap_prefs_dynamic_vals = NULL;
88
89 /* Callback definition for extcap_foreach */
90 typedef gboolean (*extcap_cb_t)(const gchar *extcap, const gchar *ifname, gchar *output, void *data,
91         gchar **err_str);
92
93 static gboolean
94 extcap_if_exists(const gchar *ifname)
95 {
96     if ( !ifname || !ifaces )
97         return FALSE;
98
99     if ( g_hash_table_lookup(ifaces, ifname) )
100         return TRUE;
101
102     return FALSE;
103 }
104
105 static gboolean
106 extcap_if_exists_for_extcap(const gchar *ifname, const gchar *extcap)
107 {
108     extcap_interface * entry = (extcap_interface *)g_hash_table_lookup(ifaces, ifname);
109
110     if ( entry && strcmp(entry->extcap_path, extcap) == 0 )
111         return TRUE;
112
113     return FALSE;
114 }
115
116 static gchar *
117 extcap_if_executable(const gchar *ifname)
118 {
119     extcap_interface * interface = (extcap_interface *)g_hash_table_lookup(ifaces, ifname);
120     return interface != NULL ? interface->extcap_path : NULL;
121 }
122
123 static void
124 extcap_if_add(extcap_interface * interface)
125 {
126     if (!g_hash_table_lookup(ifaces, interface->call))
127         g_hash_table_insert(ifaces, g_strdup(interface->call), interface);
128 }
129
130 static void
131 extcap_free_info (gpointer data) {
132     extcap_info * info = (extcap_info *)data;
133
134     g_free (info->basename);
135     g_free (info->full_path);
136     g_free (info->version);
137     g_free (info);
138 }
139
140 static void
141 extcap_tool_add(const gchar *extcap, const extcap_interface *interface)
142 {
143     char *toolname;
144
145     if ( !extcap || !interface )
146         return;
147
148     toolname = g_path_get_basename(extcap);
149
150     if ( !g_hash_table_lookup(tools, toolname) ) {
151         extcap_info * store = (extcap_info *)g_new0(extcap_info, 1);
152         store->version = g_strdup(interface->version);
153         store->full_path = g_strdup(extcap);
154         store->basename = g_strdup(toolname);
155
156         g_hash_table_insert(tools, g_strdup(toolname), store);
157     }
158
159     g_free(toolname);
160 }
161
162 /* Note: args does not need to be NULL-terminated. */
163 static void extcap_foreach(gint argc, gchar **args, extcap_cb_t cb,
164         void *cb_data, char **err_str, const char * ifname _U_) {
165     const char *dirname = get_extcap_dir();
166     GDir *dir;
167     const gchar *file;
168     gboolean keep_going;
169
170     keep_going = TRUE;
171
172     if ((dir = g_dir_open(dirname, 0, NULL)) != NULL) {
173         GString *extcap_path = NULL;
174
175         extcap_path = g_string_new("");
176         while (keep_going && (file = g_dir_read_name(dir)) != NULL ) {
177             gchar *command_output = NULL;
178
179             /* full path to extcap binary */
180 #ifdef _WIN32
181             g_string_printf(extcap_path, "%s\\%s", dirname, file);
182 #else
183             g_string_printf(extcap_path, "%s/%s", dirname, file);
184 #endif
185             if ( extcap_if_exists(ifname) && !extcap_if_exists_for_extcap(ifname, extcap_path->str ) )
186                 continue;
187
188             if ( extcap_spawn_sync ( (gchar *) dirname, extcap_path->str, argc, args, &command_output ) )
189                 keep_going = cb(extcap_path->str, ifname, command_output, cb_data, err_str);
190
191             g_free(command_output);
192         }
193
194         g_dir_close(dir);
195         g_string_free(extcap_path, TRUE);
196     }
197
198 }
199
200 static void extcap_free_dlt(gpointer d, gpointer user_data _U_) {
201     if (d == NULL)
202         return;
203
204     g_free(((extcap_dlt *)d)->name);
205     g_free(((extcap_dlt *)d)->display);
206 }
207
208 static gboolean dlt_cb(const gchar *extcap _U_, const gchar *ifname _U_, gchar *output, void *data,
209         char **err_str) {
210     GList *dlts = NULL, *temp = NULL;
211
212     if_capabilities_t *caps;
213     GList *linktype_list = NULL;
214     data_link_info_t *data_link_info;
215     extcap_dlt * dlt_item;
216
217     dlts = extcap_parse_dlts(output);
218     temp = dlts;
219
220     g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "Extcap pipe %s ", extcap);
221
222     /*
223      * Allocate the interface capabilities structure.
224      */
225     caps = (if_capabilities_t *) g_malloc(sizeof *caps);
226     caps->can_set_rfmon = FALSE;
227
228     while (dlts) {
229         dlt_item = (extcap_dlt *)dlts->data;
230         if (dlt_item) {
231             g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG,
232                 "  DLT %d name=\"%s\" display=\"%s\" ", dlt_item->number,
233                 dlt_item->name, dlt_item->display);
234
235             data_link_info = g_new(data_link_info_t, 1);
236             data_link_info->dlt = dlt_item->number;
237             data_link_info->name = g_strdup(dlt_item->name);
238             data_link_info->description = g_strdup(dlt_item->display);
239             linktype_list = g_list_append(linktype_list, data_link_info);
240         }
241
242         dlts = g_list_next(dlts);
243     }
244
245     /* Check to see if we built a list */
246     if (linktype_list != NULL && data != NULL) {
247         caps->data_link_types = linktype_list;
248         *(if_capabilities_t **) data = caps;
249     } else {
250         if (err_str) {
251             g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "  returned no DLTs");
252             *err_str = g_strdup("Extcap returned no DLTs");
253         }
254         g_free(caps);
255     }
256
257     g_list_foreach(temp, extcap_free_dlt, NULL);
258
259     return FALSE;
260 }
261
262 if_capabilities_t *
263 extcap_get_if_dlts(const gchar *ifname, char **err_str) {
264     gchar *argv[3];
265     gint i;
266     if_capabilities_t *caps = NULL;
267
268     if (err_str != NULL)
269         *err_str = NULL;
270
271     if ( extcap_if_exists(ifname) )
272     {
273         argv[0] = g_strdup(EXTCAP_ARGUMENT_LIST_DLTS);
274         argv[1] = g_strdup(EXTCAP_ARGUMENT_INTERFACE);
275         argv[2] = g_strdup(ifname);
276
277         extcap_foreach(3, argv, dlt_cb, &caps, err_str, ifname);
278
279         for (i = 0; i < 3; ++i)
280             g_free(argv[i]);
281     }
282
283     return caps;
284 }
285
286 static void extcap_free_interface(gpointer i) {
287
288     extcap_interface * interface = (extcap_interface *)i;
289
290     if ( i == NULL )
291         return;
292
293     g_free(interface->call);
294     g_free(interface->display);
295     g_free(interface->version);
296     g_free(interface->help);
297 }
298
299 static gboolean interfaces_cb(const gchar *extcap, const gchar *ifname _U_, gchar *output, void *data,
300         char **err_str _U_) {
301     GList **il = (GList **) data;
302     GList *interfaces = NULL, *walker = NULL;
303     extcap_interface *int_iter = NULL;
304     if_info_t *if_info = NULL;
305
306     interfaces = extcap_parse_interfaces(output);
307
308     g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "Extcap pipe %s ", extcap);
309
310     walker = interfaces;
311     while (walker != NULL ) {
312         int_iter = (extcap_interface *)walker->data;
313         if ( int_iter->if_type == EXTCAP_SENTENCE_INTERFACE && extcap_if_exists(int_iter->call) )
314         {
315             g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_WARNING, "Extcap interface \"%s\" is already provided by \"%s\" ",
316                     int_iter->call, (gchar *)extcap_if_executable(int_iter->call) );
317             walker = g_list_next(walker);
318             continue;
319         }
320
321         if ( int_iter->if_type == EXTCAP_SENTENCE_INTERFACE )
322             g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "  Interface [%s] \"%s\" ",
323                     int_iter->call, int_iter->display);
324         else if ( int_iter->if_type == EXTCAP_SENTENCE_EXTCAP )
325             g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "  Extcap [%s] ", int_iter->call);
326
327         if ( int_iter->if_type == EXTCAP_SENTENCE_INTERFACE ) {
328             if (il != NULL) {
329                 if_info = g_new0(if_info_t, 1);
330                 if_info->name = g_strdup(int_iter->call);
331                 if_info->friendly_name = g_strdup(int_iter->display);
332
333                 if_info->type = IF_EXTCAP;
334
335                 if_info->extcap = g_strdup(extcap);
336                 *il = g_list_append(*il, if_info);
337             }
338
339             int_iter->extcap_path = g_strdup(extcap);
340             extcap_if_add(int_iter);
341         }
342
343         /* Call for interfaces and tools alike. Multiple calls (because a tool has multiple
344          * interfaces) are handled internally */
345         extcap_tool_add(extcap, int_iter);
346
347         walker = g_list_next(walker);
348     }
349
350     return TRUE;
351 }
352
353 static gint
354 if_info_compare(gconstpointer a, gconstpointer b)
355 {
356     gint comp = 0;
357     const if_info_t * if_a = (const if_info_t *)a;
358     const if_info_t * if_b = (const if_info_t *)b;
359
360     if ( (comp = g_strcmp0(if_a->name, if_b->name)) == 0 )
361         return g_strcmp0(if_a->friendly_name, if_b->friendly_name);
362
363     return comp;
364 }
365
366 static void
367 extcap_reload_interface_list(GList **retp, char **err_str) {
368     gchar *argv;
369
370     if (err_str != NULL)
371         *err_str = NULL;
372
373     /* ifaces is used as cache, do not destroy its contents when
374      * returning or no extcap interfaces can be queried for options */
375     if (ifaces == NULL)
376         ifaces = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, extcap_free_interface);
377     else
378         g_hash_table_remove_all(ifaces);
379
380     if (tools == NULL)
381         tools = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, extcap_free_info);
382     else
383         g_hash_table_remove_all(tools);
384
385     argv = g_strdup(EXTCAP_ARGUMENT_LIST_INTERFACES);
386
387     extcap_foreach(1, &argv, interfaces_cb, retp, err_str, NULL);
388
389     g_free(argv);
390 }
391
392 gchar *
393 extcap_get_help_for_ifname(const char *ifname)
394 {
395     extcap_interface * interface = (extcap_interface *)g_hash_table_lookup(ifaces, ifname);
396     return interface != NULL ? interface->help : NULL;
397 }
398
399 GHashTable *
400 extcap_tools_list(void) {
401     if ( tools == NULL || g_hash_table_size(tools) == 0 )
402         extcap_reload_interface_list(NULL, NULL);
403
404     return tools;
405 }
406
407 GList *
408 append_extcap_interface_list(GList *list, char **err_str) {
409     GList *ret = NULL;
410     GList *entry;
411     void *data;
412
413     /* Update the extcap interfaces and get a list of their if_infos */
414     extcap_reload_interface_list(&ret, err_str);
415
416     /* Sort that list */
417     ret = g_list_sort(ret, if_info_compare);
418
419     /* Append the interfaces in that list to the list we're handed. */
420     while (ret != NULL) {
421         entry = g_list_first(ret);
422         data = entry->data;
423         ret = g_list_delete_link(ret, entry);
424         list = g_list_append(list, data);
425     }
426     return list;
427 }
428
429 static void extcap_free_arg_elem(gpointer data, gpointer user_data _U_) {
430     extcap_free_arg((extcap_arg *) data);
431     g_free(data);
432 }
433
434 void extcap_register_preferences(void)
435 {
436     GList * interfaces = NULL;
437
438     module_t * dev_module = prefs_find_module("extcap");
439
440     if ( !dev_module )
441         return;
442
443     if ( ! ifaces || g_hash_table_size(ifaces) == 0 )
444         extcap_reload_interface_list(NULL, NULL);
445
446     interfaces = g_hash_table_get_keys(ifaces);
447
448     while ( interfaces ) {
449         extcap_get_if_configuration((gchar *)interfaces->data);
450
451         interfaces = g_list_next(interfaces);
452     }
453 }
454
455 void extcap_cleanup(void)
456 {
457     if (extcap_prefs_dynamic_vals) {
458         g_hash_table_destroy(extcap_prefs_dynamic_vals);
459     }
460 }
461
462 void extcap_pref_store(extcap_arg * arg, const char * newval)
463 {
464     if (arg && arg->storeval != NULL)
465     {
466         memset(arg->storeval, 0, EXTCAP_PREF_SIZE * sizeof(char));
467         if ( newval )
468             g_snprintf(arg->storeval, EXTCAP_PREF_SIZE, "%s", newval);
469     }
470
471 }
472
473 static gchar * extcap_prefs_dynamic_valptr(const char *name)
474 {
475     gchar *valp;
476     if (!extcap_prefs_dynamic_vals) {
477         /* Initialize table only as needed, most preferences are not dynamic */
478         extcap_prefs_dynamic_vals = g_hash_table_new_full(g_str_hash, g_str_equal,
479                 g_free, g_free);
480     }
481     valp = (gchar *)g_hash_table_lookup(extcap_prefs_dynamic_vals, name);
482     if (!valp) {
483         /* New dynamic pref, allocate, initialize and store. */
484         valp = g_new0(gchar, EXTCAP_PREF_SIZE);
485         g_hash_table_insert(extcap_prefs_dynamic_vals, g_strdup(name), valp);
486     }
487     return valp;
488 }
489
490 static void extcap_free_if_configuration(GList *list)
491 {
492     GList *elem, *sl;
493
494     for (elem = g_list_first(list); elem; elem = elem->next)
495     {
496         if (elem->data != NULL) {
497             /* g_list_free_full() only exists since 2.28. */
498             sl = g_list_first((GList *)elem->data);
499             g_list_foreach(sl, (GFunc)extcap_free_arg_elem, NULL);
500             g_list_free(sl);
501         }
502     }
503     g_list_free(list);
504 }
505
506 struct preference *
507 extcap_pref_for_argument(const gchar *ifname, struct _extcap_arg * arg) {
508     struct preference * pref = NULL;
509
510     GRegex * regex_name = g_regex_new ("[-]+", (GRegexCompileFlags) 0, (GRegexMatchFlags) 0, NULL );
511     GRegex * regex_ifname = g_regex_new ("(?![a-zA-Z1-9_]).", (GRegexCompileFlags) 0, (GRegexMatchFlags) 0, NULL );
512     if (regex_name && regex_ifname) {
513         if ( prefs_find_module("extcap") ) {
514             gchar * pref_name = g_regex_replace(regex_name, arg->call, strlen(arg->call), 0, "", (GRegexMatchFlags) 0, NULL );
515             gchar * ifname_underscore = g_regex_replace(regex_ifname, ifname, strlen(ifname), 0, "_", (GRegexMatchFlags) 0, NULL );
516             gchar * ifname_lowercase = g_ascii_strdown(ifname_underscore, -1);
517             gchar * pref_ifname = g_strconcat(ifname_lowercase, ".", pref_name, NULL);
518
519             pref = prefs_find_preference(prefs_find_module("extcap"), pref_ifname);
520
521             g_free(pref_name);
522             g_free(ifname_underscore);
523             g_free(ifname_lowercase);
524             g_free(pref_ifname);
525         }
526     }
527     if (regex_name) {
528         g_regex_unref(regex_name);
529     }
530     if (regex_ifname) {
531         g_regex_unref(regex_ifname);
532     }
533
534     return pref;
535 }
536
537 static gboolean search_cb(const gchar *extcap _U_, const gchar *ifname _U_, gchar *output, void *data,
538         char **err_str _U_) {
539     GList *arguments = NULL;
540     GList **il = (GList **) data;
541     module_t * dev_module = NULL;
542
543     arguments = extcap_parse_args(output);
544
545     dev_module = prefs_find_module("extcap");
546
547     if ( dev_module ) {
548         GList * walker = arguments;
549
550         GRegex * regex_name = g_regex_new ("[-]+", (GRegexCompileFlags) 0, (GRegexMatchFlags) 0, NULL );
551         GRegex * regex_ifname = g_regex_new ("(?![a-zA-Z1-9_]).", (GRegexCompileFlags) 0, (GRegexMatchFlags) 0, NULL );
552         if (regex_name && regex_ifname) {
553             while ( walker != NULL ) {
554                 extcap_arg * arg = (extcap_arg *)walker->data;
555                 arg->device_name = g_strdup(ifname);
556
557                 if ( arg->save ) {
558                     struct preference * pref = NULL;
559
560                     gchar * pref_name = g_regex_replace(regex_name, arg->call, strlen(arg->call), 0, "", (GRegexMatchFlags) 0, NULL );
561                     gchar * ifname_underscore = g_regex_replace(regex_ifname, ifname, strlen(ifname), 0, "_", (GRegexMatchFlags) 0, NULL );
562                     gchar * ifname_lowercase = g_ascii_strdown(ifname_underscore, -1);
563                     gchar * pref_ifname = g_strconcat(ifname_lowercase, ".", pref_name, NULL);
564
565                     if ( ( pref = prefs_find_preference(dev_module, pref_ifname) ) == NULL ) {
566                         /* Set an initial value */
567                         if ( ! arg->storeval && arg->default_complex )
568                         {
569                             arg->storeval = extcap_prefs_dynamic_valptr(pref_ifname);
570                             g_snprintf(arg->storeval, EXTCAP_PREF_SIZE, "%s", arg->default_complex->_val);
571                         }
572
573                         prefs_register_string_preference(dev_module, g_strdup(pref_ifname),
574                                 arg->display, arg->display, (const gchar **)&(arg->storeval));
575                     } else {
576                         /* Been here before, restore stored value */
577                         if (! arg->storeval && pref->varp.string)
578                         {
579                             arg->storeval = extcap_prefs_dynamic_valptr(pref_ifname);
580                             g_snprintf(arg->storeval, EXTCAP_PREF_SIZE, "%s", *(pref->varp.string));
581                         }
582                     }
583
584                     g_free(pref_name);
585                     g_free(ifname_underscore);
586                     g_free(ifname_lowercase);
587                     g_free(pref_ifname);
588                 }
589
590                 walker = g_list_next(walker);
591             }
592         }
593         if (regex_name) {
594             g_regex_unref(regex_name);
595         }
596         if (regex_ifname) {
597             g_regex_unref(regex_ifname);
598         }
599     }
600
601     *il = g_list_append(*il, arguments);
602
603     /* By returning false, extcap_foreach will break on first found */
604     return TRUE;
605 }
606
607 GList *
608 extcap_get_if_configuration(const char * ifname) {
609     gchar *argv[3];
610     GList *ret = NULL;
611     gchar **err_str = NULL;
612     int i;
613
614     if ( extcap_if_exists(ifname) )
615     {
616         g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "Extcap path %s",
617                 get_extcap_dir());
618
619         argv[0] = g_strdup(EXTCAP_ARGUMENT_CONFIG);
620         argv[1] = g_strdup(EXTCAP_ARGUMENT_INTERFACE);
621         argv[2] = g_strdup(ifname);
622
623         extcap_foreach(3, argv, search_cb, &ret, err_str, ifname);
624
625         for (i = 0; i < 3; i++)
626             g_free(argv[i]);
627     }
628
629     return ret;
630 }
631
632 gboolean
633 extcap_has_configuration(const char * ifname, gboolean is_required) {
634     GList * arguments = 0;
635     GList * walker = 0, * item = 0;
636
637     gboolean found = FALSE;
638
639     arguments = extcap_get_if_configuration((const char *)( ifname ) );
640     walker = g_list_first(arguments);
641
642     while ( walker != NULL && ! found ) {
643         item = g_list_first((GList *)(walker->data));
644         while ( item != NULL && ! found ) {
645             if ( (extcap_arg *)(item->data) != NULL ) {
646                 extcap_arg * arg = (extcap_arg *)(item->data);
647                 /* Should required options be present, or any kind of options */
648                 if ( ! is_required )
649                     found = TRUE;
650                 else if ( arg->is_required ) {
651                     gchar * stored = NULL;
652                     gchar * defval = NULL;
653
654                     if ( arg->storeval != NULL )
655                         stored = arg->storeval;
656
657                     if ( arg->default_complex != NULL && arg->default_complex->_val != NULL )
658                         defval = arg->default_complex->_val;
659
660                     if ( arg->is_required ) {
661                         /* If stored and defval is identical and the argument is required,
662                          * configuration is needed */
663                         if ( defval && stored && g_strcmp0(stored, defval) == 0 )
664                             found = TRUE;
665                         else if ( ! defval && (!stored || strlen(g_strchomp(stored)) <= (size_t)0) )
666                             found = TRUE;
667                     }
668
669                     if ( arg->arg_type == EXTCAP_ARG_FILESELECT ) {
670                         if ( arg->fileexists && ! ( file_exists(defval) || file_exists(stored) ) )
671                             found = TRUE;
672                     }
673                 }
674             }
675
676             item = item->next;
677         }
678         walker = walker->next;
679     }
680     extcap_free_if_configuration(arguments);
681
682     return found;
683 }
684
685 /* taken from capchild/capture_sync.c */
686 static gboolean pipe_data_available(int pipe_fd) {
687 #ifdef _WIN32 /* PeekNamedPipe */
688     HANDLE hPipe = (HANDLE) _get_osfhandle(pipe_fd);
689     DWORD bytes_avail;
690
691     if (hPipe == INVALID_HANDLE_VALUE)
692         return FALSE;
693
694     if (! PeekNamedPipe(hPipe, NULL, 0, NULL, &bytes_avail, NULL))
695         return FALSE;
696
697     if (bytes_avail > 0)
698         return TRUE;
699     return FALSE;
700 #else /* select */
701     fd_set rfds;
702     struct timeval timeout;
703
704     FD_ZERO(&rfds);
705     FD_SET(pipe_fd, &rfds);
706     timeout.tv_sec = 0;
707     timeout.tv_usec = 0;
708
709     if (select(pipe_fd+1, &rfds, NULL, NULL, &timeout) > 0)
710         return TRUE;
711
712     return FALSE;
713 #endif
714 }
715
716 void extcap_if_cleanup(capture_options * capture_opts, gchar ** errormsg) {
717     interface_options interface_opts;
718     extcap_userdata * userdata;
719     guint icnt = 0;
720     gboolean overwrite_exitcode;
721     gchar * buffer;
722 #define STDERR_BUFFER_SIZE 1024
723
724     for (icnt = 0; icnt < capture_opts->ifaces->len; icnt++) {
725         interface_opts = g_array_index(capture_opts->ifaces, interface_options,
726                 icnt);
727
728         /* skip native interfaces */
729         if (interface_opts.if_type != IF_EXTCAP)
730             continue;
731
732         overwrite_exitcode = FALSE;
733
734         g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG,
735                 "Extcap [%s] - Cleaning up fifo: %s; PID: %d", interface_opts.name,
736                 interface_opts.extcap_fifo, interface_opts.extcap_pid);
737 #ifdef _WIN32
738         if (pipe_h)
739         {
740             g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG,
741                 "Extcap [%s] - Closing pipe", interface_opts.name);
742             FlushFileBuffers(pipe_h);
743             DisconnectNamedPipe(pipe_h);
744             CloseHandle(pipe_h);
745         }
746 #else
747         if (interface_opts.extcap_fifo != NULL && file_exists(interface_opts.extcap_fifo))
748         {
749             /* the fifo will not be freed here, but with the other capture_opts in capture_sync */
750             ws_unlink(interface_opts.extcap_fifo);
751             interface_opts.extcap_fifo = NULL;
752         }
753 #endif
754         /* Maybe the client closed and removed fifo, but ws should check if
755          * pid should be closed */
756         g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG,
757                 "Extcap [%s] - Closing spawned PID: %d", interface_opts.name,
758                 interface_opts.extcap_pid);
759
760         userdata = (extcap_userdata *) interface_opts.extcap_userdata;
761         if ( userdata )
762         {
763             if (userdata->extcap_stderr_rd > 0 && pipe_data_available(userdata->extcap_stderr_rd) )
764             {
765                 buffer = (gchar * )g_malloc0(sizeof(gchar) * STDERR_BUFFER_SIZE + 1);
766 #ifdef _WIN32
767                 win32_readfrompipe((HANDLE)_get_osfhandle(userdata->extcap_stderr_rd), STDERR_BUFFER_SIZE, buffer);
768 #else
769                 if (read(userdata->extcap_stderr_rd, buffer, sizeof(gchar) * STDERR_BUFFER_SIZE) <= 0 )
770                     buffer[0] = '\0';
771 #endif
772                 if ( strlen ( buffer) > 0 )
773                 {
774                     userdata->extcap_stderr = g_strdup_printf("%s", buffer);
775                     userdata->exitcode = 1;
776                 }
777                 g_free(buffer);
778             }
779
780 #ifndef _WIN32
781             /* Final child watch may not have been called */
782             if ( interface_opts.extcap_child_watch != 0 )
783             {
784                 extcap_child_watch_cb(userdata->pid, 0, capture_opts);
785                 /* it will have changed in extcap_child_watch_cb */
786                 interface_opts = g_array_index(capture_opts->ifaces, interface_options,
787                                 icnt);
788             }
789 #endif
790
791             if ( userdata->extcap_stderr != NULL )
792                 overwrite_exitcode = TRUE;
793
794             if ( overwrite_exitcode || userdata->exitcode != 0 )
795             {
796                 if ( userdata->extcap_stderr != 0 )
797                 {
798                     if ( *errormsg == NULL )
799                         *errormsg = g_strdup_printf("Error by extcap pipe: %s", userdata->extcap_stderr);
800                     else
801                     {
802                         gchar * temp = g_strconcat ( *errormsg, "\nError by extcap pipe: " ,userdata->extcap_stderr, NULL );
803                         g_free(*errormsg);
804                         *errormsg = temp;
805                     }
806                     g_free (userdata->extcap_stderr );
807                 }
808
809                 userdata->extcap_stderr = NULL;
810                 userdata->exitcode = 0;
811             }
812         }
813
814         if (interface_opts.extcap_child_watch > 0)
815         {
816             g_source_remove(interface_opts.extcap_child_watch);
817             interface_opts.extcap_child_watch = 0;
818         }
819
820         if (interface_opts.extcap_pid != INVALID_EXTCAP_PID)
821         {
822 #ifdef _WIN32
823             TerminateProcess(interface_opts.extcap_pid, 0);
824 #endif
825             g_spawn_close_pid(interface_opts.extcap_pid);
826             interface_opts.extcap_pid = INVALID_EXTCAP_PID;
827
828             g_free(interface_opts.extcap_userdata);
829             interface_opts.extcap_userdata = NULL;
830         }
831
832         /* Make sure modified interface_opts is saved in capture_opts. */
833         capture_opts->ifaces = g_array_remove_index(capture_opts->ifaces, icnt);
834         g_array_insert_val(capture_opts->ifaces, icnt, interface_opts);
835     }
836 }
837
838 static gboolean
839 extcap_add_arg_and_remove_cb(gpointer key, gpointer value, gpointer data) {
840     GPtrArray *args = (GPtrArray *)data;
841
842     if ( key != NULL )
843     {
844         g_ptr_array_add(args, g_strdup((const gchar*)key));
845
846         if ( value != NULL )
847             g_ptr_array_add(args, g_strdup((const gchar*)value));
848
849         return TRUE;
850     }
851
852     return FALSE;
853 }
854
855 void extcap_child_watch_cb(GPid pid, gint status, gpointer user_data)
856 {
857     guint i;
858     interface_options interface_opts;
859     extcap_userdata * userdata = NULL;
860     capture_options * capture_opts = (capture_options *)(user_data);
861
862     if ( capture_opts == NULL || capture_opts->ifaces == NULL || capture_opts->ifaces->len == 0 )
863         return;
864
865     /* Close handle to child process. */
866     g_spawn_close_pid(pid);
867
868     /* Update extcap_pid in interface options structure. */
869     for (i = 0; i < capture_opts->ifaces->len; i++)
870     {
871         interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
872         if (interface_opts.extcap_pid == pid)
873         {
874             userdata = (extcap_userdata *)interface_opts.extcap_userdata;
875             if ( userdata != NULL )
876             {
877                 interface_opts.extcap_pid = INVALID_EXTCAP_PID;
878                 userdata->exitcode = 0;
879 #ifndef _WIN32
880                 if ( WIFEXITED(status) )
881                 {
882                     if ( WEXITSTATUS(status) != 0 )
883                         userdata->exitcode = WEXITSTATUS(status);
884                 }
885                 else
886                     userdata->exitcode = G_SPAWN_ERROR_FAILED;
887 #else
888                 if (status != 0)
889                     userdata->exitcode = status;
890 #endif
891                 if ( status == 0 && userdata->extcap_stderr != NULL )
892                     userdata->exitcode = 1;
893             }
894             g_source_remove(interface_opts.extcap_child_watch);
895             interface_opts.extcap_child_watch = 0;
896
897             capture_opts->ifaces = g_array_remove_index(capture_opts->ifaces, i);
898             g_array_insert_val(capture_opts->ifaces, i, interface_opts);
899             break;
900         }
901     }
902 }
903
904 static
905 GPtrArray * extcap_prepare_arguments(interface_options interface_opts)
906 {
907     GPtrArray *result = NULL;
908
909     if (interface_opts.if_type == IF_EXTCAP )
910     {
911         result = g_ptr_array_new();
912
913 #define add_arg(X) g_ptr_array_add(result, g_strdup(X))
914
915         add_arg(interface_opts.extcap);
916         add_arg(EXTCAP_ARGUMENT_RUN_CAPTURE);
917         add_arg(EXTCAP_ARGUMENT_INTERFACE);
918         add_arg(interface_opts.name);
919         if (interface_opts.cfilter && strlen(interface_opts.cfilter) > 0) {
920             add_arg(EXTCAP_ARGUMENT_CAPTURE_FILTER);
921             add_arg(interface_opts.cfilter);
922         }
923         add_arg(EXTCAP_ARGUMENT_RUN_PIPE);
924         add_arg(interface_opts.extcap_fifo);
925         if (interface_opts.extcap_args == NULL || g_hash_table_size(interface_opts.extcap_args) == 0)
926         {
927             /* User did not perform interface configuration.
928              *
929              * Check if there are any boolean flags that are set by default
930              * and hence their argument should be added.
931              */
932             GList *arglist;
933             GList *elem;
934
935             arglist = extcap_get_if_configuration(interface_opts.name);
936             for (elem = g_list_first(arglist); elem; elem = elem->next)
937             {
938                 GList * arg_list;
939                 extcap_arg *arg_iter;
940
941                 if (elem->data == NULL)
942                 {
943                     continue;
944                 }
945
946                 arg_list = g_list_first((GList *)elem->data);
947                 while (arg_list != NULL) {
948                     gchar * stored = NULL, * defval = NULL;
949                     /* In case of boolflags only first element in arg_list is relevant. */
950                     arg_iter = (extcap_arg*) (arg_list->data);
951                     if ( arg_iter->storeval != NULL )
952                         stored = arg_iter->storeval;
953
954                     if ( arg_iter->default_complex != NULL && arg_iter->default_complex->_val != NULL )
955                         defval = arg_iter->default_complex->_val;
956
957                     /* Different data in storage then set for default */
958                     if ( g_strcmp0(stored, defval) != 0 ) {
959                         if ( arg_iter->arg_type == EXTCAP_ARG_BOOLFLAG ) {
960                             if ( g_strcmp0(stored, "true") == 0 )
961                                 add_arg(arg_iter->call);
962                         } else {
963                             gchar * call = g_strconcat(arg_iter->call, " ", stored, NULL);
964                             add_arg(call);
965                             g_free(call);
966                         }
967                     } else if  (arg_iter->arg_type == EXTCAP_ARG_BOOLFLAG) {
968                         if (extcap_complex_get_bool(arg_iter->default_complex))
969                             add_arg(arg_iter->call);
970                     }
971
972                     arg_list = arg_list->next;
973                 }
974             }
975
976             extcap_free_if_configuration(arglist);
977         }
978         else
979         {
980             g_hash_table_foreach_remove(interface_opts.extcap_args, extcap_add_arg_and_remove_cb, result);
981         }
982         add_arg(NULL);
983 #undef add_arg
984
985     }
986
987     return result;
988 }
989
990 /* call mkfifo for each extcap,
991  * returns FALSE if there's an error creating a FIFO */
992 gboolean
993 extcap_init_interfaces(capture_options *capture_opts)
994 {
995     guint i;
996     interface_options interface_opts;
997     extcap_userdata * userdata;
998
999     for (i = 0; i < capture_opts->ifaces->len; i++)
1000     {
1001         GPtrArray *args = NULL;
1002         GPid pid = INVALID_EXTCAP_PID;
1003
1004         interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
1005
1006         /* skip native interfaces */
1007         if (interface_opts.if_type != IF_EXTCAP )
1008             continue;
1009
1010         /* create pipe for fifo */
1011         if ( ! extcap_create_pipe ( &interface_opts.extcap_fifo ) )
1012             return FALSE;
1013
1014         /* Create extcap call */
1015         args = extcap_prepare_arguments(interface_opts);
1016
1017         userdata = g_new0(extcap_userdata, 1);
1018
1019         pid = extcap_spawn_async(userdata, args );
1020
1021         g_ptr_array_foreach(args, (GFunc)g_free, NULL);
1022         g_ptr_array_free(args, TRUE);
1023
1024         if ( pid == INVALID_EXTCAP_PID )
1025         {
1026             g_free(userdata);
1027             continue;
1028         }
1029
1030         interface_opts.extcap_pid = pid;
1031
1032         interface_opts.extcap_child_watch =
1033             g_child_watch_add(pid, extcap_child_watch_cb, (gpointer)capture_opts);
1034
1035 #ifdef _WIN32
1036         /* On Windows, wait for extcap to connect to named pipe.
1037          * Some extcaps will present UAC screen to user.
1038          * 30 second timeout should be reasonable timeout for extcap to
1039          * connect to named pipe (including user interaction).
1040          * Wait on multiple object in case of extcap termination
1041          * without opening pipe.
1042          *
1043          * Minimum supported version of Windows: XP / Server 2003.
1044          */
1045         if (pid != INVALID_EXTCAP_PID)
1046         {
1047             extcap_wait_for_pipe(pipe_h, pid);
1048         }
1049
1050 #endif
1051
1052         interface_opts.extcap_userdata = (gpointer) userdata;
1053
1054         capture_opts->ifaces = g_array_remove_index(capture_opts->ifaces, i);
1055         g_array_insert_val(capture_opts->ifaces, i, interface_opts);
1056     }
1057
1058     return TRUE;
1059 }
1060
1061 #ifdef _WIN32
1062 /* called by capture_sync to get the CreatNamedPipe handle*/
1063 HANDLE
1064 extcap_get_win32_handle()
1065 {
1066     return pipe_h;
1067 }
1068 #endif
1069
1070 gboolean extcap_create_pipe(char ** fifo)
1071 {
1072 #ifdef _WIN32
1073     gchar timestr[ 14+1 ];
1074     time_t current_time;
1075
1076     gchar *pipename = NULL;
1077
1078     SECURITY_ATTRIBUTES security;
1079     /* create pipename */
1080     current_time = time(NULL);
1081     strftime(timestr, sizeof(timestr), "%Y%m%d%H%M%S", localtime(&current_time));
1082     pipename = g_strconcat ( "\\\\.\\pipe\\", EXTCAP_PIPE_PREFIX, "_", timestr, NULL );
1083
1084     /* Security struct to enable Inheritable HANDLE */
1085     memset(&security, 0, sizeof(SECURITY_ATTRIBUTES));
1086     security.nLength = sizeof(SECURITY_ATTRIBUTES);
1087     security.bInheritHandle = TRUE;
1088     security.lpSecurityDescriptor = NULL;
1089
1090     /* create a namedPipe*/
1091     pipe_h = CreateNamedPipe(
1092                 utf_8to16(pipename),
1093                 PIPE_ACCESS_DUPLEX | FILE_FLAG_OVERLAPPED,
1094                 PIPE_TYPE_MESSAGE| PIPE_READMODE_MESSAGE | PIPE_WAIT,
1095                 5, 65536, 65536,
1096                 300,
1097                 &security);
1098
1099     if (pipe_h == INVALID_HANDLE_VALUE)
1100     {
1101         g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG,"\nError creating pipe => (%d)", GetLastError());
1102         return FALSE;
1103     }
1104     else
1105     {
1106         g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG,"\nWireshark Created pipe =>(%s)",pipename);
1107         *fifo = g_strdup(pipename);
1108     }
1109 #else
1110     gchar *temp_name = NULL;
1111     int fd = 0;
1112
1113     if ((fd = create_tempfile(&temp_name, EXTCAP_PIPE_PREFIX, NULL)) < 0 )
1114         return FALSE;
1115
1116     ws_close(fd);
1117
1118     g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG,
1119             "Extcap - Creating fifo: %s", temp_name);
1120
1121     if ( file_exists(temp_name) )
1122         ws_unlink(temp_name);
1123
1124     if (mkfifo(temp_name, 0600) == 0)
1125         *fifo = g_strdup(temp_name);
1126 #endif
1127
1128     return TRUE;
1129 }
1130
1131 /*
1132  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
1133  *
1134  * Local variables:
1135  * c-basic-offset: 4
1136  * tab-width: 8
1137  * indent-tabs-mode: nil
1138  * End:
1139  *
1140  * vi: set shiftwidth=4 tabstop=8 expandtab:
1141  * :indentSize=4:tabSize=8:noTabs=true:
1142  */