aboutsummaryrefslogblamecommitdiffstats
path: root/doc/man/libkeccak_hmac_destroy.3
blob: 8960a3e256875b191c365715a4cab9442bf3d341 (plain) (tree)







































                                                                        
               
.TH LIBKECCAK_HMAC_DESTROY 3 LIBKECCAK-%VERSION%
.SH NAME
libkeccak_hmac_destroy - Destroys an HMAC-hashing state with erasure
.SH SYNOPSIS
.LP
.nf
#include <libkeccak.h>
.P
void libkeccak_hmac_destroy(libkeccak_hmac_state_t *\fIstate\fP);
.fi
.P
Link with \fI-lkeccak\fP.
.SH DESCRIPTION
The
.BR libkeccak_hmac_destroy ()
function releases the allocations stored in \fI*state\fP,
without releasing the allocation of \fIstate\fP itself.
.PP
The
.BR libkeccak_hmac_destroy ()
function securely erases sensitive data.
.SH RETURN VALUES
The
.BR libkeccak_hmac_destroy ()
function does not return any value.
.SH ERRORS
The
.BR libkeccak_hmac_destroy ()
function cannot fail.
.SH SEE ALSO
.BR libkeccak_hmac_free (3),
.BR libkeccak_hmac_fast_destroy (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@kth.se