wiretap/file.c

   1 /* file.c
   2  *
   3  * $Id: file.c,v 1.53 2000/05/25 09:00:20 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-int.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 wtap_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_sequential_close = NULL;
 173         wth->subtype_close = NULL;
 174
 175         /* Try all file types */
 176         for (i = 0; i < N_FILE_TYPES; i++) {
 177                 switch ((*open_routines[i])(wth, err)) {
 178
 179                 case -1:
 180                         /* I/O error - give up */
 181                         file_close(wth->fh);
 182                         g_free(wth);
 183                         return NULL;
 184
 185                 case 0:
 186                         /* No I/O error, but not that type of file */
 187                         break;
 188
 189                 case 1:
 190                         /* We found the file type */
 191                         goto success;
 192                 }
 193         }
 194
 195         /* Well, it's not one of the types of file we know about. */
 196         if (wth->random_fh != NULL)
 197                 file_close(wth->random_fh);
 198         file_close(wth->fh);
 199         g_free(wth);
 200         *err = WTAP_ERR_FILE_UNKNOWN_FORMAT;
 201         return NULL;
 202
 203 success:
 204         wth->frame_buffer = g_malloc(sizeof(struct Buffer));
 205         buffer_init(wth->frame_buffer, 1500);
 206         return wth;
 207 }
 208
 209 /* Table of the file types we know about. */
 210 const static struct file_type_info {
 211         const char *name;
 212         const char *short_name;
 213         int     (*can_write_encap)(int, int);
 214         int     (*dump_open)(wtap_dumper *, int *);
 215 } dump_open_table[WTAP_NUM_FILE_TYPES] = {
 216         /* WTAP_FILE_UNKNOWN */
 217         { NULL, NULL,
 218           NULL, NULL },
 219
 220         /* WTAP_FILE_WTAP */
 221         { "Wiretap (Ethereal)", NULL,
 222           NULL, NULL },
 223
 224         /* WTAP_FILE_PCAP */
 225         { "libpcap (tcpdump, Ethereal, etc.)", "libpcap",
 226           libpcap_dump_can_write_encap, libpcap_dump_open },
 227
 228         /* WTAP_FILE_PCAP_MODIFIED */
 229         { "modified libpcap (tcpdump)", "modlibpcap",
 230           libpcap_dump_can_write_encap, libpcap_dump_open },
 231
 232         /* WTAP_FILE_PCAP_RH_6_1 */
 233         { "Red Hat Linux 6.1 libpcap (tcpdump)", "rh6_1libpcap",
 234           libpcap_dump_can_write_encap, libpcap_dump_open },
 235
 236         /* WTAP_FILE_LANALYZER */
 237         { "Novell LANalyzer", NULL,
 238           NULL, NULL },
 239
 240         /* WTAP_FILE_NGSNIFFER_UNCOMPRESSED */
 241         { "Network Associates Sniffer (DOS-based)", "ngsniffer",
 242           ngsniffer_dump_can_write_encap, ngsniffer_dump_open },
 243
 244         /* WTAP_FILE_NGSNIFFER_COMPRESSED */
 245         { "Network Associates Sniffer (DOS-based), compressed", "ngsniffer_comp",
 246           NULL, NULL },
 247
 248         /* WTAP_FILE_SNOOP */
 249         { "Sun snoop", "snoop",
 250           snoop_dump_can_write_encap, snoop_dump_open },
 251
 252         /* WTAP_FILE_IPTRACE_1_0 */
 253         { "AIX iptrace 1.0", NULL,
 254           NULL, NULL },
 255
 256         /* WTAP_FILE_IPTRACE_2_0 */
 257         { "AIX iptrace 2.0", NULL,
 258           NULL, NULL },
 259
 260         /* WTAP_FILE_NETMON_1_x */
 261         { "Microsoft Network Monitor 1.x", "netmon1",
 262           netmon_dump_can_write_encap, netmon_dump_open },
 263
 264         /* WTAP_FILE_NETMON_2_x */
 265         { "Microsoft Network Monitor 2.x", NULL,
 266           NULL, NULL },
 267
 268         /* WTAP_FILE_NETXRAY_1_0 */
 269         { "Cinco Networks NetXRay", NULL,
 270           NULL, NULL },
 271
 272         /* WTAP_FILE_NETXRAY_1_1 */
 273         { "Network Associates Sniffer (Windows-based) 1.1", "ngwsniffer_1_1",
 274           netxray_dump_can_write_encap, netxray_dump_open_1_1 },
 275
 276         /* WTAP_FILE_NETXRAY_2_001 */
 277         { "Network Associates Sniffer (Windows-based) 2.001", NULL,
 278           NULL, NULL },
 279
 280         /* WTAP_FILE_RADCOM */
 281         { "RADCOM WAN/LAN analyzer", NULL,
 282           NULL, NULL },
 283
 284         /* WTAP_FILE_ASCEND */
 285         { "Lucent/Ascend access server trace", NULL,
 286           NULL, NULL },
 287
 288         /* WTAP_FILE_NETTL */
 289         { "HP-UX nettl trace", NULL,
 290           NULL, NULL },
 291
 292         /* WTAP_FILE_TOSHIBA */
 293         { "Toshiba Compact ISDN Router snoop trace", NULL,
 294           NULL, NULL },
 295
 296         /* WTAP_FILE_I4BTRACE */
 297         { "I4B ISDN trace", NULL,
 298           NULL, NULL },
 299
 300 };
 301
 302 /* Name that should be somewhat descriptive. */
 303 const char *wtap_file_type_string(int filetype)
 304 {
 305         if (filetype < 0 || filetype >= WTAP_NUM_FILE_TYPES) {
 306                 g_error("Unknown capture file type %d", filetype);
 307                 return NULL;
 308         } else
 309                 return dump_open_table[filetype].name;
 310 }
 311
 312 /* Name to use in, say, a command-line flag specifying the type. */
 313 const char *wtap_file_type_short_string(int filetype)
 314 {
 315         if (filetype < 0 || filetype >= WTAP_NUM_FILE_TYPES)
 316                 return NULL;
 317         else
 318                 return dump_open_table[filetype].short_name;
 319 }
 320
 321 /* Translate a short name to a capture file type. */
 322 int wtap_short_string_to_file_type(const char *short_name)
 323 {
 324         int filetype;
 325
 326         for (filetype = 0; filetype < WTAP_NUM_FILE_TYPES; filetype++) {
 327                 if (dump_open_table[filetype].short_name != NULL &&
 328                     strcmp(short_name, dump_open_table[filetype].short_name) == 0)
 329                         return filetype;
 330         }
 331         return -1;      /* no such file type, or we can't write it */
 332 }
 333
 334 gboolean wtap_dump_can_open(int filetype)
 335 {
 336         if (filetype < 0 || filetype >= WTAP_NUM_FILE_TYPES
 337             || dump_open_table[filetype].dump_open == NULL)
 338                 return FALSE;
 339
 340         return TRUE;
 341 }
 342
 343 gboolean wtap_dump_can_write_encap(int filetype, int encap)
 344 {
 345         if (filetype < 0 || filetype >= WTAP_NUM_FILE_TYPES
 346             || dump_open_table[filetype].can_write_encap == NULL)
 347                 return FALSE;
 348
 349         if ((*dump_open_table[filetype].can_write_encap)(filetype, encap) != 0)
 350                 return FALSE;
 351
 352         return TRUE;
 353 }
 354
 355 static wtap_dumper* wtap_dump_open_common(FILE *fh, int filetype,
 356     int encap, int snaplen, int *err);
 357
 358 wtap_dumper* wtap_dump_open(const char *filename, int filetype, int encap,
 359                                 int snaplen, int *err)
 360 {
 361         FILE *fh;
 362
 363         /* In case "fopen()" fails but doesn't set "errno", set "errno"
 364            to a generic "the open failed" error. */
 365         errno = WTAP_ERR_CANT_OPEN;
 366         fh = fopen(filename, "wb");
 367         if (fh == NULL) {
 368                 *err = errno;
 369                 return NULL;    /* can't create file */
 370         }
 371         return wtap_dump_open_common(fh, filetype, encap, snaplen, err);
 372 }
 373
 374 wtap_dumper* wtap_dump_fdopen(int fd, int filetype, int encap, int snaplen,
 375                                 int *err)
 376 {
 377         FILE *fh;
 378
 379         /* In case "fopen()" fails but doesn't set "errno", set "errno"
 380            to a generic "the open failed" error. */
 381         errno = WTAP_ERR_CANT_OPEN;
 382         fh = fdopen(fd, "wb");
 383         if (fh == NULL) {
 384                 *err = errno;
 385                 return NULL;    /* can't create standard I/O stream */
 386         }
 387         return wtap_dump_open_common(fh, filetype, encap, snaplen, err);
 388 }
 389
 390 static wtap_dumper* wtap_dump_open_common(FILE *fh, int filetype, int encap,
 391                                         int snaplen, int *err)
 392 {
 393         wtap_dumper *wdh;
 394
 395         if (filetype < 0 || filetype >= WTAP_NUM_FILE_TYPES
 396             || dump_open_table[filetype].dump_open == NULL) {
 397                 /* Invalid type, or type we don't know how to write. */
 398                 *err = WTAP_ERR_UNSUPPORTED_FILE_TYPE;
 399                 /* NOTE: this means the FD handed to "wtap_dump_fdopen()"
 400                    will be closed if we can't write that file type. */
 401                 fclose(fh);
 402                 return NULL;
 403         }
 404
 405         /* OK, we know how to write that type; can we write the specified
 406            encapsulation type? */
 407         *err = (*dump_open_table[filetype].can_write_encap)(filetype, encap);
 408         if (*err != 0) {
 409                 /* NOTE: this means the FD handed to "wtap_dump_fdopen()"
 410                    will be closed if we can't write that encapsulation type. */
 411                 fclose(fh);
 412                 return NULL;
 413         }
 414
 415         /* OK, we can write the specified encapsulation type.  Allocate
 416            a data structure for the output stream. */
 417         wdh = g_malloc(sizeof (wtap_dumper));
 418         if (wdh == NULL) {
 419                 *err = errno;
 420                 /* NOTE: this means the FD handed to "wtap_dump_fdopen()"
 421                    will be closed if the malloc fails. */
 422                 fclose(fh);
 423                 return NULL;
 424         }
 425         wdh->fh = fh;
 426         wdh->file_type = filetype;
 427         wdh->snaplen = snaplen;
 428         wdh->encap = encap;
 429         wdh->dump.opaque = NULL;
 430         wdh->subtype_write = NULL;
 431         wdh->subtype_close = NULL;
 432
 433         /* Now try to open the file for writing. */
 434         if (!(*dump_open_table[filetype].dump_open)(wdh, err)) {
 435                 /* The attempt failed. */
 436                 g_free(wdh);
 437                 /* NOTE: this means the FD handed to "wtap_dump_fdopen()"
 438                    will be closed if the open fails. */
 439                 fclose(fh);
 440                 return NULL;
 441         }
 442
 443         return wdh;     /* success! */
 444 }
 445
 446 FILE* wtap_dump_file(wtap_dumper *wdh)
 447 {
 448         return wdh->fh;
 449 }
 450
 451 gboolean wtap_dump(wtap_dumper *wdh, const struct wtap_pkthdr *phdr,
 452     const union wtap_pseudo_header *pseudo_header, const u_char *pd, int *err)
 453 {
 454         return (wdh->subtype_write)(wdh, phdr, pseudo_header, pd, err);
 455 }
 456
 457 gboolean wtap_dump_close(wtap_dumper *wdh, int *err)
 458 {
 459         gboolean ret = TRUE;
 460
 461         if (wdh->subtype_close != NULL) {
 462                 /* There's a close routine for this dump stream. */
 463                 if (!(wdh->subtype_close)(wdh, err))
 464                         ret = FALSE;
 465         }
 466         errno = WTAP_ERR_CANT_CLOSE;
 467         if (fclose(wdh->fh) == EOF) {
 468                 if (ret) {
 469                         /* The per-format close function succeeded,
 470                            but the fclose didn't.  Save the reason
 471                            why, if our caller asked for it. */
 472                         if (err != NULL)
 473                                 *err = errno;
 474                 }
 475                 ret = FALSE;
 476         }
 477         if (wdh->dump.opaque != NULL)
 478                 g_free(wdh->dump.opaque);
 479         g_free(wdh);
 480         return ret;
 481 }