6 * Copyright (c) 2001 by Marc Milgram <ethereal@mmilgram.NOSPAMmail.net>
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.
28 #include "dbs-etherwatch.h"
29 #include "file_wrappers.h"
36 /* This module reads the text output of the 'DBS-ETHERTRACE' command in VMS
37 * It was initially based on vms.c.
41 Example 'ETHERWATCH' output data:
43 42 names and addresses were loaded
44 Reading recorded data from PERSISTENCE
45 ------------------------------------------------------------------------------
46 From 00-D0-C0-D2-4D-60 [MF1] to AA-00-04-00-FC-94 [PSERVB]
47 Protocol 08-00 00 00-00-00-00-00, 60 byte buffer at 10-OCT-2001 10:20:45.16
48 [E..<8.....Ò.....]- 0-[45 00 00 3C 38 93 00 00 1D 06 D2 12 80 93 11 1A]
49 [...Ö.Ò...(¤.....]- 16-[80 93 80 D6 02 D2 02 03 00 28 A4 90 00 00 00 00]
50 [.....½.....´....]- 32-[A0 02 FF FF 95 BD 00 00 02 04 05 B4 03 03 04 01]
51 [......å..... ]- 48-[01 01 08 0A 90 90 E5 14 00 00 00 00]
52 ------------------------------------------------------------------------------
53 From 00-D0-C0-D2-4D-60 [MF1] to AA-00-04-00-FC-94 [PSERVB]
54 Protocol 08-00 00 00-00-00-00-00, 50 byte buffer at 10-OCT-2001 10:20:45.17
55 [E..(8.....Ò%....]- 0-[45 00 00 28 38 94 00 00 1D 06 D2 25 80 93 11 1A]
56 [...Ö.Ò...(¤.Z.4w]- 16-[80 93 80 D6 02 D2 02 03 00 28 A4 91 5A 1C 34 77]
57 [P.#(Ás.....´....]- 32-[50 10 23 28 C1 73 00 00 02 04 05 B4 03 03 00 00]
61 Alternative HEX only output, slightly more efficient and all ethereal needs:
62 ------------------------------------------------------------------------------
63 From 00-D0-C0-D2-4D-60 [MF1] to AA-00-04-00-FC-94 [PSERVB]
64 Protocol 08-00 00 00-00-00-00-00, 50 byte buffer at 10-OCT-2001 10:20:45.17
65 0-[45 00 00 28 38 9B 00 00 1D 06 D2 1E 80 93 11 1A 80 93 80 D6]
66 20-[02 D2 02 03 00 28 A4 BF 5A 1C 34 79 50 10 23 28 C1 43 00 00]
67 40-[03 30 30 30 30 30 00 00 03 30]
70 /* Magic text to check for DBS-ETHERWATCH-ness of file */
71 static const char dbs_etherwatch_hdr_magic[] =
72 { 'E', 'T', 'H', 'E', 'R', 'W', 'A', 'T', 'C', 'H', ' ', ' '};
73 #define DBS_ETHERWATCH_HDR_MAGIC_SIZE \
74 (sizeof dbs_etherwatch_hdr_magic / sizeof dbs_etherwatch_hdr_magic[0])
76 /* Magic text for start of packet */
77 static const char dbs_etherwatch_rec_magic[] =
78 {'F', 'r', 'o', 'm', ' '};
79 #define DBS_ETHERWATCH_REC_MAGIC_SIZE \
80 (sizeof dbs_etherwatch_rec_magic / sizeof dbs_etherwatch_rec_magic[0])
83 * XXX - is this the biggest packet we can get?
85 #define DBS_ETHERWATCH_MAX_PACKET_LEN 16384
87 static gboolean dbs_etherwatch_read(wtap *wth, int *err, gchar **err_info,
89 static gboolean dbs_etherwatch_seek_read(wtap *wth, long seek_off,
90 union wtap_pseudo_header *pseudo_header, guint8 *pd, int len,
91 int *err, gchar **err_info);
92 static int parse_dbs_etherwatch_packet(wtap *wth, FILE_T fh, guint8* buf,
93 int *err, gchar **err_info);
94 static guint parse_single_hex_dump_line(char* rec, guint8 *buf,
96 static guint parse_hex_dump(char* dump, guint8 *buf, char seperator, char end);
98 /* Seeks to the beginning of the next packet, and returns the
99 byte offset. Returns -1 on failure, and sets "*err" to the error. */
100 static long dbs_etherwatch_seek_next_packet(wtap *wth, int *err)
103 unsigned int level = 0;
106 while ((byte = file_getc(wth->fh)) != EOF) {
107 if (byte == dbs_etherwatch_rec_magic[level]) {
109 if (level >= DBS_ETHERWATCH_REC_MAGIC_SIZE) {
110 /* note: we're leaving file pointer right after the magic characters */
111 cur_off = file_tell(wth->fh);
114 *err = file_error(wth->fh);
123 if (file_eof(wth->fh)) {
127 /* We (presumably) got an error (there's no equivalent to "ferror()"
128 in zlib, alas, so we don't have a wrapper to check for an error). */
129 *err = file_error(wth->fh);
134 #define DBS_ETHERWATCH_HEADER_LINES_TO_CHECK 200
135 #define DBS_ETHERWATCH_LINE_LENGTH 240
137 /* Look through the first part of a file to see if this is
138 * a DBS Ethertrace text trace file.
140 * Returns TRUE if it is, FALSE if it isn't or if we get an I/O error;
141 * if we get an I/O error, "*err" will be set to a non-zero value.
143 static gboolean dbs_etherwatch_check_file_type(wtap *wth, int *err)
145 char buf[DBS_ETHERWATCH_LINE_LENGTH];
147 unsigned int reclen, i, level;
149 buf[DBS_ETHERWATCH_LINE_LENGTH-1] = 0;
151 for (line = 0; line < DBS_ETHERWATCH_HEADER_LINES_TO_CHECK; line++) {
152 if (file_gets(buf, DBS_ETHERWATCH_LINE_LENGTH, wth->fh)!=NULL){
154 reclen = strlen(buf);
155 if (reclen < DBS_ETHERWATCH_HDR_MAGIC_SIZE)
159 for (i = 0; i < reclen; i++) {
161 if (byte == dbs_etherwatch_hdr_magic[level]) {
164 DBS_ETHERWATCH_HDR_MAGIC_SIZE) {
174 if (file_eof(wth->fh))
177 *err = file_error(wth->fh);
186 int dbs_etherwatch_open(wtap *wth, int *err, gchar **err_info _U_)
188 /* Look for DBS ETHERWATCH header */
189 if (!dbs_etherwatch_check_file_type(wth, err)) {
196 wth->data_offset = 0;
197 wth->file_encap = WTAP_ENCAP_ETHERNET;
198 wth->file_type = WTAP_FILE_DBS_ETHERWATCH;
199 wth->snapshot_length = 0; /* not known */
200 wth->subtype_read = dbs_etherwatch_read;
201 wth->subtype_seek_read = dbs_etherwatch_seek_read;
206 /* Find the next packet and parse it; called from wtap_loop(). */
207 static gboolean dbs_etherwatch_read(wtap *wth, int *err, gchar **err_info,
214 /* Find the next packet */
215 offset = dbs_etherwatch_seek_next_packet(wth, err);
219 /* Make sure we have enough room for the packet */
220 buffer_assure_space(wth->frame_buffer, DBS_ETHERWATCH_MAX_PACKET_LEN);
221 buf = buffer_start_ptr(wth->frame_buffer);
223 /* Parse the packet */
224 pkt_len = parse_dbs_etherwatch_packet(wth, wth->fh, buf, err, err_info);
229 * We don't have an FCS in this frame.
231 wth->pseudo_header.eth.fcs_len = 0;
233 wth->data_offset = offset;
234 *data_offset = offset;
238 /* Used to read packets in random-access fashion */
240 dbs_etherwatch_seek_read (wtap *wth, long seek_off,
241 union wtap_pseudo_header *pseudo_header _U_,
242 guint8 *pd, int len, int *err, gchar **err_info)
246 if (file_seek(wth->random_fh, seek_off - 1, SEEK_SET, err) == -1)
249 pkt_len = parse_dbs_etherwatch_packet(NULL, wth->random_fh, pd, err,
252 if (pkt_len != len) {
254 *err = WTAP_ERR_BAD_RECORD;
255 *err_info = g_strdup_printf("dbs_etherwatch: packet length %d doesn't match requested length %d",
262 * We don't have an FCS in this frame.
264 pseudo_header->eth.fcs_len = 0;
273 0123456789012345678901234567890123456789012345
274 From 00-D0-C0-D2-4D-60 [MF1] to AA-00-04-00-FC-94 [PSERVB]
275 Protocol 08-00 00 00-00-00-00-00, 50 byte buffer at 10-OCT-2001 10:20:45.17
277 #define MAC_ADDR_LENGTH 6 /* Length MAC address */
278 #define DEST_MAC_PREFIX "] to " /* Prefix to the dest. MAC address */
279 #define PROTOCOL_LENGTH 2 /* Length protocol */
280 #define PROTOCOL_POS 9 /* Position protocol */
281 #define SAP_LENGTH 2 /* Length DSAP+SSAP */
282 #define SAP_POS 9 /* Position DSAP+SSAP */
283 #define CTL_UNNUMB_LENGTH 1 /* Length unnumbered control field */
284 #define CTL_NUMB_LENGTH 2 /* Length numbered control field */
285 #define CTL_POS 15 /* Position control field */
286 #define PID_LENGTH 5 /* Length PID */
287 #define PID_POS 18 /* Position PID */
288 #define LENGTH_POS 33 /* Position length */
289 #define HEX_HDR_SPR '-' /* Seperator char header hex values */
290 #define HEX_HDR_END ' ' /* End char hdr. hex val. except PID */
291 #define HEX_PID_END ',' /* End char PID hex value */
292 #define IEEE802_LEN_LEN 2 /* Length of the IEEE 802 len. field */
294 To check whether it is Ethernet II or IEEE 802 we check the values of the
295 control field and PID, when they are all 0's we assume it is Ethernet II
296 else IEEE 802. In IEEE 802 the DSAP and SSAP are behind protocol, the
297 length in the IEEE data we have to construct.
299 #define ETH_II_CHECK_POS 15
300 #define ETH_II_CHECK_STR "00 00-00-00-00-00,"
302 To check whether it IEEE 802.3 with SNAP we check that both the DSAP & SSAP
303 values are 0xAA and the control field 0x03.
305 #define SNAP_CHECK_POS 9
306 #define SNAP_CHECK_STR "AA-AA 03"
308 To check whether the control field is 1 or two octets we check if it is
309 unnumbered. Unnumbered has length 1, numbered 2.
311 #define CTL_UNNUMB_MASK 0x03
312 #define CTL_UNNUMB_VALUE 0x03
314 parse_dbs_etherwatch_packet(wtap *wth, FILE_T fh, guint8* buf, int *err,
317 char line[DBS_ETHERWATCH_LINE_LENGTH];
318 int num_items_scanned;
319 int eth_hdr_len, pkt_len, csec;
320 int length_pos, length_from, length;
324 static gchar months[] = "JANFEBMARAPRMAYJUNJULAUGSEPOCTNOVDEC";
325 int count, line_count;
328 /* Our file pointer should be on the first line containing the
329 * summary information for a packet. Read in that line and
330 * extract the useful information
332 if (file_gets(line, DBS_ETHERWATCH_LINE_LENGTH, fh) == NULL) {
333 *err = file_error(fh);
335 *err = WTAP_ERR_SHORT_READ;
340 /* Get the destination address */
341 p = strstr(line, DEST_MAC_PREFIX);
343 *err = WTAP_ERR_BAD_RECORD;
344 *err_info = g_strdup("dbs_etherwatch: destination address not found");
347 p += strlen(DEST_MAC_PREFIX);
348 if(parse_hex_dump(p, &buf[eth_hdr_len], HEX_HDR_SPR, HEX_HDR_END)
349 != MAC_ADDR_LENGTH) {
350 *err = WTAP_ERR_BAD_RECORD;
351 *err_info = g_strdup("dbs_etherwatch: destination address not valid");
354 eth_hdr_len += MAC_ADDR_LENGTH;
356 /* Get the source address */
358 * Since the first part of the line is already skipped in order to find
359 * the start of the record we cannot index, just look for the first
363 while(!isxdigit((guchar)*p)) {
366 if(parse_hex_dump(p, &buf[eth_hdr_len], HEX_HDR_SPR,
367 HEX_HDR_END) != MAC_ADDR_LENGTH) {
368 *err = WTAP_ERR_BAD_RECORD;
369 *err_info = g_strdup("dbs_etherwatch: source address not valid");
372 eth_hdr_len += MAC_ADDR_LENGTH;
374 /* Read the next line of the record header */
375 if (file_gets(line, DBS_ETHERWATCH_LINE_LENGTH, fh) == NULL) {
376 *err = file_error(fh);
378 *err = WTAP_ERR_SHORT_READ;
383 /* Check the lines is as least as long as the length position */
384 if(strlen(line) < LENGTH_POS) {
385 *err = WTAP_ERR_BAD_RECORD;
386 *err_info = g_strdup("dbs_etherwatch: line too short");
390 num_items_scanned = sscanf(line + LENGTH_POS,
391 "%d byte buffer at %d-%3s-%d %d:%d:%d.%d",
394 &time.tm_year, &time.tm_hour, &time.tm_min,
395 &time.tm_sec, &csec);
397 if (num_items_scanned != 8) {
398 *err = WTAP_ERR_BAD_RECORD;
399 *err_info = g_strdup("dbs_etherwatch: header line not valid");
403 /* Determine whether it is Ethernet II or IEEE 802 */
404 if(strncmp(&line[ETH_II_CHECK_POS], ETH_II_CHECK_STR,
405 strlen(ETH_II_CHECK_STR)) == 0) {
407 /* Get the Protocol */
408 if(parse_hex_dump(&line[PROTOCOL_POS], &buf[eth_hdr_len], HEX_HDR_SPR,
409 HEX_HDR_END) != PROTOCOL_LENGTH) {
410 *err = WTAP_ERR_BAD_RECORD;
411 *err_info = g_strdup("dbs_etherwatch: Ethernet II protocol value not valid");
414 eth_hdr_len += PROTOCOL_LENGTH;
417 /* Remember where to put the length in the header */
418 length_pos = eth_hdr_len;
419 /* Leave room in the header for the length */
420 eth_hdr_len += IEEE802_LEN_LEN;
421 /* Remember how much of the header should not be added to the length */
422 length_from = eth_hdr_len;
423 /* Get the DSAP + SSAP */
424 if(parse_hex_dump(&line[SAP_POS], &buf[eth_hdr_len], HEX_HDR_SPR,
425 HEX_HDR_END) != SAP_LENGTH) {
426 *err = WTAP_ERR_BAD_RECORD;
427 *err_info = g_strdup("dbs_etherwatch: 802.2 DSAP+SSAP value not valid");
430 eth_hdr_len += SAP_LENGTH;
431 /* Get the (first part of the) control field */
432 if(parse_hex_dump(&line[CTL_POS], &buf[eth_hdr_len], HEX_HDR_SPR,
433 HEX_HDR_END) != CTL_UNNUMB_LENGTH) {
434 *err = WTAP_ERR_BAD_RECORD;
435 *err_info = g_strdup("dbs_etherwatch: 802.2 control field first part not valid");
438 /* Determine whether the control is numbered, and thus longer */
439 if((buf[eth_hdr_len] & CTL_UNNUMB_MASK) != CTL_UNNUMB_VALUE) {
440 /* Get the rest of the control field, the first octet in the PID */
441 if(parse_hex_dump(&line[PID_POS],
442 &buf[eth_hdr_len + CTL_UNNUMB_LENGTH], HEX_HDR_END,
443 HEX_HDR_SPR) != CTL_NUMB_LENGTH - CTL_UNNUMB_LENGTH) {
444 *err = WTAP_ERR_BAD_RECORD;
445 *err_info = g_strdup("dbs_etherwatch: 802.2 control field second part value not valid");
448 eth_hdr_len += CTL_NUMB_LENGTH;
450 eth_hdr_len += CTL_UNNUMB_LENGTH;
452 /* Determine whether it is SNAP */
453 if(strncmp(&line[SNAP_CHECK_POS], SNAP_CHECK_STR,
454 strlen(SNAP_CHECK_STR)) == 0) {
456 if(parse_hex_dump(&line[PID_POS], &buf[eth_hdr_len], HEX_HDR_SPR,
457 HEX_PID_END) != PID_LENGTH) {
458 *err = WTAP_ERR_BAD_RECORD;
459 *err_info = g_strdup("dbs_etherwatch: 802.2 PID value not valid");
462 eth_hdr_len += PID_LENGTH;
464 /* Write the length in the header */
465 length = eth_hdr_len - length_from + pkt_len;
466 buf[length_pos] = (length) >> 8;
467 buf[length_pos+1] = (length) & 0xFF;
471 p = strstr(months, mon);
473 time.tm_mon = (p - months) / 3;
474 time.tm_year -= 1900;
477 wth->phdr.ts.tv_sec = mktime(&time);
479 wth->phdr.ts.tv_usec = csec * 10000;
480 wth->phdr.caplen = eth_hdr_len + pkt_len;
481 wth->phdr.len = eth_hdr_len + pkt_len;
484 /* Parse the hex dump */
486 while (count < pkt_len) {
487 if (file_gets(line, DBS_ETHERWATCH_LINE_LENGTH, fh) == NULL) {
488 *err = file_error(fh);
490 *err = WTAP_ERR_SHORT_READ;
494 if (!(line_count = parse_single_hex_dump_line(line,
495 &buf[eth_hdr_len + count], count))) {
496 *err = WTAP_ERR_BAD_RECORD;
497 *err_info = g_strdup("dbs_etherwatch: packet data value not valid");
501 if (count > pkt_len) {
502 *err = WTAP_ERR_BAD_RECORD;
503 *err_info = g_strdup("dbs_etherwatch: packet data value has too many bytes");
507 return eth_hdr_len + pkt_len;
510 /* Parse a hex dump line */
512 /DISPLAY=BOTH output:
515 0123456789012345678901234567890123456789012345
516 [E..(8.....Ò.....]- 0-[45 00 00 28 38 9B 00 00 1D 06 D2 1E 80 93 11 1A]
517 [...Ö.Ò...(¤¿Z.4y]- 16-[80 93 80 D6 02 D2 02 03 00 28 A4 BF 5A 1C 34 79]
518 [P.#(ÁC...00000..]- 32-[50 10 23 28 C1 43 00 00 03 30 30 30 30 30 00 00]
521 /DISPLAY=HEXADECIMAL output:
524 0123456789012345678901234567890123456789012345
525 0-[45 00 00 28 38 9B 00 00 1D 06 D2 1E 80 93 11 1A 80 93 80 D6]
526 20-[02 D2 02 03 00 28 A4 BF 5A 1C 34 79 50 10 23 28 C1 43 00 00]
527 40-[03 30 30 30 30 30 00 00 03 30]
531 #define TYPE_CHECK_POS 2 /* Position to check the type of hex dump */
532 #define TYPE_CHECK_BOTH '[' /* Value at pos. that indicates BOTH type */
533 #define COUNT_POS_BOTH 21 /* Count position BOTH type */
534 #define COUNT_POS_HEX 1 /* Count position HEX type */
535 #define COUNT_SIZE 5 /* Length counter */
536 #define HEX_DUMP_START '[' /* Start char */
537 #define HEX_DUMP_SPR ' ' /* Seperator char */
538 #define HEX_DUMP_END ']' /* End char */
540 /* Take a string representing one line from a hex dump and converts the
541 * text to binary data. We check the printed offset with the offset
542 * we are passed to validate the record. We place the bytes in the buffer
543 * at the specified offset.
545 * Returns length parsed if a good hex dump, 0 if bad.
548 parse_single_hex_dump_line(char* rec, guint8 *buf, int byte_offset) {
554 /* Check that the record is as least as long as the check offset */
555 for(i = 0; i < TYPE_CHECK_POS; i++)
561 /* determine the format and thus the counter offset and hex dump length */
562 if(rec[TYPE_CHECK_POS] == TYPE_CHECK_BOTH)
564 pos = COUNT_POS_BOTH;
571 /* Check that the record is as least as long as the start position */
580 /* Get the byte_offset directly from the record */
582 for(i = 0; i < COUNT_SIZE; i++) {
583 if(!isspace((guchar)rec[pos])) {
584 if(isdigit((guchar)rec[pos])) {
586 value += rec[pos] - '0';
594 if (value != byte_offset) {
598 /* find the start of the hex dump */
599 while(rec[pos] != HEX_DUMP_START) {
600 if(rec[pos] == '\0') {
606 return parse_hex_dump(&rec[pos], buf, HEX_DUMP_SPR, HEX_DUMP_END);
609 /* Parse a hex dump */
611 parse_hex_dump(char* dump, guint8 *buf, char seperator, char end) {
614 /* Parse the hex dump */
617 while(dump[pos] != end) {
618 /* Check the hex value */
619 if(!(isxdigit((guchar)dump[pos]) &&
620 isxdigit((guchar)dump[pos + 1]))) {
623 /* Get the hex value value */
624 if(isdigit((guchar)dump[pos])) {
625 buf[count] = (dump[pos] - '0') << 4;
627 buf[count] = (toupper(dump[pos]) - 'A' + 10) << 4;
630 if(isdigit((guchar)dump[pos])) {
631 buf[count] += dump[pos] - '0';
633 buf[count] += toupper(dump[pos]) - 'A' + 10;
637 /* Skip the seperator characters */
638 while(dump[pos] == seperator) {