CryptoPkg: Add new hmac SHA api to Crypto Service.
REF: https://bugzilla.tianocore.org/show_bug.cgi?id=4025 Signed-off-by: Qi Zhang <qi1.zhang@intel.com> Cc: Jiewen Yao <jiewen.yao@intel.com> Cc: Jian J Wang <jian.j.wang@intel.com> Cc: Xiaoyu Lu <xiaoyu1.lu@intel.com> Cc: Guomin Jiang <guomin.jiang@intel.com> Reviewed-by: Jiewen Yao <jiewen.yao@intel.com>
This commit is contained in:
Qi Zhang
mergify[bot]
@ -1201,6 +1201,218 @@ HmacSha256Final (
|
||||
CALL_CRYPTO_SERVICE (HmacSha256Final, (HmacSha256Context, HmacValue), FALSE);
|
||||
}
|
||||
|
||||
/**
|
||||
Computes the HMAC-SHA256 digest of a input data buffer.
|
||||
|
||||
This function performs the HMAC-SHA256 digest of a given data buffer, and places
|
||||
the digest value into the specified memory.
|
||||
|
||||
If this interface is not supported, then return FALSE.
|
||||
|
||||
@param[in] Data Pointer to the buffer containing the data to be digested.
|
||||
@param[in] DataSize Size of Data buffer in bytes.
|
||||
@param[in] Key Pointer to the user-supplied key.
|
||||
@param[in] KeySize Key size in bytes.
|
||||
@param[out] HmacValue Pointer to a buffer that receives the HMAC-SHA256 digest
|
||||
value (32 bytes).
|
||||
|
||||
@retval TRUE HMAC-SHA256 digest computation succeeded.
|
||||
@retval FALSE HMAC-SHA256 digest computation failed.
|
||||
@retval FALSE This interface is not supported.
|
||||
|
||||
**/
|
||||
BOOLEAN
|
||||
EFIAPI
|
||||
HmacSha256All (
|
||||
IN CONST VOID *Data,
|
||||
IN UINTN DataSize,
|
||||
IN CONST UINT8 *Key,
|
||||
IN UINTN KeySize,
|
||||
OUT UINT8 *HmacValue
|
||||
)
|
||||
{
|
||||
CALL_CRYPTO_SERVICE (HmacSha256All, (Data, DataSize, Key, KeySize, HmacValue), FALSE);
|
||||
}
|
||||
|
||||
/**
|
||||
Allocates and initializes one HMAC_CTX context for subsequent HMAC-SHA384 use.
|
||||
|
||||
@return Pointer to the HMAC_CTX context that has been initialized.
|
||||
If the allocations fails, HmacSha384New() returns NULL.
|
||||
|
||||
**/
|
||||
VOID *
|
||||
EFIAPI
|
||||
HmacSha384New (
|
||||
VOID
|
||||
)
|
||||
{
|
||||
CALL_CRYPTO_SERVICE (HmacSha384New, (), NULL);
|
||||
}
|
||||
|
||||
/**
|
||||
Release the specified HMAC_CTX context.
|
||||
|
||||
@param[in] HmacSha384Ctx Pointer to the HMAC_CTX context to be released.
|
||||
|
||||
**/
|
||||
VOID
|
||||
EFIAPI
|
||||
HmacSha384Free (
|
||||
IN VOID *HmacSha384Ctx
|
||||
)
|
||||
{
|
||||
CALL_VOID_CRYPTO_SERVICE (HmacSha384Free, (HmacSha384Ctx));
|
||||
}
|
||||
|
||||
/**
|
||||
Set user-supplied key for subsequent use. It must be done before any
|
||||
calling to HmacSha384Update().
|
||||
|
||||
If HmacSha384Context is NULL, then return FALSE.
|
||||
If this interface is not supported, then return FALSE.
|
||||
|
||||
@param[out] HmacSha384Context Pointer to HMAC-SHA384 context.
|
||||
@param[in] Key Pointer to the user-supplied key.
|
||||
@param[in] KeySize Key size in bytes.
|
||||
|
||||
@retval TRUE The Key is set successfully.
|
||||
@retval FALSE The Key is set unsuccessfully.
|
||||
@retval FALSE This interface is not supported.
|
||||
|
||||
**/
|
||||
BOOLEAN
|
||||
EFIAPI
|
||||
HmacSha384SetKey (
|
||||
OUT VOID *HmacSha384Context,
|
||||
IN CONST UINT8 *Key,
|
||||
IN UINTN KeySize
|
||||
)
|
||||
{
|
||||
CALL_CRYPTO_SERVICE (HmacSha384SetKey, (HmacSha384Context, Key, KeySize), FALSE);
|
||||
}
|
||||
|
||||
/**
|
||||
Makes a copy of an existing HMAC-SHA384 context.
|
||||
|
||||
If HmacSha384Context is NULL, then return FALSE.
|
||||
If NewHmacSha384Context is NULL, then return FALSE.
|
||||
If this interface is not supported, then return FALSE.
|
||||
|
||||
@param[in] HmacSha384Context Pointer to HMAC-SHA384 context being copied.
|
||||
@param[out] NewHmacSha384Context Pointer to new HMAC-SHA384 context.
|
||||
|
||||
@retval TRUE HMAC-SHA384 context copy succeeded.
|
||||
@retval FALSE HMAC-SHA384 context copy failed.
|
||||
@retval FALSE This interface is not supported.
|
||||
|
||||
**/
|
||||
BOOLEAN
|
||||
EFIAPI
|
||||
HmacSha384Duplicate (
|
||||
IN CONST VOID *HmacSha384Context,
|
||||
OUT VOID *NewHmacSha384Context
|
||||
)
|
||||
{
|
||||
CALL_CRYPTO_SERVICE (HmacSha384Duplicate, (HmacSha384Context, NewHmacSha384Context), FALSE);
|
||||
}
|
||||
|
||||
/**
|
||||
Digests the input data and updates HMAC-SHA384 context.
|
||||
|
||||
This function performs HMAC-SHA384 digest on a data buffer of the specified size.
|
||||
It can be called multiple times to compute the digest of long or discontinuous data streams.
|
||||
HMAC-SHA384 context should be initialized by HmacSha384New(), and should not be finalized
|
||||
by HmacSha384Final(). Behavior with invalid context is undefined.
|
||||
|
||||
If HmacSha384Context is NULL, then return FALSE.
|
||||
If this interface is not supported, then return FALSE.
|
||||
|
||||
@param[in, out] HmacSha384Context Pointer to the HMAC-SHA384 context.
|
||||
@param[in] Data Pointer to the buffer containing the data to be digested.
|
||||
@param[in] DataSize Size of Data buffer in bytes.
|
||||
|
||||
@retval TRUE HMAC-SHA384 data digest succeeded.
|
||||
@retval FALSE HMAC-SHA384 data digest failed.
|
||||
@retval FALSE This interface is not supported.
|
||||
|
||||
**/
|
||||
BOOLEAN
|
||||
EFIAPI
|
||||
HmacSha384Update (
|
||||
IN OUT VOID *HmacSha384Context,
|
||||
IN CONST VOID *Data,
|
||||
IN UINTN DataSize
|
||||
)
|
||||
{
|
||||
CALL_CRYPTO_SERVICE (HmacSha384Update, (HmacSha384Context, Data, DataSize), FALSE);
|
||||
}
|
||||
|
||||
/**
|
||||
Completes computation of the HMAC-SHA384 digest value.
|
||||
|
||||
This function completes HMAC-SHA384 hash computation and retrieves the digest value into
|
||||
the specified memory. After this function has been called, the HMAC-SHA384 context cannot
|
||||
be used again.
|
||||
HMAC-SHA384 context should be initialized by HmacSha384New(), and should not be finalized
|
||||
by HmacSha384Final(). Behavior with invalid HMAC-SHA384 context is undefined.
|
||||
|
||||
If HmacSha384Context is NULL, then return FALSE.
|
||||
If HmacValue is NULL, then return FALSE.
|
||||
If this interface is not supported, then return FALSE.
|
||||
|
||||
@param[in, out] HmacSha384Context Pointer to the HMAC-SHA384 context.
|
||||
@param[out] HmacValue Pointer to a buffer that receives the HMAC-SHA384 digest
|
||||
value (48 bytes).
|
||||
|
||||
@retval TRUE HMAC-SHA384 digest computation succeeded.
|
||||
@retval FALSE HMAC-SHA384 digest computation failed.
|
||||
@retval FALSE This interface is not supported.
|
||||
|
||||
**/
|
||||
BOOLEAN
|
||||
EFIAPI
|
||||
HmacSha384Final (
|
||||
IN OUT VOID *HmacSha384Context,
|
||||
OUT UINT8 *HmacValue
|
||||
)
|
||||
{
|
||||
CALL_CRYPTO_SERVICE (HmacSha384Final, (HmacSha384Context, HmacValue), FALSE);
|
||||
}
|
||||
|
||||
/**
|
||||
Computes the HMAC-SHA384 digest of a input data buffer.
|
||||
|
||||
This function performs the HMAC-SHA384 digest of a given data buffer, and places
|
||||
the digest value into the specified memory.
|
||||
|
||||
If this interface is not supported, then return FALSE.
|
||||
|
||||
@param[in] Data Pointer to the buffer containing the data to be digested.
|
||||
@param[in] DataSize Size of Data buffer in bytes.
|
||||
@param[in] Key Pointer to the user-supplied key.
|
||||
@param[in] KeySize Key size in bytes.
|
||||
@param[out] HmacValue Pointer to a buffer that receives the HMAC-SHA384 digest
|
||||
value (48 bytes).
|
||||
|
||||
@retval TRUE HMAC-SHA384 digest computation succeeded.
|
||||
@retval FALSE HMAC-SHA384 digest computation failed.
|
||||
@retval FALSE This interface is not supported.
|
||||
|
||||
**/
|
||||
BOOLEAN
|
||||
EFIAPI
|
||||
HmacSha384All (
|
||||
IN CONST VOID *Data,
|
||||
IN UINTN DataSize,
|
||||
IN CONST UINT8 *Key,
|
||||
IN UINTN KeySize,
|
||||
OUT UINT8 *HmacValue
|
||||
)
|
||||
{
|
||||
CALL_CRYPTO_SERVICE (HmacSha384All, (Data, DataSize, Key, KeySize, HmacValue), FALSE);
|
||||
}
|
||||
|
||||
// =====================================================================================
|
||||
// Symmetric Cryptography Primitive
|
||||
// =====================================================================================
|
||||
|
||||
Reference in New Issue
Block a user