Removed trailing whitespaces from .h and .c files using the
[obnox/wireshark/wip.git] / wiretap / toshiba.c
1 /* toshiba.c
2  *
3  * $Id: toshiba.c,v 1.25 2002/08/28 20:30:45 jmayer Exp $
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, 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,
116         guint byte_offset);
117 static gboolean parse_toshiba_hex_dump(FILE_T fh, int pkt_len, guint8* buf,
118         int *err);
119 static int parse_toshiba_rec_hdr(wtap *wth, FILE_T fh,
120     union wtap_pseudo_header *pseudo_header, int *err);
121
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)
125 {
126   int byte;
127   guint level = 0;
128   long cur_off;
129
130   while ((byte = file_getc(wth->fh)) != EOF) {
131     if (byte == toshiba_rec_magic[level]) {
132       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);
136         if (cur_off == -1) {
137           /* Error. */
138           *err = file_error(wth->fh);
139           return -1;
140         }
141         return cur_off + 1;
142       }
143     } else {
144       level = 0;
145     }
146   }
147   if (file_eof(wth->fh)) {
148     /* We got an EOF. */
149     *err = 0;
150   } else {
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);
154   }
155   return -1;
156 }
157
158 #define TOSHIBA_HEADER_LINES_TO_CHECK   200
159 #define TOSHIBA_LINE_LENGTH             240
160
161 /* Look through the first part of a file to see if this is
162  * a Toshiba trace file.
163  *
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.
166  */
167 static gboolean toshiba_check_file_type(wtap *wth, int *err)
168 {
169         char    buf[TOSHIBA_LINE_LENGTH];
170         guint   i, reclen, level, line;
171         char    byte;
172
173         buf[TOSHIBA_LINE_LENGTH-1] = 0;
174
175         for (line = 0; line < TOSHIBA_HEADER_LINES_TO_CHECK; line++) {
176                 if (file_gets(buf, TOSHIBA_LINE_LENGTH, wth->fh) != NULL) {
177
178                         reclen = strlen(buf);
179                         if (reclen < TOSHIBA_HDR_MAGIC_SIZE) {
180                                 continue;
181                         }
182
183                         level = 0;
184                         for (i = 0; i < reclen; i++) {
185                                 byte = buf[i];
186                                 if (byte == toshiba_hdr_magic[level]) {
187                                         level++;
188                                         if (level >= TOSHIBA_HDR_MAGIC_SIZE) {
189                                                 return TRUE;
190                                         }
191                                 }
192                                 else {
193                                         level = 0;
194                                 }
195                         }
196                 }
197                 else {
198                         /* EOF or error. */
199                         if (file_eof(wth->fh))
200                                 *err = 0;
201                         else
202                                 *err = file_error(wth->fh);
203                         return FALSE;
204                 }
205         }
206         *err = 0;
207         return FALSE;
208 }
209
210
211 int toshiba_open(wtap *wth, int *err)
212 {
213         /* Look for Toshiba header */
214         if (!toshiba_check_file_type(wth, err)) {
215                 if (*err == 0)
216                         return 0;
217                 else
218                         return -1;
219         }
220
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;
227
228         return 1;
229 }
230
231 /* Find the next packet and parse it; called from wtap_loop(). */
232 static gboolean toshiba_read(wtap *wth, int *err, long *data_offset)
233 {
234         long    offset;
235         guint8  *buf;
236         int     pkt_len;
237
238         /* Find the next packet */
239         offset = toshiba_seek_next_packet(wth, err);
240         if (offset < 1)
241                 return FALSE;
242
243         /* Parse the header */
244         pkt_len = parse_toshiba_rec_hdr(wth, wth->fh, &wth->pseudo_header, err);
245         if (pkt_len == -1)
246                 return FALSE;
247
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);
251
252         /* Convert the ASCII hex dump to binary data */
253         if (!parse_toshiba_hex_dump(wth->fh, pkt_len, buf, err))
254                 return FALSE;
255
256         wth->data_offset = offset;
257         *data_offset = offset;
258         return TRUE;
259 }
260
261 /* Used to read packets in random-access fashion */
262 static gboolean
263 toshiba_seek_read (wtap *wth, long seek_off,
264         union wtap_pseudo_header *pseudo_header, guint8 *pd, int len, int *err)
265 {
266         int     pkt_len;
267
268         if (file_seek(wth->random_fh, seek_off - 1, SEEK_SET, err) == -1)
269                 return FALSE;
270
271         pkt_len = parse_toshiba_rec_hdr(NULL, wth->random_fh, pseudo_header,
272             err);
273
274         if (pkt_len != len) {
275                 if (pkt_len != -1)
276                         *err = WTAP_ERR_BAD_RECORD;
277                 return FALSE;
278         }
279
280         return parse_toshiba_hex_dump(wth->random_fh, pkt_len, pd, err);
281 }
282
283 /* Parses a packet record header. */
284 static int
285 parse_toshiba_rec_hdr(wtap *wth, FILE_T fh,
286     union wtap_pseudo_header *pseudo_header, int *err)
287 {
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];
292
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
296          */
297         if (file_gets(line, TOSHIBA_LINE_LENGTH, fh) == NULL) {
298                 *err = file_error(fh);
299                 if (*err == 0) {
300                         *err = WTAP_ERR_SHORT_READ;
301                 }
302                 return -1;
303         }
304
305         /* Find text in line after "[No.". Limit the length of the
306          * two strings since we have fixed buffers for channel[] and
307          * direction[] */
308         num_items_scanned = sscanf(line, "%d] %d:%d:%d.%d %9s %9s",
309                         &pktnum, &hr, &min, &sec, &csec, channel, direction);
310
311         if (num_items_scanned != 7) {
312                 *err = WTAP_ERR_BAD_RECORD;
313                 return -1;
314         }
315
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.
324          */
325         do {
326                 if (file_gets(line, TOSHIBA_LINE_LENGTH, fh) == NULL) {
327                         *err = file_error(fh);
328                         if (*err == 0) {
329                                 *err = WTAP_ERR_SHORT_READ;
330                         }
331                         return -1;
332                 }
333
334                 /* Check for "OFFSET 0001-0203" at beginning of line */
335                 line[16] = '\0';
336
337         } while (strcmp(line, "OFFSET 0001-0203") != 0);
338
339         num_items_scanned = sscanf(line+64, "LEN=%d", &pkt_len);
340         if (num_items_scanned != 1) {
341                 *err = WTAP_ERR_BAD_RECORD;
342                 return -1;
343         }
344
345         if (wth) {
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;
350         }
351         switch (channel[0]) {
352                 case 'B':
353                         if (wth)
354                                 wth->phdr.pkt_encap = WTAP_ENCAP_PPP;
355                         break;
356
357                 case 'D':
358                         if (wth)
359                                 wth->phdr.pkt_encap = WTAP_ENCAP_LAPD;
360                         pseudo_header->p2p.sent =
361                                 (direction[0] == 'T' ? TRUE : FALSE );
362                         break;
363
364                 default:
365                         if (wth)
366                                 wth->phdr.pkt_encap = WTAP_ENCAP_ETHERNET;
367                         break;
368         }
369         return pkt_len;
370 }
371
372 /* Converts ASCII hex dump to binary data */
373 static gboolean
374 parse_toshiba_hex_dump(FILE_T fh, int pkt_len, guint8* buf, int *err)
375 {
376         char    line[TOSHIBA_LINE_LENGTH];
377         int     i, hex_lines;
378
379         /* Calculate the number of hex dump lines, each
380          * containing 16 bytes of data */
381         hex_lines = pkt_len / 16 + ((pkt_len % 16) ? 1 : 0);
382
383         for (i = 0; i < hex_lines; i++) {
384                 if (file_gets(line, TOSHIBA_LINE_LENGTH, fh) == NULL) {
385                         *err = file_error(fh);
386                         if (*err == 0) {
387                                 *err = WTAP_ERR_SHORT_READ;
388                         }
389                         return FALSE;
390                 }
391                 if (!parse_single_hex_dump_line(line, buf, i * 16)) {
392                         *err = WTAP_ERR_BAD_RECORD;
393                         return FALSE;
394                 }
395         }
396         return TRUE;
397 }
398
399 /*
400           1         2         3         4
401 0123456789012345678901234567890123456789012345
402 0000 : FF03 003D C000 0008 2145 0000 3A12 6500 ...=....!E..:.e.
403 0010 : 003F 11E6 58CF C11A 8897 A401 0804 0400 .?..X...........
404 0020 : 0100 01                                 ...
405 */
406
407 #define START_POS       7
408 #define HEX_LENGTH      ((8 * 4) + 7) /* eight clumps of 4 bytes with 7 inner spaces */
409
410 /* Take a string representing one line from a hex dump and converts the
411  * text to binary data. We check the printed offset with the offset
412  * we are passed to validate the record. We place the bytes in the buffer
413  * at the specified offset.
414  *
415  * In the process, we're going to write all over the string.
416  *
417  * Returns TRUE if good hex dump, FALSE if bad.
418  */
419 static gboolean
420 parse_single_hex_dump_line(char* rec, guint8 *buf, guint byte_offset) {
421
422         int             pos, i;
423         char            *s;
424         unsigned long   value;
425         guint16         word_value;
426
427         /* Get the byte_offset directly from the record */
428         rec[4] = '\0';
429         s = rec;
430         value = strtoul(s, NULL, 16);
431
432         if (value != byte_offset) {
433                 return FALSE;
434         }
435
436         /* Go through the substring representing the values and:
437          *      1. Replace any spaces with '0's
438          *      2. Place \0's every 5 bytes (to terminate the string)
439          *
440          * Then read the eight sets of hex bytes
441          */
442
443         for (pos = START_POS; pos < START_POS + HEX_LENGTH; pos++) {
444                 if (rec[pos] == ' ') {
445                         rec[pos] = '0';
446                 }
447         }
448
449         pos = START_POS;
450         for (i = 0; i < 8; i++) {
451                 rec[pos+4] = '\0';
452
453                 word_value = (guint16) strtoul(&rec[pos], NULL, 16);
454                 buf[byte_offset + i * 2 + 0] = (guint8) (word_value >> 8);
455                 buf[byte_offset + i * 2 + 1] = (guint8) (word_value & 0x00ff);
456                 pos += 5;
457         }
458
459         return TRUE;
460 }