aboutsummaryrefslogtreecommitdiffstats
path: root/libkeccak_hmac_free.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_free.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_free.3')
-rw-r--r--libkeccak_hmac_free.346
1 files changed, 0 insertions, 46 deletions
diff --git a/libkeccak_hmac_free.3 b/libkeccak_hmac_free.3
deleted file mode 100644
index 91b103e..0000000
--- a/libkeccak_hmac_free.3
+++ /dev/null
@@ -1,46 +0,0 @@
-.TH LIBKECCAK_HMAC_FREE 3 LIBKECCAK
-.SH NAME
-libkeccak_hmac_free - Destroys and deallocates an HMAC-hashing state with erasure
-.SH SYNOPSIS
-.nf
-#include <libkeccak.h>
-
-void libkeccak_hmac_free(struct libkeccak_hmac_state *\fIstate\fP);
-.fi
-.PP
-Link with
-.IR -lkeccak .
-.SH DESCRIPTION
-The
-.BR libkeccak_hmac_free ()
-function releases the allocations stored in
-.IR *state ,
-and also release the allocation of
-.IR state .
-.PP
-The
-.BR libkeccak_hmac_free ()
-function securely erases sensitive data.
-.SH RETURN VALUES
-The
-.BR libkeccak_hmac_free ()
-function does not return any value.
-.SH ERRORS
-The
-.BR libkeccak_hmac_free ()
-function cannot fail.
-.SH NOTES
-A double call to
-.BR libkeccak_hmac_free ()
-will either result in a double free,
-which is must likely to crash the process,
-or free an allocation (that was created
-between the calls) that was not intended
-to be freed, resulting in undefined behaviour.
-.SH SEE ALSO
-.BR libkeccak_hmac_destroy (3),
-.BR libkeccak_hmac_fast_free (3),
-.BR libkeccak_hmac_create (3),
-.BR libkeccak_hmac_initialise (3),
-.BR libkeccak_hmac_reset (3),
-.BR libkeccak_hmac_wipe (3)