mlkem1024.h
Go to the documentation of this file.
1 /**
2  * @file mlkem1024.h
3  * @brief ML-KEM-1024 key encapsulation mechanism
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 _MLKEM1024_H
32 #define _MLKEM1024_H
33 
34 //Dependencies
35 #include "core/crypto.h"
36 
37 //Public key length
38 #define MLKEM1024_PUBLIC_KEY_LEN 1568
39 //Secret key length
40 #define MLKEM1024_SECRET_KEY_LEN 3168
41 //Ciphertext length
42 #define MLKEM1024_CIPHERTEXT_LEN 1568
43 //Shared secret length
44 #define MLKEM1024_SHARED_SECRET_LEN 32
45 
46 //Common interface for key encapsulation mechanisms (KEM)
47 #define MLKEM1024_KEM_ALGO (&mlkem1024KemAlgo)
48 
49 //C++ guard
50 #ifdef __cplusplus
51 extern "C" {
52 #endif
53 
54 //ML-KEM-1024 related constants
55 extern const KemAlgo mlkem1024KemAlgo;
56 
57 //ML-KEM-1024 related functions
58 error_t mlkem1024GenerateKeyPair(const PrngAlgo *prngAlgo, void *prngContext,
59  uint8_t *pk, uint8_t *sk);
60 
61 error_t mlkem1024Encapsulate(const PrngAlgo *prngAlgo, void *prngContext,
62  uint8_t *ct, uint8_t *ss, const uint8_t *pk);
63 
64 error_t mlkem1024Decapsulate(uint8_t *ss, const uint8_t *ct, const uint8_t *sk);
65 
66 //C++ guard
67 #ifdef __cplusplus
68 }
69 #endif
70 
71 #endif
PrngAlgo
#define PrngAlgo
Definition: crypto.h:938
mlkem1024GenerateKeyPair
error_t mlkem1024GenerateKeyPair(const PrngAlgo *prngAlgo, void *prngContext, uint8_t *pk, uint8_t *sk)
Key pair generation.
Definition: mlkem1024.c:67
mlkem1024Encapsulate
error_t mlkem1024Encapsulate(const PrngAlgo *prngAlgo, void *prngContext, uint8_t *ct, uint8_t *ss, const uint8_t *pk)
Encapsulation algorithm.
Definition: mlkem1024.c:90
mlkem1024KemAlgo
const KemAlgo mlkem1024KemAlgo
Definition: mlkem1024.c:45
error_t
error_t
Error codes.
Definition: error.h:43
crypto.h
General definitions for cryptographic algorithms.
KemAlgo
Common interface for key encapsulation mechanisms (KEM)
Definition: crypto.h:1087
mlkem1024Decapsulate
error_t mlkem1024Decapsulate(uint8_t *ss, const uint8_t *ct, const uint8_t *sk)
Decapsulation algorithm.
Definition: mlkem1024.c:111