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_squeeze.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_squeeze.3')
| -rw-r--r-- | man3/libkeccak_squeeze.3 | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/man3/libkeccak_squeeze.3 b/man3/libkeccak_squeeze.3 new file mode 100644 index 0000000..1510bb3 --- /dev/null +++ b/man3/libkeccak_squeeze.3 @@ -0,0 +1,44 @@ +.TH LIBKECCAK_FAST_SQUEEZE 3 LIBKECCAK +.SH NAME +libkeccak_squeeze - Runs the squeeze phase +.SH SYNOPSIS +.nf +#include <libkeccak.h> + +void libkeccak_squeeze(struct libkeccak_state *\fIstate\fP, void *\fIhashsum\fP); +.fi +.PP +Link with +.IR -lkeccak . +.SH DESCRIPTION +The +.BR libkeccak_squeeze () +function runs the Keccak squeeze phase, on the the hash +process described by +.IR *state , +on stores a new digest, in binary form, in +.IR hashsum . +.PP +.I hashsum +has the same requirement as for the +.BR libkeccak_digest (3) +and +.BR libkeccak_fast_digest (3) +functions: it must have an allocation size of at least +.RI (( state->n ++ 7) / 8) bytes. However, it may not be +.IR NULL . +.SH RETURN VALUES +The +.BR libkeccak_squeeze () +function does not return any value. +.SH ERRORS +The +.BR libkeccak_squeeze () +function cannot fail. +.SH SEE ALSO +.BR libkeccak_digest (3), +.BR libkeccak_fast_digest (3), +.BR libkeccak_zerocopy_digest (3), +.BR libkeccak_simple_squeeze (3), +.BR libkeccak_fast_squeeze (3) |