From 3969f3ddd458aa5faecaa46efe9fba73f84e1b39 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Tue, 6 Oct 2015 17:10:34 +0200 Subject: m + add libkeccak_state_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 | 5 +-- doc/man/libkeccak_generalised_spec_initialise.3 | 2 +- doc/man/libkeccak_generalised_sum_fd.3 | 5 +-- doc/man/libkeccak_keccaksum_fd.3 | 5 +-- doc/man/libkeccak_rawshakesum_fd.3 | 5 +-- doc/man/libkeccak_sha3sum_fd.3 | 5 +-- doc/man/libkeccak_shakesum_fd.3 | 5 +-- doc/man/libkeccak_spec_check.3 | 5 +-- doc/man/libkeccak_spec_rawshake.3 | 5 +-- doc/man/libkeccak_spec_sha3.3 | 5 +-- doc/man/libkeccak_spec_shake.3 | 5 +-- doc/man/libkeccak_state_initialise.3 | 46 +++++++++++++++++++++++++ 12 files changed, 77 insertions(+), 21 deletions(-) create mode 100644 doc/man/libkeccak_state_initialise.3 (limited to 'doc') diff --git a/doc/man/libkeccak_degeneralise_spec.3 b/doc/man/libkeccak_degeneralise_spec.3 index 17a9015..a9a147b 100644 --- a/doc/man/libkeccak_degeneralise_spec.3 +++ b/doc/man/libkeccak_degeneralise_spec.3 @@ -108,10 +108,11 @@ if ((r = libkeccak_spec_check(&spec))); .BR libkeccak_spec_check (3), .BR libkeccak_spec_sha3 (3), .BR libkeccak_spec_rawshake (3), -.BR libkeccak_spec_shake (3) +.BR libkeccak_spec_shake (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/bus/issues or to +Please report bugs to https://github.com/maandree/libkeccak/issues or to maandree@member.fsf.org diff --git a/doc/man/libkeccak_generalised_spec_initialise.3 b/doc/man/libkeccak_generalised_spec_initialise.3 index 8906967..d874cb6 100644 --- a/doc/man/libkeccak_generalised_spec_initialise.3 +++ b/doc/man/libkeccak_generalised_spec_initialise.3 @@ -39,5 +39,5 @@ function cannot fail. 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/bus/issues or to +Please report bugs to https://github.com/maandree/libkeccak/issues or to maandree@member.fsf.org diff --git a/doc/man/libkeccak_generalised_sum_fd.3 b/doc/man/libkeccak_generalised_sum_fd.3 index ac50e10..9e038a7 100644 --- a/doc/man/libkeccak_generalised_sum_fd.3 +++ b/doc/man/libkeccak_generalised_sum_fd.3 @@ -99,10 +99,11 @@ printf("%s\\n", hexhash); .BR libkeccak_spec_shake (3), .BR libkeccak_spec_rawshake (3), .BR libkeccak_spec_check (3), -.BR libkeccak_generalised_spec_initialise (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/bus/issues or to +Please report bugs to https://github.com/maandree/libkeccak/issues or to maandree@member.fsf.org diff --git a/doc/man/libkeccak_keccaksum_fd.3 b/doc/man/libkeccak_keccaksum_fd.3 index 4328fce..44f4414 100644 --- a/doc/man/libkeccak_keccaksum_fd.3 +++ b/doc/man/libkeccak_keccaksum_fd.3 @@ -93,10 +93,11 @@ printf("%s\\n", hexhash); .BR libkeccak_rawshakesum_fd (3), .BR libkeccak_shakesum_fd (3), .BR libkeccak_spec_check (3), -.BR libkeccak_generalised_spec_initialise (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/bus/issues or to +Please report bugs to https://github.com/maandree/libkeccak/issues or to maandree@member.fsf.org diff --git a/doc/man/libkeccak_rawshakesum_fd.3 b/doc/man/libkeccak_rawshakesum_fd.3 index 329b5db..89e68ec 100644 --- a/doc/man/libkeccak_rawshakesum_fd.3 +++ b/doc/man/libkeccak_rawshakesum_fd.3 @@ -88,10 +88,11 @@ printf("%s\\n", hexhash); .BR libkeccak_shakesum_fd (3), .BR libkeccak_spec_rawshake (3), .BR libkeccak_spec_check (3), -.BR libkeccak_generalised_spec_initialise (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/bus/issues or to +Please report bugs to https://github.com/maandree/libkeccak/issues or to maandree@member.fsf.org diff --git a/doc/man/libkeccak_sha3sum_fd.3 b/doc/man/libkeccak_sha3sum_fd.3 index b2d5f80..b7b0b7f 100644 --- a/doc/man/libkeccak_sha3sum_fd.3 +++ b/doc/man/libkeccak_sha3sum_fd.3 @@ -86,10 +86,11 @@ printf("%s\\n", hexhash); .BR libkeccak_shakesum_fd (3), .BR libkeccak_spec_sha3 (3), .BR libkeccak_spec_check (3), -.BR libkeccak_generalised_spec_initialise (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/bus/issues or to +Please report bugs to https://github.com/maandree/libkeccak/issues or to maandree@member.fsf.org diff --git a/doc/man/libkeccak_shakesum_fd.3 b/doc/man/libkeccak_shakesum_fd.3 index 591f827..506cff6 100644 --- a/doc/man/libkeccak_shakesum_fd.3 +++ b/doc/man/libkeccak_shakesum_fd.3 @@ -88,10 +88,11 @@ printf("%s\\n", hexhash); .BR libkeccak_rawshakesum_fd (3), .BR libkeccak_spec_shake (3), .BR libkeccak_spec_check (3), -.BR libkeccak_generalised_spec_initialise (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/bus/issues or to +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 0215937..067fb72 100644 --- a/doc/man/libkeccak_spec_check.3 +++ b/doc/man/libkeccak_spec_check.3 @@ -84,10 +84,11 @@ function cannot fail. .BR libkeccak_spec_sha3 (3), .BR libkeccak_spec_rawshake (3), .BR libkeccak_spec_shake (3), -.BR libkeccak_generalised_spec_initialise (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/bus/issues or to +Please report bugs to https://github.com/maandree/libkeccak/issues or to maandree@member.fsf.org diff --git a/doc/man/libkeccak_spec_rawshake.3 b/doc/man/libkeccak_spec_rawshake.3 index 0759150..4219b84 100644 --- a/doc/man/libkeccak_spec_rawshake.3 +++ b/doc/man/libkeccak_spec_rawshake.3 @@ -37,10 +37,11 @@ libkeccak_spec_rawshake(&spec, 256, 512); .BR libkeccak_spec_sha3 (3), .BR libkeccak_spec_shake (3), .BR libkeccak_spec_check (3), -.BR libkeccak_generalised_spec_initialise (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/bus/issues or to +Please report bugs to https://github.com/maandree/libkeccak/issues or to maandree@member.fsf.org diff --git a/doc/man/libkeccak_spec_sha3.3 b/doc/man/libkeccak_spec_sha3.3 index f163fb4..60f1469 100644 --- a/doc/man/libkeccak_spec_sha3.3 +++ b/doc/man/libkeccak_spec_sha3.3 @@ -35,10 +35,11 @@ libkeccak_spec_sha3(&spec, 256); .BR libkeccak_spec_rawshake (3), .BR libkeccak_spec_shake (3), .BR libkeccak_spec_check (3), -.BR libkeccak_generalised_spec_initialise (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/bus/issues or to +Please report bugs to https://github.com/maandree/libkeccak/issues or to maandree@member.fsf.org diff --git a/doc/man/libkeccak_spec_shake.3 b/doc/man/libkeccak_spec_shake.3 index 67302d2..a303476 100644 --- a/doc/man/libkeccak_spec_shake.3 +++ b/doc/man/libkeccak_spec_shake.3 @@ -37,10 +37,11 @@ libkeccak_spec_shake(&spec, 256, 512); .BR libkeccak_spec_sha3 (3), .BR libkeccak_spec_rawshake (3), .BR libkeccak_spec_check (3), -.BR libkeccak_generalised_spec_initialise (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/bus/issues or to +Please report bugs to https://github.com/maandree/libkeccak/issues or to maandree@member.fsf.org diff --git a/doc/man/libkeccak_state_initialise.3 b/doc/man/libkeccak_state_initialise.3 new file mode 100644 index 0000000..2845036 --- /dev/null +++ b/doc/man/libkeccak_state_initialise.3 @@ -0,0 +1,46 @@ +.TH LIBKECCAK_STATE_INITIALISE 3 LIBKECCAK-%VERSION% +.SH NAME +libkeccak_state_initialise - Initialise hash state +.SH SYNOPSIS +.LP +.nf +#include +.P +int libkeccak_state_initialise(libkeccak_state_t *\fIstate\fP, + const libkeccak_spec_t *\fIspec\fP); +.fi +.P +Link with \fI-lkeccak\fP. +.SH DESCRIPTION +The +.BR libkeccak_state_initialise () +initialises \fI*state\fP and sets the algorithm tuning parameters +to those specified by \fI*spec\fP. +.SH RETURN VALUES +The +.BR libkeccak_state_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_state_initialise () +function may fail for any specified for the function +.BR malloc (3). +.SH SEE ALSO +.BR libkeccak_generalised_sum_fd (3), +.BR libkeccak_keccaksum_fd (3), +.BR libkeccak_sha3sum_fd (3), +.BR libkeccak_rawshakesum_fd (3), +.BR libkeccak_shakesum_fd (3), +.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) +.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