SecurityPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / SecurityPkg / VariableAuthenticated / SecureBootConfigDxe / SecureBootConfigFileExplorer.c

/** @file\r
  Internal file explorer functions for SecureBoot configuration module.\r
\r
Copyright (c) 2012 - 2016, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "SecureBootConfigImpl.h"\r
\r
VOID                  *mStartOpCodeHandle = NULL;\r
VOID                  *mEndOpCodeHandle = NULL;\r
EFI_IFR_GUID_LABEL    *mStartLabel = NULL;\r
EFI_IFR_GUID_LABEL    *mEndLabel = NULL;\r
\r
/**\r
  Refresh the global UpdateData structure.\r
\r
**/\r
VOID\r
RefreshUpdateData (\r
  VOID\r
  )\r
{\r
  //\r
  // Free current updated date\r
  //\r
  if (mStartOpCodeHandle != NULL) {\r
    HiiFreeOpCodeHandle (mStartOpCodeHandle);\r
  }\r
\r
  //\r
  // Create new OpCode Handle\r
  //\r
  mStartOpCodeHandle = HiiAllocateOpCodeHandle ();\r
\r
  //\r
  // Create Hii Extend Label OpCode as the start opcode\r
  //\r
  mStartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (\r
                                         mStartOpCodeHandle,\r
                                         &gEfiIfrTianoGuid,\r
                                         NULL,\r
                                         sizeof (EFI_IFR_GUID_LABEL)\r
                                         );\r
  mStartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;\r
}\r
\r
/**\r
  Clean up the dynamic opcode at label and form specified by both LabelId.\r
\r
  @param[in] LabelId         It is both the Form ID and Label ID for opcode deletion.\r
  @param[in] PrivateData     Module private data.\r
\r
**/\r
VOID\r
CleanUpPage (\r
  IN UINT16                           LabelId,\r
  IN SECUREBOOT_CONFIG_PRIVATE_DATA   *PrivateData\r
  )\r
{\r
  RefreshUpdateData ();\r
\r
  //\r
  // Remove all op-codes from dynamic page\r
  //\r
  mStartLabel->Number = LabelId;\r
  HiiUpdateForm (\r
    PrivateData->HiiHandle,\r
    &gSecureBootConfigFormSetGuid,\r
    LabelId,\r
    mStartOpCodeHandle, // Label LabelId\r
    mEndOpCodeHandle    // LABEL_END\r
    );\r
}\r
\r
/**\r
  Extract filename from device path. The returned buffer is allocated using AllocateCopyPool.\r
  The caller is responsible for freeing the allocated buffer using FreePool(). If return NULL\r
  means not enough memory resource.\r
\r
  @param DevicePath       Device path.\r
\r
  @retval NULL            Not enough memory resourece for AllocateCopyPool.\r
  @retval Other           A new allocated string that represents the file name.\r
\r
**/\r
CHAR16 *\r
ExtractFileNameFromDevicePath (\r
  IN   EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
  )\r
{\r
  CHAR16          *String;\r
  CHAR16          *MatchString;\r
  CHAR16          *LastMatch;\r
  CHAR16          *FileName;\r
  UINTN           Length;\r
\r
  ASSERT(DevicePath != NULL);\r
\r
  String = DevicePathToStr(DevicePath);\r
  MatchString = String;\r
  LastMatch   = String;\r
  FileName    = NULL;\r
\r
  while(MatchString != NULL){\r
    LastMatch   = MatchString + 1;\r
    MatchString = StrStr(LastMatch,L"\\");\r
  }\r
\r
  Length = StrLen(LastMatch);\r
  FileName = AllocateCopyPool ((Length + 1) * sizeof(CHAR16), LastMatch);\r
  if (FileName != NULL) {\r
    *(FileName + Length) = 0;\r
  }\r
\r
  FreePool(String);\r
\r
  return FileName;\r
}\r
\r
\r
/**\r
  Update  the form base on the selected file.\r
\r
  @param FilePath   Point to the file path.\r
  @param FormId     The form need to display.\r
\r
  @retval TRUE   Exit caller function.\r
  @retval FALSE  Not exit caller function.\r
\r
**/\r
BOOLEAN\r
UpdatePage(\r
  IN  EFI_DEVICE_PATH_PROTOCOL  *FilePath,\r
  IN  EFI_FORM_ID               FormId\r
  )\r
{\r
  CHAR16                *FileName;\r
  EFI_STRING_ID         StringToken;\r
\r
  FileName = NULL;\r
\r
  if (FilePath != NULL) {\r
    FileName = ExtractFileNameFromDevicePath(FilePath);\r
  }\r
  if (FileName == NULL) {\r
    //\r
    // FileName = NULL has two case:\r
    // 1. FilePath == NULL, not select file.\r
    // 2. FilePath != NULL, but ExtractFileNameFromDevicePath return NULL not enough memory resource.\r
    // In these two case, no need to update the form, and exit the caller function.\r
    //\r
    return TRUE;\r
  }\r
  StringToken =  HiiSetString (gSecureBootPrivateData->HiiHandle, 0, FileName, NULL);\r
\r
  gSecureBootPrivateData->FileContext->FileName = FileName;\r
\r
  EfiOpenFileByDevicePath (\r
    &FilePath,\r
    &gSecureBootPrivateData->FileContext->FHandle,\r
    EFI_FILE_MODE_READ,\r
    0\r
    );\r
  //\r
  // Create Subtitle op-code for the display string of the option.\r
  //\r
  RefreshUpdateData ();\r
  mStartLabel->Number = FormId;\r
\r
  HiiCreateSubTitleOpCode (\r
    mStartOpCodeHandle,\r
    StringToken,\r
    0,\r
    0,\r
    0\r
   );\r
\r
  HiiUpdateForm (\r
    gSecureBootPrivateData->HiiHandle,\r
    &gSecureBootConfigFormSetGuid,\r
    FormId,\r
    mStartOpCodeHandle, // Label FormId\r
    mEndOpCodeHandle    // LABEL_END\r
    );\r
\r
  return TRUE;\r
}\r
\r
/**\r
  Update the PK form base on the input file path info.\r
\r
  @param FilePath    Point to the file path.\r
\r
  @retval TRUE   Exit caller function.\r
  @retval FALSE  Not exit caller function.\r
**/\r
BOOLEAN\r
EFIAPI\r
UpdatePKFromFile (\r
  IN EFI_DEVICE_PATH_PROTOCOL    *FilePath\r
  )\r
{\r
  return UpdatePage(FilePath, FORMID_ENROLL_PK_FORM);\r
\r
}\r
\r
/**\r
  Update the KEK form base on the input file path info.\r
\r
  @param FilePath    Point to the file path.\r
\r
  @retval TRUE   Exit caller function.\r
  @retval FALSE  Not exit caller function.\r
**/\r
BOOLEAN\r
EFIAPI\r
UpdateKEKFromFile (\r
  IN EFI_DEVICE_PATH_PROTOCOL    *FilePath\r
  )\r
{\r
  return UpdatePage(FilePath, FORMID_ENROLL_KEK_FORM);\r
}\r
\r
/**\r
  Update the DB form base on the input file path info.\r
\r
  @param FilePath    Point to the file path.\r
\r
  @retval TRUE   Exit caller function.\r
  @retval FALSE  Not exit caller function.\r
**/\r
BOOLEAN\r
EFIAPI\r
UpdateDBFromFile (\r
  IN EFI_DEVICE_PATH_PROTOCOL    *FilePath\r
  )\r
{\r
  return UpdatePage(FilePath, SECUREBOOT_ENROLL_SIGNATURE_TO_DB);\r
}\r
\r
/**\r
  Update the DBX form base on the input file path info.\r
\r
  @param FilePath    Point to the file path.\r
\r
  @retval TRUE   Exit caller function.\r
  @retval FALSE  Not exit caller function.\r
**/\r
BOOLEAN\r
EFIAPI\r
UpdateDBXFromFile (\r
  IN EFI_DEVICE_PATH_PROTOCOL    *FilePath\r
  )\r
{\r
  return UpdatePage(FilePath, SECUREBOOT_ENROLL_SIGNATURE_TO_DBX);\r
}\r
\r
/**\r
  Update the DBT form base on the input file path info.\r
\r
  @param FilePath    Point to the file path.\r
\r
  @retval TRUE   Exit caller function.\r
  @retval FALSE  Not exit caller function.\r
**/\r
BOOLEAN\r
EFIAPI\r
UpdateDBTFromFile (\r
  IN EFI_DEVICE_PATH_PROTOCOL    *FilePath\r
  )\r
{\r
  return UpdatePage(FilePath, SECUREBOOT_ENROLL_SIGNATURE_TO_DBT);\r
}\r
\r