aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man/libkeccak_spec_shake.3
blob: a30347680ec0a36a0a30dd815b8c55eab154bd70 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
.TH LIBKECCAK_SPEC_SHAKE 3 LIBKECCAK-%VERSION%
.SH NAME
libkeccak_spec_shake - Configure SHAKE hashing parameters
.SH SYNOPSIS
.LP
.nf
#include <libkeccak.h>
.P
void libkeccak_spec_shake(libkeccak_spec_t *\fIspec\fP, long \fIx\fP, long \fId\fP);
.fi
.P
Link with \fI-lkeccak\fP.
.SH DESCRIPTION
The
.BR libkeccak_spec_shake ()
sets \fI*spec\fP to specify the Keccak parameters used for SHAKE
hashing with the semicapacity specified, in bits, via the \fIx\fP
parameter, and the output size specified, in bits, via the \fId\fP
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 EXAMPLES
This examples configure a \fBlibkeccak_spec_t\fP to specify
the Keccak parameters used for SHAKE256(, 512):
.LP
.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)
.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