eap.h

Go to the documentation of this file.

/*
 * eap.h
 *
 * EAP Developer API
 *
 * Copyright 2019-2024 DigiCert, Inc. All Rights Reserved.
 * Proprietary and Confidential Material.
 *
 */

/*------------------------------------------------------------------*/

#ifndef __EAP_HEADER__
#define __EAP_HEADER__

#ifdef __cplusplus
extern "C" {
#endif
/* check for possible build configuration errors */

#if defined(MOC_LITTLE_ENDIAN)
#define EAP_NTOHS(A) SWAPWORD(A)
#define EAP_HTONS(A) SWAPWORD(A)
#define EAP_NTOHL(A) SWAPDWORD(A)
#define EAP_HTONL(A) SWAPDWORD(A)
#elif defined(MOC_BIG_ENDIAN)
#define EAP_NTOHS(A) (A)
#define EAP_HTONS(A) (A)
#define EAP_NTOHL(A) (A)
#define EAP_HTONL(A) (A)
#elif defined(__ENABLE_MOCANA_EAP_PEER__) || defined(__ENABLE_MOCANA_EAP_AUTH__) || defined(__ENABLE_MOCANA_EAPOL__)
#error Must define either MOC_LITTLE_ENDIAN or MOC_BIG_ENDIAN in moptions.h
#endif

#if defined(__ENABLE_MOCANA_EAP_PEER__) || defined(__ENABLE_MOCANA_EAP_AUTH__)

/* timeouts in seconds */
#define TIMEOUT_EAP_CLIENT                (30)
#define TIMEOUT_EAP_RETRANSMIT            (10)

/* for reference */
#define EAP_DEFAULT_MTU                 (1020)
#define EAP_DEFAULT_RETRY_TIMER         (5)

/* sizes */
#define EAP_SHA_FINGER_PRINT_SIZE       (20)
#define EAP_MD5_FINGER_PRINT_SIZE       (16)
#define EAP_BUFFER_SIZE                 (1020)
#define EAP_HEADER_SIZE                 (8)
#define EAP_MAX_IDENTITY_SIZE           (128)
#define EAP_MAX_KEY_SIZE                (256)
#define EAP_MAX_METHOD_NAME             (64)
#define EAP_MAX_ROUNDS                  (50)
#define EAP_MAX_METHODS                 (25)
#define EAP_MAX_USER_LEN                (64)
#define EAP_MAX_PASS_LEN                (64)

/* EAP ioctl settings */
#define EAP_SET_VERSION                 (1)

/* Vendor Ids */
#define EAP_VENDOR_ID_IETF              (0)

#include "../eap/eap_proto.h"

typedef enum logLevel_s
{
    EAP_LOG_LEVEL_NONE,
    EAP_LOG_LEVEL_WARN,
    EAP_LOG_LEVEL_NOTICE,
    EAP_LOG_LEVEL_VERBOSE,
    EAP_LOG_LEVEL_ALL

}logLevel;

typedef struct eapMethodDef_s
{
    eapMethodType method_type;

    ubyte method_name[EAP_MAX_METHOD_NAME];

    MSTATUS (*funcPtr_ulReceiveCallback)   (ubyte * app_session_handle,
                                            eapMethodType type,
                                            eapCode code, ubyte id,
                                            ubyte * eap_data,
                                            ubyte4 eap_data_len, ubyte * opaque_data);

    MSTATUS (*funcPtr_ulReceivePassthruCallback) (ubyte * app_session_handle,
                                            eapMethodType type,
                                            eapCode code, ubyte id,
                                            ubyte * eap_data, ubyte4 eap_data_len,
                                            ubyte * opaque_data);

    MSTATUS (*funcPtr_ulReceiveIndication) (ubyte * app_session_handle,
                                            eapIndication ind_type,
                                            ubyte * data, ubyte4 data_len);

    MSTATUS (*funcPtr_ulMICVerify)         (ubyte * app_session_handle,
                                            ubyte * pkt, ubyte4 pkt_len);

    MSTATUS (*funcPtr_ulGetMethodstate)    (ubyte * app_session_handle,
                                            ubyte4 * methodState);

    MSTATUS (*funcPtr_ulGetDecision)       (ubyte * app_session_handle,
                                            ubyte4 * decision);

    MSTATUS (*funcPtr_llTransmitPacket)    (ubyte * app_session_handle,
                                            eapHdr_t * eap_hdr,
                                            ubyte * eap_data, ubyte4 eap_data_len);
} eapMethodDef_t;

/* Structure for Expanded Method format */
typedef struct eapExpandedMethod_t
{
    ubyte  vendor_id[3];
    ubyte  method_type[4];
} eapExpandedMethod_t;

/* Global Statistics */
typedef struct eapGlobalStats_s
{
    ubyte4    eap_total_pkts_sent;
    ubyte4    eap_total_pkts_received;
    ubyte4    eap_total_pkts_discard;
    ubyte4    eap_no_of_create_sessions;
    ubyte4    eap_no_of_modify_sessions;
    ubyte4    eap_no_of_active_sessions;
    ubyte4    eap_no_of_failed_sessions;
    ubyte4    eap_no_of_restart_sessions;
    ubyte4    eap_no_of_session_success;
    ubyte4    eap_no_of_session_failure;
    ubyte4    eap_no_of_retransmission;
    ubyte4    eap_no_of_peer_timeouts;
    ubyte4    eap_pkts_drop_invalid_session;
    ubyte4    eap_pkts_drop_invalid_pkt;

} eapGlobalStats_t;

/* Session Statistics */
typedef struct eapSessionStats_s
{
    ubyte4    eap_pkts_ll_sent;
    ubyte4    eap_pkts_ll_received;
    ubyte4    eap_pkts_ul_callback;
    ubyte4    eap_pkts_ul_received;
    ubyte4    eap_pkts_retransmitted;
    ubyte4    eap_pkts_discard;
    ubyte4    eap_pkts_drop_ul_nocallback;
    ubyte4    eap_pkts_drop_invalid_pkt;
    ubyte4    eap_pkts_tx_id_resp;
    ubyte4    eap_pkts_rx_id_resp;
    ubyte4    eap_pkts_rx_id_req;
    ubyte4    eap_pkts_tx_id_req;
} eapSessionStats_t;

/* Session Configuration */
typedef struct eapSessionConfig_s
{
    eapSessionType sessionType;
    ubyte4         eap_mtu;
    ubyte4         eap_ul_timeout;
    ubyte4         eap_retrans_timeout;
    ubyte4         eap_max_retrans;
    ubyte4         eap_options;
} eapSessionConfig_t;

#define EAP_OPTIONS_ENABLE_FORCED_AUTH       (0x1)

#define EAP_MOD_METHOD_DEF                   (0x1)
#define EAP_MOD_SESSION_TYPE                 (0x2)
#define EAP_MOD_SESSION_MTU                  (0x4)
#define EAP_MOD_SESSION_UL_TIMEOUT           (0x8)
#define EAP_MOD_SESSION_RETRANS_TIMEOUT      (0x10)
#define EAP_MOD_SESSION_MAX_RETRANS          (0x20)

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);

