esp_packet_decrypt.h
Go to the documentation of this file.
1 /**
2  * @file esp_packet_decrypt.h
3  * @brief ESP packet decryption
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 _ESP_PACKET_DECRYPT_H
32 #define _ESP_PACKET_DECRYPT_H
33 
34 //Dependencies
35 #include "ipsec/ipsec.h"
36 #include "esp/esp.h"
37 
38 //C++ guard
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 //ESP related functions
45  const EspHeader *espHeader, uint8_t *payload, size_t *payloadLen,
46  uint8_t *nextHeader);
47 
49  const EspHeader *espHeader, const uint8_t *payload, size_t length,
50  const uint8_t *icv);
51 
52 //C++ guard
53 #ifdef __cplusplus
54 }
55 #endif
56 
57 #endif
uint8_t icv[]
Definition: ah.h:145
error_t espDecryptPacket(IpsecContext *context, IpsecSadEntry *sa, const EspHeader *espHeader, uint8_t *payload, size_t *payloadLen, uint8_t *nextHeader)
Decrypt an incoming ESP packet.
ESP (IP Encapsulating Security Payload)
error_t
Error codes.
Definition: error.h:43
uint8_t nextHeader
Definition: ipv6.h:282
IPsec context.
Definition: ipsec.h:434
uint8_t length
Definition: tcp.h:368
#define IpsecSadEntry
Definition: ipsec.h:36
EspHeader
Definition: esp.h:255
IPsec (IP security)
uint8_t payload[]
Definition: ipv6.h:286
uint16_t payloadLen
Definition: ipv6.h:281
error_t espVerifyChecksum(IpsecContext *context, IpsecSadEntry *sa, const EspHeader *espHeader, const uint8_t *payload, size_t length, const uint8_t *icv)
Verify ICV checksum.