Events/Logs Schema
When events are sent from CloudGuard WAF 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.
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 |
---|---|---|
|
| Time of the event in UTC. |
|
| This field describes the event in text. |
|
| Info, Low, Medium, High, Critical |
|
| Low, Medium, High, Urgent |
|
| Low, Medium, High, Very High (The higher the confidence level, the less likely it is the event is a false-positive) |
| e | 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. |
|
| UUID of the agent creating the log, if applicable. |
|
| The agent's and service's version sending reporting this event. |
|
| The action taken by the security practice upon this event. |
|
| The name of the asset, protected by the security practice that found a match and issued this log. |
|
| The object ID of the asset, protected by the security practice that found a match and issued this log. |
|
| The name of the zone, protected by the security practice that found a match and issued this log. |
|
| 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. |
|
| The type of the security practice that found a match and issued this log (e.g. "Threat Prevention"). |
|
| The subtype of the security practice that found a match and issued this log (e.g. "Web Application"). |
|
| The name of the security practice that found a match and issued this log. |
|
| 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 address of the network traffic that caused the matched event. |
|
| Source TCP/UDP Port of the network traffic that caused the matched event. |
|
| Source country name of the network traffic that caused the matched event, if applicable. |
|
| Destination IP address of the network traffic that caused the matched event. |
|
| Destination TCP/UDP Port of the network traffic that caused the matched event. |
|
| Destination country of the network traffic that caused the matched event, if applicable. |
|
| IP Protocol of the network traffic that caused the matched event. |
|
| 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.). |
|
| 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 as determined from the HTTP traffic (e.g. GET, POST, etc.). |
|
| HTTP URI path as determined from the HTTP traffic. |
|
| HTTP URI query as determined from the HTTP traffic. |
|
| HTTP Request Headers (Sent only if relevant additional logging is configured on the trigger object that was used). |
|
| 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. |
|
| CloudGuard WAF incident types (e.g. LDAP injection, SQL injection, etc.). |
|
| A more granular description of the event caught by CloudGuard WAF. |
|
| CloudGuard WAF user reputation for the identified source. |
|
| The location within the HTTP traffic where an indicator, causing this event, was detected (e.g. "referer parameter"). |
|
| The parameter name within the HTTP traffic, where an indicator, causing this event, was detected (e.g. "uuid"). |
|
| The traffic data where the indicators were detected and created the event. |
|
| 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). |
|
| The detected indicators which created the event. |
|
| Override configuration for this event. |
|
| Constant value of 'Security' for events sent to user. |
|
| For future use. |
Last updated