Kenji Arai / mbed-os_TYBLE16

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

Embed: (wiki syntax)

« Back to documentation index

sha512.h File Reference
Data Structures | Typedefs | Functions

sha512.h File Reference

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

Go to the source code of this file.

Data Structures

struct  mbedtls_sha512_context
 SHA-512 context structure. More...

Typedefs

typedef struct
mbedtls_sha512_context 		mbedtls_sha512_context
 The SHA-512 context structure.

Functions

void mbedtls_sha512_init (mbedtls_sha512_context *ctx)
 This function initializes a SHA-512 context.
void mbedtls_sha512_free (mbedtls_sha512_context *ctx)
 This function clears a 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.
int mbedtls_sha512_starts_ret (mbedtls_sha512_context *ctx, int is384)
 This function starts a SHA-384 or SHA-512 checksum calculation.
int mbedtls_sha512_update_ret (mbedtls_sha512_context *ctx, const unsigned char *input, size_t ilen)
 This function feeds an input buffer into an ongoing SHA-512 checksum calculation.
int mbedtls_sha512_finish_ret (mbedtls_sha512_context *ctx, unsigned char output[64])
 This function finishes the SHA-512 operation, and writes the result to the output buffer.
int mbedtls_internal_sha512_process (mbedtls_sha512_context *ctx, const unsigned char data[128])
 This function processes a single data block within the ongoing SHA-512 computation.
MBEDTLS_DEPRECATED void mbedtls_sha512_starts (mbedtls_sha512_context *ctx, int is384)
 This function starts a SHA-384 or SHA-512 checksum calculation.
MBEDTLS_DEPRECATED void 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.
MBEDTLS_DEPRECATED void mbedtls_sha512_finish (mbedtls_sha512_context *ctx, unsigned char output[64])
 This function finishes the SHA-512 operation, and writes the result to the output buffer.
MBEDTLS_DEPRECATED void mbedtls_sha512_process (mbedtls_sha512_context *ctx, const unsigned char data[128])
 This function processes a single data block within the ongoing SHA-512 computation.
int mbedtls_sha512_ret (const unsigned char *input, size_t ilen, unsigned char output[64], int is384)
 This function calculates the SHA-512 or SHA-384 checksum of a buffer.
MBEDTLS_DEPRECATED void mbedtls_sha512 (const unsigned char *input, size_t ilen, unsigned char output[64], int is384)
 This function calculates the SHA-512 or SHA-384 checksum of a buffer.
int mbedtls_sha512_self_test (int verbose)
 The SHA-384 or SHA-512 checkup routine.

Detailed Description

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).

Definition in file sha512.h.

Typedef Documentation

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_ret().

Function Documentation

int mbedtls_internal_sha512_process ( mbedtls_sha512_context *  ctx,
const unsigned char  data[128] 
)

This function processes a single data block within the ongoing SHA-512 computation.

Parameters:
ctxThe SHA-512 context. This must be initialized.
dataThe buffer holding one block of data. This must be a readable buffer of length 128 Bytes.
Returns:
0 on success.
A negative error code on failure.

Definition at line 55 of file sha512_alt.c.

MBEDTLS_DEPRECATED void mbedtls_sha512 ( const unsigned char *  input,
size_t  ilen,
unsigned char  output[64],
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).

Parameters:
inputThe buffer holding the data. This must be a readable buffer of length ilen Bytes.
ilenThe length of the input data in Bytes.
outputThe SHA-384 or SHA-512 checksum result. This must be a writable buffer of length 64 Bytes.
is384Determines which function to use. This must be either 0 for SHA-512, or 1 for SHA-384.

Definition at line 491 of file sha512.c.

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

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

Parameters:
dstThe destination context. This must be initialized.
srcThe context to clone. This must be initialized.

Definition at line 39 of file sha512_alt.c.

MBEDTLS_DEPRECATED void mbedtls_sha512_finish ( mbedtls_sha512_context *  ctx,
unsigned char  output[64] 
)

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

