diff options
| author | Mattias Andrée <maandree@kth.se> | 2017-02-10 15:46:21 +0100 |
|---|---|---|
| committer | Mattias Andrée <maandree@kth.se> | 2017-02-10 15:46:21 +0100 |
| commit | 82afa682cfaaa09c3564299fc9f709e80081c661 (patch) | |
| tree | 572c313ddc8f219a1c5fcd18b7b59633256fca0a /doc/man/libkeccak_hmac_wipe.3 | |
| parent | bump year and change e-mail (diff) | |
| download | libkeccak-82afa682cfaaa09c3564299fc9f709e80081c661.tar.gz libkeccak-82afa682cfaaa09c3564299fc9f709e80081c661.tar.bz2 libkeccak-82afa682cfaaa09c3564299fc9f709e80081c661.tar.xz | |
Work on man pages
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to '')
| -rw-r--r-- | doc/man/libkeccak_hmac_wipe.3 | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/doc/man/libkeccak_hmac_wipe.3 b/doc/man/libkeccak_hmac_wipe.3 new file mode 100644 index 0000000..bad351b --- /dev/null +++ b/doc/man/libkeccak_hmac_wipe.3 @@ -0,0 +1,36 @@ +.TH LIBKECCAK_HMAC_WIPE 3 LIBKECCAK +.SH NAME +libkeccak_hmac_wipe - Securely erase sensitive data from a HMAC-hashing state +.SH SYNOPSIS +.LP +.nf +#include <libkeccak.h> +.P +int +libkeccak_hmac_wipe(libkeccak_hmac_state_t *\fIstate\fP); +.fi +.P +Link with +.IR -lkeccak . +.SH DESCRIPTION +The +.BR libkeccak_hmac_wipe () +function securely erases data that may be +sensitive: the buffer and the state of the +underlaying hash-algorithm. +.SH RETURN VALUES +The +.BR libkeccak_hmac_wipe () +function does not return any value. +.SH ERRORS +The +.BR libkeccak_hmac_wipe () +function cannot fail. +.SH SEE ALSO +.BR libkeccak_hmac_fast_free (3), +.BR libkeccak_hmac_free (3), +.BR libkeccak_hmac_fast_destroy (3), +.BR libkeccak_hmac_destroy (3) +.SH BUGS +Please report bugs to https://github.com/maandree/libkeccak/issues or to +maandree@kth.se |