src/common/defs.h

   1 /*
   2  * WPA Supplicant - Common definitions
   3  * Copyright (c) 2004-2008, Jouni Malinen <j@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 enum wpa_alg {
  83         WPA_ALG_NONE,
  84         WPA_ALG_WEP,
  85         WPA_ALG_TKIP,
  86         WPA_ALG_CCMP,
  87         WPA_ALG_IGTK,
  88         WPA_ALG_PMK
  89 };
  90
  91 /**
  92  * enum wpa_cipher - Cipher suites
  93  */
  94 enum wpa_cipher {
  95         CIPHER_NONE,
  96         CIPHER_WEP40,
  97         CIPHER_TKIP,
  98         CIPHER_CCMP,
  99         CIPHER_WEP104
 100 };
 101
 102 /**
 103  * enum wpa_key_mgmt - Key management suites
 104  */
 105 enum wpa_key_mgmt {
 106         KEY_MGMT_802_1X,
 107         KEY_MGMT_PSK,
 108         KEY_MGMT_NONE,
 109         KEY_MGMT_802_1X_NO_WPA,
 110         KEY_MGMT_WPA_NONE,
 111         KEY_MGMT_FT_802_1X,
 112         KEY_MGMT_FT_PSK,
 113         KEY_MGMT_802_1X_SHA256,
 114         KEY_MGMT_PSK_SHA256,
 115         KEY_MGMT_WPS
 116 };
 117
 118 /**
 119  * enum wpa_states - wpa_supplicant state
 120  *
 121  * These enumeration values are used to indicate the current wpa_supplicant
 122  * state (wpa_s->wpa_state). The current state can be retrieved with
 123  * wpa_supplicant_get_state() function and the state can be changed by calling
 124  * wpa_supplicant_set_state(). In WPA state machine (wpa.c and preauth.c), the
 125  * wrapper functions wpa_sm_get_state() and wpa_sm_set_state() should be used
 126  * to access the state variable.
 127  */
 128 enum wpa_states {
 129         /**
 130          * WPA_DISCONNECTED - Disconnected state
 131          *
 132          * This state indicates that client is not associated, but is likely to
 133          * start looking for an access point. This state is entered when a
 134          * connection is lost.
 135          */
 136         WPA_DISCONNECTED,
 137
 138         /**
 139          * WPA_INACTIVE - Inactive state (wpa_supplicant disabled)
 140          *
 141          * This state is entered if there are no enabled networks in the
 142          * configuration. wpa_supplicant is not trying to associate with a new
 143          * network and external interaction (e.g., ctrl_iface call to add or
 144          * enable a network) is needed to start association.
 145          */
 146         WPA_INACTIVE,
 147
 148         /**
 149          * WPA_SCANNING - Scanning for a network
 150          *
 151          * This state is entered when wpa_supplicant starts scanning for a
 152          * network.
 153          */
 154         WPA_SCANNING,
 155
 156         /**
 157          * WPA_AUTHENTICATING - Trying to authenticate with a BSS/SSID
 158          *
 159          * This state is entered when wpa_supplicant has found a suitable BSS
 160          * to authenticate with and the driver is configured to try to
 161          * authenticate with this BSS. This state is used only with drivers
 162          * that use wpa_supplicant as the SME.
 163          */
 164         WPA_AUTHENTICATING,
 165
 166         /**
 167          * WPA_ASSOCIATING - Trying to associate with a BSS/SSID
 168          *
 169          * This state is entered when wpa_supplicant has found a suitable BSS
 170          * to associate with and the driver is configured to try to associate
 171          * with this BSS in ap_scan=1 mode. When using ap_scan=2 mode, this
 172          * state is entered when the driver is configured to try to associate
 173          * with a network using the configured SSID and security policy.
 174          */
 175         WPA_ASSOCIATING,
 176
 177         /**
 178          * WPA_ASSOCIATED - Association completed
 179          *
 180          * This state is entered when the driver reports that association has
 181          * been successfully completed with an AP. If IEEE 802.1X is used
 182          * (with or without WPA/WPA2), wpa_supplicant remains in this state
 183          * until the IEEE 802.1X/EAPOL authentication has been completed.
 184          */
 185         WPA_ASSOCIATED,
 186
 187         /**
 188          * WPA_4WAY_HANDSHAKE - WPA 4-Way Key Handshake in progress
 189          *
 190          * This state is entered when WPA/WPA2 4-Way Handshake is started. In
 191          * case of WPA-PSK, this happens when receiving the first EAPOL-Key
 192          * frame after association. In case of WPA-EAP, this state is entered
 193          * when the IEEE 802.1X/EAPOL authentication has been completed.
 194          */
 195         WPA_4WAY_HANDSHAKE,
 196
 197         /**
 198          * WPA_GROUP_HANDSHAKE - WPA Group Key Handshake in progress
 199          *
 200          * This state is entered when 4-Way Key Handshake has been completed
 201          * (i.e., when the supplicant sends out message 4/4) and when Group
 202          * Key rekeying is started by the AP (i.e., when supplicant receives
 203          * message 1/2).
 204          */
 205         WPA_GROUP_HANDSHAKE,
 206
 207         /**
 208          * WPA_COMPLETED - All authentication completed
 209          *
 210          * This state is entered when the full authentication process is
 211          * completed. In case of WPA2, this happens when the 4-Way Handshake is
 212          * successfully completed. With WPA, this state is entered after the
 213          * Group Key Handshake; with IEEE 802.1X (non-WPA) connection is
 214          * completed after dynamic keys are received (or if not used, after
 215          * the EAP authentication has been completed). With static WEP keys and
 216          * plaintext connections, this state is entered when an association
 217          * has been completed.
 218          *
 219          * This state indicates that the supplicant has completed its
 220          * processing for the association phase and that data connection is
 221          * fully configured.
 222          */
 223         WPA_COMPLETED
 224 };
 225
 226 #define MLME_SETPROTECTION_PROTECT_TYPE_NONE 0
 227 #define MLME_SETPROTECTION_PROTECT_TYPE_RX 1
 228 #define MLME_SETPROTECTION_PROTECT_TYPE_TX 2
 229 #define MLME_SETPROTECTION_PROTECT_TYPE_RX_TX 3
 230
 231 #define MLME_SETPROTECTION_KEY_TYPE_GROUP 0
 232 #define MLME_SETPROTECTION_KEY_TYPE_PAIRWISE 1
 233
 234
 235 /**
 236  * enum mfp_options - Management frame protection (IEEE 802.11w) options
 237  */
 238 enum mfp_options {
 239         NO_MGMT_FRAME_PROTECTION = 0,
 240         MGMT_FRAME_PROTECTION_OPTIONAL = 1,
 241         MGMT_FRAME_PROTECTION_REQUIRED = 2
 242 };
 243
 244 /**
 245  * enum hostapd_hw_mode - Hardware mode
 246  */
 247 enum hostapd_hw_mode {
 248         HOSTAPD_MODE_IEEE80211B,
 249         HOSTAPD_MODE_IEEE80211G,
 250         HOSTAPD_MODE_IEEE80211A,
 251         NUM_HOSTAPD_MODES
 252 };
 253
 254 #endif /* DEFS_H */