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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 #include "dbs-etherwatch.h"
27 #include "file_wrappers.h"
34 /* This module reads the text output of the 'DBS-ETHERTRACE' command in VMS
35 * It was initially based on vms.c.
39 Example 'ETHERWATCH' output data (with "printable" characters in the
40 "printable characters" section of the output replaced by "." if they have
41 the 8th bit set, so as not to upset compilers that are expecting text
42 in comments to be in a particular character encoding that can't handle
45 42 names and addresses were loaded
46 Reading recorded data from PERSISTENCE
47 ------------------------------------------------------------------------------
48 From 00-D0-C0-D2-4D-60 [MF1] to AA-00-04-00-FC-94 [PSERVB]
49 Protocol 08-00 00 00-00-00-00-00, 60 byte buffer at 10-OCT-2001 10:20:45.16
50 [E..<8...........]- 0-[45 00 00 3C 38 93 00 00 1D 06 D2 12 80 93 11 1A]
51 [.........(......]- 16-[80 93 80 D6 02 D2 02 03 00 28 A4 90 00 00 00 00]
52 [................]- 32-[A0 02 FF FF 95 BD 00 00 02 04 05 B4 03 03 04 01]
53 [............ ]- 48-[01 01 08 0A 90 90 E5 14 00 00 00 00]
54 ------------------------------------------------------------------------------
55 From 00-D0-C0-D2-4D-60 [MF1] to AA-00-04-00-FC-94 [PSERVB]
56 Protocol 08-00 00 00-00-00-00-00, 50 byte buffer at 10-OCT-2001 10:20:45.17
57 [E..(8......%....]- 0-[45 00 00 28 38 94 00 00 1D 06 D2 25 80 93 11 1A]
58 [.........(..Z.4w]- 16-[80 93 80 D6 02 D2 02 03 00 28 A4 91 5A 1C 34 77]
59 [P.#(.s..........]- 32-[50 10 23 28 C1 73 00 00 02 04 05 B4 03 03 00 00]
63 Alternative HEX only output, slightly more efficient and all wireshark needs:
64 ------------------------------------------------------------------------------
65 From 00-D0-C0-D2-4D-60 [MF1] to AA-00-04-00-FC-94 [PSERVB]
66 Protocol 08-00 00 00-00-00-00-00, 50 byte buffer at 10-OCT-2001 10:20:45.17
67 0-[45 00 00 28 38 9B 00 00 1D 06 D2 1E 80 93 11 1A 80 93 80 D6]
68 20-[02 D2 02 03 00 28 A4 BF 5A 1C 34 79 50 10 23 28 C1 43 00 00]
69 40-[03 30 30 30 30 30 00 00 03 30]
72 /* Magic text to check for DBS-ETHERWATCH-ness of file */
73 static const char dbs_etherwatch_hdr_magic[] =
74 { 'E', 'T', 'H', 'E', 'R', 'W', 'A', 'T', 'C', 'H', ' ', ' '};
75 #define DBS_ETHERWATCH_HDR_MAGIC_SIZE \
76 (sizeof dbs_etherwatch_hdr_magic / sizeof dbs_etherwatch_hdr_magic[0])
78 /* Magic text for start of packet */
79 static const char dbs_etherwatch_rec_magic[] =
80 {'F', 'r', 'o', 'm', ' '};
81 #define DBS_ETHERWATCH_REC_MAGIC_SIZE \
82 (sizeof dbs_etherwatch_rec_magic / sizeof dbs_etherwatch_rec_magic[0])
85 * XXX - is this the biggest packet we can get?
87 #define DBS_ETHERWATCH_MAX_PACKET_LEN 16384
89 static gboolean dbs_etherwatch_read(wtap *wth, int *err, gchar **err_info,
91 static gboolean dbs_etherwatch_seek_read(wtap *wth, gint64 seek_off,
92 struct wtap_pkthdr *phdr, Buffer *buf, int *err, gchar **err_info);
93 static gboolean parse_dbs_etherwatch_packet(struct wtap_pkthdr *phdr, FILE_T fh,
94 Buffer* buf, int *err, gchar **err_info);
95 static guint parse_single_hex_dump_line(char* rec, guint8 *buf,
97 static guint parse_hex_dump(char* dump, guint8 *buf, char seperator, char end);
99 /* Seeks to the beginning of the next packet, and returns the
100 byte offset. Returns -1 on failure, and sets "*err" to the error
101 and "*err_info" to null or an additional error string. */
102 static gint64 dbs_etherwatch_seek_next_packet(wtap *wth, int *err,
106 unsigned int level = 0;
109 while ((byte = file_getc(wth->fh)) != EOF) {
110 if (byte == dbs_etherwatch_rec_magic[level]) {
112 if (level >= DBS_ETHERWATCH_REC_MAGIC_SIZE) {
113 /* note: we're leaving file pointer right after the magic characters */
114 cur_off = file_tell(wth->fh);
117 *err = file_error(wth->fh, err_info);
127 *err = file_error(wth->fh, err_info);
131 #define DBS_ETHERWATCH_HEADER_LINES_TO_CHECK 200
132 #define DBS_ETHERWATCH_LINE_LENGTH 240
134 /* Look through the first part of a file to see if this is
135 * a DBS Ethertrace text trace file.
137 * Returns TRUE if it is, FALSE if it isn't or if we get an I/O error;
138 * if we get an I/O error, "*err" will be set to a non-zero value and
139 * "*err_info" will be set to null or an error string.
141 static gboolean dbs_etherwatch_check_file_type(wtap *wth, int *err,
144 char buf[DBS_ETHERWATCH_LINE_LENGTH];
147 unsigned int 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 *err = file_error(wth->fh, err_info);
158 reclen = strlen(buf);
159 if (reclen < DBS_ETHERWATCH_HDR_MAGIC_SIZE)
163 for (i = 0; i < reclen; i++) {
165 if (byte == dbs_etherwatch_hdr_magic[level]) {
168 DBS_ETHERWATCH_HDR_MAGIC_SIZE) {
181 int dbs_etherwatch_open(wtap *wth, int *err, gchar **err_info)
183 /* Look for DBS ETHERWATCH header */
184 if (!dbs_etherwatch_check_file_type(wth, err, err_info)) {
185 if (*err != 0 && *err != WTAP_ERR_SHORT_READ)
190 wth->file_encap = WTAP_ENCAP_ETHERNET;
191 wth->file_type_subtype = WTAP_FILE_TYPE_SUBTYPE_DBS_ETHERWATCH;
192 wth->snapshot_length = 0; /* not known */
193 wth->subtype_read = dbs_etherwatch_read;
194 wth->subtype_seek_read = dbs_etherwatch_seek_read;
195 wth->tsprecision = WTAP_FILE_TSPREC_CSEC;
200 /* Find the next packet and parse it; called from wtap_read(). */
201 static gboolean dbs_etherwatch_read(wtap *wth, int *err, gchar **err_info,
206 /* Find the next packet */
207 offset = dbs_etherwatch_seek_next_packet(wth, err, err_info);
210 *data_offset = offset;
212 /* Parse the packet */
213 return parse_dbs_etherwatch_packet(&wth->phdr, wth->fh,
214 wth->frame_buffer, err, err_info);
217 /* Used to read packets in random-access fashion */
219 dbs_etherwatch_seek_read(wtap *wth, gint64 seek_off,
220 struct wtap_pkthdr *phdr, Buffer *buf, int *err, gchar **err_info)
222 if (file_seek(wth->random_fh, seek_off - 1, SEEK_SET, err) == -1)
225 return parse_dbs_etherwatch_packet(phdr, wth->random_fh, buf, err,
233 0123456789012345678901234567890123456789012345
234 From 00-D0-C0-D2-4D-60 [MF1] to AA-00-04-00-FC-94 [PSERVB]
235 Protocol 08-00 00 00-00-00-00-00, 50 byte buffer at 10-OCT-2001 10:20:45.17
237 #define MAC_ADDR_LENGTH 6 /* Length MAC address */
238 #define DEST_MAC_PREFIX "] to " /* Prefix to the dest. MAC address */
239 #define PROTOCOL_LENGTH 2 /* Length protocol */
240 #define PROTOCOL_POS 9 /* Position protocol */
241 #define SAP_LENGTH 2 /* Length DSAP+SSAP */
242 #define SAP_POS 9 /* Position DSAP+SSAP */
243 #define CTL_UNNUMB_LENGTH 1 /* Length unnumbered control field */
244 #define CTL_NUMB_LENGTH 2 /* Length numbered control field */
245 #define CTL_POS 15 /* Position control field */
246 #define PID_LENGTH 5 /* Length PID */
247 #define PID_POS 18 /* Position PID */
248 #define LENGTH_POS 33 /* Position length */
249 #define HEX_HDR_SPR '-' /* Seperator char header hex values */
250 #define HEX_HDR_END ' ' /* End char hdr. hex val. except PID */
251 #define HEX_PID_END ',' /* End char PID hex value */
252 #define IEEE802_LEN_LEN 2 /* Length of the IEEE 802 len. field */
254 To check whether it is Ethernet II or IEEE 802 we check the values of the
255 control field and PID, when they are all 0's we assume it is Ethernet II
256 else IEEE 802. In IEEE 802 the DSAP and SSAP are behind protocol, the
257 length in the IEEE data we have to construct.
259 #define ETH_II_CHECK_POS 15
260 #define ETH_II_CHECK_STR "00 00-00-00-00-00,"
262 To check whether it IEEE 802.3 with SNAP we check that both the DSAP & SSAP
263 values are 0xAA and the control field 0x03.
265 #define SNAP_CHECK_POS 9
266 #define SNAP_CHECK_STR "AA-AA 03"
268 To check whether the control field is 1 or two octets we check if it is
269 unnumbered. Unnumbered has length 1, numbered 2.
271 #define CTL_UNNUMB_MASK 0x03
272 #define CTL_UNNUMB_VALUE 0x03
274 parse_dbs_etherwatch_packet(struct wtap_pkthdr *phdr, FILE_T fh, Buffer* buf,
275 int *err, gchar **err_info)
278 char line[DBS_ETHERWATCH_LINE_LENGTH];
279 int num_items_scanned;
280 int eth_hdr_len, pkt_len, csec;
281 int length_pos, length_from, length;
285 static const gchar months[] = "JANFEBMARAPRMAYJUNJULAUGSEPOCTNOVDEC";
286 int count, line_count;
288 /* Make sure we have enough room for the packet */
289 buffer_assure_space(buf, DBS_ETHERWATCH_MAX_PACKET_LEN);
290 pd = buffer_start_ptr(buf);
293 memset(&tm, 0, sizeof(tm));
294 /* Our file pointer should be on the first line containing the
295 * summary information for a packet. Read in that line and
296 * extract the useful information
298 if (file_gets(line, DBS_ETHERWATCH_LINE_LENGTH, fh) == NULL) {
299 *err = file_error(fh, err_info);
301 *err = WTAP_ERR_SHORT_READ;
306 /* Get the destination address */
307 p = strstr(line, DEST_MAC_PREFIX);
309 *err = WTAP_ERR_BAD_FILE;
310 *err_info = g_strdup("dbs_etherwatch: destination address not found");
313 p += strlen(DEST_MAC_PREFIX);
314 if(parse_hex_dump(p, &pd[eth_hdr_len], HEX_HDR_SPR, HEX_HDR_END)
315 != MAC_ADDR_LENGTH) {
316 *err = WTAP_ERR_BAD_FILE;
317 *err_info = g_strdup("dbs_etherwatch: destination address not valid");
320 eth_hdr_len += MAC_ADDR_LENGTH;
322 /* Get the source address */
324 * Since the first part of the line is already skipped in order to find
325 * the start of the record we cannot index, just look for the first
329 while(!isxdigit((guchar)*p)) {
332 if(parse_hex_dump(p, &pd[eth_hdr_len], HEX_HDR_SPR,
333 HEX_HDR_END) != MAC_ADDR_LENGTH) {
334 *err = WTAP_ERR_BAD_FILE;
335 *err_info = g_strdup("dbs_etherwatch: source address not valid");
338 eth_hdr_len += MAC_ADDR_LENGTH;
340 /* Read the next line of the record header */
341 if (file_gets(line, DBS_ETHERWATCH_LINE_LENGTH, fh) == NULL) {
342 *err = file_error(fh, err_info);
344 *err = WTAP_ERR_SHORT_READ;
349 /* Check the lines is as least as long as the length position */
350 if(strlen(line) < LENGTH_POS) {
351 *err = WTAP_ERR_BAD_FILE;
352 *err_info = g_strdup("dbs_etherwatch: line too short");
356 num_items_scanned = sscanf(line + LENGTH_POS,
357 "%9d byte buffer at %2d-%3s-%4d %2d:%2d:%2d.%9d",
360 &tm.tm_year, &tm.tm_hour, &tm.tm_min,
363 if (num_items_scanned != 8) {
364 *err = WTAP_ERR_BAD_FILE;
365 *err_info = g_strdup("dbs_etherwatch: header line not valid");
369 /* Determine whether it is Ethernet II or IEEE 802 */
370 if(strncmp(&line[ETH_II_CHECK_POS], ETH_II_CHECK_STR,
371 strlen(ETH_II_CHECK_STR)) == 0) {
373 /* Get the Protocol */
374 if(parse_hex_dump(&line[PROTOCOL_POS], &pd[eth_hdr_len], HEX_HDR_SPR,
375 HEX_HDR_END) != PROTOCOL_LENGTH) {
376 *err = WTAP_ERR_BAD_FILE;
377 *err_info = g_strdup("dbs_etherwatch: Ethernet II protocol value not valid");
380 eth_hdr_len += PROTOCOL_LENGTH;
383 /* Remember where to put the length in the header */
384 length_pos = eth_hdr_len;
385 /* Leave room in the header for the length */
386 eth_hdr_len += IEEE802_LEN_LEN;
387 /* Remember how much of the header should not be added to the length */
388 length_from = eth_hdr_len;
389 /* Get the DSAP + SSAP */
390 if(parse_hex_dump(&line[SAP_POS], &pd[eth_hdr_len], HEX_HDR_SPR,
391 HEX_HDR_END) != SAP_LENGTH) {
392 *err = WTAP_ERR_BAD_FILE;
393 *err_info = g_strdup("dbs_etherwatch: 802.2 DSAP+SSAP value not valid");
396 eth_hdr_len += SAP_LENGTH;
397 /* Get the (first part of the) control field */
398 if(parse_hex_dump(&line[CTL_POS], &pd[eth_hdr_len], HEX_HDR_SPR,
399 HEX_HDR_END) != CTL_UNNUMB_LENGTH) {
400 *err = WTAP_ERR_BAD_FILE;
401 *err_info = g_strdup("dbs_etherwatch: 802.2 control field first part not valid");
404 /* Determine whether the control is numbered, and thus longer */
405 if((pd[eth_hdr_len] & CTL_UNNUMB_MASK) != CTL_UNNUMB_VALUE) {
406 /* Get the rest of the control field, the first octet in the PID */
407 if(parse_hex_dump(&line[PID_POS],
408 &pd[eth_hdr_len + CTL_UNNUMB_LENGTH], HEX_HDR_END,
409 HEX_HDR_SPR) != CTL_NUMB_LENGTH - CTL_UNNUMB_LENGTH) {
410 *err = WTAP_ERR_BAD_FILE;
411 *err_info = g_strdup("dbs_etherwatch: 802.2 control field second part value not valid");
414 eth_hdr_len += CTL_NUMB_LENGTH;
416 eth_hdr_len += CTL_UNNUMB_LENGTH;
418 /* Determine whether it is SNAP */
419 if(strncmp(&line[SNAP_CHECK_POS], SNAP_CHECK_STR,
420 strlen(SNAP_CHECK_STR)) == 0) {
422 if(parse_hex_dump(&line[PID_POS], &pd[eth_hdr_len], HEX_HDR_SPR,
423 HEX_PID_END) != PID_LENGTH) {
424 *err = WTAP_ERR_BAD_FILE;
425 *err_info = g_strdup("dbs_etherwatch: 802.2 PID value not valid");
428 eth_hdr_len += PID_LENGTH;
430 /* Write the length in the header */
431 length = eth_hdr_len - length_from + pkt_len;
432 pd[length_pos] = (length) >> 8;
433 pd[length_pos+1] = (length) & 0xFF;
436 phdr->presence_flags = WTAP_HAS_TS|WTAP_HAS_CAP_LEN;
438 p = strstr(months, mon);
440 tm.tm_mon = (int)(p - months) / 3;
444 phdr->ts.secs = mktime(&tm);
445 phdr->ts.nsecs = csec * 10000000;
446 phdr->caplen = eth_hdr_len + pkt_len;
447 phdr->len = eth_hdr_len + pkt_len;
450 * We don't have an FCS in this frame.
452 phdr->pseudo_header.eth.fcs_len = 0;
454 /* Parse the hex dump */
456 while (count < pkt_len) {
457 if (file_gets(line, DBS_ETHERWATCH_LINE_LENGTH, fh) == NULL) {
458 *err = file_error(fh, err_info);
460 *err = WTAP_ERR_SHORT_READ;
464 if (!(line_count = parse_single_hex_dump_line(line,
465 &pd[eth_hdr_len + count], count))) {
466 *err = WTAP_ERR_BAD_FILE;
467 *err_info = g_strdup("dbs_etherwatch: packet data value not valid");
471 if (count > pkt_len) {
472 *err = WTAP_ERR_BAD_FILE;
473 *err_info = g_strdup("dbs_etherwatch: packet data value has too many bytes");
480 /* Parse a hex dump line */
482 /DISPLAY=BOTH output:
485 0123456789012345678901234567890123456789012345
486 [E..(8...........]- 0-[45 00 00 28 38 9B 00 00 1D 06 D2 1E 80 93 11 1A]
487 [.........(..Z.4y]- 16-[80 93 80 D6 02 D2 02 03 00 28 A4 BF 5A 1C 34 79]
488 [P.#(.C...00000..]- 32-[50 10 23 28 C1 43 00 00 03 30 30 30 30 30 00 00]
491 /DISPLAY=HEXADECIMAL output:
494 0123456789012345678901234567890123456789012345
495 0-[45 00 00 28 38 9B 00 00 1D 06 D2 1E 80 93 11 1A 80 93 80 D6]
496 20-[02 D2 02 03 00 28 A4 BF 5A 1C 34 79 50 10 23 28 C1 43 00 00]
497 40-[03 30 30 30 30 30 00 00 03 30]
501 #define TYPE_CHECK_POS 2 /* Position to check the type of hex dump */
502 #define TYPE_CHECK_BOTH '[' /* Value at pos. that indicates BOTH type */
503 #define COUNT_POS_BOTH 21 /* Count position BOTH type */
504 #define COUNT_POS_HEX 1 /* Count position HEX type */
505 #define COUNT_SIZE 5 /* Length counter */
506 #define HEX_DUMP_START '[' /* Start char */
507 #define HEX_DUMP_SPR ' ' /* Seperator char */
508 #define HEX_DUMP_END ']' /* End char */
510 /* Take a string representing one line from a hex dump and converts the
511 * text to binary data. We check the printed offset with the offset
512 * we are passed to validate the record. We place the bytes in the buffer
513 * at the specified offset.
515 * Returns length parsed if a good hex dump, 0 if bad.
518 parse_single_hex_dump_line(char* rec, guint8 *buf, int byte_offset) {
524 /* Check that the record is as least as long as the check offset */
525 for(i = 0; i < TYPE_CHECK_POS; i++)
531 /* determine the format and thus the counter offset and hex dump length */
532 if(rec[TYPE_CHECK_POS] == TYPE_CHECK_BOTH)
534 pos = COUNT_POS_BOTH;
541 /* Check that the record is as least as long as the start position */
550 /* Get the byte_offset directly from the record */
552 for(i = 0; i < COUNT_SIZE; i++) {
553 if(!isspace((guchar)rec[pos])) {
554 if(isdigit((guchar)rec[pos])) {
556 value += rec[pos] - '0';
564 if (value != byte_offset) {
568 /* find the start of the hex dump */
569 while(rec[pos] != HEX_DUMP_START) {
570 if(rec[pos] == '\0') {
576 return parse_hex_dump(&rec[pos], buf, HEX_DUMP_SPR, HEX_DUMP_END);
579 /* Parse a hex dump */
581 parse_hex_dump(char* dump, guint8 *buf, char seperator, char end) {
584 /* Parse the hex dump */
587 while(dump[pos] != end) {
588 /* Check the hex value */
589 if(!(isxdigit((guchar)dump[pos]) &&
590 isxdigit((guchar)dump[pos + 1]))) {
593 /* Get the hex value value */
594 if(isdigit((guchar)dump[pos])) {
595 buf[count] = (dump[pos] - '0') << 4;
597 buf[count] = (toupper(dump[pos]) - 'A' + 10) << 4;
600 if(isdigit((guchar)dump[pos])) {
601 buf[count] += dump[pos] - '0';
603 buf[count] += toupper(dump[pos]) - 'A' + 10;
607 /* Skip the seperator characters */
608 while(dump[pos] == seperator) {