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

Jump to bottom

[Filebeat] Add ECS tls fields to zeek and aws modules #15936

Merged
merged 4 commits into from
Feb 3, 2020
Merged

[Filebeat] Add ECS tls fields to zeek and aws modules #15936

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
895dc36
Add ECS tls fields to zeek and aws modules
leehinman Jan 28, 2020
c1d92d4
Use correct type for established & resumed
leehinman Jan 30, 2020
de72b02
Make null checks safer
leehinman Jan 31, 2020
27a6d3a
Merge branch 'master' into 15757_add_tls_mappings
leehinman Feb 3, 2020
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 @@ -97,6 +97,7 @@ https://github.com/elastic/beats/compare/v7.0.0-alpha2...master[Check the HEAD d
*Filebeat*
- Set event.outcome field based on googlecloud audit log output. {pull}15731[15731]
- Add dashboard for AWS ELB fileset. {pull}15804[15804]
- Add ECS tls fields to zeek:smtp,rdp,ssl and aws:s3access,elb {issue}15757[15757] {pull}15935[15936]


*Heartbeat*
Expand Down
20 changes: 20 additions & 0 deletions x-pack/filebeat/module/aws/elb/ingest/pipeline.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,26 @@ processors:
target_field: source.as.organization.name
ignore_missing: true

- set:
field: tls.cipher
value: '{{aws.elb.ssl_cipher}}'
if: ctx.aws?.elb.ssl_cipher != null
Copy link
Member

Choose a reason for hiding this comment

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

Does this work safely if the ssl_cipher field does not exist?
Is this the same as if: ctx.aws?.elb?.ssl_cipher != null?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It does work if ssl_cipher doesn't exist, the http logs are good examples.

That being said it might be safer to use null safe operator on both

This doc would fails with current if: ctx.aws?.elb.ssl_cipher != null

{
  "aws.elb.ip": "10.0.0.1"
}

and this doc succeeds

{
  "aws": {
    "elb": {
      "ip": "10.0.0.1"
    }
  }
}

both work with if: ctx.aws?.elb?.ssl_cipher != null

Copy link
Contributor

Choose a reason for hiding this comment

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

This doc would fails...

This is to be expected, Elasticsearch ingest pipelines don't support dotted keys (other than the dot expander processor). So I'd be surprised if Painless (the if clause) supported it.


- script:
lang: painless
if: ctx.aws?.elb.ssl_protocol != null
source: >-
def parts = ctx.aws.elb.ssl_protocol.splitOnToken("v");
if (parts.length != 2) {
return;
}
if (parts[1].contains(".")) {
ctx.tls.version = parts[1];
} else {
ctx.tls.version = parts[1].substring(0,1) + "." + parts[1].substring(1);
}
ctx.tls.version_protocol = parts[0].toLowerCase();

