classe ara::idsm::EventReporter

A classe EventReporter está definida no cabeçalho ara/idsm/event_reporter.h e serve, na Adaptive Platform, para reportar eventos relevantes para a segurança (Security Events) ao Intrusion Detection System Management (IdsM) [SWS_AIDSM_10101].

Uso e instanciação

Para a utilização da classe, é necessário criar uma instância através do construtor parametrizado, que recebe um identificador do tipo const ara::core::InstanceSpecifier& [SWS_AIDSM_10301]. Este construtor inicializa o reporter para a porta do tipo SecurityEventReportInterface configurada no modelo do sistema [SWS_AIDSM_10301]. Interpretação: presume-se que a vinculação à porta modelada pressuponha que o InstanceSpecifier passado esteja definido de forma consistente no manifesto ARXML e possa ser resolvido em tempo de execução. Pergunta Q-ed2f606f7446b4ba (aberta)

Tratamento de erros e simultaneidade

Em relação ao comportamento de exceções, a construção está especificada com noexcept [SWS_AIDSM_10301]; o construtor, portanto, não lança exceptions C++. No que diz respeito à concorrência, a função de construção está declarada explicitamente como thread-safe [SWS_AIDSM_10301]. Interpretação: presume-se, assim, que múltiplas threads possam instanciar paralelamente instâncias de reporter para as suas respectivas portas sem que sejam necessários mecanismos de sincronização externos. Pergunta Q-ddff9884a7b7cad8 (aberta)

Interação

A interação com o IdsM baseia-se na atribuição da instância à respectiva porta de modelagem: por meio da especificação como EventReporter para a SecurityEventReportInterface [SWS_AIDSM_10301], a classe representa a interface através da qual aplicações adaptativas transmitem eventos de segurança para a arquitetura do IdsM [SWS_AIDSM_10101].

usar

A função ReportEvent do cabeçalho ara/idsm/event_reporter.h serve para reportar um Security Event com dados de contexto [SWS_AIDSM_10304]. Na chamada, é passado o argumento contextData do tipo ContextDataType. Adicionalmente, a contagem de eventos pode ser indicada opcionalmente via count (tipo CountType), cujo valor padrão está definido como 1 [SWS_AIDSM_10304]. A função não fornece valor de retorno (void) e, como declaração noexcept, não lança exceções.

Simultaneidade e restrições

A interface é definida explicitamente como thread-safe [SWS_AIDSM_10304] e pode ser chamada em paralelo a partir de múltiplas threads sem medidas adicionais de sincronização. Como a assinatura não disponibiliza um parâmetro para carimbo de data/hora, o registro do momento da notificação deve provavelmente ocorrer internamente no momento da aceitação do evento. Pergunta Q-ab652343cc8009e9 (aberta)

Interação com interfaces correlatas

A especificação define várias sobrecargas correlatas de ReportEvent para diferentes escopos de informação:

• Notificação de um evento sem dados de contexto e carimbo de data/hora [SWS_AIDSM_10302].
• Notificação com carimbo de data/hora, mas sem dados de contexto [SWS_AIDSM_10303].
• Notificação com dados de contexto e carimbo de data/hora explícito [SWS_AIDSM_10305].
• Notificações com dados de contexto versionados do tipo VersionedContextDataType, ou sem carimbo de data/hora [SWS_AIDSM_10306] ou com carimbo de data/hora [SWS_AIDSM_10307].

usar

A função [SWS_AIDSM_10305] transmite um Security Event com dados de contexto específicos da aplicação, bem como um carimbo de data/hora explícito. Através do argumento contextData do tipo ContextDataType, são passados dados úteis relacionados ao evento, enquanto timestamp (tipo const TimestampType) registra o momento exato de captura. O parâmetro opcional count (tipo const CountType) possui o valor padrão 1 e permite reportar múltiplas ocorrências acumuladas. A função não fornece valor de retorno (void).

Simultaneidade e tratamento de erros

