KeyStore Command of HAL DUT Command dispatcher frame. More...

Collaboration diagram for Command_KeyStore:

Modules
	Command_Codes
	KeyStore Command Codes of HAL DUT Command dispatcher frame.

	Defines
	KeyStore Definitions of HAL DUT Command dispatcher frame.

	KeyStore Provisioning
	KeyStore Provisioning Command of HAL DUT Command dispatcher frame.

Functions
phStatus_t	phhalHw_DUT_Cmd_KeyStore_Init (phhalHw_DUT_DataParams_t *pDataParams, uint16_t wNoOfKeyEntries)
	Initialize the KeyStore component. More...

phStatus_t	phhalHw_DUT_Cmd_KeyStore_DeInit (phhalHw_DUT_DataParams_t *pDataParams)
	DeInitialize the KeyStore component. More...

phStatus_t	phhalHw_DUT_Cmd_KeyStore_FormatKeyEntry (phhalHw_DUT_DataParams_t *pDataParams, uint16_t wKeyNo, uint16_t wNewKeyType)
	The function resets to 0 all key versions and their corresponding key values for the indicated key wKeyNo. More...

phStatus_t	phhalHw_DUT_Cmd_KeyStore_SetKUC (phhalHw_DUT_DataParams_t *pDataParams, uint16_t wKeyNo, uint16_t wRefNoKUC)
	The function changes the key usage counter(KUC) pertaining to a key number wKeyNo to the specified value wRefNoKUC. More...

phStatus_t	phhalHw_DUT_Cmd_KeyStore_GetKUC (phhalHw_DUT_DataParams_t pDataParams, uint16_t wRefNoKUC, uint32_t pLimit, uint32_t *pCurVal)
	The function retrieves the indicated key usage counter(KUC) and stores its limit and current values at the indicated dwLimit and pdwCurVal respectively. More...

phStatus_t	phhalHw_DUT_Cmd_KeyStore_ChangeKUC (phhalHw_DUT_DataParams_t *pDataParams, uint16_t wRefNoKUC, uint32_t dwLimit)
	The function initializes the indicated key usage counter(KUC) with a limit value dwLimit. More...

phStatus_t	phhalHw_DUT_Cmd_KeyStore_SetConfig (phhalHw_DUT_DataParams_t *pDataParams, uint16_t wConfig, uint16_t wValue)
	Set configuration parameter. More...

phStatus_t	phhalHw_DUT_Cmd_KeyStore_SetConfigStr (phhalHw_DUT_DataParams_t pDataParams, uint16_t wConfig, uint8_t pBuffer, uint16_t wBuffLen)
	Set configuration parameter. More...

phStatus_t	phhalHw_DUT_Cmd_KeyStore_GetConfig (phhalHw_DUT_DataParams_t pDataParams, uint16_t wConfig, uint16_t pValue)
	Get configuration parameter. More...

phStatus_t	phhalHw_DUT_Cmd_KeyStore_GetConfigStr (phhalHw_DUT_DataParams_t pDataParams, uint16_t wConfig, uint8_t ppBuffer, uint16_t pBuffLen)
	Get configuration parameter. More...

phStatus_t	phhalHw_DUT_Cmd_KeyStore_SetKey (phhalHw_DUT_DataParams_t pDataParams, uint16_t wKeyNo, uint16_t wKeyVer, uint16_t wKeyType, uint8_t pNewKey, uint16_t wNewKeyVer)
	The function initializes a new version of the indicated wKeyNo, having key type wKeyType. More...

phStatus_t	phhalHw_DUT_Cmd_KeyStore_SetKeyAtPos (phhalHw_DUT_DataParams_t pDataParams, uint16_t wKeyNo, uint16_t wPos, uint16_t wKeyType, uint8_t pNewKey, uint16_t wNewKeyVer)
	The function initializes a new version of the indicated wKeyNo, having key type wKeyType. More...

phStatus_t	phhalHw_DUT_Cmd_KeyStore_SetFullKeyEntry (phhalHw_DUT_DataParams_t pDataParams, uint16_t wNoOfKeys, uint16_t wKeyNo, uint16_t wNewRefNoKUC, uint16_t wNewKeyType, uint8_t pNewKeys, uint16_t *pNewKeyVerList)
	The function initializes all key versions and the corresponding key data for the indicated key wKeyNo. More...

