eap_tls.h File Reference

EAP-TLS authentication method. More...

#include "eap/eap.h"
#include "supplicant/supplicant.h"

Go to the source code of this file.

Macros
#define	EAP_TLS_TX_BUFFER_START_POS
#define	EAP_TLS_MAX_INIT_FRAG_SIZE
#define	EAP_TLS_MAX_FRAG_SIZE

Functions
error_t	eapTlsCheckRequest (SupplicantContext *context, const EapTlsPacket *request, size_t length)
	Check incoming EAP-TLS request. More...
void	eapTlsProcessRequest (SupplicantContext *context, const EapTlsPacket *request, size_t length)
	Process incoming EAP-TLS request. More...
void	eapTlsBuildResponse (SupplicantContext *context)
	Build EAP-TLS response. More...
error_t	eapOpenTls (SupplicantContext *context)
	Open TLS session. More...
void	eapCloseTls (SupplicantContext *context, error_t error)
	Close TLS session. More...
error_t	eapTlsSendCallback (void *handle, const void *data, size_t length, size_t *written, uint_t flags)
	TLS send callback (I/O abstraction layer) More...
error_t	eapTlsReceiveCallback (void *handle, void *data, size_t size, size_t *received, uint_t flags)
	TLS receive callback (I/O abstraction layer) More...

Detailed Description

EAP-TLS authentication method.

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

Macro Definition Documentation

EAP_TLS_MAX_FRAG_SIZE

#define EAP_TLS_MAX_FRAG_SIZE

Value:

   (EAP_MAX_FRAG_SIZE - sizeof(EapolPdu) - \
   sizeof(EapTlsPacket))

Definition at line 47 of file eap_tls.h.

EAP_TLS_MAX_INIT_FRAG_SIZE

#define EAP_TLS_MAX_INIT_FRAG_SIZE

Value:

   (EAP_MAX_FRAG_SIZE - sizeof(EapolPdu) - \
   sizeof(EapTlsPacket) - sizeof(uint32_t))

Definition at line 43 of file eap_tls.h.

EAP_TLS_TX_BUFFER_START_POS

#define EAP_TLS_TX_BUFFER_START_POS

Value:

   (sizeof(EapolPdu) + \
   sizeof(EapTlsPacket) + sizeof(uint32_t))

Definition at line 39 of file eap_tls.h.

Function Documentation

eapCloseTls()

void eapCloseTls	(	SupplicantContext *	context,
		error_t	error
	)

Close TLS session.

Parameters

[in]	context	Pointer to the 802.1X supplicant context
[in]	error	Status code describing the reason for closing the TLS session

Definition at line 384 of file eap_tls.c.

eapOpenTls()

error_t eapOpenTls

(

SupplicantContext *

context

)

Open TLS session.

Parameters

[in]

context

Pointer to the 802.1X supplicant context

Returns

Error code

Definition at line 332 of file eap_tls.c.

eapTlsBuildResponse()

void eapTlsBuildResponse

(

SupplicantContext *

context

)

Build EAP-TLS response.

Parameters

[in]

context

Pointer to the 802.1X supplicant context

Definition at line 234 of file eap_tls.c.

eapTlsCheckRequest()

error_t eapTlsCheckRequest	(	SupplicantContext *	context,
		const EapTlsPacket *	request,
		size_t	length
	)

Check incoming EAP-TLS request.

Parameters

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

Definition at line 51 of file eap_tls.c.

eapTlsProcessRequest()

void eapTlsProcessRequest	(	SupplicantContext *	context,
		const EapTlsPacket *	request,
		size_t	length
	)

Process incoming EAP-TLS request.

Parameters

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

Definition at line 79 of file eap_tls.c.

eapTlsReceiveCallback()

error_t eapTlsReceiveCallback	(	void *	handle,
		void *	data,
		size_t	size,
		size_t *	received,
		uint_t	flags
	)

TLS receive callback (I/O abstraction layer)

Parameters

[in]	handle	Pointer the 802.1X supplicant context
[out]	data	Buffer where to store the incoming data
[in]	size	Maximum number of bytes that can be received
[out]	received	Number of bytes that have been received
[in]	flags	Unused parameter

Returns

Error code

Definition at line 460 of file eap_tls.c.

eapTlsSendCallback()

error_t eapTlsSendCallback	(	void *	handle,
		const void *	data,
		size_t	length,
		size_t *	written,
		uint_t	flags
	)

TLS send callback (I/O abstraction layer)

Parameters

[in]	handle	Pointer the 802.1X supplicant context
[in]	data	Pointer to a buffer containing the data to be transmitted
[in]	length	Number of data bytes to send
[out]	written	Number of bytes that have been transmitted
[in]	flags	Unused parameter

Returns

Error code

Definition at line 412 of file eap_tls.c.