editcap.c

   1 /* Edit capture files.  We can delete records, adjust timestamps, or
   2  * simply convert from one format to another format.
   3  *
   4  * $Id$
   5  *
   6  * Originally written by Richard Sharpe.
   7  * Improved by Guy Harris.
   8  * Further improved by Richard Sharpe.
   9  */
  10
  11 #ifdef HAVE_CONFIG_H
  12 #include "config.h"
  13 #endif
  14
  15 #include <stdio.h>
  16 #include <stdlib.h>
  17 #include <glib.h>
  18
  19 #ifdef HAVE_UNISTD_H
  20 #include <unistd.h>
  21 #endif
  22
  23 #include <time.h>
  24 #ifdef HAVE_SYS_TIME_H
  25 #include <sys/time.h>
  26 #endif
  27
  28 #include <string.h>
  29 #include "wtap.h"
  30
  31 #ifdef NEED_GETOPT_H
  32 #include "getopt.h"
  33 #endif
  34
  35 #ifdef _WIN32
  36 #include <process.h>    /* getpid */
  37 #endif
  38
  39 /*
  40  * Some globals so we can pass things to various routines
  41  */
  42
  43 struct select_item {
  44
  45   int inclusive;
  46   int first, second;
  47
  48 };
  49
  50 #define ONE_MILLION 1000000
  51
  52 /* Weights of different errors we can introduce */
  53 /* We should probably make these command-line arguments */
  54 /* XXX - Should we add a bit-level error? */
  55 #define ERR_WT_BIT   5  /* Flip a random bit */
  56 #define ERR_WT_BYTE  5  /* Substitute a random byte */
  57 #define ERR_WT_ALNUM 5  /* Substitute a random character in [A-Za-z0-9] */
  58 #define ERR_WT_FMT   2  /* Substitute "%s" */
  59 #define ERR_WT_AA    1  /* Fill the remainder of the buffer with 0xAA */
  60 #define ERR_WT_TOTAL (ERR_WT_BIT + ERR_WT_BYTE + ERR_WT_ALNUM + ERR_WT_FMT + ERR_WT_AA)
  61
  62 #define ALNUM_CHARS "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"
  63 #define ALNUM_LEN (sizeof(ALNUM_CHARS) - 1)
  64
  65
  66 struct time_adjustment {
  67   struct timeval tv;
  68   int is_negative;
  69 };
  70
  71 static struct select_item selectfrm[100];
  72 static int max_selected = -1;
  73 static int keep_em = 0;
  74 static int out_file_type = WTAP_FILE_PCAP;   /* default to "libpcap"   */
  75 static int out_frame_type = -2;              /* Leave frame type alone */
  76 static int verbose = 0;                      /* Not so verbose         */
  77 static struct time_adjustment time_adj = {{0, 0}, 0}; /* no adjustment */
  78 static double err_prob = 0.0;
  79
  80 /* Add a selection item, a simple parser for now */
  81
  82 static void add_selection(char *sel)
  83 {
  84   char *locn;
  85   char *next;
  86
  87   if (max_selected == (sizeof(selectfrm)/sizeof(struct select_item)) - 1)
  88     return;
  89
  90   printf("Add_Selected: %s\n", sel);
  91
  92   if ((locn = strchr(sel, '-')) == NULL) { /* No dash, so a single number? */
  93
  94     printf("Not inclusive ...");
  95
  96     max_selected++;
  97     selectfrm[max_selected].inclusive = 0;
  98     selectfrm[max_selected].first = atoi(sel);
  99
 100     printf(" %i\n", selectfrm[max_selected].first);
 101
 102   }
 103   else {
 104
 105     printf("Inclusive ...");
 106
 107     next = locn + 1;
 108     max_selected++;
 109     selectfrm[max_selected].inclusive = 1;
 110     selectfrm[max_selected].first = atoi(sel);
 111     selectfrm[max_selected].second = atoi(next);
 112
 113     printf(" %i, %i\n", selectfrm[max_selected].first, selectfrm[max_selected].second);
 114
 115   }
 116
 117
 118 }
 119
 120 /* Was the record selected? */
 121
 122 static int selected(int recno)
 123 {
 124   int i = 0;
 125
 126   for (i = 0; i<= max_selected; i++) {
 127
 128     if (selectfrm[i].inclusive) {
 129       if (selectfrm[i].first <= recno && selectfrm[i].second >= recno)
 130         return 1;
 131     }
 132     else {
 133       if (recno == selectfrm[i].first)
 134         return 1;
 135     }
 136   }
 137
 138   return 0;
 139
 140 }
 141
 142 static void
 143 set_time_adjustment(char *optarg)
 144 {
 145   char *frac, *end;
 146   long val;
 147   int frac_digits;
 148
 149   if (!optarg)
 150     return;
 151
 152   /* skip leading whitespace */
 153   while (*optarg == ' ' || *optarg == '\t') {
 154       optarg++;
 155   }
 156
 157   /* check for a negative adjustment */
 158   if (*optarg == '-') {
 159       time_adj.is_negative = 1;
 160       optarg++;
 161   }
 162
 163   /* collect whole number of seconds, if any */
 164   if (*optarg == '.') {         /* only fractional (i.e., .5 is ok) */
 165       val  = 0;
 166       frac = optarg;
 167   } else {
 168       val = strtol(optarg, &frac, 10);
 169       if (frac == NULL || frac == optarg || val == LONG_MIN || val == LONG_MAX) {
 170           fprintf(stderr, "editcap: \"%s\" isn't a valid time adjustment\n",
 171                   optarg);
 172           exit(1);
 173       }
 174       if (val < 0) {            /* implies '--' since we caught '-' above  */
 175           fprintf(stderr, "editcap: \"%s\" isn't a valid time adjustment\n",
 176                   optarg);
 177           exit(1);
 178       }
 179   }
 180   time_adj.tv.tv_sec = val;
 181
 182   /* now collect the partial seconds, if any */
 183   if (*frac != '\0') {             /* chars left, so get fractional part */
 184     val = strtol(&(frac[1]), &end, 10);
 185     if (*frac != '.' || end == NULL || end == frac
 186         || val < 0 || val > ONE_MILLION || val == LONG_MIN || val == LONG_MAX) {
 187       fprintf(stderr, "editcap: \"%s\" isn't a valid time adjustment\n",
 188               optarg);
 189       exit(1);
 190     }
 191   }
 192   else {
 193     return;                     /* no fractional digits */
 194   }
 195
 196   /* adjust fractional portion from fractional to numerator
 197    * e.g., in "1.5" from 5 to 500000 since .5*10^6 = 500000 */
 198   if (frac && end) {            /* both are valid */
 199     frac_digits = end - frac - 1;   /* fractional digit count (remember '.') */
 200     while(frac_digits < 6) {    /* this is frac of 10^6 */
 201       val *= 10;
 202       frac_digits++;
 203     }
 204   }
 205   time_adj.tv.tv_usec = val;
 206 }
 207
 208 static void usage(void)
 209 {
 210   int i;
 211   const char *string;
 212
 213   fprintf(stderr, "Usage: editcap [-r] [-h] [-v] [-T <encap type>] [-E <probability>]\n");
 214   fprintf(stderr, "               [-F <capture type>] [-s <snaplen>] [-t <time adjustment>]\n");
 215   fprintf(stderr, "               <infile> <outfile> [ <record#>[-<record#>] ... ]\n");
 216   fprintf(stderr, "  where\n");
 217   fprintf(stderr, "       \t-E <probability> specifies the probability (between 0 and 1)\n");
 218   fprintf(stderr, "       \t    that a particular byte will will have an error.\n");
 219   fprintf(stderr, "       \t-F <capture type> specifies the capture file type to write:\n");
 220   for (i = 0; i < WTAP_NUM_FILE_TYPES; i++) {
 221     if (wtap_dump_can_open(i))
 222       fprintf(stderr, "       \t    %s - %s\n",
 223         wtap_file_type_short_string(i), wtap_file_type_string(i));
 224   }
 225   fprintf(stderr, "       \t    default is libpcap\n");
 226   fprintf(stderr, "       \t-h produces this help listing.\n");
 227   fprintf(stderr, "       \t-r specifies that the records specified should be kept, not deleted, \n");
 228   fprintf(stderr, "                           default is to delete\n");
 229   fprintf(stderr, "       \t-s <snaplen> specifies that packets should be truncated to\n");
 230   fprintf(stderr, "       \t   <snaplen> bytes of data\n");
 231   fprintf(stderr, "       \t-t <time adjustment> specifies the time adjustment\n");
 232   fprintf(stderr, "       \t   to be applied to selected packets\n");
 233   fprintf(stderr, "       \t-T <encap type> specifies the encapsulation type to use:\n");
 234   for (i = 0; i < WTAP_NUM_ENCAP_TYPES; i++) {
 235       string = wtap_encap_short_string(i);
 236       if (string != NULL)
 237         fprintf(stderr, "       \t    %s - %s\n",
 238           string, wtap_encap_string(i));
 239   }
 240   fprintf(stderr, "       \t    default is the same as the input file\n");
 241   fprintf(stderr, "       \t-v specifies verbose operation, default is silent\n");
 242   fprintf(stderr, "\n      \t    A range of records can be specified as well\n");
 243 }
 244
 245 int main(int argc, char *argv[])
 246
 247 {
 248   wtap *wth;
 249   int i, j, err;
 250   gchar *err_info;
 251   extern char *optarg;
 252   extern int optind;
 253   int opt;
 254   char *p;
 255   unsigned int snaplen = 0;             /* No limit               */
 256   wtap_dumper *pdh;
 257   int count = 1;
 258   long data_offset;
 259   struct wtap_pkthdr snap_phdr;
 260   const struct wtap_pkthdr *phdr;
 261   int err_type;
 262   guint8 *buf;
 263
 264   /* Process the options first */
 265
 266   while ((opt = getopt(argc, argv, "E:F:hrs:t:T:v")) !=-1) {
 267
 268     switch (opt) {
 269
 270     case 'E':
 271       err_prob = strtod(optarg, &p);
 272       if (p == optarg || err_prob < 0.0 || err_prob > 1.0) {
 273         fprintf(stderr, "editcap: probability \"%s\" must be between 0.0 and 1.0\n",
 274             optarg);
 275         exit(1);
 276       }
 277       srand(time(NULL) + getpid());
 278       break;
 279
 280     case 'F':
 281       out_file_type = wtap_short_string_to_file_type(optarg);
 282       if (out_file_type < 0) {
 283         fprintf(stderr, "editcap: \"%s\" isn't a valid capture file type\n",
 284             optarg);
 285         exit(1);
 286       }
 287       break;
 288
 289     case 'h':
 290     case '?':              /* Bad options if GNU getopt */
 291       usage();
 292       exit(1);
 293       break;
 294
 295     case 'r':
 296       keep_em = !keep_em;  /* Just invert */
 297       break;
 298
 299     case 's':
 300       snaplen = strtol(optarg, &p, 10);
 301       if (p == optarg || *p != '\0') {
 302         fprintf(stderr, "editcap: \"%s\" isn't a valid snapshot length\n",
 303             optarg);
 304         exit(1);
 305       }
 306       break;
 307
 308     case 't':
 309       set_time_adjustment(optarg);
 310       break;
 311
 312     case 'T':
 313       out_frame_type = wtap_short_string_to_encap(optarg);
 314       if (out_frame_type < 0) {
 315         fprintf(stderr, "editcap: \"%s\" isn't a valid encapsulation type\n",
 316             optarg);
 317         exit(1);
 318       }
 319       break;
 320
 321     case 'v':
 322       verbose = !verbose;  /* Just invert */
 323       break;
 324
 325     }
 326
 327   }
 328
 329 #ifdef DEBUG
 330   printf("Optind = %i, argc = %i\n", optind, argc);
 331 #endif
 332
 333   if ((argc - optind) < 1) {
 334
 335     usage();
 336     exit(1);
 337
 338   }
 339
 340   wth = wtap_open_offline(argv[optind], &err, &err_info, FALSE);
 341
 342   if (!wth) {
 343     fprintf(stderr, "editcap: Can't open %s: %s\n", argv[optind],
 344         wtap_strerror(err));
 345     switch (err) {
 346
 347     case WTAP_ERR_UNSUPPORTED:
 348     case WTAP_ERR_UNSUPPORTED_ENCAP:
 349     case WTAP_ERR_BAD_RECORD:
 350       fprintf(stderr, "(%s)\n", err_info);
 351       g_free(err_info);
 352       break;
 353     }
 354     exit(1);
 355
 356   }
 357
 358   if (verbose) {
 359
 360     fprintf(stderr, "File %s is a %s capture file.\n", argv[optind],
 361             wtap_file_type_string(wtap_file_type(wth)));
 362
 363   }
 364
 365   /*
 366    * Now, process the rest, if any ... we only write if there is an extra
 367    * argument or so ...
 368    */
 369
 370   if ((argc - optind) >= 2) {
 371
 372     if (out_frame_type == -2)
 373       out_frame_type = wtap_file_encap(wth);
 374
 375     pdh = wtap_dump_open(argv[optind + 1], out_file_type,
 376                          out_frame_type, wtap_snapshot_length(wth), &err);
 377     if (pdh == NULL) {
 378
 379       fprintf(stderr, "editcap: Can't open or create %s: %s\n", argv[optind+1],
 380               wtap_strerror(err));
 381       exit(1);
 382
 383     }
 384
 385     for (i = optind + 2; i < argc; i++)
 386       add_selection(argv[i]);
 387
 388     while (wtap_read(wth, &err, &err_info, &data_offset)) {
 389
 390       if ((!selected(count) && !keep_em) ||
 391           (selected(count) && keep_em)) {
 392
 393         if (verbose)
 394           printf("Record: %u\n", count);
 395
 396         /* We simply write it, perhaps after truncating it; we could do other
 397            things, like modify it. */
 398
 399         phdr = wtap_phdr(wth);
 400
 401         if (snaplen != 0 && phdr->caplen > snaplen) {
 402           snap_phdr = *phdr;
 403           snap_phdr.caplen = snaplen;
 404           phdr = &snap_phdr;
 405         }
 406
 407         /* assume that if the frame's tv_sec is 0, then
 408          * the timestamp isn't supported */
 409         if (phdr->ts.tv_sec > 0 && time_adj.tv.tv_sec != 0) {
 410           snap_phdr = *phdr;
 411           if (time_adj.is_negative)
 412             snap_phdr.ts.tv_sec -= time_adj.tv.tv_sec;
 413           else
 414             snap_phdr.ts.tv_sec += time_adj.tv.tv_sec;
 415           phdr = &snap_phdr;
 416         }
 417
 418         /* assume that if the frame's tv_sec is 0, then
 419          * the timestamp isn't supported */
 420         if (phdr->ts.tv_sec > 0 && time_adj.tv.tv_usec != 0) {
 421           snap_phdr = *phdr;
 422           if (time_adj.is_negative) { /* subtract */
 423             if (snap_phdr.ts.tv_usec < time_adj.tv.tv_usec) { /* borrow */
 424               snap_phdr.ts.tv_sec--;
 425               snap_phdr.ts.tv_usec += ONE_MILLION;
 426             }
 427             snap_phdr.ts.tv_usec -= time_adj.tv.tv_usec;
 428           } else {                  /* add */
 429             if (snap_phdr.ts.tv_usec + time_adj.tv.tv_usec > ONE_MILLION) {
 430               /* carry */
 431               snap_phdr.ts.tv_sec++;
 432               snap_phdr.ts.tv_usec += time_adj.tv.tv_usec - ONE_MILLION;
 433             } else {
 434               snap_phdr.ts.tv_usec += time_adj.tv.tv_usec;
 435             }
 436           }
 437           phdr = &snap_phdr;
 438         }
 439
 440         if (err_prob > 0.0) {
 441           buf = wtap_buf_ptr(wth);
 442           for (i = 0; i < (int) phdr->caplen; i++) {
 443             if (rand() <= err_prob * RAND_MAX) {
 444               err_type = rand() / (RAND_MAX / ERR_WT_TOTAL + 1);
 445
 446               if (err_type < ERR_WT_BIT) {
 447                 buf[i] ^= 1 << (rand() / (RAND_MAX / 8 + 1));
 448                 err_type = ERR_WT_TOTAL;
 449               } else {
 450                 err_type -= ERR_WT_BYTE;
 451               }
 452
 453               if (err_type < ERR_WT_BYTE) {
 454                 buf[i] = rand() / (RAND_MAX / 255 + 1);
 455                 err_type = ERR_WT_TOTAL;
 456               } else {
 457                 err_type -= ERR_WT_BYTE;
 458               }
 459
 460               if (err_type < ERR_WT_ALNUM) {
 461                 buf[i] = ALNUM_CHARS[rand() / (RAND_MAX / ALNUM_LEN + 1)];
 462                 err_type = ERR_WT_TOTAL;
 463               } else {
 464                 err_type -= ERR_WT_ALNUM;
 465               }
 466
 467               if (err_type < ERR_WT_FMT) {
 468                 if ((unsigned int)i < phdr->caplen - 2)
 469                   strcpy(&buf[i],  "%s");
 470                 err_type = ERR_WT_TOTAL;
 471               } else {
 472                 err_type -= ERR_WT_FMT;
 473               }
 474
 475               if (err_type < ERR_WT_AA) {
 476                 for (j = i; j < (int) phdr->caplen; j++) {
 477                   buf[j] = 0xAA;
 478                 }
 479                 i = phdr->caplen;
 480               }
 481             }
 482           }
 483         }
 484
 485         if (!wtap_dump(pdh, phdr, wtap_pseudoheader(wth), wtap_buf_ptr(wth),
 486                        &err)) {
 487
 488           fprintf(stderr, "editcap: Error writing to %s: %s\n",
 489                   argv[optind + 1], wtap_strerror(err));
 490           exit(1);
 491
 492         }
 493
 494       }
 495
 496       count++;
 497
 498     }
 499
 500     if (err != 0) {
 501       /* Print a message noting that the read failed somewhere along the line. */
 502       fprintf(stderr,
 503               "editcap: An error occurred while reading \"%s\": %s.\n",
 504               argv[optind], wtap_strerror(err));
 505       switch (err) {
 506
 507       case WTAP_ERR_UNSUPPORTED:
 508       case WTAP_ERR_UNSUPPORTED_ENCAP:
 509       case WTAP_ERR_BAD_RECORD:
 510         fprintf(stderr, "(%s)\n", err_info);
 511         break;
 512       }
 513     }
 514
 515     if (!wtap_dump_close(pdh, &err)) {
 516
 517       fprintf(stderr, "editcap: Error writing to %s: %s\n", argv[optind + 1],
 518               wtap_strerror(err));
 519       exit(1);
 520
 521     }
 522   }
 523
 524   return 0;
 525 }
 526