TrustCore SDK NanoSec API reference  version 7.0
eap.h File Reference

EAP developer API. More...

Go to the source code of this file.

Data Structures

struct  eapMethodDef_t
 Configuration settings and callback function pointers for EAP methods. More...
 

Functions

MOC_EXTERN MSTATUS EAP_buildExpandedNAK (ubyte *eapSessionHdl, ubyte4 instanceId, eapExpandedMethod_t *expMethods, ubyte expMethodCount, ubyte **eapResponse, ubyte4 *eapRespLen)
 Builds a NAK response to send to the authenticator. More...
 
MOC_EXTERN MSTATUS EAP_buildExpandedResponse (ubyte *eapSessionHdl, ubyte4 instanceId, ubyte4 expVendorId, ubyte4 expMethodId, ubyte *eapPayload, ubyte4 eapPayloadLen, ubyte **eapResponse, ubyte4 *eapRespLen)
 Builds an expanded payload response. More...
 
MOC_EXTERN MSTATUS EAP_buildNAK (ubyte *eapSessionHdl, ubyte4 instanceId, ubyte *nakMethods, ubyte4 nakMethodCount, ubyte **eapResponse, ubyte4 *eapRespLen)
 Builds a NAK response to send to the authenticator. More...
 
MOC_EXTERN MSTATUS EAP_checkTimers (ubyte4 instanceId)
 Call expired timers' callbacks. More...
 
MOC_EXTERN MSTATUS EAP_deleteInstance (ubyte4 instanceId)
 Delete an EAP instance. More...
 
MOC_EXTERN MSTATUS EAP_generateIdReq (ubyte id, ubyte **req, ubyte4 *reqLen)
 Builds an EAP request. More...
 
MOC_EXTERN MSTATUS EAP_getAuthenticationStatus (ubyte *eapSessionHdl, ubyte4 instanceId, eapAuthStatus *authStatus)
 Get an EAP session's current authentication status. More...
 
MOC_EXTERN MSTATUS EAP_getIdentity (ubyte *eapSessionHdl, ubyte4 instanceId, ubyte **identity, ubyte4 *len)
 Get EAP session's identity string. More...
 
MOC_EXTERN MSTATUS EAP_getInstanceStats (ubyte4 instanceId, eapGlobalStats_t *stats)
 Get an EAP instance's statistics. More...
 
MOC_EXTERN MSTATUS EAP_getKey (ubyte *eapSessionHdl, ubyte4 instanceId, ubyte **key, ubyte *keylen)
 Get an EAP session's authentication key. More...
 
MOC_EXTERN MSTATUS EAP_getMtu (ubyte *eapSessionHdl, ubyte4 instanceId, ubyte4 *mtu)
 Get the MTU (maximum transmission unit) value. More...
 
MOC_EXTERN MSTATUS EAP_getSessionStats (ubyte *eapSessionHdl, ubyte4 instanceId, eapSessionStats_t *eapStats)
 Get an EAP session's statistics. More...
 
MOC_EXTERN MSTATUS EAP_getSessionStatus (ubyte *eapSessionHdl, ubyte4 instanceId, struct eapSessionStatus_s *eapStatus)
 Get an EAP session's status. More...
 
MOC_EXTERN MSTATUS EAP_init (void)
 Initialize EAP structures, data, and stack. More...
 
MOC_EXTERN MSTATUS EAP_initInstance (ubyte4 *instanceId)
 Create and initialize an EAP instance and get its ID. More...
 
MOC_EXTERN MSTATUS EAP_llReceiveIndication (ubyte *eapSessionHdl, ubyte4 instanceId, eapAltIndication altIndication)
 Change EAP state machine's EAP_SUCCESS or EAP_FAILURE state. More...
 
MOC_EXTERN MSTATUS EAP_llReceivePacket (ubyte *eapSessionHdl, ubyte4 instanceId, ubyte *eap_pkt, ubyte4 eap_pkt_len, ubyte *opaque_data)
 Pass a received packet from the lower layer to the upper for processing. More...
 
MOC_EXTERN MSTATUS EAP_resetInstanceStats (ubyte4 instanceId)
 Reset an EAP instance's global statistics. More...
 
MOC_EXTERN MSTATUS EAP_resetSessionStats (ubyte *eapSessionHdl, ubyte4 instanceId)
 Reset an EAP session's statistics. More...
 
MOC_EXTERN MSTATUS EAP_sessionCreate (ubyte *appSessionHandle, ubyte4 instanceId, eapMethodDef_t methodDef, eapSessionConfig_t cfgParam, ubyte **eapSessionHdl)
 Create an EAP Session. More...
 
MOC_EXTERN MSTATUS EAP_sessionDelete (ubyte *eapSessionHdl, ubyte4 instanceId)
 Delete an EAP session. More...
 
MOC_EXTERN MSTATUS EAP_sessionDisable (ubyte *eapSessionHdl, ubyte4 instanceId)
 Disable an EAP session. More...
 
MOC_EXTERN MSTATUS EAP_sessionEnable (ubyte *eapSessionHdl, ubyte4 instanceId)
 Enable an EAP session. More...
 
MOC_EXTERN MSTATUS EAP_sessionModify (ubyte *eapSessionHdl, ubyte4 instanceId, eapMethodDef_t methodDef, eapSessionConfig_t cfgParam, ubyte4 modifiedFlag)
 Modify an EAP Session. More...
 
MOC_EXTERN MSTATUS EAP_sessionRestart (ubyte *eapSessionHdl, ubyte4 instanceId)
 Restart an EAP session. More...
 
MOC_EXTERN MSTATUS EAP_setId_Type (ubyte *eapSessionHdl, ubyte4 instanceId, ubyte id, ubyte type)
 Set identifier and type to the last sent identifier and the EAP packet type. More...
 
MOC_EXTERN MSTATUS EAP_setIdentity (ubyte *eapSessionHdl, ubyte4 instanceId, ubyte *identity, ubyte4 len)
 Set an EAP session's identity string. More...
 
MOC_EXTERN MSTATUS EAP_setKey (ubyte *eapSessionHdl, ubyte4 instanceId, ubyte *key, ubyte4 keylen)
 Set an EAP session's authentication key. More...
 
MOC_EXTERN MSTATUS EAP_setMethodStateDecision (ubyte *eapSessionHdl, ubyte4 instanceId, ubyte methodState, ubyte methodDecision)
 Assign (place on the EAP stack) the EAP processing state machine (methodState) and decision (methodDecision) values. More...
 
MOC_EXTERN MSTATUS EAP_shutdown (void)
 Clean up memory and mutexes and shut down the EAP stack. More...
 
MOC_EXTERN MSTATUS EAP_ulStartReauth (ubyte *eapSessionHdl, ubyte4 instanceId)
 Start reauthorization and timer rescheduling. More...
 
MOC_EXTERN MSTATUS EAP_ulTransmit (ubyte *eapSessionHdl, ubyte4 instanceId, eapMethodType method_type, eapCode code, eapMethodDecision methodDecision, eapMethodState methodState, ubyte *eap_data, ubyte4 eap_data_len)
 Pass a packet from the upper (method) layer to the EAP stack. More...
 

Detailed Description

This header file contains definitions, enumerations, structures, and function declarations used by EAP API functions.

Since
1.41
Version
2.02 and later

To build products using this header file, at least one of the following flags must be defined in moptions.h:

  • __ENABLE_MOCANA_EAP_PEER__
  • __ENABLE_MOCANA_EAP_AUTH__

eap.h