forked from elastic/beats
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Zeek Signatures (elastic#23772) (elastic#24078)
Add the Signature fileset to the Zeek module for Filbeat. Co-authored-by: Andrew Kroh <[email protected]> (cherry picked from commit e332d9d) Co-authored-by: Alex Resnick <[email protected]>
- Loading branch information
1 parent
1666f89
commit 5f1bf05
Showing
12 changed files
with
320 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| - name: signature | ||
| type: group | ||
| default_field: false | ||
| description: > | ||
| Fields exported by the Zeek Signature log. | ||
| fields: | ||
| - name: note | ||
| type: keyword | ||
| description: > | ||
| Notice associated with signature event. | ||
| - name: sig_id | ||
| type: keyword | ||
| description: > | ||
| The name of the signature that matched. | ||
| - name: event_msg | ||
| type: keyword | ||
| description: > | ||
| A more descriptive message of the signature-matching event. | ||
| - name: sub_msg | ||
| type: keyword | ||
| description: > | ||
| Extracted payload data or extra message. | ||
| - name: sig_count | ||
| type: integer | ||
| description: > | ||
| Number of sigs, usually from summary count. | ||
| - name: host_count | ||
| type: integer | ||
| description: > | ||
| Number of hosts, from a summary count. |
50 changes: 50 additions & 0 deletions
50
x-pack/filebeat/module/zeek/signature/config/signature.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| type: log | ||
| paths: | ||
| {{ range $i, $path := .paths }} | ||
| - {{$path}} | ||
| {{ end }} | ||
| exclude_files: [".gz$"] | ||
| tags: {{.tags | tojson}} | ||
| publisher_pipeline.disable_host: {{ inList .tags "forwarded" }} | ||
|
|
||
| processors: | ||
| - rename: | ||
| fields: | ||
| - {from: message, to: event.original} | ||
| - decode_json_fields: | ||
| fields: [event.original] | ||
| target: zeek.signature | ||
| - convert: | ||
| ignore_missing: true | ||
| fields: | ||
| - {from: zeek.signature.src_addr, to: source.address} | ||
| - {from: zeek.signature.src_addr, to: source.ip, type: ip} | ||
| - {from: zeek.signature.src_port, to: source.port, type: long} | ||
| - {from: zeek.signature.dst_addr, to: destination.address} | ||
| - {from: zeek.signature.dst_addr, to: destination.ip, type: ip} | ||
| - {from: zeek.signature.dst_port, to: destination.port, type: long} | ||
| - rename: | ||
| ignore_missing: true | ||
| fields: | ||
| - from: zeek.signature.uid | ||
| to: zeek.session_id | ||
| - from: zeek.signature.sig_id | ||
| to: rule.id | ||
| - from: zeek.signature.event_msg | ||
| to: rule.description | ||
| - drop_fields: | ||
| ignore_missing: true | ||
| fields: | ||
| - zeek.signature.src_addr | ||
| - zeek.signature.src_port | ||
| - zeek.signature.dst_addr | ||
| - zeek.signature.dst_port | ||
| - add_fields: | ||
| target: event | ||
| fields: | ||
| kind: alert | ||
| - community_id: | ||
| - add_fields: | ||
| target: '' | ||
| fields: | ||
| ecs.version: 1.7.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| --- | ||
| description: Pipeline for normalizing Zeek signature.log. | ||
| processors: | ||
| - set: | ||
| field: event.ingested | ||
| value: '{{_ingest.timestamp}}' | ||
| - set: | ||
| field: event.created | ||
| value: '{{@timestamp}}' | ||
| - date: | ||
| field: zeek.signature.ts | ||
| formats: | ||
| - UNIX | ||
| - remove: | ||
| field: zeek.signature.ts | ||
| # IP Geolocation Lookup | ||
| - geoip: | ||
| if: ctx.source?.geo == null | ||
| field: source.ip | ||
| target_field: source.geo | ||
| ignore_missing: true | ||
| properties: | ||
| - city_name | ||
| - continent_name | ||
| - country_iso_code | ||
| - country_name | ||
| - location | ||
| - region_iso_code | ||
| - region_name | ||
| - geoip: | ||
| if: ctx.destination?.geo == null | ||
| field: destination.ip | ||
| target_field: destination.geo | ||
| ignore_missing: true | ||
| properties: | ||
| - city_name | ||
| - continent_name | ||
| - country_iso_code | ||
| - country_name | ||
| - location | ||
| - region_iso_code | ||
| - region_name | ||
|
|
||
| # IP Autonomous System (AS) Lookup | ||
| - geoip: | ||
| database_file: GeoLite2-ASN.mmdb | ||
| field: source.ip | ||
| target_field: source.as | ||
| properties: | ||
| - asn | ||
| - organization_name | ||
| ignore_missing: true | ||
| - geoip: | ||
| database_file: GeoLite2-ASN.mmdb | ||
| field: destination.ip | ||
| target_field: destination.as | ||
| properties: | ||
| - asn | ||
| - organization_name | ||
| ignore_missing: true | ||
| - rename: | ||
| field: source.as.asn | ||
| target_field: source.as.number | ||
| ignore_missing: true | ||
| - rename: | ||
| field: source.as.organization_name | ||
| target_field: source.as.organization.name | ||
| ignore_missing: true | ||
| - rename: | ||
| field: destination.as.asn | ||
| target_field: destination.as.number | ||
| ignore_missing: true | ||
| - rename: | ||
| field: destination.as.organization_name | ||
| target_field: destination.as.organization.name | ||
| ignore_missing: true | ||
| - append: | ||
| field: "related.ip" | ||
| value: "{{source.ip}}" | ||
| if: "ctx?.source?.ip != null" | ||
| - append: | ||
| field: "related.ip" | ||
| value: "{{destination.ip}}" | ||
| if: "ctx?.destination?.ip != null" | ||
|
|
||
| on_failure: | ||
| - set: | ||
| field: error.message | ||
| value: "{{ _ingest.on_failure_message }}" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| module_version: 1.0 | ||
|
|
||
| var: | ||
| - name: paths | ||
| default: | ||
| - /var/log/bro/current/signatures.log | ||
| os.linux: | ||
| - /var/log/bro/current/signatures.log | ||
| os.darwin: | ||
| - /usr/local/var/logs/current/signatures.log | ||
| - name: tags | ||
| default: [zeek.signature] | ||
|
|
||
| ingest_pipeline: ingest/pipeline.yml | ||
| input: config/signature.yml | ||
|
|
||
| requires.processors: | ||
| - name: geoip | ||
| plugin: ingest-geoip |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| {"ts": 1611852809.869245,"uid": "CbjAXE4CBxJ8W7VoJg","src_addr": "124.51.137.154","src_port": 51617,"dst_addr": "160.218.27.63","dst_port": 445,"note": "Signatures::Sensitive_Signature","sig_id": "my-second-sig","event_msg": "124.51.137.154: TCP traffic","sub_msg": ""} |
48 changes: 48 additions & 0 deletions
48
x-pack/filebeat/module/zeek/signature/test/signature-json.log-expected.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| [ | ||
| { | ||
| "@timestamp": "2021-01-28T16:53:29.869Z", | ||
| "destination.address": "160.218.27.63", | ||
| "destination.as.number": 5610, | ||
| "destination.as.organization.name": "O2 Czech Republic, a.s.", | ||
| "destination.geo.continent_name": "Europe", | ||
| "destination.geo.country_iso_code": "CZ", | ||
| "destination.geo.country_name": "Czechia", | ||
| "destination.geo.location.lat": 50.0848, | ||
| "destination.geo.location.lon": 14.4112, | ||
| "destination.ip": "160.218.27.63", | ||
| "destination.port": 445, | ||
| "event.dataset": "zeek.signature", | ||
| "event.kind": "alert", | ||
| "event.module": "zeek", | ||
| "event.original": "{\"ts\": 1611852809.869245,\"uid\": \"CbjAXE4CBxJ8W7VoJg\",\"src_addr\": \"124.51.137.154\",\"src_port\": 51617,\"dst_addr\": \"160.218.27.63\",\"dst_port\": 445,\"note\": \"Signatures::Sensitive_Signature\",\"sig_id\": \"my-second-sig\",\"event_msg\": \"124.51.137.154: TCP traffic\",\"sub_msg\": \"\"}", | ||
| "fileset.name": "signature", | ||
| "input.type": "log", | ||
| "log.offset": 0, | ||
| "related.ip": [ | ||
| "124.51.137.154", | ||
| "160.218.27.63" | ||
| ], | ||
| "rule.description": "124.51.137.154: TCP traffic", | ||
| "rule.id": "my-second-sig", | ||
| "service.type": "zeek", | ||
| "source.address": "124.51.137.154", | ||
| "source.as.number": 17858, | ||
| "source.as.organization.name": "LG POWERCOMM", | ||
| "source.geo.city_name": "Busan", | ||
| "source.geo.continent_name": "Asia", | ||
| "source.geo.country_iso_code": "KR", | ||
| "source.geo.country_name": "South Korea", | ||
| "source.geo.location.lat": 35.1003, | ||
| "source.geo.location.lon": 129.0442, | ||
| "source.geo.region_iso_code": "KR-26", | ||
| "source.geo.region_name": "Busan", | ||
| "source.ip": "124.51.137.154", | ||
| "source.port": 51617, | ||
| "tags": [ | ||
| "zeek.signature" | ||
| ], | ||
| "zeek.session_id": "CbjAXE4CBxJ8W7VoJg", | ||
| "zeek.signature.note": "Signatures::Sensitive_Signature", | ||
| "zeek.signature.sub_msg": "" | ||
| } | ||
| ] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters