cshake.h
Go to the documentation of this file.
1 /**
2  * @file cshake.h
3  * @brief cSHAKE128 and cSHAKE256 (customizable SHAKE function)
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.4
29  **/
30 
31 #ifndef _CSHAKE_H
32 #define _CSHAKE_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 cSHAKE algorithm context
46  **/
47 
48 typedef struct
49 {
50  size_t nameLen;
51  size_t customLen;
52  KeccakContext keccakContext;
53 } CshakeContext;
54 
55 
56 //cSHAKE related functions
57 error_t cshakeCompute(uint_t strength, const void *input, size_t inputLen,
58  const char_t *name, size_t nameLen, const char_t *custom, size_t customLen,
59  uint8_t *output, size_t outputLen);
60 
61 error_t cshakeInit(CshakeContext *context, uint_t strength, const char_t *name,
62  size_t nameLen, const char_t *custom, size_t customLen);
63 
64 void cshakeAbsorb(CshakeContext *context, const void *input, size_t length);
65 void cshakeFinal(CshakeContext *context);
66 void cshakeSqueeze(CshakeContext *context, uint8_t *output, size_t length);
67 
68 void cshakeLeftEncode(size_t value, uint8_t *buffer, size_t *length);
69 
70 //C++ guard
71 #ifdef __cplusplus
72 }
73 #endif
74 
75 #endif
cshakeFinal
void cshakeFinal(CshakeContext *context)
Finish absorbing phase.
Definition: cshake.c:220
CshakeContext::keccakContext
KeccakContext keccakContext
Definition: cshake.h:52
KeccakContext
Keccak context.
Definition: keccak.h:110
CshakeContext::customLen
size_t customLen
Definition: cshake.h:51
name
char_t name[]
Definition: resource_manager.h:71
CshakeContext::nameLen
size_t nameLen
Definition: cshake.h:50
cshakeLeftEncode
void cshakeLeftEncode(size_t value, uint8_t *buffer, size_t *length)
Encode integer as byte string.
Definition: cshake.c:262
error_t
error_t
Error codes.
Definition: error.h:43
cshakeCompute
error_t cshakeCompute(uint_t strength, const void *input, size_t inputLen, const char_t *name, size_t nameLen, const char_t *custom, size_t customLen, uint8_t *output, size_t outputLen)
Digest a message using cSHAKE128 or cSHAKE256.
Definition: cshake.c:62
cshakeSqueeze
void cshakeSqueeze(CshakeContext *context, uint8_t *output, size_t length)
Extract data from the squeezing phase.
Definition: cshake.c:248
crypto.h
General definitions for cryptographic algorithms.
length
uint8_t length
Definition: tcp.h:368
char_t
char char_t
Definition: compiler_port.h:48
keccak.h
Keccak sponge function.
cshakeInit
error_t cshakeInit(CshakeContext *context, uint_t strength, const char_t *name, size_t nameLen, const char_t *custom, size_t customLen)
Initialize cSHAKE context.
Definition: cshake.c:124
value
uint8_t value[]
Definition: tcp.h:369
uint_t
unsigned int uint_t
Definition: compiler_port.h:50
CshakeContext
cSHAKE algorithm context
Definition: cshake.h:49
cshakeAbsorb
void cshakeAbsorb(CshakeContext *context, const void *input, size_t length)
Absorb data.
Definition: cshake.c:208