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 /*
  38  * WEP_KEY_MAX_SIZE is in bytes, but each byte is rapresented in strings with an ascii char
  39  * 4 bit are needed to store an exadecimal number, 8 bit to store a char...
  40  */
  41 #define WEP_KEY_MAX_CHAR_SIZE (WEP_KEY_MAX_SIZE*2)
  42
  43 /*
  44  * WEP_KEY_MAX_SIZE is in bytes, this is in bits...
  45  */
  46 #define WEP_KEY_MAX_BIT_SIZE (WEP_KEY_MAX_SIZE*8)
  47
  48 #define AIRPCAP_WEP_KEY_STRING  "WEP"
  49 #define AIRPCAP_WPA_KEY_STRING  "WPA"
  50 #define AIRPCAP_WPA2_KEY_STRING "WPA2"
  51
  52 typedef PCHAR (*AirpcapGetLastErrorHandler)(PAirpcapHandle AdapterHandle);
  53 typedef BOOL (*AirpcapGetDeviceListHandler)(PAirpcapDeviceDescription *PPAllDevs, PCHAR Ebuf);
  54 typedef VOID (*AirpcapFreeDeviceListHandler)(PAirpcapDeviceDescription PAllDevs);
  55 typedef PAirpcapHandle (*AirpcapOpenHandler)(PCHAR DeviceName, PCHAR Ebuf);
  56 typedef VOID (*AirpcapCloseHandler)(PAirpcapHandle AdapterHandle);
  57 typedef BOOL (*AirpcapGetLinkTypeHandler)(PAirpcapHandle AdapterHandle, PAirpcapLinkType PLinkType);
  58 typedef BOOL (*AirpcapSetLinkTypeHandler)(PAirpcapHandle AdapterHandle, AirpcapLinkType NewLinkType);
  59 typedef BOOL (*AirpcapSetKernelBufferHandler)(PAirpcapHandle AdapterHandle, UINT BufferSize);
  60 typedef BOOL (*AirpcapSetFilterHandler)(PAirpcapHandle AdapterHandle, PVOID Instructions, UINT Len);
  61 typedef BOOL (*AirpcapGetMacAddressHandler)(PAirpcapHandle AdapterHandle, PAirpcapMacAddress PMacAddress);
  62 typedef BOOL (*AirpcapSetMinToCopyHandler)(PAirpcapHandle AdapterHandle, UINT MinToCopy);
  63 typedef BOOL (*AirpcapGetReadEventHandler)(PAirpcapHandle AdapterHandle, HANDLE* PReadEvent);
  64 typedef BOOL (*AirpcapReadHandler)(PAirpcapHandle AdapterHandle, PBYTE Buffer, UINT BufSize, PUINT PReceievedBytes);
  65 typedef BOOL (*AirpcapGetStatsHandler)(PAirpcapHandle AdapterHandle, PAirpcapStats PStats);
  66 typedef BOOL (*AirpcapTurnLedOnHandler)(PAirpcapHandle  AdapterHandle, UINT  LedNumber);
  67 typedef BOOL (*AirpcapTurnLedOffHandler)(PAirpcapHandle  AdapterHandle, UINT  LedNumber);
  68 typedef BOOL (*AirpcapSetDeviceChannelHandler)(PAirpcapHandle  AdapterHandle, UINT  Channel);
  69 typedef BOOL (*AirpcapGetDeviceChannelHandler)(PAirpcapHandle  AdapterHandle, PUINT PChannel);
  70 typedef BOOL (*AirpcapSetFcsPresenceHandler)(PAirpcapHandle  AdapterHandle, BOOL  IsFcsPresent);
  71 typedef BOOL (*AirpcapGetFcsPresenceHandler)(PAirpcapHandle  AdapterHandle, PBOOL PIsFcsPresent);
  72 typedef BOOL (*AirpcapSetFcsValidationHandler)(PAirpcapHandle  AdapterHandle, AirpcapValidationType ValidationType);
  73 typedef BOOL (*AirpcapGetFcsValidationHandler)(PAirpcapHandle  AdapterHandle, PAirpcapValidationType PValidationType);
  74 typedef BOOL (*AirpcapSetDeviceKeysHandler)(PAirpcapHandle AdapterHandle, PAirpcapKeysCollection KeysCollection);
  75 typedef BOOL (*AirpcapGetDeviceKeysHandler)(PAirpcapHandle AdapterHandle, PAirpcapKeysCollection KeysCollection, PUINT PKeysCollectionSize);
  76 typedef BOOL (*AirpcapSetDecryptionStateHandler)(PAirpcapHandle AdapterHandle, AirpcapDecryptionState Enable);
  77 typedef BOOL (*AirpcapGetDecryptionStateHandler)(PAirpcapHandle AdapterHandle, PAirpcapDecryptionState PEnable);
  78 typedef BOOL (*AirpcapStoreCurConfigAsAdapterDefaultHandler)(PAirpcapHandle AdapterHandle);
  79 /*
  80  * The list of interfaces returned by "get_airpcap_interface_list()" is
  81  * a list of these structures.
  82  */
  83 typedef struct {
  84         char                                    *name;                          /* e.g. "eth0" */
  85         char                                    *description;           /* from OS, e.g. "Local Area Connection" or NULL */
  86         GSList                                  *ip_addr;                       /* containing address values of if_addr_t */
  87         gboolean                                loopback;                       /* TRUE if loopback, FALSE otherwise */
  88         AirpcapLinkType                 linkType;                       /* The link layer type*/
  89         UINT                                    channel;                        /* Channel (1-14)*/
  90         BOOL                                    IsFcsPresent;           /* Include 802.11 CRC in frames */
  91         AirpcapValidationType   CrcValidationOn;        /* Capture Frames with Wrong CRC */
  92         AirpcapDecryptionState  DecryptionOn;           /* TRUE if decryption is on, FALSE otherwise*/
  93         PAirpcapKeysCollection  keysCollection;         /* WEP Key collection for the adapter */
  94         UINT                                    keysCollectionSize;     /* Size of the key collection */
  95         gboolean                                blinking;                       /* TRUE if is blinkng, FALSE otherwise*/
  96         gboolean                                led;                            /* TRUE if on, FALSE if off*/
  97         gboolean                                saved;                          /* TRUE if current configuration has been saved, FALSE otherwise */
  98         gint                                    tag;                            /* int for the gtk blinking callback */
  99 } airpcap_if_info_t;
 100
 101 /*
 102  * Struct used to store infos to pass to the preferences manager callbacks
 103  */
 104 typedef struct {
 105    GList *list;
 106    int current_index;
 107    int number_of_keys;
 108 } keys_cb_data_t;
 109
 110 /*
 111  * Struct to store infos about a specific decryption key.
 112  */
 113 typedef struct {
 114     GString *key;
 115     GString *ssid;
 116     guint   bits;
 117     guint   type;
 118 } decryption_key_t;
 119
 120 /* Airpcap interface list */
 121 extern GList *airpcap_if_list;
 122
 123 /* Airpcap current selected interface */
 124 extern airpcap_if_info_t *airpcap_if_selected;
 125
 126 /* Airpcap current active interface */
 127 extern airpcap_if_info_t *airpcap_if_active;
 128
 129 /* WLAN preferences pointer */
 130 //extern module_t *wlan_prefs;
 131
 132 /*
 133  * Function used to read the Decryption Keys from the preferences and store them
 134  * properly into the airpcap adapter.
 135  */
 136 BOOL
 137 load_wlan_wep_keys(airpcap_if_info_t* info_if);
 138
 139 /*
 140  *  Function used to save to the prefereces file the Decryption Keys.
 141  */
 142 BOOL
 143 save_wlan_wep_keys(airpcap_if_info_t* info_if);
 144
 145 /*
 146  * This function will tell the airpcap driver the key list to use
 147  * This will be stored into the registry...
 148  */
 149 gboolean
 150 write_wlan_wep_keys_to_regitry(airpcap_if_info_t* info_if, GList* key_list);
 151
 152 /* Returs TRUE if the WEP key is valid, false otherwise */
 153 gboolean
 154 wep_key_is_valid(char* key);
 155
 156 /*
 157  * Callback used to free an instance of airpcap_if_info_t
 158  */
 159 static void
 160 free_airpcap_if_cb(gpointer data, gpointer user_data _U_);
 161
 162 /*
 163  * Used to retrieve the two chars string from interface
 164  */
 165 gchar*
 166 airpcap_get_if_string_number_from_description(gchar* description);
 167
 168 /*
 169  * Function used to free the airpcap interface list
 170  */
 171 void
 172 free_airpcap_interface_list(GList *if_list);
 173
 174 /*
 175  * Used to retrieve the interface given the name
 176  * (the name is used in AirpcapOpen)
 177  */
 178 airpcap_if_info_t* get_airpcap_if_by_name(GList* if_list, const gchar* name);
 179
 180 /*
 181  * Airpcap wrapper, used to store the current settings for the selected adapter
 182  */
 183 BOOL
 184 airpcap_if_store_cur_config_as_adapter_default(PAirpcapHandle ah);
 185
 186 /*
 187  * Function used to load the WEP keys for a selected interface
 188  */
 189 BOOL
 190 airpcap_if_load_keys(PAirpcapHandle ad, airpcap_if_info_t *if_info);
 191
 192 /*
 193  * Function used to save the WEP keys for a selected interface
 194  */
 195 void
 196 airpcap_if_save_keys(PAirpcapHandle ad, airpcap_if_info_t *if_info);
 197
 198 /*
 199  * Airpcap wrapper, used to get the fcs validation of an airpcap adapter
 200  */
 201 BOOL
 202 airpcap_if_get_fcs_validation(PAirpcapHandle ah, PAirpcapValidationType val);
 203
 204 /*
 205  * Airpcap wrapper, used to set the fcs validation of an airpcap adapter
 206  */
 207 BOOL
 208 airpcap_if_set_fcs_validation(PAirpcapHandle ah, AirpcapValidationType val);
 209
 210 /*
 211  * Airpcap wrapper, used to get the decryption enabling of an airpcap adapter
 212  */
 213 BOOL
 214 airpcap_if_get_decryption_state(PAirpcapHandle ah, PAirpcapDecryptionState val);
 215
 216 /*
 217  * Airpcap wrapper, used to set the decryption enabling of an airpcap adapter
 218  */
 219 BOOL
 220 airpcap_if_set_decryption_state(PAirpcapHandle ah, AirpcapDecryptionState val);
 221
 222 /*
 223  * Airpcap wrapper, used to get the fcs presence of an airpcap adapter
 224  */
 225 BOOL
 226 airpcap_if_get_fcs_presence(PAirpcapHandle ah, PBOOL ch);
 227
 228 /*
 229  * Airpcap wrapper, used to set the fcs presence of an airpcap adapter
 230  */
 231 BOOL
 232 airpcap_if_set_fcs_presence(PAirpcapHandle ah, BOOL ch);
 233
 234 /*
 235  * Airpcap wrapper, used to get the link type of an airpcap adapter
 236  */
 237 BOOL
 238 airpcap_if_get_link_type(PAirpcapHandle ah, PAirpcapLinkType lt);
 239
 240 /*
 241  * Airpcap wrapper, used to set the link type of an airpcap adapter
 242  */
 243 BOOL
 244 airpcap_if_set_link_type(PAirpcapHandle ah, AirpcapLinkType lt);
 245
 246 /*
 247  * Airpcap wrapper, used to get the channel of an airpcap adapter
 248  */
 249 BOOL
 250 airpcap_if_get_device_channel(PAirpcapHandle ah, PUINT ch);
 251
 252 /*
 253  * Airpcap wrapper, used to set the channel of an airpcap adapter
 254  */
 255 BOOL
 256 airpcap_if_set_device_channel(PAirpcapHandle ah, UINT ch);
 257
 258 /*
 259  * Airpcap wrapper, used to open an airpcap adapter
 260  */
 261 PAirpcapHandle airpcap_if_open(PCHAR name, PCHAR err);
 262
 263 /*
 264  * Airpcap wrapper, used to close an airpcap adapter
 265  */
 266 VOID airpcap_if_close(PAirpcapHandle handle);
 267
 268 /*
 269  * Airpcap wrapper, used to turn on the led of an airpcap adapter
 270  */
 271 BOOL airpcap_if_turn_led_on(PAirpcapHandle AdapterHandle, UINT LedNumber);
 272
 273 /*
 274  * Airpcap wrapper, used to turn off the led of an airpcap adapter
 275  */
 276 BOOL airpcap_if_turn_led_off(PAirpcapHandle AdapterHandle, UINT LedNumber);
 277
 278 /*
 279  * This function will create a new airpcap_if_info_t using a name and a description
 280  */
 281 airpcap_if_info_t* airpcap_if_info_new(char *name, char *description);
 282
 283 /*
 284  *  Used to dinamically load the airpcap library in order link it only when
 285  *  it's present on the system.
 286  */
 287 BOOL load_airpcap(void);
 288
 289 /*
 290  * Get an error message string for a CANT_GET_INTERFACE_LIST error from
 291  * "get_airpcap_interface_list()".
 292  */
 293 gchar*
 294 cant_get_airpcap_if_list_error_message(const char *err_str);
 295
 296 /*
 297  * This function will use the airpcap.dll to find all the airpcap devices.
 298  * Will return null if no device is found.
 299  */
 300 GList*
 301 get_airpcap_interface_list(int *err, char *err_str);
 302
 303 /*
 304  * Returns the ASCII string of a key given the key bites
 305  */
 306 gchar*
 307 airpcap_get_key_string(AirpcapKey key);
 308
 309 /*
 310  * Load the configuration for the specified interface
 311  */
 312 void
 313 airpcap_load_selected_if_configuration(airpcap_if_info_t* if_info);
 314
 315 /*
 316  * Save the configuration for the specified interface
 317  */
 318 void
 319 airpcap_save_selected_if_configuration(airpcap_if_info_t* if_info);
 320
 321 /*
 322  * Used to retrieve the name of the interface given the description
 323  * (the name is used in AirpcapOpen, the description is put in the combo box)
 324  */
 325 gchar*
 326 get_airpcap_name_from_description(GList* if_list, gchar* description);
 327
 328 /*
 329  * Used to retrieve the airpcap_if_info_t of the selected interface given the
 330  * description (that is the entry of the combo box).
 331  */
 332 gpointer
 333 get_airpcap_if_from_description(GList* if_list, const gchar* description);
 334
 335 /*
 336  * Used to retrieve the two chars string from interface description
 337  */
 338 gchar*
 339 airpcap_get_if_string_number(airpcap_if_info_t* if_info);
 340
 341 /*
 342  * Returns the default airpcap interface of a list, NULL if list is empty
 343  */
 344 airpcap_if_info_t*
 345 airpcap_get_default_if(GList* airpcap_if_list);
 346
 347 /*
 348  * Airpcap wrapper, used to save the settings for the selected_if
 349  */
 350 BOOL
 351 airpcap_if_set_device_keys(PAirpcapHandle AdapterHandle, PAirpcapKeysCollection KeysCollection);
 352
 353 /*
 354  * Airpcap wrapper, used to save the settings for the selected_if
 355  */
 356 BOOL
 357 airpcap_if_get_device_keys(PAirpcapHandle AdapterHandle, PAirpcapKeysCollection KeysCollection, PUINT PKeysCollectionSize);
 358
 359 /*
 360  * DECRYPTION KEYS FUNCTIONS
 361  */
 362 /*
 363  * This function is used for DEBUG PURPOSES ONLY!!!
 364  */
 365 void
 366 print_key_list(GList* key_list);
 367
 368 /*
 369  * Retrieves a GList of decryption_key_t structures containing infos about the
 370  * keys for the given adapter... returns NULL if no keys are found.
 371  */
 372 GList*
 373 get_airpcap_device_keys(airpcap_if_info_t* if_info);
 374
 375 /*
 376  * Returns the list of the decryption keys specified for wireshark, NULL if
 377  * no key is found
 378  */
 379 GList*
 380 get_wireshark_keys();
 381
 382 /*
 383  * Tests if two collection of keys are equal or not, to be considered equals, they have to
 384  * contain the same keys in the SAME ORDER! (If both lists are NULL, which means empty will
 385  * return TRUE)
 386  */
 387 gboolean
 388 key_lists_are_equal(GList* list1, GList* list2);
 389
 390 /*
 391  * Merges two lists of keys. If a key is found multiple times, it will just appear once!
 392  */
 393 GList*
 394 merge_key_list(GList* list1, GList* list2);
 395
 396 /*
 397  * If the given key is contained in the list, returns TRUE.
 398  * Returns FALSE otherwise.
 399  */
 400 gboolean
 401 key_is_in_list(decryption_key_t *dk,GList *list);
 402
 403 /*
 404  * Returns TRUE if keys are equals, FALSE otherwise
 405  */
 406 gboolean
 407 keys_are_equals(decryption_key_t *k1,decryption_key_t *k2);
 408
 409 /*
 410  * Use this function to free a key list.
 411  */
 412 void
 413 free_key_list(GList *list);
 414
 415 /*
 416  * Returns TRUE if the Wireshark decryption is active, false otherwise
 417  */
 418 gboolean
 419 wireshark_decryption_on();
 420
 421 /*
 422  * Returns TRUE if the AirPcap decryption is active, false otherwise
 423  */
 424 gboolean
 425 airpcap_decryption_on();
 426
 427 /*
 428  * Enables decryption for Wireshark if on_off is TRUE, disables it otherwise.
 429  */
 430 void
 431 set_wireshark_decryption(gboolean on_off);
 432
 433 /*
 434  * Enables decryption for all the adapters if on_off is TRUE, disables it otherwise.
 435  */
 436 gboolean
 437 set_airpcap_decryption(gboolean on_off);
 438
 439 #endif