diff options
Diffstat (limited to 'man3/libkeccak_state_free.3')
| -rw-r--r-- | man3/libkeccak_state_free.3 | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/man3/libkeccak_state_free.3 b/man3/libkeccak_state_free.3 new file mode 100644 index 0000000..e6dd3f8 --- /dev/null +++ b/man3/libkeccak_state_free.3 @@ -0,0 +1,51 @@ +.TH LIBKECCAK_STATE_FREE 3 LIBKECCAK +.SH NAME +libkeccak_state_free - Destroys and deallocates a hash state with erasure +.SH SYNOPSIS +.LP +.nf +#include <libkeccak.h> +.P +void +libkeccak_state_free(libkeccak_state_t *\fIstate\fP); +.fi +.P +Link with +.IR -lkeccak . +.SH DESCRIPTION +The +.BR libkeccak_state_free () +function releases the allocations stored in +.IR *state , +and also release the allocation of +.IR state . +.PP +The +.BR libkeccak_state_free () +function securely erases sensitive data. +.SH RETURN VALUES +The +.BR libkeccak_state_free () +function does not return any value. +.SH ERRORS +The +.BR libkeccak_state_free () +function cannot fail. +.SH NOTES +A double call to +.BR libkeccak_state_free () +will either result in a double free, +which is must likely to crash the process, +or free an allocation (that was created +between the calls) that was not intended +to be freed, resulting in undefined behaviour. +.SH SEE ALSO +.BR libkeccak_state_destroy (3), +.BR libkeccak_state_fast_free (3), +.BR libkeccak_state_create (3), +.BR libkeccak_state_initialise (3), +.BR libkeccak_state_reset (3), +.BR libkeccak_state_wipe (3) +.SH BUGS +Please report bugs to https://github.com/maandree/libkeccak/issues or to +maandree@kth.se |