SecurityPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / SecurityPkg / Include / Library / HashLib.h

/** @file\r
  This library abstract TPM2 hash calculation.\r
  The platform can choose multiply hash, while caller just need invoke these API.\r
  Then all hash value will be returned and/or extended.\r
\r
Copyright (c) 2013 - 2016, Intel Corporation. All rights reserved. <BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _HASH_LIB_H_\r
#define _HASH_LIB_H_\r
\r
#include <Uefi.h>\r
#include <Protocol/Hash.h>\r
#include <IndustryStandard/Tpm20.h>\r
typedef UINTN  HASH_HANDLE;\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
HashStart (\r
  OUT HASH_HANDLE    *HashHandle\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
HashUpdate (\r
  IN HASH_HANDLE    HashHandle,\r
  IN VOID           *DataToHash,\r
  IN UINTN          DataToHashLen\r
  );\r
\r
/**\r
  Hash sequence complete and extend to PCR.\r
\r
  @param HashHandle    Hash handle.\r
  @param PcrIndex      PCR to be extended.\r
  @param DataToHash    Data to be hashed.\r
  @param DataToHashLen Data size.\r
  @param DigestList    Digest list.\r
\r
  @retval EFI_SUCCESS     Hash sequence complete and DigestList is returned.\r
**/\r
EFI_STATUS\r
EFIAPI\r
HashCompleteAndExtend (\r
  IN HASH_HANDLE         HashHandle,\r
  IN TPMI_DH_PCR         PcrIndex,\r
  IN VOID                *DataToHash,\r
  IN UINTN               DataToHashLen,\r
  OUT TPML_DIGEST_VALUES *DigestList\r
  );\r
\r
/**\r
  Hash data and extend to PCR.\r
\r
  @param PcrIndex      PCR to be extended.\r
  @param DataToHash    Data to be hashed.\r
  @param DataToHashLen Data size.\r
  @param DigestList    Digest list.\r
\r
  @retval EFI_SUCCESS     Hash data and DigestList is returned.\r
**/\r
EFI_STATUS\r
EFIAPI\r
HashAndExtend (\r
  IN TPMI_DH_PCR                    PcrIndex,\r
  IN VOID                           *DataToHash,\r
  IN UINTN                          DataToHashLen,\r
  OUT TPML_DIGEST_VALUES            *DigestList\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
typedef\r
EFI_STATUS\r
(EFIAPI *HASH_INIT) (\r
  OUT HASH_HANDLE    *HashHandle\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
typedef\r
EFI_STATUS\r
(EFIAPI *HASH_UPDATE) (\r
  IN HASH_HANDLE    HashHandle,\r
  IN VOID           *DataToHash,\r
  IN UINTN          DataToHashLen\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
typedef\r
EFI_STATUS\r
(EFIAPI *HASH_FINAL) (\r
  IN HASH_HANDLE         HashHandle,\r
  OUT TPML_DIGEST_VALUES *DigestList\r
  );\r
\r
#define HASH_ALGORITHM_SHA1_GUID    EFI_HASH_ALGORITHM_SHA1_GUID\r
#define HASH_ALGORITHM_SHA256_GUID  EFI_HASH_ALGORITHM_SHA256_GUID\r
#define HASH_ALGORITHM_SHA384_GUID  EFI_HASH_ALGORITHM_SHA384_GUID\r
#define HASH_ALGORITHM_SHA512_GUID  EFI_HASH_ALGORITHM_SHA512_GUID\r
\r
typedef struct {\r
  EFI_GUID                           HashGuid;\r
  HASH_INIT                          HashInit;\r
  HASH_UPDATE                        HashUpdate;\r
  HASH_FINAL                         HashFinal;\r
} HASH_INTERFACE;\r
\r
/**\r
  This service register Hash.\r
\r
  @param HashInterface  Hash interface\r
\r
  @retval EFI_SUCCESS          This hash interface is registered successfully.\r
  @retval EFI_UNSUPPORTED      System does not support register this interface.\r
  @retval EFI_ALREADY_STARTED  System already register this interface.\r
**/\r
EFI_STATUS\r
EFIAPI\r
RegisterHashInterfaceLib (\r
  IN HASH_INTERFACE   *HashInterface\r
  );\r
\r
#endif\r