TianoCore EDK2 master
Loading...
Searching...
No Matches
CryptSha512.c File Reference
#include "InternalCryptLib.h"
#include <mbedtls/sha512.h>

Go to the source code of this file.

Functions

UINTN EFIAPI Sha384GetContextSize (VOID)
 
BOOLEAN EFIAPI Sha384Init (OUT VOID *Sha384Context)
 
BOOLEAN EFIAPI Sha384Duplicate (IN CONST VOID *Sha384Context, OUT VOID *NewSha384Context)
 
BOOLEAN EFIAPI Sha384Update (IN OUT VOID *Sha384Context, IN CONST VOID *Data, IN UINTN DataSize)
 
BOOLEAN EFIAPI Sha384Final (IN OUT VOID *Sha384Context, OUT UINT8 *HashValue)
 
BOOLEAN EFIAPI Sha384HashAll (IN CONST VOID *Data, IN UINTN DataSize, OUT UINT8 *HashValue)
 
UINTN EFIAPI Sha512GetContextSize (VOID)
 
BOOLEAN EFIAPI Sha512Init (OUT VOID *Sha512Context)
 
BOOLEAN EFIAPI Sha512Duplicate (IN CONST VOID *Sha512Context, OUT VOID *NewSha512Context)
 
BOOLEAN EFIAPI Sha512Update (IN OUT VOID *Sha512Context, IN CONST VOID *Data, IN UINTN DataSize)
 
BOOLEAN EFIAPI Sha512Final (IN OUT VOID *Sha512Context, OUT UINT8 *HashValue)
 
BOOLEAN EFIAPI Sha512HashAll (IN CONST VOID *Data, IN UINTN DataSize, OUT UINT8 *HashValue)
 

Detailed Description

SHA-384 and SHA-512 Digest Wrapper Implementations over MbedTLS.

Copyright (c) 2023, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file CryptSha512.c.

Function Documentation

◆ Sha384Duplicate()

BOOLEAN EFIAPI Sha384Duplicate ( IN CONST VOID *  Sha384Context,
OUT VOID *  NewSha384Context 
)

Makes a copy of an existing SHA-384 context.

If Sha384Context is NULL, then return FALSE. If NewSha384Context is NULL, then return FALSE. If this interface is not supported, then return FALSE.

Parameters
[in]Sha384ContextPointer to SHA-384 context being copied.
[out]NewSha384ContextPointer to new SHA-384 context.
Return values
TRUESHA-384 context copy succeeded.
FALSESHA-384 context copy failed.
FALSEThis interface is not supported.

Definition at line 78 of file CryptSha512.c.

◆ Sha384Final()

BOOLEAN EFIAPI Sha384Final ( IN OUT VOID *  Sha384Context,
OUT UINT8 *  HashValue 
)

Completes computation of the SHA-384 digest value.

This function completes SHA-384 hash computation and retrieves the digest value into the specified memory. After this function has been called, the SHA-384 context cannot be used again. SHA-384 context should be already correctly initialized by Sha384Init(), and should not be finalized by Sha384Final(). Behavior with invalid SHA-384 context is undefined.

If Sha384Context is NULL, then return FALSE. If HashValue is NULL, then return FALSE.

Parameters
[in,out]Sha384ContextPointer to the SHA-384 context.
[out]HashValuePointer to a buffer that receives the SHA-384 digest value (48 bytes).
Return values
TRUESHA-384 digest computation succeeded.
FALSESHA-384 digest computation failed.

Definition at line 158 of file CryptSha512.c.

◆ Sha384GetContextSize()

UINTN EFIAPI Sha384GetContextSize ( VOID  )

Retrieves the size, in bytes, of the context buffer required for SHA-384 hash operations.

Returns
The size, in bytes, of the context buffer required for SHA-384 hash operations.

Definition at line 20 of file CryptSha512.c.

◆ Sha384HashAll()

BOOLEAN EFIAPI Sha384HashAll ( IN CONST VOID *  Data,
IN UINTN  DataSize,
OUT UINT8 *  HashValue 
)

Computes the SHA-384 message digest of a input data buffer.

This function performs the SHA-384 message digest of a given data buffer, and places the digest value into the specified memory.

If this interface is not supported, then return FALSE.

Parameters
[in]DataPointer to the buffer containing the data to be hashed.
[in]DataSizeSize of Data buffer in bytes.
[out]HashValuePointer to a buffer that receives the SHA-384 digest value (48 bytes).
Return values
TRUESHA-384 digest computation succeeded.
FALSESHA-384 digest computation failed.
FALSEThis interface is not supported.

Definition at line 198 of file CryptSha512.c.

◆ Sha384Init()

BOOLEAN EFIAPI Sha384Init ( OUT VOID *  Sha384Context)

Initializes user-supplied memory pointed by Sha384Context as SHA-384 hash context for subsequent use.

If Sha384Context is NULL, then return FALSE.