A declaração encontra-se no cabeçalho ara/idsm/event_reporter.h e é especificada explicitamente como thread-safe (thread-safe) [SWS_AIDSM_10305]. As chamadas podem, portanto, ocorrer a partir de threads paralelas sem sincronização adicional. Devido à identificação com noexcept, nenhuma exceção é propagada no nível da API; eventuais erros no encaminhamento ou no buffer devem, portanto, ser processados internamente pelo Intrusion Detection System Manager. Pergunta Q-3b45e18c9a106a0f (aberta)

Interação e alternativas

A interface pertence a um grupo de funções de notificação sobrecarregadas. Caso não sejam necessários dados de contexto ou carimbo de data/hora, variantes mais leves como [SWS_AIDSM_10302] (apenas contador), [SWS_AIDSM_10303] (com carimbo de data/hora) bem como [SWS_AIDSM_10304] (apenas com dados de contexto) estão disponíveis. Se formatos de dados estruturados ou versionados forem necessários, devem ser utilizadas em seu lugar as sobrecargas com VersionedContextDataType de acordo com [SWS_AIDSM_10306] e [SWS_AIDSM_10307].

A função ReportEvent disponibiliza no módulo aidsm uma interface para reportar um Security Event enriquecido com dados de contexto versionados [SWS_AIDSM_10306]. Ela está definida no cabeçalho ara/idsm/event_reporter.h e não fornece valor de retorno (void).

Na chamada, são processados os seguintes parâmetros:

• contextData (tipo VersionedContextDataType): passa as informações de contexto versionadas do evento de segurança ocorrido [SWS_AIDSM_10306].
• count (tipo const CountType, valor padrão 1): determina opcionalmente o número de ocorrências acumuladas deste evento [SWS_AIDSM_10306].

No que diz respeito à concorrência, a função é especificada como thread-safe (thread-safe) [SWS_AIDSM_10306]. A declaração com noexcept assegura que a execução não lance exceções C++.

Na interação com as demais funções de notificação, esta sobrecarga cobre um caso de uso específico:

• Para a notificação sem dados de contexto, estão disponíveis as variantes sem carimbo de data/hora [SWS_AIDSM_10302] ou com carimbo de data/hora [SWS_AIDSM_10303].
• Para dados de contexto não versionados (ContextDataType), existem sobrecargas sem carimbo de data/hora [SWS_AIDSM_10304] bem como com carimbo de data/hora [SWS_AIDSM_10305].
• Caso dados de contexto versionados devam ser transmitidos juntamente com um carimbo de data/hora explícito, deve-se utilizar [SWS_AIDSM_10307] em seu lugar. Interpretação: como [SWS_AIDSM_10306] não possui parâmetro de carimbo de data/hora, o momento de captura deve ser gerado internamente na execução da chamada. Pergunta Q-23e60086ab409b24 (aberta)

Utilização e contexto de chamada

A função ReportEvent do cabeçalho ara/idsm/event_reporter.h serve para reportar um Security Event com dados de contexto versionados explícitos bem como um carimbo de data/hora [SWS_AIDSM_10307]. Ela recebe os dados versionados contextData do tipo VersionedContextDataType, um carimbo de data/hora timestamp do tipo TimestampType bem como, opcionalmente, a contagem de eventos count do tipo CountType, a qual é pré-atribuída por padrão com o valor 1 [SWS_AIDSM_10307].

Simultaneidade e tratamento de erros

A função é explicitamente especificada como thread-safe [SWS_AIDSM_10307] e pode, portanto, ser chamada com segurança em paralelo a partir de múltiplas threads. Como a assinatura não prevê valor de retorno (void) e está declarada com noexcept [SWS_AIDSM_10307], os erros não são sinalizados nem via exceções C++ nem via códigos de status; Interpretação: situações de erro na transmissão de eventos devem ser tratadas ou registradas internamente pelo módulo aidsm. Pergunta Q-002c5fbc3202bcc2 (aberta)

Interação das sobrecargas

A função representa a variante especializada para eventos nos quais ocorrem tanto um carimbo de data/hora quanto dados adicionais versionados [SWS_AIDSM_10307]. Ela complementa as demais sobrecargas de ReportEvent dentro do repórter:

