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 /libkeccak_zerocopy_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 'libkeccak_zerocopy_update.3')
-rw-r--r-- | libkeccak_zerocopy_update.3 | 89 |
1 files changed, 0 insertions, 89 deletions
diff --git a/libkeccak_zerocopy_update.3 b/libkeccak_zerocopy_update.3 deleted file mode 100644 index b4086a0..0000000 --- a/libkeccak_zerocopy_update.3 +++ /dev/null @@ -1,89 +0,0 @@ -.TH LIBKECCAK_ZEROCOPY_UPDATE 3 LIBKECCAK -.SH NAME -libkeccak_zerocopy_update - Partially hash a message without copying -.RB ( ADVANCED ) -.SH SYNOPSIS -.nf -#include <libkeccak.h> - -void libkeccak_zerocopy_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_zerocopy_update () -function continues (or starts) 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 -As a restriction specific to the -.BR libkeccak_zerocopy_update () -function, the -.I msglen -argument must be an integer multiple of the bitrate -divided by eight. This is returned by the -.BR libkeccak_zerocopy_chunksize (3) -function. The -.BR libkeccak_update (3) -or -.BR libkeccak_fast_update (3) -functions can be used to avoid this restriction, -but these, unlike the -.BR libkeccak_zerocopy_update () -function, will copy the message and move around -copied data. -.SH RETURN VALUES -The -.BR libkeccak_zerocopy_update () -function does not return a value. -.SH ERRORS -The -.BR libkeccak_zerocopy_update () -function cannot fail. -.SH NOTES -Neither parameter by be -.I NULL -or 0. -.PP -It is safe call the -.BR libkeccak_zerocopy_update () -function before the -.BR libkeccak_update (3), -.BR libkeccak_fast_update (3) -.BR libkeccak_digest (3) -and -.BR libkeccak_fast_digest (3) -functions with the same -.I state -argument. However, calling the -.BR libkeccak_zerocopy_update () -function after the -.BR libkeccak_update (3) -or -.BR libkeccak_fast_update (3) -functions may cause the message -to be misread. -.SH NOTES -For cSHAKE, the -.BR libkeccak_cshake_initialise (3), -must be called, once, immediately after -state initialisation; before the first -call to the -.BR libkeccak_zerocopy_update () -function. -.SH SEE ALSO -.BR libkeccak_state_initialise (3), -.BR libkeccak_cshake_initialise (3), -.BR libkeccak_zerocopy_chunksize (3), -.BR libkeccak_fast_update (3), -.BR libkeccak_update (3), -.BR libkeccak_fast_digest (3), -.BR libkeccak_zerocopy_digest (3), -.BR libkeccak_digest (3) |