ipsec_outbound.h
Go to the documentation of this file.
1 /**
2  * @file ipsec_outbound.h
3  * @brief IPsec processing of outbound IP traffic
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.4
29  **/
30 
31 #ifndef _IPSEC_OUTBOUND_H
32 #define _IPSEC_OUTBOUND_H
33 
34 //Dependencies
35 #include "ipsec/ipsec.h"
36 
37 //C++ guard
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 //IPsec related functions
44  const Ipv4PseudoHeader *pseudoHeader, uint16_t fragId, NetBuffer *buffer,
45  size_t offset, NetTxAncillary *ancillary);
46 
48  const NetBuffer *buffer, size_t offset, IpsecSelector *selector);
49 
51  NetInterface *interface, const Ipv4PseudoHeader *pseudoHeader,
52  uint16_t fragId, NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary);
53 
55  const Ipv4PseudoHeader *pseudoHeader, uint16_t fragId, NetBuffer *buffer,
56  size_t offset, NetTxAncillary *ancillary);
57 
58 //C++ guard
59 #ifdef __cplusplus
60 }
61 #endif
62 
63 #endif
IPsec selector.
Definition: ipsec.h:302
Structure describing a buffer that spans multiple chunks.
Definition: net_mem.h:89
error_t ipsecGetOutboundIpv4PacketSelector(const Ipv4PseudoHeader *pseudoHeader, const NetBuffer *buffer, size_t offset, IpsecSelector *selector)
Extract packet's selector from outbound IPv4 packet.
error_t ipsecSendIpv4Packet(NetInterface *interface, const Ipv4PseudoHeader *pseudoHeader, uint16_t fragId, NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
Send an IPv4 packet.
error_t
Error codes.
Definition: error.h:43
#define NetInterface
Definition: net.h:36
#define NetTxAncillary
Definition: net_misc.h:36
IPsec context.
Definition: ipsec.h:434
#define Ipv4PseudoHeader
Definition: ipv4.h:39
#define IpsecSadEntry
Definition: ipsec.h:36
IPsec (IP security)
error_t ipsecProtectIpv4Packet(IpsecContext *context, IpsecSadEntry *sa, NetInterface *interface, const Ipv4PseudoHeader *pseudoHeader, uint16_t fragId, NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
Protect an outbound IPv4 packet using AH or ESP.
error_t ipsecProcessOutboundIpv4Packet(NetInterface *interface, const Ipv4PseudoHeader *pseudoHeader, uint16_t fragId, NetBuffer *buffer, size_t offset, NetTxAncillary *ancillary)
Outbound IPv4 traffic processing.