Events/Logs Schema

When events are sent from open-appsec agents to be viewed in the cloud application and/or to a Syslog/CEF server, they are sent in a specific field structure.

This page will document the fields being sent. This will allow filter queries in the cloud application and log parsing to be done on the Syslog/CEF side (see configuration of Trigger objects for more info).

Schema in openAPI format

See below the security logs schema in openAPI format.

28KB

agents-security-logs-openapi-schema-v1.0.4.json

The definitions per field are relevant even when the logs aren't sent in JSON format.

Log fields

This table shows the predefined field keywords alongside their view name in the logs table and log cards.

in brackets for each field name is the name when sent to syslog/CEF. Usually the difference is simply an all-lowercase format vs lowerCamelCase

Field Name in Log View	Field Name	Description
Event Name	eventname (title - for syslog only)	This field describes the event in text.
Severity	eventseverity (eventSeverity)	Info, Low, Medium, High, Critical
Priority	eventpriority (eventPriority)	Low, Medium, High, Urgent
Confidence Level	eventconfidence (eventConfidence)	Low, Medium, High, Very High (The higher the confidence level, the less likely it is the event is a false-positive)
Event Reference Id	eventreferenceid (eventReferenceId)	Some events result in showing the user a reference ID (for example when showing an HTTP response page upon prevention). This reference ID will correlate to this field in the log.
Agent UUID	agentid (agentId)	UUID of the agent creating the log, if applicable.
Issuing Engine Version	issuingengineversion (issuingEngineVersion)	The agent's and service's version sending reporting this event.
Security Action	securityaction (securityAction)	The action taken by the security practice upon this event.
Asset Name	assetname (assetName)	The name of the asset, protected by the security practice that found a match and issued this log.
Asset ID	assetid (assetId)	The object ID of the asset, protected by the security practice that found a match and issued this log.
Zone Name	zonename (zoneName)	The name of the zone, protected by the security practice that found a match and issued this log.
Zone ID	zoneid (zoneId)	The object ID of the zone, protected by the security practice that found a match and issued this log. This can be used unique searches when given names are similar.
Practice Type	practicetype (practiceType)	The type of the security practice that found a match and issued this log (e.g. "Threat Prevention").
Practice SubType	practicesubtype (practiceSubType)	The subtype of the security practice that found a match and issued this log (e.g. "Web Application").
Practice Name	practicename (practiceName)	The name of the security practice that found a match and issued this log.
Practice ID	practiceid (practiceId)	The object UUID of the security practice that found a match and issued this log. This can be used unique searches when given names are similar.
Source IP	sourceip (sourceIp)	Source IP address of the network traffic that caused the matched event.
Source Port	sourceport (sourcePort)	Source TCP/UDP Port of the network traffic that caused the matched event.
Source Country	sourcecountryname (sourceCountryName)	Source country name of the network traffic that caused the matched event, if applicable.
Destination IP	destinationip (destinationIp)	Destination IP address of the network traffic that caused the matched event.
Destination Port	destinationport (destinationPort)	Destination TCP/UDP Port of the network traffic that caused the matched event.
Destination Country	destinationcountryname (destinationCountryName)	Destination country of the network traffic that caused the matched event, if applicable.
IP Protocol	ipprotocol (ipProtocol)	IP Protocol of the network traffic that caused the matched event.
Source Identifier	httpsourceid (httpSourceId)	The source identifier as determined from the HTTP traffic according to configuration (according to the X-Forwarded-For header, a cookie, source IP address, etc.).
HTTP Host	httphostname (httpHostName)	The source identifier as determined from the HTTP traffic according to configuration (according to the X-Forwarded-For header, a cookie, source IP address, etc.).
HTTP Method	httpmethod (httpMethod)	HTTP Method as determined from the HTTP traffic (e.g. GET, POST, etc.).
HTTP URI Path	httpuripath (httpUriPath)	HTTP URI path as determined from the HTTP traffic.
HTTP URI Query	httpuriquery (httpUriQuery)	HTTP URI query as determined from the HTTP traffic.
HTTP Request Headers	httprequestheaders (httpRequestHeaders)	HTTP Request Headers (Sent only if relevant additional logging is configured on the trigger object that was used).
HTTP Request Body	httprequestbody (httpRequestBody)	HTTP Request Body (Sent only if relevant additional logging is configured on the trigger object that was used). Body will be truncated if too long.
Incident Type	waapincidenttype (waapIncidentType)	AppSec incident types (e.g. LDAP injection, SQL injection, etc.).
Incident Details	waapincidentdetails (waapIncidentDetails)	A more granular description of the event caught by appSec.
User Reputation	waapuserreputation (waapUserReputation)	AppSec user reputation for the identified source.
Matched Location	matchedlocation (matchedLocation)	The location within the HTTP traffic where an indicator, causing this event, was detected (e.g. "referer parameter").
Matched Parameter	matchedparameter (matchedParameter)	The parameter name within the HTTP traffic, where an indicator, causing this event, was detected (e.g. "uuid").
Matched Sample	matchedsample (matchedSample)	The traffic data where the indicators were detected and created the event.
Match Reason	matchreason (matchReason)	An additional elaboration for the reason the event was detected (For example, when Web API Schema validation fails, this field will detail what exactly failed).
Found Indicators	waapfoundindicators (waapFoundIndicators)	The detected indicators which created the event.
Practice Override	waapoverride (waapOverride)	Override configuration for this event.