From Rolf Fiedler:
[obnox/wireshark/wip.git] / wiretap / eyesdn.c
1 /* eyesdn.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 #include "wtap-int.h"
27 #include "buffer.h"
28 #include "eyesdn.h"
29 #include "file_wrappers.h"
30
31 #include <stdio.h>
32 #include <stdlib.h>
33 #include <string.h>
34 #include <errno.h>
35
36 /* This module reads the output of the EyeSDN USB S0/E1 ISDN probes
37  * They store HDLC frames of D and B channels in a binary format
38  * The fileformat is
39  * 
40  * 1-6 Byte: EyeSDN - Magic
41  * 7-n Byte: Frames
42  * 
43  * Each Frame starts with the 0xff Flag byte
44  * - Bytes 0-2: timestamp (long usec in network byte order)
45  * - Bytes 3-7: timestamp (40bits sec since 1970 in network byte order)
46  * - Byte 8: channel (0 for D channel, 1-30 for B1-B30, 129 for ATM)
47  * - Byte 9: Sender (0 NT, 1 TE)
48  * - Byte 10-11: frame size in bytes
49  * - Byte 12-n: Frame Payload
50  * 
51  * All multibyte values are represented in network byte order
52  * The frame is terminated with a flag character (0xff)
53  * bytes 0xff within a frame are escaped using the 0xfe escape character
54  * the byte following the escape character is decremented by two:
55  * so 0xfe 0xfd is actually a 0xff
56  * Characters that need to be escaped are 0xff and 0xfe
57  */
58
59
60 static int esc_read(guint8 *buf, int len, FILE_T fh)
61 {
62     int i;
63     int value;
64     
65     for(i=0; i<len; i++) {
66         value=file_getc(fh);
67         if(value==-1)
68             return -2; /* EOF or error */
69         if(value==0xff)
70             return -1; /* error !!, read into next frame */
71         if(value==0xfe) {
72             /* we need to escape */
73             value=file_getc(fh);
74             if(value==-1)
75                 return -2;
76             value+=2;
77         }
78         buf[i]=value;
79     }
80     return i;
81 }
82
83 /* Magic text to check for eyesdn-ness of file */
84 static const unsigned char eyesdn_hdr_magic[]  =
85 { 'E', 'y', 'e', 'S', 'D', 'N'};
86 #define EYESDN_HDR_MAGIC_SIZE  (sizeof(eyesdn_hdr_magic)  / sizeof(eyesdn_hdr_magic[0]))
87
88 /* Size of a record header */
89 #define EYESDN_HDR_LENGTH               12
90
91 /*
92  * XXX - is this the biggest packet we can get?
93  */
94 #define EYESDN_MAX_PACKET_LEN   16384
95
96 static gboolean eyesdn_read(wtap *wth, int *err, gchar **err_info,
97         long *data_offset);
98 static gboolean eyesdn_seek_read(wtap *wth, long seek_off,
99         union wtap_pseudo_header *pseudo_header, guint8 *pd, int len,
100         int *err, gchar **err_info);
101 static gboolean parse_eyesdn_packet_data(FILE_T fh, int pkt_len, guint8* buf,
102         int *err, gchar **err_info);
103 static int parse_eyesdn_rec_hdr(wtap *wth, FILE_T fh,
104         union wtap_pseudo_header *pseudo_header, int *err, gchar **err_info);
105
106 /* Seeks to the beginning of the next packet, and returns the
107    byte offset.  Returns -1 on failure, and sets "*err" to the error. */
108 static long eyesdn_seek_next_packet(wtap *wth, int *err)
109 {
110   int byte;
111   long cur_off;
112
113   while ((byte = file_getc(wth->fh)) != EOF) {
114     if (byte == 0xff) {
115         cur_off = file_tell(wth->fh);
116         if (cur_off == -1) {
117           /* Error. */
118           *err = file_error(wth->fh);
119           return -1;
120         }
121         return cur_off;
122       }
123   }
124   if (file_eof(wth->fh)) {
125     /* We got an EOF. */
126     *err = 0;
127   } else {
128     /* We (presumably) got an error (there's no equivalent to "ferror()"
129        in zlib, alas, so we don't have a wrapper to check for an error). */
130     *err = file_error(wth->fh);
131   }
132   return -1;
133 }
134
135 int eyesdn_open(wtap *wth, int *err, gchar **err_info _U_)
136 {
137         int     bytes_read;
138         char    magic[EYESDN_HDR_MAGIC_SIZE];
139
140         /* Look for eyesdn header */
141         errno = WTAP_ERR_CANT_READ;
142         bytes_read = file_read(&magic, 1, sizeof magic, wth->fh);
143         if (bytes_read != sizeof magic) {
144                 *err = file_error(wth->fh);
145                 if (*err != 0)
146                         return -1;
147                 return 0;
148         }
149         if (memcmp(magic, eyesdn_hdr_magic, EYESDN_HDR_MAGIC_SIZE) != 0)
150                 return 0;
151
152         wth->data_offset = 0;
153         wth->file_encap = WTAP_ENCAP_ISDN;
154         wth->file_type = WTAP_FILE_EYESDN;
155         wth->snapshot_length = 0; /* not known */
156         wth->subtype_read = eyesdn_read;
157         wth->subtype_seek_read = eyesdn_seek_read;
158         wth->tsprecision = WTAP_FILE_TSPREC_USEC;
159
160         return 1;
161 }
162
163 /* Find the next packet and parse it; called from wtap_read(). */
164 static gboolean eyesdn_read(wtap *wth, int *err, gchar **err_info,
165     long *data_offset)
166 {
167         long    offset;
168         guint8  *buf;
169         int     pkt_len;
170
171         /* Find the next packet */
172         offset = eyesdn_seek_next_packet(wth, err);
173         if (offset < 1)
174                 return FALSE;
175
176         /* Parse the header */
177         pkt_len = parse_eyesdn_rec_hdr(wth, wth->fh, &wth->pseudo_header, err,
178             err_info);
179         if (pkt_len == -1)
180                 return FALSE;
181
182         /* Make sure we have enough room for the packet */
183         buffer_assure_space(wth->frame_buffer, EYESDN_MAX_PACKET_LEN);
184         buf = buffer_start_ptr(wth->frame_buffer);
185
186         /* Read the packet data */
187         if (!parse_eyesdn_packet_data(wth->fh, pkt_len, buf, err, err_info))
188                 return FALSE;
189
190         wth->data_offset = offset;
191         *data_offset = offset;
192         return TRUE;
193 }
194
195 /* Used to read packets in random-access fashion */
196 static gboolean
197 eyesdn_seek_read (wtap *wth, long seek_off,
198         union wtap_pseudo_header *pseudo_header, guint8 *pd, int len,
199         int *err, gchar **err_info)
200 {
201         int     pkt_len;
202
203         if (file_seek(wth->random_fh, seek_off, SEEK_SET, err) == -1)
204                 return FALSE;
205
206         pkt_len = parse_eyesdn_rec_hdr(NULL, wth->random_fh, pseudo_header,
207             err, err_info);
208
209         if (pkt_len != len) {
210                 if (pkt_len != -1) {
211                         *err = WTAP_ERR_BAD_RECORD;
212                         *err_info = g_strdup_printf("eyesdn: requested length %d doesn't match length %d",
213                             len, pkt_len);
214                 }
215                 return FALSE;
216         }
217
218         return parse_eyesdn_packet_data(wth->random_fh, pkt_len, pd, err,
219             err_info);
220 }
221
222 /* Parses a packet record header. */
223 static int
224 parse_eyesdn_rec_hdr(wtap *wth, FILE_T fh,
225     union wtap_pseudo_header *pseudo_header, int *err, gchar **err_info)
226 {
227         guint8          hdr[EYESDN_HDR_LENGTH];
228         unsigned long   secs, usecs;
229         int             pkt_len;
230         unsigned int    channel, direction;
231
232         /* Our file pointer should be at the summary information header
233          * for a packet. Read in that header and extract the useful
234          * information.
235          */
236         if (esc_read(hdr, EYESDN_HDR_LENGTH, fh) != EYESDN_HDR_LENGTH) {
237                 *err = file_error(fh);
238                 if (*err == 0)
239                         *err = WTAP_ERR_SHORT_READ;
240                 return -1;
241         }
242     
243         /* extract information from header */
244         usecs = ((unsigned long) hdr[0]);
245         usecs = (usecs << 8) | ((unsigned long) hdr[1]);
246         usecs = (usecs << 8) | ((unsigned long) hdr[2]);
247 #ifdef TV64BITS    
248         secs = ((unsigned long) hdr[3]);
249 #else    
250         secs = 0;
251 #endif    
252         secs = (secs << 8) | ((unsigned long) hdr[4]);
253         secs = (secs << 8) | ((unsigned long) hdr[5]);
254         secs = (secs << 8) | ((unsigned long) hdr[6]);
255         secs = (secs << 8) | ((unsigned long) hdr[7]);
256
257         channel = hdr[8];
258         direction = hdr[9];
259         pkt_len = ((unsigned long) hdr[10]);
260         pkt_len = (pkt_len << 8) | ((unsigned long) hdr[11]);
261
262         /* sanity checks */
263         if((channel>30)&&(channel!=129)) {
264             *err = WTAP_ERR_BAD_RECORD;
265             *err_info = g_strdup_printf("eyesdn: bad channel number %u",
266                 channel);
267             return -1;
268         }
269
270         if(direction>1) {
271             *err = WTAP_ERR_BAD_RECORD;
272             *err_info = g_strdup_printf("eyesdn: bad direction value %u",
273                 direction);
274             return -1;
275         }
276         if(pkt_len > EYESDN_MAX_PACKET_LEN) {
277             *err = WTAP_ERR_BAD_RECORD;
278             *err_info = g_strdup_printf("eyesdn: File has %u-byte packet, bigger than maximum of %u",
279                 pkt_len, EYESDN_MAX_PACKET_LEN);
280             return -1;
281         }
282
283         if (wth) {
284                 wth->phdr.ts.secs = secs;
285                 wth->phdr.ts.nsecs = usecs * 1000;
286                 wth->phdr.caplen = pkt_len;
287                 wth->phdr.len = pkt_len;
288         }
289         pseudo_header->isdn.uton = direction;
290         pseudo_header->isdn.channel = channel;
291
292         return pkt_len;
293 }
294
295 /* read a packet */
296 static gboolean
297 parse_eyesdn_packet_data(FILE_T fh, int pkt_len, guint8* buf, int *err,
298     gchar **err_info)
299 {
300         int bytes_read;
301
302         errno = WTAP_ERR_CANT_READ;
303         bytes_read = esc_read(buf, pkt_len, fh);
304         if (bytes_read != pkt_len) {
305             if (bytes_read == -2) {
306                 *err = file_error(fh);
307                 if (*err == 0)
308                     *err = WTAP_ERR_SHORT_READ;
309             }  else if (bytes_read == -1) {
310                 *err = WTAP_ERR_BAD_RECORD;
311                 *err_info = g_strdup("eyesdn: No flag character seen in frame");
312             } else
313                 *err = WTAP_ERR_SHORT_READ;
314             return FALSE;
315         }
316         return TRUE;
317 }