git.oblomov.eu Git - linux-2.6/blob - drivers/staging/rt2870/common/cmm_wpa.c

   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.c
  29
  30         Abstract:
  31
  32         Revision History:
  33         Who                     When                    What
  34         --------        ----------              ----------------------------------------------
  35         Jan     Lee             03-07-22                Initial
  36         Paul Lin        03-11-28                Modify for supplicant
  37 */
  38 #include "../rt_config.h"
  39 // WPA OUI
  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_WEP40[4]      = {0x00, 0x50, 0xF2, 0x01};
  43 UCHAR       OUI_WPA_TKIP[4]     = {0x00, 0x50, 0xF2, 0x02};
  44 UCHAR       OUI_WPA_CCMP[4]     = {0x00, 0x50, 0xF2, 0x04};
  45 UCHAR       OUI_WPA_WEP104[4]      = {0x00, 0x50, 0xF2, 0x05};
  46 UCHAR       OUI_WPA_8021X_AKM[4]        = {0x00, 0x50, 0xF2, 0x01};
  47 UCHAR       OUI_WPA_PSK_AKM[4]      = {0x00, 0x50, 0xF2, 0x02};
  48 // WPA2 OUI
  49 UCHAR       OUI_WPA2_WEP40[4]   = {0x00, 0x0F, 0xAC, 0x01};
  50 UCHAR       OUI_WPA2_TKIP[4]        = {0x00, 0x0F, 0xAC, 0x02};
  51 UCHAR       OUI_WPA2_CCMP[4]        = {0x00, 0x0F, 0xAC, 0x04};
  52 UCHAR       OUI_WPA2_8021X_AKM[4]   = {0x00, 0x0F, 0xAC, 0x01};
  53 UCHAR       OUI_WPA2_PSK_AKM[4]         = {0x00, 0x0F, 0xAC, 0x02};
  54 UCHAR       OUI_WPA2_WEP104[4]   = {0x00, 0x0F, 0xAC, 0x05};
  55 // MSA OUI
  56 UCHAR           OUI_MSA_8021X_AKM[4]    = {0x00, 0x0F, 0xAC, 0x05};             // Not yet final - IEEE 802.11s-D1.06
  57 UCHAR           OUI_MSA_PSK_AKM[4]      = {0x00, 0x0F, 0xAC, 0x06};             // Not yet final - IEEE 802.11s-D1.06
  58
  59 /*
  60         ========================================================================
  61
  62         Routine Description:
  63                 The pseudo-random function(PRF) that hashes various inputs to
  64                 derive a pseudo-random value. To add liveness to the pseudo-random
  65                 value, a nonce should be one of the inputs.
  66
  67                 It is used to generate PTK, GTK or some specific random value.
  68
  69         Arguments:
  70                 UCHAR   *key,           -       the key material for HMAC_SHA1 use
  71                 INT             key_len         -       the length of key
  72                 UCHAR   *prefix         -       a prefix label
  73                 INT             prefix_len      -       the length of the label
  74                 UCHAR   *data           -       a specific data with variable length
  75                 INT             data_len        -       the length of a specific data
  76                 INT             len                     -       the output lenght
  77
  78         Return Value:
  79                 UCHAR   *output         -       the calculated result
  80
  81         Note:
  82                 802.11i-2004    Annex H.3
  83
  84         ========================================================================
  85 */
  86 VOID    PRF(
  87         IN      UCHAR   *key,
  88         IN      INT             key_len,
  89         IN      UCHAR   *prefix,
  90         IN      INT             prefix_len,
  91         IN      UCHAR   *data,
  92         IN      INT             data_len,
  93         OUT     UCHAR   *output,
  94         IN      INT             len)
  95 {
  96         INT             i;
  97     UCHAR   *input;
  98         INT             currentindex = 0;
  99         INT             total_len;
 100
 101         // Allocate memory for input
 102         os_alloc_mem(NULL, (PUCHAR *)&input, 1024);
 103
 104     if (input == NULL)
 105     {
 106         DBGPRINT(RT_DEBUG_ERROR, ("!!!PRF: no memory!!!\n"));
 107         return;
 108     }
 109
 110         // Generate concatenation input
 111         NdisMoveMemory(input, prefix, prefix_len);
 112
 113         // Concatenate a single octet containing 0
 114         input[prefix_len] =     0;
 115
 116         // Concatenate specific data
 117         NdisMoveMemory(&input[prefix_len + 1], data, data_len);
 118         total_len =     prefix_len + 1 + data_len;
 119
 120         // Concatenate a single octet containing 0
 121         // This octet shall be update later
 122         input[total_len] = 0;
 123         total_len++;
 124
 125         // Iterate to calculate the result by hmac-sha-1
 126         // Then concatenate to last result
 127         for     (i = 0; i <     (len + 19) / 20; i++)
 128         {
 129                 HMAC_SHA1(input, total_len,     key, key_len, &output[currentindex]);
 130                 currentindex += 20;
 131
 132                 // update the last octet
 133                 input[total_len - 1]++;
 134         }
 135     os_free_mem(NULL, input);
 136 }
 137
 138 /*
 139         ========================================================================
 140
 141         Routine Description:
 142                 It utilizes PRF-384 or PRF-512 to derive session-specific keys from a PMK.
 143                 It shall be called by 4-way handshake processing.
 144
 145         Arguments:
 146                 pAd     -       pointer to our pAdapter context
 147                 PMK             -       pointer to PMK
 148                 ANonce  -       pointer to ANonce
 149                 AA              -       pointer to Authenticator Address
 150                 SNonce  -       pointer to SNonce
 151                 SA              -       pointer to Supplicant Address
 152                 len             -       indicate the length of PTK (octet)
 153
 154         Return Value:
 155                 Output          pointer to the PTK
 156
 157         Note:
 158                 Refer to IEEE 802.11i-2004 8.5.1.2
 159
 160         ========================================================================
 161 */
 162 VOID WpaCountPTK(
 163         IN      PRTMP_ADAPTER   pAd,
 164         IN      UCHAR   *PMK,
 165         IN      UCHAR   *ANonce,
 166         IN      UCHAR   *AA,
 167         IN      UCHAR   *SNonce,
 168         IN      UCHAR   *SA,
 169         OUT     UCHAR   *output,
 170         IN      UINT    len)
 171 {
 172         UCHAR   concatenation[76];
 173         UINT    CurrPos = 0;
 174         UCHAR   temp[32];
 175         UCHAR   Prefix[] = {'P', 'a', 'i', 'r', 'w', 'i', 's', 'e', ' ', 'k', 'e', 'y', ' ',
 176                                                 'e', 'x', 'p', 'a', 'n', 's', 'i', 'o', 'n'};
 177
 178         // initiate the concatenation input
 179         NdisZeroMemory(temp, sizeof(temp));
 180         NdisZeroMemory(concatenation, 76);
 181
 182         // Get smaller address
 183         if (RTMPCompareMemory(SA, AA, 6) == 1)
 184                 NdisMoveMemory(concatenation, AA, 6);
 185         else
 186                 NdisMoveMemory(concatenation, SA, 6);
 187         CurrPos += 6;
 188
 189         // Get larger address
 190         if (RTMPCompareMemory(SA, AA, 6) == 1)
 191                 NdisMoveMemory(&concatenation[CurrPos], SA, 6);
 192         else
 193                 NdisMoveMemory(&concatenation[CurrPos], AA, 6);
 194
 195         // store the larger mac address for backward compatible of
 196         // ralink proprietary STA-key issue
 197         NdisMoveMemory(temp, &concatenation[CurrPos], MAC_ADDR_LEN);
 198         CurrPos += 6;
 199
 200         // Get smaller Nonce
 201         if (RTMPCompareMemory(ANonce, SNonce, 32) == 0)
 202                 NdisMoveMemory(&concatenation[CurrPos], temp, 32);      // patch for ralink proprietary STA-key issue
 203         else if (RTMPCompareMemory(ANonce, SNonce, 32) == 1)
 204                 NdisMoveMemory(&concatenation[CurrPos], SNonce, 32);
 205         else
 206                 NdisMoveMemory(&concatenation[CurrPos], ANonce, 32);
 207         CurrPos += 32;
 208
 209         // Get larger Nonce
 210         if (RTMPCompareMemory(ANonce, SNonce, 32) == 0)
 211                 NdisMoveMemory(&concatenation[CurrPos], temp, 32);      // patch for ralink proprietary STA-key issue
 212         else if (RTMPCompareMemory(ANonce, SNonce, 32) == 1)
 213                 NdisMoveMemory(&concatenation[CurrPos], ANonce, 32);
 214         else
 215                 NdisMoveMemory(&concatenation[CurrPos], SNonce, 32);
 216         CurrPos += 32;
 217
 218         hex_dump("concatenation=", concatenation, 76);
 219
 220         // Use PRF to generate PTK
 221         PRF(PMK, LEN_MASTER_KEY, Prefix, 22, concatenation, 76, output, len);
 222
 223 }
 224
 225 /*
 226         ========================================================================
 227
 228         Routine Description:
 229                 Generate random number by software.
 230
 231         Arguments:
 232                 pAd             -       pointer to our pAdapter context
 233                 macAddr -       pointer to local MAC address
 234
 235         Return Value:
 236
 237         Note:
 238                 802.1ii-2004  Annex H.5
 239
 240         ========================================================================
 241 */
 242 VOID    GenRandom(
 243         IN      PRTMP_ADAPTER   pAd,
 244         IN      UCHAR                   *macAddr,
 245         OUT     UCHAR                   *random)
 246 {
 247         INT             i, curr;
 248         UCHAR   local[80], KeyCounter[32];
 249         UCHAR   result[80];
 250         ULONG   CurrentTime;
 251         UCHAR   prefix[] = {'I', 'n', 'i', 't', ' ', 'C', 'o', 'u', 'n', 't', 'e', 'r'};
 252
 253         // Zero the related information
 254         NdisZeroMemory(result, 80);
 255         NdisZeroMemory(local, 80);
 256         NdisZeroMemory(KeyCounter, 32);
 257
 258         for     (i = 0; i <     32;     i++)
 259         {
 260                 // copy the local MAC address
 261                 COPY_MAC_ADDR(local, macAddr);
 262                 curr =  MAC_ADDR_LEN;
 263
 264                 // concatenate the current time
 265                 NdisGetSystemUpTime(&CurrentTime);
 266                 NdisMoveMemory(&local[curr],  &CurrentTime,     sizeof(CurrentTime));
 267                 curr += sizeof(CurrentTime);
 268
 269                 // concatenate the last result
 270                 NdisMoveMemory(&local[curr],  result, 32);
 271                 curr += 32;
 272
 273                 // concatenate a variable
 274                 NdisMoveMemory(&local[curr],  &i,  2);
 275                 curr += 2;
 276
 277                 // calculate the result
 278                 PRF(KeyCounter, 32, prefix,12, local, curr, result, 32);
 279         }
 280
 281         NdisMoveMemory(random, result,  32);
 282 }
 283
 284 /*
 285         ========================================================================
 286
 287         Routine Description:
 288                 Build cipher suite in RSN-IE.
 289                 It only shall be called by RTMPMakeRSNIE.
 290
 291         Arguments:
 292                 pAd                     -       pointer to our pAdapter context
 293         ElementID       -       indicate the WPA1 or WPA2
 294         WepStatus       -       indicate the encryption type
 295                 bMixCipher      -       a boolean to indicate the pairwise cipher and group
 296                                                 cipher are the same or not
 297
 298         Return Value:
 299
 300         Note:
 301
 302         ========================================================================
 303 */
 304 static VOID RTMPInsertRsnIeCipher(
 305         IN  PRTMP_ADAPTER   pAd,
 306         IN      UCHAR                   ElementID,
 307         IN      UINT                    WepStatus,
 308         IN      BOOLEAN                 bMixCipher,
 309         IN      UCHAR                   FlexibleCipher,
 310         OUT     PUCHAR                  pRsnIe,
 311         OUT     UCHAR                   *rsn_len)
 312 {
 313         UCHAR   PairwiseCnt;
 314
 315         *rsn_len = 0;
 316
 317         // decide WPA2 or WPA1
 318         if (ElementID == Wpa2Ie)
 319         {
 320                 RSNIE2  *pRsnie_cipher = (RSNIE2*)pRsnIe;
 321
 322                 // Assign the verson as 1
 323                 pRsnie_cipher->version = 1;
 324
 325         switch (WepStatus)
 326         {
 327                 // TKIP mode
 328             case Ndis802_11Encryption2Enabled:
 329                 NdisMoveMemory(pRsnie_cipher->mcast, OUI_WPA2_TKIP, 4);
 330                 pRsnie_cipher->ucount = 1;
 331                 NdisMoveMemory(pRsnie_cipher->ucast[0].oui, OUI_WPA2_TKIP, 4);
 332                 *rsn_len = sizeof(RSNIE2);
 333                 break;
 334
 335                         // AES mode
 336             case Ndis802_11Encryption3Enabled:
 337                                 if (bMixCipher)
 338                                         NdisMoveMemory(pRsnie_cipher->mcast, OUI_WPA2_TKIP, 4);
 339                                 else
 340                                         NdisMoveMemory(pRsnie_cipher->mcast, OUI_WPA2_CCMP, 4);
 341                 pRsnie_cipher->ucount = 1;
 342                 NdisMoveMemory(pRsnie_cipher->ucast[0].oui, OUI_WPA2_CCMP, 4);
 343                 *rsn_len = sizeof(RSNIE2);
 344                 break;
 345
 346                         // TKIP-AES mix mode
 347             case Ndis802_11Encryption4Enabled:
 348                 NdisMoveMemory(pRsnie_cipher->mcast, OUI_WPA2_TKIP, 4);
 349
 350                                 PairwiseCnt = 1;
 351                                 // Insert WPA2 TKIP as the first pairwise cipher
 352                                 if (MIX_CIPHER_WPA2_TKIP_ON(FlexibleCipher))
 353                                 {
 354                         NdisMoveMemory(pRsnie_cipher->ucast[0].oui, OUI_WPA2_TKIP, 4);
 355                                         // Insert WPA2 AES as the secondary pairwise cipher
 356                                         if (MIX_CIPHER_WPA2_AES_ON(FlexibleCipher))
 357                                         {
 358                                 NdisMoveMemory(pRsnie_cipher->ucast[0].oui + 4, OUI_WPA2_CCMP, 4);
 359                                                 PairwiseCnt = 2;
 360                                         }
 361                                 }
 362                                 else
 363                                 {
 364                                         // Insert WPA2 AES as the first pairwise cipher
 365                                         NdisMoveMemory(pRsnie_cipher->ucast[0].oui, OUI_WPA2_CCMP, 4);
 366                                 }
 367
 368                 pRsnie_cipher->ucount = PairwiseCnt;
 369                 *rsn_len = sizeof(RSNIE2) + (4 * (PairwiseCnt - 1));
 370                 break;
 371         }
 372
 373                 if ((pAd->OpMode == OPMODE_STA) &&
 374                         (pAd->StaCfg.GroupCipher != Ndis802_11Encryption2Enabled) &&
 375                         (pAd->StaCfg.GroupCipher != Ndis802_11Encryption3Enabled))
 376                 {
 377                         UINT GroupCipher = pAd->StaCfg.GroupCipher;
 378                         switch(GroupCipher)
 379                         {
 380                                 case Ndis802_11GroupWEP40Enabled:
 381                                         NdisMoveMemory(pRsnie_cipher->mcast, OUI_WPA2_WEP40, 4);
 382                                         break;
 383                                 case Ndis802_11GroupWEP104Enabled:
 384                                         NdisMoveMemory(pRsnie_cipher->mcast, OUI_WPA2_WEP104, 4);
 385                                         break;
 386                         }
 387                 }
 388
 389                 // swap for big-endian platform
 390                 pRsnie_cipher->version = cpu2le16(pRsnie_cipher->version);
 391             pRsnie_cipher->ucount = cpu2le16(pRsnie_cipher->ucount);
 392         }
 393         else
 394         {
 395                 RSNIE   *pRsnie_cipher = (RSNIE*)pRsnIe;
 396
 397                 // Assign OUI and version
 398                 NdisMoveMemory(pRsnie_cipher->oui, OUI_WPA_VERSION, 4);
 399         pRsnie_cipher->version = 1;
 400
 401                 switch (WepStatus)
 402                 {
 403                         // TKIP mode
 404             case Ndis802_11Encryption2Enabled:
 405                 NdisMoveMemory(pRsnie_cipher->mcast, OUI_WPA_TKIP, 4);
 406                 pRsnie_cipher->ucount = 1;
 407                 NdisMoveMemory(pRsnie_cipher->ucast[0].oui, OUI_WPA_TKIP, 4);
 408                 *rsn_len = sizeof(RSNIE);
 409                 break;
 410
 411                         // AES mode
 412             case Ndis802_11Encryption3Enabled:
 413                                 if (bMixCipher)
 414                                         NdisMoveMemory(pRsnie_cipher->mcast, OUI_WPA_TKIP, 4);
 415                                 else
 416                                         NdisMoveMemory(pRsnie_cipher->mcast, OUI_WPA_CCMP, 4);
 417                 pRsnie_cipher->ucount = 1;
 418                 NdisMoveMemory(pRsnie_cipher->ucast[0].oui, OUI_WPA_CCMP, 4);
 419                 *rsn_len = sizeof(RSNIE);
 420                 break;
 421
 422                         // TKIP-AES mix mode
 423             case Ndis802_11Encryption4Enabled:
 424                 NdisMoveMemory(pRsnie_cipher->mcast, OUI_WPA_TKIP, 4);
 425
 426                                 PairwiseCnt = 1;
 427                                 // Insert WPA TKIP as the first pairwise cipher
 428                                 if (MIX_CIPHER_WPA_TKIP_ON(FlexibleCipher))
 429                                 {
 430                         NdisMoveMemory(pRsnie_cipher->ucast[0].oui, OUI_WPA_TKIP, 4);
 431                                         // Insert WPA AES as the secondary pairwise cipher
 432                                         if (MIX_CIPHER_WPA_AES_ON(FlexibleCipher))
 433                                         {
 434                                 NdisMoveMemory(pRsnie_cipher->ucast[0].oui + 4, OUI_WPA_CCMP, 4);
 435                                                 PairwiseCnt = 2;
 436                                         }
 437                                 }
 438                                 else
 439                                 {
 440                                         // Insert WPA AES as the first pairwise cipher
 441                                         NdisMoveMemory(pRsnie_cipher->ucast[0].oui, OUI_WPA_CCMP, 4);
 442                                 }
 443
 444                 pRsnie_cipher->ucount = PairwiseCnt;
 445                 *rsn_len = sizeof(RSNIE) + (4 * (PairwiseCnt - 1));
 446                 break;
 447         }
 448
 449                 if ((pAd->OpMode == OPMODE_STA) &&
 450                         (pAd->StaCfg.GroupCipher != Ndis802_11Encryption2Enabled) &&
 451                         (pAd->StaCfg.GroupCipher != Ndis802_11Encryption3Enabled))
 452                 {
 453                         UINT GroupCipher = pAd->StaCfg.GroupCipher;
 454                         switch(GroupCipher)
 455                         {
 456                                 case Ndis802_11GroupWEP40Enabled:
 457                                         NdisMoveMemory(pRsnie_cipher->mcast, OUI_WPA_WEP40, 4);
 458                                         break;
 459                                 case Ndis802_11GroupWEP104Enabled:
 460                                         NdisMoveMemory(pRsnie_cipher->mcast, OUI_WPA_WEP104, 4);
 461                                         break;
 462                         }
 463                 }
 464
 465                 // swap for big-endian platform
 466                 pRsnie_cipher->version = cpu2le16(pRsnie_cipher->version);
 467             pRsnie_cipher->ucount = cpu2le16(pRsnie_cipher->ucount);
 468         }
 469 }
 470
 471 /*
 472         ========================================================================
 473
 474         Routine Description:
 475                 Build AKM suite in RSN-IE.
 476                 It only shall be called by RTMPMakeRSNIE.
 477
 478         Arguments:
 479                 pAd                     -       pointer to our pAdapter context
 480         ElementID       -       indicate the WPA1 or WPA2
 481         AuthMode        -       indicate the authentication mode
 482                 apidx           -       indicate the interface index
 483
 484         Return Value:
 485
 486         Note:
 487
 488         ========================================================================
 489 */
 490 static VOID RTMPInsertRsnIeAKM(
 491         IN  PRTMP_ADAPTER   pAd,
 492         IN      UCHAR                   ElementID,
 493         IN      UINT                    AuthMode,
 494         IN      UCHAR                   apidx,
 495         OUT     PUCHAR                  pRsnIe,
 496         OUT     UCHAR                   *rsn_len)
 497 {
 498         RSNIE_AUTH              *pRsnie_auth;
 499
 500         pRsnie_auth = (RSNIE_AUTH*)(pRsnIe + (*rsn_len));
 501
 502         // decide WPA2 or WPA1
 503         if (ElementID == Wpa2Ie)
 504         {
 505                 switch (AuthMode)
 506         {
 507             case Ndis802_11AuthModeWPA2:
 508             case Ndis802_11AuthModeWPA1WPA2:
 509                 pRsnie_auth->acount = 1;
 510                         NdisMoveMemory(pRsnie_auth->auth[0].oui, OUI_WPA2_8021X_AKM, 4);
 511                 break;
 512
 513             case Ndis802_11AuthModeWPA2PSK:
 514             case Ndis802_11AuthModeWPA1PSKWPA2PSK:
 515                 pRsnie_auth->acount = 1;
 516                         NdisMoveMemory(pRsnie_auth->auth[0].oui, OUI_WPA2_PSK_AKM, 4);
 517                 break;
 518         }
 519         }
 520         else
 521         {
 522                 switch (AuthMode)
 523         {
 524             case Ndis802_11AuthModeWPA:
 525             case Ndis802_11AuthModeWPA1WPA2:
 526                 pRsnie_auth->acount = 1;
 527                 NdisMoveMemory(pRsnie_auth->auth[0].oui, OUI_WPA_8021X_AKM, 4);
 528                 break;
 529
 530             case Ndis802_11AuthModeWPAPSK:
 531             case Ndis802_11AuthModeWPA1PSKWPA2PSK:
 532                 pRsnie_auth->acount = 1;
 533                 NdisMoveMemory(pRsnie_auth->auth[0].oui, OUI_WPA_PSK_AKM, 4);
 534                 break;
 535
 536                         case Ndis802_11AuthModeWPANone:
 537                 pRsnie_auth->acount = 1;
 538                 NdisMoveMemory(pRsnie_auth->auth[0].oui, OUI_WPA_NONE_AKM, 4);
 539                 break;
 540         }
 541         }
 542
 543         pRsnie_auth->acount = cpu2le16(pRsnie_auth->acount);
 544
 545         (*rsn_len) += sizeof(RSNIE_AUTH);       // update current RSNIE length
 546
 547 }
 548
 549 /*
 550         ========================================================================
 551
 552         Routine Description:
 553                 Build capability in RSN-IE.
 554                 It only shall be called by RTMPMakeRSNIE.
 555
 556         Arguments:
 557                 pAd                     -       pointer to our pAdapter context
 558         ElementID       -       indicate the WPA1 or WPA2
 559                 apidx           -       indicate the interface index
 560
 561         Return Value:
 562
 563         Note:
 564
 565         ========================================================================
 566 */
 567 static VOID RTMPInsertRsnIeCap(
 568         IN  PRTMP_ADAPTER   pAd,
 569         IN      UCHAR                   ElementID,
 570         IN      UCHAR                   apidx,
 571         OUT     PUCHAR                  pRsnIe,
 572         OUT     UCHAR                   *rsn_len)
 573 {
 574         RSN_CAPABILITIES    *pRSN_Cap;
 575
 576         // it could be ignored in WPA1 mode
 577         if (ElementID == WpaIe)
 578                 return;
 579
 580         pRSN_Cap = (RSN_CAPABILITIES*)(pRsnIe + (*rsn_len));
 581
 582
 583         pRSN_Cap->word = cpu2le16(pRSN_Cap->word);
 584
 585         (*rsn_len) += sizeof(RSN_CAPABILITIES); // update current RSNIE length
 586
 587 }
 588
 589
 590 /*
 591         ========================================================================
 592
 593         Routine Description:
 594                 Build RSN IE context. It is not included element-ID and length.
 595
 596         Arguments:
 597                 pAd                     -       pointer to our pAdapter context
 598         AuthMode        -       indicate the authentication mode
 599         WepStatus       -       indicate the encryption type
 600                 apidx           -       indicate the interface index
 601
 602         Return Value:
 603
 604         Note:
 605
 606         ========================================================================
 607 */
 608 VOID RTMPMakeRSNIE(
 609     IN  PRTMP_ADAPTER   pAd,
 610     IN  UINT            AuthMode,
 611     IN  UINT            WepStatus,
 612         IN      UCHAR                   apidx)
 613 {
 614         PUCHAR          pRsnIe = NULL;                  // primary RSNIE
 615         UCHAR           *rsnielen_cur_p = 0;    // the length of the primary RSNIE
 616         UCHAR           *rsnielen_ex_cur_p = 0; // the length of the secondary RSNIE
 617         UCHAR           PrimaryRsnie;
 618         BOOLEAN         bMixCipher = FALSE;     // indicate the pairwise and group cipher are different
 619         UCHAR           p_offset;
 620         WPA_MIX_PAIR_CIPHER             FlexibleCipher = MIX_CIPHER_NOTUSE;     // it provide the more flexible cipher combination in WPA-WPA2 and TKIPAES mode
 621
 622         rsnielen_cur_p = NULL;
 623         rsnielen_ex_cur_p = NULL;
 624
 625         {
 626                 {
 627                         if (pAd->StaCfg.WpaSupplicantUP != WPA_SUPPLICANT_DISABLE)
 628                         {
 629                                 if (AuthMode < Ndis802_11AuthModeWPA)
 630                                         return;
 631                         }
 632                         else
 633                         {
 634                                 // Support WPAPSK or WPA2PSK in STA-Infra mode
 635                                 // Support WPANone in STA-Adhoc mode
 636                                 if ((AuthMode != Ndis802_11AuthModeWPAPSK) &&
 637                                         (AuthMode != Ndis802_11AuthModeWPA2PSK) &&
 638                                         (AuthMode != Ndis802_11AuthModeWPANone)
 639                                         )
 640                                         return;
 641                         }
 642
 643                         DBGPRINT(RT_DEBUG_TRACE,("==> RTMPMakeRSNIE(STA)\n"));
 644
 645                         // Zero RSNIE context
 646                         pAd->StaCfg.RSNIE_Len = 0;
 647                         NdisZeroMemory(pAd->StaCfg.RSN_IE, MAX_LEN_OF_RSNIE);
 648
 649                         // Pointer to RSNIE
 650                         rsnielen_cur_p = &pAd->StaCfg.RSNIE_Len;
 651                         pRsnIe = pAd->StaCfg.RSN_IE;
 652
 653                         bMixCipher = pAd->StaCfg.bMixCipher;
 654                 }
 655         }
 656
 657         // indicate primary RSNIE as WPA or WPA2
 658         if ((AuthMode == Ndis802_11AuthModeWPA) ||
 659                 (AuthMode == Ndis802_11AuthModeWPAPSK) ||
 660                 (AuthMode == Ndis802_11AuthModeWPANone) ||
 661                 (AuthMode == Ndis802_11AuthModeWPA1WPA2) ||
 662                 (AuthMode == Ndis802_11AuthModeWPA1PSKWPA2PSK))
 663                 PrimaryRsnie = WpaIe;
 664         else
 665                 PrimaryRsnie = Wpa2Ie;
 666
 667         {
 668                 // Build the primary RSNIE
 669                 // 1. insert cipher suite
 670                 RTMPInsertRsnIeCipher(pAd, PrimaryRsnie, WepStatus, bMixCipher, FlexibleCipher, pRsnIe, &p_offset);
 671
 672                 // 2. insert AKM
 673                 RTMPInsertRsnIeAKM(pAd, PrimaryRsnie, AuthMode, apidx, pRsnIe, &p_offset);
 674
 675                 // 3. insert capability
 676                 RTMPInsertRsnIeCap(pAd, PrimaryRsnie, apidx, pRsnIe, &p_offset);
 677         }
 678
 679         // 4. update the RSNIE length
 680         *rsnielen_cur_p = p_offset;
 681
 682         hex_dump("The primary RSNIE", pRsnIe, (*rsnielen_cur_p));
 683
 684
 685 }
 686
 687 /*
 688     ==========================================================================
 689     Description:
 690                 Check whether the received frame is EAP frame.
 691
 692         Arguments:
 693                 pAd                             -       pointer to our pAdapter context
 694                 pEntry                  -       pointer to active entry
 695                 pData                   -       the received frame
 696                 DataByteCount   -       the received frame's length
 697                 FromWhichBSSID  -       indicate the interface index
 698
 699     Return:
 700          TRUE                   -       This frame is EAP frame
 701          FALSE                  -       otherwise
 702     ==========================================================================
 703 */
 704 BOOLEAN RTMPCheckWPAframe(
 705     IN PRTMP_ADAPTER    pAd,
 706     IN PMAC_TABLE_ENTRY pEntry,
 707     IN PUCHAR           pData,
 708     IN ULONG            DataByteCount,
 709         IN UCHAR                        FromWhichBSSID)
 710 {
 711         ULONG   Body_len;
 712         BOOLEAN Cancelled;
 713
 714
 715     if(DataByteCount < (LENGTH_802_1_H + LENGTH_EAPOL_H))
 716         return FALSE;
 717
 718
 719         // Skip LLC header
 720     if (NdisEqualMemory(SNAP_802_1H, pData, 6) ||
 721         // Cisco 1200 AP may send packet with SNAP_BRIDGE_TUNNEL
 722         NdisEqualMemory(SNAP_BRIDGE_TUNNEL, pData, 6))
 723     {
 724         pData += 6;
 725     }
 726         // Skip 2-bytes EAPoL type
 727     if (NdisEqualMemory(EAPOL, pData, 2))
 728     {
 729         pData += 2;
 730     }
 731     else
 732         return FALSE;
 733
 734     switch (*(pData+1))
 735     {
 736         case EAPPacket:
 737                         Body_len = (*(pData+2)<<8) | (*(pData+3));
 738             DBGPRINT(RT_DEBUG_TRACE, ("Receive EAP-Packet frame, TYPE = 0, Length = %ld\n", Body_len));
 739             break;
 740         case EAPOLStart:
 741             DBGPRINT(RT_DEBUG_TRACE, ("Receive EAPOL-Start frame, TYPE = 1 \n"));
 742                         if (pEntry->EnqueueEapolStartTimerRunning != EAPOL_START_DISABLE)
 743             {
 744                 DBGPRINT(RT_DEBUG_TRACE, ("Cancel the EnqueueEapolStartTimerRunning \n"));
 745                 RTMPCancelTimer(&pEntry->EnqueueStartForPSKTimer, &Cancelled);
 746                 pEntry->EnqueueEapolStartTimerRunning = EAPOL_START_DISABLE;
 747             }
 748             break;
 749         case EAPOLLogoff:
 750             DBGPRINT(RT_DEBUG_TRACE, ("Receive EAPOLLogoff frame, TYPE = 2 \n"));
 751             break;
 752         case EAPOLKey:
 753                         Body_len = (*(pData+2)<<8) | (*(pData+3));
 754             DBGPRINT(RT_DEBUG_TRACE, ("Receive EAPOL-Key frame, TYPE = 3, Length = %ld\n", Body_len));
 755             break;
 756         case EAPOLASFAlert:
 757             DBGPRINT(RT_DEBUG_TRACE, ("Receive EAPOLASFAlert frame, TYPE = 4 \n"));
 758             break;
 759         default:
 760             return FALSE;
 761
 762     }
 763     return TRUE;
 764 }
 765
 766
 767 /*
 768     ==========================================================================
 769     Description:
 770         ENCRYPT AES GTK before sending in EAPOL frame.
 771         AES GTK length = 128 bit,  so fix blocks for aes-key-wrap as 2 in this function.
 772         This function references to RFC 3394 for aes key wrap algorithm.
 773     Return:
 774     ==========================================================================
 775 */
 776 VOID AES_GTK_KEY_WRAP(
 777     IN UCHAR    *key,
 778     IN UCHAR    *plaintext,
 779     IN UCHAR    p_len,
 780     OUT UCHAR   *ciphertext)
 781 {
 782     UCHAR       A[8], BIN[16], BOUT[16];
 783     UCHAR       R[512];
 784     INT         num_blocks = p_len/8;   // unit:64bits
 785     INT         i, j;
 786     aes_context aesctx;
 787     UCHAR       xor;
 788
 789     rtmp_aes_set_key(&aesctx, key, 128);
 790
 791     // Init IA
 792     for (i = 0; i < 8; i++)
 793         A[i] = 0xa6;
 794
 795     //Input plaintext
 796     for (i = 0; i < num_blocks; i++)
 797     {
 798         for (j = 0 ; j < 8; j++)
 799             R[8 * (i + 1) + j] = plaintext[8 * i + j];
 800     }
 801
 802     // Key Mix
 803     for (j = 0; j < 6; j++)
 804     {
 805         for(i = 1; i <= num_blocks; i++)
 806         {
 807             //phase 1
 808             NdisMoveMemory(BIN, A, 8);
 809             NdisMoveMemory(&BIN[8], &R[8 * i], 8);
 810             rtmp_aes_encrypt(&aesctx, BIN, BOUT);
 811
 812             NdisMoveMemory(A, &BOUT[0], 8);
 813             xor = num_blocks * j + i;
 814             A[7] = BOUT[7] ^ xor;
 815             NdisMoveMemory(&R[8 * i], &BOUT[8], 8);
 816         }
 817     }
 818
 819     // Output ciphertext
 820     NdisMoveMemory(ciphertext, A, 8);
 821
 822     for (i = 1; i <= num_blocks; i++)
 823     {
 824         for (j = 0 ; j < 8; j++)
 825             ciphertext[8 * i + j] = R[8 * i + j];
 826     }
 827 }
 828
 829
 830 /*
 831         ========================================================================
 832
 833         Routine Description:
 834                 Misc function to decrypt AES body
 835
 836         Arguments:
 837
 838         Return Value:
 839
 840         Note:
 841                 This function references to     RFC     3394 for aes key unwrap algorithm.
 842
 843         ========================================================================
 844 */
 845 VOID    AES_GTK_KEY_UNWRAP(
 846         IN      UCHAR   *key,
 847         OUT     UCHAR   *plaintext,
 848         IN      UCHAR    c_len,
 849         IN      UCHAR   *ciphertext)
 850
 851 {
 852         UCHAR       A[8], BIN[16], BOUT[16];
 853         UCHAR       xor;
 854         INT         i, j;
 855         aes_context aesctx;
 856         UCHAR       *R;
 857         INT         num_blocks = c_len/8;       // unit:64bits
 858
 859
 860         os_alloc_mem(NULL, (PUCHAR *)&R, 512);
 861
 862         if (R == NULL)
 863     {
 864         DBGPRINT(RT_DEBUG_ERROR, ("!!!AES_GTK_KEY_UNWRAP: no memory!!!\n"));
 865         return;
 866     } /* End of if */
 867
 868         // Initialize
 869         NdisMoveMemory(A, ciphertext, 8);
 870         //Input plaintext
 871         for(i = 0; i < (c_len-8); i++)
 872         {
 873                 R[ i] = ciphertext[i + 8];
 874         }
 875
 876         rtmp_aes_set_key(&aesctx, key, 128);
 877
 878         for(j = 5; j >= 0; j--)
 879         {
 880                 for(i = (num_blocks-1); i > 0; i--)
 881                 {
 882                         xor = (num_blocks -1 )* j + i;
 883                         NdisMoveMemory(BIN, A, 8);
 884                         BIN[7] = A[7] ^ xor;
 885                         NdisMoveMemory(&BIN[8], &R[(i-1)*8], 8);
 886                         rtmp_aes_decrypt(&aesctx, BIN, BOUT);
 887                         NdisMoveMemory(A, &BOUT[0], 8);
 888                         NdisMoveMemory(&R[(i-1)*8], &BOUT[8], 8);
 889                 }
 890         }
 891
 892         // OUTPUT
 893         for(i = 0; i < c_len; i++)
 894         {
 895                 plaintext[i] = R[i];
 896         }
 897
 898
 899         os_free_mem(NULL, R);
 900 }
 901
 902 /*
 903     ==========================================================================
 904     Description:
 905                 Report the EAP message type
 906
 907         Arguments:
 908                 msg             -       EAPOL_PAIR_MSG_1
 909                                         EAPOL_PAIR_MSG_2
 910                                         EAPOL_PAIR_MSG_3
 911                                         EAPOL_PAIR_MSG_4
 912                                         EAPOL_GROUP_MSG_1
 913                                         EAPOL_GROUP_MSG_2
 914
 915     Return:
 916          message type string
 917
 918     ==========================================================================
 919 */
 920 CHAR *GetEapolMsgType(CHAR msg)
 921 {
 922     if(msg == EAPOL_PAIR_MSG_1)
 923         return "Pairwise Message 1";
 924     else if(msg == EAPOL_PAIR_MSG_2)
 925         return "Pairwise Message 2";
 926         else if(msg == EAPOL_PAIR_MSG_3)
 927         return "Pairwise Message 3";
 928         else if(msg == EAPOL_PAIR_MSG_4)
 929         return "Pairwise Message 4";
 930         else if(msg == EAPOL_GROUP_MSG_1)
 931         return "Group Message 1";
 932         else if(msg == EAPOL_GROUP_MSG_2)
 933         return "Group Message 2";
 934     else
 935         return "Invalid Message";
 936 }
 937
 938
 939 /*
 940     ========================================================================
 941
 942     Routine Description:
 943     Check Sanity RSN IE of EAPoL message
 944
 945     Arguments:
 946
 947     Return Value:
 948
 949
 950     ========================================================================
 951 */
 952 BOOLEAN RTMPCheckRSNIE(
 953         IN  PRTMP_ADAPTER   pAd,
 954         IN  PUCHAR          pData,
 955         IN  UCHAR           DataLen,
 956         IN  MAC_TABLE_ENTRY *pEntry,
 957         OUT     UCHAR                   *Offset)
 958 {
 959         PUCHAR              pVIE;
 960         UCHAR               len;
 961         PEID_STRUCT         pEid;
 962         BOOLEAN                         result = FALSE;
 963
 964         pVIE = pData;
 965         len      = DataLen;
 966         *Offset = 0;
 967
 968         while (len > sizeof(RSNIE2))
 969         {
 970                 pEid = (PEID_STRUCT) pVIE;
 971                 // WPA RSN IE
 972                 if ((pEid->Eid == IE_WPA) && (NdisEqualMemory(pEid->Octet, WPA_OUI, 4)))
 973                 {
 974                         if ((pEntry->AuthMode == Ndis802_11AuthModeWPA || pEntry->AuthMode == Ndis802_11AuthModeWPAPSK) &&
 975                                 (NdisEqualMemory(pVIE, pEntry->RSN_IE, pEntry->RSNIE_Len)) &&
 976                                 (pEntry->RSNIE_Len == (pEid->Len + 2)))
 977                         {
 978                                         result = TRUE;
 979                         }
 980
 981                         *Offset += (pEid->Len + 2);
 982                 }
 983                 // WPA2 RSN IE
 984                 else if ((pEid->Eid == IE_RSN) && (NdisEqualMemory(pEid->Octet + 2, RSN_OUI, 3)))
 985                 {
 986                         if ((pEntry->AuthMode == Ndis802_11AuthModeWPA2 || pEntry->AuthMode == Ndis802_11AuthModeWPA2PSK) &&
 987                                 (NdisEqualMemory(pVIE, pEntry->RSN_IE, pEntry->RSNIE_Len)) &&
 988                                 (pEntry->RSNIE_Len == (pEid->Len + 2))/* ToDo-AlbertY for mesh*/)
 989                         {
 990                                         result = TRUE;
 991                         }
 992
 993                         *Offset += (pEid->Len + 2);
 994                 }
 995                 else
 996                 {
 997                         break;
 998                 }
 999
1000                 pVIE += (pEid->Len + 2);
1001                 len  -= (pEid->Len + 2);
1002         }
1003
1004
1005         return result;
1006
1007 }
1008
1009
1010 /*
1011     ========================================================================
1012
1013     Routine Description:
1014     Parse KEYDATA field.  KEYDATA[] May contain 2 RSN IE and optionally GTK.
1015     GTK  is encaptulated in KDE format at  p.83 802.11i D10
1016
1017     Arguments:
1018
1019     Return Value:
1020
1021     Note:
1022         802.11i D10
1023
1024     ========================================================================
1025 */
1026 BOOLEAN RTMPParseEapolKeyData(
1027         IN  PRTMP_ADAPTER   pAd,
1028         IN  PUCHAR          pKeyData,
1029         IN  UCHAR           KeyDataLen,
1030         IN      UCHAR                   GroupKeyIndex,
1031         IN      UCHAR                   MsgType,
1032         IN      BOOLEAN                 bWPA2,
1033         IN  MAC_TABLE_ENTRY *pEntry)
1034 {
1035     PKDE_ENCAP          pKDE = NULL;
1036     PUCHAR              pMyKeyData = pKeyData;
1037     UCHAR               KeyDataLength = KeyDataLen;
1038     UCHAR               GTKLEN = 0;
1039         UCHAR                           DefaultIdx = 0;
1040         UCHAR                           skip_offset;
1041
1042         // Verify The RSN IE contained in pairewise_msg_2 && pairewise_msg_3 and skip it
1043         if (MsgType == EAPOL_PAIR_MSG_2 || MsgType == EAPOL_PAIR_MSG_3)
1044     {
1045                 // Check RSN IE whether it is WPA2/WPA2PSK
1046                 if (!RTMPCheckRSNIE(pAd, pKeyData, KeyDataLen, pEntry, &skip_offset))
1047                 {
1048                         // send wireless event - for RSN IE different
1049                         if (pAd->CommonCfg.bWirelessEvent)
1050                                 RTMPSendWirelessEvent(pAd, IW_RSNIE_DIFF_EVENT_FLAG, pEntry->Addr, pEntry->apidx, 0);
1051
1052                 DBGPRINT(RT_DEBUG_ERROR, ("RSN_IE Different in msg %d of 4-way handshake!\n", MsgType));
1053                         hex_dump("Receive RSN_IE ", pKeyData, KeyDataLen);
1054                         hex_dump("Desired RSN_IE ", pEntry->RSN_IE, pEntry->RSNIE_Len);
1055
1056                         return FALSE;
1057         }
1058         else
1059                 {
1060                         if (bWPA2 && MsgType == EAPOL_PAIR_MSG_3)
1061                         {
1062                                 // skip RSN IE
1063                                 pMyKeyData += skip_offset;
1064                                 KeyDataLength -= skip_offset;
1065                                 DBGPRINT(RT_DEBUG_TRACE, ("RTMPParseEapolKeyData ==> WPA2/WPA2PSK RSN IE matched in Msg 3, Length(%d) \n", skip_offset));
1066                         }
1067                         else
1068                                 return TRUE;
1069                 }
1070         }
1071
1072         DBGPRINT(RT_DEBUG_TRACE,("RTMPParseEapolKeyData ==> KeyDataLength %d without RSN_IE \n", KeyDataLength));
1073
1074         // Parse EKD format in pairwise_msg_3_WPA2 && group_msg_1_WPA2
1075         if (bWPA2 && (MsgType == EAPOL_PAIR_MSG_3 || MsgType == EAPOL_GROUP_MSG_1))
1076         {
1077                 if (KeyDataLength >= 8) // KDE format exclude GTK length
1078         {
1079                 pKDE = (PKDE_ENCAP) pMyKeyData;
1080
1081
1082                         DefaultIdx = pKDE->GTKEncap.Kid;
1083
1084                         // Sanity check - KED length
1085                         if (KeyDataLength < (pKDE->Len + 2))
1086                 {
1087                         DBGPRINT(RT_DEBUG_ERROR, ("ERROR: The len from KDE is too short \n"));
1088                         return FALSE;
1089                 }
1090
1091                         // Get GTK length - refer to IEEE 802.11i-2004 p.82
1092                         GTKLEN = pKDE->Len -6;
1093                         if (GTKLEN < LEN_AES_KEY)
1094                         {
1095                                 DBGPRINT(RT_DEBUG_ERROR, ("ERROR: GTK Key length is too short (%d) \n", GTKLEN));
1096                         return FALSE;
1097                         }
1098
1099         }
1100                 else
1101         {
1102                         DBGPRINT(RT_DEBUG_ERROR, ("ERROR: KDE format length is too short \n"));
1103                 return FALSE;
1104         }
1105
1106                 DBGPRINT(RT_DEBUG_TRACE, ("GTK in KDE format ,DefaultKeyID=%d, KeyLen=%d \n", DefaultIdx, GTKLEN));
1107                 // skip it
1108                 pMyKeyData += 8;
1109                 KeyDataLength -= 8;
1110
1111         }
1112         else if (!bWPA2 && MsgType == EAPOL_GROUP_MSG_1)
1113         {
1114                 DefaultIdx = GroupKeyIndex;
1115                 DBGPRINT(RT_DEBUG_TRACE, ("GTK DefaultKeyID=%d \n", DefaultIdx));
1116         }
1117
1118         // Sanity check - shared key index must be 1 ~ 3
1119         if (DefaultIdx < 1 || DefaultIdx > 3)
1120     {
1121         DBGPRINT(RT_DEBUG_ERROR, ("ERROR: GTK Key index(%d) is invalid in %s %s \n", DefaultIdx, ((bWPA2) ? "WPA2" : "WPA"), GetEapolMsgType(MsgType)));
1122         return FALSE;
1123     }
1124
1125         return TRUE;
1126
1127 }
1128
1129
1130 /*
1131         ========================================================================
1132
1133         Routine Description:
1134                 Construct EAPoL message for WPA handshaking
1135                 Its format is below,
1136
1137                 +--------------------+
1138                 | Protocol Version       |  1 octet
1139                 +--------------------+
1140                 | Protocol Type          |      1 octet
1141                 +--------------------+
1142                 | Body Length            |  2 octets
1143                 +--------------------+
1144                 | Descriptor Type        |      1 octet
1145                 +--------------------+
1146                 | Key Information    |  2 octets
1147                 +--------------------+
1148                 | Key Length         |  1 octet
1149                 +--------------------+
1150                 | Key Repaly Counter |  8 octets
1151                 +--------------------+
1152                 | Key Nonce                  |  32 octets
1153                 +--------------------+
1154                 | Key IV                         |  16 octets
1155                 +--------------------+
1156                 | Key RSC                        |  8 octets
1157                 +--------------------+
1158                 | Key ID or Reserved |  8 octets
1159                 +--------------------+
1160                 | Key MIC                        |      16 octets
1161                 +--------------------+
1162                 | Key Data Length        |      2 octets
1163                 +--------------------+
1164                 | Key Data                       |      n octets
1165                 +--------------------+
1166
1167
1168         Arguments:
1169                 pAd                     Pointer to our adapter
1170
1171         Return Value:
1172                 None
1173
1174         Note:
1175
1176         ========================================================================
1177 */
1178 VOID    ConstructEapolMsg(
1179         IN      PRTMP_ADAPTER           pAd,
1180     IN  UCHAR                           AuthMode,
1181     IN  UCHAR                           WepStatus,
1182     IN  UCHAR                           GroupKeyWepStatus,
1183     IN  UCHAR                           MsgType,
1184     IN  UCHAR                           DefaultKeyIdx,
1185     IN  UCHAR                           *ReplayCounter,
1186         IN      UCHAR                           *KeyNonce,
1187         IN      UCHAR                           *TxRSC,
1188         IN      UCHAR                           *PTK,
1189         IN      UCHAR                           *GTK,
1190         IN      UCHAR                           *RSNIE,
1191         IN      UCHAR                           RSNIE_Len,
1192     OUT PEAPOL_PACKET       pMsg)
1193 {
1194         BOOLEAN bWPA2 = FALSE;
1195
1196         // Choose WPA2 or not
1197         if ((AuthMode == Ndis802_11AuthModeWPA2) || (AuthMode == Ndis802_11AuthModeWPA2PSK))
1198                 bWPA2 = TRUE;
1199
1200     // Init Packet and Fill header
1201     pMsg->ProVer = EAPOL_VER;
1202     pMsg->ProType = EAPOLKey;
1203
1204         // Default 95 bytes, the EAPoL-Key descriptor exclude Key-data field
1205         pMsg->Body_Len[1] = LEN_EAPOL_KEY_MSG;
1206
1207         // Fill in EAPoL descriptor
1208         if (bWPA2)
1209                 pMsg->KeyDesc.Type = WPA2_KEY_DESC;
1210         else
1211                 pMsg->KeyDesc.Type = WPA1_KEY_DESC;
1212
1213         // Fill in Key information, refer to IEEE Std 802.11i-2004 page 78
1214         // When either the pairwise or the group cipher is AES, the DESC_TYPE_AES(2) shall be used.
1215         pMsg->KeyDesc.KeyInfo.KeyDescVer =
1216                 (((WepStatus == Ndis802_11Encryption3Enabled) || (GroupKeyWepStatus == Ndis802_11Encryption3Enabled)) ? (DESC_TYPE_AES) : (DESC_TYPE_TKIP));
1217
1218         // Specify Key Type as Group(0) or Pairwise(1)
1219         if (MsgType >= EAPOL_GROUP_MSG_1)
1220                 pMsg->KeyDesc.KeyInfo.KeyType = GROUPKEY;
1221         else
1222                 pMsg->KeyDesc.KeyInfo.KeyType = PAIRWISEKEY;
1223
1224         // Specify Key Index, only group_msg1_WPA1
1225         if (!bWPA2 && (MsgType >= EAPOL_GROUP_MSG_1))
1226                 pMsg->KeyDesc.KeyInfo.KeyIndex = DefaultKeyIdx;
1227
1228         if (MsgType == EAPOL_PAIR_MSG_3)
1229                 pMsg->KeyDesc.KeyInfo.Install = 1;
1230
1231         if ((MsgType == EAPOL_PAIR_MSG_1) || (MsgType == EAPOL_PAIR_MSG_3) || (MsgType == EAPOL_GROUP_MSG_1))
1232                 pMsg->KeyDesc.KeyInfo.KeyAck = 1;
1233
1234         if (MsgType != EAPOL_PAIR_MSG_1)
1235                 pMsg->KeyDesc.KeyInfo.KeyMic = 1;
1236
1237         if ((bWPA2 && (MsgType >= EAPOL_PAIR_MSG_3)) || (!bWPA2 && (MsgType >= EAPOL_GROUP_MSG_1)))
1238     {
1239         pMsg->KeyDesc.KeyInfo.Secure = 1;
1240     }
1241
1242         if (bWPA2 && ((MsgType == EAPOL_PAIR_MSG_3) || (MsgType == EAPOL_GROUP_MSG_1)))
1243     {
1244         pMsg->KeyDesc.KeyInfo.EKD_DL = 1;
1245     }
1246
1247         // key Information element has done.
1248         *(USHORT *)(&pMsg->KeyDesc.KeyInfo) = cpu2le16(*(USHORT *)(&pMsg->KeyDesc.KeyInfo));
1249
1250         // Fill in Key Length
1251 #if 0
1252         if (bWPA2)
1253         {
1254                 // In WPA2 mode, the field indicates the length of pairwise key cipher,
1255                 // so only pairwise_msg_1 and pairwise_msg_3 need to fill.
1256                 if ((MsgType == EAPOL_PAIR_MSG_1) || (MsgType == EAPOL_PAIR_MSG_3))
1257                         pMsg->KeyDesc.KeyLength[1] = ((WepStatus == Ndis802_11Encryption2Enabled) ? LEN_TKIP_KEY : LEN_AES_KEY);
1258         }
1259         else if (!bWPA2)
1260 #endif
1261         {
1262                 if (MsgType >= EAPOL_GROUP_MSG_1)
1263                 {
1264                         // the length of group key cipher
1265                         pMsg->KeyDesc.KeyLength[1] = ((GroupKeyWepStatus == Ndis802_11Encryption2Enabled) ? TKIP_GTK_LENGTH : LEN_AES_KEY);
1266                 }
1267                 else
1268                 {
1269                         // the length of pairwise key cipher
1270                         pMsg->KeyDesc.KeyLength[1] = ((WepStatus == Ndis802_11Encryption2Enabled) ? LEN_TKIP_KEY : LEN_AES_KEY);
1271                 }
1272         }
1273
1274         // Fill in replay counter
1275     NdisMoveMemory(pMsg->KeyDesc.ReplayCounter, ReplayCounter, LEN_KEY_DESC_REPLAY);
1276
1277         // Fill Key Nonce field
1278         // ANonce : pairwise_msg1 & pairwise_msg3
1279         // SNonce : pairwise_msg2
1280         // GNonce : group_msg1_wpa1
1281         if ((MsgType <= EAPOL_PAIR_MSG_3) || ((!bWPA2 && (MsgType == EAPOL_GROUP_MSG_1))))
1282         NdisMoveMemory(pMsg->KeyDesc.KeyNonce, KeyNonce, LEN_KEY_DESC_NONCE);
1283
1284         // Fill key IV - WPA2 as 0, WPA1 as random
1285         if (!bWPA2 && (MsgType == EAPOL_GROUP_MSG_1))
1286         {
1287                 // Suggest IV be random number plus some number,
1288                 NdisMoveMemory(pMsg->KeyDesc.KeyIv, &KeyNonce[16], LEN_KEY_DESC_IV);
1289         pMsg->KeyDesc.KeyIv[15] += 2;
1290         }
1291
1292     // Fill Key RSC field
1293     // It contains the RSC for the GTK being installed.
1294         if ((MsgType == EAPOL_PAIR_MSG_3 && bWPA2) || (MsgType == EAPOL_GROUP_MSG_1))
1295         {
1296         NdisMoveMemory(pMsg->KeyDesc.KeyRsc, TxRSC, 6);
1297         }
1298
1299         // Clear Key MIC field for MIC calculation later
1300     NdisZeroMemory(pMsg->KeyDesc.KeyMic, LEN_KEY_DESC_MIC);
1301
1302         ConstructEapolKeyData(pAd,
1303                                                   AuthMode,
1304                                                   WepStatus,
1305                                                   GroupKeyWepStatus,
1306                                                   MsgType,
1307                                                   DefaultKeyIdx,
1308                                                   bWPA2,
1309                                                   PTK,
1310                                                   GTK,
1311                                                   RSNIE,
1312                                                   RSNIE_Len,
1313                                                   pMsg);
1314
1315         // Calculate MIC and fill in KeyMic Field except Pairwise Msg 1.
1316         if (MsgType != EAPOL_PAIR_MSG_1)
1317         {
1318                 CalculateMIC(pAd, WepStatus, PTK, pMsg);
1319         }
1320
1321         DBGPRINT(RT_DEBUG_TRACE, ("===> ConstructEapolMsg for %s %s\n", ((bWPA2) ? "WPA2" : "WPA"), GetEapolMsgType(MsgType)));
1322         DBGPRINT(RT_DEBUG_TRACE, ("          Body length = %d \n", pMsg->Body_Len[1]));
1323         DBGPRINT(RT_DEBUG_TRACE, ("          Key length  = %d \n", pMsg->KeyDesc.KeyLength[1]));
1324
1325
1326 }
1327
1328 /*
1329         ========================================================================
1330
1331         Routine Description:
1332                 Construct the Key Data field of EAPoL message
1333
1334         Arguments:
1335                 pAd                     Pointer to our adapter
1336                 Elem            Message body
1337
1338         Return Value:
1339                 None
1340
1341         Note:
1342
1343         ========================================================================
1344 */
1345 VOID    ConstructEapolKeyData(
1346         IN      PRTMP_ADAPTER   pAd,
1347         IN      UCHAR                   AuthMode,
1348         IN      UCHAR                   WepStatus,
1349         IN      UCHAR                   GroupKeyWepStatus,
1350         IN      UCHAR                   MsgType,
1351         IN      UCHAR                   DefaultKeyIdx,
1352         IN      BOOLEAN                 bWPA2Capable,
1353         IN      UCHAR                   *PTK,
1354         IN      UCHAR                   *GTK,
1355         IN      UCHAR                   *RSNIE,
1356         IN      UCHAR                   RSNIE_LEN,
1357         OUT PEAPOL_PACKET   pMsg)
1358 {
1359         UCHAR           *mpool, *Key_Data, *Rc4GTK;
1360         UCHAR       ekey[(LEN_KEY_DESC_IV+LEN_EAP_EK)];
1361         UCHAR           data_offset;
1362
1363
1364         if (MsgType == EAPOL_PAIR_MSG_1 || MsgType == EAPOL_PAIR_MSG_4 || MsgType == EAPOL_GROUP_MSG_2)
1365                 return;
1366
1367         // allocate memory pool
1368         os_alloc_mem(pAd, (PUCHAR *)&mpool, 1500);
1369
1370     if (mpool == NULL)
1371                 return;
1372
1373         /* Rc4GTK Len = 512 */
1374         Rc4GTK = (UCHAR *) ROUND_UP(mpool, 4);
1375         /* Key_Data Len = 512 */
1376         Key_Data = (UCHAR *) ROUND_UP(Rc4GTK + 512, 4);
1377
1378         NdisZeroMemory(Key_Data, 512);
1379         pMsg->KeyDesc.KeyDataLen[1] = 0;
1380         data_offset = 0;
1381
1382         // Encapsulate RSNIE in pairwise_msg2 & pairwise_msg3
1383         if (RSNIE_LEN && ((MsgType == EAPOL_PAIR_MSG_2) || (MsgType == EAPOL_PAIR_MSG_3)))
1384         {
1385                 if (bWPA2Capable)
1386                         Key_Data[data_offset + 0] = IE_WPA2;
1387                 else
1388                         Key_Data[data_offset + 0] = IE_WPA;
1389
1390         Key_Data[data_offset + 1] = RSNIE_LEN;
1391                 NdisMoveMemory(&Key_Data[data_offset + 2], RSNIE, RSNIE_LEN);
1392                 data_offset += (2 + RSNIE_LEN);
1393         }
1394
1395         // Encapsulate KDE format in pairwise_msg3_WPA2 & group_msg1_WPA2
1396         if (bWPA2Capable && ((MsgType == EAPOL_PAIR_MSG_3) || (MsgType == EAPOL_GROUP_MSG_1)))
1397         {
1398                 // Key Data Encapsulation (KDE) format - 802.11i-2004  Figure-43w and Table-20h
1399         Key_Data[data_offset + 0] = 0xDD;
1400
1401                 if (GroupKeyWepStatus == Ndis802_11Encryption3Enabled)
1402                 {
1403                         Key_Data[data_offset + 1] = 0x16;// 4+2+16(OUI+DataType+DataField)
1404                 }
1405                 else
1406                 {
1407                         Key_Data[data_offset + 1] = 0x26;// 4+2+32(OUI+DataType+DataField)
1408                 }
1409
1410         Key_Data[data_offset + 2] = 0x00;
1411         Key_Data[data_offset + 3] = 0x0F;
1412         Key_Data[data_offset + 4] = 0xAC;
1413         Key_Data[data_offset + 5] = 0x01;
1414
1415                 // GTK KDE format - 802.11i-2004  Figure-43x
1416         Key_Data[data_offset + 6] = (DefaultKeyIdx & 0x03);
1417         Key_Data[data_offset + 7] = 0x00;       // Reserved Byte
1418
1419                 data_offset += 8;
1420         }
1421
1422
1423         // Encapsulate GTK and encrypt the key-data field with KEK.
1424         // Only for pairwise_msg3_WPA2 and group_msg1
1425         if ((MsgType == EAPOL_PAIR_MSG_3 && bWPA2Capable) || (MsgType == EAPOL_GROUP_MSG_1))
1426         {
1427                 // Fill in GTK
1428                 if (GroupKeyWepStatus == Ndis802_11Encryption3Enabled)
1429                 {
1430                         NdisMoveMemory(&Key_Data[data_offset], GTK, LEN_AES_KEY);
1431                         data_offset += LEN_AES_KEY;
1432                 }
1433                 else
1434                 {
1435                         NdisMoveMemory(&Key_Data[data_offset], GTK, TKIP_GTK_LENGTH);
1436                         data_offset += TKIP_GTK_LENGTH;
1437                 }
1438
1439                 // Still dont know why, but if not append will occur "GTK not include in MSG3"
1440                 // Patch for compatibility between zero config and funk
1441                 if (MsgType == EAPOL_PAIR_MSG_3 && bWPA2Capable)
1442                 {
1443                         if (GroupKeyWepStatus == Ndis802_11Encryption3Enabled)
1444                         {
1445                                 Key_Data[data_offset + 0] = 0xDD;
1446                                 Key_Data[data_offset + 1] = 0;
1447                                 data_offset += 2;
1448                         }
1449                         else
1450                         {
1451                                 Key_Data[data_offset + 0] = 0xDD;
1452                                 Key_Data[data_offset + 1] = 0;
1453                                 Key_Data[data_offset + 2] = 0;
1454                                 Key_Data[data_offset + 3] = 0;
1455                                 Key_Data[data_offset + 4] = 0;
1456                                 Key_Data[data_offset + 5] = 0;
1457                                 data_offset += 6;
1458                         }
1459                 }
1460
1461                 // Encrypt the data material in key data field
1462                 if (WepStatus == Ndis802_11Encryption3Enabled)
1463                 {
1464                         AES_GTK_KEY_WRAP(&PTK[16], Key_Data, data_offset, Rc4GTK);
1465             // AES wrap function will grow 8 bytes in length
1466             data_offset += 8;
1467                 }
1468                 else
1469                 {
1470                         // PREPARE Encrypted  "Key DATA" field.  (Encrypt GTK with RC4, usinf PTK[16]->[31] as Key, IV-field as IV)
1471                         // put TxTsc in Key RSC field
1472                         pAd->PrivateInfo.FCSCRC32 = PPPINITFCS32;   //Init crc32.
1473
1474                         // ekey is the contanetion of IV-field, and PTK[16]->PTK[31]
1475                         NdisMoveMemory(ekey, pMsg->KeyDesc.KeyIv, LEN_KEY_DESC_IV);
1476                         NdisMoveMemory(&ekey[LEN_KEY_DESC_IV], &PTK[16], LEN_EAP_EK);
1477                         ARCFOUR_INIT(&pAd->PrivateInfo.WEPCONTEXT, ekey, sizeof(ekey));  //INIT SBOX, KEYLEN+3(IV)
1478                         pAd->PrivateInfo.FCSCRC32 = RTMP_CALC_FCS32(pAd->PrivateInfo.FCSCRC32, Key_Data, data_offset);
1479                         WPAARCFOUR_ENCRYPT(&pAd->PrivateInfo.WEPCONTEXT, Rc4GTK, Key_Data, data_offset);
1480                 }
1481
1482                 NdisMoveMemory(pMsg->KeyDesc.KeyData, Rc4GTK, data_offset);
1483         }
1484         else
1485         {
1486                 NdisMoveMemory(pMsg->KeyDesc.KeyData, Key_Data, data_offset);
1487         }
1488
1489         // set key data length field and total length
1490         pMsg->KeyDesc.KeyDataLen[1] = data_offset;
1491     pMsg->Body_Len[1] += data_offset;
1492
1493         os_free_mem(pAd, mpool);
1494
1495 }
1496
1497 /*
1498         ========================================================================
1499
1500         Routine Description:
1501                 Calcaulate MIC. It is used during 4-ways handsharking.
1502
1503         Arguments:
1504                 pAd                             -       pointer to our pAdapter context
1505         PeerWepStatus   -       indicate the encryption type
1506
1507         Return Value:
1508
1509         Note:
1510
1511         ========================================================================
1512 */
1513 VOID    CalculateMIC(
1514         IN      PRTMP_ADAPTER   pAd,
1515         IN      UCHAR                   PeerWepStatus,
1516         IN      UCHAR                   *PTK,
1517         OUT PEAPOL_PACKET   pMsg)
1518 {
1519     UCHAR   *OutBuffer;
1520         ULONG   FrameLen = 0;
1521         UCHAR   mic[LEN_KEY_DESC_MIC];
1522         UCHAR   digest[80];
1523
1524         // allocate memory for MIC calculation
1525         os_alloc_mem(pAd, (PUCHAR *)&OutBuffer, 512);
1526
1527     if (OutBuffer == NULL)
1528     {
1529                 DBGPRINT(RT_DEBUG_ERROR, ("!!!CalculateMIC: no memory!!!\n"));
1530                 return;
1531     }
1532
1533         // make a frame for calculating MIC.
1534     MakeOutgoingFrame(OutBuffer,                &FrameLen,
1535                       pMsg->Body_Len[1] + 4,    pMsg,
1536                       END_OF_ARGS);
1537
1538         NdisZeroMemory(mic, sizeof(mic));
1539
1540         // Calculate MIC
1541     if (PeerWepStatus == Ndis802_11Encryption3Enabled)
1542         {
1543                 HMAC_SHA1(OutBuffer,  FrameLen, PTK, LEN_EAP_MICK, digest);
1544                 NdisMoveMemory(mic, digest, LEN_KEY_DESC_MIC);
1545         }
1546         else
1547         {
1548                 hmac_md5(PTK,  LEN_EAP_MICK, OutBuffer, FrameLen, mic);
1549         }
1550
1551         // store the calculated MIC
1552         NdisMoveMemory(pMsg->KeyDesc.KeyMic, mic, LEN_KEY_DESC_MIC);
1553
1554         os_free_mem(pAd, OutBuffer);
1555 }
1556
1557 /*
1558         ========================================================================
1559
1560         Routine Description:
1561                 Some received frames can't decrypt by Asic, so decrypt them by software.
1562
1563         Arguments:
1564                 pAd                             -       pointer to our pAdapter context
1565         PeerWepStatus   -       indicate the encryption type
1566
1567         Return Value:
1568                 NDIS_STATUS_SUCCESS             -       decryption successful
1569                 NDIS_STATUS_FAILURE             -       decryption failure
1570
1571         ========================================================================
1572 */
1573 NDIS_STATUS     RTMPSoftDecryptBroadCastData(
1574         IN      PRTMP_ADAPTER                                   pAd,
1575         IN      RX_BLK                                                  *pRxBlk,
1576         IN  NDIS_802_11_ENCRYPTION_STATUS       GroupCipher,
1577         IN  PCIPHER_KEY                                         pShard_key)
1578 {
1579         PRXWI_STRUC                     pRxWI = pRxBlk->pRxWI;
1580
1581
1582
1583         // handle WEP decryption
1584         if (GroupCipher == Ndis802_11Encryption1Enabled)
1585     {
1586                 if (RTMPSoftDecryptWEP(pAd, pRxBlk->pData, pRxWI->MPDUtotalByteCount, pShard_key))
1587                 {
1588
1589                         //Minus IV[4] & ICV[4]
1590                         pRxWI->MPDUtotalByteCount -= 8;
1591                 }
1592                 else
1593                 {
1594                         DBGPRINT(RT_DEBUG_ERROR, ("ERROR : Software decrypt WEP data fails.\n"));
1595                         // give up this frame
1596                         return NDIS_STATUS_FAILURE;
1597                 }
1598         }
1599         // handle TKIP decryption
1600         else if (GroupCipher == Ndis802_11Encryption2Enabled)
1601         {
1602                 if (RTMPSoftDecryptTKIP(pAd, pRxBlk->pData, pRxWI->MPDUtotalByteCount, 0, pShard_key))
1603                 {
1604
1605                         //Minus 8 bytes MIC, 8 bytes IV/EIV, 4 bytes ICV
1606                         pRxWI->MPDUtotalByteCount -= 20;
1607                 }
1608         else
1609                 {
1610                         DBGPRINT(RT_DEBUG_ERROR, ("ERROR : RTMPSoftDecryptTKIP Failed\n"));
1611                         // give up this frame
1612                         return NDIS_STATUS_FAILURE;
1613         }
1614         }
1615         // handle AES decryption
1616         else if (GroupCipher == Ndis802_11Encryption3Enabled)
1617         {
1618                 if (RTMPSoftDecryptAES(pAd, pRxBlk->pData, pRxWI->MPDUtotalByteCount , pShard_key))
1619                 {
1620
1621                         //8 bytes MIC, 8 bytes IV/EIV (CCMP Header)
1622                         pRxWI->MPDUtotalByteCount -= 16;
1623                 }
1624                 else
1625                 {
1626                         DBGPRINT(RT_DEBUG_ERROR, ("ERROR : RTMPSoftDecryptAES Failed\n"));
1627                         // give up this frame
1628                         return NDIS_STATUS_FAILURE;
1629                 }
1630         }
1631         else
1632         {
1633                 // give up this frame
1634                 return NDIS_STATUS_FAILURE;
1635         }
1636
1637         return NDIS_STATUS_SUCCESS;
1638
1639 }
1640