classe ara::idsm::EventReporter

La classe EventReporter est définie dans l'en-tête ara/idsm/event_reporter.h et sert, dans l'Adaptive Platform, à signaler des événements relatifs à la sécurité (Security Events) à l'Intrusion Detection System Management (IdsM) [SWS_AIDSM_10101].

Utilisation et instanciation

Pour utiliser la classe, une instance doit être créée via le constructeur paramétré, qui accepte un identifiant de type const ara::core::InstanceSpecifier& [SWS_AIDSM_10301]. Ce constructeur initialise le reporter pour le port de type SecurityEventReportInterface configuré dans le modèle de système [SWS_AIDSM_10301]. Interprétation : la liaison au port modélisé devrait supposer que l'InstanceSpecifier transmis est défini de manière cohérente dans le manifeste ARXML et résoluble au moment de l'exécution. Question Q-ed2f606f7446b4ba (ouverte)

Gestion des erreurs et concurrence

En ce qui concerne le comportement vis-à-vis des exceptions, la construction est spécifiée avec noexcept [SWS_AIDSM_10301] ; le constructeur ne lève donc aucune exception C++. Concernant la concurrence, la fonction de construction est explicitement déclarée thread-safe [SWS_AIDSM_10301]. Interprétation : plusieurs threads devraient ainsi pouvoir instancier en parallèle des instances de reporter pour leurs ports respectifs sans nécessiter de mécanismes de synchronisation externes. Question Q-ddff9884a7b7cad8 (ouverte)

Interaction

L'interaction avec l'IdsM repose sur l'assignation de l'instance au port de modélisation respectif : grâce à la spécification en tant que EventReporter pour le SecurityEventReportInterface [SWS_AIDSM_10301], la classe représente l'interface par laquelle les applications adaptatives transmettent des événements de sécurité à l'architecture IdsM [SWS_AIDSM_10101].

Utilisation

La fonction ReportEvent de l'en-tête ara/idsm/event_reporter.h sert à signaler un événement de sécurité avec des données de contexte [SWS_AIDSM_10304]. Lors de l'appel, l'argument contextData de type ContextDataType est transmis. De plus, le nombre d'événements peut être indiqué de manière optionnelle via count (type CountType), dont la valeur par défaut est fixée à 1 [SWS_AIDSM_10304]. La fonction ne fournit aucune valeur de retour (void) et, en tant que déclaration noexcept, ne lève aucune exception.

Concurrence et restrictions

L'interface est explicitement définie comme thread-safe [SWS_AIDSM_10304] et peut être appelée en parallèle depuis plusieurs threads sans mesures de synchronisation supplémentaires. Comme la signature ne fournit aucun paramètre pour un horodatage, la saisie de l'instant de signalement devrait probablement s'effectuer en interne lors de l'acceptation de l'événement. Question Q-ab652343cc8009e9 (ouverte)

Interaction avec les interfaces associées

La spécification définit plusieurs surcharges associées de ReportEvent pour différents volumes d'informations :

• Signalement d'un événement sans données de contexte ni horodatage [SWS_AIDSM_10302].
• Signalement avec horodatage, mais sans données de contexte [SWS_AIDSM_10303].
• Signalement avec données de contexte et horodatage explicite [SWS_AIDSM_10305].
• Signalements avec données de contexte versionnées de type VersionedContextDataType, soit sans horodatage [SWS_AIDSM_10306], soit avec horodatage [SWS_AIDSM_10307].

Utilisation

La fonction [SWS_AIDSM_10305] transmet un événement de sécurité avec des données de contexte spécifiques à l'application ainsi qu'un horodatage explicite. Via l'argument contextData de type ContextDataType, des données utiles liées à l'événement sont transmises, tandis que timestamp (type const TimestampType) consigne l'instant exact de saisie. Le paramètre optionnel count (type const CountType) possède la valeur par défaut 1 et permet de signaler plusieurs occurrences cumulées. La fonction ne fournit aucune valeur de retour (void).

Concurrence et traitement des erreurs

