UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm

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

/** @file\r
  Implement TPM2 help.\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
typedef struct {\r
  TPMI_ALG_HASH    HashAlgo;\r
  UINT16           HashSize;\r
  UINT32           HashMask;\r
} INTERNAL_HASH_INFO;\r
\r
STATIC INTERNAL_HASH_INFO  mHashInfo[] = {\r
  { TPM_ALG_SHA1,    SHA1_DIGEST_SIZE,    HASH_ALG_SHA1    },\r
  { TPM_ALG_SHA256,  SHA256_DIGEST_SIZE,  HASH_ALG_SHA256  },\r
  { TPM_ALG_SM3_256, SM3_256_DIGEST_SIZE, HASH_ALG_SM3_256 },\r
  { TPM_ALG_SHA384,  SHA384_DIGEST_SIZE,  HASH_ALG_SHA384  },\r
  { TPM_ALG_SHA512,  SHA512_DIGEST_SIZE,  HASH_ALG_SHA512  },\r
};\r
\r
/**\r
  Return size of digest.\r
\r
  @param[in] HashAlgo  Hash algorithm\r
\r
  @return size of digest\r
**/\r
UINT16\r
EFIAPI\r
GetHashSizeFromAlgo (\r
  IN TPMI_ALG_HASH  HashAlgo\r
  )\r
{\r
  UINTN  Index;\r
\r
  for (Index = 0; Index < sizeof (mHashInfo)/sizeof (mHashInfo[0]); Index++) {\r
    if (mHashInfo[Index].HashAlgo == HashAlgo) {\r
      return mHashInfo[Index].HashSize;\r
    }\r
  }\r
\r
  return 0;\r
}\r
\r
/**\r
  Get hash mask from algorithm.\r
\r
  @param[in] HashAlgo   Hash algorithm\r
\r
  @return Hash mask\r
**/\r
UINT32\r
EFIAPI\r
GetHashMaskFromAlgo (\r
  IN TPMI_ALG_HASH  HashAlgo\r
  )\r
{\r
  UINTN  Index;\r
\r
  for (Index = 0; Index < sizeof (mHashInfo)/sizeof (mHashInfo[0]); Index++) {\r
    if (mHashInfo[Index].HashAlgo == HashAlgo) {\r
      return mHashInfo[Index].HashMask;\r
    }\r
  }\r
\r
  return 0;\r
}\r
\r
/**\r
  Copy AuthSessionIn to TPM2 command buffer.\r
\r
  @param [in]  AuthSessionIn   Input AuthSession data\r
  @param [out] AuthSessionOut  Output AuthSession data in TPM2 command buffer\r
\r
  @return AuthSession size\r
**/\r
UINT32\r
EFIAPI\r
CopyAuthSessionCommand (\r
  IN      TPMS_AUTH_COMMAND  *AuthSessionIn  OPTIONAL,\r
  OUT     UINT8              *AuthSessionOut\r
  )\r
{\r
  UINT8  *Buffer;\r
\r
  Buffer = (UINT8 *)AuthSessionOut;\r
\r
  //\r
  // Add in Auth session\r
  //\r
  if (AuthSessionIn != NULL) {\r
    //  sessionHandle\r
    WriteUnaligned32 ((UINT32 *)Buffer, SwapBytes32 (AuthSessionIn->sessionHandle));\r
    Buffer += sizeof (UINT32);\r
\r
    // nonce\r
    WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (AuthSessionIn->nonce.size));\r
    Buffer += sizeof (UINT16);\r
\r
    CopyMem (Buffer, AuthSessionIn->nonce.buffer, AuthSessionIn->nonce.size);\r
    Buffer += AuthSessionIn->nonce.size;\r
\r
    // sessionAttributes\r
    *(UINT8 *)Buffer = *(UINT8 *)&AuthSessionIn->sessionAttributes;\r
    Buffer++;\r
\r
    // hmac\r
    WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (AuthSessionIn->hmac.size));\r
    Buffer += sizeof (UINT16);\r
\r
    CopyMem (Buffer, AuthSessionIn->hmac.buffer, AuthSessionIn->hmac.size);\r
    Buffer += AuthSessionIn->hmac.size;\r
  } else {\r
    //  sessionHandle\r
    WriteUnaligned32 ((UINT32 *)Buffer, SwapBytes32 (TPM_RS_PW));\r
    Buffer += sizeof (UINT32);\r
\r
    // nonce = nullNonce\r
    WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (0));\r
    Buffer += sizeof (UINT16);\r
