shake128_256.h
Go to the documentation of this file.
1 /**
2  * @file shake128_256.h
3  * @brief SHAKE128/256 hash function
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2026 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneCRYPTO Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 2.6.6
29  **/
30 
31 #ifndef _SHAKE128_256_H
32 #define _SHAKE128_256_H
33 
34 //Dependencies
35 #include "core/crypto.h"
36 #include "xof/shake.h"
37 
38 //SHAKE128/256 block size
39 #define SHAKE128_256_BLOCK_SIZE 168
40 //SHAKE128/256 digest size
41 #define SHAKE128_256_DIGEST_SIZE 32
42 //Minimum length of the padding string
43 #define SHAKE128_256_MIN_PAD_SIZE 1
44 //Common interface for hash algorithms
45 #define SHAKE128_256_HASH_ALGO (&shake128_256HashAlgo)
46 
47 //C++ guard
48 #ifdef __cplusplus
49 extern "C" {
50 #endif
51 
52 
53 /**
54  * @brief SHAKE128/256 algorithm context
55  **/
56 
57 typedef ShakeContext Shake128_256Context;
58 
59 
60 //SHAKE128/256 related constants
61 extern const HashAlgo shake128_256HashAlgo;
62 
63 //SHAKE128/256 related functions
64 error_t shake128_256Compute(const void *data, size_t length, uint8_t *digest);
65 void shake128_256Init(Shake128_256Context *context);
66 void shake128_256Update(Shake128_256Context *context, const void *data, size_t length);
67 void shake128_256Final(Shake128_256Context *context, uint8_t *digest);
68 
69 //C++ guard
70 #ifdef __cplusplus
71 }
72 #endif
73 
74 #endif
shake.h
SHAKE extendable-output function.
shake128_256Final
void shake128_256Final(Shake128_256Context *context, uint8_t *digest)
Finish the SHAKE128/256 message digest.
Definition: shake128_256.c:140
data
uint8_t data[]
Definition: ethernet.h:224
error_t
error_t
Error codes.
Definition: error.h:43
shake128_256Compute
error_t shake128_256Compute(const void *data, size_t length, uint8_t *digest)
Digest a message using SHAKE128/256.
Definition: shake128_256.c:68
crypto.h
General definitions for cryptographic algorithms.
ShakeContext
SHAKE algorithm context.
Definition: shake.h:53
length
uint8_t length
Definition: tcp.h:375
shake128_256Init
void shake128_256Init(Shake128_256Context *context)
Initialize SHAKE128/256 message digest context.
Definition: shake128_256.c:113
shake128_256HashAlgo
const HashAlgo shake128_256HashAlgo
Definition: shake128_256.c:42
HashAlgo
Common interface for hash algorithms.
Definition: crypto.h:1243
shake128_256Update
void shake128_256Update(Shake128_256Context *context, const void *data, size_t length)
Update the SHAKE128/256 context with a portion of the message being hashed.
Definition: shake128_256.c:127
Shake128_256Context
ShakeContext Shake128_256Context
SHAKE128/256 algorithm context.
Definition: shake128_256.h:57