aboutsummaryrefslogtreecommitdiffstats
path: root/libkeccak_hmac_initialise.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_hmac_initialise.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_hmac_initialise.3')
-rw-r--r--libkeccak_hmac_initialise.351
1 files changed, 0 insertions, 51 deletions
diff --git a/libkeccak_hmac_initialise.3 b/libkeccak_hmac_initialise.3
deleted file mode 100644
index db3590f..0000000
--- a/libkeccak_hmac_initialise.3
+++ /dev/null
@@ -1,51 +0,0 @@
-.TH LIBKECCAK_HMAC_INITIALISE 3 LIBKECCAK
-.SH NAME
-libkeccak_hmac_initialise - Initialise HMAC-hashing state
-.SH SYNOPSIS
-.nf
-#include <libkeccak.h>
-
-int libkeccak_hmac_initialise(struct libkeccak_hmac_state *\fIstate\fP, const struct libkeccak_spec *\fIspec\fP,
- const void *\fIkey\fP, size_t \fIkey_length\fP);
-.fi
-.PP
-Link with
-.IR -lkeccak .
-.SH DESCRIPTION
-The
-.BR libkeccak_hmac_initialise ()
-function initialises
-.I *state
-and sets the algorithm tuning parameters to
-those specified by
-.IR *spec ,
-and the key to
-.I key
-of length
-.IR key_length .
-.SH RETURN VALUES
-The
-.BR libkeccak_hmac_initialise ()
-function returns 0 upon successful completion.
-On error, -1 is returned and
-.I errno
-is set to describe the error.
-.SH ERRORS
-The
-.BR libkeccak_hmac_initialise ()
-function may fail for any specified for the functions
-.BR malloc (3)
-and
-.BR realloc (3).
-.SH SEE ALSO
-.BR libkeccak_hmac_create (3),
-.BR libkeccak_hmac_destroy (3),
-.BR libkeccak_hmac_fast_destroy (3),
-.BR libkeccak_hmac_copy (3),
-.BR libkeccak_spec_cshake (3),
-.BR libkeccak_spec_sha3 (3),
-.BR libkeccak_spec_shake (3),
-.BR libkeccak_spec_rawshake (3),
-.BR libkeccak_spec_check (3),
-.BR libkeccak_generalised_spec_initialise (3),
-.BR libkeccak_state_initialise (3)