esp_algorithms.h
Go to the documentation of this file.
1 /**
2  * @file esp_algorithms.h
3  * @brief ESP algorithm negotiation
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 _ESP_ALGORITHMS_H
32 #define _ESP_ALGORITHMS_H
33 
34 //Dependencies
35 #include "esp/esp.h"
36 #include "ike/ike.h"
37 #include "ike/ike_algorithms.h"
38 
39 //C++ guard
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 //ESP related functions
45 error_t espSelectEncAlgo(IkeChildSaEntry *childSa, uint16_t encAlgoId,
46  size_t encKeyLen);
47 
48 error_t espSelectAuthAlgo(IkeChildSaEntry *childSa, uint16_t authAlgoId);
49 
51  uint8_t **lastSubstruc);
52 
54  IkeProposal *proposal, uint8_t **lastSubstruc);
55 
57  IkeProposal *proposal, uint8_t **lastSubstruc);
58 
60  IkeProposal *proposal, uint8_t **lastSubstruc);
61 
63  const IkeProposal *proposal, size_t proposalLen);
64 
65 uint16_t espSelectAuthTransform(IkeContext *context, const IkeProposal *proposal,
66  size_t proposalLen);
67 
68 uint16_t espSelectEsnTransform(IkeContext *context, const IkeProposal *proposal,
69  size_t proposalLen);
70 
73 
74 //C++ guard
75 #ifdef __cplusplus
76 }
77 #endif
78 
79 #endif
error_t
Error codes.
Definition: error.h:43
ESP (IP Encapsulating Security Payload)
uint16_t espSelectAuthTransform(IkeContext *context, const IkeProposal *proposal, size_t proposalLen)
Integrity transform negotiation.
error_t espSelectAuthAlgo(IkeChildSaEntry *childSa, uint16_t authAlgoId)
Select the relevant MAC algorithm.
uint16_t espSelectEsnTransform(IkeContext *context, const IkeProposal *proposal, size_t proposalLen)
ESN transform negotiation.
error_t espAddSupportedEsnTransforms(IkeContext *context, IkeProposal *proposal, uint8_t **lastSubstruc)
Add the supported ESN transforms to the proposal.
error_t espSelectEncAlgo(IkeChildSaEntry *childSa, uint16_t encAlgoId, size_t encKeyLen)
Select the relevant encryption algorithm.
error_t espCheckSaProposal(IkeChildSaEntry *childSa, const IkeSaPayload *payload)
Check whether the selected proposal is acceptable.
error_t espSelectSaProposal(IkeChildSaEntry *childSa, const IkeSaPayload *payload)
Select a single proposal.
error_t espAddSupportedEncTransforms(IkeContext *context, IkeProposal *proposal, uint8_t **lastSubstruc)
Add the supported encryption transforms to the proposal.
error_t espAddSupportedAuthTransforms(IkeContext *context, IkeProposal *proposal, uint8_t **lastSubstruc)
Add the supported integrity transforms to the proposal.
error_t espAddSupportedTransforms(IkeContext *context, IkeProposal *proposal, uint8_t **lastSubstruc)
Add the supported ESP transforms to the proposal.
const IkeEncAlgo * espSelectEncTransform(IkeContext *context, const IkeProposal *proposal, size_t proposalLen)
Encryption transform negotiation.
IKEv2 (Internet Key Exchange Protocol)
IkeProposal
Definition: ike.h:1312
IkeSaPayload
Definition: ike.h:1295
#define IkeChildSaEntry
Definition: ike.h:686
#define IkeContext
Definition: ike.h:678
IKEv2 algorithm negotiation.
uint8_t payload[]
Definition: ipv6.h:277
Encryption algorithm.