SecurityPkg: Fix spelling errors

[mirror_edk2.git] / SecurityPkg / Library / DxeTpmMeasurementLib / DxeTpmMeasurementLib.c

/** @file\r
  This library is used by other modules to measure data to TPM.\r
\r
Copyright (c) 2012 - 2018, Intel Corporation. All rights reserved. <BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <PiDxe.h>\r
\r
#include <Protocol/TcgService.h>\r
#include <Protocol/Tcg2Protocol.h>\r
\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/TpmMeasurementLib.h>\r
\r
#include <Guid/Acpi.h>\r
#include <IndustryStandard/Acpi.h>\r
\r
\r
\r
/**\r
  Tpm12 measure and log data, and extend the measurement result into a specific PCR.\r
\r
  @param[in]  PcrIndex         PCR Index.\r
  @param[in]  EventType        Event type.\r
  @param[in]  EventLog         Measurement event log.\r
  @param[in]  LogLen           Event log length in bytes.\r
  @param[in]  HashData         The start of the data buffer to be hashed, extended.\r
  @param[in]  HashDataLen      The length, in bytes, of the buffer referenced by HashData\r
\r
  @retval EFI_SUCCESS           Operation completed successfully.\r
  @retval EFI_UNSUPPORTED       TPM device not available.\r
  @retval EFI_OUT_OF_RESOURCES  Out of memory.\r
  @retval EFI_DEVICE_ERROR      The operation was unsuccessful.\r
**/\r
EFI_STATUS\r
Tpm12MeasureAndLogData (\r
  IN UINT32             PcrIndex,\r
  IN UINT32             EventType,\r
  IN VOID               *EventLog,\r
  IN UINT32             LogLen,\r
  IN VOID               *HashData,\r
  IN UINT64             HashDataLen\r
  )\r
{\r
  EFI_STATUS                Status;\r
  EFI_TCG_PROTOCOL          *TcgProtocol;\r
  TCG_PCR_EVENT             *TcgEvent;\r
  EFI_PHYSICAL_ADDRESS      EventLogLastEntry;\r
  UINT32                    EventNumber;\r
\r
  TcgEvent = NULL;\r
\r
  //\r
  // Tpm activation state is checked in HashLogExtendEvent\r
  //\r
  Status = gBS->LocateProtocol (&gEfiTcgProtocolGuid, NULL, (VOID **) &TcgProtocol);\r
  if (EFI_ERROR(Status)){\r
    return Status;\r
  }\r
\r
  TcgEvent = (TCG_PCR_EVENT *)AllocateZeroPool (sizeof (TCG_PCR_EVENT_HDR) + LogLen);\r
  if(TcgEvent == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  TcgEvent->PCRIndex  = PcrIndex;\r
  TcgEvent->EventType = EventType;\r
  TcgEvent->EventSize = LogLen;\r
  CopyMem (&TcgEvent->Event[0], EventLog, LogLen);\r
  EventNumber = 1;\r
  Status = TcgProtocol->HashLogExtendEvent (\r
                          TcgProtocol,\r
                          (EFI_PHYSICAL_ADDRESS)(UINTN)HashData,\r
                          HashDataLen,\r
                          TPM_ALG_SHA,\r
                          TcgEvent,\r
                          &EventNumber,\r
                          &EventLogLastEntry\r
                          );\r
\r
  FreePool (TcgEvent);\r
\r
  return Status;\r
}\r
\r
/**\r
  Tpm20 measure and log data, and extend the measurement result into a specific PCR.\r
\r
  @param[in]  PcrIndex         PCR Index.\r
  @param[in]  EventType        Event type.\r
  @param[in]  EventLog         Measurement event log.\r
  @param[in]  LogLen           Event log length in bytes.\r
  @param[in]  HashData         The start of the data buffer to be hashed, extended.\r
  @param[in]  HashDataLen      The length, in bytes, of the buffer referenced by HashData\r
\r
  @retval EFI_SUCCESS           Operation completed successfully.\r
  @retval EFI_UNSUPPORTED       TPM device not available.\r
  @retval EFI_OUT_OF_RESOURCES  Out of memory.\r
  @retval EFI_DEVICE_ERROR      The operation was unsuccessful.\r
**/\r
EFI_STATUS\r
Tpm20MeasureAndLogData (\r
  IN UINT32             PcrIndex,\r
  IN UINT32             EventType,\r
  IN VOID               *EventLog,\r
  IN UINT32             LogLen,\r
  IN VOID               *HashData,\r
  IN UINT64             HashDataLen\r
  )\r
{\r
  EFI_STATUS                Status;\r
  EFI_TCG2_PROTOCOL         *Tcg2Protocol;\r
  EFI_TCG2_EVENT            *Tcg2Event;\r
\r
  //\r
  // TPMPresentFlag is checked in HashLogExtendEvent\r
  //\r
  Status = gBS->LocateProtocol (&gEfiTcg2ProtocolGuid, NULL, (VOID **) &Tcg2Protocol);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Tcg2Event = (EFI_TCG2_EVENT *) AllocateZeroPool (LogLen + sizeof (EFI_TCG2_EVENT));\r
  if(Tcg2Event == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  Tcg2Event->Size = (UINT32)LogLen + sizeof (EFI_TCG2_EVENT) - sizeof(Tcg2Event->Event);\r
  Tcg2Event->Header.HeaderSize    = sizeof(EFI_TCG2_EVENT_HEADER);\r
  Tcg2Event->Header.HeaderVersion = EFI_TCG2_EVENT_HEADER_VERSION;\r
  Tcg2Event->Header.PCRIndex      = PcrIndex;\r
  Tcg2Event->Header.EventType     = EventType;\r
  CopyMem (&Tcg2Event->Event[0], EventLog, LogLen);\r
\r
  Status = Tcg2Protocol->HashLogExtendEvent (\r
                           Tcg2Protocol,\r
                           0,\r
                           (EFI_PHYSICAL_ADDRESS)(UINTN)HashData,\r
                           HashDataLen,\r
                           Tcg2Event\r
                           );\r
  FreePool (Tcg2Event);\r
\r
  return Status;\r
}\r
\r
/**\r
  Tpm measure and log data, and extend the measurement result into a specific PCR.\r
\r
  @param[in]  PcrIndex         PCR Index.\r
  @param[in]  EventType        Event type.\r
  @param[in]  EventLog         Measurement event log.\r
  @param[in]  LogLen           Event log length in bytes.\r
  @param[in]  HashData         The start of the data buffer to be hashed, extended.\r
  @param[in]  HashDataLen      The length, in bytes, of the buffer referenced by HashData\r
\r
  @retval EFI_SUCCESS               Operation completed successfully.\r
  @retval EFI_UNSUPPORTED       TPM device not available.\r
  @retval EFI_OUT_OF_RESOURCES  Out of memory.\r
  @retval EFI_DEVICE_ERROR      The operation was unsuccessful.\r
**/\r
EFI_STATUS\r
EFIAPI\r
TpmMeasureAndLogData (\r
  IN UINT32             PcrIndex,\r
  IN UINT32             EventType,\r
  IN VOID               *EventLog,\r
  IN UINT32             LogLen,\r
  IN VOID               *HashData,\r
  IN UINT64             HashDataLen\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  //\r
  // Try to measure using Tpm20 protocol\r
  //\r
  Status = Tpm20MeasureAndLogData(\r
             PcrIndex,\r
             EventType,\r
             EventLog,\r
             LogLen,\r
             HashData,\r
             HashDataLen\r
             );\r
\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // Try to measure using Tpm1.2 protocol\r
    //\r
    Status = Tpm12MeasureAndLogData(\r
               PcrIndex,\r
               EventType,\r
               EventLog,\r
               LogLen,\r
               HashData,\r
               HashDataLen\r
               );\r
  }\r
\r
  return Status;\r
}\r