La déclaration se trouve dans l'en-tête ara/idsm/event_reporter.h et est explicitement spécifiée comme thread-safe (thread-safe) [SWS_AIDSM_10305]. Les appels peuvent donc s'effectuer sans synchronisation supplémentaire depuis des threads parallèles. Grâce à la désignation par noexcept, aucune exception n'est propagée au niveau de l'API ; d'éventuelles erreurs lors du transfert ou de la mise en mémoire tampon devraient donc être traitées en interne par l'Intrusion Detection System Manager. Question Q-3b45e18c9a106a0f (ouverte)

Interaction et alternatives

L'interface appartient à un groupe de fonctions de reporting surchargées. Si aucune donnée de contexte ni aucun horodatage ne sont requis, des variantes plus légères telles que [SWS_AIDSM_10302] (compteur uniquement), [SWS_AIDSM_10303] (avec horodatage) ainsi que [SWS_AIDSM_10304] (avec données de contexte uniquement) sont disponibles. Si des formats de données structurés ou versionnés sont nécessaires, il convient d'utiliser à la place les surcharges avec VersionedContextDataType conformément à [SWS_AIDSM_10306] et [SWS_AIDSM_10307].

La fonction ReportEvent fournit dans le module aidsm une interface pour signaler un événement de sécurité enrichi de données de contexte versionnées [SWS_AIDSM_10306]. Elle est définie dans l'en-tête ara/idsm/event_reporter.h et ne fournit aucune valeur de retour (void).

Lors de l'appel, les paramètres suivants sont traités :

• contextData (type VersionedContextDataType) : transmet les informations de contexte versionnées de l'événement de sécurité survenu [SWS_AIDSM_10306].
• count (type const CountType, valeur par défaut 1) : détermine de manière optionnelle le nombre d'occurrences cumulées de cet événement [SWS_AIDSM_10306].

Concernant la concurrence, la fonction est spécifiée comme thread-safe (thread-safe) [SWS_AIDSM_10306]. Grâce à la déclaration avec noexcept, il est garanti que l'exécution ne lève aucune exception C++.

En interaction avec les autres fonctions de signalement, cette surcharge couvre un cas d'usage spécifique :

• Pour le signalement sans données de contexte, les variantes sans horodatage [SWS_AIDSM_10302] ou avec horodatage [SWS_AIDSM_10303] sont disponibles.
• Pour les données de contexte non versionnées (ContextDataType), il existe des surcharges sans horodatage [SWS_AIDSM_10304] ainsi qu'avec horodatage [SWS_AIDSM_10305].
• Si des données de contexte versionnées doivent être transmises conjointement avec un horodatage explicite, il convient d'utiliser [SWS_AIDSM_10307] à la place. Interprétation : comme [SWS_AIDSM_10306] ne possède aucun paramètre d'horodatage, l'instant de saisie devrait être généré en interne lors de l'exécution de l'appel. Question Q-23e60086ab409b24 (ouverte)

Utilisation et contexte d'appel

La fonction ReportEvent de l'en-tête ara/idsm/event_reporter.h sert à signaler un événement de sécurité avec des données de contexte versionnées explicites ainsi qu'un horodatage [SWS_AIDSM_10307]. Elle accepte les données versionnées contextData de type VersionedContextDataType, un horodatage timestamp de type TimestampType ainsi que, de manière optionnelle, le nombre d'événements count de type CountType, qui est préaffecté par défaut avec la valeur 1 [SWS_AIDSM_10307].

Concurrence et traitement des erreurs

La fonction est explicitement spécifiée comme thread-safe [SWS_AIDSM_10307] et peut donc être appelée en toute sécurité en parallèle depuis plusieurs threads. Comme la signature ne prévoit aucune valeur de retour (void) et est déclarée avec noexcept [SWS_AIDSM_10307], les erreurs ne sont signalées ni par des exceptions C++ ni par des codes d'état ; interprétation : les situations d'erreur lors de la transmission de l'événement devraient être traitées ou journalisées en interne par le module aidsm. Question Q-002c5fbc3202bcc2 (ouverte)

Interaction des surcharges

