Prepare to move the airpdcap code to epan/crypt (SVN won't let me actually
[obnox/wireshark/wip.git] / airpcap_loader.h
1 /* airpcap_loader.h
2  * Declarations of routines for the "About" dialog
3  *
4  * $Id$
5  *
6  * Giorgio Tino <giorgio.tino@cacetech.com>
7  * Copyright (c) CACE Technologies, LLC 2006
8  *
9  * Wireshark - Network traffic analyzer
10  * By Gerald Combs <gerald@wireshark.org>
11  * Copyright 1998 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 #ifndef __AIRPCAP_LOADER_H__
29 #define __AIRPCAP_LOADER_H__
30
31 /* Error values from "get_airpcap_interface_list()". */
32 #define CANT_GET_AIRPCAP_INTERFACE_LIST 0       /* error getting list */
33 #define NO_AIRPCAP_INTERFACES_FOUND     1       /* list is empty */
34
35 #define AIRPCAP_CHANNEL_ANY_NAME "ANY"
36
37 #define AIRPCAP_WEP_KEY_STRING  "WEP"
38 /*
39  * XXX - WPA_PWD is the passphrase+ssid and WPA-PSK is the hexadecimal key
40  */
41 #define AIRPCAP_WPA_PWD_KEY_STRING  "WPA-PWD"
42 #define AIRPCAP_WPA_BIN_KEY_STRING  "WPA-PSK"
43
44 #define AIRPCAP_DLL_OK                  0
45 #define AIRPCAP_DLL_OLD                 1
46 #define AIRPCAP_DLL_ERROR               2
47 #define AIRPCAP_DLL_NOT_FOUND   3
48
49 typedef PCHAR (*AirpcapGetLastErrorHandler)(PAirpcapHandle AdapterHandle);
50 typedef BOOL (*AirpcapGetDeviceListHandler)(PAirpcapDeviceDescription *PPAllDevs, PCHAR Ebuf);
51 typedef VOID (*AirpcapFreeDeviceListHandler)(PAirpcapDeviceDescription PAllDevs);
52 typedef PAirpcapHandle (*AirpcapOpenHandler)(PCHAR DeviceName, PCHAR Ebuf);
53 typedef VOID (*AirpcapCloseHandler)(PAirpcapHandle AdapterHandle);
54 typedef BOOL (*AirpcapGetLinkTypeHandler)(PAirpcapHandle AdapterHandle, PAirpcapLinkType PLinkType);
55 typedef BOOL (*AirpcapSetLinkTypeHandler)(PAirpcapHandle AdapterHandle, AirpcapLinkType NewLinkType);
56 typedef BOOL (*AirpcapSetKernelBufferHandler)(PAirpcapHandle AdapterHandle, UINT BufferSize);
57 typedef BOOL (*AirpcapSetFilterHandler)(PAirpcapHandle AdapterHandle, PVOID Instructions, UINT Len);
58 typedef BOOL (*AirpcapGetMacAddressHandler)(PAirpcapHandle AdapterHandle, PAirpcapMacAddress PMacAddress);
59 typedef BOOL (*AirpcapSetMinToCopyHandler)(PAirpcapHandle AdapterHandle, UINT MinToCopy);
60 typedef BOOL (*AirpcapGetReadEventHandler)(PAirpcapHandle AdapterHandle, HANDLE* PReadEvent);
61 typedef BOOL (*AirpcapReadHandler)(PAirpcapHandle AdapterHandle, PBYTE Buffer, UINT BufSize, PUINT PReceievedBytes);
62 typedef BOOL (*AirpcapGetStatsHandler)(PAirpcapHandle AdapterHandle, PAirpcapStats PStats);
63 typedef BOOL (*AirpcapTurnLedOnHandler)(PAirpcapHandle  AdapterHandle, UINT  LedNumber);
64 typedef BOOL (*AirpcapTurnLedOffHandler)(PAirpcapHandle  AdapterHandle, UINT  LedNumber);
65 typedef BOOL (*AirpcapSetDeviceChannelHandler)(PAirpcapHandle  AdapterHandle, UINT  Channel);
66 typedef BOOL (*AirpcapGetDeviceChannelHandler)(PAirpcapHandle  AdapterHandle, PUINT PChannel);
67 typedef BOOL (*AirpcapSetFcsPresenceHandler)(PAirpcapHandle  AdapterHandle, BOOL  IsFcsPresent);
68 typedef BOOL (*AirpcapGetFcsPresenceHandler)(PAirpcapHandle  AdapterHandle, PBOOL PIsFcsPresent);
69 typedef BOOL (*AirpcapSetFcsValidationHandler)(PAirpcapHandle  AdapterHandle, AirpcapValidationType ValidationType);
70 typedef BOOL (*AirpcapGetFcsValidationHandler)(PAirpcapHandle  AdapterHandle, PAirpcapValidationType PValidationType);
71 typedef BOOL (*AirpcapSetDeviceKeysHandler)(PAirpcapHandle AdapterHandle, PAirpcapKeysCollection KeysCollection);
72 typedef BOOL (*AirpcapGetDeviceKeysHandler)(PAirpcapHandle AdapterHandle, PAirpcapKeysCollection KeysCollection, PUINT PKeysCollectionSize);
73 typedef BOOL (*AirpcapSetDriverKeysHandler)(PAirpcapHandle AdapterHandle, PAirpcapKeysCollection KeysCollection);
74 typedef BOOL (*AirpcapGetDriverKeysHandler)(PAirpcapHandle AdapterHandle, PAirpcapKeysCollection KeysCollection, PUINT PKeysCollectionSize);
75 typedef BOOL (*AirpcapSetDecryptionStateHandler)(PAirpcapHandle AdapterHandle, AirpcapDecryptionState Enable);
76 typedef BOOL (*AirpcapGetDecryptionStateHandler)(PAirpcapHandle AdapterHandle, PAirpcapDecryptionState PEnable);
77 typedef BOOL (*AirpcapSetDriverDecryptionStateHandler)(PAirpcapHandle AdapterHandle, AirpcapDecryptionState Enable);
78 typedef BOOL (*AirpcapGetDriverDecryptionStateHandler)(PAirpcapHandle AdapterHandle, PAirpcapDecryptionState PEnable);
79 typedef BOOL (*AirpcapStoreCurConfigAsAdapterDefaultHandler)(PAirpcapHandle AdapterHandle);
80 typedef VOID (*AirpcapGetVersionHandler)(PUINT VersionMajor, PUINT VersionMinor, PUINT VersionRev, PUINT VersionBuild);
81
82 /*
83  * The list of interfaces returned by "get_airpcap_interface_list()" is
84  * a list of these structures.
85  */
86 typedef struct {
87         char                                    *name;                          /* e.g. "eth0" */
88         char                                    *description;           /* from OS, e.g. "Local Area Connection" or NULL */
89         GSList                                  *ip_addr;                       /* containing address values of if_addr_t */
90         gboolean                                loopback;                       /* TRUE if loopback, FALSE otherwise */
91         AirpcapLinkType                 linkType;                       /* The link layer type*/
92         UINT                                    channel;                        /* Channel (1-14)*/
93         BOOL                                    IsFcsPresent;           /* Include 802.11 CRC in frames */
94         AirpcapValidationType   CrcValidationOn;        /* Capture Frames with Wrong CRC */
95         AirpcapDecryptionState  DecryptionOn;           /* TRUE if decryption is on, FALSE otherwise*/
96         PAirpcapKeysCollection  keysCollection;         /* WEP Key collection for the adapter */
97         UINT                                    keysCollectionSize;     /* Size of the key collection */
98         gboolean                                blinking;                       /* TRUE if is blinkng, FALSE otherwise*/
99         gboolean                                led;                            /* TRUE if on, FALSE if off*/
100         gboolean                                saved;                          /* TRUE if current configuration has been saved, FALSE otherwise */
101         gint                                    tag;                            /* int for the gtk blinking callback */
102 } airpcap_if_info_t;
103
104 /*
105  * Struct used to store infos to pass to the preferences manager callbacks
106  */
107 typedef struct {
108    GList *list;
109    int current_index;
110    int number_of_keys;
111 } keys_cb_data_t;
112
113 /* Airpcap interface list */
114 extern GList *airpcap_if_list;
115
116 /* Airpcap current selected interface */
117 extern airpcap_if_info_t *airpcap_if_selected;
118
119 /* Airpcap current active interface */
120 extern airpcap_if_info_t *airpcap_if_active;
121
122 /* WLAN preferences pointer */
123 //extern module_t *wlan_prefs;
124
125 /*
126  * Function used to read the Decryption Keys from the preferences and store them
127  * properly into the airpcap adapter.
128  */
129 BOOL
130 load_wlan_driver_wep_keys();
131
132 /*
133  *  Function used to save to the prefereces file the Decryption Keys.
134  */
135 BOOL
136 save_wlan_wep_keys(airpcap_if_info_t* info_if);
137
138 /*
139  * This function will tell the airpcap driver the key list to use
140  * This will be stored into the registry...
141  */
142 gboolean
143 write_wlan_wep_keys_to_regitry(airpcap_if_info_t* info_if, GList* key_list);
144
145 /* Returs TRUE if the WEP key is valid, false otherwise */
146 gboolean
147 wep_key_is_valid(char* key);
148
149 /*
150  * Callback used to free an instance of airpcap_if_info_t
151  */
152 static void
153 free_airpcap_if_cb(gpointer data, gpointer user_data _U_);
154
155 /*
156  * USED FOR DEBUG ONLY... PRINTS AN AirPcap ADAPTER STRUCTURE in a fancy way.
157  */
158 void
159 airpcap_if_info_print(airpcap_if_info_t* if_info);
160
161 /*
162  * Used to retrieve the two chars string from interface
163  */
164 gchar*
165 airpcap_get_if_string_number_from_description(gchar* description);
166
167 /*
168  * Function used to free the airpcap interface list
169  */
170 void
171 free_airpcap_interface_list(GList *if_list);
172
173 /*
174  * Used to retrieve the interface given the name
175  * (the name is used in AirpcapOpen)
176  */
177 airpcap_if_info_t* get_airpcap_if_by_name(GList* if_list, const gchar* name);
178
179 /*
180  * Airpcap wrapper, used to store the current settings for the selected adapter
181  */
182 BOOL
183 airpcap_if_store_cur_config_as_adapter_default(PAirpcapHandle ah);
184
185 /*
186  * Function used to load the WEP keys for a selected interface
187  */
188 BOOL
189 airpcap_if_load_keys(PAirpcapHandle ad, airpcap_if_info_t *if_info);
190
191 /*
192  * Function used to load the WEP keys from the global driver list
193  */
194 BOOL
195 airpcap_if_load_driver_keys(PAirpcapHandle ad, airpcap_if_info_t *if_info);
196
197 /*
198  * Function used to save the WEP keys for a selected interface
199  */
200 void
201 airpcap_if_save_keys(PAirpcapHandle ad, airpcap_if_info_t *if_info);
202
203 /*
204  * Function used to save the WEP keys for a selected interface
205  */
206 void
207 airpcap_if_save_driver_keys(PAirpcapHandle ad, airpcap_if_info_t *if_info);
208
209 /*
210  * Airpcap wrapper, used to get the fcs validation of an airpcap adapter
211  */
212 BOOL
213 airpcap_if_get_fcs_validation(PAirpcapHandle ah, PAirpcapValidationType val);
214
215 /*
216  * Airpcap wrapper, used to set the fcs validation of an airpcap adapter
217  */
218 BOOL
219 airpcap_if_set_fcs_validation(PAirpcapHandle ah, AirpcapValidationType val);
220
221 /*
222  * Airpcap wrapper, used to get the decryption enabling of an airpcap adapter
223  */
224 BOOL
225 airpcap_if_get_decryption_state(PAirpcapHandle ah, PAirpcapDecryptionState val);
226
227 /*
228  * Airpcap wrapper, used to set the decryption enabling of an airpcap adapter
229  */
230 BOOL
231 airpcap_if_set_decryption_state(PAirpcapHandle ah, AirpcapDecryptionState val);
232
233 /*
234  * Airpcap wrapper, used to get the fcs presence of an airpcap adapter
235  */
236 BOOL
237 airpcap_if_get_fcs_presence(PAirpcapHandle ah, PBOOL ch);
238
239 /*
240  * Airpcap wrapper, used to set the fcs presence of an airpcap adapter
241  */
242 BOOL
243 airpcap_if_set_fcs_presence(PAirpcapHandle ah, BOOL ch);
244
245 /*
246  * Airpcap wrapper, used to get the link type of an airpcap adapter
247  */
248 BOOL
249 airpcap_if_get_link_type(PAirpcapHandle ah, PAirpcapLinkType lt);
250
251 /*
252  * Airpcap wrapper, used to set the link type of an airpcap adapter
253  */
254 BOOL
255 airpcap_if_set_link_type(PAirpcapHandle ah, AirpcapLinkType lt);
256
257 /*
258  * Airpcap wrapper, used to get the channel of an airpcap adapter
259  */
260 BOOL
261 airpcap_if_get_device_channel(PAirpcapHandle ah, PUINT ch);
262
263 /*
264  * Airpcap wrapper, used to set the channel of an airpcap adapter
265  */
266 BOOL
267 airpcap_if_set_device_channel(PAirpcapHandle ah, UINT ch);
268
269 /*
270  * Airpcap wrapper, used to open an airpcap adapter
271  */
272 PAirpcapHandle airpcap_if_open(PCHAR name, PCHAR err);
273
274 /*
275  * Airpcap wrapper, used to close an airpcap adapter
276  */
277 VOID airpcap_if_close(PAirpcapHandle handle);
278
279 /*
280  * Airpcap wrapper, used to turn on the led of an airpcap adapter
281  */
282 BOOL airpcap_if_turn_led_on(PAirpcapHandle AdapterHandle, UINT LedNumber);
283
284 /*
285  * Airpcap wrapper, used to turn off the led of an airpcap adapter
286  */
287 BOOL airpcap_if_turn_led_off(PAirpcapHandle AdapterHandle, UINT LedNumber);
288
289 /*
290  * This function will create a new airpcap_if_info_t using a name and a description
291  */
292 airpcap_if_info_t* airpcap_if_info_new(char *name, char *description);
293
294 /*
295  * This function will create a new fake drivers' interface, to load global keys...
296  */
297 airpcap_if_info_t* airpcap_driver_fake_if_info_new();
298
299 /*
300  *  Used to dinamically load the airpcap library in order link it only when
301  *  it's present on the system.
302  */
303 int load_airpcap(void);
304
305 /*
306  * Get an error message string for a CANT_GET_INTERFACE_LIST error from
307  * "get_airpcap_interface_list()".
308  */
309 gchar*
310 cant_get_airpcap_if_list_error_message(const char *err_str);
311
312 /*
313  * This function will use the airpcap.dll to find all the airpcap devices.
314  * Will return null if no device is found.
315  */
316 GList*
317 get_airpcap_interface_list(int *err, char *err_str);
318
319 /*
320  * Returns the ASCII string of a key given the key bites
321  */
322 gchar*
323 airpcap_get_key_string(AirpcapKey key);
324
325 /*
326  * Load the configuration for the specified interface
327  */
328 void
329 airpcap_load_selected_if_configuration(airpcap_if_info_t* if_info);
330
331 /*
332  * Save the configuration for the specified interface
333  */
334 void
335 airpcap_save_selected_if_configuration(airpcap_if_info_t* if_info);
336
337 /*
338  * Used to retrieve the name of the interface given the description
339  * (the name is used in AirpcapOpen, the description is put in the combo box)
340  */
341 gchar*
342 get_airpcap_name_from_description(GList* if_list, gchar* description);
343
344 /*
345  * Used to retrieve the airpcap_if_info_t of the selected interface given the
346  * description (that is the entry of the combo box).
347  */
348 gpointer
349 get_airpcap_if_from_description(GList* if_list, const gchar* description);
350
351 /*
352  * Used to retrieve the two chars string from interface description
353  */
354 gchar*
355 airpcap_get_if_string_number(airpcap_if_info_t* if_info);
356
357 /*
358  * Returns the default airpcap interface of a list, NULL if list is empty
359  */
360 airpcap_if_info_t*
361 airpcap_get_default_if(GList* airpcap_if_list);
362
363 /*
364  * Airpcap wrapper, used to save the settings for the selected_if
365  */
366 BOOL
367 airpcap_if_set_device_keys(PAirpcapHandle AdapterHandle, PAirpcapKeysCollection KeysCollection);
368
369 /*
370  * Airpcap wrapper, used to save the settings for the selected_if
371  */
372 BOOL
373 airpcap_if_get_device_keys(PAirpcapHandle AdapterHandle, PAirpcapKeysCollection KeysCollection, PUINT PKeysCollectionSize);
374
375 /*
376  * Airpcap wrapper, used to save the settings for the selected_if
377  */
378 BOOL
379 airpcap_if_set_driver_keys(PAirpcapHandle AdapterHandle, PAirpcapKeysCollection KeysCollection);
380
381 /*
382  * Airpcap wrapper, used to save the settings for the selected_if
383  */
384 BOOL
385 airpcap_if_get_driver_keys(PAirpcapHandle AdapterHandle, PAirpcapKeysCollection KeysCollection, PUINT PKeysCollectionSize);
386
387 /*
388  * Airpcap wrapper, used to get the decryption enabling of an airpcap driver
389  */
390 BOOL
391 airpcap_if_get_driver_decryption_state(PAirpcapHandle ah, PAirpcapDecryptionState PEnable);
392 /*
393  * Airpcap wrapper, used to set the decryption enabling of an airpcap driver
394  */
395 BOOL
396 airpcap_if_set_driver_decryption_state(PAirpcapHandle ah, AirpcapDecryptionState Enable);
397
398 /*
399  * Save the configuration for the specified interface
400  */
401 void
402 airpcap_save_driver_if_configuration(airpcap_if_info_t* fake_if_info);
403
404 /*
405  * Free an instance of airpcap_if_info_t
406  */
407 void
408 airpcap_if_info_free(airpcap_if_info_t *if_info);
409
410 /*
411  * This function will tell the airpcap driver the key list to use
412  * This will be stored into the registry...
413  */
414 BOOL
415 write_wlan_driver_wep_keys_to_regitry(GList* key_list);
416
417 /*
418  * Clear keys and decryption status for the specified interface
419  */
420 void
421 airpcap_if_clear_decryption_settings(airpcap_if_info_t* info_if);
422
423 /*
424  *  Function used to save to the preference file the Decryption Keys.
425  */
426 int
427 save_wlan_driver_wep_keys();
428
429 /*
430  *  Function used to save to the preference file the Decryption Keys.
431  */
432 int
433 save_wlan_wireshark_wep_keys(GList* key_ls);
434
435 /*
436  * DECRYPTION KEYS FUNCTIONS
437  */
438 /*
439  * This function is used for DEBUG PURPOSES ONLY!!!
440  */
441 void
442 print_key_list(GList* key_list);
443
444 /*
445  * Retrieves a GList of decryption_key_t structures containing infos about the
446  * keys for the given adapter... returns NULL if no keys are found.
447  */
448 GList*
449 get_airpcap_device_keys(airpcap_if_info_t* if_info);
450
451 /*
452  * Retrieves a GList of decryption_key_t structures containing infos about the
453  * keys for the global AirPcap driver... returns NULL if no keys are found.
454  */
455 GList*
456 get_airpcap_driver_keys();
457
458 /*
459  * Returns the list of the decryption keys specified for wireshark, NULL if
460  * no key is found
461  */
462 GList*
463 get_wireshark_keys();
464
465 /*
466  * Tests if two collection of keys are equal or not, to be considered equals, they have to
467  * contain the same keys in the SAME ORDER! (If both lists are NULL, which means empty will
468  * return TRUE)
469  */
470 gboolean
471 key_lists_are_equal(GList* list1, GList* list2);
472
473 /*
474  * Merges two lists of keys. If a key is found multiple times, it will just appear once!
475  */
476 GList*
477 merge_key_list(GList* list1, GList* list2);
478
479 /*
480  * If the given key is contained in the list, returns TRUE.
481  * Returns FALSE otherwise.
482  */
483 gboolean
484 key_is_in_list(decryption_key_t *dk,GList *list);
485
486 /*
487  * Returns TRUE if keys are equals, FALSE otherwise
488  */
489 gboolean
490 keys_are_equals(decryption_key_t *k1,decryption_key_t *k2);
491
492 /*
493  * Use this function to free a key list.
494  */
495 void
496 free_key_list(GList *list);
497
498 /*
499  * Returns TRUE if the Wireshark decryption is active, FALSE otherwise
500  */
501 gboolean
502 wireshark_decryption_on();
503
504 /*
505  * Returns TRUE if the AirPcap decryption for the current adapter is active, FALSE otherwise
506  */
507 gboolean
508 airpcap_decryption_on();
509
510 /*
511  * Enables decryption for Wireshark if on_off is TRUE, disables it otherwise.
512  */
513 void
514 set_wireshark_decryption(gboolean on_off);
515
516 /*
517  * Enables decryption for all the adapters if on_off is TRUE, disables it otherwise.
518  */
519 gboolean
520 set_airpcap_decryption(gboolean on_off);
521
522 /*
523  * Adds compiled version string to str
524  */
525 void
526 get_compiled_airpcap_version(GString *str);
527
528 void
529 get_runtime_airpcap_version(GString *str);
530
531 /*
532  * Returns the decryption_key_t struct given a string describing the key.
533  * Returns NULL if the key_string cannot be parsed.
534  */
535 decryption_key_t*
536 parse_key_string(gchar* key_string);
537
538 /*
539  * Returns a newly allocated string representing the given decryption_key_t struct
540  */
541 gchar*
542 get_key_string(decryption_key_t* dk);
543
544 #endif