klasse ara::idsm::EventReporter

De klasse EventReporter is gedefinieerd in header ara/idsm/event_reporter.h en dient in het Adaptive Platform voor het melden van veiligheidsrelevante gebeurtenissen (Security Events) aan het Intrusion Detection System Management (IdsM) [SWS_AIDSM_10101].

Gebruik en instantiëring

Voor het gebruik van de klasse moet een instantie worden aangemaakt via de geparametriseerde constructor, die een identifier van het type const ara::core::InstanceSpecifier& accepteert [SWS_AIDSM_10301]. Deze constructor initialiseert de reporter voor de in het systeemmodel geconfigureerde poort van het type SecurityEventReportInterface [SWS_AIDSM_10301]. Interpretatie: De binding aan de gemodelleerde poort vereist vermoedelijk dat de meegegeven InstanceSpecifier in het ARXML-manifest consistent gedefinieerd en tijdens runtime oplosbaar is. Vraag Q-ed2f606f7446b4ba (open)

Foutafhandeling en gelijktijdigheid

Wat betreft het exceptiegedrag is de constructie met noexcept gespecificeerd [SWS_AIDSM_10301]; de constructor genereert zodoende geen C++-exceptions. Met betrekking tot gelijktijdigheid is de constructiefunctie expliciet als thread-safe gedeclareerd [SWS_AIDSM_10301]. Interpretatie: Meerdere threads kunnen vermoedelijk parallel reporter-instanties voor hun respectievelijke poorten instantiëren, zonder dat externe synchronisatiemechanismen vereist zijn. Vraag Q-ddff9884a7b7cad8 (open)

Samenspel

De interactie met het IdsM is gebaseerd op de toewijzing van de instantie aan de desbetreffende modelleringspoort: Door de specificatie als EventReporter voor het SecurityEventReportInterface [SWS_AIDSM_10301] vormt de klasse de interface waarmee adaptieve applicaties veiligheidsgebeurtenissen naar de IdsM-architectuur verzenden [SWS_AIDSM_10101].

Gebruik

De functie ReportEvent uit de header ara/idsm/event_reporter.h dient voor het melden van een security event met contextgegevens [SWS_AIDSM_10304]. Bij de aanroep wordt het argument contextData van het type ContextDataType meegegeven. Daarnaast kan optioneel het aantal gebeurtenissen via count (type CountType) worden opgegeven, waarvan de standaardwaarde is vastgelegd op 1 [SWS_AIDSM_10304]. De functie levert geen retourwaarde (void) en werpt als noexcept-declaratie geen exceptions.

Gelijktijdigheid en beperkingen

De interface is expliciet gedefinieerd als thread-safe [SWS_AIDSM_10304] en kan zonder aanvullende synchronisatiemaatregelen parallel worden aangeroepen vanuit meerdere threads. Aangezien de signatuur geen parameter voor een tijdstempel biedt, vindt de registratie van het meldtijdstip vermoedelijk intern plaats bij acceptatie van de gebeurtenis. Vraag Q-ab652343cc8009e9 (open)

Interactie met verwante interfaces

De specificatie definieert meerdere verwante overloads van ReportEvent voor verschillende informatieomvangen:

• Melding van een gebeurtenis zonder contextgegevens en tijdstempel [SWS_AIDSM_10302].
• Melding met tijdstempel, maar zonder contextgegevens [SWS_AIDSM_10303].
• Melding met contextgegevens en expliciete tijdstempel [SWS_AIDSM_10305].
• Meldingen met geversioneerde contextgegevens van het type VersionedContextDataType, hetzij zonder tijdstempel [SWS_AIDSM_10306] hetzij met tijdstempel [SWS_AIDSM_10307].

Gebruik

De functie [SWS_AIDSM_10305] verzendt een security event met applicatiespecifieke contextgegevens en een expliciete tijdstempel. Via het argument contextData van het type ContextDataType worden gebeurtenisgerelateerde payloadgegevens overgedragen, terwijl timestamp (type const TimestampType) het exacte registratietijdstip vastlegt. De optionele parameter count (type const CountType) heeft de standaardwaarde 1 en maakt het melden van meerdere gecumuleerde incidenten mogelijk. De functie levert geen retourwaarde (void).

Gelijktijdigheid en foutafhandeling

