eap_auth_procedures.h
Go to the documentation of this file.
1 /**
2  * @file eap_auth_procedures.h
3  * @brief EAP authenticator 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_AUTH_PROCEDURES_H
32 #define _EAP_AUTH_PROCEDURES_H
33 
34 //Dependencies
36 
37 //C++ guard
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 //EAP related functions
48 
52 
61 
62 uint_t eapGetId(const uint8_t *eapReqData, size_t eapReqDataLen);
63 
64 //C++ guard
65 #ifdef __cplusplus
66 }
67 #endif
68 
69 #endif
802.1X authenticator
#define AuthenticatorPort
Definition: authenticator.h:40
unsigned int uint_t
Definition: compiler_port.h:50
int bool_t
Definition: compiler_port.h:53
uint16_t port
Definition: dns_common.h:267
EapMethodType
EAP method types.
Definition: eap.h:164
bool_t eapCheckResp(AuthenticatorPort *port)
Test for the validity of a message.
bool_t eapIsDone(AuthenticatorPort *port)
Check for method completion.
uint_t eapNextId(uint_t id)
Determine the next identifier value to use.
void eapProcessResp(AuthenticatorPort *port)
Parse and process a response.
void eapBuildFailure(AuthenticatorPort *port)
Create an EAP failure packet.
EapMethodType eapPolicyGetNextMethod(AuthenticatorPort *port)
Determine the method that should be used at this point in the conversation.
void eapReset(AuthenticatorPort *port)
The method is ending in the middle of or before completion.
void eapPolicyUpdate(AuthenticatorPort *port)
Update all variables related to internal policy state.
uint_t eapGetId(const uint8_t *eapReqData, size_t eapReqDataLen)
Determine the identifier value for the current EAP request.
EapDecision eapPolicyGetDecision(AuthenticatorPort *port)
Determine if the policy will allow SUCCESS, FAIL, or is yet to determine.
uint_t eapCalculateTimeout(AuthenticatorPort *port)
Calculate retransmission timeout.
void eapInit(AuthenticatorPort *port)
Method procedure to initialize state just before use.
uint8_t * eapAuthGetKey(AuthenticatorPort *port)
Obtain key material for use by EAP or lower layers.
uint_t eapGetTimeout(AuthenticatorPort *port)
Determine an appropriate timeout hint for the method.
void eapBuildReq(AuthenticatorPort *port)
Produce the next request.
void eapParseResp(AuthenticatorPort *port)
Determine the code, identifier value, and type of the current response.
void eapBuildSuccess(AuthenticatorPort *port)
Create an EAP success packet.
EapDecision
Decisions.