class ara::crypto::x509::CertificateValidationResult

The interface ara::crypto::x509::CertificateValidationResult provides the result of an X.509 certificate validation and is typically managed as an immutable Sptrc [SWS_CRYPT_50093]. Via its methods, the application queries the overall status, determines the complete certificate chain with the leaf certificate at position 0, or isolates the failed certificate. If the validation was successful, the call to determine the erroneous certificate fails with the error code ara::crypto::CryptoErrc::kNoSuchValue [SWS_CRYPT_50095]. All interface methods are designed to be thread-safe and exception-safe.

more ›

Context

The interface ara::crypto::x509::CertificateValidationResult encapsulates the result of an X.509 certificate validation process within the Adaptive module crypto. Its primary responsibility is to provide calling applications with a structured and consistent verification result. This includes both the aggregated validation status of the certificate path and access to the participating certificate objects. Acting as an intermediary between the internal cryptographic verification mechanisms and safety-critical applications, the class enables a differentiated evaluation of certificate hierarchies. Its central interaction partners include instances of Certificate::Sptrc, which are either assembled as a complete certificate chain or identified as the cause of the failure in case of an error.

Lifecycle

As a pure virtual interface, CertificateValidationResult defines no public constructors of its own. Lifetime and ownership are decisively controlled by the typed smart pointer Sptrc, which is defined as std::shared_ptr<const CertificateValidationResult> [SWS_CRYPT_50093]. This constant pointer establishes a shared, immutable ownership model: after completion of a certificate validation, the result object is provided as an unmodifiable snapshot. Creation and initialization of concrete instances are likely performed internally by higher-level validation functions of the platform backend. Question Q-a5580dcf443b0905 (open) Since all member functions are declared as const and noexcept and explicitly specified as thread-safe and exception-safe ([SWS_CRYPT_50094], [SWS_CRYPT_50095], [SWS_CRYPT_50096]), multiple threads can access the same instance concurrently and without additional synchronization measures until the last reference is released.

Usage Path

A typical usage path starts after receiving a CertificateValidationResult::Sptrc instance from a preceding certificate validation. Callers carry out the evaluation in a standardized sequence:

• First, the application calls GetValidationStatus() to query the basic result of the certificate validation as CertificateValidationStatus [SWS_CRYPT_50094].
• If the validation was successful, the client calls GetCertificateChain() to retrieve the certificate chain found during the verification process as ara::core::Vector<Certificate::Sptrc> [SWS_CRYPT_50096]. According to the specification, this chain always begins at index position 0 with the leaf certificate [SWS_CRYPT_50096].
• If, on the other hand, path validation failed, the caller calls GetFailedCertificate() to specifically identify the certificate that triggered the validation error [SWS_CRYPT_50095].

Sequence diagram: Typical sequence for querying validation status, certificate chain, and error cause. Sources: [SWS_CRYPT_50094], [SWS_CRYPT_50095], [SWS_CRYPT_50096]

Error Scenarios

The error management of the interface relies on ara::core::Result, with all calls maintaining the noexcept guarantee and being exception-safe:

• Successful validation and GetFailedCertificate(): When the verification has completed successfully (return value kValid), no certificate caused a failure. In this state, calling GetFailedCertificate() fails with the error code ara::crypto::CryptoErrc::kNoSuchValue [SWS_CRYPT_50095]. Applications must interpret this error as a logical confirmation of an error-free chain or couple the call to a negative status.
• Implementation-specific status errors: No standardized error codes are defined for GetValidationStatus(), but implementation-specific errors are encapsulated in the returned ara::core::Result [SWS_CRYPT_50094].
• Certificate chain query: GetCertificateChain() also does not specify any standardized error codes [SWS_CRYPT_50096]; any internal error states are signaled via the resulting ara::core::Result.