SSP Crypto Key Installation Framework

RTOS-integrated Crypto Key Installation Framework Module. More...

Data Structures
struct	sf_crypto_key_installation_instance_ctrl_t

Macros
#define	SF_CRYPTO_KEY_INSTALLATION_CODE_VERSION_MAJOR   (2U)

Functions
ssp_err_t	SF_CRYPTO_KEY_INSTALLATION_Open (sf_crypto_key_installation_ctrl_t *const p_api_ctrl, sf_crypto_key_installation_cfg_t const *const p_cfg)
	SSP Crypto Key Installation Framework Open operation. More...
ssp_err_t	SF_CRYPTO_KEY_INSTALLATION_Close (sf_crypto_key_installation_ctrl_t *const p_api_ctrl)
	SSP Crypto Key Installation Framework Close operation. More...
ssp_err_t	SF_CRYPTO_KEY_INSTALLATION_KeyInstall (sf_crypto_key_installation_ctrl_t *const p_api_ctrl, sf_crypto_data_handle_t const *const p_user_key_rsa_modulus, sf_crypto_data_handle_t const *const p_user_key_input, sf_crypto_key_installation_shared_index_t const shared_index_input, sf_crypto_data_handle_t const *const p_session_key_input, uint32_t const *const p_iv_input, sf_crypto_data_handle_t *const p_key_data_out)
	SSP Crypto Framework Key Installation operation. More...
ssp_err_t	SF_CRYPTO_KEY_INSTALLATION_VersionGet (ssp_version_t *const p_version)
	Gets driver version based on compile time macros. More...

Detailed Description

RTOS-integrated Crypto Key Installation Framework Module.

Macro Definition Documentation

SF_CRYPTO_KEY_INSTALLATION_CODE_VERSION_MAJOR

#define SF_CRYPTO_KEY_INSTALLATION_CODE_VERSION_MAJOR   (2U)

The API version of SSP Crypto Key Installation Framework

Function Documentation

SF_CRYPTO_KEY_INSTALLATION_Close()

ssp_err_t SF_CRYPTO_KEY_INSTALLATION_Close

(

sf_crypto_key_installation_ctrl_t *const

p_api_ctrl

)

SSP Crypto Key Installation Framework Close operation.

Return values

SSP_SUCCESS	The module was successfully closed.
SSP_ERR_ASSERTION	NULL is passed through the argument.
SSP_ERR_NOT_OPEN	The module has yet been opened. Call Open API first.

Returns

See Common Error Codes for other possible return codes.

Check if the Crypto Framework has been opened. If not yet opened, return an error.

Call HAL API to Close Key Installation HAL Driver

SF_CRYPTO_KEY_INSTALLATION_KeyInstall()

ssp_err_t SF_CRYPTO_KEY_INSTALLATION_KeyInstall	(	sf_crypto_key_installation_ctrl_t *const	p_api_ctrl,
		sf_crypto_data_handle_t const *const	p_user_key_rsa_modulus,
		sf_crypto_data_handle_t const *const	p_user_key_input,
		sf_crypto_key_installation_shared_index_t const	shared_index_input,
		sf_crypto_data_handle_t const *const	p_session_key_input,
		uint32_t const *const	p_iv_input,
		sf_crypto_data_handle_t *const	p_key_data_out
	)

SSP Crypto Framework Key Installation operation.

Return values

SSP_SUCCESS	The module created a key successfully.
SSP_ERR_ASSERTION	NULL is passed through an argument.
SSP_ERR_NOT_OPEN	The module has yet been opened. Call Open API first.
SSP_ERR_INVALID_ARGUMENT	At least one of the input arguments is invalid.
SSP_ERR_INVALID_SIZE	At least one of the buffers provided is of invalid size.

Returns

See Common Error Codes for other possible return codes.

Validate modulus and output buffers only in case of RSA key type.

Check if the Crypto Key Installation Framework has been opened. If not yet opened, return an error.

Call HAL API to perform Key Installation operation

SF_CRYPTO_KEY_INSTALLATION_Open()

ssp_err_t SF_CRYPTO_KEY_INSTALLATION_Open	(	sf_crypto_key_installation_ctrl_t *const	p_api_ctrl,
		sf_crypto_key_installation_cfg_t const *const	p_cfg
	)

SSP Crypto Key Installation Framework Open operation.

Return values

SSP_SUCCESS	The module was successfully opened.
SSP_ERR_ASSERTION	NULL is passed through an argument.
SSP_ERR_CRYPTO_COMMON_NOT_OPENED	Crypto Framework Common Module has yet been opened.
SSP_ERR_ALREADY_OPEN	The module has been already opened.
SSP_ERR_INVALID_ARGUMENT	The module does not support the key type specified by user.

Returns

See Common Error Codes for other possible return codes.

Check if the Crypto Framework has been opened. If not yet opened, return an error.

Check if SF Crypto Key Installation is already opened

Validate and copy configuration parameters to control block

Call HAL API to Open Key Installation HAL Driver

Set Key Installation Framework module status to Open

SF_CRYPTO_KEY_INSTALLATION_VersionGet()

ssp_err_t SF_CRYPTO_KEY_INSTALLATION_VersionGet

(

ssp_version_t *const

p_version

)

Gets driver version based on compile time macros.

Return values

SSP_SUCCESS	Successful close.
SSP_ERR_ASSERTION	The parameter p_version is NULL.