• Notificação sem dados de contexto e carimbo de data/hora [SWS_AIDSM_10302] ou puramente com carimbo de data/hora [SWS_AIDSM_10303].
• Notificação com dados de contexto não versionados sem carimbo de data/hora [SWS_AIDSM_10304] bem como com carimbo de data/hora [SWS_AIDSM_10305].
• Notificação com dados de contexto versionados sem carimbo de data/hora [SWS_AIDSM_10306].

usar

A função ReportEvent é disponibilizada através do cabeçalho ara/idsm/event_reporter.h e serve para reportar Security Events sem dados de contexto e carimbo de data/hora [SWS_AIDSM_10302]. Como parâmetro, ela aceita a contagem de eventos count do tipo CountType, a qual é pré-atribuída por padrão com o valor 1 [SWS_AIDSM_10302]. A função não possui valor de retorno (void) e garante, por meio da identificação noexcept, que nenhuma exceção seja lançada [SWS_AIDSM_10302]. Em relação à semântica de execução, o processamento interno não deve ser bloqueante, uma vez que não está especificado nenhum tipo de retorno de status síncrono ou Future assíncrono. Pergunta Q-6e240ebde61d8a83 (aberta)

Simultaneidade e tratamento de erros

De acordo com a especificação, a chamada é classificada como thread-safe e pode, portanto, ser chamada com segurança a partir de threads concorrentes [SWS_AIDSM_10302]. Não existem códigos de erro específicos, uma vez que a assinatura está fixada em void e noexcept [SWS_AIDSM_10302].

Interação e alternativas

A função representa a sobrecarga mais simples para a notificação de eventos. Caso devam ser transmitidas informações estendidas, sobrecargas correlatas estão disponíveis:

• Notificação com carimbo de data/hora via TimestampType [SWS_AIDSM_10303].
• Notificação com dados de contexto regulares via ContextDataType [SWS_AIDSM_10304] bem como combinada com carimbo de data/hora [SWS_AIDSM_10305].
• Notificação com dados de contexto versionados via VersionedContextDataType [SWS_AIDSM_10306] bem como combinada com carimbo de data/hora [SWS_AIDSM_10307].

A função ReportEvent serve para reportar um Security Event sob indicação explícita de um carimbo de data/hora [SWS_AIDSM_10303]. Ela está declarada no cabeçalho ara/idsm/event_reporter.h [SWS_AIDSM_10303].

usar

A chamada ocorre com o parâmetro obrigatório timestamp do tipo TimestampType bem como o contador opcional count do tipo CountType, pré-atribuído com o valor padrão 1 [SWS_AIDSM_10303]. A função não possui valor de retorno (void) [SWS_AIDSM_10303].

Tratamento de erros e simultaneidade

A função está declarada como noexcept, razão pela qual nenhuma exceção C++ ocorre [SWS_AIDSM_10303]. Como o tipo de retorno é void, não são transmitidos códigos de erro; eventuais erros ocorridos devem, portanto, ser descartados internamente ou registrados de forma assíncrona [SWS_AIDSM_10303]. Pergunta Q-2d3cd862f6867ba9 (aberta) Em relação à concorrência, a função é classificada como thread-safe e pode ser chamada com segurança a partir de threads paralelas [SWS_AIDSM_10303].

Interação

A função é parte de uma família de interfaces ReportEvent sobrecarregadas no módulo aidsm:

• Sem carimbo de data/hora e sem dados de contexto, está disponível a função básica [SWS_AIDSM_10302].
• Com dados de contexto regulares do tipo ContextDataType, existem sobrecargas sem carimbo de data/hora [SWS_AIDSM_10304] bem como com carimbo de data/hora [SWS_AIDSM_10305].
• Com dados de contexto versionados do tipo VersionedContextDataType, estão prontas assinaturas correspondentes sem carimbo de data/hora [SWS_AIDSM_10306] e com carimbo de data/hora [SWS_AIDSM_10307].