SNIP_CLASSIC_CRYIF_SECTION_8_3_4_3_Key_Extraction_Interface

8.3.4.3 Key Extraction Interface [SWS_CryIf_91006] Definition of API function CryIf_KeyElementGet ⌈ Service Name CryIf_KeyElementGet Syntax Std_ReturnType CryIf_KeyElementGet ( uint32 cryIfKeyId, uint32 keyElementId, uint8* resultPtr, uint32* resultLengthPtr ) Service ID [hex] 0x06 Sync/Async Synchronous Reentrancy Reentrant cryIfKeyId Holds the identifier of the key whose key element shall be returned. Parameters (in) keyElementId Holds the identifier of the key element which shall be returned. Parameters (inout) resultLengthPtr Holds a pointer to a memory location in which the length information is stored. On calling this function this parameter shall contain the size of the buffer provided by resultPtr. If the key element is configured to allow partial access, this parameter contains the amount of data which should be read from the key element. The size may not be equal to the size of the provided buffer anymore. When the request has finished, the amount of data that has been stored shall be stored. Parameters (out) resultPtr Holds the pointer of the buffer for the returned key element Return value Std_ReturnType E_OK: Request successful E_NOT_OK: Request failed CRYPTO_E_BUSY: Request failed, Crypto Driver Object is busy CRYPTO_E_KEY_NOT_AVAILABLE: Request failed, the requested key element is not available CRYPTO_E_KEY_READ_FAIL: Request failed because read access was denied CRYPTO_E_KEY_EMPTY: Request failed because of uninitialized source key element Description This function shall dispatch the get key element function to the configured crypto driver object. ▽ △ Available via CryIf.h ⌋ [SWS_CryIf_00059] CryIf_KeyElementGet API: Report CRYIF_E_UNINIT error Upstream requirements: SRS_CryptoStack_00034, SRS_BSW_00369, SRS_BSW_00406 ⌈If development error detection for the CRYIF module is enabled: The function CryIf_KeyElementGet shall report CRYIF_E_UNINIT to the DET if the module is not yet initialized.⌋ [SWS_CryIf_00060] CryIf_KeyElementGet API: Report CRYIF_E_PARAM_HANDLE error Upstream requirements: SRS_CryptoStack_00034, SRS_BSW_00369 ⌈If development error detection for the CRYIF module is enabled: The function CryIf_KeyElementGet shall report CRYIF_E_PARAM_HANDLE to the DET if the parameter cryIfKeyId is out of range.⌋ [SWS_CryIf_00062] CryIf_KeyElementGet API: Report CRYIF_E_PARAM_POINTER error for resultPtr Upstream requirements: SRS_CryptoStack_00034, SRS_BSW_00369 ⌈If development error detection for the CRYIF module is enabled: The function CryIf_KeyElementGet shall report CRYIF_E_PARAM_POINTER to the DET if the parameter resultPtr is a null pointer.⌋ [SWS_CryIf_00063] CryIf_KeyElementGet API: Report CRYIF_E_PARAM_POINTER error for resultLengthPtr Upstream requirements: SRS_CryptoStack_00034, SRS_BSW_00369 ⌈If development error detection for the CRYIF module is enabled: The function CryIf_KeyElementGet shall report CRYIF_E_PARAM_POINTER to the DET if the parameter resultLengthPtr is a null pointer.⌋ [SWS_CryIf_00064] CryIf_KeyElementGet API: Report CRYIF_E_PARAM_VALUE error Upstream requirements: SRS_CryptoStack_00034, SRS_BSW_00369 ⌈If development error detection for the CRYIF module is enabled: The function CryIf_KeyElementGet shall report CRYIF_E_PARAM_VALUE to the DET if the value, which is pointed by resultLengthPtr, is zero.⌋ [SWS_CryIf_00065] CryIf_KeyElementGet API: Forward key job to the mapped driver Upstream requirements: SRS_CryptoStack_00104 ⌈If no errors are detected by CRYIF, the service CryIf_KeyElementGet shall call Crypto_<vi>_<ai>_KeyElementGet for the driver configuration mapped to the service and pass on the return value.⌋