Management of the 802.1X authenticator. More...

#include "authenticator/authenticator.h"

Functions
void	authenticatorMgmtLock (AuthenticatorContext *context)
	Acquire exclusive access to the 802.1X authenticator context. More...

void	authenticatorMgmtUnlock (AuthenticatorContext *context)
	Release exclusive access to the 802.1X authenticator context. More...

error_t	authenticatorMgmtSetInitialize (AuthenticatorContext *context, uint_t portIndex, bool_t initialize, bool_t commit)
	Force the value of the initialize variable. More...

error_t	authenticatorMgmtSetReauthenticate (AuthenticatorContext *context, uint_t portIndex, bool_t reAuthenticate, bool_t commit)
	Force the value of the reAuthenticate variable. More...

error_t	authenticatorMgmtSetPortControl (AuthenticatorContext *context, uint_t portIndex, AuthenticatorPortMode portControl, bool_t commit)
	Set the value of the AuthControlledPortControl parameter. More...

error_t	authenticatorMgmtSetQuietPeriod (AuthenticatorContext *context, uint_t portIndex, uint_t quietPeriod, bool_t commit)
	Set the value of the quietPeriod parameter. More...

error_t	authenticatorMgmtSetServerTimeout (AuthenticatorContext *context, uint_t portIndex, uint_t serverTimeout, bool_t commit)
	Set the value of the serverTimeout parameter. More...

error_t	authenticatorMgmtSetReAuthPeriod (AuthenticatorContext *context, uint_t portIndex, uint_t reAuthPeriod, bool_t commit)
	Set the value of the reAuthPeriod parameter. More...

error_t	authenticatorMgmtSetReAuthEnabled (AuthenticatorContext *context, uint_t portIndex, bool_t reAuthEnabled, bool_t commit)
	Set the value of the reAuthEnabled parameter. More...

error_t	authenticatorMgmtSetKeyTxEnabled (AuthenticatorContext *context, uint_t portIndex, bool_t keyTxEnabled, bool_t commit)
	Set the value of the KeyTransmissionEnabled parameter. More...

Detailed Description

Management of the 802.1X authenticator.

License

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

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 authenticator_mgmt.h.

Function Documentation

◆ authenticatorMgmtLock()

void authenticatorMgmtLock ( AuthenticatorContext * context )

Acquire exclusive access to the 802.1X authenticator context.

Parameters

[in] context Pointer to the 802.1X authenticator context

Definition at line 49 of file authenticator_mgmt.c.

◆ authenticatorMgmtSetInitialize()

error_t authenticatorMgmtSetInitialize	(	AuthenticatorContext *	context,
		uint_t	portIndex,
		bool_t	initialize,
		bool_t	commit
	)

Force the value of the initialize variable.

Parameters

[in]	context	Pointer to the 802.1X authenticator context
[in]	portIndex	Port index
[in]	initialize	Value of the initialize variable
[in]	commit	If this flag is TRUE, the authenticator verifies the parameter value and commits the change if the value is valid. If FALSE, the authenticator only performs the verification and does not take any further action

Returns: Error code

Definition at line 80 of file authenticator_mgmt.c.

◆ authenticatorMgmtSetKeyTxEnabled()

error_t authenticatorMgmtSetKeyTxEnabled	(	AuthenticatorContext *	context,
		uint_t	portIndex,
		bool_t	keyTxEnabled,
		bool_t	commit
	)

Set the value of the KeyTransmissionEnabled parameter.

Parameters

[in]	context	Pointer to the 802.1X authenticator context
[in]	portIndex	Port index
[in]	keyTxEnabled	Value of the KeyTransmissionEnabled parameter
[in]	commit	If this flag is TRUE, the authenticator verifies the parameter value and commits the change if the value is valid. If FALSE, the authenticator only performs the verification and does not take any further action

Returns: Error code

Definition at line 439 of file authenticator_mgmt.c.

◆ authenticatorMgmtSetPortControl()

error_t authenticatorMgmtSetPortControl	(	AuthenticatorContext *	context,
		uint_t	portIndex,
		AuthenticatorPortMode	portControl,
		bool_t	commit
	)

Set the value of the AuthControlledPortControl parameter.

Parameters

[in]	context	Pointer to the 802.1X authenticator context
[in]	portIndex	Port index
[in]	portControl	Value of the AuthControlledPortControl parameter
[in]	commit	If this flag is TRUE, the authenticator verifies the parameter value and commits the change if the value is valid. If FALSE, the authenticator only performs the verification and does not take any further action

