Commands_Utility

Describes about the CryptoASym Utility functions. More...

Collaboration diagram for Commands_Utility:

Functions
phStatus_t	phCryptoASym_InvalidateKey (void *pDataParams)
	Invalidate the currently loaded key. More...
phStatus_t	phCryptoASym_GetLastStatus (void *pDataParams, uint16_t wStatusMsgLen, int8_t *pStatusMsg, int32_t *pStatusCode)
	Returns the status code and respective message. More...
uint16_t	phCryptoASym_GetKeySize (uint16_t wKeyType, uint16_t wKeyPair, uint8_t bCurveID)
	Gets the size of the key based on the KeyPair and CurveID provided. More...

Detailed Description

Describes about the CryptoASym Utility functions.

Function Documentation

phCryptoASym_InvalidateKey()

phStatus_t phCryptoASym_InvalidateKey

(

void *

pDataParams

)

Invalidate the currently loaded key.

Resets the key

Returns

Status code

Return values

PH_ERR_SUCCESS	Operation successful.
Other	Depending on implementation and underlying component.

Parameters

[in]

pDataParams

[In] Pointer to this layer's parameter structure

phCryptoASym_GetLastStatus()

phStatus_t phCryptoASym_GetLastStatus	(	void *	pDataParams,
		uint16_t	wStatusMsgLen,
		int8_t *	pStatusMsg,
		int32_t *	pStatusCode
	)

Returns the status code and respective message.

Returns

Status code

Return values

PH_ERR_SUCCESS

Operation successful.

Parameters

[in]	pDataParams	[In] Pointer to this layer's parameter structure.
[in]	wStatusMsgLen	[In] Size of bytes allocated for pStatusMsg parameter.
[out]	pStatusMsg	[Out] The equivalent status message for the information available in pStatusCode.
[out]	pStatusCode	[Out] The status code returned by the underlying Crypto library.

phCryptoASym_GetKeySize()

uint16_t phCryptoASym_GetKeySize	(	uint16_t	wKeyType,
		uint16_t	wKeyPair,
		uint8_t	bCurveID
	)

Gets the size of the key based on the KeyPair and CurveID provided.

Returns

Status code

Return values

0	: If any of the parameter value is not supported.
Key	Size : For the key provided as parameter information.

Parameters

[in]	wKeyType	[In] Refer Key Types for supported values.
[in]	wKeyPair	[In] Refer Key Pair for supported values.
[in]	bCurveID	[In] Refer Curve ID for supported values.