Parameters
[out]Sha384ContextPointer to SHA-384 context being initialized.
Return values
TRUESHA-384 context initialization succeeded.
FALSESHA-384 context initialization failed.

Definition at line 41 of file CryptSha512.c.

◆ Sha384Update()

BOOLEAN EFIAPI Sha384Update ( IN OUT VOID *  Sha384Context,
IN CONST VOID *  Data,
IN UINTN  DataSize 
)

Digests the input data and updates SHA-384 context.

This function performs SHA-384 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. SHA-384 context should be already correctly initialized by Sha384Init(), and should not be finalized by Sha384Final(). Behavior with invalid context is undefined.

If Sha384Context is NULL, then return FALSE.

Parameters
[in,out]Sha384ContextPointer to the SHA-384 context.
[in]DataPointer to the buffer containing the data to be hashed.
[in]DataSizeSize of Data buffer in bytes.
Return values
TRUESHA-384 data digest succeeded.
FALSESHA-384 data digest failed.

Definition at line 112 of file CryptSha512.c.

◆ Sha512Duplicate()

BOOLEAN EFIAPI Sha512Duplicate ( IN CONST VOID *  Sha512Context,
OUT VOID *  NewSha512Context 
)

Makes a copy of an existing SHA-512 context.

If Sha512Context is NULL, then return FALSE. If NewSha512Context is NULL, then return FALSE. If this interface is not supported, then return FALSE.

Parameters
[in]Sha512ContextPointer to SHA-512 context being copied.
[out]NewSha512ContextPointer to new SHA-512 context.
Return values
TRUESHA-512 context copy succeeded.
FALSESHA-512 context copy failed.
FALSEThis interface is not supported.

Definition at line 288 of file CryptSha512.c.

◆ Sha512Final()

BOOLEAN EFIAPI Sha512Final ( IN OUT VOID *  Sha512Context,
OUT UINT8 *  HashValue 
)

Completes computation of the SHA-512 digest value.

This function completes SHA-512 hash computation and retrieves the digest value into the specified memory. After this function has been called, the SHA-512 context cannot be used again. SHA-512 context should be already correctly initialized by Sha512Init(), and should not be finalized by Sha512Final(). Behavior with invalid SHA-512 context is undefined.

If Sha512Context is NULL, then return FALSE. If HashValue is NULL, then return FALSE.

Parameters
[in,out]Sha512ContextPointer to the SHA-512 context.
[out]HashValuePointer to a buffer that receives the SHA-512 digest value (64 bytes).
Return values
TRUESHA-512 digest computation succeeded.
FALSESHA-512 digest computation failed.

Definition at line 368 of file CryptSha512.c.

◆ Sha512GetContextSize()

UINTN EFIAPI Sha512GetContextSize ( VOID  )

Retrieves the size, in bytes, of the context buffer required for SHA-512 hash operations.

Returns
The size, in bytes, of the context buffer required for SHA-512 hash operations.

Definition at line 230 of file CryptSha512.c.

◆ Sha512HashAll()

BOOLEAN EFIAPI Sha512HashAll ( IN CONST VOID *  Data,
IN UINTN  DataSize,
OUT UINT8 *  HashValue 
)

Computes the SHA-512 message digest of a input data buffer.

This function performs the SHA-512 message digest of a given data buffer, and places the digest value into the specified memory.

If this interface is not supported, then return FALSE.

Parameters
[in]DataPointer to the buffer containing the data to be hashed.
[in]DataSizeSize of Data buffer in bytes.
[out]HashValuePointer to a buffer that receives the SHA-512 digest value (64 bytes).
Return values
TRUESHA-512 digest computation succeeded.
FALSESHA-512 digest computation failed.
FALSEThis interface is not supported.

Definition at line 408 of file CryptSha512.c.

◆ Sha512Init()

BOOLEAN EFIAPI Sha512Init ( OUT VOID *  Sha512Context)

Initializes user-supplied memory pointed by Sha512Context as SHA-512 hash context for subsequent use.

If Sha512Context is NULL, then return FALSE.

Parameters
[out]Sha512ContextPointer to SHA-512 context being initialized.
Return values
TRUESHA-512 context initialization succeeded.
FALSESHA-512 context initialization failed.

Definition at line 251 of file CryptSha512.c.

◆ Sha512Update()

BOOLEAN EFIAPI Sha512Update ( IN OUT VOID *  Sha512Context,
IN CONST VOID *  Data,
IN UINTN  DataSize 
)

Digests the input data and updates SHA-512 context.

This function performs SHA-512 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. SHA-512 context should be already correctly initialized by Sha512Init(), and should not be finalized by Sha512Final(). Behavior with invalid context is undefined.

If Sha512Context is NULL, then return FALSE.

Parameters
[in,out]Sha512ContextPointer to the SHA-512 context.
[in]DataPointer to the buffer containing the data to be hashed.
[in]DataSizeSize of Data buffer in bytes.
Return values
TRUESHA-512 data digest succeeded.
FALSESHA-512 data digest failed.

Definition at line 322 of file CryptSha512.c.