shake.h
Go to the documentation of this file.
1 /**
2  * @file shake.h
3  * @brief SHAKE128 and SHAKE256 extendable-output functions
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2024 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.4.0
29  **/
30 
31 #ifndef _SHAKE_H
32 #define _SHAKE_H
33 
34 //Dependencies
35 #include "core/crypto.h"
36 #include "xof/keccak.h"
37 
38 //C++ guard
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 
44 /**
45  * @brief SHAKE algorithm context
46  **/
47 
48 typedef struct
49 {
50  KeccakContext keccakContext;
51 } ShakeContext;
52 
53 
54 //SHAKE related constants
55 extern const uint8_t shake128Oid[9];
56 extern const uint8_t shake256Oid[9];
57 
58 //SHAKE related functions
59 error_t shakeCompute(uint_t strength, const void *input, size_t inputLen,
60  uint8_t *output, size_t outputLen);
61 
62 error_t shakeInit(ShakeContext *context, uint_t strength);
63 void shakeAbsorb(ShakeContext *context, const void *input, size_t length);
64 void shakeFinal(ShakeContext *context);
65 void shakeSqueeze(ShakeContext *context, uint8_t *output, size_t length);
66 
67 //C++ guard
68 #ifdef __cplusplus
69 }
70 #endif
71 
72 #endif
uint_t
unsigned int uint_t
Definition: compiler_port.h:50
crypto.h
General definitions for cryptographic algorithms.
error_t
error_t
Error codes.
Definition: error.h:43
keccak.h
Keccak sponge function.
shakeInit
error_t shakeInit(ShakeContext *context, uint_t strength)
Initialize SHAKE context.
Definition: shake.c:121
shakeAbsorb
void shakeAbsorb(ShakeContext *context, const void *input, size_t length)
Absorb data.
Definition: shake.c:149
shakeCompute
error_t shakeCompute(uint_t strength, const void *input, size_t inputLen, uint8_t *output, size_t outputLen)
Digest a message using SHAKE128 or SHAKE256.
Definition: shake.c:64
shakeFinal
void shakeFinal(ShakeContext *context)
Finish absorbing phase.
Definition: shake.c:161
shake256Oid
const uint8_t shake256Oid[9]
Definition: shake.c:50
shakeSqueeze
void shakeSqueeze(ShakeContext *context, uint8_t *output, size_t length)
Extract data from the squeezing phase.
Definition: shake.c:175
shake128Oid
const uint8_t shake128Oid[9]
Definition: shake.c:48
KeccakContext
Keccak context.
Definition: keccak.h:110
ShakeContext
SHAKE algorithm context.
Definition: shake.h:49
ShakeContext::keccakContext
KeccakContext keccakContext
Definition: shake.h:50
length
uint8_t length
Definition: tcp.h:368