wiretap/file.c

   1 /* file.c
   2  *
   3  * $Id: file.c,v 1.51 2000/05/18 09:09:25 guy Exp $
   4  *
   5  * Wiretap Library
   6  * Copyright (c) 1998 by Gilbert Ramirez <gram@xiexie.org>
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * as published by the Free Software Foundation; either version 2
  11  * of the License, or (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  21  *
  22  */
  23 #ifdef HAVE_CONFIG_H
  24 #include "config.h"
  25 #endif
  26
  27 #include <stdio.h>
  28 #include <fcntl.h>
  29 #include <string.h>
  30 #include <stdlib.h>
  31 #include <sys/stat.h>
  32 #include <errno.h>
  33
  34 #ifdef HAVE_IO_H
  35 #include <io.h> /* open/close on win32 */
  36 #endif
  37
  38 #include "wtap.h"
  39 #include "file_wrappers.h"
  40 #include "buffer.h"
  41 #include "lanalyzer.h"
  42 #include "ngsniffer.h"
  43 #include "radcom.h"
  44 #include "ascend.h"
  45 #include "nettl.h"
  46 #include "libpcap.h"
  47 #include "snoop.h"
  48 #include "iptrace.h"
  49 #include "netmon.h"
  50 #include "netxray.h"
  51 #include "toshiba.h"
  52 #include "i4btrace.h"
  53
  54 /* The open_file_* routines should return:
  55  *
  56  *      -1 on an I/O error;
  57  *
  58  *      1 if the file they're reading is one of the types it handles;
  59  *
  60  *      0 if the file they're reading isn't the type they're checking for.
  61  *
  62  * If the routine handles this type of file, it should set the "file_type"
  63  * field in the "struct wtap" to the type of the file.
  64  *
  65  * XXX - I need to drag my damn ANSI C spec in to figure out how to
  66  * declare a "const" array of pointers to functions; putting "const"
  67  * right after "static" isn't the right answer, at least according
  68  * to GCC, which whines if I do that.
  69  *
  70  * Put the trace files that are merely saved telnet-sessions last, since it's
  71  * possible that you could have captured someone a router telnet-session
  72  * using another tool. So, a libpcap trace of an toshiba "snoop" session
  73  * should be discovered as a libpcap file, not a toshiba file.
  74  */
  75
  76 static int (*open_routines[])(wtap *, int *) = {
  77         /* Files that have magic bytes in fixed locations. These
  78          * are easy to identify.
  79          */
  80         libpcap_open,
  81         lanalyzer_open,
  82         ngsniffer_open,
  83         snoop_open,
  84         iptrace_open,
  85         netmon_open,
  86         netxray_open,
  87         radcom_open,
  88         nettl_open,
  89
  90         /* Files whose magic headers are in text *somewhere* in the
  91          * file (usually because the trace is just a saved copy of
  92          * the telnet session).
  93          */
  94         ascend_open,
  95         toshiba_open,
  96         i4btrace_open,
  97 };
  98
  99 int wtap_def_seek_read(wtap *wth, int seek_off,
 100         union pseudo_header *pseudo_header, guint8 *pd, int len)
 101 {
 102         file_seek(wth->random_fh, seek_off, SEEK_SET);
 103
 104         return file_read(pd, sizeof(guint8), len, wth->random_fh);
 105 }
 106
 107 #define N_FILE_TYPES    (sizeof open_routines / sizeof open_routines[0])
 108
 109 /* Opens a file and prepares a wtap struct.
 110    If "do_random" is TRUE, it opens the file twice; the second open
 111    allows the application to do random-access I/O without moving
 112    the seek offset for sequential I/O, which is used by Ethereal
 113    so that it can do sequential I/O to a capture file that's being
 114    written to as new packets arrive independently of random I/O done
 115    to display protocol trees for packets when they're selected. */
 116 wtap* wtap_open_offline(const char *filename, int *err, gboolean do_random)
 117 {
 118         struct stat statb;
 119         wtap    *wth;
 120         int     i;
 121
 122         /* First, make sure the file is valid */
 123         if (stat(filename, &statb) < 0) {
 124                 *err = errno;
 125                 return NULL;
 126         }
 127 #ifndef WIN32
 128         if (! S_ISREG(statb.st_mode) && ! S_ISFIFO(statb.st_mode)) {
 129                 *err = WTAP_ERR_NOT_REGULAR_FILE;
 130                 return NULL;
 131         }
 132 #endif
 133
 134         errno = ENOMEM;
 135         wth = g_malloc(sizeof(wtap));
 136         if (wth == NULL) {
 137                 *err = errno;
 138                 return NULL;
 139         }
 140
 141 /* Win32 needs the O_BINARY flag for open() */
 142 #ifndef O_BINARY
 143 #define O_BINARY        0
 144 #endif
 145
 146         /* Open the file */
 147         errno = WTAP_ERR_CANT_OPEN;
 148         if (!(wth->fd = open(filename, O_RDONLY|O_BINARY))) {
 149                 *err = errno;
 150                 g_free(wth);
 151                 return NULL;
 152         }
 153         if (!(wth->fh = filed_open(wth->fd, "rb"))) {
 154                 *err = errno;
 155                 g_free(wth);
 156                 return NULL;
 157         }
 158
 159         if (do_random) {
 160                 if (!(wth->random_fh = file_open(filename, "rb"))) {
 161                         *err = errno;
 162                         file_close(wth->fh);
 163                         g_free(wth);
 164                         return NULL;
 165                 }
 166         } else
 167                 wth->random_fh = NULL;
 168
 169         /* initialization */
 170         wth->file_encap = WTAP_ENCAP_UNKNOWN;
 171         wth->data_offset = 0;
 172         wth->subtype_close = NULL;
 173
 174         /* Try all file types */
 175         for (i = 0; i < N_FILE_TYPES; i++) {
 176                 switch ((*open_routines[i])(wth, err)) {
 177
 178                 case -1:
 179                         /* I/O error - give up */
 180                         file_close(wth->fh);
 181                         g_free(wth);
 182                         return NULL;
 183
 184                 case 0:
 185                         /* No I/O error, but not that type of file */
 186                         break;
 187
 188                 case 1:
 189                         /* We found the file type */
 190                         goto success;
 191                 }
 192         }
 193
 194         /* Well, it's not one of the types of file we know about. */
 195         if (wth->random_fh != NULL)
 196                 file_close(wth->random_fh);
 197         file_close(wth->fh);
 198         g_free(wth);
 199         *err = WTAP_ERR_FILE_UNKNOWN_FORMAT;
 200         return NULL;
 201
 202 success:
 203         wth->frame_buffer = g_malloc(sizeof(struct Buffer));
 204         buffer_init(wth->frame_buffer, 1500);
 205         return wth;
 206 }
 207
 208 /* Table of the file types we know about. */
 209 const static struct file_type_info {
 210         const char *name;
 211         const char *short_name;
 212         int     (*can_write_encap)(int, int);
 213         int     (*dump_open)(wtap_dumper *, int *);
 214 } dump_open_table[WTAP_NUM_FILE_TYPES] = {
 215         /* WTAP_FILE_UNKNOWN */
 216         { NULL, NULL,
 217           NULL, NULL },
 218
 219         /* WTAP_FILE_WTAP */
 220         { "Wiretap (Ethereal)", NULL,
 221           NULL, NULL },
 222
 223         /* WTAP_FILE_PCAP */
 224         { "libpcap (tcpdump, Ethereal, etc.)", "libpcap",
 225           libpcap_dump_can_write_encap, libpcap_dump_open },
 226
 227         /* WTAP_FILE_PCAP_MODIFIED */
 228         { "modified libpcap (tcpdump)", "modlibpcap",
 229           libpcap_dump_can_write_encap, libpcap_dump_open },
 230
 231         /* WTAP_FILE_PCAP_RH_6_1 */
 232         { "Red Hat Linux 6.1 libpcap (tcpdump)", "rh6_1libpcap",
 233           libpcap_dump_can_write_encap, libpcap_dump_open },
 234
 235         /* WTAP_FILE_LANALYZER */
 236         { "Novell LANalyzer", NULL,
 237           NULL, NULL },
 238
 239         /* WTAP_FILE_NGSNIFFER */
 240         { "Network Associates Sniffer (DOS-based)", "ngsniffer",
 241           ngsniffer_dump_can_write_encap, ngsniffer_dump_open },
 242
 243         /* WTAP_FILE_SNOOP */
 244         { "Sun snoop", "snoop",
 245           snoop_dump_can_write_encap, snoop_dump_open },
 246
 247         /* WTAP_FILE_IPTRACE_1_0 */
 248         { "AIX iptrace 1.0", NULL,
 249           NULL, NULL },
 250
 251         /* WTAP_FILE_IPTRACE_2_0 */
 252         { "AIX iptrace 2.0", NULL,
 253           NULL, NULL },
 254
 255         /* WTAP_FILE_NETMON_1_x */
 256         { "Microsoft Network Monitor 1.x", "netmon1",
 257           netmon_dump_can_write_encap, netmon_dump_open },
 258
 259         /* WTAP_FILE_NETMON_2_x */
 260         { "Microsoft Network Monitor 2.x", NULL,
 261           NULL, NULL },
 262
 263         /* WTAP_FILE_NETXRAY_1_0 */
 264         { "Cinco Networks NetXRay", NULL,
 265           NULL, NULL },
 266
 267         /* WTAP_FILE_NETXRAY_1_1 */
 268         { "Network Associates Sniffer (Windows-based) 1.1", "ngwsniffer_1_1",
 269           netxray_dump_can_write_encap, netxray_dump_open_1_1 },
 270
 271         /* WTAP_FILE_NETXRAY_2_001 */
 272         { "Network Associates Sniffer (Windows-based) 2.001", NULL,
 273           NULL, NULL },
 274
 275         /* WTAP_FILE_RADCOM */
 276         { "RADCOM WAN/LAN analyzer", NULL,
 277           NULL, NULL },
 278
 279         /* WTAP_FILE_ASCEND */
 280         { "Lucent/Ascend access server trace", NULL,
 281           NULL, NULL },
 282
 283         /* WTAP_FILE_NETTL */
 284         { "HP-UX nettl trace", NULL,
 285           NULL, NULL },
 286
 287         /* WTAP_FILE_TOSHIBA */
 288         { "Toshiba Compact ISDN Router snoop trace", NULL,
 289           NULL, NULL },
 290
 291         /* WTAP_FILE_I4BTRACE */
 292         { "I4B ISDN trace", NULL,
 293           NULL, NULL },
 294
 295 };
 296
 297 /* Name that should be somewhat descriptive. */
 298 const char *wtap_file_type_string(int filetype)
 299 {
 300         if (filetype < 0 || filetype >= WTAP_NUM_FILE_TYPES) {
 301                 g_error("Unknown capture file type %d", filetype);
 302                 return NULL;
 303         } else
 304                 return dump_open_table[filetype].name;
 305 }
 306
 307 /* Name to use in, say, a command-line flag specifying the type. */
 308 const char *wtap_file_type_short_string(int filetype)
 309 {
 310         if (filetype < 0 || filetype >= WTAP_NUM_FILE_TYPES)
 311                 return NULL;
 312         else
 313                 return dump_open_table[filetype].short_name;
 314 }
 315
 316 /* Translate a short name to a capture file type. */
 317 int wtap_short_string_to_file_type(const char *short_name)
 318 {
 319         int filetype;
 320
 321         for (filetype = 0; filetype < WTAP_NUM_FILE_TYPES; filetype++) {
 322                 if (dump_open_table[filetype].short_name != NULL &&
 323                     strcmp(short_name, dump_open_table[filetype].short_name) == 0)
 324                         return filetype;
 325         }
 326         return -1;      /* no such file type, or we can't write it */
 327 }
 328
 329 gboolean wtap_dump_can_open(int filetype)
 330 {
 331         if (filetype < 0 || filetype >= WTAP_NUM_FILE_TYPES
 332             || dump_open_table[filetype].dump_open == NULL)
 333                 return FALSE;
 334
 335         return TRUE;
 336 }
 337
 338 gboolean wtap_dump_can_write_encap(int filetype, int encap)
 339 {
 340         if (filetype < 0 || filetype >= WTAP_NUM_FILE_TYPES
 341             || dump_open_table[filetype].can_write_encap == NULL)
 342                 return FALSE;
 343
 344         if ((*dump_open_table[filetype].can_write_encap)(filetype, encap) != 0)
 345                 return FALSE;
 346
 347         return TRUE;
 348 }
 349
 350 static wtap_dumper* wtap_dump_open_common(FILE *fh, int filetype,
 351     int encap, int snaplen, int *err);
 352
 353 wtap_dumper* wtap_dump_open(const char *filename, int filetype, int encap,
 354                                 int snaplen, int *err)
 355 {
 356         FILE *fh;
 357
 358         /* In case "fopen()" fails but doesn't set "errno", set "errno"
 359            to a generic "the open failed" error. */
 360         errno = WTAP_ERR_CANT_OPEN;
 361         fh = fopen(filename, "wb");
 362         if (fh == NULL) {
 363                 *err = errno;
 364                 return NULL;    /* can't create file */
 365         }
 366         return wtap_dump_open_common(fh, filetype, encap, snaplen, err);
 367 }
 368
 369 wtap_dumper* wtap_dump_fdopen(int fd, int filetype, int encap, int snaplen,
 370                                 int *err)
 371 {
 372         FILE *fh;
 373
 374         /* In case "fopen()" fails but doesn't set "errno", set "errno"
 375            to a generic "the open failed" error. */
 376         errno = WTAP_ERR_CANT_OPEN;
 377         fh = fdopen(fd, "wb");
 378         if (fh == NULL) {
 379                 *err = errno;
 380                 return NULL;    /* can't create standard I/O stream */
 381         }
 382         return wtap_dump_open_common(fh, filetype, encap, snaplen, err);
 383 }
 384
 385 static wtap_dumper* wtap_dump_open_common(FILE *fh, int filetype, int encap,
 386                                         int snaplen, int *err)
 387 {
 388         wtap_dumper *wdh;
 389
 390         if (filetype < 0 || filetype >= WTAP_NUM_FILE_TYPES
 391             || dump_open_table[filetype].dump_open == NULL) {
 392                 /* Invalid type, or type we don't know how to write. */
 393                 *err = WTAP_ERR_UNSUPPORTED_FILE_TYPE;
 394                 /* NOTE: this means the FD handed to "wtap_dump_fdopen()"
 395                    will be closed if we can't write that file type. */
 396                 fclose(fh);
 397                 return NULL;
 398         }
 399
 400         /* OK, we know how to write that type; can we write the specified
 401            encapsulation type? */
 402         *err = (*dump_open_table[filetype].can_write_encap)(filetype, encap);
 403         if (*err != 0) {
 404                 /* NOTE: this means the FD handed to "wtap_dump_fdopen()"
 405                    will be closed if we can't write that encapsulation type. */
 406                 fclose(fh);
 407                 return NULL;
 408         }
 409
 410         /* OK, we can write the specified encapsulation type.  Allocate
 411            a data structure for the output stream. */
 412         wdh = g_malloc(sizeof (wtap_dumper));
 413         if (wdh == NULL) {
 414                 *err = errno;
 415                 /* NOTE: this means the FD handed to "wtap_dump_fdopen()"
 416                    will be closed if the malloc fails. */
 417                 fclose(fh);
 418                 return NULL;
 419         }
 420         wdh->fh = fh;
 421         wdh->file_type = filetype;
 422         wdh->snaplen = snaplen;
 423         wdh->encap = encap;
 424         wdh->dump.opaque = NULL;
 425         wdh->subtype_write = NULL;
 426         wdh->subtype_close = NULL;
 427
 428         /* Now try to open the file for writing. */
 429         if (!(*dump_open_table[filetype].dump_open)(wdh, err)) {
 430                 /* The attempt failed. */
 431                 g_free(wdh);
 432                 /* NOTE: this means the FD handed to "wtap_dump_fdopen()"
 433                    will be closed if the open fails. */
 434                 fclose(fh);
 435                 return NULL;
 436         }
 437
 438         return wdh;     /* success! */
 439 }
 440
 441 FILE* wtap_dump_file(wtap_dumper *wdh)
 442 {
 443         return wdh->fh;
 444 }
 445
 446 gboolean wtap_dump(wtap_dumper *wdh, const struct wtap_pkthdr *phdr,
 447     const union pseudo_header *pseudo_header, const u_char *pd, int *err)
 448 {
 449         return (wdh->subtype_write)(wdh, phdr, pseudo_header, pd, err);
 450 }
 451
 452 gboolean wtap_dump_close(wtap_dumper *wdh, int *err)
 453 {
 454         gboolean ret = TRUE;
 455
 456         if (wdh->subtype_close != NULL) {
 457                 /* There's a close routine for this dump stream. */
 458                 if (!(wdh->subtype_close)(wdh, err))
 459                         ret = FALSE;
 460         }
 461         errno = WTAP_ERR_CANT_CLOSE;
 462         if (fclose(wdh->fh) == EOF) {
 463                 if (ret) {
 464                         /* The per-format close function succeeded,
 465                            but the fclose didn't.  Save the reason
 466                            why, if our caller asked for it. */
 467                         if (err != NULL)
 468                                 *err = errno;
 469                 }
 470                 ret = FALSE;
 471         }
 472         if (wdh->dump.opaque != NULL)
 473                 g_free(wdh->dump.opaque);
 474         g_free(wdh);
 475         return ret;
 476 }