diff options
| author | Mattias Andrée <maandree@kth.se> | 2019-02-11 16:22:00 +0100 |
|---|---|---|
| committer | Mattias Andrée <maandree@kth.se> | 2019-02-11 16:22:00 +0100 |
| commit | 5ff4c5af715d098852d124de116d354ee10f4ea4 (patch) | |
| tree | 5789ad5798f2dbf21d9406a2942e48b222f773ae /libkeccak_spec_shake.3 | |
| parent | Remove old file (diff) | |
| download | libkeccak-5ff4c5af715d098852d124de116d354ee10f4ea4.tar.gz libkeccak-5ff4c5af715d098852d124de116d354ee10f4ea4.tar.bz2 libkeccak-5ff4c5af715d098852d124de116d354ee10f4ea4.tar.xz | |
Split most .c files into one per function and flatten file hierarchy
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'libkeccak_spec_shake.3')
| -rw-r--r-- | libkeccak_spec_shake.3 | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/libkeccak_spec_shake.3 b/libkeccak_spec_shake.3 new file mode 100644 index 0000000..4beea49 --- /dev/null +++ b/libkeccak_spec_shake.3 @@ -0,0 +1,47 @@ +.TH LIBKECCAK_SPEC_SHAKE 3 LIBKECCAK +.SH NAME +libkeccak_spec_shake - Configure SHAKE hashing parameters +.SH SYNOPSIS +.nf +#include <libkeccak.h> + +void libkeccak_spec_shake(libkeccak_spec_t *\fIspec\fP, long int \fIx\fP, long int \fId\fP); +.fi +.PP +Link with +.IR -lkeccak . +.SH DESCRIPTION +The +.BR libkeccak_spec_shake () +function sets +.I *spec +to specify the Keccak parameters used for SHAKE hashing +with the semicapacity specified, in bits, via the +.I x +parameter, and the output size specified, in bits, via the +.I d +parameter. +.SH RETURN VALUES +The +.BR libkeccak_spec_shake () +function does not return any value. +.SH ERRORS +The +.BR libkeccak_spec_shake () +function cannot fail. +.SH EXAMPLE +This example configure a +.B libkeccak_spec_t +to specify the Keccak parameters used for SHAKE256(, 512): +.PP +.nf +libkeccak_spec_t spec; +libkeccak_spec_shake(&spec, 256, 512); +.fi +.SH SEE ALSO +.BR libkeccak_spec_sha3 (3), +.BR libkeccak_spec_rawshake (3), +.BR libkeccak_spec_check (3), +.BR libkeccak_generalised_spec_initialise (3), +.BR libkeccak_state_initialise (3), +.BR libkeccak_hmac_initialise (3) |