]>
git.proxmox.com Git - mirror_edk2.git/blob - CryptoPkg/Library/BaseCryptLib/Hash/CryptSha256.c
2 SHA-256 Digest Wrapper Implementation over OpenSSL.
4 Copyright (c) 2009 - 2016, 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/sha.h>
19 Retrieves the size, in bytes, of the context buffer required for SHA-256 hash operations.
21 @return The size, in bytes, of the context buffer required for SHA-256 hash operations.
26 Sha256GetContextSize (
31 // Retrieves OpenSSL SHA-256 Context Size
33 return (UINTN
) (sizeof (SHA256_CTX
));
37 Initializes user-supplied memory pointed by Sha256Context as SHA-256 hash context for
40 If Sha256Context is NULL, then return FALSE.
42 @param[out] Sha256Context Pointer to SHA-256 context being initialized.
44 @retval TRUE SHA-256 context initialization succeeded.
45 @retval FALSE SHA-256 context initialization failed.
51 OUT VOID
*Sha256Context
55 // Check input parameters.
57 if (Sha256Context
== NULL
) {
62 // OpenSSL SHA-256 Context Initialization
64 return (BOOLEAN
) (SHA256_Init ((SHA256_CTX
*) Sha256Context
));
68 Makes a copy of an existing SHA-256 context.
70 If Sha256Context is NULL, then return FALSE.
71 If NewSha256Context is NULL, then return FALSE.
73 @param[in] Sha256Context Pointer to SHA-256 context being copied.
74 @param[out] NewSha256Context Pointer to new SHA-256 context.
76 @retval TRUE SHA-256 context copy succeeded.
77 @retval FALSE SHA-256 context copy failed.
83 IN CONST VOID
*Sha256Context
,
84 OUT VOID
*NewSha256Context
88 // Check input parameters.
90 if (Sha256Context
== NULL
|| NewSha256Context
== NULL
) {
94 CopyMem (NewSha256Context
, Sha256Context
, sizeof (SHA256_CTX
));
100 Digests the input data and updates SHA-256 context.
102 This function performs SHA-256 digest on a data buffer of the specified size.
103 It can be called multiple times to compute the digest of long or discontinuous data streams.
104 SHA-256 context should be already correctly intialized by Sha256Init(), and should not be finalized
105 by Sha256Final(). Behavior with invalid context is undefined.
107 If Sha256Context is NULL, then return FALSE.
109 @param[in, out] Sha256Context Pointer to the SHA-256 context.
110 @param[in] Data Pointer to the buffer containing the data to be hashed.
111 @param[in] DataSize Size of Data buffer in bytes.
113 @retval TRUE SHA-256 data digest succeeded.
114 @retval FALSE SHA-256 data digest failed.
120 IN OUT VOID
*Sha256Context
,
126 // Check input parameters.
128 if (Sha256Context
== NULL
) {
133 // Check invalid parameters, in case that only DataLength was checked in OpenSSL
135 if (Data
== NULL
&& DataSize
!= 0) {
140 // OpenSSL SHA-256 Hash Update
142 return (BOOLEAN
) (SHA256_Update ((SHA256_CTX
*) Sha256Context
, Data
, DataSize
));
146 Completes computation of the SHA-256 digest value.
148 This function completes SHA-256 hash computation and retrieves the digest value into
149 the specified memory. After this function has been called, the SHA-256 context cannot
151 SHA-256 context should be already correctly intialized by Sha256Init(), and should not be
152 finalized by Sha256Final(). Behavior with invalid SHA-256 context is undefined.
154 If Sha256Context is NULL, then return FALSE.
155 If HashValue is NULL, then return FALSE.
157 @param[in, out] Sha256Context Pointer to the SHA-256 context.
158 @param[out] HashValue Pointer to a buffer that receives the SHA-256 digest
161 @retval TRUE SHA-256 digest computation succeeded.
162 @retval FALSE SHA-256 digest computation failed.
168 IN OUT VOID
*Sha256Context
,
173 // Check input parameters.
175 if (Sha256Context
== NULL
|| HashValue
== NULL
) {
180 // OpenSSL SHA-256 Hash Finalization
182 return (BOOLEAN
) (SHA256_Final (HashValue
, (SHA256_CTX
*) Sha256Context
));
186 Computes the SHA-256 message digest of a input data buffer.
188 This function performs the SHA-256 message digest of a given data buffer, and places
189 the digest value into the specified memory.
191 If this interface is not supported, then return FALSE.
193 @param[in] Data Pointer to the buffer containing the data to be hashed.
194 @param[in] DataSize Size of Data buffer in bytes.
195 @param[out] HashValue Pointer to a buffer that receives the SHA-256 digest
198 @retval TRUE SHA-256 digest computation succeeded.
199 @retval FALSE SHA-256 digest computation failed.
200 @retval FALSE This interface is not supported.
212 // Check input parameters.
214 if (HashValue
== NULL
) {
217 if (Data
== NULL
&& DataSize
!= 0) {
222 // OpenSSL SHA-256 Hash Computation.
224 if (SHA256 (Data
, DataSize
, HashValue
) == NULL
) {