SecurityPkg: Fix spelling errors

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

/** @file\r
  This library is BaseCrypto SHA1 hash instance.\r
  It can be registered to BaseCrypto router, to serve as hash engine.\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 <PiPei.h>\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/Tpm2CommandLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/BaseCryptLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/HashLib.h>\r
\r
/**\r
  The function set SHA1 to digest list.\r
\r
  @param DigestList digest list\r
  @param Sha1Digest SHA1 digest\r
**/\r
VOID\r
Tpm2SetSha1ToDigestList (\r
  IN TPML_DIGEST_VALUES *DigestList,\r
  IN UINT8              *Sha1Digest\r
  )\r
{\r
  DigestList->count = 1;\r
  DigestList->digests[0].hashAlg = TPM_ALG_SHA1;\r
  CopyMem (\r
    DigestList->digests[0].digest.sha1,\r
    Sha1Digest,\r
    SHA1_DIGEST_SIZE\r
    );\r
}\r
\r
/**\r
  Start hash sequence.\r
\r
  @param HashHandle Hash handle.\r
\r
  @retval EFI_SUCCESS          Hash sequence start and HandleHandle returned.\r
  @retval EFI_OUT_OF_RESOURCES No enough resource to start hash.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Sha1HashInit (\r
  OUT HASH_HANDLE    *HashHandle\r
  )\r
{\r
  VOID     *Sha1Ctx;\r
  UINTN    CtxSize;\r
\r
  CtxSize = Sha1GetContextSize ();\r
  Sha1Ctx = AllocatePool (CtxSize);\r
  ASSERT (Sha1Ctx != NULL);\r
\r
  Sha1Init (Sha1Ctx);\r
\r
  *HashHandle = (HASH_HANDLE)Sha1Ctx;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Update hash sequence data.\r
\r
  @param HashHandle    Hash handle.\r
  @param DataToHash    Data to be hashed.\r
  @param DataToHashLen Data size.\r
\r
  @retval EFI_SUCCESS     Hash sequence updated.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Sha1HashUpdate (\r
  IN HASH_HANDLE    HashHandle,\r
  IN VOID           *DataToHash,\r
  IN UINTN          DataToHashLen\r
  )\r
{\r
  VOID     *Sha1Ctx;\r
\r
  Sha1Ctx = (VOID *)HashHandle;\r
  Sha1Update (Sha1Ctx, DataToHash, DataToHashLen);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Complete hash sequence complete.\r
\r
  @param HashHandle    Hash handle.\r
  @param DigestList    Digest list.\r
\r
  @retval EFI_SUCCESS     Hash sequence complete and DigestList is returned.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Sha1HashFinal (\r
  IN HASH_HANDLE         HashHandle,\r
  OUT TPML_DIGEST_VALUES *DigestList\r
  )\r
{\r
  UINT8         Digest[SHA1_DIGEST_SIZE];\r
  VOID          *Sha1Ctx;\r
\r
  Sha1Ctx = (VOID *)HashHandle;\r
  Sha1Final (Sha1Ctx, Digest);\r
\r
  FreePool (Sha1Ctx);\r
\r
  Tpm2SetSha1ToDigestList (DigestList, Digest);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
HASH_INTERFACE  mSha1InternalHashInstance = {\r
  HASH_ALGORITHM_SHA1_GUID,\r
  Sha1HashInit,\r
  Sha1HashUpdate,\r
  Sha1HashFinal,\r
};\r
\r
/**\r
  The function register SHA1 instance.\r
\r
  @retval EFI_SUCCESS   SHA1 instance is registered, or system does not support register SHA1 instance\r
**/\r
EFI_STATUS\r
EFIAPI\r
HashInstanceLibSha1Constructor (\r
  VOID\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  Status = RegisterHashInterfaceLib (&mSha1InternalHashInstance);\r
  if ((Status == EFI_SUCCESS) || (Status == EFI_UNSUPPORTED)) {\r
    //\r
    // Unsupported means platform policy does not need this instance enabled.\r
    //\r
    return EFI_SUCCESS;\r
  }\r
  return Status;\r
}\r