Commit | Line | Data |
---|---|---|
91980990 GKH |
1 | /* |
2 | ************************************************************************* | |
3 | * Ralink Tech Inc. | |
4 | * 5F., No.36, Taiyuan St., Jhubei City, | |
5 | * Hsinchu County 302, | |
6 | * Taiwan, R.O.C. | |
7 | * | |
8 | * (c) Copyright 2002-2007, Ralink Technology, Inc. | |
9 | * | |
10 | * This program is free software; you can redistribute it and/or modify * | |
11 | * it under the terms of the GNU General Public License as published by * | |
12 | * the Free Software Foundation; either version 2 of the License, or * | |
13 | * (at your option) any later version. * | |
14 | * * | |
15 | * This program is distributed in the hope that it will be useful, * | |
16 | * but WITHOUT ANY WARRANTY; without even the implied warranty of * | |
17 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * | |
18 | * GNU General Public License for more details. * | |
19 | * * | |
20 | * You should have received a copy of the GNU General Public License * | |
21 | * along with this program; if not, write to the * | |
22 | * Free Software Foundation, Inc., * | |
23 | * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * | |
24 | * * | |
25 | ************************************************************************* | |
26 | ||
27 | Module Name: | |
28 | wpa.h | |
29 | ||
30 | Abstract: | |
31 | ||
32 | Revision History: | |
33 | Who When What | |
34 | -------- ---------- ---------------------------------------------- | |
35 | Name Date Modification logs | |
36 | */ | |
37 | ||
38 | #ifndef __WPA_H__ | |
39 | #define __WPA_H__ | |
40 | ||
41 | // EAPOL Key descripter frame format related length | |
42 | #define LEN_KEY_DESC_NONCE 32 | |
43 | #define LEN_KEY_DESC_IV 16 | |
44 | #define LEN_KEY_DESC_RSC 8 | |
45 | #define LEN_KEY_DESC_ID 8 | |
46 | #define LEN_KEY_DESC_REPLAY 8 | |
47 | #define LEN_KEY_DESC_MIC 16 | |
48 | ||
49 | // The length is the EAPoL-Key frame except key data field. | |
50 | // Please refer to 802.11i-2004 ,Figure 43u in p.78 | |
51 | #define LEN_EAPOL_KEY_MSG (sizeof(KEY_DESCRIPTER) - MAX_LEN_OF_RSNIE) | |
52 | ||
53 | // EAP Code Type. | |
54 | #define EAP_CODE_REQUEST 1 | |
55 | #define EAP_CODE_RESPONSE 2 | |
56 | #define EAP_CODE_SUCCESS 3 | |
57 | #define EAP_CODE_FAILURE 4 | |
58 | ||
59 | // EAPOL frame Protocol Version | |
60 | #define EAPOL_VER 1 | |
61 | #define EAPOL_VER2 2 | |
62 | ||
63 | // EAPOL-KEY Descriptor Type | |
64 | #define WPA1_KEY_DESC 0xfe | |
65 | #define WPA2_KEY_DESC 0x02 | |
66 | ||
67 | // Key Descriptor Version of Key Information | |
68 | #define DESC_TYPE_TKIP 1 | |
69 | #define DESC_TYPE_AES 2 | |
70 | #define DESC_TYPE_MESH 3 | |
71 | ||
72 | #define LEN_MSG1_2WAY 0x7f | |
73 | #define MAX_LEN_OF_EAP_HS 256 | |
74 | ||
75 | #define LEN_MASTER_KEY 32 | |
76 | ||
77 | // EAPOL EK, MK | |
78 | #define LEN_EAP_EK 16 | |
79 | #define LEN_EAP_MICK 16 | |
80 | #define LEN_EAP_KEY ((LEN_EAP_EK)+(LEN_EAP_MICK)) | |
81 | // TKIP key related | |
82 | #define LEN_PMKID 16 | |
83 | #define LEN_TKIP_EK 16 | |
84 | #define LEN_TKIP_RXMICK 8 | |
85 | #define LEN_TKIP_TXMICK 8 | |
86 | #define LEN_AES_EK 16 | |
87 | #define LEN_AES_KEY LEN_AES_EK | |
88 | #define LEN_TKIP_KEY ((LEN_TKIP_EK)+(LEN_TKIP_RXMICK)+(LEN_TKIP_TXMICK)) | |
89 | #define TKIP_AP_TXMICK_OFFSET ((LEN_EAP_KEY)+(LEN_TKIP_EK)) | |
90 | #define TKIP_AP_RXMICK_OFFSET (TKIP_AP_TXMICK_OFFSET+LEN_TKIP_TXMICK) | |
91 | #define TKIP_GTK_LENGTH ((LEN_TKIP_EK)+(LEN_TKIP_RXMICK)+(LEN_TKIP_TXMICK)) | |
92 | #define LEN_PTK ((LEN_EAP_KEY)+(LEN_TKIP_KEY)) | |
93 | ||
94 | // RSN IE Length definition | |
95 | #define MAX_LEN_OF_RSNIE 90 | |
96 | #define MIN_LEN_OF_RSNIE 8 | |
97 | ||
98 | //EAP Packet Type | |
99 | #define EAPPacket 0 | |
100 | #define EAPOLStart 1 | |
101 | #define EAPOLLogoff 2 | |
102 | #define EAPOLKey 3 | |
103 | #define EAPOLASFAlert 4 | |
104 | #define EAPTtypeMax 5 | |
105 | ||
106 | #define EAPOL_MSG_INVALID 0 | |
107 | #define EAPOL_PAIR_MSG_1 1 | |
108 | #define EAPOL_PAIR_MSG_2 2 | |
109 | #define EAPOL_PAIR_MSG_3 3 | |
110 | #define EAPOL_PAIR_MSG_4 4 | |
111 | #define EAPOL_GROUP_MSG_1 5 | |
112 | #define EAPOL_GROUP_MSG_2 6 | |
113 | ||
114 | #define PAIRWISEKEY 1 | |
115 | #define GROUPKEY 0 | |
116 | ||
117 | // Retry timer counter initial value | |
118 | #define PEER_MSG1_RETRY_TIMER_CTR 0 | |
119 | #define PEER_MSG3_RETRY_TIMER_CTR 10 | |
120 | #define GROUP_MSG1_RETRY_TIMER_CTR 20 | |
121 | ||
122 | ||
123 | #define EAPOL_START_DISABLE 0 | |
124 | #define EAPOL_START_PSK 1 | |
125 | #define EAPOL_START_1X 2 | |
126 | ||
127 | #define MIX_CIPHER_WPA_TKIP_ON(x) (((x) & 0x08) != 0) | |
128 | #define MIX_CIPHER_WPA_AES_ON(x) (((x) & 0x04) != 0) | |
129 | #define MIX_CIPHER_WPA2_TKIP_ON(x) (((x) & 0x02) != 0) | |
130 | #define MIX_CIPHER_WPA2_AES_ON(x) (((x) & 0x01) != 0) | |
131 | ||
132 | #define ROUND_UP(__x, __y) \ | |
133 | (((ULONG)((__x)+((__y)-1))) & ((ULONG)~((__y)-1))) | |
134 | ||
135 | #define ADD_ONE_To_64BIT_VAR(_V) \ | |
136 | { \ | |
137 | UCHAR cnt = LEN_KEY_DESC_REPLAY; \ | |
138 | do \ | |
139 | { \ | |
140 | cnt--; \ | |
141 | _V[cnt]++; \ | |
142 | if (cnt == 0) \ | |
143 | break; \ | |
144 | }while (_V[cnt] == 0); \ | |
145 | } | |
146 | ||
147 | #define IS_WPA_CAPABILITY(a) (((a) >= Ndis802_11AuthModeWPA) && ((a) <= Ndis802_11AuthModeWPA1PSKWPA2PSK)) | |
148 | ||
149 | // EAPOL Key Information definition within Key descriptor format | |
150 | typedef struct PACKED _KEY_INFO | |
151 | { | |
91980990 GKH |
152 | UCHAR KeyMic:1; |
153 | UCHAR Secure:1; | |
154 | UCHAR Error:1; | |
155 | UCHAR Request:1; | |
156 | UCHAR EKD_DL:1; // EKD for AP; DL for STA | |
157 | UCHAR Rsvd:3; | |
158 | UCHAR KeyDescVer:3; | |
159 | UCHAR KeyType:1; | |
160 | UCHAR KeyIndex:2; | |
161 | UCHAR Install:1; | |
162 | UCHAR KeyAck:1; | |
91980990 GKH |
163 | } KEY_INFO, *PKEY_INFO; |
164 | ||
165 | // EAPOL Key descriptor format | |
166 | typedef struct PACKED _KEY_DESCRIPTER | |
167 | { | |
168 | UCHAR Type; | |
169 | KEY_INFO KeyInfo; | |
170 | UCHAR KeyLength[2]; | |
171 | UCHAR ReplayCounter[LEN_KEY_DESC_REPLAY]; | |
172 | UCHAR KeyNonce[LEN_KEY_DESC_NONCE]; | |
173 | UCHAR KeyIv[LEN_KEY_DESC_IV]; | |
174 | UCHAR KeyRsc[LEN_KEY_DESC_RSC]; | |
175 | UCHAR KeyId[LEN_KEY_DESC_ID]; | |
176 | UCHAR KeyMic[LEN_KEY_DESC_MIC]; | |
177 | UCHAR KeyDataLen[2]; | |
178 | UCHAR KeyData[MAX_LEN_OF_RSNIE]; | |
179 | } KEY_DESCRIPTER, *PKEY_DESCRIPTER; | |
180 | ||
181 | typedef struct PACKED _EAPOL_PACKET | |
182 | { | |
183 | UCHAR ProVer; | |
184 | UCHAR ProType; | |
185 | UCHAR Body_Len[2]; | |
186 | KEY_DESCRIPTER KeyDesc; | |
187 | } EAPOL_PACKET, *PEAPOL_PACKET; | |
188 | ||
189 | //802.11i D10 page 83 | |
190 | typedef struct PACKED _GTK_ENCAP | |
191 | { | |
91980990 GKH |
192 | UCHAR Kid:2; |
193 | UCHAR tx:1; | |
194 | UCHAR rsv:5; | |
195 | UCHAR rsv1; | |
91980990 GKH |
196 | UCHAR GTK[TKIP_GTK_LENGTH]; |
197 | } GTK_ENCAP, *PGTK_ENCAP; | |
198 | ||
199 | typedef struct PACKED _KDE_ENCAP | |
200 | { | |
201 | UCHAR Type; | |
202 | UCHAR Len; | |
203 | UCHAR OUI[3]; | |
204 | UCHAR DataType; | |
205 | GTK_ENCAP GTKEncap; | |
206 | } KDE_ENCAP, *PKDE_ENCAP; | |
207 | ||
208 | // For WPA1 | |
209 | typedef struct PACKED _RSNIE { | |
210 | UCHAR oui[4]; | |
211 | USHORT version; | |
212 | UCHAR mcast[4]; | |
213 | USHORT ucount; | |
214 | struct PACKED { | |
215 | UCHAR oui[4]; | |
216 | }ucast[1]; | |
217 | } RSNIE, *PRSNIE; | |
218 | ||
219 | // For WPA2 | |
220 | typedef struct PACKED _RSNIE2 { | |
221 | USHORT version; | |
222 | UCHAR mcast[4]; | |
223 | USHORT ucount; | |
224 | struct PACKED { | |
225 | UCHAR oui[4]; | |
226 | }ucast[1]; | |
227 | } RSNIE2, *PRSNIE2; | |
228 | ||
229 | // AKM Suite | |
230 | typedef struct PACKED _RSNIE_AUTH { | |
231 | USHORT acount; | |
232 | struct PACKED { | |
233 | UCHAR oui[4]; | |
234 | }auth[1]; | |
235 | } RSNIE_AUTH,*PRSNIE_AUTH; | |
236 | ||
237 | typedef union PACKED _RSN_CAPABILITIES { | |
238 | struct PACKED { | |
91980990 GKH |
239 | USHORT PreAuth:1; |
240 | USHORT No_Pairwise:1; | |
241 | USHORT PTKSA_R_Counter:2; | |
242 | USHORT GTKSA_R_Counter:2; | |
243 | USHORT Rsvd:10; | |
91980990 GKH |
244 | } field; |
245 | USHORT word; | |
246 | } RSN_CAPABILITIES, *PRSN_CAPABILITIES; | |
247 | ||
248 | typedef struct PACKED _EAP_HDR { | |
249 | UCHAR ProVer; | |
250 | UCHAR ProType; | |
251 | UCHAR Body_Len[2]; | |
252 | UCHAR code; | |
253 | UCHAR identifier; | |
254 | UCHAR length[2]; // including code and identifier, followed by length-2 octets of data | |
255 | } EAP_HDR, *PEAP_HDR; | |
256 | ||
257 | // For supplicant state machine states. 802.11i Draft 4.1, p. 97 | |
258 | // We simplified it | |
259 | typedef enum _WpaState | |
260 | { | |
261 | SS_NOTUSE, // 0 | |
262 | SS_START, // 1 | |
263 | SS_WAIT_MSG_3, // 2 | |
264 | SS_WAIT_GROUP, // 3 | |
265 | SS_FINISH, // 4 | |
266 | SS_KEYUPDATE, // 5 | |
267 | } WPA_STATE; | |
268 | ||
269 | // | |
270 | // The definition of the cipher combination | |
271 | // | |
272 | // bit3 bit2 bit1 bit0 | |
273 | // +------------+------------+ | |
274 | // | WPA | WPA2 | | |
275 | // +------+-----+------+-----+ | |
276 | // | TKIP | AES | TKIP | AES | | |
277 | // | 0 | 1 | 1 | 0 | -> 0x06 | |
278 | // | 0 | 1 | 1 | 1 | -> 0x07 | |
279 | // | 1 | 0 | 0 | 1 | -> 0x09 | |
280 | // | 1 | 0 | 1 | 1 | -> 0x0B | |
281 | // | 1 | 1 | 0 | 1 | -> 0x0D | |
282 | // | 1 | 1 | 1 | 0 | -> 0x0E | |
283 | // | 1 | 1 | 1 | 1 | -> 0x0F | |
284 | // +------+-----+------+-----+ | |
285 | // | |
286 | typedef enum _WpaMixPairCipher | |
287 | { | |
288 | MIX_CIPHER_NOTUSE = 0x00, | |
289 | WPA_NONE_WPA2_TKIPAES = 0x03, // WPA2-TKIPAES | |
290 | WPA_AES_WPA2_TKIP = 0x06, | |
291 | WPA_AES_WPA2_TKIPAES = 0x07, | |
292 | WPA_TKIP_WPA2_AES = 0x09, | |
293 | WPA_TKIP_WPA2_TKIPAES = 0x0B, | |
294 | WPA_TKIPAES_WPA2_NONE = 0x0C, // WPA-TKIPAES | |
295 | WPA_TKIPAES_WPA2_AES = 0x0D, | |
296 | WPA_TKIPAES_WPA2_TKIP = 0x0E, | |
297 | WPA_TKIPAES_WPA2_TKIPAES = 0x0F, | |
298 | } WPA_MIX_PAIR_CIPHER; | |
299 | ||
300 | typedef struct PACKED _RSN_IE_HEADER_STRUCT { | |
301 | UCHAR Eid; | |
302 | UCHAR Length; | |
303 | USHORT Version; // Little endian format | |
304 | } RSN_IE_HEADER_STRUCT, *PRSN_IE_HEADER_STRUCT; | |
305 | ||
306 | // Cipher suite selector types | |
307 | typedef struct PACKED _CIPHER_SUITE_STRUCT { | |
308 | UCHAR Oui[3]; | |
309 | UCHAR Type; | |
310 | } CIPHER_SUITE_STRUCT, *PCIPHER_SUITE_STRUCT; | |
311 | ||
312 | // Authentication and Key Management suite selector | |
313 | typedef struct PACKED _AKM_SUITE_STRUCT { | |
314 | UCHAR Oui[3]; | |
315 | UCHAR Type; | |
316 | } AKM_SUITE_STRUCT, *PAKM_SUITE_STRUCT; | |
317 | ||
318 | // RSN capability | |
319 | typedef struct PACKED _RSN_CAPABILITY { | |
320 | USHORT Rsv:10; | |
321 | USHORT GTKSAReplayCnt:2; | |
322 | USHORT PTKSAReplayCnt:2; | |
323 | USHORT NoPairwise:1; | |
324 | USHORT PreAuth:1; | |
325 | } RSN_CAPABILITY, *PRSN_CAPABILITY; | |
326 | ||
327 | #endif |