RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-01-17 04:52:59 +01:00
Code Releases Activity

Merge pull request #12418 from Rotzbua/doc_sha3

Browse Source 
sys/hashes/sha3: docu rename hashes to FIPS 202 standard
This commit is contained in:
José Alamos 2019-10-18 15:59:26 +02:00 committed by GitHub
commit 2fb4a79d9a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
sys/include/hashes/sha3.h
View File

@ -34,17 +34,17 @@ extern "C" {
#endif
/**
* @brief Length of SHA256 digests in bytes
* @brief Length of SHA3-256 digests in bytes
*/
#define SHA3_256_DIGEST_LENGTH 32
/**
* @brief Length of SHA384 digests in bytes
* @brief Length of SHA3-384 digests in bytes
*/
#define SHA3_384_DIGEST_LENGTH 48
/**
* @brief Length of SHA512 digests in bytes
* @brief Length of SHA3-512 digests in bytes
*/
#define SHA3_512_DIGEST_LENGTH 64
@ -98,7 +98,7 @@ void Keccak_final(keccak_state_t *ctx, unsigned char *output,
unsigned long long int outputByteLen);
/**
* @brief SHA-3-256 initialization. Begins a SHA-3-256 operation.
* @brief SHA3-256 initialization. Begins a SHA3-256 operation.
*
* @param[in] ctx keccak_state_t handle to initialise
*/
@ -114,7 +114,7 @@ void sha3_256_init(keccak_state_t *ctx);
void sha3_update(keccak_state_t *ctx, const void *data, size_t len);
/**
* @brief SHA-3-256 finalization. Pads the input data and exports the hash value
* @brief SHA3-256 finalization. Pads the input data and exports the hash value
*
* @param[in,out] ctx context handle to use
* @param[out] digest resulting digest, this is the hash of all the bytes
@ -122,14 +122,14 @@ void sha3_update(keccak_state_t *ctx, const void *data, size_t len);
void sha3_256_final(keccak_state_t *ctx, void *digest);
/**
* @brief SHA-3-384 initialization. Begins a SHA-3-256 operation.
* @brief SHA3-384 initialization. Begins a SHA3-384 operation.
*
* @param[in] ctx keccak_state_t handle to initialise
*/
void sha3_384_init(keccak_state_t *ctx);
/**
* @brief SHA-3-384 finalization. Pads the input data and exports the hash value
* @brief SHA3-384 finalization. Pads the input data and exports the hash value
*
* @param[in,out] ctx context handle to use
* @param[out] digest resulting digest, this is the hash of all the bytes
@ -137,14 +137,14 @@ void sha3_384_init(keccak_state_t *ctx);
void sha3_384_final(keccak_state_t *ctx, void *digest);
/**
* @brief SHA-3-512 initialization. Begins a SHA-3-256 operation.
* @brief SHA3-512 initialization. Begins a SHA3-512 operation.
*
* @param[in] ctx keccak_state_t handle to initialise
*/
void sha3_512_init(keccak_state_t *ctx);
/**
* @brief SHA-3-512 finalization. Pads the input data and exports the hash value
* @brief SHA3-512 finalization. Pads the input data and exports the hash value
*
* @param[in,out] ctx context handle to use
* @param[out] digest resulting digest, this is the hash of all the bytes
@ -154,7 +154,7 @@ void sha3_512_final(keccak_state_t *ctx, void *digest);
/**
* @brief A wrapper function to simplify the generation of a hash, this is
* useful for generating SHA-3-256 from one buffer
* useful for generating SHA3-256 from one buffer
*
* @param[in] data pointer to the buffer to generate hash from
* @param[in] len length of the buffer
@ -165,7 +165,7 @@ void sha3_256(void *digest, const void *data, size_t len);
/**
* @brief A wrapper function to simplify the generation of a hash, this is
* useful for generating SHA-3-384 from one buffer
* useful for generating SHA3-384 from one buffer
*
* @param[in] data pointer to the buffer to generate hash from
* @param[in] len length of the buffer
@ -176,7 +176,7 @@ void sha3_384(void *digest, const void *data, size_t len);
/**
* @brief A wrapper function to simplify the generation of a hash, this is
* useful for generating SHA-3-512 from one buffer
* useful for generating SHA3-512 from one buffer
*
* @param[in] data pointer to the buffer to generate hash from
* @param[in] len length of the buffer