aboutsummaryrefslogtreecommitdiffstats
path: root/libkeccak_squeeze.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2019-02-11 16:22:00 +0100
committerMattias Andrée <maandree@kth.se>2019-02-11 16:22:00 +0100
commit5ff4c5af715d098852d124de116d354ee10f4ea4 (patch)
tree5789ad5798f2dbf21d9406a2942e48b222f773ae /libkeccak_squeeze.3
parentRemove old file (diff)
downloadlibkeccak-5ff4c5af715d098852d124de116d354ee10f4ea4.tar.gz
libkeccak-5ff4c5af715d098852d124de116d354ee10f4ea4.tar.bz2
libkeccak-5ff4c5af715d098852d124de116d354ee10f4ea4.tar.xz
Split most .c files into one per function and flatten file hierarchy
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'libkeccak_squeeze.3')
-rw-r--r--libkeccak_squeeze.343
1 files changed, 43 insertions, 0 deletions
diff --git a/libkeccak_squeeze.3 b/libkeccak_squeeze.3
new file mode 100644
index 0000000..67430a4
--- /dev/null
+++ b/libkeccak_squeeze.3
@@ -0,0 +1,43 @@
+.TH LIBKECCAK_FAST_SQUEEZE 3 LIBKECCAK
+.SH NAME
+libkeccak_squeeze - Runs the squeeze phase
+.SH SYNOPSIS
+.nf
+#include <libkeccak.h>
+
+void libkeccak_squeeze(libkeccak_state_t *\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_simple_squeeze (3),
+.BR libkeccak_fast_squeeze (3)