Returns: Error code

Definition at line 181 of file authenticator_mgmt.c.

◆ authenticatorMgmtSetQuietPeriod()

error_t authenticatorMgmtSetQuietPeriod	(	AuthenticatorContext *	context,
		uint_t	portIndex,
		uint_t	quietPeriod,
		bool_t	commit
	)

Set the value of the quietPeriod parameter.

Parameters

[in]	context	Pointer to the 802.1X authenticator context
[in]	portIndex	Port index
[in]	quietPeriod	Value of the quietPeriod parameter
[in]	commit	If this flag is TRUE, the authenticator verifies the parameter value and commits the change if the value is valid. If FALSE, the authenticator only performs the verification and does not take any further action

Returns: Error code

Definition at line 224 of file authenticator_mgmt.c.

◆ authenticatorMgmtSetReAuthEnabled()

error_t authenticatorMgmtSetReAuthEnabled	(	AuthenticatorContext *	context,
		uint_t	portIndex,
		bool_t	reAuthEnabled,
		bool_t	commit
	)

Set the value of the reAuthEnabled parameter.

Parameters

[in]	context	Pointer to the 802.1X authenticator context
[in]	portIndex	Port index
[in]	reAuthEnabled	Value of the reAuthEnabled parameter
[in]	commit	If this flag is TRUE, the authenticator verifies the parameter value and commits the change if the value is valid. If FALSE, the authenticator only performs the verification and does not take any further action

Returns: Error code

Definition at line 396 of file authenticator_mgmt.c.

◆ authenticatorMgmtSetReauthenticate()

error_t authenticatorMgmtSetReauthenticate	(	AuthenticatorContext *	context,
		uint_t	portIndex,
		bool_t	reAuthenticate,
		bool_t	commit
	)

Force the value of the reAuthenticate variable.

Parameters

[in]	context	Pointer to the 802.1X authenticator context
[in]	portIndex	Port index
[in]	reAuthenticate	Value of the reAuthenticate variable
[in]	commit	If this flag is TRUE, the authenticator verifies the parameter value and commits the change if the value is valid. If FALSE, the authenticator only performs the verification and does not take any further action

Returns: Error code

Definition at line 135 of file authenticator_mgmt.c.

◆ authenticatorMgmtSetReAuthPeriod()

error_t authenticatorMgmtSetReAuthPeriod	(	AuthenticatorContext *	context,
		uint_t	portIndex,
		uint_t	reAuthPeriod,
		bool_t	commit
	)

Set the value of the reAuthPeriod parameter.

Parameters

[in]	context	Pointer to the 802.1X authenticator context
[in]	portIndex	Port index
[in]	reAuthPeriod	Value of the reAuthPeriod parameter
[in]	commit	If this flag is TRUE, the authenticator verifies the parameter value and commits the change if the value is valid. If FALSE, the authenticator only performs the verification and does not take any further action

Returns: Error code

Definition at line 338 of file authenticator_mgmt.c.

◆ authenticatorMgmtSetServerTimeout()

error_t authenticatorMgmtSetServerTimeout	(	AuthenticatorContext *	context,
		uint_t	portIndex,
		uint_t	serverTimeout,
		bool_t	commit
	)

Set the value of the serverTimeout parameter.

Parameters

[in]	context	Pointer to the 802.1X authenticator context
[in]	portIndex	Port index
[in]	serverTimeout	Value of the serverTimeout parameter
[in]	commit	If this flag is TRUE, the authenticator verifies the parameter value and commits the change if the value is valid. If FALSE, the authenticator only performs the verification and does not take any further action

Returns: Error code

Definition at line 279 of file authenticator_mgmt.c.

◆ authenticatorMgmtUnlock()

void authenticatorMgmtUnlock ( AuthenticatorContext * context )

Release exclusive access to the 802.1X authenticator context.

Parameters

[in] context Pointer to the 802.1X authenticator context

Definition at line 61 of file authenticator_mgmt.c.

Functions

Detailed Description

License

Function Documentation

◆ authenticatorMgmtLock()

◆ authenticatorMgmtSetInitialize()

◆ authenticatorMgmtSetKeyTxEnabled()

◆ authenticatorMgmtSetPortControl()

◆ authenticatorMgmtSetQuietPeriod()

◆ authenticatorMgmtSetReAuthEnabled()

◆ authenticatorMgmtSetReauthenticate()

◆ authenticatorMgmtSetReAuthPeriod()

◆ authenticatorMgmtSetServerTimeout()

◆ authenticatorMgmtUnlock()