This is only a wrapper layer to abstract the different KeyStore implementations. With this wrapper it is possible to support more than one CryptoSym implementation in parallel, by adapting this wrapper. More...

Collaboration diagram for KeyStore:

Modules
	Component : Software
	KeyStore implementation in Software.

	Component : Rc663
	KeyStore implementation to use RC663 Hardware KeyStore.

	Component : Rc632
	KeyStore implementation to use RC632 Hardware KeyStore.

	Component : Rd710
	KeyStore implementation to use RD710 Hardware KeyStore.

	Component : SamAV2
	SamAV2 implementation of the phSam interface.

	Component : SamAV3
	SamAV3 implementation of the phSam interface.

	Defines
	Definitions for KeyStore layer.

	Symmetric
	Interfaces for Symmetric keys of KeyStore component.

	ASymmetric
	Interfaces for ASymmetric keys of KeyStore component.

	Utility
	Interfaces for utility interfaces for KeyStore component.

Functions
phStatus_t	phKeyStore_FormatKeyEntry (void *pDataParams, uint16_t wKeyNo, uint16_t wNewKeyType)
	Format a key entry to a new KeyType. More...

phStatus_t	phKeyStore_SetKUC (void *pDataParams, uint16_t wKeyNo, uint16_t wRefNoKUC)
	Change the KUC of a key entry. More...

phStatus_t	phKeyStore_GetKUC (void pDataParams, uint16_t wRefNoKUC, uint32_t pdwLimit, uint32_t *pdwCurVal)
	Obtain a key usage counter entry. More...

phStatus_t	phKeyStore_ChangeKUC (void *pDataParams, uint16_t wRefNoKUC, uint32_t dwLimit)
	Change a key usage counter entry. More...

phStatus_t	phKeyStore_SetConfig (void *pDataParams, uint16_t wConfig, uint16_t wValue)
	Set configuration parameter. More...

phStatus_t	phKeyStore_SetConfigStr (void pDataParams, uint16_t wConfig, uint8_t pBuffer, uint16_t wBufferLength)
	Set configuration parameter. More...

phStatus_t	phKeyStore_GetConfig (void pDataParams, uint16_t wConfig, uint16_t pValue)
	Get configuration parameter. More...

phStatus_t	phKeyStore_GetConfigStr (void pDataParams, uint16_t wConfig, uint8_t ppBuffer, uint16_t pBufferLength)
	Get configuration parameter. More...

Detailed Description

This is only a wrapper layer to abstract the different KeyStore implementations. With this wrapper it is possible to support more than one CryptoSym implementation in parallel, by adapting this wrapper.

Important hints for users of this component:

Before use of any function, the dedicated KeyStore implementation has to be initialized using either of the interfaces mentioned below.

Function Documentation

◆ phKeyStore_FormatKeyEntry()

phStatus_t phKeyStore_FormatKeyEntry	(	void *	pDataParams,
		uint16_t	wKeyNo,
		uint16_t	wNewKeyType
	)

Format a key entry to a new KeyType.

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] KeyEntry number to be Formatted.
[in]	wNewKeyType	[In] New Key type of the KeyEntry (predefined type of KeyType). Symmetric KeyTypes ASymmetric KeyTypes

◆ phKeyStore_SetKUC()

phStatus_t phKeyStore_SetKUC	(	void *	pDataParams,
		uint16_t	wKeyNo,
		uint16_t	wRefNoKUC
	)

Change the KUC of a key entry.

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] KeyEntry number.
[in]	wRefNoKUC	[In] Reference Number of the key usage counter used together with that key.

◆ phKeyStore_GetKUC()

phStatus_t phKeyStore_GetKUC	(	void *	pDataParams,
		uint16_t	wRefNoKUC,
		uint32_t *	pdwLimit,
		uint32_t *	pdwCurVal
	)

Obtain a key usage counter entry.

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]	wRefNoKUC	[In] Number of the key usage counter to be looked at (00h to 0Fh)
[out]	pdwLimit	[Out] Currently Set Limit in the KUC
[out]	pdwCurVal	[Out] Currently set value in the KUC

◆ phKeyStore_ChangeKUC()

phStatus_t phKeyStore_ChangeKUC	(	void *	pDataParams,
		uint16_t	wRefNoKUC,
		uint32_t	dwLimit
	)

Change a key usage counter entry.

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]	wRefNoKUC	[In] Number of key entry.
[in]	dwLimit	[In] Limit of the Key Usage Counter.

◆ phKeyStore_SetConfig()

phStatus_t phKeyStore_SetConfig	(	void *	pDataParams,
		uint16_t	wConfig,
		uint16_t	wValue
	)

Set configuration parameter.

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]	wConfig	[In] Configuration Identifier
[in]	wValue	[In] Configuration Value

◆ phKeyStore_SetConfigStr()

phStatus_t phKeyStore_SetConfigStr	(	void *	pDataParams,
		uint16_t	wConfig,
		uint8_t *	pBuffer,
		uint16_t	wBufferLength
	)

Set configuration parameter.

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]	wConfig	[In] Configuration Identifier.
[in]	pBuffer	[In] Buffer containing the configuration string.
[in]	wBufferLength	[In] Length of configuration string.

◆ phKeyStore_GetConfig()

phStatus_t phKeyStore_GetConfig	(	void *	pDataParams,
		uint16_t	wConfig,
		uint16_t *	pValue
	)

Get configuration parameter.

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]	wConfig	[In] Configuration Identifier
[out]	pValue	[Out] Configuration Value

◆ phKeyStore_GetConfigStr()

phStatus_t phKeyStore_GetConfigStr	(	void *	pDataParams,
		uint16_t	wConfig,
		uint8_t **	ppBuffer,
		uint16_t *	pBufferLength
	)

Get configuration parameter.

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]	wConfig	[In] Configuration Identifier
[out]	ppBuffer	[Out] Pointer to the buffer containing the configuration string.
[out]	pBufferLength	[Out] Amount of valid bytes in the configuration string buffer.

Modules

Functions

Detailed Description

Function Documentation

◆ phKeyStore_FormatKeyEntry()

◆ phKeyStore_SetKUC()

◆ phKeyStore_GetKUC()

◆ phKeyStore_ChangeKUC()

◆ phKeyStore_SetConfig()

◆ phKeyStore_SetConfigStr()

◆ phKeyStore_GetConfig()

◆ phKeyStore_GetConfigStr()