Functions
authenticator_procedures.h File Reference

Authenticator state machine procedures. More...

#include "authenticator/authenticator.h"

Go to the source code of this file.

Functions

void authenticatorSetAuthPortStatus (AuthenticatorPort *port, AuthenticatorPortStatus status)
 Set authorization state for a given port. More...
 
void authenticatorTxCannedFail (AuthenticatorPort *port)
 Transmit an EAPOL frame containing an EAP failure (8.2.4.1.3 a) More...
 
void authenticatorTxCannedSuccess (AuthenticatorPort *port)
 Transmit an EAPOL frame containing an EAP success (8.2.4.1.3 b) More...
 
void authenticatorTxReq (AuthenticatorPort *port)
 Transmit an EAPOL frame of type EAP-Packet (8.2.9.1.3 a) More...
 
void authenticatorSendRespToServer (AuthenticatorPort *port)
 Deliver the received EAP frame to EAP for processing (8.2.9.1.3 b) More...
 
void authenticatorAbortAuth (AuthenticatorPort *port)
 Release any system resources (8.2.9.1.3 c) More...
 
void authenticatorDecrementTimer (uint_t *x)
 Decrement timer value. More...
 

Detailed Description

Authenticator state machine procedures.

License

SPDX-License-Identifier: GPL-2.0-or-later

Copyright (C) 2022-2025 Oryx Embedded SARL. All rights reserved.

This file is part of CycloneEAP Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author
Oryx Embedded SARL (www.oryx-embedded.com)
Version
2.5.4

Definition in file authenticator_procedures.h.

Function Documentation

◆ authenticatorAbortAuth()

void authenticatorAbortAuth ( AuthenticatorPort *  port)

Release any system resources (8.2.9.1.3 c)

Parameters
[in]portPointer to the port context

Definition at line 302 of file authenticator_procedures.c.

◆ authenticatorDecrementTimer()

void authenticatorDecrementTimer ( uint_t *  x)

Decrement timer value.

Parameters
[in,out]xActual timer value

Definition at line 312 of file authenticator_procedures.c.

◆ authenticatorSendRespToServer()

void authenticatorSendRespToServer ( AuthenticatorPort *  port)

Deliver the received EAP frame to EAP for processing (8.2.9.1.3 b)

Parameters
[in]portPointer to the port context

Definition at line 290 of file authenticator_procedures.c.

◆ authenticatorSetAuthPortStatus()

void authenticatorSetAuthPortStatus ( AuthenticatorPort *  port,
AuthenticatorPortStatus  status 
)

Set authorization state for a given port.

Parameters
[in]portPointer to the port context
[in]statusAuthorization state (authorized or unauthorized)

Definition at line 52 of file authenticator_procedures.c.

◆ authenticatorTxCannedFail()

void authenticatorTxCannedFail ( AuthenticatorPort *  port)

Transmit an EAPOL frame containing an EAP failure (8.2.4.1.3 a)

Parameters
[in]portPointer to the port context

Definition at line 102 of file authenticator_procedures.c.

◆ authenticatorTxCannedSuccess()

void authenticatorTxCannedSuccess ( AuthenticatorPort *  port)

Transmit an EAPOL frame containing an EAP success (8.2.4.1.3 b)

Parameters
[in]portPointer to the port context

Definition at line 164 of file authenticator_procedures.c.

◆ authenticatorTxReq()

void authenticatorTxReq ( AuthenticatorPort *  port)

Transmit an EAPOL frame of type EAP-Packet (8.2.9.1.3 a)

Parameters
[in]portPointer to the port context

Definition at line 226 of file authenticator_procedures.c.