Provides EAP-PSK (EAP-Pre-Shared Key) authentication. More...

Functions
MOC_EXTERN MSTATUS	EAP_PSKAuthRequestFirst (ubyte eapPSKHdl, ubyte rand_s, ubyte id_s, ubyte2 id_s_len, ubyte request, ubyte4 requestLen)
	Forms the First Packet to be sent by the Authenticator. More...

MOC_EXTERN MSTATUS	EAP_PSKAuthRequestThird (ubyte eapPSKHdl, eapPSKResultInd resultInd, ubyte ext, ubyte2 extLen, ubyte id, ubyte *request, ubyte4 requestLen)
	Forms the third request packet to be sent by the Authenticator. More...

MOC_EXTERN MSTATUS	EAP_PSKDeleteSession (ubyte *eapPSKHdl)
	Deletes the EAP PSK Session. More...

MOC_EXTERN MSTATUS	EAP_PSKgetEXT (ubyte eapPSKHdl, ubyte ext, ubyte2 extLen)
	Returns the EXTENSION data received. More...

MOC_EXTERN MSTATUS	EAP_PSKgetID_P (ubyte eapPSKHdl, ubyte id_p, ubyte2 id_p_len)
	Returns the ID_P received from the Peer. More...

MOC_EXTERN MSTATUS	EAP_PSKgetID_S (ubyte eapPSKHdl, ubyte id_s, ubyte2 id_s_len)
	Returns the ID_S received from the Authenticator. More...

MOC_EXTERN MSTATUS	EAP_PSKgetKeys (ubyte eapPSKHdl, ubyte tek, ubyte msk, ubyte *emsk)
	Returns the generated session keys. More...

MOC_EXTERN MSTATUS	EAP_PSKgetResultInd (ubyte eapPSKHdl, eapPSKResultInd resInd)
	Returns the result indication received. More...

MOC_EXTERN MSTATUS	EAP_PSKInitSession (ubyte appSessionHdl, ubyte *eapPSKHdl, eapPSKConfig eapPSKCfg)
	Inits the EAP PSK Session. More...

MOC_EXTERN MSTATUS	EAP_PSKKeySetup (ubyte eapPSKHdl, ubyte psk)
	Generates the AK/KDK Based upon PSK. More...

MOC_EXTERN MSTATUS	EAP_PSKPeerReplyFourth (ubyte eapPSKHdl, eapPSKResultInd resultInd, ubyte ext, ubyte2 extLen, ubyte id, ubyte *reply, ubyte4 replyLen)
	Forms the fourth reply packet to be sent by the Peer. More...

MOC_EXTERN MSTATUS	EAP_PSKPeerReplySecond (ubyte eapPSKHdl, ubyte rand_p, ubyte id_p, ubyte2 id_p_len, ubyte reply, ubyte4 replyLen)
	Forms the Second Packet to be sent by the Peer. More...

MOC_EXTERN MSTATUS	EAP_PSKProcessMsg (ubyte eapPSKHdl, ubyte data, ubyte4 dataLen, ubyte id)
	Processes the incoming EAP PSK data message. More...

Detailed Description

Function Documentation

◆ EAP_PSKAuthRequestFirst()

MOC_EXTERN MSTATUS EAP_PSKAuthRequestFirst	(	ubyte *	eapPSKHdl,
		ubyte *	rand_s,
		ubyte *	id_s,
		ubyte2	id_s_len,
		ubyte **	request,
		ubyte4 *	requestLen
	)

Forms the First Packet to be sent by the Authenticator.

Since: 1.41

Version: 1.41 and later

To enable this function, the following flags must be defined in moptions.h:

__ENABLE_MOCANA_EAP_PSK__
__ENABLE_MOCANA_EAP_AUTH__

eap_psk.h

Parameters

eapPSKHdl	EAP PSK Session Handle.
rand_s	16 Byte Rand Generated by the Authenticator.
id_s	ID of the Authenticator to be sent.
id_s_len	Number of bytes in `id_s`.
request	Pointer to the buffer where the request is stored. Application needs to delete it after use.
requestLen	Request buffer length (`request`).

Returns: 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.

See also: EAP_PSKInitSession; EAP_PSKDeleteSession; EAP_PSKPeerReplySecond; EAP_PSKAuthRequestThird; EAP_PSKPeerReplyFourth

eap_psk.h

◆ EAP_PSKAuthRequestThird()

MOC_EXTERN MSTATUS EAP_PSKAuthRequestThird	(	ubyte *	eapPSKHdl,
		eapPSKResultInd	resultInd,
		ubyte *	ext,
		ubyte2	extLen,
		ubyte	id,
		ubyte **	request,
		ubyte4 *	requestLen
	)

