3 * $Id: toshiba.c,v 1.27 2003/10/01 07:11:48 guy Exp $
6 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
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.
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.
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.
29 #include "file_wrappers.h"
35 /* This module reads the output of the 'snoop' command in the Toshiba
36 * TR-600 and TR-650 "Compact" ISDN Routers. You can telnet to the
37 * router and run 'snoop' on the different channels, and at different
38 * detail levels. Be sure to choose the 'dump' level to get the hex dump.
39 * The 'snoop' command has nothing to do with the Solaris 'snoop'
40 * command, except that they both capture packets.
44 Example 'snoop' output data:
46 Script started on Thu Sep 9 21:48:49 1999
47 \e]0;gram@nirvana:/tmp
\a$ telnet 10.0.0.254
49 Connected to 10.0.0.254.
50 Escape character is '^]'.
53 TR-600(tr600) System Console
57 *--------------------------------------------------------*
58 | T O S H I B A T R - 6 0 0 |
59 | < Compact Router > |
62 | (C) Copyright TOSHIBA Corp. 1997 All rights reserved. |
63 *--------------------------------------------------------*
66 Trace start?(on/off/dump/dtl)->dump
69 Trace start(Dump Mode)...
71 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?
72 OFFSET 0001-0203-0405-0607-0809-0A0B-0C0D-0E0F 0123456789ABCDEF LEN=67
73 0000 : FF03 003D C000 0008 2145 0000 3A12 6500 ...=....!E..:.e.
74 0010 : 003F 11E6 58CF C11A 8897 A401 0804 0400 .?..X...........
75 0020 : 3500 264F D409 5601 0000 0100 0000 0000 5.&O..V.........
76 0030 : 0003 706F 7704 7A69 6E67 036F 7267 0000 ..pow.zing.org..
79 [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
80 OFFSET 0001-0203-0405-0607-0809-0A0B-0C0D-0E0F 0123456789ABCDEF LEN=222
81 0000 : FF03 003D C000 0013 2145 0000 D590 9340 ...=....!E.....@
82 0010 : 00F7 116F 8E97 A401 08CF C11A 8800 3504 ...o..........5.
83 0020 : 0400 C13E 0609 5681 8000 0100 0100 0300 ...>..V.........
84 0030 : 0303 706F 7704 7A69 6E67 036F 7267 0000 ..pow.zing.org..
85 0040 : 0100 01C0 0C00 0100 0100 000A 5C00 04CE ............\...
86 0050 : 3924 5A04 5A49 4E47 036F 7267 0000 0200 9$Z.ZING.org....
87 0060 : 0100 016F 5B00 0D03 4841 4E03 5449 5703 ...o[...HAN.TIW.
88 0070 : 4E45 5400 C02E 0002 0001 0001 6F5B 0006 NET.........o[..
89 0080 : 034E 5331 C02E C02E 0002 0001 0001 6F5B .NS1..........o[
90 0090 : 001C 0854 414C 4945 5349 4E0D 434F 4E46 ...TALIESIN.CONF
91 00A0 : 4142 554C 4154 494F 4E03 434F 4D00 C042 ABULATION.COM..B
92 00B0 : 0001 0001 0001 51EC 0004 CE39 2406 C05B ......Q....9$..[
93 00C0 : 0001 0001 0001 6F5B 0004 CE39 245A C06D ......o[...9$Z.m
94 00D0 : 0001 0001 0001 4521 0004 187C 1F01 ......E!...|..
98 /* Magic text to check for toshiba-ness of file */
99 static const char toshiba_hdr_magic[] =
100 { 'T', ' ', 'O', ' ', 'S', ' ', 'H', ' ', 'I', ' ', 'B', ' ', 'A' };
101 #define TOSHIBA_HDR_MAGIC_SIZE (sizeof toshiba_hdr_magic / sizeof toshiba_hdr_magic[0])
103 /* Magic text for start of packet */
104 static const char toshiba_rec_magic[] = { '[', 'N', 'o', '.' };
105 #define TOSHIBA_REC_MAGIC_SIZE (sizeof toshiba_rec_magic / sizeof toshiba_rec_magic[0])
108 * XXX - is this the biggest packet we can get?
110 #define TOSHIBA_MAX_PACKET_LEN 16384
112 static gboolean toshiba_read(wtap *wth, int *err, long *data_offset);
113 static gboolean toshiba_seek_read(wtap *wth, long seek_off,
114 union wtap_pseudo_header *pseudo_header, guint8 *pd, int len, int *err);
115 static gboolean parse_single_hex_dump_line(char* rec, guint8 *buf,
117 static gboolean parse_toshiba_hex_dump(FILE_T fh, int pkt_len, guint8* buf,
119 static int parse_toshiba_rec_hdr(wtap *wth, FILE_T fh,
120 union wtap_pseudo_header *pseudo_header, int *err);
122 /* Seeks to the beginning of the next packet, and returns the
123 byte offset. Returns -1 on failure, and sets "*err" to the error. */
124 static long toshiba_seek_next_packet(wtap *wth, int *err)
130 while ((byte = file_getc(wth->fh)) != EOF) {
131 if (byte == toshiba_rec_magic[level]) {
133 if (level >= TOSHIBA_REC_MAGIC_SIZE) {
134 /* note: we're leaving file pointer right after the magic characters */
135 cur_off = file_tell(wth->fh);
138 *err = file_error(wth->fh);
147 if (file_eof(wth->fh)) {
151 /* We (presumably) got an error (there's no equivalent to "ferror()"
152 in zlib, alas, so we don't have a wrapper to check for an error). */
153 *err = file_error(wth->fh);
158 #define TOSHIBA_HEADER_LINES_TO_CHECK 200
159 #define TOSHIBA_LINE_LENGTH 240
161 /* Look through the first part of a file to see if this is
162 * a Toshiba trace file.
164 * Returns TRUE if it is, FALSE if it isn't or if we get an I/O error;
165 * if we get an I/O error, "*err" will be set to a non-zero value.
167 static gboolean toshiba_check_file_type(wtap *wth, int *err)
169 char buf[TOSHIBA_LINE_LENGTH];
170 guint i, reclen, level, line;
173 buf[TOSHIBA_LINE_LENGTH-1] = 0;
175 for (line = 0; line < TOSHIBA_HEADER_LINES_TO_CHECK; line++) {
176 if (file_gets(buf, TOSHIBA_LINE_LENGTH, wth->fh) != NULL) {
178 reclen = strlen(buf);
179 if (reclen < TOSHIBA_HDR_MAGIC_SIZE) {
184 for (i = 0; i < reclen; i++) {
186 if (byte == toshiba_hdr_magic[level]) {
188 if (level >= TOSHIBA_HDR_MAGIC_SIZE) {
199 if (file_eof(wth->fh))
202 *err = file_error(wth->fh);
211 int toshiba_open(wtap *wth, int *err)
213 /* Look for Toshiba header */
214 if (!toshiba_check_file_type(wth, err)) {
221 wth->data_offset = 0;
222 wth->file_encap = WTAP_ENCAP_PER_PACKET;
223 wth->file_type = WTAP_FILE_TOSHIBA;
224 wth->snapshot_length = 0; /* not known */
225 wth->subtype_read = toshiba_read;
226 wth->subtype_seek_read = toshiba_seek_read;
231 /* Find the next packet and parse it; called from wtap_loop(). */
232 static gboolean toshiba_read(wtap *wth, int *err, long *data_offset)
238 /* Find the next packet */
239 offset = toshiba_seek_next_packet(wth, err);
243 /* Parse the header */
244 pkt_len = parse_toshiba_rec_hdr(wth, wth->fh, &wth->pseudo_header, err);
248 /* Make sure we have enough room for the packet */
249 buffer_assure_space(wth->frame_buffer, TOSHIBA_MAX_PACKET_LEN);
250 buf = buffer_start_ptr(wth->frame_buffer);
252 /* Convert the ASCII hex dump to binary data */
253 if (!parse_toshiba_hex_dump(wth->fh, pkt_len, buf, err))
256 wth->data_offset = offset;
257 *data_offset = offset;
261 /* Used to read packets in random-access fashion */
263 toshiba_seek_read (wtap *wth, long seek_off,
264 union wtap_pseudo_header *pseudo_header, guint8 *pd, int len, int *err)
268 if (file_seek(wth->random_fh, seek_off - 1, SEEK_SET, err) == -1)
271 pkt_len = parse_toshiba_rec_hdr(NULL, wth->random_fh, pseudo_header,
274 if (pkt_len != len) {
276 *err = WTAP_ERR_BAD_RECORD;
280 return parse_toshiba_hex_dump(wth->random_fh, pkt_len, pd, err);
283 /* Parses a packet record header. */
285 parse_toshiba_rec_hdr(wtap *wth, FILE_T fh,
286 union wtap_pseudo_header *pseudo_header, int *err)
288 char line[TOSHIBA_LINE_LENGTH];
289 int num_items_scanned;
290 int pkt_len, pktnum, hr, min, sec, csec;
291 char channel[10], direction[10];
293 /* Our file pointer should be on the line containing the
294 * summary information for a packet. Read in that line and
295 * extract the useful information
297 if (file_gets(line, TOSHIBA_LINE_LENGTH, fh) == NULL) {
298 *err = file_error(fh);
300 *err = WTAP_ERR_SHORT_READ;
305 /* Find text in line after "[No.". Limit the length of the
306 * two strings since we have fixed buffers for channel[] and
308 num_items_scanned = sscanf(line, "%d] %d:%d:%d.%d %9s %9s",
309 &pktnum, &hr, &min, &sec, &csec, channel, direction);
311 if (num_items_scanned != 7) {
312 *err = WTAP_ERR_BAD_RECORD;
316 /* Scan lines until we find the OFFSET line. In a "telnet" trace,
317 * this will be the next line. But if you save your telnet session
318 * to a file from within a Windows-based telnet client, it may
319 * put in line breaks at 80 columns (or however big your "telnet" box
320 * is). CRT (a Windows telnet app from VanDyke) does this.
321 * Here we assume that 80 columns will be the minimum size, and that
322 * the OFFSET line is not broken in the middle. It's the previous
323 * line that is normally long and can thus be broken at column 80.
326 if (file_gets(line, TOSHIBA_LINE_LENGTH, fh) == NULL) {
327 *err = file_error(fh);
329 *err = WTAP_ERR_SHORT_READ;
334 /* Check for "OFFSET 0001-0203" at beginning of line */
337 } while (strcmp(line, "OFFSET 0001-0203") != 0);
339 num_items_scanned = sscanf(line+64, "LEN=%d", &pkt_len);
340 if (num_items_scanned != 1) {
341 *err = WTAP_ERR_BAD_RECORD;
346 wth->phdr.ts.tv_sec = hr * 3600 + min * 60 + sec;
347 wth->phdr.ts.tv_usec = csec * 10000;
348 wth->phdr.caplen = pkt_len;
349 wth->phdr.len = pkt_len;
351 switch (channel[0]) {
354 wth->phdr.pkt_encap = WTAP_ENCAP_ISDN;
355 pseudo_header->isdn.uton = (direction[0] == 'T');
356 pseudo_header->isdn.channel =
357 strtol(&channel[1], NULL, 10);
362 wth->phdr.pkt_encap = WTAP_ENCAP_ISDN;
363 pseudo_header->isdn.uton = (direction[0] == 'T');
364 pseudo_header->isdn.channel = 0;
369 wth->phdr.pkt_encap = WTAP_ENCAP_ETHERNET;
370 /* XXX - is there an FCS in the frame? */
371 pseudo_header->eth.fcs_len = -1;
377 /* Converts ASCII hex dump to binary data */
379 parse_toshiba_hex_dump(FILE_T fh, int pkt_len, guint8* buf, int *err)
381 char line[TOSHIBA_LINE_LENGTH];
384 /* Calculate the number of hex dump lines, each
385 * containing 16 bytes of data */
386 hex_lines = pkt_len / 16 + ((pkt_len % 16) ? 1 : 0);
388 for (i = 0; i < hex_lines; i++) {
389 if (file_gets(line, TOSHIBA_LINE_LENGTH, fh) == NULL) {
390 *err = file_error(fh);
392 *err = WTAP_ERR_SHORT_READ;
396 if (!parse_single_hex_dump_line(line, buf, i * 16)) {
397 *err = WTAP_ERR_BAD_RECORD;
406 0123456789012345678901234567890123456789012345
407 0000 : FF03 003D C000 0008 2145 0000 3A12 6500 ...=....!E..:.e.
408 0010 : 003F 11E6 58CF C11A 8897 A401 0804 0400 .?..X...........
413 #define HEX_LENGTH ((8 * 4) + 7) /* eight clumps of 4 bytes with 7 inner spaces */
415 /* Take a string representing one line from a hex dump and converts the
416 * text to binary data. We check the printed offset with the offset
417 * we are passed to validate the record. We place the bytes in the buffer
418 * at the specified offset.
420 * In the process, we're going to write all over the string.
422 * Returns TRUE if good hex dump, FALSE if bad.
425 parse_single_hex_dump_line(char* rec, guint8 *buf, guint byte_offset) {
432 /* Get the byte_offset directly from the record */
435 value = strtoul(s, NULL, 16);
437 if (value != byte_offset) {
441 /* Go through the substring representing the values and:
442 * 1. Replace any spaces with '0's
443 * 2. Place \0's every 5 bytes (to terminate the string)
445 * Then read the eight sets of hex bytes
448 for (pos = START_POS; pos < START_POS + HEX_LENGTH; pos++) {
449 if (rec[pos] == ' ') {
455 for (i = 0; i < 8; i++) {
458 word_value = (guint16) strtoul(&rec[pos], NULL, 16);
459 buf[byte_offset + i * 2 + 0] = (guint8) (word_value >> 8);
460 buf[byte_offset + i * 2 + 1] = (guint8) (word_value & 0x00ff);