From d2dd4dd1a5726b1382401bedfa5fde9b0719595f Mon Sep 17 00:00:00 2001
From: Mattias Andrée <maandree@operamail.com>
Date: Tue, 6 Oct 2015 18:06:25 +0200
Subject: add libkeccak_state_destroy.3 and libkeccak_state_fast_destroy.3
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Mattias Andrée <maandree@operamail.com>
---
 doc/man/libkeccak_state_destroy.3      | 39 ++++++++++++++++++++++++++++++++++
 doc/man/libkeccak_state_fast_destroy.3 | 39 ++++++++++++++++++++++++++++++++++
 doc/man/libkeccak_state_initialise.3   |  2 ++
 doc/man/libkeccak_state_reset.3        |  4 +++-
 4 files changed, 83 insertions(+), 1 deletion(-)
 create mode 100644 doc/man/libkeccak_state_destroy.3
 create mode 100644 doc/man/libkeccak_state_fast_destroy.3

(limited to 'doc')

diff --git a/doc/man/libkeccak_state_destroy.3 b/doc/man/libkeccak_state_destroy.3
new file mode 100644
index 0000000..9ea81fa
--- /dev/null
+++ b/doc/man/libkeccak_state_destroy.3
@@ -0,0 +1,39 @@
+.TH LIBKECCAK_STATE_DESTROY 3 LIBKECCAK-%VERSION%
+.SH NAME
+libkeccak_state_destroy - Destroys a hash state with erasure
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+void libkeccak_state_destroy(libkeccak_state_t *\fIstate\fP);
+.fi
+.P
+Link with \fI-lkeccak\fP.
+.SH DESCRIPTION
+The
+.BR libkeccak_state_destroy ()
+function releases the allocations stored in \fI*state\fP,
+without releasing the allocation of \fIstate\fP 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_fast_destroy (3),
+.BR libkeccak_state_initialise (3),
+.BR libkeccak_state_reset (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
diff --git a/doc/man/libkeccak_state_fast_destroy.3 b/doc/man/libkeccak_state_fast_destroy.3
new file mode 100644
index 0000000..230e703
--- /dev/null
+++ b/doc/man/libkeccak_state_fast_destroy.3
@@ -0,0 +1,39 @@
+.TH LIBKECCAK_STATE_FAST_DESTROY 3 LIBKECCAK-%VERSION%
+.SH NAME
+libkeccak_state_fast_destroy - Destroys a hash state without erasure
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+void libkeccak_state_fast_destroy(libkeccak_state_t *\fIstate\fP);
+.fi
+.P
+Link with \fI-lkeccak\fP.
+.SH DESCRIPTION
+The
+.BR libkeccak_state_fast_destroy ()
+function releases the allocations stored in \fI*state\fP,
+without releasing the allocation of \fIstate\fP itself.
+.PP
+The
+.BR libkeccak_state_fast_destroy ()
+function does not securely erase sensitive data.
+.SH RETURN VALUES
+The
+.BR libkeccak_state_fast_destroy ()
+function does not return any value.
+.SH ERRORS
+The
+.BR libkeccak_state_fast_destroy ()
+function cannot fail.
+.SH SEE ALSO
+.BR libkeccak_state_destroy (3),
+.BR libkeccak_state_initialise (3),
+.BR libkeccak_state_reset (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
diff --git a/doc/man/libkeccak_state_initialise.3 b/doc/man/libkeccak_state_initialise.3
index 788117d..effc2cd 100644
--- a/doc/man/libkeccak_state_initialise.3
+++ b/doc/man/libkeccak_state_initialise.3
@@ -29,6 +29,8 @@ function may fail for any specified for the function
 .BR malloc (3).
 .SH SEE ALSO
 .BR libkeccak_state_reset (3),
+.BR libkeccak_state_destroy (3),
+.BR libkeccak_state_fast_destroy (3),
 .BR libkeccak_generalised_sum_fd (3),
 .BR libkeccak_keccaksum_fd (3),
 .BR libkeccak_sha3sum_fd (3),
diff --git a/doc/man/libkeccak_state_reset.3 b/doc/man/libkeccak_state_reset.3
index c44a83f..1bcf8b3 100644
--- a/doc/man/libkeccak_state_reset.3
+++ b/doc/man/libkeccak_state_reset.3
@@ -24,7 +24,9 @@ The
 .BR libkeccak_state_reset ()
 function cannot fail.
 .SH SEE ALSO
-.BR libkeccak_state_initialise (3)
+.BR libkeccak_state_initialise (3),
+.BR libkeccak_state_destroy (3),
+.BR libkeccak_state_fast_destroy (3)
 .SH AUTHORS
 Principal author, Mattias Andrée.  See the LICENSE file for the full
 list of authors.
-- 
cgit v1.2.3-70-g09d2