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