]>
git.proxmox.com Git - mirror_edk2.git/blob - CryptoPkg/Library/BaseCryptLib/Hmac/CryptHmacSha1.c
2 HMAC-SHA1 Wrapper Implementation over OpenSSL.
4 Copyright (c) 2010 - 2012, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #include "InternalCryptLib.h"
16 #include <openssl/hmac.h>
19 Retrieves the size, in bytes, of the context buffer required for HMAC-SHA1 operations.
21 @return The size, in bytes, of the context buffer required for HMAC-SHA1 operations.
26 HmacSha1GetContextSize (
31 // Retrieves the OpenSSL HMAC-SHA1 Context Size
33 return (UINTN
) (sizeof (HMAC_CTX
));
37 Initializes user-supplied memory pointed by HmacSha1Context as HMAC-SHA1 context for
40 If HmacSha1Context is NULL, then return FALSE.
42 @param[out] HmacSha1Context Pointer to HMAC-SHA1 context being initialized.
43 @param[in] Key Pointer to the user-supplied key.
44 @param[in] KeySize Key size in bytes.
46 @retval TRUE HMAC-SHA1 context initialization succeeded.
47 @retval FALSE HMAC-SHA1 context initialization failed.
53 OUT VOID
*HmacSha1Context
,
59 // Check input parameters.
61 if (HmacSha1Context
== NULL
|| KeySize
> INT_MAX
) {
66 // OpenSSL HMAC-SHA1 Context Initialization
68 HMAC_CTX_init (HmacSha1Context
);
69 HMAC_Init_ex (HmacSha1Context
, Key
, (UINT32
) KeySize
, EVP_sha1(), NULL
);
75 Makes a copy of an existing HMAC-SHA1 context.
77 If HmacSha1Context is NULL, then return FALSE.
78 If NewHmacSha1Context is NULL, then return FALSE.
80 @param[in] HmacSha1Context Pointer to HMAC-SHA1 context being copied.
81 @param[out] NewHmacSha1Context Pointer to new HMAC-SHA1 context.
83 @retval TRUE HMAC-SHA1 context copy succeeded.
84 @retval FALSE HMAC-SHA1 context copy failed.
90 IN CONST VOID
*HmacSha1Context
,
91 OUT VOID
*NewHmacSha1Context
95 // Check input parameters.
97 if (HmacSha1Context
== NULL
|| NewHmacSha1Context
== NULL
) {
101 CopyMem (NewHmacSha1Context
, HmacSha1Context
, sizeof (HMAC_CTX
));
107 Digests the input data and updates HMAC-SHA1 context.
109 This function performs HMAC-SHA1 digest on a data buffer of the specified size.
110 It can be called multiple times to compute the digest of long or discontinuous data streams.
111 HMAC-SHA1 context should be already correctly initialized by HmacSha1Init(), and should not
112 be finalized by HmacSha1Final(). Behavior with invalid context is undefined.
114 If HmacSha1Context is NULL, then return FALSE.
116 @param[in, out] HmacSha1Context Pointer to the HMAC-SHA1 context.
117 @param[in] Data Pointer to the buffer containing the data to be digested.
118 @param[in] DataSize Size of Data buffer in bytes.
120 @retval TRUE HMAC-SHA1 data digest succeeded.
121 @retval FALSE HMAC-SHA1 data digest failed.
127 IN OUT VOID
*HmacSha1Context
,
133 // Check input parameters.
135 if (HmacSha1Context
== NULL
) {
140 // Check invalid parameters, in case that only DataLength was checked in OpenSSL
142 if (Data
== NULL
&& DataSize
!= 0) {
147 // OpenSSL HMAC-SHA1 digest update
149 HMAC_Update (HmacSha1Context
, Data
, DataSize
);
155 Completes computation of the HMAC-SHA1 digest value.
157 This function completes HMAC-SHA1 digest computation and retrieves the digest value into
158 the specified memory. After this function has been called, the HMAC-SHA1 context cannot
160 HMAC-SHA1 context should be already correctly initialized by HmacSha1Init(), and should
161 not be finalized by HmacSha1Final(). Behavior with invalid HMAC-SHA1 context is undefined.
163 If HmacSha1Context is NULL, then return FALSE.
164 If HmacValue is NULL, then return FALSE.
166 @param[in, out] HmacSha1Context Pointer to the HMAC-SHA1 context.
167 @param[out] HmacValue Pointer to a buffer that receives the HMAC-SHA1 digest
170 @retval TRUE HMAC-SHA1 digest computation succeeded.
171 @retval FALSE HMAC-SHA1 digest computation failed.
177 IN OUT VOID
*HmacSha1Context
,
184 // Check input parameters.
186 if (HmacSha1Context
== NULL
|| HmacValue
== NULL
) {
191 // OpenSSL HMAC-SHA1 digest finalization
193 HMAC_Final (HmacSha1Context
, HmacValue
, &Length
);
194 HMAC_CTX_cleanup (HmacSha1Context
);