[mirror_edk2.git] / SecurityPkg / Library / Tpm2CommandLib / Tpm2Hierarchy.c

/** @file\r
  Implement TPM2 Hierarchy related command.\r
\r
Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved. <BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <IndustryStandard/UefiTcgPlatform.h>\r
#include <Library/Tpm2CommandLib.h>\r
#include <Library/Tpm2DeviceLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/DebugLib.h>\r
\r
#pragma pack(1)\r
\r
typedef struct {\r
  TPM2_COMMAND_HEADER       Header;\r
  TPMI_RH_HIERARCHY_AUTH    AuthHandle;\r
  UINT32                    AuthSessionSize;\r
  TPMS_AUTH_COMMAND         AuthSession;\r
  TPM2B_DIGEST              AuthPolicy;\r
  TPMI_ALG_HASH             HashAlg;\r
} TPM2_SET_PRIMARY_POLICY_COMMAND;\r
\r
typedef struct {\r
  TPM2_RESPONSE_HEADER    Header;\r
  UINT32                  AuthSessionSize;\r
  TPMS_AUTH_RESPONSE      AuthSession;\r
} TPM2_SET_PRIMARY_POLICY_RESPONSE;\r
\r
typedef struct {\r
  TPM2_COMMAND_HEADER    Header;\r
  TPMI_RH_CLEAR          AuthHandle;\r
  UINT32                 AuthorizationSize;\r
  TPMS_AUTH_COMMAND      AuthSession;\r
} TPM2_CLEAR_COMMAND;\r
\r
typedef struct {\r
  TPM2_RESPONSE_HEADER    Header;\r
  UINT32                  ParameterSize;\r
  TPMS_AUTH_RESPONSE      AuthSession;\r
} TPM2_CLEAR_RESPONSE;\r
\r
typedef struct {\r
  TPM2_COMMAND_HEADER    Header;\r
  TPMI_RH_CLEAR          AuthHandle;\r
  UINT32                 AuthorizationSize;\r
  TPMS_AUTH_COMMAND      AuthSession;\r
  TPMI_YES_NO            Disable;\r
} TPM2_CLEAR_CONTROL_COMMAND;\r
\r
typedef struct {\r
  TPM2_RESPONSE_HEADER    Header;\r
  UINT32                  ParameterSize;\r
  TPMS_AUTH_RESPONSE      AuthSession;\r
} TPM2_CLEAR_CONTROL_RESPONSE;\r
\r
typedef struct {\r
  TPM2_COMMAND_HEADER       Header;\r
  TPMI_RH_HIERARCHY_AUTH    AuthHandle;\r
  UINT32                    AuthorizationSize;\r
  TPMS_AUTH_COMMAND         AuthSession;\r
  TPM2B_AUTH                NewAuth;\r
} TPM2_HIERARCHY_CHANGE_AUTH_COMMAND;\r
\r
typedef struct {\r
  TPM2_RESPONSE_HEADER    Header;\r
  UINT32                  ParameterSize;\r
  TPMS_AUTH_RESPONSE      AuthSession;\r
} TPM2_HIERARCHY_CHANGE_AUTH_RESPONSE;\r
\r
typedef struct {\r
  TPM2_COMMAND_HEADER    Header;\r
  TPMI_RH_PLATFORM       AuthHandle;\r
  UINT32                 AuthorizationSize;\r
  TPMS_AUTH_COMMAND      AuthSession;\r
} TPM2_CHANGE_EPS_COMMAND;\r
\r
typedef struct {\r
  TPM2_RESPONSE_HEADER    Header;\r
  UINT32                  ParameterSize;\r
  TPMS_AUTH_RESPONSE      AuthSession;\r
} TPM2_CHANGE_EPS_RESPONSE;\r
\r
typedef struct {\r
  TPM2_COMMAND_HEADER    Header;\r
  TPMI_RH_PLATFORM       AuthHandle;\r
  UINT32                 AuthorizationSize;\r
  TPMS_AUTH_COMMAND      AuthSession;\r
} TPM2_CHANGE_PPS_COMMAND;\r
\r
typedef struct {\r
  TPM2_RESPONSE_HEADER    Header;\r
  UINT32                  ParameterSize;\r
  TPMS_AUTH_RESPONSE      AuthSession;\r
} TPM2_CHANGE_PPS_RESPONSE;\r
\r
typedef struct {\r
  TPM2_COMMAND_HEADER    Header;\r
  TPMI_RH_HIERARCHY      AuthHandle;\r
  UINT32                 AuthorizationSize;\r
  TPMS_AUTH_COMMAND      AuthSession;\r
  TPMI_RH_HIERARCHY      Hierarchy;\r
  TPMI_YES_NO            State;\r
} TPM2_HIERARCHY_CONTROL_COMMAND;\r
\r
typedef struct {\r
  TPM2_RESPONSE_HEADER    Header;\r
  UINT32                  ParameterSize;\r
  TPMS_AUTH_RESPONSE      AuthSession;\r
} TPM2_HIERARCHY_CONTROL_RESPONSE;\r
\r
#pragma pack()\r
\r
/**\r
  This command allows setting of the authorization policy for the platform hierarchy (platformPolicy), the\r
  storage hierarchy (ownerPolicy), and and the endorsement hierarchy (endorsementPolicy).\r
\r
  @param[in]  AuthHandle            TPM_RH_ENDORSEMENT, TPM_RH_OWNER or TPM_RH_PLATFORM+{PP} parameters to be validated\r
  @param[in]  AuthSession           Auth Session context\r
  @param[in]  AuthPolicy            An authorization policy hash\r
  @param[in]  HashAlg               The hash algorithm to use for the policy\r
\r
  @retval EFI_SUCCESS      Operation completed successfully.\r
  @retval EFI_DEVICE_ERROR Unexpected device behavior.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tpm2SetPrimaryPolicy (\r
  IN  TPMI_RH_HIERARCHY_AUTH  AuthHandle,\r
  IN  TPMS_AUTH_COMMAND       *AuthSession,\r
  IN  TPM2B_DIGEST            *AuthPolicy,\r
  IN  TPMI_ALG_HASH           HashAlg\r
  )\r
{\r
  EFI_STATUS                        Status;\r
  TPM2_SET_PRIMARY_POLICY_COMMAND   SendBuffer;\r
  TPM2_SET_PRIMARY_POLICY_RESPONSE  RecvBuffer;\r
  UINT32                            SendBufferSize;\r
  UINT32                            RecvBufferSize;\r
  UINT8                             *Buffer;\r
  UINT32                            SessionInfoSize;\r
\r
  //\r
  // Construct command\r
  //\r
  SendBuffer.Header.tag         = SwapBytes16 (TPM_ST_SESSIONS);\r
  SendBuffer.Header.commandCode = SwapBytes32 (TPM_CC_SetPrimaryPolicy);\r
\r
  SendBuffer.AuthHandle = SwapBytes32 (AuthHandle);\r
\r
  //\r
  // Add in Auth session\r
  //\r
  Buffer = (UINT8 *)&SendBuffer.AuthSession;\r
\r
  // sessionInfoSize\r
  SessionInfoSize            = CopyAuthSessionCommand (AuthSession, Buffer);\r
  Buffer                    += SessionInfoSize;\r
  SendBuffer.AuthSessionSize = SwapBytes32 (SessionInfoSize);\r
\r
  //\r
  // Real data\r
  //\r
  WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (AuthPolicy->size));\r
  Buffer += sizeof (UINT16);\r
  CopyMem (Buffer, AuthPolicy->buffer, AuthPolicy->size);\r
  Buffer += AuthPolicy->size;\r
  WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (HashAlg));\r
  Buffer += sizeof (UINT16);\r
\r
  SendBufferSize              = (UINT32)((UINTN)Buffer - (UINTN)&SendBuffer);\r
  SendBuffer.Header.paramSize = SwapBytes32 (SendBufferSize);\r
\r
  //\r
  // send Tpm command\r
  //\r
  RecvBufferSize = sizeof (RecvBuffer);\r
  Status         = Tpm2SubmitCommand (SendBufferSize, (UINT8 *)&SendBuffer, &RecvBufferSize, (UINT8 *)&RecvBuffer);\r
  if (EFI_ERROR (Status)) {\r
    goto Done;\r
  }\r
\r
  if (RecvBufferSize < sizeof (TPM2_RESPONSE_HEADER)) {\r
    DEBUG ((DEBUG_ERROR, "Tpm2SetPrimaryPolicy - RecvBufferSize Error - %x\n", RecvBufferSize));\r
    Status = EFI_DEVICE_ERROR;\r
    goto Done;\r
  }\r
\r
  if (SwapBytes32 (RecvBuffer.Header.responseCode) != TPM_RC_SUCCESS) {\r
    DEBUG ((DEBUG_ERROR, "Tpm2SetPrimaryPolicy - responseCode - %x\n", SwapBytes32 (RecvBuffer.Header.responseCode)));\r
    Status = EFI_DEVICE_ERROR;\r
    goto Done;\r
  }\r
\r
Done:\r
  //\r
  // Clear AuthSession Content\r
  //\r
  ZeroMem (&SendBuffer, sizeof (SendBuffer));\r
  ZeroMem (&RecvBuffer, sizeof (RecvBuffer));\r
  return Status;\r
}\r
\r
/**\r
  This command removes all TPM context associated with a specific Owner.\r
\r
  @param[in] AuthHandle        TPM_RH_LOCKOUT or TPM_RH_PLATFORM+{PP}\r
  @param[in] AuthSession       Auth Session context\r
\r
  @retval EFI_SUCCESS      Operation completed successfully.\r
  @retval EFI_DEVICE_ERROR Unexpected device behavior.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tpm2Clear (\r
  IN TPMI_RH_CLEAR      AuthHandle,\r
  IN TPMS_AUTH_COMMAND  *AuthSession OPTIONAL\r
  )\r
{\r
  EFI_STATUS           Status;\r
  TPM2_CLEAR_COMMAND   Cmd;\r
  TPM2_CLEAR_RESPONSE  Res;\r
  UINT32               ResultBufSize;\r
  UINT32               CmdSize;\r
  UINT32               RespSize;\r
  UINT8                *Buffer;\r
  UINT32               SessionInfoSize;\r
\r
  Cmd.Header.tag         = SwapBytes16 (TPM_ST_SESSIONS);\r
  Cmd.Header.commandCode = SwapBytes32 (TPM_CC_Clear);\r
  Cmd.AuthHandle         = SwapBytes32 (AuthHandle);\r
\r
  //\r
  // Add in Auth session\r
  //\r
  Buffer = (UINT8 *)&Cmd.AuthSession;\r
\r
  // sessionInfoSize\r
  SessionInfoSize       = CopyAuthSessionCommand (AuthSession, Buffer);\r
  Buffer               += SessionInfoSize;\r
  Cmd.AuthorizationSize = SwapBytes32 (SessionInfoSize);\r
\r
  CmdSize              = (UINT32)(Buffer - (UINT8 *)&Cmd);\r
  Cmd.Header.paramSize = SwapBytes32 (CmdSize);\r
\r
  ResultBufSize = sizeof (Res);\r
  Status        = Tpm2SubmitCommand (CmdSize, (UINT8 *)&Cmd, &ResultBufSize, (UINT8 *)&Res);\r
  if (EFI_ERROR (Status)) {\r
    goto Done;\r
  }\r
\r
  if (ResultBufSize > sizeof (Res)) {\r
    DEBUG ((DEBUG_ERROR, "Clear: Failed ExecuteCommand: Buffer Too Small\r\n"));\r
    Status = EFI_BUFFER_TOO_SMALL;\r
    goto Done;\r
  }\r
\r
  //\r
  // Validate response headers\r
  //\r
  RespSize = SwapBytes32 (Res.Header.paramSize);\r
  if (RespSize > sizeof (Res)) {\r
    DEBUG ((DEBUG_ERROR, "Clear: Response size too large! %d\r\n", RespSize));\r
    Status = EFI_BUFFER_TOO_SMALL;\r
    goto Done;\r
  }\r
\r
  //\r
  // Fail if command failed\r
  //\r
  if (SwapBytes32 (Res.Header.responseCode) != TPM_RC_SUCCESS) {\r
    DEBUG ((DEBUG_ERROR, "Clear: Response Code error! 0x%08x\r\n", SwapBytes32 (Res.Header.responseCode)));\r
    Status = EFI_DEVICE_ERROR;\r
    goto Done;\r
  }\r
\r
  //\r
  // Unmarshal the response\r
  //\r
\r
  // None\r
Done:\r
  //\r
  // Clear AuthSession Content\r
  //\r
  ZeroMem (&Cmd, sizeof (Cmd));\r
  ZeroMem (&Res, sizeof (Res));\r
  return Status;\r
}\r
\r
/**\r
  Disables and enables the execution of TPM2_Clear().\r
\r
  @param[in] AuthHandle        TPM_RH_LOCKOUT or TPM_RH_PLATFORM+{PP}\r
  @param[in] AuthSession       Auth Session context\r
  @param[in] Disable           YES if the disableOwnerClear flag is to be SET,\r
                               NO if the flag is to be CLEAR.\r
\r
  @retval EFI_SUCCESS      Operation completed successfully.\r
  @retval EFI_DEVICE_ERROR Unexpected device behavior.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tpm2ClearControl (\r
  IN TPMI_RH_CLEAR      AuthHandle,\r
  IN TPMS_AUTH_COMMAND  *AuthSession  OPTIONAL,\r
  IN TPMI_YES_NO        Disable\r
  )\r
{\r
  EFI_STATUS                   Status;\r
  TPM2_CLEAR_CONTROL_COMMAND   Cmd;\r
  TPM2_CLEAR_CONTROL_RESPONSE  Res;\r
  UINT32                       ResultBufSize;\r
  UINT32                       CmdSize;\r
  UINT32                       RespSize;\r
  UINT8                        *Buffer;\r
  UINT32                       SessionInfoSize;\r
\r
  Cmd.Header.tag         = SwapBytes16 (TPM_ST_SESSIONS);\r
  Cmd.Header.commandCode = SwapBytes32 (TPM_CC_ClearControl);\r
  Cmd.AuthHandle         = SwapBytes32 (AuthHandle);\r
\r
  //\r
  // Add in Auth session\r
  //\r
  Buffer = (UINT8 *)&Cmd.AuthSession;\r
\r
  // sessionInfoSize\r
  SessionInfoSize       = CopyAuthSessionCommand (AuthSession, Buffer);\r
  Buffer               += SessionInfoSize;\r
  Cmd.AuthorizationSize = SwapBytes32 (SessionInfoSize);\r
\r
  // disable\r
  *(UINT8 *)Buffer = Disable;\r
  Buffer++;\r
\r
  CmdSize              = (UINT32)(Buffer - (UINT8 *)&Cmd);\r
  Cmd.Header.paramSize = SwapBytes32 (CmdSize);\r
\r
  ResultBufSize = sizeof (Res);\r
  Status        = Tpm2SubmitCommand (CmdSize, (UINT8 *)&Cmd, &ResultBufSize, (UINT8 *)&Res);\r
  if (EFI_ERROR (Status)) {\r
    goto Done;\r
  }\r
\r
  if (ResultBufSize > sizeof (Res)) {\r
    DEBUG ((DEBUG_ERROR, "ClearControl: Failed ExecuteCommand: Buffer Too Small\r\n"));\r
    Status = EFI_BUFFER_TOO_SMALL;\r
    goto Done;\r
  }\r
\r
  //\r
  // Validate response headers\r
  //\r
  RespSize = SwapBytes32 (Res.Header.paramSize);\r
  if (RespSize > sizeof (Res)) {\r
    DEBUG ((DEBUG_ERROR, "ClearControl: Response size too large! %d\r\n", RespSize));\r
    Status = EFI_BUFFER_TOO_SMALL;\r
    goto Done;\r
  }\r
\r
  //\r
  // Fail if command failed\r
  //\r
  if (SwapBytes32 (Res.Header.responseCode) != TPM_RC_SUCCESS) {\r
    DEBUG ((DEBUG_ERROR, "ClearControl: Response Code error! 0x%08x\r\n", SwapBytes32 (Res.Header.responseCode)));\r
    Status = EFI_DEVICE_ERROR;\r
    goto Done;\r
  }\r
\r
  //\r
  // Unmarshal the response\r
  //\r
\r
  // None\r
Done:\r
  //\r
  // Clear AuthSession Content\r
  //\r
  ZeroMem (&Cmd, sizeof (Cmd));\r
  ZeroMem (&Res, sizeof (Res));\r
  return Status;\r
}\r
\r
/**\r
  This command allows the authorization secret for a hierarchy or lockout to be changed using the current\r
  authorization value as the command authorization.\r
\r
  @param[in] AuthHandle        TPM_RH_LOCKOUT, TPM_RH_ENDORSEMENT, TPM_RH_OWNER or TPM_RH_PLATFORM+{PP}\r
  @param[in] AuthSession       Auth Session context\r
  @param[in] NewAuth           New authorization secret\r
\r
  @retval EFI_SUCCESS      Operation completed successfully.\r
  @retval EFI_DEVICE_ERROR Unexpected device behavior.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tpm2HierarchyChangeAuth (\r
  IN TPMI_RH_HIERARCHY_AUTH  AuthHandle,\r
  IN TPMS_AUTH_COMMAND       *AuthSession,\r
  IN TPM2B_AUTH              *NewAuth\r
  )\r
{\r
  EFI_STATUS                           Status;\r
  TPM2_HIERARCHY_CHANGE_AUTH_COMMAND   Cmd;\r
  TPM2_HIERARCHY_CHANGE_AUTH_RESPONSE  Res;\r
  UINT32                               CmdSize;\r
  UINT32                               RespSize;\r
  UINT8                                *Buffer;\r
  UINT32                               SessionInfoSize;\r
  UINT8                                *ResultBuf;\r
  UINT32                               ResultBufSize;\r
\r
  //\r
  // Construct command\r
  //\r
  Cmd.Header.tag         = SwapBytes16 (TPM_ST_SESSIONS);\r
  Cmd.Header.paramSize   = SwapBytes32 (sizeof (Cmd));\r
  Cmd.Header.commandCode = SwapBytes32 (TPM_CC_HierarchyChangeAuth);\r
  Cmd.AuthHandle         = SwapBytes32 (AuthHandle);\r
\r
  //\r
  // Add in Auth session\r
  //\r
  Buffer = (UINT8 *)&Cmd.AuthSession;\r
\r
  // sessionInfoSize\r
  SessionInfoSize       = CopyAuthSessionCommand (AuthSession, Buffer);\r
  Buffer               += SessionInfoSize;\r
  Cmd.AuthorizationSize = SwapBytes32 (SessionInfoSize);\r
\r
  // New Authorization size\r
  WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (NewAuth->size));\r
  Buffer += sizeof (UINT16);\r
\r
  // New Authorization\r
  CopyMem (Buffer, NewAuth->buffer, NewAuth->size);\r
  Buffer += NewAuth->size;\r
\r
  CmdSize              = (UINT32)(Buffer - (UINT8 *)&Cmd);\r
  Cmd.Header.paramSize = SwapBytes32 (CmdSize);\r
\r
  ResultBuf     = (UINT8 *)&Res;\r
  ResultBufSize = sizeof (Res);\r
\r
  //\r
  // Call the TPM\r
  //\r
  Status = Tpm2SubmitCommand (\r
             CmdSize,\r
             (UINT8 *)&Cmd,\r
             &ResultBufSize,\r
             ResultBuf\r
             );\r
  if (EFI_ERROR (Status)) {\r
    goto Done;\r
  }\r
\r
  if (ResultBufSize > sizeof (Res)) {\r
    DEBUG ((DEBUG_ERROR, "HierarchyChangeAuth: Failed ExecuteCommand: Buffer Too Small\r\n"));\r
    Status = EFI_BUFFER_TOO_SMALL;\r
    goto Done;\r
  }\r
\r
  //\r
  // Validate response headers\r
  //\r
  RespSize = SwapBytes32 (Res.Header.paramSize);\r
  if (RespSize > sizeof (Res)) {\r
    DEBUG ((DEBUG_ERROR, "HierarchyChangeAuth: Response size too large! %d\r\n", RespSize));\r
    Status = EFI_BUFFER_TOO_SMALL;\r
    goto Done;\r
  }\r
\r
  //\r
  // Fail if command failed\r
  //\r
  if (SwapBytes32 (Res.Header.responseCode) != TPM_RC_SUCCESS) {\r
    DEBUG ((DEBUG_ERROR, "HierarchyChangeAuth: Response Code error! 0x%08x\r\n", SwapBytes32 (Res.Header.responseCode)));\r
    Status = EFI_DEVICE_ERROR;\r
    goto Done;\r
  }\r
\r
Done:\r
  //\r
  // Clear AuthSession Content\r
  //\r
  ZeroMem (&Cmd, sizeof (Cmd));\r
  ZeroMem (&Res, sizeof (Res));\r
  return Status;\r
}\r
\r
/**\r
  This replaces the current EPS with a value from the RNG and sets the Endorsement hierarchy controls to\r
  their default initialization values.\r
\r
  @param[in] AuthHandle        TPM_RH_PLATFORM+{PP}\r
  @param[in] AuthSession       Auth Session context\r
\r
  @retval EFI_SUCCESS      Operation completed successfully.\r
  @retval EFI_DEVICE_ERROR Unexpected device behavior.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tpm2ChangeEPS (\r
  IN TPMI_RH_PLATFORM   AuthHandle,\r
  IN TPMS_AUTH_COMMAND  *AuthSession\r
  )\r
{\r
  EFI_STATUS                Status;\r
  TPM2_CHANGE_EPS_COMMAND   Cmd;\r
  TPM2_CHANGE_EPS_RESPONSE  Res;\r
  UINT32                    CmdSize;\r
  UINT32                    RespSize;\r
  UINT8                     *Buffer;\r
  UINT32                    SessionInfoSize;\r
  UINT8                     *ResultBuf;\r
  UINT32                    ResultBufSize;\r
\r
  //\r
  // Construct command\r
  //\r
  Cmd.Header.tag         = SwapBytes16 (TPM_ST_SESSIONS);\r
  Cmd.Header.paramSize   = SwapBytes32 (sizeof (Cmd));\r
  Cmd.Header.commandCode = SwapBytes32 (TPM_CC_ChangeEPS);\r
  Cmd.AuthHandle         = SwapBytes32 (AuthHandle);\r
\r
  //\r
  // Add in Auth session\r
  //\r
  Buffer = (UINT8 *)&Cmd.AuthSession;\r
\r
  // sessionInfoSize\r
  SessionInfoSize       = CopyAuthSessionCommand (AuthSession, Buffer);\r
  Buffer               += SessionInfoSize;\r
  Cmd.AuthorizationSize = SwapBytes32 (SessionInfoSize);\r
\r
  CmdSize              = (UINT32)(Buffer - (UINT8 *)&Cmd);\r
  Cmd.Header.paramSize = SwapBytes32 (CmdSize);\r
\r
  ResultBuf     = (UINT8 *)&Res;\r
  ResultBufSize = sizeof (Res);\r
\r
  //\r
  // Call the TPM\r
  //\r
  Status = Tpm2SubmitCommand (\r
             CmdSize,\r
             (UINT8 *)&Cmd,\r
             &ResultBufSize,\r
             ResultBuf\r
             );\r
  if (EFI_ERROR (Status)) {\r
    goto Done;\r
  }\r
\r
  if (ResultBufSize > sizeof (Res)) {\r
    DEBUG ((DEBUG_ERROR, "ChangeEPS: Failed ExecuteCommand: Buffer Too Small\r\n"));\r
    Status = EFI_BUFFER_TOO_SMALL;\r
    goto Done;\r
  }\r
\r
  //\r
  // Validate response headers\r
  //\r
  RespSize = SwapBytes32 (Res.Header.paramSize);\r
  if (RespSize > sizeof (Res)) {\r
    DEBUG ((DEBUG_ERROR, "ChangeEPS: Response size too large! %d\r\n", RespSize));\r
    Status = EFI_BUFFER_TOO_SMALL;\r
    goto Done;\r
  }\r
\r
  //\r
  // Fail if command failed\r
  //\r
  if (SwapBytes32 (Res.Header.responseCode) != TPM_RC_SUCCESS) {\r
    DEBUG ((DEBUG_ERROR, "ChangeEPS: Response Code error! 0x%08x\r\n", SwapBytes32 (Res.Header.responseCode)));\r
    Status = EFI_DEVICE_ERROR;\r
    goto Done;\r
  }\r
\r
Done:\r
  //\r
  // Clear AuthSession Content\r
  //\r
  ZeroMem (&Cmd, sizeof (Cmd));\r
  ZeroMem (&Res, sizeof (Res));\r
  return Status;\r
}\r
\r
/**\r
  This replaces the current PPS with a value from the RNG and sets platformPolicy to the default\r
  initialization value (the Empty Buffer).\r
\r
  @param[in] AuthHandle        TPM_RH_PLATFORM+{PP}\r
  @param[in] AuthSession       Auth Session context\r
\r
  @retval EFI_SUCCESS      Operation completed successfully.\r
  @retval EFI_DEVICE_ERROR Unexpected device behavior.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tpm2ChangePPS (\r
  IN TPMI_RH_PLATFORM   AuthHandle,\r
  IN TPMS_AUTH_COMMAND  *AuthSession\r
  )\r
{\r
  EFI_STATUS                Status;\r
  TPM2_CHANGE_PPS_COMMAND   Cmd;\r
  TPM2_CHANGE_PPS_RESPONSE  Res;\r
  UINT32                    CmdSize;\r
  UINT32                    RespSize;\r
  UINT8                     *Buffer;\r
  UINT32                    SessionInfoSize;\r
  UINT8                     *ResultBuf;\r
  UINT32                    ResultBufSize;\r
\r
  //\r
  // Construct command\r
  //\r
  Cmd.Header.tag         = SwapBytes16 (TPM_ST_SESSIONS);\r
  Cmd.Header.paramSize   = SwapBytes32 (sizeof (Cmd));\r
  Cmd.Header.commandCode = SwapBytes32 (TPM_CC_ChangePPS);\r
  Cmd.AuthHandle         = SwapBytes32 (AuthHandle);\r
\r
  //\r
  // Add in Auth session\r
  //\r
  Buffer = (UINT8 *)&Cmd.AuthSession;\r
\r
  // sessionInfoSize\r
  SessionInfoSize       = CopyAuthSessionCommand (AuthSession, Buffer);\r
  Buffer               += SessionInfoSize;\r
  Cmd.AuthorizationSize = SwapBytes32 (SessionInfoSize);\r
\r
  CmdSize              = (UINT32)(Buffer - (UINT8 *)&Cmd);\r
  Cmd.Header.paramSize = SwapBytes32 (CmdSize);\r
\r
  ResultBuf     = (UINT8 *)&Res;\r
  ResultBufSize = sizeof (Res);\r
\r
  //\r
  // Call the TPM\r
  //\r
  Status = Tpm2SubmitCommand (\r
             CmdSize,\r
             (UINT8 *)&Cmd,\r
             &ResultBufSize,\r
             ResultBuf\r
             );\r
  if (EFI_ERROR (Status)) {\r
    goto Done;\r
  }\r
\r
  if (ResultBufSize > sizeof (Res)) {\r
    DEBUG ((DEBUG_ERROR, "ChangePPS: Failed ExecuteCommand: Buffer Too Small\r\n"));\r
    Status = EFI_BUFFER_TOO_SMALL;\r
    goto Done;\r
  }\r
\r
  //\r
  // Validate response headers\r
  //\r
  RespSize = SwapBytes32 (Res.Header.paramSize);\r
  if (RespSize > sizeof (Res)) {\r
    DEBUG ((DEBUG_ERROR, "ChangePPS: Response size too large! %d\r\n", RespSize));\r
    Status = EFI_BUFFER_TOO_SMALL;\r
    goto Done;\r
  }\r
\r
  //\r
  // Fail if command failed\r
  //\r
  if (SwapBytes32 (Res.Header.responseCode) != TPM_RC_SUCCESS) {\r
    DEBUG ((DEBUG_ERROR, "ChangePPS: Response Code error! 0x%08x\r\n", SwapBytes32 (Res.Header.responseCode)));\r
    Status = EFI_DEVICE_ERROR;\r
    goto Done;\r
  }\r
\r
Done:\r
  //\r
  // Clear AuthSession Content\r
  //\r
  ZeroMem (&Cmd, sizeof (Cmd));\r
  ZeroMem (&Res, sizeof (Res));\r
  return Status;\r
}\r
\r
/**\r
  This command enables and disables use of a hierarchy.\r
\r
  @param[in] AuthHandle        TPM_RH_ENDORSEMENT, TPM_RH_OWNER or TPM_RH_PLATFORM+{PP}\r
  @param[in] AuthSession       Auth Session context\r
  @param[in] Hierarchy         Hierarchy of the enable being modified\r
  @param[in] State             YES if the enable should be SET,\r
                               NO if the enable should be CLEAR\r
\r
  @retval EFI_SUCCESS      Operation completed successfully.\r
  @retval EFI_DEVICE_ERROR Unexpected device behavior.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tpm2HierarchyControl (\r
  IN TPMI_RH_HIERARCHY  AuthHandle,\r
  IN TPMS_AUTH_COMMAND  *AuthSession,\r
  IN TPMI_RH_HIERARCHY  Hierarchy,\r
  IN TPMI_YES_NO        State\r
  )\r
{\r
  EFI_STATUS                       Status;\r
  TPM2_HIERARCHY_CONTROL_COMMAND   Cmd;\r
  TPM2_HIERARCHY_CONTROL_RESPONSE  Res;\r
  UINT32                           CmdSize;\r
  UINT32                           RespSize;\r
  UINT8                            *Buffer;\r
  UINT32                           SessionInfoSize;\r
  UINT8                            *ResultBuf;\r
  UINT32                           ResultBufSize;\r
\r
  //\r
  // Construct command\r
  //\r
  Cmd.Header.tag         = SwapBytes16 (TPM_ST_SESSIONS);\r
  Cmd.Header.paramSize   = SwapBytes32 (sizeof (Cmd));\r
  Cmd.Header.commandCode = SwapBytes32 (TPM_CC_HierarchyControl);\r
  Cmd.AuthHandle         = SwapBytes32 (AuthHandle);\r
\r
  //\r
  // Add in Auth session\r
  //\r
  Buffer = (UINT8 *)&Cmd.AuthSession;\r
\r
  // sessionInfoSize\r
  SessionInfoSize       = CopyAuthSessionCommand (AuthSession, Buffer);\r
  Buffer               += SessionInfoSize;\r
  Cmd.AuthorizationSize = SwapBytes32 (SessionInfoSize);\r
\r
  WriteUnaligned32 ((UINT32 *)Buffer, SwapBytes32 (Hierarchy));\r
  Buffer += sizeof (UINT32);\r
\r
  *(UINT8 *)Buffer = State;\r
  Buffer++;\r
\r
  CmdSize              = (UINT32)(Buffer - (UINT8 *)&Cmd);\r
  Cmd.Header.paramSize = SwapBytes32 (CmdSize);\r
\r
  ResultBuf     = (UINT8 *)&Res;\r
  ResultBufSize = sizeof (Res);\r
\r
  //\r
  // Call the TPM\r
  //\r
  Status = Tpm2SubmitCommand (\r
             CmdSize,\r
             (UINT8 *)&Cmd,\r
             &ResultBufSize,\r
             ResultBuf\r
             );\r
  if (EFI_ERROR (Status)) {\r
    goto Done;\r
  }\r
\r
  if (ResultBufSize > sizeof (Res)) {\r
    DEBUG ((DEBUG_ERROR, "HierarchyControl: Failed ExecuteCommand: Buffer Too Small\r\n"));\r
    Status = EFI_BUFFER_TOO_SMALL;\r
    goto Done;\r
  }\r
\r
  //\r
  // Validate response headers\r
  //\r
  RespSize = SwapBytes32 (Res.Header.paramSize);\r
  if (RespSize > sizeof (Res)) {\r
    DEBUG ((DEBUG_ERROR, "HierarchyControl: Response size too large! %d\r\n", RespSize));\r
    Status = EFI_BUFFER_TOO_SMALL;\r
    goto Done;\r
  }\r
\r
  //\r
  // Fail if command failed\r
  //\r
  if (SwapBytes32 (Res.Header.responseCode) != TPM_RC_SUCCESS) {\r
    DEBUG ((DEBUG_ERROR, "HierarchyControl: Response Code error! 0x%08x\r\n", SwapBytes32 (Res.Header.responseCode)));\r
    Status = EFI_DEVICE_ERROR;\r
    goto Done;\r
  }\r
\r
Done:\r
  //\r
  // Clear AuthSession Content\r
  //\r
  ZeroMem (&Cmd, sizeof (Cmd));\r
  ZeroMem (&Res, sizeof (Res));\r
  return Status;\r
}\r