-
Notifications
You must be signed in to change notification settings - Fork 4.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Ingest ES structured audit logs (#10352)
This is a "forward port" of #8852. In #8852, we taught Filebeat to ingest either structured or unstructured ES audit logs but the resulting fields conformed to the 6.x mapping structure. In this PR we also teach Filebeat to ingest either structured or unstructured ES audit logs but the resulting fields conform to the 7.0 (ECS-based) mapping structure.
- Loading branch information
1 parent
fd149bb
commit 5e460ed
Showing
13 changed files
with
421 additions
and
70 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
132 changes: 132 additions & 0 deletions
132
filebeat/module/elasticsearch/audit/ingest/pipeline-json.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,132 @@ | ||
| { | ||
| "description": "Pipeline for parsing elasticsearch audit logs in JSON format", | ||
| "processors": [ | ||
| { | ||
| "json": { | ||
| "field": "message", | ||
| "target_field": "elasticsearch.audit" | ||
| } | ||
| }, | ||
| { | ||
| "dot_expander": { | ||
| "field": "event.action", | ||
| "path": "elasticsearch.audit" | ||
| } | ||
| }, | ||
| { | ||
| "rename": { | ||
| "field": "elasticsearch.audit.event.action", | ||
| "target_field": "event.action" | ||
| } | ||
| }, | ||
| { | ||
| "dot_expander": { | ||
| "field": "event.type", | ||
| "path": "elasticsearch.audit" | ||
| } | ||
| }, | ||
| { | ||
| "rename": { | ||
| "field": "elasticsearch.audit.event.type", | ||
| "target_field": "elasticsearch.audit.layer" | ||
| } | ||
| }, | ||
| { | ||
| "dot_expander": { | ||
| "field": "origin.address", | ||
| "path": "elasticsearch.audit" | ||
| } | ||
| }, | ||
| { | ||
| "grok": { | ||
| "field": "elasticsearch.audit.origin.address", | ||
| "patterns": [ | ||
| "\\[%{IPORHOST:source.ip}\\]:%{INT:source.port:int}", | ||
| "%{IPORHOST:source.ip}:%{INT:source.port:int}" | ||
| ] | ||
| } | ||
| }, | ||
| { | ||
| "rename": { | ||
| "field": "elasticsearch.audit.origin.address", | ||
| "target_field": "source.address" | ||
| } | ||
| }, | ||
| { | ||
| "dot_expander": { | ||
| "field": "url.path", | ||
| "path": "elasticsearch.audit" | ||
| } | ||
| }, | ||
| { | ||
| "dot_expander": { | ||
| "field": "url.query", | ||
| "path": "elasticsearch.audit" | ||
| } | ||
| }, | ||
| { | ||
| "set": { | ||
| "if": "ctx.elasticsearch.audit?.url?.path != null && ctx.elasticsearch.audit?.url?.query == null", | ||
| "field": "url.original", | ||
| "value": "{{elasticsearch.audit.url.path}}" | ||
| } | ||
| }, | ||
| { | ||
| "set": { | ||
| "if": "ctx.elasticsearch.audit?.url?.path != null && ctx.elasticsearch.audit?.url?.query != null", | ||
| "field": "url.original", | ||
| "value": "{{elasticsearch.audit.url.path}}?{{elasticsearch.audit.url.query}}" | ||
| } | ||
| }, | ||
| { | ||
| "remove": { | ||
| "if": "ctx.elasticsearch.audit?.url?.path != null", | ||
| "field": "elasticsearch.audit.url.path" | ||
| } | ||
| }, | ||
| { | ||
| "remove": { | ||
| "if": "ctx.elasticsearch.audit?.url?.query != null", | ||
| "field": "elasticsearch.audit.url.query" | ||
| } | ||
| }, | ||
| { | ||
| "dot_expander": { | ||
| "field": "node.id", | ||
| "path": "elasticsearch.audit" | ||
| } | ||
| }, | ||
| { | ||
| "dot_expander": { | ||
| "field": "node.name", | ||
| "path": "elasticsearch.audit" | ||
| } | ||
| }, | ||
| { | ||
| "rename": { | ||
| "field": "elasticsearch.audit.node", | ||
| "target_field": "elasticsearch.node" | ||
| } | ||
| }, | ||
| { | ||
| "dot_expander": { | ||
| "field": "user.name", | ||
| "path": "elasticsearch.audit" | ||
| } | ||
| }, | ||
| { | ||
| "rename": { | ||
| "field": "elasticsearch.audit.user.name", | ||
| "target_field": "user.name" | ||
| } | ||
| } | ||
| ], | ||
| "on_failure": [ | ||
| { | ||
| "set": { | ||
| "field": "error.message", | ||
| "value": "{{ _ingest.on_failure_message }}" | ||
| } | ||
| } | ||
| ] | ||
| } |
63 changes: 63 additions & 0 deletions
63
filebeat/module/elasticsearch/audit/ingest/pipeline-plaintext.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,63 @@ | ||
| { | ||
| "description": "Pipeline for parsing elasticsearch audit logs in plaintext format", | ||
| "processors": [ | ||
| { | ||
| "grok": { | ||
| "field": "message", | ||
| "pattern_definitions": { | ||
| "ES_TIMESTAMP": "\\[%{TIMESTAMP_ISO8601:elasticsearch.audit.@timestamp}\\]", | ||
| "ES_NODE_NAME": "(\\[%{DATA:elasticsearch.node.name}\\])?", | ||
| "ES_AUDIT_LAYER": "\\[%{WORD:elasticsearch.audit.layer}\\]", | ||
| "ES_AUDIT_EVENT_TYPE": "\\[%{WORD:event.type}\\]", | ||
| "ES_AUDIT_ORIGIN_TYPE": "(origin_type\\=\\[%{WORD:elasticsearch.audit.origin.type}\\])?", | ||
| "ES_AUDIT_ORIGIN_ADDRESS": "(origin_address\\=\\[%{IPORHOST:source.ip}\\])?", | ||
| "ES_AUDIT_PRINCIPAL": "(principal\\=\\[%{WORD:user.name}\\])?", | ||
| "ES_AUDIT_REALM": "(realm\\=\\[%{WORD:elasticsearch.audit.user.realm}\\])?", | ||
| "ES_AUDIT_ROLES": "(roles\\=\\[%{DATA:elasticsearch.audit.user.roles}\\])?", | ||
| "ES_AUDIT_ACTION": "(action\\=\\[%{DATA:elasticsearch.audit.action}(\\[%{DATA:elasticsearch.audit.sub_action}\\])?\\])?", | ||
| "ES_AUDIT_URI": "(uri=\\[%{DATA:url.original}\\])?", | ||
| "ES_AUDIT_INDICES": "(indices\\=\\[%{DATA:elasticsearch.audit.indices}\\])?", | ||
| "ES_AUDIT_REQUEST": "(request\\=\\[%{WORD:elasticsearch.audit.request.name}\\])?", | ||
| "ES_AUDIT_REQUEST_BODY": "(request_body\\=\\[%{DATA:http.request.body.content}\\])?" | ||
| }, | ||
| "patterns": [ | ||
| "%{ES_TIMESTAMP}\\s*%{ES_NODE_NAME}\\s*%{ES_AUDIT_LAYER}\\s*%{ES_AUDIT_EVENT_TYPE}\\s*%{ES_AUDIT_ORIGIN_TYPE},?\\s*%{ES_AUDIT_ORIGIN_ADDRESS},?\\s*%{ES_AUDIT_PRINCIPAL},?\\s*%{ES_AUDIT_REALM},?\\s*%{ES_AUDIT_ROLES},?\\s*%{ES_AUDIT_ACTION},?\\s*%{ES_AUDIT_INDICES},?\\s*%{ES_AUDIT_URI},?\\s*%{ES_AUDIT_REQUEST},?\\s*%{ES_AUDIT_REQUEST_BODY},?" | ||
| ] | ||
| } | ||
| }, | ||
| { | ||
| "split": { | ||
| "field": "elasticsearch.audit.user.roles", | ||
| "separator": ",", | ||
| "ignore_missing": true | ||
| } | ||
| }, | ||
| { | ||
| "split": { | ||
| "field": "elasticsearch.audit.indices", | ||
| "separator": ",", | ||
| "ignore_missing": true | ||
| } | ||
| }, | ||
| { | ||
| "script": { | ||
| "lang": "painless", | ||
| "source": "if (ctx.elasticsearch.audit.sub_action != null) { ctx.elasticsearch.audit.action += '[' + ctx.elasticsearch.audit.sub_action + ']' }" | ||
| } | ||
| }, | ||
| { | ||
| "remove": { | ||
| "field": "elasticsearch.audit.sub_action", | ||
| "ignore_missing": true | ||
| } | ||
| } | ||
| ], | ||
| "on_failure": [ | ||
| { | ||
| "set": { | ||
| "field": "error.message", | ||
| "value": "{{ _ingest.on_failure_message }}" | ||
| } | ||
| } | ||
| ] | ||
| } |
Oops, something went wrong.