CryptoPkg: Replace BSD License with BSD+Patent License

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

/** @file\r
  MD5 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/md5.h>\r
\r
\r
/**\r
  Retrieves the size, in bytes, of the context buffer required for MD5 hash operations.\r
\r
  @return  The size, in bytes, of the context buffer required for MD5 hash operations.\r
\r
**/\r
UINTN\r
EFIAPI\r
Md5GetContextSize (\r
  VOID\r
  )\r
{\r
  //\r
  // Retrieves the OpenSSL MD5 Context Size\r
  //\r
  return (UINTN) (sizeof (MD5_CTX));\r
}\r
\r
\r
/**\r
  Initializes user-supplied memory pointed by Md5Context as MD5 hash context for\r
  subsequent use.\r
\r
  If Md5Context is NULL, then return FALSE.\r
\r
  @param[out]  Md5Context  Pointer to MD5 context being initialized.\r
\r
  @retval TRUE   MD5 context initialization succeeded.\r
  @retval FALSE  MD5 context initialization failed.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
Md5Init (\r
  OUT  VOID  *Md5Context\r
  )\r
{\r
  //\r
  // Check input parameters.\r
  //\r
  if (Md5Context == NULL) {\r
    return FALSE;\r
  }\r
\r
  //\r
  // OpenSSL MD5 Context Initialization\r
  //\r
  return (BOOLEAN) (MD5_Init ((MD5_CTX *) Md5Context));\r
}\r
\r
/**\r
  Makes a copy of an existing MD5 context.\r
\r
  If Md5Context is NULL, then return FALSE.\r
  If NewMd5Context is NULL, then return FALSE.\r
\r
  @param[in]  Md5Context     Pointer to MD5 context being copied.\r
  @param[out] NewMd5Context  Pointer to new MD5 context.\r
\r
  @retval TRUE   MD5 context copy succeeded.\r
  @retval FALSE  MD5 context copy failed.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
Md5Duplicate (\r
  IN   CONST VOID  *Md5Context,\r
  OUT  VOID        *NewMd5Context\r
  )\r
{\r
  //\r
  // Check input parameters.\r
  //\r
  if (Md5Context == NULL || NewMd5Context == NULL) {\r
    return FALSE;\r
  }\r
\r
  CopyMem (NewMd5Context, Md5Context, sizeof (MD5_CTX));\r
\r
  return TRUE;\r
}\r
\r
/**\r
  Digests the input data and updates MD5 context.\r
\r
  This function performs MD5 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
  MD5 context should be already correctly initialized by Md5Init(), and should not be finalized\r
  by Md5Final(). Behavior with invalid context is undefined.\r
\r
  If Md5Context is NULL, then return FALSE.\r
\r
  @param[in, out]  Md5Context  Pointer to the MD5 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   MD5 data digest succeeded.\r
  @retval FALSE  MD5 data digest failed.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
Md5Update (\r
  IN OUT  VOID        *Md5Context,\r
  IN      CONST VOID  *Data,\r
  IN      UINTN       DataSize\r
  )\r
{\r
  //\r
  // Check input parameters.\r
  //\r
  if (Md5Context == 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 MD5 Hash Update\r
  //\r
  return (BOOLEAN) (MD5_Update ((MD5_CTX *) Md5Context, Data, DataSize));\r
}\r
\r
/**\r
  Completes computation of the MD5 digest value.\r
\r
  This function completes MD5 hash computation and retrieves the digest value into\r
  the specified memory. After this function has been called, the MD5 context cannot\r
  be used again.\r
  MD5 context should be already correctly initialized by Md5Init(), and should not be\r
  finalized by Md5Final(). Behavior with invalid MD5 context is undefined.\r
\r
  If Md5Context is NULL, then return FALSE.\r
  If HashValue is NULL, then return FALSE.\r
\r
  @param[in, out]  Md5Context  Pointer to the MD5 context.\r
  @param[out]      HashValue   Pointer to a buffer that receives the MD5 digest\r
                               value (16 bytes).\r
\r
  @retval TRUE   MD5 digest computation succeeded.\r
  @retval FALSE  MD5 digest computation failed.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
Md5Final (\r
  IN OUT  VOID   *Md5Context,\r
  OUT     UINT8  *HashValue\r
  )\r
{\r
  //\r
  // Check input parameters.\r
  //\r
  if (Md5Context == NULL || HashValue == NULL) {\r
    return FALSE;\r
  }\r
\r
  //\r
  // OpenSSL MD5 Hash Finalization\r
  //\r
  return (BOOLEAN) (MD5_Final (HashValue, (MD5_CTX *) Md5Context));\r
}\r
\r
/**\r
  Computes the MD5 message digest of a input data buffer.\r
\r
  This function performs the MD5 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 MD5 digest\r
                           value (16 bytes).\r
\r
  @retval TRUE   MD5 digest computation succeeded.\r
  @retval FALSE  MD5 digest computation failed.\r
  @retval FALSE  This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
Md5HashAll (\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
  if (Data == NULL && (DataSize != 0)) {\r
    return FALSE;\r
  }\r
\r
  //\r
  // OpenSSL MD5 Hash Computation.\r
  //\r
  if (MD5 (Data, DataSize, HashValue) == NULL) {\r
    return FALSE;\r
  } else {\r
    return TRUE;\r
  }\r
}\r