aboutsummaryrefslogtreecommitdiffstats
path: root/libkeccak_hmac_create.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_create.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_create.3')
-rw-r--r--libkeccak_hmac_create.347
1 files changed, 0 insertions, 47 deletions
diff --git a/libkeccak_hmac_create.3 b/libkeccak_hmac_create.3
deleted file mode 100644
index d804f31..0000000
--- a/libkeccak_hmac_create.3
+++ /dev/null
@@ -1,47 +0,0 @@
-.TH LIBKECCAK_HMAC_CREATE 3 LIBKECCAK
-.SH NAME
-libkeccak_hmac_create - Allocate and initialise HMAC-hashing state
-.SH SYNOPSIS
-.nf
-#include <libkeccak.h>
-
-struct libkeccak_hmac_state *libkeccak_hmac_create(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_create ()
-function allocates a new
-.I struct libkeccak_hmac_state *
-with one initialised element, 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_create ()
-function returns a newly allocated
-.I struct libkeccak_hmac_state *
-(of one initialised element) upon successful completion.
-On error,
-.I NULL
-is returned and
-.I errno
-is set to describe the error.
-.SH ERRORS
-The
-.BR libkeccak_hmac_create ()
-function may fail for any specified for the functions
-.BR malloc (3)
-and
-.BR realloc (3).
-.SH SEE ALSO
-.BR libkeccak_hmac_initialise (3),
-.BR libkeccak_hmac_free (3),
-.BR libkeccak_hmac_fast_free (3),
-.BR libkeccak_hmac_duplicate (3)