phStatus_t	phhalHw_DUT_Cmd_KeyStore_GetKeyEntry (phhalHw_DUT_DataParams_t pDataParams, uint16_t wKeyNo, uint16_t wKeyVerBufSize, uint16_t wKeyVersion, uint16_t wKeyVernLen, uint16_t pKeyType)
	The function retrieves the key type and the available key versions of the indicated key. More...

phStatus_t	phhalHw_DUT_Cmd_KeyStore_GetKey (phhalHw_DUT_DataParams_t pDataParams, uint16_t wKeyNo, uint16_t wKeyVer, uint8_t bKeyBufSize, uint8_t pKey, uint16_t *pKeyType)
	The function retrieves the key type and the available key versions of the indicated key. More...

phStatus_t	phhalHw_DUT_Cmd_KeyStore_SetKeyASym (phhalHw_DUT_DataParams_t pDataParams, uint16_t wKeyNo, uint16_t wPos, uint16_t wKeyType, uint16_t wKeyInfo, uint8_t pKey, uint16_t wKeyLen)
	Change a Asymmetric Private or Public key entry in Un-compressed Binary format. More...

phStatus_t	phhalHw_DUT_Cmd_KeyStore_GetKeyASym (phhalHw_DUT_DataParams_t pDataParams, uint16_t wKeyNo, uint16_t wPos, uint16_t wKeyPairType, uint16_t pKeyType, uint8_t pCurveID, uint8_t pKey, uint16_t *pKeyLen)
	Get a ASymmetric key. More...

Detailed Description

KeyStore Command of HAL DUT Command dispatcher frame.

Function Documentation

◆ phhalHw_DUT_Cmd_KeyStore_Init()

phStatus_t phhalHw_DUT_Cmd_KeyStore_Init	(	phhalHw_DUT_DataParams_t *	pDataParams,
		uint16_t	wNoOfKeyEntries
	)

Initialize the KeyStore component.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
Other	Depending on implementation and underlying component.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	wNoOfKeyEntries	[In] Number of key entries for storing the keys.

◆ phhalHw_DUT_Cmd_KeyStore_DeInit()

phStatus_t phhalHw_DUT_Cmd_KeyStore_DeInit ( phhalHw_DUT_DataParams_t * pDataParams )

DeInitialize the KeyStore component.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
Other	Depending on implementation and underlying component.

Parameters

[in] pDataParams [In] Pointer to an initialized HAL parameter structure.

◆ phhalHw_DUT_Cmd_KeyStore_FormatKeyEntry()

phStatus_t phhalHw_DUT_Cmd_KeyStore_FormatKeyEntry	(	phhalHw_DUT_DataParams_t *	pDataParams,
		uint16_t	wKeyNo,
		uint16_t	wNewKeyType
	)

The function resets to 0 all key versions and their corresponding key values for the indicated key wKeyNo.

The key type, which is valid for all key versions of wKeyNo is initialized through this function to the specified wNewKeyType.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
Other	Depending on implementation and underlying component.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	wKeyNo	[In] Key number of the key, which has to be formated.
[in]	wNewKeyType	[In] Key type of the key (predefined type).

◆ phhalHw_DUT_Cmd_KeyStore_SetKUC()

phStatus_t phhalHw_DUT_Cmd_KeyStore_SetKUC	(	phhalHw_DUT_DataParams_t *	pDataParams,
		uint16_t	wKeyNo,
		uint16_t	wRefNoKUC
	)

The function changes the key usage counter(KUC) pertaining to a key number wKeyNo to the specified value wRefNoKUC.

The current KUC gets overwritten with the indicated value.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
Other	Depending on implementation and underlying component.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	wKeyNo	[In] Key number of the key, which has to be.
[in]	wRefNoKUC	[In] Key usage counter(KUC) value for the indicated key wKeyNo

◆ phhalHw_DUT_Cmd_KeyStore_GetKUC()

phStatus_t phhalHw_DUT_Cmd_KeyStore_GetKUC	(	phhalHw_DUT_DataParams_t *	pDataParams,
		uint16_t	wRefNoKUC,
		uint32_t *	pLimit,
		uint32_t *	pCurVal
	)

