HashLib.h 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163
  1. /** @file
  2. This library abstract TPM2 hash calculation.
  3. The platform can choose multiply hash, while caller just need invoke these API.
  4. Then all hash value will be returned and/or extended.
  5. Copyright (c) 2013 - 2016, Intel Corporation. All rights reserved. <BR>
  6. SPDX-License-Identifier: BSD-2-Clause-Patent
  7. **/
  8. #ifndef _HASH_LIB_H_
  9. #define _HASH_LIB_H_
  10. #include <Uefi.h>
  11. #include <Protocol/Hash.h>
  12. #include <IndustryStandard/Tpm20.h>
  13. typedef UINTN HASH_HANDLE;
  14. /**
  15. Start hash sequence.
  16. @param HashHandle Hash handle.
  17. @retval EFI_SUCCESS Hash sequence start and HandleHandle returned.
  18. @retval EFI_OUT_OF_RESOURCES No enough resource to start hash.
  19. **/
  20. EFI_STATUS
  21. EFIAPI
  22. HashStart (
  23. OUT HASH_HANDLE *HashHandle
  24. );
  25. /**
  26. Update hash sequence data.
  27. @param HashHandle Hash handle.
  28. @param DataToHash Data to be hashed.
  29. @param DataToHashLen Data size.
  30. @retval EFI_SUCCESS Hash sequence updated.
  31. **/
  32. EFI_STATUS
  33. EFIAPI
  34. HashUpdate (
  35. IN HASH_HANDLE HashHandle,
  36. IN VOID *DataToHash,
  37. IN UINTN DataToHashLen
  38. );
  39. /**
  40. Hash sequence complete and extend to PCR.
  41. @param HashHandle Hash handle.
  42. @param PcrIndex PCR to be extended.
  43. @param DataToHash Data to be hashed.
  44. @param DataToHashLen Data size.
  45. @param DigestList Digest list.
  46. @retval EFI_SUCCESS Hash sequence complete and DigestList is returned.
  47. **/
  48. EFI_STATUS
  49. EFIAPI
  50. HashCompleteAndExtend (
  51. IN HASH_HANDLE HashHandle,
  52. IN TPMI_DH_PCR PcrIndex,
  53. IN VOID *DataToHash,
  54. IN UINTN DataToHashLen,
  55. OUT TPML_DIGEST_VALUES *DigestList
  56. );
  57. /**
  58. Hash data and extend to PCR.
  59. @param PcrIndex PCR to be extended.
  60. @param DataToHash Data to be hashed.
  61. @param DataToHashLen Data size.
  62. @param DigestList Digest list.
  63. @retval EFI_SUCCESS Hash data and DigestList is returned.
  64. **/
  65. EFI_STATUS
  66. EFIAPI
  67. HashAndExtend (
  68. IN TPMI_DH_PCR PcrIndex,
  69. IN VOID *DataToHash,
  70. IN UINTN DataToHashLen,
  71. OUT TPML_DIGEST_VALUES *DigestList
  72. );
  73. /**
  74. Start hash sequence.
  75. @param HashHandle Hash handle.
  76. @retval EFI_SUCCESS Hash sequence start and HandleHandle returned.
  77. @retval EFI_OUT_OF_RESOURCES No enough resource to start hash.
  78. **/
  79. typedef
  80. EFI_STATUS
  81. (EFIAPI *HASH_INIT) (
  82. OUT HASH_HANDLE *HashHandle
  83. );
  84. /**
  85. Update hash sequence data.
  86. @param HashHandle Hash handle.
  87. @param DataToHash Data to be hashed.
  88. @param DataToHashLen Data size.
  89. @retval EFI_SUCCESS Hash sequence updated.
  90. **/
  91. typedef
  92. EFI_STATUS
  93. (EFIAPI *HASH_UPDATE) (
  94. IN HASH_HANDLE HashHandle,
  95. IN VOID *DataToHash,
  96. IN UINTN DataToHashLen
  97. );
  98. /**
  99. Complete hash sequence complete.
  100. @param HashHandle Hash handle.
  101. @param DigestList Digest list.
  102. @retval EFI_SUCCESS Hash sequence complete and DigestList is returned.
  103. **/
  104. typedef
  105. EFI_STATUS
  106. (EFIAPI *HASH_FINAL) (
  107. IN HASH_HANDLE HashHandle,
  108. OUT TPML_DIGEST_VALUES *DigestList
  109. );
  110. #define HASH_ALGORITHM_SHA1_GUID EFI_HASH_ALGORITHM_SHA1_GUID
  111. #define HASH_ALGORITHM_SHA256_GUID EFI_HASH_ALGORITHM_SHA256_GUID
  112. #define HASH_ALGORITHM_SHA384_GUID EFI_HASH_ALGORITHM_SHA384_GUID
  113. #define HASH_ALGORITHM_SHA512_GUID EFI_HASH_ALGORITHM_SHA512_GUID
  114. typedef struct {
  115. EFI_GUID HashGuid;
  116. HASH_INIT HashInit;
  117. HASH_UPDATE HashUpdate;
  118. HASH_FINAL HashFinal;
  119. } HASH_INTERFACE;
  120. /**
  121. This service register Hash.
  122. @param HashInterface Hash interface
  123. @retval EFI_SUCCESS This hash interface is registered successfully.
  124. @retval EFI_UNSUPPORTED System does not support register this interface.
  125. @retval EFI_ALREADY_STARTED System already register this interface.
  126. **/
  127. EFI_STATUS
  128. EFIAPI
  129. RegisterHashInterfaceLib (
  130. IN HASH_INTERFACE *HashInterface
  131. );
  132. #endif