Skip to content

zscaler_zia.firewall: Fix source/destination ip mapping #11613

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

Merged
kcreddy merged 3 commits into from
Nov 6, 2024
Merged

zscaler_zia.firewall: Fix source/destination ip mapping #11613

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b4bb8f0
Fix source/destination ip mapping in firewall logs.
kcreddy Nov 1, 2024
ebf115c
Add geoip processor to source and destination ip. Run tests
kcreddy Nov 1, 2024
6fef889
update PR number.
kcreddy Nov 1, 2024
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions packages/zscaler_zia/changelog.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
# newer versions go on top
- version: "3.3.0"
changes:
- description: Fix source/destination ip mapping in firewall logs.
type: bugfix
link: https://github.com/elastic/integrations/pull/11613
- description: Add geoip processor to source and destination ip.
type: enhancement
link: https://github.com/elastic/integrations/pull/11613
- version: "3.2.4"
changes:
- description: Improve data processing in the web pipeline.
Expand Down
46 changes: 23 additions & 23 deletions ...zia/data_stream/firewall/_dev/test/pipeline/test-firewall-http-endpoint.log-expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@
"geo": {
"country_iso_code": "USA"
},
"ip": [
"1.128.0.0"
],
"ip": "1.128.0.0",
"port": [
22,
443
Expand Down Expand Up @@ -87,10 +85,10 @@
"geo": {
"country_name": "United States"
},
"ip": [
"0.0.0.0",
"1.128.0.0"
],
"ip": "0.0.0.0",
"nat": {
"ip": "89.160.20.128"
},
"port": [
22
]
Expand Down Expand Up @@ -238,9 +236,7 @@
"@timestamp": "2022-12-31T02:22:22.000Z",
"destination": {
"bytes": 0,
"ip": [
"0.0.0.0"
],
"ip": "0.0.0.0",
"port": [
120,
456
Expand Down Expand Up @@ -279,9 +275,10 @@
},
"source": {
"bytes": 0,
"ip": [
"0.0.0.0"
],
"ip": "0.0.0.0",
"nat": {
"ip": "0.0.0.0"
},
"port": [
123,
0
Expand Down Expand Up @@ -348,12 +345,15 @@
"bytes": 10000,
"domain": "www.example.com",
"geo": {
"country_iso_code": "USA"
"continent_name": "Europe",
"country_iso_code": "NO",
"country_name": "Norway",
"location": {
"lat": 62.0,
"lon": 10.0
}
},
"ip": [
"2a02:cf40::",
"67.43.156.0"
],
"ip": "2a02:cf40::",
"port": [
22,
443
Expand Down Expand Up @@ -407,8 +407,8 @@
],
"ip": [
"2a02:cf40::",
"67.43.156.0",
"0.0.0.0",
"67.43.156.0",
"1.128.0.0",
"89.160.20.128"
],
Expand All @@ -432,10 +432,10 @@
"geo": {
"country_name": "United States"
},
"ip": [
"0.0.0.0",
"1.128.0.0"
],
"ip": "0.0.0.0",
"nat": {
"ip": "89.160.20.128"
},
"port": [
25,
22
Expand Down
34 changes: 18 additions & 16 deletions packages/zscaler_zia/data_stream/firewall/_dev/test/pipeline/test-firewall.log-expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@
"geo": {
"country_iso_code": "USA"
},
"ip": [
"1.128.0.0"
],
"ip": "1.128.0.0",
"port": [
22,
443
Expand Down Expand Up @@ -86,9 +84,10 @@
"geo": {
"country_name": "United States"
},
"ip": [
"1.128.0.0"
],
"ip": "1.128.0.0",
"nat": {
"ip": "89.160.20.128"
},
"port": [
22
]
Expand Down Expand Up @@ -238,12 +237,15 @@
"bytes": 10000,
"domain": "www.example.com",
"geo": {
"country_iso_code": "USA"
"continent_name": "Europe",
"country_iso_code": "NO",
"country_name": "Norway",
"location": {
"lat": 62.0,
"lon": 10.0
}
},
"ip": [
"2a02:cf40::",
"67.43.156.0"
],
"ip": "2a02:cf40::",
"port": [
22,
443
Expand Down Expand Up @@ -297,8 +299,8 @@
],
"ip": [
"2a02:cf40::",
"67.43.156.0",
"0.0.0.0",
"67.43.156.0",
"1.128.0.0",
"89.160.20.128"
],
Expand All @@ -322,10 +324,10 @@
"geo": {
"country_name": "United States"
},
"ip": [
"0.0.0.0",
"1.128.0.0"
],
"ip": "0.0.0.0",
"nat": {
"ip": "89.160.20.128"
},
"port": [
25,
22
Expand Down
23 changes: 13 additions & 10 deletions packages/zscaler_zia/data_stream/firewall/_dev/test/pipeline/test-unicode.json-expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,15 @@
"bytes": 10000,
"domain": "www.example.com",
"geo": {
"country_iso_code": "USA"
"continent_name": "Europe",
"country_iso_code": "NO",
"country_name": "Norway",
"location": {
"lat": 62.0,
"lon": 10.0
}
},
"ip": [
"2a02:cf40::",
"67.43.156.0"
],
"ip": "2a02:cf40::",
"port": [
22,
443
Expand Down Expand Up @@ -65,8 +68,8 @@
],
"ip": [
"2a02:cf40::",
"67.43.156.0",
"0.0.0.0",
"67.43.156.0",
"1.128.0.0",
"89.160.20.128"
],
Expand All @@ -90,10 +93,10 @@
"geo": {
"country_name": "United States"
},
"ip": [
"0.0.0.0",
"1.128.0.0"
],
"ip": "0.0.0.0",
"nat": {
"ip": "89.160.20.128"
},
"port": [
25,
22
Expand Down
75 changes: 41 additions & 34 deletions packages/zscaler_zia/data_stream/firewall/elasticsearch/ingest_pipeline/default.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,12 +164,22 @@ processors:
- append:
field: error.message
value: 'Processor {{{_ingest.on_failure_processor_type}}} with tag {{{_ingest.on_failure_processor_tag}}} in pipeline {{{_ingest.on_failure_pipeline}}} failed with message: {{{_ingest.on_failure_message}}}'
- append:
- set:
field: destination.ip
tag: set_destination_ip_from_zscaler_zia_firewall_client_destination_ip
copy_from: zscaler_zia.firewall.client.destination.ip
ignore_empty_value: true
- geoip:
field: destination.ip
tag: append_zscaler_zia_firewall_client_destination_ip_into_destination_ip
value: '{{{zscaler_zia.firewall.client.destination.ip}}}'
target_field: destination.geo
tag: geoip_destination_ip
ignore_missing: true
- append:
field: related.ip
value: '{{{destination.ip}}}'
tag: append_related_ip_from_destination_ip
if: ctx.destination?.ip != null
allow_duplicates: false
if: ctx.zscaler_zia?.firewall?.client?.destination?.ip != null
- convert:
field: json.cdport
tag: convert_cdport_to_long
Expand Down Expand Up @@ -208,12 +218,22 @@ processors:
- append:
field: error.message
value: 'Processor {{{_ingest.on_failure_processor_type}}} with tag {{{_ingest.on_failure_processor_tag}}} in pipeline {{{_ingest.on_failure_pipeline}}} failed with message: {{{_ingest.on_failure_message}}}'
- append:
- set:
field: source.ip
tag: set_source_ip_from_zscaler_zia_firewall_client_source_ip
copy_from: zscaler_zia.firewall.client.source.ip
ignore_empty_value: true
- geoip:
field: source.ip
tag: append_zscaler_zia_firewall_client_source_ip_into_source_ip
value: '{{{zscaler_zia.firewall.client.source.ip}}}'
target_field: source.geo
tag: geoip_source_ip
ignore_missing: true
- append:
field: related.ip
value: '{{{source.ip}}}'
tag: append_related_ip_from_source_ip
if: ctx.source?.ip != null
allow_duplicates: false
if: ctx.zscaler_zia?.firewall?.client?.source?.ip != null
- convert:
field: json.csport
tag: convert_csport_to_long
Expand Down Expand Up @@ -283,6 +303,7 @@ processors:
field: destination.geo.country_iso_code
tag: set_destination_geo_country_iso_code_from_firewall_destination_country
copy_from: zscaler_zia.firewall.destination.country
if: ctx.destination?.geo?.country_iso_code == null
ignore_empty_value: true
- rename:
field: json.deviceappversion
Expand Down Expand Up @@ -763,21 +784,11 @@ processors:
field: error.message
value: 'Processor {{{_ingest.on_failure_processor_type}}} with tag {{{_ingest.on_failure_processor_tag}}} in pipeline {{{_ingest.on_failure_pipeline}}} failed with message: {{{_ingest.on_failure_message}}}'
- append:
field: destination.ip
tag: append_zscaler_zia_firewall_server_destination_ip_into_destination_ip
field: related.ip
value: '{{{zscaler_zia.firewall.server.destination.ip}}}'
allow_duplicates: false
tag: append_related_ip_from_zscaler_zia_firewall_server_destination_ip
if: ctx.zscaler_zia?.firewall?.server?.destination?.ip != null
- foreach:
field: destination.ip
tag: foreach_destination_ip_to_append_related_ip_from_destination_ip
if: ctx.destination?.ip instanceof List
processor:
append:
field: related.ip
tag: append_related_ip_from_destination_ip
value: '{{{_ingest._value}}}'
allow_duplicates: false
allow_duplicates: false
- convert:
field: json.sdport
tag: convert_sdport_to_long
Expand Down Expand Up @@ -821,21 +832,11 @@ processors:
field: error.message
value: 'Processor {{{_ingest.on_failure_processor_type}}} with tag {{{_ingest.on_failure_processor_tag}}} in pipeline {{{_ingest.on_failure_pipeline}}} failed with message: {{{_ingest.on_failure_message}}}'
- append:
field: source.ip
tag: append_zscaler_zia_firewall_server_source_ip_into_source_ip
field: related.ip
value: '{{{zscaler_zia.firewall.server.source.ip}}}'
allow_duplicates: false
tag: append_related_ip_from_zscaler_zia_firewall_server_source_ip
if: ctx.zscaler_zia?.firewall?.server?.source?.ip != null
- foreach:
field: source.ip
tag: foreach_source_ip_to_append_related_ip_from_source_ip
if: ctx.source?.ip instanceof List
processor:
append:
field: related.ip
tag: append_related_ip_from_source_ip
value: '{{{_ingest._value}}}'
allow_duplicates: false
allow_duplicates: false
- convert:
field: json.ssport
tag: convert_ssport_to_long
Expand Down Expand Up @@ -887,6 +888,7 @@ processors:
field: source.geo.country_name
tag: set_source_geo_country_name_from_firewall_source_ip_country
copy_from: zscaler_zia.firewall.source_ip_country
if: ctx.source?.geo?.country_name == null
ignore_empty_value: true
- rename:
field: json.stateful
Expand Down Expand Up @@ -969,6 +971,11 @@ processors:
- append:
field: error.message
value: 'Processor {{{_ingest.on_failure_processor_type}}} with tag {{{_ingest.on_failure_processor_tag}}} in pipeline {{{_ingest.on_failure_pipeline}}} failed with message: {{{_ingest.on_failure_message}}}'
- set:
field: source.nat.ip
tag: set_source_nat_ip_from_zscaler_zia_firewall_tunnel_ip
copy_from: zscaler_zia.firewall.tunnel.ip
ignore_empty_value: true

@ShourieG ShourieG Nov 6, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@kcreddy , Is this also part of the required change? cause I thought we were just removing the proxy address mapping from source and destination, adding geoip proc and updating related ips.

@kcreddy kcreddy Nov 6, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@ShourieG, yes it is also one of the asks from the SDH. I've updated the PR description.
- append:
field: related.ip
value: '{{{zscaler_zia.firewall.tunnel.ip}}}'
Expand Down
Loading