Skip to content

opencanary: implement password redaction via gsub #14036

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 1 commit into from
May 29, 2025
Merged

opencanary: implement password redaction via gsub #14036

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions packages/opencanary/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: "0.5.0"
changes:
- description: Make password redaction available for basic subscription.
type: enhancement
link: https://github.com/elastic/integrations/pull/14036
- version: "0.4.1"
changes:
- description: Update event ECS fields to remove unwanted alert noise.
Expand Down
1 change: 1 addition & 0 deletions packages/opencanary/data_stream/events/_dev/test/pipeline/test-common-config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
fields:
tags:
- preserve_original_event
- redact_passwords
52 changes: 34 additions & 18 deletions packages/opencanary/data_stream/events/_dev/test/pipeline/test-events.log-expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,8 @@
"port": 62915
},
"tags": [
"preserve_original_event"
"preserve_original_event",
"redact_passwords"
]
},
{
Expand Down Expand Up @@ -118,7 +119,8 @@
"port": 36462
},
"tags": [
"preserve_original_event"
"preserve_original_event",
"redact_passwords"
]
},
{
Expand Down Expand Up @@ -172,7 +174,8 @@
"port": 37388
},
"tags": [
"preserve_original_event"
"preserve_original_event",
"redact_passwords"
]
},
{
Expand Down Expand Up @@ -225,7 +228,8 @@
"port": 11851
},
"tags": [
"preserve_original_event"
"preserve_original_event",
"redact_passwords"
]
},
{
Expand Down Expand Up @@ -274,7 +278,8 @@
"port": 36958
},
"tags": [
"preserve_original_event"
"preserve_original_event",
"redact_passwords"
]
},
{
Expand All @@ -293,7 +298,7 @@
"kind": [
"alert"
],
"original": "{\"dst_host\": \"10.10.10.10\", \"dst_port\": 22, \"local_time\": \"2024-04-04 17:03:52.569759\", \"local_time_adjusted\": \"2024-04-04 11:03:52.569785\", \"logdata\": {\"LOCALVERSION\": \"SSH-2.0-OpenSSH_5.1p1 Debian-4\", \"PASSWORD\": \"P@ssw0rd!\", \"REMOTEVERSION\": \"SSH-2.0-OpenSSH_8.9p1 Ubuntu-3ubuntu0.6\", \"USERNAME\": \"jdoe\"}, \"logtype\": 4002, \"node_id\": \"opencanary-1\", \"src_host\": \"192.168.0.10\", \"src_port\": 11851, \"utc_time\": \"2024-04-04 17:03:52.569781\"}",
"original": "{\"dst_host\": \"10.10.10.10\", \"dst_port\": 22, \"local_time\": \"2024-04-04 17:03:52.569759\", \"local_time_adjusted\": \"2024-04-04 11:03:52.569785\", \"logdata\": {\"LOCALVERSION\": \"SSH-2.0-OpenSSH_5.1p1 Debian-4\", \"PASSWORD\": \"<REDACTED>\", \"REMOTEVERSION\": \"SSH-2.0-OpenSSH_8.9p1 Ubuntu-3ubuntu0.6\", \"USERNAME\": \"jdoe\"}, \"logtype\": 4002, \"node_id\": \"opencanary-1\", \"src_host\": \"192.168.0.10\", \"src_port\": 11851, \"utc_time\": \"2024-04-04 17:03:52.569781\"}",
"provider": "LOG_SSH_LOGIN_ATTEMPT",
"start": "2024-04-04T17:03:52.569Z",
"type": [
Expand Down Expand Up @@ -330,7 +335,8 @@
"port": 11851
},
"tags": [
"preserve_original_event"
"preserve_original_event",
"redact_passwords"
],
"user": {
"name": "jdoe"
Expand Down Expand Up @@ -386,7 +392,8 @@
"port": 36986
},
"tags": [
"preserve_original_event"
"preserve_original_event",
"redact_passwords"
]
},
{
Expand Down Expand Up @@ -439,7 +446,8 @@
"port": 11875
},
"tags": [
"preserve_original_event"
"preserve_original_event",
"redact_passwords"
],
"url": {
"extension": "html",
Expand Down Expand Up @@ -509,7 +517,8 @@
"port": 59142
},
"tags": [
"preserve_original_event"
"preserve_original_event",
"redact_passwords"
]
},
{
Expand Down Expand Up @@ -561,7 +570,8 @@
"port": 59156
},
"tags": [
"preserve_original_event"
"preserve_original_event",
"redact_passwords"
]
},
{
Expand All @@ -580,7 +590,7 @@
"kind": [
"alert"
],
"original": "{\"dst_host\": \"10.10.10.10\", \"dst_port\": 80, \"local_time\": \"2024-04-04 17:04:14.888092\", \"local_time_adjusted\": \"2024-04-04 11:04:14.888116\", \"logdata\": {\"HOSTNAME\": \"192.168.200.85\", \"PASSWORD\": \"P@$$w0rd!\", \"PATH\": \"/index.html\", \"SKIN\": \"nasLogin\", \"USERAGENT\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/122.0.0.0 Safari/537.36 Edg/122.0.0.0\", \"USERNAME\": \"jdoe\"}, \"logtype\": 3001, \"node_id\": \"opencanary-1\", \"src_host\": \"192.168.0.10\", \"src_port\": 11878, \"utc_time\": \"2024-04-04 17:04:14.888112\"}",
"original": "{\"dst_host\": \"10.10.10.10\", \"dst_port\": 80, \"local_time\": \"2024-04-04 17:04:14.888092\", \"local_time_adjusted\": \"2024-04-04 11:04:14.888116\", \"logdata\": {\"HOSTNAME\": \"192.168.200.85\", \"PASSWORD\": \"<REDACTED>\", \"PATH\": \"/index.html\", \"SKIN\": \"nasLogin\", \"USERAGENT\": \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/122.0.0.0 Safari/537.36 Edg/122.0.0.0\", \"USERNAME\": \"jdoe\"}, \"logtype\": 3001, \"node_id\": \"opencanary-1\", \"src_host\": \"192.168.0.10\", \"src_port\": 11878, \"utc_time\": \"2024-04-04 17:04:14.888112\"}",
"provider": "LOG_HTTP_POST_LOGIN_ATTEMPT",
"start": "2024-04-04T17:04:14.888Z",
"type": [
Expand Down Expand Up @@ -617,7 +627,8 @@
"port": 11878
},
"tags": [
"preserve_original_event"
"preserve_original_event",
"redact_passwords"
],
"url": {
"extension": "html",
Expand Down Expand Up @@ -691,7 +702,8 @@
"port": 11892
},
"tags": [
"preserve_original_event"
"preserve_original_event",
"redact_passwords"
],
"url": {
"extension": "html",
Expand Down Expand Up @@ -761,7 +773,8 @@
"port": 52962
},
"tags": [
"preserve_original_event"
"preserve_original_event",
"redact_passwords"
]
},
{
Expand Down Expand Up @@ -814,7 +827,8 @@
"port": 57648
},
"tags": [
"preserve_original_event"
"preserve_original_event",
"redact_passwords"
]
},
{
Expand Down Expand Up @@ -879,7 +893,8 @@
"ip": "192.168.0.10"
},
"tags": [
"preserve_original_event"
"preserve_original_event",
"redact_passwords"
],
"user": {
"domain": "CONTOSO",
Expand Down Expand Up @@ -922,7 +937,8 @@
"ip": "192.168.0.10"
},
"tags": [
"preserve_original_event"
"preserve_original_event",
"redact_passwords"
]
}
]
Expand Down
8 changes: 3 additions & 5 deletions packages/opencanary/data_stream/events/elasticsearch/ingest_pipeline/default.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -653,15 +653,13 @@ processors:
field: opencanary.logdata.PASSWORD
ignore_missing: true
ignore_failure: true
- redact:
- gsub:
description: Redact any passwords in the log data
tag: redact_event_original
if: 'ctx.tags != null && ctx.tags.contains("redact_passwords") && ctx.event?.original =~ /\"PASSWORD\": \"/'
field: event.original
patterns:
- '"PASSWORD": "%{DATA:REDACTED}"'
prefix: '"PASSWORD": "<'
suffix: '>"'
pattern: '(.*"PASSWORD": *").*?(".*)'
replacement: '$1<REDACTED>$2'
ignore_missing: true
- rename:
description: Rename opencanary.logdata.DOMAIN to user.domain
Expand Down
2 changes: 1 addition & 1 deletion packages/opencanary/manifest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
format_version: 3.1.3
name: opencanary
title: "OpenCanary"
version: "0.4.1"
version: "0.5.0"
description: "This integration collects and parses logs from OpenCanary honeypots."
type: integration
categories:
Expand Down