RPKI RTR: Add support draft-ietf-sidr-rpki-rtr-rfc6810-bis-01
[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 #include <glib.h>
41 #include <log.h>
42
43 #include <wsutil/file_util.h>
44 #include <wsutil/filesystem.h>
45 #include <wsutil/tempfile.h>
46
47 #include "capture_opts.h"
48
49 #ifdef HAVE_EXTCAP
50
51 #include "extcap.h"
52 #include "extcap_parser.h"
53
54 #ifdef _WIN32
55 static HANDLE pipe_h = NULL;
56 #endif
57
58 /* internal container, for all the extcap interfaces that have been found.
59  * will be resetted by every call to extcap_interface_list() and is being
60  * used in extcap_get_if_* as well as extcaps_init_initerfaces to ensure,
61  * that only extcap interfaces are being given to underlying extcap programs
62  */
63 static GHashTable *ifaces = NULL;
64
65 /* Prefix for the pipe interfaces */
66 #define EXTCAP_PIPE_PREFIX "wireshark_extcap"
67
68 /* Callback definition for extcap_foreach */
69 typedef gboolean (*extcap_cb_t)(const gchar *extcap, gchar *output, void *data,
70                 gchar **err_str);
71
72 /* #define ARG_DEBUG */
73 #if ARG_DEBUG
74 static void extcap_debug_arguments ( extcap_arg *arg_iter );
75 #endif
76
77 static gboolean
78 extcap_if_exists(const char *ifname)
79 {
80         if ( ifname != NULL )
81         {
82                 if ( ifaces != NULL )
83                 {
84                         if ( g_hash_table_size(ifaces) > 0 )
85                         {
86                                 if ( g_hash_table_lookup(ifaces, (const gchar *)ifname) != NULL )
87                                 {
88                                         return TRUE;
89                                 }
90                         }
91                 }
92         }
93         return FALSE;
94 }
95
96 static gboolean
97 extcap_if_exists_for_extcap(const char *ifname, const char *extcap)
98 {
99         gchar * entry = NULL;
100
101         if ( extcap_if_exists(ifname) )
102         {
103                 if ( ( entry = (gchar *)g_hash_table_lookup(ifaces, (const gchar *)ifname) ) != NULL )
104                 {
105                         if ( strcmp(entry, extcap) == 0 )
106                                 return TRUE;
107                 }
108         }
109
110         return FALSE;
111 }
112
113 static gchar *
114 extcap_if_executable(const char *ifname)
115 {
116         if ( extcap_if_exists(ifname) )
117                 return (gchar *)g_hash_table_lookup(ifaces, (const gchar *)ifname);
118
119         return (gchar *)NULL;
120 }
121
122 static void
123 extcap_if_cleanup(void)
124 {
125         if ( ifaces == NULL )
126                 ifaces = g_hash_table_new(g_str_hash, g_str_equal);
127
128         g_hash_table_remove_all(ifaces);
129 }
130
131 static void
132 extcap_if_add(gchar *ifname, gchar *extcap)
133 {
134         if ( g_hash_table_lookup(ifaces, ifname) == NULL )
135                 g_hash_table_insert(ifaces, ifname, extcap);
136 }
137
138 static void extcap_foreach(gint argc, gchar **args, extcap_cb_t cb,
139                 void *cb_data, char **err_str, const char * ifname _U_) {
140         const char *dirname = get_extcap_dir();
141         GDir *dir;
142         const gchar *file;
143         gboolean keep_going;
144         gchar **argv;
145
146         keep_going = TRUE;
147
148         argv = (gchar **) g_malloc0(sizeof(gchar *) * (argc + 2));
149
150         if ((dir = g_dir_open(dirname, 0, NULL)) != NULL) {
151 #ifdef WIN32
152                 dirname = g_strescape(dirname,NULL);
153 #endif
154                 while (keep_going && (file = g_dir_read_name(dir)) != NULL ) {
155                         GString *extcap_string = NULL;
156                         gchar *extcap = NULL;
157                         gchar *command_output = NULL;
158                         gboolean status = FALSE;
159                         gint i;
160                         gint exit_status = 0;
161                         GError *error = NULL;
162
163                         /* full path to extcap binary */
164                         extcap_string = g_string_new("");
165 #ifdef WIN32
166                         g_string_printf(extcap_string, "%s\\\\%s",dirname,file);
167                         extcap = g_string_free(extcap_string, FALSE);
168 #else
169                         g_string_printf(extcap_string, "%s/%s", dirname, file);
170                         extcap = g_string_free(extcap_string, FALSE);
171 #endif
172                         if ( extcap_if_exists(ifname) && !extcap_if_exists_for_extcap(ifname, extcap ) )
173                                 continue;
174
175                         argv[0] = extcap;
176                         for (i = 0; i < argc; ++i)
177                                 argv[i+1] = args[i];
178                         argv[argc+1] = NULL;
179
180                         status = g_spawn_sync(dirname, argv, NULL,
181                                 (GSpawnFlags) 0, NULL, NULL,
182                                         &command_output, NULL, &exit_status, &error);
183
184                         if (status && exit_status == 0)
185                         keep_going = cb(extcap, command_output, cb_data, err_str);
186
187                         g_free(extcap);
188                         g_free(command_output);
189                 }
190
191                 g_dir_close(dir);
192         }
193
194         g_free(argv);
195 }
196
197 static gboolean dlt_cb(const gchar *extcap _U_, gchar *output, void *data,
198                 char **err_str) {
199         extcap_token_sentence *tokens;
200         extcap_dlt *dlts, *dlt_iter, *next;
201         if_capabilities_t *caps;
202         GList *linktype_list = NULL;
203         data_link_info_t *data_link_info;
204
205         tokens = extcap_tokenize_sentences(output);
206         extcap_parse_dlts(tokens, &dlts);
207
208         extcap_free_tokenized_sentence_list(tokens);
209
210         g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "Extcap pipe %s ", extcap);
211
212         /*
213          * Allocate the interface capabilities structure.
214          */
215         caps = (if_capabilities_t *) g_malloc(sizeof *caps);
216         caps->can_set_rfmon = FALSE;
217
218         dlt_iter = dlts;
219         while (dlt_iter != NULL ) {
220                 g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG,
221                                 "  DLT %d name=\"%s\" display=\"%s\" ", dlt_iter->number,
222                                 dlt_iter->name, dlt_iter->display);
223
224                 data_link_info = g_new(data_link_info_t, 1);
225                 data_link_info->dlt = dlt_iter->number;
226                 data_link_info->name = g_strdup(dlt_iter->name);
227                 data_link_info->description = g_strdup(dlt_iter->display);
228                 linktype_list = g_list_append(linktype_list, data_link_info);
229                 dlt_iter = dlt_iter->next_dlt;
230         }
231
232         /* Check to see if we built a list */
233         if (linktype_list != NULL && data != NULL) {
234                 caps->data_link_types = linktype_list;
235                 *(if_capabilities_t **) data = caps;
236         } else {
237                 if (err_str) {
238                         g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "  returned no DLTs");
239                         *err_str = g_strdup("Extcap returned no DLTs");
240                 }
241                 g_free(caps);
242         }
243
244         dlt_iter = dlts;
245         while (dlt_iter != NULL ) {
246                 next = dlt_iter->next_dlt;
247                 extcap_free_dlt(dlt_iter);
248                 dlt_iter = next;
249         }
250
251         return FALSE;
252 }
253
254 if_capabilities_t *
255 extcap_get_if_dlts(const gchar *ifname, char **err_str) {
256         gchar *argv[3];
257         gint i;
258         if_capabilities_t *caps = NULL;
259
260         g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "  returned no DLTs");
261
262         if (ifname != NULL && err_str != NULL)
263                 *err_str = NULL;
264
265         if ( extcap_if_exists(ifname) )
266         {
267                 argv[0] = g_strdup(EXTCAP_ARGUMENT_LIST_DLTS);
268                 argv[1] = g_strdup(EXTCAP_ARGUMENT_INTERFACE);
269                 argv[2] = g_strdup(ifname);
270
271                 if (err_str)
272                         *err_str = NULL;
273                 extcap_foreach(3, argv, dlt_cb, &caps, err_str, ifname);
274
275                 for (i = 0; i < 3; ++i)
276                         g_free(argv[i]);
277         }
278
279         return caps;
280 }
281
282 static gboolean interfaces_cb(const gchar *extcap, gchar *output, void *data,
283                 char **err_str _U_) {
284         GList **il = (GList **) data;
285         extcap_token_sentence *tokens;
286         extcap_interface *interfaces, *int_iter; /*, *next; */
287         if_info_t *if_info;
288
289         tokens = extcap_tokenize_sentences(output);
290         extcap_parse_interfaces(tokens, &interfaces);
291
292         extcap_free_tokenized_sentence_list(tokens);
293
294         g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "Extcap pipe %s ", extcap);
295
296         int_iter = interfaces;
297         while (int_iter != NULL ) {
298                 if ( extcap_if_exists(int_iter->call) )
299                 {
300                         g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_WARNING, "Extcap interface \"%s\" is already provided by \"%s\" ",
301                                         int_iter->call, (gchar *)extcap_if_executable(int_iter->call) );
302                         int_iter = int_iter->next_interface;
303                         continue;
304                 }
305
306                 g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "  Interface [%s] \"%s\" ",
307                                 int_iter->call, int_iter->display);
308
309                 if_info = g_new0(if_info_t, 1);
310                 if_info->name = g_strdup(int_iter->call);
311                 if_info->friendly_name = g_strdup(int_iter->display);
312
313                 if_info->type = IF_EXTCAP;
314
315                 if_info->extcap = g_strdup(extcap);
316                 *il = g_list_append(*il, if_info);
317
318                 extcap_if_add(g_strdup(int_iter->call), g_strdup(extcap) );
319                 int_iter = int_iter->next_interface;
320         }
321
322         return TRUE;
323 }
324
325 GList *
326 extcap_interface_list(char **err_str) {
327         gchar *argv;
328         /* gint i; */
329         GList *ret = NULL;
330
331         if (err_str != NULL)
332         *err_str = NULL;
333
334         extcap_if_cleanup();
335
336         argv = g_strdup(EXTCAP_ARGUMENT_LIST_INTERFACES);
337
338         if (err_str)
339         *err_str = NULL;
340         extcap_foreach(1, &argv, interfaces_cb, &ret, err_str, NULL);
341
342         g_free(argv);
343
344         return ret;
345 }
346
347 static gboolean search_cb(const gchar *extcap _U_, gchar *output, void *data,
348                 char **err_str _U_) {
349         extcap_token_sentence *tokens = NULL;
350         GList *arguments = NULL;
351         GList **il = (GList **) data;
352
353         tokens = extcap_tokenize_sentences(output);
354         arguments = extcap_parse_args(tokens);
355
356         extcap_free_tokenized_sentence_list(tokens);
357
358 #if ARG_DEBUG
359         extcap_debug_arguments ( arguments );
360 #endif
361
362         *il = g_list_append(*il, arguments);
363
364         /* By returning false, extcap_foreach will break on first found */
365         return TRUE;
366 }
367
368 GList *
369 extcap_get_if_configuration(const char * ifname) {
370         gchar *argv[4];
371         GList *ret = NULL;
372         gchar **err_str = NULL;
373
374         if ( extcap_if_exists(ifname) )
375         {
376                 g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG, "Extcap path %s",
377                                 get_extcap_dir());
378
379                 if (err_str != NULL)
380                 *err_str = NULL;
381
382                 argv[0] = g_strdup(EXTCAP_ARGUMENT_CONFIG);
383                 argv[1] = g_strdup(EXTCAP_ARGUMENT_INTERFACE);
384                 argv[2] = g_strdup(ifname);
385                 argv[3] = NULL;
386
387                 extcap_foreach(4, argv, search_cb, &ret, err_str, ifname);
388         }
389
390         return ret;
391 }
392
393 void extcap_cleanup(capture_options * capture_opts) {
394         interface_options interface_opts;
395         guint icnt = 0;
396
397         for (icnt = 0; icnt < capture_opts->ifaces->len; icnt++) {
398                 interface_opts = g_array_index(capture_opts->ifaces, interface_options,
399                                 icnt);
400
401                 /* skip native interfaces */
402                 if (interface_opts.if_type != IF_EXTCAP)
403                 continue;
404
405                 g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG,
406                                 "Extcap [%s] - Cleaning up fifo: %s; PID: %d", interface_opts.name,
407                                 interface_opts.extcap_fifo, interface_opts.extcap_pid);
408 #ifdef WIN32
409                 if (pipe_h)
410                 {
411                         g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG,
412                                 "Extcap [%s] - Closing pipe", interface_opts.name);
413                         FlushFileBuffers(pipe_h);
414                         DisconnectNamedPipe(pipe_h);
415                         CloseHandle(pipe_h);
416                 }
417 #else
418                 if (interface_opts.extcap_fifo != NULL && file_exists(interface_opts.extcap_fifo))
419                 {
420                         /* the fifo will not be freed here, but with the other capture_opts in capture_sync */
421                         ws_unlink(interface_opts.extcap_fifo);
422                         interface_opts.extcap_fifo = NULL;
423                 }
424 #endif
425                 /* Maybe the client closed and removed fifo, but ws should check if
426                  * pid should be closed */
427                 g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG,
428                                 "Extcap [%s] - Closing spawned PID: %d", interface_opts.name,
429                                 interface_opts.extcap_pid);
430
431                 if (interface_opts.extcap_pid != (GPid)-1 )
432                 {
433                         g_spawn_close_pid(interface_opts.extcap_pid);
434                         interface_opts.extcap_pid = (GPid)-1;
435                 }
436         }
437 }
438
439 static void
440 extcap_arg_cb(gpointer key, gpointer value, gpointer data) {
441         GPtrArray *args = (GPtrArray *)data;
442
443         if ( key != NULL )
444         {
445                 g_ptr_array_add(args, key);
446
447                 if ( value != NULL )
448                         g_ptr_array_add(args, value);
449         }
450 }
451
452 /* call mkfifo for each extcap,
453  * returns FALSE if there's an error creating a FIFO */
454 gboolean
455 extcaps_init_initerfaces(capture_options *capture_opts)
456 {
457         guint i;
458         interface_options interface_opts;
459
460         for (i = 0; i < capture_opts->ifaces->len; i++)
461         {
462                 GPtrArray *args = NULL;
463                 GPid pid = 0;
464
465                 interface_opts = g_array_index(capture_opts->ifaces, interface_options, i);
466
467                 /* skip native interfaces */
468                 if (interface_opts.if_type != IF_EXTCAP )
469                         continue;
470
471                 /* create pipe for fifo */
472                 if ( ! extcap_create_pipe ( &interface_opts.extcap_fifo ) )
473                         return FALSE;
474
475                 /* Create extcap call */
476                 args = g_ptr_array_new();
477 #define add_arg(X) g_ptr_array_add(args, g_strdup(X))
478
479                 add_arg(interface_opts.extcap);
480                 add_arg(EXTCAP_ARGUMENT_RUN_CAPTURE);
481                 add_arg(EXTCAP_ARGUMENT_INTERFACE);
482                 add_arg(interface_opts.name);
483                 add_arg(EXTCAP_ARGUMENT_RUN_PIPE);
484                 add_arg(interface_opts.extcap_fifo);
485                 if (interface_opts.extcap_args != NULL)
486                         g_hash_table_foreach(interface_opts.extcap_args, extcap_arg_cb, args);
487                 add_arg(NULL);
488 #undef add_arg
489
490                 /* Wireshark for windows crashes here sometimes *
491                  * Access violation reading location 0x...      */
492                 g_spawn_async(NULL, (gchar **)args->pdata, NULL,
493                                         (GSpawnFlags) 0, NULL, NULL,
494                                         &pid,NULL);
495
496                 g_ptr_array_foreach(args, (GFunc)g_free, NULL);
497                 g_ptr_array_free(args, TRUE);
498                 interface_opts.extcap_pid = pid;
499                 capture_opts->ifaces = g_array_remove_index(capture_opts->ifaces, i);
500                 g_array_insert_val(capture_opts->ifaces, i, interface_opts);
501         }
502
503         return TRUE;
504 }
505
506 #ifdef WIN32
507 /* called by capture_sync to get the CreatNamedPipe handle*/
508 HANDLE
509 extcap_get_win32_handle()
510 {
511         return pipe_h;
512 }
513 #endif
514
515 gboolean extcap_create_pipe(char ** fifo)
516 {
517 #ifdef WIN32
518         gchar timestr[ 14+1 ];
519         time_t current_time;
520
521         gchar *pipename = NULL;
522
523         LPSECURITY_ATTRIBUTES security = NULL;
524         /* create pipename */
525         current_time = time(NULL);
526         strftime(timestr, sizeof(timestr), "%Y%m%d%H%M%S", localtime(&current_time));
527         pipename = g_strconcat ( "\\\\.\\pipe\\", EXTCAP_PIPE_PREFIX, "_", timestr, NULL );
528
529         /* Security struct to enable Inheritable HANDLE */
530         security = (LPSECURITY_ATTRIBUTES)g_malloc0(sizeof(LPSECURITY_ATTRIBUTES));
531         security->nLength = sizeof(LPSECURITY_ATTRIBUTES);
532         security->bInheritHandle = TRUE;
533         security->lpSecurityDescriptor = NULL;
534
535         /* create a namedPipe*/
536         pipe_h = CreateNamedPipe(
537                                 utf_8to16(pipename),
538                                 PIPE_ACCESS_DUPLEX,
539                                 PIPE_TYPE_MESSAGE| PIPE_READMODE_MESSAGE | PIPE_WAIT,
540                                 5, 65536, 65536,
541                                 300,
542                                 security);
543
544         if (pipe_h == INVALID_HANDLE_VALUE)
545         {
546                 g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG,"\nError creating pipe => (%d)", GetLastError());
547                 return FALSE;
548         }
549         else
550         {
551                 g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG,"\nWireshark Created pipe =>(%s)",pipename);
552                 *fifo = g_strdup(pipename);
553         }
554 #else
555         gchar *temp_name = NULL;
556         int fd = 0;
557
558         if ( ( fd = create_tempfile ( &temp_name, EXTCAP_PIPE_PREFIX ) ) == 0 )
559                 return FALSE;
560
561         ws_close(fd);
562
563         g_log(LOG_DOMAIN_CAPTURE, G_LOG_LEVEL_DEBUG,
564                         "Extcap - Creating fifo: %s", temp_name);
565
566         if ( file_exists(temp_name) )
567                 ws_unlink(temp_name);
568
569         if (mkfifo(temp_name, 0600) == 0)
570                 *fifo = g_strdup(temp_name);
571 #endif
572
573         return TRUE;
574 }
575
576 #if ARG_DEBUG
577 void extcap_debug_arguments ( extcap_arg *arg_iter )
578 {
579         extcap_value *v = NULL;
580         GList *walker = NULL;
581
582         printf("debug - parser dump\n");
583         while (arg_iter != NULL) {
584                 printf("ARG %d call=%s display=\"%s\" type=", arg_iter->arg_num, arg_iter->call, arg_iter->display);
585
586                 switch (arg_iter->arg_type) {
587                         case EXTCAP_ARG_INTEGER:
588                         printf("int\n");
589                         break;
590                         case EXTCAP_ARG_UNSIGNED:
591                         printf("unsigned\n");
592                         break;
593                         case EXTCAP_ARG_LONG:
594                         printf("long\n");
595                         break;
596                         case EXTCAP_ARG_DOUBLE:
597                         printf("double\n");
598                         break;
599                         case EXTCAP_ARG_BOOLEAN:
600                         printf("boolean\n");
601                         break;
602                         case EXTCAP_ARG_MENU:
603                         printf("menu\n");
604                         break;
605                         case EXTCAP_ARG_RADIO:
606                         printf("radio\n");
607                         break;
608                         case EXTCAP_ARG_SELECTOR:
609                         printf("selctor\n");
610                         break;
611                         case EXTCAP_ARG_STRING:
612                         printf ( "string\n" );
613                         break;
614                         case EXTCAP_ARG_MULTICHECK:
615                         printf ( "unknown\n" );
616                         break;
617                         case EXTCAP_ARG_UNKNOWN:
618                         printf ( "unknown\n" );
619                         break;
620                 }
621
622                 if (arg_iter->range_start != NULL && arg_iter->range_end != NULL) {
623                         printf("\tRange: ");
624                         extcap_printf_complex(arg_iter->range_start);
625                         printf(" - ");
626                         extcap_printf_complex(arg_iter->range_end);
627                         printf("\n");
628                 }
629
630                 for ( walker = g_list_first ( arg_iter->value_list ); walker; walker = walker->next )
631                 {
632                         v = (extcap_value *)walker->data;
633                         if (v->is_default == TRUE)
634                         printf("*");
635                         printf("\tcall=\"%p\" display=\"%p\"\n", v->call, v->display);
636                         printf("\tcall=\"%s\" display=\"%s\"\n", v->call, v->display);
637                 }
638
639                 arg_iter = arg_iter->next_arg;
640         }
641 }
642 #endif
643 #endif
644
645 /*
646  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
647  *
648  * Local variables:
649  * c-basic-offset: 4
650  * tab-width: 4
651  * indent-tabs-mode: t
652  * End:
653  *
654  * vi: set shiftwidth=4 tabstop=4 noexpandtab:
655  * :indentSize=4:tabSize=4:noTabs=false:
656  */