Also add the new dissectors
[obnox/wireshark/wip.git] / editcap.c
index 0e306f021e7dc2bfd3de9d50791e5c3db7b08351..50592854a456840c3701bd658113f87218ca9220 100644 (file)
--- a/editcap.c
+++ b/editcap.c
-/* Edit capture files.  We can delete records, or simply convert from one 
- * format to another format.
+/* Edit capture files.  We can delete records, adjust timestamps, or
+ * simply convert from one format to another format.
  *
- * $Id: editcap.c,v 1.3 1999/12/05 01:27:14 guy Exp $
+ * $Id$
  *
  * Originally written by Richard Sharpe.
  * Improved by Guy Harris.
+ * Further improved by Richard Sharpe.
  */
 
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
 #include <stdio.h>
+#include <stdlib.h>
 #include <glib.h>
+
+#ifdef HAVE_UNISTD_H
 #include <unistd.h>
+#endif
+
+#include <time.h>
+#ifdef HAVE_SYS_TIME_H
 #include <sys/time.h>
+#endif
+
+#include <string.h>
 #include "wtap.h"
 
+#ifdef NEED_GETOPT_H
+#include "getopt.h"
+#endif
+
+#ifdef _WIN32
+#include <process.h>    /* getpid */
+#endif
+
 /*
  * Some globals so we can pass things to various routines
  */
 
-int selectfrm[100], max_selected = -1;
-static int count = 1;
+struct select_item {
+
+  int inclusive;
+  int first, second;
+
+};
+
+#define ONE_MILLION 1000000
+
+/* Weights of different errors we can introduce */
+/* We should probably make these command-line arguments */
+/* XXX - Should we add a bit-level error? */
+#define ERR_WT_BIT   5  /* Flip a random bit */
+#define ERR_WT_BYTE  5  /* Substitute a random byte */
+#define ERR_WT_ALNUM 5  /* Substitute a random character in [A-Za-z0-9] */
+#define ERR_WT_FMT   2  /* Substitute "%s" */
+#define ERR_WT_AA    1  /* Fill the remainder of the buffer with 0xAA */
+#define ERR_WT_TOTAL (ERR_WT_BIT + ERR_WT_BYTE + ERR_WT_ALNUM + ERR_WT_FMT + ERR_WT_AA)
+
+#define ALNUM_CHARS "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"
+#define ALNUM_LEN (sizeof(ALNUM_CHARS) - 1)
+
+
+struct time_adjustment {
+  struct timeval tv;
+  int is_negative;
+};
+
+static struct select_item selectfrm[100];
+static int max_selected = -1;
 static int keep_em = 0;
-static int out_file_type = WTAP_FILE_PCAP;     /* default to "libpcap" */
-static int out_frame_type = -2;   /* Leave frame type alone */
+static int out_file_type = WTAP_FILE_PCAP;   /* default to "libpcap"   */
+static int out_frame_type = -2;              /* Leave frame type alone */
+static int verbose = 0;                      /* Not so verbose         */
+static struct time_adjustment time_adj = {{0, 0}, 0}; /* no adjustment */
+static double err_prob = 0.0;
 
-/* Was the record selected? */
+/* Add a selection item, a simple parser for now */
 
