diff options
| author | Mattias Andrée <maandree@kth.se> | 2017-10-14 01:01:14 +0200 |
|---|---|---|
| committer | Mattias Andrée <maandree@kth.se> | 2017-10-14 01:01:14 +0200 |
| commit | 3e1864aa14a33a3c917537a241f6a032cfcacf78 (patch) | |
| tree | 25297b1363fa88c9f45b5102afa5e95d08e986c1 /man/libkeccak_spec_sha3.3 | |
| parent | Change style and license (diff) | |
| download | libkeccak-3e1864aa14a33a3c917537a241f6a032cfcacf78.tar.gz libkeccak-3e1864aa14a33a3c917537a241f6a032cfcacf78.tar.bz2 libkeccak-3e1864aa14a33a3c917537a241f6a032cfcacf78.tar.xz | |
General improvements
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'man/libkeccak_spec_sha3.3')
| -rw-r--r-- | man/libkeccak_spec_sha3.3 | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/man/libkeccak_spec_sha3.3 b/man/libkeccak_spec_sha3.3 new file mode 100644 index 0000000..8e07a7d --- /dev/null +++ b/man/libkeccak_spec_sha3.3 @@ -0,0 +1,51 @@ +.TH LIBKECCAK_SPEC_SHA3 3 LIBKECCAK +.SH NAME +libkeccak_spec_sha3 - Configure SHA-3 hashing parameters +.SH SYNOPSIS +.LP +.nf +#include <libkeccak.h> +.P +void +libkeccak_spec_sha3(libkeccak_spec_t *\fIspec\fP, long int \fIx\fP); +.fi +.P +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: +.LP +.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) +.SH BUGS +Please report bugs to https://github.com/maandree/libkeccak/issues or to +maandree@kth.se |