class ara::crypto::x509::OcspResponse

The interface ara::crypto::x509::OcspResponse encapsulates the response of an OCSP query for checking the certificate status in AUTOSAR Adaptive. Callers typically first check the status of the response via GetResponseStatus() [SWS_CRYPT_50130] and subsequently retrieve the contained certificates using GetCertificates() [SWS_CRYPT_50131]. Access is concurrency-safe and exception-safe via shared smart pointers to immutable instances (Sptrc) [SWS_CRYPT_40802].

more ›

Context

In the crypto module of the AUTOSAR Adaptive Platform, the interface ara::crypto::x509::OcspResponse encapsulates the data of a response conforming to the Online Certificate Status Protocol (OCSP). Its primary responsibility is to provide the validity and revocation status of X.509 certificates to applications and security functions. Unlike static certificate revocation lists (CRLs), OCSP enables timely status queries for individual certificates from a validation service.

In the crypto architecture, the interface acts as an information source for calling components such as authentication services or TLS protocol stacks. It provides methods both to query the high-level response status of the OCSP message [SWS_CRYPT_50130] and to read out the certificates transported in the response [SWS_CRYPT_50131]. In this way, communication peers can immediately verify the validity of certificate chains.

Lifecycle

As a purely virtual interface, ara::crypto::x509::OcspResponse does not define any public constructors or custom factory methods. Instantiation typically occurs platform-internally via the driver and provider components of the crypto stack, which parse received raw data of the OCSP response (interpretation: concrete instances are created by underlying X.509 providers). Question Q-30d53aa886333cbc (open)

For passing and managing instances, the class specifies the type alias Sptrc as std::shared_ptr<const OcspResponse> [SWS_CRYPT_40802]. This smart pointer establishes a shared ownership model with strict read-only access. The lifetime of the object is governed via the reference counting of the shared pointer and terminates automatically as soon as the last reference is released.

With respect to concurrency and fault tolerance, the methods GetResponseStatus [SWS_CRYPT_50130] and GetCertificates [SWS_CRYPT_50131] are declared as exception-safe (exception safe) and thread-safe (thread-safe). Since only constant access is granted via Sptrc [SWS_CRYPT_40802], multiple threads can access the same OCSP response instance concurrently and without external locks.

Usage Path

The typical sequence for evaluating an OCSP response comprises checking the status and subsequently retrieving embedded certificates:

1. Query status: The caller first invokes GetResponseStatus() [SWS_CRYPT_50130]. The method returns a ara::core::Result<OcspResponseStatus> indicating whether the response was generated successfully or a protocol error occurred.
2. Check result: The application checks the Result object. Only if the OCSP response is marked as successful is the evaluation of further payload data sensible.
3. Obtain certificates: The application then calls GetCertificates() [SWS_CRYPT_50131]. Here, a ara::core::Result<ara::core::Vector<Certificate::Sptrc>> is returned that encapsulates all certificates contained in the OCSP response.
4. Perform verification: The extracted certificates presumably serve to validate the signature of the OCSP response or the certificate chain of the responder (interpretation: certificates support the authenticity verification of the OCSP data). Question Q-4f4a5f1b72358a1f (open)

Sequence diagram: Typical sequence for querying the OCSP response status and fetching contained certificates. Sources: [SWS_CRYPT_50130], [SWS_CRYPT_50131].

Error Scenarios

Both methods of the interface use ara::core::Result as a synchronous return type and are annotated with the identifier noexcept, which precludes throwing synchronous C++ exceptions [SWS_CRYPT_50130] [SWS_CRYPT_50131].

For GetResponseStatus() [SWS_CRYPT_50130] and GetCertificates() [SWS_CRYPT_50131], the AUTOSAR specification explicitly defines no standardized error codes. Possible error causes—such as parsing errors or platform-internal memory shortages—are reported in an implementation-specific manner via the error object of ara::core::Result. The existence of a valid pointer of type OcspResponse::Sptrc [SWS_CRYPT_40802] serves as a precondition, since access via null pointers would cause undefined behavior.