diff options
author | Mattias Andrée <maandree@operamail.com> | 2015-10-11 13:39:39 +0200 |
---|---|---|
committer | Mattias Andrée <maandree@operamail.com> | 2015-10-11 13:39:39 +0200 |
commit | 46ccd59e30629517562b3a4cdc546be148769154 (patch) | |
tree | c5747220bbc1bccc7ce7107a43836bc53ad60e18 /doc | |
parent | add libkeccak_hmac_copy.3 and libkeccak_hmac_duplicate.3 (diff) | |
download | libkeccak-46ccd59e30629517562b3a4cdc546be148769154.tar.gz libkeccak-46ccd59e30629517562b3a4cdc546be148769154.tar.bz2 libkeccak-46ccd59e30629517562b3a4cdc546be148769154.tar.xz |
add libkeccak_hmac_marshal_size.3, libkeccak_hmac_marshal.3, libkeccak_hmac_unmarshal.3, and libkeccak_hmac_unmarshal_skip.3
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man/libkeccak_hmac_initialise.3 | 1 | ||||
-rw-r--r-- | doc/man/libkeccak_hmac_marshal.3 | 40 | ||||
-rw-r--r-- | doc/man/libkeccak_hmac_marshal_size.3 | 36 | ||||
-rw-r--r-- | doc/man/libkeccak_hmac_unmarshal.3 | 36 | ||||
-rw-r--r-- | doc/man/libkeccak_hmac_unmarshal_skip.3 | 40 |
5 files changed, 153 insertions, 0 deletions
diff --git a/doc/man/libkeccak_hmac_initialise.3 b/doc/man/libkeccak_hmac_initialise.3 index bb8d156..e141230 100644 --- a/doc/man/libkeccak_hmac_initialise.3 +++ b/doc/man/libkeccak_hmac_initialise.3 @@ -36,6 +36,7 @@ and .BR libkeccak_hmac_destroy (3), .BR libkeccak_hmac_fast_destroy (3), .BR libkeccak_hmac_copy (3), +.BR libkeccak_hmac_marshal_size (3), .BR libkeccak_spec_sha3 (3), .BR libkeccak_spec_shake (3), .BR libkeccak_spec_rawshake (3), diff --git a/doc/man/libkeccak_hmac_marshal.3 b/doc/man/libkeccak_hmac_marshal.3 new file mode 100644 index 0000000..0a070ae --- /dev/null +++ b/doc/man/libkeccak_hmac_marshal.3 @@ -0,0 +1,40 @@ +.TH LIBKECCAK_HMAC_MARSHAL 3 LIBKECCAK-%VERSION% +.SH NAME +libkeccak_hmac_marshal - Marshals an HMAC-hashing state +.SH SYNOPSIS +.LP +.nf +#include <libkeccak.h> +.P +size_t libkeccak_hmac_marshal(const libkeccak_hmac_state_t *\fIstate\fP, char *\fIdata\fP); +.fi +.P +Link with \fI-lkeccak\fP. +.SH DESCRIPTION +The +.BR libkeccak_hmac_marshal () +function marshals \fI*state\fP into the beginning +of \fIdata\fP. +.PP +Use the +.BR libkeccak_hmac_marshal_size (3) +function to get minimum usable allocation size +for \fIdata\fP. +.SH RETURN VALUES +The +.BR libkeccak_hmac_marshal () +returns the number of bytes written to \fIdata\fP. +.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) +.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_hmac_marshal_size.3 b/doc/man/libkeccak_hmac_marshal_size.3 new file mode 100644 index 0000000..5332fa0 --- /dev/null +++ b/doc/man/libkeccak_hmac_marshal_size.3 @@ -0,0 +1,36 @@ +.TH LIBKECCAK_HMAC_MARSHAL_SIZE 3 LIBKECCAK-%VERSION% +.SH NAME +libkeccak_hmac_marshal_size - Calculates the marshal-size of an HMAC-hashing state +.SH SYNOPSIS +.LP +.nf +#include <libkeccak.h> +.P +size_t libkeccak_hmac_marshal_size(const libkeccak_hmac_state_t *\fIstate\fP); +.fi +.P +Link with \fI-lkeccak\fP. +.SH DESCRIPTION +The +.BR libkeccak_hmac_marshal_size () +function calculates the number of bytes required +to marshal \fI*state\fP. +.SH RETURN VALUES +The +.BR libkeccak_hmac_marshal_size () +returns a positive value: the number of +bytes required to marshal the specified state. +.SH ERRORS +The +.BR libkeccak_hmac_marshal_size () +function cannot fail. +.SH SEE ALSO +.BR libkeccak_hmac_marshal (3), +.BR libkeccak_hmac_unmarshal (3), +.BR libkeccak_hmac_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_hmac_unmarshal.3 b/doc/man/libkeccak_hmac_unmarshal.3 new file mode 100644 index 0000000..816f9dc --- /dev/null +++ b/doc/man/libkeccak_hmac_unmarshal.3 @@ -0,0 +1,36 @@ +.TH LIBKECCAK_HMAC_UNMARSHAL 3 LIBKECCAK-%VERSION% +.SH NAME +libkeccak_hmac_unmarshal - Unharshals an HMAC-hashing state +.SH SYNOPSIS +.LP +.nf +#include <libkeccak.h> +.P +size_t libkeccak_hmac_unmarshal(libkeccak_hmac_state_t *\fIstate\fP, const char *\fIdata\fP); +.fi +.P +Link with \fI-lkeccak\fP. +.SH DESCRIPTION +The +.BR libkeccak_hmac_unmarshal () +function unmarshals an HMAC-hashing state from the beginning +of \fIdata\fP. and stores it in \fI*state\fP. +.SH RETURN VALUES +The +.BR libkeccak_hmac_unmarshal () +returns the number of bytes reads from \fIdata\fP. +.SH ERRORS +The +.BR libkeccak_hmac_unmarshal () +function may fail for any specified for the function +.BR malloc (3). +.SH SEE ALSO +.BR libkeccak_hmac_marshal_size (3), +.BR libkeccak_hmac_marshal (3), +.BR libkeccak_hmac_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_hmac_unmarshal_skip.3 b/doc/man/libkeccak_hmac_unmarshal_skip.3 new file mode 100644 index 0000000..22c5524 --- /dev/null +++ b/doc/man/libkeccak_hmac_unmarshal_skip.3 @@ -0,0 +1,40 @@ +.TH LIBKECCAK_HMAC_UNMARSHAL_SKIP 3 LIBKECCAK-%VERSION% +.SH NAME +libkeccak_hmac_unmarshal_skip - Calculates the marshal-size of a marshalled HMAC-hashing state +.SH SYNOPSIS +.LP +.nf +#include <libkeccak.h> +.P +size_t libkeccak_hmac_unmarshal_skip(const char *\fIdata\fP); +.fi +.P +Link with \fI-lkeccak\fP. +.SH DESCRIPTION +The +.BR libkeccak_hmac_unmarshal_skip () +function gets the number of bytes with which +the HMAC-hashing 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_hmac_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_hmac_unmarshal_skip () +function cannot fail. +.SH SEE ALSO +.BR libkeccak_hmac_marshal_size (3), +.BR libkeccak_hmac_marshal (3), +.BR libkeccak_hmac_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 |