eap_sim.h

Go to the documentation of this file.

/*
 * eap_sim.h
 *
 * EAP SIM/AKA Helper Functions
 *
 * Copyright 2019-2024 DigiCert, Inc. All Rights Reserved.
 * Proprietary and Confidential Material.
 *
 */

#ifndef __EAP_SIM_H__
#define __EAP_SIM_H__

#ifdef __cplusplus
extern "C" {
#endif

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

#define EAP_SIM_AT_RAND                         (1)
#define EAP_AKA_AT_AUTN                         (2)
#define EAP_AKA_AT_RES                          (3)
#define EAP_AKA_AT_AUTS                         (4)
#define EAP_SIM_AT_PADDING                      (6)
#define EAP_SIM_AT_NONCE_MT                     (7)
#define EAP_SIM_AT_PERMANENT_ID_REQ             (10)
#define EAP_SIM_AT_MAC                          (11)
#define EAP_SIM_AT_NOTIFICATION                 (12)
#define EAP_SIM_AT_ANY_ID_REQ                   (13)
#define EAP_SIM_AT_IDENTITY                     (14)
#define EAP_SIM_AT_VERSION_LIST                 (15)
#define EAP_SIM_AT_SELECTED_VERSION             (16)
#define EAP_SIM_AT_FULLAUTH_ID_REQ              (17)
#define EAP_SIM_AT_COUNTER                      (19)
#define EAP_SIM_AT_COUNTER_TOO_SMALL            (20)
#define EAP_SIM_AT_NONCE_S                      (21)
#define EAP_SIM_AT_CLIENT_ERROR_CODE            (22)
#define EAP_SIM_AT_IV                           (129)
#define EAP_SIM_AT_ENCR_DATA                    (130)
#define EAP_SIM_AT_NEXT_PSEUDONYM               (132)
#define EAP_SIM_AT_NEXT_REAUTH_ID               (133)
#define EAP_AKA_AT_CHECKCODE                    (134)
#define EAP_SIM_AT_RESULT_IND                   (135)

#define EAP_SIM_AT_RAND_PRESENT                 (0x1)
#define EAP_SIM_AT_PADDING_PRESENT              (0x2)
#define EAP_SIM_AT_NONCE_MT_PRESENT             (0x4)
#define EAP_SIM_AT_PERMANENT_ID_REQ_PRESENT     (0x8)
#define EAP_SIM_AT_MAC_PRESENT                  (0x10)
#define EAP_SIM_AT_NOTIFICATION_PRESENT         (0x20)
#define EAP_SIM_AT_ANY_ID_REQ_PRESENT           (0x40)
#define EAP_SIM_AT_IDENTITY_PRESENT             (0x80)
#define EAP_SIM_AT_VERSION_LIST_PRESENT         (0x100)
#define EAP_SIM_AT_SELECTED_VERSION_PRESENT     (0x200)
#define EAP_SIM_AT_FULLAUTH_ID_REQ_PRESENT      (0x400)
#define EAP_SIM_AT_COUNTER_PRESENT              (0x800)
#define EAP_SIM_AT_COUNTER_TOO_SMALL_PRESENT    (0x1000)
#define EAP_SIM_AT_NONCE_S_PRESENT              (0x2000)
#define EAP_SIM_AT_CLIENT_ERROR_CODE_PRESENT    (0x4000)
#define EAP_SIM_AT_IV_PRESENT                   (0x8000)
#define EAP_SIM_AT_ENCR_DATA_PRESENT            (0x10000)
#define EAP_SIM_AT_NEXT_PSEUDONYM_PRESENT       (0x20000)
#define EAP_SIM_AT_NEXT_REAUTH_ID_PRESENT       (0x40000)
#define EAP_SIM_AT_RESULT_IND_PRESENT           (0x80000)
#define EAP_AKA_AT_AUTN_PRESENT                 (0x100000)
#define EAP_AKA_AT_RES_PRESENT                  (0x200000)
#define EAP_AKA_AT_AUTS_PRESENT                 (0x400000)
#define EAP_AKA_AT_CHECKCODE_PRESENT            (0x800000)

#define EAP_AKA_SUBTYPE_CHALLENGE               (1)
#define EAP_AKA_SUBTYPE_AUTH_REJECT             (2)
#define EAP_AKA_SUBTYPE_SYNC_FAIL               (4)
#define EAP_AKA_SUBTYPE_IDENTITY                (5)
#define EAP_SIM_SUBTYPE_START                   (10)
#define EAP_SIM_SUBTYPE_CHALLENGE               (11)
#define EAP_SIM_SUBTYPE_NOTIFICATION            (12)
#define EAP_AKA_SUBTYPE_NOTIFICATION            (12)
#define EAP_SIM_SUBTYPE_REAUTHENTICATION        (13)
#define EAP_AKA_SUBTYPE_REAUTHENTICATION        (13)
#define EAP_SIM_SUBTYPE_CLIENT_ERROR            (14)
#define EAP_AKA_SUBTYPE_CLIENT_ERROR            (14)

#define EAP_SIM_MAC_LEN                         (16)
#define EAP_SIM_KAUT_LEN                        (16)
#define EAP_SIM_KENCR_LEN                       (16)
#define EAP_SIM_MK_LEN                          (20)
#define EAP_SIM_MSK_LEN                         (64)
#define EAP_SIM_EMSK_LEN                        (64)
#define EAP_SIM_KC_LEN                          (8)
#define EAP_SIM_SRES_LEN                        (4)
#define EAP_SIM_MAX_RAND                        (3)
#define EAP_SIM_RAND_LEN                        (16)
#define EAP_SIM_NONCE_MT_LEN                    (16)
#define EAP_SIM_NONCE_S_LEN                     (16)
#define EAP_SIM_IV_LEN                          (16)
#define EAP_AKA_AUTN_LEN                        (16)
#define EAP_AKA_AUTS_LEN                        (14)
#define EAP_AKA_MAX_RES_LEN                     (16) /* Max 128 Bits */
#define EAP_AKA_IK_LEN                          (16)
#define EAP_AKA_CK_LEN                          (16)

#define EAP_SIM_NOTIF_S_BIT                     (0x8000)
#define EAP_SIM_NOTIF_P_BIT                     (0x4000)

#define EAP_SIM_PACKET_SIZE                     (1024)


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

typedef enum eapSimKeyType_e
{
    EAP_SIM_MASTER_KEY = 1,
    EAP_SIM_ENCR_KEY   = 2,
    EAP_SIM_AUT_KEY    = 3,
    EAP_SIM_MSK_KEY    = 4,
    EAP_SIM_EMSK_KEY   = 5,

} eapSimKeyType;

typedef enum eapSimNotifCode_e
{
    EAP_SIM_NOTIF_GENERAL_ERROR = 0,
    EAP_SIM_NOTIF_DENIED_ACCESS=1026,
    EAP_SIM_NOTIF_NOT_SUBSCRIBED=1031,
    EAP_SIM_NOTIF_GENERAL_FAILURE = 16384,
    EAP_SIM_NOTIF_SUCCESS=32768

} eapSimNotifCode;

typedef enum eapSimClientErrCode_e
{
    EAP_SIM_CLERR_PROCESSING = 0,
    EAP_SIM_CLERR_UNSUPPORT_VER=1,
    EAP_SIM_CLERR_LESS_CHALLENGES=2,
    EAP_SIM_CLERR_STALE_RAND = 3

} eapSimClientErrCode;

typedef enum eapSimIdType_e
{
    EAP_SIM_PERMANENT_ID_TYPE = 1,
    EAP_SIM_FULLAUTH_ID_TYPE,
    EAP_SIM_FASTREAUTH_ID_TYPE

} eapSimIdType;

typedef enum eapSimPdus_e {
  EAP_SIM_START_REQ,
  EAP_SIM_START_RESP,
  EAP_SIM_CHALLENGE_REQ,
  EAP_SIM_CHALLENGE_RESP,
  EAP_SIM_NOTIFICATION_REQ,
  EAP_SIM_NOTIFICATION_RESP,
  EAP_SIM_CLIENT_ERROR,
  EAP_SIM_REAUTH_REQ,
  EAP_SIM_REAUTH_RESP,
  EAP_AKA_IDENTITY_REQ,
  EAP_AKA_IDENTITY_RESP,
  EAP_AKA_AUTH_REJECT_RESP,
  EAP_AKA_SYNC_FAIL_RESP

} eapSimPdus;

typedef enum eapSimStatus_e {
  EAP_SIM_STATUS_INIT,
  EAP_SIM_STATUS_RECV_START_RESP,
  EAP_SIM_STATUS_RECV_START_REQ,
  EAP_SIM_STATUS_RECV_CHALLENGE_RESP,
  EAP_SIM_STATUS_RECV_CHALLENGE_REQ,
  EAP_SIM_STATUS_RECV_NOTIFICATION_RESP,
  EAP_SIM_STATUS_RECV_NOTIFICATION_REQ,
  EAP_SIM_STATUS_RECV_NOTIFICATION_ERROR,
  EAP_SIM_STATUS_RECV_REAUTH_REQ,
  EAP_SIM_STATUS_RECV_REAUTH_RESP,
  EAP_SIM_STATUS_RECV_CLIENT_ERROR_CODE,
  EAP_AKA_STATUS_RECV_IDENTITY_REQ,
  EAP_AKA_STATUS_RECV_IDENTITY_RESP,
  EAP_AKA_STATUS_RECV_AUTH_REJECT_RESP,
  EAP_AKA_STATUS_RECV_SYNC_FAIL_RESP

} eapSimStatus;


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

typedef struct eapSimConfig_s
{
    ubyte send_result_ind;                                          /* Support Result_IND Attr */

    MSTATUS(*getSresKc)(void * appCb,void *eapSim,ubyte *rand,ubyte numRand,
                          ubyte *Sres,ubyte *Kc);                   /* Function that gets called once RAND from AUTH are received */

    MSTATUS(*getAKARes)(void * appCb,void *eapSim,ubyte *rand,ubyte *autn,
                          ubyte *ik,ubyte * ck,
                          ubyte *Res,ubyte2 *resLen,ubyte *auts);   /* Function that gets called once RAND from AUTN are received  */
                                                                    /*It can return back OK/ AUTHREJECT or SYNC FAIL.. */
                                                                    /*If it returns sync fail then it has to fill the auts value*/

    eapSessionType sessionType;                                     /* PEER- AUTH */

    ubyte minNumRand;                                               /* Minimum number of Rands That the Auth Needs to Send */

    ubyte dontSendPerm;                                             /* Deny The PERM ID attribute to the Server */

    ubyte aka;                                                      /* AKA Session */

} eapSimConfig;

typedef struct eapSimCb_s {

    void*           appSessionHdl;
    ubyte*          permanentIdentity;              /* Based upon IMSI*/
    ubyte2          permanentIdentityLen;
    ubyte*          psuedonym;                      /* Received from NEXT_PSUEDONYM For Identity Hiding*/
    ubyte2          psuedonymLen;
    ubyte*          reauthId;                       /* For Reauth ,received from REAUTH_ID*/
    ubyte2          reauthIdLen;
    ubyte           numIdReq;
    ubyte*          identity;
    ubyte           id_requested;                   /*The Type of ID requested by AUTH(ANY,FULL,PERM)*/
    ubyte2          identityLen;
    ubyte           sRes[EAP_SIM_SRES_LEN* EAP_SIM_MAX_RAND];
    ubyte           kC[EAP_SIM_KC_LEN* EAP_SIM_MAX_RAND];
    ubyte2*         versionListImpl;
    ubyte2          numVersionListImpl;             /* Has to be atleast 1*/
    ubyte2*         versionList;                    /* Version List Sent by AUTH*/
    ubyte2          numVersionList;
    ubyte2          selectedVersion;                /* Version Selected by Peer*/
    ubyte           nonce_mt[EAP_SIM_NONCE_MT_LEN]; /* Nonce Sent by PEER*/
    ubyte           nonce_s[EAP_SIM_NONCE_S_LEN];   /* Nonce sent by AUTH during Fast Reauth*/
    ubyte           numRand;                        /* Number of Rands sent by AUTH*/
    ubyte           rand[EAP_SIM_MAX_RAND][EAP_SIM_RAND_LEN];
    ubyte           mac[EAP_SIM_MAC_LEN];
    ubyte           autn[EAP_AKA_AUTN_LEN];
    ubyte           auts[EAP_AKA_AUTS_LEN];
    ubyte           res[EAP_AKA_MAX_RES_LEN];
    ubyte2          resLen;
    ubyte           authRes[EAP_AKA_MAX_RES_LEN];
    ubyte2          authResLen;
    ubyte           masterKey[EAP_SIM_MK_LEN];
    ubyte           k_aut[EAP_SIM_KAUT_LEN];
    ubyte           k_encr[EAP_SIM_KENCR_LEN];
    ubyte           k_msk[EAP_SIM_MSK_LEN];
    ubyte           k_emsk[EAP_SIM_EMSK_LEN];
    ubyte           IK[EAP_AKA_IK_LEN];
    ubyte           CK[EAP_AKA_CK_LEN];
    ubyte*          encr_data;
    ubyte2          encr_dataLen;
    ubyte           iv[EAP_SIM_IV_LEN];
    ubyte4          attrPresent;                    /* Bit map of attr present in any message received*/
    ubyte2          counter;                        /* AT_COUNTER Sent by AUTH*/
    ubyte2          notifCode;
    ubyte2          clientErrCode;
    eapSimConfig    eapSimCfg;                      /* Initial Params set during Session Create*/
    eapSimStatus    sessionStatus;                  /* Session Stataus*/
    ubyte           recvResultInd;
    ubyte           reAuthRoundSuccess;             /* Doing Reauth Istead of Full Auth*/
    ubyte           attemptreAuthRound;
    ubyte           fullAuthRoundSuccess;
    ubyte           attemptfullAuthRound;
    ubyte           counterTooSmall;
} eapSimCb;


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

MOC_EXTERN MSTATUS
EAP_SIMSendChallengeReq(eapSimCb *eapSim, ubyte **pkt, ubyte4 *pktLen,
                        ubyte *rand, ubyte2 num_rand,
                        ubyte *kC, ubyte *sRes,
                        ubyte *at_next_psuedo, ubyte2 at_psuedo_len,
                        ubyte *at_next_reauthid, ubyte2 at_reauthid_len,
                        ubyte id);

MOC_EXTERN MSTATUS
EAP_SIMSendNotificationReq(eapSimCb *eapSim, ubyte **pkt, ubyte4 *pktLen,
                           ubyte2 at_counter,
                           ubyte4 notification_code, ubyte id);

MOC_EXTERN MSTATUS
EAP_SIMProcessPkt(eapSimCb *eapSim, ubyte *pkt, ubyte2 pktLen,
                  ubyte **resp, ubyte4 *respLen, eapSimStatus *state);

MOC_EXTERN MSTATUS
EAP_SIMInitSession(void *appCb, void **eapSim, eapSimConfig eapSimCfg);

MOC_EXTERN MSTATUS
EAP_SIMGetResultInd(void *eap_sim, ubyte *rInd);

MOC_EXTERN MSTATUS
EAP_SIMSendStartReq(eapSimCb *eapSim, ubyte **pkt, ubyte4 *pktLen,
                    ubyte id_type, ubyte id);

extern MSTATUS
EAP_SIMSendReauthReq(eapSimCb *eapSim, ubyte **pkt, ubyte4 *pktLen,
                     ubyte *at_next_reauthid, ubyte2 at_reauthid_len,
                     ubyte id);

MOC_EXTERN MSTATUS
EAP_SIMGetSessionStatus(void *eap_sim, eapSimStatus *status);

MOC_EXTERN MSTATUS
EAP_SIMGetClientErrorCode(eapSimCb *eapSim, ubyte2 *clCode);

MOC_EXTERN MSTATUS
EAP_SIMGetNotification(eapSimCb *eapSim, ubyte2 *notifCode);

MOC_EXTERN MSTATUS
EAP_SIMGetIdentity(eapSimCb *eapSim, ubyte **identity, ubyte4 *len);

MOC_EXTERN MSTATUS
EAP_SIMSetImplementedVersion(eapSimCb *eapSim,
                             ubyte2 *versionList, ubyte2 numVersion);

MOC_EXTERN MSTATUS
EAP_SIMSetPermIdentity(eapSimCb *eapSim, ubyte *id, ubyte2 idLen);

MOC_EXTERN MSTATUS
EAP_SIMGetSelectedVersion(void *eap_sim, ubyte2 *rVer);

MOC_EXTERN MSTATUS
EAP_SIMSetIdentity(eapSimCb *eapSim, ubyte *id, ubyte2 idLen);

MOC_EXTERN MSTATUS
EAP_SIMGetSuccessNotifCode(void *eap_sim, ubyte *rCode);

MOC_EXTERN MSTATUS
EAP_SIMDeleteSession(eapSimCb *eapSim);

MOC_EXTERN MSTATUS
EAP_AKASendIdentityReq(eapSimCb *eapSim, ubyte **pkt, ubyte4 *pktLen,
                       ubyte id_type, ubyte id);

MOC_EXTERN MSTATUS
EAP_AKASendChallengeReq(eapSimCb *eapSim, ubyte **pkt, ubyte4 *pktLen,
                        ubyte *rand, ubyte *autn,
                        ubyte *ck, ubyte *ik, ubyte* res, ubyte2 resLen,
                        ubyte *at_next_psuedo, ubyte2 at_psuedo_len,
                        ubyte *at_next_reauthid, ubyte2 at_reauthid_len,
                        ubyte id);

MOC_EXTERN MSTATUS
EAP_AKAProcessPkt(eapSimCb *eapSim, ubyte *pkt, ubyte2 pktLen,
                  ubyte **resp, ubyte4 *respLen, eapSimStatus *state);

MOC_EXTERN MSTATUS
EAP_AKAGetAuts(eapSimCb *eapSim, ubyte **auts);

MOC_EXTERN MSTATUS
EAP_SIMgetKey(eapSimCb *eapSim, eapSimKeyType keyType,
              ubyte **key, ubyte4 *keyLen);


#endif /* ((defined(__ENABLE_MOCANA_EAP_PEER__) || defined(__ENABLE_MOCANA_EAP_AUTH__)) */
#ifdef __cplusplus
}
#endif
#endif /* __EAP_SIM_H__  */