Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set event.category and event.kind for Suricata #10882

Merged
merged 2 commits into from
Feb 25, 2019
Merged

Set event.category and event.kind for Suricata #10882

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ff5eaf6
Set event.category and event.kind for Suricata
andrewkroh Feb 22, 2019
f3b893d
Handle event_type:stats as event.kind:metric
andrewkroh Feb 23, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.next.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,7 @@ https://github.com/elastic/beats/compare/v7.0.0-alpha2...master[Check the HEAD d
- Add ISO8601 timestamp support in syslog metricset. {issue}8716[8716] {pull}10736[10736]
- Add more info to message logged when a duplicated symlink file is found {pull}10845[10845]
- Add Netflow module to enrich flow events with geoip data. {pull}10877[10877]
- Set `event.category: network_traffic` for Suricata. {pull}10882[10882]

*Heartbeat*

Expand Down
8 changes: 5 additions & 3 deletions x-pack/filebeat/module/suricata/eve/ingest/pipeline.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,13 +227,15 @@
},
{
"geoip": {
"if": "ctx.source?.geo == null",
"field": "source.ip",
"target_field": "source.geo",
"ignore_missing": true
}
},
{
"geoip": {
"if": "ctx.destination?.geo == null",
"field": "destination.ip",
"target_field": "destination.geo",
"ignore_missing": true
Expand All @@ -254,9 +256,9 @@
}
},
{
"set": {
"field": "event.kind",
"value": "event"
"script": {
"lang": "painless",
"source": "def t = ctx.suricata?.eve?.event_type; if (t == \"stats\") {\n ctx['event']['kind'] = \"metric\";\n} else if (t == \"alert\") {\n ctx['event']['kind'] = \"alert\";\n ctx['event']['category'] = \"network_traffic\";\n} else {\n ctx['event']['kind'] = \"event\";\n ctx['event']['category'] = \"network_traffic\";\n}"
}
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the reviewers sake, this is what the code looked like before I made it JSON.

  - script:
      lang: painless
      source: >-
        def t = ctx.suricata?.eve?.event_type;
        if (t == "stats") {
          ctx['event']['kind'] = "metric";
        } else if (t == "alert") {
          ctx['event']['kind'] = "alert";
          ctx['event']['category'] = "network_traffic";
        } else {
          ctx['event']['kind'] = "event";
          ctx['event']['category'] = "network_traffic";
        }

}
],
Expand Down
60 changes: 40 additions & 20 deletions x-pack/filebeat/module/suricata/eve/test/eve-alerts.log-expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,11 @@
"destination.packets": 3,
"destination.port": 80,
"ecs.version": "1.0.0-beta2",
"event.category": "network_traffic",
"event.dataset": "suricata.eve",
"event.duration": 223000000,
"event.end": "2018-10-03T14:42:44.836Z",
"event.kind": "event",
"event.kind": "alert",
"event.module": "suricata",
"event.outcome": "allowed",
"event.severity": 2,
Expand Down Expand Up @@ -75,10 +76,11 @@
"destination.packets": 3,
"destination.port": 80,
"ecs.version": "1.0.0-beta2",
"event.category": "network_traffic",
"event.dataset": "suricata.eve",
"event.duration": 244000000,
"event.end": "2018-10-03T16:16:26.711Z",
"event.kind": "event",
"event.kind": "alert",
"event.module": "suricata",
"event.outcome": "allowed",
"event.severity": 2,
Expand Down Expand Up @@ -136,10 +138,11 @@
"destination.packets": 3,
"destination.port": 80,
"ecs.version": "1.0.0-beta2",
"event.category": "network_traffic",
"event.dataset": "suricata.eve",
"event.duration": 233000000,
"event.end": "2018-10-03T16:44:50.813Z",
"event.kind": "event",
"event.kind": "alert",
"event.module": "suricata",
"event.outcome": "allowed",
"event.severity": 2,
Expand Down Expand Up @@ -197,10 +200,11 @@
"destination.packets": 3,
"destination.port": 80,
"ecs.version": "1.0.0-beta2",
"event.category": "network_traffic",
"event.dataset": "suricata.eve",
"event.duration": 231000000,
"event.end": "2018-10-03T16:45:09.267Z",
"event.kind": "event",
"event.kind": "alert",
"event.module": "suricata",
"event.outcome": "allowed",
"event.severity": 2,
Expand Down Expand Up @@ -258,10 +262,11 @@
"destination.packets": 3,
"destination.port": 80,
"ecs.version": "1.0.0-beta2",
"event.category": "network_traffic",
"event.dataset": "suricata.eve",
"event.duration": 229000000,
"event.end": "2018-10-03T16:45:34.481Z",
"event.kind": "event",
"event.kind": "alert",
"event.module": "suricata",
"event.outcome": "allowed",
"event.severity": 2,
Expand Down Expand Up @@ -319,10 +324,11 @@
"destination.packets": 3,
"destination.port": 80,
"ecs.version": "1.0.0-beta2",
"event.category": "network_traffic",
"event.dataset": "suricata.eve",
"event.duration": 301000000,
"event.end": "2018-10-03T17:02:38.900Z",
"event.kind": "event",
"event.kind": "alert",
"event.module": "suricata",
"event.outcome": "allowed",
"event.severity": 2,
Expand Down Expand Up @@ -380,10 +386,11 @@
"destination.packets": 3,
"destination.port": 80,
"ecs.version": "1.0.0-beta2",
"event.category": "network_traffic",
"event.dataset": "suricata.eve",
"event.duration": 85000000,
"event.end": "2018-10-04T09:34:59.009Z",
"event.kind": "event",
"event.kind": "alert",
"event.module": "suricata",
"event.outcome": "allowed",
"event.severity": 3,
Expand Down Expand Up @@ -441,10 +448,11 @@
"destination.packets": 3,
"destination.port": 80,
"ecs.version": "1.0.0-beta2",
"event.category": "network_traffic",
"event.dataset": "suricata.eve",
"event.duration": 242000000,
"event.end": "2018-10-04T09:34:59.168Z",
"event.kind": "event",
"event.kind": "alert",
"event.module": "suricata",
"event.outcome": "allowed",
"event.severity": 3,
Expand Down Expand Up @@ -502,10 +510,11 @@
"destination.packets": 5,
"destination.port": 80,
"ecs.version": "1.0.0-beta2",
"event.category": "network_traffic",
"event.dataset": "suricata.eve",
"event.duration": 362000000,
"event.end": "2018-10-04T09:34:59.288Z",
"event.kind": "event",
"event.kind": "alert",
"event.module": "suricata",
"event.outcome": "allowed",
"event.severity": 3,
Expand Down Expand Up @@ -563,10 +572,11 @@
"destination.packets": 62,
"destination.port": 80,
"ecs.version": "1.0.0-beta2",
"event.category": "network_traffic",
"event.dataset": "suricata.eve",
"event.duration": 365000000,
"event.end": "2018-10-04T09:34:59.289Z",
"event.kind": "event",
"event.kind": "alert",
"event.module": "suricata",
"event.outcome": "allowed",
"event.severity": 3,
Expand Down Expand Up @@ -624,10 +634,11 @@
"destination.packets": 98,
"destination.port": 80,
"ecs.version": "1.0.0-beta2",
"event.category": "network_traffic",
"event.dataset": "suricata.eve",
"event.duration": 432000000,
"event.end": "2018-10-04T09:34:59.356Z",
"event.kind": "event",
"event.kind": "alert",
"event.module": "suricata",
"event.outcome": "allowed",
"event.severity": 3,
Expand Down Expand Up @@ -685,10 +696,11 @@
"destination.packets": 221,
"destination.port": 80,
"ecs.version": "1.0.0-beta2",
"event.category": "network_traffic",
"event.dataset": "suricata.eve",
"event.duration": 532000000,
"event.end": "2018-10-04T09:34:59.456Z",
"event.kind": "event",
"event.kind": "alert",
"event.module": "suricata",
"event.outcome": "allowed",
"event.severity": 3,
Expand Down Expand Up @@ -746,10 +758,11 @@
"destination.packets": 67,
"destination.port": 80,
"ecs.version": "1.0.0-beta2",
"event.category": "network_traffic",
"event.dataset": "suricata.eve",
"event.duration": 821000000,
"event.end": "2018-10-04T09:34:59.747Z",
"event.kind": "event",
"event.kind": "alert",
"event.module": "suricata",
"event.outcome": "allowed",
"event.severity": 3,
Expand Down Expand Up @@ -807,10 +820,11 @@
"destination.packets": 119,
"destination.port": 80,
"ecs.version": "1.0.0-beta2",
"event.category": "network_traffic",
"event.dataset": "suricata.eve",
"event.duration": 1027000000,
"event.end": "2018-10-04T09:34:59.953Z",
"event.kind": "event",
"event.kind": "alert",
"event.module": "suricata",
"event.outcome": "allowed",
"event.severity": 3,
Expand Down Expand Up @@ -868,10 +882,11 @@
"destination.packets": 253,
"destination.port": 80,
"ecs.version": "1.0.0-beta2",
"event.category": "network_traffic",
"event.dataset": "suricata.eve",
"event.duration": 1324000000,
"event.end": "2018-10-04T09:35:00.250Z",
"event.kind": "event",
"event.kind": "alert",
"event.module": "suricata",
"event.outcome": "allowed",
"event.severity": 3,
Expand Down Expand Up @@ -929,10 +944,11 @@
"destination.packets": 314,
"destination.port": 80,
"ecs.version": "1.0.0-beta2",
"event.category": "network_traffic",
"event.dataset": "suricata.eve",
"event.duration": 1475000000,
"event.end": "2018-10-04T09:35:00.401Z",
"event.kind": "event",
"event.kind": "alert",
"event.module": "suricata",
"event.outcome": "allowed",
"event.severity": 3,
Expand Down Expand Up @@ -990,10 +1006,11 @@
"destination.packets": 588,
"destination.port": 80,
"ecs.version": "1.0.0-beta2",
"event.category": "network_traffic",
"event.dataset": "suricata.eve",
"event.duration": 1850000000,
"event.end": "2018-10-04T09:35:00.776Z",
"event.kind": "event",
"event.kind": "alert",
"event.module": "suricata",
"event.outcome": "allowed",
"event.severity": 3,
Expand Down Expand Up @@ -1051,10 +1068,11 @@
"destination.packets": 591,
"destination.port": 80,
"ecs.version": "1.0.0-beta2",
"event.category": "network_traffic",
"event.dataset": "suricata.eve",
"event.duration": 1971000000,
"event.end": "2018-10-04T09:35:00.897Z",
"event.kind": "event",
"event.kind": "alert",
"event.module": "suricata",
"event.outcome": "allowed",
"event.severity": 3,
Expand Down Expand Up @@ -1112,10 +1130,11 @@
"destination.packets": 979,
"destination.port": 80,
"ecs.version": "1.0.0-beta2",
"event.category": "network_traffic",
"event.dataset": "suricata.eve",
"event.duration": 2436000000,
"event.end": "2018-10-04T09:35:01.362Z",
"event.kind": "event",
"event.kind": "alert",
"event.module": "suricata",
"event.outcome": "allowed",
"event.severity": 3,
Expand Down Expand Up @@ -1172,10 +1191,11 @@
"destination.packets": 1079,
"destination.port": 80,
"ecs.version": "1.0.0-beta2",
"event.category": "network_traffic",
"event.dataset": "suricata.eve",
"event.duration": 2649000000,
"event.end": "2018-10-04T09:35:01.575Z",
"event.kind": "event",
"event.kind": "alert",
"event.module": "suricata",
"event.outcome": "allowed",
"event.severity": 3,
Expand Down
11 changes: 9 additions & 2 deletions x-pack/filebeat/module/suricata/eve/test/eve-small.log-expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"destination.ip": "192.168.253.112",
"destination.port": 22,
"ecs.version": "1.0.0-beta2",
"event.category": "network_traffic",
"event.dataset": "suricata.eve",
"event.end": "2018-07-05T19:01:09.820Z",
"event.kind": "event",
Expand Down Expand Up @@ -33,10 +34,11 @@
"destination.packets": 3,
"destination.port": 443,
"ecs.version": "1.0.0-beta2",
"event.category": "network_traffic",
"event.dataset": "suricata.eve",
"event.duration": 1251000000,
"event.end": "2018-07-05T19:07:20.910Z",
"event.kind": "event",
"event.kind": "alert",
"event.module": "suricata",
"event.outcome": "allowed",
"event.severity": 1,
Expand Down Expand Up @@ -76,6 +78,7 @@
"destination.ip": "192.168.86.28",
"destination.port": 63963,
"ecs.version": "1.0.0-beta2",
"event.category": "network_traffic",
"event.dataset": "suricata.eve",
"event.end": "2018-07-05T19:43:47.690Z",
"event.kind": "event",
Expand Down Expand Up @@ -116,6 +119,7 @@
"destination.ip": "192.168.86.85",
"destination.port": 56118,
"ecs.version": "1.0.0-beta2",
"event.category": "network_traffic",
"event.dataset": "suricata.eve",
"event.end": "2018-07-05T19:44:33.222Z",
"event.kind": "event",
Expand Down Expand Up @@ -164,6 +168,7 @@
"destination.ip": "192.168.86.85",
"destination.port": 39464,
"ecs.version": "1.0.0-beta2",
"event.category": "network_traffic",
"event.dataset": "suricata.eve",
"event.end": "2018-07-05T19:51:20.213Z",
"event.kind": "event",
Expand Down Expand Up @@ -194,7 +199,7 @@
"ecs.version": "1.0.0-beta2",
"event.dataset": "suricata.eve",
"event.end": "2018-07-05T19:51:23.009Z",
"event.kind": "event",
"event.kind": "metric",
"event.module": "suricata",
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@webmat This is metric now. 👍

"fileset.name": "eve",
"input.type": "log",
Expand Down Expand Up @@ -330,6 +335,7 @@
"destination.ip": "17.142.164.13",
"destination.port": 443,
"ecs.version": "1.0.0-beta2",
"event.category": "network_traffic",
"event.dataset": "suricata.eve",
"event.end": "2018-07-05T19:51:50.666Z",
"event.kind": "event",
Expand Down Expand Up @@ -363,6 +369,7 @@
"destination.packets": 0,
"destination.port": 547,
"ecs.version": "1.0.0-beta2",
"event.category": "network_traffic",
"event.dataset": "suricata.eve",
"event.duration": 30548000000,
"event.end": "2018-07-05T19:51:54.001Z",
Expand Down