aboutsummaryrefslogtreecommitdiffstats
path: root/man/libkeccak_spec_rawshake.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2017-10-14 01:01:14 +0200
committerMattias Andrée <maandree@kth.se>2017-10-14 01:01:14 +0200
commit3e1864aa14a33a3c917537a241f6a032cfcacf78 (patch)
tree25297b1363fa88c9f45b5102afa5e95d08e986c1 /man/libkeccak_spec_rawshake.3
parentChange style and license (diff)
downloadlibkeccak-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_rawshake.3')
-rw-r--r--man/libkeccak_spec_rawshake.353
1 files changed, 53 insertions, 0 deletions
diff --git a/man/libkeccak_spec_rawshake.3 b/man/libkeccak_spec_rawshake.3
new file mode 100644
index 0000000..6f60c36
--- /dev/null
+++ b/man/libkeccak_spec_rawshake.3
@@ -0,0 +1,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