ike_response_format.h
Go to the documentation of this file.
1 /**
2  * @file ike_response_format.h
3  * @brief IKE response formatting
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2022-2026 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.6.6
29  **/
30 
31 #ifndef _IKE_RESPONSE_FORMAT_H
32 #define _IKE_RESPONSE_FORMAT_H
33 
34 //Dependencies
35 #include "ike/ike.h"
36 
37 //C++ guard
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 //IKE related functions
43 error_t ikeSendResponse(IkeContext *context, const uint8_t *message,
44  size_t length);
45 
50 
52  size_t length);
53 
54 error_t ikeFormatIkeSaInitResponse(IkeSaEntry *sa, uint8_t *p, size_t *length);
55 error_t ikeFormatIkeAuthResponse(IkeSaEntry *sa, uint8_t *p, size_t *length);
56 
58  size_t *length);
59 
61  size_t *length);
62 
63 error_t ikeFormatErrorResponse(IkeHeader *requestHeader, uint8_t *p,
64  size_t *length);
65 
67  size_t *length, uint8_t **nextPayload);
68 
70  uint8_t **nextPayload);
71 
72 //C++ guard
73 #ifdef __cplusplus
74 }
75 #endif
76 
77 #endif
error_t ikeFormatIkeSaInitResponse(IkeSaEntry *sa, uint8_t *p, size_t *length)
Format IKE_SA_INIT response.
uint8_t p
Definition: ndp.h:300
uint8_t message[]
Definition: chap.h:154
error_t ikeSendResponse(IkeContext *context, const uint8_t *message, size_t length)
Send IKE response.
#define IkeContext
Definition: ike.h:832
error_t
Error codes.
Definition: error.h:43
error_t ikeFormatErrorResponse(IkeHeader *requestHeader, uint8_t *p, size_t *length)
Format INFORMATIONAL response (outside of an IKE SA)
uint8_t length
Definition: tcp.h:375
IkeHeader
Definition: ike.h:1459
IKEv2 (Internet Key Exchange Protocol)
#define IkeSaEntry
Definition: ike.h:836
error_t ikeFormatCreateChildSaResponse(IkeSaEntry *sa, uint8_t *p, size_t *length)
Format CREATE_CHILD_SA response.
error_t ikeFormatChildSaCreateResponse(IkeSaEntry *sa, uint8_t *p, size_t *length, uint8_t **nextPayload)
Format Child SA creation/rekeying response.
error_t ikeSendInfoResponse(IkeSaEntry *sa)
Send INFORMATIONAL response.
error_t ikeSendIkeSaInitResponse(IkeSaEntry *sa)
Send IKE_SA_INIT response.
error_t ikeSendErrorResponse(IkeContext *context, uint8_t *message, size_t length)
Send INFORMATIONAL response (outside of an IKE SA)
error_t ikeFormatInfoResponse(IkeSaEntry *sa, uint8_t *p, size_t *length)
Format INFORMATIONAL response.
uint8_t nextPayload
Definition: ike.h:1447
error_t ikeSendCreateChildSaResponse(IkeSaEntry *sa)
Send CREATE_CHILD_SA response.
error_t ikeSendIkeAuthResponse(IkeSaEntry *sa)
Send IKE_AUTH response.
error_t ikeFormatIkeAuthResponse(IkeSaEntry *sa, uint8_t *p, size_t *length)
Format IKE_AUTH response.
error_t ikeFormatIkeSaRekeyResponse(IkeSaEntry *sa, uint8_t *p, size_t *length, uint8_t **nextPayload)
Format IKE SA rekeying response.