diff options
| author | Mattias Andrée <maandree@kth.se> | 2017-10-14 01:01:14 +0200 |
|---|---|---|
| committer | Mattias Andrée <maandree@kth.se> | 2017-10-14 01:01:14 +0200 |
| commit | 3e1864aa14a33a3c917537a241f6a032cfcacf78 (patch) | |
| tree | 25297b1363fa88c9f45b5102afa5e95d08e986c1 /man/libkeccak_state_wipe.3 | |
| parent | Change style and license (diff) | |
| download | libkeccak-3e1864aa14a33a3c917537a241f6a032cfcacf78.tar.gz libkeccak-3e1864aa14a33a3c917537a241f6a032cfcacf78.tar.bz2 libkeccak-3e1864aa14a33a3c917537a241f6a032cfcacf78.tar.xz | |
General improvements
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'man/libkeccak_state_wipe.3')
| -rw-r--r-- | man/libkeccak_state_wipe.3 | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/man/libkeccak_state_wipe.3 b/man/libkeccak_state_wipe.3 new file mode 100644 index 0000000..664cd51 --- /dev/null +++ b/man/libkeccak_state_wipe.3 @@ -0,0 +1,37 @@ +.TH LIBKECCAK_STATE_WIPE 3 LIBKECCAK +.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 +.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) +.SH BUGS +Please report bugs to https://github.com/maandree/libkeccak/issues or to +maandree@kth.se |