Skip to content

zscaler_zia: add strict field template mode for tcp and http_endpoint input data streams #13904

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
efd6 merged 8 commits into from
May 25, 2025
Merged

zscaler_zia: add strict field template mode for tcp and http_endpoint input data streams #13904

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2125a6e
zscaler_zia: add strict field template mode for tcp and http_endpoint…
efd6 May 14, 2025
05c57c7
address pr comment - wip
efd6 May 20, 2025
9e9b376
update expectations
efd6 May 20, 2025
4a48264
add versioned links
efd6 May 22, 2025
451811b
add protective comment/tags and use data_stream param
efd6 May 22, 2025
d004c9a
address pr comment
efd6 May 22, 2025
a40b8d8
make strict fields on by default
efd6 May 22, 2025
192b7a6
disable strict fields for system tests
efd6 May 22, 2025
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
26 changes: 13 additions & 13 deletions packages/zscaler_zia/_dev/build/docs/README.md
View file
Open in desktop

Large diffs are not rendered by default.

5 changes: 5 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,9 @@
# newer versions go on top
- version: "3.12.0"
changes:
- description: Add strict field template mode for TCP and HTTP Endpoint input data streams.
type: enhancement
link: https://github.com/elastic/integrations/pull/13904
- version: "3.11.0"
changes:
- description: Update `event.type` from info to access, and add the `event.outcome` ECS field.
Expand Down
2 changes: 1 addition & 1 deletion packages/zscaler_zia/data_stream/alerts/_dev/test/pipeline/test-alerts.log-expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,4 +125,4 @@
}
}
]
}
}
3 changes: 2 additions & 1 deletion packages/zscaler_zia/data_stream/audit/_dev/test/pipeline/test-audit-http-endpoint.log
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
{ "sourcetype": "zscalernss-audit","input": {"type": "http_endpoint"}, "event": { "time": "Mon Oct 16 22:55:48 2023", "recordid": "1234", "action": "Activate", "category": "DATA_LOSS_PREVENTION_RESOURCE", "subcategory": "DLP_DICTIONARY", "resource": "SSL Rule Name", "interface": "API", "adminid": "example@zscaler.com", "clientip": "89.160.20.112", "result": "SUCCESS", "errorcode": "AUTHENTICATION_FAILED", "auditlogtype": "ZIA Portal Audit Log", "preaction": {}, "postaction": {} } }
{"sourcetype":"zscalernss-audit","input":{"type":"http_endpoint"},"event":{"time":"Mon Oct 16 22:55:48 2023","recordid":"1234","action":"Activate","category":"DATA_LOSS_PREVENTION_RESOURCE","subcategory":"DLP_DICTIONARY","resource":"SSL Rule Name","interface":"API","adminid":"example@zscaler.com","clientip":"89.160.20.112","result":"SUCCESS","errorcode":"AUTHENTICATION_FAILED","auditlogtype":"ZIA Portal Audit Log","preaction":{},"postaction":{},"timezone":"UTC"}}
{"version":"v1","sourcetype":"zscalernss-audit","input":{"type":"http_endpoint"},"event":{"time":"Mon Oct 16 22:55:48 2023","recordid":"1234","action":"Activate","category":"DATA_LOSS_PREVENTION_RESOURCE","subcategory":"DLP_DICTIONARY","resource":"SSL Rule Name","interface":"API","adminid":"example@zscaler.com","clientip":"89.160.20.112","result":"SUCCESS","errorcode":"AUTHENTICATION_FAILED","auditlogtype":"ZIA Portal Audit Log","preaction":{},"postaction":{},"timezone":"UTC"}}
87 changes: 84 additions & 3 deletions ...caler_zia/data_stream/audit/_dev/test/pipeline/test-audit-http-endpoint.log-expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
],
"id": "1234",
"kind": "event",
"original": "{ \"sourcetype\": \"zscalernss-audit\",\"input\": {\"type\": \"http_endpoint\"}, \"event\": { \"time\": \"Mon Oct 16 22:55:48 2023\", \"recordid\": \"1234\", \"action\": \"Activate\", \"category\": \"DATA_LOSS_PREVENTION_RESOURCE\", \"subcategory\": \"DLP_DICTIONARY\", \"resource\": \"SSL Rule Name\", \"interface\": \"API\", \"adminid\": \"example@zscaler.com\", \"clientip\": \"89.160.20.112\", \"result\": \"SUCCESS\", \"errorcode\": \"AUTHENTICATION_FAILED\", \"auditlogtype\": \"ZIA Portal Audit Log\", \"preaction\": {}, \"postaction\": {} } }",
"original": "{\"sourcetype\":\"zscalernss-audit\",\"input\":{\"type\":\"http_endpoint\"},\"event\":{\"time\":\"Mon Oct 16 22:55:48 2023\",\"recordid\":\"1234\",\"action\":\"Activate\",\"category\":\"DATA_LOSS_PREVENTION_RESOURCE\",\"subcategory\":\"DLP_DICTIONARY\",\"resource\":\"SSL Rule Name\",\"interface\":\"API\",\"adminid\":\"example@zscaler.com\",\"clientip\":\"89.160.20.112\",\"result\":\"SUCCESS\",\"errorcode\":\"AUTHENTICATION_FAILED\",\"auditlogtype\":\"ZIA Portal Audit Log\",\"preaction\":{},\"postaction\":{},\"timezone\":\"UTC\"}}",
"outcome": "success",
"timezone": "UTC",
"type": [
Expand Down Expand Up @@ -75,9 +75,90 @@
"resource": "SSL Rule Name",
"result": "SUCCESS",
"sub_category": "DLP_DICTIONARY",
"time": "2023-10-16T22:55:48.000Z"
"time": "2023-10-16T22:55:48.000Z",
"timezone": "UTC"
}
}
},
{
"@timestamp": "2023-10-16T22:55:48.000Z",
"ecs": {
"version": "8.11.0"
},
"error": {
"code": "AUTHENTICATION_FAILED"
},
"event": {
"action": "activate",
"category": [
"configuration"
],
"id": "1234",
"kind": "event",
"original": "{\"version\":\"v1\",\"sourcetype\":\"zscalernss-audit\",\"input\":{\"type\":\"http_endpoint\"},\"event\":{\"time\":\"Mon Oct 16 22:55:48 2023\",\"recordid\":\"1234\",\"action\":\"Activate\",\"category\":\"DATA_LOSS_PREVENTION_RESOURCE\",\"subcategory\":\"DLP_DICTIONARY\",\"resource\":\"SSL Rule Name\",\"interface\":\"API\",\"adminid\":\"example@zscaler.com\",\"clientip\":\"89.160.20.112\",\"result\":\"SUCCESS\",\"errorcode\":\"AUTHENTICATION_FAILED\",\"auditlogtype\":\"ZIA Portal Audit Log\",\"preaction\":{},\"postaction\":{},\"timezone\":\"UTC\"}}",
"outcome": "success",
"timezone": "UTC",
"type": [
"change"
]
},
"related": {
"ip": [
"89.160.20.112"
],
"user": [
"example",
"example@zscaler.com"
]
},
"rule": {
"category": "DLP_DICTIONARY",
"name": "SSL Rule Name",
"ruleset": "DATA_LOSS_PREVENTION_RESOURCE"
},
"source": {
"geo": {
"city_name": "Linköping",
"continent_name": "Europe",
"country_iso_code": "SE",
"country_name": "Sweden",
"location": {
"lat": 58.4167,
"lon": 15.6167
},
"region_iso_code": "SE-E",
"region_name": "Östergötland County"
},
"ip": "89.160.20.112"
},
"tags": [
"preserve_original_event",
"preserve_duplicate_custom_fields"
],
"user": {
"domain": "zscaler.com",
"email": "example@zscaler.com",
"name": "example"
},
"zscaler_zia": {
"audit": {
"action": "Activate",
"admin_id": "example@zscaler.com",
"audit_log_type": "ZIA Portal Audit Log",
"category": "DATA_LOSS_PREVENTION_RESOURCE",
"client_ip": "89.160.20.112",
"error_code": "AUTHENTICATION_FAILED",
"interface": "API",
"record": {
"id": "1234"
},
"resource": "SSL Rule Name",
"result": "SUCCESS",
"sub_category": "DLP_DICTIONARY",
"time": "2023-10-16T22:55:48.000Z",
"timezone": "UTC"
}
}
}
]
}
}
7 changes: 5 additions & 2 deletions packages/zscaler_zia/data_stream/audit/_dev/test/pipeline/test-audit.log
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
{ "sourcetype": "zscalernss-audit", "event": { "time": "Mon Oct 16 22:55:48 2023", "recordid": "1234", "action": "Activate", "category": "DATA_LOSS_PREVENTION_RESOURCE", "subcategory": "DLP_DICTIONARY", "resource": "SSL Rule Name", "interface": "API", "adminid": "example@zscaler.com", "clientip": "89.160.20.112", "result": "SUCCESS", "errorcode": "AUTHENTICATION_FAILED", "auditlogtype": "ZIA Portal Audit Log", "preaction": {}, "postaction": {} } }
{ "sourcetype": "zscalernss-audit", "event": { "time": "Mon Oct 16 22:55:48 2023", "recordid": "1234", "action": "Activate", "category": "DATA_LOSS_PREVENTION_RESOURCE", "subcategory": "DLP_DICTIONARY", "resource": "SSL Rule Name", "interface": "API", "adminid": "example@zscaler.com", "clientip": "89.160.20.112", "result": "SUCCESS", "errorcode": "AUTHENTICATION_FAILED", "auditlogtype": "ZIA Portal Audit Log", "preaction": {}, "postaction": {} , "timezone": "UTC"} }
{ "sourcetype": "zscalernss-audit", "event": { "time": "Mon Oct 16 22:55:48 2023", "recordid": "1234", "action": "Activate", "category": "DATA_LOSS_PREVENTION_RESOURCE", "subcategory": "DLP_DICTIONARY", "resource": "SSL Rule Name", "interface": "API", "adminid": "example@zscaler.com", "clientip": "89.160.20.112", "result": "SUCCESS", "errorcode": "AUTHENTICATION_FAILED", "auditlogtype": "ZIA Portal Audit Log", "timezone": "UTC", "preaction": {}, "postaction": {} } }
{"sourcetype":"zscalernss-audit","event":{"time":"Thu Jan 9 20:38:29 2025","recordid":"737420","action":"SIGN_OUT","category":"LOGIN","subcategory":"LOGIN","resource":"None","interface":"Unknown","adminid":"foo@example.com","clientip":"Unknown","result":"SUCCESS","errorcode":"None","auditlogtype":"EC","preaction":{},"postaction":{}}}
{"sourcetype":"zscalernss-audit","event":{"time":"Thu Jan 9 20:38:29 2025","recordid":"737420","action":"SIGN_OUT","category":"LOGIN","subcategory":"LOGIN","resource":"None","interface":"Unknown","adminid":"foo@example.com","clientip":"Unknown","result":"SUCCESS","errorcode":"None","auditlogtype":"EC","preaction":{},"postaction":{},"timezone":"UTC"}}
{"version":"v1", "sourcetype": "zscalernss-audit", "event": { "time": "Mon Oct 16 22:55:48 2023", "recordid": "1234", "action": "Activate", "category": "DATA_LOSS_PREVENTION_RESOURCE", "subcategory": "DLP_DICTIONARY", "resource": "SSL Rule Name", "interface": "API", "adminid": "example@zscaler.com", "clientip": "89.160.20.112", "result": "SUCCESS", "errorcode": "AUTHENTICATION_FAILED", "auditlogtype": "ZIA Portal Audit Log", "preaction": {}, "postaction": {} , "timezone": "UTC"} }
{"version":"v1", "sourcetype": "zscalernss-audit", "event": { "time": "Mon Oct 16 22:55:48 2023", "recordid": "1234", "action": "Activate", "category": "DATA_LOSS_PREVENTION_RESOURCE", "subcategory": "DLP_DICTIONARY", "resource": "SSL Rule Name", "interface": "API", "adminid": "example@zscaler.com", "clientip": "89.160.20.112", "result": "SUCCESS", "errorcode": "AUTHENTICATION_FAILED", "auditlogtype": "ZIA Portal Audit Log", "timezone": "UTC", "preaction": {}, "postaction": {} } }
{"version":"v1","sourcetype":"zscalernss-audit","event":{"time":"Thu Jan 9 20:38:29 2025","recordid":"737420","action":"SIGN_OUT","category":"LOGIN","subcategory":"LOGIN","resource":"None","interface":"Unknown","adminid":"foo@example.com","clientip":"Unknown","result":"SUCCESS","errorcode":"None","auditlogtype":"EC","preaction":{},"postaction":{},"timezone":"UTC"}}
Loading