Skip to content

Commit

Permalink
Document mac_reset()
Browse files Browse the repository at this point in the history
  • Loading branch information
jedisct1 committed Dec 9, 2024
1 parent 1a9fb21 commit a65be0d
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/include/aegis128l.h
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,8 @@ void aegis128l_decrypt_unauthenticated(uint8_t *m, const uint8_t *c, size_t clen
* After initialization, the state can be reused to generate multiple MACs by cloning it
* with `aegis128l_mac_state_clone()`. It is only safe to copy a state directly without using
* the clone function if the state is guaranteed to be properly aligned.
*
* A state can also be reset for reuse without cloning with `aegis128l_mac_reset()`.
*/
void aegis128l_mac_init(aegis128l_mac_state *st_, const uint8_t *k, const uint8_t *npub);

Expand Down
2 changes: 2 additions & 0 deletions src/include/aegis128x2.h
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,8 @@ void aegis128x2_decrypt_unauthenticated(uint8_t *m, const uint8_t *c, size_t cle
* After initialization, the state can be reused to generate multiple MACs by cloning it
* with `aegis128x2_mac_state_clone()`. It is only safe to copy a state directly without using
* the clone function if the state is guaranteed to be properly aligned.
*
* A state can also be reset for reuse without cloning with `aegis128x2_mac_reset()`.
*/
void aegis128x2_mac_init(aegis128x2_mac_state *st_, const uint8_t *k, const uint8_t *npub);

Expand Down
2 changes: 2 additions & 0 deletions src/include/aegis128x4.h
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,8 @@ void aegis128x4_decrypt_unauthenticated(uint8_t *m, const uint8_t *c, size_t cle
* After initialization, the state can be reused to generate multiple MACs by cloning it
* with `aegis128x4_mac_state_clone()`. It is only safe to copy a state directly without using
* the clone function if the state is guaranteed to be properly aligned.
*
* A state can also be reset for reuse without cloning with `aegis128x4_mac_reset()`.
*/
void aegis128x4_mac_init(aegis128x4_mac_state *st_, const uint8_t *k, const uint8_t *npub);

Expand Down
2 changes: 2 additions & 0 deletions src/include/aegis256.h
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,8 @@ void aegis256_decrypt_unauthenticated(uint8_t *m, const uint8_t *c, size_t clen,
* After initialization, the state can be reused to generate multiple MACs by cloning it
* with `aegis256_mac_state_clone()`. It is only safe to copy a state directly without using
* the clone function if the state is guaranteed to be properly aligned.
*
* A state can also be reset for reuse without cloning with `aegis256_mac_reset()`.
*/
void aegis256_mac_init(aegis256_mac_state *st_, const uint8_t *k, const uint8_t *npub);

Expand Down
2 changes: 2 additions & 0 deletions src/include/aegis256x2.h
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,8 @@ void aegis256x2_decrypt_unauthenticated(uint8_t *m, const uint8_t *c, size_t cle
* After initialization, the state can be reused to generate multiple MACs by cloning it
* with `aegis256x2_mac_state_clone()`. It is only safe to copy a state directly without using
* the clone function if the state is guaranteed to be properly aligned.
*
* A state can also be reset for reuse without cloning with `aegis256x2_mac_reset()`.
*/
void aegis256x2_mac_init(aegis256x2_mac_state *st_, const uint8_t *k, const uint8_t *npub);

Expand Down
2 changes: 2 additions & 0 deletions src/include/aegis256x4.h
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,8 @@ void aegis256x4_decrypt_unauthenticated(uint8_t *m, const uint8_t *c, size_t cle
* After initialization, the state can be reused to generate multiple MACs by cloning it
* with `aegis256x4_mac_state_clone()`. It is only safe to copy a state directly without using
* the clone function if the state is guaranteed to be properly aligned.
*
* A state can also be reset for reuse without cloning with `aegis256x4_mac_reset()`.
*/
void aegis256x4_mac_init(aegis256x4_mac_state *st_, const uint8_t *k, const uint8_t *npub);

Expand Down

0 comments on commit a65be0d

Please sign in to comment.