\r
    // sessionAttributes = 0\r
    *(UINT8 *)Buffer = 0x00;\r
    Buffer++;\r
\r
    // hmac = nullAuth\r
    WriteUnaligned16 ((UINT16 *)Buffer, SwapBytes16 (0));\r
    Buffer += sizeof (UINT16);\r
  }\r
\r
  return (UINT32)((UINTN)Buffer - (UINTN)AuthSessionOut);\r
}\r
\r
/**\r
  Copy AuthSessionIn from TPM2 response buffer.\r
\r
  @param [in]  AuthSessionIn   Input AuthSession data in TPM2 response buffer\r
  @param [out] AuthSessionOut  Output AuthSession data\r
\r
  @return 0    copy failed\r
          else AuthSession size\r
**/\r
UINT32\r
EFIAPI\r
CopyAuthSessionResponse (\r
  IN      UINT8               *AuthSessionIn,\r
  OUT     TPMS_AUTH_RESPONSE  *AuthSessionOut OPTIONAL\r
  )\r
{\r
  UINT8               *Buffer;\r
  TPMS_AUTH_RESPONSE  LocalAuthSessionOut;\r
\r
  if (AuthSessionOut == NULL) {\r
    AuthSessionOut = &LocalAuthSessionOut;\r
  }\r
\r
  Buffer = (UINT8 *)AuthSessionIn;\r
\r
  // nonce\r
  AuthSessionOut->nonce.size = SwapBytes16 (ReadUnaligned16 ((UINT16 *)Buffer));\r
  Buffer                    += sizeof (UINT16);\r
  if (AuthSessionOut->nonce.size > sizeof (TPMU_HA)) {\r
    DEBUG ((DEBUG_ERROR, "CopyAuthSessionResponse - nonce.size error %x\n", AuthSessionOut->nonce.size));\r
    return 0;\r
  }\r
\r
  CopyMem (AuthSessionOut->nonce.buffer, Buffer, AuthSessionOut->nonce.size);\r
  Buffer += AuthSessionOut->nonce.size;\r
\r
  // sessionAttributes\r
  *(UINT8 *) &AuthSessionOut->sessionAttributes = *(UINT8 *)Buffer;\r
  Buffer++;\r
\r
  // hmac\r
  AuthSessionOut->hmac.size = SwapBytes16 (ReadUnaligned16 ((UINT16 *)Buffer));\r
  Buffer                   += sizeof (UINT16);\r
  if (AuthSessionOut->hmac.size > sizeof (TPMU_HA)) {\r
    DEBUG ((DEBUG_ERROR, "CopyAuthSessionResponse - hmac.size error %x\n", AuthSessionOut->hmac.size));\r
    return 0;\r
  }\r
\r
  CopyMem (AuthSessionOut->hmac.buffer, Buffer, AuthSessionOut->hmac.size);\r
  Buffer += AuthSessionOut->hmac.size;\r
\r
  return (UINT32)((UINTN)Buffer - (UINTN)AuthSessionIn);\r
}\r
\r
/**\r
  Return if hash alg is supported in HashAlgorithmMask.\r
\r
  @param HashAlg            Hash algorithm to be checked.\r
  @param HashAlgorithmMask  Bitfield of allowed hash algorithms.\r
\r
  @retval TRUE  Hash algorithm is supported.\r
  @retval FALSE Hash algorithm is not supported.\r
**/\r
BOOLEAN\r
EFIAPI\r
IsHashAlgSupportedInHashAlgorithmMask (\r
  IN TPMI_ALG_HASH  HashAlg,\r
  IN UINT32         HashAlgorithmMask\r
  )\r
{\r
  switch (HashAlg) {\r
    case TPM_ALG_SHA1:\r
      if ((HashAlgorithmMask & HASH_ALG_SHA1) != 0) {\r
        return TRUE;\r
      }\r
\r
      break;\r
    case TPM_ALG_SHA256:\r
      if ((HashAlgorithmMask & HASH_ALG_SHA256) != 0) {\r
        return TRUE;\r
      }\r
\r
      break;\r
    case TPM_ALG_SHA384:\r
      if ((HashAlgorithmMask & HASH_ALG_SHA384) != 0) {\r
        return TRUE;\r
      }\r
\r
      break;\r
    case TPM_ALG_SHA512:\r
      if ((HashAlgorithmMask & HASH_ALG_SHA512) != 0) {\r
        return TRUE;\r
      }\r
\r
      break;\r
    case TPM_ALG_SM3_256:\r
      if ((HashAlgorithmMask & HASH_ALG_SM3_256) != 0) {\r
        return TRUE;\r
      }\r
\r
      break;\r
  }\r
\r
  return FALSE;\r
}\r
\r
/**\r
  Copy TPML_DIGEST_VALUES into a buffer\r
\r
  @param[in,out] Buffer             Buffer to hold copied TPML_DIGEST_VALUES compact binary.\r
  @param[in]     DigestList         TPML_DIGEST_VALUES to be copied.\r
  @param[in]     HashAlgorithmMask  HASH bits corresponding to the desired digests to copy.\r
\r
  @return The end of buffer to hold TPML_DIGEST_VALUES.\r
**/\r
VOID *\r
EFIAPI\r
CopyDigestListToBuffer (\r
  IN OUT VOID            *Buffer,\r
  IN TPML_DIGEST_VALUES  *DigestList,\r
  IN UINT32              HashAlgorithmMask\r
  )\r
{\r
  UINTN   Index;\r
  UINT16  DigestSize;\r
  UINT32  DigestListCount;\r
  UINT32  *DigestListCountPtr;\r
\r
  DigestListCountPtr = (UINT32 *)Buffer;\r
  DigestListCount    = 0;\r
  Buffer             = (UINT8 *)Buffer + sizeof (DigestList->count);\r
  for (Index = 0; Index < DigestList->count; Index++) {\r
    if (!IsHashAlgSupportedInHashAlgorithmMask (DigestList->digests[Index].hashAlg, HashAlgorithmMask)) {\r
      DEBUG ((DEBUG_ERROR, "WARNING: TPM2 Event log has HashAlg unsupported by PCR bank (0x%x)\n", DigestList->digests[Index].hashAlg));\r
      continue;\r
    }\r
\r
    CopyMem (Buffer, &DigestList->digests[Index].hashAlg, sizeof (DigestList->digests[Index].hashAlg));\r
    Buffer     = (UINT8 *)Buffer + sizeof (DigestList->digests[Index].hashAlg);\r
    DigestSize = GetHashSizeFromAlgo (DigestList->digests[Index].hashAlg);\r
    CopyMem (Buffer, &DigestList->digests[Index].digest, DigestSize);\r
    Buffer = (UINT8 *)Buffer + DigestSize;\r
    DigestListCount++;\r
  }\r
\r
  WriteUnaligned32 (DigestListCountPtr, DigestListCount);\r
\r
  return Buffer;\r
}\r
\r
/**\r
  Get TPML_DIGEST_VALUES data size.\r
\r
  @param[in]     DigestList    TPML_DIGEST_VALUES data.\r
\r
  @return TPML_DIGEST_VALUES data size.\r
**/\r
UINT32\r
EFIAPI\r
GetDigestListSize (\r
  IN TPML_DIGEST_VALUES  *DigestList\r
  )\r
{\r
  UINTN   Index;\r
  UINT16  DigestSize;\r
  UINT32  TotalSize;\r
\r
  TotalSize = sizeof (DigestList->count);\r
  for (Index = 0; Index < DigestList->count; Index++) {\r
    DigestSize = GetHashSizeFromAlgo (DigestList->digests[Index].hashAlg);\r
    TotalSize += sizeof (DigestList->digests[Index].hashAlg) + DigestSize;\r
  }\r
\r
  return TotalSize;\r
}\r
\r
/**\r
  This function get digest from digest list.\r
\r
  @param[in]  HashAlg       Digest algorithm\r
  @param[in]  DigestList    Digest list\r
  @param[out] Digest        Digest\r
\r
  @retval EFI_SUCCESS       Digest is found and returned.\r
  @retval EFI_NOT_FOUND     Digest is not found.\r
**/\r
EFI_STATUS\r
EFIAPI\r
GetDigestFromDigestList (\r
  IN TPMI_ALG_HASH       HashAlg,\r
  IN TPML_DIGEST_VALUES  *DigestList,\r
  OUT VOID               *Digest\r
  )\r
{\r
  UINTN   Index;\r
  UINT16  DigestSize;\r
\r
  DigestSize = GetHashSizeFromAlgo (HashAlg);\r
  for (Index = 0; Index < DigestList->count; Index++) {\r
    if (DigestList->digests[Index].hashAlg == HashAlg) {\r
      CopyMem (\r
        Digest,\r
        &DigestList->digests[Index].digest,\r
        DigestSize\r
        );\r
      return EFI_SUCCESS;\r
    }\r
  }\r
\r
  return EFI_NOT_FOUND;\r
}\r