klasse ara::diag::ClientAuthentication

Gebruik en aanroep

De functie ara::diag::ClientAuthentication::Authenticate wordt door een applicatie aangeroepen om de succesvolle authenticatie van een diagnoseclient door te geven aan de Diagnostic Server-instantie [SWS_DM_01142]. Dit kan plaatsvinden na een authenticatie via de interfaces van de Diagnostic Server of via applicatie-eigen mechanismen [SWS_DM_01142].

Als invoerparameter accepteert de functie userRoles (van het type ara::core::Vector<DiagnosticAuthRole>). Bij een succesvolle aanroep wisselt de authenticatiestatus van de instantie naar kAuthenticated en worden de overgedragen gebruikersrollen definitief overgenomen [SWS_DM_01206]. Als retourwaarde levert zij een ara::core::Result<ClientAuthenticationHandle> [SWS_DM_01142]. Aangezien er direct een Result-object beschikbaar wordt gesteld, vindt de verwerking vermoedelijk synchroon in de aanroepende context plaats. Vraag Q-dae22c82694f2103 (open)

Foutafhandeling en gelijktijdigheid

De methode is gedeclareerd als noexcept en geldt als uitzonderingsveilig (exception safe) [SWS_DM_01142]. Treedt er een fout op omdat fundamentele functionaliteiten van de Diagnostic Manager op het moment van aanroepen niet beschikbaar zijn, dan mislukt de operatie met rollback-semantiek en retourneert zij DiagErrc::kServiceNotAvailable in het Result-object [SWS_DM_01142].

Wat betreft gelijktijdigheid is de methode uitdrukkelijk gespecificeerd als not thread-safe [SWS_DM_01142]. Parallelle aanroepen op hetzelfde ClientAuthentication-object zijn daarom niet toegestaan en moeten door de applicatie worden gesynchroniseerd.

Zusammenspiel en levenscyclus

De verkregen ClientAuthenticationHandle stelt de applicatie in staat om een DynamicAccessList voor de geauthentiseerde client te definiëren of uit te breiden [SWS_DM_01142]. Bovendien start of refereert de aanroep de inactiviteitsbewaking van de client: blijft na succesvolle authenticatie in de standaardsessietoestand gedurende authenticationTimeout een volgend UDS-verzoek uit, dan reset de Diagnostic Server-instantie de client automatisch weer naar kDeAuthenticated [SWS_DM_01210]. Om deze time-out te voorkomen, kan de applicatie de timer via de methode Refresh van de handle bijwerken [SWS_DM_01155].

Met de synchrone methode OverrideDefaultRoles van de klasse ara::diag::ClientAuthentication kan een applicatie de standaard authenticatierollen (defaultRoles) van een diagnoseclient tijdelijk overschrijven [SWS_DM_01141]. De voor de overgedragen rollen vrijgegeven diagnosediensten staan de tester ter beschikking voor de in de parameter timeout gedefinieerde tijdsperiode [SWS_DM_01141]. Voorwaarde hiervoor is dat de client zich in de toestand kDeAuthenticated bevindt [SWS_DM_01209]. Interpretatie: vindt de aanroep niet plaats in de toestand kDeAuthenticated, dan zal de roloverschrijving vermoedelijk worden afgewezen of zonder effect blijven, aangezien de specificatie het gedrag uitsluitend voor deze begintoestand voorschrijft. Vraag Q-81189f2c2fe0f301 (open)

Bij succesvolle uitvoering retourneert de methode een instantie van ClientAuthenticationHandle binnen een ara::core::Result aan de applicatie [SWS_DM_01141], [SWS_DM_01209]. Kan de aanroep niet worden uitgevoerd omdat essentiële functionaliteit van de Diagnostic Manager momenteel niet beschikbaar is, dan wordt de foutcode DiagErrc::kServiceNotAvailable geretourneerd [SWS_DM_01141]. De functie is gedeclareerd als noexcept en is uitzonderingsveilig (exception safe) [SWS_DM_01141].

Voor gelijktijdigheid en het samenspel met andere componenten gelden de volgende richtlijnen:

• Gelijktijdigheid: De methode is gespecificeerd als not thread-safe [SWS_DM_01141]. Parallelle aanroepen op dezelfde instantie moeten aan de applicatiezijde worden gesynchroniseerd.
• Handle-beheer: Via de geretourneerde instantie van ClientAuthenticationHandle kan de lopende timer worden verlengd met Refresh() [SWS_DM_01155]. Bovendien maakt de handle het beheer mogelijk van de DynamicAccessList voor aanvullende diagnoseresources AUTOSAR_AP_SWS_Diagnostics §7.3.2.3.3 “ClientAuthenticationHandle”.

Gebruik

De methode [SWS_DM_01144] van de klasse ara::diag::ClientAuthentication dient ertoe dat de applicatie een callback-functie van het type ClientAuthenticationSetNotifier registreert. Deze wordt aangeroepen door de instantie van de Diagnostic Server zodra de authenticatiestatus van een client verandert [SWS_DM_01144]. Dit stelt de applicatie in staat om direct te reageren op statusovergangen, bijvoorbeeld wanneer na een S3-server-timeout een automatische overgang naar de status kDeAuthenticated plaatsvindt [SWS_DM_01211] of wanneer een time-out optreedt door inactiviteit van de client [SWS_DM_01210].

Foutafhandeling en retourwaarde

De functie retourneert een ara::core::Result<void> en is gedeclareerd als noexcept en uitzonderingsveilig (exception safe) [SWS_DM_01144]. Er zijn geen gestandaardiseerde foutcodes gespecificeerd [SWS_DM_01144]; vermoedelijk levert het Result-object bij normaal bedrijf altijd succes op (void). Vraag Q-0d7d43cc37d57944 (open)

Gelijktijdigheid en wisselwerking

Wat betreft thread-safety is de methode gespecificeerd als „not thread-safe” [SWS_DM_01144]. Aanroepen op dezelfde instantie mogen daarom niet onbeschermd vanuit concurrerende threads plaatsvinden. Bovendien geldt voor de registratie overschrijfgedrag: een hernieuwde aanroep van SetNotifier vervangt de eerder geregistreerde notifier volledig [SWS_DM_01144]. Dit gedrag komt overeen met het uniforme registratiepatroon in Diagnostic Management, zoals dat analoog ook is gedefinieerd voor [SWS_DM_00615] (CancellationHandler), [SWS_DM_00745] (Indicator) en [SWS_DM_00755] (OperationCycle).

De destructor [SWS_DM_01136] van de klasse ara::diag::ClientAuthentication dient voor de vrijgave en de correcte ontmanteling van een instantie voor clientauthenticatie in Diagnostic Management. De functie is gedefinieerd in het headerbestand #include "ara/diag/client_authentication.h" en wordt synchroon aangeroepen aan het einde van de levensduur van het object (AUTOSAR_AP_SWS_Diagnostics §8.5.1.2.1.2 “Destructor”).

Voor het gebruik en de uitvoeringseigenschappen gelden de volgende bepalingen:

• Aanroep en parameters: Als destructor heeft ~ClientAuthentication() noch overdrachtsparameters noch een retourwaarde.
• Fout- en uitzonderingsveiligheid: De operatie is gespecificeerd als noexcept en exception safe [SWS_DM_01136]; bij de afbraak van het object worden gegarandeerd geen exceptions gegenereerd.
• Concurrency: De aanroep is uitdrukkelijk geclassificeerd als not thread-safe. Een vernietiging van het object mag derhalve niet gelijktijdig met andere methode-aanroepen van dezelfde instantie plaatsvinden.

Het element implementeert de upstream-eis RS_Diag_04251 (AUTOSAR_AP_SWS_Diagnostics §8.5.1.2.1.2 “Destructor”). Interpretatie: Vóór de vernietiging van de instantie moeten actieve authenticatie- of communicatieprocessen van de applicatie vermoedelijk ordelijk worden beëindigd om ongedefinieerd gedrag als gevolg van het ontbreken van thread-safety te voorkomen. Vraag Q-cedd6f523eb2c1c3 (open)