The function retrieves the indicated key usage counter(KUC) and stores its limit and current values at the indicated dwLimit and pdwCurVal respectively.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
Other	Depending on implementation and underlying component.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	wRefNoKUC	[In] Reference number of the key usage counter.
[out]	pLimit	[Out] Pointer to received limit of key usage counter.
[out]	pCurVal	[Out] Pointer to received current key usage counter.

◆ phhalHw_DUT_Cmd_KeyStore_ChangeKUC()

phStatus_t phhalHw_DUT_Cmd_KeyStore_ChangeKUC	(	phhalHw_DUT_DataParams_t *	pDataParams,
		uint16_t	wRefNoKUC,
		uint32_t	dwLimit
	)

The function initializes the indicated key usage counter(KUC) with a limit value dwLimit.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
Other	Depending on implementation and underlying component.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	wRefNoKUC	[In] Reference number of the key usage counter.
[in]	dwLimit	[In] Limit of the key usage counter(KUC).

◆ phhalHw_DUT_Cmd_KeyStore_SetConfig()

phStatus_t phhalHw_DUT_Cmd_KeyStore_SetConfig	(	phhalHw_DUT_DataParams_t *	pDataParams,
		uint16_t	wConfig,
		uint16_t	wValue
	)

Set configuration parameter.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
Other	Depending on implementation and underlying component.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	wConfig	[In] Configuration Identifier
[in]	wValue	[In] Configuration Value

◆ phhalHw_DUT_Cmd_KeyStore_SetConfigStr()

phStatus_t phhalHw_DUT_Cmd_KeyStore_SetConfigStr	(	phhalHw_DUT_DataParams_t *	pDataParams,
		uint16_t	wConfig,
		uint8_t *	pBuffer,
		uint16_t	wBuffLen
	)

Set configuration parameter.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
Other	Depending on implementation and underlying component.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	wConfig	[In] Configuration Identifier
[in]	pBuffer	[In] Buffer containing the configuration string.
[in]	wBuffLen	[In] Length of configuration string

◆ phhalHw_DUT_Cmd_KeyStore_GetConfig()

phStatus_t phhalHw_DUT_Cmd_KeyStore_GetConfig	(	phhalHw_DUT_DataParams_t *	pDataParams,
		uint16_t	wConfig,
		uint16_t *	pValue
	)

Get configuration parameter.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
Other	Depending on implementation and underlying component.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	wConfig	[In] Configuration Identifier
[in]	pValue	[In] Configuration Value

◆ phhalHw_DUT_Cmd_KeyStore_GetConfigStr()

phStatus_t phhalHw_DUT_Cmd_KeyStore_GetConfigStr	(	phhalHw_DUT_DataParams_t *	pDataParams,
		uint16_t	wConfig,
		uint8_t **	ppBuffer,
		uint16_t *	pBuffLen
	)

Get configuration parameter.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
Other	Depending on implementation and underlying component.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	wConfig	[In] Configuration Identifier
[in]	ppBuffer	[In] Pointer to the buffer containing the configuration string.
[in]	pBuffLen	[In] Amount of valid bytes in the configuration string buffer.

◆ phhalHw_DUT_Cmd_KeyStore_SetKey()

phStatus_t phhalHw_DUT_Cmd_KeyStore_SetKey	(	phhalHw_DUT_DataParams_t *	pDataParams,
		uint16_t	wKeyNo,
		uint16_t	wKeyVer,
		uint16_t	wKeyType,
		uint8_t *	pNewKey,
		uint16_t	wNewKeyVer
	)

The function initializes a new version of the indicated wKeyNo, having key type wKeyType.

Note that the key type is not set here, but this done by the Format Key function. All key versions of wKeyNo are searched for the indicated wKeyVer and when found it gets overwritten together with its key data by the new version and data.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
Other	Depending on implementation and underlying component.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	wKeyNo	[In] Key number of the key, which has to be initialized.
[in]	wKeyVer	[In] Key version of the key, which has to be initialized.
[in]	wKeyType	[In] Key type of the key which has to be initialized.
[in]	pNewKey	[In] Pointer to a buffer holding the new key data for the indicated key number and version.
[in]	wNewKeyVer	[In] New key version for the indicated key number

