securityviolationsprocessor

package
v3.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 8, 2025 License: Apache-2.0 Imports: 17 Imported by: 0

README

SecurityViolations Processor

Internal component of the NGINX Agent that processes security violation syslog messages. Parses RFC3164 formatted syslog entries from log records and extracts structured attributes. Successfully parsed messages have their body replaced with the clean message content.

Part of the NGINX Agent's log collection pipeline.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewFactory

func NewFactory() processor.Factory

NewFactory creates a factory for the securityviolations processor.

Types

type ContextData

type ContextData struct {
	Name  string `json:"context_data_name"`
	Value string `json:"context_data_value"`
}

ContextData represents the context data of the violation

type SecurityViolationEvent

type SecurityViolationEvent struct {
	PolicyName               string          `json:"policy_name"`
	SupportID                string          `json:"support_id"`
	Outcome                  string          `json:"outcome"`
	OutcomeReason            string          `json:"outcome_reason"`
	BlockingExceptionReason  string          `json:"blocking_exception_reason"`
	Method                   string          `json:"method"`
	Protocol                 string          `json:"protocol"`
	XForwardedForHeaderValue string          `json:"xff_header_value"`
	URI                      string          `json:"uri"`
	Request                  string          `json:"request"`
	IsTruncated              string          `json:"is_truncated"`
	RequestStatus            string          `json:"request_status"`
	ResponseCode             string          `json:"response_code"`
	ServerAddr               string          `json:"server_addr"`
	VSName                   string          `json:"vs_name"`
	RemoteAddr               string          `json:"remote_addr"`
	RemotePort               string          `json:"destination_port"`
	ServerPort               string          `json:"server_port"`
	Violations               string          `json:"violations"`
	SubViolations            string          `json:"sub_violations"`
	ViolationRating          string          `json:"violation_rating"`
	SigSetNames              string          `json:"sig_set_names"`
	SigCVEs                  string          `json:"sig_cves"`
	ClientClass              string          `json:"client_class"`
	ClientApplication        string          `json:"client_application"`
	ClientApplicationVersion string          `json:"client_application_version"`
	Severity                 string          `json:"severity"`
	ThreatCampaignNames      string          `json:"threat_campaign_names"`
	BotAnomalies             string          `json:"bot_anomalies"`
	BotCategory              string          `json:"bot_category"`
	EnforcedBotAnomalies     string          `json:"enforced_bot_anomalies"`
	BotSignatureName         string          `json:"bot_signature_name"`
	SystemID                 string          `json:"system_id"`
	InstanceTags             string          `json:"instance_tags"`
	InstanceGroup            string          `json:"instance_group"`
	ParentHostname           string          `json:"parent_hostname"`
	DisplayName              string          `json:"display_name"`
	ViolationsData           []ViolationData `json:"violations_data"`
}

SecurityViolationEvent represents the structured NGINX App Protect security violation data

type SignatureData

type SignatureData struct {
	ID           string `json:"sig_data_id"`
	BlockingMask string `json:"sig_data_blocking_mask"`
	Buffer       string `json:"sig_data_buffer"`
	Offset       string `json:"sig_data_offset"`
	Length       string `json:"sig_data_length"`
}

SignatureData represents signature data contained within each violation

type ViolationData

type ViolationData struct {
	Name        string          `json:"violation_data_name"`
	Context     string          `json:"violation_data_context"`
	ContextData ContextData     `json:"violation_data_context_data"`
	Signatures  []SignatureData `json:"violation_data_signatures"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL