AUTOSAR Classic Security & Intrusion Detection

This callback function is invoked by the BswM to indicate ECU state changes.

This function is called to acquire the transmit data of an I-PDU segment (N-PDU). Each call to this function provides the next part of the I-PDU data unless retry->TpDataState is TP_ DATARETRY. In this case the function restarts to copy the data beginning at the offset from the current position indicated by retry->TxTpDataCnt. The size of the remaining data is written to the position indicated by availableDataPtr.

This function is a request from DCM to the IdsM to read the routine results triggered by function IdsM_Dcm_GetReportingMode_Start().

This function is a request from DCM to the IdsM to start the routine execution to request the current reporting mode of a specific Security Event ID.

This function is a request from DCM to the IdsM to start the routine execution to set the reporting mode of a specific Security Event ID.

Returns version information, vendor ID and AUTOSAR module ID of the component.

Service to initialize the module IdsM. It initializes all variables and sets the module state to initialized.

This function is called periodically. It processes security events asynchronously which are queued during API function calls.

This API is the application interface to report security events to the IdsM.

This API is the application interface to report security events with context data to the IdsM.

This API is the application interface for Smart Sensors to report security events with a count value to the IdsM.

This API is the application interface for Smart Sensors to report security events with a count value and context data to the IdsM.

This API is the application interface for Smart Sensors to report security events with a timestamp and a count value to the IdsM.

This API is the application interface for Smart Sensors to report security events with a timestamp, a count value and context data to the IdsM.

This function is called after the I-PDU has been transmitted on its network, the result indicates whether the transmission was successful or not.

The lower layer communication interface module confirms the transmission of a PDU, or the failure to transmit a PDU.

Configuration data structure of IdsM module.

Data type used for "Block State" filter values (bit masks)

Reporting modes used by the reporting mode filter

Data type used for local IdsM Security Event IDs

Data type for IdsM timestamps

Service KeyM_CertElementGet.

Service KeyM_CertElementGetFirst.

Service KeyM_CertElementGetNext.

This function provides the sta tus of a certificate.

Service KeyM_CertificateElementGetByIndex.

This function provides the total number of data elements that a re available for the specified certificate element. Typically, only one data element is available. But in some cases, several data elements can be assigned to one certificate element in a row. This function retrieves the total number of elements. The indiv idual data elements can then accessed with Key M_ Certificate Element Get By Index(). It is similar to the functions Key M_ Cert Element Get First/ Key M_ Cert Element Get Next to retrieve a group of data elements of one certificate element. AUTOSAR CP R20 - of

Notifies the application that a certificate verification has been finished. The function name is configurable by Key MCertificate Verify Callback Notification Func. Availabl e via Key M_ Externals.h

Service KeyM_CryptoKeyFinalizeCallbackNotification.

Notifies the application that a crypto key update operation has been finished. This function is used by the key manager.

Notifies the application that a crypto key verify operation has been finished. This function is used by the key manager.

This function resets the key management module to the uninitialized state.

The function is used to finalize key update operations. It is typi cally used in conjunction with the Key M_

This function provides the certificate data

Provides the version information of this module.

This function initializes the key management module.

If Key MCrypto Key Start Finalize Function Enabled and Key MCrypto Key Handler Start Finalize Enabled is set to TRUE, this function will be called immediately when Key M_

If the configuration parameters Key MCrypto Key Prepare Function Enabled and Key MCrypto Key Handler Prepare Enabled are both set to TRUE, then this function w ill be called immediately when Key M_ Prepare gets called. The function takes over the task to prepare a key management operation. The response data will be passed on as is to the caller of Key_ Prepare.

If Key MCrypto Key Start Finalize Function Enabled and Key MCrypto Key

Function is called from a pre - emptive operating system when no other task operation is needed. Can be used for calling time consuming synchronous functions such as Key M_ KH_ Update().

Function is called periodically according the specified time interval.

This function is used to prepare a key update operation. The main intent is to provide information for the key operation to the key server. Other operations may start the negotiation for a common secret that is used further to derive key material. This function is only av ailable if Key MCrypto Key Prepare Function Enabled is set to TRUE.

Notifies the application that the certificate service operation has been finished. This function is used by the certificate submodule. Thi s callback is only provided if Key MService Certificate Function Enabled is set to TRUE. The function name is configurable by Key MService Certificate Callback Notification Func.

This function provides the certificate data to the key managem ent module to temporarily store the certificate.

This function is optional and only used if the configuration item Key MCrypto Key Start Finalize Function Enabled is set to true. It intents to allow key update operation.

Service KeyM_VerifyCertificate.

Service KeyM_VerifyCertificateChain.

This function verifies two certificates that are stored and parsed internally against each other. The certificat e referenced with Cert Id was signed by the certificate referenced with cert Upper Id. Only these two certificates are validated against each other.

Byte - pointer to the data of the certificate

This structure is used to exchange certificate data through interface functions.

Certificate Element handle.

