From be75eceee6e0b9eb0e35968f46a997d684dde341 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Sat, 10 Oct 2015 15:02:11 +0200 Subject: grammaro + add libkeccak_hmac_create.3 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- doc/man/libkeccak_hmac_create.3 | 45 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 doc/man/libkeccak_hmac_create.3 (limited to 'doc/man/libkeccak_hmac_create.3') diff --git a/doc/man/libkeccak_hmac_create.3 b/doc/man/libkeccak_hmac_create.3 new file mode 100644 index 0000000..6bdf846 --- /dev/null +++ b/doc/man/libkeccak_hmac_create.3 @@ -0,0 +1,45 @@ +.TH LIBKECCAK_HMAC_CREATE 3 LIBKECCAK-%VERSION% +.SH NAME +libkeccak_hmac_create - Allocate and initialise HMAC-hashing state +.SH SYNOPSIS +.LP +.nf +#include +.P +libkeccak_hmac_state_t *libkeccak_hmac_create(const libkeccak_spec_t *\fIspec\fP, + const char *\fIkey\fP, size_t \fIkey_length\fP); +.fi +.P +Link with \fI-lkeccak\fP. +.SH DESCRIPTION +The +.BR libkeccak_hmac_create () +function allocates a new \fIlibkeccak_hmac_state_t*\fP with one +initialised element, and sets the algorithm tuning parameters to +those specified by \fI*spec\fP, and the key to \fIkey\fP of +length \fIkey_length\fP. +.SH RETURN VALUES +The +.BR libkeccak_hmac_create () +function returns a newly allocated \fIlibkeccak_hmac_state_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_create () +function may fail for any specified for the functions +.BR malloc (3) +and +.BR realloc (3). +.SH SEE ALSO +.BR libkeccak_hmac_initialise (3), +.BR libkeccak_hmac_free (3), +.BR libkeccak_hmac_fast_free (3), +.BR libkeccak_hmac_duplicate (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 -- cgit v1.2.3-70-g09d2