De declaratie bevindt zich in de header ara/idsm/event_reporter.h en is expliciet gespecificeerd als thread-safe (thread-safe) [SWS_AIDSM_10305]. Aanroepen kunnen derhalve zonder extra synchronisatie worden uitgevoerd vanuit parallelle threads. Door de aanduiding met noexcept worden op API-niveau geen excepties gepropageerd; eventuele fouten bij het doorsturen of bufferen worden daarom vermoedelijk intern verwerkt door de Intrusion Detection System Manager. Vraag Q-3b45e18c9a106a0f (open)

Interactie en alternatieven

De interface behoort tot een groep overladen rapportagefuncties. Indien er geen contextgegevens of tijdstempels vereist zijn, staan lichtere varianten zoals [SWS_AIDSM_10302] (alleen teller), [SWS_AIDSM_10303] (met tijdstempel) en [SWS_AIDSM_10304] (alleen met contextgegevens) ter beschikking. Worden gestructureerde respectievelijk geversioneerde gegevensformaten vereist, dan moeten in plaats daarvan de overloads met VersionedContextDataType conform [SWS_AIDSM_10306] en [SWS_AIDSM_10307] worden toegepast.

De functie ReportEvent biedt in module aidsm een interface voor het melden van een security event dat is verrijkt met geversioneerde contextgegevens [SWS_AIDSM_10306]. Zij is gedefinieerd in header ara/idsm/event_reporter.h en levert geen retourwaarde (void).

Bij de aanroep worden de volgende parameters verwerkt:

• contextData (type VersionedContextDataType): draagt de geversioneerde contextinformatie van het opgetreden beveiligingsincident over [SWS_AIDSM_10306].
• count (type const CountType, standaardwaarde 1): bepaalt optioneel het aantal gecumuleerde incidenten van dit event [SWS_AIDSM_10306].

Met betrekking tot concurrency is de functie gespecificeerd als thread-safe (thread-safe) [SWS_AIDSM_10306]. Door de declaratie met noexcept is gewaarborgd dat de uitvoering geen C++-excepties gooit.

In samenspel met de overige meldfuncties dekt deze overload een specifieke use-case af:

• Voor meldingen zonder contextgegevens staan de varianten zonder tijdstempel [SWS_AIDSM_10302] of met tijdstempel [SWS_AIDSM_10303] ter beschikking.
• Voor niet-geversioneerde contextgegevens (ContextDataType) bestaan overloads zonder tijdstempel [SWS_AIDSM_10304] en met tijdstempel [SWS_AIDSM_10305].
• Moeten geversioneerde contextgegevens samen met een expliciete tijdstempel worden verzonden, dan moet in plaats daarvan [SWS_AIDSM_10307] worden gebruikt. Interpretatie: aangezien [SWS_AIDSM_10306] geen tijdstempelparameter heeft, wordt het registratietijdstip vermoedelijk intern gegenereerd bij het uitvoeren van de aanroep. Vraag Q-23e60086ab409b24 (open)

Gebruik en aanroepcontext

De functie ReportEvent uit de header ara/idsm/event_reporter.h dient voor het melden van een security event met expliciete geversioneerde contextgegevens en een tijdstempel [SWS_AIDSM_10307]. Zij accepteert de geversioneerde gegevens contextData van het type VersionedContextDataType, een tijdstempel timestamp van het type TimestampType en optioneel het aantal gebeurtenissen count van het type CountType, dat standaard is vooringesteld met de waarde 1 [SWS_AIDSM_10307].

Gelijktijdigheid en foutafhandeling

De functie is expliciet gespecificeerd als thread-safe [SWS_AIDSM_10307] en kan dus veilig parallel vanuit meerdere threads worden aangeroepen. Aangezien de signatuur niet voorziet in een retourwaarde (void) en is gedeclareerd met noexcept [SWS_AIDSM_10307], worden fouten noch via C++-exceptions noch via statuscodes gesignaleerd; interpretatie: foutsituaties bij de gebeurtenisoverdracht worden vermoedelijk intern afgehandeld of geprotocolleerd door module aidsm. Vraag Q-002c5fbc3202bcc2 (open)

Interactie tussen de overloads

