From 7b1f0f25b2478272492a4b2bba9e59c6abce26a0 Mon Sep 17 00:00:00 2001 From: Kurt Himebauch <136133082+xXJSONDeruloXx@users.noreply.github.com> Date: Wed, 7 Oct 2026 22:10:06 -0400 Subject: [PATCH] harden logging (#414) --- .../droiddeck/launcher/core/LogRedactor.kt | 18 ++++++++++- .../launcher/core/LogRedactorTest.kt | 32 +++++++++++++++++++ .../launcher/session/SessionLogShareTest.kt | 12 +++++++ 3 files changed, 61 insertions(+), 1 deletion(-) diff --git a/app/src/main/java/com/droiddeck/launcher/core/LogRedactor.kt b/app/src/main/java/com/droiddeck/launcher/core/LogRedactor.kt index f9c03fefb3..bac157b82e 100644 --- a/app/src/main/java/com/droiddeck/launcher/core/LogRedactor.kt +++ b/app/src/main/java/com/droiddeck/launcher/core/LogRedactor.kt @@ -60,6 +60,15 @@ object LogRedactor { private val IPV4 = Regex("(?]+\"|'[^'\\r\\n<>]+'|[^\\s\"'<>&;,\\[\\]{}]+)" + ) /** * The account a Steam UI login line names ("Login: OnLoginStateChange 2 1 0 0"): a @@ -196,7 +205,7 @@ object LogRedactor { * only when that matches, so a folder scrubbed under older rules is scrubbed again on the way * out. */ - const val RULES_VERSION = 1 + const val RULES_VERSION = 2 /** [src]'s lines, scrubbed, to [out]. */ fun scrubTo(src: java.io.File, out: java.io.Writer) { @@ -208,6 +217,13 @@ object LogRedactor { if (line.isEmpty()) return line return try { var out = line + out = MAC_FIELD.replace(out) { "${it.groupValues[1]}" } + out = MAC.replace(out, "") + out = DEVICE_IDENTIFIER.replace(out) { + val value = it.groupValues[2] + val quote = value.first().takeIf { char -> char == '\"' || char == '\'' }?.toString().orEmpty() + "${it.groupValues[1]}${quote}${quote}" + } out = GUID.replace(out, "") out = JWT_LABELLED.replace(out) { "${it.groupValues[1]}" } out = JWT_BASE64.replace(out, "") diff --git a/app/src/test/java/com/droiddeck/launcher/core/LogRedactorTest.kt b/app/src/test/java/com/droiddeck/launcher/core/LogRedactorTest.kt index 88f2a87036..8b21590974 100644 --- a/app/src/test/java/com/droiddeck/launcher/core/LogRedactorTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/core/LogRedactorTest.kt @@ -42,6 +42,34 @@ class LogRedactorTest { assertEquals(line, LogRedactor.redact(line)) } + @Test fun macAddressesAreRedactedInAnyLog() { + assertEquals(" mac ", LogRedactor.redact(" mac 02:ab:cd:ef:12:34")) + assertEquals("controller connected", LogRedactor.redact("controller A2-B3-C4-D5-E6-F7 connected")) + assertEquals("mac=, peer=", LogRedactor.redact("mac=02:ab:cd:ef:12:34, peer=a2:b3:c4:d5:e6:f7")) + assertEquals("MAC:", LogRedactor.redact("MAC:02:ab:cd:ef:12:34")) + assertEquals("MacAddress:", LogRedactor.redact("MacAddress:A2-B3-C4-D5-E6-F7")) + assertEquals("{\"mac_address\":\"\"}", LogRedactor.redact("{\"mac_address\":\"02:ab:cd:ef:12:34\"}")) + } + + @Test fun macRedactionPreservesOtherDiagnosticValues() { + val line = "[12:34:56] server ab:cd:ef:12:34:56:78:90 partial=ab:cd:ef:12:34 mixed=ab:cd-ef:12:34:56" + assertEquals(line, LogRedactor.redact(line)) + } + + @Test fun labelledDeviceIdentifiersAreRedacted() { + for (label in listOf("Serial number", "serial_number", "serialNumber", "serial", "device_serial", "Controller Serial", "ANDROID_ID", "build.serial")) { + assertEquals("$label: ", LogRedactor.redact("$label: controller-123456")) + } + assertEquals("Serial number: connected", LogRedactor.redact("Serial number: 12345678901234567 connected")) + assertEquals("{\"serial_number\":\"\",\"result\":0}", LogRedactor.redact("{\"serial_number\":\"controller 123456\",\"result\":0}")) + assertEquals("device_serial = ''", LogRedactor.redact("device_serial = 'controller 123456'")) + } + + @Test fun serialRedactionPreservesUnlabelledDiagnostics() { + val line = "serial port initialized; serial_number_count=2; controller=12345678901234567" + assertEquals(line, LogRedactor.redact(line)) + } + @Test fun redactingTwiceChangesNothing() { val lines = listOf( "Using JWT 25484942796017334", @@ -49,6 +77,10 @@ class LogRedactorTest { "user 76561198012341234 [U:1:52075506]", "external address 2607:f8b0:4005:80a::200e", "OnLoginStateChange someaccount 2 1 0 0", + "mac 02:ab:cd:ef:12:34 controller A2-B3-C4-D5-E6-F7", + "MAC:02:ab:cd:ef:12:34", + "Serial number: 12345678901234567", + "{\"ANDROID_ID\":\"0123456789abcdef\"}", ) for (line in lines) { val once = LogRedactor.redact(line) diff --git a/app/src/test/java/com/droiddeck/launcher/session/SessionLogShareTest.kt b/app/src/test/java/com/droiddeck/launcher/session/SessionLogShareTest.kt index ea92505205..39978490a6 100644 --- a/app/src/test/java/com/droiddeck/launcher/session/SessionLogShareTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/session/SessionLogShareTest.kt @@ -66,6 +66,18 @@ class SessionLogShareTest { assertFalse(zip(folder).getValue("session.log").contains(leaked)) } + @Test fun olderRuleRecordReScrubsDeviceIdentifiers() { + val folder = tmp.newFolder("2026-10-07-01-steam") + File(folder, "network.txt").writeText("mac 02:ab:cd:ef:12:34\n") + File(folder, "steam").mkdirs() + File(folder, "steam/controller_support.txt").writeText("Serial number: controller-123456\n") + record(folder, "network.txt", "steam/controller_support.txt", rules = 1) + + val out = zip(folder) + assertEquals("mac \n", out.getValue("network.txt")) + assertEquals("Serial number: \n", out.getValue("steam/controller_support.txt")) + } + @Test fun withoutARecordEveryFileIsScrubbed() { val folder = tmp.newFolder("2026-10-06-04-steam") File(folder, "session.log").writeText("$secret\n")