aboutsummaryrefslogblamecommitdiffstats
path: root/doc/man/libkeccak_spec_rawshake.3
blob: 8a47196f7f3697cc66a498e5244c963eee6cf246 (plain) (tree)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15














                                                                                       



                                                          







                                   
           









                                                           
                             

                                              



                                                                     
                                                                        
                       
.TH LIBKECCAK_SPEC_RAWSHAKE 3 LIBKECCAK-%VERSION%
.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 \fIx\fP, long \fId\fP);
.fi
.P
Link with \fI-lkeccak\fP.
.SH DESCRIPTION
The
.BR libkeccak_spec_rawshake ()
function sets \fI*spec\fP to specify the Keccak parameters
used for RawSHAKE 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_rawshake ()
function does not return any value.
.SH ERRORS
The
.BR libkeccak_spec_rawshake ()
function cannot fail.
.SH EXAMPLE
This examples configure a \fBlibkeccak_spec_t\fP 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)
.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