aboutsummaryrefslogtreecommitdiffstats
path: root/libkeccak_hmac_marshal.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2019-02-11 16:22:00 +0100
committerMattias Andrée <maandree@kth.se>2019-02-11 16:22:00 +0100
commit5ff4c5af715d098852d124de116d354ee10f4ea4 (patch)
tree5789ad5798f2dbf21d9406a2942e48b222f773ae /libkeccak_hmac_marshal.3
parentRemove old file (diff)
downloadlibkeccak-5ff4c5af715d098852d124de116d354ee10f4ea4.tar.gz
libkeccak-5ff4c5af715d098852d124de116d354ee10f4ea4.tar.bz2
libkeccak-5ff4c5af715d098852d124de116d354ee10f4ea4.tar.xz
Split most .c files into one per function and flatten file hierarchy
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'libkeccak_hmac_marshal.3')
-rw-r--r--libkeccak_hmac_marshal.338
1 files changed, 38 insertions, 0 deletions
diff --git a/libkeccak_hmac_marshal.3 b/libkeccak_hmac_marshal.3
new file mode 100644
index 0000000..2e31dd7
--- /dev/null
+++ b/libkeccak_hmac_marshal.3
@@ -0,0 +1,38 @@
+.TH LIBKECCAK_HMAC_MARSHAL 3 LIBKECCAK
+.SH NAME
+libkeccak_hmac_marshal - Marshals an HMAC-hashing state
+.SH SYNOPSIS
+.nf
+#include <libkeccak.h>
+
+size_t libkeccak_hmac_marshal(const libkeccak_hmac_state_t *\fIstate\fP, void *\fIdata\fP);
+.fi
+.PP
+Link with
+.IR -lkeccak .
+.SH DESCRIPTION
+The
+.BR libkeccak_hmac_marshal ()
+function marshals
+.I *state
+into the beginning of
+.IR data .
+.PP
+Use the
+.BR libkeccak_hmac_marshal_size (3)
+function to get minimum usable allocation size
+for
+.IR data .
+.SH RETURN VALUES
+The
+.BR libkeccak_hmac_marshal ()
+returns the number of bytes written to
+.IR data .
+.SH ERRORS
+The
+.BR libkeccak_hmac_marshal ()
+function cannot fail.
+.SH SEE ALSO
+.BR libkeccak_hmac_marshal_size (3),
+.BR libkeccak_hmac_unmarshal (3),
+.BR libkeccak_hmac_unmarshal_skip (3)