SecurityPkg: Fix TPM 1.2 NV Storage Command Size byte order

[mirror_edk2.git] / SecurityPkg / Library / Tpm12CommandLib / Tpm12NvStorage.c

/** @file\r
  Implement TPM1.2 NV storage related command.\r
\r
Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved. <BR>\r
(C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include <PiPei.h>\r
#include <Library/Tpm12CommandLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/Tpm12DeviceLib.h>\r
\r
//\r
// Max TPM NV value length\r
//\r
#define TPMNVVALUELENGTH  1024\r
\r
#pragma pack(1)\r
\r
typedef struct {\r
  TPM_RQU_COMMAND_HDR   Hdr;\r
  TPM12_NV_DATA_PUBLIC  PubInfo;\r
  TPM_ENCAUTH           EncAuth;\r
} TPM_CMD_NV_DEFINE_SPACE;\r
\r
typedef struct {\r
  TPM_RQU_COMMAND_HDR   Hdr;\r
  TPM_NV_INDEX          NvIndex;\r
  UINT32                Offset;\r
  UINT32                DataSize;\r
} TPM_CMD_NV_READ_VALUE;\r
\r
typedef struct {\r
  TPM_RSP_COMMAND_HDR   Hdr;\r
  UINT32                DataSize;\r
  UINT8                 Data[TPMNVVALUELENGTH];\r
} TPM_RSP_NV_READ_VALUE;\r
\r
typedef struct {\r
  TPM_RQU_COMMAND_HDR   Hdr;\r
  TPM_NV_INDEX          NvIndex;\r
  UINT32                Offset;\r
  UINT32                DataSize;\r
  UINT8                 Data[TPMNVVALUELENGTH];\r
} TPM_CMD_NV_WRITE_VALUE;\r
\r
#pragma pack()\r
\r
/**\r
  Send NV DefineSpace command to TPM1.2.\r
  \r
  @param PubInfo           The public parameters of the NV area.\r
  @param EncAuth           The encrypted AuthData, only valid if the attributes require subsequent authorization.\r
\r
  @retval EFI_SUCCESS      Operation completed successfully.\r
  @retval EFI_DEVICE_ERROR Unexpected device behavior.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tpm12NvDefineSpace (\r
  IN TPM12_NV_DATA_PUBLIC  *PubInfo,\r
  IN TPM_ENCAUTH           *EncAuth\r
  )\r
{\r
  EFI_STATUS               Status;\r
  TPM_CMD_NV_DEFINE_SPACE  Command;\r
  TPM_RSP_COMMAND_HDR      Response;\r
  UINT32                   Length;\r
\r
  //\r
  // send Tpm command TPM_ORD_NV_DefineSpace\r
  //\r
  Command.Hdr.tag         = SwapBytes16 (TPM_TAG_RQU_COMMAND);\r
  Command.Hdr.paramSize   = SwapBytes32 (sizeof (Command));\r
  Command.Hdr.ordinal     = SwapBytes32 (TPM_ORD_NV_DefineSpace);\r
  Command.PubInfo.tag     = SwapBytes16 (PubInfo->tag);\r
  Command.PubInfo.nvIndex = SwapBytes32 (PubInfo->nvIndex);\r
  Command.PubInfo.pcrInfoRead.pcrSelection.sizeOfSelect  = SwapBytes16 (PubInfo->pcrInfoRead.pcrSelection.sizeOfSelect);\r
  Command.PubInfo.pcrInfoRead.pcrSelection.pcrSelect[0]  = PubInfo->pcrInfoRead.pcrSelection.pcrSelect[0];\r
  Command.PubInfo.pcrInfoRead.pcrSelection.pcrSelect[1]  = PubInfo->pcrInfoRead.pcrSelection.pcrSelect[1];\r
  Command.PubInfo.pcrInfoRead.pcrSelection.pcrSelect[2]  = PubInfo->pcrInfoRead.pcrSelection.pcrSelect[2];\r
  Command.PubInfo.pcrInfoRead.localityAtRelease          = PubInfo->pcrInfoRead.localityAtRelease;\r
  CopyMem (&Command.PubInfo.pcrInfoRead.digestAtRelease, &PubInfo->pcrInfoRead.digestAtRelease, sizeof(PubInfo->pcrInfoRead.digestAtRelease));\r
  Command.PubInfo.pcrInfoWrite.pcrSelection.sizeOfSelect = SwapBytes16 (PubInfo->pcrInfoWrite.pcrSelection.sizeOfSelect);\r
  Command.PubInfo.pcrInfoWrite.pcrSelection.pcrSelect[0] = PubInfo->pcrInfoWrite.pcrSelection.pcrSelect[0];\r
  Command.PubInfo.pcrInfoWrite.pcrSelection.pcrSelect[1] = PubInfo->pcrInfoWrite.pcrSelection.pcrSelect[1];\r
  Command.PubInfo.pcrInfoWrite.pcrSelection.pcrSelect[2] = PubInfo->pcrInfoWrite.pcrSelection.pcrSelect[2];\r
  Command.PubInfo.pcrInfoWrite.localityAtRelease         = PubInfo->pcrInfoWrite.localityAtRelease;\r
  CopyMem (&Command.PubInfo.pcrInfoWrite.digestAtRelease, &PubInfo->pcrInfoWrite.digestAtRelease, sizeof(PubInfo->pcrInfoWrite.digestAtRelease));\r
  Command.PubInfo.permission.tag        = SwapBytes16 (PubInfo->permission.tag);\r
  Command.PubInfo.permission.attributes = SwapBytes32 (PubInfo->permission.attributes);\r
  Command.PubInfo.bReadSTClear          = PubInfo->bReadSTClear;\r
  Command.PubInfo.bWriteSTClear         = PubInfo->bWriteSTClear;\r
  Command.PubInfo.bWriteDefine          = PubInfo->bWriteDefine;\r
  Command.PubInfo.dataSize              = SwapBytes32 (PubInfo->dataSize);\r
  CopyMem (&Command.EncAuth, EncAuth, sizeof(*EncAuth));\r
  Length = sizeof (Response);\r
  Status = Tpm12SubmitCommand (sizeof (Command), (UINT8 *)&Command, &Length, (UINT8 *)&Response);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
  DEBUG ((DEBUG_INFO, "Tpm12NvDefineSpace - ReturnCode = %x\n", SwapBytes32 (Response.returnCode)));\r
  switch (SwapBytes32 (Response.returnCode)) {\r
  case TPM_SUCCESS:\r
    return EFI_SUCCESS;\r
  default:\r
    return EFI_DEVICE_ERROR;\r
  }\r
}\r
\r
/**\r
  Send NV ReadValue command to TPM1.2.\r
\r
  @param NvIndex           The index of the area to set.\r
  @param Offset            The offset into the area.\r
  @param DataSize          The size of the data area.\r
  @param Data              The data to set the area to.\r
\r
  @retval EFI_SUCCESS      Operation completed successfully.\r
  @retval EFI_DEVICE_ERROR Unexpected device behavior.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tpm12NvReadValue (\r
  IN TPM_NV_INDEX  NvIndex,\r
  IN UINT32        Offset,\r
  IN OUT UINT32    *DataSize,\r
  OUT UINT8        *Data\r
  )\r
{\r
  EFI_STATUS             Status;\r
  TPM_CMD_NV_READ_VALUE  Command;\r
  TPM_RSP_NV_READ_VALUE  Response;\r
  UINT32                 Length;\r
\r
  //\r
  // send Tpm command TPM_ORD_NV_ReadValue\r
  //\r
  Command.Hdr.tag       = SwapBytes16 (TPM_TAG_RQU_COMMAND);\r
  Command.Hdr.paramSize = SwapBytes32 (sizeof (Command));\r
  Command.Hdr.ordinal   = SwapBytes32 (TPM_ORD_NV_ReadValue);\r
  Command.NvIndex       = SwapBytes32 (NvIndex);\r
  Command.Offset        = SwapBytes32 (Offset);\r
  Command.DataSize      = SwapBytes32 (*DataSize);\r
  Length = sizeof (Response);\r
  Status = Tpm12SubmitCommand (sizeof (Command), (UINT8 *)&Command, &Length, (UINT8 *)&Response);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
  DEBUG ((DEBUG_INFO, "Tpm12NvReadValue - ReturnCode = %x\n", SwapBytes32 (Response.Hdr.returnCode)));\r
  switch (SwapBytes32 (Response.Hdr.returnCode)) {\r
  case TPM_SUCCESS:\r
    break;\r
  default:\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  //\r
  // Return the response\r
  //\r
  if (SwapBytes32 (Response.DataSize) > *DataSize) {\r
    return EFI_BUFFER_TOO_SMALL;\r
  }\r
  *DataSize = SwapBytes32 (Response.DataSize);\r
  ZeroMem (Data, *DataSize);\r
  CopyMem (Data, &Response.Data, *DataSize);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Send NV WriteValue command to TPM1.2.\r
  \r
  @param NvIndex           The index of the area to set.\r
  @param Offset            The offset into the NV Area.\r
  @param DataSize          The size of the data parameter.\r
  @param Data              The data to set the area to.\r
\r
  @retval EFI_SUCCESS      Operation completed successfully.\r
  @retval EFI_DEVICE_ERROR Unexpected device behavior.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tpm12NvWriteValue (\r
  IN TPM_NV_INDEX  NvIndex,\r
  IN UINT32        Offset,\r
  IN UINT32        DataSize,\r
  IN UINT8         *Data\r
  )\r
{\r
  EFI_STATUS              Status;\r
  TPM_CMD_NV_WRITE_VALUE  Command;\r
  UINT32                  CommandLength;\r
  TPM_RSP_COMMAND_HDR     Response;\r
  UINT32                  ResponseLength;\r
\r
  if (DataSize > sizeof (Command.Data)) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  //\r
  // send Tpm command TPM_ORD_NV_WriteValue\r
  //\r
  Command.Hdr.tag       = SwapBytes16 (TPM_TAG_RQU_COMMAND);\r
  CommandLength = sizeof (Command) - sizeof(Command.Data) + DataSize;\r
  Command.Hdr.paramSize = SwapBytes32 (CommandLength);\r
  Command.Hdr.ordinal   = SwapBytes32 (TPM_ORD_NV_WriteValue);\r
  Command.NvIndex       = SwapBytes32 (NvIndex);\r
  Command.Offset        = SwapBytes32 (Offset);\r
  Command.DataSize      = SwapBytes32 (DataSize);\r
  CopyMem (Command.Data, Data, DataSize);\r
  ResponseLength = sizeof (Response);\r
  Status = Tpm12SubmitCommand (CommandLength, (UINT8 *)&Command, &ResponseLength, (UINT8 *)&Response);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
  DEBUG ((DEBUG_INFO, "Tpm12NvWritedValue - ReturnCode = %x\n", SwapBytes32 (Response.returnCode)));\r
  switch (SwapBytes32 (Response.returnCode)) {\r
  case TPM_SUCCESS:\r
    return EFI_SUCCESS;\r
  default:\r
    return EFI_DEVICE_ERROR;\r
  }\r
}\r