classe ara::diag::ClientAuthentication

Utilisation et appel

La fonction ara::diag::ClientAuthentication::Authenticate est appelée par une application afin de notifier à l'instance de Diagnostic Server l'authentification réussie d'un client de diagnostic [SWS_DM_01142]. Cela peut se produire après une authentification via les interfaces du Diagnostic Server ou via des mécanismes propres à l'application [SWS_DM_01142].

En paramètre d'entrée, la fonction accepte userRoles (de type ara::core::Vector<DiagnosticAuthRole>). En cas d'appel réussi, l'état d'authentification de l'instance passe à kAuthenticated et les rôles utilisateur transmis sont définitivement adoptés [SWS_DM_01206]. Comme valeur de retour, elle fournit un ara::core::Result<ClientAuthenticationHandle> [SWS_DM_01142]. Puisqu'un objet Result est directement mis à disposition, le traitement devrait s'effectuer de manière synchrone dans le contexte appelant. Question Q-dae22c82694f2103 (ouverte)

Gestion des erreurs et concurrence

La méthode est déclarée comme noexcept et est considérée comme sûre vis-à-vis des exceptions (exception safe) [SWS_DM_01142]. Si une erreur survient en raison de l'indisponibilité de fonctionnalités fondamentales du Diagnostic Manager au moment de l'appel, l'opération échoue avec une sémantique de rollback et renvoie DiagErrc::kServiceNotAvailable dans l'objet Result [SWS_DM_01142].

Concernant la concurrence, la méthode est expressément spécifiée comme not thread-safe [SWS_DM_01142]. Les appels parallèles sur le même objet ClientAuthentication sont donc non autorisés et doivent être synchronisés par l'application.

Zusammenspiel et cycle de vie

Le ClientAuthenticationHandle obtenu permet à l'application de définir ou d'étendre une DynamicAccessList pour le client authentifié [SWS_DM_01142]. De plus, l'appel démarre ou référence la surveillance de l'inactivité du client : si, après une authentification réussie dans l'état de session par défaut, aucune autre requête UDS n'est reçue pendant une durée de authenticationTimeout, l'instance de Diagnostic Server réinitialise automatiquement le client à kDeAuthenticated [SWS_DM_01210]. Pour prévenir ce timeout, l'application peut rafraîchir le temporisateur via la méthode Refresh du handle [SWS_DM_01155].

À l'aide de la méthode synchrone OverrideDefaultRoles de la classe ara::diag::ClientAuthentication, une application peut surcharger temporairement les rôles d'authentification par défaut (defaultRoles) d'un client de diagnostic [SWS_DM_01141]. Les services de diagnostic autorisés pour les rôles transmis sont à la disposition du testeur pendant le laps de temps défini dans le paramètre timeout [SWS_DM_01141]. La condition préalable est que le client se trouve dans l'état kDeAuthenticated [SWS_DM_01209]. Interprétation : si l'appel n'a pas lieu dans l'état kDeAuthenticated, la surcharge de rôles devrait être rejetée ou rester sans effet, car la spécification prescrit ce comportement exclusivement pour cet état initial. Question Q-81189f2c2fe0f301 (ouverte)

En cas d'exécution réussie, la méthode renvoie à l'application une instance de ClientAuthenticationHandle au sein d'un ara::core::Result [SWS_DM_01141], [SWS_DM_01209]. Si l'appel ne peut pas être exécuté parce qu'une fonctionnalité essentielle du Diagnostic Manager n'est pas disponible actuellement, le code d'erreur DiagErrc::kServiceNotAvailable est renvoyé [SWS_DM_01141]. La fonction est déclarée comme noexcept et est sûre vis-à-vis des exceptions (exception safe) [SWS_DM_01141].

Les exigences suivantes s'appliquent à la concurrence et à l'interaction avec d'autres composants :

• Concurrence : la méthode est spécifiée comme not thread-safe [SWS_DM_01141]. Les appels parallèles sur la même instance doivent être synchronisés côté application.
• Gestion des handles : via l'instance renvoyée de ClientAuthenticationHandle, le temporisateur en cours peut être prolongé avec Refresh() [SWS_DM_01155]. De plus, le handle permet la gestion de la DynamicAccessList pour des ressources de diagnostic supplémentaires AUTOSAR_AP_SWS_Diagnostics §7.3.2.3.3 « ClientAuthenticationHandle ».

Utilisation

La méthode [SWS_DM_01144] de la classe ara::diag::ClientAuthentication permet à l'application d'enregistrer une fonction de rappel du type ClientAuthenticationSetNotifier. Celle-ci est appelée par l'instance du Diagnostic Server dès que l'état d'authentification d'un client change [SWS_DM_01144]. Cela permet à l'application de réagir immédiatement aux changements d'état, par exemple lorsqu'une transition automatique vers l'état kDeAuthenticated intervient après un timeout de serveur S3 [SWS_DM_01211] ou lorsqu'un timeout survient en raison d'une inactivité du client [SWS_DM_01210].

Gestion des erreurs et valeur de retour

La fonction renvoie un ara::core::Result<void> et est déclarée comme noexcept ainsi que sûre vis-à-vis des exceptions (exception safe) [SWS_DM_01144]. Aucun code d'erreur standardisé n'est spécifié [SWS_DM_01144] ; l'objet de résultat fournit vraisemblablement toujours un succès (void) en fonctionnement normal. Question Q-0d7d43cc37d57944 (ouverte)

Concurrence et interaction

Concernant la sécurité des threads, la méthode est spécifiée comme « not thread-safe » [SWS_DM_01144]. Les appels sur la même instance ne doivent donc pas être effectués sans protection à partir de threads concurrents. De plus, un comportement d'écrasement s'applique à l'enregistrement : un nouvel appel de SetNotifier remplace entièrement le notificateur précédemment enregistré [SWS_DM_01144]. Ce comportement correspond au modèle d'enregistrement uniforme dans le Diagnostic Management, tel qu'il est défini de manière analogue pour [SWS_DM_00615] (CancellationHandler), [SWS_DM_00745] (Indicator) et [SWS_DM_00755] (OperationCycle).

Le destructeur [SWS_DM_01136] de la classe ara::diag::ClientAuthentication sert à la libération et à la déconstruction propre d'une instance destinée à l'authentification de client dans le Diagnostic Management. La fonction est définie dans le fichier d'en-tête #include "ara/diag/client_authentication.h" et est appelée de manière synchrone à la fin de la durée de vie de l'objet (AUTOSAR_AP_SWS_Diagnostics §8.5.1.2.1.2 « Destructor »).

Les dispositions suivantes s'appliquent à l'utilisation et aux propriétés d'exécution :

• Appel et paramètres : en tant que destructeur, ~ClientAuthentication() ne possède ni paramètre d'entrée ni valeur de retour.
• Sécurité vis-à-vis des erreurs et des exceptions : l'opération est spécifiée comme noexcept et exception safe [SWS_DM_01136] ; aucune exception n'est déclenchée lors de la déconstruction de l'objet.
• Concurrence : l'appel est expressément classé comme not thread-safe. Une destruction de l'objet ne doit par conséquent pas avoir lieu de manière concurrente à d'autres appels de méthode de la même instance.

L'élément met en œuvre l'exigence amont RS_Diag_04251 (AUTOSAR_AP_SWS_Diagnostics §8.5.1.2.1.2 « Destructor »). Interprétation : avant de détruire l'instance, les opérations actives d'authentification ou de communication de l'application devraient devoir être terminées de manière ordonnée afin d'éviter tout comportement indéfini résultant de l'absence de sécurité des threads. Question Q-cedd6f523eb2c1c3 (ouverte)