-int selected(int recno)
+static void add_selection(char *sel)
 {
-  int i = 0;
+  char *locn;
+  char *next;
 
-  for (i = 0; i<= max_selected; i++) {
+  if (max_selected == (sizeof(selectfrm)/sizeof(struct select_item)) - 1)
+    return;
+
+  printf("Add_Selected: %s\n", sel);
+
+  if ((locn = strchr(sel, '-')) == NULL) { /* No dash, so a single number? */
+
+    printf("Not inclusive ...");
 
-    if (recno == selectfrm[i]) return 1;
+    max_selected++;
+    selectfrm[max_selected].inclusive = 0;
+    selectfrm[max_selected].first = atoi(sel);
+
+    printf(" %i\n", selectfrm[max_selected].first);
 
   }
+  else {
 
-  return 0;
+    printf("Inclusive ...");
 
-}
+    next = locn + 1;
+    max_selected++;
+    selectfrm[max_selected].inclusive = 1;
+    selectfrm[max_selected].first = atoi(sel);
+    selectfrm[max_selected].second = atoi(next);
 
-/* An argument to the callback routine */
+    printf(" %i, %i\n", selectfrm[max_selected].first, selectfrm[max_selected].second);
 
-typedef struct {
-       char    *filename;
-       wtap_dumper *pdh;
-} callback_arg;
+  }
 
-/*
- *The callback routine that is called for each frame in the input file
- */
 
-static void
-edit_callback(u_char *user, const struct wtap_pkthdr *phdr, int offset,
-    const u_char *buf) 
+}
+
+/* Was the record selected? */
+
+static int selected(int recno)
 {
-  callback_arg *argp = (callback_arg *)user;
-  int err;
+  int i = 0;
 
-  if ((!selected(count) && !keep_em) ||
-      (selected(count) && keep_em)) {
+  for (i = 0; i<= max_selected; i++) {
 
-    printf("Record: %u\n", count);
+    if (selectfrm[i].inclusive) {
+      if (selectfrm[i].first <= recno && selectfrm[i].second >= recno)
+       return 1;
+    }
+    else {
+      if (recno == selectfrm[i].first)
+       return 1;
+    }
+  }
 
-    /* We simply write it, we could do other things, like modify it */
+  return 0;
 
-    if (!wtap_dump(argp->pdh, phdr, buf, &err)) {
+}
 
-      fprintf(stderr, "editcap: Error writing to %s: %s\n", argp->filename,
-        wtap_strerror(err));
-      exit(1);
+static void
+set_time_adjustment(char *optarg)
+{
+  char *frac, *end;
+  long val;
+  int frac_digits;
 
-    }
+  if (!optarg)
+    return;
 
+  /* skip leading whitespace */
+  while (*optarg == ' ' || *optarg == '\t') {
+      optarg++;
   }
 
-  count++;
+  /* check for a negative adjustment */
+  if (*optarg == '-') {
+      time_adj.is_negative = 1;
+      optarg++;
+  }
 
+  /* collect whole number of seconds, if any */
+  if (*optarg == '.') {         /* only fractional (i.e., .5 is ok) */
+      val  = 0;
+      frac = optarg;
+  } else {
+      val = strtol(optarg, &frac, 10);
+      if (frac == NULL || frac == optarg || val == LONG_MIN || val == LONG_MAX) {
+          fprintf(stderr, "editcap: \"%s\" isn't a valid time adjustment\n",
+                  optarg);
+          exit(1);
+      }
+      if (val < 0) {            /* implies '--' since we caught '-' above  */
+          fprintf(stderr, "editcap: \"%s\" isn't a valid time adjustment\n",
+                  optarg);
+          exit(1);
+      }
+  }
+  time_adj.tv.tv_sec = val;
+
+  /* now collect the partial seconds, if any */
+  if (*frac != '\0') {             /* chars left, so get fractional part */
+    val = strtol(&(frac[1]), &end, 10);
+    if (*frac != '.' || end == NULL || end == frac
+        || val < 0 || val > ONE_MILLION || val == LONG_MIN || val == LONG_MAX) {
+      fprintf(stderr, "editcap: \"%s\" isn't a valid time adjustment\n",
+              optarg);
+      exit(1);
+    }
+  }
+  else {
+    return;                     /* no fractional digits */
+  }
+
+  /* adjust fractional portion from fractional to numerator
+   * e.g., in "1.5" from 5 to 500000 since .5*10^6 = 500000 */
+  if (frac && end) {            /* both are valid */
+    frac_digits = end - frac - 1;   /* fractional digit count (remember '.') */
+    while(frac_digits < 6) {    /* this is frac of 10^6 */
+      val *= 10;
+      frac_digits++;
+    }
+  }
+  time_adj.tv.tv_usec = val;
 }
 
-void usage()
+static void usage(void)
 {
   int i;
-  char *string;
-
-  fprintf(stderr, "Usage: editcap [-r] [-T <encap type>] [-F <capture type>] <infile> <outfile>\\\n");
-  fprintf(stderr, "                [ <record#> ... ]\n");
-  fprintf(stderr, "  where\t-r specifies that the records specified should be kept, not deleted, \n");
+  const char *string;
+
+  fprintf(stderr, "Usage: editcap [-r] [-h] [-v] [-T <encap type>] [-E <probability>]\n");
+  fprintf(stderr, "               [-F <capture type>] [-s <snaplen>] [-t <time adjustment>]\n");
+  fprintf(stderr, "               <infile> <outfile> [ <record#>[-<record#>] ... ]\n");
+  fprintf(stderr, "  where\n");
+  fprintf(stderr, "       \t-E <probability> specifies the probability (between 0 and 1)\n");
+  fprintf(stderr, "       \t    that a particular byte will will have an error.\n");
+  fprintf(stderr, "       \t-F <capture type> specifies the capture file type to write:\n");
+  for (i = 0; i < WTAP_NUM_FILE_TYPES; i++) {
+    if (wtap_dump_can_open(i))
+      fprintf(stderr, "       \t    %s - %s\n",
+        wtap_file_type_short_string(i), wtap_file_type_string(i));
+  }
+  fprintf(stderr, "       \t    default is libpcap\n");
+  fprintf(stderr, "       \t-h produces this help listing.\n");
+  fprintf(stderr, "       \t-r specifies that the records specified should be kept, not deleted, \n");
   fprintf(stderr, "                           default is to delete\n");
+  fprintf(stderr, "       \t-s <snaplen> specifies that packets should be truncated to\n");
+  fprintf(stderr, "       \t   <snaplen> bytes of data\n");
+  fprintf(stderr, "       \t-t <time adjustment> specifies the time adjustment\n");
+  fprintf(stderr, "       \t   to be applied to selected packets\n");
   fprintf(stderr, "       \t-T <encap type> specifies the encapsulation type to use:\n");
   for (i = 0; i < WTAP_NUM_ENCAP_TYPES; i++) {
       string = wtap_encap_short_string(i);
@@ -94,108 +237,290 @@ void usage()
         fprintf(stderr, "       \t    %s - %s\n",
           string, wtap_encap_string(i));
   }
-  fprintf(stderr, "       \t   default is the same as the input file\n");
-  fprintf(stderr, "       \t-F <capture type> specifies the capture file type to write:\n");
-  for (i = 0; i < WTAP_NUM_FILE_TYPES; i++) {
-    if (wtap_dump_can_open(i))
-      fprintf(stderr, "       \t    %s - %s\n",
-        wtap_file_type_short_string(i), wtap_file_type_string(i));
-  }
-  fprintf(stderr, "       \t   default is libpcap\n");
+  fprintf(stderr, "       \t    default is the same as the input file\n");
+  fprintf(stderr, "       \t-v specifies verbose operation, default is silent\n");
+  fprintf(stderr, "\n      \t    A range of records can be specified as well\n");
 }
 
 int main(int argc, char *argv[])
 
 {
   wtap *wth;
-  int read_bytes, pcnt = 0, i, err;
-  callback_arg args;
+  int i, j, err;
+  gchar *err_info;
   extern char *optarg;
-  extern int optind, opterr, optopt;
-  char opt;
+  extern int optind;
+  int opt;
+  char *p;
+  unsigned int snaplen = 0;             /* No limit               */
+  wtap_dumper *pdh;
+  int count = 1;
+  long data_offset;
+  struct wtap_pkthdr snap_phdr;
+  const struct wtap_pkthdr *phdr;
+  int err_type;
+  guint8 *buf;
 
   /* Process the options first */
 
-  while ((opt = getopt(argc, argv, "T:F:r")) != EOF) {
+  while ((opt = getopt(argc, argv, "E:F:hrs:t:T:v")) !=-1) {
 
     switch (opt) {
 
-    case 'T':
-      out_frame_type = wtap_short_string_to_encap(optarg);
-      if (out_frame_type < 0) {
-       fprintf(stderr, "editcap: \"%s\" is not a valid encapsulation type\n",
+    case 'E':
+      err_prob = strtod(optarg, &p);
+      if (p == optarg || err_prob < 0.0 || err_prob > 1.0) {
+       fprintf(stderr, "editcap: probability \"%s\" must be between 0.0 and 1.0\n",
            optarg);
        exit(1);
       }
+      srand(time(NULL) + getpid());
       break;
-      
+
     case 'F':
       out_file_type = wtap_short_string_to_file_type(optarg);
       if (out_file_type < 0) {
-       fprintf(stderr, "editcap: \"%s\" is not a valid capture file type\n",
+       fprintf(stderr, "editcap: \"%s\" isn't a valid capture file type\n",
            optarg);
        exit(1);
       }
       break;
 
+    case 'h':
+    case '?':              /* Bad options if GNU getopt */
+      usage();
+      exit(1);
+      break;
+
     case 'r':
       keep_em = !keep_em;  /* Just invert */
       break;
 
-    case '?':              /* Bad options if GNU getopt */
-      usage();
-      exit(1);
+    case 's':
+      snaplen = strtol(optarg, &p, 10);
+      if (p == optarg || *p != '\0') {
+       fprintf(stderr, "editcap: \"%s\" isn't a valid snapshot length\n",
+           optarg);
+       exit(1);
+      }
+      break;
+
+    case 't':
+      set_time_adjustment(optarg);
+      break;
+
+    case 'T':
+      out_frame_type = wtap_short_string_to_encap(optarg);
+      if (out_frame_type < 0) {
+       fprintf(stderr, "editcap: \"%s\" isn't a valid encapsulation type\n",
+           optarg);
+       exit(1);
+      }
+      break;
+
+    case 'v':
+      verbose = !verbose;  /* Just invert */
       break;
 
     }
 
   }
 
+#ifdef DEBUG
   printf("Optind = %i, argc = %i\n", optind, argc);
+#endif
 
-  if ((argc - optind) < 2) {
+  if ((argc - optind) < 1) {
 
     usage();
     exit(1);
 
   }
 
-  wth = wtap_open_offline(argv[optind], &err);
+  wth = wtap_open_offline(argv[optind], &err, &err_info, FALSE);
 
   if (!wth) {
-
     fprintf(stderr, "editcap: Can't open %s: %s\n", argv[optind],
         wtap_strerror(err));
+    switch (err) {
+
+    case WTAP_ERR_UNSUPPORTED:
+    case WTAP_ERR_UNSUPPORTED_ENCAP:
+    case WTAP_ERR_BAD_RECORD:
+      fprintf(stderr, "(%s)\n", err_info);
+      g_free(err_info);
+      break;
+    }
     exit(1);
 
   }
 
-  args.filename = argv[optind + 1];
-  if (out_frame_type == -2)
-    out_frame_type = wtap_file_encap(wth);
-
-  args.pdh = wtap_dump_open(argv[optind + 1], out_file_type,
-               out_frame_type, wtap_snapshot_length(wth), &err);
-  if (args.pdh == NULL) {
+  if (verbose) {
 
-    fprintf(stderr, "editcap: Can't open or create %s: %s\n", argv[optind+1],
-        wtap_strerror(err));
-    exit(1);
+    fprintf(stderr, "File %s is a %s capture file.\n", argv[optind],
+           wtap_file_type_string(wtap_file_type(wth)));
 
   }
 
-  for (i = optind + 2; i < argc; i++)
-    selectfrm[++max_selected] = atoi(argv[i]);
+  /*
+   * Now, process the rest, if any ... we only write if there is an extra
+   * argument or so ...
+   */
 
-  wtap_loop(wth, 0, edit_callback, (char *)&args, &err);
+  if ((argc - optind) >= 2) {
 
-  if (!wtap_dump_close(args.pdh, &err)) {
+    if (out_frame_type == -2)
+      out_frame_type = wtap_file_encap(wth);
 
-    fprintf(stderr, "editcap: Error writing to %s: %s\n", argv[2],
-        wtap_strerror(err));
-    exit(1);
+    pdh = wtap_dump_open(argv[optind + 1], out_file_type,
+                        out_frame_type, wtap_snapshot_length(wth), FALSE /* compressed */, &err);
+    if (pdh == NULL) {
+
+      fprintf(stderr, "editcap: Can't open or create %s: %s\n", argv[optind+1],
+             wtap_strerror(err));
+      exit(1);
+
+    }
+
+    for (i = optind + 2; i < argc; i++)
+      add_selection(argv[i]);
+
+    while (wtap_read(wth, &err, &err_info, &data_offset)) {
+
+      if ((!selected(count) && !keep_em) ||
+          (selected(count) && keep_em)) {
+
+        if (verbose)
+          printf("Record: %u\n", count);
+
+        /* We simply write it, perhaps after truncating it; we could do other
+           things, like modify it. */
+
+        phdr = wtap_phdr(wth);
+
+        if (snaplen != 0 && phdr->caplen > snaplen) {
+          snap_phdr = *phdr;
+          snap_phdr.caplen = snaplen;
+          phdr = &snap_phdr;
+        }
+
+        /* assume that if the frame's tv_sec is 0, then
+         * the timestamp isn't supported */
+        if (phdr->ts.secs > 0 && time_adj.tv.tv_sec != 0) {
+          snap_phdr = *phdr;
+          if (time_adj.is_negative)
+            snap_phdr.ts.secs -= time_adj.tv.tv_sec;
+          else
+            snap_phdr.ts.secs += time_adj.tv.tv_sec;
+          phdr = &snap_phdr;
+        }
+
+        /* assume that if the frame's tv_sec is 0, then
+         * the timestamp isn't supported */
+        if (phdr->ts.secs > 0 && time_adj.tv.tv_usec != 0) {
+          snap_phdr = *phdr;
+          if (time_adj.is_negative) { /* subtract */
+            if (snap_phdr.ts.nsecs/1000 < time_adj.tv.tv_usec) { /* borrow */
+              snap_phdr.ts.secs--;
+              snap_phdr.ts.nsecs += ONE_MILLION * 1000;
+            }
+            snap_phdr.ts.nsecs -= time_adj.tv.tv_usec * 1000;
+          } else {                  /* add */
+            if (snap_phdr.ts.nsecs + time_adj.tv.tv_usec * 1000 > ONE_MILLION * 1000) {
+              /* carry */
+              snap_phdr.ts.secs++;
+              snap_phdr.ts.nsecs += (time_adj.tv.tv_usec - ONE_MILLION) * 1000;
+            } else {
+              snap_phdr.ts.nsecs += time_adj.tv.tv_usec * 1000;
+            }
+          }
+          phdr = &snap_phdr;
+        }
+
+        if (err_prob > 0.0) {
+          buf = wtap_buf_ptr(wth);
+          for (i = 0; i < (int) phdr->caplen; i++) {
+            if (rand() <= err_prob * RAND_MAX) {
+              err_type = rand() / (RAND_MAX / ERR_WT_TOTAL + 1);
+
+              if (err_type < ERR_WT_BIT) {
+                buf[i] ^= 1 << (rand() / (RAND_MAX / 8 + 1));
+                err_type = ERR_WT_TOTAL;
+              } else {
+                err_type -= ERR_WT_BYTE;
+              }
+
+              if (err_type < ERR_WT_BYTE) {
+                buf[i] = rand() / (RAND_MAX / 255 + 1);
+                err_type = ERR_WT_TOTAL;
+              } else {
+                err_type -= ERR_WT_BYTE;
+              }
+
+              if (err_type < ERR_WT_ALNUM) {
+                buf[i] = ALNUM_CHARS[rand() / (RAND_MAX / ALNUM_LEN + 1)];
+                err_type = ERR_WT_TOTAL;
+              } else {
+                err_type -= ERR_WT_ALNUM;
+              }
+
+              if (err_type < ERR_WT_FMT) {
+                if ((unsigned int)i < phdr->caplen - 2)
+                  strcpy(&buf[i],  "%s");
+                err_type = ERR_WT_TOTAL;
+              } else {
+                err_type -= ERR_WT_FMT;
+              }
+
+              if (err_type < ERR_WT_AA) {
+                for (j = i; j < (int) phdr->caplen; j++) {
+                  buf[j] = 0xAA;
+                }
+                i = phdr->caplen;
+              }
+            }
+          }
+        }
+
+        if (!wtap_dump(pdh, phdr, wtap_pseudoheader(wth), wtap_buf_ptr(wth),
+                       &err)) {
+
+          fprintf(stderr, "editcap: Error writing to %s: %s\n",
+                  argv[optind + 1], wtap_strerror(err));
+          exit(1);
+
+       }
 
+      }
+
+      count++;
+
+    }
+
+    if (err != 0) {
+      /* Print a message noting that the read failed somewhere along the line. */
+      fprintf(stderr,
+              "editcap: An error occurred while reading \"%s\": %s.\n",
+             argv[optind], wtap_strerror(err));
+      switch (err) {
+
+      case WTAP_ERR_UNSUPPORTED:
+      case WTAP_ERR_UNSUPPORTED_ENCAP:
+      case WTAP_ERR_BAD_RECORD:
+       fprintf(stderr, "(%s)\n", err_info);
+       break;
+      }
+    }
+
+    if (!wtap_dump_close(pdh, &err)) {
+
+      fprintf(stderr, "editcap: Error writing to %s: %s\n", argv[optind + 1],
+             wtap_strerror(err));
+      exit(1);
+
+    }
   }
-  exit(0);
+
+  return 0;
 }
-  
+