ascon_xof128.h
Go to the documentation of this file.
1 /**
2  * @file ascon_xof128.h
3  * @brief Ascon-XOF128 extendable-output function
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2025 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.5.4
29  **/
30 
31 #ifndef _ASCON_XOF128_H
32 #define _ASCON_XOF128_H
33 
34 //Dependencies
35 #include "core/crypto.h"
36 #include "lwc/ascon.h"
37 
38 //Common interface for XOF algorithms
39 #define ASCON_XOF128_XOF_ALGO (&asconXof128XofAlgo)
40 
41 //C++ guard
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45 
46 
47 /**
48  * @brief Ascon-XOF128 algorithm context
49  **/
50 
51 typedef struct
52 {
53  AsconState state;
54  uint8_t buffer[8];
55  size_t length;
56 } AsconXof128Context;
57 
58 
59 //Ascon-XOF128 related constants
60 extern const uint8_t ASCON_XOF128_OID[1];
61 extern const XofAlgo asconXof128XofAlgo;
62 
63 //Ascon-XOF128 related functions
64 error_t asconXof128Compute(const void *input, size_t inputLen, uint8_t *output,
65  size_t outputLen);
66 
67 void asconXof128Init(AsconXof128Context *context);
68 
69 void asconXof128Absorb(AsconXof128Context *context, const void *input,
70  size_t length);
71 
72 void asconXof128Final(AsconXof128Context *context);
73 
74 void asconXof128Squeeze(AsconXof128Context *context, uint8_t *output,
75  size_t length);
76 
77 //C++ guard
78 #ifdef __cplusplus
79 }
80 #endif
81 
82 #endif
asconXof128Final
void asconXof128Final(AsconXof128Context *context)
Finish absorbing phase.
Definition: ascon_xof128.c:196
asconXof128Init
void asconXof128Init(AsconXof128Context *context)
Initialize Ascon-XOF128 context.
Definition: ascon_xof128.c:122
AsconXof128Context
Ascon-XOF128 algorithm context.
Definition: ascon_xof128.h:52
AsconState
Ascon state.
Definition: ascon.h:48
ASCON_XOF128_OID
const uint8_t ASCON_XOF128_OID[1]
Definition: ascon_xof128.c:48
error_t
error_t
Error codes.
Definition: error.h:43
ascon.h
Ascon-Based lightweight cryptography.
crypto.h
General definitions for cryptographic algorithms.
asconXof128Compute
error_t asconXof128Compute(const void *input, size_t inputLen, uint8_t *output, size_t outputLen)
Digest a message using Ascon-XOF128.
Definition: ascon_xof128.c:74
length
uint8_t length
Definition: tcp.h:375
asconXof128XofAlgo
const XofAlgo asconXof128XofAlgo
Definition: ascon_xof128.c:51
asconXof128Absorb
void asconXof128Absorb(AsconXof128Context *context, const void *input, size_t length)
Absorb data.
Definition: ascon_xof128.c:152
asconXof128Squeeze
void asconXof128Squeeze(AsconXof128Context *context, uint8_t *output, size_t length)
Extract data from the squeezing phase.
Definition: ascon_xof128.c:235
XofAlgo
Common interface for XOF algorithms.
Definition: crypto.h:1146
AsconXof128Context::state
AsconState state
Definition: ascon_xof128.h:53