Home | History | Annotate | Download | only in common
      1 /*
      2  * WPA Supplicant - Common definitions
      3  * Copyright (c) 2004-2008, Jouni Malinen <j (at) w1.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 #define WPA_CIPHER_NONE BIT(0)
     28 #define WPA_CIPHER_WEP40 BIT(1)
     29 #define WPA_CIPHER_WEP104 BIT(2)
     30 #define WPA_CIPHER_TKIP BIT(3)
     31 #define WPA_CIPHER_CCMP BIT(4)
     32 #ifdef CONFIG_IEEE80211W
     33 #define WPA_CIPHER_AES_128_CMAC BIT(5)
     34 #endif /* CONFIG_IEEE80211W */
     35 
     36 #define WPA_KEY_MGMT_IEEE8021X BIT(0)
     37 #define WPA_KEY_MGMT_PSK BIT(1)
     38 #define WPA_KEY_MGMT_NONE BIT(2)
     39 #define WPA_KEY_MGMT_IEEE8021X_NO_WPA BIT(3)
     40 #define WPA_KEY_MGMT_WPA_NONE BIT(4)
     41 #define WPA_KEY_MGMT_FT_IEEE8021X BIT(5)
     42 #define WPA_KEY_MGMT_FT_PSK BIT(6)
     43 #define WPA_KEY_MGMT_IEEE8021X_SHA256 BIT(7)
     44 #define WPA_KEY_MGMT_PSK_SHA256 BIT(8)
     45 #define WPA_KEY_MGMT_WPS BIT(9)
     46 
     47 static inline int wpa_key_mgmt_wpa_ieee8021x(int akm)
     48 {
     49 	return akm == WPA_KEY_MGMT_IEEE8021X ||
     50 		akm == WPA_KEY_MGMT_FT_IEEE8021X ||
     51 		akm == WPA_KEY_MGMT_IEEE8021X_SHA256;
     52 }
     53 
     54 static inline int wpa_key_mgmt_wpa_psk(int akm)
     55 {
     56 	return akm == WPA_KEY_MGMT_PSK ||
     57 		akm == WPA_KEY_MGMT_FT_PSK ||
     58 		akm == WPA_KEY_MGMT_PSK_SHA256;
     59 }
     60 
     61 static inline int wpa_key_mgmt_ft(int akm)
     62 {
     63 	return akm == WPA_KEY_MGMT_FT_PSK ||
     64 		akm == WPA_KEY_MGMT_FT_IEEE8021X;
     65 }
     66 
     67 static inline int wpa_key_mgmt_sha256(int akm)
     68 {
     69 	return akm == WPA_KEY_MGMT_PSK_SHA256 ||
     70 		akm == WPA_KEY_MGMT_IEEE8021X_SHA256;
     71 }
     72 
     73 
     74 #define WPA_PROTO_WPA BIT(0)
     75 #define WPA_PROTO_RSN BIT(1)
     76 
     77 #define WPA_AUTH_ALG_OPEN BIT(0)
     78 #define WPA_AUTH_ALG_SHARED BIT(1)
     79 #define WPA_AUTH_ALG_LEAP BIT(2)
     80 
     81 
     82 typedef enum { WPA_ALG_NONE, WPA_ALG_WEP, WPA_ALG_TKIP, WPA_ALG_CCMP,
     83 	       WPA_ALG_IGTK, WPA_ALG_PMK } wpa_alg;
     84 typedef enum { CIPHER_NONE, CIPHER_WEP40, CIPHER_TKIP, CIPHER_CCMP,
     85 	       CIPHER_WEP104 } wpa_cipher;
     86 typedef enum { KEY_MGMT_802_1X, KEY_MGMT_PSK, KEY_MGMT_NONE,
     87 	       KEY_MGMT_802_1X_NO_WPA, KEY_MGMT_WPA_NONE,
     88 	       KEY_MGMT_FT_802_1X, KEY_MGMT_FT_PSK,
     89 	       KEY_MGMT_802_1X_SHA256, KEY_MGMT_PSK_SHA256,
     90 	       KEY_MGMT_WPS
     91 } wpa_key_mgmt;
     92 
     93 /**
     94  * enum wpa_states - wpa_supplicant state
     95  *
     96  * These enumeration values are used to indicate the current wpa_supplicant
     97  * state (wpa_s->wpa_state). The current state can be retrieved with
     98  * wpa_supplicant_get_state() function and the state can be changed by calling
     99  * wpa_supplicant_set_state(). In WPA state machine (wpa.c and preauth.c), the
    100  * wrapper functions wpa_sm_get_state() and wpa_sm_set_state() should be used
    101  * to access the state variable.
    102  */
    103 typedef enum {
    104 	/**
    105 	 * WPA_DISCONNECTED - Disconnected state
    106 	 *
    107 	 * This state indicates that client is not associated, but is likely to
    108 	 * start looking for an access point. This state is entered when a
    109 	 * connection is lost.
    110 	 */
    111 	WPA_DISCONNECTED,
    112 
    113 	/**
    114 	 * WPA_INACTIVE - Inactive state (wpa_supplicant disabled)
    115 	 *
    116 	 * This state is entered if there are no enabled networks in the
    117 	 * configuration. wpa_supplicant is not trying to associate with a new
    118 	 * network and external interaction (e.g., ctrl_iface call to add or
    119 	 * enable a network) is needed to start association.
    120 	 */
    121 	WPA_INACTIVE,
    122 
    123 	/**
    124 	 * WPA_SCANNING - Scanning for a network
    125 	 *
    126 	 * This state is entered when wpa_supplicant starts scanning for a
    127 	 * network.
    128 	 */
    129 	WPA_SCANNING,
    130 
    131 	/**
    132 	 * WPA_ASSOCIATING - Trying to associate with a BSS/SSID
    133 	 *
    134 	 * This state is entered when wpa_supplicant has found a suitable BSS
    135 	 * to associate with and the driver is configured to try to associate
    136 	 * with this BSS in ap_scan=1 mode. When using ap_scan=2 mode, this
    137 	 * state is entered when the driver is configured to try to associate
    138 	 * with a network using the configured SSID and security policy.
    139 	 */
    140 	WPA_ASSOCIATING,
    141 
    142 	/**
    143 	 * WPA_ASSOCIATED - Association completed
    144 	 *
    145 	 * This state is entered when the driver reports that association has
    146 	 * been successfully completed with an AP. If IEEE 802.1X is used
    147 	 * (with or without WPA/WPA2), wpa_supplicant remains in this state
    148 	 * until the IEEE 802.1X/EAPOL authentication has been completed.
    149 	 */
    150 	WPA_ASSOCIATED,
    151 
    152 	/**
    153 	 * WPA_4WAY_HANDSHAKE - WPA 4-Way Key Handshake in progress
    154 	 *
    155 	 * This state is entered when WPA/WPA2 4-Way Handshake is started. In
    156 	 * case of WPA-PSK, this happens when receiving the first EAPOL-Key
    157 	 * frame after association. In case of WPA-EAP, this state is entered
    158 	 * when the IEEE 802.1X/EAPOL authentication has been completed.
    159 	 */
    160 	WPA_4WAY_HANDSHAKE,
    161 
    162 	/**
    163 	 * WPA_GROUP_HANDSHAKE - WPA Group Key Handshake in progress
    164 	 *
    165 	 * This state is entered when 4-Way Key Handshake has been completed
    166 	 * (i.e., when the supplicant sends out message 4/4) and when Group
    167 	 * Key rekeying is started by the AP (i.e., when supplicant receives
    168 	 * message 1/2).
    169 	 */
    170 	WPA_GROUP_HANDSHAKE,
    171 
    172 	/**
    173 	 * WPA_COMPLETED - All authentication completed
    174 	 *
    175 	 * This state is entered when the full authentication process is
    176 	 * completed. In case of WPA2, this happens when the 4-Way Handshake is
    177 	 * successfully completed. With WPA, this state is entered after the
    178 	 * Group Key Handshake; with IEEE 802.1X (non-WPA) connection is
    179 	 * completed after dynamic keys are received (or if not used, after
    180 	 * the EAP authentication has been completed). With static WEP keys and
    181 	 * plaintext connections, this state is entered when an association
    182 	 * has been completed.
    183 	 *
    184 	 * This state indicates that the supplicant has completed its
    185 	 * processing for the association phase and that data connection is
    186 	 * fully configured.
    187 	 */
    188 	WPA_COMPLETED
    189 
    190 #ifdef ANDROID
    191 	/**
    192 	 * WPA_IDLE - Eeplicit disconnect was performed
    193 	 *
    194 	 * This state is entered when a disconnect command is issued to the
    195 	 * supplicant. In this case, the supplicant not only disassociates
    196 	 * from the current network, but it also stops trying to associate
    197 	 * with any AP until a subsequent reconnect or reassociate command
    198 	 * is issued. This state was added to distinguish it from the
    199 	 * WPA_DISCONNECTED state, which is now reserved for disconnects
    200 	 * that were not explicitly requested by a client.
    201 	 * This state is reported to clients, but it is not internally stored.
    202 	 */
    203 	, WPA_IDLE
    204 #endif /* ANDROID */
    205 } wpa_states;
    206 
    207 #define MLME_SETPROTECTION_PROTECT_TYPE_NONE 0
    208 #define MLME_SETPROTECTION_PROTECT_TYPE_RX 1
    209 #define MLME_SETPROTECTION_PROTECT_TYPE_TX 2
    210 #define MLME_SETPROTECTION_PROTECT_TYPE_RX_TX 3
    211 
    212 #define MLME_SETPROTECTION_KEY_TYPE_GROUP 0
    213 #define MLME_SETPROTECTION_KEY_TYPE_PAIRWISE 1
    214 
    215 #endif /* DEFS_H */
    216