aboutsummaryrefslogtreecommitdiffstats
path: root/man3/libkeccak_hmac_fast_free.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2019-02-09 21:56:53 +0100
committerMattias Andrée <maandree@kth.se>2019-02-09 21:56:53 +0100
commit7085817a3d356f7c3240fe1d616a5b1f1b56e38a (patch)
tree9bfebc7c3330d99410cc8a73af3ee2f21e386be0 /man3/libkeccak_hmac_fast_free.3
parentRemove texinfo file (it was truncated anyhow for some reason) (diff)
downloadlibkeccak-7085817a3d356f7c3240fe1d616a5b1f1b56e38a.tar.gz
libkeccak-7085817a3d356f7c3240fe1d616a5b1f1b56e38a.tar.bz2
libkeccak-7085817a3d356f7c3240fe1d616a5b1f1b56e38a.tar.xz
Fix makefile add add OSCONFIGFILE
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'man3/libkeccak_hmac_fast_free.3')
-rw-r--r--man3/libkeccak_hmac_fast_free.351
1 files changed, 51 insertions, 0 deletions
diff --git a/man3/libkeccak_hmac_fast_free.3 b/man3/libkeccak_hmac_fast_free.3
new file mode 100644
index 0000000..b4817ce
--- /dev/null
+++ b/man3/libkeccak_hmac_fast_free.3
@@ -0,0 +1,51 @@
+.TH LIBKECCAK_STATE_FAST_FREE 3 LIBKECCAK
+.SH NAME
+libkeccak_hmac_fast_free - Destroys and deallocates an HMAC-hashing state without erasure
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+void
+libkeccak_hmac_fast_free(libkeccak_hmac_state_t *\fIstate\fP);
+.fi
+.P
+Link with
+.IR -lkeccak .
+.SH DESCRIPTION
+The
+.BR libkeccak_hmac_fast_free ()
+function releases the allocations stored in
+.IR *state ,
+and also released the allocation of
+.IR state .
+.PP
+The
+.BR libkeccak_hmac_fast_free ()
+function does not securely erase sensitive data.
+.SH RETURN VALUES
+The
+.BR libkeccak_hmac_fast_free ()
+function does not return any value.
+.SH ERRORS
+The
+.BR libkeccak_hmac_fast_free ()
+function cannot fail.
+.SH NOTES
+A double call to
+.BR libkeccak_hmac_fast_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_fast_destroy (3),
+.BR libkeccak_hmac_free (3),
+.BR libkeccak_hmac_create (3),
+.BR libkeccak_hmac_initialise (3),
+.BR libkeccak_hmac_reset (3),
+.BR libkeccak_hmac_wipe (3)
+.SH BUGS
+Please report bugs to https://github.com/maandree/libkeccak/issues or to
+maandree@kth.se