aboutsummaryrefslogblamecommitdiffstats
path: root/doc/man/libkeccak_state_wipe.3
blob: aca7fdb4aada9eea2b7ddda49d153fc272a344f4 (plain) (tree)





































                                                                        
.TH LIBKECCAK_STATE_WIPE 3 LIBKECCAK-%VERSION%
.SH NAME
libkeccak_state_wipe - Securely erase sensitive data
.SH SYNOPSIS
.LP
.nf
#include <libkeccak.h>
.P
void libkeccak_state_wipe(libkeccak_state_t *\fIstate\fP);
.fi
.P
Link with \fI-lkeccak\fP.
.SH DESCRIPTION
The
.BR libkeccak_state_wipe ()
function securely erases data that may be
sensitive: the state of the Keccak sponge,
and the message chunk buffer.
.SH RETURN VALUES
The
.BR libkeccak_state_wipe ()
function does not return any value.
.SH ERRORS
The
.BR libkeccak_state_wipe ()
function cannot fail.
.SH SEE ALSO
.BR libkeccak_state_wipe_message (3),
.BR libkeccak_state_wipe_sponge (3),
.BR libkeccak_state_fast_destroy (3),
.BR libkeccak_state_destroy (3),
.BR libkeccak_state_reset (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