From aa6c04b0e0410a47cf6ca72c5b475894e80a7fa7 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Thu, 8 Oct 2015 15:28:25 +0200 Subject: add libkeccak_hmac_initialise.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_degeneralise_spec.3 | 3 ++- doc/man/libkeccak_hmac_initialise.3 | 46 +++++++++++++++++++++++++++++++++++ doc/man/libkeccak_spec_check.3 | 3 ++- doc/man/libkeccak_spec_rawshake.3 | 3 ++- doc/man/libkeccak_spec_sha3.3 | 3 ++- doc/man/libkeccak_spec_shake.3 | 3 ++- doc/man/libkeccak_state_initialise.3 | 3 ++- 7 files changed, 58 insertions(+), 6 deletions(-) create mode 100644 doc/man/libkeccak_hmac_initialise.3 (limited to 'doc') diff --git a/doc/man/libkeccak_degeneralise_spec.3 b/doc/man/libkeccak_degeneralise_spec.3 index f5f2c08..de98fec 100644 --- a/doc/man/libkeccak_degeneralise_spec.3 +++ b/doc/man/libkeccak_degeneralise_spec.3 @@ -109,7 +109,8 @@ if ((r = libkeccak_spec_check(&spec))); .BR libkeccak_spec_sha3 (3), .BR libkeccak_spec_rawshake (3), .BR libkeccak_spec_shake (3), -.BR libkeccak_state_initialise (3) +.BR libkeccak_state_initialise (3), +.BR libkeccak_hmac_initialise (3) .SH AUTHORS Principal author, Mattias Andrée. See the LICENSE file for the full list of authors. diff --git a/doc/man/libkeccak_hmac_initialise.3 b/doc/man/libkeccak_hmac_initialise.3 new file mode 100644 index 0000000..d25ba40 --- /dev/null +++ b/doc/man/libkeccak_hmac_initialise.3 @@ -0,0 +1,46 @@ +.TH LIBKECCAK_HMAC_INITIALISE 3 LIBKECCAK-%VERSION% +.SH NAME +libkeccak_hmac_initialise - Initialise HMAC-hashing state +.SH SYNOPSIS +.LP +.nf +#include +.P +int libkeccak_hmac_initialise(libkeccak_hmac_state_t *\fIstate\fP, + 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_initialise () +function initialises \fI*state\fP 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_initialise () +function return 0 upon successful completion. +On error, -1 is returned and \fIerrno\fP is set to describe +the error. +.SH ERRORS +The +.BR libkeccak_hmac_initialise () +function may fail for any specified for the functions +.BR malloc (3) +and +.BR realloc (3). +.SH SEE ALSO +.BR libkeccak_spec_sha3 (3), +.BR libkeccak_spec_shake (3), +.BR libkeccak_spec_rawshake (3), +.BR libkeccak_spec_check (3), +.BR libkeccak_generalised_spec_initialise (3), +.BR libkeccak_state_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_spec_check.3 b/doc/man/libkeccak_spec_check.3 index 1caceaa..d27a0af 100644 --- a/doc/man/libkeccak_spec_check.3 +++ b/doc/man/libkeccak_spec_check.3 @@ -85,7 +85,8 @@ function cannot fail. .BR libkeccak_spec_rawshake (3), .BR libkeccak_spec_shake (3), .BR libkeccak_generalised_spec_initialise (3), -.BR libkeccak_state_initialise (3) +.BR libkeccak_state_initialise (3), +.BR libkeccak_hmac_initialise (3) .SH AUTHORS Principal author, Mattias Andrée. See the LICENSE file for the full list of authors. diff --git a/doc/man/libkeccak_spec_rawshake.3 b/doc/man/libkeccak_spec_rawshake.3 index 8a47196..d085b81 100644 --- a/doc/man/libkeccak_spec_rawshake.3 +++ b/doc/man/libkeccak_spec_rawshake.3 @@ -38,7 +38,8 @@ libkeccak_spec_rawshake(&spec, 256, 512); .BR libkeccak_spec_shake (3), .BR libkeccak_spec_check (3), .BR libkeccak_generalised_spec_initialise (3), -.BR libkeccak_state_initialise (3) +.BR libkeccak_state_initialise (3), +.BR libkeccak_hmac_initialise (3) .SH AUTHORS Principal author, Mattias Andrée. See the LICENSE file for the full list of authors. diff --git a/doc/man/libkeccak_spec_sha3.3 b/doc/man/libkeccak_spec_sha3.3 index 747443d..87151f3 100644 --- a/doc/man/libkeccak_spec_sha3.3 +++ b/doc/man/libkeccak_spec_sha3.3 @@ -37,7 +37,8 @@ libkeccak_spec_sha3(&spec, 256); .BR libkeccak_spec_shake (3), .BR libkeccak_spec_check (3), .BR libkeccak_generalised_spec_initialise (3), -.BR libkeccak_state_initialise (3) +.BR libkeccak_state_initialise (3), +.BR libkeccak_hmac_initialise (3) .SH AUTHORS Principal author, Mattias Andrée. See the LICENSE file for the full list of authors. diff --git a/doc/man/libkeccak_spec_shake.3 b/doc/man/libkeccak_spec_shake.3 index 33f2272..13695ea 100644 --- a/doc/man/libkeccak_spec_shake.3 +++ b/doc/man/libkeccak_spec_shake.3 @@ -38,7 +38,8 @@ libkeccak_spec_shake(&spec, 256, 512); .BR libkeccak_spec_rawshake (3), .BR libkeccak_spec_check (3), .BR libkeccak_generalised_spec_initialise (3), -.BR libkeccak_state_initialise (3) +.BR libkeccak_state_initialise (3), +.BR libkeccak_hmac_initialise (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_initialise.3 b/doc/man/libkeccak_state_initialise.3 index 5618fb8..230338e 100644 --- a/doc/man/libkeccak_state_initialise.3 +++ b/doc/man/libkeccak_state_initialise.3 @@ -47,7 +47,8 @@ function may fail for any specified for the function .BR libkeccak_spec_rawshake (3), .BR libkeccak_spec_check (3), .BR libkeccak_generalised_spec_initialise (3), -.BR libkeccak_state_marshal_size (3) +.BR libkeccak_state_marshal_size (3), +.BR libkeccak_hmac_initialise (3) .SH AUTHORS Principal author, Mattias Andrée. See the LICENSE file for the full list of authors. -- cgit v1.2.3-70-g09d2