types

Documentation

Index

• type Details
• type Event
• type Message
• type Producer
• type Request
• type Response
• type Transaction

Types

type Details

type Details struct {
	Accuracy   string   `json:"accuracy"`
	Data       string   `json:"data"`
	File       string   `json:"file"`
	LineNumber string   `json:"lineNumber"`
	Match      string   `json:"match"`
	Maturity   string   `json:"maturity"`
	Reference  string   `json:"reference"`
	Rev        string   `json:"rev"`
	RuleID     string   `json:"ruleId"`
	Severity   string   `json:"severity"`
	Tags       []string `json:"tags"`
	Ver        string   `json:"ver"`
}

Details contains the details related to a single rule firing on a transaction

type Event

type Event struct {
	Transaction Transaction `json:"transaction"`
}

Event is an ModSecurity audit log event in JSON (`SecAuditLogFormat JSON`) Note: this is somewhat particular to the set of SecAuditLogParts we have configured.

type Message

type Message struct {
	Details Details `json:"details"`
	Message string  `json:"message"`
}

Message is the data generated by a single rule firing on a transaction

type Producer

type Producer struct {
	Components     []string `json:"components"`
	Connector      string   `json:"connector"`
	Modsecurity    string   `json:"modsecurity"`
	SecrulesEngine string   `json:"secrules_engine"`
}

Producer identifies the components/versions of the software that generated the alert

type Request

type Request struct {
	Headers     map[string]string `json:"headers"`
	HTTPVersion float64           `json:"http_version"`
	Method      string            `json:"method"`
	URI         string            `json:"uri"`
}

Request contains details about the HTTP request in the transaction

type Response

type Response struct {
	HTTPCode int `json:"http_code"`
}

Response contains details about the HTTP response in the transaction

type Transaction

type Transaction struct {
	ClientIP   string    `json:"client_ip"`
	ClientPort int       `json:"client_port"`
	HostIP     string    `json:"host_ip"`
	HostPort   int       `json:"host_port"`
	ID         string    `json:"id"`
	Messages   []Message `json:"messages"`
	Producer   Producer  `json:"producer"`
	Request    Request   `json:"request"`
	Response   Response  `json:"response"`
	ServerID   string    `json:"server_id"`
	TimeStamp  string    `json:"time_stamp"`
}

Transaction reprsents a single ModSecurity transaction (request->processing->response)