aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man/libkeccak_spec_rawshake.3
blob: 6f60c365a7145c4a2debda37b9c8019e41752227 (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
48
49
50
51
52
53
.TH LIBKECCAK_SPEC_RAWSHAKE 3 LIBKECCAK
.SH NAME
libkeccak_spec_rawshake - Configure RawSHAKE hashing parameters
.SH SYNOPSIS
.LP
.nf
#include <libkeccak.h>
.P
void
libkeccak_spec_rawshake(libkeccak_spec_t *\fIspec\fP, long int \fIx\fP,
                        long int \fId\fP);
.fi
.P
Link with
.IR -lkeccak .
.SH DESCRIPTION
The
.BR libkeccak_spec_rawshake ()
function sets
.I *spec
to specify the Keccak parameters used for RawSHAKE 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_rawshake ()
function does not return any value.
.SH ERRORS
The
.BR libkeccak_spec_rawshake ()
function cannot fail.
.SH EXAMPLE
This example configure a
.B libkeccak_spec_t
to specify the Keccak parameters used for RawSHAKE256(, 512):
.LP
.nf
libkeccak_spec_t spec;
libkeccak_spec_rawshake(&spec, 256, 512);
.fi
.SH SEE ALSO
.BR libkeccak_spec_sha3 (3),
.BR libkeccak_spec_shake (3),
.BR libkeccak_spec_check (3),
.BR libkeccak_generalised_spec_initialise (3),
.BR libkeccak_state_initialise (3),
.BR libkeccak_hmac_initialise (3)
.SH BUGS
Please report bugs to https://github.com/maandree/libkeccak/issues or to
maandree@kth.se