De functie vertegenwoordigt de gespecialiseerde variant voor gebeurtenissen waarbij zowel een tijdstempel als geversioneerde aanvullende gegevens optreden [SWS_AIDSM_10307]. Zij vormt een aanvulling op de overige overloads van ReportEvent binnen de reporter:

• Melding zonder contextgegevens en tijdstempel [SWS_AIDSM_10302] of louter met tijdstempel [SWS_AIDSM_10303].
• Melding met niet-geversioneerde contextgegevens zonder tijdstempel [SWS_AIDSM_10304] en met tijdstempel [SWS_AIDSM_10305].
• Melding met geversioneerde contextgegevens zonder tijdstempel [SWS_AIDSM_10306].

Gebruik

De functie ReportEvent wordt beschikbaar gesteld via de header ara/idsm/event_reporter.h en dient voor het melden van security events zonder contextgegevens en tijdstempel [SWS_AIDSM_10302]. Als parameter accepteert deze het aantal gebeurtenissen count van het type CountType, dat standaard is vooringesteld op de waarde 1 [SWS_AIDSM_10302]. De functie heeft geen retourwaarde (void) en garandeert via de markering noexcept dat er geen uitzonderingen worden geworpen [SWS_AIDSM_10302]. Wat betreft de uitvoeringssemantiek vindt de verwerking intern vermoedelijk niet-blokkerend plaats, aangezien er geen synchroon status- of asynchroon future-retourtype is gespecificeerd. Vraag Q-6e240ebde61d8a83 (open)

Gelijktijdigheid en foutafhandeling

Volgens de specificatie is de aanroep geclassificeerd als thread-safe en kan deze dus veilig worden aangeroepen vanuit concurrente threads [SWS_AIDSM_10302]. Specifieke foutcodes bestaan niet, aangezien de signatuur is vastgelegd op void en noexcept [SWS_AIDSM_10302].

Interactie en alternatieven

De functie vormt de eenvoudigste overload voor het melden van gebeurtenissen. Indien uitgebreide informatie moet worden doorgegeven, staan verwante overloads ter beschikking:

• Melding met tijdstempel via TimestampType [SWS_AIDSM_10303].
• Melding met reguliere contextgegevens via ContextDataType [SWS_AIDSM_10304] evenals gecombineerd met tijdstempel [SWS_AIDSM_10305].
• Melding met geversioneerde contextgegevens via VersionedContextDataType [SWS_AIDSM_10306] evenals gecombineerd met tijdstempel [SWS_AIDSM_10307].

De functie ReportEvent dient voor het melden van een security event onder expliciete vermelding van een tijdstempel [SWS_AIDSM_10303]. Zij is gedeclareerd in header ara/idsm/event_reporter.h [SWS_AIDSM_10303].

Gebruik

De aanroep geschiedt met de verplichte parameter timestamp van het type TimestampType en de optionele teller count van het type CountType, die is vooringesteld met de standaardwaarde 1 [SWS_AIDSM_10303]. De functie heeft geen retourwaarde (void) [SWS_AIDSM_10303].

Foutafhandeling en gelijktijdigheid

De functie is gedeclareerd als noexcept, waardoor er geen C++-exceptions optreden [SWS_AIDSM_10303]. Omdat het retourtype void is, worden er geen foutcodes overgedragen; opgetreden fouten worden intern daarom vermoedelijk verworpen of asynchroon geprotocolleerd [SWS_AIDSM_10303]. Vraag Q-2d3cd862f6867ba9 (open) Wat betreft de concurrency is de functie geclassificeerd als thread-safe en kan deze veilig worden aangeroepen vanuit parallelle threads [SWS_AIDSM_10303].

Samenspel

De functie maakt deel uit van een familie van overladen ReportEvent-interfaces in de module aidsm:

• Zonder tijdstempel en zonder contextgegevens staat de basisfunctie ter beschikking [SWS_AIDSM_10302].
• Met reguliere contextgegevens van het type ContextDataType bestaan overloads zonder tijdstempel [SWS_AIDSM_10304] en met tijdstempel [SWS_AIDSM_10305].
• Met geversioneerde contextgegevens van het type VersionedContextDataType staan overeenkomstige signaturen zonder tijdstempel [SWS_AIDSM_10306] en met tijdstempel [SWS_AIDSM_10307] klaar.