From f14ba70de62cbd47e074756b1f1aec1f3b77a02d Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Sun, 15 Sep 2024 00:47:51 +0200 Subject: Move man pages into man3/ and man7/ MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- man3/libkeccak_cshake_suffix.3 | 45 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 man3/libkeccak_cshake_suffix.3 (limited to 'man3/libkeccak_cshake_suffix.3') diff --git a/man3/libkeccak_cshake_suffix.3 b/man3/libkeccak_cshake_suffix.3 new file mode 100644 index 0000000..b390134 --- /dev/null +++ b/man3/libkeccak_cshake_suffix.3 @@ -0,0 +1,45 @@ +.TH LIBKECCAK_CSHAKE_SUFFIX 3 LIBKECCAK +.SH NAME +libkeccak_cshake_suffix - Get message suffix for cSHAKE hashing +.SH SYNOPSIS +.nf +#include + +const char *libkeccak_cshake_suffix(size_t \fInlen\fP, size_t \fIslen\fP); +.fi +.PP +Link with +.IR -lkeccak . +.SH DESCRIPTION +The +.BR libkeccak_cshake_suffix () +function returns a string of '1':s and '0':s +representing the bits the the message suffixed +that shall be used. +Canonically, the values of the +.I nlen +and +.I slen +parameters shall be the length of the cSHAKE +function-name bit-string and the cSHAKE +customisation bit-string, however, the function +will only check whether these values are zero +or non-zero. +.SH RETURN VALUES +The +.BR libkeccak_cshake_suffix () +function returns a statically allocated, +read-only, message suffix bit-string +that shall be used. +.SH ERRORS +The +.BR libkeccak_cshake_suffix () +function cannot fail. +.SH SEE ALSO +.BR libkeccak_spec_cshake (3), +.BR libkeccak_generalised_spec_initialise (3), +.BR libkeccak_state_initialise (3), +.BR libkeccak_cshake_initialise (3), +.BR libkeccak_fast_digest (3), +.BR libkeccak_zerocopy_digest (3), +.BR libkeccak_digest (3) -- cgit v1.2.3-70-g09d2