/* toshiba.c
*
- * $Id: toshiba.c,v 1.6 2000/01/01 04:01:41 gram Exp $
+ * $Id$
*
* Wiretap Library
- * Copyright (c) 1998 by Gilbert Ramirez <gram@xiexie.org>
- *
+ * 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 "wtap.h"
+#include "wtap-int.h"
#include "buffer.h"
#include "toshiba.h"
-#include "file.h"
+#include "file_wrappers.h"
#include <stdio.h>
#include <stdlib.h>
/* This module reads the output of the 'snoop' command in the Toshiba
* TR-600 and TR-650 "Compact" ISDN Routers. You can telnet to the
* router and run 'snoop' on the different channels, and at different
- * detail levels. Be sure to choose 'dump' to get the hex dump.
+ * detail levels. Be sure to choose the 'dump' level to get the hex dump.
* The 'snoop' command has nothing to do with the Solaris 'snoop'
* command, except that they both capture packets.
*/
/*
Example 'snoop' output data:
-
Script started on Thu Sep 9 21:48:49 1999
-\e]0;gram@nirvana:/tmp\a$ telnet 10.0.0.254\r
-Trying 10.0.0.254...\r
-Connected to 10.0.0.254.\r
-Escape character is '^]'.\r
-\r
-\r
-TR-600(tr600) System Console\r
-\r
-Login:admin\r
-Password:*******\r
-*--------------------------------------------------------*\r
-| T O S H I B A T R - 6 0 0 |\r
-| < Compact Router > |\r
-| V1.02.02 |\r
-| |\r
-| (C) Copyright TOSHIBA Corp. 1997 All rights reserved. |\r
-*--------------------------------------------------------*\r
-\r
-tr600>snoop dump b1\r
- Trace start?(on/off/dump/dtl)->dump\r
- IP Address?->b1\r
-B1 Port Filetering\r
-Trace start(Dump Mode)...\r
-\r
-tr600>[No.1] 00:00:09.14 B1:1 Tx 207.193.26.136->151.164.1.8 DNS SPORT=1028 LEN=38 CHKSUM=4FD4 ID=2390 Query RD QCNT=1 pow.zing.org?\r
-OFFSET 0001-0203-0405-0607-0809-0A0B-0C0D-0E0F 0123456789ABCDEF LEN=67\r
-0000 : FF03 003D C000 0008 2145 0000 3A12 6500 ...=....!E..:.e.\r
-0010 : 003F 11E6 58CF C11A 8897 A401 0804 0400 .?..X...........\r
-0020 : 3500 264F D409 5601 0000 0100 0000 0000 5.&O..V.........\r
-0030 : 0003 706F 7704 7A69 6E67 036F 7267 0000 ..pow.zing.org..\r
-0040 : 0100 01 ...\r
-\r
-[No.2] 00:00:09.25 B1:1 Rx 151.164.1.8->207.193.26.136 DNS DPORT=1028 LEN=193 CHKSUM=3E06 ID=2390 Answer RD RA QCNT=1 pow.zing.org? ANCNT=1 pow.zing.org=206.57.36.90 TTL=2652\r
-OFFSET 0001-0203-0405-0607-0809-0A0B-0C0D-0E0F 0123456789ABCDEF LEN=222\r
-0000 : FF03 003D C000 0013 2145 0000 D590 9340 ...=....!E.....@\r
-0010 : 00F7 116F 8E97 A401 08CF C11A 8800 3504 ...o..........5.\r
-0020 : 0400 C13E 0609 5681 8000 0100 0100 0300 ...>..V.........\r
-0030 : 0303 706F 7704 7A69 6E67 036F 7267 0000 ..pow.zing.org..\r
-0040 : 0100 01C0 0C00 0100 0100 000A 5C00 04CE ............\...\r
-0050 : 3924 5A04 5A49 4E47 036F 7267 0000 0200 9$Z.ZING.org....\r
-0060 : 0100 016F 5B00 0D03 4841 4E03 5449 5703 ...o[...HAN.TIW.\r
-0070 : 4E45 5400 C02E 0002 0001 0001 6F5B 0006 NET.........o[..\r
-0080 : 034E 5331 C02E C02E 0002 0001 0001 6F5B .NS1..........o[\r
-0090 : 001C 0854 414C 4945 5349 4E0D 434F 4E46 ...TALIESIN.CONF\r
-00A0 : 4142 554C 4154 494F 4E03 434F 4D00 C042 ABULATION.COM..B\r
-00B0 : 0001 0001 0001 51EC 0004 CE39 2406 C05B ......Q....9$..[\r
-00C0 : 0001 0001 0001 6F5B 0004 CE39 245A C06D ......o[...9$Z.m\r
-00D0 : 0001 0001 0001 4521 0004 187C 1F01 ......E!...|..\r
-\r
+\e]0;gram@nirvana:/tmp\a$ telnet 10.0.0.254
+Trying 10.0.0.254...
+Connected to 10.0.0.254.
+Escape character is '^]'.
+
+
+TR-600(tr600) System Console
+
+Login:admin
+Password:*******
+*--------------------------------------------------------*
+| T O S H I B A T R - 6 0 0 |
+| < Compact Router > |
+| V1.02.02 |
+| |
+| (C) Copyright TOSHIBA Corp. 1997 All rights reserved. |
+*--------------------------------------------------------*
+
+tr600>snoop dump b1
+ Trace start?(on/off/dump/dtl)->dump
+ IP Address?->b1
+B1 Port Filetering
+Trace start(Dump Mode)...
+
+tr600>[No.1] 00:00:09.14 B1:1 Tx 207.193.26.136->151.164.1.8 DNS SPORT=1028 LEN=38 CHKSUM=4FD4 ID=2390 Query RD QCNT=1 pow.zing.org?
+OFFSET 0001-0203-0405-0607-0809-0A0B-0C0D-0E0F 0123456789ABCDEF LEN=67
+0000 : FF03 003D C000 0008 2145 0000 3A12 6500 ...=....!E..:.e.
+0010 : 003F 11E6 58CF C11A 8897 A401 0804 0400 .?..X...........
+0020 : 3500 264F D409 5601 0000 0100 0000 0000 5.&O..V.........
+0030 : 0003 706F 7704 7A69 6E67 036F 7267 0000 ..pow.zing.org..
+0040 : 0100 01 ...
+
+[No.2] 00:00:09.25 B1:1 Rx 151.164.1.8->207.193.26.136 DNS DPORT=1028 LEN=193 CHKSUM=3E06 ID=2390 Answer RD RA QCNT=1 pow.zing.org? ANCNT=1 pow.zing.org=206.57.36.90 TTL=2652
+OFFSET 0001-0203-0405-0607-0809-0A0B-0C0D-0E0F 0123456789ABCDEF LEN=222
+0000 : FF03 003D C000 0013 2145 0000 D590 9340 ...=....!E.....@
+0010 : 00F7 116F 8E97 A401 08CF C11A 8800 3504 ...o..........5.
+0020 : 0400 C13E 0609 5681 8000 0100 0100 0300 ...>..V.........
+0030 : 0303 706F 7704 7A69 6E67 036F 7267 0000 ..pow.zing.org..
+0040 : 0100 01C0 0C00 0100 0100 000A 5C00 04CE ............\...
+0050 : 3924 5A04 5A49 4E47 036F 7267 0000 0200 9$Z.ZING.org....
+0060 : 0100 016F 5B00 0D03 4841 4E03 5449 5703 ...o[...HAN.TIW.
+0070 : 4E45 5400 C02E 0002 0001 0001 6F5B 0006 NET.........o[..
+0080 : 034E 5331 C02E C02E 0002 0001 0001 6F5B .NS1..........o[
+0090 : 001C 0854 414C 4945 5349 4E0D 434F 4E46 ...TALIESIN.CONF
+00A0 : 4142 554C 4154 494F 4E03 434F 4D00 C042 ABULATION.COM..B
+00B0 : 0001 0001 0001 51EC 0004 CE39 2406 C05B ......Q....9$..[
+00C0 : 0001 0001 0001 6F5B 0004 CE39 245A C06D ......o[...9$Z.m
+00D0 : 0001 0001 0001 4521 0004 187C 1F01 ......E!...|..
+
*/
/* Magic text to check for toshiba-ness of file */
static const char toshiba_rec_magic[] = { '[', 'N', 'o', '.' };
#define TOSHIBA_REC_MAGIC_SIZE (sizeof toshiba_rec_magic / sizeof toshiba_rec_magic[0])
-static int toshiba_read(wtap *wth, int *err);
-static gboolean parse_single_hex_dump_line(char* rec, guint8 *buf, int byte_offset);
-static int parse_toshiba_hex_dump(FILE *fh, int pkt_len, guint8* buf, int *err);
-static int parse_toshiba_rec_hdr(wtap *wth, FILE *fh, int *err);
-static int parse_toshiba(FILE *fh, guint8 *pd, int len);
+/*
+ * XXX - is this the biggest packet we can get?
+ */
+#define TOSHIBA_MAX_PACKET_LEN 16384
+
+static gboolean toshiba_read(wtap *wth, int *err, gchar **err_info,
+ gint64 *data_offset);
+static gboolean toshiba_seek_read(wtap *wth, gint64 seek_off,
+ union wtap_pseudo_header *pseudo_header, guint8 *pd, int len,
+ int *err, gchar **err_info);
+static gboolean parse_single_hex_dump_line(char* rec, guint8 *buf,
+ guint byte_offset);
+static gboolean parse_toshiba_hex_dump(FILE_T fh, int pkt_len, guint8* buf,
+ int *err, gchar **err_info);
+static int parse_toshiba_rec_hdr(wtap *wth, FILE_T fh,
+ union wtap_pseudo_header *pseudo_header, int *err, gchar **err_info);
/* Seeks to the beginning of the next packet, and returns the
- byte offset. Returns -1 on failure. */
-/* XXX - Handle I/O errors. */
-static int toshiba_seek_next_packet(wtap *wth)
+ byte offset. Returns -1 on failure, and sets "*err" to the error. */
+static gint64 toshiba_seek_next_packet(wtap *wth, int *err)
{
int byte;
- int level = 0;
+ guint level = 0;
+ gint64 cur_off;
while ((byte = file_getc(wth->fh)) != EOF) {
if (byte == toshiba_rec_magic[level]) {
level++;
if (level >= TOSHIBA_REC_MAGIC_SIZE) {
/* note: we're leaving file pointer right after the magic characters */
- return file_tell(wth->fh) + 1;
+ cur_off = file_tell(wth->fh);
+ if (cur_off == -1) {
+ /* Error. */
+ *err = file_error(wth->fh);
+ return -1;
+ }
+ return cur_off + 1;
}
} else {
level = 0;
}
}
+ if (file_eof(wth->fh)) {
+ /* We got an EOF. */
+ *err = 0;
+ } else {
+ /* We (presumably) got an error (there's no equivalent to "ferror()"
+ in zlib, alas, so we don't have a wrapper to check for an error). */
+ *err = file_error(wth->fh);
+ }
return -1;
}
/* Look through the first part of a file to see if this is
* a Toshiba trace file.
*
- * Returns TRUE if it is, FALSE if it isn't.
+ * Returns TRUE if it is, FALSE if it isn't or if we get an I/O error;
+ * if we get an I/O error, "*err" will be set to a non-zero value.
*/
-static gboolean toshiba_check_file_type(wtap *wth)
+static gboolean toshiba_check_file_type(wtap *wth, int *err)
{
char buf[TOSHIBA_LINE_LENGTH];
- int reclen, i, line, byte, level;
+ guint i, reclen, level, line;
+ char byte;
buf[TOSHIBA_LINE_LENGTH-1] = 0;
}
}
else {
+ /* EOF or error. */
+ if (file_eof(wth->fh))
+ *err = 0;
+ else
+ *err = file_error(wth->fh);
return FALSE;
}
}
+ *err = 0;
return FALSE;
}
-/* XXX - return -1 on I/O error and actually do something with 'err'. */
-int toshiba_open(wtap *wth, int *err)
+int toshiba_open(wtap *wth, int *err, gchar **err_info _U_)
{
- /* Reset file position and look for Toshiba header */
- file_seek(wth->fh, 0, SEEK_SET);
-
- if (!toshiba_check_file_type(wth)) {
- return 0;
+ /* Look for Toshiba header */
+ if (!toshiba_check_file_type(wth, err)) {
+ if (*err == 0)
+ return 0;
+ else
+ return -1;
}
wth->data_offset = 0;
wth->file_encap = WTAP_ENCAP_PER_PACKET;
wth->file_type = WTAP_FILE_TOSHIBA;
- wth->snapshot_length = 16384; /* just guessing */
+ wth->snapshot_length = 0; /* not known */
wth->subtype_read = toshiba_read;
+ wth->subtype_seek_read = toshiba_seek_read;
+ wth->tsprecision = WTAP_FILE_TSPREC_CSEC;
return 1;
}
-/* Find the next packet and parse it; called from wtap_loop(). */
-static int toshiba_read(wtap *wth, int *err)
+/* Find the next packet and parse it; called from wtap_read(). */
+static gboolean toshiba_read(wtap *wth, int *err, gchar **err_info,
+ gint64 *data_offset)
{
- int offset = 0;
+ gint64 offset;
guint8 *buf;
int pkt_len;
/* Find the next packet */
- offset = toshiba_seek_next_packet(wth);
- if (offset < 1) {
- return 0;
- }
+ offset = toshiba_seek_next_packet(wth, err);
+ if (offset < 1)
+ return FALSE;
/* Parse the header */
- pkt_len = parse_toshiba_rec_hdr(wth, wth->fh, err);
+ pkt_len = parse_toshiba_rec_hdr(wth, wth->fh, &wth->pseudo_header,
+ err, err_info);
+ if (pkt_len == -1)
+ return FALSE;
/* Make sure we have enough room for the packet */
- buffer_assure_space(wth->frame_buffer, wth->snapshot_length);
+ buffer_assure_space(wth->frame_buffer, TOSHIBA_MAX_PACKET_LEN);
buf = buffer_start_ptr(wth->frame_buffer);
/* Convert the ASCII hex dump to binary data */
- parse_toshiba_hex_dump(wth->fh, pkt_len, buf, err);
+ if (!parse_toshiba_hex_dump(wth->fh, pkt_len, buf, err, err_info))
+ return FALSE;
wth->data_offset = offset;
- return offset;
-}
-
-/* Used to read packets in random-access fashion */
-int
-toshiba_seek_read (FILE *fh, int seek_off, guint8 *pd, int len)
-{
- file_seek(fh, seek_off - 1, SEEK_SET);
- return parse_toshiba(fh, pd, len);
+ *data_offset = offset;
+ return TRUE;
}
/* Used to read packets in random-access fashion */
-static int
-parse_toshiba(FILE *fh, guint8 *pd, int len)
+static gboolean
+toshiba_seek_read (wtap *wth, gint64 seek_off,
+ union wtap_pseudo_header *pseudo_header, guint8 *pd, int len,
+ int *err, gchar **err_info)
{
int pkt_len;
- int err;
- pkt_len = parse_toshiba_rec_hdr(NULL, fh, &err);
+ if (file_seek(wth->random_fh, seek_off - 1, SEEK_SET, err) == -1)
+ return FALSE;
+
+ pkt_len = parse_toshiba_rec_hdr(NULL, wth->random_fh, pseudo_header,
+ err, err_info);
if (pkt_len != len) {
- return -1;
+ if (pkt_len != -1) {
+ *err = WTAP_ERR_BAD_RECORD;
+ *err_info = g_strdup_printf("toshiba: requested length %d doesn't match record length %d",
+ len, pkt_len);
+ }
+ return FALSE;
}
- parse_toshiba_hex_dump(fh, pkt_len, pd, &err);
-
- return 0;
+ return parse_toshiba_hex_dump(wth->random_fh, pkt_len, pd, err, err_info);
}
/* Parses a packet record header. */
static int
-parse_toshiba_rec_hdr(wtap *wth, FILE *fh, int *err)
+parse_toshiba_rec_hdr(wtap *wth, FILE_T fh,
+ union wtap_pseudo_header *pseudo_header, int *err, gchar **err_info)
{
char line[TOSHIBA_LINE_LENGTH];
int num_items_scanned;
if (num_items_scanned != 7) {
*err = WTAP_ERR_BAD_RECORD;
+ *err_info = g_strdup("toshiba: record header isn't valid");
return -1;
}
- /* The next line contains mostly junk, but it does contain the
- * packet length. */
- if (file_gets(line, TOSHIBA_LINE_LENGTH, fh) == NULL) {
- *err = file_error(fh);
- if (*err == 0) {
- *err = WTAP_ERR_SHORT_READ;
+ /* Scan lines until we find the OFFSET line. In a "telnet" trace,
+ * this will be the next line. But if you save your telnet session
+ * to a file from within a Windows-based telnet client, it may
+ * put in line breaks at 80 columns (or however big your "telnet" box
+ * is). CRT (a Windows telnet app from VanDyke) does this.
+ * Here we assume that 80 columns will be the minimum size, and that
+ * the OFFSET line is not broken in the middle. It's the previous
+ * line that is normally long and can thus be broken at column 80.
+ */
+ do {
+ if (file_gets(line, TOSHIBA_LINE_LENGTH, fh) == NULL) {
+ *err = file_error(fh);
+ if (*err == 0) {
+ *err = WTAP_ERR_SHORT_READ;
+ }
+ return -1;
}
- return -1;
- }
+
+ /* Check for "OFFSET 0001-0203" at beginning of line */
+ line[16] = '\0';
+
+ } while (strcmp(line, "OFFSET 0001-0203") != 0);
num_items_scanned = sscanf(line+64, "LEN=%d", &pkt_len);
if (num_items_scanned != 1) {
*err = WTAP_ERR_BAD_RECORD;
+ *err_info = g_strdup("toshiba: OFFSET line doesn't have valid LEN item");
return -1;
}
if (wth) {
- wth->phdr.ts.tv_sec = hr * 3600 + min * 60 + sec;
- wth->phdr.ts.tv_usec = csec * 10000;
+ wth->phdr.ts.secs = hr * 3600 + min * 60 + sec;
+ wth->phdr.ts.nsecs = csec * 10000000;
wth->phdr.caplen = pkt_len;
wth->phdr.len = pkt_len;
- switch (channel[0]) {
- case 'B':
- wth->phdr.pkt_encap = WTAP_ENCAP_PPP;
- break;
-
- case 'D':
- wth->phdr.pkt_encap = WTAP_ENCAP_LAPD;
- wth->phdr.pseudo_header.lapd.from_network_to_user =
- (direction[0] == 'R' ? TRUE : FALSE );
- break;
-
- default:
+ }
+ switch (channel[0]) {
+ case 'B':
+ if (wth)
+ wth->phdr.pkt_encap = WTAP_ENCAP_ISDN;
+ pseudo_header->isdn.uton = (direction[0] == 'T');
+ pseudo_header->isdn.channel = (guint8)
+ strtol(&channel[1], NULL, 10);
+ break;
+
+ case 'D':
+ if (wth)
+ wth->phdr.pkt_encap = WTAP_ENCAP_ISDN;
+ pseudo_header->isdn.uton = (direction[0] == 'T');
+ pseudo_header->isdn.channel = 0;
+ break;
+
+ default:
+ if (wth)
wth->phdr.pkt_encap = WTAP_ENCAP_ETHERNET;
- break;
- }
+ /* XXX - is there an FCS in the frame? */
+ pseudo_header->eth.fcs_len = -1;
+ break;
}
return pkt_len;
}
/* Converts ASCII hex dump to binary data */
-static int
-parse_toshiba_hex_dump(FILE *fh, int pkt_len, guint8* buf, int *err)
+static gboolean
+parse_toshiba_hex_dump(FILE_T fh, int pkt_len, guint8* buf, int *err,
+ gchar **err_info)
{
char line[TOSHIBA_LINE_LENGTH];
int i, hex_lines;
-
+
/* Calculate the number of hex dump lines, each
* containing 16 bytes of data */
hex_lines = pkt_len / 16 + ((pkt_len % 16) ? 1 : 0);
if (*err == 0) {
*err = WTAP_ERR_SHORT_READ;
}
- return -1;
+ return FALSE;
}
if (!parse_single_hex_dump_line(line, buf, i * 16)) {
*err = WTAP_ERR_BAD_RECORD;
- return -1;
+ *err_info = g_strdup("toshiba: hex dump not valid");
+ return FALSE;
}
}
- return 0;
+ return TRUE;
}
/*
1 2 3 4
0123456789012345678901234567890123456789012345
-0000 : FF03 003D C000 0008 2145 0000 3A12 6500 ...=....!E..:.e.\r
-0010 : 003F 11E6 58CF C11A 8897 A401 0804 0400 .?..X...........\r
-0020 : 0100 01 ...\r
+0000 : FF03 003D C000 0008 2145 0000 3A12 6500 ...=....!E..:.e.
+0010 : 003F 11E6 58CF C11A 8897 A401 0804 0400 .?..X...........
+0020 : 0100 01 ...
*/
#define START_POS 7
* Returns TRUE if good hex dump, FALSE if bad.
*/
static gboolean
-parse_single_hex_dump_line(char* rec, guint8 *buf, int byte_offset) {
+parse_single_hex_dump_line(char* rec, guint8 *buf, guint byte_offset) {
int pos, i;
char *s;