add libkeccak_state_create.3, libkeccak_state_fast_free.3 and libkeccak_state_free.3

Signed-off-by: Mattias Andrée <maandree@operamail.com>

6 files changed, 141 insertions, 0 deletions

diff --git a/doc/man/libkeccak_state_create.3 b/doc/man/libkeccak_state_create.3
new file mode 100644
index 0000000..ba8b522
--- /dev/null
+++ b/doc/man/libkeccak_state_create.3
@@ -0,0 +1,38 @@
+.TH LIBKECCAK_STATE_CREATE 3 LIBKECCAK-%VERSION%
+.SH NAME
+libkeccak_state_create - Allocate and initialise hash state
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+libkeccak_state_t *libkeccak_state_create(const libkeccak_spec_t *\fIspec\fP);
+.fi
+.P
+Link with \fI-lkeccak\fP.
+.SH DESCRIPTION
+The
+.BR libkeccak_state_create ()
+allocates a new \fIlibkeccak_state_t*\fP with one initialised element,
+and sets the algorithm tuning parameters to those specified by \fI*spec\fP.
+.SH RETURN VALUES
+The
+.BR libkeccak_state_create ()
+function return a new allocated \fIlibkeccak_state_t*\fP
+(of one initialised element). On error, \fINULL\fP is returned
+and \fIerrno\fP is set to describe the error.
+.SH ERRORS
+The
+.BR libkeccak_state_create ()
+function may fail for any specified for the function
+.BR malloc (3).
+.SH SEE ALSO
+.BR libkeccak_state_initialise (3),
+.BR libkeccak_state_free (3),
+.BR libkeccak_state_fast_free (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_destroy.3 b/doc/man/libkeccak_state_destroy.3
index d3ec35f..0ca2450 100644
--- a/doc/man/libkeccak_state_destroy.3
+++ b/doc/man/libkeccak_state_destroy.3
@@ -28,6 +28,7 @@ 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),
diff --git a/doc/man/libkeccak_state_fast_destroy.3 b/doc/man/libkeccak_state_fast_destroy.3
index 3f7964e..c3c98d0 100644
--- a/doc/man/libkeccak_state_fast_destroy.3
+++ b/doc/man/libkeccak_state_fast_destroy.3
@@ -28,6 +28,7 @@ The
 .BR libkeccak_state_fast_destroy ()
 function cannot fail.
 .SH SEE ALSO
+.BR libkeccak_state_fast_free (3),
 .BR libkeccak_state_destroy (3),
 .BR libkeccak_state_initialise (3),
 .BR libkeccak_state_reset (3),
diff --git a/doc/man/libkeccak_state_fast_free.3 b/doc/man/libkeccak_state_fast_free.3
new file mode 100644
index 0000000..b532d83
--- /dev/null
+++ b/doc/man/libkeccak_state_fast_free.3
@@ -0,0 +1,50 @@
+.TH LIBKECCAK_STATE_FAST_FREE 3 LIBKECCAK-%VERSION%
+.SH NAME
+libkeccak_state_fast_free - Destroys and deallocates a hash state without erasure
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+void libkeccak_state_fast_free(libkeccak_state_t *\fIstate\fP);
+.fi
+.P
+Link with \fI-lkeccak\fP.
+.SH DESCRIPTION
+The
+.BR libkeccak_state_fast_free ()
+function releases the allocations stored in \fI*state\fP,
+and also released the allocation of \fIstate\fP.
+.PP
+The
+.BR libkeccak_state_fast_free ()
+function does not securely erase sensitive data.
+.SH RETURN VALUES
+The
+.BR libkeccak_state_fast_free ()
+function does not return any value.
+.SH ERRORS
+The
+.BR libkeccak_state_fast_free ()
+function cannot fail.
+.SH NOTES
+A double call to
+.BR libkeccak_state_fast_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_fast_destroy (3),
+.BR libkeccak_state_free (3),
+.BR libkeccak_state_create (3),
+.BR libkeccak_state_initialise (3),
+.BR libkeccak_state_reset (3),
+.BR libkeccak_state_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
diff --git a/doc/man/libkeccak_state_free.3 b/doc/man/libkeccak_state_free.3
new file mode 100644
index 0000000..4263149
--- /dev/null
+++ b/doc/man/libkeccak_state_free.3
@@ -0,0 +1,50 @@
+.TH LIBKECCAK_STATE_FREE 3 LIBKECCAK-%VERSION%
+.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 \fI-lkeccak\fP.
+.SH DESCRIPTION
+The
+.BR libkeccak_state_free ()
+function releases the allocations stored in \fI*state\fP,
+and also release the allocation of \fIstate\fP.
+.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 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 effc2cd..bf04665 100644
--- a/doc/man/libkeccak_state_initialise.3
+++ b/doc/man/libkeccak_state_initialise.3
@@ -28,6 +28,7 @@ The
 function may fail for any specified for the function
 .BR malloc (3).
 .SH SEE ALSO
+.BR libkeccak_state_create (3),
 .BR libkeccak_state_reset (3),
 .BR libkeccak_state_destroy (3),
 .BR libkeccak_state_fast_destroy (3),