◆ phhalHw_DUT_Cmd_KeyStore_SetKeyAtPos()

phStatus_t phhalHw_DUT_Cmd_KeyStore_SetKeyAtPos	(	phhalHw_DUT_DataParams_t *	pDataParams,
		uint16_t	wKeyNo,
		uint16_t	wPos,
		uint16_t	wKeyType,
		uint8_t *	pNewKey,
		uint16_t	wNewKeyVer
	)

The function initializes a new version of the indicated wKeyNo, having key type wKeyType.

Note that the key type is not set here, but this is done by the phhalHw_DUT_Cmd_KeyStore_FormatKeyEntry "Format KeyEntry" function. The key version at position wPos gets overwritten together with its key data by the new version and data.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
Other	Depending on implementation and underlying component.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	wKeyNo	[In] Key number of the key, which has to be initialized.
[in]	wPos	[In] Position of the key version for the indicated key
[in]	wKeyType	[In] Key type of the key, which has to be initialized.
[in]	pNewKey	[In] Pointer to a buffer holding the new key data for the indicated key number and version.
[in]	wNewKeyVer	[In] New key version for the indicated key number

◆ phhalHw_DUT_Cmd_KeyStore_SetFullKeyEntry()

phStatus_t phhalHw_DUT_Cmd_KeyStore_SetFullKeyEntry	(	phhalHw_DUT_DataParams_t *	pDataParams,
		uint16_t	wNoOfKeys,
		uint16_t	wKeyNo,
		uint16_t	wNewRefNoKUC,
		uint16_t	wNewKeyType,
		uint8_t *	pNewKeys,
		uint16_t *	pNewKeyVerList
	)

The function initializes all key versions and the corresponding key data for the indicated key wKeyNo.

The key usage counter(KUC) and the key type are set equal to the specified values.

Returns: Status code

Return values

Other Depending on implementation and underlying component.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	wNoOfKeys	[In] Number of keys versions in pNewKeys buffer.
[in]	wKeyNo	[In] Key number of the key to be initialized.
[in]	wNewRefNoKUC	[In] Key usage counter(KUC) value for the indicated key.
[in]	wNewKeyType	[In] Key type to be initialized
[in]	pNewKeys	[In] Pointer to array of key entries to load. The order of the key-data entirely corresponds to the order of the version numbers in pNewKeyVersionList.
[in]	pNewKeyVerList	[In] Pointer to key version list of the key to be loaded.

◆ phhalHw_DUT_Cmd_KeyStore_GetKeyEntry()

phStatus_t phhalHw_DUT_Cmd_KeyStore_GetKeyEntry	(	phhalHw_DUT_DataParams_t *	pDataParams,
		uint16_t	wKeyNo,
		uint16_t	wKeyVerBufSize,
		uint16_t *	wKeyVersion,
		uint16_t *	wKeyVernLen,
		uint16_t *	pKeyType
	)

The function retrieves the key type and the available key versions of the indicated key.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
Other	Depending on implementation and underlying component.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	wKeyNo	[In] Key number of the key, whose version data is retrieved.
[in]	wKeyVerBufSize	[In] Size of the key versions buffer wKeyVersion.
[out]	wKeyVersion	[Out] Pointer to a buffer where the key versions shall be stored.
[out]	wKeyVernLen	[Out] Pointer to a variable holding the number of the retrieved key versions.
[out]	pKeyType	[Out] Pointer to a variable that shall store the key type of the retrieved key.

◆ phhalHw_DUT_Cmd_KeyStore_GetKey()

phStatus_t phhalHw_DUT_Cmd_KeyStore_GetKey	(	phhalHw_DUT_DataParams_t *	pDataParams,
		uint16_t	wKeyNo,
		uint16_t	wKeyVer,
		uint8_t	bKeyBufSize,
		uint8_t *	pKey,
		uint16_t *	pKeyType
	)

The function retrieves the key type and the available key versions of the indicated key.

Returns: Status code

Return values

