harden logging (#414)

This commit is contained in:
Kurt Himebauch authored and GitHub committed 2026-10-08 02:10:06 +00:00
1 parent 5954ac58f8
commit 7b1f0f25b2
3 files changed
+61 -1

No files matched your search

@@ -60,6 +60,15 @@ object LogRedactor {
private val IPV4 = Regex("(?<![0-9.])(\\d{1,3})\\.(\\d{1,3})\\.(\\d{1,3})\\.(\\d{1,3})(?![0-9.])")
/** An IPv6 literal: "::" somewhere, or all eight groups (a clock's 10:03:05 is neither). */
private val IPV6 = Regex("(?<![0-9A-Za-z:])[0-9A-Fa-f]{0,4}(?::[0-9A-Fa-f]{0,4}){2,7}(?:%[A-Za-z0-9_.]+)?(?![0-9A-Za-z:])")
private val MAC = Regex("(?i)(?<![0-9a-z:-])[0-9a-f]{2}([:-])(?:[0-9a-f]{2}\\1){4}[0-9a-f]{2}(?![0-9a-z:-])")
private val MAC_FIELD = Regex(
"(?i)(\\bmac(?:[_ ]?address)?[\"']?\\s*[:=]\\s*[\"']?)[0-9a-f]{2}([:-])" +
"(?:[0-9a-f]{2}\\2){4}[0-9a-f]{2}(?![0-9a-z:-])"
)
private val DEVICE_IDENTIFIER = Regex(
"(?i)(\\b(?:android[_ ]?id|(?:device|controller)[_ ]?serial|serial(?:[_ ]?number)?|build\\.serial)" +
"[\"']?\\s*[:=]\\s*)(\"[^\"\\r\\n<>]+\"|'[^'\\r\\n<>]+'|[^\\s\"'<>&;,\\[\\]{}]+)"
)
/**
* The account a Steam UI login line names ("Login: OnLoginStateChange <account> 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]}<redacted:mac>" }
out = MAC.replace(out, "<redacted:mac>")
out = DEVICE_IDENTIFIER.replace(out) {
val value = it.groupValues[2]
val quote = value.first().takeIf { char -> char == '\"' || char == '\'' }?.toString().orEmpty()
"${it.groupValues[1]}${quote}<redacted:serial>${quote}"
}
out = GUID.replace(out, "<redacted:guid>")
out = JWT_LABELLED.replace(out) { "${it.groupValues[1]}<redacted:jwt>" }
out = JWT_BASE64.replace(out, "<redacted:jwt>")
@@ -42,6 +42,34 @@ class LogRedactorTest {
assertEquals(line, LogRedactor.redact(line))
}
@Test fun macAddressesAreRedactedInAnyLog() {
assertEquals(" mac <redacted:mac>", LogRedactor.redact(" mac 02:ab:cd:ef:12:34"))
assertEquals("controller <redacted:mac> connected", LogRedactor.redact("controller A2-B3-C4-D5-E6-F7 connected"))
assertEquals("mac=<redacted:mac>, peer=<redacted:mac>", LogRedactor.redact("mac=02:ab:cd:ef:12:34, peer=a2:b3:c4:d5:e6:f7"))
assertEquals("MAC:<redacted:mac>", LogRedactor.redact("MAC:02:ab:cd:ef:12:34"))
assertEquals("MacAddress:<redacted:mac>", LogRedactor.redact("MacAddress:A2-B3-C4-D5-E6-F7"))
assertEquals("{\"mac_address\":\"<redacted:mac>\"}", 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: <redacted:serial>", LogRedactor.redact("$label: controller-123456"))
}
assertEquals("Serial number: <redacted:serial> connected", LogRedactor.redact("Serial number: 12345678901234567 connected"))
assertEquals("{\"serial_number\":\"<redacted:serial>\",\"result\":0}", LogRedactor.redact("{\"serial_number\":\"controller 123456\",\"result\":0}"))
assertEquals("device_serial = '<redacted: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)
@@ -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 <redacted:mac>\n", out.getValue("network.txt"))
assertEquals("Serial number: <redacted:serial>\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")