OvmfPkg: Refactor MeasureHobList

[mirror_edk2.git] / OvmfPkg / IntelTdx / TdxHelperLib / SecTdxHelper.c

/** @file\r
  TdxHelper Functions which are used in SEC phase\r
\r
  Copyright (c) 2022 - 2023, Intel Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <PiPei.h>\r
#include <Library/BaseLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/HobLib.h>\r
#include <Library/BaseCryptLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <IndustryStandard/Tdx.h>\r
#include <IndustryStandard/IntelTdx.h>\r
#include <IndustryStandard/Tpm20.h>\r
#include <Library/TdxLib.h>\r
#include <Pi/PrePiHob.h>\r
#include <WorkArea.h>\r
#include <ConfidentialComputingGuestAttr.h>\r
#include <Library/TdxHelperLib.h>\r
\r
/**\r
  Build the GuidHob for tdx measurements which were done in SEC phase.\r
  The measurement values are stored in WorkArea.\r
\r
  @retval EFI_SUCCESS  The GuidHob is built successfully\r
  @retval Others       Other errors as indicated\r
**/\r
EFI_STATUS\r
InternalBuildGuidHobForTdxMeasurement (\r
  VOID\r
  );\r
\r
/**\r
  In Tdx guest, some information need to be passed from host VMM to guest\r
  firmware. For example, the memory resource, etc. These information are\r
  prepared by host VMM and put in TdHob which is described in TdxMetadata.\r
  TDVF processes the TdHob to accept memories.\r
\r
  @retval   EFI_SUCCESS   Successfully process the TdHob\r
  @retval   Others        Other error as indicated\r
**/\r
EFI_STATUS\r
EFIAPI\r
TdxHelperProcessTdHob (\r
  VOID\r
  )\r
{\r
  return EFI_UNSUPPORTED;\r
}\r
\r
/**\r
 * Calculate the sha384 of input Data and extend it to RTMR register.\r
 *\r
 * @param RtmrIndex       Index of the RTMR register\r
 * @param DataToHash      Data to be hashed\r
 * @param DataToHashLen   Length of the data\r
 * @param Digest          Hash value of the input data\r
 * @param DigestLen       Length of the hash value\r
 *\r
 * @retval EFI_SUCCESS    Successfully hash and extend to RTMR\r
 * @retval Others         Other errors as indicated\r
 */\r
STATIC\r
EFI_STATUS\r
HashAndExtendToRtmr (\r
  IN UINT32  RtmrIndex,\r
  IN VOID    *DataToHash,\r
  IN UINTN   DataToHashLen,\r
  OUT UINT8  *Digest,\r
  IN  UINTN  DigestLen\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  if ((DataToHash == NULL) || (DataToHashLen == 0)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if ((Digest == NULL) || (DigestLen != SHA384_DIGEST_SIZE)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Calculate the sha384 of the data\r
  //\r
  if (!Sha384HashAll (DataToHash, DataToHashLen, Digest)) {\r
    return EFI_ABORTED;\r
  }\r
\r
  //\r
  // Extend to RTMR\r
  //\r
  Status = TdExtendRtmr (\r
             (UINT32 *)Digest,\r
             SHA384_DIGEST_SIZE,\r
             (UINT8)RtmrIndex\r
             );\r
\r
  ASSERT (!EFI_ERROR (Status));\r
  return Status;\r
}\r
\r
/**\r
  In Tdx guest, TdHob is passed from host VMM to guest firmware and it contains\r
  the information of the memory resource. From the security perspective before\r
  it is consumed, it should be measured and extended.\r
 *\r
 * @retval EFI_SUCCESS Successfully measure the TdHob\r
 * @retval Others      Other error as indicated\r
 */\r
EFI_STATUS\r
EFIAPI\r
TdxHelperMeasureTdHob (\r
  VOID\r
  )\r
{\r
  EFI_PEI_HOB_POINTERS  Hob;\r
  EFI_STATUS            Status;\r
  UINT8                 Digest[SHA384_DIGEST_SIZE];\r
  OVMF_WORK_AREA        *WorkArea;\r
  VOID                  *TdHob;\r
\r
  TdHob   = (VOID *)(UINTN)FixedPcdGet32 (PcdOvmfSecGhcbBase);\r
  Hob.Raw = (UINT8 *)TdHob;\r
\r
  //\r
  // Walk thru the TdHob list until end of list.\r
  //\r
  while (!END_OF_HOB_LIST (Hob)) {\r
    Hob.Raw = GET_NEXT_HOB (Hob);\r
  }\r
\r
  Status = HashAndExtendToRtmr (\r
             0,\r
             (UINT8 *)TdHob,\r
             (UINTN)((UINT8 *)Hob.Raw - (UINT8 *)TdHob),\r
             Digest,\r
             SHA384_DIGEST_SIZE\r
             );\r
\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // This function is called in SEC phase and at that moment the Hob service\r
  // is not available. So the TdHob measurement value is stored in workarea.\r
  //\r
  WorkArea = (OVMF_WORK_AREA *)FixedPcdGet32 (PcdOvmfWorkAreaBase);\r
  if (WorkArea == NULL) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  WorkArea->TdxWorkArea.SecTdxWorkArea.TdxMeasurementsData.MeasurementsBitmap |= TDX_MEASUREMENT_TDHOB_BITMASK;\r
  CopyMem (WorkArea->TdxWorkArea.SecTdxWorkArea.TdxMeasurementsData.TdHobHashValue, Digest, SHA384_DIGEST_SIZE);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
 * In Tdx guest, Configuration FV (CFV) is treated as external input because it\r
 * may contain the data provided by VMM. From the sucurity perspective Cfv image\r
 * should be measured before it is consumed.\r
 *\r
 * @retval EFI_SUCCESS Successfully measure the CFV image\r
 * @retval Others      Other error as indicated\r
 */\r
EFI_STATUS\r
EFIAPI\r
TdxHelperMeasureCfvImage (\r
  VOID\r
  )\r
{\r
  return EFI_UNSUPPORTED;\r
}\r
\r
/**\r
  Build the GuidHob for tdx measurements which were done in SEC phase.\r
  The measurement values are stored in WorkArea.\r
\r
  @retval EFI_SUCCESS  The GuidHob is built successfully\r
  @retval Others       Other errors as indicated\r
**/\r
EFI_STATUS\r
EFIAPI\r
TdxHelperBuildGuidHobForTdxMeasurement (\r
  VOID\r
  )\r
{\r
 #ifdef TDX_PEI_LESS_BOOT\r
  return InternalBuildGuidHobForTdxMeasurement ();\r
 #else\r
  return EFI_UNSUPPORTED;\r
 #endif\r
}\r