aboutsummaryrefslogtreecommitdiffstats
path: root/libkeccak_spec_sha3.3
blob: 1320631cc8da532ddd9f1d9dc2fe3810592c4bfb (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
.TH LIBKECCAK_SPEC_SHA3 3 LIBKECCAK
.SH NAME
libkeccak_spec_sha3 - Configure SHA-3 hashing parameters
.SH SYNOPSIS
.nf
#include <libkeccak.h>

void libkeccak_spec_sha3(libkeccak_spec_t *\fIspec\fP, long int \fIx\fP);
.fi
.PP
Link with
.IR -lkeccak .
.SH DESCRIPTION
The
.BR libkeccak_spec_sha3 ()
function sets
.I *spec
to specify the Keccak parameters
used for SHA-3 hashing with the output size specified,
in bits, via the
.I x
parameter.
.SH RETURN VALUES
The
.BR libkeccak_spec_sha3 ()
function does not return any value.
.SH ERRORS
The
.BR libkeccak_spec_sha3 ()
function cannot fail.
.SH EXAMPLE
This example configure a
.B libkeccak_spec_t
to specify the Keccak parameters used for SHA3-256:
.PP
.nf
libkeccak_spec_t spec;
libkeccak_spec_sha3(&spec, 256);
.fi
.SH SEE ALSO
.BR libkeccak_spec_rawshake (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)