wiretap/toshiba.c

   1 /* toshiba.c
   2  *
   3  * $Id: toshiba.c,v 1.11 2000/05/19 23:07:03 gram 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 #include "wtap-int.h"
  27 #include "buffer.h"
  28 #include "toshiba.h"
  29 #include "file_wrappers.h"
  30
  31 #include <stdio.h>
  32 #include <stdlib.h>
  33 #include <string.h>
  34
  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.
  41  */
  42
  43 /*
  44    Example 'snoop' output data:
  45
  46 Script started on Thu Sep  9 21:48:49 1999
  47 \e]0;gram@nirvana:/tmp\a$ telnet 10.0.0.254\r
  48 Trying 10.0.0.254...\r
  49 Connected to 10.0.0.254.\r
  50 Escape character is '^]'.\r
  51 \r
  52 \r
  53 TR-600(tr600) System Console\r
  54 \r
  55 Login:admin\r
  56 Password:*******\r
  57 *--------------------------------------------------------*\r
  58 |             T O S H I B A    T R - 6 0 0               |\r
  59 |                 <  Compact Router >                    |\r
  60 |                       V1.02.02                         |\r
  61 |                                                        |\r
  62 |  (C) Copyright TOSHIBA Corp. 1997 All rights reserved. |\r
  63 *--------------------------------------------------------*\r
  64 \r
  65 tr600>snoop dump b1\r
  66  Trace start?(on/off/dump/dtl)->dump\r
  67  IP Address?->b1\r
  68 B1 Port Filetering\r
  69 Trace start(Dump Mode)...\r
  70 \r
  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?\r
  72 OFFSET 0001-0203-0405-0607-0809-0A0B-0C0D-0E0F 0123456789ABCDEF LEN=67\r
  73 0000 : FF03 003D C000 0008 2145 0000 3A12 6500 ...=....!E..:.e.\r
  74 0010 : 003F 11E6 58CF C11A 8897 A401 0804 0400 .?..X...........\r
  75 0020 : 3500 264F D409 5601 0000 0100 0000 0000 5.&O..V.........\r
  76 0030 : 0003 706F 7704 7A69 6E67 036F 7267 0000 ..pow.zing.org..\r
  77 0040 : 0100 01                                 ...\r
  78 \r
  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\r
  80 OFFSET 0001-0203-0405-0607-0809-0A0B-0C0D-0E0F 0123456789ABCDEF LEN=222\r
  81 0000 : FF03 003D C000 0013 2145 0000 D590 9340 ...=....!E.....@\r
  82 0010 : 00F7 116F 8E97 A401 08CF C11A 8800 3504 ...o..........5.\r
  83 0020 : 0400 C13E 0609 5681 8000 0100 0100 0300 ...>..V.........\r
  84 0030 : 0303 706F 7704 7A69 6E67 036F 7267 0000 ..pow.zing.org..\r
  85 0040 : 0100 01C0 0C00 0100 0100 000A 5C00 04CE ............\...\r
  86 0050 : 3924 5A04 5A49 4E47 036F 7267 0000 0200 9$Z.ZING.org....\r
  87 0060 : 0100 016F 5B00 0D03 4841 4E03 5449 5703 ...o[...HAN.TIW.\r
  88 0070 : 4E45 5400 C02E 0002 0001 0001 6F5B 0006 NET.........o[..\r
  89 0080 : 034E 5331 C02E C02E 0002 0001 0001 6F5B .NS1..........o[\r
  90 0090 : 001C 0854 414C 4945 5349 4E0D 434F 4E46 ...TALIESIN.CONF\r
  91 00A0 : 4142 554C 4154 494F 4E03 434F 4D00 C042 ABULATION.COM..B\r
  92 00B0 : 0001 0001 0001 51EC 0004 CE39 2406 C05B ......Q....9$..[\r
  93 00C0 : 0001 0001 0001 6F5B 0004 CE39 245A C06D ......o[...9$Z.m\r
  94 00D0 : 0001 0001 0001 4521 0004 187C 1F01      ......E!...|..\r
  95 \r
  96  */
  97
  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])
 102
 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])
 106
 107 static int toshiba_read(wtap *wth, int *err);
 108 static int toshiba_seek_read(wtap *wth, int seek_off,
 109         union wtap_pseudo_header *pseudo_header, guint8 *pd, int len);
 110 static gboolean parse_single_hex_dump_line(char* rec, guint8 *buf, int byte_offset);
 111 static int parse_toshiba_hex_dump(FILE_T fh, int pkt_len, guint8* buf, int *err);
 112 static int parse_toshiba_rec_hdr(wtap *wth, FILE_T fh,
 113     union wtap_pseudo_header *pseudo_header, int *err);
 114
 115 /* Seeks to the beginning of the next packet, and returns the
 116    byte offset.  Returns -1 on failure. */
 117 /* XXX - Handle I/O errors. */
 118 static int toshiba_seek_next_packet(wtap *wth)
 119 {
 120   int byte;
 121   int level = 0;
 122
 123   while ((byte = file_getc(wth->fh)) != EOF) {
 124     if (byte == toshiba_rec_magic[level]) {
 125       level++;
 126       if (level >= TOSHIBA_REC_MAGIC_SIZE) {
 127               /* note: we're leaving file pointer right after the magic characters */
 128         return file_tell(wth->fh) + 1;
 129       }
 130     } else {
 131       level = 0;
 132     }
 133   }
 134   return -1;
 135 }
 136
 137 #define TOSHIBA_HEADER_LINES_TO_CHECK   200
 138 #define TOSHIBA_LINE_LENGTH             240
 139
 140 /* Look through the first part of a file to see if this is
 141  * a Toshiba trace file.
 142  *
 143  * Returns TRUE if it is, FALSE if it isn't.
 144  */
 145 static gboolean toshiba_check_file_type(wtap *wth)
 146 {
 147         char    buf[TOSHIBA_LINE_LENGTH];
 148         int     reclen, i, line, byte, level;
 149
 150         buf[TOSHIBA_LINE_LENGTH-1] = 0;
 151
 152         for (line = 0; line < TOSHIBA_HEADER_LINES_TO_CHECK; line++) {
 153                 if (file_gets(buf, TOSHIBA_LINE_LENGTH, wth->fh) != NULL) {
 154
 155                         reclen = strlen(buf);
 156                         if (reclen < TOSHIBA_HDR_MAGIC_SIZE) {
 157                                 continue;
 158                         }
 159
 160                         level = 0;
 161                         for (i = 0; i < reclen; i++) {
 162                                 byte = buf[i];
 163                                 if (byte == toshiba_hdr_magic[level]) {
 164                                         level++;
 165                                         if (level >= TOSHIBA_HDR_MAGIC_SIZE) {
 166                                                 return TRUE;
 167                                         }
 168                                 }
 169                                 else {
 170                                         level = 0;
 171                                 }
 172                         }
 173                 }
 174                 else {
 175                         return FALSE;
 176                 }
 177         }
 178         return FALSE;
 179 }
 180
 181
 182 /* XXX - return -1 on I/O error and actually do something with 'err'. */
 183 int toshiba_open(wtap *wth, int *err)
 184 {
 185         /* Reset file position and look for Toshiba header */
 186         file_seek(wth->fh, 0, SEEK_SET);
 187
 188         if (!toshiba_check_file_type(wth)) {
 189                 return 0;
 190         }
 191
 192         wth->data_offset = 0;
 193         wth->file_encap = WTAP_ENCAP_PER_PACKET;
 194         wth->file_type = WTAP_FILE_TOSHIBA;
 195         wth->snapshot_length = 16384; /* just guessing */
 196         wth->subtype_read = toshiba_read;
 197         wth->subtype_seek_read = toshiba_seek_read;
 198
 199         return 1;
 200 }
 201
 202 /* Find the next packet and parse it; called from wtap_loop(). */
 203 static int toshiba_read(wtap *wth, int *err)
 204 {
 205         int     offset = 0;
 206         guint8  *buf;
 207         int     pkt_len;
 208
 209         /* Find the next packet */
 210         offset = toshiba_seek_next_packet(wth);
 211         if (offset < 1) {
 212                 return 0;
 213         }
 214
 215         /* Parse the header */
 216         pkt_len = parse_toshiba_rec_hdr(wth, wth->fh,
 217             &wth->pseudo_header, err);
 218
 219         /* Make sure we have enough room for the packet */
 220         buffer_assure_space(wth->frame_buffer, wth->snapshot_length);
 221         buf = buffer_start_ptr(wth->frame_buffer);
 222
 223         /* Convert the ASCII hex dump to binary data */
 224         parse_toshiba_hex_dump(wth->fh, pkt_len, buf, err);
 225
 226         wth->data_offset = offset;
 227         return offset;
 228 }
 229
 230 /* Used to read packets in random-access fashion */
 231 static int
 232 toshiba_seek_read (wtap *wth, int seek_off, union wtap_pseudo_header *pseudo_header,
 233         guint8 *pd, int len)
 234 {
 235         int     pkt_len;
 236         int     err;
 237
 238         file_seek(wth->random_fh, seek_off - 1, SEEK_SET);
 239
 240         pkt_len = parse_toshiba_rec_hdr(NULL, wth->random_fh, pseudo_header,
 241             &err);
 242
 243         if (pkt_len != len) {
 244                 return -1;
 245         }
 246
 247         parse_toshiba_hex_dump(wth->random_fh, pkt_len, pd, &err);
 248
 249         return 0;
 250 }
 251
 252 /* Parses a packet record header. */
 253 static int
 254 parse_toshiba_rec_hdr(wtap *wth, FILE_T fh,
 255     union wtap_pseudo_header *pseudo_header, int *err)
 256 {
 257         char    line[TOSHIBA_LINE_LENGTH];
 258         int     num_items_scanned;
 259         int     pkt_len, pktnum, hr, min, sec, csec;
 260         char    channel[10], direction[10];
 261
 262         /* Our file pointer should be on the line containing the
 263          * summary information for a packet. Read in that line and
 264          * extract the useful information
 265          */
 266         if (file_gets(line, TOSHIBA_LINE_LENGTH, fh) == NULL) {
 267                 *err = file_error(fh);
 268                 if (*err == 0) {
 269                         *err = WTAP_ERR_SHORT_READ;
 270                 }
 271                 return -1;
 272         }
 273
 274         /* Find text in line after "[No.". Limit the length of the
 275          * two strings since we have fixed buffers for channel[] and
 276          * direction[] */
 277         num_items_scanned = sscanf(line, "%d] %d:%d:%d.%d %9s %9s",
 278                         &pktnum, &hr, &min, &sec, &csec, channel, direction);
 279
 280         if (num_items_scanned != 7) {
 281                 *err = WTAP_ERR_BAD_RECORD;
 282                 return -1;
 283         }
 284
 285         /* Scan lines until we find the OFFSET line. In a "telnet" trace,
 286          * this will be the next line. But if you save your telnet session
 287          * to a file from within a Windows-based telnet client, it may
 288          * put in line breaks at 80 columns (or however big your "telnet" box
 289          * is). CRT (a Windows telnet app from VanDyke) does this.
 290          * Here we assume that 80 columns will be the minimum size, and that
 291          * the OFFSET line is not broken in the middle. It's the previous
 292          * line that is normally long and can thus be broken at column 80.
 293          */
 294         do {
 295                 if (file_gets(line, TOSHIBA_LINE_LENGTH, fh) == NULL) {
 296                         *err = file_error(fh);
 297                         if (*err == 0) {
 298                                 *err = WTAP_ERR_SHORT_READ;
 299                         }
 300                         return -1;
 301                 }
 302
 303                 /* Check for "OFFSET 0001-0203" at beginning of line */
 304                 line[16] = '\0';
 305
 306         } while (strcmp(line, "OFFSET 0001-0203") != 0);
 307
 308         num_items_scanned = sscanf(line+64, "LEN=%d", &pkt_len);
 309         if (num_items_scanned != 1) {
 310                 *err = WTAP_ERR_BAD_RECORD;
 311                 return -1;
 312         }
 313
 314         if (wth) {
 315                 wth->phdr.ts.tv_sec = hr * 3600 + min * 60 + sec;
 316                 wth->phdr.ts.tv_usec = csec * 10000;
 317                 wth->phdr.caplen = pkt_len;
 318                 wth->phdr.len = pkt_len;
 319         }
 320         switch (channel[0]) {
 321                 case 'B':
 322                         if (wth)
 323                                 wth->phdr.pkt_encap = WTAP_ENCAP_PPP;
 324                         break;
 325
 326                 case 'D':
 327                         if (wth)
 328                                 wth->phdr.pkt_encap = WTAP_ENCAP_LAPD;
 329                         pseudo_header->lapd.from_network_to_user =
 330                                 (direction[0] == 'R' ? TRUE : FALSE );
 331                         break;
 332
 333                 default:
 334                         if (wth)
 335                                 wth->phdr.pkt_encap = WTAP_ENCAP_ETHERNET;
 336                         break;
 337         }
 338         return pkt_len;
 339 }
 340
 341 /* Converts ASCII hex dump to binary data */
 342 static int
 343 parse_toshiba_hex_dump(FILE_T fh, int pkt_len, guint8* buf, int *err)
 344 {
 345         char    line[TOSHIBA_LINE_LENGTH];
 346         int     i, hex_lines;
 347
 348         /* Calculate the number of hex dump lines, each
 349          * containing 16 bytes of data */
 350         hex_lines = pkt_len / 16 + ((pkt_len % 16) ? 1 : 0);
 351
 352         for (i = 0; i < hex_lines; i++) {
 353                 if (file_gets(line, TOSHIBA_LINE_LENGTH, fh) == NULL) {
 354                         *err = file_error(fh);
 355                         if (*err == 0) {
 356                                 *err = WTAP_ERR_SHORT_READ;
 357                         }
 358                         return -1;
 359                 }
 360                 if (!parse_single_hex_dump_line(line, buf, i * 16)) {
 361                         *err = WTAP_ERR_BAD_RECORD;
 362                         return -1;
 363                 }
 364         }
 365         return 0;
 366 }
 367
 368 /*
 369           1         2         3         4
 370 0123456789012345678901234567890123456789012345
 371 0000 : FF03 003D C000 0008 2145 0000 3A12 6500 ...=....!E..:.e.\r
 372 0010 : 003F 11E6 58CF C11A 8897 A401 0804 0400 .?..X...........\r
 373 0020 : 0100 01                                 ...\r
 374 */
 375
 376 #define START_POS       7
 377 #define HEX_LENGTH      ((8 * 4) + 7) /* eight clumps of 4 bytes with 7 inner spaces */
 378
 379 /* Take a string representing one line from a hex dump and converts the
 380  * text to binary data. We check the printed offset with the offset
 381  * we are passed to validate the record. We place the bytes in the buffer
 382  * at the specified offset.
 383  *
 384  * In the process, we're going to write all over the string.
 385  *
 386  * Returns TRUE if good hex dump, FALSE if bad.
 387  */
 388 static gboolean
 389 parse_single_hex_dump_line(char* rec, guint8 *buf, int byte_offset) {
 390
 391         int             pos, i;
 392         char            *s;
 393         unsigned long   value;
 394         guint16         word_value;
 395
 396         /* Get the byte_offset directly from the record */
 397         rec[4] = '\0';
 398         s = rec;
 399         value = strtoul(s, NULL, 16);
 400
 401         if (value != byte_offset) {
 402                 return FALSE;
 403         }
 404
 405         /* Go through the substring representing the values and:
 406          *      1. Replace any spaces with '0's
 407          *      2. Place \0's every 5 bytes (to terminate the string)
 408          *
 409          * Then read the eight sets of hex bytes
 410          */
 411
 412         for (pos = START_POS; pos < START_POS + HEX_LENGTH; pos++) {
 413                 if (rec[pos] == ' ') {
 414                         rec[pos] = '0';
 415                 }
 416         }
 417
 418         pos = START_POS;
 419         for (i = 0; i < 8; i++) {
 420                 rec[pos+4] = '\0';
 421
 422                 word_value = (guint16) strtoul(&rec[pos], NULL, 16);
 423                 buf[byte_offset + i * 2 + 0] = (guint8) (word_value >> 8);
 424                 buf[byte_offset + i * 2 + 1] = (guint8) (word_value & 0x00ff);
 425                 pos += 5;
 426         }
 427
 428         return TRUE;
 429 }