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

sha256.h File Reference
Data Structures | Typedefs | Functions

sha256.h File Reference

This file contains SHA-224 and SHA-256 definitions and functions. More...

Go to the source code of this file.

Data Structures

struct  mbedtls_sha256_context
 SHA-256 context structure. More...

Typedefs

typedef struct
mbedtls_sha256_context 		mbedtls_sha256_context
 The SHA-256 context structure.

Functions

void mbedtls_sha256_init (mbedtls_sha256_context *ctx)
 This function initializes a SHA-256 context.
void mbedtls_sha256_free (mbedtls_sha256_context *ctx)
 This function clears a SHA-256 context.
void mbedtls_sha256_clone (mbedtls_sha256_context *dst, const mbedtls_sha256_context *src)
 This function clones the state of a SHA-256 context.
int mbedtls_sha256_starts_ret (mbedtls_sha256_context *ctx, int is224)
 This function starts a SHA-224 or SHA-256 checksum calculation.
int mbedtls_sha256_update_ret (mbedtls_sha256_context *ctx, const unsigned char *input, size_t ilen)
 This function feeds an input buffer into an ongoing SHA-256 checksum calculation.
int mbedtls_sha256_finish_ret (mbedtls_sha256_context *ctx, unsigned char output[32])
 This function finishes the SHA-256 operation, and writes the result to the output buffer.
int mbedtls_internal_sha256_process (mbedtls_sha256_context *ctx, const unsigned char data[64])
 This function processes a single data block within the ongoing SHA-256 computation.
MBEDTLS_DEPRECATED void mbedtls_sha256_starts (mbedtls_sha256_context *ctx, int is224)
 This function starts a SHA-224 or SHA-256 checksum calculation.
MBEDTLS_DEPRECATED void mbedtls_sha256_update (mbedtls_sha256_context *ctx, const unsigned char *input, size_t ilen)
 This function feeds an input buffer into an ongoing SHA-256 checksum calculation.
MBEDTLS_DEPRECATED void mbedtls_sha256_finish (mbedtls_sha256_context *ctx, unsigned char output[32])
 This function finishes the SHA-256 operation, and writes the result to the output buffer.
MBEDTLS_DEPRECATED void mbedtls_sha256_process (mbedtls_sha256_context *ctx, const unsigned char data[64])
 This function processes a single data block within the ongoing SHA-256 computation.
int mbedtls_sha256_ret (const unsigned char *input, size_t ilen, unsigned char output[32], int is224)
 This function calculates the SHA-224 or SHA-256 checksum of a buffer.
MBEDTLS_DEPRECATED void mbedtls_sha256 (const unsigned char *input, size_t ilen, unsigned char output[32], int is224)
 This function calculates the SHA-224 or SHA-256 checksum of a buffer.
int mbedtls_sha256_self_test (int verbose)
 The SHA-224 and SHA-256 checkup routine.

Detailed Description

This file contains SHA-224 and SHA-256 definitions and functions.

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

Definition in file sha256.h.

Typedef Documentation

typedef struct mbedtls_sha256_context mbedtls_sha256_context

The SHA-256 context structure.

The structure is used both for SHA-256 and for SHA-224 checksum calculations. The choice between these two is made in the call to mbedtls_sha256_starts_ret().

Function Documentation

int mbedtls_internal_sha256_process ( mbedtls_sha256_context *  ctx,
const unsigned char  data[64] 
)

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

This function is for internal use only.

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

Definition at line 54 of file sha256_alt.c.

MBEDTLS_DEPRECATED void mbedtls_sha256 ( const unsigned char *  input,
size_t  ilen,
unsigned char  output[32],
int  is224 
)

This function calculates the SHA-224 or SHA-256 checksum of a buffer.

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