- remove:
field:
- message
Expand Down
9 changes: 9 additions & 0 deletions x-pack/filebeat/module/aws/elb/test/example-alb-http.log-expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,9 @@
"service.type": "aws",
"source.ip": "192.168.131.39",
"source.port": "2817",
"tls.cipher": "ECDHE-RSA-AES128-GCM-SHA256",
"tls.version": "1.2",
"tls.version_protocol": "tls",
"user_agent.original": "curl/7.46.0"
},
{
Expand Down Expand Up @@ -110,6 +113,9 @@
"service.type": "aws",
"source.ip": "10.0.1.252",
"source.port": "48160",
"tls.cipher": "ECDHE-RSA-AES128-GCM-SHA256",
"tls.version": "1.2",
"tls.version_protocol": "tls",
"user_agent.original": "curl/7.46.0"
},
{
Expand Down Expand Up @@ -174,6 +180,9 @@
"service.type": "aws",
"source.ip": "10.0.0.140",
"source.port": "44244",
"tls.cipher": "ECDHE-RSA-AES128-GCM-SHA256",
"tls.version": "1.2",
"tls.version_protocol": "tls",
"user_agent.original": "-"
},
{
Expand Down
3 changes: 3 additions & 0 deletions x-pack/filebeat/module/aws/elb/test/example-https.log-expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
"service.type": "aws",
"source.ip": "192.168.131.39",
"source.port": "2817",
"tls.cipher": "DHE-RSA-AES128-SHA",
"tls.version": "1.2",
"tls.version_protocol": "tls",
"user_agent.original": "curl/7.38.0"
}
]
5 changes: 4 additions & 1 deletion x-pack/filebeat/module/aws/elb/test/example-nlb-tcp.log-expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@
"source.geo.region_iso_code": "US-VA",
"source.geo.region_name": "Virginia",
"source.ip": "72.21.218.154",
"source.port": "51341"
"source.port": "51341",
"tls.cipher": "ECDHE-RSA-AES128-SHA",
"tls.version": "1.2",
"tls.version_protocol": "tls"
}
]
5 changes: 4 additions & 1 deletion x-pack/filebeat/module/aws/elb/test/example-ssl.log-expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@
"service.type": "aws",
"source.bytes": 57,
"source.ip": "192.168.131.39",
"source.port": "2817"
"source.port": "2817",
"tls.cipher": "ECDHE-ECDSA-AES128-GCM-SHA256",
"tls.version": "1.2",
"tls.version_protocol": "tls"
}
]
15 changes: 15 additions & 0 deletions x-pack/filebeat/module/aws/s3access/ingest/pipeline.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,21 @@ processors:
ignore_failure: true
formats:
- "dd/MMM/yyyy:H:m:s Z"
- set:
field: tls.cipher
value: '{{aws.s3access.cipher_suite}}'
if: ctx.aws?.s3access.cipher_suite != null

- script:
lang: painless
if: ctx.aws?.s3access.tls_version != null
source: >-
def parts = ctx.aws.s3access.tls_version.toLowerCase().splitOnToken("v");
if (parts.length != 2) {
return;
}
ctx.tls.version = parts[1];
ctx.tls.version_protocol = parts[0]