Forms the Third request to be sent by the Authenticator after receving the second packet from the Peer.

Since: 1.41

Version: 1.41 and later

To enable this function, the following flags must be defined in moptions.h:

__ENABLE_MOCANA_EAP_PSK__
__ENABLE_MOCANA_EAP_AUTH__

eap_psk.h

Parameters

eapPSKHdl	EAP PSK Session Handle.
resultInd	Result indication to be sent to the Peer.
ext	Any EXTENSION data to be sent to the Peer.
extLen	EXTENSION data Length (`ext`).
id	EAP ID from the received EAP header for calculation of channel.
request	Pointer to the buffer where the request is stored. Application needs to delete it after use.
requestLen	Request Buffer Length (`request`).

Returns: 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.

See also: EAP_PSKInitSession; EAP_PSKDeleteSession; EAP_PSKPeerReplySecond; EAP_PSKAuthRequestThird; EAP_PSKPeerReplyFourth

eap_psk.h

◆ EAP_PSKDeleteSession()

MOC_EXTERN MSTATUS EAP_PSKDeleteSession ( ubyte * eapPSKHdl )

Deletes the EAP PSK Session.

Since: 1.41

Version: 1.41 and later

To enable this function, the following flag must be defined in moptions.h:

__ENABLE_MOCANA_EAP_PSK__

Additionally, at least one of the following flags must be defined in moptions.h:

__ENABLE_MOCANA_EAP_PEER__
__ENABLE_MOCANA_EAP_AUTH__

eap_psk.h

Parameters

eapPSKHdl Pointer to EAP PSK Session Handle.

Returns: 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.

See also: EAP_PSKInitSession; EAP_PSKAuthRequestFirst; EAP_PSKPeerReplySecond; EAP_PSKAuthRequestThird; EAP_PSKPeerReplyFourth

eap_psk.h

◆ EAP_PSKgetEXT()

MOC_EXTERN MSTATUS EAP_PSKgetEXT	(	ubyte *	eapPSKHdl,
		ubyte **	ext,
		ubyte2 *	extLen
	)

Returns the EXTENSION data received.

Since: 1.41

Version: 1.41 and later

To enable this function, the following flag must be defined in moptions.h:

__ENABLE_MOCANA_EAP_PSK__

Additionally, at least one of the following flags must be defined in moptions.h:

__ENABLE_MOCANA_EAP_PEER__
__ENABLE_MOCANA_EAP_AUTH__

eap_psk.h

Parameters

eapPSKHdl	EAP PSK Session Handle.
ext	On return, pointer to the EXTENSION data.
extLen	On return, pointer to the length of `ext`.

Returns: 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.

See also: EAP_PSKInitSession; EAP_PSKDeleteSession; EAP_PSKAuthRequestFirst; EAP_PSKPeerReplySecond; EAP_PSKAuthRequestThird; EAP_PSKPeerReplyFourth

eap_psk.h

◆ EAP_PSKgetID_P()

MOC_EXTERN MSTATUS EAP_PSKgetID_P	(	ubyte *	eapPSKHdl,
		ubyte **	id_p,
		ubyte2 *	id_p_len
	)

Returns the ID_P received from the Peer.

Since: 1.41

Version: 1.41 and later

To enable this function, the following flag must be defined in moptions.h:

__ENABLE_MOCANA_EAP_PSK__

Additionally, at least one of the following flags must be defined in moptions.h:

__ENABLE_MOCANA_EAP_PEER__
__ENABLE_MOCANA_EAP_AUTH__

eap_psk.h

Parameters

eapPSKHdl	EAP PSK Session Handle.
id_p	On return, pointer to the ID_P.
id_p_len	On return, pointer to the length of `id_p`.

Returns: 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.

See also: EAP_PSKInitSession; EAP_PSKDeleteSession; EAP_PSKAuthRequestFirst; EAP_PSKPeerReplySecond; EAP_PSKAuthRequestThird; EAP_PSKPeerReplyFourth

eap_psk.h

◆ EAP_PSKgetID_S()

MOC_EXTERN MSTATUS EAP_PSKgetID_S	(	ubyte *	eapPSKHdl,
		ubyte **	id_s,
		ubyte2 *	id_s_len
	)

Returns the ID_S received from the Authenticator.

Since: 1.41

Version: 1.41 and later

To enable this function, the following flag must be defined in moptions.h:

__ENABLE_MOCANA_EAP_PSK__

Additionally, at least one of the following flags must be defined in moptions.h:

