From f14ba70de62cbd47e074756b1f1aec1f3b77a02d Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Sun, 15 Sep 2024 00:47:51 +0200 Subject: Move man pages into man3/ and man7/ MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- man3/libkeccak_hmac_fast_free.3 | 46 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 man3/libkeccak_hmac_fast_free.3 (limited to 'man3/libkeccak_hmac_fast_free.3') diff --git a/man3/libkeccak_hmac_fast_free.3 b/man3/libkeccak_hmac_fast_free.3 new file mode 100644 index 0000000..87cb556 --- /dev/null +++ b/man3/libkeccak_hmac_fast_free.3 @@ -0,0 +1,46 @@ +.TH LIBKECCAK_STATE_FAST_FREE 3 LIBKECCAK +.SH NAME +libkeccak_hmac_fast_free - Destroys and deallocates an HMAC-hashing state without erasure +.SH SYNOPSIS +.nf +#include + +void libkeccak_hmac_fast_free(struct libkeccak_hmac_state *\fIstate\fP); +.fi +.PP +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) -- cgit v1.2.3-70-g09d2