[mirror_edk2.git] / NetworkPkg / WifiConnectionManagerDxe / WifiConnectionMgrMisc.c

/** @file\r
  The Miscellaneous Routines for WiFi Connection Manager.\r
\r
  Copyright (c) 2019 - 2022, Intel Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "WifiConnectionMgrDxe.h"\r
\r
//\r
//  STA AKM preference order\r
//  REF: https://www.wi-fi.org/file/wpa3-specification\r
//\r
STATIC UINT32  mAKMSuitePreference[] = {\r
  IEEE_80211_AKM_SUITE_8021X_SUITE_B192,            // AKM Suite 12\r
  IEEE_80211_AKM_SUITE_8021X_SUITE_B,               // AKM Suite 11\r
  IEEE_80211_AKM_SUITE_8021X_OR_PMKSA_SHA256,       // AKM Suite 5\r
  IEEE_80211_AKM_SUITE_8021X_OR_PMKSA,              // AKM Suite 1\r
\r
  IEEE_80211_AKM_SUITE_SAE,                         // AKM Suite 8\r
  IEEE_80211_AKM_SUITE_PSK_SHA256,                  // AKM Suite 6\r
  IEEE_80211_AKM_SUITE_PSK,                         // AKM Suite 2\r
\r
  IEEE_80211_AKM_SUITE_OWE                          // AKM Suite 18\r
};\r
#define AKM_SUITE_PREFERENCE_COUNT  (sizeof (mAKMSuitePreference)  / sizeof (UINT32))\r
\r
/**\r
  Empty function for event process function.\r
\r
  @param Event    The Event need to be process\r
  @param Context  The context of the event.\r
\r
**/\r
VOID\r
EFIAPI\r
WifiMgrInternalEmptyFunction (\r
  IN  EFI_EVENT  Event,\r
  IN  VOID       *Context\r
  )\r
{\r
  return;\r
}\r
\r
/**\r
  Convert the mac address into a hexadecimal encoded ":" seperated string.\r
\r
  @param[in]  Mac     The mac address.\r
  @param[in]  StrSize The size, in bytes, of the output buffer specified by Str.\r
  @param[out] Str     The storage to return the mac string.\r
\r
**/\r
VOID\r
WifiMgrMacAddrToStr (\r
  IN  EFI_80211_MAC_ADDRESS  *Mac,\r
  IN  UINT32                 StrSize,\r
  OUT CHAR16                 *Str\r
  )\r
{\r
  if ((Mac == NULL) || (Str == NULL)) {\r
    return;\r
  }\r
\r
  UnicodeSPrint (\r
    Str,\r
    StrSize,\r
    L"%02X:%02X:%02X:%02X:%02X:%02X",\r
    Mac->Addr[0],\r
    Mac->Addr[1],\r
    Mac->Addr[2],\r
    Mac->Addr[3],\r
    Mac->Addr[4],\r
    Mac->Addr[5]\r
    );\r
}\r
\r
/**\r
  Read private key file to buffer.\r
\r
  @param[in]   FileContext           The file context of private key file.\r
  @param[out]  PrivateKeyDataAddr    The buffer address to restore private key file, should be\r
                                     freed by caller.\r
  @param[out]  PrivateKeyDataSize    The size of read private key file.\r
\r
  @retval EFI_SUCCESS                Successfully read the private key file.\r
  @retval EFI_INVALID_PARAMETER      One or more of the parameters is invalid.\r
\r
**/\r
EFI_STATUS\r
WifiMgrReadFileToBuffer (\r
  IN   WIFI_MGR_FILE_CONTEXT  *FileContext,\r
  OUT  VOID                   **DataAddr,\r
  OUT  UINTN                  *DataSize\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  if ((FileContext != NULL) && (FileContext->FHandle != NULL)) {\r
    Status = ReadFileContent (\r
               FileContext->FHandle,\r
               DataAddr,\r
               DataSize,\r
               0\r
               );\r
\r
    if (FileContext->FHandle != NULL) {\r
      FileContext->FHandle->Close (FileContext->FHandle);\r
    }\r
\r
    FileContext->FHandle = NULL;\r
    return Status;\r
  }\r
\r
  return EFI_INVALID_PARAMETER;\r
}\r
\r
/**\r
  Get the Nic data by the NicIndex.\r
\r
  @param[in]  Private        The pointer to the global private data structure.\r
  @param[in]  NicIndex       The index indicates the position of wireless NIC.\r
\r
  @return     Pointer to the Nic data, or NULL if not found.\r
\r
**/\r
WIFI_MGR_DEVICE_DATA *\r
WifiMgrGetNicByIndex (\r
  IN WIFI_MGR_PRIVATE_DATA  *Private,\r
  IN UINT32                 NicIndex\r
  )\r
{\r
  LIST_ENTRY            *Entry;\r
  WIFI_MGR_DEVICE_DATA  *Nic;\r
\r
  if (Private == NULL) {\r
    return NULL;\r
  }\r
\r
  NET_LIST_FOR_EACH (Entry, &Private->NicList) {\r
    Nic = NET_LIST_USER_STRUCT_S (\r
            Entry,\r
            WIFI_MGR_DEVICE_DATA,\r
            Link,\r
            WIFI_MGR_DEVICE_DATA_SIGNATURE\r
            );\r
    if (Nic->NicIndex == NicIndex) {\r
      return Nic;\r
    }\r
  }\r
\r
  return NULL;\r
}\r
\r
/**\r
  Find a network profile through its' SSId and securit type, and the SSId is an unicode string.\r
\r
  @param[in]  SSId                   The target network's SSId.\r
  @param[in]  SecurityType           The target network's security type.\r
  @param[in]  ProfileList            The profile list on a Nic.\r
\r
  @return Pointer to a network profile, or NULL if not found.\r
\r
**/\r
WIFI_MGR_NETWORK_PROFILE *\r
WifiMgrGetProfileByUnicodeSSId (\r
  IN  CHAR16      *SSId,\r
  IN  UINT8       SecurityType,\r
  IN  LIST_ENTRY  *ProfileList\r
  )\r
{\r
  LIST_ENTRY                *Entry;\r
  WIFI_MGR_NETWORK_PROFILE  *Profile;\r
\r
  if ((SSId == NULL) || (ProfileList == NULL)) {\r
    return NULL;\r
  }\r
\r
  NET_LIST_FOR_EACH (Entry, ProfileList) {\r
    Profile = NET_LIST_USER_STRUCT_S (\r
                Entry,\r
                WIFI_MGR_NETWORK_PROFILE,\r
                Link,\r
                WIFI_MGR_PROFILE_SIGNATURE\r
                );\r
    if ((StrCmp (SSId, Profile->SSId) == 0) && (SecurityType == Profile->SecurityType)) {\r
      return Profile;\r
    }\r
  }\r
\r
  return NULL;\r
}\r
\r
/**\r
  Find a network profile through its' SSId and securit type, and the SSId is an ascii string.\r
\r
  @param[in]  SSId               The target network's SSId.\r
  @param[in]  SecurityType       The target network's security type.\r
  @param[in]  ProfileList        The profile list on a Nic.\r
\r
  @return Pointer to a network profile, or NULL if not found.\r
\r
**/\r
WIFI_MGR_NETWORK_PROFILE *\r
WifiMgrGetProfileByAsciiSSId (\r
  IN  CHAR8       *SSId,\r
  IN  UINT8       SecurityType,\r
  IN  LIST_ENTRY  *ProfileList\r
  )\r
{\r
  CHAR16  SSIdUniCode[SSID_STORAGE_SIZE];\r
\r
  if (SSId == NULL) {\r
    return NULL;\r
  }\r
\r
  if (AsciiStrToUnicodeStrS (SSId, SSIdUniCode, SSID_STORAGE_SIZE) != RETURN_SUCCESS) {\r
    return NULL;\r
  }\r
\r
  return WifiMgrGetProfileByUnicodeSSId (SSIdUniCode, SecurityType, ProfileList);\r
}\r
\r
/**\r
  Find a network profile through its' profile index.\r
\r
  @param[in]  ProfileIndex           The target network's profile index.\r
  @param[in]  ProfileList            The profile list on a Nic.\r
\r
  @return Pointer to a network profile, or NULL if not found.\r
\r
**/\r
WIFI_MGR_NETWORK_PROFILE *\r
WifiMgrGetProfileByProfileIndex (\r
  IN  UINT32      ProfileIndex,\r
  IN  LIST_ENTRY  *ProfileList\r
  )\r
{\r
  WIFI_MGR_NETWORK_PROFILE  *Profile;\r
  LIST_ENTRY                *Entry;\r
\r
  if (ProfileList == NULL) {\r
    return NULL;\r
  }\r
\r
  NET_LIST_FOR_EACH (Entry, ProfileList) {\r
    Profile = NET_LIST_USER_STRUCT_S (\r
                Entry,\r
                WIFI_MGR_NETWORK_PROFILE,\r
                Link,\r
                WIFI_MGR_PROFILE_SIGNATURE\r
                );\r
    if (Profile->ProfileIndex == ProfileIndex) {\r
      return Profile;\r
    }\r
  }\r
  return NULL;\r
}\r
\r
/**\r
  To test if the AKMSuite is in supported AKMSuite list.\r
\r
  @param[in]  SupportedAKMSuiteCount       The count of the supported AKMSuites.\r
  @param[in]  SupportedAKMSuiteList        The supported AKMSuite list.\r
  @param[in]  AKMSuite                     The AKMSuite to be tested.\r
\r
  @return True if this AKMSuite is supported, or False if not.\r
\r
**/\r
BOOLEAN\r
WifiMgrSupportAKMSuite (\r
  IN  UINT16  SupportedAKMSuiteCount,\r
  IN  UINT32  *SupportedAKMSuiteList,\r
  IN  UINT32  *AKMSuite\r
  )\r
{\r
  UINT16  Index;\r
\r
  if ((AKMSuite == NULL) || (SupportedAKMSuiteList == NULL) ||\r
      (SupportedAKMSuiteCount == 0))\r
  {\r
    return FALSE;\r
  }\r
\r
  for (Index = 0; Index < SupportedAKMSuiteCount; Index++) {\r
    if (SupportedAKMSuiteList[Index] == *AKMSuite) {\r
      return TRUE;\r
    }\r
  }\r
\r
  return FALSE;\r
}\r
\r
/**\r
  To check if the CipherSuite is in supported CipherSuite list.\r
\r
  @param[in]  SupportedCipherSuiteCount       The count of the supported CipherSuites.\r
  @param[in]  SupportedCipherSuiteList        The supported CipherSuite list.\r
  @param[in]  CipherSuite                     The CipherSuite to be tested.\r
\r
  @return True if this CipherSuite is supported, or False if not.\r
\r
**/\r
BOOLEAN\r
WifiMgrSupportCipherSuite (\r
  IN  UINT16  SupportedCipherSuiteCount,\r
  IN  UINT32  *SupportedCipherSuiteList,\r
  IN  UINT32  *CipherSuite\r
  )\r
{\r
  UINT16  Index;\r
\r
  if ((CipherSuite == NULL) || (SupportedCipherSuiteCount == 0) ||\r
      (SupportedCipherSuiteList == NULL))\r
  {\r
    return FALSE;\r
  }\r
\r
  for (Index = 0; Index < SupportedCipherSuiteCount; Index++) {\r
    if (SupportedCipherSuiteList[Index] == *CipherSuite) {\r
      return TRUE;\r
    }\r
  }\r
\r
  return FALSE;\r
}\r
\r
/**\r
  Check an AKM suite list and a Cipher suite list to see if one or more AKM suites or Cipher suites\r
  are supported and find the matchable security type.\r
\r
  @param[in]   AKMList                     The target AKM suite list to be checked.\r
  @param[in]   CipherList                  The target Cipher suite list to be checked\r
  @param[in]   Nic                         The Nic to operate, contains the supported AKMSuite list\r
                                           and supported CipherSuite list\r
  @param[out]  SecurityType                To identify a security type from the AKM suite list and\r
                                           Cipher suite list\r
  @param[out]  AKMSuiteSupported           To identify if this security type is supported. If it is\r
                                           NULL, overcome this field\r
  @param[out]  CipherSuiteSupported        To identify if this security type is supported. If it is\r
                                           NULL, overcome this field\r
\r
  @retval EFI_SUCCESS                      This operation has completed successfully.\r
  @retval EFI_INVALID_PARAMETER            No Nic found or the suite list is null.\r
\r
**/\r
EFI_STATUS\r
WifiMgrCheckRSN (\r
  IN    EFI_80211_AKM_SUITE_SELECTOR     *AKMList,\r
  IN    EFI_80211_CIPHER_SUITE_SELECTOR  *CipherList,\r
  IN    WIFI_MGR_DEVICE_DATA             *Nic,\r
  OUT   UINT8                            *SecurityType,\r
  OUT   BOOLEAN                          *AKMSuiteSupported,\r
  OUT   BOOLEAN                          *CipherSuiteSupported\r
  )\r
{\r
  EFI_80211_AKM_SUITE_SELECTOR     *SupportedAKMSuites;\r
  EFI_80211_CIPHER_SUITE_SELECTOR  *SupportedSwCipherSuites;\r
  EFI_80211_CIPHER_SUITE_SELECTOR  *SupportedHwCipherSuites;\r
  UINT32                           *AKMSuite;\r
  EFI_80211_SUITE_SELECTOR         *CipherSuite;\r
  UINT16                           AKMIndex;\r
  UINT16                           CipherIndex;\r
\r
  if ((Nic == NULL) || (AKMList == NULL) || (CipherList == NULL) || (SecurityType == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  SupportedAKMSuites      = Nic->SupportedSuites.SupportedAKMSuites;\r
  SupportedSwCipherSuites = Nic->SupportedSuites.SupportedSwCipherSuites;\r
  SupportedHwCipherSuites = Nic->SupportedSuites.SupportedHwCipherSuites;\r
\r
  *SecurityType = SECURITY_TYPE_UNKNOWN;\r
  if ((AKMSuiteSupported != NULL) && (CipherSuiteSupported != NULL)) {\r
    *AKMSuiteSupported    = FALSE;\r
    *CipherSuiteSupported = FALSE;\r
  }\r
\r
  if (AKMList->AKMSuiteCount == 0) {\r
    if (CipherList->CipherSuiteCount == 0) {\r
      *SecurityType = SECURITY_TYPE_NONE;\r
      if ((AKMSuiteSupported != NULL) && (CipherSuiteSupported != NULL)) {\r
        *AKMSuiteSupported    = TRUE;\r
        *CipherSuiteSupported = TRUE;\r
      }\r
    }\r
\r
    return EFI_SUCCESS;\r
  }\r
\r
  for (AKMIndex = 0; AKMIndex < AKM_SUITE_PREFERENCE_COUNT; AKMIndex++) {\r
    AKMSuite = mAKMSuitePreference + AKMIndex;\r
    if (WifiMgrSupportAKMSuite (AKMList->AKMSuiteCount, (UINT32 *)AKMList->AKMSuiteList, AKMSuite) &&\r
        WifiMgrSupportAKMSuite (SupportedAKMSuites->AKMSuiteCount, (UINT32 *)SupportedAKMSuites->AKMSuiteList, AKMSuite))\r
    {\r
      if ((AKMSuiteSupported != NULL) && (CipherSuiteSupported != NULL)) {\r
        *AKMSuiteSupported = TRUE;\r
      }\r
\r
      //\r
      // OWE transition mode allow CipherSuiteCount is 0\r
      //\r
      if (CipherList->CipherSuiteCount == 0) {\r
        *SecurityType = WifiMgrGetSecurityType ((UINT32 *)AKMSuite, NULL);\r
        if (*SecurityType != SECURITY_TYPE_UNKNOWN) {\r
          if ((AKMSuiteSupported != NULL) && (CipherSuiteSupported != NULL)) {\r
            *CipherSuiteSupported = TRUE;\r
          }\r
\r
          return EFI_SUCCESS;\r
        }\r
      }\r
\r
      for (CipherIndex = 0; CipherIndex < CipherList->CipherSuiteCount; CipherIndex++) {\r
        CipherSuite = CipherList->CipherSuiteList + CipherIndex;\r
\r
        if (SupportedSwCipherSuites != NULL) {\r
          if (WifiMgrSupportCipherSuite (\r
                SupportedSwCipherSuites->CipherSuiteCount,\r
                (UINT32 *)SupportedSwCipherSuites->CipherSuiteList,\r
                (UINT32 *)CipherSuite\r
                ))\r
          {\r
            *SecurityType = WifiMgrGetSecurityType ((UINT32 *)AKMSuite, (UINT32 *)CipherSuite);\r
\r
            if (*SecurityType != SECURITY_TYPE_UNKNOWN) {\r
              if ((AKMSuiteSupported != NULL) && (CipherSuiteSupported != NULL)) {\r
                *CipherSuiteSupported = TRUE;\r
              }\r
\r
              return EFI_SUCCESS;\r
            }\r
          }\r
        }\r
\r
        if (SupportedHwCipherSuites != NULL) {\r
          if (WifiMgrSupportCipherSuite (\r
                SupportedHwCipherSuites->CipherSuiteCount,\r
                (UINT32 *)SupportedHwCipherSuites->CipherSuiteList,\r
                (UINT32 *)CipherSuite\r
                ))\r
          {\r
            *SecurityType = WifiMgrGetSecurityType ((UINT32 *)AKMSuite, (UINT32 *)CipherSuite);\r
\r
            if (*SecurityType != SECURITY_TYPE_UNKNOWN) {\r
              if ((AKMSuiteSupported != NULL) && (CipherSuiteSupported != NULL)) {\r
                *CipherSuiteSupported = TRUE;\r
              }\r
\r
              return EFI_SUCCESS;\r
            }\r
          }\r
        }\r
      }\r
    }\r
  }\r
\r
  *SecurityType = WifiMgrGetSecurityType (\r
                    (UINT32 *)AKMList->AKMSuiteList,\r
                    (UINT32 *)CipherList->CipherSuiteList\r
                    );\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Get the security type for a certain AKMSuite and CipherSuite.\r
\r
  @param[in]   AKMSuite             An certain AKMSuite.\r
  @param[in]   CipherSuite          An certain CipherSuite.\r
\r
  @return a security type if found, or SECURITY_TYPE_UNKNOWN.\r
\r
**/\r
UINT8\r
WifiMgrGetSecurityType (\r
  IN  UINT32  *AKMSuite,\r
  IN  UINT32  *CipherSuite\r
  )\r
{\r
  if ((AKMSuite != NULL) && (*AKMSuite == IEEE_80211_AKM_SUITE_OWE)) {\r
    return SECURITY_TYPE_NONE;\r
  }\r
\r
  if (CipherSuite == NULL) {\r
    if (AKMSuite == NULL) {\r
      return SECURITY_TYPE_NONE;\r
    } else {\r
      return SECURITY_TYPE_UNKNOWN;\r
    }\r
  } else if (*CipherSuite == IEEE_80211_PAIRWISE_CIPHER_SUITE_USE_GROUP) {\r
    if (AKMSuite == NULL) {\r
      return SECURITY_TYPE_NONE;\r
    } else {\r
      return SECURITY_TYPE_UNKNOWN;\r
    }\r
  } else if ((*CipherSuite == IEEE_80211_PAIRWISE_CIPHER_SUITE_WEP40) ||\r
             (*CipherSuite == IEEE_80211_PAIRWISE_CIPHER_SUITE_WEP104))\r
  {\r
    return SECURITY_TYPE_WEP;\r
  } else if (*CipherSuite == IEEE_80211_PAIRWISE_CIPHER_SUITE_CCMP) {\r
    if (AKMSuite == NULL) {\r
      return SECURITY_TYPE_UNKNOWN;\r
    }\r
\r
    if (*AKMSuite == IEEE_80211_AKM_SUITE_SAE) {\r
      return SECURITY_TYPE_WPA3_PERSONAL;\r
    } else if ((*AKMSuite == IEEE_80211_AKM_SUITE_8021X_OR_PMKSA) ||\r
               (*AKMSuite == IEEE_80211_AKM_SUITE_8021X_OR_PMKSA_SHA256))\r
    {\r
      return SECURITY_TYPE_WPA2_ENTERPRISE;\r
    } else if ((*AKMSuite == IEEE_80211_AKM_SUITE_PSK) ||\r
               (*AKMSuite == IEEE_80211_AKM_SUITE_PSK_SHA256))\r
    {\r
      return SECURITY_TYPE_WPA2_PERSONAL;\r
    } else {\r
      return SECURITY_TYPE_UNKNOWN;\r
    }\r
  } else if (*CipherSuite == IEEE_80211_PAIRWISE_CIPHER_SUITE_TKIP) {\r
    if (AKMSuite == NULL) {\r
      return SECURITY_TYPE_UNKNOWN;\r
    }\r
\r
    if ((*AKMSuite == IEEE_80211_AKM_SUITE_8021X_OR_PMKSA) ||\r
        (*AKMSuite == IEEE_80211_AKM_SUITE_8021X_OR_PMKSA_SHA256))\r
    {\r
      return SECURITY_TYPE_WPA_ENTERPRISE;\r
    } else if ((*AKMSuite == IEEE_80211_AKM_SUITE_PSK) ||\r
               (*AKMSuite == IEEE_80211_AKM_SUITE_PSK_SHA256))\r
    {\r
      return SECURITY_TYPE_WPA_PERSONAL;\r
    } else {\r
      return SECURITY_TYPE_UNKNOWN;\r
    }\r
  } else if (*CipherSuite == IEEE_80211_PAIRWISE_CIPHER_SUITE_GCMP) {\r
    if (AKMSuite == NULL) {\r
      return SECURITY_TYPE_UNKNOWN;\r
    }\r
\r
    if (*AKMSuite == IEEE_80211_AKM_SUITE_8021X_SUITE_B) {\r
      return SECURITY_TYPE_WPA3_ENTERPRISE;\r
    } else {\r
      return SECURITY_TYPE_UNKNOWN;\r
    }\r
  } else if (*CipherSuite == IEEE_80211_PAIRWISE_CIPHER_SUITE_GCMP256) {\r
    if (AKMSuite == NULL) {\r
      return SECURITY_TYPE_UNKNOWN;\r
    }\r
\r
    if (*AKMSuite == IEEE_80211_AKM_SUITE_8021X_SUITE_B192) {\r
      return SECURITY_TYPE_WPA3_ENTERPRISE;\r
    } else {\r
      return SECURITY_TYPE_UNKNOWN;\r
    }\r
  } else {\r
    return SECURITY_TYPE_UNKNOWN;\r
  }\r
}\r
\r
/**\r
  Get supported AKMSuites and CipherSuites from supplicant for a Nic.\r
\r
  @param[in]   Nic                      The Nic to operate.\r
\r
  @retval EFI_SUCCESS                   Get the supported suite list successfully.\r
  @retval EFI_INVALID_PARAMETER         No Nic found or supplicant is NULL.\r
\r
**/\r
EFI_STATUS\r
WifiMgrGetSupportedSuites (\r
  IN    WIFI_MGR_DEVICE_DATA  *Nic\r
  )\r
{\r
  EFI_STATUS                       Status;\r
  EFI_SUPPLICANT_PROTOCOL          *Supplicant;\r
  EFI_80211_AKM_SUITE_SELECTOR     *SupportedAKMSuites;\r
  EFI_80211_CIPHER_SUITE_SELECTOR  *SupportedSwCipherSuites;\r
  EFI_80211_CIPHER_SUITE_SELECTOR  *SupportedHwCipherSuites;\r
  UINTN                            DataSize;\r
\r
  SupportedAKMSuites      = NULL;\r
  SupportedSwCipherSuites = NULL;\r
  SupportedHwCipherSuites = NULL;\r
\r
  if ((Nic == NULL) || (Nic->Supplicant == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Supplicant = Nic->Supplicant;\r
\r
  DataSize = 0;\r
  Status   = Supplicant->GetData (Supplicant, EfiSupplicant80211SupportedAKMSuites, NULL, &DataSize);\r
  if ((Status == EFI_BUFFER_TOO_SMALL) && (DataSize > 0)) {\r
    SupportedAKMSuites = AllocateZeroPool (DataSize);\r
    if (SupportedAKMSuites == NULL) {\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
\r
    Status = Supplicant->GetData (\r
                           Supplicant,\r
                           EfiSupplicant80211SupportedAKMSuites,\r
                           (UINT8 *)SupportedAKMSuites,\r
                           &DataSize\r
                           );\r
    if (!EFI_ERROR (Status)) {\r
      Nic->SupportedSuites.SupportedAKMSuites = SupportedAKMSuites;\r
    } else {\r
      FreePool (SupportedAKMSuites);\r
    }\r
  } else {\r
    SupportedAKMSuites = NULL;\r
  }\r
\r
  DataSize = 0;\r
  Status   = Supplicant->GetData (Supplicant, EfiSupplicant80211SupportedSoftwareCipherSuites, NULL, &DataSize);\r
  if ((Status == EFI_BUFFER_TOO_SMALL) && (DataSize > 0)) {\r
    SupportedSwCipherSuites = AllocateZeroPool (DataSize);\r
    if (SupportedSwCipherSuites == NULL) {\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
\r
    Status = Supplicant->GetData (\r
                           Supplicant,\r
                           EfiSupplicant80211SupportedSoftwareCipherSuites,\r
                           (UINT8 *)SupportedSwCipherSuites,\r
                           &DataSize\r
                           );\r
    if (!EFI_ERROR (Status)) {\r
      Nic->SupportedSuites.SupportedSwCipherSuites = SupportedSwCipherSuites;\r
    } else {\r
      FreePool (SupportedSwCipherSuites);\r
    }\r
  } else {\r
    SupportedSwCipherSuites = NULL;\r
  }\r
\r
  DataSize = 0;\r
  Status   = Supplicant->GetData (Supplicant, EfiSupplicant80211SupportedHardwareCipherSuites, NULL, &DataSize);\r
  if ((Status == EFI_BUFFER_TOO_SMALL) && (DataSize > 0)) {\r
    SupportedHwCipherSuites = AllocateZeroPool (DataSize);\r
    if (SupportedHwCipherSuites == NULL) {\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
\r
    Status = Supplicant->GetData (\r
                           Supplicant,\r
                           EfiSupplicant80211SupportedHardwareCipherSuites,\r
                           (UINT8 *)SupportedHwCipherSuites,\r
                           &DataSize\r
                           );\r
    if (!EFI_ERROR (Status)) {\r
      Nic->SupportedSuites.SupportedHwCipherSuites = SupportedHwCipherSuites;\r
    } else {\r
      FreePool (SupportedHwCipherSuites);\r
    }\r
  } else {\r
    SupportedHwCipherSuites = NULL;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Clean secrets from a network profile.\r
\r
  @param[in]   Profile               The profile to be cleanned.\r
\r
**/\r
VOID\r
WifiMgrCleanProfileSecrets (\r
  IN  WIFI_MGR_NETWORK_PROFILE  *Profile\r
  )\r
{\r
  EFI_STATUS                        Status;\r
  EDKII_WIFI_PROFILE_SYNC_PROTOCOL  *WiFiProfileSyncProtocol;\r
\r
  ZeroMem (Profile->Password, sizeof (CHAR16) * PASSWORD_STORAGE_SIZE);\r
  ZeroMem (Profile->EapPassword, sizeof (CHAR16) * PASSWORD_STORAGE_SIZE);\r
  ZeroMem (Profile->PrivateKeyPassword, sizeof (CHAR16) * PASSWORD_STORAGE_SIZE);\r
\r
  //\r
  //  When EFI WiFi profile sync protocol is found the system is performing a recovery boot in secure\r
  //  boot mode. The profile sync driver will manage the CA certificate, client certificate, and key\r
  //  data, cleaning them at exit boot services.\r
  //\r
  Status = gBS->LocateProtocol (&gEdkiiWiFiProfileSyncProtocolGuid, NULL, (VOID **)&WiFiProfileSyncProtocol);\r
  if (!EFI_ERROR (Status)) {\r
    return;\r
  }\r
\r
  if (Profile->CACertData != NULL) {\r
    ZeroMem (Profile->CACertData, Profile->CACertSize);\r
    FreePool (Profile->CACertData);\r
  }\r
\r
  Profile->CACertData = NULL;\r
  Profile->CACertSize = 0;\r
\r
  if (Profile->ClientCertData != NULL) {\r
    ZeroMem (Profile->ClientCertData, Profile->ClientCertSize);\r
    FreePool (Profile->ClientCertData);\r
  }\r
\r
  Profile->ClientCertData = NULL;\r
  Profile->ClientCertSize = 0;\r
\r
  if (Profile->PrivateKeyData != NULL) {\r
    ZeroMem (Profile->PrivateKeyData, Profile->PrivateKeyDataSize);\r
    FreePool (Profile->PrivateKeyData);\r
  }\r
\r
  Profile->PrivateKeyData     = NULL;\r
  Profile->PrivateKeyDataSize = 0;\r
}\r
\r
/**\r
  Free all network profiles in a profile list.\r
\r
  @param[in]   ProfileList           The profile list to be freed.\r
\r
**/\r
VOID\r
WifiMgrFreeProfileList (\r
  IN  LIST_ENTRY  *ProfileList\r
  )\r
{\r
  WIFI_MGR_NETWORK_PROFILE  *Profile;\r
  LIST_ENTRY                *Entry;\r
  LIST_ENTRY                *NextEntry;\r
\r
  if (ProfileList == NULL) {\r
    return;\r
  }\r
\r
  NET_LIST_FOR_EACH_SAFE (Entry, NextEntry, ProfileList) {\r
    Profile = NET_LIST_USER_STRUCT_S (\r
                Entry,\r
                WIFI_MGR_NETWORK_PROFILE,\r
                Link,\r
                WIFI_MGR_PROFILE_SIGNATURE\r
                );\r
\r
    WifiMgrCleanProfileSecrets (Profile);\r
\r
    if (Profile->Network.AKMSuite != NULL) {\r
      FreePool (Profile->Network.AKMSuite);\r
    }\r
\r
    if (Profile->Network.CipherSuite != NULL) {\r
      FreePool (Profile->Network.CipherSuite);\r
    }\r
\r
    FreePool (Profile);\r
  }\r
}\r
\r
/**\r
  Free user configured hidden network list.\r
\r
  @param[in]   HiddenList           The hidden network list to be freed.\r
\r
**/\r
VOID\r
WifiMgrFreeHiddenList (\r
  IN  LIST_ENTRY  *HiddenList\r
  )\r
{\r
  WIFI_HIDDEN_NETWORK_DATA  *HiddenNetwork;\r
  LIST_ENTRY                *Entry;\r
  LIST_ENTRY                *NextEntry;\r
\r
  if (HiddenList == NULL) {\r
    return;\r
  }\r
\r
  NET_LIST_FOR_EACH_SAFE (Entry, NextEntry, HiddenList) {\r
    HiddenNetwork = NET_LIST_USER_STRUCT_S (\r
                      Entry,\r
                      WIFI_HIDDEN_NETWORK_DATA,\r
                      Link,\r
                      WIFI_MGR_HIDDEN_NETWORK_SIGNATURE\r
                      );\r
    FreePool (HiddenNetwork);\r
  }\r
}\r
\r
/**\r
  Free the resources of a config token.\r
\r
  @param[in]   ConfigToken          The config token to be freed.\r
**/\r
VOID\r
WifiMgrFreeToken (\r
  IN   WIFI_MGR_MAC_CONFIG_TOKEN  *ConfigToken\r
  )\r
{\r
  EFI_80211_GET_NETWORKS_RESULT  *Result;\r
\r
  if (ConfigToken == NULL) {\r
    return;\r
  }\r
\r
  switch (ConfigToken->Type) {\r
    case TokenTypeGetNetworksToken:\r
\r
      if (ConfigToken->Token.GetNetworksToken != NULL) {\r
        gBS->CloseEvent (ConfigToken->Token.GetNetworksToken->Event);\r
        if (ConfigToken->Token.GetNetworksToken->Data != NULL) {\r
          FreePool (ConfigToken->Token.GetNetworksToken->Data);\r
        }\r
\r
        Result = ConfigToken->Token.GetNetworksToken->Result;\r
        if (Result != NULL) {\r
          FreePool (Result);\r
        }\r
\r
        FreePool (ConfigToken->Token.GetNetworksToken);\r
      }\r
\r
      FreePool (ConfigToken);\r
      break;\r
\r
    case TokenTypeConnectNetworkToken:\r
\r
      if (ConfigToken->Token.ConnectNetworkToken != NULL) {\r
        gBS->CloseEvent (ConfigToken->Token.ConnectNetworkToken->Event);\r
        if (ConfigToken->Token.ConnectNetworkToken->Data != NULL) {\r
          FreePool (ConfigToken->Token.ConnectNetworkToken->Data);\r
        }\r
\r
        FreePool (ConfigToken->Token.ConnectNetworkToken);\r
      }\r
\r
      FreePool (ConfigToken);\r
      break;\r
\r
    case TokenTypeDisconnectNetworkToken:\r
\r
      if (ConfigToken->Token.DisconnectNetworkToken != NULL) {\r
        FreePool (ConfigToken->Token.DisconnectNetworkToken);\r
      }\r
\r
      FreePool (ConfigToken);\r
      break;\r
\r
    default:\r
      break;\r
  }\r
}\r