__ENABLE_MOCANA_EAP_PEER__
__ENABLE_MOCANA_EAP_AUTH__

eap_psk.h

Parameters

eapPSKHdl	EAP PSK Session Handle.
id_s	On return, pointer to the ID_S.
id_s_len	On return, pointer to the length of `id_s`.

Returns: 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.

See also: EAP_PSKInitSession; EAP_PSKDeleteSession; EAP_PSKAuthRequestFirst; EAP_PSKPeerReplySecond; EAP_PSKAuthRequestThird; EAP_PSKPeerReplyFourth

eap_psk.h

◆ EAP_PSKgetKeys()

MOC_EXTERN MSTATUS EAP_PSKgetKeys	(	ubyte *	eapPSKHdl,
		ubyte **	tek,
		ubyte **	msk,
		ubyte **	emsk
	)

Returns the generated keys for the session.

Since: 1.41

Version: 1.41 and later

To enable this function, the following flag must be defined in moptions.h:

__ENABLE_MOCANA_EAP_PSK__

Additionally, at least one of the following flags must be defined in moptions.h:

__ENABLE_MOCANA_EAP_PEER__
__ENABLE_MOCANA_EAP_AUTH__

eap_psk.h

Parameters

eapPSKHdl	EAP PSK Session Handle.
tek	On return, pointer to the TEK (16 bytes).
msk	On return, pointer to the MSK (64 Bytes).
emsk	On return, pointer to the EMSK (64bytes).

Returns: 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.

See also: EAP_PSKInitSession; EAP_PSKDeleteSession; EAP_PSKAuthRequestFirst; EAP_PSKPeerReplySecond; EAP_PSKAuthRequestThird; EAP_PSKPeerReplyFourth

eap_psk.h

◆ EAP_PSKgetResultInd()

MOC_EXTERN MSTATUS EAP_PSKgetResultInd	(	ubyte *	eapPSKHdl,
		eapPSKResultInd *	resInd
	)

Returns the result indication received.

Since: 1.41

Version: 1.41 and later

To enable this function, the following flag must be defined in moptions.h:

__ENABLE_MOCANA_EAP_PSK__

Additionally, at least one of the following flags must be defined in moptions.h:

__ENABLE_MOCANA_EAP_PEER__
__ENABLE_MOCANA_EAP_AUTH__

eap_psk.h

Parameters

eapPSKHdl	EAP PSK Session Handle.
resInd	On return, pointer to the result indication.

Returns: 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.

See also: EAP_PSKInitSession; EAP_PSKDeleteSession; EAP_PSKAuthRequestFirst; EAP_PSKPeerReplySecond; EAP_PSKAuthRequestThird; EAP_PSKPeerReplyFourth

eap_psk.h

◆ EAP_PSKInitSession()

MOC_EXTERN MSTATUS EAP_PSKInitSession	(	ubyte *	appSessionHdl,
		ubyte **	eapPSKHdl,
		eapPSKConfig	eapPSKCfg
	)

Inititializes the EAP PSK Session and Returns the EAP PSK Handle.

Since: 1.41

Version: 1.41 and later

To enable this function, the following flag must be defined in moptions.h:

__ENABLE_MOCANA_EAP_PSK__

Additionally, at least one of the following flags must be defined in moptions.h:

__ENABLE_MOCANA_EAP_PEER__
__ENABLE_MOCANA_EAP_AUTH__

eap_psk.h

Parameters

appSessionHdl	Application Session Handle.
eapPSKHdl	Pointer to EAP PSK Session Handle.
eapPSKCfg	EAP PSK Config params, such as session type, callback function pointer.

Returns: 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.

See also: EAP_PSKDeleteSession; EAP_PSKAuthRequestFirst; EAP_PSKPeerReplySecond; EAP_PSKAuthRequestThird; EAP_PSKPeerReplyFourth

eap_psk.h

◆ EAP_PSKKeySetup()

MOC_EXTERN MSTATUS EAP_PSKKeySetup	(	ubyte *	eapPSKHdl,
		ubyte *	psk
	)

Generate AK and KDK based upon PSK for the session.

Since: 1.41

Version: 1.41 and later

To enable this function, the following flag must be defined in moptions.h:

__ENABLE_MOCANA_EAP_PSK__

Additionally, at least one of the following flags must be defined in moptions.h:

__ENABLE_MOCANA_EAP_PEER__
__ENABLE_MOCANA_EAP_AUTH__

eap_psk.h

Parameters

eapPSKHdl	EAP PSK Session Handle.
psk	Pointer to the 16 Byte PSK.

Returns: 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.

