contrib/wpa_supplicant-0.4.9/defs.h

   1 /*
   2  * WPA Supplicant - Common definitions
   3  * Copyright (c) 2004-2005, Jouni Malinen <jkmaline@cc.hut.fi>
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License version 2 as
   7  * published by the Free Software Foundation.
   8  *
   9  * Alternatively, this software may be distributed under the terms of BSD
  10  * license.
  11  *
  12  * See README and COPYING for more details.
  13  */
  14
  15 #ifndef DEFS_H
  16 #define DEFS_H
  17
  18 #ifdef FALSE
  19 #undef FALSE
  20 #endif
  21 #ifdef TRUE
  22 #undef TRUE
  23 #endif
  24 typedef enum { FALSE = 0, TRUE = 1 } Boolean;
  25
  26
  27 typedef enum { WPA_ALG_NONE, WPA_ALG_WEP, WPA_ALG_TKIP, WPA_ALG_CCMP } wpa_alg;
  28 typedef enum { CIPHER_NONE, CIPHER_WEP40, CIPHER_TKIP, CIPHER_CCMP,
  29                CIPHER_WEP104 } wpa_cipher;
  30 typedef enum { KEY_MGMT_802_1X, KEY_MGMT_PSK, KEY_MGMT_NONE,
  31                KEY_MGMT_802_1X_NO_WPA, KEY_MGMT_WPA_NONE } wpa_key_mgmt;
  32
  33 /**
  34  * enum wpa_states - wpa_supplicant state
  35  *
  36  * These enumeration values are used to indicate the current wpa_supplicant
  37  * state (wpa_s->wpa_state). The current state can be retrieved with
  38  * wpa_supplicant_get_state() function and the state can be changed by calling
  39  * wpa_supplicant_set_state(). In WPA state machine (wpa.c and preauth.c), the
  40  * wrapper functions wpa_sm_get_state() and wpa_sm_set_state() should be used
  41  * to access the state variable.
  42  */
  43 typedef enum {
  44         /**
  45          * WPA_DISCONNECTED - Disconnected state
  46          *
  47          * This state indicates that client is not associated, but is likely to
  48          * start looking for an access point. This state is entered when a
  49          * connection is lost.
  50          */
  51         WPA_DISCONNECTED,
  52
  53         /**
  54          * WPA_INACTIVE - Inactive state (wpa_supplicant disabled)
  55          *
  56          * This state is entered if there are no enabled networks in the
  57          * configuration. wpa_supplicant is not trying to associate with a new
  58          * network and external interaction (e.g., ctrl_iface call to add or
  59          * enable a network) is needed to start association.
  60          */
  61         WPA_INACTIVE,
  62
  63         /**
  64          * WPA_SCANNING - Scanning for a network
  65          *
  66          * This state is entered when wpa_supplicant starts scanning for a
  67          * network.
  68          */
  69         WPA_SCANNING,
  70
  71         /**
  72          * WPA_ASSOCIATING - Trying to associate with a BSS/SSID
  73          *
  74          * This state is entered when wpa_supplicant has found a suitable BSS
  75          * to associate with and the driver is configured to try to associate
  76          * with this BSS in ap_scan=1 mode. When using ap_scan=2 mode, this
  77          * state is entered when the driver is configured to try to associate
  78          * with a network using the configured SSID and security policy.
  79          */
  80         WPA_ASSOCIATING,
  81
  82         /**
  83          * WPA_ASSOCIATED - Association completed
  84          *
  85          * This state is entered when the driver reports that association has
  86          * been successfully completed with an AP. If IEEE 802.1X is used
  87          * (with or without WPA/WPA2), wpa_supplicant remains in this state
  88          * until the IEEE 802.1X/EAPOL authentication has been completed.
  89          */
  90         WPA_ASSOCIATED,
  91
  92         /**
  93          * WPA_4WAY_HANDSHAKE - WPA 4-Way Key Handshake in progress
  94          *
  95          * This state is entered when WPA/WPA2 4-Way Handshake is started. In
  96          * case of WPA-PSK, this happens when receiving the first EAPOL-Key
  97          * frame after association. In case of WPA-EAP, this state is entered
  98          * when the IEEE 802.1X/EAPOL authentication has been completed.
  99          */
 100         WPA_4WAY_HANDSHAKE,
 101
 102         /**
 103          * WPA_GROUP_HANDSHAKE - WPA Group Key Handshake in progress
 104          *
 105          * This state is entered when 4-Way Key Handshake has been completed
 106          * (i.e., when the supplicant sends out message 4/4) and when Group
 107          * Key rekeying is started by the AP (i.e., when supplicant receives
 108          * message 1/2).
 109          */
 110         WPA_GROUP_HANDSHAKE,
 111
 112         /**
 113          * WPA_COMPLETED - All authentication completed
 114          *
 115          * This state is entered when the full authentication process is
 116          * completed. In case of WPA2, this happens when the 4-Way Handshake is
 117          * successfully completed. With WPA, this state is entered after the
 118          * Group Key Handshake; with IEEE 802.1X (non-WPA) connection is
 119          * completed after dynamic keys are received (or if not used, after
 120          * the EAP authentication has been completed). With static WEP keys and
 121          * plaintext connections, this state is entered when an association
 122          * has been completed.
 123          *
 124          * This state indicates that the supplicant has completed its
 125          * processing for the association phase and that data connection is
 126          * fully configured.
 127          */
 128         WPA_COMPLETED
 129 } wpa_states;
 130
 131 #endif /* DEFS_H */