diff --git a/filters/audits/sonicwall.md b/filters/audits/sonicwall.md new file mode 100644 index 000000000..da4fb8de0 --- /dev/null +++ b/filters/audits/sonicwall.md @@ -0,0 +1,40 @@ +# SonicWall normalization and rule review + +Validate standard IPs and translate numeric IP protocol identifiers. + +This draft targets UTMStack `v11`. It contains 1 filter changes +and 0 rule changes for this technology only. Review covered +1 filter configurations and 7 matching shipped rule files. +Unchanged rules are listed in the regression manifest; they are not duplicated in the diff. + +## Contract and validation + +- Compared exact standard names/types with go-sdk v1.1.31 and the supplied UTMStack dictionaries. +- Checked documented pipeline ordering, rename/move behavior, open vendor log fields, + event-side versus alert-side fields, and surviving fields used by affected rule predicates/history/grouping. +- Strict SDK configuration decoding and actual CEL compilation pass for this scope. +- 3 synthetic normalization cases pass, including SDK Event conversion and any + trigger predicate assertions recorded in the manifest. +- The scoped alerts module tests and `git diff --check` pass with the shared contract runner applied. + +The shared alert-contract PR supplies the reusable Go runner for the manifest in +`plugins/alerts/testdata/filter-contracts/sonicwall.json`. Apply that support before running `go test ./...` in `plugins/alerts`. + +The model starts from synthetic extraction results. It does not run complex grok, +JSON/KV/XML/CSV extraction, time conversion, dynamic plugins, historical OpenSearch +queries, or the closed EventProcessor. Raw vendor logs and resulting alerts must +still be checked in staging before rollout. No customer false-positive reduction +has been measured and no production rollout is included. + + + +## References + +- [SDK schema](https://github.com/threatwinds/go-sdk/blob/v1.1.31/plugins/plugins.proto) +- [Filter steps](https://github.com/threatwinds/go-sdk/wiki/Filter-Steps-Reference) +- [Standard event schema](https://github.com/threatwinds/go-sdk/wiki/Standard-Event-Schema) +- [Rule implementation](https://github.com/threatwinds/go-sdk/wiki/Implementing-Rules) + +`afterEvents`, empty noncapturing grok names, supported numeric strings, and custom +`log.*` fields are accepted. Existing textual protocol casing and vendor action names +are preserved unless a concrete consumer mismatch requires correction. diff --git a/filters/sonicwall/sonic_wall.yml b/filters/sonicwall/sonic_wall.yml index d20d7b247..f9034a804 100644 --- a/filters/sonicwall/sonic_wall.yml +++ b/filters/sonicwall/sonic_wall.yml @@ -852,3 +852,68 @@ pipeline: - log.cefVersion - log.fwaction - log.grokTrash + + # Keep addresses in IP fields and retain other source values under log. + - rename: + from: + - origin.ip + to: log.unparsedOriginIp + where: exists("origin.ip") && (!(inCIDR("origin.ip","0.0.0.0/0") || inCIDR("origin.ip","::/0")) || oneOf("origin.ip",["0.0.0.0","::"])) + - rename: + from: + - target.ip + to: log.unparsedTargetIp + where: exists("target.ip") && (!(inCIDR("target.ip","0.0.0.0/0") || inCIDR("target.ip","::/0")) || oneOf("target.ip",["0.0.0.0","::"])) + - add: + function: string + params: + key: protocol + value: ICMP + where: equals("protocol",1) + - add: + function: string + params: + key: protocol + value: TCP + where: equals("protocol",6) + - add: + function: string + params: + key: protocol + value: UDP + where: equals("protocol",17) + - add: + function: string + params: + key: protocol + value: GRE + where: equals("protocol",47) + - add: + function: string + params: + key: protocol + value: ESP + where: equals("protocol",50) + - add: + function: string + params: + key: protocol + value: AH + where: equals("protocol",51) + - add: + function: string + params: + key: protocol + value: ICMPV6 + where: equals("protocol",58) + - add: + function: string + params: + key: protocol + value: SCTP + where: equals("protocol",132) + - rename: + from: + - protocol + to: log.ipProtocolNumber + where: exists("protocol") && greaterOrEqual("protocol",0) diff --git a/plugins/alerts/testdata/filter-contracts/sonicwall.json b/plugins/alerts/testdata/filter-contracts/sonicwall.json new file mode 100644 index 000000000..93b52701e --- /dev/null +++ b/plugins/alerts/testdata/filter-contracts/sonicwall.json @@ -0,0 +1,59 @@ +{ + "technology": "SonicWall", + "filters": [ + "filters/sonicwall/sonic_wall.yml" + ], + "rules": [ + "rules/sonicwall/sonicwall_firewall/anti_spyware_detection.yml", + "rules/sonicwall/sonicwall_firewall/botnet_detection.yml", + "rules/sonicwall/sonicwall_firewall/capture_atp_verdicts.yml", + "rules/sonicwall/sonicwall_firewall/gateway_antivirus_detection.yml", + "rules/sonicwall/sonicwall_firewall/intrusion_prevention_alert.yml", + "rules/sonicwall/sonicwall_firewall/sonicwall_admin_auth_failures.yml", + "rules/sonicwall/sonicwall_firewall/sonicwall_vpn_failures.yml" + ], + "fixtures": [ + { + "name": "sonicwall_valid_source_ip", + "filter": "sonicwall/sonic_wall.yml", + "input": { + "origin": { + "ip": "2001:db8::7" + } + }, + "expected": { + "origin.ip": "2001:db8::7" + }, + "absent": [], + "rules": {} + }, + { + "name": "sonicwall_hostname_not_ip", + "filter": "sonicwall/sonic_wall.yml", + "input": { + "origin": { + "ip": "lab-host" + } + }, + "expected": { + "log.unparsedOriginIp": "lab-host" + }, + "absent": [ + "origin.ip" + ], + "rules": {} + }, + { + "name": "sonicwall_numeric_protocol", + "filter": "sonicwall/sonic_wall.yml", + "input": { + "protocol": 6 + }, + "expected": { + "protocol": "TCP" + }, + "absent": [], + "rules": {} + } + ] +}