802.1X supplicant context More...
#include <supplicant.h>
Data Fields | |
| bool_t | running |
| Operational state of the supplicant. More... | |
| bool_t | stop |
| Stop request. More... | |
| OsEvent | event |
| Event object used to poll the sockets. More... | |
| OsTaskParameters | taskParams |
| Task parameters. More... | |
| OsTaskId | taskId |
| Task identifier. More... | |
| NetInterface * | interface |
| Underlying network interface. More... | |
| uint_t | portIndex |
| Port index. More... | |
| Socket * | socket |
| Underlying socket. More... | |
| char_t | username [SUPPLICANT_MAX_USERNAME_LEN] |
| User name. More... | |
| char_t | password [SUPPLICANT_MAX_PASSWORD_LEN] |
| Password. More... | |
| uint8_t | digest [MD5_DIGEST_SIZE] |
| Calculated hash value. More... | |
| TlsContext * | tlsContext |
| TLS context. More... | |
| TlsSessionState | tlsSession |
| TLS session state. More... | |
| SupplicantTlsInitCallback | tlsInitCallback |
| TLS initialization callback function. More... | |
| SupplicantPaeStateChangeCallback | paeStateChangeCallback |
| Supplicant PAE state change callback function. More... | |
| SupplicantBackendStateChangeCallback | backendStateChangeCallback |
| Supplicant backend state change callback function. More... | |
| EapPeerStateChangeCallback | eapPeerStateChangeCallback |
| EAP peer state change callback function. More... | |
| SupplicantTickCallback | tickCallback |
| Tick callback function. More... | |
| systime_t | timestamp |
| Timestamp to manage timeout. More... | |
| uint8_t | txBuffer [SUPPLICANT_TX_BUFFER_SIZE] |
| Transmission buffer. More... | |
| size_t | txBufferWritePos |
| size_t | txBufferReadPos |
| size_t | txBufferLen |
| uint8_t | rxBuffer [SUPPLICANT_TX_BUFFER_SIZE] |
| Reception buffer. More... | |
| size_t | rxBufferPos |
| size_t | rxBufferLen |
| SupplicantPaeState | suppPaeState |
| Supplicant PAE state. More... | |
| SupplicantBackendState | suppBackendState |
| Supplicant backend state. More... | |
| uint_t | authWhile |
| Timer used by the supplicant backend state machine (8.2.2.1 a) More... | |
| uint_t | heldWhile |
| Timer used by the supplicant PAE state machine (8.2.2.1 c) More... | |
| uint_t | startWhen |
| Timer used by the supplicant PAE state machine (8.2.2.1 f) More... | |
| bool_t | eapFail |
| The authentication has failed (8.2.2.2 g) More... | |
| bool_t | eapolEap |
| EAPOL PDU carrying a packet Type of EAP-Packet is received (8.2.2.2 h) More... | |
| bool_t | eapSuccess |
| The authentication process succeeds (8.2.2.2 i) More... | |
| bool_t | initialize |
| Forces all EAPOL state machines to their initial state (8.2.2.2 k) More... | |
| bool_t | keyDone |
| Variable set by the key machine (8.2.2.2 m) More... | |
| bool_t | keyRun |
| Variable set by the PACP machine (8.2.2.2 n) More... | |
| SupplicantPortMode | portControl |
| Port control (8.2.2.2 p) More... | |
| bool_t | portEnabled |
| Operational state of the port (8.2.2.2 q) More... | |
| bool_t | portValid |
| The value of this variable is set externally (8.2.2.2 s) More... | |
| bool_t | suppAbort |
| Aborts an authentication sequence (8.2.2.2 u) More... | |
| bool_t | suppFail |
| Unsuccessful authentication sequence (8.2.2.2 v) More... | |
| SupplicantPortStatus | suppPortStatus |
| Current authorization state of the supplicant PAE state machine (8.2.2.2 w) More... | |
| bool_t | suppStart |
| Start an authentication sequence (8.2.2.2 x) More... | |
| bool_t | suppSuccess |
| Successful authentication sequence (8.2.2.2 y) More... | |
| bool_t | suppTimeout |
| The authentication sequence has timed out (8.2.2.2 z) More... | |
| bool_t | eapRestart |
| The higher layer is ready to establish an authentication session (8.2.11.1.1 a) More... | |
| bool_t | logoffSent |
| An EAPOL-Logoff message has been sent (8.2.11.1.1 b) More... | |
| SupplicantPortMode | sPortMode |
| Used to switch between the auto and non-auto modes of operation (8.2.11.1.1 c) More... | |
| uint_t | startCount |
| Number of EAPOL-Start messages that have been sent (8.2.11.1.1 d) More... | |
| bool_t | userLogoff |
| The user is logged off (8.2.11.1.1 e) More... | |
| uint_t | heldPeriod |
| Initialization value used for the heldWhile timer (8.2.11.1.2 a) More... | |
| uint_t | startPeriod |
| Initialization value used for the startWhen timer (8.2.11.1.2 b) More... | |
| uint_t | maxStart |
| Maximum number of successive EAPOL-Start messages that will be sent (8.2.11.1.2 c) More... | |
| bool_t | eapNoResp |
| No EAP Response for the last EAP frame delivered to EAP (8.2.12.1.1 a) More... | |
| bool_t | eapReq |
| An EAP frame is available for processing by EAP (8.2.12.1.1 b) More... | |
| bool_t | eapResp |
| An EAP frame available for transmission to authenticator (8.2.12.1.1 c) More... | |
| uint_t | authPeriod |
| Initialization value used for the authWhile timer (8.2.12.1.2 a) More... | |
| EapPeerState | eapPeerState |
| EAP peer state. More... | |
| bool_t | allowNotifications |
| const uint8_t * | eapReqData |
| Contents of the EAP request (4.1.1) More... | |
| size_t | eapReqDataLen |
| Length of the EAP request. More... | |
| uint_t | idleWhile |
| Timer (4.1.1) More... | |
| bool_t | altAccept |
| Alternate indication of success (4.1.1) More... | |
| bool_t | altReject |
| Alternate indication of failure (4.1.1) More... | |
| uint8_t * | eapRespData |
| EAP response to send (4.1.2) More... | |
| size_t | eapRespDataLen |
| Length of the EAP response. More... | |
| uint8_t * | eapKeyData |
| EAP key (4.1.2) More... | |
| bool_t | eapKeyAvailable |
| Keying material is available (4.1.2) More... | |
| uint_t | clientTimeout |
| Time to wait for a valid request before aborting (4.1.3) More... | |
| EapMethodType | selectedMethod |
| The method currently in progress (4.3.1) More... | |
| EapMethodState | methodState |
| Method state (4.3.1) More... | |
| uint_t | lastId |
| EAP identifier value of the last request (4.3.1) More... | |
| uint8_t * | lastRespData |
| Last EAP packet sent from the peer (4.3.1) More... | |
| size_t | lastRespDataLen |
| Length of the last EAP response. More... | |
| EapDecision | decision |
| Decision (4.3.1) More... | |
| bool_t | rxReq |
| The current received packet is an EAP Request (4.3.2) More... | |
| bool_t | rxSuccess |
| The current received packet is an EAP Success (4.3.2) More... | |
| bool_t | rxFailure |
| The current received packet is an EAP Failure (4.3.2) More... | |
| uint_t | reqId |
| Identifier value associated with the current EAP request (4.3.2) More... | |
| EapMethodType | reqMethod |
| Method type of the current EAP request (4.3.2) More... | |
| bool_t | ignore |
| Drop the current packet (4.3.2) More... | |
| bool_t | allowCanned |
| Allow canned EAP Success and Failure packets. More... | |
| bool_t | busy |
| Busy flag. More... | |
Detailed Description
802.1X supplicant context
Definition at line 204 of file supplicant.h.
Field Documentation
◆ allowCanned
| bool_t allowCanned |
Allow canned EAP Success and Failure packets.
Definition at line 305 of file supplicant.h.
◆ allowNotifications
| bool_t allowNotifications |
Definition at line 279 of file supplicant.h.
◆ altAccept
| bool_t altAccept |
Alternate indication of success (4.1.1)
Definition at line 283 of file supplicant.h.
◆ altReject
| bool_t altReject |
Alternate indication of failure (4.1.1)
Definition at line 284 of file supplicant.h.
◆ authPeriod
| uint_t authPeriod |
Initialization value used for the authWhile timer (8.2.12.1.2 a)
Definition at line 275 of file supplicant.h.
◆ authWhile
| uint_t authWhile |
Timer used by the supplicant backend state machine (8.2.2.1 a)
Definition at line 241 of file supplicant.h.
◆ backendStateChangeCallback
| SupplicantBackendStateChangeCallback backendStateChangeCallback |
Supplicant backend state change callback function.
Definition at line 225 of file supplicant.h.
◆ busy
| bool_t busy |
Busy flag.
Definition at line 306 of file supplicant.h.
◆ clientTimeout
| uint_t clientTimeout |
Time to wait for a valid request before aborting (4.1.3)
Definition at line 289 of file supplicant.h.
◆ decision
| EapDecision decision |
Decision (4.3.1)
Definition at line 296 of file supplicant.h.
◆ digest
| uint8_t digest[MD5_DIGEST_SIZE] |
Calculated hash value.
Definition at line 217 of file supplicant.h.
◆ eapFail
| bool_t eapFail |
The authentication has failed (8.2.2.2 g)
Definition at line 245 of file supplicant.h.
◆ eapKeyAvailable
| bool_t eapKeyAvailable |
Keying material is available (4.1.2)
Definition at line 288 of file supplicant.h.
◆ eapKeyData
| uint8_t* eapKeyData |
EAP key (4.1.2)
Definition at line 287 of file supplicant.h.
◆ eapNoResp
| bool_t eapNoResp |
No EAP Response for the last EAP frame delivered to EAP (8.2.12.1.1 a)
Definition at line 271 of file supplicant.h.
◆ eapolEap
| bool_t eapolEap |
EAPOL PDU carrying a packet Type of EAP-Packet is received (8.2.2.2 h)
Definition at line 246 of file supplicant.h.
◆ eapPeerState
| EapPeerState eapPeerState |
EAP peer state.
Definition at line 277 of file supplicant.h.
◆ eapPeerStateChangeCallback
| EapPeerStateChangeCallback eapPeerStateChangeCallback |
EAP peer state change callback function.
Definition at line 226 of file supplicant.h.
◆ eapReq
| bool_t eapReq |
An EAP frame is available for processing by EAP (8.2.12.1.1 b)
Definition at line 272 of file supplicant.h.
◆ eapReqData
| const uint8_t* eapReqData |
Contents of the EAP request (4.1.1)
Definition at line 280 of file supplicant.h.
◆ eapReqDataLen
| size_t eapReqDataLen |
Length of the EAP request.
Definition at line 281 of file supplicant.h.
◆ eapResp
| bool_t eapResp |
An EAP frame available for transmission to authenticator (8.2.12.1.1 c)
Definition at line 273 of file supplicant.h.
◆ eapRespData
| uint8_t* eapRespData |
EAP response to send (4.1.2)
Definition at line 285 of file supplicant.h.
◆ eapRespDataLen
| size_t eapRespDataLen |
Length of the EAP response.
Definition at line 286 of file supplicant.h.
◆ eapRestart
| bool_t eapRestart |
The higher layer is ready to establish an authentication session (8.2.11.1.1 a)
Definition at line 261 of file supplicant.h.
◆ eapSuccess
| bool_t eapSuccess |
The authentication process succeeds (8.2.2.2 i)
Definition at line 247 of file supplicant.h.
◆ event
| OsEvent event |
Event object used to poll the sockets.
Definition at line 208 of file supplicant.h.
◆ heldPeriod
| uint_t heldPeriod |
Initialization value used for the heldWhile timer (8.2.11.1.2 a)
Definition at line 267 of file supplicant.h.
◆ heldWhile
| uint_t heldWhile |
Timer used by the supplicant PAE state machine (8.2.2.1 c)
Definition at line 242 of file supplicant.h.
◆ idleWhile
| uint_t idleWhile |
Timer (4.1.1)
Definition at line 282 of file supplicant.h.
◆ ignore
| bool_t ignore |
Drop the current packet (4.3.2)
Definition at line 303 of file supplicant.h.
◆ initialize
| bool_t initialize |
Forces all EAPOL state machines to their initial state (8.2.2.2 k)
Definition at line 248 of file supplicant.h.
◆ interface
| NetInterface* interface |
Underlying network interface.
Definition at line 211 of file supplicant.h.
◆ keyDone
| bool_t keyDone |
Variable set by the key machine (8.2.2.2 m)
Definition at line 249 of file supplicant.h.
◆ keyRun
| bool_t keyRun |
Variable set by the PACP machine (8.2.2.2 n)
Definition at line 250 of file supplicant.h.
◆ lastId
| uint_t lastId |
EAP identifier value of the last request (4.3.1)
Definition at line 293 of file supplicant.h.
◆ lastRespData
| uint8_t* lastRespData |
Last EAP packet sent from the peer (4.3.1)
Definition at line 294 of file supplicant.h.
◆ lastRespDataLen
| size_t lastRespDataLen |
Length of the last EAP response.
Definition at line 295 of file supplicant.h.
◆ logoffSent
| bool_t logoffSent |
An EAPOL-Logoff message has been sent (8.2.11.1.1 b)
Definition at line 262 of file supplicant.h.
◆ maxStart
| uint_t maxStart |
Maximum number of successive EAPOL-Start messages that will be sent (8.2.11.1.2 c)
Definition at line 269 of file supplicant.h.
◆ methodState
| EapMethodState methodState |
Method state (4.3.1)
Definition at line 292 of file supplicant.h.
◆ paeStateChangeCallback
| SupplicantPaeStateChangeCallback paeStateChangeCallback |
Supplicant PAE state change callback function.
Definition at line 224 of file supplicant.h.
◆ password
| char_t password[SUPPLICANT_MAX_PASSWORD_LEN] |
Password.
Definition at line 216 of file supplicant.h.
◆ portControl
| SupplicantPortMode portControl |
Port control (8.2.2.2 p)
Definition at line 251 of file supplicant.h.
◆ portEnabled
| bool_t portEnabled |
Operational state of the port (8.2.2.2 q)
Definition at line 252 of file supplicant.h.
◆ portIndex
| uint_t portIndex |
Port index.
Definition at line 212 of file supplicant.h.
◆ portValid
| bool_t portValid |
The value of this variable is set externally (8.2.2.2 s)
Definition at line 253 of file supplicant.h.
◆ reqId
| uint_t reqId |
Identifier value associated with the current EAP request (4.3.2)
Definition at line 301 of file supplicant.h.
◆ reqMethod
| EapMethodType reqMethod |
Method type of the current EAP request (4.3.2)
Definition at line 302 of file supplicant.h.
◆ running
| bool_t running |
Operational state of the supplicant.
Definition at line 206 of file supplicant.h.
◆ rxBuffer
| uint8_t rxBuffer[SUPPLICANT_TX_BUFFER_SIZE] |
Reception buffer.
Definition at line 234 of file supplicant.h.
◆ rxBufferLen
| size_t rxBufferLen |
Definition at line 236 of file supplicant.h.
◆ rxBufferPos
| size_t rxBufferPos |
Definition at line 235 of file supplicant.h.
◆ rxFailure
| bool_t rxFailure |
The current received packet is an EAP Failure (4.3.2)
Definition at line 300 of file supplicant.h.
◆ rxReq
| bool_t rxReq |
The current received packet is an EAP Request (4.3.2)
Definition at line 298 of file supplicant.h.
◆ rxSuccess
| bool_t rxSuccess |
The current received packet is an EAP Success (4.3.2)
Definition at line 299 of file supplicant.h.
◆ selectedMethod
| EapMethodType selectedMethod |
The method currently in progress (4.3.1)
Definition at line 291 of file supplicant.h.
◆ socket
| Socket* socket |
Underlying socket.
Definition at line 213 of file supplicant.h.
◆ sPortMode
| SupplicantPortMode sPortMode |
Used to switch between the auto and non-auto modes of operation (8.2.11.1.1 c)
Definition at line 263 of file supplicant.h.
◆ startCount
| uint_t startCount |
Number of EAPOL-Start messages that have been sent (8.2.11.1.1 d)
Definition at line 264 of file supplicant.h.
◆ startPeriod
| uint_t startPeriod |
Initialization value used for the startWhen timer (8.2.11.1.2 b)
Definition at line 268 of file supplicant.h.
◆ startWhen
| uint_t startWhen |
Timer used by the supplicant PAE state machine (8.2.2.1 f)
Definition at line 243 of file supplicant.h.
◆ stop
| bool_t stop |
Stop request.
Definition at line 207 of file supplicant.h.
◆ suppAbort
| bool_t suppAbort |
Aborts an authentication sequence (8.2.2.2 u)
Definition at line 254 of file supplicant.h.
◆ suppBackendState
| SupplicantBackendState suppBackendState |
Supplicant backend state.
Definition at line 239 of file supplicant.h.
◆ suppFail
| bool_t suppFail |
Unsuccessful authentication sequence (8.2.2.2 v)
Definition at line 255 of file supplicant.h.
◆ suppPaeState
| SupplicantPaeState suppPaeState |
Supplicant PAE state.
Definition at line 238 of file supplicant.h.
◆ suppPortStatus
| SupplicantPortStatus suppPortStatus |
Current authorization state of the supplicant PAE state machine (8.2.2.2 w)
Definition at line 256 of file supplicant.h.
◆ suppStart
| bool_t suppStart |
Start an authentication sequence (8.2.2.2 x)
Definition at line 257 of file supplicant.h.
◆ suppSuccess
| bool_t suppSuccess |
Successful authentication sequence (8.2.2.2 y)
Definition at line 258 of file supplicant.h.
◆ suppTimeout
| bool_t suppTimeout |
The authentication sequence has timed out (8.2.2.2 z)
Definition at line 259 of file supplicant.h.
◆ taskId
| OsTaskId taskId |
Task identifier.
Definition at line 210 of file supplicant.h.
◆ taskParams
| OsTaskParameters taskParams |
Task parameters.
Definition at line 209 of file supplicant.h.
◆ tickCallback
| SupplicantTickCallback tickCallback |
Tick callback function.
Definition at line 227 of file supplicant.h.
◆ timestamp
| systime_t timestamp |
Timestamp to manage timeout.
Definition at line 228 of file supplicant.h.
◆ tlsContext
| TlsContext* tlsContext |
TLS context.
Definition at line 220 of file supplicant.h.
◆ tlsInitCallback
| SupplicantTlsInitCallback tlsInitCallback |
TLS initialization callback function.
Definition at line 222 of file supplicant.h.
◆ tlsSession
| TlsSessionState tlsSession |
TLS session state.
Definition at line 221 of file supplicant.h.
◆ txBuffer
| uint8_t txBuffer[SUPPLICANT_TX_BUFFER_SIZE] |
Transmission buffer.
Definition at line 230 of file supplicant.h.
◆ txBufferLen
| size_t txBufferLen |
Definition at line 233 of file supplicant.h.
◆ txBufferReadPos
| size_t txBufferReadPos |
Definition at line 232 of file supplicant.h.
◆ txBufferWritePos
| size_t txBufferWritePos |
Definition at line 231 of file supplicant.h.
◆ userLogoff
| bool_t userLogoff |
The user is logged off (8.2.11.1.1 e)
Definition at line 265 of file supplicant.h.
◆ username
| char_t username[SUPPLICANT_MAX_USERNAME_LEN] |
User name.
Definition at line 214 of file supplicant.h.
The documentation for this struct was generated from the following file:
- cyclone_eap/supplicant/supplicant.h