supplicant_misc.h
Go to the documentation of this file.
1 /**
2  * @file supplicant_misc.h
3  * @brief Helper functions for 802.1X supplicant
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 CycloneEAP 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 _SUPPLICANT_MISC_H
32 #define _SUPPLICANT_MISC_H
33 
34 //Dependencies
35 #include "supplicant/supplicant.h"
36 
37 //C++ guard
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 //Supplicant related functions
43 void supplicantTick(SupplicantContext *context);
45 
48 
49 error_t supplicantSendEapolPdu(SupplicantContext *context, const uint8_t *pdu,
50  size_t length);
51 
53 
55  const EapPacket *packet, size_t length);
56 
57 //C++ guard
58 #ifdef __cplusplus
59 }
60 #endif
61 
62 #endif
int bool_t
Definition: compiler_port.h:53
EapPacket
Definition: eap.h:224
error_t
Error codes.
Definition: error.h:43
uint8_t pdu[]
802.1X supplicant
#define SupplicantContext
Definition: supplicant.h:36
void supplicantProcessEapPacket(SupplicantContext *context, const EapPacket *packet, size_t length)
Process incoming EAP packet.
error_t supplicantSendEapolPdu(SupplicantContext *context, const uint8_t *pdu, size_t length)
Send EAPOL PDU.
void supplicantProcessEapolPdu(SupplicantContext *context)
Process incoming EAPOL PDU.
void supplicantTick(SupplicantContext *context)
Handle periodic operations.
error_t supplicantAcceptPaeGroupAddr(SupplicantContext *context)
Add the PAE group address to the static MAC table.
error_t supplicantDropPaeGroupAddr(SupplicantContext *context)
Remove the PAE group address from the static MAC table.
bool_t supplicantGetLinkState(SupplicantContext *context)
Get link state.
uint8_t length
Definition: tcp.h:368