Grammatical and disclaimer changes (does not follow internal C coding stds.)

[mirror_edk2.git] / MdePkg / Include / Protocol / Hash.h

/** @file\r
  EFI_HASH_SERVICE_BINDING_PROTOCOL as defined in UEFI 2.0.\r
  EFI_HASH_PROTOCOL as defined in UEFI 2.0.\r
  The EFI Hash Service Binding Protocol is used to locate hashing services support \r
  provided by a driver and to create and destroy instances of the EFI Hash Protocol \r
  so that a multiple drivers can use the underlying hashing services.\r
\r
Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
This program and the accompanying materials are licensed and made available under \r
the terms and conditions of the BSD License that accompanies this distribution.  \r
The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php.                                          \r
    \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
**/\r
\r
#ifndef __EFI_HASH_PROTOCOL_H__\r
#define __EFI_HASH_PROTOCOL_H__\r
\r
#define EFI_HASH_SERVICE_BINDING_PROTOCOL_GUID \\r
  { \\r
    0x42881c98, 0xa4f3, 0x44b0, {0xa3, 0x9d, 0xdf, 0xa1, 0x86, 0x67, 0xd8, 0xcd } \\r
  }\r
  \r
#define EFI_HASH_PROTOCOL_GUID \\r
  { \\r
    0xc5184932, 0xdba5, 0x46db, {0xa5, 0xba, 0xcc, 0x0b, 0xda, 0x9c, 0x14, 0x35 } \\r
  }\r
\r
#define EFI_HASH_ALGORITHM_SHA1_GUID \\r
  { \\r
    0x2ae9d80f, 0x3fb2, 0x4095, {0xb7, 0xb1, 0xe9, 0x31, 0x57, 0xb9, 0x46, 0xb6 } \\r
  }\r
\r
#define EFI_HASH_ALGORITHM_SHA224_GUID \\r
  { \\r
    0x8df01a06, 0x9bd5, 0x4bf7, {0xb0, 0x21, 0xdb, 0x4f, 0xd9, 0xcc, 0xf4, 0x5b } \\r
  } \r
\r
#define EFI_HASH_ALGORITHM_SHA256_GUID \\r
  { \\r
    0x51aa59de, 0xfdf2, 0x4ea3, {0xbc, 0x63, 0x87, 0x5f, 0xb7, 0x84, 0x2e, 0xe9 } \\r
  } \r
\r
#define EFI_HASH_ALGORITHM_SHA384_GUID \\r
  { \\r
    0xefa96432, 0xde33, 0x4dd2, {0xae, 0xe6, 0x32, 0x8c, 0x33, 0xdf, 0x77, 0x7a } \\r
  } \r
\r
#define EFI_HASH_ALGORITHM_SHA512_GUID \\r
  { \\r
    0xcaa4381e, 0x750c, 0x4770, {0xb8, 0x70, 0x7a, 0x23, 0xb4, 0xe4, 0x21, 0x30 } \\r
  }\r
\r
#define EFI_HASH_ALGORTIHM_MD5_GUID \\r
  { \\r
    0xaf7c79c, 0x65b5, 0x4319, {0xb0, 0xae, 0x44, 0xec, 0x48, 0x4e, 0x4a, 0xd7 } \\r
  }\r
\r
typedef struct _EFI_HASH_PROTOCOL EFI_HASH_PROTOCOL;\r
\r
typedef UINT8  EFI_MD5_HASH[16];\r
typedef UINT8  EFI_SHA1_HASH[20];\r
typedef UINT8  EFI_SHA224_HASH[28];\r
typedef UINT8  EFI_SHA256_HASH[32];\r
typedef UINT8  EFI_SHA384_HASH[48];\r
typedef UINT8  EFI_SHA512_HASH[64];\r
\r
typedef union {\r
  EFI_MD5_HASH     *Md5Hash;\r
  EFI_SHA1_HASH    *Sha1Hash;\r
  EFI_SHA224_HASH  *Sha224Hash;\r
  EFI_SHA256_HASH  *Sha256Hash;\r
  EFI_SHA384_HASH  *Sha384Hash;\r
  EFI_SHA512_HASH  *Sha512Hash;\r
} EFI_HASH_OUTPUT;\r
\r
/**\r
  Returns the size of the hash which results from a specific algorithm.\r
\r
  @param[in]  This                  Points to this instance of EFI_HASH_PROTOCOL.\r
  @param[in]  HashAlgorithm         Points to the EFI_GUID which identifies the algorithm to use.\r
  @param[out] HashSize              Holds the returned size of the algorithm's hash.\r
\r
  @retval EFI_SUCCESS           Hash size returned successfully.\r
  @retval EFI_INVALID_PARAMETER HashSize is NULL\r
  @retval EFI_UNSUPPORTED       The algorithm specified by HashAlgorithm is not supported \r
                                by this driver.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_HASH_GET_HASH_SIZE)(\r
  IN  CONST EFI_HASH_PROTOCOL     *This,\r
  IN  CONST EFI_GUID              *HashAlgorithm,\r
  OUT UINTN                       *HashSize\r
  );      \r
\r
/**\r
  Returns the size of the hash which results from a specific algorithm.\r
\r
  @param[in]  This          Points to this instance of EFI_HASH_PROTOCOL.\r
  @param[in]  HashAlgorithm Points to the EFI_GUID which identifies the algorithm to use.\r
  @param[in]  Extend        Specifies whether to create a new hash (FALSE) or extend the specified\r
                            existing hash (TRUE).\r
  @param[in]  Message       Points to the start of the message.\r
  @param[in]  MessageSize   The size of Message, in bytes.\r
  @param[in,out]  Hash      On input, if Extend is TRUE, then this holds the hash to extend. On\r
                            output, holds the resulting hash computed from the message.\r
\r
  @retval EFI_SUCCESS           Hash returned successfully.\r
  @retval EFI_INVALID_PARAMETER Message or Hash is NULL\r
  @retval EFI_UNSUPPORTED       The algorithm specified by HashAlgorithm is not supported by this\r
                                 driver. Or, Extend is TRUE, and the algorithm doesn't support extending the hash.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_HASH_HASH)(\r
  IN CONST EFI_HASH_PROTOCOL      *This,\r
  IN CONST EFI_GUID               *HashAlgorithm,\r
  IN BOOLEAN                      Extend,\r
  IN CONST UINT8                  *Message,\r
  IN UINT64                       MessageSize,\r
  IN OUT EFI_HASH_OUTPUT          *Hash\r
  );    \r
\r
///\r
/// This protocol allows creating a hash of an arbitrary message digest \r
/// using one or more hash algorithms.\r
///\r
struct _EFI_HASH_PROTOCOL {\r
  EFI_HASH_GET_HASH_SIZE          GetHashSize;\r
  EFI_HASH_HASH                   Hash;\r
};\r
\r
extern EFI_GUID gEfiHashServiceBindingProtocolGuid;\r
extern EFI_GUID gEfiHashProtocolGuid;\r
extern EFI_GUID gEfiHashAlgorithmSha1Guid;\r
extern EFI_GUID gEfiHashAlgorithmSha224Guid;\r
extern EFI_GUID gEfiHashAlgorithmSha256Guid;\r
extern EFI_GUID gEfiHashAlgorithmSha384Guid;\r
extern EFI_GUID gEfiHashAlgorithmSha512Guid;\r
extern EFI_GUID gEfiHashAlgorithmMD5Guid;\r
\r
#endif\r