CryptoPkg: Apply uncrustify changes

[mirror_edk2.git] / CryptoPkg / Library / BaseCryptLib / Hash / CryptSha1.c

/** @file\r
  SHA-1 Digest Wrapper Implementation over OpenSSL.\r
\r
Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "InternalCryptLib.h"\r
#include <openssl/sha.h>\r
\r
#ifndef DISABLE_SHA1_DEPRECATED_INTERFACES\r
\r
/**\r
  Retrieves the size, in bytes, of the context buffer required for SHA-1 hash operations.\r
\r
  @return  The size, in bytes, of the context buffer required for SHA-1 hash operations.\r
\r
**/\r
UINTN\r
EFIAPI\r
Sha1GetContextSize (\r
  VOID\r
  )\r
{\r
  //\r
  // Retrieves OpenSSL SHA Context Size\r
  //\r
  return (UINTN)(sizeof (SHA_CTX));\r
}\r
\r
/**\r
  Initializes user-supplied memory pointed by Sha1Context as SHA-1 hash context for\r
  subsequent use.\r
\r
  If Sha1Context is NULL, then return FALSE.\r
\r
  @param[out]  Sha1Context  Pointer to SHA-1 context being initialized.\r
\r
  @retval TRUE   SHA-1 context initialization succeeded.\r
  @retval FALSE  SHA-1 context initialization failed.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
Sha1Init (\r
  OUT  VOID  *Sha1Context\r
  )\r
{\r
  //\r
  // Check input parameters.\r
  //\r
  if (Sha1Context == NULL) {\r
    return FALSE;\r
  }\r
\r
  //\r
  // OpenSSL SHA-1 Context Initialization\r
  //\r
  return (BOOLEAN)(SHA1_Init ((SHA_CTX *)Sha1Context));\r
}\r
\r
/**\r
  Makes a copy of an existing SHA-1 context.\r
\r
  If Sha1Context is NULL, then return FALSE.\r
  If NewSha1Context is NULL, then return FALSE.\r
\r
  @param[in]  Sha1Context     Pointer to SHA-1 context being copied.\r
  @param[out] NewSha1Context  Pointer to new SHA-1 context.\r
\r
  @retval TRUE   SHA-1 context copy succeeded.\r
  @retval FALSE  SHA-1 context copy failed.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
Sha1Duplicate (\r
  IN   CONST VOID  *Sha1Context,\r
  OUT  VOID        *NewSha1Context\r
  )\r
{\r
  //\r
  // Check input parameters.\r
  //\r
  if ((Sha1Context == NULL) || (NewSha1Context == NULL)) {\r
    return FALSE;\r
  }\r
\r
  CopyMem (NewSha1Context, Sha1Context, sizeof (SHA_CTX));\r
\r
  return TRUE;\r
}\r
\r
/**\r
  Digests the input data and updates SHA-1 context.\r
\r
  This function performs SHA-1 digest on a data buffer of the specified size.\r
  It can be called multiple times to compute the digest of long or discontinuous data streams.\r
  SHA-1 context should be already correctly initialized by Sha1Init(), and should not be finalized\r
  by Sha1Final(). Behavior with invalid context is undefined.\r
\r
  If Sha1Context is NULL, then return FALSE.\r
\r
  @param[in, out]  Sha1Context  Pointer to the SHA-1 context.\r
  @param[in]       Data         Pointer to the buffer containing the data to be hashed.\r
  @param[in]       DataSize     Size of Data buffer in bytes.\r
\r
  @retval TRUE   SHA-1 data digest succeeded.\r
  @retval FALSE  SHA-1 data digest failed.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
Sha1Update (\r
  IN OUT  VOID        *Sha1Context,\r
  IN      CONST VOID  *Data,\r
  IN      UINTN       DataSize\r
  )\r
{\r
  //\r
  // Check input parameters.\r
  //\r
  if (Sha1Context == NULL) {\r
    return FALSE;\r
  }\r
\r
  //\r
  // Check invalid parameters, in case that only DataLength was checked in OpenSSL\r
  //\r
  if ((Data == NULL) && (DataSize != 0)) {\r
    return FALSE;\r
  }\r
\r
  //\r
  // OpenSSL SHA-1 Hash Update\r
  //\r
  return (BOOLEAN)(SHA1_Update ((SHA_CTX *)Sha1Context, Data, DataSize));\r
}\r
\r
/**\r
  Completes computation of the SHA-1 digest value.\r
\r
  This function completes SHA-1 hash computation and retrieves the digest value into\r
  the specified memory. After this function has been called, the SHA-1 context cannot\r
  be used again.\r
  SHA-1 context should be already correctly initialized by Sha1Init(), and should not be\r
  finalized by Sha1Final(). Behavior with invalid SHA-1 context is undefined.\r
\r
  If Sha1Context is NULL, then return FALSE.\r
  If HashValue is NULL, then return FALSE.\r
\r
  @param[in, out]  Sha1Context  Pointer to the SHA-1 context.\r
  @param[out]      HashValue    Pointer to a buffer that receives the SHA-1 digest\r
                                value (20 bytes).\r
\r
  @retval TRUE   SHA-1 digest computation succeeded.\r
  @retval FALSE  SHA-1 digest computation failed.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
Sha1Final (\r
  IN OUT  VOID   *Sha1Context,\r
  OUT     UINT8  *HashValue\r
  )\r
{\r
  //\r
  // Check input parameters.\r
  //\r
  if ((Sha1Context == NULL) || (HashValue == NULL)) {\r
    return FALSE;\r
  }\r
\r
  //\r
  // OpenSSL SHA-1 Hash Finalization\r
  //\r
  return (BOOLEAN)(SHA1_Final (HashValue, (SHA_CTX *)Sha1Context));\r
}\r
\r
/**\r
  Computes the SHA-1 message digest of a input data buffer.\r
\r
  This function performs the SHA-1 message digest of a given data buffer, and places\r
  the digest value into the specified memory.\r
\r
  If this interface is not supported, then return FALSE.\r
\r
  @param[in]   Data        Pointer to the buffer containing the data to be hashed.\r
  @param[in]   DataSize    Size of Data buffer in bytes.\r
  @param[out]  HashValue   Pointer to a buffer that receives the SHA-1 digest\r
                           value (20 bytes).\r
\r
  @retval TRUE   SHA-1 digest computation succeeded.\r
  @retval FALSE  SHA-1 digest computation failed.\r
  @retval FALSE  This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
Sha1HashAll (\r
  IN   CONST VOID  *Data,\r
  IN   UINTN       DataSize,\r
  OUT  UINT8       *HashValue\r
  )\r
{\r
  //\r
  // Check input parameters.\r
  //\r
  if (HashValue == NULL) {\r
    return FALSE;\r
  }\r
\r
  if ((Data == NULL) && (DataSize != 0)) {\r
    return FALSE;\r
  }\r
\r
  //\r
  // OpenSSL SHA-1 Hash Computation.\r
  //\r
  if (SHA1 (Data, DataSize, HashValue) == NULL) {\r
    return FALSE;\r
  } else {\r
    return TRUE;\r
  }\r
}\r
\r
#endif\r