MOC_EXTERN MSTATUS EAP_llReceivePacket (ubyte *eapSessionHdl,
                                    ubyte4 instanceId,
                                    ubyte * eap_pkt,
                                    ubyte4 eap_pkt_len,
                                    ubyte * opaque_data);

/* Receive Alternate Indication from lower layer */
MOC_EXTERN MSTATUS EAP_llReceiveIndication (ubyte *eapSessionHdl,
                                    ubyte4 instanceId,
                                    eapAltIndication altIndication);

/* Session management API */

MOC_EXTERN MSTATUS EAP_sessionCreate (ubyte * appSessionHandle,
                                  ubyte4 instanceId,
                                  eapMethodDef_t methodDef,
                                  eapSessionConfig_t cfgParam ,
                      ubyte ** eapSessionHdl);

MOC_EXTERN MSTATUS EAP_sessionModify (ubyte * eapSessionHdl,
                                  ubyte4 instanceId,
                                  eapMethodDef_t methodDef,
                                  eapSessionConfig_t cfgParam,
                                  ubyte4 modifiedFlag);

MOC_EXTERN MSTATUS EAP_sessionDelete  (ubyte * eapSessionHdl,
                                  ubyte4 instanceId);

MOC_EXTERN MSTATUS EAP_sessionRestart (ubyte * eapSessionHdl,
                                   ubyte4 instanceId);

MOC_EXTERN MSTATUS EAP_sessionEnable  (ubyte * eapSessionHdl, ubyte4 instanceId);

MOC_EXTERN MSTATUS EAP_sessionDisable  (ubyte * eapSessionHdl, ubyte4 instanceId);

MOC_EXTERN MSTATUS EAP_getIdentity(ubyte * eapSessionHdl, ubyte4 instanceId,
                               ubyte **identity, ubyte4 *len);

MOC_EXTERN MSTATUS EAP_setIdentity(ubyte * eapSessionHdl, ubyte4 instanceId,
                               ubyte  *identity,ubyte4 len);

