airpcap.h

   1 /*
   2  * Copyright (c) 2006 CACE Technologies, Davis (California)
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted.
   7  *
   8  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   9  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  10  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  11  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  12  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  13  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  14  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  15  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  16  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  17  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  18  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  19  *
  20  */
  21
  22 #if !defined(AIRPCAP_H__EAE405F5_0171_9592_B3C2_C19EC426AD34__INCLUDED_)
  23 #define AIRPCAP_H__EAE405F5_0171_9592_B3C2_C19EC426AD34__INCLUDED_
  24
  25 #include <epan/crypt/wep-wpadefs.h>  /* WEP_KEY_MAX_SIZE */
  26
  27 /* This disables a VS warning for zero-sized arrays. All the compilers we support have that feature */
  28 #pragma warning( disable : 4200)
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 /*!
  35         \mainpage AirPcap interface documentation
  36
  37         \section Introduction
  38
  39         This document describes the data structures and the functions exported by the CACE Technologies AirPcap library.
  40         The AirPcap library provides low-level access to the AirPcap driver including advanced capabilities such as channel setting,
  41         link type control and WEP configuration.<br>
  42         This manual includes the following sections:
  43
  44         \note throughout this documentation, \i device refers to a physical USB AirPcap device, wile \i adapter is an open API
  45         instance. Most of the AirPcap API operations are adapter-specific but some of them, like setting the channel, are
  46         per-device and will be reflected on all the open adapters. These functions will have "Device" in their name, e.g.
  47         AirpcapSetDeviceChannel().
  48
  49         \b Sections:
  50
  51         - \ref airpcapfuncs
  52         - \ref airpcapdefs
  53         - \ref radiotap
  54 */
  55
  56 /** @defgroup airpcapdefs AirPcap definitions and data structures
  57  *  @{
  58  */
  59
  60 /*!
  61   \brief This string is the fixed prefix in the airpcap adapter name.
  62   It can be used to parse the name field in an AirpcapDeviceDescription structure.
  63 */
  64 #define AIRPCAP_DEVICE_NAME_PREFIX "\\\\.\\airpcap"
  65
  66 /*!
  67   \brief This string is the scanf modifier to extract the adapter number from an adapter name.
  68   It can be used to parse the name field in an AirpcapDeviceDescription structure with scanf.
  69 */
  70 #define AIRPCAP_DEVICE_NUMBER_EXTRACT_STRING "\\\\.\\airpcap%u"
  71
  72 /*!
  73   \brief This string is the scanf modifier to extract the adapter "Any" string from an adapter name.
  74   It can be used to parse the name field in an AirpcapDeviceDescription structure with scanf.
  75 */
  76 #define AIRPCAP_DEVICE_ANY_EXTRACT_STRING "\\\\.\\airpcap_any"
  77
  78 /*!
  79   \brief Entry in the list returned by \ref AirpcapGetDeviceList();
  80 */
  81 typedef struct _AirpcapDeviceDescription
  82 {
  83         struct  _AirpcapDeviceDescription *next;                        /* Next element in the list */
  84         PCHAR   Name;                                                                           /* Device name */
  85         PCHAR   Description;                                                            /* Device description */
  86 } AirpcapDeviceDescription, *PAirpcapDeviceDescription;
  87
  88
  89 #ifndef __MINGW32__
  90 #pragma pack(push)
  91 #pragma pack(1)
  92 #endif /* __MINGW32__ */
  93
  94
  95 #define AIRPCAP_KEYTYPE_WEP             0       /* Key type: WEP. The key can have an arbitrary length smaller than 32 bytes. */
  96 #define AIRPCAP_KEYTYPE_TKIP    1       /* Key type: TKIP (WPA_PWD). NOT SUPPORTED YET. */
  97 #define AIRPCAP_KEYTYPE_CCMP    2       /* Key type: CCMP (WPA_BIN). NOT SUPPORTED YET. */
  98
  99 /*!
 100   \brief WEP key container
 101 */
 102 typedef struct _AirpcapKey
 103 {
 104         UINT KeyType;                                           /* Type of key, can be on of: \ref AIRPCAP_KEYTYPE_WEP, \ref AIRPCAP_KEYTYPE_TKIP, \ref AIRPCAP_KEYTYPE_CCMP. Only AIRPCAP_KEYTYPE_WEP is supported by the driver at the moment. */
 105         UINT KeyLen;                                            /* Length of the key, in bytes */
 106         BYTE KeyData[WEP_KEY_MAX_SIZE];         /* Key Data */
 107 }
 108 #ifdef __MINGW32__
 109 __attribute__((__packed__))
 110 #endif /* __MINGW32__ */
 111 AirpcapKey, *PAirpcapKey;
 112
 113 /*!
 114   \brief Type of frame validation the adapter performs.
 115    An adapter can be instructed to accept different kind of frames: correct frames only, frames with wrong Frame Check Sequence (FCS) only, all frames.
 116 */
 117 typedef enum _AirpcapValidationType
 118 {
 119     AIRPCAP_VT_ACCEPT_EVERYTHING = 1,           /* Accept all the frames the device captures */
 120     AIRPCAP_VT_ACCEPT_CORRECT_FRAMES = 2,       /* Accept correct frames only, i.e. frames with correct Frame Check Sequence (FCS). */
 121     AIRPCAP_VT_ACCEPT_CORRUPT_FRAMES = 3,       /* Accept corrupt frames only, i.e. frames with worng Frame Check Sequence (FCS). */
 122         AIRPCAP_VT_UNKNOWN = 4                                  /* Unknown validation type. You should see it only in case of error. */
 123 }AirpcapValidationType, *PAirpcapValidationType;
 124
 125 /*!
 126   \brief Type of decryption the adapter performs.
 127    An adapter can be instructed to turn decryption (based on the device-configured keys configured
 128    with \ref AirpcapSetDeviceKeys()) on or off.
 129 */
 130 typedef enum _AirpcapDecryptionState
 131 {
 132     AIRPCAP_DECRYPTION_ON = 1,                          /* This adapter performs decryption */
 133     AIRPCAP_DECRYPTION_OFF = 2                          /* This adapter does not perform decryption */
 134 }AirpcapDecryptionState, *PAirpcapDecryptionState;
 135
 136
 137 /*!
 138   \brief Storage for a MAC address
 139 */
 140 typedef struct _AirpcapMacAddress
 141 {
 142         BYTE Address[6];                /* MAC address bytes */
 143 }
 144 #ifdef __MINGW32__
 145 __attribute__((__packed__))
 146 #endif /* __MINGW32__ */
 147 AirpcapMacAddress, *PAirpcapMacAddress;
 148
 149 /*!
 150   \brief This structure is used to store a collection of WEP keys.
 151   Note that the definition of the structure doesn't contain any key, so be careful to allocate a buffer
 152   with the size of the key, like in the following example:
 153
 154   \code
 155         PAirpcapKeysCollection KeysCollection;
 156         UINT KeysCollectionSize;
 157
 158         KeysCollectionSize = sizeof(AirpcapKeysCollection) + NumKeys * sizeof(AirpcapKey);
 159
 160         KeysCollection = (PAirpcapKeysCollection)g_malloc(KeysCollectionSize);
 161         if(!KeysCollection)
 162         {
 163                 // Error
 164         }
 165   \endcode
 166 */
 167 typedef struct _AirpcapKeysCollection
 168 {
 169         UINT nKeys;                                                                                             /* Number of keys in the collection */
 170         AirpcapKey Keys[0];                                                                             /* Array of nKeys keys.  */
 171 } AirpcapKeysCollection, *PAirpcapKeysCollection;
 172
 173 /*!
 174   \brief Packet header.
 175
 176   This structure defines the BPF that preceeds every packet delivered to the application.
 177 */
 178 typedef struct _AirpcapBpfHeader
 179 {
 180         UINT TsSec;                     /* Timestamp associated with the captured packet. SECONDS. */
 181         UINT TsUsec;            /* Timestamp associated with the captured packet. MICROSECONDS. */
 182         UINT Caplen;            /* Length of captured portion. The captured portion <b>can be different</b> from the original packet, because it is possible (with a proper filter) to instruct the driver to capture only a portion of the packets. */
 183         UINT Originallen;       /* Original length of packet */
 184         USHORT  Hdrlen;         /* Length of bpf header (this struct plus alignment padding). In some cases, a padding could be added between the end of this structure and the packet data for performance reasons. This field can be used to retrieve the actual data of the packet. */
 185 }
 186 #ifdef __MINGW32__
 187 __attribute__((__packed__))
 188 #endif /* __MINGW32__ */
 189 AirpcapBpfHeader, *PAirpcapBpfHeader;
 190
 191 /* Helper macros to extract packets coming from the driver. Rounds up to the next even multiple of AIRPCAP_ALIGNMENT.  */
 192 #define AIRPCAP_ALIGNMENT sizeof(int)
 193 #define AIRPCAP_WORDALIGN(x) (((x)+(AIRPCAP_ALIGNMENT-1))&~(AIRPCAP_ALIGNMENT-1))
 194
 195 #ifndef __MINGW32__
 196 #pragma pack(pop)
 197 #endif /* __MINGW32__ */
 198
 199 #define AIRPCAP_ERRBUF_SIZE 512         /* Size of the error buffer, in bytes */
 200
 201 #ifndef __AIRPCAP_DRIVER__
 202
 203 /*!
 204   \brief Link type.
 205    AirPcap supports two kind of 802.11 linktypes: plain 802.11 and radiotap.
 206 */
 207 typedef enum _AirpcapLinkType
 208 {
 209     AIRPCAP_LT_802_11 = 1,                              /* plain 802.11 linktype. Every packet in the buffer contains the raw 802.11 frame, including MAC FCS. */
 210     AIRPCAP_LT_802_11_PLUS_RADIO = 2,   /* 802.11 plus radiotap linktype. Every packet in the buffer contains a radiotap header followed by the 802.11 frame. MAC FCS is included. */
 211         AIRPCAP_LT_UNKNOWN = 3                          /* Unknown linktype. You should see it only in case of error. */
 212 }AirpcapLinkType, *PAirpcapLinkType;
 213
 214 #if !defined(AIRPCAP_HANDLE__EAE405F5_0171_9592_B3C2_C19EC426AD34__DEFINED_)
 215 #define AIRPCAP_HANDLE__EAE405F5_0171_9592_B3C2_C19EC426AD34__DEFINED_
 216 /*!
 217   \brief Adapter handle.
 218 */
 219 typedef struct _AirpcapHandle AirpcapHandle, *PAirpcapHandle;
 220 #endif
 221
 222 /*!
 223   \brief Capture statistics.
 224    Returned by \ref AirpcapGetStats();
 225 */
 226 typedef struct _AirpcapStats
 227 {
 228         UINT Recvs;                     /* Number of packets that the driver received by the adapter  */
 229                                                 /* from the beginning of the current capture. This value includes the packets  */
 230                                                 /* dropped because of buffer full. */
 231         UINT Drops;                     /* number of packets that the driver dropped from the beginning of a capture.  */
 232                                                 /* A packet is lost when the the buffer of the driver is full.  */
 233         UINT IfDrops;           /* Packets dropped by the card before going to the USB bus.  */
 234                                                 /* Not supported at the moment. */
 235         UINT Capt;                      /* number of packets that pass the BPF filter, find place in the kernel buffer and */
 236                                                 /* therefore reach the application. */
 237 }AirpcapStats, *PAirpcapStats;
 238
 239 /*@}*/
 240
 241 /** @defgroup airpcapfuncs AirPcap functions
 242  *  @{
 243  */
 244
 245 /*!
 246   \brief Return a string with the API version
 247   \param VersionMajor Pointer to a variable that will be filled with the major version number.
 248   \param VersionMinor Pointer to a variable that will be filled with the minor version number.
 249   \param VersionRev Pointer to a variable that will be filled with the revision number.
 250   \param VersionBuild Pointer to a variable that will be filled with the build number.
 251 */
 252 void AirpcapGetVersion(PUINT VersionMajor, PUINT VersionMinor, PUINT VersionRev, PUINT VersionBuild);
 253
 254 /*!
 255   \brief Return the last error related to the specified handle
 256   \param AdapterHandle Handle to an open adapter.
 257   \return The string with the last error.
 258 */
 259 PCHAR AirpcapGetLastError(PAirpcapHandle AdapterHandle);
 260
 261 /*!
 262   \brief Return the list of available devices
 263   \param PPAllDevs Address to a caller allocated pointer. On success this pointer will receive the head of a list of available devices.
 264   \param Ebuf String that will contain error information if FALSE is returned. The size of the string must be AIRPCAP_ERRBUF_SIZE bytes.
 265   \return TRUE on success. FALSE is returned on failure, in which case Ebuf is filled in with an appropriate error message.
 266
 267         Here's a snppet of code that shows how to use AirpcapGetDeviceList():
 268
 269         \code
 270         CHAR Ebuf[AIRPCAP_ERRBUF_SIZE];
 271         AirpcapDeviceDescription *Desc, *tDesc;
 272
 273         if(AirpcapGetDeviceList(&Desc, Ebuf) == -1)
 274         {
 275                 printf("Unable to get the list of devices: %s\n", Ebuf);
 276                 return -1;
 277         }
 278
 279         for(tDesc = Desc; tDesc; tDesc = tDesc->next)
 280         {
 281                 printf("%u) %s (%s)\n",
 282                 ++i,
 283                 tDesc->Name,
 284                 tDesc->Description);
 285         }
 286         \endcode
 287 */
 288 BOOL AirpcapGetDeviceList(PAirpcapDeviceDescription *PPAllDevs, PCHAR Ebuf);
 289
 290 /*!
 291   \brief Free a list of devices returned by AirpcapGetDeviceList()
 292   \param PAllDevs Head of the list of devices returned by \ref AirpcapGetDeviceList().
 293 */
 294 VOID AirpcapFreeDeviceList(PAirpcapDeviceDescription PAllDevs);
 295
 296 /*!
 297   \brief Open an adapter
 298   \param DeviceName Name of the device to open. Use \ref AirpcapGetDeviceList() to get the list of devices.
 299   \param Ebuf String that will contain error information in case of failure. The size of the string must be AIRPCAP_ERRBUF_SIZE bytes.
 300   \return A PAirpcapHandle handle on success. NULL is returned on failure, in which case Ebuf is filled in with an appropriate error message.
 301 */
 302 PAirpcapHandle AirpcapOpen(PCHAR DeviceName, PCHAR Ebuf);
 303
 304 /*!
 305   \brief Close an adapter
 306   \param AdapterHandle Handle to the adapter to close.
 307 */
 308 VOID AirpcapClose(PAirpcapHandle AdapterHandle);
 309
 310 /*!
 311   \brief Set the link type of an adapter
 312   \param AdapterHandle Handle to the adapter.
 313   \param NewLinkType the "link type", i.e. the format of the frames that will be received from the adapter.
 314   \return TRUE on success.
 315
 316   the "link type" determines how the driver will encode the packets captured from the network.
 317   Aircap supports two link types:
 318   - AIRPCAP_LT_802_11, to capture 802.11 frames (including control frames) without any
 319    power information. Look at the Capture_no_radio example application in the developer's pack
 320    for a reference on how to decode 802.11 frames with this link type.
 321   - AIRPCAP_LT_802_11_PLUS_RADIO, to capture 802.11 frames (including control frames) with a radiotap header
 322   that contains power and channel information. More information about the radiotap header can be found int the
 323   \ref radiotap section. Moreover, the "Capture_radio" example application in
 324   the developer's pack can be used as a reference on how to decode 802.11 frames with radiotap headers.
 325 */
 326 BOOL AirpcapSetLinkType(PAirpcapHandle AdapterHandle, AirpcapLinkType NewLinkType);
 327
 328 /*!
 329   \brief Get the link type of the specified adapter
 330   \param AdapterHandle Handle to the adapter.
 331   \param PLinkType Pointer to a caller allocated AirpcapLinkType variable that will contain the link type of the adapter.
 332   \return TRUE on success.
 333
 334   the "link type" determines how the driver will encode the packets captured from the network.
 335   Aircap supports two link types:
 336   - AIRPCAP_LT_802_11, to capture 802.11 frames (including control frames) without any
 337    power information. Look at the Capture_no_radio example application in the developer's pack
 338    for a reference on how to decode 802.11 frames with this link type.
 339   - AIRPCAP_LT_802_11_PLUS_RADIO, to capture 802.11 frames (including control frames) with a radiotap header
 340   that contains power and channel information. More information about the radiotap header can be found int the
 341   \ref radiotap section. Moreover, the "Capture_radio" example application in
 342   the developer's pack can be used as a reference on how to decode 802.11 frames with radiotap headers.
 343 */
 344 BOOL AirpcapGetLinkType(PAirpcapHandle AdapterHandle, PAirpcapLinkType PLinkType);
 345
 346 /*!
 347   \brief Configures the adapter on whether to include the MAC Frame Check Sequence in the captured packets.
 348   \param AdapterHandle Handle to the adapter.
 349   \param IsFcsPresent TRUE if the packets should include the FCS. FALSE otherwise
 350   \return TRUE on success.
 351
 352   In the default configuration, the adapter includes the FCS in the captured packets. The MAC Frame Check Sequence
 353   is 4 bytes and is located at the end of the 802.11 packet, with both AIRPCAP_LT_802_11 and AIRPCAP_LT_802_11_PLUS_RADIO
 354   link types.
 355   When the FCS inclusion is turned on, and if the link type is AIRPCAP_LT_802_11_PLUS_RADIO, the radiotap header
 356   that precedes each frame has two additional fields at the end: Padding and FCS. These two fields are not present
 357   when FCS inclusion is off.
 358 */
 359 BOOL AirpcapSetFcsPresence(PAirpcapHandle AdapterHandle, BOOL IsFcsPresent);
 360
 361 /*!
 362   \brief Returns TRUE if the specified adapter includes the MAC Frame Check Sequence in the captured packets
 363   \param AdapterHandle Handle to the adapter.
 364   \param PIsFcsPresent User-provided variable that will be set to true if the adapter is including the FCS.
 365   \return TRUE if the operation is successful. FALSE otherwise.
 366
 367   In the default configuration, the adatper has FCS inclusion turned on. The MAC Frame Check Sequence is 4 bytes
 368   and is located at the end of the 802.11 packet, with both AIRPCAP_LT_802_11 and AIRPCAP_LT_802_11_PLUS_RADIO
 369   link types.
 370   When the FCS inclusion is turned on, and if the link type is AIRPCAP_LT_802_11_PLUS_RADIO, the radiotap header
 371   that precedes each frame has two additional fields at the end: Padding and FCS. These two fields are not present
 372   when FCS inclusion is off.
 373 */
 374 BOOL AirpcapGetFcsPresence(PAirpcapHandle AdapterHandle, PBOOL PIsFcsPresent);
 375
 376 /*!
 377   \brief Configures the adapter to accept or drop frames with an incorrect Frame Check sequence (FCS).
 378   \param AdapterHandle Handle to the adapter.
 379   \param ValidationType The type of validation the driver will perform. See the documentation of \ref AirpcapValidationType for details.
 380   \return TRUE on success.
 381
 382   \note By default, the driver is configured in \ref AIRPCAP_VT_ACCEPT_EVERYTHING mode.
 383 */
 384 BOOL AirpcapSetFcsValidation(PAirpcapHandle AdapterHandle, AirpcapValidationType ValidationType);
 385
 386 /*!
 387   \brief Checks if the specified adapter is configured to capture frames with incorrect an incorrect Frame Check Sequence (FCS).
 388   \param AdapterHandle Handle to the adapter.
 389   \param ValidationType Pointer to a user supplied variable that will contain the type of validation the driver will perform. See the documentation of \ref AirpcapValidationType for details.
 390   \return TRUE if the operation is succesful. FALSE otherwise.
 391
 392   \note By default, the driver is configured in \ref AIRPCAP_VT_ACCEPT_EVERYTHING mode.
 393 */
 394 BOOL AirpcapGetFcsValidation(PAirpcapHandle AdapterHandle, PAirpcapValidationType ValidationType);
 395
 396 /*!
 397   \brief Set the list of decryption keys that the driver is going to use with the specified device.
 398   \param AdapterHandle Handle an open adapter instance.
 399   \param KeysCollection Pointer to a \ref PAirpcapKeysCollection structure that contains the keys to be set in the driver.
 400   \return TRUE if the operation is successful. FALSE otherwise.
 401
 402   The AirPcap driver is able to use a set of decryption keys to decrypt the traffic transmitted on a specific SSID. If one of the
 403   keys corresponds to the one the frame has been encrypted with, the driver will perform decryption and return the cleartext frames
 404   to the application.
 405   The driver supports, for every device, multiple keys at the same time.
 406
 407   At this time, the only supported decryption method is WEP.
 408
 409   The configured decryption keys are device-specific: they will not be used by other airpcap devices besides the specified one.
 410
 411   The keys are applied to the packets in the same order they appear in the KeysCollection structure until the packet is
 412   correctly decrypted, therefore putting frequently used keys at the beginning of the structure improves performance.
 413
 414   \note: this is a Device-related function: when you change the channel from an open capture instance, the change will be
 415          immediately reflected on all the other capture instances.
 416 */
 417 BOOL AirpcapSetDeviceKeys(PAirpcapHandle AdapterHandle, PAirpcapKeysCollection KeysCollection);
 418
 419 /*!
 420   \brief Returns the list of decryption keys in the driver that are currently associated with the specified device
 421   \param AdapterHandle Handle to an open adapter instance.
 422   \param KeysCollection User-allocated PAirpcapKeysCollection structure that will be filled with the keys.
 423   \param PKeysCollectionSize \b IN: pointer to a user-allocated variable that contains the length of the KeysCollection structure, in bytes.
 424                                                 \b OUT: amount of data moved by the driver in the buffer pointed by KeysBuffer, in bytes.
 425   \return TRUE if the operation is succesful. If an error occurs, the return value is FALSE and KeysCollectionSize is zero.
 426   If the provided buffer is too small to contain the keys, the return value is FALSE and KeysCollectionSize contains the
 427   needed KeysCollection length, in bytes. If the device doesn't have any decryption key configured, the return value is TRUE, and
 428   KeysCollectionSize will be zero.
 429
 430   This function returns the list of decryption keys in the driver that are associated with the specified device.
 431   The AirPcap driver is able to use a set of decryption keys to decrypt the traffic transmitted on a specific SSID. If one of the
 432   keys corresponds to the one the frame has been encrypted with, the driver will perform decryption and return the cleartext frames
 433   to the application.
 434   The driver supports, for every device, multiple keys at the same time.
 435
 436   The configured decryption keys are device-specific, therefore AirpcapGetDeviceKeys() will return a different set of keys
 437   when called on different devices.
 438
 439   At this time, the only supported decryption method is WEP.
 440
 441   \note: this is a Device-related function: when you change the channel from an open capture instance, the change will be
 442          immediately reflected on all the other capture instances.
 443 */
 444 BOOL AirpcapGetDeviceKeys(PAirpcapHandle AdapterHandle, PAirpcapKeysCollection KeysCollection, PUINT PKeysCollectionSize);
 445
 446 /*!
 447   \brief Turns on or off the decryption of the incoming frames
 448   \param AdapterHandle Handle to the adapter.
 449   \param ValidationType Either \ref AIRPCAP_DECRYPTION_ON or \ref AIRPCAP_DECRYPTION_OFF
 450   \return TRUE on success.
 451
 452   The decryption keys can be configured with the \ref AirpcapSetDeviceKeys() function.
 453   \note By default, the driver is configured with \ref AIRPCAP_DECRYPTION_ON.
 454 */
 455 BOOL AirpcapSetDecryptionState(PAirpcapHandle AdapterHandle, AirpcapDecryptionState Enable);
 456
 457 /*!
 458   \brief Tells if this open instance is configured to perform the decryption of the incoming frames
 459   \param AdapterHandle Handle to the adapter.
 460   \param ValidationType Pointer to a user supplied variable that will contain the decryption configuration. See \ref PAirpcapDecryptionState for details.
 461   \return TRUE if the operation is succesful. FALSE otherwise.
 462
 463   The decryption keys can be configured with the \ref AirpcapSetDeviceKeys() function.
 464   \note By default, the driver is configured with \ref AIRPCAP_DECRYPTION_ON.
 465 */
 466 BOOL AirpcapGetDecryptionState(PAirpcapHandle AdapterHandle, PAirpcapDecryptionState PEnable);
 467
 468 /*!
 469   \brief Set the radio channel of a device
 470   \param AdapterHandle Handle to the adapter.
 471   \param Channel the new channel to set.
 472   \return TRUE on success.
 473
 474   Valid channels are in the range 1-14. The default channel setting is 6.
 475
 476   \note: this is a Device-related function: when you change the channel from an open capture instance, the change will be
 477          immediately reflected on all the other capture instances.
 478 */
 479 BOOL AirpcapSetDeviceChannel(PAirpcapHandle AdapterHandle, UINT Channel);
 480
 481 /*!
 482   \brief Get the radio channel of a device
 483   \param AdapterHandle Handle to the adapter.
 484   \param PChannel Pointer to a user-supplied variable into which the function will copy the currently configured radio channel.
 485   \return TRUE on success.
 486
 487   Valid channels are in the range 1-14. The default channel setting is 6.
 488
 489   \note: this is a Device-related function: when you change the channel from an open capture instance, the change will be
 490          immediately reflected on all the other capture instances.
 491 */
 492 BOOL AirpcapGetDeviceChannel(PAirpcapHandle AdapterHandle, PUINT PChannel);
 493
 494 /*!
 495   \brief Set the size of the kernel packet buffer for this adapter
 496   \param AdapterHandle Handle to the adapter.
 497   \param BufferSize New size, in bytes.
 498   \return TRUE on success.
 499
 500   Every AirPcap open instance has an associated kernel buffer, whose default size is 1 Mbyte.
 501   This function can be used to change the size of this buffer, and can be called at any time.
 502   A bigger kernel buffer size decreases the risk of dropping packets during network bursts or when the
 503   application is busy, at the cost of higher kernel memory usage.
 504
 505   \note: don't use this function unless you know what you are doing. Due to chaching issues and bigger non-paged
 506   memory consumption, Bigger buffer sizes can decrease the capture performace instead of improving it.
 507 */
 508 BOOL AirpcapSetKernelBuffer(PAirpcapHandle AdapterHandle, UINT BufferSize);
 509
 510 /*!
 511   \brief Get the size of the kernel packet buffer for this adapter
 512   \param AdapterHandle Handle to the adapter.
 513   \param PSizeBytes User-allocated variable that will be filled with the size of the kernel buffer.
 514   \return TRUE on success.
 515
 516   Every AirPcap open instance has an associated kernel buffer, whose default size is 1 Mbyte.
 517   This function can be used to get the size of this buffer.
 518 */
 519 BOOL AirpcapGetKernelBufferSize(PAirpcapHandle AdapterHandle, PUINT PSizeBytes);
 520
 521 /*!
 522   \brief Saves the configuration of the specified adapter in the registry, so that it becomes the default for this adapter.
 523   \param AdapterHandle Handle to the adapter.
 524   \return TRUE on success. FALSE on failure.
 525
 526   Almost all the AirPcap calls that modify the configuration (\ref AirpcapSetLinkType(), \ref AirpcapSetFcsPresence(),
 527   \ref AirpcapSetFcsValidation(), \ref AirpcapSetKernelBuffer(), \ref AirpcapSetMinToCopy())
 528   affect only the referenced AirPcap open instance. This means that if you do another \ref AirpcapOpen() on the same
 529   adapter, the configuration changes will not be remembered, and the new adapter handle will have default configuration
 530   settings.
 531
 532   Exceptions to this rule are the \ref AirpcapSetDeviceChannel() and \ref AirpcapSetDeviceKeys() functions: a channel change is
 533   reflected on all the open instances, and remembered until the next call to \ref AirpcapSetDeviceChannel(), until the adapter
 534   is unplugged, or until the machine is powered off. Same thing for the configuration of the WEP keys.
 535
 536   AirpcapStoreCurConfigAsAdapterDefault() stores the configuration of the give open instance as the default for the adapter:
 537   all the instances opened in the future will have the same configuration that this adapter currently has.
 538   The configuration is stored in the registry, therefore it is remembered even when the adapter is unplugged or the
 539   machine is turned off. However, an adapter doesn't bring its configuration with it from machine to machine.
 540
 541   the configuration information saved in the registry includes the following parameters:
 542    - channel
 543    - kernel buffer size
 544    - mintocopy
 545    - link type
 546    - CRC presence
 547    - Encryption keys
 548    - Encryption Enabled/Disabled state
 549
 550   The configuration is adapter-specific. This means that changing the configuration of an adapter
 551   doesn't modify the one of the other adapters that are currently used or that will be used in the future.
 552
 553   \note AirpcapStoreCurConfigAsAdapterDefault() must have exclusive access to the adapter -- it
 554    will fail if more than one AirPcap handle is opened at the same time for this adapter.
 555    AirpcapStoreCurConfigAsAdapterDefault() needs administrator privileges. It will fail if the calling user
 556    is not a local machine administrator.
 557 */
 558 BOOL AirpcapStoreCurConfigAsAdapterDefault(PAirpcapHandle AdapterHandle);
 559
 560 /*!
 561   \brief Set the BPF kernel filter for an adapter
 562   \param AdapterHandle Handle to the adapter.
 563   \param Instructions pointer to the first BPF instruction in the array. Corresponds to the  bf_insns
 564    in a bpf_program structure (see the WinPcap documentation at http://www.winpcap.org/devel.htm).
 565   \param Len Number of instructions in the array pointed by the previous field. Corresponds to the bf_len in
 566   a a bpf_program structure (see the WinPcap documentation at http://www.winpcap.org/devel.htm).
 567   \return TRUE on success.
 568
 569   The AirPcap driver is able to perform kernel-level filtering using the standard BPF pseudo-machine format. You can read
 570   the WinPcap documentation at http://www.winpcap.org/devel.htm for more details on the BPF filtering mechaism.
 571
 572   A filter can be automatically created by using the pcap_compile() function of the WinPcap API. This function
 573   converts a human readable text expression with the tcpdump/libpcap syntax into a BPF program.
 574   If your program doesn't link wpcap, but you need to generate the code for a particular filter, you can run WinDump
 575   with the -d or -dd or -ddd flags to obtain the pseudocode.
 576
 577 */
 578 BOOL AirpcapSetFilter(PAirpcapHandle AdapterHandle, PVOID Instructions, UINT Len);
 579
 580 /*!
 581   \brief Return the MAC address of an adapter.
 582   \param AdapterHandle Handle to the adapter.
 583   \param PMacAddress Pointer to a user allocated MAC address.
 584    The size of this buffer needs to be at least 6 bytes.
 585   \return TRUE on success.
 586 */
 587 BOOL AirpcapGetMacAddress(PAirpcapHandle AdapterHandle, PAirpcapMacAddress PMacAddress);
 588
 589 /*!
 590   \brief Set the mintocopy parameter for an open adapter
 591   \param AdapterHandle Handle to the adapter.
 592   \param MinToCopy is the mintocopy size in bytes.
 593   \return TRUE on success.
 594
 595   When the number of bytes in the kernel buffer changes from less than mintocopy bytes to greater than or equal to mintocopy bytes,
 596   the read event is signalled (see \ref AirpcapGetReadEvent()). A high value for mintocopy results in poor responsiveness since the
 597   driver may signal the application "long" after the arrival of the packet. And a high value results in low CPU loading
 598   by minimizing the number of user/kernel context switches.
 599   A low MinToCopy results in good responsiveness since the driver will signal the application close to the arrival time of
 600   the packet. This has higher CPU loading over the first approach.
 601 */
 602 BOOL AirpcapSetMinToCopy(PAirpcapHandle AdapterHandle, UINT MinToCopy);
 603
 604 /*!
 605   \brief Gets an event that is signaled when that is signalled when packets are available in the kernel buffer (see \ref AirpcapSetMinToCopy()).
 606   \param AdapterHandle Handle to the adapter.
 607   \param PReadEvent Pointer to a user-supplied handle that in which the read event will be copied.
 608   \return TRUE on success.
 609
 610   \note the event is signalled when at least mintocopy bytes are present in the kernel buffer (see \ref AirpcapSetMinToCopy()).
 611   This event can be used by WaitForSingleObject() and WaitForMultipleObjects() to create blocking behavior when reading
 612   packets from one or more adapters (see \ref AirpcapRead()).
 613 */
 614 BOOL AirpcapGetReadEvent(PAirpcapHandle AdapterHandle, HANDLE* PReadEvent);
 615
 616 /*!
 617   \brief Fills a user-provided buffer with zero or more packets that have been captured on the referenced adapter.
 618   \param AdapterHandle Handle to the adapter.
 619   \param Buffer pointer to the buffer that will be filled with captured packets.
 620   \param BufSize size of the input buffer that will contain the packets, in bytes.
 621   \param PReceievedBytes Pointer to a user supplied variable that will receive the number of bytes copied by AirpcapRead.
 622   Can be smaller than BufSize.
 623   \return TRUE on success.
 624
 625   802.11 frames are returned by the driver in buffers. Every 802.11 frame in the buffer is preceded by a \ref AirpcapBpfHeader structure.
 626   The suggested way to use an AirPcap adapter is through the pcap API exported by wpcap.dll. If this is not
 627   possible, the Capture_radio and Capture_no_radio examples in the AirPcap developer's pack show how to properly decode the
 628   packets in the read buffer returned by AirpcapRead().
 629
 630   \note this function is NOT blocking. Blocking behavior can be obtained using the event returned
 631    by \ref AirpcapGetReadEvent(). See also \ref AirpcapSetMinToCopy().
 632 */
 633 BOOL AirpcapRead(PAirpcapHandle AdapterHandle, PBYTE Buffer, UINT BufSize, PUINT PReceievedBytes);
 634
 635 /*!
 636   \brief Get per-adapter WinPcap-compatible capture statistics.
 637   \param AdapterHandle Handle to the adapter.
 638   \param PStats pointer to a user-allocated AirpcapStats structure that will be filled with statistical information.
 639   \return TRUE on success.
 640 */
 641 BOOL AirpcapGetStats(PAirpcapHandle AdapterHandle, PAirpcapStats PStats);
 642
 643 /*!
 644   \brief Get the number of LEDs the referenced adapter has available.
 645   \param AdapterHandle Handle to the adapter.
 646   \param NumberOfLeds Number of LEDs available on this adapter.
 647   \return TRUE on success.
 648 */
 649 BOOL AirpcapGetLedsNumber(PAirpcapHandle AdapterHandle, PUINT NumberOfLeds);
 650
 651 /*!
 652   \brief Turn on one of the adapter's LEDs.
 653   \param AdapterHandle Handle to the adapter.
 654   \param LedNumber zero-based identifier of the LED to turn on.
 655   \return TRUE on success.
 656 */
 657 BOOL AirpcapTurnLedOn(PAirpcapHandle AdapterHandle, UINT LedNumber);
 658
 659 /*!
 660   \brief Turn off one of the adapter's LEDs.
 661   \param AdapterHandle Handle to the adapter.
 662   \param LedNumber zero-based identifier of the LED to turn off.
 663   \return TRUE on success.
 664 */
 665 BOOL AirpcapTurnLedOff(PAirpcapHandle AdapterHandle, UINT LedNumber);
 666
 667 /*@}*/
 668
 669 #endif /* __AIRPCAP_DRIVER__ */
 670
 671 #ifdef __cplusplus
 672 }
 673 #endif
 674
 675 #endif /* !defined(AIRPCAP_H__EAE405F5_0171_9592_B3C2_C19EC426AD34__INCLUDED_) */