This structure is used to iterate through a number of elements of a certificate.

Array long enough to store data

Certificate handle.

Type KeyM_CertificateStatusType.

This structure is the base type to initialize the Key Manager module. A pointer to an instance of this structure will be used in the initialization of the Key Manager module.

Byte - pointer to the input or output data

Crypto key handle.

Specifies the type of key handler update operation that was performed in the callback.

Specifies the result type of an asynchronous key management fu nction.

This type specifies the requested service operation and what information is provided with this function.

This type specifies in which mode the key operation will start. The OEM production mode provides higher privileges compared to workshop mode.

Array long enough to store the key or certificate name. base Type Encoding = UTF -

This function is called to provide the received data of an I - PDU segment (N - PDU) to the upper layer. Each call to this function provides the next part of the I - PDU data. The si ze of the remaining buffer is written to the position indicated by buffer Size Ptr.

Service SecOC_CopyTxData.

This service stops the secure onboard communication. All buffered I - PDU are removed and have to be obtained again, if needed, after Sec OC_ Init has been called. By a call to Sec OC_ De Init the AUTOSAR Sec OC module is put into a not in itialized state (Sec OC_ UNINIT).

Service SecOC_GetRxFreshness.

Service SecOC_GetRxFreshnessAuthData.

This API returns th e freshness value from the Most Significant Bits in the first byte in the array (Sec OCFreshness Value), in big endian format.

Service SecOC_GetTxFreshnessTruncData.

Returns the version information of this module.

Requests cancellation of an ongoing transmission of a PDU in a lower layer communication module.

Requests transmission of a PDU.

Initializes the the Sec OC module. Successful initialization leads to state Sec OC_ INIT. In configurations, in which Sec OC is assigned to more than one partition (i.e. Sec OC_ Main Functions are mapped to partition s), Sec OC may provide one init AUTOSAR CP R20 - of Document ID : AUTOSAR_SWS_SecureOnboardCommunication function per partition. The decision on whether a single Sec OC_ Init() function or one per partition is provided is implementation - specific. In case a given implementation provides one Sec OC_ Init() function per partition, it is up to the implementation to devise a naming pattern that prevents name clashes among the different Sec OC_ Init() functions (e.g., by adding a suffix containing short name the Ecuc Partition.

This function performs the processing of the Sec OC module's authentication and verification processing for the Rx path. Per configured Sec OCMain Function Rx instance one Sec OC_ Main Function Rx_ shall be implemented. Hereby is the short name of the Sec OCMain Function Rx configuration container in the ECU configuration.

This function performs the processing of the Sec OC module's authentication and verification processing for the Tx path. Per configured Sec OCMain Function Tx instance one Sec OC_ Main Function Tx_ shall be implemented. Hereby is t he short name of the Sec OCMain Function Tx configuration container in the ECU configuration.

Indication of a received PDU from a lower layer communication interface module.

The service provides the ability to enable the sending of un - authenticated PDU to lower layer. (example: in case authentication build counter has reached the configuration value Sec OCAuthentication Build Attempts or the query of the freshness function returns E_ NOT_ OK or the calculation of the authenticator has returned a non - recoverable error such as returning E_ NOT_ OK or KEY_ FAILURE). T his service is optional (the service is available only if Sec OCDefault Authentication Information Pattern is configured). If the service is not available or the service is available but the service was called with send Default

This interface is used by the Sec OC to indicate that the Secured I - PDU has been initiated for transmission.

Service SecOC_StartReception.

Requests cancellation of an ongoing reception of a PDU in a lower layer transport protocol module.

Requests cancellation of an ongoing transmission of a PDU in a lower layer communication module.

Called after an I - PDU has been received via the TP API, the result indicates whether the transmission was successful or not.

Requests transmission of a PDU.

This function is called after the I - PDU has been transmitted on its network, the result indicates whether the transmission was successful or not.

Within this API , the upper layer module (called module) shall check whether the available data fits into the buffer size reported by Pdu Info Ptr - >Sdu Length. If it fits, it shall copy its data into the buffer provided by Pdu Info Ptr - >Sdu Data Ptr and update the length of the actual copied data in Pdu Info Ptr - >Sdu Length. If not, it returns E_ NOT_ OK without changing Pdu Info Ptr.

The lower layer communication interface module confirms the transmission of a PDU, or the failure to transmit a PDU.

Service is used to propagate the status of each verification attempt from the Sec OC module to other modules. This service can be configured such that:  Only: "False" Verifica tion Status is propagated to modules  Both: "True" and "False" Verification Status are propagated to modules  None: No Verification Status is propagated

This s ervice provides the ability to inform the application about the result of the verification attempt of a received PDU by the Sec OC module.

Service SecOC_VerifyStatusOverride.

Configuration data structure of Sec OC module

-

Type SecOC_OverrideStatusType.

States of the Sec OC module

Enumeration to indicate veri fication results.

Data structure to bundle the status of a verification attempt for a specific Freshness Value and Data ID