 |
TrustCore SDK NanoSec API reference
version 7.0
|
|
TrustCore SDK NanoSec API reference
version 7.0
|
Customizable EAP callbacks. More...
Variables | |
| MSTATUS(* | eapMethodDef_t::funcPtr_llTransmitPacket )(ubyte *app_session_handle, eapHdr_t *eap_hdr, ubyte *eap_data, ubyte4 eap_data_len) |
| Transmit (send) an EAP packet out through the lower (physical) layer. More... | |
| MSTATUS(* | eapMethodDef_t::funcPtr_ulGetDecision )(ubyte *app_session_handle, ubyte4 *decision) |
| Enable customized accounting. More... | |
| MSTATUS(* | eapMethodDef_t::funcPtr_ulGetMethodstate )(ubyte *app_session_handle, ubyte4 *methodState) |
| Enable customized accounting. More... | |
| MSTATUS(* | eapMethodDef_t::funcPtr_ulMICVerify )(ubyte *app_session_handle, ubyte *pkt, ubyte4 pkt_len) |
| Verify a packet's MIC (message integrity code). More... | |
| MSTATUS(* | eapMethodDef_t::funcPtr_ulReceiveCallback )(ubyte *app_session_handle, eapMethodType type, eapCode code, ubyte id, ubyte *eap_data, ubyte4 eap_data_len, ubyte *opaque_data) |
| Process received EAP messages. More... | |
| MSTATUS(* | eapMethodDef_t::funcPtr_ulReceiveIndication )(ubyte *app_session_handle, eapIndication ind_type, ubyte *data, ubyte4 data_len) |
| Notify the upper layer that an error has occurred or that reauthorization is needed. More... | |
| MSTATUS(* | eapMethodDef_t::funcPtr_ulReceivePassthruCallback )(ubyte *app_session_handle, eapMethodType type, eapCode code, ubyte id, ubyte *eap_data, ubyte4 eap_data_len, ubyte *opaque_data) |
| Receive EAP packets in passthrough mode. More... | |
| MSTATUS(* | eapSimConfig::getAKARes )(void *appCb, void *eapSim, ubyte *rand, ubyte *autn, ubyte *ik, ubyte *ck, ubyte *Res, ubyte2 *resLen, ubyte *auts) |
| Get AKA IK and CK values from the application. More... | |
| MSTATUS(* | eapSimConfig::getSresKc )(void *appCb, void *eapSim, ubyte *rand, ubyte numRand, ubyte *Sres, ubyte *Kc) |
| Get SRES and KC values from application. More... | |
| MSTATUS(* | EAP_PEAP_params::ul2ndStageReceive )(ubyte *appSessionCB, eapMethodType type, eapCode code, ubyte id, ubyte *eap_data, ubyte4 eap_data_len, ubyte *opaque_data) |
| Process received EAP messages. More... | |
| MSTATUS(* | EAP_TTLS_params::ul2ndStageReceive )(ubyte *app_session_handle, eapMethodType type, eapCode code, ubyte id, ubyte *eap_data, ubyte4 eap_data_len, ubyte *opaque_data) |
| Process received EAP messages. More... | |
| MSTATUS(* | EAP_FAST_params::ul2ndStageReceive )(ubyte *appSessionCB, eapMethodType type, eapCode code, ubyte id, ubyte *eap_data, ubyte4 eap_data_len, ubyte *opaque_data) |
| Process received EAP messages. More... | |
| MSTATUS(* | EAP_PEAP_params::ulAuthResultTransmit )(ubyte *appSessionCB, eapAuthStatus authStatus) |
| Send the inner method authentication status. More... | |
| MSTATUS(* | EAP_TTLS_params::ulAuthResultTransmit )(ubyte *appSessionCB, eapAuthStatus authStatus) |
| Send the inner method authentication status. More... | |
| MSTATUS(* | EAP_FAST_params::ulAuthResultTransmit )(ubyte *appSessionCB, ubyte cryptoBindingVerified, eapAuthStatus authStatus) |
| Send the inner method authentication status. More... | |
| MSTATUS(* | EAP_TTLS_params::ulAuthTransmit )(ubyte *appSessionCB, ubyte *eapTTLSCb, ubyte *pkt, ubyte4 pktLen) |
| Send a fully formed RADIUS packet for authentication. More... | |
| MSTATUS(* | EAP_FAST_params::ulGetFastCompoundKey )(ubyte *appSessionCB, ubyte *cmk) |
| Get compound session key (CMK). More... | |
| MSTATUS(* | EAP_FAST_params::ulGetPeapV2CompoundKey )(ubyte *appSessionCB, ubyte *cmk, ubyte *s_nonce, ubyte *c_nonce) |
| Get compound session key. More... | |
| MSTATUS(* | EAP_FAST_params::ulTLSclose )(ubyte *appSessionCB) |
| Close the TLS tunnel. More... | |
| MSTATUS(* | EAP_PEAP_params::ulTransmit )(ubyte *appSessionCB, ubyte *eapPkt, ubyte4 eapPktLen, intBoolean encrypted) |
| Send a plain text inner method payload to the application (for further encryption and transmittal). More... | |
| MSTATUS(* | EAP_TTLS_params::ulTransmit )(ubyte *appSessionCB, ubyte *eapPkt, ubyte4 eapPktLen, intBoolean encrypted) |
| Send a plain text inner method payload to the application (for further encryption and transmittal). More... | |
| MSTATUS(* | EAP_FAST_params::ulTransmit )(ubyte *appSessionCB, ubyte *eapPkt, ubyte4 eapPktLen, intBoolean encrypted) |
| Send a plain text inner method payload to the application (for further encryption and transmittal). More... | |
| MSTATUS(* eapMethodDef_t::funcPtr_llTransmitPacket) (ubyte *app_session_handle, eapHdr_t *eap_hdr, ubyte *eap_data, ubyte4 eap_data_len) |
This callback function is provided to transmit (send) an EAP packet out through the lower (physical) layer.
Callback registration happens at session creation and initialization by assigning your custom callback function (which can have any name) to the session's callback pointer in the eapMethodDef structure.
To enable this callback, at least one of the following flags must be defined in moptions.h:
__ENABLE_MOCANA_EAP_PEER__ __ENABLE_MOCANA_EAP_AUTH__ | app_session_handle | Cookie given by the application to identify the session. |
| eap_hdr | Pointer to EAP header. |
| eap_data | Pointer to EAP payload. |
| eap_data_len | Number of bytes in eap_data. |
OK (0) if successful; otherwise a negative number error code definition from merrors.h. To retrieve a string containing an English text error identifier corresponding to the function's returned error status, use the DISPLAY_ERROR macro.| MSTATUS(* eapMethodDef_t::funcPtr_ulGetDecision) (ubyte *app_session_handle, ubyte4 *decision) |
This callback function is provided to enable customized accounting.
Callback registration happens at session creation and initialization by assigning your custom callback function (which can have any name) to the session's callback pointer in the eapMethodDef structure.
To enable this callback, at least one of the following flags must be defined in moptions.h:
__ENABLE_MOCANA_EAP_PEER__ __ENABLE_MOCANA_EAP_AUTH__ | app_session_handle | Cookie given by the application to identify the session. |
| decision | Pointer to current decision value. |
OK (0) if successful; otherwise a negative number error code definition from merrors.h. To retrieve a string containing an English text error identifier corresponding to the function's returned error status, use the DISPLAY_ERROR macro.| MSTATUS(* eapMethodDef_t::funcPtr_ulGetMethodstate) (ubyte *app_session_handle, ubyte4 *methodState) |
This callback function is provided to enable customized accounting.
Callback registration happens at session creation and initialization by assigning your custom callback function (which can have any name) to the session's callback pointer in the eapMethodDef structure.
To enable this callback, at least one of the following flags must be defined in moptions.h:
__ENABLE_MOCANA_EAP_PEER__ __ENABLE_MOCANA_EAP_AUTH__ | app_session_handle | Cookie given by the application to identify the session. |
| methodState | Pointer to current state machine value. |
OK (0) if successful; otherwise a negative number error code definition from merrors.h. To retrieve a string containing an English text error identifier corresponding to the function's returned error status, use the DISPLAY_ERROR macro.| MSTATUS(* eapMethodDef_t::funcPtr_ulMICVerify) (ubyte *app_session_handle, ubyte *pkt, ubyte4 pkt_len) |
This callback function is provided to verify a packet's MIC (message integrity code).
Callback registration happens at session creation and initialization by assigning your custom callback function (which can have any name) to the session's callback pointer in the eapMethodDef structure.
To enable this callback, at least one of the following flags must be defined in moptions.h:
__ENABLE_MOCANA_EAP_PEER__ __ENABLE_MOCANA_EAP_AUTH__ | app_session_handle | Cookie given by the application to identify the session. |
| pkt | Pointer to packet. |
| pkt_len | Number of bytes in pkt. |
OK (0) if successful; otherwise a negative number error code definition from merrors.h. To retrieve a string containing an English text error identifier corresponding to the function's returned error status, use the DISPLAY_ERROR macro.| MSTATUS(* eapMethodDef_t::funcPtr_ulReceiveCallback) (ubyte *app_session_handle, eapMethodType type, eapCode code, ubyte id, ubyte *eap_data, ubyte4 eap_data_len, ubyte *opaque_data) |
This callback function is provided to process received EAP messages.
Callback registration happens at session creation and initialization by assigning your custom callback function (which can have any name) to the session's callback pointer in the eapMethodDef structure.
To enable this callback, at least one of the following flags must be defined in moptions.h:
__ENABLE_MOCANA_EAP_PEER__ __ENABLE_MOCANA_EAP_AUTH__ | app_session_handle | Cookie given by the application to identify the session. |
| type | Any of the eapMethodType enumerated values (see eap_proto.h). |
| code | Any of the eapCode enumerated values (see eap_proto.h). |
| id | EAP packet id. |
| eap_data | Pointer to EAP payload. |
| eap_data_len | Length of EAP payload. |
| opaque_data | Pointer to any opaque data — extra data that's passed from the lower layer to the upper (method) layer through the EAP stack. |
OK (0) if successful; otherwise a negative number error code definition from merrors.h. To retrieve a string containing an English text error identifier corresponding to the function's returned error status, use the DISPLAY_ERROR macro.| MSTATUS(* eapMethodDef_t::funcPtr_ulReceiveIndication) (ubyte *app_session_handle, eapIndication ind_type, ubyte *data, ubyte4 data_len) |
This callback function is provided to notify the upper layer that one of the following errors occurred:
TIMEOUT — No data received by NanoEAP within the time configured at EAP session creationERROR — Error number (as defined in merrors.h)REAUTH — Packet received for reauthorizationYour application must interpret the data returned through the data parameter based on the indication type.
Callback registration happens at session creation and initialization by assigning your custom callback function (which can have any name) to the session's callback pointer in the eapMethodDef structure.
To enable this callback, at least one of the following flags must be defined in moptions.h:
__ENABLE_MOCANA_EAP_PEER__ __ENABLE_MOCANA_EAP_AUTH__ | app_session_handle | Cookie given by the application to identify the session. |
| ind_type | Any of the eapIndication enumerated values (see eap_proto.h). |
| data | Data specific to the indication type. |
| data_len | Number of bytes in data. |
OK (0) if successful; otherwise a negative number error code definition from merrors.h. To retrieve a string containing an English text error identifier corresponding to the function's returned error status, use the DISPLAY_ERROR macro.| MSTATUS(* eapMethodDef_t::funcPtr_ulReceivePassthruCallback) (ubyte *app_session_handle, eapMethodType type, eapCode code, ubyte id, ubyte *eap_data, ubyte4 eap_data_len, ubyte *opaque_data) |
This callback function is provided to receive EAP packets from the EAP layer in passthrough mode. The complete packet, including the EAP header, is passed to this function.
Callback registration happens at session creation and initialization by assigning your custom callback function (which can have any name) to the session's callback pointer in the eapMethodDef structure.
To enable this callback, at least one of the following flags must be defined in moptions.h:
__ENABLE_MOCANA_EAP_PEER__ __ENABLE_MOCANA_EAP_AUTH__ | app_session_handle | Cookie given by the application to identify the session. |
| type | Any of the eapMethodType enumerated values (see eap_proto.h). |
| code | Any of the eapCode enumerated values (see eap_proto.h). |
| id | EAP packet ID. |
| eap_data | Pointer to EAP payload. |
| eap_data_len | Number of bytes in eap_data. |
| opaque_data | Pointer to any opaque data to be passed from lower layer. |
OK (0) if successful; otherwise a negative number error code definition from merrors.h. To retrieve a string containing an English text error identifier corresponding to the function's returned error status, use the DISPLAY_ERROR macro.| MSTATUS(* eapSimConfig::getAKARes) (void *appCb, void *eapSim, ubyte *rand, ubyte *autn, ubyte *ik, ubyte *ck, ubyte *Res, ubyte2 *resLen, ubyte *auts) |
This function gets AKA IK and CK values from the application.
To enable this callback function, the following flags must be defined in moptions.h:
__ENABLE_MOCANA_EAP_SIM__ __ENABLE_MOCANA_EAP_PEER__ | appCb | Application Handle. |
| eapSim | EAP-SIM Handle. |
| rand | 128 bit random number. |
| autn | 128bit AUTN Value. |
| ik | output IK value. |
| ck | output CK value. |
| Res | 32 to 128 RES value. |
| resLen | Length of Res. |
| auts | 112 bits AUTS value. |
OK (0) if successful; otherwise a negative number error code definition from merrors.h. To retrieve a string containing an English text error identifier corresponding to the function's returned error status, use the DISPLAY_ERROR macro.| MSTATUS(* eapSimConfig::getSresKc) (void *appCb, void *eapSim, ubyte *rand, ubyte numRand, ubyte *Sres, ubyte *Kc) |
This function gets SRES and KC values from application.
To enable this callback function, the following flags must be defined in moptions.h:
__ENABLE_MOCANA_EAP_SIM__ __ENABLE_MOCANA_EAP_PEER__ | appCb | Application Handle. |
| eapSim | EAP-SIM Handle. |
| rand | Array of Random Value. |
| numRand | Number of elements in rand. |
| Sres | SRES value returned by the application. |
| Kc | KC value returned by the application. |
OK (0) if successful; otherwise a negative number error code definition from merrors.h. To retrieve a string containing an English text error identifier corresponding to the function's returned error status, use the DISPLAY_ERROR macro.| MSTATUS(* EAP_PEAP_params::ul2ndStageReceive) (ubyte *appSessionCB, eapMethodType type, eapCode code, ubyte id, ubyte *eap_data, ubyte4 eap_data_len, ubyte *opaque_data) |
This callback function is provided to process received EAP messages. It is called by the inner EAP message processing if the inner TTLS method is EAP in order to provide application-specific data. Once the application is done processing the inner EAP method, the application should call EAP_TTLSulPeerTransmit to send the payload using the inner EAP session.
There are no flag dependencies to enable this callback.
| appSessionCB | Cookie given by the application to identify the session. |
| type | Any of the eapMethodType enumerated values (see eap_proto.h). |
| code | Any of the eapCode enumerated values (see eap_proto.h). |
| id | EAP packet id. |
| eap_data | Pointer to EAP payload. |
| eap_data_len | Length of EAP payload. |
| opaque_data | Pointer to any opaque data — extra data that's passed from the lower layer to the upper (method) layer through the EAP stack. |
OK (0) if successful; otherwise a negative number error code definition from merrors.h. To retrieve a string containing an English text error identifier corresponding to the function's returned error status, use the DISPLAY_ERROR macro.| MSTATUS(* EAP_TTLS_params::ul2ndStageReceive) (ubyte *app_session_handle, eapMethodType type, eapCode code, ubyte id, ubyte *eap_data, ubyte4 eap_data_len, ubyte *opaque_data) |
This callback function is provided to process received EAP messages. It is called by the inner EAP message processing if the inner TTLS method is EAP in order to provide application-specific data. Once the application is done processing the inner EAP method, the application should call EAP_TTLSulPeerTransmit to send the payload using the inner EAP session.
There are no flag dependencies to enable this callback.
| app_session_handle | Cookie given by the application to identify the session. |
| type | Any of the eapMethodType enumerated values (see eap_proto.h). |
| code | Any of the eapCode enumerated values (see eap_proto.h). |
| id | EAP packet id. |
| eap_data | Pointer to EAP payload. |
| eap_data_len | Length of EAP payload. |
| opaque_data | Pointer to any opaque data — extra data that's passed from the lower layer to the upper (method) layer through the EAP stack. |
OK (0) if successful; otherwise a negative number error code definition from merrors.h. To retrieve a string containing an English text error identifier corresponding to the function's returned error status, use the DISPLAY_ERROR macro.| MSTATUS(* EAP_FAST_params::ul2ndStageReceive) (ubyte *appSessionCB, eapMethodType type, eapCode code, ubyte id, ubyte *eap_data, ubyte4 eap_data_len, ubyte *opaque_data) |
This callback function is provided to process received EAP messages. It is called by the inner EAP message processing if the inner TTLS method is EAP in order to provide application-specific data. Once the application is done processing the inner EAP method, the application should call EAP_TTLSulPeerTransmit to send the payload using the inner EAP session.
There are no flag dependencies to enable this callback.
| appSessionCB | Cookie given by the application to identify the session. |
| type | Any of the eapMethodType enumerated values (see eap_proto.h). |
| code | Any of the eapCode enumerated values (see eap_proto.h). |
| id | EAP packet id. |
| eap_data | Pointer to EAP payload. |
| eap_data_len | Length of EAP payload. |
| opaque_data | Pointer to any opaque data — extra data that's passed from the lower layer to the upper (method) layer through the EAP stack. |
OK (0) if successful; otherwise a negative number error code definition from merrors.h. To retrieve a string containing an English text error identifier corresponding to the function's returned error status, use the DISPLAY_ERROR macro.| MSTATUS(* EAP_PEAP_params::ulAuthResultTransmit) (ubyte *appSessionCB, eapAuthStatus authStatus) |
This callback function is used to send the inner (second stage) method authenticatation status to the application, which in turn sets the outer (first stage) EAP session status.
For example, if the inner method receives an EAP_AUTH_SUCCESS or EAP_AUTH_FAILURE (which are eapAuthStatus enumerations defined in eap_proto.h), the application must be informed of the authentication status. Once informed, the application can set the state machine (methodState) and decision (decision) values.
There are no flag dependencies to enable this callback.
| appSessionCB | Application-specific session identifier. |
| authStatus | Any of the eapAuthStatus enumerated values (defined in eap_proto.h). |
OK (0) if successful; otherwise a negative number error code definition from merrors.h. To retrieve a string containing an English text error identifier corresponding to the function's returned error status, use the DISPLAY_ERROR macro.| MSTATUS(* EAP_TTLS_params::ulAuthResultTransmit) (ubyte *appSessionCB, eapAuthStatus authStatus) |
This callback function is used to send the inner (second stage) method authenticatation status to the application, which in turn sets the outer (first stage) EAP session status.
For example, if the inner method receives an EAP_AUTH_SUCCESS or EAP_AUTH_FAILURE (which are eapAuthStatus enumerations defined in eap_proto.h), the application must be informed of the authentication status. Once informed, the application can set the state machine (methodState) and decision (decision) values.
There are no flag dependencies to enable this callback.
| appSessionCB | Application-specific session identifier. |
| authStatus | Any of the eapAuthStatus enumerated values (defined in eap_proto.h). |
OK (0) if successful; otherwise a negative number error code definition from merrors.h. To retrieve a string containing an English text error identifier corresponding to the function's returned error status, use the DISPLAY_ERROR macro.| MSTATUS(* EAP_FAST_params::ulAuthResultTransmit) (ubyte *appSessionCB, ubyte cryptoBindingVerified, eapAuthStatus authStatus) |
This callback function is used to send the inner (second stage) method authenticatation status to the application, which in turn sets the outer (first stage) EAP session status.
For example, if the inner method receives an EAP_AUTH_SUCCESS or EAP_AUTH_FAILURE (which are eapAuthStatus enumerations defined in eap_proto.h), the application must be informed of the authentication status. Once informed, the application can set the state machine (methodState) and decision (decision) values.
There are no flag dependencies to enable this callback.
| appSessionCB | Application-specific session identifier. |
| cryptoBindingVerified | Status of crypto binding attempt. TRUE == success. FALSE == failure. |
| authStatus | Any of the eapAuthStatus enumerated values (defined in eap_proto.h). |
OK (0) if successful; otherwise a negative number error code definition from merrors.h. To retrieve a string containing an English text error identifier corresponding to the function's returned error status, use the DISPLAY_ERROR macro.| MSTATUS(* EAP_TTLS_params::ulAuthTransmit) (ubyte *appSessionCB, ubyte *eapTTLSCb, ubyte *pkt, ubyte4 pktLen) |
This callback function is used by the EAP TTLS authenticator to send a fully formed RADIUS packet for authentication.
When the RADIUS server returns the response, your application should call EAP_TTLSProcessRadiusAuthResponse to process the response.
There are no flag dependencies to enable this callback.
| appSessionCB | Application-specific session identifier. |
| eapTTLSCb | EAP-TTLS session handle returned from EAP_TTLSinitSession. |
| pkt | Pointer to packet to send for authentication. |
| pktLen | Number of bytes in packet to send (pkt). |
OK (0) if successful; otherwise a negative number error code definition from merrors.h. To retrieve a string containing an English text error identifier corresponding to the function's returned error status, use the DISPLAY_ERROR macro.| MSTATUS(* EAP_FAST_params::ulGetFastCompoundKey) (ubyte *appSessionCB, ubyte *cmk) |
This callback is used by the EAP-FAST method implementation to get the compound session key(CMK) from the application. The CMK is used to calculate the Compound MAC as part of the Crypto-Binding TLV, which helps provide assurance that the same entities are involved in all communications in EAP-FAST.
There are no flag dependencies to enable this callback.
| appSessionCB | Cookie given by the application to identify the session. |
| cmk | Pointer to compund session key. |
OK (0) if successful; otherwise a negative number error code definition from merrors.h. To retrieve a string containing an English text error identifier corresponding to the function's returned error status, use the DISPLAY_ERROR macro.| MSTATUS(* EAP_FAST_params::ulGetPeapV2CompoundKey) (ubyte *appSessionCB, ubyte *cmk, ubyte *s_nonce, ubyte *c_nonce) |
This callback is similar to ulGetFastCompoundKey, but it is needed if the method type is EAP-PEAP instead of EAP-FAST. This call back takes 2 additional parameters viz. s_nonce which is server nonce and c_nonce which is client nonce. these nonce values are used in calculation of CMK.
There are no flag dependencies to enable this callback.
| appSessionCB | Cookie given by the application to identify the session. |
| cmk | Pointer to compund session key. |
| s_nonce | Server nonce used to calculate CMK. |
| c_nonce | Client nonce used to calculate CMK. |
OK (0) if successful; otherwise a negative number error code definition from merrors.h. To retrieve a string containing an English text error identifier corresponding to the function's returned error status, use the DISPLAY_ERROR macro.| MSTATUS(* EAP_FAST_params::ulTLSclose) (ubyte *appSessionCB) |
This callback takes an application handle and closes the TLS tunnel. This is applicable if the session type is EAP_SESSION_TYPE_AUTHENTICATOR.
There are no flag dependencies to enable this callback.
| appSessionCB | Application-specific session identifier. |
OK (0) if successful; otherwise a negative number error code definition from merrors.h. To retrieve a string containing an English text error identifier corresponding to the function's returned error status, use the DISPLAY_ERROR macro.| MSTATUS(* EAP_PEAP_params::ulTransmit) (ubyte *appSessionCB, ubyte *eapPkt, ubyte4 eapPktLen, intBoolean encrypted) |
This callback function sends a plain text inner method payload to the application (which will then further encrypt the message and send out the payload).
If the encrypted parameter value is TRUE, which occurs when the inner method is sending an ACK or handling fragmented packets, the application does not need to encrypt the payload.
However, if the encrypted parameter value is FALSE, indicating that the payload is not yet encrypted, this callback should encrypt the payload (TTLS Attribute Value Pairs, such as EAP or UserName/Password) using the lower layer TLS connection and then send the packet using the outer EAP ulTransmit.
There are no flag dependencies to enable this callback.
| appSessionCB | Application-specific session identifier. |
| eapPkt | Pointer to plain text inner method payload to send. |
| eapPktLen | Number of bytes in payload to send (eapPkt). |
| encrypted | TRUE if the payload to send is encrypted; FALSE otherwise. |
OK (0) if successful; otherwise a negative number error code definition from merrors.h. To retrieve a string containing an English text error identifier corresponding to the function's returned error status, use the DISPLAY_ERROR macro.| MSTATUS(* EAP_TTLS_params::ulTransmit) (ubyte *appSessionCB, ubyte *eapPkt, ubyte4 eapPktLen, intBoolean encrypted) |
This callback function sends a plain text inner method payload to the application (which will then further encrypt the message and send out the payload).
If the encrypted parameter value is TRUE, which occurs when the inner method is sending an ACK or handling fragmented packets, the application does not need to encrypt the payload.
However, if the encrypted parameter value is FALSE, indicating that the payload is not yet encrypted, this callback should encrypt the payload (TTLS Attribute Value Pairs, such as EAP or UserName/Password) using the lower layer TLS connection and then send the packet using the outer EAP ulTransmit.
There are no flag dependencies to enable this callback.
| appSessionCB | Application-specific session identifier. |
| eapPkt | Pointer to plain text inner method payload to send. |
| eapPktLen | Number of bytes in payload to send (eapPkt). |
| encrypted | TRUE if the payload to send is encrypted; FALSE otherwise. |
OK (0) if successful; otherwise a negative number error code definition from merrors.h. To retrieve a string containing an English text error identifier corresponding to the function's returned error status, use the DISPLAY_ERROR macro.| MSTATUS(* EAP_FAST_params::ulTransmit) (ubyte *appSessionCB, ubyte *eapPkt, ubyte4 eapPktLen, intBoolean encrypted) |
This callback function sends a plain text inner method payload to the application (which will then further encrypt the message and send out the payload).
If the encrypted parameter value is TRUE, which occurs when the inner method is sending an ACK or handling fragmented packets, the application does not need to encrypt the payload.
However, if the encrypted parameter value is FALSE, indicating that the payload is not yet encrypted, this callback should encrypt the payload (TTLS Attribute Value Pairs, such as EAP or UserName/Password) using the lower layer TLS connection and then send the packet using the outer EAP ulTransmit.
There are no flag dependencies to enable this callback.
| appSessionCB | Application-specific session identifier. |
| eapPkt | Pointer to plain text inner method payload to send. |
| eapPktLen | Number of bytes in payload to send (eapPkt). |
| encrypted | TRUE if the payload to send is encrypted; FALSE otherwise. |
OK (0) if successful; otherwise a negative number error code definition from merrors.h. To retrieve a string containing an English text error identifier corresponding to the function's returned error status, use the DISPLAY_ERROR macro.