Common structure elements. More...

#include <security_events_defs.h>

Collaboration diagram for ast_security_event_common:

Data Fields
const char *	account_id
	Account ID, specific to the service type. More...

enum ast_security_event_type	event_type
	The security event sub-type. More...

struct ast_security_event_ip_addr	local_addr
	Local address the request came in on. More...

const char *	module
	Module, Normally the AST_MODULE define. More...

struct ast_security_event_ip_addr	remote_addr
	Remote address the request came from. More...

const char *	service
	Service that generated the event. More...

const char *	session_id
	Session ID, specific to the service type. More...

const struct timeval *	session_tv
	Session timeval, when the session started. More...

uint32_t	version
	security event version More...

Detailed Description

Common structure elements.

This is the structure header for all event descriptor structures defined below. The contents of this structure are very important and must not change. Even though these structures are exposed via a public API, we have a version field that can be used to ensure ABI safety. If the event descriptors need to be changed or updated in the future, we can safely do so and can detect ABI changes at runtime.

Definition at line 156 of file security_events_defs.h.

Field Documentation

◆ account_id

const char* account_id

Account ID, specific to the service type.

Note: optional/required, depending on event type

Definition at line 177 of file security_events_defs.h.

◆ event_type

enum ast_security_event_type event_type

The security event sub-type.

Definition at line 158 of file security_events_defs.h.

Referenced by alloc_security_event_json_object(), ast_security_event_report(), ast_sip_report_auth_challenge_sent(), ast_sip_report_auth_failed_challenge_response(), ast_sip_report_auth_success(), ast_sip_report_failed_acl(), ast_sip_report_invalid_endpoint(), ast_sip_report_mem_limit(), ast_sip_report_req_no_support(), evt_gen_auth_method_not_allowed(), evt_gen_chal_resp_failed(), evt_gen_chal_sent(), evt_gen_failed_acl(), evt_gen_inval_acct_id(), evt_gen_inval_password(), evt_gen_inval_transport(), evt_gen_load_avg(), evt_gen_mem_limit(), evt_gen_req_bad_format(), evt_gen_req_no_support(), evt_gen_req_not_allowed(), evt_gen_successful_auth(), evt_gen_unexpected_addr(), handle_security_event(), report_auth_success(), report_failed_acl(), report_failed_challenge_response(), report_inval_password(), report_invalid_user(), report_req_bad_format(), and report_req_not_allowed().

◆ local_addr

struct ast_security_event_ip_addr local_addr

Local address the request came in on.

Note: Always required

Definition at line 192 of file security_events_defs.h.

◆ module

const char* module

Module, Normally the AST_MODULE define.

Note: Always optional

Definition at line 172 of file security_events_defs.h.

◆ remote_addr

struct ast_security_event_ip_addr remote_addr

Remote address the request came from.

Note: Always required

Definition at line 197 of file security_events_defs.h.

◆ service

const char* service

Service that generated the event.

Note: Always required

Examples: "SIP", "AMI"

Definition at line 167 of file security_events_defs.h.

Referenced by alloc_security_event_json_object().

◆ session_id

const char* session_id

Session ID, specific to the service type.

Note: Always required

Definition at line 182 of file security_events_defs.h.

◆ session_tv

const struct timeval* session_tv

Session timeval, when the session started.

Note: Always optional

Definition at line 187 of file security_events_defs.h.

◆ version

uint32_t version

security event version

Definition at line 160 of file security_events_defs.h.

Referenced by alloc_security_event_json_object(), ast_security_event_report(), and ParsingContext::next().

The documentation for this struct was generated from the following file:

security_events_defs.h

Data Fields