ascon_cxof128.h
Go to the documentation of this file.
1 /**
2  * @file ascon_cxof128.h
3  * @brief Ascon-CXOF128 customizable extendable-output 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 _ASCON_CXOF128_H
32 #define _ASCON_CXOF128_H
33 
34 //Dependencies
35 #include "core/crypto.h"
36 #include "lwc/ascon.h"
37 
38 //Common interface for XOF algorithms
39 #define ASCON_CXOF128_XOF_ALGO (&asconCxof128XofAlgo)
40 
41 //C++ guard
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45 
46 
47 /**
48  * @brief Ascon-CXOF128 algorithm context
49  **/
50 
51 typedef struct
52 {
54  uint8_t buffer[8];
55  size_t length;
57 
58 
59 //Ascon-CXOF128 related constants
60 extern const uint8_t ASCON_CXOF128_OID[1];
61 extern const XofAlgo asconCxof128XofAlgo;
62 
63 //Ascon-CXOF128 related functions
64 error_t asconCxof128Compute(const void *input, size_t inputLen,
65  const char_t *custom, size_t customLen, uint8_t *output, size_t outputLen);
66 
67 error_t asconCxof128Init(AsconCxof128Context *context, const char_t *custom,
68  size_t customLen);
69 
70 void asconCxof128Absorb(AsconCxof128Context *context, const void *input,
71  size_t length);
72 
74 
75 void asconCxof128Squeeze(AsconCxof128Context *context, uint8_t *output,
76  size_t length);
77 
78 //C++ guard
79 #ifdef __cplusplus
80 }
81 #endif
82 
83 #endif
Ascon state.
Definition: ascon.h:48
void asconCxof128Absorb(AsconCxof128Context *context, const void *input, size_t length)
Absorb data.
void asconCxof128Final(AsconCxof128Context *context)
Finish absorbing phase.
const uint8_t ASCON_CXOF128_OID[1]
Definition: ascon_cxof128.c:48
const XofAlgo asconCxof128XofAlgo
Definition: ascon_cxof128.c:51
void asconCxof128Squeeze(AsconCxof128Context *context, uint8_t *output, size_t length)
Extract data from the squeezing phase.
error_t
Error codes.
Definition: error.h:43
Ascon-CXOF128 algorithm context.
Definition: ascon_cxof128.h:52
Ascon-Based lightweight cryptography.
General definitions for cryptographic algorithms.
uint8_t length
Definition: tcp.h:375
Common interface for XOF algorithms.
Definition: crypto.h:1265
char char_t
Definition: compiler_port.h:55
error_t asconCxof128Compute(const void *input, size_t inputLen, const char_t *custom, size_t customLen, uint8_t *output, size_t outputLen)
Digest a message using Ascon-CXOF128.
Definition: ascon_cxof128.c:78
error_t asconCxof128Init(AsconCxof128Context *context, const char_t *custom, size_t customLen)
Initialize Ascon-CXOF128 context.