c7aa7f18a719ee02f3f21f60c82338562a55e01e
[obnox/wireshark/wip.git] / wiretap / nettl.c
1 /* nettl.c
2  *
3  * $Id$
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
27 #include <stdlib.h>
28 #include <errno.h>
29 #include <string.h>
30 #include "wtap-int.h"
31 #include "file_wrappers.h"
32 #include "buffer.h"
33 #include "nettl.h"
34
35 static guchar nettl_magic_hpux9[12] = {
36     0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x07, 0xD0, 0x00
37 };
38 static guchar nettl_magic_hpux10[12] = {
39     0x54, 0x52, 0x00, 0x64, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x80
40 };
41
42 /* HP nettl record header for the SX25L2 subsystem - The FCS is not included in the file. */
43 struct nettlrec_sx25l2_hdr {
44     guint8      xxa[8];
45     guint8      from_dce;
46     guint8      xxb[55];
47     guint8      caplen[2];
48     guint8      length[2];
49     guint8      xxc[4];
50     guint8      sec[4];
51     guint8      usec[4];
52     guint8      xxd[4];
53 };
54
55 /* HP nettl record header for the NS_LS_IP subsystem */
56 /* This also works for BASE100 and GSC100BT */
57 struct nettlrec_ns_ls_ip_hdr {
58     guint8      xxa[28];
59     guint8      caplen[4];
60     guint8      length[4];
61     guint8      sec[4];
62     guint8      usec[4];
63     guint8      xxb[16];
64 };
65
66
67 /* header is followed by data and once again the total length (2 bytes) ! */
68
69
70 /* NL_LS_DRIVER :
71 The following shows what the header looks like for NS_LS_DRIVER
72 The capture was taken on HPUX11 and for a 100baseT interface.
73
74 000080 00 44 00 0b 00 00 00 02 00 00 00 00 20 00 00 00
75 000090 00 00 00 00 00 00 04 06 00 00 00 00 00 00 00 00
76 0000a0 00 00 00 74 00 00 00 74 3c e3 76 19 00 06 34 63
77 0000b0 ff ff ff ff 00 00 00 00 00 00 00 00 ff ff ff ff
78 0000c0 00 00 00 00 00 00 01 02 00 5c 00 5c ff ff ff ff
79 0000d0 3c e3 76 19 00 06 34 5a 00 0b 00 14 <here starts the MAC heder>
80
81 Each entry starts with 0x0044000b
82
83 The values 0x005c at position 0x0000c8 and 0x0000ca matches the number of bytes in
84 the packet up to the next entry, which starts with 0x00440b again. These probably
85 indicate the real and captured length of the packet (order unknown)
86
87 The values 0x00000074 at positions 0x0000a0 and 0x0000a4 seems to indicate
88 the same number as positions 0x0000c8 and 0x0000ca but added with 24.
89 Perhaps we have here two layers of headers.
90 The first layer is fixed and consists of all the bytes from 0x000084 up to and
91 including 0x0000c3 which is a generic header for all packets captured from any
92 device. This header might be of fixed size 64 bytes and there might be something in
93 it which indicates the type of the next header which is link type specific.
94 Following this header there is another header for the 100baseT interface which
95 in this case is 24 bytes long spanning positions 0x0000c4 to 0x0000db.
96
97 When someone reports that the loading of the captures breaks, we can compare
98 this header above with what he/she got to learn how to distinguish between different
99 types of link specific headers.
100
101
102 For now:
103 The first header seems to be
104         a normal nettlrec_ns_ls_ip_hdr
105
106 The header for 100baseT seems to be
107         0-3     unknown
108         4-5     captured length
109         6-7     actual length
110         8-11    unknown
111         12-15   secs
112         16-19   usecs
113         20-23   unknown
114 */
115 struct nettlrec_ns_ls_drv_eth_hdr {
116     guint8      xxa[4];
117     guint8      caplen[2];
118     guint8      length[2];
119     guint8      xxb[4];
120     guint8      sec[4];
121     guint8      usec[4];
122     guint8      xxc[4];
123 };
124
125
126 static gboolean nettl_read(wtap *wth, int *err, gchar **err_info,
127                 long *data_offset);
128 static gboolean nettl_seek_read(wtap *wth, long seek_off,
129                 union wtap_pseudo_header *pseudo_header, guchar *pd,
130                 int length, int *err, gchar **err_info);
131 static int nettl_read_rec_header(wtap *wth, FILE_T fh,
132                 struct wtap_pkthdr *phdr, union wtap_pseudo_header *pseudo_header,
133                 int *err, gchar **err_info);
134 static gboolean nettl_read_rec_data(FILE_T fh, guchar *pd, int length,
135                 int *err);
136 static void nettl_close(wtap *wth);
137
138 int nettl_open(wtap *wth, int *err, gchar **err_info _U_)
139 {
140     char magic[12], os_vers[2];
141     int bytes_read;
142
143     /* Read in the string that should be at the start of a HP file */
144     errno = WTAP_ERR_CANT_READ;
145     bytes_read = file_read(magic, 1, 12, wth->fh);
146     if (bytes_read != 12) {
147         *err = file_error(wth->fh);
148         if (*err != 0)
149             return -1;
150         return 0;
151     }
152
153     if (memcmp(magic, nettl_magic_hpux9, 12) &&
154         memcmp(magic, nettl_magic_hpux10, 12)) {
155         return 0;
156     }
157
158     if (file_seek(wth->fh, 0x63, SEEK_SET, err) == -1)
159         return -1;
160     wth->data_offset = 0x63;
161     bytes_read = file_read(os_vers, 1, 2, wth->fh);
162     if (bytes_read != 2) {
163         *err = file_error(wth->fh);
164         if (*err != 0)
165             return -1;
166         return 0;
167     }
168
169     if (file_seek(wth->fh, 0x80, SEEK_SET, err) == -1)
170         return -1;
171     wth->data_offset = 0x80;
172
173     /* This is an nettl file */
174     wth->file_type = WTAP_FILE_NETTL;
175     wth->capture.nettl = g_malloc(sizeof(nettl_t));
176     if (os_vers[0] == '1' && os_vers[1] == '1')
177         wth->capture.nettl->is_hpux_11 = TRUE;
178     else
179         wth->capture.nettl->is_hpux_11 = FALSE;
180     wth->subtype_read = nettl_read;
181     wth->subtype_seek_read = nettl_seek_read;
182     wth->subtype_close = nettl_close;
183     wth->snapshot_length = 0;   /* not available in header, only in frame */
184
185     return 1;
186 }
187
188 /* Read the next packet */
189 static gboolean nettl_read(wtap *wth, int *err, gchar **err_info,
190     long *data_offset)
191 {
192     int ret;
193
194     /* Read record header. */
195     *data_offset = wth->data_offset;
196     ret = nettl_read_rec_header(wth, wth->fh, &wth->phdr, &wth->pseudo_header,
197         err, err_info);
198     if (ret <= 0) {
199         /* Read error or EOF */
200         return FALSE;
201     }
202     wth->data_offset += ret;
203
204     /*
205      * If the per-file encapsulation isn't known, set it to this
206      * packet's encapsulation.
207      *
208      * If it *is* known, and it isn't this packet's encapsulation,
209      * set it to WTAP_ENCAP_PER_PACKET, as this file doesn't
210      * have a single encapsulation for all packets in the file.
211      */
212     if (wth->file_encap == WTAP_ENCAP_UNKNOWN)
213         wth->file_encap = wth->phdr.pkt_encap;
214     else {
215         if (wth->file_encap != wth->phdr.pkt_encap)
216             wth->file_encap = WTAP_ENCAP_PER_PACKET;
217     }
218
219     /*
220      * Read the packet data.
221      */
222     buffer_assure_space(wth->frame_buffer, wth->phdr.caplen);
223     if (!nettl_read_rec_data(wth->fh, buffer_start_ptr(wth->frame_buffer),
224                 wth->phdr.caplen, err))
225         return FALSE;   /* Read error */
226     wth->data_offset += wth->phdr.caplen;
227     return TRUE;
228 }
229
230 static gboolean
231 nettl_seek_read(wtap *wth, long seek_off,
232                 union wtap_pseudo_header *pseudo_header, guchar *pd,
233                 int length, int *err, gchar **err_info)
234 {
235     int ret;
236     struct wtap_pkthdr phdr;
237
238     if (file_seek(wth->random_fh, seek_off, SEEK_SET, err) == -1)
239         return FALSE;
240
241     /* Read record header. */
242     ret = nettl_read_rec_header(wth, wth->random_fh, &phdr, pseudo_header,
243         err, err_info);
244     if (ret <= 0) {
245         /* Read error or EOF */
246         if (ret == 0) {
247             /* EOF means "short read" in random-access mode */
248             *err = WTAP_ERR_SHORT_READ;
249         }
250         return FALSE;
251     }
252
253     /*
254      * Read the packet data.
255      */
256     return nettl_read_rec_data(wth->random_fh, pd, length, err);
257 }
258
259 static int
260 nettl_read_rec_header(wtap *wth, FILE_T fh, struct wtap_pkthdr *phdr,
261                 union wtap_pseudo_header *pseudo_header, int *err,
262                 gchar **err_info)
263 {
264     int bytes_read;
265     struct nettlrec_sx25l2_hdr lapb_hdr;
266     struct nettlrec_ns_ls_ip_hdr ip_hdr;
267     struct nettlrec_ns_ls_drv_eth_hdr drv_eth_hdr;
268     guint16 length;
269     int offset = 0;
270     guint8 encap[4];
271     guint8 dummy[4];
272
273     errno = WTAP_ERR_CANT_READ;
274     bytes_read = file_read(encap, 1, 4, fh);
275     if (bytes_read != 4) {
276         *err = file_error(fh);
277         if (*err != 0)
278             return -1;
279         if (bytes_read != 0) {
280             *err = WTAP_ERR_SHORT_READ;
281             return -1;
282         }
283         return 0;
284     }
285     offset += 4;
286
287     switch (encap[3]) {
288         case NETTL_SUBSYS_LAN100 :
289         case NETTL_SUBSYS_BASE100 :
290         case NETTL_SUBSYS_GSC100BT :
291         case NETTL_SUBSYS_PCI100BT :
292         case NETTL_SUBSYS_SPP100BT :
293         case NETTL_SUBSYS_GELAN :
294         case NETTL_SUBSYS_BTLAN :
295         case NETTL_SUBSYS_INTL100 :
296         case NETTL_SUBSYS_IGELAN :
297         case NETTL_SUBSYS_IETHER :
298         case NETTL_SUBSYS_PCI_FDDI :
299         case NETTL_SUBSYS_TOKEN :
300         case NETTL_SUBSYS_PCI_TR :
301         case NETTL_SUBSYS_NS_LS_IP :
302         case NETTL_SUBSYS_NS_LS_LOOPBACK :
303         case NETTL_SUBSYS_NS_LS_TCP :
304         case NETTL_SUBSYS_NS_LS_UDP :
305         case NETTL_SUBSYS_NS_LS_ICMP :
306             if( (encap[3] == NETTL_SUBSYS_NS_LS_IP)
307              || (encap[3] == NETTL_SUBSYS_NS_LS_LOOPBACK)
308              || (encap[3] == NETTL_SUBSYS_NS_LS_UDP)
309              || (encap[3] == NETTL_SUBSYS_NS_LS_TCP) ) {
310                 phdr->pkt_encap = WTAP_ENCAP_RAW_IP;
311             } else if (encap[3] == NETTL_SUBSYS_NS_LS_ICMP) {
312                 phdr->pkt_encap = WTAP_ENCAP_UNKNOWN;
313             } else if (encap[3] == NETTL_SUBSYS_PCI_FDDI) {
314                 phdr->pkt_encap = WTAP_ENCAP_FDDI;
315             } else if( (encap[3] == NETTL_SUBSYS_PCI_TR)
316                     || (encap[3] == NETTL_SUBSYS_TOKEN) ) {
317                 phdr->pkt_encap = WTAP_ENCAP_TOKEN_RING;
318             } else {
319                 phdr->pkt_encap = WTAP_ENCAP_ETHERNET;
320                 /* We assume there's no FCS in this frame. */
321                 pseudo_header->eth.fcs_len = 0;
322             }
323
324             bytes_read = file_read(&ip_hdr, 1, sizeof ip_hdr, fh);
325             if (bytes_read != sizeof ip_hdr) {
326                 *err = file_error(fh);
327                 if (*err != 0)
328                     return -1;
329                 if (bytes_read != 0) {
330                     *err = WTAP_ERR_SHORT_READ;
331                     return -1;
332                 }
333                 return 0;
334             }
335             offset += sizeof ip_hdr;
336
337             /* The packet header in HP-UX 11 nettl traces is 4 octets longer than
338              * HP-UX 9 and 10 */
339             if (wth->capture.nettl->is_hpux_11) {
340                 bytes_read = file_read(dummy, 1, 4, fh);
341                 if (bytes_read != 4) {
342                     *err = file_error(fh);
343                     if (*err != 0)
344                         return -1;
345                     if (bytes_read != 0) {
346                         *err = WTAP_ERR_SHORT_READ;
347                         return -1;
348                     }
349                     return 0;
350                 }
351                 offset += 4;
352             }
353
354             /* PCI FDDI has an extra 3 bytes of padding */
355             if (encap[3] == NETTL_SUBSYS_PCI_FDDI) {
356                 bytes_read = file_read(dummy, 1, 3, fh);
357                 if (bytes_read != 3) {
358                     *err = file_error(fh);
359                     if (*err != 0)
360                         return -1;
361                     if (bytes_read != 0) {
362                         *err = WTAP_ERR_SHORT_READ;
363                         return -1;
364                     }
365                     return 0;
366                 }
367                 offset += 3;
368                 length = pntohl(&ip_hdr.length);
369                 if (length <= 0)
370                         return 0;
371                 phdr->len = length - 3;
372                 length = pntohl(&ip_hdr.caplen);
373                 phdr->caplen = length - 3;
374             } else {
375                 length = pntohl(&ip_hdr.length);
376                 if (length <= 0)
377                     return 0;
378                 phdr->len = length;
379                 length = pntohl(&ip_hdr.caplen);
380                 phdr->caplen = length;
381             }
382
383             phdr->ts.tv_sec = pntohl(&ip_hdr.sec);
384             phdr->ts.tv_usec = pntohl(&ip_hdr.usec);
385             break;
386         case NETTL_SUBSYS_NS_LS_DRIVER :
387             bytes_read = file_read(&ip_hdr, 1, sizeof ip_hdr, fh);
388             if (bytes_read != sizeof ip_hdr) {
389                 *err = file_error(fh);
390                 if (*err != 0)
391                     return -1;
392                 if (bytes_read != 0) {
393                     *err = WTAP_ERR_SHORT_READ;
394                     return -1;
395                 }
396                 return 0;
397             }
398             offset += sizeof ip_hdr;
399
400             /* The packet header in HP-UX 11 nettl traces is 4 octets longer than
401              * HP-UX 9 and 10 */
402             if (wth->capture.nettl->is_hpux_11) {
403                 bytes_read = file_read(dummy, 1, 4, fh);
404                 if (bytes_read != 4) {
405                     *err = file_error(fh);
406                     if (*err != 0)
407                         return -1;
408                     if (bytes_read != 0) {
409                         *err = WTAP_ERR_SHORT_READ;
410                         return -1;
411                     }
412                     return 0;
413                 }
414                 offset += 4;
415             }
416
417             /* XXX we dont know how to identify this as ethernet frames, so
418                we assumes everything is. We will crash and burn for anything else */
419             /* for encapsulated 100baseT we do this */
420             phdr->pkt_encap = WTAP_ENCAP_ETHERNET;
421             /* We assume there's no FCS in this frame. */
422             pseudo_header->eth.fcs_len = 0;
423             bytes_read = file_read(&drv_eth_hdr, 1, sizeof drv_eth_hdr, fh);
424             if (bytes_read != sizeof drv_eth_hdr) {
425                 *err = file_error(fh);
426                 if (*err != 0)
427                     return -1;
428                 if (bytes_read != 0) {
429                     *err = WTAP_ERR_SHORT_READ;
430                     return -1;
431                 }
432                 return 0;
433             }
434             offset += sizeof drv_eth_hdr;
435
436             length = pntohs(&drv_eth_hdr.length); 
437             if (length <= 0) return 0;
438             phdr->len = length;
439             length = pntohs(&drv_eth_hdr.caplen);
440             phdr->caplen = length;
441
442             phdr->ts.tv_sec = pntohl(&ip_hdr.sec);
443             phdr->ts.tv_usec = pntohl(&ip_hdr.usec);
444             break;
445         case NETTL_SUBSYS_SX25L2 :
446             phdr->pkt_encap = WTAP_ENCAP_LAPB;
447             bytes_read = file_read(&lapb_hdr, 1, sizeof lapb_hdr, fh);
448             if (bytes_read != sizeof lapb_hdr) {
449                 *err = file_error(fh);
450                 if (*err != 0)
451                     return -1;
452                 if (bytes_read != 0) {
453                     *err = WTAP_ERR_SHORT_READ;
454                     return -1;
455                 }
456                 return 0;
457             }
458             offset += sizeof lapb_hdr;
459
460             if (wth->capture.nettl->is_hpux_11) {
461                 bytes_read = file_read(dummy, 1, 4, fh);
462                 if (bytes_read != 4) {
463                     *err = file_error(fh);
464                     if (*err != 0)
465                         return -1;
466                     if (bytes_read != 0) {
467                         *err = WTAP_ERR_SHORT_READ;
468                         return -1;
469                     }
470                     return 0;
471                 }
472                 offset += 4;
473             }
474
475             length = pntohs(&lapb_hdr.length);
476             if (length <= 0) return 0;
477             phdr->len = length;
478             phdr->caplen = length;
479
480             phdr->ts.tv_sec = pntohl(&lapb_hdr.sec);
481             phdr->ts.tv_usec = pntohl(&lapb_hdr.usec);
482             pseudo_header->x25.flags =
483                 (lapb_hdr.from_dce & 0x20 ? FROM_DCE : 0x00);
484             break;
485         default:
486             *err = WTAP_ERR_UNSUPPORTED_ENCAP;
487             *err_info = g_strdup_printf("nettl: network type %u unknown or unsupported",
488                     encap[3]);
489             return -1;
490     }
491     return offset;
492 }
493
494 static gboolean
495 nettl_read_rec_data(FILE_T fh, guchar *pd, int length, int *err)
496 {
497     int bytes_read;
498
499     bytes_read = file_read(pd, 1, length, fh);
500
501     if (bytes_read != length) {
502         *err = file_error(fh);
503         if (*err == 0)
504             *err = WTAP_ERR_SHORT_READ;
505         return FALSE;
506     }
507     return TRUE;
508 }
509
510 static void nettl_close(wtap *wth)
511 {
512     g_free(wth->capture.nettl);
513 }