aboutsummaryrefslogtreecommitdiffstats
path: root/libkeccak_cshake_suffix.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2024-09-15 00:47:51 +0200
committerMattias Andrée <maandree@kth.se>2024-09-15 00:47:51 +0200
commitf14ba70de62cbd47e074756b1f1aec1f3b77a02d (patch)
tree4b4c27260816f553b7a1fe54153c06b122160ffc /libkeccak_cshake_suffix.3
parentSplit libkeccak.h and fix support for architectures that do not allow misaligned memory (diff)
downloadlibkeccak-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_cshake_suffix.3')
-rw-r--r--libkeccak_cshake_suffix.345
1 files changed, 0 insertions, 45 deletions
diff --git a/libkeccak_cshake_suffix.3 b/libkeccak_cshake_suffix.3
deleted file mode 100644
index b390134..0000000
--- a/libkeccak_cshake_suffix.3
+++ /dev/null
@@ -1,45 +0,0 @@
-.TH LIBKECCAK_CSHAKE_SUFFIX 3 LIBKECCAK
-.SH NAME
-libkeccak_cshake_suffix - Get message suffix for cSHAKE hashing
-.SH SYNOPSIS
-.nf
-#include <libkeccak.h>
-
-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)