From 3c6447528a2b1d6e419f0f0fa6fde0e7889481a6 Mon Sep 17 00:00:00 2001 From: wallentx Date: Wed, 4 Nov 2026 12:35:48 -0600 Subject: [PATCH] Make secure log export testable under Robolectric --- .../session/EnhancedSessionLogShare.kt | 19 +++++ .../session/EnhancedSessionLogShareTest.kt | 31 ++++++++ .../session/SecureSourceOpenerTestSupport.kt | 72 +++++++++++++++++++ .../launcher/session/SessionLogShareTest.kt | 6 ++ .../session/SessionLogShareZipTest.kt | 6 ++ 5 files changed, 134 insertions(+) create mode 100644 app/src/test/java/com/droiddeck/launcher/session/SecureSourceOpenerTestSupport.kt diff --git a/app/src/main/java/com/droiddeck/launcher/session/EnhancedSessionLogShare.kt b/app/src/main/java/com/droiddeck/launcher/session/EnhancedSessionLogShare.kt index 6d6f357d70..914e8c7b40 100644 --- a/app/src/main/java/com/droiddeck/launcher/session/EnhancedSessionLogShare.kt +++ b/app/src/main/java/com/droiddeck/launcher/session/EnhancedSessionLogShare.kt @@ -32,6 +32,10 @@ internal data class EnhancedShareLimits( val maxBytesTotal: Long = 64L * 1024 * 1024, ) +internal interface SecureSourceOpener { + fun withChannel(root: Path, relative: Path, block: (SeekableByteChannel) -> T): T? +} + internal object EnhancedSessionLogShare { private enum class Category(val suffix: String) { SESSION("session"), GRAPHICS("graphics"), GAMES("games") } @@ -63,6 +67,16 @@ internal object EnhancedSessionLogShare { private class Budget(val limit: Long, var remaining: Long = limit) + private val sourceOpenerOverride = object : ThreadLocal() { + override fun initialValue(): SecureSourceOpener? = null + } + + internal fun setSourceOpenerForTest(opener: SecureSourceOpener?) { + if (opener == null) sourceOpenerOverride.remove() else sourceOpenerOverride.set(opener) + } + + internal fun hasSourceOpenerForTest(): Boolean = sourceOpenerOverride.get() != null + fun create( context: Context, folder: File, @@ -313,6 +327,11 @@ internal object EnhancedSessionLogShare { } private fun withSecureChannel(root: Path, relative: Path, block: (SeekableByteChannel) -> T): T? { + sourceOpenerOverride.get()?.let { return it.withChannel(root, relative, block) } + return withAndroidSecureChannel(root, relative, block) + } + + private fun withAndroidSecureChannel(root: Path, relative: Path, block: (SeekableByteChannel) -> T): T? { val opened = ArrayList() return try { val parts = relative.map { it.toString() } diff --git a/app/src/test/java/com/droiddeck/launcher/session/EnhancedSessionLogShareTest.kt b/app/src/test/java/com/droiddeck/launcher/session/EnhancedSessionLogShareTest.kt index 73dd3f2132..b87649d5a8 100644 --- a/app/src/test/java/com/droiddeck/launcher/session/EnhancedSessionLogShareTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/session/EnhancedSessionLogShareTest.kt @@ -16,6 +16,8 @@ import org.robolectric.annotation.Config import java.io.RandomAccessFile import java.nio.file.Files import java.util.zip.ZipFile +import org.junit.After +import org.junit.Before @RunWith(RobolectricTestRunner::class) @Config(sdk = [33]) @@ -23,6 +25,10 @@ class EnhancedSessionLogShareTest { @get:Rule val tmp = TemporaryFolder() private val app get() = RuntimeEnvironment.getApplication() + @Before fun installSecureSourceOpener() = installJvmSecureSourceOpener() + + @After fun resetSourceOpener() = resetSecureSourceOpener() + @Test fun diagnosticsAreSplitIntoManifestedArchivesWithOneSessionIdentity() { val session = tmp.newFolder("2026-11-04-01-steam") session.resolve("session.log").writeText("startup ok\n") @@ -328,4 +334,29 @@ class EnhancedSessionLogShareTest { } SessionLogShare.clear(app) } + + @Test fun injectedSecureOpenFailureFailsClosedAndTheOverrideCanBeReset() { + val session = tmp.newFolder("2026-11-04-15-steam") + session.resolve("session.log").writeText("must not be shared\n") + EnhancedSessionLogShare.setSourceOpenerForTest(object : SecureSourceOpener { + override fun withChannel( + root: java.nio.file.Path, + relative: java.nio.file.Path, + block: (java.nio.channels.SeekableByteChannel) -> T, + ): T? = null + }) + try { + val sessionZip = EnhancedSessionLogShare.create(app, session).single { it.name.endsWith("-session.zip") } + ZipFile(sessionZip).use { archive -> + assertFalse(archive.entries().toList().any { it.name.endsWith("session.log") }) + val manifest = archive.getInputStream(archive.getEntry("diagnostics-manifest.json")) + .bufferedReader().readText() + assertTrue(manifest.contains("unsafe-or-unavailable-source")) + } + } finally { + resetSecureSourceOpener() + } + assertFalse(EnhancedSessionLogShare.hasSourceOpenerForTest()) + SessionLogShare.clear(app) + } } diff --git a/app/src/test/java/com/droiddeck/launcher/session/SecureSourceOpenerTestSupport.kt b/app/src/test/java/com/droiddeck/launcher/session/SecureSourceOpenerTestSupport.kt new file mode 100644 index 0000000000..7eeba41b71 --- /dev/null +++ b/app/src/test/java/com/droiddeck/launcher/session/SecureSourceOpenerTestSupport.kt @@ -0,0 +1,72 @@ +package com.droiddeck.launcher.session + +import java.nio.channels.SeekableByteChannel +import java.nio.file.DirectoryStream +import java.nio.file.Files +import java.nio.file.LinkOption +import java.nio.file.Path +import java.nio.file.Paths +import java.nio.file.SecureDirectoryStream +import java.nio.file.StandardOpenOption +import java.nio.file.attribute.BasicFileAttributeView +import java.nio.file.attribute.BasicFileAttributes + +internal object JvmSecureSourceOpener : SecureSourceOpener { + override fun withChannel(root: Path, relative: Path, block: (SeekableByteChannel) -> T): T? { + val expected = root.resolve(relative).normalize() + if (!expected.startsWith(root.normalize())) return null + val initial = runCatching { + Files.readAttributes(expected, BasicFileAttributes::class.java, LinkOption.NOFOLLOW_LINKS) + }.getOrNull() ?: return null + val links = runCatching { + (Files.getAttribute(expected, "unix:nlink", LinkOption.NOFOLLOW_LINKS) as Number).toLong() + }.getOrNull() ?: return null + val expectedKey = initial.fileKey() ?: return null + if (!initial.isRegularFile || initial.isSymbolicLink || links != 1L) return null + val first = Files.newDirectoryStream(root) + if (first !is SecureDirectoryStream<*>) { + first.close() + return null + } + @Suppress("UNCHECKED_CAST") + val secureFirst = first as SecureDirectoryStream + val opened = ArrayList>() + opened += first + var current = secureFirst + return try { + val parts = relative.map { it.toString() } + if (parts.isEmpty()) return null + for (part in parts.dropLast(1)) { + val child = Paths.get(part) + val attrs = current.getFileAttributeView( + child, BasicFileAttributeView::class.java, LinkOption.NOFOLLOW_LINKS, + ).readAttributes() + if (!attrs.isDirectory || attrs.isSymbolicLink) return null + val next = current.newDirectoryStream(child, LinkOption.NOFOLLOW_LINKS) + opened += next + current = next + } + val leaf = Paths.get(parts.last()) + val attrs = current.getFileAttributeView( + leaf, BasicFileAttributeView::class.java, LinkOption.NOFOLLOW_LINKS, + ).readAttributes() + if (!attrs.isRegularFile || attrs.isSymbolicLink || attrs.fileKey() != expectedKey) return null + current.newByteChannel(leaf, setOf(StandardOpenOption.READ, LinkOption.NOFOLLOW_LINKS)).use { channel -> + val after = current.getFileAttributeView( + leaf, BasicFileAttributeView::class.java, LinkOption.NOFOLLOW_LINKS, + ).readAttributes() + if (after.fileKey() != expectedKey) null else block(channel) + } + } finally { + opened.asReversed().forEach { runCatching { it.close() } } + } + } +} + +internal fun installJvmSecureSourceOpener() { + EnhancedSessionLogShare.setSourceOpenerForTest(JvmSecureSourceOpener) +} + +internal fun resetSecureSourceOpener() { + EnhancedSessionLogShare.setSourceOpenerForTest(null) +} 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 678ae876fd..d451abc9de 100644 --- a/app/src/test/java/com/droiddeck/launcher/session/SessionLogShareTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/session/SessionLogShareTest.kt @@ -8,6 +8,8 @@ import org.junit.Assert.assertNull import org.junit.Assert.assertTrue import org.junit.Rule import org.junit.Test +import org.junit.After +import org.junit.Before import org.junit.rules.TemporaryFolder import org.junit.runner.RunWith import org.robolectric.RobolectricTestRunner @@ -24,6 +26,10 @@ import java.util.zip.ZipFile class SessionLogShareTest { @get:Rule val tmp = TemporaryFolder() + @Before fun installSecureSourceOpener() = installJvmSecureSourceOpener() + + @After fun resetSourceOpener() = resetSecureSourceOpener() + private val secret = "GET /x?sessionid=abcdef123456 200" private val leaked = "abcdef123456" diff --git a/app/src/test/java/com/droiddeck/launcher/session/SessionLogShareZipTest.kt b/app/src/test/java/com/droiddeck/launcher/session/SessionLogShareZipTest.kt index ecc756553f..d02e616c20 100644 --- a/app/src/test/java/com/droiddeck/launcher/session/SessionLogShareZipTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/session/SessionLogShareZipTest.kt @@ -9,6 +9,8 @@ import java.util.zip.ZipFile import org.junit.Assert.assertEquals import org.junit.Assert.assertFalse import org.junit.Assert.assertTrue +import org.junit.After +import org.junit.Before import org.junit.Test import org.junit.runner.RunWith import org.robolectric.RobolectricTestRunner @@ -20,6 +22,10 @@ import org.robolectric.annotation.Config class SessionLogShareZipTest { private val app get() = RuntimeEnvironment.getApplication() + @Before fun installSecureSourceOpener() = installJvmSecureSourceOpener() + + @After fun resetSourceOpener() = resetSecureSourceOpener() + @Test fun aLargeSteamLogIsRedactedInTheSharedArchive() { val session = File(LinuxRuntime.logDir(app), "2026-10-08-02-steam").apply { mkdirs() } val raw = File(session, "steam-42.log")