aboutsummaryrefslogtreecommitdiffstats
path: root/libkeccak_state_destroy.3
diff options
context:
space:
mode:
Diffstat (limited to 'libkeccak_state_destroy.3')
-rw-r--r--libkeccak_state_destroy.338
1 files changed, 38 insertions, 0 deletions
diff --git a/libkeccak_state_destroy.3 b/libkeccak_state_destroy.3
new file mode 100644
index 0000000..2df1f49
--- /dev/null
+++ b/libkeccak_state_destroy.3
@@ -0,0 +1,38 @@
+.TH LIBKECCAK_STATE_DESTROY 3 LIBKECCAK
+.SH NAME
+libkeccak_state_destroy - Destroys a hash state with erasure
+.SH SYNOPSIS
+.nf
+#include <libkeccak.h>
+
+void libkeccak_state_destroy(libkeccak_state_t *\fIstate\fP);
+.fi
+.PP
+Link with
+.IR -lkeccak .
+.SH DESCRIPTION
+The
+.BR libkeccak_state_destroy ()
+function releases the allocations stored in
+.IR *state ,
+without releasing the allocation of
+.I state
+itself.
+.PP
+The
+.BR libkeccak_state_destroy ()
+function securely erases sensitive data.
+.SH RETURN VALUES
+The
+.BR libkeccak_state_destroy ()
+function does not return any value.
+.SH ERRORS
+The
+.BR libkeccak_state_destroy ()
+function cannot fail.
+.SH SEE ALSO
+.BR libkeccak_state_free (3),
+.BR libkeccak_state_fast_destroy (3),
+.BR libkeccak_state_initialise (3),
+.BR libkeccak_state_reset (3),
+.BR libkeccak_state_wipe (3)