"wtap_read()" must *always* set "*err" when it returns FALSE - if it's
[obnox/wireshark/wip.git] / wiretap / csids.c
1 /* csids.c
2  *
3  * $Id: csids.c,v 1.5 2000/11/19 03:47:35 guy Exp $
4  *
5  * Copyright (c) 2000 by Mike Hall <mlh@io.com>
6  * Copyright (c) 2000 by Cisco Systems
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 "csids.h"
29 #include "file_wrappers.h"
30
31 #include <stdio.h>
32 #include <stdlib.h>
33 #include <string.h>
34
35 /* 
36  * This module reads the output from the Cisco Secure Intrustion Detection
37  * System iplogging facility. The term iplogging is misleading since this 
38  * logger will only output TCP. There is no link layer information. 
39  * Packet format is 4 byte timestamp (seconds since epoch), and a 4 byte size
40  * of data following for that packet.
41  *
42  * For a time there was an error in iplogging and the ip length, flags, and id
43  * were byteswapped. We will check for this and handle it before handing to ethereal.
44  *
45  */
46
47 static gboolean csids_read(wtap *wth, int *err, int *data_offset);
48 static int csids_seek_read(wtap *wth, int seek_off,
49         union wtap_pseudo_header *pseudo_header, guint8 *pd, int len);
50
51 struct csids_header {
52   guint32 seconds; /* seconds since epoch */
53   guint16 zeropad; /* 2 byte zero'ed pads */
54   guint16 caplen;  /* the capture length  */
55 };
56
57 /* XXX - return -1 on I/O error and actually do something with 'err'. */
58 int csids_open(wtap *wth, int *err)
59 {
60   /* There is no file header. There is only a header for each packet 
61    * so we read a packet header and compare the caplen with iplen. They 
62    * should always be equal except with the wierd byteswap version.
63    * 
64    * THIS IS BROKEN-- anytime the caplen is 0x0101 or 0x0202 up to 0x0505 
65    * this will byteswap it. I need to fix this. XXX --mlh 
66    */
67
68   int tmp,iplen,bytesRead;
69   
70   gboolean byteswap = FALSE;
71   struct csids_header hdr;
72   bytesRead=0;
73
74   file_seek(wth->fh, 0, SEEK_SET); 
75  
76   /* check the file to make sure it is a csids file. */ 
77   bytesRead = file_read( &hdr, 1, sizeof( struct csids_header), wth->fh );
78   if( bytesRead != sizeof( struct csids_header) ) {
79     *err = file_error( wth->fh );
80     if( *err != 0 ) {
81       return -1;
82     } else {
83       return 0;
84     }
85   }
86   if( hdr.zeropad != 0 ) {
87         return 0;
88   }
89   hdr.seconds = pntohl( &hdr.seconds );
90   hdr.caplen = pntohs( &hdr.caplen );
91   bytesRead = file_read( &tmp, 1, 2, wth->fh );
92   if( bytesRead != 2 ) {
93     *err = file_error( wth->fh );
94     if( *err != 0 ) {
95       return -1;
96     } else {
97       return 0;
98     }
99   }
100   bytesRead = file_read( &iplen, 1, 2, wth->fh );
101   if( bytesRead != 2 ) {
102     *err = file_error( wth->fh );
103     if( *err != 0 ) {
104       return -1;
105     } else {
106       return 0;
107     }
108   }
109   iplen = pntohs(&iplen);
110   /* if iplen and hdr.caplen are equal, default to no byteswap. */
111   if( iplen > hdr.caplen ) {
112     /* maybe this is just a byteswapped version. the iplen ipflags */
113     /* and ipid are swapped. We cannot use the normal swaps because */
114     /* we don't know the host */
115     iplen = BSWAP16(iplen);
116     if( iplen <= hdr.caplen ) {
117       /* we know this format */
118       byteswap = TRUE;
119     } else {
120       /* don't know this one */
121       return 0;
122     }
123   } else {
124     byteswap = FALSE;
125   } 
126
127   wth->data_offset = 0; 
128   wth->capture.csids = g_malloc(sizeof(csids_t));
129   wth->capture.csids->byteswapped = byteswap;
130   wth->file_encap = WTAP_ENCAP_RAW_IP; 
131   wth->file_type = WTAP_FILE_CSIDS; 
132   wth->snapshot_length = 16384; /* just guessing */ 
133   wth->subtype_read = csids_read; 
134   wth->subtype_seek_read = csids_seek_read; 
135
136   /* no file header. So reset the fh to 0 so we can read the first packet */
137   file_seek(wth->fh, 0, SEEK_SET); 
138
139   return 1;
140 }
141
142 /* Find the next packet and parse it; called from wtap_loop(). */
143 static gboolean csids_read(wtap *wth, int *err, int *data_offset)
144 {
145   guint8 *buf;
146   int bytesRead = 0;
147   struct csids_header hdr;
148
149   *data_offset = wth->data_offset;
150
151   bytesRead = file_read( &hdr, 1, sizeof( struct csids_header) , wth->fh );
152   if( bytesRead != sizeof( struct csids_header) ) {
153     *err = file_error( wth->fh );
154     if (*err == 0 && bytesRead != 0)
155       *err = WTAP_ERR_SHORT_READ;
156     return FALSE;
157   }
158   hdr.seconds = pntohl(&hdr.seconds);
159   hdr.caplen = pntohs(&hdr.caplen);
160
161   wth->data_offset += sizeof( struct csids_header );
162
163   /* Make sure we have enough room for the packet */
164   buffer_assure_space(wth->frame_buffer, hdr.caplen);
165   buf = buffer_start_ptr(wth->frame_buffer);
166   
167   bytesRead = file_read( buf, 1, hdr.caplen, wth->fh );
168   if( bytesRead != hdr.caplen ) {
169     *err = file_error( wth->fh );
170     if (*err == 0)
171       *err = WTAP_ERR_SHORT_READ;
172     return FALSE;
173   }
174   
175   wth->data_offset += hdr.caplen;
176
177   wth->phdr.len = hdr.caplen;
178   wth->phdr.caplen = hdr.caplen;
179   wth->phdr.ts.tv_sec = hdr.seconds;
180   wth->phdr.ts.tv_usec = 0;
181   wth->phdr.pkt_encap = WTAP_ENCAP_RAW_IP;
182
183   if( wth->capture.csids->byteswapped == TRUE ) {
184     guint16* swap = (guint16*)buf;
185     *(++swap) = BSWAP16(*swap); /* the ip len */
186     *(++swap) = BSWAP16(*swap); /* ip id */
187     *(++swap) = BSWAP16(*swap); /* ip flags and fragoff */
188   }
189
190   return TRUE;
191 }
192
193 /* Used to read packets in random-access fashion */
194 static int
195 csids_seek_read (wtap *wth,
196                  int seek_off,
197                  union wtap_pseudo_header *pseudo_header,
198                  guint8 *pd,
199                  int len)
200 {
201   int err = 0;
202   int bytesRead = 0;
203   struct csids_header hdr;
204
205   file_seek(wth->random_fh, seek_off , SEEK_SET);
206
207   bytesRead = file_read( &hdr, 1, sizeof( struct csids_header) , wth->random_fh );
208   if( bytesRead != sizeof( struct csids_header) ) {
209     err = file_error( wth->fh );
210     if( err != 0 ) {
211       return -1;
212     } else {
213       return 0;
214     }
215   }
216   hdr.seconds = pntohl(&hdr.seconds);
217   hdr.caplen = pntohs(&hdr.caplen);
218   
219   if( len != hdr.caplen ) {
220     return -1;
221   }
222
223   bytesRead = file_read( pd, 1, hdr.caplen, wth->random_fh );
224   if( bytesRead != hdr.caplen ) {
225     err = file_error( wth->fh );
226     if( err != 0 ) {
227       return -1;
228     }       
229   }
230
231   if( wth->capture.csids->byteswapped == TRUE ) {
232     guint16* swap = (guint16*)pd;
233     *(++swap) = BSWAP16(*swap); /* the ip len */
234     *(++swap) = BSWAP16(*swap); /* ip id */
235     *(++swap) = BSWAP16(*swap); /* ip flags and fragoff */
236   }
237   
238   return 0;
239 }
240
241
242