kmac_xof.h
Go to the documentation of this file.
1 /**
2  * @file kmac_xof.h
3  * @brief KMACXOF (KMAC with arbitrary-length output)
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 _KMAC_XOF_H
32 #define _KMAC_XOF_H
33 
34 //Dependencies
35 #include "core/crypto.h"
36 #include "xof/cshake.h"
37 
38 //C++ guard
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 
44 /**
45  * @brief KMACXOF algorithm context
46  **/
47 
48 typedef struct
49 {
50  CshakeContext cshakeContext;
51 } KmacXofContext;
52 
53 
54 //KMACXOF related constants
55 extern const uint8_t KMAC_XOF128_OID[9];
56 extern const uint8_t KMAC_XOF256_OID[9];
57 
58 //KMACXOF related functions
59 error_t kmacXofCompute(uint_t strength, const void *key, size_t keyLen,
60  const void *data, size_t dataLen, const char_t *custom, size_t customLen,
61  uint8_t *mac, size_t macLen);
62 
63 error_t kmacXofInit(KmacXofContext *context, uint_t strength, const void *key,
64  size_t keyLen, const char_t *custom, size_t customLen);
65 
66 void kmacXofAbsorb(KmacXofContext *context, const void *input, size_t length);
67 void kmacXofFinal(KmacXofContext *context);
68 void kmacXofSqueeze(KmacXofContext *context, uint8_t *output, size_t length);
69 
70 //C++ guard
71 #ifdef __cplusplus
72 }
73 #endif
74 
75 #endif
kmacXofFinal
void kmacXofFinal(KmacXofContext *context)
Finish absorbing phase.
Definition: kmac_xof.c:195
data
uint8_t data[]
Definition: ethernet.h:224
kmacXofSqueeze
void kmacXofSqueeze(KmacXofContext *context, uint8_t *output, size_t length)
Extract data from the squeezing phase.
Definition: kmac_xof.c:217
KMAC_XOF128_OID
const uint8_t KMAC_XOF128_OID[9]
Definition: kmac_xof.c:38
error_t
error_t
Error codes.
Definition: error.h:43
crypto.h
General definitions for cryptographic algorithms.
cshake.h
cSHAKE (customizable SHAKE function)
length
uint8_t length
Definition: tcp.h:375
dataLen
uint32_t dataLen
Definition: sftp_common.h:229
kmacXofAbsorb
void kmacXofAbsorb(KmacXofContext *context, const void *input, size_t length)
Absorb data.
Definition: kmac_xof.c:183
char_t
char char_t
Definition: compiler_port.h:55
kmacXofCompute
error_t kmacXofCompute(uint_t strength, const void *key, size_t keyLen, const void *data, size_t dataLen, const char_t *custom, size_t customLen, uint8_t *mac, size_t macLen)
Digest a message using KMACXOF.
Definition: kmac_xof.c:58
KmacXofContext
KMACXOF algorithm context.
Definition: kmac_xof.h:49
uint_t
unsigned int uint_t
Definition: compiler_port.h:57
kmacXofInit
error_t kmacXofInit(KmacXofContext *context, uint_t strength, const void *key, size_t keyLen, const char_t *custom, size_t customLen)
Initialize KMACXOF context.
Definition: kmac_xof.c:120
KmacXofContext::cshakeContext
CshakeContext cshakeContext
Definition: kmac_xof.h:50
CshakeContext
cSHAKE algorithm context
Definition: cshake.h:49
KMAC_XOF256_OID
const uint8_t KMAC_XOF256_OID[9]
Definition: kmac_xof.c:40