Parameters:
ctxThe SHA-512 context. This must be initialized and have a hash operation started.
outputThe SHA-384 or SHA-512 checksum result. This must be a writable buffer of size 64 Bytes.
Parameters:
ctxThe SHA-512 context.
outputThe SHA-384 or SHA-512 checksum result.

Definition at line 449 of file sha512.c.

int mbedtls_sha512_finish_ret ( mbedtls_sha512_context *  ctx,
unsigned char  output[64] 
)

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

This function is for internal use only.

Parameters:
ctxThe SHA-512 context. This must be initialized and have a hash operation started.
outputThe SHA-384 or SHA-512 checksum result. This must be a writable buffer of length 64 Bytes.
Returns:
0 on success.
A negative error code on failure.

Definition at line 70 of file sha512_alt.c.

void mbedtls_sha512_free ( mbedtls_sha512_context *  ctx )

This function clears a SHA-512 context.

Parameters:
ctxThe 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.

Definition at line 31 of file sha512_alt.c.

void mbedtls_sha512_init ( mbedtls_sha512_context *  ctx )

This function initializes a SHA-512 context.

Parameters:
ctxThe SHA-512 context to initialize. This must not be NULL.

Definition at line 26 of file sha512_alt.c.

MBEDTLS_DEPRECATED void mbedtls_sha512_process ( mbedtls_sha512_context *  ctx,
const unsigned char  data[128] 
)

This function processes a single data block within the ongoing SHA-512 computation.

This function is for internal use only.

Parameters:
ctxThe SHA-512 context. This must be initialized.
dataThe buffer holding one block of data. This must be a readable buffer of length 128 Bytes.

Definition at line 311 of file sha512.c.

int mbedtls_sha512_ret ( const unsigned char *  input,
size_t  ilen,
unsigned char  output[64],
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).

Parameters:
inputThe buffer holding the input data. This must be a readable buffer of length ilen Bytes.
ilenThe length of the input data in Bytes.
outputThe SHA-384 or SHA-512 checksum result. This must be a writable buffer of length 64 Bytes.
is384Determines which function to use. This must be either 0 for SHA-512, or 1 for SHA-384.
Returns:
0 on success.
A negative error code on failure.

Definition at line 461 of file sha512.c.

int mbedtls_sha512_self_test ( int  verbose )

The SHA-384 or SHA-512 checkup routine.

Returns:
0 on success.
1 on failure.

Definition at line 574 of file sha512.c.

MBEDTLS_DEPRECATED void mbedtls_sha512_starts ( mbedtls_sha512_context *  ctx,
int  is384 
)

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

Parameters:
ctxThe SHA-512 context to use. This must be initialized.
is384Determines which function to use. This must be either 0 for SHA-512 or 1 for SHA-384.
Parameters:
ctxThe SHA-512 context to initialize.
is384Determines which function to use.

  • 0: Use SHA-512.
  • 1: Use SHA-384.

Definition at line 170 of file sha512.c.

int mbedtls_sha512_starts_ret ( mbedtls_sha512_context *  ctx,
int  is384 
)

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

Parameters:
ctxThe SHA-512 context to use. This must be initialized.
is384Determines which function to use. This must be either for SHA-512, or 1 for SHA-384.
Returns:
0 on success.
A negative error code on failure.

Definition at line 46 of file sha512_alt.c.

MBEDTLS_DEPRECATED void 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:
ctxThe SHA-512 context. This must be initialized and have a hash operation started.
inputThe buffer holding the data. This must be a readable buffer of length ilen Bytes.
ilenThe length of the input data in Bytes.
Parameters:
ctxThe SHA-512 context.
inputThe buffer holding the data.
ilenThe length of the input data.

Definition at line 372 of file sha512.c.

int mbedtls_sha512_update_ret ( 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:
ctxThe SHA-512 context. This must be initialized and have a hash operation started.
inputThe buffer holding the input data. This must be a readable buffer of length ilen Bytes.
ilenThe length of the input data in Bytes.
Returns:
0 on success.
A negative error code on failure.

Definition at line 61 of file sha512_alt.c.

Generated on Tue Jul 12 2022 13:55:18 by  doxygen 1.7.2