Make sure the packet length isn't > WTAP_MAX_PACKET_SIZE.
[metze/wireshark/wip.git] / wiretap / toshiba.c
1 /* toshiba.c
2  *
3  * Wiretap Library
4  * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19  */
20
21 #include "config.h"
22 #include "wtap-int.h"
23 #include "toshiba.h"
24 #include "file_wrappers.h"
25
26 #include <stdlib.h>
27 #include <string.h>
28
29 /* This module reads the output of the 'snoop' command in the Toshiba
30  * TR-600 and TR-650 "Compact" ISDN Routers. You can telnet to the
31  * router and run 'snoop' on the different channels, and at different
32  * detail levels. Be sure to choose the 'dump' level to get the hex dump.
33  * The 'snoop' command has nothing to do with the Solaris 'snoop'
34  * command, except that they both capture packets.
35  */
36
37 /*
38    Example 'snoop' output data:
39
40 Script started on Thu Sep  9 21:48:49 1999
41 \e]0;gram@nirvana:/tmp\a$ telnet 10.0.0.254
42 Trying 10.0.0.254...
43 Connected to 10.0.0.254.
44 Escape character is '^]'.
45
46
47 TR-600(tr600) System Console
48
49 Login:admin
50 Password:*******
51 *--------------------------------------------------------*
52 |             T O S H I B A    T R - 6 0 0               |
53 |                 <  Compact Router >                    |
54 |                       V1.02.02                         |
55 |                                                        |
56 |  (C) Copyright TOSHIBA Corp. 1997 All rights reserved. |
57 *--------------------------------------------------------*
58
59 tr600>snoop dump b1
60  Trace start?(on/off/dump/dtl)->dump
61  IP Address?->b1
62 B1 Port Filetering
63 Trace start(Dump Mode)...
64
65 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?
66 OFFSET 0001-0203-0405-0607-0809-0A0B-0C0D-0E0F 0123456789ABCDEF LEN=67
67 0000 : FF03 003D C000 0008 2145 0000 3A12 6500 ...=....!E..:.e.
68 0010 : 003F 11E6 58CF C11A 8897 A401 0804 0400 .?..X...........
69 0020 : 3500 264F D409 5601 0000 0100 0000 0000 5.&O..V.........
70 0030 : 0003 706F 7704 7A69 6E67 036F 7267 0000 ..pow.zing.org..
71 0040 : 0100 01                                 ...
72
73 [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
74 OFFSET 0001-0203-0405-0607-0809-0A0B-0C0D-0E0F 0123456789ABCDEF LEN=222
75 0000 : FF03 003D C000 0013 2145 0000 D590 9340 ...=....!E.....@
76 0010 : 00F7 116F 8E97 A401 08CF C11A 8800 3504 ...o..........5.
77 0020 : 0400 C13E 0609 5681 8000 0100 0100 0300 ...>..V.........
78 0030 : 0303 706F 7704 7A69 6E67 036F 7267 0000 ..pow.zing.org..
79 0040 : 0100 01C0 0C00 0100 0100 000A 5C00 04CE ............\...
80 0050 : 3924 5A04 5A49 4E47 036F 7267 0000 0200 9$Z.ZING.org....
81 0060 : 0100 016F 5B00 0D03 4841 4E03 5449 5703 ...o[...HAN.TIW.
82 0070 : 4E45 5400 C02E 0002 0001 0001 6F5B 0006 NET.........o[..
83 0080 : 034E 5331 C02E C02E 0002 0001 0001 6F5B .NS1..........o[
84 0090 : 001C 0854 414C 4945 5349 4E0D 434F 4E46 ...TALIESIN.CONF
85 00A0 : 4142 554C 4154 494F 4E03 434F 4D00 C042 ABULATION.COM..B
86 00B0 : 0001 0001 0001 51EC 0004 CE39 2406 C05B ......Q....9$..[
87 00C0 : 0001 0001 0001 6F5B 0004 CE39 245A C06D ......o[...9$Z.m
88 00D0 : 0001 0001 0001 4521 0004 187C 1F01      ......E!...|..
89
90  */
91
92 /* Magic text to check for toshiba-ness of file */
93 static const char toshiba_hdr_magic[]  =
94 { 'T', ' ', 'O', ' ', 'S', ' ', 'H', ' ', 'I', ' ', 'B', ' ', 'A' };
95 #define TOSHIBA_HDR_MAGIC_SIZE  (sizeof toshiba_hdr_magic  / sizeof toshiba_hdr_magic[0])
96
97 /* Magic text for start of packet */
98 static const char toshiba_rec_magic[]  = { '[', 'N', 'o', '.' };
99 #define TOSHIBA_REC_MAGIC_SIZE  (sizeof toshiba_rec_magic  / sizeof toshiba_rec_magic[0])
100
101 static gboolean toshiba_read(wtap *wth, int *err, gchar **err_info,
102         gint64 *data_offset);
103 static gboolean toshiba_seek_read(wtap *wth, gint64 seek_off,
104         struct wtap_pkthdr *phdr, Buffer *buf, int *err, gchar **err_info);
105 static gboolean parse_single_hex_dump_line(char* rec, guint8 *buf,
106         guint byte_offset);
107 static gboolean parse_toshiba_packet(FILE_T fh, struct wtap_pkthdr *phdr,
108         Buffer *buf, int *err, gchar **err_info);
109
110 /* Seeks to the beginning of the next packet, and returns the
111    byte offset.  Returns -1 on failure, and sets "*err" to the error
112    and "*err_info" to null or an additional error string. */
113 static gint64 toshiba_seek_next_packet(wtap *wth, int *err, gchar **err_info)
114 {
115         int byte;
116         guint level = 0;
117         gint64 cur_off;
118
119         while ((byte = file_getc(wth->fh)) != EOF) {
120                 if (byte == toshiba_rec_magic[level]) {
121                         level++;
122                         if (level >= TOSHIBA_REC_MAGIC_SIZE) {
123                                 /* note: we're leaving file pointer right after the magic characters */
124                                 cur_off = file_tell(wth->fh);
125                                 if (cur_off == -1) {
126                                         /* Error. */
127                                         *err = file_error(wth->fh, err_info);
128                                         return -1;
129                                 }
130                                 return cur_off + 1;
131                         }
132                 } else {
133                         level = 0;
134                 }
135         }
136         /* EOF or error. */
137         *err = file_error(wth->fh, err_info);
138         return -1;
139 }
140
141 #define TOSHIBA_HEADER_LINES_TO_CHECK   200
142 #define TOSHIBA_LINE_LENGTH             240
143
144 /* Look through the first part of a file to see if this is
145  * a Toshiba trace file.
146  *
147  * Returns TRUE if it is, FALSE if it isn't or if we get an I/O error;
148  * if we get an I/O error, "*err" will be set to a non-zero value and
149  * "*err_info" will be set to null or an additional error string.
150  */
151 static gboolean toshiba_check_file_type(wtap *wth, int *err, gchar **err_info)
152 {
153         char    buf[TOSHIBA_LINE_LENGTH];
154         guint   i, reclen, level, line;
155         char    byte;
156
157         buf[TOSHIBA_LINE_LENGTH-1] = 0;
158
159         for (line = 0; line < TOSHIBA_HEADER_LINES_TO_CHECK; line++) {
160                 if (file_gets(buf, TOSHIBA_LINE_LENGTH, wth->fh) == NULL) {
161                         /* EOF or error. */
162                         *err = file_error(wth->fh, err_info);
163                         return FALSE;
164                 }
165
166                 reclen = (guint) strlen(buf);
167                 if (reclen < TOSHIBA_HDR_MAGIC_SIZE) {
168                         continue;
169                 }
170
171                 level = 0;
172                 for (i = 0; i < reclen; i++) {
173                         byte = buf[i];
174                         if (byte == toshiba_hdr_magic[level]) {
175                                 level++;
176                                 if (level >= TOSHIBA_HDR_MAGIC_SIZE) {
177                                         return TRUE;
178                                 }
179                         }
180                         else {
181                                 level = 0;
182                         }
183                 }
184         }
185         *err = 0;
186         return FALSE;
187 }
188
189
190 wtap_open_return_val toshiba_open(wtap *wth, int *err, gchar **err_info)
191 {
192         /* Look for Toshiba header */
193         if (!toshiba_check_file_type(wth, err, err_info)) {
194                 if (*err != 0 && *err != WTAP_ERR_SHORT_READ)
195                         return WTAP_OPEN_ERROR;
196                 return WTAP_OPEN_NOT_MINE;
197         }
198
199         wth->file_encap = WTAP_ENCAP_PER_PACKET;
200         wth->file_type_subtype = WTAP_FILE_TYPE_SUBTYPE_TOSHIBA;
201         wth->snapshot_length = 0; /* not known */
202         wth->subtype_read = toshiba_read;
203         wth->subtype_seek_read = toshiba_seek_read;
204         wth->file_tsprec = WTAP_TSPREC_CSEC;
205
206         return WTAP_OPEN_MINE;
207 }
208
209 /* Find the next packet and parse it; called from wtap_read(). */
210 static gboolean toshiba_read(wtap *wth, int *err, gchar **err_info,
211     gint64 *data_offset)
212 {
213         gint64  offset;
214
215         /* Find the next packet */
216         offset = toshiba_seek_next_packet(wth, err, err_info);
217         if (offset < 1)
218                 return FALSE;
219         *data_offset = offset;
220
221         /* Parse the packet */
222         return parse_toshiba_packet(wth->fh, &wth->phdr, wth->frame_buffer,
223             err, err_info);
224 }
225
226 /* Used to read packets in random-access fashion */
227 static gboolean
228 toshiba_seek_read(wtap *wth, gint64 seek_off,
229         struct wtap_pkthdr *phdr, Buffer *buf,
230         int *err, gchar **err_info)
231 {
232         if (file_seek(wth->random_fh, seek_off - 1, SEEK_SET, err) == -1)
233                 return FALSE;
234
235         if (!parse_toshiba_packet(wth->random_fh, phdr, buf, err, err_info)) {
236                 if (*err == 0)
237                         *err = WTAP_ERR_SHORT_READ;
238                 return FALSE;
239         }
240         return TRUE;
241 }
242
243 /* Parses a packet. */
244 static gboolean
245 parse_toshiba_packet(FILE_T fh, struct wtap_pkthdr *phdr, Buffer *buf,
246     int *err, gchar **err_info)
247 {
248         union wtap_pseudo_header *pseudo_header = &phdr->pseudo_header;
249         char    line[TOSHIBA_LINE_LENGTH];
250         int     num_items_scanned;
251         int     pkt_len, pktnum, hr, min, sec, csec;
252         char    channel[10], direction[10];
253         int     i, hex_lines;
254         guint8  *pd;
255
256         /* Our file pointer should be on the line containing the
257          * summary information for a packet. Read in that line and
258          * extract the useful information
259          */
260         if (file_gets(line, TOSHIBA_LINE_LENGTH, fh) == NULL) {
261                 *err = file_error(fh, err_info);
262                 if (*err == 0) {
263                         *err = WTAP_ERR_SHORT_READ;
264                 }
265                 return FALSE;
266         }
267
268         /* Find text in line after "[No.". Limit the length of the
269          * two strings since we have fixed buffers for channel[] and
270          * direction[] */
271         num_items_scanned = sscanf(line, "%9d] %2d:%2d:%2d.%9d %9s %9s",
272                         &pktnum, &hr, &min, &sec, &csec, channel, direction);
273
274         if (num_items_scanned != 7) {
275                 *err = WTAP_ERR_BAD_FILE;
276                 *err_info = g_strdup("toshiba: record header isn't valid");
277                 return FALSE;
278         }
279
280         /* Scan lines until we find the OFFSET line. In a "telnet" trace,
281          * this will be the next line. But if you save your telnet session
282          * to a file from within a Windows-based telnet client, it may
283          * put in line breaks at 80 columns (or however big your "telnet" box
284          * is). CRT (a Windows telnet app from VanDyke) does this.
285          * Here we assume that 80 columns will be the minimum size, and that
286          * the OFFSET line is not broken in the middle. It's the previous
287          * line that is normally long and can thus be broken at column 80.
288          */
289         do {
290                 if (file_gets(line, TOSHIBA_LINE_LENGTH, fh) == NULL) {
291                         *err = file_error(fh, err_info);
292                         if (*err == 0) {
293                                 *err = WTAP_ERR_SHORT_READ;
294                         }
295                         return FALSE;
296                 }
297
298                 /* Check for "OFFSET 0001-0203" at beginning of line */
299                 line[16] = '\0';
300
301         } while (strcmp(line, "OFFSET 0001-0203") != 0);
302
303         num_items_scanned = sscanf(line+64, "LEN=%9d", &pkt_len);
304         if (num_items_scanned != 1) {
305                 *err = WTAP_ERR_BAD_FILE;
306                 *err_info = g_strdup("toshiba: OFFSET line doesn't have valid LEN item");
307                 return FALSE;
308         }
309         if (pkt_len < 0) {
310                 *err = WTAP_ERR_BAD_FILE;
311                 *err_info = g_strdup("toshiba: packet header has a negative packet length");
312                 return FALSE;
313         }
314         if (pkt_len > WTAP_MAX_PACKET_SIZE) {
315                 /*
316                  * Probably a corrupt capture file; don't blow up trying
317                  * to allocate space for an immensely-large packet.
318                  */
319                 *err = WTAP_ERR_BAD_FILE;
320                 *err_info = g_strdup_printf("toshiba: File has %u-byte packet, bigger than maximum of %u",
321                     pkt_len, WTAP_MAX_PACKET_SIZE);
322                 return FALSE;
323         }
324
325         phdr->rec_type = REC_TYPE_PACKET;
326         phdr->presence_flags = WTAP_HAS_TS|WTAP_HAS_CAP_LEN;
327         phdr->ts.secs = hr * 3600 + min * 60 + sec;
328         phdr->ts.nsecs = csec * 10000000;
329         phdr->caplen = pkt_len;
330         phdr->len = pkt_len;
331
332         switch (channel[0]) {
333                 case 'B':
334                         phdr->pkt_encap = WTAP_ENCAP_ISDN;
335                         pseudo_header->isdn.uton = (direction[0] == 'T');
336                         pseudo_header->isdn.channel = (guint8)
337                             strtol(&channel[1], NULL, 10);
338                         break;
339
340                 case 'D':
341                         phdr->pkt_encap = WTAP_ENCAP_ISDN;
342                         pseudo_header->isdn.uton = (direction[0] == 'T');
343                         pseudo_header->isdn.channel = 0;
344                         break;
345
346                 default:
347                         phdr->pkt_encap = WTAP_ENCAP_ETHERNET;
348                         /* XXX - is there an FCS in the frame? */
349                         pseudo_header->eth.fcs_len = -1;
350                         break;
351         }
352
353         /* Make sure we have enough room for the packet */
354         ws_buffer_assure_space(buf, pkt_len);
355         pd = ws_buffer_start_ptr(buf);
356
357         /* Calculate the number of hex dump lines, each
358          * containing 16 bytes of data */
359         hex_lines = pkt_len / 16 + ((pkt_len % 16) ? 1 : 0);
360
361         for (i = 0; i < hex_lines; i++) {
362                 if (file_gets(line, TOSHIBA_LINE_LENGTH, fh) == NULL) {
363                         *err = file_error(fh, err_info);
364                         if (*err == 0) {
365                                 *err = WTAP_ERR_SHORT_READ;
366                         }
367                         return FALSE;
368                 }
369                 if (!parse_single_hex_dump_line(line, pd, i * 16)) {
370                         *err = WTAP_ERR_BAD_FILE;
371                         *err_info = g_strdup("toshiba: hex dump not valid");
372                         return FALSE;
373                 }
374         }
375         return TRUE;
376 }
377
378 /*
379           1         2         3         4
380 0123456789012345678901234567890123456789012345
381 0000 : FF03 003D C000 0008 2145 0000 3A12 6500 ...=....!E..:.e.
382 0010 : 003F 11E6 58CF C11A 8897 A401 0804 0400 .?..X...........
383 0020 : 0100 01                                 ...
384 */
385
386 #define START_POS       7
387 #define HEX_LENGTH      ((8 * 4) + 7) /* eight clumps of 4 bytes with 7 inner spaces */
388
389 /* Take a string representing one line from a hex dump and converts the
390  * text to binary data. We check the printed offset with the offset
391  * we are passed to validate the record. We place the bytes in the buffer
392  * at the specified offset.
393  *
394  * In the process, we're going to write all over the string.
395  *
396  * Returns TRUE if good hex dump, FALSE if bad.
397  */
398 static gboolean
399 parse_single_hex_dump_line(char* rec, guint8 *buf, guint byte_offset) {
400
401         int             pos, i;
402         char            *s;
403         unsigned long   value;
404         guint16         word_value;
405
406         /* Get the byte_offset directly from the record */
407         rec[4] = '\0';
408         s = rec;
409         value = strtoul(s, NULL, 16);
410
411         if (value != byte_offset) {
412                 return FALSE;
413         }
414
415         /* Go through the substring representing the values and:
416          *      1. Replace any spaces with '0's
417          *      2. Place \0's every 5 bytes (to terminate the string)
418          *
419          * Then read the eight sets of hex bytes
420          */
421
422         for (pos = START_POS; pos < START_POS + HEX_LENGTH; pos++) {
423                 if (rec[pos] == ' ') {
424                         rec[pos] = '0';
425                 }
426         }
427
428         pos = START_POS;
429         for (i = 0; i < 8; i++) {
430                 rec[pos+4] = '\0';
431
432                 word_value = (guint16) strtoul(&rec[pos], NULL, 16);
433                 buf[byte_offset + i * 2 + 0] = (guint8) (word_value >> 8);
434                 buf[byte_offset + i * 2 + 1] = (guint8) (word_value & 0x00ff);
435                 pos += 5;
436         }
437
438         return TRUE;
439 }
440
441 /*
442  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
443  *
444  * Local variables:
445  * c-basic-offset: 8
446  * tab-width: 8
447  * indent-tabs-mode: t
448  * End:
449  *
450  * vi: set shiftwidth=8 tabstop=8 noexpandtab:
451  * :indentSize=8:tabSize=8:noTabs=false:
452  */