aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man/libkeccak_state_wipe.3
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--doc/man/libkeccak_state_wipe.338
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/man/libkeccak_state_wipe.3 b/doc/man/libkeccak_state_wipe.3
new file mode 100644
index 0000000..aca7fdb
--- /dev/null
+++ b/doc/man/libkeccak_state_wipe.3
@@ -0,0 +1,38 @@
+.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