MdePkg/Include/Protocol/Hash.h

   1 /** @file
   2   EFI_HASH_SERVICE_BINDING_PROTOCOL as defined in UEFI 2.0.
   3   EFI_HASH_PROTOCOL as defined in UEFI 2.0.
   4   The EFI Hash Service Binding Protocol is used to locate hashing services support
   5   provided by a driver and to create and destroy instances of the EFI Hash Protocol
   6   so that a multiple drivers can use the underlying hashing services.
   7
   8 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
   9 SPDX-License-Identifier: BSD-2-Clause-Patent
  10
  11 **/
  12
  13 #ifndef __EFI_HASH_PROTOCOL_H__
  14 #define __EFI_HASH_PROTOCOL_H__
  15
  16 #define EFI_HASH_SERVICE_BINDING_PROTOCOL_GUID \
  17   { \
  18     0x42881c98, 0xa4f3, 0x44b0, {0xa3, 0x9d, 0xdf, 0xa1, 0x86, 0x67, 0xd8, 0xcd } \
  19   }
  20
  21 #define EFI_HASH_PROTOCOL_GUID \
  22   { \
  23     0xc5184932, 0xdba5, 0x46db, {0xa5, 0xba, 0xcc, 0x0b, 0xda, 0x9c, 0x14, 0x35 } \
  24   }
  25
  26 #define EFI_HASH_ALGORITHM_SHA1_GUID \
  27   { \
  28     0x2ae9d80f, 0x3fb2, 0x4095, {0xb7, 0xb1, 0xe9, 0x31, 0x57, 0xb9, 0x46, 0xb6 } \
  29   }
  30
  31 #define EFI_HASH_ALGORITHM_SHA224_GUID \
  32   { \
  33     0x8df01a06, 0x9bd5, 0x4bf7, {0xb0, 0x21, 0xdb, 0x4f, 0xd9, 0xcc, 0xf4, 0x5b } \
  34   }
  35
  36 #define EFI_HASH_ALGORITHM_SHA256_GUID \
  37   { \
  38     0x51aa59de, 0xfdf2, 0x4ea3, {0xbc, 0x63, 0x87, 0x5f, 0xb7, 0x84, 0x2e, 0xe9 } \
  39   }
  40
  41 #define EFI_HASH_ALGORITHM_SHA384_GUID \
  42   { \
  43     0xefa96432, 0xde33, 0x4dd2, {0xae, 0xe6, 0x32, 0x8c, 0x33, 0xdf, 0x77, 0x7a } \
  44   }
  45
  46 #define EFI_HASH_ALGORITHM_SHA512_GUID \
  47   { \
  48     0xcaa4381e, 0x750c, 0x4770, {0xb8, 0x70, 0x7a, 0x23, 0xb4, 0xe4, 0x21, 0x30 } \
  49   }
  50
  51 #define EFI_HASH_ALGORTIHM_MD5_GUID \
  52   { \
  53     0xaf7c79c, 0x65b5, 0x4319, {0xb0, 0xae, 0x44, 0xec, 0x48, 0x4e, 0x4a, 0xd7 } \
  54   }
  55
  56 #define EFI_HASH_ALGORITHM_SHA1_NOPAD_GUID \
  57   { \
  58     0x24c5dc2f, 0x53e2, 0x40ca, {0x9e, 0xd6, 0xa5, 0xd9, 0xa4, 0x9f, 0x46, 0x3b } \
  59   }
  60
  61 #define EFI_HASH_ALGORITHM_SHA256_NOPAD_GUID \
  62   { \
  63     0x8628752a, 0x6cb7, 0x4814, {0x96, 0xfc, 0x24, 0xa8, 0x15, 0xac, 0x22, 0x26 } \
  64   }
  65
  66 //
  67 // Note: Use of the following algorithms with EFI_HASH_PROTOCOL is deprecated.
  68 //       EFI_HASH_ALGORITHM_SHA1_GUID
  69 //       EFI_HASH_ALGORITHM_SHA224_GUID
  70 //       EFI_HASH_ALGORITHM_SHA256_GUID
  71 //       EFI_HASH_ALGORITHM_SHA384_GUID
  72 //       EFI_HASH_ALGORITHM_SHA512_GUID
  73 //       EFI_HASH_ALGORTIHM_MD5_GUID
  74 //
  75
  76 typedef struct _EFI_HASH_PROTOCOL EFI_HASH_PROTOCOL;
  77
  78 typedef UINT8 EFI_MD5_HASH[16];
  79 typedef UINT8 EFI_SHA1_HASH[20];
  80 typedef UINT8 EFI_SHA224_HASH[28];
  81 typedef UINT8 EFI_SHA256_HASH[32];
  82 typedef UINT8 EFI_SHA384_HASH[48];
  83 typedef UINT8 EFI_SHA512_HASH[64];
  84
  85 typedef union {
  86   EFI_MD5_HASH       *Md5Hash;
  87   EFI_SHA1_HASH      *Sha1Hash;
  88   EFI_SHA224_HASH    *Sha224Hash;
  89   EFI_SHA256_HASH    *Sha256Hash;
  90   EFI_SHA384_HASH    *Sha384Hash;
  91   EFI_SHA512_HASH    *Sha512Hash;
  92 } EFI_HASH_OUTPUT;
  93
  94 /**
  95   Returns the size of the hash which results from a specific algorithm.
  96
  97   @param[in]  This                  Points to this instance of EFI_HASH_PROTOCOL.
  98   @param[in]  HashAlgorithm         Points to the EFI_GUID which identifies the algorithm to use.
  99   @param[out] HashSize              Holds the returned size of the algorithm's hash.
 100
 101   @retval EFI_SUCCESS           Hash size returned successfully.
 102   @retval EFI_INVALID_PARAMETER HashSize is NULL or HashAlgorithm is NULL.
 103   @retval EFI_UNSUPPORTED       The algorithm specified by HashAlgorithm is not supported
 104                                 by this driver.
 105
 106 **/
 107 typedef
 108 EFI_STATUS
 109 (EFIAPI *EFI_HASH_GET_HASH_SIZE)(
 110   IN  CONST EFI_HASH_PROTOCOL     *This,
 111   IN  CONST EFI_GUID              *HashAlgorithm,
 112   OUT UINTN                       *HashSize
 113   );
 114
 115 /**
 116   Creates a hash for the specified message text.
 117
 118   @param[in]  This          Points to this instance of EFI_HASH_PROTOCOL.
 119   @param[in]  HashAlgorithm Points to the EFI_GUID which identifies the algorithm to use.
 120   @param[in]  Extend        Specifies whether to create a new hash (FALSE) or extend the specified
 121                             existing hash (TRUE).
 122   @param[in]  Message       Points to the start of the message.
 123   @param[in]  MessageSize   The size of Message, in bytes.
 124   @param[in,out]  Hash      On input, if Extend is TRUE, then this parameter holds a pointer
 125                             to a pointer to an array containing the hash to extend. If Extend
 126                             is FALSE, then this parameter holds a pointer to a pointer to a
 127                             caller-allocated array that will receive the result of the hash
 128                             computation. On output (regardless of the value of Extend), the
 129                             array will contain the result of the hash computation.
 130
 131   @retval EFI_SUCCESS           Hash returned successfully.
 132   @retval EFI_INVALID_PARAMETER Message or Hash, HashAlgorithm is NULL or MessageSize is 0.
 133                                 MessageSize is not an integer multiple of block size.
 134   @retval EFI_UNSUPPORTED       The algorithm specified by HashAlgorithm is not supported by this
 135                                  driver. Or, Extend is TRUE, and the algorithm doesn't support extending the hash.
 136
 137 **/
 138 typedef
 139 EFI_STATUS
 140 (EFIAPI *EFI_HASH_HASH)(
 141   IN CONST EFI_HASH_PROTOCOL      *This,
 142   IN CONST EFI_GUID               *HashAlgorithm,
 143   IN BOOLEAN                      Extend,
 144   IN CONST UINT8                  *Message,
 145   IN UINT64                       MessageSize,
 146   IN OUT EFI_HASH_OUTPUT          *Hash
 147   );
 148
 149 ///
 150 /// This protocol allows creating a hash of an arbitrary message digest
 151 /// using one or more hash algorithms.
 152 ///
 153 struct _EFI_HASH_PROTOCOL {
 154   EFI_HASH_GET_HASH_SIZE    GetHashSize;
 155   EFI_HASH_HASH             Hash;
 156 };
 157
 158 extern EFI_GUID  gEfiHashServiceBindingProtocolGuid;
 159 extern EFI_GUID  gEfiHashProtocolGuid;
 160 extern EFI_GUID  gEfiHashAlgorithmSha1Guid;
 161 extern EFI_GUID  gEfiHashAlgorithmSha224Guid;
 162 extern EFI_GUID  gEfiHashAlgorithmSha256Guid;
 163 extern EFI_GUID  gEfiHashAlgorithmSha384Guid;
 164 extern EFI_GUID  gEfiHashAlgorithmSha512Guid;
 165 extern EFI_GUID  gEfiHashAlgorithmMD5Guid;
 166 extern EFI_GUID  gEfiHashAlgorithmSha1NoPadGuid;
 167 extern EFI_GUID  gEfiHashAlgorithmSha256NoPadGuid;
 168
 169 #endif