Re-initialize hostapd/wpa_supplicant git repository based on 0.6.3 release
[wpasupplicant] / src / common / defs.h
1 /*
2  * WPA Supplicant - Common definitions
3  * Copyright (c) 2004-2007, 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
44 #define WPA_PROTO_WPA BIT(0)
45 #define WPA_PROTO_RSN BIT(1)
46
47 #define WPA_AUTH_ALG_OPEN BIT(0)
48 #define WPA_AUTH_ALG_SHARED BIT(1)
49 #define WPA_AUTH_ALG_LEAP BIT(2)
50
51
52 typedef enum { WPA_ALG_NONE, WPA_ALG_WEP, WPA_ALG_TKIP, WPA_ALG_CCMP,
53                WPA_ALG_IGTK, WPA_ALG_PMK } wpa_alg;
54 typedef enum { CIPHER_NONE, CIPHER_WEP40, CIPHER_TKIP, CIPHER_CCMP,
55                CIPHER_WEP104 } wpa_cipher;
56 typedef enum { KEY_MGMT_802_1X, KEY_MGMT_PSK, KEY_MGMT_NONE,
57                KEY_MGMT_802_1X_NO_WPA, KEY_MGMT_WPA_NONE,
58                KEY_MGMT_FT_802_1X, KEY_MGMT_FT_PSK
59 } wpa_key_mgmt;
60
61 /**
62  * enum wpa_states - wpa_supplicant state
63  *
64  * These enumeration values are used to indicate the current wpa_supplicant
65  * state (wpa_s->wpa_state). The current state can be retrieved with
66  * wpa_supplicant_get_state() function and the state can be changed by calling
67  * wpa_supplicant_set_state(). In WPA state machine (wpa.c and preauth.c), the
68  * wrapper functions wpa_sm_get_state() and wpa_sm_set_state() should be used
69  * to access the state variable.
70  */
71 typedef enum {
72         /**
73          * WPA_DISCONNECTED - Disconnected state
74          *
75          * This state indicates that client is not associated, but is likely to
76          * start looking for an access point. This state is entered when a
77          * connection is lost.
78          */
79         WPA_DISCONNECTED,
80
81         /**
82          * WPA_INACTIVE - Inactive state (wpa_supplicant disabled)
83          *
84          * This state is entered if there are no enabled networks in the
85          * configuration. wpa_supplicant is not trying to associate with a new
86          * network and external interaction (e.g., ctrl_iface call to add or
87          * enable a network) is needed to start association.
88          */
89         WPA_INACTIVE,
90
91         /**
92          * WPA_SCANNING - Scanning for a network
93          *
94          * This state is entered when wpa_supplicant starts scanning for a
95          * network.
96          */
97         WPA_SCANNING,
98
99         /**
100          * WPA_ASSOCIATING - Trying to associate with a BSS/SSID
101          *
102          * This state is entered when wpa_supplicant has found a suitable BSS
103          * to associate with and the driver is configured to try to associate
104          * with this BSS in ap_scan=1 mode. When using ap_scan=2 mode, this
105          * state is entered when the driver is configured to try to associate
106          * with a network using the configured SSID and security policy.
107          */
108         WPA_ASSOCIATING,
109
110         /**
111          * WPA_ASSOCIATED - Association completed
112          *
113          * This state is entered when the driver reports that association has
114          * been successfully completed with an AP. If IEEE 802.1X is used
115          * (with or without WPA/WPA2), wpa_supplicant remains in this state
116          * until the IEEE 802.1X/EAPOL authentication has been completed.
117          */
118         WPA_ASSOCIATED,
119
120         /**
121          * WPA_4WAY_HANDSHAKE - WPA 4-Way Key Handshake in progress
122          *
123          * This state is entered when WPA/WPA2 4-Way Handshake is started. In
124          * case of WPA-PSK, this happens when receiving the first EAPOL-Key
125          * frame after association. In case of WPA-EAP, this state is entered
126          * when the IEEE 802.1X/EAPOL authentication has been completed.
127          */
128         WPA_4WAY_HANDSHAKE,
129
130         /**
131          * WPA_GROUP_HANDSHAKE - WPA Group Key Handshake in progress
132          *
133          * This state is entered when 4-Way Key Handshake has been completed
134          * (i.e., when the supplicant sends out message 4/4) and when Group
135          * Key rekeying is started by the AP (i.e., when supplicant receives
136          * message 1/2).
137          */
138         WPA_GROUP_HANDSHAKE,
139
140         /**
141          * WPA_COMPLETED - All authentication completed
142          *
143          * This state is entered when the full authentication process is
144          * completed. In case of WPA2, this happens when the 4-Way Handshake is
145          * successfully completed. With WPA, this state is entered after the
146          * Group Key Handshake; with IEEE 802.1X (non-WPA) connection is
147          * completed after dynamic keys are received (or if not used, after
148          * the EAP authentication has been completed). With static WEP keys and
149          * plaintext connections, this state is entered when an association
150          * has been completed.
151          *
152          * This state indicates that the supplicant has completed its
153          * processing for the association phase and that data connection is
154          * fully configured.
155          */
156         WPA_COMPLETED
157 } wpa_states;
158
159 #define MLME_SETPROTECTION_PROTECT_TYPE_NONE 0
160 #define MLME_SETPROTECTION_PROTECT_TYPE_RX 1
161 #define MLME_SETPROTECTION_PROTECT_TYPE_TX 2
162 #define MLME_SETPROTECTION_PROTECT_TYPE_RX_TX 3
163
164 #define MLME_SETPROTECTION_KEY_TYPE_GROUP 0
165 #define MLME_SETPROTECTION_KEY_TYPE_PAIRWISE 1
166
167 #endif /* DEFS_H */