xref: /netbsd-src/lib/libc/hash/sha3/keccak.3 (revision 2daf92edc4222f7fb41610d445b198536c925967)
1.\" $NetBSD: keccak.3,v 1.1 2017/11/30 16:00:48 wiz Exp $
2.\"
3.\" Copyright (c) 2015 Taylor R. Campbell
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.Dd October 14, 2015
28.Dt KECCAK 3
29.Os
30.Sh NAME
31.Nm Keccak
32.Nd NIST FIPS PUB 202: SHA-3 Standard: Permutation-Based Hash and Extendable-Output Functions
33.Sh SYNOPSIS
34.In keccak.h
35.Ft void
36.Fn keccakf1600 "uint64_t A[25]"
37.Sh DESCRIPTION
38The
39.Nm
40functions implement the core Keccak permutation of the NIST SHA-3
41standard, FIPS PUB 202.
42.Pp
43Before using the
44.Nm
45functions, applications should first call
46.Xr SHA3_Selftest 3
47and confirm that it succeeded.
48.Pp
49The
50.Fn keccakf1600
51function implements the 24-round Keccak-f[1600] permutation on a state
52of twenty-five 64-bit words, to be loaded from or stored to octets in
53little-endian order.
54.Pp
55This function scrambles a 1600-bit state, and is conjectured to look
56like a random permutation.
57It lies at the core of all the SHA-3 hash and extendable-output
58functions, and can be used for other cryptographic constructions,
59e.g. a sponge duplex.
60.Pp
61The permutation Keccak-f[1600] is also known as Keccak-p[1600, 24].
62.Sh SEE ALSO
63.Xr sha3 3 ,
64.Xr SHA3_Selftest 3 ,
65.Xr SHAKE 3
66.Sh STANDARDS
67.Rs
68.%A National Institute of Standards and Technology
69.%T SHA-3 Standard: Permutation-Based Hash and Extendable-Output Functions
70.%O FIPS PUB 202
71.%D August 2015
72.Re
73.Sh AUTHORS
74.An Taylor R Campbell Aq campbell+sha3@mumble.net
75