supplicant_misc.h File Reference

Helper functions for 802.1X supplicant. More...

#include "supplicant/supplicant.h"

Go to the source code of this file.

Functions
void	supplicantTick (SupplicantContext *context)
	Handle periodic operations. More...
bool_t	supplicantGetLinkState (SupplicantContext *context)
	Get link state. More...
error_t	supplicantAcceptPaeGroupAddr (SupplicantContext *context)
	Add the PAE group address to the static MAC table. More...
error_t	supplicantDropPaeGroupAddr (SupplicantContext *context)
	Remove the PAE group address from the static MAC table. More...
error_t	supplicantSendEapolPdu (SupplicantContext *context, const uint8_t *pdu, size_t length)
	Send EAPOL PDU. More...
void	supplicantProcessEapolPdu (SupplicantContext *context)
	Process incoming EAPOL PDU. More...
void	supplicantProcessEapPacket (SupplicantContext *context, const EapPacket *packet, size_t length)
	Process incoming EAP packet. More...

Detailed Description

Helper functions for 802.1X supplicant.

License

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

Copyright (C) 2022-2024 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.4.0

Definition in file supplicant_misc.h.

Function Documentation

supplicantAcceptPaeGroupAddr()

error_t supplicantAcceptPaeGroupAddr

(

SupplicantContext *

context

)

Add the PAE group address to the static MAC table.

Parameters

[in]

context

Pointer to the 802.1X supplicant context

Returns

Error code

Definition at line 123 of file supplicant_misc.c.

supplicantDropPaeGroupAddr()

error_t supplicantDropPaeGroupAddr

(

SupplicantContext *

context

)

Remove the PAE group address from the static MAC table.

Parameters

[in]

context

Pointer to the 802.1X supplicant context

Returns

Error code

Definition at line 173 of file supplicant_misc.c.

supplicantGetLinkState()

bool_t supplicantGetLinkState

(

SupplicantContext *

context

)

Get link state.

Parameters

[in]

context

Pointer to the 802.1X supplicant context

Returns

Error code

Definition at line 84 of file supplicant_misc.c.

supplicantProcessEapolPdu()

void supplicantProcessEapolPdu

(

SupplicantContext *

context

)

Process incoming EAPOL PDU.

Parameters

[in]

context

Pointer to the 802.1X supplicant context

Definition at line 265 of file supplicant_misc.c.

supplicantProcessEapPacket()

void supplicantProcessEapPacket	(	SupplicantContext *	context,
		const EapPacket *	packet,
		size_t	length
	)

Process incoming EAP packet.

Parameters

[in]	context	Pointer to the 802.1X supplicant context
[in]	packet	Pointer to the received EAP packet
[in]	length	Length of the packet, in bytes

Definition at line 335 of file supplicant_misc.c.

supplicantSendEapolPdu()

error_t supplicantSendEapolPdu	(	SupplicantContext *	context,
		const uint8_t *	pdu,
		size_t	length
	)

Send EAPOL PDU.

Parameters

[in]	context	Pointer to the 802.1X supplicant context
[in]	pdu	Pointer to the PDU to be transmitted
[in]	length	Length of the PDU, in bytes

Returns

Error code

Definition at line 225 of file supplicant_misc.c.

supplicantTick()

void supplicantTick

(

SupplicantContext *

context

)

Handle periodic operations.

Parameters

[in]

context

Pointer to the 802.1X supplicant context

Definition at line 54 of file supplicant_misc.c.