add libkeccak_state_marshal.3, libkeccak_state_marshal_size.3, libkeccak_state_unmarshal.3, and libkeccak_state_unmarshal_skip.3

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

5 files changed, 154 insertions, 1 deletions

diff --git a/doc/man/libkeccak_state_initialise.3 b/doc/man/libkeccak_state_initialise.3
index 6c39f7e..be7b577 100644
--- a/doc/man/libkeccak_state_initialise.3
+++ b/doc/man/libkeccak_state_initialise.3
@@ -42,7 +42,8 @@ function may fail for any specified for the function
 .BR libkeccak_spec_shake (3),
 .BR libkeccak_spec_rawshake (3),
 .BR libkeccak_spec_check (3),
-.BR libkeccak_generalised_spec_initialise (3)
+.BR libkeccak_generalised_spec_initialise (3),
+.BR libkeccak_state_marshal_size (3)
 .SH AUTHORS
 Principal author, Mattias Andrée.  See the LICENSE file for the full
 list of authors.
diff --git a/doc/man/libkeccak_state_marshal.3 b/doc/man/libkeccak_state_marshal.3
new file mode 100644
index 0000000..52c8502
--- /dev/null
+++ b/doc/man/libkeccak_state_marshal.3
@@ -0,0 +1,40 @@
+.TH LIBKECCAK_STATE_MARSHAL 3 LIBKECCAK-%VERSION%
+.SH NAME
+libkeccak_state_marshal - Marshals a hash state
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+size_t libkeccak_state_marshal(const libkeccak_state_t *\fIstate\fP, char *\fIdata\fP);
+.fi
+.P
+Link with \fI-lkeccak\fP.
+.SH DESCRIPTION
+The
+.BR libkeccak_state_marshal ()
+function marshals \fI*state\fP into the beginning
+of \fIdata\fP.
+.PP
+Use the
+.BR libkeccak_state_marshal_size (3)
+function to get minimum usable allocation size
+for \fIdata\fP.
+.SH RETURN VALUES
+The
+.BR libkeccak_state_marshal ()
+returns the number of bytes written to \fIdata\fP.
+.SH ERRORS
+The
+.BR libkeccak_state_marshal ()
+function cannot fail.
+.SH SEE ALSO
+.BR libkeccak_state_marshal_size (3),
+.BR libkeccak_state_unmarshal (3),
+.BR libkeccak_state_unmarshal_skip (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_marshal_size.3 b/doc/man/libkeccak_state_marshal_size.3
new file mode 100644
index 0000000..698053c
--- /dev/null
+++ b/doc/man/libkeccak_state_marshal_size.3
@@ -0,0 +1,36 @@
+.TH LIBKECCAK_STATE_MARSHAL_SIZE 3 LIBKECCAK-%VERSION%
+.SH NAME
+libkeccak_state_marshal_size - Calculates the marshal-size of a hash state
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+size_t libkeccak_state_marshal_size(const libkeccak_state_t *\fIstate\fP);
+.fi
+.P
+Link with \fI-lkeccak\fP.
+.SH DESCRIPTION
+The
+.BR libkeccak_state_marshal_size ()
+function calculates the number of bytes required
+to marshal \fI*state\fP.
+.SH RETURN VALUES
+The
+.BR libkeccak_state_marshal_size ()
+returns a positive value: the number of
+bytes required to marshal the specified state.
+.SH ERRORS
+The
+.BR libkeccak_state_marshal_size ()
+function cannot fail.
+.SH SEE ALSO
+.BR libkeccak_state_marshal (3),
+.BR libkeccak_state_unmarshal (3),
+.BR libkeccak_state_unmarshal_skip (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_unmarshal.3 b/doc/man/libkeccak_state_unmarshal.3
new file mode 100644
index 0000000..fa96951
--- /dev/null
+++ b/doc/man/libkeccak_state_unmarshal.3
@@ -0,0 +1,36 @@
+.TH LIBKECCAK_STATE_UNMARSHAL 3 LIBKECCAK-%VERSION%
+.SH NAME
+libkeccak_state_unmarshal - Unharshals a hash state
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+size_t libkeccak_state_unmarshal(libkeccak_state_t *\fIstate\fP, const char *\fIdata\fP);
+.fi
+.P
+Link with \fI-lkeccak\fP.
+.SH DESCRIPTION
+The
+.BR libkeccak_state_unmarshal ()
+function unmarshals a hash state from the beginning
+of \fIdata\fP. and stores it in \fI*state\fP.
+.SH RETURN VALUES
+The
+.BR libkeccak_state_unmarshal ()
+returns the number of bytes reads from \fIdata\fP.
+.SH ERRORS
+The
+.BR libkeccak_state_unmarshal ()
+function may fail for any specified for the function
+.BR malloc (3).
+.SH SEE ALSO
+.BR libkeccak_state_marshal_size (3),
+.BR libkeccak_state_marshal (3),
+.BR libkeccak_state_unmarshal_skip (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_unmarshal_skip.3 b/doc/man/libkeccak_state_unmarshal_skip.3
new file mode 100644
index 0000000..f5630cb
--- /dev/null
+++ b/doc/man/libkeccak_state_unmarshal_skip.3
@@ -0,0 +1,40 @@
+.TH LIBKECCAK_STATE_UNMARSHAL_SKIP 3 LIBKECCAK-%VERSION%
+.SH NAME
+libkeccak_state_unmarshal_skip - Calculates the marshal-size of a marshalled hash state
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+size_t libkeccak_state_unmarshal_skip(const char *\fIdata\fP);
+.fi
+.P
+Link with \fI-lkeccak\fP.
+.SH DESCRIPTION
+The
+.BR libkeccak_state_unmarshal_skip ()
+function gets the number of bytes with which
+the hash state in the beginning of \fIdata\fP
+is store stored. This is useful if you do not
+want to unmarshal the state.
+.SH RETURN VALUES
+The
+.BR libkeccak_state_unmarshal_skip ()
+returns a positive value: the number of
+bytes to skip forward to skip pass the
+hash state stored at the beginning of
+the buffer.
+.SH ERRORS
+The
+.BR libkeccak_state_unmarshal_skip ()
+function cannot fail.
+.SH SEE ALSO
+.BR libkeccak_state_marshal_size (3),
+.BR libkeccak_state_marshal (3),
+.BR libkeccak_state_unmarshal (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