open-appsec
WebsiteManagement PortalPlaygroundGitHub
  • open-appsec Documentation
  • What is open-appsec?
  • open-appsec Video Tutorials
  • Release Notes
  • Getting started
    • Getting Started
    • Start With Kubernetes
      • Install Using Interactive CLI Tool (Ingress NGINX)
      • Configuration Using Interactive CLI Tool
      • Install Using Helm
      • Install Using Helm - new flow (beta)
      • Configuration Using CRDs
      • Configuration Using CRDs - v1beta2
      • Configuration using CRDs - special options for Large Scale Deployments
        • Using appsec class for assigning separate custom resources to specific deployments
        • Using namespace-scoped custom resources
      • Monitor Events
    • Start With Linux
      • Install open-appsec for Linux
      • Using the open-appsec-ctl Tool
      • Configuration Using Local Policy File (Linux)
      • Local Policy File (Advanced)
      • Local Policy File v1beta2 (beta)
      • Monitor Events
    • Start with Docker
      • Install With Docker (Centrally Managed)
      • Install With Docker (Locally Managed)
      • Deploy With Docker-Compose (Beta)
      • Configuration Using Local Policy File (Docker)
      • Local Policy File (Advanced)
    • Using the Web UI (SaaS)
      • Sign-Up and Login to Portal
      • Agents Deployment
      • Connect Deployed Agents to SaaS Management Using Tool (K8s & Linux)
      • Connect Deployed Agents to SaaS Management Using Helm (K8s)
      • Connect Deployed Agents to SaaS Management (Docker)
      • Create a Profile
      • Protect Additional Assets
      • Monitor Events
    • Using the Advanced Machine Learning Model
  • Concepts
    • Agents
    • Management & Automation
    • Security Practices
    • Contextual Machine Learning
  • SETUP INSTRUCTIONS
    • Setup Web Application Settings
    • Setup Custom Rules and Exceptions
    • Setup Web User Response Pages
    • Setup Log Triggers
    • Setup Behavior Upon Failure
    • Setup Agent Upgrade Schedule
  • Additional Security Engines
    • Anti-Bot
    • API Schema Enforcement
    • Data Loss Prevention (DLP) Rules
    • File Security
    • Intrusion Prevention System (IPS)
    • Rate Limit
  • Snort Rules
    • Import Snort Rules
    • Write Snort Signatures
  • HOW TO
    • Configuration and Learning
      • Track Learning and Move From Learn/Detect to Prevent
      • Configure Contextual Machine Learning for Best Accuracy
      • Track Learning and Local Tuning in Standalone Deployments
      • Move From Detect to Prevent in K8s With Many Ingress Rules
  • Deployment and Upgrade
    • Load the Attachment in Proxy Configuration
    • Upgrade Your Reverse Proxy/API Gateway When an Agent is Installed
    • Integration in GitOps CD (K8s)
    • Build open-appsec Based on Source Code
  • Management Web UI
    • Track Agent Status
    • Delete or Reset Management Tenant (SaaS)
    • Disconnect an open-appsec agent from Central Management
  • Integrations
    • About Integrations With 3rd Party Solutions
    • CrowdSec
      • CrowdSec Bouncer Support
      • CrowdSec Intelligence Sharing Using open-appsec Parser/Scenario
    • NGINX Proxy Manager
      • Install NGINX Proxy Manager with open-appsec managed from NPM WebUI
      • Install NGINX Proxy Manager with open-appsec managed from central WebUI (SaaS)
      • Frequently Asked Questions
      • How to Migrate from an Existing NGINX Proxy Manager Deployment and Keep Configuration
    • NPMplus
    • Docker SWAG
      • Install Docker SWAG with open-appsec (locally managed)
      • How to connect locally managed Docker SWAG with open-appsec to WebUI
      • Install Docker SWAG with open-appsec (centrally managed)
      • Deploy Docker SWAG with docker-compose (beta)
      • Frequently Asked Questions
  • Prometheus
  • Troubleshooting
    • Troubleshooting
    • Troubleshooting Guides
      • Configuration contains ingress/asset with URL which already has asset attached to it in your tenant
      • HTTP Request to Port 80 Not Returning as Expected
      • Agent Fails to Recognize HTTP Transactions with NGINX
      • Agent Not Recognizing Initial HTTP Requests
      • Handling Large Requests (413 Responses)
      • open-appsec on Docker HTTP Transaction Handler Is Set To Ready
      • Traffic Recognition Issue on Single-Core Machine/Connection Timed Out
      • Installing open-appsec on CentOS 7
      • SELinux: checking status and disabling
      • Deploy open-appsec directly on the web server hosting the application to protect
      • object is locked or remote, and therefore cannot be modified
      • Failed to Register to Fog
  • references
    • Agent CLI
    • Event Query Language
    • Events/Logs Schema
    • WAF Comparison Project
Powered by GitBook
On this page
  • Schema in openAPI format
  • Log fields

Was this helpful?

  1. references

Events/Logs Schema

PreviousEvent Query LanguageNextWAF Comparison Project

Last updated 1 month ago

Was this helpful?

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 in the cloud application and log parsing to be done on the Syslog/CEF side (see configuration of 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

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 Body

httprequestbody (httpRequestBody)

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.

HTTP Request Headers (Sent only if relevant additional logging is configured on the object that was used).

HTTP Request Body (Sent only if relevant additional logging is configured on the object that was used). Body will be truncated if too long.

trigger
trigger
filter queries
Trigger objects
28KB
agents-security-logs-openapi-schema-v1.0.4.json