6 * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
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.
30 #include "file_wrappers.h"
35 static gboolean iptrace_read_1_0(wtap *wth, int *err, gchar **err_info,
37 static gboolean iptrace_seek_read_1_0(wtap *wth, long seek_off,
38 union wtap_pseudo_header *pseudo_header, guchar *pd, int packet_size,
39 int *err, gchar **err_info);
41 static gboolean iptrace_read_2_0(wtap *wth, int *err, gchar **err_info,
43 static gboolean iptrace_seek_read_2_0(wtap *wth, long seek_off,
44 union wtap_pseudo_header *pseudo_header, guchar *pd, int packet_size,
45 int *err, gchar **err_info);
47 static int iptrace_read_rec_header(FILE_T fh, guint8 *header, int header_len,
49 static gboolean iptrace_read_rec_data(FILE_T fh, guint8 *data_ptr,
50 int packet_size, int *err);
51 static void fill_in_pseudo_header(int encap, const guint8 *pd, guint32 len,
52 union wtap_pseudo_header *pseudo_header, guint8 *header);
53 static int wtap_encap_ift(unsigned int ift);
55 int iptrace_open(wtap *wth, int *err, gchar **err_info _U_)
60 errno = WTAP_ERR_CANT_READ;
61 bytes_read = file_read(name, 1, 11, wth->fh);
62 if (bytes_read != 11) {
63 *err = file_error(wth->fh);
68 wth->data_offset += 11;
71 if (strcmp(name, "iptrace 1.0") == 0) {
72 wth->file_type = WTAP_FILE_IPTRACE_1_0;
73 wth->subtype_read = iptrace_read_1_0;
74 wth->subtype_seek_read = iptrace_seek_read_1_0;
76 else if (strcmp(name, "iptrace 2.0") == 0) {
77 wth->file_type = WTAP_FILE_IPTRACE_2_0;
78 wth->subtype_read = iptrace_read_2_0;
79 wth->subtype_seek_read = iptrace_seek_read_2_0;
88 /***********************************************************
90 ***********************************************************/
93 * iptrace 1.0, discovered through inspection
95 * Packet record contains:
97 * an initial header, with a length field and a time stamp, in
98 * seconds since the Epoch;
100 * data, with the specified length.
104 * a bunch of information about the packet;
106 * padding, at least for FDDI;
108 * the raw packet data.
111 /* 0-3 */ guint32 pkt_length; /* packet length + 0x16 */
112 /* 4-7 */ guint32 tv_sec; /* time stamp, seconds since the Epoch */
113 /* 8-11 */ guint32 junk1; /* ???, not time */
114 /* 12-15 */ char if_name[4]; /* null-terminated */
115 /* 16-27 */ char junk2[12]; /* ??? */
116 /* 28 */ guint8 if_type; /* BSD net/if_types.h */
117 /* 29 */ guint8 tx_flag; /* 0=receive, 1=transmit */
120 #define IPTRACE_1_0_PHDR_SIZE 30 /* initial header plus packet data */
121 #define IPTRACE_1_0_PDATA_SIZE 22 /* packet data */
123 /* Read the next packet */
124 static gboolean iptrace_read_1_0(wtap *wth, int *err, gchar **err_info _U_,
129 guint8 header[IPTRACE_1_0_PHDR_SIZE];
131 iptrace_1_0_phdr pkt_hdr;
132 guchar fddi_padding[3];
134 /* Read the descriptor data */
135 *data_offset = wth->data_offset;
136 ret = iptrace_read_rec_header(wth->fh, header, IPTRACE_1_0_PHDR_SIZE,
139 /* Read error or EOF */
142 wth->data_offset += IPTRACE_1_0_PHDR_SIZE;
145 * Byte 28 of the frame header appears to be a BSD-style IFT_xxx
146 * value giving the type of the interface. Check out the
147 * <net/if_types.h> header file.
149 pkt_hdr.if_type = header[28];
150 wth->phdr.pkt_encap = wtap_encap_ift(pkt_hdr.if_type);
152 /* Read the packet data */
153 packet_size = pntohl(&header[0]) - IPTRACE_1_0_PDATA_SIZE;
156 * AIX appears to put 3 bytes of padding in front of FDDI
157 * frames; strip that crap off.
159 if (wth->phdr.pkt_encap == WTAP_ENCAP_FDDI_BITSWAPPED) {
161 * The packet size is really a record size and includes
165 wth->data_offset += 3;
170 if (!iptrace_read_rec_data(wth->fh, fddi_padding, 3, err))
171 return FALSE; /* Read error */
174 buffer_assure_space( wth->frame_buffer, packet_size );
175 data_ptr = buffer_start_ptr( wth->frame_buffer );
176 if (!iptrace_read_rec_data(wth->fh, data_ptr, packet_size, err))
177 return FALSE; /* Read error */
178 wth->data_offset += packet_size;
180 wth->phdr.len = packet_size;
181 wth->phdr.caplen = packet_size;
182 wth->phdr.ts.tv_sec = pntohl(&header[4]);
183 wth->phdr.ts.tv_usec = 0;
185 if (wth->phdr.pkt_encap == WTAP_ENCAP_UNKNOWN) {
186 *err = WTAP_ERR_UNSUPPORTED_ENCAP;
187 *err_info = g_strdup_printf("iptrace: interface type IFT=0x%02x unknown or unsupported",
192 /* Fill in the pseudo-header. */
193 fill_in_pseudo_header(wth->phdr.pkt_encap, data_ptr, wth->phdr.caplen,
194 &wth->pseudo_header, header);
196 /* If the per-file encapsulation isn't known, set it to this
197 packet's encapsulation.
199 If it *is* known, and it isn't this packet's encapsulation,
200 set it to WTAP_ENCAP_PER_PACKET, as this file doesn't
201 have a single encapsulation for all packets in the file. */
202 if (wth->file_encap == WTAP_ENCAP_UNKNOWN)
203 wth->file_encap = wth->phdr.pkt_encap;
205 if (wth->file_encap != wth->phdr.pkt_encap)
206 wth->file_encap = WTAP_ENCAP_PER_PACKET;
212 static gboolean iptrace_seek_read_1_0(wtap *wth, long seek_off,
213 union wtap_pseudo_header *pseudo_header, guchar *pd, int packet_size,
214 int *err, gchar **err_info _U_)
217 guint8 header[IPTRACE_1_0_PHDR_SIZE];
219 guchar fddi_padding[3];
221 if (file_seek(wth->random_fh, seek_off, SEEK_SET, err) == -1)
224 /* Read the descriptor data */
225 ret = iptrace_read_rec_header(wth->random_fh, header,
226 IPTRACE_1_0_PHDR_SIZE, err);
228 /* Read error or EOF */
230 /* EOF means "short read" in random-access mode */
231 *err = WTAP_ERR_SHORT_READ;
237 * Get the interface type.
239 pkt_encap = wtap_encap_ift(header[28]);
242 * AIX appears to put 3 bytes of padding in front of FDDI
243 * frames; strip that crap off.
245 if (pkt_encap == WTAP_ENCAP_FDDI_BITSWAPPED) {
249 if (!iptrace_read_rec_data(wth->random_fh, fddi_padding, 3, err))
250 return FALSE; /* Read error */
253 /* Get the packet data */
254 if (!iptrace_read_rec_data(wth->random_fh, pd, packet_size, err))
257 /* Fill in the pseudo_header. */
258 fill_in_pseudo_header(pkt_encap, pd, packet_size, pseudo_header,
264 /***********************************************************
266 ***********************************************************/
269 * iptrace 2.0, discovered through inspection
271 * Packet record contains:
273 * an initial header, with a length field and a time stamp, in
274 * seconds since the Epoch;
276 * data, with the specified length.
280 * a bunch of information about the packet;
282 * padding, at least for FDDI;
284 * the raw packet data.
287 /* 0-3 */ guint32 pkt_length; /* packet length + 32 */
288 /* 4-7 */ guint32 tv_sec0; /* time stamp, seconds since the Epoch */
289 /* 8-11 */ guint32 junk1; /* ?? */
290 /* 12-15 */ char if_name[4]; /* null-terminated */
291 /* 16-27 */ char if_desc[12]; /* interface description. */
292 /* 28 */ guint8 if_type; /* BSD net/if_types.h */
293 /* 29 */ guint8 tx_flag; /* 0=receive, 1=transmit */
294 /* 30-31 */ guint16 junk3;
295 /* 32-35 */ guint32 tv_sec; /* time stamp, seconds since the Epoch */
296 /* 36-39 */ guint32 tv_nsec; /* nanoseconds since that second */
299 #define IPTRACE_2_0_PHDR_SIZE 40 /* initial header plus packet data */
300 #define IPTRACE_2_0_PDATA_SIZE 32 /* packet data */
302 /* Read the next packet */
303 static gboolean iptrace_read_2_0(wtap *wth, int *err, gchar **err_info _U_,
308 guint8 header[IPTRACE_2_0_PHDR_SIZE];
310 iptrace_2_0_phdr pkt_hdr;
311 guchar fddi_padding[3];
313 /* Read the descriptor data */
314 *data_offset = wth->data_offset;
315 ret = iptrace_read_rec_header(wth->fh, header, IPTRACE_2_0_PHDR_SIZE,
318 /* Read error or EOF */
321 wth->data_offset += IPTRACE_2_0_PHDR_SIZE;
324 * Byte 28 of the frame header appears to be a BSD-style IFT_xxx
325 * value giving the type of the interface. Check out the
326 * <net/if_types.h> header file.
328 pkt_hdr.if_type = header[28];
329 wth->phdr.pkt_encap = wtap_encap_ift(pkt_hdr.if_type);
331 /* Read the packet data */
332 packet_size = pntohl(&header[0]) - IPTRACE_2_0_PDATA_SIZE;
335 * AIX appears to put 3 bytes of padding in front of FDDI
336 * frames; strip that crap off.
338 if (wth->phdr.pkt_encap == WTAP_ENCAP_FDDI_BITSWAPPED) {
340 * The packet size is really a record size and includes
344 wth->data_offset += 3;
349 if (!iptrace_read_rec_data(wth->fh, fddi_padding, 3, err))
350 return FALSE; /* Read error */
353 buffer_assure_space( wth->frame_buffer, packet_size );
354 data_ptr = buffer_start_ptr( wth->frame_buffer );
355 if (!iptrace_read_rec_data(wth->fh, data_ptr, packet_size, err))
356 return FALSE; /* Read error */
357 wth->data_offset += packet_size;
359 /* AIX saves time in nsec, not usec. It's easier to make iptrace
360 * files more Unix-compliant here than try to get the calling
361 * program to know when to use nsec or usec */
363 wth->phdr.len = packet_size;
364 wth->phdr.caplen = packet_size;
365 wth->phdr.ts.tv_sec = pntohl(&header[32]);
366 wth->phdr.ts.tv_usec = pntohl(&header[36]) / 1000;
368 if (wth->phdr.pkt_encap == WTAP_ENCAP_UNKNOWN) {
369 *err = WTAP_ERR_UNSUPPORTED_ENCAP;
370 *err_info = g_strdup_printf("iptrace: interface type IFT=0x%02x unknown or unsupported",
375 /* Fill in the pseudo-header. */
376 fill_in_pseudo_header(wth->phdr.pkt_encap, data_ptr, wth->phdr.caplen,
377 &wth->pseudo_header, header);
379 /* If the per-file encapsulation isn't known, set it to this
380 packet's encapsulation.
382 If it *is* known, and it isn't this packet's encapsulation,
383 set it to WTAP_ENCAP_PER_PACKET, as this file doesn't
384 have a single encapsulation for all packets in the file. */
385 if (wth->file_encap == WTAP_ENCAP_UNKNOWN)
386 wth->file_encap = wth->phdr.pkt_encap;
388 if (wth->file_encap != wth->phdr.pkt_encap)
389 wth->file_encap = WTAP_ENCAP_PER_PACKET;
395 static gboolean iptrace_seek_read_2_0(wtap *wth, long seek_off,
396 union wtap_pseudo_header *pseudo_header, guchar *pd, int packet_size,
397 int *err, gchar **err_info _U_)
400 guint8 header[IPTRACE_2_0_PHDR_SIZE];
402 guchar fddi_padding[3];
404 if (file_seek(wth->random_fh, seek_off, SEEK_SET, err) == -1)
407 /* Read the descriptor data */
408 ret = iptrace_read_rec_header(wth->random_fh, header,
409 IPTRACE_2_0_PHDR_SIZE, err);
411 /* Read error or EOF */
413 /* EOF means "short read" in random-access mode */
414 *err = WTAP_ERR_SHORT_READ;
420 * Get the interface type.
422 pkt_encap = wtap_encap_ift(header[28]);
425 * AIX appears to put 3 bytes of padding in front of FDDI
426 * frames; strip that crap off.
428 if (pkt_encap == WTAP_ENCAP_FDDI_BITSWAPPED) {
432 if (!iptrace_read_rec_data(wth->random_fh, fddi_padding, 3, err))
433 return FALSE; /* Read error */
436 /* Get the packet data */
437 if (!iptrace_read_rec_data(wth->random_fh, pd, packet_size, err))
440 /* Fill in the pseudo-header. */
441 fill_in_pseudo_header(pkt_encap, pd, packet_size, pseudo_header,
448 iptrace_read_rec_header(FILE_T fh, guint8 *header, int header_len, int *err)
452 errno = WTAP_ERR_CANT_READ;
453 bytes_read = file_read(header, 1, header_len, fh);
454 if (bytes_read != header_len) {
455 *err = file_error(fh);
458 if (bytes_read != 0) {
459 *err = WTAP_ERR_SHORT_READ;
468 iptrace_read_rec_data(FILE_T fh, guint8 *data_ptr, int packet_size, int *err)
472 errno = WTAP_ERR_CANT_READ;
473 bytes_read = file_read( data_ptr, 1, packet_size, fh );
475 if (bytes_read != packet_size) {
476 *err = file_error(fh);
478 *err = WTAP_ERR_SHORT_READ;
485 * Fill in the pseudo-header information we can.
487 * For ATM traffic, "iptrace", alas, doesn't tell us what type of traffic
488 * is in the packet - it was presumably run on a machine that was one of
489 * the endpoints of the connection, so in theory it could presumably have
490 * told us, but, for whatever reason, it failed to do so - perhaps the
491 * low-level mechanism that feeds the presumably-AAL5 frames to us doesn't
492 * have access to that information (e.g., because it's in the ATM driver,
493 * and the ATM driver merely knows that stuff on VPI/VCI X.Y should be
494 * handed up to some particular client, it doesn't know what that client is).
496 * We let our caller try to figure out what kind of traffic it is, either
497 * by guessing based on the VPI/VCI, guessing based on the header of the
498 * packet, seeing earlier traffic that set up the circuit and specified
499 * in some fashion what sort of traffic it is, or being told by the user.
502 fill_in_pseudo_header(int encap, const guint8 *pd, guint32 len,
503 union wtap_pseudo_header *pseudo_header, guint8 *header)
512 case WTAP_ENCAP_ATM_PDUS:
513 /* Rip apart the "x.y" text into Vpi/Vci numbers */
514 memcpy(if_text, &header[20], 8);
516 decimal = strchr(if_text, '.');
519 Vpi = strtoul(if_text, NULL, 10);
521 Vci = strtoul(decimal, NULL, 10);
525 * OK, which value means "DTE->DCE" and which value means
528 pseudo_header->atm.channel = header[29];
530 pseudo_header->atm.vpi = Vpi;
531 pseudo_header->atm.vci = Vci;
534 * Attempt to guess from the packet data, the VPI,
535 * and the VCI information about the type of traffic.
537 atm_guess_traffic_type(pd, len, pseudo_header);
539 /* We don't have this information */
540 pseudo_header->atm.flags = 0;
541 pseudo_header->atm.cells = 0;
542 pseudo_header->atm.aal5t_u2u = 0;
543 pseudo_header->atm.aal5t_len = 0;
544 pseudo_header->atm.aal5t_chksum = 0;
547 case WTAP_ENCAP_ETHERNET:
548 /* We assume there's no FCS in this frame. */
549 pseudo_header->eth.fcs_len = 0;
554 /* Given an RFC1573 (SNMP ifType) interface type,
555 * return the appropriate Wiretap Encapsulation Type.
558 wtap_encap_ift(unsigned int ift)
561 static const int ift_encap[] = {
562 /* 0x0 */ WTAP_ENCAP_UNKNOWN, /* nothing */
563 /* 0x1 */ WTAP_ENCAP_UNKNOWN, /* IFT_OTHER */
564 /* 0x2 */ WTAP_ENCAP_UNKNOWN, /* IFT_1822 */
565 /* 0x3 */ WTAP_ENCAP_UNKNOWN, /* IFT_HDH1822 */
566 /* 0x4 */ WTAP_ENCAP_RAW_IP, /* IFT_X25DDN */
567 /* 0x5 */ WTAP_ENCAP_UNKNOWN, /* IFT_X25 */
568 /* 0x6 */ WTAP_ENCAP_ETHERNET, /* IFT_ETHER */
569 /* 0x7 */ WTAP_ENCAP_ETHERNET, /* IFT_ISO88023 */
570 /* 0x8 */ WTAP_ENCAP_UNKNOWN, /* IFT_ISO88024 */
571 /* 0x9 */ WTAP_ENCAP_TOKEN_RING, /* IFT_ISO88025 */
572 /* 0xa */ WTAP_ENCAP_UNKNOWN, /* IFT_ISO88026 */
573 /* 0xb */ WTAP_ENCAP_UNKNOWN, /* IFT_STARLAN */
574 /* 0xc */ WTAP_ENCAP_RAW_IP, /* IFT_P10, IBM SP switch */
575 /* 0xd */ WTAP_ENCAP_UNKNOWN, /* IFT_P80 */
576 /* 0xe */ WTAP_ENCAP_UNKNOWN, /* IFT_HY */
577 /* 0xf */ WTAP_ENCAP_FDDI_BITSWAPPED, /* IFT_FDDI */
578 /* 0x10 */ WTAP_ENCAP_LAPB, /* IFT_LAPB */ /* no data to back this up */
579 /* 0x11 */ WTAP_ENCAP_UNKNOWN, /* IFT_SDLC */
580 /* 0x12 */ WTAP_ENCAP_UNKNOWN, /* IFT_T1 */
581 /* 0x13 */ WTAP_ENCAP_UNKNOWN, /* IFT_CEPT */
582 /* 0x14 */ WTAP_ENCAP_UNKNOWN, /* IFT_ISDNBASIC */
583 /* 0x15 */ WTAP_ENCAP_UNKNOWN, /* IFT_ISDNPRIMARY */
584 /* 0x16 */ WTAP_ENCAP_UNKNOWN, /* IFT_PTPSERIAL */
585 /* 0x17 */ WTAP_ENCAP_UNKNOWN, /* IFT_PPP */
586 /* 0x18 */ WTAP_ENCAP_RAW_IP, /* IFT_LOOP */
587 /* 0x19 */ WTAP_ENCAP_UNKNOWN, /* IFT_EON */
588 /* 0x1a */ WTAP_ENCAP_UNKNOWN, /* IFT_XETHER */
589 /* 0x1b */ WTAP_ENCAP_UNKNOWN, /* IFT_NSIP */
590 /* 0x1c */ WTAP_ENCAP_UNKNOWN, /* IFT_SLIP */
591 /* 0x1d */ WTAP_ENCAP_UNKNOWN, /* IFT_ULTRA */
592 /* 0x1e */ WTAP_ENCAP_UNKNOWN, /* IFT_DS3 */
593 /* 0x1f */ WTAP_ENCAP_UNKNOWN, /* IFT_SIP */
594 /* 0x20 */ WTAP_ENCAP_UNKNOWN, /* IFT_FRELAY */
595 /* 0x21 */ WTAP_ENCAP_UNKNOWN, /* IFT_RS232 */
596 /* 0x22 */ WTAP_ENCAP_UNKNOWN, /* IFT_PARA */
597 /* 0x23 */ WTAP_ENCAP_UNKNOWN, /* IFT_ARCNET */
598 /* 0x24 */ WTAP_ENCAP_UNKNOWN, /* IFT_ARCNETPLUS */
599 /* 0x25 */ WTAP_ENCAP_ATM_PDUS, /* IFT_ATM */
601 #define NUM_IFT_ENCAPS (sizeof ift_encap / sizeof ift_encap[0])
603 if (ift < NUM_IFT_ENCAPS) {
604 return ift_encap[ift];
607 return WTAP_ENCAP_UNKNOWN;