ike_dh_groups.h
Go to the documentation of this file.
1 /**
2  * @file ike_dh_groups.h
3  * @brief Diffie-Hellman groups
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2022-2024 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneIPSEC 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.0
29  **/
30 
31 #ifndef _IKE_DH_GROUPS_H
32 #define _IKE_DH_GROUPS_H
33 
34 //Dependencies
35 #include "ike/ike.h"
36 #include "pkc/dh.h"
37 
38 //C++ guard
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 
44 /**
45  * @brief Diffie-Hellman group
46  **/
47 
48 typedef struct
49 {
50  const char_t *name; ///<Group name
51  const uint8_t p[IKE_MAX_DH_MODULUS_SIZE / 8]; ///<Prime modulus
52  size_t pLen; ///<Length of the prime modulus, in bytes
53  uint8_t g; ///<Generator
54 } IkeDhGroup;
55 
56 
57 //Diffie-Hellman groups
58 extern const IkeDhGroup ikeDhGroup1;
59 extern const IkeDhGroup ikeDhGroup5;
60 extern const IkeDhGroup ikeDhGroup14;
61 extern const IkeDhGroup ikeDhGroup15;
62 extern const IkeDhGroup ikeDhGroup16;
63 extern const IkeDhGroup ikeDhGroup17;
64 extern const IkeDhGroup ikeDhGroup18;
65 
66 //Diffie-Hellman group related functions
67 const IkeDhGroup *ikeGetDhGroup(uint16_t groupNum);
68 error_t ikeLoadDhParams(DhParameters *params, uint16_t groupNum);
69 
70 //C++ guard
71 #ifdef __cplusplus
72 }
73 #endif
74 
75 #endif
char char_t
Definition: compiler_port.h:48
Diffie-Hellman key exchange.
error_t
Error codes.
Definition: error.h:43
IKEv2 (Internet Key Exchange Protocol)
#define IKE_MAX_DH_MODULUS_SIZE
Definition: ike.h:579
const IkeDhGroup ikeDhGroup17
const IkeDhGroup ikeDhGroup15
const IkeDhGroup ikeDhGroup16
error_t ikeLoadDhParams(DhParameters *params, uint16_t groupNum)
Load Diffie-Hellman parameters.
const IkeDhGroup ikeDhGroup5
const IkeDhGroup ikeDhGroup1
const IkeDhGroup * ikeGetDhGroup(uint16_t groupNum)
Get the Diffie-Hellman group that matches the specified group number.
const IkeDhGroup ikeDhGroup14
const IkeDhGroup ikeDhGroup18
uint8_t p
Definition: ndp.h:300
Diffie-Hellman parameters.
Definition: dh.h:49
Diffie-Hellman group.
Definition: ike_dh_groups.h:49
uint8_t g
Generator.
Definition: ike_dh_groups.h:53
const char_t * name
Group name.
Definition: ike_dh_groups.h:50
size_t pLen
Length of the prime modulus, in bytes.
Definition: ike_dh_groups.h:52