SecurityPkg: Change use of EFI_D_* to DEBUG_*

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

/** @file\r
  Implement TPM2 Session related command.\r
\r
Copyright (c) 2014 - 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_DH_OBJECT            TpmKey;\r
  TPMI_DH_ENTITY            Bind;\r
  TPM2B_NONCE               NonceCaller;\r
  TPM2B_ENCRYPTED_SECRET    Salt;\r
  TPM_SE                    SessionType;\r
  TPMT_SYM_DEF              Symmetric;\r
  TPMI_ALG_HASH             AuthHash;\r
} TPM2_START_AUTH_SESSION_COMMAND;\r
\r
typedef struct {\r
  TPM2_RESPONSE_HEADER      Header;\r
  TPMI_SH_AUTH_SESSION      SessionHandle;\r
  TPM2B_NONCE               NonceTPM;\r
} TPM2_START_AUTH_SESSION_RESPONSE;\r
\r
#pragma pack()\r
\r
/**\r
  This command is used to start an authorization session using alternative methods of\r
  establishing the session key (sessionKey) that is used for authorization and encrypting value.\r
\r
  @param[in]  TpmKey             Handle of a loaded decrypt key used to encrypt salt.\r
  @param[in]  Bind               Entity providing the authValue.\r
  @param[in]  NonceCaller        Initial nonceCaller, sets nonce size for the session.\r
  @param[in]  Salt               Value encrypted according to the type of tpmKey.\r
  @param[in]  SessionType        Indicates the type of the session.\r
  @param[in]  Symmetric          The algorithm and key size for parameter encryption.\r
  @param[in]  AuthHash           Hash algorithm to use for the session.\r
  @param[out] SessionHandle      Handle for the newly created session.\r
  @param[out] NonceTPM           The initial nonce from the TPM, used in the computation of the sessionKey.\r
\r
  @retval EFI_SUCCESS            Operation completed successfully.\r
  @retval EFI_DEVICE_ERROR       The command was unsuccessful.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Tpm2StartAuthSession (\r
  IN      TPMI_DH_OBJECT            TpmKey,\r
  IN      TPMI_DH_ENTITY            Bind,\r
  IN      TPM2B_NONCE               *NonceCaller,\r
  IN      TPM2B_ENCRYPTED_SECRET    *Salt,\r
  IN      TPM_SE                    SessionType,\r
  IN      TPMT_SYM_DEF              *Symmetric,\r
  IN      TPMI_ALG_HASH             AuthHash,\r
     OUT  TPMI_SH_AUTH_SESSION      *SessionHandle,\r
     OUT  TPM2B_NONCE               *NonceTPM\r
  )\r
{\r
  EFI_STATUS                        Status;\r
  TPM2_START_AUTH_SESSION_COMMAND   SendBuffer;\r
  TPM2_START_AUTH_SESSION_RESPONSE  RecvBuffer;\r
  UINT32                            SendBufferSize;\r
  UINT32                            RecvBufferSize;\r
  UINT8                             *Buffer;\r
\r
  //\r
  // Construct command\r
  //\r
  SendBuffer.Header.tag = SwapBytes16(TPM_ST_NO_SESSIONS);\r
  SendBuffer.Header.commandCode = SwapBytes32(TPM_CC_StartAuthSession);\r
\r
  SendBuffer.TpmKey = SwapBytes32 (TpmKey);\r
  SendBuffer.Bind = SwapBytes32 (Bind);\r
  Buffer = (UINT8 *)&SendBuffer.NonceCaller;\r
\r
  WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (NonceCaller->size));\r
  Buffer += sizeof(UINT16);\r
  CopyMem (Buffer, NonceCaller->buffer, NonceCaller->size);\r
  Buffer += NonceCaller->size;\r
\r
  WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (Salt->size));\r
  Buffer += sizeof(UINT16);\r
  CopyMem (Buffer, Salt->secret, Salt->size);\r
  Buffer += Salt->size;\r
\r
  *(TPM_SE *)Buffer = SessionType;\r
  Buffer++;\r
\r
  WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (Symmetric->algorithm));\r
  Buffer += sizeof(UINT16);\r
  switch (Symmetric->algorithm) {\r
  case TPM_ALG_NULL:\r
    break;\r
  case TPM_ALG_AES:\r
    WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (Symmetric->keyBits.aes));\r
    Buffer += sizeof(UINT16);\r
    WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (Symmetric->mode.aes));\r
    Buffer += sizeof(UINT16);\r
    break;\r
  case TPM_ALG_SM4:\r
    WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (Symmetric->keyBits.SM4));\r
    Buffer += sizeof(UINT16);\r
    WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (Symmetric->mode.SM4));\r
    Buffer += sizeof(UINT16);\r
    break;\r
  case TPM_ALG_SYMCIPHER:\r
    WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (Symmetric->keyBits.sym));\r
    Buffer += sizeof(UINT16);\r
    WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (Symmetric->mode.sym));\r
    Buffer += sizeof(UINT16);\r
    break;\r
  case TPM_ALG_XOR:\r
    WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (Symmetric->keyBits.xor));\r
    Buffer += sizeof(UINT16);\r
    break;\r
  default:\r
    ASSERT (FALSE);\r
    DEBUG ((DEBUG_ERROR, "Tpm2StartAuthSession - Symmetric->algorithm - %x\n", Symmetric->algorithm));\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (AuthHash));\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
    return Status;\r
  }\r
\r
  if (RecvBufferSize < sizeof (TPM2_RESPONSE_HEADER)) {\r
    DEBUG ((DEBUG_ERROR, "Tpm2StartAuthSession - RecvBufferSize Error - %x\n", RecvBufferSize));\r
    return EFI_DEVICE_ERROR;\r
  }\r
  if (SwapBytes32(RecvBuffer.Header.responseCode) != TPM_RC_SUCCESS) {\r
    DEBUG ((DEBUG_ERROR, "Tpm2StartAuthSession - responseCode - %x\n", SwapBytes32(RecvBuffer.Header.responseCode)));\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  //\r
  // Return the response\r
  //\r
  *SessionHandle = SwapBytes32 (RecvBuffer.SessionHandle);\r
  NonceTPM->size = SwapBytes16 (RecvBuffer.NonceTPM.size);\r
  if (NonceTPM->size > sizeof(TPMU_HA)) {\r
    DEBUG ((DEBUG_ERROR, "Tpm2StartAuthSession - NonceTPM->size error %x\n", NonceTPM->size));\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  CopyMem (NonceTPM->buffer, &RecvBuffer.NonceTPM.buffer, NonceTPM->size);\r
\r
  return EFI_SUCCESS;\r
}\r