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

Macros
#define	MBEDTLS_ERR_SHA256_BAD_INPUT_DATA -0x0074

#define	MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED -0x0037

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

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.

void	mbedtls_sha256_clone (mbedtls_sha256_context dst, const mbedtls_sha256_context src)
	This function clones the state of a SHA-256 context.

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.

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.

void	mbedtls_sha256_free (mbedtls_sha256_context *ctx)
	This function clears a SHA-256 context.

void	mbedtls_sha256_init (mbedtls_sha256_context *ctx)
	This function initializes a SHA-256 context.

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.

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.

int	mbedtls_sha256_self_test (int verbose)
	The SHA-224 and SHA-256 checkup routine.

MBEDTLS_DEPRECATED void	mbedtls_sha256_starts (mbedtls_sha256_context *ctx, int is224)
	This function starts a SHA-224 or SHA-256 checksum calculation.

int	mbedtls_sha256_starts_ret (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.

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.

void	sha2_hmac (const unsigned char key, uint32_t keylen, const unsigned char input, uint32_t ilen, unsigned char output[32], int32_t is224)
	Output = HMAC-SHA-256( hmac key, input buffer )

void	sha2_hmac_finish (sha2_hmac_context *ctx, unsigned char output[32])
	SHA-256 HMAC final digest.

void	sha2_hmac_starts (sha2_hmac_context ctx, const unsigned char key, uint32_t keylen, int32_t is224)
	SHA-256 HMAC context setup.

void	sha2_hmac_update (sha2_hmac_context ctx, const unsigned char input, uint32_t ilen)
	SHA-256 HMAC process buffer.

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

Macro Definition Documentation

◆ MBEDTLS_ERR_SHA256_BAD_INPUT_DATA

#define MBEDTLS_ERR_SHA256_BAD_INPUT_DATA -0x0074

SHA-256 input data was malformed.

◆ MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED

#define MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED -0x0037

SHA-256 hardware accelerator failed

Function Documentation

◆ mbedtls_internal_sha256_process()

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. This must be initialized.
data	The 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.

◆ mbedtls_sha256()

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

Deprecated: Superseded by mbedtls_sha256_ret() in 2.7.0.

Parameters

input	The buffer holding the data. This must be a readable buffer of length `ilen` Bytes.
ilen	The length of the input data in Bytes.
output	The SHA-224 or SHA-256 checksum result. This must be a writable buffer of length `32` Bytes.
is224	Determines which function to use. This must be either `0` for SHA-256, or `1` for SHA-224.

◆ mbedtls_sha256_clone()

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. This must be initialized.
src	The context to clone. This must be initialized.

◆ mbedtls_sha256_finish()

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.

Deprecated: Superseded by mbedtls_sha256_finish_ret() in 2.7.0.

Parameters

ctx	The SHA-256 context. This must be initialized and have a hash operation started.
output	The SHA-224 or SHA-256 checksum result. This must be a writable buffer of length `32` Bytes.

◆ mbedtls_sha256_finish_ret()

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. This must be initialized and have a hash operation started.
output	The 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.

◆ mbedtls_sha256_free()

void mbedtls_sha256_free ( mbedtls_sha256_context * ctx )

This function clears a SHA-256 context.

Parameters

ctx	The 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.

◆ mbedtls_sha256_init()

void mbedtls_sha256_init ( mbedtls_sha256_context * ctx )

This function initializes a SHA-256 context.

Parameters

ctx	The SHA-256 context to initialize. This must not be `NULL`.

◆ mbedtls_sha256_process()

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.

Deprecated: Superseded by mbedtls_internal_sha256_process() in 2.7.0.

Parameters

ctx	The SHA-256 context. This must be initialized.
data	The buffer holding one block of data. This must be a readable buffer of size `64` Bytes.

◆ mbedtls_sha256_ret()

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 data. This must be a readable buffer of length `ilen` Bytes.
ilen	The length of the input data in Bytes.
output	The SHA-224 or SHA-256 checksum result. This must be a writable buffer of length `32` Bytes.
is224	Determines which function to use. This must be either `0` for SHA-256, or `1` for SHA-224.

◆ mbedtls_sha256_self_test()

int mbedtls_sha256_self_test ( int verbose )

The SHA-224 and SHA-256 checkup routine.

Returns: 0 on success.; 1 on failure.

◆ mbedtls_sha256_starts()

MBEDTLS_DEPRECATED void mbedtls_sha256_starts	(	mbedtls_sha256_context *	ctx,
		int	is224 )

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

Deprecated: Superseded by mbedtls_sha256_starts_ret() in 2.7.0.

Parameters

ctx	The context to use. This must be initialized.
is224	Determines which function to use. This must be either `0` for SHA-256, or `1` for SHA-224.

◆ mbedtls_sha256_starts_ret()

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 use. This must be initialized.
is224	This 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.

◆ mbedtls_sha256_update()

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.

Deprecated: Superseded by mbedtls_sha256_update_ret() in 2.7.0.

Parameters

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

◆ mbedtls_sha256_update_ret()

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. This must be initialized and have a hash operation started.
input	The buffer holding the data. This must be a readable buffer of length `ilen` Bytes.
ilen	The length of the input data in Bytes.

Returns: 0 on success.; A negative error code on failure.

◆ sha2_hmac()

void sha2_hmac	(	const unsigned char *	key,
		uint32_t	keylen,
		const unsigned char *	input,
		uint32_t	ilen,
		unsigned char	output[32],
		int32_t	is224 )

Output = HMAC-SHA-256( hmac key, input buffer )

Parameters

key	HMAC secret key
keylen	length of the HMAC key
input	buffer holding the data
ilen	length of the input data
output	HMAC-SHA-224/256 result
is224	0 = use SHA256, 1 = use SHA224

◆ sha2_hmac_finish()

void sha2_hmac_finish	(	sha2_hmac_context *	ctx,
		unsigned char	output[32] )

SHA-256 HMAC final digest.

Parameters

ctx	HMAC context
output	SHA-224/256 HMAC checksum result

◆ sha2_hmac_starts()

void sha2_hmac_starts	(	sha2_hmac_context *	ctx,
		const unsigned char *	key,
		uint32_t	keylen,
		int32_t	is224 )

SHA-256 HMAC context setup.

Parameters

ctx	HMAC context to be initialized
key	HMAC secret key
keylen	length of the HMAC key
is224	0 = use SHA256, 1 = use SHA224

◆ sha2_hmac_update()

void sha2_hmac_update	(	sha2_hmac_context *	ctx,
		const unsigned char *	input,
		uint32_t	ilen )

SHA-256 HMAC process buffer.

Parameters

ctx	HMAC context
input	buffer holding the data
ilen	length of the input data

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ MBEDTLS_ERR_SHA256_BAD_INPUT_DATA

◆ MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED

Function Documentation

◆ mbedtls_internal_sha256_process()

◆ mbedtls_sha256()

◆ mbedtls_sha256_clone()

◆ mbedtls_sha256_finish()

◆ mbedtls_sha256_finish_ret()

◆ mbedtls_sha256_free()

◆ mbedtls_sha256_init()

◆ mbedtls_sha256_process()

◆ mbedtls_sha256_ret()

◆ mbedtls_sha256_self_test()

◆ mbedtls_sha256_starts()

◆ mbedtls_sha256_starts_ret()

◆ mbedtls_sha256_update()

◆ mbedtls_sha256_update_ret()

◆ sha2_hmac()

◆ sha2_hmac_finish()

◆ sha2_hmac_starts()

◆ sha2_hmac_update()