diff options
author | Mattias Andrée <maandree@kth.se> | 2024-09-15 00:47:51 +0200 |
---|---|---|
committer | Mattias Andrée <maandree@kth.se> | 2024-09-15 00:47:51 +0200 |
commit | f14ba70de62cbd47e074756b1f1aec1f3b77a02d (patch) | |
tree | 4b4c27260816f553b7a1fe54153c06b122160ffc /man3/libkeccak_hmac_fast_update.3 | |
parent | Split libkeccak.h and fix support for architectures that do not allow misaligned memory (diff) | |
download | libkeccak-f14ba70de62cbd47e074756b1f1aec1f3b77a02d.tar.gz libkeccak-f14ba70de62cbd47e074756b1f1aec1f3b77a02d.tar.bz2 libkeccak-f14ba70de62cbd47e074756b1f1aec1f3b77a02d.tar.xz |
Move man pages into man3/ and man7/
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'man3/libkeccak_hmac_fast_update.3')
-rw-r--r-- | man3/libkeccak_hmac_fast_update.3 | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/man3/libkeccak_hmac_fast_update.3 b/man3/libkeccak_hmac_fast_update.3 new file mode 100644 index 0000000..ca62baf --- /dev/null +++ b/man3/libkeccak_hmac_fast_update.3 @@ -0,0 +1,53 @@ +.TH LIBKECCAK_HMAC_FAST_UPDATE 3 LIBKECCAK +.SH NAME +libkeccak_hmac_fast_update - Partially HMAC-hash a message without erasure +.SH SYNOPSIS +.nf +#include <libkeccak.h> + +int libkeccak_hmac_fast_update(struct libkeccak_state *\fIstate\fP, const void *\fImsg\fP, size_t \fImsglen\fP); +.fi +.PP +Link with +.IR -lkeccak . +.SH DESCRIPTION +The +.BR libkeccak_hmac_fast_update () +function continues (or starts) HMAC-hashing a message. +The current state of the hashing is stored in +.IR *state , +and will be updated. The message specified by the +.I msg +parameter with the byte-size specified by the +.I msglen +parameter, will be hashed. +.PP +The +.BR libkeccak_hmac_fast_update () +function may reallocate the state's message chunk buffer. +When doing so, it attempts to do so as securely as possible, +rather than as fast as possible. +.SH RETURN VALUES +The +.BR libkeccak_hmac_fast_update () +function returns 0 upon successful completion. On error, +-1 is returned and +.I errno +is set to describe the error. +.SH ERRORS +The +.BR libkeccak_hmac_fast_update () +function may reallocate the state's message chunk buffer. +When doing so, it attempts to do so as quickly as possible, +rather than ensuring that the information in the old +allocation is securely removed if a new allocation is required. +.BR realloc (3). +.SH NOTES +Neither parameter by be +.I NULL +or 0. +.SH SEE ALSO +.BR libkeccak_hmac_create (3), +.BR libkeccak_hmac_initialise (3), +.BR libkeccak_hmac_fast_digest (3), +.BR libkeccak_hmac_update (3) |