diff options
Diffstat (limited to 'libkeccak_state_wipe.3')
-rw-r--r-- | libkeccak_state_wipe.3 | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/libkeccak_state_wipe.3 b/libkeccak_state_wipe.3 new file mode 100644 index 0000000..1ae2759 --- /dev/null +++ b/libkeccak_state_wipe.3 @@ -0,0 +1,32 @@ +.TH LIBKECCAK_STATE_WIPE 3 LIBKECCAK +.SH NAME +libkeccak_state_wipe - Securely erase sensitive data +.SH SYNOPSIS +.nf +#include <libkeccak.h> + +void libkeccak_state_wipe(libkeccak_state_t *\fIstate\fP); +.fi +.PP +Link with +.IR -lkeccak . +.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) |