See also: EAP_PSKInitSession; EAP_PSKDeleteSession; EAP_PSKAuthRequestFirst; EAP_PSKPeerReplySecond; EAP_PSKAuthRequestThird; EAP_PSKPeerReplyFourth

eap_psk.h

◆ EAP_PSKPeerReplyFourth()

MOC_EXTERN MSTATUS EAP_PSKPeerReplyFourth	(	ubyte *	eapPSKHdl,
		eapPSKResultInd	resultInd,
		ubyte *	ext,
		ubyte2	extLen,
		ubyte	id,
		ubyte **	reply,
		ubyte4 *	replyLen
	)

Forms the fourth reply to be sent by the Peer after receving the third Packet from the Authenticator.

Since: 1.41

Version: 1.41 and later

To enable this function, the following flags must be defined in moptions.h:

__ENABLE_MOCANA_EAP_PSK__
__ENABLE_MOCANA_EAP_PEER__

eap_psk.h

Parameters

eapPSKHdl	EAP PSK Session Handle.
resultInd	Result Indication to be sent to the Authenticator.
ext	Any EXTENSION data to be sent to the Authenticator.
extLen	EXTENSION data Length (`ext`).
id	EAP ID from the received EAP header for calculation of channel.
reply	Pointer to the buffer where the reply is stored. Application needs to delete it after use.
replyLen	Reply buffer length (`reply`).

Returns: 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.

See also: EAP_PSKInitSession; EAP_PSKDeleteSession; EAP_PSKAuthRequestFirst; EAP_PSKPeerReplySecond; EAP_PSKAuthRequestThird; EAP_PSKPeerReplyFourth

eap_psk.h

◆ EAP_PSKPeerReplySecond()

MOC_EXTERN MSTATUS EAP_PSKPeerReplySecond	(	ubyte *	eapPSKHdl,
		ubyte *	rand_p,
		ubyte *	id_p,
		ubyte2	id_p_len,
		ubyte **	reply,
		ubyte4 *	replyLen
	)

Forms the Second Reply to be sent by the Peer after receving the first request from the Authenticator.

Since: 1.41

Version: 1.41 and later

To enable this function, the following flags must be defined in moptions.h:

__ENABLE_MOCANA_EAP_PSK__
__ENABLE_MOCANA_EAP_PEER__

eap_psk.h

Parameters

eapPSKHdl	EAP PSK Session Handle.
rand_p	16 Byte random number generated by the Peer.
id_p	ID of the Peer to be sent.
id_p_len	Number of bytes in `id_p`.
reply	Pointer to the buffer where the reply is stored. Application needs to delete it after use.
replyLen	Reply buffer length (`reply`).

Returns: 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.

See also: EAP_PSKInitSession; EAP_PSKDeleteSession; EAP_PSKAuthRequestFirst; EAP_PSKAuthRequestThird; EAP_PSKPeerReplyFourth

eap_psk.h

◆ EAP_PSKProcessMsg()

MOC_EXTERN MSTATUS EAP_PSKProcessMsg	(	ubyte *	eapPSKHdl,
		ubyte *	data,
		ubyte4	dataLen,
		ubyte	id
	)

Processes the incoming EAP PSK message and verifies the responses and informs the application about the state change and status.

Since: 1.41

Version: 1.41 and later

To enable this function, the following flag must be defined in moptions.h:

__ENABLE_MOCANA_EAP_PSK__

Additionally, at least one of the following flags must be defined in moptions.h:

__ENABLE_MOCANA_EAP_PEER__
__ENABLE_MOCANA_EAP_AUTH__

eap_psk.h

Parameters

eapPSKHdl	EAP PSK Session Handle.
data	Incoming PSK data.
dataLen	Number of bytes in `data`.
id	EAP ID from the received EAP header for calculation of channel.

Returns: 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.

See also: EAP_PSKInitSession; EAP_PSKDeleteSession; EAP_PSKPeerReplySecond; EAP_PSKAuthRequestThird; EAP_PSKPeerReplyFourth

eap_psk.h

Functions

Detailed Description

Function Documentation

◆ EAP_PSKAuthRequestFirst()

◆ EAP_PSKAuthRequestThird()

◆ EAP_PSKDeleteSession()

◆ EAP_PSKgetEXT()

◆ EAP_PSKgetID_P()

◆ EAP_PSKgetID_S()

◆ EAP_PSKgetKeys()

◆ EAP_PSKgetResultInd()

◆ EAP_PSKInitSession()

◆ EAP_PSKKeySetup()

◆ EAP_PSKPeerReplyFourth()

◆ EAP_PSKPeerReplySecond()

◆ EAP_PSKProcessMsg()