PH_ERR_SUCCESS	Command successfully executed.
Other	Depending on implementation and underlying component.

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	wKeyNo	[In] Key number of the key whose data is retrieved.
[in]	wKeyVer	[In] Key version of the key which has to be retrieved.
[in]	bKeyBufSize	[In] Size of the key buffer pKey.
[out]	pKey	[Out] Pointer to a buffer receiving the key data for the indicated key number and version.
[out]	pKeyType	[Out] Pointer to a variable that shall store the key type of the retrieved key.

◆ phhalHw_DUT_Cmd_KeyStore_SetKeyASym()

phStatus_t phhalHw_DUT_Cmd_KeyStore_SetKeyASym	(	phhalHw_DUT_DataParams_t *	pDataParams,
		uint16_t	wKeyNo,
		uint16_t	wPos,
		uint16_t	wKeyType,
		uint16_t	wKeyInfo,
		uint8_t *	pKey,
		uint16_t	wKeyLen
	)

Change a Asymmetric Private or Public key entry in Un-compressed Binary format.

Note

This interface should be called more than ones to load Private or Public Key.
One Key number at a specific position can hold both Private and Public Key.
Public Key alone can be stored also.

Returns: Status code

Return values

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

Parameters

[in]	pDataParams	[In] Pointer to an initialized HAL parameter structure.
[in]	wKeyNo	[In] Key number of the KeyStore to be loaded.
[in]	wPos	[In] Position at which the Key should be updated.
[in]	wKeyType	[In] New Key type of the KeyEntry (predefined type of KeyType).
[in]	wKeyInfo	[In] Type of Key pair and Curve to save.
[in]	pKey	[In] Pointer to the key itself.
[in]	wKeyLen	[In] Length of bytes available in pKey buffer.

◆ phhalHw_DUT_Cmd_KeyStore_GetKeyASym()

phStatus_t phhalHw_DUT_Cmd_KeyStore_GetKeyASym	(	phhalHw_DUT_DataParams_t *	pDataParams,
		uint16_t	wKeyNo,
		uint16_t	wPos,
		uint16_t	wKeyPairType,
		uint16_t *	pKeyType,
		uint8_t *	pCurveID,
		uint8_t *	pKey,
		uint16_t *	pKeyLen
	)

Get a ASymmetric 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.
[in]	wKeyNo	[In] Key number of the KeyStore to be retrieved.
[in]	wPos	[In] Position at which the Key should be retrieved.
[in]	wKeyPairType	[In] Type of Key-pair to be retrieved.
[in]	pKeyType	[In] Type of key being saved earlier.
[in]	pCurveID	[In] One of the Curve ID's.
[out]	pKey	[Out] Pointer to the key itself. The buffer size should be equal or greater than the Size of the stored key.
[out]	pKeyLen	[Out] Length of bytes available in pKey buffer.

Modules

Functions

Detailed Description

Function Documentation

◆ phhalHw_DUT_Cmd_KeyStore_Init()

◆ phhalHw_DUT_Cmd_KeyStore_DeInit()

◆ phhalHw_DUT_Cmd_KeyStore_FormatKeyEntry()

◆ phhalHw_DUT_Cmd_KeyStore_SetKUC()

◆ phhalHw_DUT_Cmd_KeyStore_GetKUC()

◆ phhalHw_DUT_Cmd_KeyStore_ChangeKUC()

◆ phhalHw_DUT_Cmd_KeyStore_SetConfig()

◆ phhalHw_DUT_Cmd_KeyStore_SetConfigStr()

◆ phhalHw_DUT_Cmd_KeyStore_GetConfig()

◆ phhalHw_DUT_Cmd_KeyStore_GetConfigStr()

◆ phhalHw_DUT_Cmd_KeyStore_SetKey()

◆ phhalHw_DUT_Cmd_KeyStore_SetKeyAtPos()

◆ phhalHw_DUT_Cmd_KeyStore_SetFullKeyEntry()

◆ phhalHw_DUT_Cmd_KeyStore_GetKeyEntry()

◆ phhalHw_DUT_Cmd_KeyStore_GetKey()

◆ phhalHw_DUT_Cmd_KeyStore_SetKeyASym()

◆ phhalHw_DUT_Cmd_KeyStore_GetKeyASym()