diff options
Diffstat (limited to '')
| -rw-r--r-- | doc/man/libkeccak_hmac_free.3 | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/doc/man/libkeccak_hmac_free.3 b/doc/man/libkeccak_hmac_free.3 new file mode 100644 index 0000000..6395f22 --- /dev/null +++ b/doc/man/libkeccak_hmac_free.3 @@ -0,0 +1,50 @@ +.TH LIBKECCAK_HMAC_FREE 3 LIBKECCAK-%VERSION% +.SH NAME +libkeccak_hmac_free - Destroys and deallocates an HMAC-hashing state with erasure +.SH SYNOPSIS +.LP +.nf +#include <libkeccak.h> +.P +void libkeccak_hmac_free(libkeccak_hmac_state_t *\fIstate\fP); +.fi +.P +Link with \fI-lkeccak\fP. +.SH DESCRIPTION +The +.BR libkeccak_hmac_free () +function releases the allocations stored in \fI*state\fP, +and also release the allocation of \fIstate\fP. +.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) +.SH AUTHORS +Principal author, Mattias Andrée. See the LICENSE file for the full +list of authors. +.SH BUGS +Please report bugs to https://github.com/maandree/libkeccak/issues or to +maandree@member.fsf.org |