1587 lines
117 KiB
C
1587 lines
117 KiB
C
/**********************************************************************************************************************
|
|
* COPYRIGHT
|
|
* -------------------------------------------------------------------------------------------------------------------
|
|
* \verbatim
|
|
* Copyright (c) 2025 by Vector Informatik GmbH. All rights reserved.
|
|
*
|
|
* This software is copyright protected and proprietary to Vector Informatik GmbH.
|
|
* Vector Informatik GmbH grants to you only those rights as set out in the license conditions.
|
|
* All other rights remain with Vector Informatik GmbH.
|
|
* \endverbatim
|
|
* -------------------------------------------------------------------------------------------------------------------
|
|
* FILE DESCRIPTION
|
|
* -----------------------------------------------------------------------------------------------------------------*/
|
|
/*! \file Csm.h
|
|
* \brief MICROSAR Crypto Service Manager (CSM)
|
|
*
|
|
* \details Implementation of the MICROSAR Crypto Service Manager (CSM)
|
|
*
|
|
*********************************************************************************************************************/
|
|
|
|
/**********************************************************************************************************************
|
|
* REVISION HISTORY
|
|
* -------------------------------------------------------------------------------------------------------------------
|
|
* Version Date Author Change Id Description
|
|
* -------------------------------------------------------------------------------------------------------------------
|
|
* 01.00.00 2016-10-31 vismss Major rework for ASR 4.3
|
|
* 01.00.01 2016-12-06 vismss Adaption to the specification
|
|
* 01.00.02 2016-12-16 vismss ESCAN00093323 Correction of Csm_RandomGenerate
|
|
* 01.00.03 2017-01-04 vismss ESCAN00093383 Encapsulation of RTE related types
|
|
* 01.00.04 2017-01-12 vismss ESCAN00093703 Adaption of Csm_Types.h to the specification
|
|
* 01.01.00 2017-02-16 visgut FEATC-814 Support CSM 4.3
|
|
* Introduce Exclusive Areas to protect queue resources
|
|
* Add missing DET Checks
|
|
* Support Csm_CancelJob
|
|
* Remove lower layer queue handling structures from Csm_Types.h
|
|
* Remove declaration of Csm_MainFunction as will be declared in SchM_Csm.h
|
|
* 01.02.00 2017-05-05 vismss FEATC-1227 Added/Corrected Doxygen comments
|
|
* Adapted code to MISRA
|
|
* Adapted null pointer checks to operation modes
|
|
* Improved job queueing
|
|
* 01.02.01 2017-05-25 vismss ESCAN00095301 Correction of DET null pointer exceptions
|
|
* 01.03.00 2017-06-08 vismaw FEAT-2500 SafeBSW for CSM 4.3
|
|
* ESCAN00095452 Job sorting is only triggered during MainFunction
|
|
* ESCAN00094770 Csm_GetSizeOfJob() macro definition is missing if no job is configured
|
|
* 02.03.00 2017-08-22 visrpp ESCAN00096371 After cancellation, job is executed anyway or ECU results in
|
|
* unexpected behavior
|
|
* ESCAN00096373 Synchronous job is executed even if there were asynchronous jobs with
|
|
* higher priority queued before
|
|
* ESCAN00096489 Callbacks are not notified to the RTE
|
|
* 02.03.01 2018-03-13 visrpp ESCAN00097686 Added jobId to Crypto_JobType to increase compatibility to 3rd party
|
|
Crypto drivers
|
|
* ESCAN00098768 Jobs are not executed/passed to wrong channel if queue size is > 255
|
|
* 03.00.00 2018-08-03 vismaw STORYC-5809 Introduce pre-and post job callouts
|
|
* STORYC-5999 Process new async job in callback
|
|
* ESCAN00100309 Application is not notified if a queued job is rejected by CryIf
|
|
* ESCAN00099325 Compiler warning: Csm.c: '<' : signed/unsigned mismatch
|
|
* 03.01.00 2018-08-20 vismaw STORYC-6300 Misra 2012 for Csm
|
|
* 03.01.01 2018-10-23 vismwe ESCAN00100873 CryIf_CertificateVerify is called with wrong verifyCryIfKeyId
|
|
* 04.00.00 2018-11-07 vismaw STORYC-6542 Support redirection of input/output buffers from/to key elements
|
|
* STORYC-6545 Support partial key element copy
|
|
* 04.01.00 2019-03-06 vismaw STORYC-7653 Release of CSM 4.x
|
|
* 04.01.01 2019-06-28 vismaw ESCAN00102925 Crypto_JobType is not declared as specified in ASR 4.3.x
|
|
* 04.02.00 2019-07-25 vismaw SEC-675 Add possibility to configure const members of job type as var
|
|
* 05.00.00 2019-10-30 visenc SEC-21 Add Asynchronous Key Handling
|
|
* SEC-907 CSM SWC according ASR 4.4
|
|
* ESCAN00104302 Mapped Csm_ServiceToApiIdTable to CONST_8BIT memory section
|
|
* SEC-1001 Support ASR 4.4- and 4.5-style Callbacks
|
|
* 05.00.01 2020-01-20 visewl ESCAN00105342 Set operation mode for key management jobs always to single call
|
|
* ESCAN00105391 Resolve compiler warning that typedef name has already been declared
|
|
* ESCAN00105395 Resolve compiler warning that var. was declared but never referenced
|
|
* 2020-02-12 visewl ESCAN00105626 Resolve compiler errors due to possible loss of data using least types
|
|
* 05.01.00 2020-07-07 visrpp SEC-1454 Revised switches used for defining layout of Crypto_JobType structure
|
|
* SEC-1584 Reduce footprint through shared job objects
|
|
* SEC-1645 Call post job callout also for skipped synchronous jobs
|
|
* SEC-1655 Canceling of jobs according ASR 4.4
|
|
* ESCAN00105993 Add field input64 to Crypto_JobPrimitiveInputOutputType
|
|
* ESCAN00106799 Add CYRPTO_KE_KEYEXCHANGE_SHAREDVALUE with typo as defined in AUTOSAR
|
|
* 06.00.00 2021-01-20 vismxe SEC-1889 Update algorithm modes and families to AUTOSAR R20-11
|
|
* 06.01.00 2021-03-16 visenc SEC-2474 Save and restore context for running crypto operations
|
|
* ESCAN00108742 Execution of queued jobs might be delayed
|
|
* 06.01.01 2021-06-07 visrpp ESCAN00109411 Enqueued job might get lost
|
|
* 06.02.00 2021-11-25 visewl ESCAN00110824 Correct job state handling for asynchronous jobs
|
|
* ESCAN00110897 Free only shared job objects in callback function
|
|
* SEC-3604 Improve retriggering of asynchronous job processing
|
|
* 06.03.00 2022-03-10 visrpp SEC-4254 Speed up retriggering of asynchronous job if queue was empty
|
|
* 07.00.00 2023-01-18 visrpp SEC-5797 Use CRYPTO_E_BUSY instead of CRYPTO_E_QUEUE_FULL according ASR 4.4
|
|
* SEC-5476 Remove keyId parameter from JobKey APIs according ASR R21-11
|
|
* SEC-5478 CSM SWC according ASR R21-11
|
|
* SEC-5804 Adapt types according ASR R21-11 and move them to Crypto_GeneralTypes.h
|
|
* SEC-5472 Introduce APIs KeyGetStatus, KeySetInvalid and JobKeySetInvalid
|
|
* SEC-5802 Adapt error reporting to ASR R21/11
|
|
* SEC-4188 Finite Execution Time Analysis for Csm
|
|
* 07.01.00 2023-01-18 visrpp HSM-3724 Add multi-core/multi-partition support
|
|
* 07.02.00 2023-06-13 visfnn ESCAN00114839 Fix unreferenced variables
|
|
* HSM-4388 Rework Csm_InitMemory
|
|
* ESCAN00114847 Rename incorrect define CRYPTO_ALGOFAM_POLY13 to CRYPTO_ALGOFAM_POLY1305
|
|
* 07.02.01 2024-02-15 visrpp ESCAN00116232 Prefix swc interface error codes with CRYPTO_E starting from ASR R19-11
|
|
* vismwe ESCAN00115844 Avoid duplicated call of Csm_CallbackNotification during Csm_CancelJob
|
|
* vismwe CRY-508 Add CRYPTO_KEYSTATUS_UPDATE_IN_PROGRESS as value for KeyStatusType
|
|
* mapelt ESCAN00116539 Redirection might fail during asynchronous job processing
|
|
* main-1 2024-06-14 viseag CRY-715 Change history is maintained in the global ChangeHistory.txt file
|
|
* starting with this release.
|
|
*********************************************************************************************************************/
|
|
|
|
#if !defined (CSM_H)
|
|
# define CSM_H
|
|
|
|
/**********************************************************************************************************************
|
|
* INCLUDES
|
|
*********************************************************************************************************************/
|
|
# include "Csm_Cfg.h"
|
|
# include "Csm_Cbk.h"
|
|
|
|
/**********************************************************************************************************************
|
|
* GLOBAL CONSTANT MACROS
|
|
*********************************************************************************************************************/
|
|
|
|
/* Vendor and module identification */
|
|
# define CSM_VENDOR_ID (30u)
|
|
# define CSM_MODULE_ID (110u)
|
|
# define CSM_INSTANCE_ID (0u)
|
|
|
|
/* AUTOSAR Software specification version information */
|
|
# define CSM_AR_RELEASE_MAJOR_VERSION (0x04u)
|
|
# define CSM_AR_RELEASE_MINOR_VERSION (0x07u)
|
|
# define CSM_AR_RELEASE_REVISION_VERSION (0x00u)
|
|
|
|
/* ----- Component version information (decimal version of ALM implementation package) ----- */
|
|
# define CSM_SW_MAJOR_VERSION (9u)
|
|
# define CSM_SW_MINOR_VERSION (1u)
|
|
# define CSM_SW_PATCH_VERSION (1u)
|
|
|
|
/* ----- API service IDs ----- */
|
|
/* Service ID: Csm_Init() */
|
|
# define CSM_INIT_ID (0x00u)
|
|
/* Service ID: Csm_MainFunction() */
|
|
# define CSM_MAINFUNCTION_ID (0x01u)
|
|
/* Service ID: Csm_GetVersionInfo() */
|
|
# define CSM_GETVERSIONINFO_ID (0x3Bu)
|
|
/* Service ID: Csm_KeyElementSet() */
|
|
# define CSM_KEYELEMENTSET_ID (0x78u)
|
|
/* Service ID: Csm_KeySetValid() */
|
|
# define CSM_KEYSETVALID_ID (0x67u)
|
|
/* Service ID: Csm_JobKeySetValid() */
|
|
# define CSM_JOBKEYSETVALID_ID (0x7Au)
|
|
/* Service ID: Csm_KeySetInvalid() */
|
|
# define CSM_KEYSETINVALID_ID (0x85u)
|
|
/* Service ID: Csm_JobKeySetInvalid() */
|
|
# define CSM_JOBKEYSETINVALID_ID (0x84u)
|
|
/* Service ID: Csm_KeyGetStatus() */
|
|
# define CSM_KEYGETSTATUS_ID (0x83u)
|
|
/* Service ID: Csm_KeyElementGet() */
|
|
# define CSM_KEYELEMENTGET_ID (0x68u)
|
|
/* Service ID: Csm_KeyElementCopy() */
|
|
# define CSM_KEYELEMENTCOPY_ID (0x71u)
|
|
/* Service ID: Csm_KeyElementCopyPartial() */
|
|
# define CSM_KEYELEMENTCOPYPARTIAL_ID (0x79u)
|
|
/* Service ID: Csm_KeyCopy() */
|
|
# define CSM_KEYCOPY_ID (0x73u)
|
|
/* Service ID: Csm_RandomSeed() */
|
|
# define CSM_RANDOMSEED_ID (0x69u)
|
|
/* Service ID: Csm_JobRandomSeed() */
|
|
# define CSM_JOBRANDOMSEED_ID (0x7Bu)
|
|
/* Service ID: Csm_KeyGenerate() */
|
|
# define CSM_KEYGENERATE_ID (0x6Au)
|
|
/* Service ID: Csm_JobKeyGenerate() */
|
|
# define CSM_JOBKEYGENERATE_ID (0x7Cu)
|
|
/* Service ID: Csm_KeyDerive() */
|
|
# define CSM_KEYDERIVE_ID (0x6Bu)
|
|
/* Service ID: Csm_JobKeyDerive() */
|
|
# define CSM_JOBKEYDERIVE_ID (0x7Du)
|
|
/* Service ID: Csm_KeyExchangeCalcPubVal() */
|
|
# define CSM_KEYEXCHANGECALCPUBVAL_ID (0x6Cu)
|
|
/* Service ID: Csm_JobKeyExchangeCalcPubVal() */
|
|
# define CSM_JOBKEYEXCHANGECALCPUBVAL_ID (0x7Eu)
|
|
/* Service ID: Csm_KeyExchangeCalcSecret() */
|
|
# define CSM_KEYEXCHANGECALCSECRET_ID (0x6Du)
|
|
/* Service ID: Csm_JobKeyExchangeCalcSecret() */
|
|
# define CSM_JOBKEYEXCHANGECALCSECRET_ID (0x7Fu)
|
|
/* Service ID: Csm_CertificateParse() */
|
|
# define CSM_CERTIFICATEPARSE_ID (0x6Eu)
|
|
/* Service ID: Csm_CertificateVerify() */
|
|
# define CSM_CERTIFICATEVERIFY_ID (0x74u)
|
|
/* Service ID: Csm_Hash() */
|
|
# define CSM_HASH_ID (0x5Du)
|
|
/* Service ID: Csm_MacGenerate() */
|
|
# define CSM_MACGENERATE_ID (0x60u)
|
|
/* Service ID: Csm_MacVerify() */
|
|
# define CSM_MACVERIFY_ID (0x61u)
|
|
/* Service ID: Csm_Encrypt() */
|
|
# define CSM_ENCRYPT_ID (0x5Eu)
|
|
/* Service ID: Csm_Decrypt() */
|
|
# define CSM_DECRYPT_ID (0x5Fu)
|
|
/* Service ID: Csm_AEADEncrypt() */
|
|
# define CSM_AEADENCRYPT_ID (0x62u)
|
|
/* Service ID: Csm_AEADDecrypt() */
|
|
# define CSM_AEADDECRYPT_ID (0x63u)
|
|
/* Service ID: Csm_SignatureGenerate() */
|
|
# define CSM_SIGNATUREGENERATE_ID (0x76u)
|
|
/* Service ID: Csm_SignatureVerify() */
|
|
# define CSM_SIGNATUREVERIFY_ID (0x64u)
|
|
/* Service ID: Csm_SecureCounterIncrement() */
|
|
# define CSM_SECURECOUNTERINCREMENT_ID (0x65u)
|
|
/* Service ID: Csm_SecureCounterRead() */
|
|
# define CSM_SECURECOUNTERREAD_ID (0x66u)
|
|
/* Service ID: Csm_RandomGenerate() */
|
|
# define CSM_RANDOMGENERATE_ID (0x72u)
|
|
/* Service ID: Csm_CancelJob() */
|
|
# define CSM_CANCELJOB_ID (0x6Fu)
|
|
/* Service ID: Csm_CallbackNotification() */
|
|
# define CSM_CALLBACKNOTIFICATION_ID (0x70u)
|
|
/* Service ID: Csm_SaveContextJob() */
|
|
# define CSM_SAVECONTEXTJOB_ID (0x86u)
|
|
/* Service ID: Csm_RestoreContextJob() */
|
|
# define CSM_RESTORECONTEXTJOB_ID (0x87u)
|
|
/* Service ID: Csm_JobKeyWrap() */
|
|
# define CSM_JOBKEYWRAP_ID (0x89u)
|
|
/* Service ID: Csm_JobKeyUnwrap() */
|
|
# define CSM_JOBKEYUNWRAP_ID (0x8Au)
|
|
/* Service ID: This id is notified to DET if e.g. an error occurs during
|
|
job processing which is not related to a specific API. */
|
|
# define CSM_GENERIC_JOB_PROCESSING_ID (0xFFu)
|
|
|
|
/* ----- Error codes ----- */
|
|
/* Error Code: Used to check if no error occurred */
|
|
# define CSM_E_NO_ERROR (0x00u)
|
|
/* Error Code: API request called with invalid parameter (null pointer) */
|
|
# define CSM_E_PARAM_POINTER (0x01u)
|
|
/* Error Code: API request called with invalid parameter (invalid method for selected service) */
|
|
# define CSM_E_PARAM_METHOD_INVALID (0x03u)
|
|
/* Error Code: API request called with Csm configuration ID out of range */
|
|
# define CSM_E_PARAM_HANDLE (0x04u)
|
|
/* Error Code: API request called before initialization of CSM module */
|
|
# define CSM_E_UNINIT (0x05u)
|
|
/* Error Code: Initialization of CSM module failed */
|
|
# define CSM_E_INIT_FAILED (0x07u)
|
|
/* Error Code: API request called with invalid processing mode */
|
|
# define CSM_E_PROCESSING_MODE (0x08u)
|
|
/* Error Code: Mismatch between the called API request and the service type of the job */
|
|
# define CSM_E_SERVICE_TYPE (0x09u)
|
|
/* Error code: The service Csm_Init() is called while the module is already initialized */
|
|
# define CSM_E_ALREADY_INITIALIZED (0x11u)
|
|
/* Error code: API request called on wrong partition */
|
|
# define CSM_E_INVALID_PARTITION (0x12u)
|
|
|
|
/* Runtime Error code: Queue overrun - More jobs have been requested than the queue can store */
|
|
# define CSM_E_QUEUE_FULL (0x01u)
|
|
/* Runtime Error code: Unexpected callback from lower layer */
|
|
# define CSM_E_UNEXPECTED_CALLBACK (0x81u)
|
|
|
|
/* ----- Modes ----- */
|
|
/* State: Uninitialized */
|
|
# define CSM_UNINIT (0x00u)
|
|
/* State: Initialized */
|
|
# define CSM_INITIALIZED (0x01u)
|
|
|
|
# define CSM_CALLOUT_STATE_IDLE (0x00u)
|
|
# define CSM_CALLOUT_STATE_PRE_INITIAL (0x01u)
|
|
# define CSM_CALLOUT_STATE_PRE_PENDING (0x02u)
|
|
# define CSM_CALLOUT_STATE_PROCESSING (0x03u)
|
|
# define CSM_CALLOUT_STATE_PROCESSING_ABORTED_BY_CALLOUT (0x04u)
|
|
# define CSM_CALLOUT_STATE_POST_INITIAL (0x05u)
|
|
# define CSM_CALLOUT_STATE_POST_PENDING (0x06u)
|
|
|
|
/**********************************************************************************************************************
|
|
* GLOBAL FUNCTION MACROS
|
|
*********************************************************************************************************************/
|
|
|
|
/**********************************************************************************************************************
|
|
* GLOBAL DATA TYPES AND STRUCTURES
|
|
*********************************************************************************************************************/
|
|
|
|
/**********************************************************************************************************************
|
|
* GLOBAL DATA PROTOTYPES
|
|
*********************************************************************************************************************/
|
|
|
|
/**********************************************************************************************************************
|
|
* GLOBAL FUNCTION PROTOTYPES
|
|
*********************************************************************************************************************/
|
|
|
|
# define CSM_START_SEC_CODE
|
|
# include "MemMap.h" /* PRQA S 5087 */ /* MD_MSR_MemMap */
|
|
|
|
/* General Function Prototypes */
|
|
/**********************************************************************************************************************
|
|
* Csm_Init()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Initializes the CSM module.
|
|
* \details Set all service states to initial idle.
|
|
* \pre None
|
|
* \context TASK
|
|
* \reentrant FALSE
|
|
* \synchronous TRUE
|
|
*********************************************************************************************************************/
|
|
FUNC(void, CSM_CODE) Csm_Init(void);
|
|
|
|
# if (CSM_VERSION_INFO_API == STD_ON)
|
|
/**********************************************************************************************************************
|
|
* Csm_GetVersionInfo()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Returns the version information of this module.
|
|
* \details Stores version information, i.e. Module Id, Vendor Id, Vendor specific version numbers to structure
|
|
* pointed by versioninfo.
|
|
* \param[out] versioninfo Pointer where the version info data shall be stored.
|
|
* \pre GetVersionInfo API is enabled via pre-compile configuration.
|
|
* \context TASK
|
|
* \reentrant TRUE
|
|
* \synchronous TRUE
|
|
* \trace CREQ-129269
|
|
*********************************************************************************************************************/
|
|
FUNC(void, CSM_CODE) Csm_GetVersionInfo(P2VAR(Std_VersionInfoType, AUTOMATIC, CSM_APPL_VAR) versioninfo);
|
|
# endif /* (CSM_VERSION_INFO_API == STD_ON) */
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_CancelJob()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Cancels the job processing from asynchronous or streaming jobs.
|
|
* \details Removes the job in the Csm Queue and calls the job's callback with the result
|
|
* CRYPTO_E_JOB_CANCELED. It also passes the cancellation command to the
|
|
* CryIf to try to cancel the job in the Crypto Driver.
|
|
* \param[in] jobId Holds the identifier of the job using the CSM service.
|
|
* \param[in] mode Not used, just for interface compatibility provided
|
|
* \return E_OK Request successful - Job was cancelled or was already Idle
|
|
* E_NOT_OK Request failed - Job could not be cancelled
|
|
* CRYPTO_E_JOB_CANCELED Request pending - Job will be cancelled with next callback notification
|
|
* \pre -
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same jobId (will be rejected with E_NOT_OK)
|
|
* \synchronous TRUE
|
|
* \note For cancellation of asynchronous jobs the application must be able to handle two callbacks.
|
|
* It is possible that the normal job callback notification will be called while cancelling.
|
|
* The cancel callback notification can be identified by contained result CRYPTO_E_JOB_CANCELED.
|
|
* \trace CREQ-129244
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_CancelJob(uint32 jobId, Crypto_OperationModeType mode);
|
|
|
|
/* Key Management Function Prototypes */
|
|
/**********************************************************************************************************************
|
|
* Csm_KeyElementSet()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Sets the given key element bytes to the key identified by keyId.
|
|
* \details If the values of a key element are modified with Csm_KeyElementSet(), the key needs to be
|
|
* re-validated by calling Csm_KeySetValid() before using it for a cryptographic operation.
|
|
* \param[in] keyId Holds the identifier of the key for which a new material shall be set.
|
|
* \param[in] keyElementId Holds the identifier of the key element to be written.
|
|
* \param[in] keyPtr Holds the pointer to the key element bytes to be processed.
|
|
* \param[in] keyLength Contains the number of key element bytes.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, Crypto Driver Object is busy
|
|
* CRYPTO_E_KEY_WRITE_FAIL Request failed because write access was denied.
|
|
* CRYPTO_E_KEY_NOT_AVAILABLE Request failed because the key is not available
|
|
* CRYPTO_E_KEY_SIZE_MISMATCH Request failed, key element size does not match size of provided data.
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same keyId
|
|
* \synchronous TRUE
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-129256
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_KeyElementSet(uint32 keyId,
|
|
uint32 keyElementId,
|
|
P2CONST(uint8, AUTOMATIC, CSM_APPL_VAR) keyPtr,
|
|
uint32 keyLength);
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_KeySetValid()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Sets the key state of the key identified by keyId to valid.
|
|
* \details -
|
|
* \param[in] keyId Holds the identifier of the key for which a new material shall be validated.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, Crypto Driver Object is busy
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same keyId
|
|
* \synchronous TRUE
|
|
* \pre -
|
|
* \trace CREQ-129255
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_KeySetValid(uint32 keyId);
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_KeySetInvalid()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Sets the key status to invalid. The key cannot be used any longer for cryptographic operations
|
|
* until it has been set to valid state again.
|
|
* \details -
|
|
* \param[in] keyId Holds the identifier of the key which shall be invalidated.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, Crypto Driver Object is busy
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same keyId
|
|
* \synchronous TRUE
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-3000000
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_KeySetInvalid(uint32 keyId);
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_KeyGetStatus()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Returns the key state of the key identified by keyId.
|
|
* \details -
|
|
* \param[in] keyId Holds the identifier of the key for which the key state shall be returned.
|
|
* \param[out] keyStatusPtr Contains the pointer to the data where the status of the key shall be stored.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same keyId
|
|
* \synchronous TRUE
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-3000001
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_KeyGetStatus(uint32 keyId, P2VAR(Crypto_KeyStatusType, AUTOMATIC, CSM_APPL_VAR) keyStatusPtr);
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_KeyElementGet()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Retrieves the key element bytes from a specific key element of the key identified by the keyId and
|
|
* stores the key element in the memory location pointed by the key pointer.
|
|
* \details -
|
|
* \param[in] keyId Holds the identifier of the key from which a key element shall be
|
|
* extracted.
|
|
* \param[in] keyElementId Holds the identifier of the key element to be extracted.
|
|
* \param[out] keyPtr Holds the pointer to the memory location where the key shall be copied
|
|
* to.
|
|
* \param[in,out] keyLengthPtr Holds a pointer to the memory location in which the output buffer length
|
|
* in bytes is stored. On calling this function, this parameter shall
|
|
* contain the buffer length in bytes of the keyPtr. When the request has
|
|
* finished, the actual size of the written input bytes shall be stored.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, Crypto Driver Object is busy
|
|
* CRYPTO_E_KEY_READ_FAIL Request failed because read access was denied
|
|
* CRYPTO_E_KEY_NOT_AVAILABLE Request failed because the key is not available
|
|
* CRYPTO_E_KEY_EMPTY Request failed because of uninitialized source key element
|
|
* CRYPTO_E_SMALL_BUFFER The provided buffer is too small to store the result
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same keyId
|
|
* \synchronous TRUE
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-129254
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_KeyElementGet(uint32 keyId,
|
|
uint32 keyElementId,
|
|
P2VAR(uint8, AUTOMATIC, CSM_APPL_VAR) keyPtr,
|
|
P2VAR(uint32, AUTOMATIC, CSM_APPL_VAR) keyLengthPtr);
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_KeyElementCopy()
|
|
*********************************************************************************************************************/
|
|
/*! \brief This function shall copy a key elements from one key to a target key.
|
|
* \details -
|
|
* \param[in] keyId Holds the identifier of the key whose key element shall be the source
|
|
* element.
|
|
* \param[in] keyElementId Holds the identifier of the key element which shall be the source for
|
|
* the copy operation.
|
|
* \param[in] targetKeyId Holds the identifier of the key whose key element shall be the
|
|
* destination element.
|
|
* \param[in] targetKeyElementId Holds the identifier of the key element which shall be the destination
|
|
* for the copy operation.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, Crypto Driver Object is busy
|
|
* CRYPTO_E_KEY_READ_FAIL Request failed because read access was denied
|
|
* CRYPTO_E_KEY_WRITE_FAIL Request failed because write access was denied
|
|
* CRYPTO_E_KEY_NOT_AVAILABLE Request failed because the key is not available
|
|
* CRYPTO_E_KEY_SIZE_MISMATCH Request failed, key element sizes are not compatible
|
|
* CRYPTO_E_KEY_EMPTY Request failed because of uninitialized source key element
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same keyId
|
|
* \synchronous TRUE
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-129253
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_KeyElementCopy(uint32 keyId,
|
|
uint32 keyElementId,
|
|
uint32 targetKeyId,
|
|
uint32 targetKeyElementId);
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_KeyElementCopyPartial()
|
|
*********************************************************************************************************************/
|
|
/*! \brief This function copies a key element partially from one key to a target key.
|
|
* \details The function copies a specific chunk of the source key element to a specific location of the target key.
|
|
* The locations are given through the parameters.
|
|
* \param[in] keyId Holds the identifier of the key whose key element shall be the source
|
|
* element.
|
|
* \param[in] keyElementId Holds the identifier of the key element which shall be the source for the
|
|
* copy operation.
|
|
* \param[in] keyElementSourceOffset This is the offset of the source key element indicating the start index
|
|
* of the copy operation.
|
|
* \param[in] keyElementTargetOffset This is the offset of the destination key element indicating the start index
|
|
* of the copy operation.
|
|
* \param[in] keyElementCopyLength Specifies the number of bytes that shall be copied.
|
|
* \param[in] targetKeyId Holds the identifier of the key whose key element shall be the destination
|
|
* element.
|
|
* \param[in] targetKeyElementId Holds the identifier of the key element which shall be the destination for
|
|
* the copy operation.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, Crypto Driver Object is busy
|
|
* CRYPTO_E_KEY_READ_FAIL Request failed because read access was denied
|
|
* CRYPTO_E_KEY_WRITE_FAIL Request failed because write access was denied
|
|
* CRYPTO_E_KEY_NOT_AVAILABLE Request failed because the key is not available
|
|
* CRYPTO_E_KEY_SIZE_MISMATCH Request failed, key element sizes are not compatible
|
|
* CRYPTO_E_KEY_EMPTY Request failed because of uninitialized source key element
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same keyId
|
|
* \synchronous TRUE
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-185644
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_KeyElementCopyPartial(uint32 keyId,
|
|
uint32 keyElementId,
|
|
uint32 keyElementSourceOffset,
|
|
uint32 keyElementTargetOffset,
|
|
uint32 keyElementCopyLength,
|
|
uint32 targetKeyId,
|
|
uint32 targetKeyElementId);
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_KeyCopy()
|
|
*********************************************************************************************************************/
|
|
/*! \brief This function shall copy all key elements from the source key to a target key.
|
|
* \details -
|
|
* \param[in] keyId Holds the identifier of the key whose key element shall be the source
|
|
* element.
|
|
* \param[in] targetKeyId Holds the identifier of the key whose key element shall be the
|
|
* destination element.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, Crypto Driver Object is busy
|
|
* CRYPTO_E_KEY_READ_FAIL Request failed because read access was denied
|
|
* CRYPTO_E_KEY_WRITE_FAIL Request failed because write access was denied
|
|
* CRYPTO_E_KEY_NOT_AVAILABLE Request failed because the key is not available
|
|
* CRYPTO_E_KEY_SIZE_MISMATCH Request failed, key element size does not match size of provided data
|
|
* CRYPTO_E_KEY_EMPTY Request failed because of uninitialized source key element
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same keyId
|
|
* \synchronous TRUE
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-129252
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_KeyCopy(uint32 keyId,
|
|
uint32 targetKeyId);
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_RandomSeed()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Feeds the key element CRYPTO_KE_RANDOM_SEED with a random seed.
|
|
* \details -
|
|
* \param[in] keyId Holds the identifier of the key for which a new seed shall be generated.
|
|
* \param[in] seedPtr Holds a pointer to the memory location which contains the data to feed the
|
|
* seed.
|
|
* \param[in] seedLength Contains the length of the seed in bytes.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, Crypto Driver Object is busy
|
|
* CRYPTO_E_KEY_NOT_VALID Request failed, the key's state is "invalid"
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same keyId
|
|
* \synchronous TRUE
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-129251
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_RandomSeed(uint32 keyId,
|
|
P2CONST(uint8, AUTOMATIC, CSM_APPL_VAR) seedPtr,
|
|
uint32 seedLength);
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_KeyGenerate()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Generates new key material and store it in the key identified by keyId.
|
|
* \details -
|
|
* \param[in] keyId Holds the identifier of the key for which a new material shall be generated.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, Crypto Driver Object is busy
|
|
* CRYPTO_E_KEY_NOT_VALID Request failed, the key's state is "invalid"
|
|
* CRYPTO_E_KEY_EMPTY Request failed because of uninitialized source key element
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same keyId
|
|
* \synchronous TRUE
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-129250
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_KeyGenerate(uint32 keyId);
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_KeyDerive()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Derives a new key by using the key elements in the given key identified by the keyId. The given key
|
|
* contains the key elements for the password and salt. The derived key is stored in the key element
|
|
* with the id 1 of the key identified by targetCryptoKeyId.
|
|
* \details -
|
|
* \param[in] keyId Holds the identifier of the key which is used for key derivation.
|
|
* \param[in] targetKeyId Holds the identifier of the key which is used to store the derived key.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, service is busy or queue is full
|
|
* CRYPTO_E_KEY_READ_FAIL Request failed, not allowed to extract key element
|
|
* CRYPTO_E_KEY_WRITE_FAIL Request failed, not allowed to write key element
|
|
* CRYPTO_E_KEY_NOT_VALID Request failed, the key's state is "invalid"
|
|
* CRYPTO_E_KEY_SIZE_MISMATCH Request failed, key element sizes are not compatible
|
|
* CRYPTO_E_KEY_EMPTY Request failed because of uninitialized source key element
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same keyId
|
|
* \synchronous TRUE
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-129249
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_KeyDerive(uint32 keyId,
|
|
uint32 targetKeyId);
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_KeyExchangeCalcPubVal()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Calculates the public value of the current user for the key exchange and stores the public key in
|
|
* the memory location pointed by the public value pointer.
|
|
* \details -
|
|
* \param[in] keyId Holds the identifier of the key which shall be used for the key exchange
|
|
* protocol.
|
|
* \param[out] publicValuePtr Contains the pointer to the data where the public value shall be stored.
|
|
* \param[in,out] publicValueLengthPtr Holds a pointer to the memory location in which the public value length
|
|
* information is stored. On calling this function, this parameter shall
|
|
* contain the size of the buffer provided by publicValuePtr. When the request
|
|
* has finished, the actual length of the returned value shall be stored.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, Crypto Driver Object is busy
|
|
* CRYPTO_E_KEY_NOT_VALID Request failed, the key's state is "invalid"
|
|
* CRYPTO_E_KEY_EMPTY Request failed because of uninitialized source key element
|
|
* CRYPTO_E_SMALL_BUFFER Request failed because the provided buffer is too small to store the result
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same keyId
|
|
* \synchronous TRUE
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-129248
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_KeyExchangeCalcPubVal(uint32 keyId,
|
|
P2VAR(uint8, AUTOMATIC, CSM_APPL_VAR) publicValuePtr,
|
|
P2VAR(uint32, AUTOMATIC, CSM_APPL_VAR) publicValueLengthPtr);
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_KeyExchangeCalcSecret()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Calculates the shared secret key for the key exchange with the key material of the key identified by
|
|
* the keyId and the partner public key. The shared secret key is stored as a key element in the same
|
|
* key.
|
|
* \details -
|
|
* \param[in] keyId Holds the identifier of the key which shall be used for the key exchange
|
|
* protocol.
|
|
* \param[in] partnerPublicValuePtr Holds the pointer to the memory location which contains the partner's
|
|
* public value.
|
|
* \param[in] partnerPublicValueLength Contains the length of the partner's public value in bytes.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, service is busy or queue is full
|
|
* CRYPTO_E_KEY_NOT_VALID Request failed, the key's state is "invalid"
|
|
* CRYPTO_E_KEY_EMPTY Request failed because of uninitialized source key element
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same keyId
|
|
* \synchronous TRUE
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-129247
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_KeyExchangeCalcSecret(uint32 keyId,
|
|
P2CONST(uint8, AUTOMATIC, CSM_APPL_VAR) partnerPublicValuePtr,
|
|
uint32 partnerPublicValueLength);
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_CertificateParse()
|
|
*********************************************************************************************************************/
|
|
/*! \brief This function shall dispatch the certificate parse function to the CryIf.
|
|
* \details -
|
|
* \param[in] keyId Holds the identifier of the key to be used for the certificate parsing.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, Crypto Driver Object is busy
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same keyId
|
|
* \synchronous TRUE
|
|
* \pre -
|
|
* \trace CREQ-129246
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_CertificateParse(uint32 keyId);
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_CertificateVerify()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Verifies the certificate stored in the key referenced by verifyKeyId with the certificate stored in
|
|
* the key referenced by keyId. Note: Only certificates stored in the same Crypto Driver can be
|
|
* verified against each other. If the key element CRYPTO_KE_CERTIFICATE_CURRENT_TIME is used for the
|
|
* verification of the validity period of the certificate identified by verifyKeyId, it shall have the
|
|
* same format as the timestamp in the certificate.
|
|
* \details -
|
|
* \param[in] keyId Holds the identifier of the key which shall be used to validate the certificate.
|
|
* \param[in] verifyKeyId Holds the identifier of the key containing the certificate to be verified.
|
|
* \param[out] verifyPtr Holds a pointer to the memory location which will contain the result of the certificate
|
|
* verification.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, Crypto Driver Object is busy
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same keyId
|
|
* \synchronous TRUE
|
|
* \pre -
|
|
* \trace CREQ-129245
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_CertificateVerify(uint32 keyId,
|
|
uint32 verifyKeyId,
|
|
P2VAR(Crypto_VerifyResultType, AUTOMATIC, CSM_APPL_VAR) verifyPtr);
|
|
|
|
/* CSM Service Function Prototypes */
|
|
/**********************************************************************************************************************
|
|
* Csm_Hash()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Uses the given data to perform the hash calculation and stores the hash in the memory location
|
|
* pointed to by the result pointer.
|
|
* \details -
|
|
* \param[in] jobId Holds the identifier of the job using the CSM service.
|
|
* \param[in] mode Indicates which operation mode(s) to perform.
|
|
* \param[in] dataPtr Contains the pointer to the data for which the hash shall be computed.
|
|
* \param[in] dataLength Contains the number of bytes to be hashed.
|
|
* \param[out] resultPtr Contains the pointer to the data where the hash value shall be stored.
|
|
* \param[in,out] resultLengthPtr Holds a pointer to the memory location in which the output length in bytes is
|
|
* stored. On calling this function, this parameter shall contain the size of the
|
|
* buffer provided by resultPtr. When the request has finished, the actual length of
|
|
* the returned value shall be stored.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, service is busy or queue is full
|
|
* CRYPTO_E_SMALL_BUFFER The provided buffer is too small to store the result
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same jobId (will be rejected with CRYPTO_E_BUSY)
|
|
* \synchronous TRUE|FALSE Depends on given job.
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-129268
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_Hash(uint32 jobId,
|
|
Crypto_OperationModeType mode,
|
|
P2CONST(uint8, AUTOMATIC, CSM_APPL_VAR) dataPtr,
|
|
uint32 dataLength,
|
|
P2VAR(uint8, AUTOMATIC, CSM_APPL_VAR) resultPtr,
|
|
P2VAR(uint32, AUTOMATIC, CSM_APPL_VAR) resultLengthPtr);
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_MacGenerate()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Uses the given data to perform a MAC generation and stores the MAC in the memory location pointed to
|
|
* by the MAC pointer.
|
|
* \details -
|
|
* \param[in] jobId Holds the identifier of the job using the CSM service.
|
|
* \param[in] mode Indicates which operation mode(s) to perform.
|
|
* \param[in] dataPtr Contains the pointer to the data for which the MAC shall be computed.
|
|
* \param[in] dataLength Contains the number of bytes for the MAC generation.
|
|
* \param[out] macPtr Contains the pointer to the data where the MAC shall be stored.
|
|
* \param[in,out] macLengthPtr Holds a pointer to the memory location in which the output length in bytes is
|
|
* stored. On calling this function, this parameter shall contain the size of the
|
|
* buffer provided by macPtr. When the request has finished, the actual length of
|
|
* the returned MAC shall be stored.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, service is busy or queue is full
|
|
* CRYPTO_E_KEY_NOT_VALID Request failed, the key's state is "invalid"
|
|
* CRYPTO_E_KEY_SIZE_MISMATCH Request failed, key element sizes are not compatible
|
|
* CRYPTO_E_KEY_EMPTY Request failed because of uninitialized source key element
|
|
* CRYPTO_E_SMALL_BUFFER The provided buffer is too small to store the result
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same jobId (will be rejected with CRYPTO_E_BUSY)
|
|
* \synchronous TRUE|FALSE Depends on given job.
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_MacGenerate(uint32 jobId,
|
|
Crypto_OperationModeType mode,
|
|
P2CONST(uint8, AUTOMATIC, CSM_APPL_VAR) dataPtr,
|
|
uint32 dataLength,
|
|
P2VAR(uint8, AUTOMATIC, CSM_APPL_VAR) macPtr,
|
|
P2VAR(uint32, AUTOMATIC, CSM_APPL_VAR) macLengthPtr);
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_MacVerify()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Verifies the given MAC by comparing if the MAC is generated with the given data.
|
|
* \details -
|
|
* \param[in] jobId Holds the identifier of the job using the CSM service.
|
|
* \param[in] mode Indicates which operation mode(s) to perform.
|
|
* \param[in] dataPtr Contains the pointer to the data for which the MAC shall be verified.
|
|
* \param[in] dataLength Contains the number of data bytes for which the MAC shall be verified.
|
|
* \param[in] macPtr Holds a pointer to the MAC to be verified.
|
|
* \param[in] macLength Contains the MAC length in BITS to be verified.
|
|
* \param[out] verifyPtr Holds a pointer to the memory location, which will hold the result of the MAC
|
|
* verification.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, service is busy or queue is full
|
|
* CRYPTO_E_KEY_NOT_VALID Request failed, the key's state is "invalid"
|
|
* CRYPTO_E_KEY_SIZE_MISMATCH Request failed, key element sizes are not compatible
|
|
* CRYPTO_E_KEY_EMPTY Request failed because of uninitialized source key element
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same jobId (will be rejected with CRYPTO_E_BUSY)
|
|
* \synchronous TRUE|FALSE Depends on given job.
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_MacVerify(uint32 jobId,
|
|
Crypto_OperationModeType mode,
|
|
P2CONST(uint8, AUTOMATIC, CSM_APPL_VAR) dataPtr,
|
|
uint32 dataLength,
|
|
P2CONST(uint8, AUTOMATIC, CSM_APPL_VAR) macPtr,
|
|
uint32 macLength,
|
|
P2VAR(Crypto_VerifyResultType, AUTOMATIC, CSM_APPL_VAR) verifyPtr);
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_Encrypt()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Encrypts the given data and store the ciphertext in the memory location pointed by the result
|
|
* pointer.
|
|
* \details -
|
|
* \param[in] jobId Holds the identifier of the job using the CSM service.
|
|
* \param[in] mode Indicates which operation mode(s) to perform.
|
|
* \param[in] dataPtr Contains the pointer to the data to be encrypted.
|
|
* \param[in] dataLength Contains the number of bytes to encrypt.
|
|
* \param[out] resultPtr Contains the pointer to the data where the encrypted data shall be stored.
|
|
* \param[in,out] resultLengthPtr Holds a pointer to the memory location in which the output length information is
|
|
* stored in bytes. On calling this function, this parameter shall contain the size
|
|
* of the buffer provided by resultPtr. When the request has finished, the actual
|
|
* length of the returned value shall be stored.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, service is busy or queue is full
|
|
* CRYPTO_E_KEY_NOT_VALID Request failed, the key's state is "invalid"
|
|
* CRYPTO_E_KEY_SIZE_MISMATCH Request failed, key element sizes are not compatible
|
|
* CRYPTO_E_KEY_EMPTY Request failed because of uninitialized source key element
|
|
* CRYPTO_E_SMALL_BUFFER The provided buffer is too small to store the result
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same jobId (will be rejected with CRYPTO_E_BUSY)
|
|
* \synchronous TRUE|FALSE Depends on given job.
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-129265
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_Encrypt(uint32 jobId,
|
|
Crypto_OperationModeType mode,
|
|
P2CONST(uint8, AUTOMATIC, CSM_APPL_VAR) dataPtr,
|
|
uint32 dataLength,
|
|
P2VAR(uint8, AUTOMATIC, CSM_APPL_VAR) resultPtr,
|
|
P2VAR(uint32, AUTOMATIC, CSM_APPL_VAR) resultLengthPtr);
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_Decrypt()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Decrypts the given encrypted data and store the decrypted plaintext in the memory location pointed
|
|
* by the result pointer.
|
|
* \details -
|
|
* \param[in] jobId Holds the identifier of the job using the CSM service.
|
|
* \param[in] mode Indicates which operation mode(s) to perform.
|
|
* \param[in] dataPtr Contains the pointer to the data to be decrypted.
|
|
* \param[in] dataLength Contains the number of bytes to decrypt.
|
|
* \param[out] resultPtr Contains the pointer to the data where the decrypted data shall be stored.
|
|
* \param[in,out] resultLengthPtr Holds a pointer to the memory location in which the output length information is
|
|
* stored in bytes. On calling this function, this parameter shall contain the size
|
|
* of the buffer provided by resultPtr. When the request has finished, the actual
|
|
* length of the returned value shall be stored.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, service is busy or queue is full
|
|
* CRYPTO_E_KEY_NOT_VALID Request failed, the key's state is "invalid"
|
|
* CRYPTO_E_KEY_SIZE_MISMATCH Request failed, key element sizes are not compatible
|
|
* CRYPTO_E_KEY_EMPTY Request failed because of uninitialized source key element
|
|
* CRYPTO_E_SMALL_BUFFER The provided buffer is too small to store the result
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same jobId (will be rejected with CRYPTO_E_BUSY)
|
|
* \synchronous TRUE|FALSE Depends on given job.
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-129264
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_Decrypt(uint32 jobId,
|
|
Crypto_OperationModeType mode,
|
|
P2CONST(uint8, AUTOMATIC, CSM_APPL_VAR) dataPtr,
|
|
uint32 dataLength,
|
|
P2VAR(uint8, AUTOMATIC, CSM_APPL_VAR) resultPtr,
|
|
P2VAR(uint32, AUTOMATIC, CSM_APPL_VAR) resultLengthPtr);
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_AEADEncrypt()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Uses the given input data to perform a AEAD encryption and stores the ciphertext and the MAC in the
|
|
* memory locations pointed by the ciphertext pointer and Tag pointer.
|
|
* \details -
|
|
* \param[in] jobId Holds the identifier of the job using the CSM service.
|
|
* \param[in] mode Indicates which operation mode(s) to perform.
|
|
* \param[in] plaintextPtr Contains the pointer to the data to be encrypted.
|
|
* \param[in] plaintextLength Contains the number of bytes to encrypt.
|
|
* \param[in] associatedDataPtr Contains the pointer to the associated data.
|
|
* \param[in] associatedDataLength Contains the number of bytes of the associated data.
|
|
* \param[out] ciphertextPtr Contains the pointer to the data where the encrypted data shall be stored.
|
|
* \param[in,out] ciphertextLengthPtr Holds a pointer to the memory location in which the output length in bytes of
|
|
* the ciphertext is stored. On calling this function, this parameter shall
|
|
* contain the size of the buffer in bytes provided by ciphertextPtr. When the
|
|
* request has finished, the actual length of the returned value shall be stored.
|
|
* \param[out] tagPtr Contains the pointer to the data where the Tag shall be stored.
|
|
* \param[in,out] tagLengthPtr Holds a pointer to the memory location in which the output length in bytes of
|
|
* the Tag is stored. On calling this function, this parameter shall contain the
|
|
* size of the buffer in bytes provided by tagPtr. When the request has
|
|
* finished, the actual length of the returned value shall be stored.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, service is busy or queue is full
|
|
* CRYPTO_E_KEY_NOT_VALID Request failed, the key's state is "invalid"
|
|
* CRYPTO_E_KEY_SIZE_MISMATCH Request failed, key element sizes are not compatible
|
|
* CRYPTO_E_KEY_EMPTY Request failed because of uninitialized source key element
|
|
* CRYPTO_E_SMALL_BUFFER The provided buffer is too small to store the result
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same jobId (will be rejected with CRYPTO_E_BUSY)
|
|
* \synchronous TRUE|FALSE Depends on given job.
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-129263
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_AEADEncrypt(uint32 jobId,
|
|
Crypto_OperationModeType mode,
|
|
P2CONST(uint8, AUTOMATIC, CSM_APPL_VAR) plaintextPtr,
|
|
uint32 plaintextLength,
|
|
P2CONST(uint8, AUTOMATIC, CSM_APPL_VAR) associatedDataPtr,
|
|
uint32 associatedDataLength,
|
|
P2VAR(uint8, AUTOMATIC, CSM_APPL_VAR) ciphertextPtr,
|
|
P2VAR(uint32, AUTOMATIC, CSM_APPL_VAR) ciphertextLengthPtr,
|
|
P2VAR(uint8, AUTOMATIC, CSM_APPL_VAR) tagPtr,
|
|
P2VAR(uint32, AUTOMATIC, CSM_APPL_VAR) tagLengthPtr);
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_AEADDecrypt()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Uses the given data to perform an AEAD decryption and stores the plaintext and the result of
|
|
* verification in the memory locations pointed by the plaintext pointer and verifyPtr pointer.
|
|
* \details -
|
|
* \param[in] jobId Holds the identifier of the job using the CSM service.
|
|
* \param[in] mode Indicates which operation mode(s) to perform.
|
|
* \param[in] ciphertextPtr Contains the pointer to the data to be decrypted.
|
|
* \param[in] ciphertextLength Contains the number of bytes to decrypt.
|
|
* \param[in] associatedDataPtr Contains the pointer to the associated data.
|
|
* \param[in] associatedDataLength Contains the number of bytes of the associated data.
|
|
* \param[in] tagPtr Contains the pointer to the data where the Tag shall be stored.
|
|
* \param[in] tagLength Contains the length in bytes of the Tag to be verified.
|
|
* \param[out] plaintextPtr Contains the pointer to the data where the encrypted data shall be stored.
|
|
* \param[in,out] plaintextLengthPtr Holds a pointer to the memory location in which the output length in bytes of
|
|
* the plaintext is stored. On calling this function, this parameter shall
|
|
* contain the size of the buffer in bytes provided by plaintextPtr. When the
|
|
* request has finished, the actual length of the returned value shall be stored.
|
|
* \param[out] verifyPtr Contains the pointer to the result of the verification.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, service is busy or queue is full
|
|
* CRYPTO_E_KEY_NOT_VALID Request failed, the key's state is "invalid"
|
|
* CRYPTO_E_KEY_SIZE_MISMATCH Request failed, key element sizes are not compatible
|
|
* CRYPTO_E_KEY_EMPTY Request failed because of uninitialized source key element
|
|
* CRYPTO_E_SMALL_BUFFER The provided buffer is too small to store the result
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same jobId (will be rejected with CRYPTO_E_BUSY)
|
|
* \synchronous TRUE|FALSE Depends on given job.
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-129262
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_AEADDecrypt(uint32 jobId,
|
|
Crypto_OperationModeType mode,
|
|
P2CONST(uint8, AUTOMATIC, CSM_APPL_VAR) ciphertextPtr,
|
|
uint32 ciphertextLength,
|
|
P2CONST(uint8, AUTOMATIC, CSM_APPL_VAR) associatedDataPtr,
|
|
uint32 associatedDataLength,
|
|
P2CONST(uint8, AUTOMATIC, CSM_APPL_VAR) tagPtr,
|
|
uint32 tagLength,
|
|
P2VAR(uint8, AUTOMATIC, CSM_APPL_VAR) plaintextPtr,
|
|
P2VAR(uint32, AUTOMATIC, CSM_APPL_VAR) plaintextLengthPtr,
|
|
P2VAR(Crypto_VerifyResultType, AUTOMATIC, CSM_APPL_VAR) verifyPtr);
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_SignatureGenerate()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Uses the given data to perform the signature calculation and stores the signature in the memory
|
|
* location pointed by the result pointer.
|
|
* \details -
|
|
* \param[in] jobId Holds the identifier of the job using the CSM service.
|
|
* \param[in] mode Indicates which operation mode(s) to perform.
|
|
* \param[in] dataPtr Contains the pointer to the data to be signed.
|
|
* \param[in] dataLength Contains the number of bytes to sign.
|
|
* \param[out] resultPtr Contains the pointer to the data where the signature shall be stored.
|
|
* \param[in,out] resultLengthPtr Holds a pointer to the memory location in which the output length in bytes is
|
|
* stored. On calling this function, this parameter shall contain the size of the
|
|
* buffer in bytes provided by resultPtr. When the request has finished, the actual
|
|
* length of the returned value shall be stored.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, service is busy or queue is full
|
|
* CRYPTO_E_KEY_NOT_VALID Request failed, the key's state is "invalid"
|
|
* CRYPTO_E_KEY_SIZE_MISMATCH Request failed, key element sizes are not compatible
|
|
* CRYPTO_E_KEY_EMPTY Request failed because of uninitialized source key element
|
|
* CRYPTO_E_SMALL_BUFFER The provided buffer is too small to store the result
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same jobId (will be rejected with CRYPTO_E_BUSY)
|
|
* \synchronous TRUE|FALSE Depends on given job.
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-129261
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_SignatureGenerate(uint32 jobId,
|
|
Crypto_OperationModeType mode,
|
|
P2CONST(uint8, AUTOMATIC, CSM_APPL_VAR) dataPtr,
|
|
uint32 dataLength,
|
|
P2VAR(uint8, AUTOMATIC, CSM_APPL_VAR) resultPtr,
|
|
P2VAR(uint32, AUTOMATIC, CSM_APPL_VAR) resultLengthPtr);
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_SignatureVerify()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Verifies the given MAC by comparing if the signature is generated with the given data.
|
|
* \details -
|
|
* \param[in] jobId Holds the identifier of the job using the CSM service.
|
|
* \param[in] mode Indicates which operation mode(s) to perform.
|
|
* \param[in] dataPtr Contains the pointer to the data to be verified.
|
|
* \param[in] dataLength Contains the number of bytes to be verified.
|
|
* \param[in] signaturePtr Holds a pointer to the signature to be verified.
|
|
* \param[in] signatureLength Contains the signature length in bytes.
|
|
* \param[out] verifyPtr Holds a pointer to the memory location, which will hold the result of the
|
|
* signature verification.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, service is busy or queue is full
|
|
* CRYPTO_E_KEY_NOT_VALID Request failed, the key's state is "invalid"
|
|
* CRYPTO_E_KEY_SIZE_MISMATCH Request failed, key element sizes are not compatible
|
|
* CRYPTO_E_KEY_EMPTY Request failed because of uninitialized source key element
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same jobId (will be rejected with CRYPTO_E_BUSY)
|
|
* \synchronous TRUE|FALSE Depends on given job.
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-129260
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_SignatureVerify(uint32 jobId,
|
|
Crypto_OperationModeType mode,
|
|
P2CONST(uint8, AUTOMATIC, CSM_APPL_VAR) dataPtr,
|
|
uint32 dataLength,
|
|
P2CONST(uint8, AUTOMATIC, CSM_APPL_VAR) signaturePtr,
|
|
uint32 signatureLength,
|
|
P2VAR(Crypto_VerifyResultType, AUTOMATIC, CSM_APPL_VAR) verifyPtr);
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_RandomGenerate()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Generate a random number and stores it in the memory location pointed by the result pointer.
|
|
* \details -
|
|
* \param[in] jobId Holds the identifier of the job using the CSM service.
|
|
* \param[out] resultPtr Holds a pointer to the memory location which will hold the result of the
|
|
* random number generation.
|
|
* \param[in,out] resultLengthPtr Holds a pointer to the memory location in which the result length in bytes
|
|
* is stored. On calling this function, this parameter shall contain the
|
|
* number of random bytes, which shall be stored to the buffer provided by
|
|
* resultPtr. When the request has finished, the actual length of the returned
|
|
* value shall be stored.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, service is busy or queue is full
|
|
* CRYPTO_E_SMALL_BUFFER The provided buffer is too small to store the result
|
|
* CRYPTO_E_ENTROPY_EXHAUSTION Request failed, entropy of random number generator is exhausted
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same jobId (will be rejected with CRYPTO_E_BUSY)
|
|
* \synchronous TRUE|FALSE Depends on given job.
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-129257
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_RandomGenerate(uint32 jobId,
|
|
P2VAR(uint8, AUTOMATIC, CSM_APPL_VAR) resultPtr,
|
|
P2VAR(uint32, AUTOMATIC, CSM_APPL_VAR) resultLengthPtr);
|
|
|
|
# if (CSM_JOB_KEY_API_VERSION == CSM_ASR_VERSION_R21_11) /* COV_CSM_ASR_COMPATIBILITY_FUNCTIONS */
|
|
/**********************************************************************************************************************
|
|
* Csm_JobKeySetValid()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Stores the key if necessary and sets the key state of the key configured in the job to valid.
|
|
* \details -
|
|
* \param[in] jobId Holds the identifier of the job using the CSM service.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, service is busy or queue is full
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same jobId (will be rejected with CRYPTO_E_BUSY)
|
|
* \synchronous TRUE|FALSE Depends on given job.
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-129255
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_JobKeySetValid(uint32 jobId);
|
|
# endif /* (CSM_JOB_KEY_API_VERSION == CSM_ASR_VERSION_R21_11) */
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_JobKeySetValid44x()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Stores the key if necessary and sets the key state of the key configured in the job to valid.
|
|
* \details -
|
|
* \param[in] jobId Holds the identifier of the job using the CSM service.
|
|
* \param[in] keyId Not used - keyId already given by corresponding job of passed jobId
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, service is busy or queue is full
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same jobId (will be rejected with CRYPTO_E_BUSY)
|
|
* \synchronous TRUE|FALSE Depends on given job.
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-129255
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_JobKeySetValid44x(uint32 jobId, uint32 keyId);
|
|
|
|
# if (CSM_JOB_KEY_API_VERSION == CSM_ASR_VERSION_R21_11) /* COV_CSM_ASR_COMPATIBILITY_FUNCTIONS */
|
|
/**********************************************************************************************************************
|
|
* Csm_JobKeySetInvalid()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Sets the key status to invalid. The key cannot be used any longer for cryptographic operations
|
|
* until it has been set to valid state again.
|
|
* \details -
|
|
* \param[in] jobId Holds the identifier of the job using the CSM service.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, service is busy or queue is full
|
|
* \context TASK
|
|
* \reentrant TRUE
|
|
* \synchronous TRUE|FALSE Depends on given job.
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-3000000
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_JobKeySetInvalid(uint32 jobId);
|
|
# endif /* (CSM_JOB_KEY_API_VERSION == CSM_ASR_VERSION_R21_11) */
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_JobKeySetInvalid44x()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Sets the key status to invalid. The key cannot be used any longer for cryptographic operations
|
|
* until it has been set to valid state again.
|
|
* \details -
|
|
* \param[in] jobId Holds the identifier of the job using the CSM service.
|
|
* \param[in] keyId Not used - keyId already given by corresponding job of passed jobId
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, service is busy or queue is full
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same jobId (will be rejected with CRYPTO_E_BUSY)
|
|
* \synchronous TRUE|FALSE Depends on given job.
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-3000000
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_JobKeySetInvalid44x(uint32 jobId, uint32 keyId);
|
|
|
|
# if (CSM_JOB_KEY_API_VERSION == CSM_ASR_VERSION_R21_11) /* COV_CSM_ASR_COMPATIBILITY_FUNCTIONS */
|
|
/**********************************************************************************************************************
|
|
* Csm_JobRandomSeed()
|
|
*********************************************************************************************************************/
|
|
/*! \brief This function shall dispatch the random seed function to the configured Crypto Driver object.
|
|
* \details -
|
|
* \param[in] jobId Holds the identifier of the job using the CSM service.
|
|
* \param[in] seedPtr Holds a pointer to the memory location which contains the data to feed the seed.
|
|
* \param[in] seedLength Contains the length of the seed in bytes.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, service is busy or queue is full
|
|
* CRYPTO_E_KEY_NOT_VALID Request failed, the key's state is "invalid"
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same jobId (will be rejected with CRYPTO_E_BUSY)
|
|
* \synchronous TRUE|FALSE Depends on given job.
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-129251
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_JobRandomSeed(uint32 jobId, P2CONST(uint8, AUTOMATIC, CSM_APPL_VAR) seedPtr, uint32 seedLength);
|
|
# endif /* (CSM_JOB_KEY_API_VERSION == CSM_ASR_VERSION_R21_11) */
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_JobRandomSeed44x()
|
|
*********************************************************************************************************************/
|
|
/*! \brief This function shall dispatch the random seed function to the configured Crypto Driver object.
|
|
* \details -
|
|
* \param[in] jobId Holds the identifier of the job using the CSM service.
|
|
* \param[in] keyId Not used - keyId already given by corresponding job of passed jobId
|
|
* \param[in] seedPtr Holds a pointer to the memory location which contains the data to feed the seed.
|
|
* \param[in] seedLength Contains the length of the seed in bytes.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, service is busy or queue is full
|
|
* CRYPTO_E_KEY_NOT_VALID Request failed, the key's state is "invalid"
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same jobId (will be rejected with CRYPTO_E_BUSY)
|
|
* \synchronous TRUE|FALSE Depends on given job.
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-129251
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_JobRandomSeed44x(uint32 jobId, uint32 keyId, P2CONST(uint8, AUTOMATIC, CSM_APPL_VAR) seedPtr, uint32 seedLength);
|
|
|
|
# if (CSM_JOB_KEY_API_VERSION == CSM_ASR_VERSION_R21_11) /* COV_CSM_ASR_COMPATIBILITY_FUNCTIONS */
|
|
/**********************************************************************************************************************
|
|
* Csm_JobKeyGenerate()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Generates new key material and stores it in the key configured in the job.
|
|
* \details -
|
|
* \param[in] jobId Holds the identifier of the job using the CSM service.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, service is busy or queue is full
|
|
* CRYPTO_E_KEY_NOT_VALID Request failed, the key's state is "invalid"
|
|
* CRYPTO_E_KEY_EMPTY Request failed because of uninitialized source key element
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same jobId (will be rejected with CRYPTO_E_BUSY)
|
|
* \synchronous TRUE|FALSE Depends on given job.
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-129250
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_JobKeyGenerate(uint32 jobId);
|
|
# endif /* (CSM_JOB_KEY_API_VERSION == CSM_ASR_VERSION_R21_11) */
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_JobKeyGenerate44x()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Generates new key material and stores it in the key identified by keyId.
|
|
* \details -
|
|
* \param[in] jobId Holds the identifier of the job using the CSM service.
|
|
* \param[in] keyId Not used - keyId already given by corresponding job of passed jobId
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, service is busy or queue is full
|
|
* CRYPTO_E_KEY_NOT_VALID Request failed, the key's state is "invalid"
|
|
* CRYPTO_E_KEY_EMPTY Request failed because of uninitialized source key element
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same jobId (will be rejected with CRYPTO_E_BUSY)
|
|
* \synchronous TRUE|FALSE Depends on given job.
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-129250
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_JobKeyGenerate44x(uint32 jobId, uint32 keyId);
|
|
|
|
# if (CSM_JOB_KEY_API_VERSION == CSM_ASR_VERSION_R21_11) /* COV_CSM_ASR_COMPATIBILITY_FUNCTIONS */
|
|
/**********************************************************************************************************************
|
|
* Csm_JobKeyDerive()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Derives a new key by using the key elements in the key configured in the job.
|
|
* The key contains the key elements for the password and salt. The derived key is
|
|
* stored in the key element with the id 1 of the key identified by targetKeyId.
|
|
* \details -
|
|
* \param[in] jobId Holds the identifier of the job using the CSM service.
|
|
* \param[in] targetKeyId Holds the identifier of the key which is used to store the derived key.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, service is busy or queue is full
|
|
* CRYPTO_E_KEY_READ_FAIL Request failed, not allowed to extract key element
|
|
* CRYPTO_E_KEY_WRITE_FAIL Request failed, not allowed to write key element
|
|
* CRYPTO_E_KEY_NOT_VALID Request failed, the key's state is "invalid"
|
|
* CRYPTO_E_KEY_SIZE_MISMATCH Request failed, key element sizes are not compatible
|
|
* CRYPTO_E_KEY_EMPTY Request failed because of uninitialized source key element
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same jobId (will be rejected with CRYPTO_E_BUSY)
|
|
* \synchronous TRUE|FALSE Depends on given job.
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-129249
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_JobKeyDerive(uint32 jobId, uint32 targetKeyId);
|
|
# endif /* (CSM_JOB_KEY_API_VERSION == CSM_ASR_VERSION_R21_11) */
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_JobKeyDerive44x()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Derives a new key by using the key elements in the key configured in the job.
|
|
* The key contains the key elements for the password and salt. The derived key is
|
|
* stored in the key element with the id 1 of the key identified by targetKeyId.
|
|
* \details -
|
|
* \param[in] jobId Holds the identifier of the job using the CSM service.
|
|
* \param[in] keyId Not used - keyId already given by corresponding job of passed jobId
|
|
* \param[in] targetKeyId Holds the identifier of the key which is used to store the derived key.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, service is busy or queue is full
|
|
* CRYPTO_E_KEY_READ_FAIL Request failed, not allowed to extract key element
|
|
* CRYPTO_E_KEY_WRITE_FAIL Request failed, not allowed to write key element
|
|
* CRYPTO_E_KEY_NOT_VALID Request failed, the key's state is "invalid"
|
|
* CRYPTO_E_KEY_SIZE_MISMATCH Request failed, key element sizes are not compatible
|
|
* CRYPTO_E_KEY_EMPTY Request failed because of uninitialized source key element
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same jobId (will be rejected with CRYPTO_E_BUSY)
|
|
* \synchronous TRUE|FALSE Depends on given job.
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-129249
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_JobKeyDerive44x(uint32 jobId, uint32 keyId, uint32 targetKeyId);
|
|
|
|
# if (CSM_JOB_KEY_API_VERSION == CSM_ASR_VERSION_R21_11) /* COV_CSM_ASR_COMPATIBILITY_FUNCTIONS */
|
|
/**********************************************************************************************************************
|
|
* Csm_JobKeyExchangeCalcPubVal()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Calculates the public value of the current user for the key exchange and stores the
|
|
* public key in the memory location pointed by the public value pointer.
|
|
* \details -
|
|
* \param[in] jobId Holds the identifier of the job using the CSM service.
|
|
* \param[out] publicValuePtr Contains the pointer to the data where the public value shall be stored.
|
|
* \param[in,out] publicValueLengthPtr Holds a pointer to the memory location in which the public value length information
|
|
* is stored. On calling this function, this parameter shall contain the size of the buffer provided
|
|
* by publicValuePtr. When the request has finished, the actual length of the returned value shall be stored.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, service is busy or queue is full
|
|
* CRYPTO_E_KEY_NOT_VALID Request failed, the key's state is "invalid"
|
|
* CRYPTO_E_KEY_EMPTY Request failed because of uninitialized source key element
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same jobId (will be rejected with CRYPTO_E_BUSY)
|
|
* \synchronous TRUE|FALSE Depends on given job.
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-129248
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_JobKeyExchangeCalcPubVal(uint32 jobId,
|
|
P2VAR(uint8, AUTOMATIC, CSM_APPL_VAR) publicValuePtr,
|
|
P2VAR(uint32, AUTOMATIC, CSM_APPL_VAR) publicValueLengthPtr);
|
|
# endif /* (CSM_JOB_KEY_API_VERSION == CSM_ASR_VERSION_R21_11) */
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_JobKeyExchangeCalcPubVal44x()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Calculates the public value of the current user for the key exchange and stores the
|
|
* public key in the memory location pointed by the public value pointer.
|
|
* \details -
|
|
* \param[in] jobId Holds the identifier of the job using the CSM service.
|
|
* \param[in] keyId Not used - keyId already given by corresponding job of passed jobId
|
|
* \param[out] publicValuePtr Contains the pointer to the data where the public value shall be stored.
|
|
* \param[in,out] publicValueLengthPtr Holds a pointer to the memory location in which the public value length information
|
|
* is stored. On calling this function, this parameter shall contain the size of the buffer provided
|
|
* by publicValuePtr. When the request has finished, the actual length of the returned value shall be stored.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, service is busy or queue is full
|
|
* CRYPTO_E_KEY_NOT_VALID Request failed, the key's state is "invalid"
|
|
* CRYPTO_E_KEY_EMPTY Request failed because of uninitialized source key element
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same jobId (will be rejected with CRYPTO_E_BUSY)
|
|
* \synchronous TRUE|FALSE Depends on given job.
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-129248
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_JobKeyExchangeCalcPubVal44x(uint32 jobId,
|
|
uint32 keyId,
|
|
P2VAR(uint8, AUTOMATIC, CSM_APPL_VAR) publicValuePtr,
|
|
P2VAR(uint32, AUTOMATIC, CSM_APPL_VAR) publicValueLengthPtr);
|
|
|
|
# if (CSM_JOB_KEY_API_VERSION == CSM_ASR_VERSION_R21_11) /* COV_CSM_ASR_COMPATIBILITY_FUNCTIONS */
|
|
/**********************************************************************************************************************
|
|
* Csm_JobKeyExchangeCalcSecret()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Calculates the shared secret key for the key exchange with the key material of the key configured in
|
|
* the job and the partner public key. The shared secret key is stored as a key element in the same key.
|
|
* \details -
|
|
* \param[in] jobId Holds the identifier of the job using the CSM service.
|
|
* \param[in] partnerPublicValuePtr Holds the pointer to the memory location which contains the partner's public value.
|
|
* \param[in] partnerPublicValueLength Contains the length of the partner's public value in bytes.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, service is busy or queue is full
|
|
* CRYPTO_E_KEY_NOT_VALID Request failed, the key's state is "invalid"
|
|
* CRYPTO_E_KEY_EMPTY Request failed because of uninitialized source key element
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same jobId (will be rejected with CRYPTO_E_BUSY)
|
|
* \synchronous TRUE|FALSE Depends on given job.
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-129247
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_JobKeyExchangeCalcSecret(uint32 jobId,
|
|
P2CONST(uint8, AUTOMATIC, CSM_APPL_VAR) partnerPublicValuePtr,
|
|
uint32 partnerPublicValueLength);
|
|
# endif /* (CSM_JOB_KEY_API_VERSION == CSM_ASR_VERSION_R21_11) */
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_JobKeyExchangeCalcSecret44x()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Calculates the shared secret key for the key exchange with the key material of the key configured in
|
|
* the job and the partner public key. The shared secret key is stored as a key element in the same key.
|
|
* \details -
|
|
* \param[in] jobId Holds the identifier of the job using the CSM service.
|
|
* \param[in] keyId Not used - keyId already given by corresponding job of passed jobId
|
|
* \param[in] partnerPublicValuePtr Holds the pointer to the memory location which contains the partner's public value.
|
|
* \param[in] partnerPublicValueLength Contains the length of the partner's public value in bytes.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, service is busy or queue is full
|
|
* CRYPTO_E_KEY_NOT_VALID Request failed, the key's state is "invalid"
|
|
* CRYPTO_E_KEY_EMPTY Request failed because of uninitialized source key element
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same jobId (will be rejected with CRYPTO_E_BUSY)
|
|
* \synchronous TRUE|FALSE Depends on given job.
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-129247
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_JobKeyExchangeCalcSecret44x(uint32 jobId,
|
|
uint32 keyId,
|
|
P2CONST(uint8, AUTOMATIC, CSM_APPL_VAR) partnerPublicValuePtr,
|
|
uint32 partnerPublicValueLength);
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_JobKeyWrap()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Wraps the plaintext key given by sourceKeyId (in the key element with the id 1) with the key
|
|
* wrapping key associated with the jobId. The wrapped key will be written to ciphertextPtr. If the
|
|
* algorithm does provide an authenticator this will be written to authenticatorPtr. If the algorithm
|
|
* has no authenticator or the algorithm has an authenticator and no authentication shall be done,
|
|
* authenticatorLengthPtr shall be set to zero.
|
|
* \details -
|
|
* \param[in] jobId Holds the identifier of the job using the CSM service.
|
|
* \param[in] sourceKeyId Holds the identifier of the key to be wrapped.
|
|
* \param[in] ciphertextPtr References the data of the wrapped key.
|
|
* \param[in,out] ciphertextLengthPtr Contains the length in bytes of the wrapped key.
|
|
* \param[in] authenticatorPtr References the data of the authenticator - NOT USED.
|
|
* \param[in,out] authenticatorLengthPtr Contains the length in bytes of the authenticator.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, service is busy or queue is full
|
|
* CRYPTO_E_KEY_READ_FAIL Request failed, not allowed to extract key element
|
|
* CRYPTO_E_KEY_NOT_VALID Request failed, the key's state is "invalid"
|
|
* CRYPTO_E_KEY_EMPTY Request failed because of uninitialized source key element
|
|
* CRYPTO_E_KEY_SIZE_MISMATCH Request failed, key element sizes are not compatible
|
|
* CRYPTO_E_JOB_CANCELED Request failed because the job has been canceled.
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same jobId (will be rejected with CRYPTO_E_BUSY)
|
|
* \synchronous TRUE|FALSE Depends on given job.
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-Csm-KeyWrap
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_JobKeyWrap(uint32 jobId,
|
|
uint32 sourceKeyId,
|
|
P2VAR(uint8, AUTOMATIC, CSM_APPL_VAR) ciphertextPtr,
|
|
P2VAR(uint32, AUTOMATIC, CSM_APPL_VAR) ciphertextLengthPtr,
|
|
P2VAR(uint8, AUTOMATIC, CSM_APPL_VAR) authenticatorPtr,
|
|
P2VAR(uint32, AUTOMATIC, CSM_APPL_VAR) authenticatorLengthPtr);
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_JobKeyUnwrap()
|
|
*********************************************************************************************************************/
|
|
/*! \brief Unwraps the wrapped key given by the ciphertextPtr with the key wrapping key associated with
|
|
* the jobId. The unwrapped key will be written to targetKeyId in the element with the Id 1. If an
|
|
* authentication shall be done, the authenticator shall be referenced with authenticatorPtr. If the
|
|
* algorithm has no authenticator or the algorithm has an authenticator and no authentication shall
|
|
* be done, authenticatorLengthPtr shall be set to zero. If the algorithm has no authentication,
|
|
* verifyPtr will be set to CRYPTO_E_VER_OK.
|
|
* \details -
|
|
* \param[in] jobId Holds the identifier of the job using the CSM service.
|
|
* \param[in] targetKeyId Holds the identifier of the slot where the plaintext key shall be
|
|
* written.
|
|
* \param[in] ciphertextPtr References the data of the wrapped key.
|
|
* \param[in] ciphertextLength Contains the length in bytes of the wrapped key.
|
|
* \param[in] authenticatorPtr References the data of the authenticator - NOT USED.
|
|
* \param[in] authenticatorLength Contains the length in bytes of the authenticator.
|
|
* \param[out] verifyPtr Contains the pointer to the result of the verification.
|
|
* \return E_OK Request successful
|
|
* E_NOT_OK Request failed
|
|
* CRYPTO_E_BUSY Request failed, service is busy or queue is full
|
|
* CRYPTO_E_KEY_WRITE_FAIL Request failed, not allowed to write key element
|
|
* CRYPTO_E_KEY_NOT_VALID Request failed, the key's state is "invalid"
|
|
* CRYPTO_E_KEY_SIZE_MISMATCH Request failed, key element sizes are not compatible
|
|
* CRYPTO_E_JOB_CANCELED Request failed because the job has been canceled
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same jobId (will be rejected with CRYPTO_E_BUSY)
|
|
* \synchronous TRUE|FALSE Depends on given job.
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
* \trace CREQ-Csm-KeyUnwrap
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_JobKeyUnwrap(uint32 jobId,
|
|
uint32 targetKeyId,
|
|
P2CONST(uint8, AUTOMATIC, CSM_APPL_VAR) ciphertextPtr,
|
|
uint32 ciphertextLength,
|
|
P2CONST(uint8, AUTOMATIC, CSM_APPL_VAR) authenticatorPtr,
|
|
uint32 authenticatorLength,
|
|
P2VAR(Crypto_VerifyResultType, AUTOMATIC, CSM_APPL_VAR) verifyPtr);
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_SaveContextJob()
|
|
*********************************************************************************************************************/
|
|
/*! \brief The Crypto Driver stores the internal context of the respective crypto operation to the contextBuffer.
|
|
* \details -
|
|
* \param[in] jobId Holds the identifier of the job using the CSM service.
|
|
* \param[out] contextBufferPtr Pointer to the buffer in the application where the context data shall be
|
|
* stored to.
|
|
* \param[in,out] contextBufferLengthPtr Pointer to the buffer, where the length value is located.As input data it
|
|
* provides the maximum length of data available in contextBufferPtr.As
|
|
* output data it provides the actual length of data located in context
|
|
* BufferPtr(or 0 in case of a failure)
|
|
* \return E_OK Context data successfully provided.
|
|
* E_NOT_OK Context data could not be provided, values are not valid.
|
|
* CRYPTO_E_BUSY Request failed, service is busy or queue is full
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same jobId (will be rejected with CRYPTO_E_BUSY)
|
|
* \synchronous TRUE|FALSE Depends on given job.
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_SaveContextJob(uint32 jobId,
|
|
P2VAR(uint8, AUTOMATIC, CSM_APPL_VAR) contextBufferPtr,
|
|
P2VAR(uint32, AUTOMATIC, CSM_APPL_VAR) contextBufferLengthPtr);
|
|
|
|
/**********************************************************************************************************************
|
|
* Csm_RestoreContextJob()
|
|
*********************************************************************************************************************/
|
|
/*! \brief The Crypto Driver extracts the context data from the contextBuffer and restores the
|
|
* internal state so that further crypto operation of this crypto service will continue at
|
|
* the exact point when the context was taken.
|
|
* \details -
|
|
* \param[in] jobId Holds the identifier of the job using the CSM service.
|
|
* \param[in] contextBufferPtr Pointer to the buffer, where the context data are located that
|
|
* shall be restored.
|
|
* \param[in] contextBufferLength Provides the length of context data that are located in contextBufferPtr.
|
|
* \return E_OK Context data successfully restored.
|
|
* E_NOT_OK Context data could not be restored.
|
|
* CRYPTO_E_BUSY Request failed, service is busy or queue is full
|
|
* \context TASK
|
|
* \reentrant TRUE, but not for the same jobId (will be rejected with CRYPTO_E_BUSY)
|
|
* \synchronous TRUE|FALSE Depends on given job.
|
|
* \pre -
|
|
* \note The returned value is defined by the underlying Crypto Driver and may differ from the listed ones.
|
|
*********************************************************************************************************************/
|
|
FUNC(Std_ReturnType, CSM_CODE) Csm_RestoreContextJob(uint32 jobId,
|
|
P2VAR(uint8, AUTOMATIC, CSM_APPL_VAR) contextBufferPtr,
|
|
uint32 contextBufferLength);
|
|
|
|
# define CSM_STOP_SEC_CODE
|
|
# include "MemMap.h" /* PRQA S 5087 */ /* MD_MSR_MemMap */
|
|
|
|
/* AUTOSAR Compatibility Block */
|
|
# if (CSM_JOB_KEY_API_VERSION == CSM_ASR_VERSION_4_04) /* COV_CSM_ASR_COMPATIBILITY_FUNCTIONS */
|
|
# define Csm_JobKeySetValid Csm_JobKeySetValid44x
|
|
# define Csm_JobKeySetInvalid Csm_JobKeySetInvalid44x
|
|
# define Csm_JobRandomSeed Csm_JobRandomSeed44x
|
|
# define Csm_JobKeyGenerate Csm_JobKeyGenerate44x
|
|
# define Csm_JobKeyDerive Csm_JobKeyDerive44x
|
|
# define Csm_JobKeyExchangeCalcPubVal Csm_JobKeyExchangeCalcPubVal44x
|
|
# define Csm_JobKeyExchangeCalcSecret Csm_JobKeyExchangeCalcSecret44x
|
|
# endif /* (CSM_JOB_KEY_API_VERSION == CSM_ASR_VERSION_4_04) */
|
|
|
|
/*!
|
|
* \exclusivearea CSM_EXCLUSIVE_AREA_0
|
|
* Ensures consistency of global RAM variables.
|
|
* \protects Job state and queue handling variables.
|
|
* \usedin Csm_Hash, Csm_MacGenerate, Csm_MacVerify, Csm_Encrypt, Csm_Decrypt, Csm_AEADEncrypt, Csm_AEADDecrypt,
|
|
* Csm_SignatureGenerate, Csm_SignatureVerify, Csm_RandomGenerate, Csm_JobKeySetValid, Csm_JobKeySetInvalid,
|
|
* Csm_JobRandomSeed, Csm_JobKeyGenerate, Csm_JobKeyDerive, Csm_JobKeyExchangeCalcPubVal,
|
|
* Csm_JobKeyExchangeCalcSecret, Csm_SaveContextJob, Csm_RestoreContextJob, Csm_CallbackNotification,
|
|
* Csm_CancelJob, Csm_MainFunction
|
|
* \exclude All functions in which this exclusive area is used in.
|
|
* \length MEDIUM for Job state and queue handling.
|
|
* \endexclusivearea
|
|
*/
|
|
|
|
#endif /* !defined (CSM_H) */
|
|
/**********************************************************************************************************************
|
|
* END OF FILE: Csm.h
|
|
*********************************************************************************************************************/
|