#
# Remove temporary fields
Expand Down
30 changes: 24 additions & 6 deletions x-pack/filebeat/module/aws/s3access/test/s3_server_access.log-expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,10 @@
"fileset.name": "s3access",
"input.type": "log",
"log.offset": 0,
"service.type": "aws"
"service.type": "aws",
"tls.cipher": "ECDHE-RSA-AES128-SHA",
"tls.version": "1.2",
"tls.version_protocol": "tls"
},
{
"@timestamp": "2019-08-01T00:24:42.000Z",
Expand All @@ -51,7 +54,10 @@
"fileset.name": "s3access",
"input.type": "log",
"log.offset": 715,
"service.type": "aws"
"service.type": "aws",
"tls.cipher": "ECDHE-RSA-AES128-SHA",
"tls.version": "1.2",
"tls.version_protocol": "tls"
},
{
"@timestamp": "2019-08-01T00:24:43.000Z",
Expand Down Expand Up @@ -79,7 +85,10 @@
"fileset.name": "s3access",
"input.type": "log",
"log.offset": 1429,
"service.type": "aws"
"service.type": "aws",
"tls.cipher": "ECDHE-RSA-AES128-SHA",
"tls.version": "1.2",
"tls.version_protocol": "tls"
},
{
"@timestamp": "2019-08-01T00:24:43.000Z",
Expand All @@ -106,7 +115,10 @@
"fileset.name": "s3access",
"input.type": "log",
"log.offset": 2161,
"service.type": "aws"
"service.type": "aws",
"tls.cipher": "ECDHE-RSA-AES128-SHA",
"tls.version": "1.2",
"tls.version_protocol": "tls"
},
{
"@timestamp": "2019-09-10T15:11:07.000Z",
Expand All @@ -130,7 +142,10 @@
"fileset.name": "s3access",
"input.type": "log",
"log.offset": 2875,
"service.type": "aws"
"service.type": "aws",
"tls.cipher": "ECDHE-RSA-AES128-SHA",
"tls.version": "1.2",
"tls.version_protocol": "tls"
},
{
"@timestamp": "2019-09-19T17:06:39.000Z",
Expand All @@ -154,6 +169,9 @@
"fileset.name": "s3access",
"input.type": "log",
"log.offset": 3280,
"service.type": "aws"
"service.type": "aws",
"tls.cipher": "ECDHE-RSA-AES128-SHA",
"tls.version": "1.2",
"tls.version_protocol": "tls"
}
]
25 changes: 20 additions & 5 deletions x-pack/filebeat/module/aws/s3access/test/test.log-expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,10 @@
"fileset.name": "s3access",
"input.type": "log",
"log.offset": 0,
"service.type": "aws"
"service.type": "aws",
"tls.cipher": "ECDHE-RSA-AES128-GCM-SHA256",
"tls.version": "1.1",
"tls.version_protocol": "tls"
},
{
"@timestamp": "2019-02-06T00:00:38.000Z",
Expand All @@ -51,7 +54,10 @@
"fileset.name": "s3access",
"input.type": "log",
"log.offset": 471,
"service.type": "aws"
"service.type": "aws",
"tls.cipher": "ECDHE-RSA-AES128-GCM-SHA256",
"tls.version": "1.1",
"tls.version_protocol": "tls"
},
{
"@timestamp": "2019-02-06T00:00:38.000Z",
Expand Down Expand Up @@ -79,7 +85,10 @@
"fileset.name": "s3access",
"input.type": "log",
"log.offset": 944,
"service.type": "aws"
"service.type": "aws",
"tls.cipher": "ECDHE-RSA-AES128-GCM-SHA256",
"tls.version": "1.1",
"tls.version_protocol": "tls"
},
{
"@timestamp": "2019-02-06T00:01:00.000Z",
Expand All @@ -106,7 +115,10 @@
"fileset.name": "s3access",
"input.type": "log",
"log.offset": 1431,
"service.type": "aws"
"service.type": "aws",
"tls.cipher": "ECDHE-RSA-AES128-GCM-SHA256",
"tls.version": "1.1",
"tls.version_protocol": "tls"
},
{
"@timestamp": "2019-02-06T00:01:57.000Z",
Expand Down Expand Up @@ -135,6 +147,9 @@
"fileset.name": "s3access",
"input.type": "log",
"log.offset": 1903,
"service.type": "aws"
"service.type": "aws",
"tls.cipher": "ECDHE-RSA-AES128-SHA",
"tls.version": "1.1",
"tls.version_protocol": "tls"
}
]
8 changes: 8 additions & 0 deletions x-pack/filebeat/module/zeek/rdp/ingest/pipeline.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,14 @@
"if": "ctx.zeek.session_id != null"
}
},
{
"convert": {
"field": "zeek.rdp.ssl",
"target_field": "tls.established",
"type": "boolean",
"ignore_missing": true
}
},
{
"set": {
"field": "source.ip",
Expand Down
1 change: 1 addition & 0 deletions x-pack/filebeat/module/zeek/rdp/test/rdp-json.log-expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
"tags": [
"zeek.rdp"
],
"tls.established": true,
"zeek.rdp.cert.count": 0,
"zeek.rdp.result": "encrypted",
"zeek.rdp.security_protocol": "HYBRID",
Expand Down
8 changes: 8 additions & 0 deletions x-pack/filebeat/module/zeek/smtp/ingest/pipeline.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,14 @@
"value": "{{destination.address}}"
}
},
{
"convert": {
"field": "zeek.smtp.tls",
"target_field": "tls.established",
"type": "boolean",
"ignore_missing": true
}
},
{
"date": {
"field": "zeek.smtp.date",
Expand Down
1 change: 1 addition & 0 deletions x-pack/filebeat/module/zeek/smtp/test/smtp-json.log-expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
"tags": [
"zeek.smtp"
],
"tls.established": true,
"zeek.session_id": "CWWzPB3RjqhFf528c",
"zeek.smtp.fuids": [],
"zeek.smtp.helo": "EXAMPLE.COM",
Expand Down
Loading