diff options
| author | Mattias Andrée <maandree@operamail.com> | 2015-10-11 13:30:39 +0200 |
|---|---|---|
| committer | Mattias Andrée <maandree@operamail.com> | 2015-10-11 13:30:39 +0200 |
| commit | 82faa3c34fd0070272933e2214c4c8cc848367d6 (patch) | |
| tree | be56adcf6516a5b3d9caaa8d47b315d0f3d418b1 /doc | |
| parent | add libkeccak_hmac_fast_destroy.3, libkeccak_hmac_destroy.3, libkeccak_hmac_fast_free.3, and libkeccak_hmac_free.3 (diff) | |
| download | libkeccak-82faa3c34fd0070272933e2214c4c8cc848367d6.tar.gz libkeccak-82faa3c34fd0070272933e2214c4c8cc848367d6.tar.bz2 libkeccak-82faa3c34fd0070272933e2214c4c8cc848367d6.tar.xz | |
add libkeccak_hmac_copy.3 and libkeccak_hmac_duplicate.3
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man/libkeccak_hmac_copy.3 | 40 | ||||
| -rw-r--r-- | doc/man/libkeccak_hmac_duplicate.3 | 40 |
2 files changed, 80 insertions, 0 deletions
diff --git a/doc/man/libkeccak_hmac_copy.3 b/doc/man/libkeccak_hmac_copy.3 new file mode 100644 index 0000000..03cad07 --- /dev/null +++ b/doc/man/libkeccak_hmac_copy.3 @@ -0,0 +1,40 @@ +.TH LIBKECCAK_HMAC_COPY 3 LIBKECCAK-%VERSION% +.SH NAME +libkeccak_hmac_copy - Copies an HMAC-hashing state +.SH SYNOPSIS +.LP +.nf +#include <libkeccak.h> +.P +int libkeccak_hmac_copy(libkeccak_hmac_state_t *\fIdest\fP, + const libkeccak_hmac_state_t *\fIsrc\fP); +.fi +.P +Link with \fI-lkeccak\fP. +.SH DESCRIPTION +The +.BR libkeccak_hmac_copy () +function initialises \fI*dest\fP to be identical to \fI*src\fP. +This includes all members of the \fBlibkeccak_hmac_state_t\fP +structure, including the state of the sponge and the +message chunk buffer. +.SH RETURN VALUES +The +.BR libkeccak_hmac_copy () +function returns 0 upon successful completion. +On error, -1 is returned and \fIerrno\fP is set to describe +the error. +.SH ERRORS +The +.BR libkeccak_hmac_copy () +function may fail for any specified for the function +.BR malloc (3). +.SH SEE ALSO +.BR libkeccak_hmac_duplicate (3), +.BR libkeccak_hmac_initialise (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_duplicate.3 b/doc/man/libkeccak_hmac_duplicate.3 new file mode 100644 index 0000000..18772aa --- /dev/null +++ b/doc/man/libkeccak_hmac_duplicate.3 @@ -0,0 +1,40 @@ +.TH LIBKECCAK_HMAC_DUPLICATE 3 LIBKECCAK-%VERSION% +.SH NAME +libkeccak_hmac_duplicate - Allocate a duplicate an HMAC-hashing state +.SH SYNOPSIS +.LP +.nf +#include <libkeccak.h> +.P +libkeccak_hmac_state_t *libkeccak_hmac_duplicate(const libkeccak_hmac_state_t *\fIsrc\fP); +.fi +.P +Link with \fI-lkeccak\fP. +.SH DESCRIPTION +The +.BR libkeccak_hmac_duplicate () +function allocates a new hash state and initialises it to be identical +to \fI*src\fP. This includes all members of the \fBlibkeccak_hmac_state_t\fP +structure, including the state of the sponge and the message +chunk buffer. +.SH RETURN VALUES +The +.BR libkeccak_hmac_duplicate () +function returns a newly allocated \fIlibkeccak_hmac_t*\fP +(of one initialised element) upon successful completion. +On error, \fINULL\fP is returned and \fIerrno\fP is set to +describe the error. +.SH ERRORS +The +.BR libkeccak_hmac_duplicate () +function may fail for any specified for the function +.BR malloc (3). +.SH SEE ALSO +.BR libkeccak_hmac_copy (3), +.BR libkeccak_hmac_create (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 |