Interfaces for Symmetric keys of KeyStore component. More...

Collaboration diagram for Symmetric:

Modules
	Common Definitions
	Definitions for Symmetric keys of KeyStore component.

Functions
phStatus_t	phKeyStore_SetKey (void pDataParams, uint16_t wKeyNo, uint16_t wKeyVersion, uint16_t wKeyType, uint8_t pNewKey, uint16_t wNewKeyVersion)
	Change a symmetric key entry at a given version. More...

phStatus_t	phKeyStore_SetKeyAtPos (void pDataParams, uint16_t wKeyNo, uint16_t wPos, uint16_t wKeyType, uint8_t pNewKey, uint16_t wNewKeyVersion)
	Change a symmetric key entry at the specified position. More...

phStatus_t	phKeyStore_SetFullKeyEntry (void pDataParams, uint16_t wNoOfKeys, uint16_t wKeyNo, uint16_t wNewRefNoKUC, uint16_t wNewKeyType, uint8_t pNewKeys, uint16_t *pNewKeyVersionList)
	Change a full symmetric key entry. More...

phStatus_t	phKeyStore_GetKeyEntry (void pDataParams, uint16_t wKeyNo, uint16_t wKeyVersionBufSize, uint16_t wKeyVersion, uint16_t wKeyVersionLength, uint16_t pKeyType)
	Get a symmetric key entry information block. More...

phStatus_t	phKeyStore_GetKey (void pDataParams, uint16_t wKeyNo, uint16_t wKeyVersion, uint8_t bKeyBufSize, uint8_t pKey, uint16_t *pKeyType)
	Get a symmetric key. More...

Detailed Description

Interfaces for Symmetric keys of KeyStore component.

Function Documentation

◆ phKeyStore_SetKey()

phStatus_t phKeyStore_SetKey	(	void *	pDataParams,
		uint16_t	wKeyNo,
		uint16_t	wKeyVersion,
		uint16_t	wKeyType,
		uint8_t *	pNewKey,
		uint16_t	wNewKeyVersion
	)

Change a symmetric key entry at a given version.

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 key to be loaded. Should be the Key index to set the key to DataParams pKeyEntries buffer.
[in]	wKeyVersion	[In] Key version of the key to be loaded.
[in]	wKeyType	[In] New Key type of the KeyEntry (predefined type of KeyType). AES 128Bit Key AES 192Bit Key AES 256Bit Key DES Key TripleDES - 2Key TripleDES - 3Key CRYPTO-1 Key
[in]	pNewKey	[In] Pointer to the key itself.
[in]	wNewKeyVersion	[In] New Key version of the key to be updated.

◆ phKeyStore_SetKeyAtPos()

phStatus_t phKeyStore_SetKeyAtPos	(	void *	pDataParams,
		uint16_t	wKeyNo,
		uint16_t	wPos,
		uint16_t	wKeyType,
		uint8_t *	pNewKey,
		uint16_t	wNewKeyVersion
	)

Change a symmetric key entry at the specified position.

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 key to be loaded. Should be the Key index to set the key to DataParams pKeyEntries member.
[in]	wPos	[In] Key position to be updated. Should be the Key position to set the key to DataParams pKeyEntries buffer.
[in]	wKeyType	[In] New Key type of the KeyEntry (predefined type of KeyType). AES 128Bit Key AES 192Bit Key AES 256Bit Key DES Key TripleDES - 2Key TripleDES - 3Key CRYPTO-1 Key
[in]	pNewKey	[In] Pointer to the key itself.
[in]	wNewKeyVersion	[In] New Key version of the key to be updated.

◆ phKeyStore_SetFullKeyEntry()

phStatus_t phKeyStore_SetFullKeyEntry	(	void *	pDataParams,
		uint16_t	wNoOfKeys,
		uint16_t	wKeyNo,
		uint16_t	wNewRefNoKUC,
		uint16_t	wNewKeyType,
		uint8_t *	pNewKeys,
		uint16_t *	pNewKeyVersionList
	)

Change a full symmetric 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]	wNoOfKeys	[In] Number of keys in pNewKeys.
[in]	wKeyNo	[In] Key number of the key to be loaded.
[in]	wNewRefNoKUC	[In] Number of the key usage counter used together with that key.
[in]	wNewKeyType	[In] Key type of the key (if the current keyType of KeyEntry is different, error).
[in]	pNewKeys	[In] Array of Keys to load.
[in]	pNewKeyVersionList	[In] KeyVersionList of the key to be loaded.

◆ phKeyStore_GetKeyEntry()

phStatus_t phKeyStore_GetKeyEntry	(	void *	pDataParams,
		uint16_t	wKeyNo,
		uint16_t	wKeyVersionBufSize,
		uint16_t *	wKeyVersion,
		uint16_t *	wKeyVersionLength,
		uint16_t *	pKeyType
	)

Get a symmetric key entry information block.

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 key entry of interest.
[in]	wKeyVersionBufSize	[In] Buffer Size of wKeyVersion in Bytes.
[out]	wKeyVersion	[Out] Array for version information.
[out]	wKeyVersionLength	[Out] Length of valid data in wKeyVersion.
[out]	pKeyType	[Out] Type of the key.

◆ phKeyStore_GetKey()

phStatus_t phKeyStore_GetKey	(	void *	pDataParams,
		uint16_t	wKeyNo,
		uint16_t	wKeyVersion,
		uint8_t	bKeyBufSize,
		uint8_t *	pKey,
		uint16_t *	pKeyType
	)

Get a symmetric 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 key to be retrieved.
[in]	wKeyVersion	[In] Key version of the key to be retrieved.
[in]	bKeyBufSize	[In] Size of the key buffer.
[out]	pKey	[Out] Pointer to the key itself.
[out]	pKeyType	[Out] Type of the key.

Modules

Functions

Detailed Description

Function Documentation

◆ phKeyStore_SetKey()

◆ phKeyStore_SetKeyAtPos()

◆ phKeyStore_SetFullKeyEntry()

◆ phKeyStore_GetKeyEntry()

◆ phKeyStore_GetKey()