eap_peer_procedures.h
Go to the documentation of this file.
1 /**
2  * @file eap_peer_procedures.h
3  * @brief EAP peer state machine procedures
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 _EAP_PEER_PROCEDURES_H
32 #define _EAP_PEER_PROCEDURES_H
33 
34 //Dependencies
35 #include "supplicant/supplicant.h"
36 
37 //C++ guard
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 //EAP related functions
43 void eapParseReq(SupplicantContext *context);
44 bool_t eapCheckReq(SupplicantContext *context);
45 void eapProcessReq(SupplicantContext *context);
46 void eapBuildResp(SupplicantContext *context);
47 void eapProcessIdentity(SupplicantContext *context);
48 void eapBuildIdentity(SupplicantContext *context);
49 void eapProcessNotify(SupplicantContext *context);
50 void eapBuildNotify(SupplicantContext *context);
51 void eapBuildNak(SupplicantContext *context);
52 uint8_t *eapPeerGetKey(SupplicantContext *context);
53 bool_t eapIsKeyAvailable(SupplicantContext *context);
54 bool_t eapAllowMethod(SupplicantContext *context, EapMethodType method);
55 
56 //C++ guard
57 #ifdef __cplusplus
58 }
59 #endif
60 
61 #endif
bool_t
int bool_t
Definition: compiler_port.h:53
EapMethodType
EapMethodType
EAP method types.
Definition: eap.h:164
eapProcessReq
void eapProcessReq(SupplicantContext *context)
Parse and process a request.
Definition: eap_peer_procedures.c:154
eapProcessIdentity
void eapProcessIdentity(SupplicantContext *context)
Process the contents of Identity request.
Definition: eap_peer_procedures.c:242
eapPeerGetKey
uint8_t * eapPeerGetKey(SupplicantContext *context)
Obtain key material for use by EAP or lower layers.
Definition: eap_peer_procedures.c:411
eapAllowMethod
bool_t eapAllowMethod(SupplicantContext *context, EapMethodType method)
Check whether the specified EAP method is allowed.
Definition: eap_peer_procedures.c:444
eapIsKeyAvailable
bool_t eapIsKeyAvailable(SupplicantContext *context)
Check whether EAP key is available.
Definition: eap_peer_procedures.c:427
eapCheckReq
bool_t eapCheckReq(SupplicantContext *context)
Test for the validity of a message.
Definition: eap_peer_procedures.c:111
eapBuildResp
void eapBuildResp(SupplicantContext *context)
Create a response message.
Definition: eap_peer_procedures.c:207
eapBuildIdentity
void eapBuildIdentity(SupplicantContext *context)
Create the appropriate Identity response.
Definition: eap_peer_procedures.c:254
eapParseReq
void eapParseReq(SupplicantContext *context)
Determine the code, identifier value, and type of the current request.
Definition: eap_peer_procedures.c:51
eapBuildNotify
void eapBuildNotify(SupplicantContext *context)
Create the appropriate Notification response.
Definition: eap_peer_procedures.c:308
eapProcessNotify
void eapProcessNotify(SupplicantContext *context)
Process the contents of Notification request.
Definition: eap_peer_procedures.c:296
eapBuildNak
void eapBuildNak(SupplicantContext *context)
Create a NAK response.
Definition: eap_peer_procedures.c:345
supplicant.h
802.1X supplicant
SupplicantContext
#define SupplicantContext
Definition: supplicant.h:36