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.
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... | |
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.
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:
-
ctx The SHA-256 context. data The buffer holding one block of data.
- Returns:
0
on success.
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:
-
input The buffer holding the data. ilen The length of the input data. output The SHA-224 or SHA-256 checksum result. is224 Determines which function to use: 0: Use SHA-256, or 1: Use SHA-224.
void mbedtls_sha256_clone | ( | mbedtls_sha256_context * | dst, |
const mbedtls_sha256_context * | src | ||
) |
This function clones the state of a SHA-256 context.
- Parameters:
-
dst The destination context. src The context to clone.
Definition at line 39 of file sha256_alt.c.
MBEDTLS_DEPRECATED void mbedtls_sha256_finish | ( | mbedtls_sha256_context * | ctx, |
unsigned char | output[32] | ||
) |
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:
-
ctx The SHA-256 context. output The SHA-224 or SHA-256 checksum result.
- Returns:
0
on success.
Definition at line 71 of file sha256_alt.c.
void mbedtls_sha256_free | ( | mbedtls_sha256_context * | ctx ) |
This function clears a SHA-256 context.
- Parameters:
-
ctx The SHA-256 context to clear.
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:
-
ctx The SHA-256 context to initialize.
Definition at line 25 of file sha256_alt.c.
MBEDTLS_DEPRECATED void mbedtls_sha256_process | ( | mbedtls_sha256_context * | ctx, |
const unsigned char | data[64] | ||
) |
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:
-
input The buffer holding the input data. ilen The length of the input data. output The SHA-224 or SHA-256 checksum result. is224 Determines which function to use: 0: Use SHA-256, or 1: Use SHA-224.
int mbedtls_sha256_self_test | ( | int | verbose ) |
MBEDTLS_DEPRECATED void mbedtls_sha256_starts | ( | mbedtls_sha256_context * | ctx, |
int | is224 | ||
) |
This function starts a SHA-224 or SHA-256 checksum calculation.
- Parameters:
-
ctx The context to initialize. is224 Determines which function to use: 0: Use SHA-256, or 1: Use SHA-224.
This function starts a SHA-224 or SHA-256 checksum calculation.
- Parameters:
-
ctx The SHA-256 context to initialize. is224 Determines which function to use. - 0: Use SHA-256.
- 1: Use SHA-224.
int mbedtls_sha256_starts_ret | ( | mbedtls_sha256_context * | ctx, |
int | is224 | ||
) |
This function starts a SHA-224 or SHA-256 checksum calculation.
- Parameters:
-
ctx The context to initialize. is224 Determines which function to use: 0: Use SHA-256, or 1: Use SHA-224.
- Returns:
0
on success.
- Parameters:
-
ctx The context to initialize. is224 Determines which function to use. - 0: Use SHA-256.
- 1: Use SHA-224.
- Returns:
0
on success.
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:
-
ctx The SHA-256 context to initialize. input The buffer holding the data. ilen The length of the input data.
- Parameters:
-
ctx The SHA-256 context to initialize. input The buffer holding the data. ilen The length of the input data.
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:
-
ctx The SHA-256 context. input The buffer holding the data. ilen The length of the input data.
- Returns:
0
on success.
- Parameters:
-
ctx SHA-256 context input buffer holding the data ilen length of the input data
- Returns:
0
on success.
Definition at line 62 of file sha256_alt.c.
Generated on Tue Jul 12 2022 12:46:32 by
