CryptoPkg/BaseCryptLib: replace HmacXxxInit API with HmacXxxSetKey

[mirror_edk2.git] / CryptoPkg / Library / BaseCryptLib / Hmac / CryptHmacSha256Null.c

/** @file\r
  HMAC-SHA256 Wrapper Implementation which does not provide real capabilities.\r
\r
Copyright (c) 2016 - 2017, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "InternalCryptLib.h"\r
\r
/**\r
  Retrieves the size, in bytes, of the context buffer required for HMAC-SHA256 operations.\r
  (NOTE: This API is deprecated.\r
         Use HmacSha256New() / HmacSha256Free() for HMAC-SHA256 Context operations.)\r
\r
  Return zero to indicate this interface is not supported.\r
\r
  @retval  0   This interface is not supported.\r
\r
**/\r
UINTN\r
EFIAPI\r
HmacSha256GetContextSize (\r
  VOID\r
  )\r
{\r
  ASSERT (FALSE);\r
  return 0;\r
}\r
\r
/**\r
  Allocates and initializes one HMAC_CTX context for subsequent HMAC-SHA256 use.\r
\r
  Return NULL to indicate this interface is not supported.\r
\r
  @return  NULL  This interface is not supported..\r
\r
**/\r
VOID *\r
EFIAPI\r
HmacSha256New (\r
  VOID\r
  )\r
{\r
  ASSERT (FALSE);\r
  return NULL;\r
}\r
\r
/**\r
  Release the specified HMAC_CTX context.\r
\r
  This function will do nothing.\r
\r
  @param[in]  HmacSha256Ctx  Pointer to the HMAC_CTX context to be released.\r
\r
**/\r
VOID\r
EFIAPI\r
HmacSha256Free (\r
  IN  VOID  *HmacSha256Ctx\r
  )\r
{\r
  ASSERT (FALSE);\r
  return;\r
}\r
\r
/**\r
  Set user-supplied key for subsequent use. It must be done before any\r
  calling to HmacSha256Update().\r
\r
  Return FALSE to indicate this interface is not supported.\r
\r
  @param[out]  HmacSha256Context  Pointer to HMAC-SHA256 context.\r
  @param[in]   Key                Pointer to the user-supplied key.\r
  @param[in]   KeySize            Key size in bytes.\r
\r
  @retval FALSE  This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
HmacSha256SetKey (\r
  OUT  VOID         *HmacSha256Context,\r
  IN   CONST UINT8  *Key,\r
  IN   UINTN        KeySize\r
  )\r
{\r
  ASSERT (FALSE);\r
  return FALSE;\r
}\r
\r
/**\r
  Makes a copy of an existing HMAC-SHA256 context.\r
\r
  Return FALSE to indicate this interface is not supported.\r
\r
  @param[in]  HmacSha256Context     Pointer to HMAC-SHA256 context being copied.\r
  @param[out] NewHmacSha256Context  Pointer to new HMAC-SHA256 context.\r
\r
  @retval FALSE  This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
HmacSha256Duplicate (\r
  IN   CONST VOID  *HmacSha256Context,\r
  OUT  VOID        *NewHmacSha256Context\r
  )\r
{\r
  ASSERT (FALSE);\r
  return FALSE;\r
}\r
\r
/**\r
  Digests the input data and updates HMAC-SHA256 context.\r
\r
  Return FALSE to indicate this interface is not supported.\r
\r
  @param[in, out]  HmacSha256Context Pointer to the HMAC-SHA256 context.\r
  @param[in]       Data              Pointer to the buffer containing the data to be digested.\r
  @param[in]       DataSize          Size of Data buffer in bytes.\r
\r
  @retval FALSE  This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
HmacSha256Update (\r
  IN OUT  VOID        *HmacSha256Context,\r
  IN      CONST VOID  *Data,\r
  IN      UINTN       DataSize\r
  )\r
{\r
  ASSERT (FALSE);\r
  return FALSE;\r
}\r
\r
/**\r
  Completes computation of the HMAC-SHA256 digest value.\r
\r
  Return FALSE to indicate this interface is not supported.\r
\r
  @param[in, out]  HmacSha256Context  Pointer to the HMAC-SHA256 context.\r
  @param[out]      HmacValue          Pointer to a buffer that receives the HMAC-SHA256 digest\r
                                      value (32 bytes).\r
\r
  @retval FALSE  This interface is not supported.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
HmacSha256Final (\r
  IN OUT  VOID   *HmacSha256Context,\r
  OUT     UINT8  *HmacValue\r
  )\r
{\r
  ASSERT (FALSE);\r
  return FALSE;\r
}\r