2 *************************************************************************
4 * 5F., No.36, Taiyuan St., Jhubei City,
8 * (c) Copyright 2002-2007, Ralink Technology, Inc.
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. *
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. *
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. *
25 *************************************************************************
34 -------- ---------- ----------------------------------------------
35 Jan Lee 03-07-22 Initial
36 Paul Lin 03-11-28 Modify for supplicant
38 #include "../rt_config.h"
40 UCHAR OUI_WPA_NONE_AKM[4] = {0x00, 0x50, 0xF2, 0x00};
41 UCHAR OUI_WPA_VERSION[4] = {0x00, 0x50, 0xF2, 0x01};
42 UCHAR OUI_WPA_TKIP[4] = {0x00, 0x50, 0xF2, 0x02};
43 UCHAR OUI_WPA_CCMP[4] = {0x00, 0x50, 0xF2, 0x04};
44 UCHAR OUI_WPA_8021X_AKM[4] = {0x00, 0x50, 0xF2, 0x01};
45 UCHAR OUI_WPA_PSK_AKM[4] = {0x00, 0x50, 0xF2, 0x02};
47 UCHAR OUI_WPA2_WEP40[4] = {0x00, 0x0F, 0xAC, 0x01};
48 UCHAR OUI_WPA2_TKIP[4] = {0x00, 0x0F, 0xAC, 0x02};
49 UCHAR OUI_WPA2_CCMP[4] = {0x00, 0x0F, 0xAC, 0x04};
50 UCHAR OUI_WPA2_8021X_AKM[4] = {0x00, 0x0F, 0xAC, 0x01};
51 UCHAR OUI_WPA2_PSK_AKM[4] = {0x00, 0x0F, 0xAC, 0x02};
53 UCHAR OUI_MSA_8021X_AKM[4] = {0x00, 0x0F, 0xAC, 0x05}; // Not yet final - IEEE 802.11s-D1.06
54 UCHAR OUI_MSA_PSK_AKM[4] = {0x00, 0x0F, 0xAC, 0x06}; // Not yet final - IEEE 802.11s-D1.06
57 ========================================================================
60 The pseudo-random function(PRF) that hashes various inputs to
61 derive a pseudo-random value. To add liveness to the pseudo-random
62 value, a nonce should be one of the inputs.
64 It is used to generate PTK, GTK or some specific random value.
67 UCHAR *key, - the key material for HMAC_SHA1 use
68 INT key_len - the length of key
69 UCHAR *prefix - a prefix label
70 INT prefix_len - the length of the label
71 UCHAR *data - a specific data with variable length
72 INT data_len - the length of a specific data
73 INT len - the output lenght
76 UCHAR *output - the calculated result
79 802.11i-2004 Annex H.3
81 ========================================================================
98 // Allocate memory for input
99 os_alloc_mem(NULL, (PUCHAR *)&input, 1024);
103 DBGPRINT(RT_DEBUG_ERROR, ("!!!PRF: no memory!!!\n"));
107 // Generate concatenation input
108 NdisMoveMemory(input, prefix, prefix_len);
110 // Concatenate a single octet containing 0
111 input[prefix_len] = 0;
113 // Concatenate specific data
114 NdisMoveMemory(&input[prefix_len + 1], data, data_len);
115 total_len = prefix_len + 1 + data_len;
117 // Concatenate a single octet containing 0
118 // This octet shall be update later
119 input[total_len] = 0;
122 // Iterate to calculate the result by hmac-sha-1
123 // Then concatenate to last result
124 for (i = 0; i < (len + 19) / 20; i++)
126 HMAC_SHA1(input, total_len, key, key_len, &output[currentindex]);
129 // update the last octet
130 input[total_len - 1]++;
132 os_free_mem(NULL, input);
136 ========================================================================
139 It utilizes PRF-384 or PRF-512 to derive session-specific keys from a PMK.
140 It shall be called by 4-way handshake processing.
143 pAd - pointer to our pAdapter context
145 ANonce - pointer to ANonce
146 AA - pointer to Authenticator Address
147 SNonce - pointer to SNonce
148 SA - pointer to Supplicant Address
149 len - indicate the length of PTK (octet)
152 Output pointer to the PTK
155 Refer to IEEE 802.11i-2004 8.5.1.2
157 ========================================================================
160 IN PRTMP_ADAPTER pAd,
169 UCHAR concatenation[76];
172 UCHAR Prefix[] = {'P', 'a', 'i', 'r', 'w', 'i', 's', 'e', ' ', 'k', 'e', 'y', ' ',
173 'e', 'x', 'p', 'a', 'n', 's', 'i', 'o', 'n'};
175 // initiate the concatenation input
176 NdisZeroMemory(temp, sizeof(temp));
177 NdisZeroMemory(concatenation, 76);
179 // Get smaller address
180 if (RTMPCompareMemory(SA, AA, 6) == 1)
181 NdisMoveMemory(concatenation, AA, 6);
183 NdisMoveMemory(concatenation, SA, 6);
186 // Get larger address
187 if (RTMPCompareMemory(SA, AA, 6) == 1)
188 NdisMoveMemory(&concatenation[CurrPos], SA, 6);
190 NdisMoveMemory(&concatenation[CurrPos], AA, 6);
192 // store the larger mac address for backward compatible of
193 // ralink proprietary STA-key issue
194 NdisMoveMemory(temp, &concatenation[CurrPos], MAC_ADDR_LEN);
198 if (RTMPCompareMemory(ANonce, SNonce, 32) == 0)
199 NdisMoveMemory(&concatenation[CurrPos], temp, 32); // patch for ralink proprietary STA-key issue
200 else if (RTMPCompareMemory(ANonce, SNonce, 32) == 1)
201 NdisMoveMemory(&concatenation[CurrPos], SNonce, 32);
203 NdisMoveMemory(&concatenation[CurrPos], ANonce, 32);
207 if (RTMPCompareMemory(ANonce, SNonce, 32) == 0)
208 NdisMoveMemory(&concatenation[CurrPos], temp, 32); // patch for ralink proprietary STA-key issue
209 else if (RTMPCompareMemory(ANonce, SNonce, 32) == 1)
210 NdisMoveMemory(&concatenation[CurrPos], ANonce, 32);
212 NdisMoveMemory(&concatenation[CurrPos], SNonce, 32);
215 hex_dump("concatenation=", concatenation, 76);
217 // Use PRF to generate PTK
218 PRF(PMK, LEN_MASTER_KEY, Prefix, 22, concatenation, 76, output, len);
223 ========================================================================
226 Generate random number by software.
229 pAd - pointer to our pAdapter context
230 macAddr - pointer to local MAC address
235 802.1ii-2004 Annex H.5
237 ========================================================================
240 IN PRTMP_ADAPTER pAd,
245 UCHAR local[80], KeyCounter[32];
248 UCHAR prefix[] = {'I', 'n', 'i', 't', ' ', 'C', 'o', 'u', 'n', 't', 'e', 'r'};
250 // Zero the related information
251 NdisZeroMemory(result, 80);
252 NdisZeroMemory(local, 80);
253 NdisZeroMemory(KeyCounter, 32);
255 for (i = 0; i < 32; i++)
257 // copy the local MAC address
258 COPY_MAC_ADDR(local, macAddr);
261 // concatenate the current time
262 NdisGetSystemUpTime(&CurrentTime);
263 NdisMoveMemory(&local[curr], &CurrentTime, sizeof(CurrentTime));
264 curr += sizeof(CurrentTime);
266 // concatenate the last result
267 NdisMoveMemory(&local[curr], result, 32);
270 // concatenate a variable
271 NdisMoveMemory(&local[curr], &i, 2);
274 // calculate the result
275 PRF(KeyCounter, 32, prefix,12, local, curr, result, 32);
278 NdisMoveMemory(random, result, 32);
282 ========================================================================
285 Build cipher suite in RSN-IE.
286 It only shall be called by RTMPMakeRSNIE.
289 pAd - pointer to our pAdapter context
290 ElementID - indicate the WPA1 or WPA2
291 WepStatus - indicate the encryption type
292 bMixCipher - a boolean to indicate the pairwise cipher and group
293 cipher are the same or not
299 ========================================================================
301 static VOID RTMPInsertRsnIeCipher(
302 IN PRTMP_ADAPTER pAd,
305 IN BOOLEAN bMixCipher,
306 IN UCHAR FlexibleCipher,
314 // decide WPA2 or WPA1
315 if (ElementID == Wpa2Ie)
317 RSNIE2 *pRsnie_cipher = (RSNIE2*)pRsnIe;
319 // Assign the verson as 1
320 pRsnie_cipher->version = 1;
325 case Ndis802_11Encryption2Enabled:
326 NdisMoveMemory(pRsnie_cipher->mcast, OUI_WPA2_TKIP, 4);
327 pRsnie_cipher->ucount = 1;
328 NdisMoveMemory(pRsnie_cipher->ucast[0].oui, OUI_WPA2_TKIP, 4);
329 *rsn_len = sizeof(RSNIE2);
333 case Ndis802_11Encryption3Enabled:
335 NdisMoveMemory(pRsnie_cipher->mcast, OUI_WPA2_TKIP, 4);
337 NdisMoveMemory(pRsnie_cipher->mcast, OUI_WPA2_CCMP, 4);
338 pRsnie_cipher->ucount = 1;
339 NdisMoveMemory(pRsnie_cipher->ucast[0].oui, OUI_WPA2_CCMP, 4);
340 *rsn_len = sizeof(RSNIE2);
344 case Ndis802_11Encryption4Enabled:
345 NdisMoveMemory(pRsnie_cipher->mcast, OUI_WPA2_TKIP, 4);
348 // Insert WPA2 TKIP as the first pairwise cipher
349 if (MIX_CIPHER_WPA2_TKIP_ON(FlexibleCipher))
351 NdisMoveMemory(pRsnie_cipher->ucast[0].oui, OUI_WPA2_TKIP, 4);
352 // Insert WPA2 AES as the secondary pairwise cipher
353 if (MIX_CIPHER_WPA2_AES_ON(FlexibleCipher))
355 NdisMoveMemory(pRsnie_cipher->ucast[0].oui + 4, OUI_WPA2_CCMP, 4);
361 // Insert WPA2 AES as the first pairwise cipher
362 NdisMoveMemory(pRsnie_cipher->ucast[0].oui, OUI_WPA2_CCMP, 4);
365 pRsnie_cipher->ucount = PairwiseCnt;
366 *rsn_len = sizeof(RSNIE2) + (4 * (PairwiseCnt - 1));
370 // swap for big-endian platform
371 pRsnie_cipher->version = cpu2le16(pRsnie_cipher->version);
372 pRsnie_cipher->ucount = cpu2le16(pRsnie_cipher->ucount);
376 RSNIE *pRsnie_cipher = (RSNIE*)pRsnIe;
378 // Assign OUI and version
379 NdisMoveMemory(pRsnie_cipher->oui, OUI_WPA_VERSION, 4);
380 pRsnie_cipher->version = 1;
385 case Ndis802_11Encryption2Enabled:
386 NdisMoveMemory(pRsnie_cipher->mcast, OUI_WPA_TKIP, 4);
387 pRsnie_cipher->ucount = 1;
388 NdisMoveMemory(pRsnie_cipher->ucast[0].oui, OUI_WPA_TKIP, 4);
389 *rsn_len = sizeof(RSNIE);
393 case Ndis802_11Encryption3Enabled:
395 NdisMoveMemory(pRsnie_cipher->mcast, OUI_WPA_TKIP, 4);
397 NdisMoveMemory(pRsnie_cipher->mcast, OUI_WPA_CCMP, 4);
398 pRsnie_cipher->ucount = 1;
399 NdisMoveMemory(pRsnie_cipher->ucast[0].oui, OUI_WPA_CCMP, 4);
400 *rsn_len = sizeof(RSNIE);
404 case Ndis802_11Encryption4Enabled:
405 NdisMoveMemory(pRsnie_cipher->mcast, OUI_WPA_TKIP, 4);
408 // Insert WPA TKIP as the first pairwise cipher
409 if (MIX_CIPHER_WPA_TKIP_ON(FlexibleCipher))
411 NdisMoveMemory(pRsnie_cipher->ucast[0].oui, OUI_WPA_TKIP, 4);
412 // Insert WPA AES as the secondary pairwise cipher
413 if (MIX_CIPHER_WPA_AES_ON(FlexibleCipher))
415 NdisMoveMemory(pRsnie_cipher->ucast[0].oui + 4, OUI_WPA_CCMP, 4);
421 // Insert WPA AES as the first pairwise cipher
422 NdisMoveMemory(pRsnie_cipher->ucast[0].oui, OUI_WPA_CCMP, 4);
425 pRsnie_cipher->ucount = PairwiseCnt;
426 *rsn_len = sizeof(RSNIE) + (4 * (PairwiseCnt - 1));
430 // swap for big-endian platform
431 pRsnie_cipher->version = cpu2le16(pRsnie_cipher->version);
432 pRsnie_cipher->ucount = cpu2le16(pRsnie_cipher->ucount);
438 ========================================================================
441 Build AKM suite in RSN-IE.
442 It only shall be called by RTMPMakeRSNIE.
445 pAd - pointer to our pAdapter context
446 ElementID - indicate the WPA1 or WPA2
447 AuthMode - indicate the authentication mode
448 apidx - indicate the interface index
454 ========================================================================
456 static VOID RTMPInsertRsnIeAKM(
457 IN PRTMP_ADAPTER pAd,
464 RSNIE_AUTH *pRsnie_auth;
466 pRsnie_auth = (RSNIE_AUTH*)(pRsnIe + (*rsn_len));
468 // decide WPA2 or WPA1
469 if (ElementID == Wpa2Ie)
473 case Ndis802_11AuthModeWPA2:
474 case Ndis802_11AuthModeWPA1WPA2:
475 pRsnie_auth->acount = 1;
476 NdisMoveMemory(pRsnie_auth->auth[0].oui, OUI_WPA2_8021X_AKM, 4);
479 case Ndis802_11AuthModeWPA2PSK:
480 case Ndis802_11AuthModeWPA1PSKWPA2PSK:
481 pRsnie_auth->acount = 1;
482 NdisMoveMemory(pRsnie_auth->auth[0].oui, OUI_WPA2_PSK_AKM, 4);
490 case Ndis802_11AuthModeWPA:
491 case Ndis802_11AuthModeWPA1WPA2:
492 pRsnie_auth->acount = 1;
493 NdisMoveMemory(pRsnie_auth->auth[0].oui, OUI_WPA_8021X_AKM, 4);
496 case Ndis802_11AuthModeWPAPSK:
497 case Ndis802_11AuthModeWPA1PSKWPA2PSK:
498 pRsnie_auth->acount = 1;
499 NdisMoveMemory(pRsnie_auth->auth[0].oui, OUI_WPA_PSK_AKM, 4);
502 case Ndis802_11AuthModeWPANone:
503 pRsnie_auth->acount = 1;
504 NdisMoveMemory(pRsnie_auth->auth[0].oui, OUI_WPA_NONE_AKM, 4);
509 pRsnie_auth->acount = cpu2le16(pRsnie_auth->acount);
511 (*rsn_len) += sizeof(RSNIE_AUTH); // update current RSNIE length
516 ========================================================================
519 Build capability in RSN-IE.
520 It only shall be called by RTMPMakeRSNIE.
523 pAd - pointer to our pAdapter context
524 ElementID - indicate the WPA1 or WPA2
525 apidx - indicate the interface index
531 ========================================================================
533 static VOID RTMPInsertRsnIeCap(
534 IN PRTMP_ADAPTER pAd,
540 RSN_CAPABILITIES *pRSN_Cap;
542 // it could be ignored in WPA1 mode
543 if (ElementID == WpaIe)
546 pRSN_Cap = (RSN_CAPABILITIES*)(pRsnIe + (*rsn_len));
549 pRSN_Cap->word = cpu2le16(pRSN_Cap->word);
551 (*rsn_len) += sizeof(RSN_CAPABILITIES); // update current RSNIE length
557 ========================================================================
560 Build RSN IE context. It is not included element-ID and length.
563 pAd - pointer to our pAdapter context
564 AuthMode - indicate the authentication mode
565 WepStatus - indicate the encryption type
566 apidx - indicate the interface index
572 ========================================================================
575 IN PRTMP_ADAPTER pAd,
580 PUCHAR pRsnIe = NULL; // primary RSNIE
581 UCHAR *rsnielen_cur_p = 0; // the length of the primary RSNIE
582 UCHAR *rsnielen_ex_cur_p = 0; // the length of the secondary RSNIE
584 BOOLEAN bMixCipher = FALSE; // indicate the pairwise and group cipher are different
586 WPA_MIX_PAIR_CIPHER FlexibleCipher = MIX_CIPHER_NOTUSE; // it provide the more flexible cipher combination in WPA-WPA2 and TKIPAES mode
588 rsnielen_cur_p = NULL;
589 rsnielen_ex_cur_p = NULL;
593 if (pAd->StaCfg.WpaSupplicantUP != WPA_SUPPLICANT_DISABLE)
595 if (AuthMode < Ndis802_11AuthModeWPA)
600 // Support WPAPSK or WPA2PSK in STA-Infra mode
601 // Support WPANone in STA-Adhoc mode
602 if ((AuthMode != Ndis802_11AuthModeWPAPSK) &&
603 (AuthMode != Ndis802_11AuthModeWPA2PSK) &&
604 (AuthMode != Ndis802_11AuthModeWPANone)
609 DBGPRINT(RT_DEBUG_TRACE,("==> RTMPMakeRSNIE(STA)\n"));
611 // Zero RSNIE context
612 pAd->StaCfg.RSNIE_Len = 0;
613 NdisZeroMemory(pAd->StaCfg.RSN_IE, MAX_LEN_OF_RSNIE);
616 rsnielen_cur_p = &pAd->StaCfg.RSNIE_Len;
617 pRsnIe = pAd->StaCfg.RSN_IE;
619 bMixCipher = pAd->StaCfg.bMixCipher;
623 // indicate primary RSNIE as WPA or WPA2
624 if ((AuthMode == Ndis802_11AuthModeWPA) ||
625 (AuthMode == Ndis802_11AuthModeWPAPSK) ||
626 (AuthMode == Ndis802_11AuthModeWPANone) ||
627 (AuthMode == Ndis802_11AuthModeWPA1WPA2) ||
628 (AuthMode == Ndis802_11AuthModeWPA1PSKWPA2PSK))
629 PrimaryRsnie = WpaIe;
631 PrimaryRsnie = Wpa2Ie;
634 // Build the primary RSNIE
635 // 1. insert cipher suite
636 RTMPInsertRsnIeCipher(pAd, PrimaryRsnie, WepStatus, bMixCipher, FlexibleCipher, pRsnIe, &p_offset);
639 RTMPInsertRsnIeAKM(pAd, PrimaryRsnie, AuthMode, apidx, pRsnIe, &p_offset);
641 // 3. insert capability
642 RTMPInsertRsnIeCap(pAd, PrimaryRsnie, apidx, pRsnIe, &p_offset);
645 // 4. update the RSNIE length
646 *rsnielen_cur_p = p_offset;
648 hex_dump("The primary RSNIE", pRsnIe, (*rsnielen_cur_p));
654 ==========================================================================
656 Check whether the received frame is EAP frame.
659 pAd - pointer to our pAdapter context
660 pEntry - pointer to active entry
661 pData - the received frame
662 DataByteCount - the received frame's length
663 FromWhichBSSID - indicate the interface index
666 TRUE - This frame is EAP frame
668 ==========================================================================
670 BOOLEAN RTMPCheckWPAframe(
671 IN PRTMP_ADAPTER pAd,
672 IN PMAC_TABLE_ENTRY pEntry,
674 IN ULONG DataByteCount,
675 IN UCHAR FromWhichBSSID)
681 if(DataByteCount < (LENGTH_802_1_H + LENGTH_EAPOL_H))
686 if (NdisEqualMemory(SNAP_802_1H, pData, 6) ||
687 // Cisco 1200 AP may send packet with SNAP_BRIDGE_TUNNEL
688 NdisEqualMemory(SNAP_BRIDGE_TUNNEL, pData, 6))
692 // Skip 2-bytes EAPoL type
693 if (NdisEqualMemory(EAPOL, pData, 2))
703 Body_len = (*(pData+2)<<8) | (*(pData+3));
704 DBGPRINT(RT_DEBUG_TRACE, ("Receive EAP-Packet frame, TYPE = 0, Length = %ld\n", Body_len));
707 DBGPRINT(RT_DEBUG_TRACE, ("Receive EAPOL-Start frame, TYPE = 1 \n"));
708 if (pEntry->EnqueueEapolStartTimerRunning != EAPOL_START_DISABLE)
710 DBGPRINT(RT_DEBUG_TRACE, ("Cancel the EnqueueEapolStartTimerRunning \n"));
711 RTMPCancelTimer(&pEntry->EnqueueStartForPSKTimer, &Cancelled);
712 pEntry->EnqueueEapolStartTimerRunning = EAPOL_START_DISABLE;
716 DBGPRINT(RT_DEBUG_TRACE, ("Receive EAPOLLogoff frame, TYPE = 2 \n"));
719 Body_len = (*(pData+2)<<8) | (*(pData+3));
720 DBGPRINT(RT_DEBUG_TRACE, ("Receive EAPOL-Key frame, TYPE = 3, Length = %ld\n", Body_len));
723 DBGPRINT(RT_DEBUG_TRACE, ("Receive EAPOLASFAlert frame, TYPE = 4 \n"));
734 ==========================================================================
736 ENCRYPT AES GTK before sending in EAPOL frame.
737 AES GTK length = 128 bit, so fix blocks for aes-key-wrap as 2 in this function.
738 This function references to RFC 3394 for aes key wrap algorithm.
740 ==========================================================================
742 VOID AES_GTK_KEY_WRAP(
746 OUT UCHAR *ciphertext)
748 UCHAR A[8], BIN[16], BOUT[16];
750 INT num_blocks = p_len/8; // unit:64bits
755 rtmp_aes_set_key(&aesctx, key, 128);
758 for (i = 0; i < 8; i++)
762 for (i = 0; i < num_blocks; i++)
764 for (j = 0 ; j < 8; j++)
765 R[8 * (i + 1) + j] = plaintext[8 * i + j];
769 for (j = 0; j < 6; j++)
771 for(i = 1; i <= num_blocks; i++)
774 NdisMoveMemory(BIN, A, 8);
775 NdisMoveMemory(&BIN[8], &R[8 * i], 8);
776 rtmp_aes_encrypt(&aesctx, BIN, BOUT);
778 NdisMoveMemory(A, &BOUT[0], 8);
779 xor = num_blocks * j + i;
780 A[7] = BOUT[7] ^ xor;
781 NdisMoveMemory(&R[8 * i], &BOUT[8], 8);
786 NdisMoveMemory(ciphertext, A, 8);
788 for (i = 1; i <= num_blocks; i++)
790 for (j = 0 ; j < 8; j++)
791 ciphertext[8 * i + j] = R[8 * i + j];
797 ========================================================================
800 Misc function to decrypt AES body
807 This function references to RFC 3394 for aes key unwrap algorithm.
809 ========================================================================
811 VOID AES_GTK_KEY_UNWRAP(
813 OUT UCHAR *plaintext,
815 IN UCHAR *ciphertext)
818 UCHAR A[8], BIN[16], BOUT[16];
823 INT num_blocks = c_len/8; // unit:64bits
826 os_alloc_mem(NULL, (PUCHAR *)&R, 512);
830 DBGPRINT(RT_DEBUG_ERROR, ("!!!AES_GTK_KEY_UNWRAP: no memory!!!\n"));
835 NdisMoveMemory(A, ciphertext, 8);
837 for(i = 0; i < (c_len-8); i++)
839 R[ i] = ciphertext[i + 8];
842 rtmp_aes_set_key(&aesctx, key, 128);
844 for(j = 5; j >= 0; j--)
846 for(i = (num_blocks-1); i > 0; i--)
848 xor = (num_blocks -1 )* j + i;
849 NdisMoveMemory(BIN, A, 8);
851 NdisMoveMemory(&BIN[8], &R[(i-1)*8], 8);
852 rtmp_aes_decrypt(&aesctx, BIN, BOUT);
853 NdisMoveMemory(A, &BOUT[0], 8);
854 NdisMoveMemory(&R[(i-1)*8], &BOUT[8], 8);
859 for(i = 0; i < c_len; i++)
865 os_free_mem(NULL, R);
869 ==========================================================================
871 Report the EAP message type
874 msg - EAPOL_PAIR_MSG_1
884 ==========================================================================
886 CHAR *GetEapolMsgType(CHAR msg)
888 if(msg == EAPOL_PAIR_MSG_1)
889 return "Pairwise Message 1";
890 else if(msg == EAPOL_PAIR_MSG_2)
891 return "Pairwise Message 2";
892 else if(msg == EAPOL_PAIR_MSG_3)
893 return "Pairwise Message 3";
894 else if(msg == EAPOL_PAIR_MSG_4)
895 return "Pairwise Message 4";
896 else if(msg == EAPOL_GROUP_MSG_1)
897 return "Group Message 1";
898 else if(msg == EAPOL_GROUP_MSG_2)
899 return "Group Message 2";
901 return "Invalid Message";
906 ========================================================================
909 Check Sanity RSN IE of EAPoL message
916 ========================================================================
918 BOOLEAN RTMPCheckRSNIE(
919 IN PRTMP_ADAPTER pAd,
922 IN MAC_TABLE_ENTRY *pEntry,
928 BOOLEAN result = FALSE;
934 while (len > sizeof(RSNIE2))
936 pEid = (PEID_STRUCT) pVIE;
938 if ((pEid->Eid == IE_WPA) && (NdisEqualMemory(pEid->Octet, WPA_OUI, 4)))
940 if ((pEntry->AuthMode == Ndis802_11AuthModeWPA || pEntry->AuthMode == Ndis802_11AuthModeWPAPSK) &&
941 (NdisEqualMemory(pVIE, pEntry->RSN_IE, pEntry->RSNIE_Len)) &&
942 (pEntry->RSNIE_Len == (pEid->Len + 2)))
947 *Offset += (pEid->Len + 2);
950 else if ((pEid->Eid == IE_RSN) && (NdisEqualMemory(pEid->Octet + 2, RSN_OUI, 3)))
952 if ((pEntry->AuthMode == Ndis802_11AuthModeWPA2 || pEntry->AuthMode == Ndis802_11AuthModeWPA2PSK) &&
953 (NdisEqualMemory(pVIE, pEntry->RSN_IE, pEntry->RSNIE_Len)) &&
954 (pEntry->RSNIE_Len == (pEid->Len + 2))/* ToDo-AlbertY for mesh*/)
959 *Offset += (pEid->Len + 2);
966 pVIE += (pEid->Len + 2);
967 len -= (pEid->Len + 2);
977 ========================================================================
980 Parse KEYDATA field. KEYDATA[] May contain 2 RSN IE and optionally GTK.
981 GTK is encaptulated in KDE format at p.83 802.11i D10
990 ========================================================================
992 BOOLEAN RTMPParseEapolKeyData(
993 IN PRTMP_ADAPTER pAd,
996 IN UCHAR GroupKeyIndex,
999 IN MAC_TABLE_ENTRY *pEntry)
1001 PKDE_ENCAP pKDE = NULL;
1002 PUCHAR pMyKeyData = pKeyData;
1003 UCHAR KeyDataLength = KeyDataLen;
1005 UCHAR DefaultIdx = 0;
1008 // Verify The RSN IE contained in pairewise_msg_2 && pairewise_msg_3 and skip it
1009 if (MsgType == EAPOL_PAIR_MSG_2 || MsgType == EAPOL_PAIR_MSG_3)
1011 // Check RSN IE whether it is WPA2/WPA2PSK
1012 if (!RTMPCheckRSNIE(pAd, pKeyData, KeyDataLen, pEntry, &skip_offset))
1014 // send wireless event - for RSN IE different
1015 if (pAd->CommonCfg.bWirelessEvent)
1016 RTMPSendWirelessEvent(pAd, IW_RSNIE_DIFF_EVENT_FLAG, pEntry->Addr, pEntry->apidx, 0);
1018 DBGPRINT(RT_DEBUG_ERROR, ("RSN_IE Different in msg %d of 4-way handshake!\n", MsgType));
1019 hex_dump("Receive RSN_IE ", pKeyData, KeyDataLen);
1020 hex_dump("Desired RSN_IE ", pEntry->RSN_IE, pEntry->RSNIE_Len);
1026 if (bWPA2 && MsgType == EAPOL_PAIR_MSG_3)
1029 pMyKeyData += skip_offset;
1030 KeyDataLength -= skip_offset;
1031 DBGPRINT(RT_DEBUG_TRACE, ("RTMPParseEapolKeyData ==> WPA2/WPA2PSK RSN IE matched in Msg 3, Length(%d) \n", skip_offset));
1038 DBGPRINT(RT_DEBUG_TRACE,("RTMPParseEapolKeyData ==> KeyDataLength %d without RSN_IE \n", KeyDataLength));
1040 // Parse EKD format in pairwise_msg_3_WPA2 && group_msg_1_WPA2
1041 if (bWPA2 && (MsgType == EAPOL_PAIR_MSG_3 || MsgType == EAPOL_GROUP_MSG_1))
1043 if (KeyDataLength >= 8) // KDE format exclude GTK length
1045 pKDE = (PKDE_ENCAP) pMyKeyData;
1048 DefaultIdx = pKDE->GTKEncap.Kid;
1050 // Sanity check - KED length
1051 if (KeyDataLength < (pKDE->Len + 2))
1053 DBGPRINT(RT_DEBUG_ERROR, ("ERROR: The len from KDE is too short \n"));
1057 // Get GTK length - refer to IEEE 802.11i-2004 p.82
1058 GTKLEN = pKDE->Len -6;
1059 if (GTKLEN < LEN_AES_KEY)
1061 DBGPRINT(RT_DEBUG_ERROR, ("ERROR: GTK Key length is too short (%d) \n", GTKLEN));
1068 DBGPRINT(RT_DEBUG_ERROR, ("ERROR: KDE format length is too short \n"));
1072 DBGPRINT(RT_DEBUG_TRACE, ("GTK in KDE format ,DefaultKeyID=%d, KeyLen=%d \n", DefaultIdx, GTKLEN));
1078 else if (!bWPA2 && MsgType == EAPOL_GROUP_MSG_1)
1080 DefaultIdx = GroupKeyIndex;
1081 DBGPRINT(RT_DEBUG_TRACE, ("GTK DefaultKeyID=%d \n", DefaultIdx));
1084 // Sanity check - shared key index must be 1 ~ 3
1085 if (DefaultIdx < 1 || DefaultIdx > 3)
1087 DBGPRINT(RT_DEBUG_ERROR, ("ERROR: GTK Key index(%d) is invalid in %s %s \n", DefaultIdx, ((bWPA2) ? "WPA2" : "WPA"), GetEapolMsgType(MsgType)));
1097 ========================================================================
1099 Routine Description:
1100 Construct EAPoL message for WPA handshaking
1101 Its format is below,
1103 +--------------------+
1104 | Protocol Version | 1 octet
1105 +--------------------+
1106 | Protocol Type | 1 octet
1107 +--------------------+
1108 | Body Length | 2 octets
1109 +--------------------+
1110 | Descriptor Type | 1 octet
1111 +--------------------+
1112 | Key Information | 2 octets
1113 +--------------------+
1114 | Key Length | 1 octet
1115 +--------------------+
1116 | Key Repaly Counter | 8 octets
1117 +--------------------+
1118 | Key Nonce | 32 octets
1119 +--------------------+
1120 | Key IV | 16 octets
1121 +--------------------+
1122 | Key RSC | 8 octets
1123 +--------------------+
1124 | Key ID or Reserved | 8 octets
1125 +--------------------+
1126 | Key MIC | 16 octets
1127 +--------------------+
1128 | Key Data Length | 2 octets
1129 +--------------------+
1130 | Key Data | n octets
1131 +--------------------+
1135 pAd Pointer to our adapter
1142 ========================================================================
1144 VOID ConstructEapolMsg(
1145 IN PRTMP_ADAPTER pAd,
1148 IN UCHAR GroupKeyWepStatus,
1150 IN UCHAR DefaultKeyIdx,
1151 IN UCHAR *ReplayCounter,
1158 OUT PEAPOL_PACKET pMsg)
1160 BOOLEAN bWPA2 = FALSE;
1162 // Choose WPA2 or not
1163 if ((AuthMode == Ndis802_11AuthModeWPA2) || (AuthMode == Ndis802_11AuthModeWPA2PSK))
1166 // Init Packet and Fill header
1167 pMsg->ProVer = EAPOL_VER;
1168 pMsg->ProType = EAPOLKey;
1170 // Default 95 bytes, the EAPoL-Key descriptor exclude Key-data field
1171 pMsg->Body_Len[1] = LEN_EAPOL_KEY_MSG;
1173 // Fill in EAPoL descriptor
1175 pMsg->KeyDesc.Type = WPA2_KEY_DESC;
1177 pMsg->KeyDesc.Type = WPA1_KEY_DESC;
1179 // Fill in Key information, refer to IEEE Std 802.11i-2004 page 78
1180 // When either the pairwise or the group cipher is AES, the DESC_TYPE_AES(2) shall be used.
1181 pMsg->KeyDesc.KeyInfo.KeyDescVer =
1182 (((WepStatus == Ndis802_11Encryption3Enabled) || (GroupKeyWepStatus == Ndis802_11Encryption3Enabled)) ? (DESC_TYPE_AES) : (DESC_TYPE_TKIP));
1184 // Specify Key Type as Group(0) or Pairwise(1)
1185 if (MsgType >= EAPOL_GROUP_MSG_1)
1186 pMsg->KeyDesc.KeyInfo.KeyType = GROUPKEY;
1188 pMsg->KeyDesc.KeyInfo.KeyType = PAIRWISEKEY;
1190 // Specify Key Index, only group_msg1_WPA1
1191 if (!bWPA2 && (MsgType >= EAPOL_GROUP_MSG_1))
1192 pMsg->KeyDesc.KeyInfo.KeyIndex = DefaultKeyIdx;
1194 if (MsgType == EAPOL_PAIR_MSG_3)
1195 pMsg->KeyDesc.KeyInfo.Install = 1;
1197 if ((MsgType == EAPOL_PAIR_MSG_1) || (MsgType == EAPOL_PAIR_MSG_3) || (MsgType == EAPOL_GROUP_MSG_1))
1198 pMsg->KeyDesc.KeyInfo.KeyAck = 1;
1200 if (MsgType != EAPOL_PAIR_MSG_1)
1201 pMsg->KeyDesc.KeyInfo.KeyMic = 1;
1203 if ((bWPA2 && (MsgType >= EAPOL_PAIR_MSG_3)) || (!bWPA2 && (MsgType >= EAPOL_GROUP_MSG_1)))
1205 pMsg->KeyDesc.KeyInfo.Secure = 1;
1208 if (bWPA2 && ((MsgType == EAPOL_PAIR_MSG_3) || (MsgType == EAPOL_GROUP_MSG_1)))
1210 pMsg->KeyDesc.KeyInfo.EKD_DL = 1;
1213 // key Information element has done.
1214 *(USHORT *)(&pMsg->KeyDesc.KeyInfo) = cpu2le16(*(USHORT *)(&pMsg->KeyDesc.KeyInfo));
1216 // Fill in Key Length
1218 if (MsgType >= EAPOL_GROUP_MSG_1)
1220 // the length of group key cipher
1221 pMsg->KeyDesc.KeyLength[1] = ((GroupKeyWepStatus == Ndis802_11Encryption2Enabled) ? TKIP_GTK_LENGTH : LEN_AES_KEY);
1225 // the length of pairwise key cipher
1226 pMsg->KeyDesc.KeyLength[1] = ((WepStatus == Ndis802_11Encryption2Enabled) ? LEN_TKIP_KEY : LEN_AES_KEY);
1230 // Fill in replay counter
1231 NdisMoveMemory(pMsg->KeyDesc.ReplayCounter, ReplayCounter, LEN_KEY_DESC_REPLAY);
1233 // Fill Key Nonce field
1234 // ANonce : pairwise_msg1 & pairwise_msg3
1235 // SNonce : pairwise_msg2
1236 // GNonce : group_msg1_wpa1
1237 if ((MsgType <= EAPOL_PAIR_MSG_3) || ((!bWPA2 && (MsgType == EAPOL_GROUP_MSG_1))))
1238 NdisMoveMemory(pMsg->KeyDesc.KeyNonce, KeyNonce, LEN_KEY_DESC_NONCE);
1240 // Fill key IV - WPA2 as 0, WPA1 as random
1241 if (!bWPA2 && (MsgType == EAPOL_GROUP_MSG_1))
1243 // Suggest IV be random number plus some number,
1244 NdisMoveMemory(pMsg->KeyDesc.KeyIv, &KeyNonce[16], LEN_KEY_DESC_IV);
1245 pMsg->KeyDesc.KeyIv[15] += 2;
1248 // Fill Key RSC field
1249 // It contains the RSC for the GTK being installed.
1250 if ((MsgType == EAPOL_PAIR_MSG_3 && bWPA2) || (MsgType == EAPOL_GROUP_MSG_1))
1252 NdisMoveMemory(pMsg->KeyDesc.KeyRsc, TxRSC, 6);
1255 // Clear Key MIC field for MIC calculation later
1256 NdisZeroMemory(pMsg->KeyDesc.KeyMic, LEN_KEY_DESC_MIC);
1258 ConstructEapolKeyData(pAd,
1271 // Calculate MIC and fill in KeyMic Field except Pairwise Msg 1.
1272 if (MsgType != EAPOL_PAIR_MSG_1)
1274 CalculateMIC(pAd, WepStatus, PTK, pMsg);
1277 DBGPRINT(RT_DEBUG_TRACE, ("===> ConstructEapolMsg for %s %s\n", ((bWPA2) ? "WPA2" : "WPA"), GetEapolMsgType(MsgType)));
1278 DBGPRINT(RT_DEBUG_TRACE, (" Body length = %d \n", pMsg->Body_Len[1]));
1279 DBGPRINT(RT_DEBUG_TRACE, (" Key length = %d \n", pMsg->KeyDesc.KeyLength[1]));
1285 ========================================================================
1287 Routine Description:
1288 Construct the Key Data field of EAPoL message
1291 pAd Pointer to our adapter
1299 ========================================================================
1301 VOID ConstructEapolKeyData(
1302 IN PRTMP_ADAPTER pAd,
1305 IN UCHAR GroupKeyWepStatus,
1307 IN UCHAR DefaultKeyIdx,
1308 IN BOOLEAN bWPA2Capable,
1313 OUT PEAPOL_PACKET pMsg)
1315 UCHAR *mpool, *Key_Data, *Rc4GTK;
1316 UCHAR ekey[(LEN_KEY_DESC_IV+LEN_EAP_EK)];
1320 if (MsgType == EAPOL_PAIR_MSG_1 || MsgType == EAPOL_PAIR_MSG_4 || MsgType == EAPOL_GROUP_MSG_2)
1323 // allocate memory pool
1324 os_alloc_mem(pAd, (PUCHAR *)&mpool, 1500);
1329 /* Rc4GTK Len = 512 */
1330 Rc4GTK = (UCHAR *) ROUND_UP(mpool, 4);
1331 /* Key_Data Len = 512 */
1332 Key_Data = (UCHAR *) ROUND_UP(Rc4GTK + 512, 4);
1334 NdisZeroMemory(Key_Data, 512);
1335 pMsg->KeyDesc.KeyDataLen[1] = 0;
1338 // Encapsulate RSNIE in pairwise_msg2 & pairwise_msg3
1339 if (RSNIE_LEN && ((MsgType == EAPOL_PAIR_MSG_2) || (MsgType == EAPOL_PAIR_MSG_3)))
1342 Key_Data[data_offset + 0] = IE_WPA2;
1344 Key_Data[data_offset + 0] = IE_WPA;
1346 Key_Data[data_offset + 1] = RSNIE_LEN;
1347 NdisMoveMemory(&Key_Data[data_offset + 2], RSNIE, RSNIE_LEN);
1348 data_offset += (2 + RSNIE_LEN);
1351 // Encapsulate KDE format in pairwise_msg3_WPA2 & group_msg1_WPA2
1352 if (bWPA2Capable && ((MsgType == EAPOL_PAIR_MSG_3) || (MsgType == EAPOL_GROUP_MSG_1)))
1354 // Key Data Encapsulation (KDE) format - 802.11i-2004 Figure-43w and Table-20h
1355 Key_Data[data_offset + 0] = 0xDD;
1357 if (GroupKeyWepStatus == Ndis802_11Encryption3Enabled)
1359 Key_Data[data_offset + 1] = 0x16;// 4+2+16(OUI+DataType+DataField)
1363 Key_Data[data_offset + 1] = 0x26;// 4+2+32(OUI+DataType+DataField)
1366 Key_Data[data_offset + 2] = 0x00;
1367 Key_Data[data_offset + 3] = 0x0F;
1368 Key_Data[data_offset + 4] = 0xAC;
1369 Key_Data[data_offset + 5] = 0x01;
1371 // GTK KDE format - 802.11i-2004 Figure-43x
1372 Key_Data[data_offset + 6] = (DefaultKeyIdx & 0x03);
1373 Key_Data[data_offset + 7] = 0x00; // Reserved Byte
1379 // Encapsulate GTK and encrypt the key-data field with KEK.
1380 // Only for pairwise_msg3_WPA2 and group_msg1
1381 if ((MsgType == EAPOL_PAIR_MSG_3 && bWPA2Capable) || (MsgType == EAPOL_GROUP_MSG_1))
1384 if (GroupKeyWepStatus == Ndis802_11Encryption3Enabled)
1386 NdisMoveMemory(&Key_Data[data_offset], GTK, LEN_AES_KEY);
1387 data_offset += LEN_AES_KEY;
1391 NdisMoveMemory(&Key_Data[data_offset], GTK, TKIP_GTK_LENGTH);
1392 data_offset += TKIP_GTK_LENGTH;
1395 // Still dont know why, but if not append will occur "GTK not include in MSG3"
1396 // Patch for compatibility between zero config and funk
1397 if (MsgType == EAPOL_PAIR_MSG_3 && bWPA2Capable)
1399 if (GroupKeyWepStatus == Ndis802_11Encryption3Enabled)
1401 Key_Data[data_offset + 0] = 0xDD;
1402 Key_Data[data_offset + 1] = 0;
1407 Key_Data[data_offset + 0] = 0xDD;
1408 Key_Data[data_offset + 1] = 0;
1409 Key_Data[data_offset + 2] = 0;
1410 Key_Data[data_offset + 3] = 0;
1411 Key_Data[data_offset + 4] = 0;
1412 Key_Data[data_offset + 5] = 0;
1417 // Encrypt the data material in key data field
1418 if (WepStatus == Ndis802_11Encryption3Enabled)
1420 AES_GTK_KEY_WRAP(&PTK[16], Key_Data, data_offset, Rc4GTK);
1421 // AES wrap function will grow 8 bytes in length
1426 // PREPARE Encrypted "Key DATA" field. (Encrypt GTK with RC4, usinf PTK[16]->[31] as Key, IV-field as IV)
1427 // put TxTsc in Key RSC field
1428 pAd->PrivateInfo.FCSCRC32 = PPPINITFCS32; //Init crc32.
1430 // ekey is the contanetion of IV-field, and PTK[16]->PTK[31]
1431 NdisMoveMemory(ekey, pMsg->KeyDesc.KeyIv, LEN_KEY_DESC_IV);
1432 NdisMoveMemory(&ekey[LEN_KEY_DESC_IV], &PTK[16], LEN_EAP_EK);
1433 ARCFOUR_INIT(&pAd->PrivateInfo.WEPCONTEXT, ekey, sizeof(ekey)); //INIT SBOX, KEYLEN+3(IV)
1434 pAd->PrivateInfo.FCSCRC32 = RTMP_CALC_FCS32(pAd->PrivateInfo.FCSCRC32, Key_Data, data_offset);
1435 WPAARCFOUR_ENCRYPT(&pAd->PrivateInfo.WEPCONTEXT, Rc4GTK, Key_Data, data_offset);
1438 NdisMoveMemory(pMsg->KeyDesc.KeyData, Rc4GTK, data_offset);
1442 NdisMoveMemory(pMsg->KeyDesc.KeyData, Key_Data, data_offset);
1445 // set key data length field and total length
1446 pMsg->KeyDesc.KeyDataLen[1] = data_offset;
1447 pMsg->Body_Len[1] += data_offset;
1449 os_free_mem(pAd, mpool);
1454 ========================================================================
1456 Routine Description:
1457 Calcaulate MIC. It is used during 4-ways handsharking.
1460 pAd - pointer to our pAdapter context
1461 PeerWepStatus - indicate the encryption type
1467 ========================================================================
1470 IN PRTMP_ADAPTER pAd,
1471 IN UCHAR PeerWepStatus,
1473 OUT PEAPOL_PACKET pMsg)
1477 UCHAR mic[LEN_KEY_DESC_MIC];
1480 // allocate memory for MIC calculation
1481 os_alloc_mem(pAd, (PUCHAR *)&OutBuffer, 512);
1483 if (OutBuffer == NULL)
1485 DBGPRINT(RT_DEBUG_ERROR, ("!!!CalculateMIC: no memory!!!\n"));
1489 // make a frame for calculating MIC.
1490 MakeOutgoingFrame(OutBuffer, &FrameLen,
1491 pMsg->Body_Len[1] + 4, pMsg,
1494 NdisZeroMemory(mic, sizeof(mic));
1497 if (PeerWepStatus == Ndis802_11Encryption3Enabled)
1499 HMAC_SHA1(OutBuffer, FrameLen, PTK, LEN_EAP_MICK, digest);
1500 NdisMoveMemory(mic, digest, LEN_KEY_DESC_MIC);
1504 hmac_md5(PTK, LEN_EAP_MICK, OutBuffer, FrameLen, mic);
1507 // store the calculated MIC
1508 NdisMoveMemory(pMsg->KeyDesc.KeyMic, mic, LEN_KEY_DESC_MIC);
1510 os_free_mem(pAd, OutBuffer);
1514 ========================================================================
1516 Routine Description:
1517 Some received frames can't decrypt by Asic, so decrypt them by software.
1520 pAd - pointer to our pAdapter context
1521 PeerWepStatus - indicate the encryption type
1524 NDIS_STATUS_SUCCESS - decryption successful
1525 NDIS_STATUS_FAILURE - decryption failure
1527 ========================================================================
1529 NDIS_STATUS RTMPSoftDecryptBroadCastData(
1530 IN PRTMP_ADAPTER pAd,
1532 IN NDIS_802_11_ENCRYPTION_STATUS GroupCipher,
1533 IN PCIPHER_KEY pShard_key)
1535 PRXWI_STRUC pRxWI = pRxBlk->pRxWI;
1539 // handle WEP decryption
1540 if (GroupCipher == Ndis802_11Encryption1Enabled)
1542 if (RTMPSoftDecryptWEP(pAd, pRxBlk->pData, pRxWI->MPDUtotalByteCount, pShard_key))
1545 //Minus IV[4] & ICV[4]
1546 pRxWI->MPDUtotalByteCount -= 8;
1550 DBGPRINT(RT_DEBUG_ERROR, ("ERROR : Software decrypt WEP data fails.\n"));
1551 // give up this frame
1552 return NDIS_STATUS_FAILURE;
1555 // handle TKIP decryption
1556 else if (GroupCipher == Ndis802_11Encryption2Enabled)
1558 if (RTMPSoftDecryptTKIP(pAd, pRxBlk->pData, pRxWI->MPDUtotalByteCount, 0, pShard_key))
1561 //Minus 8 bytes MIC, 8 bytes IV/EIV, 4 bytes ICV
1562 pRxWI->MPDUtotalByteCount -= 20;
1566 DBGPRINT(RT_DEBUG_ERROR, ("ERROR : RTMPSoftDecryptTKIP Failed\n"));
1567 // give up this frame
1568 return NDIS_STATUS_FAILURE;
1571 // handle AES decryption
1572 else if (GroupCipher == Ndis802_11Encryption3Enabled)
1574 if (RTMPSoftDecryptAES(pAd, pRxBlk->pData, pRxWI->MPDUtotalByteCount , pShard_key))
1577 //8 bytes MIC, 8 bytes IV/EIV (CCMP Header)
1578 pRxWI->MPDUtotalByteCount -= 16;
1582 DBGPRINT(RT_DEBUG_ERROR, ("ERROR : RTMPSoftDecryptAES Failed\n"));
1583 // give up this frame
1584 return NDIS_STATUS_FAILURE;
1589 // give up this frame
1590 return NDIS_STATUS_FAILURE;
1593 return NDIS_STATUS_SUCCESS;