Port context. More...
#include <authenticator.h>
Data Fields | |
| AuthenticatorContext * | context |
| 802.1X authenticator context More... | |
| uint8_t | portIndex |
| Port index. More... | |
| MacAddr | macAddr |
| MAC address of the port. More... | |
| AuthenticatorPaeState | authPaeState |
| Authenticator PAE state. More... | |
| AuthenticatorBackendState | authBackendState |
| Backend authentication state. More... | |
| AuthenticatorReauthTimerState | reauthTimerState |
| Reauthentication timer state. More... | |
| uint_t | aWhile |
| Timer used by the backend authentication state machine (8.2.2.1 a) More... | |
| uint_t | quietWhile |
| Timer used by the authenticator PAE state machine (8.2.2.1 d) More... | |
| uint_t | reAuthWhen |
| Timer used to determine when reauthentication takes place (8.2.2.1 e) More... | |
| bool_t | authAbort |
| Abort authentication procedure (8.2.2.2 a) More... | |
| bool_t | authFail |
| Authentication process has failed (8.2.2.2 b) More... | |
| AuthenticatorPortStatus | authPortStatus |
| Current authorization state of the authenticator PAE state machine (8.2.2.2 c) More... | |
| bool_t | authStart |
| bool_t | authTimeout |
| Start authentication procedure (8.2.2.2 d) More... | |
| bool_t | authSuccess |
| Successful authentication process (8.2.2.2 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 | eapTimeout |
| The supplicant is not responding to requests (8.2.2.2 j) More... | |
| bool_t | initialize |
| Forces all EAPOL state machines to their initial state (8.2.2.2 k) More... | |
| bool_t | keyDone |
| This variable is set by the key machine (8.2.2.2 m) More... | |
| bool_t | keyRun |
| Run transmit key machine (8.2.2.2 n) More... | |
| AuthenticatorPortMode | 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 | reAuthenticate |
| The reAuthWhen timer has expired (8.2.2.2 t) More... | |
| bool_t | eapolLogoff |
| EAPOL-Logoff received (8.2.4.1.1 a) More... | |
| bool_t | eapolStart |
| EAPOL-Start received (8.2.4.1.1 b) More... | |
| bool_t | eapRestart |
| Restart Authenticator state machine (8.2.4.1.1 d) More... | |
| AuthenticatorPortMode | portMode |
| Port mode (8.2.4.1.1 e) More... | |
| uint_t | reAuthCount |
| Number of times the CONNECTING state is re-entered (8.2.4.1.1 f) More... | |
| uint_t | quietPeriod |
| Initialization value used for the quietWhile timer (8.2.4.1.2 a) More... | |
| uint_t | reAuthMax |
| Maximum number of reauthentication attempts (8.2.4.1.2 b) More... | |
| bool_t | keyTxEnabled |
| Current value of the KeyTransmissionEnabled parameter (8.2.6.1.2) More... | |
| uint_t | reAuthPeriod |
| Number of seconds between periodic reauthentication (8.2.8.1 a) More... | |
| bool_t | reAuthEnabled |
| Enable or disable reauthentication (8.2.8.1 b) More... | |
| bool_t | eapNoReq |
| No EAP frame to be sent to the supplicant (8.2.9.1.1 a) More... | |
| bool_t | eapReq |
| An EAP frame to be sent to the supplicant (8.2.9.1.1 b) More... | |
| bool_t | eapResp |
| A new EAP frame available for the higher layer to process (8.2.9.1.1 c) More... | |
| uint_t | serverTimeout |
| Initialization value used for the aWhile timer (8.2.9.1.2 a) More... | |
| EapFullAuthState | eapFullAuthState |
| EAP full authenticator state. More... | |
| const uint8_t * | eapRespData |
| The EAP packet to be processed (5.1.1) More... | |
| size_t | eapRespDataLen |
| Length of the EAP response. More... | |
| uint_t | retransWhile |
| Timer (5.1.1) More... | |
| uint8_t * | eapReqData |
| The actual EAP request to be sent (5.1.2) More... | |
| size_t | eapReqDataLen |
| Length of the EAP request. More... | |
| uint8_t * | eapKeyData |
| EAP key (5.1.2) More... | |
| bool_t | eapKeyAvailable |
| Keying material is available (5.1.2) More... | |
| EapMethodType | currentMethod |
| Current method (5.3.1) More... | |
| uint_t | currentId |
| Identifier value of the currently outstanding EAP request (5.3.1) More... | |
| EapMethodState | methodState |
| Method state (5.3.1) More... | |
| uint_t | retransCount |
| Current number of retransmissions (5.3.1) More... | |
| uint8_t * | lastReqData |
| EAP packet containing the last sent request (5.3.1) More... | |
| size_t | lastReqDataLen |
| Length of the last EAP request. More... | |
| uint_t | methodTimeout |
| Method-provided hint for suitable retransmission timeout (5.3.1) More... | |
| bool_t | rxResp |
| The current received packet is an EAP response (5.3.2) More... | |
| uint_t | respId |
| Identifier from the current EAP response (5.3.2) More... | |
| EapMethodType | respMethod |
| Method type of the current EAP response (5.3.2) More... | |
| bool_t | ignore |
| The method has decided to drop the current packet (5.3.2) More... | |
| EapDecision | decision |
| Decision (5.3.2) More... | |
| bool_t | aaaEapReq |
| A new EAP request is ready to be sent (6.1.2) More... | |
| bool_t | aaaEapNoReq |
| No new request to send (6.1.2) More... | |
| bool_t | aaaSuccess |
| The state machine has reached the SUCCESS state (6.1.2) More... | |
| bool_t | aaaFail |
| The state machine has reached the FAILURE state (6.1.2) More... | |
| uint8_t * | aaaEapReqData |
| The actual EAP request to be sent (6.1.2) More... | |
| size_t | aaaEapReqDataLen |
| Length of the EAP request. More... | |
| uint8_t * | aaaEapKeyData |
| EAP key (6.1.2) More... | |
| bool_t | aaaEapKeyAvailable |
| Keying material is available (6.1.2) More... | |
| uint_t | aaaMethodTimeout |
| Method-provided hint for suitable retransmission timeout (6.1.2) More... | |
| bool_t | aaaEapResp |
| An EAP response is available for processing by the AAA server (7.1.2) More... | |
| const uint8_t * | aaaEapRespData |
| The EAP packet to be processed (5.1.2) More... | |
| size_t | aaaEapRespDataLen |
| Length of the EAP response. More... | |
| char_t | aaaIdentity [AUTHENTICATOR_MAX_ID_LEN+1] |
| Identity (5.1.2) More... | |
| uint_t | maxRetrans |
| Maximum number of retransmissions before aborting (5.1.3) More... | |
| bool_t | aaaTimeout |
| No response from the AAA layer (7.1.2) More... | |
| uint8_t | aaaReqId |
| Identifier value of the currently outstanding RADIUS request. More... | |
| uint8_t * | aaaReqData |
| RADIUS request. More... | |
| size_t | aaaReqDataLen |
| Length of the RADIUS request. More... | |
| uint_t | aaaRetransTimer |
| RADIUS retransmission timer. More... | |
| uint_t | aaaRetransCount |
| Current number of retransmissions or RADIUS requests. More... | |
| uint8_t | reqAuthenticator [16] |
| Request Authenticator field. More... | |
| uint8_t | serverState [AUTHENTICATOR_MAX_STATE_SIZE] |
| State attribute received from the server. More... | |
| size_t | serverStateLen |
| Length of the state attribute, in byte. More... | |
| MacAddr | supplicantMacAddr |
| Supplicant's MAC address. More... | |
| uint8_t | eapTxBuffer [AUTHENTICATOR_TX_BUFFER_SIZE] |
| Transmission buffer for EAP requests. More... | |
| uint8_t | aaaTxBuffer [AUTHENTICATOR_TX_BUFFER_SIZE] |
| Transmission buffer for RADIUS requests. More... | |
| AuthenticatorStats | stats |
| Statistics information. More... | |
| AuthenticatorSessionStats | sessionStats |
| Session statistics information. More... | |
Detailed Description
Port context.
Definition at line 303 of file authenticator.h.
Field Documentation
◆ aaaEapKeyAvailable
| bool_t aaaEapKeyAvailable |
Keying material is available (6.1.2)
Definition at line 388 of file authenticator.h.
◆ aaaEapKeyData
| uint8_t* aaaEapKeyData |
EAP key (6.1.2)
Definition at line 387 of file authenticator.h.
◆ aaaEapNoReq
| bool_t aaaEapNoReq |
No new request to send (6.1.2)
Definition at line 382 of file authenticator.h.
◆ aaaEapReq
| bool_t aaaEapReq |
A new EAP request is ready to be sent (6.1.2)
Definition at line 381 of file authenticator.h.
◆ aaaEapReqData
| uint8_t* aaaEapReqData |
The actual EAP request to be sent (6.1.2)
Definition at line 385 of file authenticator.h.
◆ aaaEapReqDataLen
| size_t aaaEapReqDataLen |
Length of the EAP request.
Definition at line 386 of file authenticator.h.
◆ aaaEapResp
| bool_t aaaEapResp |
An EAP response is available for processing by the AAA server (7.1.2)
Definition at line 391 of file authenticator.h.
◆ aaaEapRespData
| const uint8_t* aaaEapRespData |
The EAP packet to be processed (5.1.2)
Definition at line 392 of file authenticator.h.
◆ aaaEapRespDataLen
| size_t aaaEapRespDataLen |
Length of the EAP response.
Definition at line 393 of file authenticator.h.
◆ aaaFail
| bool_t aaaFail |
The state machine has reached the FAILURE state (6.1.2)
Definition at line 384 of file authenticator.h.
◆ aaaIdentity
| char_t aaaIdentity[AUTHENTICATOR_MAX_ID_LEN+1] |
Identity (5.1.2)
Definition at line 394 of file authenticator.h.
◆ aaaMethodTimeout
| uint_t aaaMethodTimeout |
Method-provided hint for suitable retransmission timeout (6.1.2)
Definition at line 389 of file authenticator.h.
◆ aaaReqData
| uint8_t* aaaReqData |
RADIUS request.
Definition at line 401 of file authenticator.h.
◆ aaaReqDataLen
| size_t aaaReqDataLen |
Length of the RADIUS request.
Definition at line 402 of file authenticator.h.
◆ aaaReqId
| uint8_t aaaReqId |
Identifier value of the currently outstanding RADIUS request.
Definition at line 400 of file authenticator.h.
◆ aaaRetransCount
| uint_t aaaRetransCount |
Current number of retransmissions or RADIUS requests.
Definition at line 404 of file authenticator.h.
◆ aaaRetransTimer
| uint_t aaaRetransTimer |
RADIUS retransmission timer.
Definition at line 403 of file authenticator.h.
◆ aaaSuccess
| bool_t aaaSuccess |
The state machine has reached the SUCCESS state (6.1.2)
Definition at line 383 of file authenticator.h.
◆ aaaTimeout
| bool_t aaaTimeout |
No response from the AAA layer (7.1.2)
Definition at line 398 of file authenticator.h.
◆ aaaTxBuffer
| uint8_t aaaTxBuffer[AUTHENTICATOR_TX_BUFFER_SIZE] |
Transmission buffer for RADIUS requests.
Definition at line 411 of file authenticator.h.
◆ authAbort
| bool_t authAbort |
Abort authentication procedure (8.2.2.2 a)
Definition at line 317 of file authenticator.h.
◆ authBackendState
| AuthenticatorBackendState authBackendState |
Backend authentication state.
Definition at line 310 of file authenticator.h.
◆ authFail
| bool_t authFail |
Authentication process has failed (8.2.2.2 b)
Definition at line 318 of file authenticator.h.
◆ authPaeState
| AuthenticatorPaeState authPaeState |
Authenticator PAE state.
Definition at line 309 of file authenticator.h.
◆ authPortStatus
| AuthenticatorPortStatus authPortStatus |
Current authorization state of the authenticator PAE state machine (8.2.2.2 c)
Definition at line 319 of file authenticator.h.
◆ authStart
| bool_t authStart |
Definition at line 320 of file authenticator.h.
◆ authSuccess
| bool_t authSuccess |
Successful authentication process (8.2.2.2 f)
Definition at line 322 of file authenticator.h.
◆ authTimeout
| bool_t authTimeout |
Start authentication procedure (8.2.2.2 d)
Failed to obtain a response from the supplicant(8.2.2.2 e)
Definition at line 321 of file authenticator.h.
◆ aWhile
| uint_t aWhile |
Timer used by the backend authentication state machine (8.2.2.1 a)
Definition at line 313 of file authenticator.h.
◆ context
| AuthenticatorContext* context |
802.1X authenticator context
Definition at line 305 of file authenticator.h.
◆ currentId
| uint_t currentId |
Identifier value of the currently outstanding EAP request (5.3.1)
Definition at line 368 of file authenticator.h.
◆ currentMethod
| EapMethodType currentMethod |
Current method (5.3.1)
Definition at line 367 of file authenticator.h.
◆ decision
| EapDecision decision |
Decision (5.3.2)
Definition at line 379 of file authenticator.h.
◆ eapFail
| bool_t eapFail |
The authentication has failed (8.2.2.2 g)
Definition at line 323 of file authenticator.h.
◆ eapFullAuthState
| EapFullAuthState eapFullAuthState |
EAP full authenticator state.
Definition at line 356 of file authenticator.h.
◆ eapKeyAvailable
| bool_t eapKeyAvailable |
Keying material is available (5.1.2)
Definition at line 365 of file authenticator.h.
◆ eapKeyData
| uint8_t* eapKeyData |
EAP key (5.1.2)
Definition at line 364 of file authenticator.h.
◆ eapNoReq
| bool_t eapNoReq |
No EAP frame to be sent to the supplicant (8.2.9.1.1 a)
Definition at line 350 of file authenticator.h.
◆ eapolEap
| bool_t eapolEap |
EAPOL PDU carrying a packet Type of EAP-Packet is received (8.2.2.2 h)
Definition at line 324 of file authenticator.h.
◆ eapolLogoff
| bool_t eapolLogoff |
EAPOL-Logoff received (8.2.4.1.1 a)
Definition at line 336 of file authenticator.h.
◆ eapolStart
| bool_t eapolStart |
EAPOL-Start received (8.2.4.1.1 b)
Definition at line 337 of file authenticator.h.
◆ eapReq
| bool_t eapReq |
An EAP frame to be sent to the supplicant (8.2.9.1.1 b)
Definition at line 351 of file authenticator.h.
◆ eapReqData
| uint8_t* eapReqData |
The actual EAP request to be sent (5.1.2)
Definition at line 362 of file authenticator.h.
◆ eapReqDataLen
| size_t eapReqDataLen |
Length of the EAP request.
Definition at line 363 of file authenticator.h.
◆ eapResp
| bool_t eapResp |
A new EAP frame available for the higher layer to process (8.2.9.1.1 c)
Definition at line 352 of file authenticator.h.
◆ eapRespData
| const uint8_t* eapRespData |
The EAP packet to be processed (5.1.1)
Definition at line 358 of file authenticator.h.
◆ eapRespDataLen
| size_t eapRespDataLen |
Length of the EAP response.
Definition at line 359 of file authenticator.h.
◆ eapRestart
| bool_t eapRestart |
Restart Authenticator state machine (8.2.4.1.1 d)
Definition at line 338 of file authenticator.h.
◆ eapSuccess
| bool_t eapSuccess |
The authentication process succeeds (8.2.2.2 i)
Definition at line 325 of file authenticator.h.
◆ eapTimeout
| bool_t eapTimeout |
The supplicant is not responding to requests (8.2.2.2 j)
Definition at line 326 of file authenticator.h.
◆ eapTxBuffer
| uint8_t eapTxBuffer[AUTHENTICATOR_TX_BUFFER_SIZE] |
Transmission buffer for EAP requests.
Definition at line 410 of file authenticator.h.
◆ ignore
| bool_t ignore |
The method has decided to drop the current packet (5.3.2)
Definition at line 378 of file authenticator.h.
◆ initialize
| bool_t initialize |
Forces all EAPOL state machines to their initial state (8.2.2.2 k)
Definition at line 328 of file authenticator.h.
◆ keyDone
| bool_t keyDone |
This variable is set by the key machine (8.2.2.2 m)
Definition at line 329 of file authenticator.h.
◆ keyRun
| bool_t keyRun |
Run transmit key machine (8.2.2.2 n)
Definition at line 330 of file authenticator.h.
◆ keyTxEnabled
| bool_t keyTxEnabled |
Current value of the KeyTransmissionEnabled parameter (8.2.6.1.2)
Definition at line 345 of file authenticator.h.
◆ lastReqData
| uint8_t* lastReqData |
EAP packet containing the last sent request (5.3.1)
Definition at line 371 of file authenticator.h.
◆ lastReqDataLen
| size_t lastReqDataLen |
Length of the last EAP request.
Definition at line 372 of file authenticator.h.
◆ macAddr
| MacAddr macAddr |
MAC address of the port.
Definition at line 307 of file authenticator.h.
◆ maxRetrans
| uint_t maxRetrans |
Maximum number of retransmissions before aborting (5.1.3)
Definition at line 396 of file authenticator.h.
◆ methodState
| EapMethodState methodState |
Method state (5.3.1)
Definition at line 369 of file authenticator.h.
◆ methodTimeout
| uint_t methodTimeout |
Method-provided hint for suitable retransmission timeout (5.3.1)
Definition at line 373 of file authenticator.h.
◆ portControl
| AuthenticatorPortMode portControl |
Port control (8.2.2.2 p)
Definition at line 331 of file authenticator.h.
◆ portEnabled
| bool_t portEnabled |
Operational state of the port (8.2.2.2 q)
Definition at line 332 of file authenticator.h.
◆ portIndex
| uint8_t portIndex |
Port index.
Definition at line 306 of file authenticator.h.
◆ portMode
| AuthenticatorPortMode portMode |
Port mode (8.2.4.1.1 e)
Definition at line 339 of file authenticator.h.
◆ portValid
| bool_t portValid |
The value of this variable is set externally (8.2.2.2 s)
Definition at line 333 of file authenticator.h.
◆ quietPeriod
| uint_t quietPeriod |
Initialization value used for the quietWhile timer (8.2.4.1.2 a)
Definition at line 342 of file authenticator.h.
◆ quietWhile
| uint_t quietWhile |
Timer used by the authenticator PAE state machine (8.2.2.1 d)
Definition at line 314 of file authenticator.h.
◆ reAuthCount
| uint_t reAuthCount |
Number of times the CONNECTING state is re-entered (8.2.4.1.1 f)
Definition at line 340 of file authenticator.h.
◆ reAuthEnabled
| bool_t reAuthEnabled |
Enable or disable reauthentication (8.2.8.1 b)
Definition at line 348 of file authenticator.h.
◆ reAuthenticate
| bool_t reAuthenticate |
The reAuthWhen timer has expired (8.2.2.2 t)
Definition at line 334 of file authenticator.h.
◆ reAuthMax
| uint_t reAuthMax |
Maximum number of reauthentication attempts (8.2.4.1.2 b)
Definition at line 343 of file authenticator.h.
◆ reAuthPeriod
| uint_t reAuthPeriod |
Number of seconds between periodic reauthentication (8.2.8.1 a)
Definition at line 347 of file authenticator.h.
◆ reauthTimerState
| AuthenticatorReauthTimerState reauthTimerState |
Reauthentication timer state.
Definition at line 311 of file authenticator.h.
◆ reAuthWhen
| uint_t reAuthWhen |
Timer used to determine when reauthentication takes place (8.2.2.1 e)
Definition at line 315 of file authenticator.h.
◆ reqAuthenticator
| uint8_t reqAuthenticator[16] |
Request Authenticator field.
Definition at line 405 of file authenticator.h.
◆ respId
| uint_t respId |
Identifier from the current EAP response (5.3.2)
Definition at line 376 of file authenticator.h.
◆ respMethod
| EapMethodType respMethod |
Method type of the current EAP response (5.3.2)
Definition at line 377 of file authenticator.h.
◆ retransCount
| uint_t retransCount |
Current number of retransmissions (5.3.1)
Definition at line 370 of file authenticator.h.
◆ retransWhile
| uint_t retransWhile |
Timer (5.1.1)
Definition at line 360 of file authenticator.h.
◆ rxResp
| bool_t rxResp |
The current received packet is an EAP response (5.3.2)
Definition at line 375 of file authenticator.h.
◆ serverState
| uint8_t serverState[AUTHENTICATOR_MAX_STATE_SIZE] |
State attribute received from the server.
Definition at line 406 of file authenticator.h.
◆ serverStateLen
| size_t serverStateLen |
Length of the state attribute, in byte.
Definition at line 407 of file authenticator.h.
◆ serverTimeout
| uint_t serverTimeout |
Initialization value used for the aWhile timer (8.2.9.1.2 a)
Definition at line 354 of file authenticator.h.
◆ sessionStats
| AuthenticatorSessionStats sessionStats |
Session statistics information.
Definition at line 414 of file authenticator.h.
◆ stats
| AuthenticatorStats stats |
Statistics information.
Definition at line 413 of file authenticator.h.
◆ supplicantMacAddr
| MacAddr supplicantMacAddr |
Supplicant's MAC address.
Definition at line 408 of file authenticator.h.
The documentation for this struct was generated from the following file:
- cyclone_eap/authenticator/authenticator.h