MOC_EXTERN MSTATUS EAP_getKey(ubyte * eapSessionHdl,
                          ubyte4 instanceId,
                          ubyte **key, ubyte *keylen);

MOC_EXTERN MSTATUS EAP_setKey(ubyte * eapSessionHdl,
                          ubyte4 instanceId,
                          ubyte *key, ubyte4 keylen);

MOC_EXTERN MSTATUS EAP_getAuthenticationStatus(ubyte * eapSessionHdl ,
                                           ubyte4 instanceId,
                                           eapAuthStatus *authStatus);

struct eapSessionStatus_s;
MOC_EXTERN MSTATUS EAP_getSessionStatus(ubyte * eapSessionHdl,
                                    ubyte4 instanceId,
                                    struct eapSessionStatus_s *eapStatus);

/* Configuration/Management  API */

MOC_EXTERN MSTATUS EAP_getSessionStats  (ubyte * eapSessionHdl,
                                     ubyte4 instanceId,
                                     eapSessionStats_t *eapStats);

MOC_EXTERN MSTATUS EAP_getInstanceStats  (ubyte4 instanceId,
                                     eapGlobalStats_t *stats);

MOC_EXTERN MSTATUS EAP_resetInstanceStats  (ubyte4 instanceId);

MOC_EXTERN MSTATUS EAP_resetSessionStats(ubyte *eapSessionHdl,
                                     ubyte4 instanceId);

/*
MOC_EXTERN MSTATUS EAP_setGlobalTimeout(ubyte4 timeout);

MOC_EXTERN MSTATUS EAP_loggingEnable (void);

MOC_EXTERN MSTATUS eap_setLogLevel (logLevel level);

MOC_EXTERN MSTATUS eap_loggingDisable (void);
*/

/* EAP Initialization APIs */

MOC_EXTERN MSTATUS EAP_initInstance  (ubyte4 *instanceId);

MOC_EXTERN MSTATUS EAP_deleteInstance  (ubyte4 instanceId);

MOC_EXTERN MSTATUS EAP_checkTimers (ubyte4 instanceId);

MOC_EXTERN MSTATUS EAP_init(void);

MOC_EXTERN MSTATUS EAP_shutdown(void);

MOC_EXTERN MSTATUS
EAP_buildExpandedNAK(ubyte *eapSessionHdl, ubyte4 instanceId,
                     eapExpandedMethod_t *expMethods, ubyte expMethodCount,
                     ubyte **eapResponse, ubyte4 *eapRespLen);

MOC_EXTERN MSTATUS
EAP_buildExpandedResponse(ubyte *eapSessionHdl, ubyte4 instanceId,
                          ubyte4 expVendorId, ubyte4 expMethodId,
                          ubyte *eapPayload, ubyte4 eapPayloadLen,
                          ubyte **eapResponse, ubyte4 *eapRespLen);


MOC_EXTERN MSTATUS
EAP_buildNAK(ubyte *eapSessionHdl, ubyte4 instanceId,
             ubyte* nakMethods, ubyte4 nakMethodCount,
             ubyte **eapResponse, ubyte4 *eapRespLen);

MOC_EXTERN MSTATUS
EAP_setMethodStateDecision(ubyte *eapSessionHdl, ubyte4 instanceId,
                           ubyte methodState, ubyte methodDecision);

MOC_EXTERN MSTATUS
EAP_setId_Type(ubyte * eapSessionHdl, ubyte4 instanceId,
               ubyte id, ubyte type);

MOC_EXTERN MSTATUS
EAP_generateIdReq(ubyte id,ubyte ** req, ubyte4 *reqLen);

MOC_EXTERN MSTATUS
EAP_getAppHdl(ubyte4  eapSessionHdl,
              ubyte4 instanceId,ubyte **appHdl);

#if defined(__ENABLE_ALL_DEBUGGING__)

MOC_EXTERN void EAP_PrintBytes( ubyte* buffer, sbyte4 len);
#endif

#if defined(__ENABLE_MOCANA_EAP_AUTH__)

MOC_EXTERN MSTATUS EAP_ulStartReauth(ubyte * eapSessionHdl, ubyte4 instanceId);
#endif

MOC_EXTERN MSTATUS EAP_getMtu(ubyte *eapSessionHdl, ubyte4 instanceId, ubyte4 *mtu);

#endif  /* __ENABLE_MOCANA_EAP_PEER__ || __ENABLE_MOCANA_EAP_AUTH__ */

#ifdef __cplusplus
}
#endif

#endif  /* __EAP_HEADER__ */