diff options
| author | Mattias Andrée <maandree@operamail.com> | 2015-10-11 13:21:56 +0200 |
|---|---|---|
| committer | Mattias Andrée <maandree@operamail.com> | 2015-10-11 13:21:56 +0200 |
| commit | 794e213c173da0c56f5e2c234c629b1eb27440ad (patch) | |
| tree | d39ee2fbd8c0f386a9e74fd1a8c6c90e1694313c /doc/man/libkeccak_hmac_destroy.3 | |
| parent | update todo (diff) | |
| download | libkeccak-794e213c173da0c56f5e2c234c629b1eb27440ad.tar.gz libkeccak-794e213c173da0c56f5e2c234c629b1eb27440ad.tar.bz2 libkeccak-794e213c173da0c56f5e2c234c629b1eb27440ad.tar.xz | |
add libkeccak_hmac_fast_destroy.3, libkeccak_hmac_destroy.3, libkeccak_hmac_fast_free.3, and libkeccak_hmac_free.3
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to 'doc/man/libkeccak_hmac_destroy.3')
| -rw-r--r-- | doc/man/libkeccak_hmac_destroy.3 | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/doc/man/libkeccak_hmac_destroy.3 b/doc/man/libkeccak_hmac_destroy.3 new file mode 100644 index 0000000..292b122 --- /dev/null +++ b/doc/man/libkeccak_hmac_destroy.3 @@ -0,0 +1,41 @@ +.TH LIBKECCAK_HMAC_DESTROY 3 LIBKECCAK-%VERSION% +.SH NAME +libkeccak_hmac_destroy - Destroys an HMAC-hashing state with erasure +.SH SYNOPSIS +.LP +.nf +#include <libkeccak.h> +.P +void libkeccak_hmac_destroy(libkeccak_hmac_state_t *\fIstate\fP); +.fi +.P +Link with \fI-lkeccak\fP. +.SH DESCRIPTION +The +.BR libkeccak_hmac_destroy () +function releases the allocations stored in \fI*state\fP, +without releasing the allocation of \fIstate\fP itself. +.PP +The +.BR libkeccak_hmac_destroy () +function securely erases sensitive data. +.SH RETURN VALUES +The +.BR libkeccak_hmac_destroy () +function does not return any value. +.SH ERRORS +The +.BR libkeccak_hmac_destroy () +function cannot fail. +.SH SEE ALSO +.BR libkeccak_hmac_free (3), +.BR libkeccak_hmac_fast_destroy (3), +.BR libkeccak_hmac_initialise (3), +.BR libkeccak_hmac_reset (3), +.BR libkeccak_hmac_wipe (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 |