La fonction représente la variante spécialisée pour les événements pour lesquels apparaissent à la fois un horodatage et des données supplémentaires versionnées [SWS_AIDSM_10307]. Elle complète les autres surcharges de ReportEvent au sein du reporter :

• Signalement sans données de contexte ni horodatage [SWS_AIDSM_10302] ou uniquement avec horodatage [SWS_AIDSM_10303].
• Signalement avec données de contexte non versionnées sans horodatage [SWS_AIDSM_10304] ainsi qu'avec horodatage [SWS_AIDSM_10305].
• Signalement avec données de contexte versionnées sans horodatage [SWS_AIDSM_10306].

Utilisation

La fonction ReportEvent est fournie via l'en-tête ara/idsm/event_reporter.h et sert à signaler des événements de sécurité sans données de contexte ni horodatage [SWS_AIDSM_10302]. Elle accepte comme paramètre le nombre d'événements count de type CountType, qui est préaffecté par défaut avec la valeur 1 [SWS_AIDSM_10302]. La fonction ne possède aucune valeur de retour (void) et garantit, via la désignation noexcept, qu'aucune exception n'est levée [SWS_AIDSM_10302]. Concernant la sémantique d'exécution, le traitement devrait s'effectuer de manière non bloquante en interne, étant donné qu'aucun type de retour synchrone d'état ou asynchrone de type future n'est spécifié. Question Q-6e240ebde61d8a83 (ouverte)

Concurrence et traitement des erreurs

Conformément à la spécification, l'appel est classé comme thread-safe et peut donc être invoqué en toute sécurité depuis des threads concurrents [SWS_AIDSM_10302]. Il n'existe pas de codes d'erreur spécifiques, car la signature est fixée à void et noexcept [SWS_AIDSM_10302].

Interaction et alternatives

Cette fonction constitue la surcharge la plus simple pour le signalement d'événements. Dans la mesure où des informations étendues doivent être transmises, des surcharges associées sont disponibles :

• Signalement avec horodatage via TimestampType [SWS_AIDSM_10303].
• Signalement avec données de contexte régulières via ContextDataType [SWS_AIDSM_10304] ainsi que combiné avec un horodatage [SWS_AIDSM_10305].
• Signalement avec données de contexte versionnées via VersionedContextDataType [SWS_AIDSM_10306] ainsi que combiné avec un horodatage [SWS_AIDSM_10307].

La fonction ReportEvent sert à signaler un événement de sécurité en indiquant explicitement un horodatage [SWS_AIDSM_10303]. Elle est déclarée dans l'en-tête ara/idsm/event_reporter.h [SWS_AIDSM_10303].

Utilisation

L'appel s'effectue avec le paramètre obligatoire timestamp de type TimestampType ainsi qu'avec le compteur optionnel count de type CountType, qui est préaffecté avec la valeur par défaut 1 [SWS_AIDSM_10303]. La fonction ne possède aucune valeur de retour (void) [SWS_AIDSM_10303].

Gestion des erreurs et concurrence

La fonction est déclarée comme noexcept, raison pour laquelle aucune exception C++ ne survient [SWS_AIDSM_10303]. Comme le type de retour est void, aucun code d'erreur n'est transmis ; les erreurs survenant devraient donc être rejetées en interne ou journalisées de manière asynchrone [SWS_AIDSM_10303]. Question Q-2d3cd862f6867ba9 (ouverte) Concernant la concurrence, la fonction est classée comme thread-safe et peut être appelée en toute sécurité depuis des threads parallèles [SWS_AIDSM_10303].

Interaction

La fonction fait partie d'une famille d'interfaces ReportEvent surchargées dans le module aidsm :

• Sans horodatage et sans données de contexte, la fonction de base est disponible [SWS_AIDSM_10302].
• Avec des données de contexte régulières de type ContextDataType, il existe des surcharges sans horodatage [SWS_AIDSM_10304] ainsi qu'avec horodatage [SWS_AIDSM_10305].
• Avec des données de contexte versionnées de type VersionedContextDataType, des signatures correspondantes sans horodatage [SWS_AIDSM_10306] et avec horodatage [SWS_AIDSM_10307] sont disponibles.