as mentioned by Graham Bloice:
[obnox/wireshark/wip.git] / capture_wpcap_packet.c
1 /* capture_wpcap_packet.c
2  * WinPcap-specific interfaces for low-level information (packet.dll).  
3  * We load WinPcap at run
4  * time, so that we only need one Wireshark binary and one TShark binary
5  * for Windows, regardless of whether WinPcap is installed or not.
6  *
7  * $Id$
8  *
9  * Wireshark - Network traffic analyzer
10  * By Gerald Combs <gerald@wireshark.org>
11  * Copyright 2001 Gerald Combs
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software
25  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
26  */
27
28 #ifdef HAVE_CONFIG_H
29 # include "config.h"
30 #endif
31
32 #if defined HAVE_LIBPCAP && defined _WIN32
33
34 #include <glib.h>
35 #include <gmodule.h>
36
37 #include <wtap.h>
38 #include <pcap.h>
39
40 /* XXX - yes, I know, I should move cppmagic.h to a generic location. */
41 #include "tools/lemon/cppmagic.h"
42
43 #include <epan/value_string.h>
44
45
46
47 #ifndef HAVE_SOCKADDR_STORAGE
48 /* packet32.h requires sockaddr_storage (usually defined in Platform SDK)
49  * copied from RFC2553 (and slightly modified because of datatypes) ...
50  * XXX - defined more than once, move this to a header file */
51 typedef unsigned short eth_sa_family_t;
52
53 /*
54  * Desired design of maximum size and alignment
55  */
56 #define ETH_SS_MAXSIZE    128  /* Implementation specific max size */
57 #define ETH_SS_ALIGNSIZE  (sizeof (gint64 /*int64_t*/))
58                          /* Implementation specific desired alignment */
59 /*
60  * Definitions used for sockaddr_storage structure paddings design.
61  */
62 #define ETH_SS_PAD1SIZE   (ETH_SS_ALIGNSIZE - sizeof (eth_sa_family_t))
63 #define ETH_SS_PAD2SIZE   (ETH_SS_MAXSIZE - (sizeof (eth_sa_family_t) + \
64                               ETH_SS_PAD1SIZE + ETH_SS_ALIGNSIZE))
65
66 /* sockaddr_storage seems to depend if a Platform SDK is installed,
67    (or to be more precise, if WINSOCK2 is available)
68    and not on the MSVC version installed */
69 #if defined _WIN32 && !defined _WINSOCK2API_
70 struct sockaddr_storage {
71     eth_sa_family_t  __ss_family;     /* address family */
72     /* Following fields are implementation specific */
73     char      __ss_pad1[ETH_SS_PAD1SIZE];
74               /* 6 byte pad, this is to make implementation */
75               /* specific pad up to alignment field that */
76               /* follows explicit in the data structure */
77     gint64 /*int64_t*/   __ss_align;     /* field to force desired structure */
78                /* storage alignment */
79     char      __ss_pad2[ETH_SS_PAD2SIZE];
80               /* 112 byte pad to achieve desired size, */
81               /* _SS_MAXSIZE value minus size of ss_family */
82               /* __ss_pad1, __ss_align fields is 112 */
83 };
84 /* ... copied from RFC2553 */
85 #endif /* _WIN32 */
86 #endif /* HAVE_SOCKADDR_STORAGE */
87
88
89 #include <Packet32.h>
90 #include <windows.h>
91 #include <windowsx.h>
92 #include <Ntddndis.h>
93
94 #include "capture_wpcap_packet.h"
95
96 gboolean has_wpacket = FALSE;
97
98
99 /* This module will use the PacketRequest function in packet.dll (coming with WinPcap) to "directly" access 
100  * the Win32 NDIS network driver(s) and ask for various values (status, statistics, ...).
101  *
102  * Unfortunately, the definitions required for this are not available through the usual windows header files, 
103  * but require the Windows "Device Driver Kit" which is not available for free :-( 
104  *
105  * Fortunately, the definitions needed to access the various NDIS values are available from various OSS projects:
106  * - WinPcap in Ntddndis.h
107  * - Ndiswrapper in driver/ndis.h and driver/iw_ndis.h
108  * - cygwin (MingW?) in usr/include/w32api/ddk/ndis.h and ntddndis.h
109  * - FreeBSD (netperf)
110  */
111
112 /* The MSDN description of the NDIS driver API is available at:
113 /* MSDN Home >  MSDN Library >  Win32 and COM Development >  Driver Development Kit >  Network Devices and Protocols >  Reference */
114 /* "NDIS Objects" */
115 /* http://msdn.microsoft.com/library/default.asp?url=/library/en-us/network/hh/network/21oidovw_d55042e5-0b8a-4439-8ef2-be7331e98464.xml.asp */
116
117 /* Some more interesting links:
118  * http://sourceforge.net/projects/ndiswrapper/
119  * http://www.osronline.com/lists_archive/windbg/thread521.html
120  * http://cvs.sourceforge.net/viewcvs.py/mingw/w32api/include/ddk/ndis.h?view=markup
121  * http://cvs.sourceforge.net/viewcvs.py/mingw/w32api/include/ddk/ntddndis.h?view=markup
122  */
123
124
125
126 /******************************************************************************************************************************/
127 /* stuff to load WinPcap's packet.dll and the functions required from it */
128
129 static PCHAR     (*p_PacketGetVersion) (void);
130 static LPADAPTER (*p_PacketOpenAdapter) (char *adaptername);
131 static void      (*p_PacketCloseAdapter) (LPADAPTER);
132 static int       (*p_PacketRequest) (LPADAPTER, int, void *);
133
134 typedef struct {
135         const char      *name;
136         gpointer        *ptr;
137         gboolean        optional;
138 } symbol_table_t;
139
140 #define SYM(x, y)       { STRINGIFY(x) , (gpointer) &CONCAT(p_,x), y }
141
142 void
143 wpcap_packet_load(void)
144 {
145
146         /* These are the symbols I need or want from packet.dll */
147         static const symbol_table_t     symbols[] = {
148                 SYM(PacketGetVersion, FALSE),
149                 SYM(PacketOpenAdapter, FALSE),
150                 SYM(PacketCloseAdapter, FALSE),
151                 SYM(PacketRequest, FALSE),
152                 { NULL, NULL, FALSE }
153         };
154
155         GModule         *wh; /* wpcap handle */
156         const symbol_table_t    *sym;
157
158         wh = g_module_open("packet", 0);
159
160         if (!wh) {
161                 return;
162         }
163
164         sym = symbols;
165         while (sym->name) {
166                 if (!g_module_symbol(wh, sym->name, sym->ptr)) {
167                         if (sym->optional) {
168                                 /*
169                                  * We don't care if it's missing; we just
170                                  * don't use it.
171                                  */
172                                 *sym->ptr = NULL;
173                         } else {
174                                 /*
175                                  * We require this symbol.
176                                  */
177                                 return;
178                         }
179                 }
180                 sym++;
181         }
182
183         has_wpacket = TRUE;
184 }
185
186
187
188 /******************************************************************************************************************************/
189 /* functions to access the NDIS driver values */
190
191
192 /* get dll version */
193 char *
194 wpcap_packet_get_version(void)
195 {
196     if(!has_wpacket) {
197         return NULL;
198     }
199     return p_PacketGetVersion();
200 }
201
202
203 /* open the interface */
204 void *
205 wpcap_packet_open(char *if_name)
206 {
207     LPADAPTER   adapter;
208
209         g_assert(has_wpacket);
210     adapter = p_PacketOpenAdapter(if_name);
211
212     return adapter;
213 }
214
215
216 /* close the interface */
217 void
218 wpcap_packet_close(void *adapter)
219 {
220
221         g_assert(has_wpacket);
222     p_PacketCloseAdapter(adapter);
223 }
224
225
226 /* do a packet request call */
227 int 
228 wpcap_packet_request(void *adapter, ULONG Oid, int set, char *value, unsigned int *length)
229 {
230     BOOLEAN    Status;
231     ULONG      IoCtlBufferLength=(sizeof(PACKET_OID_DATA) + (*length) - 1);
232     PPACKET_OID_DATA  OidData;
233
234
235         g_assert(has_wpacket);
236
237     if(p_PacketRequest == NULL) {
238         g_warning("packet_request not available\n");
239         return 0;
240     }
241
242         /* get a buffer suitable for PacketRequest() */
243     OidData=GlobalAllocPtr(GMEM_MOVEABLE | GMEM_ZEROINIT,IoCtlBufferLength);
244     if (OidData == NULL) {
245         g_warning("GlobalAllocPtr failed for %u\n", IoCtlBufferLength);
246         return 0;
247     }
248
249     OidData->Oid = Oid;
250     OidData->Length = *length;
251     memcpy(OidData->Data, value, *length);
252
253     Status = p_PacketRequest(adapter, set, OidData);
254
255     if(Status) {
256                 if(OidData->Length <= *length) {
257                         /* copy value from driver */
258                         memcpy(value, OidData->Data, OidData->Length);
259                         *length = OidData->Length;
260                 } else {
261                         /* the driver returned a value that is longer than expected (and longer than the given buffer) */
262                         g_warning("returned oid too long, Oid: 0x%x OidLen:%u MaxLen:%u", Oid, OidData->Length, *length);
263                         Status = FALSE;
264                 }
265     }
266
267     GlobalFreePtr (OidData);
268
269     if(Status) {
270         return 1;
271     } else {
272         return 0;
273     }
274 }
275
276
277 /* get an UINT value using the packet request call */
278 int
279 wpcap_packet_request_uint(void *adapter, ULONG Oid, UINT *value)
280 {
281     BOOLEAN     Status;
282     int         length = sizeof(UINT);
283
284
285     Status = wpcap_packet_request(adapter, Oid, FALSE /* !set */, (char *) value, &length);
286     if(Status && length == sizeof(UINT)) {
287         return 1;
288     } else {
289         return 0;
290     }
291 }
292
293
294 /* get an ULONG value using the NDIS packet request call */
295 int
296 wpcap_packet_request_ulong(void *adapter, ULONG Oid, ULONG *value)
297 {
298     BOOLEAN     Status;
299     int         length = sizeof(ULONG);
300
301
302     Status = wpcap_packet_request(adapter, Oid, FALSE /* !set */, (char *) value, &length);
303     if(Status && length == sizeof(ULONG)) {
304         return 1;
305     } else {
306         return 0;
307     }
308 }
309
310
311 #else /* HAVE_LIBPCAP && _WIN32 */
312
313 void
314 wpcap_packet_load(void)
315 {
316         return;
317 }
318
319 #endif /* HAVE_LIBPCAP */