wiretap/toshiba.c

   1 /* toshiba.c
   2  *
   3  * $Id$
   4  *
   5  * Wiretap Library
   6  * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
   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
  48 Trying 10.0.0.254...
  49 Connected to 10.0.0.254.
  50 Escape character is '^]'.
  51
  52
  53 TR-600(tr600) System Console
  54
  55 Login:admin
  56 Password:*******
  57 *--------------------------------------------------------*
  58 |             T O S H I B A    T R - 6 0 0               |
  59 |                 <  Compact Router >                    |
  60 |                       V1.02.02                         |
  61 |                                                        |
  62 |  (C) Copyright TOSHIBA Corp. 1997 All rights reserved. |
  63 *--------------------------------------------------------*
  64
  65 tr600>snoop dump b1
  66  Trace start?(on/off/dump/dtl)->dump
  67  IP Address?->b1
  68 B1 Port Filetering
  69 Trace start(Dump Mode)...
  70
  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..
  77 0040 : 0100 01                                 ...
  78
  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!...|..
  95
  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 /*
 108  * XXX - is this the biggest packet we can get?
 109  */
 110 #define TOSHIBA_MAX_PACKET_LEN  16384
 111
 112 static gboolean toshiba_read(wtap *wth, int *err, gchar **err_info,
 113         long *data_offset);
 114 static gboolean toshiba_seek_read(wtap *wth, long seek_off,
 115         union wtap_pseudo_header *pseudo_header, guint8 *pd, int len,
 116         int *err, gchar **err_info);
 117 static gboolean parse_single_hex_dump_line(char* rec, guint8 *buf,
 118         guint byte_offset);
 119 static gboolean parse_toshiba_hex_dump(FILE_T fh, int pkt_len, guint8* buf,
 120         int *err, gchar **err_info);
 121 static int parse_toshiba_rec_hdr(wtap *wth, FILE_T fh,
 122     union wtap_pseudo_header *pseudo_header, int *err, gchar **err_info);
 123
 124 /* Seeks to the beginning of the next packet, and returns the
 125    byte offset.  Returns -1 on failure, and sets "*err" to the error. */
 126 static long toshiba_seek_next_packet(wtap *wth, int *err)
 127 {
 128   int byte;
 129   guint level = 0;
 130   long cur_off;
 131
 132   while ((byte = file_getc(wth->fh)) != EOF) {
 133     if (byte == toshiba_rec_magic[level]) {
 134       level++;
 135       if (level >= TOSHIBA_REC_MAGIC_SIZE) {
 136               /* note: we're leaving file pointer right after the magic characters */
 137         cur_off = file_tell(wth->fh);
 138         if (cur_off == -1) {
 139           /* Error. */
 140           *err = file_error(wth->fh);
 141           return -1;
 142         }
 143         return cur_off + 1;
 144       }
 145     } else {
 146       level = 0;
 147     }
 148   }
 149   if (file_eof(wth->fh)) {
 150     /* We got an EOF. */
 151     *err = 0;
 152   } else {
 153     /* We (presumably) got an error (there's no equivalent to "ferror()"
 154        in zlib, alas, so we don't have a wrapper to check for an error). */
 155     *err = file_error(wth->fh);
 156   }
 157   return -1;
 158 }
 159
 160 #define TOSHIBA_HEADER_LINES_TO_CHECK   200
 161 #define TOSHIBA_LINE_LENGTH             240
 162
 163 /* Look through the first part of a file to see if this is
 164  * a Toshiba trace file.
 165  *
 166  * Returns TRUE if it is, FALSE if it isn't or if we get an I/O error;
 167  * if we get an I/O error, "*err" will be set to a non-zero value.
 168  */
 169 static gboolean toshiba_check_file_type(wtap *wth, int *err)
 170 {
 171         char    buf[TOSHIBA_LINE_LENGTH];
 172         guint   i, reclen, level, line;
 173         char    byte;
 174
 175         buf[TOSHIBA_LINE_LENGTH-1] = 0;
 176
 177         for (line = 0; line < TOSHIBA_HEADER_LINES_TO_CHECK; line++) {
 178                 if (file_gets(buf, TOSHIBA_LINE_LENGTH, wth->fh) != NULL) {
 179
 180                         reclen = strlen(buf);
 181                         if (reclen < TOSHIBA_HDR_MAGIC_SIZE) {
 182                                 continue;
 183                         }
 184
 185                         level = 0;
 186                         for (i = 0; i < reclen; i++) {
 187                                 byte = buf[i];
 188                                 if (byte == toshiba_hdr_magic[level]) {
 189                                         level++;
 190                                         if (level >= TOSHIBA_HDR_MAGIC_SIZE) {
 191                                                 return TRUE;
 192                                         }
 193                                 }
 194                                 else {
 195                                         level = 0;
 196                                 }
 197                         }
 198                 }
 199                 else {
 200                         /* EOF or error. */
 201                         if (file_eof(wth->fh))
 202                                 *err = 0;
 203                         else
 204                                 *err = file_error(wth->fh);
 205                         return FALSE;
 206                 }
 207         }
 208         *err = 0;
 209         return FALSE;
 210 }
 211
 212
 213 int toshiba_open(wtap *wth, int *err, gchar **err_info _U_)
 214 {
 215         /* Look for Toshiba header */
 216         if (!toshiba_check_file_type(wth, err)) {
 217                 if (*err == 0)
 218                         return 0;
 219                 else
 220                         return -1;
 221         }
 222
 223         wth->data_offset = 0;
 224         wth->file_encap = WTAP_ENCAP_PER_PACKET;
 225         wth->file_type = WTAP_FILE_TOSHIBA;
 226         wth->snapshot_length = 0; /* not known */
 227         wth->subtype_read = toshiba_read;
 228         wth->subtype_seek_read = toshiba_seek_read;
 229         wth->tsprecision = WTAP_FILE_TSPREC_CSEC;
 230
 231         return 1;
 232 }
 233
 234 /* Find the next packet and parse it; called from wtap_read(). */
 235 static gboolean toshiba_read(wtap *wth, int *err, gchar **err_info,
 236     long *data_offset)
 237 {
 238         long    offset;
 239         guint8  *buf;
 240         int     pkt_len;
 241
 242         /* Find the next packet */
 243         offset = toshiba_seek_next_packet(wth, err);
 244         if (offset < 1)
 245                 return FALSE;
 246
 247         /* Parse the header */
 248         pkt_len = parse_toshiba_rec_hdr(wth, wth->fh, &wth->pseudo_header,
 249             err, err_info);
 250         if (pkt_len == -1)
 251                 return FALSE;
 252
 253         /* Make sure we have enough room for the packet */
 254         buffer_assure_space(wth->frame_buffer, TOSHIBA_MAX_PACKET_LEN);
 255         buf = buffer_start_ptr(wth->frame_buffer);
 256
 257         /* Convert the ASCII hex dump to binary data */
 258         if (!parse_toshiba_hex_dump(wth->fh, pkt_len, buf, err, err_info))
 259                 return FALSE;
 260
 261         wth->data_offset = offset;
 262         *data_offset = offset;
 263         return TRUE;
 264 }
 265
 266 /* Used to read packets in random-access fashion */
 267 static gboolean
 268 toshiba_seek_read (wtap *wth, long seek_off,
 269         union wtap_pseudo_header *pseudo_header, guint8 *pd, int len,
 270         int *err, gchar **err_info)
 271 {
 272         int     pkt_len;
 273
 274         if (file_seek(wth->random_fh, seek_off - 1, SEEK_SET, err) == -1)
 275                 return FALSE;
 276
 277         pkt_len = parse_toshiba_rec_hdr(NULL, wth->random_fh, pseudo_header,
 278             err, err_info);
 279
 280         if (pkt_len != len) {
 281                 if (pkt_len != -1) {
 282                         *err = WTAP_ERR_BAD_RECORD;
 283                         *err_info = g_strdup_printf("toshiba: requested length %d doesn't match record length %d",
 284                             len, pkt_len);
 285                 }
 286                 return FALSE;
 287         }
 288
 289         return parse_toshiba_hex_dump(wth->random_fh, pkt_len, pd, err, err_info);
 290 }
 291
 292 /* Parses a packet record header. */
 293 static int
 294 parse_toshiba_rec_hdr(wtap *wth, FILE_T fh,
 295     union wtap_pseudo_header *pseudo_header, int *err, gchar **err_info)
 296 {
 297         char    line[TOSHIBA_LINE_LENGTH];
 298         int     num_items_scanned;
 299         int     pkt_len, pktnum, hr, min, sec, csec;
 300         char    channel[10], direction[10];
 301
 302         /* Our file pointer should be on the line containing the
 303          * summary information for a packet. Read in that line and
 304          * extract the useful information
 305          */
 306         if (file_gets(line, TOSHIBA_LINE_LENGTH, fh) == NULL) {
 307                 *err = file_error(fh);
 308                 if (*err == 0) {
 309                         *err = WTAP_ERR_SHORT_READ;
 310                 }
 311                 return -1;
 312         }
 313
 314         /* Find text in line after "[No.". Limit the length of the
 315          * two strings since we have fixed buffers for channel[] and
 316          * direction[] */
 317         num_items_scanned = sscanf(line, "%d] %d:%d:%d.%d %9s %9s",
 318                         &pktnum, &hr, &min, &sec, &csec, channel, direction);
 319
 320         if (num_items_scanned != 7) {
 321                 *err = WTAP_ERR_BAD_RECORD;
 322                 *err_info = g_strdup("toshiba: record header isn't valid");
 323                 return -1;
 324         }
 325
 326         /* Scan lines until we find the OFFSET line. In a "telnet" trace,
 327          * this will be the next line. But if you save your telnet session
 328          * to a file from within a Windows-based telnet client, it may
 329          * put in line breaks at 80 columns (or however big your "telnet" box
 330          * is). CRT (a Windows telnet app from VanDyke) does this.
 331          * Here we assume that 80 columns will be the minimum size, and that
 332          * the OFFSET line is not broken in the middle. It's the previous
 333          * line that is normally long and can thus be broken at column 80.
 334          */
 335         do {
 336                 if (file_gets(line, TOSHIBA_LINE_LENGTH, fh) == NULL) {
 337                         *err = file_error(fh);
 338                         if (*err == 0) {
 339                                 *err = WTAP_ERR_SHORT_READ;
 340                         }
 341                         return -1;
 342                 }
 343
 344                 /* Check for "OFFSET 0001-0203" at beginning of line */
 345                 line[16] = '\0';
 346
 347         } while (strcmp(line, "OFFSET 0001-0203") != 0);
 348
 349         num_items_scanned = sscanf(line+64, "LEN=%d", &pkt_len);
 350         if (num_items_scanned != 1) {
 351                 *err = WTAP_ERR_BAD_RECORD;
 352                 *err_info = g_strdup("toshiba: OFFSET line doesn't have valid LEN item");
 353                 return -1;
 354         }
 355
 356         if (wth) {
 357                 wth->phdr.ts.secs = hr * 3600 + min * 60 + sec;
 358                 wth->phdr.ts.nsecs = csec * 10000000;
 359                 wth->phdr.caplen = pkt_len;
 360                 wth->phdr.len = pkt_len;
 361         }
 362         switch (channel[0]) {
 363                 case 'B':
 364                         if (wth)
 365                                 wth->phdr.pkt_encap = WTAP_ENCAP_ISDN;
 366                         pseudo_header->isdn.uton = (direction[0] == 'T');
 367                         pseudo_header->isdn.channel = (guint8)
 368                             strtol(&channel[1], NULL, 10);
 369                         break;
 370
 371                 case 'D':
 372                         if (wth)
 373                                 wth->phdr.pkt_encap = WTAP_ENCAP_ISDN;
 374                         pseudo_header->isdn.uton = (direction[0] == 'T');
 375                         pseudo_header->isdn.channel = 0;
 376                         break;
 377
 378                 default:
 379                         if (wth)
 380                                 wth->phdr.pkt_encap = WTAP_ENCAP_ETHERNET;
 381                         /* XXX - is there an FCS in the frame? */
 382                         pseudo_header->eth.fcs_len = -1;
 383                         break;
 384         }
 385         return pkt_len;
 386 }
 387
 388 /* Converts ASCII hex dump to binary data */
 389 static gboolean
 390 parse_toshiba_hex_dump(FILE_T fh, int pkt_len, guint8* buf, int *err,
 391     gchar **err_info)
 392 {
 393         char    line[TOSHIBA_LINE_LENGTH];
 394         int     i, hex_lines;
 395
 396         /* Calculate the number of hex dump lines, each
 397          * containing 16 bytes of data */
 398         hex_lines = pkt_len / 16 + ((pkt_len % 16) ? 1 : 0);
 399
 400         for (i = 0; i < hex_lines; i++) {
 401                 if (file_gets(line, TOSHIBA_LINE_LENGTH, fh) == NULL) {
 402                         *err = file_error(fh);
 403                         if (*err == 0) {
 404                                 *err = WTAP_ERR_SHORT_READ;
 405                         }
 406                         return FALSE;
 407                 }
 408                 if (!parse_single_hex_dump_line(line, buf, i * 16)) {
 409                         *err = WTAP_ERR_BAD_RECORD;
 410                         *err_info = g_strdup("toshiba: hex dump not valid");
 411                         return FALSE;
 412                 }
 413         }
 414         return TRUE;
 415 }
 416
 417 /*
 418           1         2         3         4
 419 0123456789012345678901234567890123456789012345
 420 0000 : FF03 003D C000 0008 2145 0000 3A12 6500 ...=....!E..:.e.
 421 0010 : 003F 11E6 58CF C11A 8897 A401 0804 0400 .?..X...........
 422 0020 : 0100 01                                 ...
 423 */
 424
 425 #define START_POS       7
 426 #define HEX_LENGTH      ((8 * 4) + 7) /* eight clumps of 4 bytes with 7 inner spaces */
 427
 428 /* Take a string representing one line from a hex dump and converts the
 429  * text to binary data. We check the printed offset with the offset
 430  * we are passed to validate the record. We place the bytes in the buffer
 431  * at the specified offset.
 432  *
 433  * In the process, we're going to write all over the string.
 434  *
 435  * Returns TRUE if good hex dump, FALSE if bad.
 436  */
 437 static gboolean
 438 parse_single_hex_dump_line(char* rec, guint8 *buf, guint byte_offset) {
 439
 440         int             pos, i;
 441         char            *s;
 442         unsigned long   value;
 443         guint16         word_value;
 444
 445         /* Get the byte_offset directly from the record */
 446         rec[4] = '\0';
 447         s = rec;
 448         value = strtoul(s, NULL, 16);
 449
 450         if (value != byte_offset) {
 451                 return FALSE;
 452         }
 453
 454         /* Go through the substring representing the values and:
 455          *      1. Replace any spaces with '0's
 456          *      2. Place \0's every 5 bytes (to terminate the string)
 457          *
 458          * Then read the eight sets of hex bytes
 459          */
 460
 461         for (pos = START_POS; pos < START_POS + HEX_LENGTH; pos++) {
 462                 if (rec[pos] == ' ') {
 463                         rec[pos] = '0';
 464                 }
 465         }
 466
 467         pos = START_POS;
 468         for (i = 0; i < 8; i++) {
 469                 rec[pos+4] = '\0';
 470
 471                 word_value = (guint16) strtoul(&rec[pos], NULL, 16);
 472                 buf[byte_offset + i * 2 + 0] = (guint8) (word_value >> 8);
 473                 buf[byte_offset + i * 2 + 1] = (guint8) (word_value & 0x00ff);
 474                 pos += 5;
 475         }
 476
 477         return TRUE;
 478 }