Commit Graph

2 Commits

Author SHA1 Message Date
dsmurrow 0c5eccc69e
docs: fixed some documentation errors in BLAKE2b (#1234)
* docs: Slight modifications

Changed #include comments from doc to regular because it messed up the generated documentation. Changed blake2b() comment from regular to doc

* docs: Removed @define's

Doxygen doesn't seem to like them. Also fixed param on CEIL

* chore: made it so math directory gets built

* docs: added back third slash for includes

* feat: added extended Euclidean algorithm

* fix: key wasn't being considered in the algorithm

* chore: added more tests

* chore: Deleted file accidentally added from different branch

* chore: moved tests to their own function

* chore: apply suggestions from code review

---------

Co-authored-by: David Leal <halfpacho@gmail.com>
2023-04-07 13:35:40 -06:00
dsmurrow acbaf4a291
feat: implemented BLAKE2b cryptographic hashing algorithm (#1230)
* feat: added BLAKE2b with one working assert
docs: added BLAKE2b to README.md

* [enhancement] added more doc comments and fully implemented BLAKE2b key hashing

* fix: forgot to add arg

* chore: applied clang-format

* updating DIRECTORY.md

* docs: added main function docs

Co-authored-by: David Leal <halfpacho@gmail.com>

* docs: removed @file qualifier

Co-authored-by: David Leal <halfpacho@gmail.com>

* docs: added doc comment for assert_bytes()

Co-authored-by: David Leal <halfpacho@gmail.com>

* docs: added documentation for #include's

As requested by Panquesito27 in https://github.com/TheAlgorithms/C/pull/1230#discussion_r1130143641

* docs: added algorithm description

As requested in https://github.com/TheAlgorithms/C/pull/1230#discussion_r1130143364

* docs: added reasoning for warning suppression pragmas

* docs: spellcheck and additions

Added doc for bb definition.
Added description for mixing function G and compression function F.

* Added print statement to let user know tests have passed

Co-authored-by: David Leal <halfpacho@gmail.com>

* Updated doc comments for variables

* docs: removed old doc comments

* fix: had minus sign instead of assignment operator

* chore: replaced uint64_t[16] with block_t type to improve readability

* docs: defined macro constants to reduce magic numbers

* fix: fixed memory leak in blake2b()

* docs: moved comment

Moved comment about the suppressed warning directly above the code that emits the warning

* docs: added psuedocode/feat: added u128

Added psuedocode for the algorithm in doc comment for BLAKE2B(). Added return docs for void functions. Defined an unsigned 128-bit integer to match the max input size specified for the algorithm.

* fix: fixed build errors

* docs: added some clarifying comments

* docs: reduced magic numbers

---------

Co-authored-by: github-actions[bot] <github-actions@users.noreply.github.com>
Co-authored-by: David Leal <halfpacho@gmail.com>
2023-03-13 20:38:42 -06:00