File sha512.h

This file contains SHA-384 and SHA-512 definitions and functions.

The Secure Hash Algorithms 384 and 512 (SHA-384 and SHA-512) cryptographic hash functions are defined in FIPS 180-4: Secure Hash Standard (SHS).

Defines

MBEDTLS_ERR_SHA512_BAD_INPUT_DATA: SHA-512 input data was malformed.

Typedefs

typedef struct mbedtls_sha512_context mbedtls_sha512_context

The SHA-512 context structure.

            The structure is used both for SHA-384 and for SHA-512
            checksum calculations. The choice between these two is
            made in the call to mbedtls_sha512_starts().

Functions

void mbedtls_sha512_init(mbedtls_sha512_context *ctx)

This function initializes a SHA-512 context.

Parameters:: ctx – The SHA-512 context to initialize. This must not be NULL.

void mbedtls_sha512_free(mbedtls_sha512_context *ctx)

This function clears a SHA-512 context.

Parameters:: ctx – The SHA-512 context to clear. This may be NULL, in which case this function does nothing. If it is not NULL, it must point to an initialized SHA-512 context.

void mbedtls_sha512_clone(mbedtls_sha512_context *dst, const mbedtls_sha512_context *src)

This function clones the state of a SHA-512 context.

Parameters:

dst – The destination context. This must be initialized.
src – The context to clone. This must be initialized.

int mbedtls_sha512_starts(mbedtls_sha512_context *ctx, int is384)

This function starts a SHA-384 or SHA-512 checksum calculation.

Note

is384 must be defined accordingly to the enabled MBEDTLS_SHA384_C/MBEDTLS_SHA512_C symbols otherwise the function will return MBEDTLS_ERR_SHA512_BAD_INPUT_DATA.

Parameters:

ctx – The SHA-512 context to use. This must be initialized.
is384 – Determines which function to use. This must be either 0 for SHA-512, or 1 for SHA-384.

Returns:

0 on success.

Returns:

A negative error code on failure.

int mbedtls_sha512_update(mbedtls_sha512_context *ctx, const unsigned char *input, size_t ilen)

This function feeds an input buffer into an ongoing SHA-512 checksum calculation.

Parameters:

ctx – The SHA-512 context. This must be initialized and have a hash operation started.
input – The buffer holding the input data. This must be a readable buffer of length ilen Bytes.
ilen – The length of the input data in Bytes.

Returns:

0 on success.

Returns:

A negative error code on failure.

int mbedtls_sha512_finish(mbedtls_sha512_context *ctx, unsigned char *output)

This function finishes the SHA-512 operation, and writes the result to the output buffer.

Parameters:

ctx – The SHA-512 context. This must be initialized and have a hash operation started.
output – The SHA-384 or SHA-512 checksum result. This must be a writable buffer of length 64 bytes for SHA-512, 48 bytes for SHA-384.

Returns:

0 on success.

Returns:

A negative error code on failure.

int mbedtls_sha512(const unsigned char *input, size_t ilen, unsigned char *output, int is384)

This function calculates the SHA-512 or SHA-384 checksum of a buffer.

The function allocates the context, performs the calculation, and frees the context.

The SHA-512 result is calculated as output = SHA-512(input buffer).

Note

is384 must be defined accordingly with the supported symbols in the config file. If:

is384 is 0, but MBEDTLS_SHA384_C is not defined, or
is384 is 1, but MBEDTLS_SHA512_C is not defined then the function will return MBEDTLS_ERR_SHA512_BAD_INPUT_DATA.

Parameters:

input – The buffer holding the input data. This must be a readable buffer of length ilen Bytes.
ilen – The length of the input data in Bytes.
output – The SHA-384 or SHA-512 checksum result. This must be a writable buffer of length 64 bytes for SHA-512, 48 bytes for SHA-384.
is384 – Determines which function to use. This must be either 0 for SHA-512, or 1 for SHA-384.

Returns:

0 on success.

Returns:

A negative error code on failure.

int mbedtls_sha384_self_test(int verbose)

The SHA-384 checkup routine.

Returns:: 0 on success.
Returns:: 1 on failure.

int mbedtls_sha512_self_test(int verbose)

The SHA-512 checkup routine.

Returns:: 0 on success.
Returns:: 1 on failure.

struct mbedtls_sha512_context

#include <sha512.h>

The SHA-512 context structure.

            The structure is used both for SHA-384 and for SHA-512
            checksum calculations. The choice between these two is
            made in the call to mbedtls_sha512_starts().

Public Members

uint64_t private_total[2]: The number of Bytes processed.

uint64_t private_state[8]: The intermediate digest state.

unsigned char private_buffer[128]: The data block being processed.

int private_is384: Determines which function to use: 0: Use SHA-512, or 1: Use SHA-384.