capture_opts.c

   1 /* capture_opts.c
   2  * Routines for capture options setting
   3  *
   4  * $Id$
   5  *
   6  * Ethereal - Network traffic analyzer
   7  * By Gerald Combs <gerald@ethereal.com>
   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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  23  */
  24
  25 #ifdef HAVE_CONFIG_H
  26 # include "config.h"
  27 #endif
  28
  29 #ifdef HAVE_LIBPCAP
  30
  31 #include <string.h>
  32 #include <ctype.h>
  33
  34 #include <glib.h>
  35
  36 #include <epan/packet.h>
  37
  38 #include "capture.h"
  39 #include "capture_opts.h"
  40 #include "ringbuffer.h"
  41 #include "clopts_common.h"
  42 #include "cmdarg_err.h"
  43
  44 #include "capture-pcap-util.h"
  45 #include <wiretap/file_util.h>
  46
  47
  48 static gboolean capture_opts_output_to_pipe(const char *save_file, gboolean *is_pipe);
  49
  50
  51 void
  52 capture_opts_init(capture_options *capture_opts, void *cfile)
  53 {
  54   capture_opts->cf                      = cfile;
  55   capture_opts->cfilter                 = g_strdup("");     /* No capture filter string specified */
  56   capture_opts->iface                   = NULL;             /* Default is "pick the first interface" */
  57 #ifdef _WIN32
  58   capture_opts->buffer_size             = 1;                /* 1 MB */
  59 #endif
  60   capture_opts->has_snaplen             = FALSE;
  61   capture_opts->snaplen                 = WTAP_MAX_PACKET_SIZE; /* snapshot length - default is
  62                                                                    infinite, in effect */
  63   capture_opts->promisc_mode            = TRUE;             /* promiscuous mode is the default */
  64   capture_opts->linktype                = -1;               /* the default linktype */
  65   capture_opts->saving_to_file          = FALSE;
  66   capture_opts->save_file               = NULL;
  67   capture_opts->real_time_mode          = TRUE;
  68   capture_opts->show_info               = TRUE;
  69   capture_opts->quit_after_cap          = FALSE;
  70   capture_opts->restart                 = FALSE;
  71
  72   capture_opts->multi_files_on          = FALSE;
  73   capture_opts->has_file_duration       = FALSE;
  74   capture_opts->file_duration           = 60;               /* 1 min */
  75   capture_opts->has_ring_num_files      = FALSE;
  76   capture_opts->ring_num_files          = RINGBUFFER_MIN_NUM_FILES;
  77
  78   capture_opts->has_autostop_files      = FALSE;
  79   capture_opts->autostop_files          = 1;
  80   capture_opts->has_autostop_packets    = FALSE;
  81   capture_opts->autostop_packets        = 0;
  82   capture_opts->has_autostop_filesize   = FALSE;
  83   capture_opts->autostop_filesize       = 1024;             /* 1 MB */
  84   capture_opts->has_autostop_duration   = FALSE;
  85   capture_opts->autostop_duration       = 60;               /* 1 min */
  86
  87
  88   capture_opts->fork_child              = -1;               /* invalid process handle */
  89 #ifdef _WIN32
  90   capture_opts->signal_pipe_write_fd    = -1;
  91 #endif
  92   capture_opts->state                   = CAPTURE_STOPPED;
  93   capture_opts->output_to_pipe          = FALSE;
  94 }
  95
  96
  97 /* log content of capture_opts */
  98 void
  99 capture_opts_log(const char *log_domain, GLogLevelFlags log_level, capture_options *capture_opts) {
 100     g_log(log_domain, log_level, "CAPTURE OPTIONS    :");
 101     g_log(log_domain, log_level, "CFile              : 0x%p", capture_opts->cf);
 102     g_log(log_domain, log_level, "Filter             : %s", capture_opts->cfilter);
 103     g_log(log_domain, log_level, "Interface          : %s", capture_opts->iface);
 104 #ifdef _WIN32
 105     g_log(log_domain, log_level, "BufferSize         : %u (MB)", capture_opts->buffer_size);
 106 #endif
 107     g_log(log_domain, log_level, "SnapLen         (%u): %u", capture_opts->has_snaplen, capture_opts->snaplen);
 108     g_log(log_domain, log_level, "Promisc            : %u", capture_opts->promisc_mode);
 109     g_log(log_domain, log_level, "LinkType           : %d", capture_opts->linktype);
 110     g_log(log_domain, log_level, "SavingToFile       : %u", capture_opts->saving_to_file);
 111     g_log(log_domain, log_level, "SaveFile           : %s", (capture_opts->save_file) ? capture_opts->save_file : "");
 112     g_log(log_domain, log_level, "RealTimeMode       : %u", capture_opts->real_time_mode);
 113     g_log(log_domain, log_level, "ShowInfo           : %u", capture_opts->show_info);
 114     g_log(log_domain, log_level, "QuitAfterCap       : %u", capture_opts->quit_after_cap);
 115
 116     g_log(log_domain, log_level, "MultiFilesOn       : %u", capture_opts->multi_files_on);
 117     g_log(log_domain, log_level, "FileDuration    (%u): %u", capture_opts->has_file_duration, capture_opts->file_duration);
 118     g_log(log_domain, log_level, "RingNumFiles    (%u): %u", capture_opts->has_ring_num_files, capture_opts->ring_num_files);
 119
 120     g_log(log_domain, log_level, "AutostopFiles   (%u): %u", capture_opts->has_autostop_files, capture_opts->autostop_files);
 121     g_log(log_domain, log_level, "AutostopPackets (%u): %u", capture_opts->has_autostop_packets, capture_opts->autostop_packets);
 122     g_log(log_domain, log_level, "AutostopFilesize(%u): %u (KB)", capture_opts->has_autostop_filesize, capture_opts->autostop_filesize);
 123     g_log(log_domain, log_level, "AutostopDuration(%u): %u", capture_opts->has_autostop_duration, capture_opts->autostop_duration);
 124
 125     g_log(log_domain, log_level, "ForkChild          : %d", capture_opts->fork_child);
 126 #ifdef _WIN32
 127     g_log(log_domain, log_level, "SignalPipeWrite    : %d", capture_opts->signal_pipe_write_fd);
 128 #endif
 129 }
 130
 131 /*
 132  * Given a string of the form "<autostop criterion>:<value>", as might appear
 133  * as an argument to a "-a" option, parse it and set the criterion in
 134  * question.  Return an indication of whether it succeeded or failed
 135  * in some fashion.
 136  */
 137 static gboolean
 138 set_autostop_criterion(capture_options *capture_opts, const char *autostoparg)
 139 {
 140   gchar *p, *colonp;
 141
 142   colonp = strchr(autostoparg, ':');
 143   if (colonp == NULL)
 144     return FALSE;
 145
 146   p = colonp;
 147   *p++ = '\0';
 148
 149   /*
 150    * Skip over any white space (there probably won't be any, but
 151    * as we allow it in the preferences file, we might as well
 152    * allow it here).
 153    */
 154   while (isspace((guchar)*p))
 155     p++;
 156   if (*p == '\0') {
 157     /*
 158      * Put the colon back, so if our caller uses, in an
 159      * error message, the string they passed us, the message
 160      * looks correct.
 161      */
 162     *colonp = ':';
 163     return FALSE;
 164   }
 165   if (strcmp(autostoparg,"duration") == 0) {
 166     capture_opts->has_autostop_duration = TRUE;
 167     capture_opts->autostop_duration = get_positive_int(p,"autostop duration");
 168   } else if (strcmp(autostoparg,"filesize") == 0) {
 169     capture_opts->has_autostop_filesize = TRUE;
 170     capture_opts->autostop_filesize = get_positive_int(p,"autostop filesize");
 171   } else if (strcmp(autostoparg,"files") == 0) {
 172     capture_opts->multi_files_on = TRUE;
 173     capture_opts->has_autostop_files = TRUE;
 174     capture_opts->autostop_files = get_positive_int(p,"autostop files");
 175   } else {
 176     return FALSE;
 177   }
 178   *colonp = ':'; /* put the colon back */
 179   return TRUE;
 180 }
 181
 182 /*
 183  * Given a string of the form "<ring buffer file>:<duration>", as might appear
 184  * as an argument to a "-b" option, parse it and set the arguments in
 185  * question.  Return an indication of whether it succeeded or failed
 186  * in some fashion.
 187  */
 188 static gboolean
 189 get_ring_arguments(capture_options *capture_opts, const char *arg)
 190 {
 191   gchar *p = NULL, *colonp;
 192
 193   colonp = strchr(arg, ':');
 194   if (colonp == NULL)
 195     return FALSE;
 196
 197   p = colonp;
 198   *p++ = '\0';
 199
 200   /*
 201    * Skip over any white space (there probably won't be any, but
 202    * as we allow it in the preferences file, we might as well
 203    * allow it here).
 204    */
 205   while (isspace((guchar)*p))
 206     p++;
 207   if (*p == '\0') {
 208     /*
 209      * Put the colon back, so if our caller uses, in an
 210      * error message, the string they passed us, the message
 211      * looks correct.
 212      */
 213     *colonp = ':';
 214     return FALSE;
 215   }
 216
 217   if (strcmp(arg,"files") == 0) {
 218     capture_opts->has_ring_num_files = TRUE;
 219     capture_opts->ring_num_files = get_natural_int(p, "number of ring buffer files");
 220   } else if (strcmp(arg,"filesize") == 0) {
 221     capture_opts->has_autostop_filesize = TRUE;
 222     capture_opts->autostop_filesize = get_positive_int(p, "ring buffer filesize");
 223   } else if (strcmp(arg,"duration") == 0) {
 224     capture_opts->has_file_duration = TRUE;
 225     capture_opts->file_duration = get_positive_int(p, "ring buffer duration");
 226   }
 227
 228   *colonp = ':';    /* put the colon back */
 229   return TRUE;
 230 }
 231
 232
 233 static int
 234 capture_opts_add_iface_opt(capture_options *capture_opts, const char *optarg)
 235 {
 236     long        adapter_index;
 237     char        *p;
 238     GList       *if_list;
 239     if_info_t   *if_info;
 240     int         err;
 241     gchar       err_str[CAPTURE_PCAP_ERRBUF_SIZE];
 242     gchar       *cant_get_if_list_errstr;
 243
 244
 245     /*
 246      * If the argument is a number, treat it as an index into the list
 247      * of adapters, as printed by "tethereal -D".
 248      *
 249      * This should be OK on UNIX systems, as interfaces shouldn't have
 250      * names that begin with digits.  It can be useful on Windows, where
 251      * more than one interface can have the same name.
 252      */
 253     adapter_index = strtol(optarg, &p, 10);
 254     if (p != NULL && *p == '\0') {
 255       if (adapter_index < 0) {
 256         cmdarg_err("The specified adapter index is a negative number");
 257         return 1;
 258       }
 259       if (adapter_index > INT_MAX) {
 260         cmdarg_err("The specified adapter index is too large (greater than %d)",
 261             INT_MAX);
 262         return 1;
 263       }
 264       if (adapter_index == 0) {
 265         cmdarg_err("there is no interface with that adapter index");
 266         return 1;
 267       }
 268       if_list = get_interface_list(&err, err_str);
 269       if (if_list == NULL) {
 270         switch (err) {
 271
 272         case CANT_GET_INTERFACE_LIST:
 273             cant_get_if_list_errstr =
 274                 cant_get_if_list_error_message(err_str);
 275             cmdarg_err("%s", cant_get_if_list_errstr);
 276             g_free(cant_get_if_list_errstr);
 277             break;
 278
 279         case NO_INTERFACES_FOUND:
 280             cmdarg_err("There are no interfaces on which a capture can be done");
 281             break;
 282         }
 283         return 2;
 284       }
 285       if_info = g_list_nth_data(if_list, adapter_index - 1);
 286       if (if_info == NULL) {
 287         cmdarg_err("there is no interface with that adapter index");
 288         return 1;
 289       }
 290       capture_opts->iface = g_strdup(if_info->name);
 291       free_interface_list(if_list);
 292     } else {
 293       capture_opts->iface = g_strdup(optarg);
 294     }
 295
 296     return 0;
 297 }
 298
 299 int
 300 capture_opts_add_opt(capture_options *capture_opts, int opt, const char *optarg, gboolean *start_capture)
 301 {
 302     int status;
 303
 304     switch(opt) {
 305     case 'a':        /* autostop criteria */
 306         if (set_autostop_criterion(capture_opts, optarg) == FALSE) {
 307           cmdarg_err("Invalid or unknown -a flag \"%s\"", optarg);
 308           return 1;
 309         }
 310         break;
 311     case 'b':        /* Ringbuffer option */
 312         capture_opts->multi_files_on = TRUE;
 313         if (get_ring_arguments(capture_opts, optarg) == FALSE) {
 314           cmdarg_err("Invalid or unknown -b arg \"%s\"", optarg);
 315           return 1;
 316         }
 317         break;
 318 #ifdef _WIN32
 319     case 'B':        /* Buffer size */
 320         capture_opts->buffer_size = get_positive_int(optarg, "buffer size");
 321         break;
 322 #endif
 323     case 'c':        /* Capture n packets */
 324         capture_opts->has_autostop_packets = TRUE;
 325         capture_opts->autostop_packets = get_positive_int(optarg, "packet count");
 326         break;
 327     case 'f':        /* capture filter */
 328         if (capture_opts->cfilter)
 329             g_free(capture_opts->cfilter);
 330         capture_opts->cfilter = g_strdup(optarg);
 331         break;
 332     case 'H':        /* Hide capture info dialog box */
 333         capture_opts->show_info = FALSE;
 334         break;
 335     case 'i':        /* Use interface x */
 336         status = capture_opts_add_iface_opt(capture_opts, optarg);
 337         if(status != 0) {
 338             return status;
 339         }
 340         break;
 341     case 'k':        /* Start capture immediately */
 342         *start_capture = TRUE;
 343         break;
 344     /*case 'l':*/    /* Automatic scrolling in live capture mode */
 345     case 'p':        /* Don't capture in promiscuous mode */
 346         capture_opts->promisc_mode = FALSE;
 347         break;
 348     case 'Q':        /* Quit after capture (just capture to file) */
 349         capture_opts->quit_after_cap  = TRUE;
 350         *start_capture   = TRUE;  /*** -Q implies -k !! ***/
 351         break;
 352     case 's':        /* Set the snapshot (capture) length */
 353         capture_opts->has_snaplen = TRUE;
 354         capture_opts->snaplen = get_positive_int(optarg, "snapshot length");
 355         break;
 356     case 'S':        /* "Real-Time" mode: used for following file ala tail -f */
 357         capture_opts->real_time_mode = TRUE;
 358         break;
 359     case 'w':        /* Write to capture file x */
 360         capture_opts->saving_to_file = TRUE;
 361 #if defined _WIN32 && (GLIB_MAJOR_VERSION > 2 || (GLIB_MAJOR_VERSION == 2 && GLIB_MINOR_VERSION >= 6))
 362         /* since GLib 2.6, we need to convert filenames to utf8 for Win32 */
 363         capture_opts->save_file = g_locale_to_utf8(optarg, -1, NULL, NULL, NULL);
 364 #else
 365         capture_opts->save_file = g_strdup(optarg);
 366 #endif
 367         status = capture_opts_output_to_pipe(capture_opts->save_file, &capture_opts->output_to_pipe);
 368         return status;
 369         break;
 370     case 'y':        /* Set the pcap data link type */
 371 #ifdef HAVE_PCAP_DATALINK_NAME_TO_VAL
 372         capture_opts->linktype = linktype_name_to_val(optarg);
 373         if (capture_opts->linktype == -1) {
 374           cmdarg_err("The specified data link type \"%s\" isn't valid",
 375                   optarg);
 376           return 1;
 377         }
 378 #else /* HAVE_PCAP_DATALINK_NAME_TO_VAL */
 379         /* we can't get the type name, just treat it as a number */
 380         capture_opts->linktype = get_natural_int(optarg, "data link type");
 381 #endif /* HAVE_PCAP_DATALINK_NAME_TO_VAL */
 382         break;
 383     default:
 384         /* the caller is responsible to send us only the right opt's */
 385         g_assert_not_reached();
 386     }
 387
 388     return 0;
 389 }
 390
 391
 392 int capture_opts_list_link_layer_types(capture_options *capture_opts)
 393 {
 394     gchar err_str[CAPTURE_PCAP_ERRBUF_SIZE];
 395     GList *lt_list, *lt_entry;
 396     data_link_info_t *data_link_info;
 397
 398     /* Get the list of link-layer types for the capture device. */
 399     lt_list = get_pcap_linktype_list(capture_opts->iface, err_str);
 400     if (lt_list == NULL) {
 401       if (err_str[0] != '\0') {
 402         cmdarg_err("The list of data link types for the capture device \"%s\" could not be obtained (%s)."
 403          "Please check to make sure you have sufficient permissions, and that\n"
 404          "you have the proper interface or pipe specified.\n", capture_opts->iface, err_str);
 405       } else
 406         cmdarg_err("The capture device \"%s\" has no data link types.", capture_opts->iface);
 407       return 2;
 408     }
 409     cmdarg_err_cont("Data link types (use option -y to set):");
 410     for (lt_entry = lt_list; lt_entry != NULL;
 411          lt_entry = g_list_next(lt_entry)) {
 412       data_link_info = lt_entry->data;
 413       cmdarg_err_cont("  %s", data_link_info->name);
 414       if (data_link_info->description != NULL)
 415         cmdarg_err_cont(" (%s)", data_link_info->description);
 416       else
 417         cmdarg_err_cont(" (not supported)");
 418       putchar('\n');
 419     }
 420     free_pcap_linktype_list(lt_list);
 421
 422     return 0;
 423 }
 424
 425
 426 int capture_opts_list_interfaces()
 427 {
 428     GList       *if_list;
 429     GList       *if_entry;
 430     if_info_t   *if_info;
 431     int         err;
 432     gchar       err_str[CAPTURE_PCAP_ERRBUF_SIZE];
 433     gchar       *cant_get_if_list_errstr;
 434     int         i;
 435
 436
 437     if_list = get_interface_list(&err, err_str);
 438     if (if_list == NULL) {
 439         switch (err) {
 440         case CANT_GET_INTERFACE_LIST:
 441             cant_get_if_list_errstr = cant_get_if_list_error_message(err_str);
 442             cmdarg_err("%s", cant_get_if_list_errstr);
 443             g_free(cant_get_if_list_errstr);
 444         break;
 445
 446         case NO_INTERFACES_FOUND:
 447             cmdarg_err("There are no interfaces on which a capture can be done");
 448         break;
 449         }
 450         return 2;
 451     }
 452
 453     i = 1;  /* Interface id number */
 454     for (if_entry = g_list_first(if_list); if_entry != NULL;
 455     if_entry = g_list_next(if_entry)) {
 456         if_info = if_entry->data;
 457         printf("%d. %s", i++, if_info->name);
 458         if (if_info->description != NULL)
 459             printf(" (%s)", if_info->description);
 460         printf("\n");
 461     }
 462     free_interface_list(if_list);
 463
 464     return 0;
 465 }
 466
 467
 468 void capture_opts_trim_snaplen(capture_options *capture_opts, int snaplen_min)
 469 {
 470   if (capture_opts->snaplen < 1)
 471     capture_opts->snaplen = WTAP_MAX_PACKET_SIZE;
 472   else if (capture_opts->snaplen < snaplen_min)
 473     capture_opts->snaplen = snaplen_min;
 474 }
 475
 476
 477 void capture_opts_trim_ring_num_files(capture_options *capture_opts)
 478 {
 479   /* Check the value range of the ring_num_files parameter */
 480   if (capture_opts->ring_num_files > RINGBUFFER_MAX_NUM_FILES)
 481     capture_opts->ring_num_files = RINGBUFFER_MAX_NUM_FILES;
 482 #if RINGBUFFER_MIN_NUM_FILES > 0
 483   else if (capture_opts->ring_num_files < RINGBUFFER_MIN_NUM_FILES)
 484     capture_opts->ring_num_files = RINGBUFFER_MIN_NUM_FILES;
 485 #endif
 486 }
 487
 488
 489 gboolean capture_opts_trim_iface(capture_options *capture_opts, const char *capture_device)
 490 {
 491     GList       *if_list;
 492     if_info_t   *if_info;
 493     int         err;
 494     gchar       err_str[CAPTURE_PCAP_ERRBUF_SIZE];
 495     gchar       *cant_get_if_list_errstr;
 496
 497
 498     /* Did the user specify an interface to use? */
 499     if (capture_opts->iface == NULL) {
 500       /* No - is a default specified in the preferences file? */
 501       if (capture_device != NULL) {
 502           /* Yes - use it. */
 503           capture_opts->iface = g_strdup(capture_device);
 504       } else {
 505         /* No - pick the first one from the list of interfaces. */
 506         if_list = get_interface_list(&err, err_str);
 507         if (if_list == NULL) {
 508           switch (err) {
 509
 510           case CANT_GET_INTERFACE_LIST:
 511               cant_get_if_list_errstr = cant_get_if_list_error_message(err_str);
 512               cmdarg_err("%s", cant_get_if_list_errstr);
 513               g_free(cant_get_if_list_errstr);
 514               break;
 515
 516           case NO_INTERFACES_FOUND:
 517               cmdarg_err("There are no interfaces on which a capture can be done");
 518               break;
 519           }
 520           return FALSE;
 521         }
 522         if_info = if_list->data;        /* first interface */
 523         capture_opts->iface = g_strdup(if_info->name);
 524         free_interface_list(if_list);
 525       }
 526     }
 527
 528     return TRUE;
 529 }
 530
 531
 532
 533 #ifndef S_IFIFO
 534 #define S_IFIFO _S_IFIFO
 535 #endif
 536 #ifndef S_ISFIFO
 537 #define S_ISFIFO(mode)  (((mode) & S_IFMT) == S_IFIFO)
 538 #endif
 539
 540 /* copied from filesystem.c */
 541 static int capture_opts_test_for_fifo(const char *path)
 542 {
 543         struct stat statb;
 544
 545         if (eth_stat(path, &statb) < 0)
 546                 return errno;
 547
 548         if (S_ISFIFO(statb.st_mode))
 549                 return ESPIPE;
 550         else
 551                 return 0;
 552 }
 553
 554 static gboolean capture_opts_output_to_pipe(const char *save_file, gboolean *is_pipe)
 555 {
 556   int err;
 557
 558   if (save_file != NULL) {
 559     /* We're writing to a capture file. */
 560     if (strcmp(save_file, "-") == 0) {
 561       /* Writing to stdout. */
 562       /* XXX - should we check whether it's a pipe?  It's arguably
 563          silly to do "-w - >output_file" rather than "-w output_file",
 564          but by not checking we might be violating the Principle Of
 565          Least Astonishment. */
 566       *is_pipe = TRUE;
 567     } else {
 568       /* not a capture file, test for a FIFO (aka named pipe) */
 569       err = capture_opts_test_for_fifo(save_file);
 570       switch (err) {
 571
 572       case ENOENT:      /* it doesn't exist, so we'll be creating it,
 573                            and it won't be a FIFO */
 574       case 0:           /* found it, but it's not a FIFO */
 575         break;
 576
 577       case ESPIPE:      /* it is a FIFO */
 578         *is_pipe = TRUE;
 579         break;
 580
 581       default:          /* couldn't stat it */
 582         cmdarg_err("Error testing whether capture file is a pipe: %s",
 583                 strerror(errno));
 584         return 2;
 585       }
 586     }
 587   }
 588
 589   *is_pipe = FALSE;
 590
 591   return 0;
 592 }
 593
 594 #endif /* HAVE_LIBPCAP */