sha256.h

Functions

	Name
int	wc_InitSha256(wc_Sha256 * ) This function initializes SHA256. This is automatically called by wc_Sha256Hash.
int	wc_Sha256Update(wc_Sha256 * sha, const byte * data, word32 len) Can be called to continually hash the provided byte array of length len.
int	wc_Sha256Final(wc_Sha256 * sha256, byte * hash) Finalizes hashing of data. Result is placed into hash. Resets state of sha256 struct.
void	wc_Sha256Free(wc_Sha256 * ) Resets the Sha256 structure. Note: this is only supported if you have WOLFSSL_TI_HASH defined.
int	wc_Sha256GetHash(wc_Sha256 * sha256, byte * hash) Gets hash data. Result is placed into hash. Does not reset state of sha256 struct.
int	wc_InitSha224(wc_Sha224 * ) Used to initialize a Sha224 struct.
int	wc_Sha224Update(wc_Sha224 * sha224, const byte * data, word32 len) Can be called to continually hash the provided byte array of length len.
int	wc_Sha224Final(wc_Sha224 * sha224, byte * hash) Finalizes hashing of data. Result is placed into hash. Resets state of sha224 struct.

Functions Documentation

function wc_InitSha256

int wc_InitSha256(
    wc_Sha256 * 
)

This function initializes SHA256. This is automatically called by wc_Sha256Hash.

Parameters:

sha256 pointer to the sha256 structure to use for encryption

See:

Return: 0 Returned upon successfully initializing

Example

Sha256 sha256[1];
if ((ret = wc_InitSha256(sha256)) != 0) {
    WOLFSSL_MSG("wc_InitSha256 failed");
}
else {
    wc_Sha256Update(sha256, data, len);
    wc_Sha256Final(sha256, hash);
}

function wc_Sha256Update

int wc_Sha256Update(
    wc_Sha256 * sha,
    const byte * data,
    word32 len
)

Can be called to continually hash the provided byte array of length len.

Parameters:

sha256 pointer to the sha256 structure to use for encryption
data the data to be hashed
len length of data to be hashed

See:

Return: 0 Returned upon successfully adding the data to the digest.

Example

Sha256 sha256[1];
byte data[] = { Data to be hashed };
word32 len = sizeof(data);

if ((ret = wc_InitSha256(sha256)) != 0) {
   WOLFSSL_MSG("wc_InitSha256 failed");
}
else {
    wc_Sha256Update(sha256, data, len);
    wc_Sha256Final(sha256, hash);
}

function wc_Sha256Final

int wc_Sha256Final(
    wc_Sha256 * sha256,
    byte * hash
)

Finalizes hashing of data. Result is placed into hash. Resets state of sha256 struct.

Parameters:

sha256 pointer to the sha256 structure to use for encryption
hash Byte array to hold hash value.

See:

Return: 0 Returned upon successfully finalizing.

Example

Sha256 sha256[1];
byte data[] = { Data to be hashed };
word32 len = sizeof(data);

if ((ret = wc_InitSha256(sha256)) != 0) {
   WOLFSSL_MSG("wc_InitSha256 failed");
}
else {
   wc_Sha256Update(sha256, data, len);
   wc_Sha256Final(sha256, hash);
}

function wc_Sha256Free

void wc_Sha256Free(
    wc_Sha256 * 
)

Resets the Sha256 structure. Note: this is only supported if you have WOLFSSL_TI_HASH defined.

Parameters:

sha256 Pointer to the sha256 structure to be freed.

See:

Return: none No returns.

Example

Sha256 sha256;
byte data[] = { Data to be hashed };
word32 len = sizeof(data);

if ((ret = wc_InitSha256(&sha256)) != 0) {
    WOLFSSL_MSG("wc_InitSha256 failed");
}
else {
    wc_Sha256Update(&sha256, data, len);
    wc_Sha256Final(&sha256, hash);
    wc_Sha256Free(&sha256);
}

function wc_Sha256GetHash

int wc_Sha256GetHash(
    wc_Sha256 * sha256,
    byte * hash
)

Gets hash data. Result is placed into hash. Does not reset state of sha256 struct.

Parameters:

sha256 pointer to the sha256 structure to use for encryption
hash Byte array to hold hash value.

See:

Return: 0 Returned upon successfully finalizing.

Example

Sha256 sha256[1];
if ((ret = wc_InitSha256(sha256)) != 0) {
   WOLFSSL_MSG("wc_InitSha256 failed");
}
else {
   wc_Sha256Update(sha256, data, len);
   wc_Sha256GetHash(sha256, hash);
}

function wc_InitSha224

int wc_InitSha224(
    wc_Sha224 * 
)

Used to initialize a Sha224 struct.

Parameters:

sha224 Pointer to a Sha224 struct to initialize.

See:

Return:

0 Success
1 Error returned because sha224 is null.

Example

Sha224 sha224;
if(wc_InitSha224(&sha224) != 0)
{
    // Handle error
}

function wc_Sha224Update

int wc_Sha224Update(
    wc_Sha224 * sha224,
    const byte * data,
    word32 len
)

Can be called to continually hash the provided byte array of length len.

Parameters:

sha224 Pointer to the Sha224 structure to use for encryption.
data Data to be hashed.
len Length of data to be hashed.

See:

Return:

0 Success
1 Error returned if function fails.
BAD_FUNC_ARG Error returned if sha224 or data is null.

Example

Sha224 sha224;
byte data[] = { /* Data to be hashed };
word32 len = sizeof(data);

if ((ret = wc_InitSha224(&sha224)) != 0) {
   WOLFSSL_MSG("wc_InitSha224 failed");
}
else {
  wc_Sha224Update(&sha224, data, len);
  wc_Sha224Final(&sha224, hash);
}

function wc_Sha224Final

int wc_Sha224Final(
    wc_Sha224 * sha224,
    byte * hash
)

Finalizes hashing of data. Result is placed into hash. Resets state of sha224 struct.

Parameters:

sha224 pointer to the sha224 structure to use for encryption
hash Byte array to hold hash value.

See:

Return:

0 Success
<0 Error

Example

Sha224 sha224;
byte data[] = { /* Data to be hashed };
word32 len = sizeof(data);

if ((ret = wc_InitSha224(&sha224)) != 0) {
    WOLFSSL_MSG("wc_InitSha224 failed");
}
else {
    wc_Sha224Update(&sha224, data, len);
    wc_Sha224Final(&sha224, hash);
}

Source code


int wc_InitSha256(wc_Sha256*);

int wc_Sha256Update(wc_Sha256* sha, const byte* data, word32 len);

int wc_Sha256Final(wc_Sha256* sha256, byte* hash);

void wc_Sha256Free(wc_Sha256*);

int wc_Sha256GetHash(wc_Sha256* sha256, byte* hash);

int wc_InitSha224(wc_Sha224*);

int wc_Sha224Update(wc_Sha224* sha224, const byte* data, word32 len);

int wc_Sha224Final(wc_Sha224* sha224, byte* hash);

Updated on 2024-11-22 at 01:12:39 +0000