The SHA-256 result is calculated as output = SHA-256(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-224 or SHA-256 checksum result. This must be a writable buffer of length 32 Bytes.
is224Determines which function to use. This must be either 0 for SHA-256, or 1 for SHA-224.

Definition at line 442 of file sha256.c.

void mbedtls_sha256_clone ( mbedtls_sha256_context *  dst,
const mbedtls_sha256_context *  src 
)

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

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

Definition at line 39 of file sha256_alt.c.

MBEDTLS_DEPRECATED void mbedtls_sha256_finish ( mbedtls_sha256_context *  ctx,
unsigned char  output[32] 
)

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

Parameters:
ctxThe SHA-256 context. This must be initialized and have a hash operation started.
outputThe SHA-224 or SHA-256 checksum result. This must be a writable buffer of length 32 Bytes.
Parameters:
ctxThe SHA-256 context.
outputThe SHA-224or SHA-256 checksum result.

Definition at line 400 of file sha256.c.

int mbedtls_sha256_finish_ret ( mbedtls_sha256_context *  ctx,
unsigned char  output[32] 
)

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

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

Definition at line 69 of file sha256_alt.c.

void mbedtls_sha256_free ( mbedtls_sha256_context *  ctx )

This function clears a SHA-256 context.

Parameters:
ctxThe SHA-256 context to clear. This may be NULL, in which case this function returns immediately. If it is not NULL, it must point to an initialized SHA-256 context.

Definition at line 31 of file sha256_alt.c.

void mbedtls_sha256_init ( mbedtls_sha256_context *  ctx )

This function initializes a SHA-256 context.

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

Definition at line 26 of file sha256_alt.c.

MBEDTLS_DEPRECATED void mbedtls_sha256_process ( mbedtls_sha256_context *  ctx,
const unsigned char  data[64] 
)

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

This function is for internal use only.

Parameters:
ctxThe SHA-256 context. This must be initialized.
dataThe buffer holding one block of data. This must be a readable buffer of size 64 Bytes.

Definition at line 263 of file sha256.c.

int mbedtls_sha256_ret ( const unsigned char *  input,
size_t  ilen,
unsigned char  output[32],
int  is224 
)

This function calculates the SHA-224 or SHA-256 checksum of a buffer.

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

The SHA-256 result is calculated as output = SHA-256(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-224 or SHA-256 checksum result. This must be a writable buffer of length 32 Bytes.
is224Determines which function to use. This must be either 0 for SHA-256, or 1 for SHA-224.

Definition at line 412 of file sha256.c.

int mbedtls_sha256_self_test ( int  verbose )

The SHA-224 and SHA-256 checkup routine.

Returns:
0 on success.
1 on failure.

Definition at line 505 of file sha256.c.

MBEDTLS_DEPRECATED void mbedtls_sha256_starts ( mbedtls_sha256_context *  ctx,
int  is224 
)

This function starts a SHA-224 or SHA-256 checksum calculation.

Parameters:
ctxThe context to use. This must be initialized.
is224Determines which function to use. This must be either 0 for SHA-256, or 1 for SHA-224.

This function starts a SHA-224 or SHA-256 checksum calculation.

Parameters:
ctxThe SHA-256 context to initialize.
is224Determines which function to use.

  • 0: Use SHA-256.
  • 1: Use SHA-224.

Definition at line 147 of file sha256.c.

int mbedtls_sha256_starts_ret ( mbedtls_sha256_context *  ctx,
int  is224 
)

This function starts a SHA-224 or SHA-256 checksum calculation.

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

Definition at line 46 of file sha256_alt.c.

MBEDTLS_DEPRECATED void mbedtls_sha256_update ( mbedtls_sha256_context *  ctx,
const unsigned char *  input,
size_t  ilen 
)

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

Parameters:
ctxThe SHA-256 context to use. 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-256 context to initialize.
inputThe buffer holding the data.
ilenThe length of the input data.

Definition at line 325 of file sha256.c.

int mbedtls_sha256_update_ret ( mbedtls_sha256_context *  ctx,
const unsigned char *  input,
size_t  ilen 
)

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

Parameters:
ctxThe SHA-256 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.
Returns:
0 on success.
A negative error code on failure.

Definition at line 60 of file sha256_alt.c.

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