From Harald Welte:
[obnox/wireshark/wip.git] / wiretap / radcom.c
index 3e39af37ed4c313ebea3ddf03c87bc8720768436..a4fe9b30e6a21cf0c241617903b323e2d996d07f 100644 (file)
@@ -1,31 +1,33 @@
 /* radcom.c
+ *
+ * $Id$
  *
  * Wiretap Library
- * Copyright (c) 1998 by Gilbert Ramirez <gram@verdict.uthscsa.edu>
- * 
+ * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
+ *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
  * as published by the Free Software Foundation; either version 2
  * of the License, or (at your option) any later version.
- * 
+ *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
- * 
+ *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
- *
  */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
 
-#include <stdlib.h>
 #include <errno.h>
-#include <time.h>
-#include "wtap.h"
+#include <string.h>
+#include "wtap-int.h"
+#include "file_wrappers.h"
 #include "buffer.h"
 #include "radcom.h"
 
@@ -45,99 +47,135 @@ struct unaligned_frame_date {
        char    usec[4];
 };
 
-static char radcom_magic[8] = {
+/* Found at the beginning of the file. Bytes 2 and 3 (D2:00) seem to be
+ * different in some captures */
+static const guint8 radcom_magic[8] = {
        0x42, 0xD2, 0x00, 0x34, 0x12, 0x66, 0x22, 0x88
 };
 
+static const guint8 encap_magic[4] = {
+       0x00, 0x42, 0x43, 0x09
+};
+
+static const guint8 active_time_magic[11] = {
+       0x41, 0x63, 0x74, 0x69, 0x76, 0x65, 0x20, 0x54, 0x69, 0x6d, 0x65
+};
+
 /* RADCOM record header - followed by frame data (perhaps including FCS).
-   The first two bytes of "xxz" appear to equal "length", as do the
-   second two bytes; if a RADCOM box can be told not to save all of
-   the captured packet, might one or the other of those be the
-   captured length of the packet? */
+
+   "data_length" appears to be the length of packet data following
+   the record header.  It's 0 in the last record.
+
+   "length" appears to be the amount of captured packet data, and
+   "real_length" might be the actual length of the frame on the wire -
+   in some captures, it's the same as "length", and, in others,
+   it's greater than "length".  In the last record, however, those
+   may have bogus values (or is that some kind of trailer record?).
+
+   "xxx" appears to be all-zero in all but the last record in one
+   capture; if so, perhaps this indicates that the last record is,
+   in fact, a trailer of some sort, and some field in the header
+   is a record type. */
 struct radcomrec_hdr {
        char    xxx[4];         /* unknown */
-       char    length[2];      /* packet length */
+       char    data_length[2]; /* packet length? */
        char    xxy[5];         /* unknown */
        struct unaligned_frame_date date; /* date/time stamp of packet */
-       char    xxz[6];         /* unknown */
+       char    real_length[2]; /* actual length of packet */
+       char    length[2];      /* captured length of packet */
+       char    xxz[2];         /* unknown */
        char    dce;            /* DCE/DTE flag (and other flags?) */
        char    xxw[9];         /* unknown */
 };
 
-static int radcom_read(wtap *wth, int *err);
+static gboolean radcom_read(wtap *wth, int *err, gchar **err_info,
+       gint64 *data_offset);
+static gboolean radcom_seek_read(wtap *wth, gint64 seek_off,
+       union wtap_pseudo_header *pseudo_header, guint8 *pd, int length,
+       int *err, gchar **err_info);
+static int radcom_read_rec_header(FILE_T fh, struct radcomrec_hdr *hdr,
+       int *err, gchar **err_info);
+static gboolean radcom_read_rec_data(FILE_T fh, guint8 *pd, int length,
+       int *err, gchar **err_info);
 
-int radcom_open(wtap *wth, int *err)
+int radcom_open(wtap *wth, int *err, gchar **err_info)
 {
        int bytes_read;
-       char magic[8];
+       guint8 r_magic[8], t_magic[11], search_encap[7];
        struct frame_date start_date;
+#if 0
        guint32 sec;
        struct tm tm;
-       char byte;
-       char encap_magic[7] = {0x54, 0x43, 0x50, 0x00, 0x42, 0x43, 0x09};
-       char search_encap[7];
+#endif
 
        /* Read in the string that should be at the start of a RADCOM file */
-       fseek(wth->fh, 0, SEEK_SET);
        errno = WTAP_ERR_CANT_READ;
-       bytes_read = fread(magic, 1, 8, wth->fh);
+       bytes_read = file_read(r_magic, 8, wth->fh);
        if (bytes_read != 8) {
-               if (ferror(wth->fh)) {
-                       *err = errno;
+               *err = file_error(wth->fh, err_info);
+               if (*err != 0)
                        return -1;
-               }
                return 0;
        }
 
-       if (memcmp(magic, radcom_magic, 8)) {
+       /* XXX: bytes 2 and 3 of the "magic" header seem to be different in some
+        * captures. We force them to our standard value so that the test
+        * succeeds (until we find if they have a special meaning, perhaps a
+        * version number ?) */
+       r_magic[1] = 0xD2;
+       r_magic[2] = 0x00;
+       if (memcmp(r_magic, radcom_magic, 8) != 0) {
                return 0;
        }
 
-       fseek(wth->fh, 0x8B, SEEK_SET);
-       wth->data_offset = 0x8B;
+       /* Look for the "Active Time" string. The "frame_date" structure should
+        * be located 32 bytes before the beginning of this string */
+       wth->data_offset = 8;
        errno = WTAP_ERR_CANT_READ;
-       bytes_read = fread(&byte, 1, 1, wth->fh);
-       if (bytes_read != 1) {
-               if (ferror(wth->fh)) {
-                       *err = errno;
+       bytes_read = file_read(t_magic, 11, wth->fh);
+       if (bytes_read != 11) {
+               *err = file_error(wth->fh, err_info);
+               if (*err != 0)
                        return -1;
-               }
                return 0;
        }
-       wth->data_offset += 1;
-       while (byte) {
+       while (memcmp(t_magic, active_time_magic, 11) != 0)
+       {
+               if (file_seek(wth->fh, -10, SEEK_CUR, err) == -1)
+                       return -1;
+               wth->data_offset += 1;
                errno = WTAP_ERR_CANT_READ;
-               bytes_read = fread(&byte, 1, 1, wth->fh);
-               if (bytes_read != 1) {
-                       if (ferror(wth->fh)) {
-                               *err = errno;
+               bytes_read = file_read(t_magic, 11, wth->fh);
+               if (bytes_read != 11) {
+                       *err = file_error(wth->fh, err_info);
+                       if (*err != 0)
                                return -1;
-                       }
                        return 0;
                }
-               wth->data_offset += 1;
        }
-       fseek(wth->fh, 1, SEEK_CUR);
-       wth->data_offset += 1;
+       if (file_seek(wth->fh, -43, SEEK_CUR, err) == -1) return -1;
+       wth->data_offset -= 32;
 
        /* Get capture start time */
        errno = WTAP_ERR_CANT_READ;
-       bytes_read = fread(&start_date, 1, sizeof(struct frame_date), wth->fh);
+       bytes_read = file_read(&start_date, sizeof(struct frame_date),
+                              wth->fh);
        if (bytes_read != sizeof(struct frame_date)) {
-               if (ferror(wth->fh)) {
-                       *err = errno;
+               *err = file_error(wth->fh, err_info);
+               if (*err != 0)
                        return -1;
-               }
                return 0;
        }
        wth->data_offset += sizeof(struct frame_date);
 
        /* This is a radcom file */
        wth->file_type = WTAP_FILE_RADCOM;
-       wth->capture.radcom = g_malloc(sizeof(radcom_t));
        wth->subtype_read = radcom_read;
-       wth->snapshot_length = 16384;   /* not available in header, only in frame */
+       wth->subtype_seek_read = radcom_seek_read;
+       wth->snapshot_length = 0; /* not available in header, only in frame */
+       wth->tsprecision = WTAP_FILE_TSPREC_USEC;
 
+#if 0
        tm.tm_year = pletohs(&start_date.year)-1900;
        tm.tm_mon = start_date.month-1;
        tm.tm_mday = start_date.day;
@@ -146,162 +184,285 @@ int radcom_open(wtap *wth, int *err)
        tm.tm_min = (sec%3600)/60;
        tm.tm_sec = sec%60;
        tm.tm_isdst = -1;
-       wth->capture.radcom->start = mktime(&tm);
-
-       fseek(wth->fh, sizeof(struct frame_date), SEEK_CUR);
+#endif
+       if (file_seek(wth->fh, sizeof(struct frame_date), SEEK_CUR, err) == -1)
+               return -1;
        wth->data_offset += sizeof(struct frame_date);
 
        errno = WTAP_ERR_CANT_READ;
-       bytes_read = fread(search_encap, 1, 7, wth->fh);
-       if (bytes_read != 7) {
+       bytes_read = file_read(search_encap, 4, wth->fh);
+       if (bytes_read != 4) {
                goto read_error;
        }
-       wth->data_offset += 7;
-       while (memcmp(encap_magic, search_encap, 7)) {
-               fseek(wth->fh, -6, SEEK_CUR);
-               wth->data_offset -= 6;
+       wth->data_offset += 4;
+       while (memcmp(encap_magic, search_encap, 4)) {
+               if (file_seek(wth->fh, -3, SEEK_CUR, err) == -1)
+                       return -1;
+               wth->data_offset -= 3;
                errno = WTAP_ERR_CANT_READ;
-               bytes_read = fread(search_encap, 1, 7, wth->fh);
-               if (bytes_read != 7) {
+               bytes_read = file_read(search_encap, 4, wth->fh);
+               if (bytes_read != 4) {
                        goto read_error;
                }
-               wth->data_offset += 7;
+               wth->data_offset += 4;
        }
-       fseek(wth->fh, 12, SEEK_CUR);
+       if (file_seek(wth->fh, 12, SEEK_CUR, err) == -1)
+               return -1;
        wth->data_offset += 12;
        errno = WTAP_ERR_CANT_READ;
-       bytes_read = fread(search_encap, 1, 4, wth->fh);
+       bytes_read = file_read(search_encap, 4, wth->fh);
        if (bytes_read != 4) {
                goto read_error;
        }
        wth->data_offset += 4;
-       if (!memcmp(search_encap, "LAPB", 4))
+       if (memcmp(search_encap, "LAPB", 4) == 0)
                wth->file_encap = WTAP_ENCAP_LAPB;
-       else if (!memcmp(search_encap, "Ethe", 4))
+       else if (memcmp(search_encap, "Ethe", 4) == 0)
                wth->file_encap = WTAP_ENCAP_ETHERNET;
+       else if (memcmp(search_encap, "ATM/", 4) == 0)
+               wth->file_encap = WTAP_ENCAP_ATM_RFC1483;
        else {
-               g_message("pcap: network type \"%.4s\" unknown", search_encap);
-               *err = WTAP_ERR_UNSUPPORTED;
+               *err = WTAP_ERR_UNSUPPORTED_ENCAP;
+               *err_info = g_strdup_printf("radcom: network type \"%.4s\" unknown", search_encap);
                return -1;
        }
 
-       /*bytes_read = fread(&next_date, 1, sizeof(struct frame_date), wth->fh);
+#if 0
+       bytes_read = file_read(&next_date, sizeof(struct frame_date), wth->fh);
        errno = WTAP_ERR_CANT_READ;
        if (bytes_read != sizeof(struct frame_date)) {
                goto read_error;
        }
 
        while (memcmp(&start_date, &next_date, 4)) {
-               fseek(wth->fh, 1-sizeof(struct frame_date), SEEK_CUR);
+               if (file_seek(wth->fh, 1-sizeof(struct frame_date), SEEK_CUR, err) == -1)
+                       return -1;
                errno = WTAP_ERR_CANT_READ;
-               bytes_read = fread(&next_date, 1, sizeof(struct frame_date),
+               bytes_read = file_read(&next_date, sizeof(struct frame_date),
                                   wth->fh);
                if (bytes_read != sizeof(struct frame_date)) {
                        goto read_error;
                }
-       }*/
+       }
+#endif
 
        if (wth->file_encap == WTAP_ENCAP_ETHERNET) {
-               fseek(wth->fh, 294, SEEK_CUR);
+               if (file_seek(wth->fh, 294, SEEK_CUR, err) == -1)
+                       return -1;
                wth->data_offset += 294;
        } else if (wth->file_encap == WTAP_ENCAP_LAPB) {
-               fseek(wth->fh, 297, SEEK_CUR);
+               if (file_seek(wth->fh, 297, SEEK_CUR, err) == -1)
+                       return -1;
                wth->data_offset += 297;
+       } else if (wth->file_encap == WTAP_ENCAP_ATM_RFC1483) {
+               if (file_seek(wth->fh, 504, SEEK_CUR, err) == -1)
+                       return -1;
+               wth->data_offset += 504;
        }
 
        return 1;
 
 read_error:
-       if (ferror(wth->fh)) {
-               *err = errno;
-               free(wth->capture.radcom);
+       *err = file_error(wth->fh, err_info);
+       if (*err != 0)
                return -1;
-       }
-       free(wth->capture.radcom);
        return 0;
 }
 
 /* Read the next packet */
-static int radcom_read(wtap *wth, int *err)
+static gboolean radcom_read(wtap *wth, int *err, gchar **err_info,
+                           gint64 *data_offset)
 {
-       int     bytes_read;
+       int     ret;
        struct radcomrec_hdr hdr;
-       guint16 length;
+       guint16 data_length, real_length, length;
        guint32 sec;
+       int     bytes_read;
        struct tm tm;
-       int     data_offset;
+       guint8  phdr[8];
        char    fcs[2];
 
        /* Read record header. */
-       errno = WTAP_ERR_CANT_READ;
-       bytes_read = fread(&hdr, 1, sizeof hdr, wth->fh);
-       if (bytes_read != sizeof hdr) {
-               if (ferror(wth->fh)) {
-                       *err = errno;
-                       return -1;
-               }
-               if (bytes_read != 0) {
-                       *err = WTAP_ERR_SHORT_READ;
-                       return -1;
-               }
-               return 0;
+       *data_offset = wth->data_offset;
+       ret = radcom_read_rec_header(wth->fh, &hdr, err, err_info);
+       if (ret <= 0) {
+               /* Read error or EOF */
+               return FALSE;
        }
        wth->data_offset += sizeof hdr;
+       data_length = pletohs(&hdr.data_length);
+       if (data_length == 0) {
+               /*
+                * The last record appears to have 0 in its "data_length"
+                * field, but non-zero values in other fields, so we
+                * check for that and treat it as an EOF indication.
+                */
+               *err = 0;
+               return FALSE;
+       }
        length = pletohs(&hdr.length);
-       if (length == 0) return 0;
+       real_length = pletohs(&hdr.real_length);
 
-       if (wth->file_encap == WTAP_ENCAP_LAPB)
+       if (wth->file_encap == WTAP_ENCAP_LAPB) {
                length -= 2; /* FCS */
+               real_length -= 2;
+       }
 
-       wth->phdr.len = length;
+       wth->phdr.len = real_length;
        wth->phdr.caplen = length;
 
        tm.tm_year = pletohs(&hdr.date.year)-1900;
-       tm.tm_mon = hdr.date.month-1;
+       tm.tm_mon = (hdr.date.month&0x0f)-1;
        tm.tm_mday = hdr.date.day;
        sec = pletohl(&hdr.date.sec);
        tm.tm_hour = sec/3600;
        tm.tm_min = (sec%3600)/60;
        tm.tm_sec = sec%60;
        tm.tm_isdst = -1;
-       wth->phdr.ts.tv_sec = mktime(&tm);
-       wth->phdr.ts.tv_usec = pletohl(&hdr.date.usec);
-       wth->phdr.pseudo_header.x25.flags = (hdr.dce & 0x1) ? 0x00 : 0x80;
+       wth->phdr.ts.secs = mktime(&tm);
+       wth->phdr.ts.nsecs = pletohl(&hdr.date.usec) * 1000;
+
+       switch (wth->file_encap) {
+
+       case WTAP_ENCAP_ETHERNET:
+               /* XXX - is there an FCS? */
+               wth->pseudo_header.eth.fcs_len = -1;
+               break;
+
+       case WTAP_ENCAP_LAPB:
+               wth->pseudo_header.x25.flags = (hdr.dce & 0x1) ?
+                   0x00 : FROM_DCE;
+               break;
+
+       case WTAP_ENCAP_ATM_RFC1483:
+               /*
+                * XXX - is this stuff a pseudo-header?
+                * The direction appears to be in the "hdr.dce" field.
+                */
+               if (!radcom_read_rec_data(wth->fh, phdr, sizeof phdr, err,
+                   err_info))
+                       return FALSE;   /* Read error */
+               wth->data_offset += 8;
+               length -= 8;
+               wth->phdr.len -= 8;
+               wth->phdr.caplen -= 8;
+               break;
+       }
 
        /*
         * Read the packet data.
         */
        buffer_assure_space(wth->frame_buffer, length);
-       data_offset = wth->data_offset;
-       errno = WTAP_ERR_CANT_READ;
-       bytes_read = fread(buffer_start_ptr(wth->frame_buffer), 1,
-                       length, wth->fh);
-
-       if (bytes_read != length) {
-               if (ferror(wth->fh))
-                       *err = errno;
-               else
-                       *err = WTAP_ERR_SHORT_READ;
-               return -1;
-       }
+       if (!radcom_read_rec_data(wth->fh,
+           buffer_start_ptr(wth->frame_buffer), length, err, err_info))
+               return FALSE;   /* Read error */
        wth->data_offset += length;
 
-       wth->phdr.pkt_encap = wth->file_encap;
-
        if (wth->file_encap == WTAP_ENCAP_LAPB) {
                /* Read the FCS.
-                  XXX - should we put it in the pseudo-header? */
+                  XXX - should we have some way of indicating the
+                  presence and size of an FCS to our caller?
+                  That'd let us handle other file types as well. */
                errno = WTAP_ERR_CANT_READ;
-               bytes_read = fread(&fcs, 1, sizeof fcs, wth->fh);
+               bytes_read = file_read(&fcs, sizeof fcs, wth->fh);
                if (bytes_read != sizeof fcs) {
-                       if (ferror(wth->fh))
-                               *err = errno;
-                       else
+                       *err = file_error(wth->fh, err_info);
+                       if (*err == 0)
                                *err = WTAP_ERR_SHORT_READ;
-                       return -1;
+                       return FALSE;
                }
                wth->data_offset += sizeof fcs;
        }
 
-       return data_offset;
+       return TRUE;
+}
+
+static gboolean
+radcom_seek_read(wtap *wth, gint64 seek_off,
+                union wtap_pseudo_header *pseudo_header, guint8 *pd, int length,
+                int *err, gchar **err_info)
+{
+       int     ret;
+       struct radcomrec_hdr hdr;
+       guint8  phdr[8];
+
+       if (file_seek(wth->random_fh, seek_off, SEEK_SET, err) == -1)
+               return FALSE;
+
+       /* Read record header. */
+       ret = radcom_read_rec_header(wth->random_fh, &hdr, err, err_info);
+       if (ret <= 0) {
+               /* Read error or EOF */
+               if (ret == 0) {
+                       /* EOF means "short read" in random-access mode */
+                       *err = WTAP_ERR_SHORT_READ;
+               }
+               return FALSE;
+       }
+
+       switch (wth->file_encap) {
+
+       case WTAP_ENCAP_ETHERNET:
+               /* XXX - is there an FCS? */
+               pseudo_header->eth.fcs_len = -1;
+               break;
+
+       case WTAP_ENCAP_LAPB:
+               pseudo_header->x25.flags = (hdr.dce & 0x1) ? 0x00 : FROM_DCE;
+               break;
+
+       case WTAP_ENCAP_ATM_RFC1483:
+               /*
+                * XXX - is this stuff a pseudo-header?
+                * The direction appears to be in the "hdr.dce" field.
+                */
+               if (!radcom_read_rec_data(wth->random_fh, phdr, sizeof phdr,
+                   err, err_info))
+                       return FALSE;   /* Read error */
+               break;
+       }
+
+       /*
+        * Read the packet data.
+        */
+       return radcom_read_rec_data(wth->random_fh, pd, length, err, err_info);
+}
+
+static int
+radcom_read_rec_header(FILE_T fh, struct radcomrec_hdr *hdr, int *err,
+                      gchar **err_info)
+{
+       int     bytes_read;
+
+       errno = WTAP_ERR_CANT_READ;
+       bytes_read = file_read(hdr, sizeof *hdr, fh);
+       if (bytes_read != sizeof *hdr) {
+               *err = file_error(fh, err_info);
+               if (*err != 0)
+                       return -1;
+               if (bytes_read != 0) {
+                       *err = WTAP_ERR_SHORT_READ;
+                       return -1;
+               }
+               return 0;
+       }
+       return 1;
+}
+
+static gboolean
+radcom_read_rec_data(FILE_T fh, guint8 *pd, int length, int *err,
+                    gchar **err_info)
+{
+       int     bytes_read;
+
+       errno = WTAP_ERR_CANT_READ;
+       bytes_read = file_read(pd, length, fh);
+
+       if (bytes_read != length) {
+               *err = file_error(fh, err_info);
+               if (*err == 0)
+                       *err = WTAP_ERR_SHORT_READ;
+               return FALSE;
+       }
+       return TRUE;
 }