Write passkey logs to disk and copy to clipboard from settings > about

SaintPatrck · SaintPatrck · commit 24e174ef31a1 · 2025-02-05T16:04:48.000-05:00
This commit introduces the ability to copy Passkey logs for debugging purposes.

Key changes:

-   Added `writeToFile` and `readFromFile` functions to `FileManager` to handle file writing and reading operations.
-   Implemented `getPasskeyLogs` function in `LogsManager` to fetch the logs.
-   Introduced a PasskeyTree class in `LogsManagerImpl` to write Passkey related logs to a designated log file.
-   Added a "Copy passkey logs" option in the About screen to allow users to copy the logs to the clipboard.
-   Updated `AboutViewModel` to handle the copy passkey logs action.
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/platform/manager/LogsManager.kt b/app/src/main/java/com/x8bit/bitwarden/data/platform/manager/LogsManager.kt
@@ -21,4 +21,9 @@ interface LogsManager {
      * Tracks the current user data.
      */
     fun setUserData(userId: String?, environmentType: Environment.Type)
+
+    /**
+     * Gets the passkey logs.
+     */
+    suspend fun getPasskeyLogs(): Result<String>
 }
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/platform/manager/di/PlatformManagerModule.kt b/app/src/main/java/com/x8bit/bitwarden/data/platform/manager/di/PlatformManagerModule.kt
@@ -68,6 +68,7 @@ import com.x8bit.bitwarden.data.platform.repository.EnvironmentRepository
 import com.x8bit.bitwarden.data.platform.repository.ServerConfigRepository
 import com.x8bit.bitwarden.data.platform.repository.SettingsRepository
 import com.x8bit.bitwarden.data.vault.datasource.disk.VaultDiskSource
+import com.x8bit.bitwarden.data.vault.manager.FileManager
 import com.x8bit.bitwarden.data.vault.manager.VaultLockManager
 import com.x8bit.bitwarden.data.vault.repository.VaultRepository
 import dagger.Module
@@ -257,9 +258,15 @@ object PlatformManagerModule {
     fun provideLogsManager(
         legacyAppCenterMigrator: LegacyAppCenterMigrator,
         settingsRepository: SettingsRepository,
+        clock: Clock,
+        fileManager: FileManager,
+        dispatcherManager: DispatcherManager,
     ): LogsManager = LogsManagerImpl(
         settingsRepository = settingsRepository,
         legacyAppCenterMigrator = legacyAppCenterMigrator,
+        fileManager = fileManager,
+        clock = clock,
+        dispatcherManager = dispatcherManager,
     )
 
     @Provides
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/vault/manager/FileManager.kt b/app/src/main/java/com/x8bit/bitwarden/data/vault/manager/FileManager.kt
@@ -49,4 +49,14 @@ interface FileManager {
      * reference.
      */
     suspend fun writeUriToCache(fileUri: Uri): Result<File>
+
+    /**
+     * Writes [data] to a file on disk.
+     */
+    suspend fun writeToFile(parent: String?, fileName: String, data: String)
+
+    /**
+     * Reads the contents of a file on disk.
+     */
+    suspend fun readFromFile(parent: String?, fileName: String): Result<String>
 }
diff --git a/app/src/main/java/com/x8bit/bitwarden/data/vault/manager/FileManagerImpl.kt b/app/src/main/java/com/x8bit/bitwarden/data/vault/manager/FileManagerImpl.kt
@@ -4,6 +4,8 @@ import android.content.Context
 import android.net.Uri
 import com.x8bit.bitwarden.data.platform.annotation.OmitFromCoverage
 import com.x8bit.bitwarden.data.platform.manager.dispatcher.DispatcherManager
+import com.x8bit.bitwarden.data.platform.util.asFailure
+import com.x8bit.bitwarden.data.platform.util.asSuccess
 import com.x8bit.bitwarden.data.platform.util.sdkAgnosticTransferTo
 import com.x8bit.bitwarden.data.vault.datasource.network.service.DownloadService
 import com.x8bit.bitwarden.data.vault.manager.model.DownloadResult
@@ -12,6 +14,7 @@ import java.io.ByteArrayOutputStream
 import java.io.File
 import java.io.FileInputStream
 import java.io.FileOutputStream
+import java.io.FileWriter
 import java.util.UUID
 
 /**
@@ -154,4 +157,44 @@ class FileManagerImpl(
                 File(context.filesDir, tempFileName)
             }
         }
+
+    @Suppress("TooGenericExceptionCaught")
+    override suspend fun writeToFile(parent: String?, fileName: String, data: String) {
+        withContext(dispatcherManager.io) {
+            try {
+                context.getExternalFilesDir(parent)
+                    ?.let { logDir ->
+                        val file = File("${logDir.path}/$fileName")
+                        if (!file.exists()) {
+                            file.createNewFile()
+                        }
+                        FileWriter(File(logDir, fileName), true).use {
+                            it.write(data)
+                            it.flush()
+                        }
+                    }
+            } catch (e: Exception) {
+                e.printStackTrace()
+            }
+        }
+    }
+
+    @Suppress("TooGenericExceptionCaught")
+    override suspend fun readFromFile(parent: String?, fileName: String): Result<String> {
+        return withContext(dispatcherManager.io) {
+            try {
+                context.getExternalFilesDir(parent)
+                    ?.let { logDir ->
+                        val file = File("${logDir.path}/$fileName")
+                        if (!file.exists()) {
+                            return@withContext "Log file does not exist".asSuccess()
+                        }
+                        file.readText().asSuccess()
+                    }
+                    ?: "Shared storage currently unavailable".asSuccess()
+            } catch (e: Exception) {
+                e.asFailure()
+            }
+        }
+    }
 }
diff --git a/app/src/main/java/com/x8bit/bitwarden/ui/platform/feature/settings/about/AboutScreen.kt b/app/src/main/java/com/x8bit/bitwarden/ui/platform/feature/settings/about/AboutScreen.kt
@@ -1,5 +1,7 @@
 package com.x8bit.bitwarden.ui.platform.feature.settings.about
 
+import android.content.Context
+import android.widget.Toast
 import androidx.compose.foundation.layout.Box
 import androidx.compose.foundation.layout.Column
 import androidx.compose.foundation.layout.Spacer
@@ -21,6 +23,7 @@ import androidx.compose.runtime.remember
 import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.input.nestedscroll.nestedScroll
+import androidx.compose.ui.platform.LocalContext
 import androidx.compose.ui.platform.testTag
 import androidx.compose.ui.res.stringResource
 import androidx.compose.ui.tooling.preview.Preview
@@ -55,8 +58,10 @@ fun AboutScreen(
     onNavigateBack: () -> Unit,
     viewModel: AboutViewModel = hiltViewModel(),
     intentManager: IntentManager = LocalIntentManager.current,
+    context: Context = LocalContext.current,
 ) {
     val state by viewModel.stateFlow.collectAsStateWithLifecycle()
+    val resources = context.resources
     EventsEffect(viewModel = viewModel) { event ->
         when (event) {
             is AboutEvent.NavigateToWebVault -> {
@@ -84,9 +89,13 @@ fun AboutScreen(
             AboutEvent.NavigateToRateApp -> {
                 intentManager.launchUri(
                     uri =
-                    "https://play.google.com/store/apps/details?id=com.x8bit.bitwarden".toUri(),
+                        "https://play.google.com/store/apps/details?id=com.x8bit.bitwarden".toUri(),
                 )
             }
+
+            is AboutEvent.ShowToast -> {
+                Toast.makeText(context, event.text(resources), Toast.LENGTH_SHORT).show()
+            }
         }
     }
 
@@ -134,6 +143,9 @@ fun AboutScreen(
             onWebVaultClick = remember(viewModel) {
                 { viewModel.trySendAction(AboutAction.WebVaultClick) }
             },
+            onCopyPasskeyLogsClick = remember(viewModel) {
+                { viewModel.trySendAction(AboutAction.CopyPasskeyLogsClick) }
+            },
         )
     }
 }
@@ -150,6 +162,7 @@ private fun ContentColumn(
     onSubmitCrashLogsCheckedChange: (Boolean) -> Unit,
     onVersionClick: () -> Unit,
     onWebVaultClick: () -> Unit,
+    onCopyPasskeyLogsClick: () -> Unit,
     modifier: Modifier = Modifier,
 ) {
     Column(
@@ -245,11 +258,27 @@ private fun ContentColumn(
         CopyRow(
             text = state.version,
             onClick = onVersionClick,
+            cardStyle = if (state.isSubmitCrashLogsEnabled) {
+                CardStyle.Middle()
+            } else {
+                CardStyle.Bottom
+            },
             modifier = Modifier
                 .standardHorizontalMargin()
                 .fillMaxWidth()
                 .testTag("CopyAboutInfoRow"),
         )
+        if (state.isSubmitCrashLogsEnabled) {
+            CopyRow(
+                text = R.string.copy_passkey_logs.asText(),
+                onClick = onCopyPasskeyLogsClick,
+                cardStyle = CardStyle.Bottom,
+                modifier = Modifier
+                    .standardHorizontalMargin()
+                    .fillMaxWidth()
+                    .testTag("CopyPasskeyLogsRow"),
+            )
+        }
         Box(
             modifier = Modifier
                 .defaultMinSize(minHeight = 60.dp)
@@ -271,13 +300,14 @@ private fun ContentColumn(
 private fun CopyRow(
     text: Text,
     onClick: () -> Unit,
+    cardStyle: CardStyle,
     modifier: Modifier = Modifier,
 ) {
     BitwardenTextRow(
         text = text(),
         onClick = onClick,
         withDivider = false,
-        cardStyle = CardStyle.Bottom,
+        cardStyle = cardStyle,
         modifier = modifier,
     ) {
         Icon(
@@ -296,6 +326,7 @@ private fun CopyRow_preview() {
         CopyRow(
             text = "Copyable Text".asText(),
             onClick = { },
+            cardStyle = CardStyle.Full,
         )
     }
 }
diff --git a/app/src/main/java/com/x8bit/bitwarden/ui/platform/feature/settings/about/AboutViewModel.kt b/app/src/main/java/com/x8bit/bitwarden/ui/platform/feature/settings/about/AboutViewModel.kt
@@ -19,6 +19,7 @@ import dagger.hilt.android.lifecycle.HiltViewModel
 import kotlinx.coroutines.flow.launchIn
 import kotlinx.coroutines.flow.onEach
 import kotlinx.coroutines.flow.update
+import kotlinx.coroutines.launch
 import kotlinx.parcelize.Parcelize
 import java.time.Clock
 import java.time.Year
@@ -29,6 +30,7 @@ private const val KEY_STATE = "state"
 /**
  * View model for the about screen.
  */
+@Suppress("TooManyFunctions")
 @HiltViewModel
 class AboutViewModel @Inject constructor(
     private val savedStateHandle: SavedStateHandle,
@@ -58,6 +60,7 @@ class AboutViewModel @Inject constructor(
         is AboutAction.SubmitCrashLogsClick -> handleSubmitCrashLogsClick(action)
         AboutAction.VersionClick -> handleVersionClick()
         AboutAction.WebVaultClick -> handleWebVaultClick()
+        AboutAction.CopyPasskeyLogsClick -> handleCopyPasskeyLogsClick()
     }
 
     private fun handleBackClick() {
@@ -131,6 +134,24 @@ class AboutViewModel @Inject constructor(
         )
     }
 
+    private fun handleCopyPasskeyLogsClick() {
+        viewModelScope.launch {
+            logsManager
+                .getPasskeyLogs()
+                .fold(
+                    onSuccess = { logs ->
+                        clipboardManager.setText(
+                            text = logs,
+                            toastDescriptorOverride = R.string.passkey_logs.asText(),
+                        )
+                    },
+                    onFailure = {
+                        sendEvent(AboutEvent.ShowToast(R.string.error_copying_logs.asText()))
+                    },
+                )
+        }
+    }
+
     @Suppress("UndocumentedPublicClass")
     companion object {
         /**
@@ -201,6 +222,11 @@ sealed class AboutEvent {
      * Navigates to rate the app.
      */
     data object NavigateToRateApp : AboutEvent()
+
+    /**
+     * Show a toast.
+     */
+    data class ShowToast(val text: Text) : AboutEvent()
 }
 
 /**
@@ -253,4 +279,9 @@ sealed class AboutAction {
      * User clicked the web vault row.
      */
     data object WebVaultClick : AboutAction()
+
+    /**
+     * User clicked the copy passkey logs row.
+     */
+    data object CopyPasskeyLogsClick : AboutAction()
 }
diff --git a/app/src/main/java/com/x8bit/bitwarden/ui/vault/feature/itemlisting/VaultItemListingViewModel.kt b/app/src/main/java/com/x8bit/bitwarden/ui/vault/feature/itemlisting/VaultItemListingViewModel.kt
@@ -1495,41 +1495,11 @@ class VaultItemListingViewModel @Inject constructor(
     }
 
     private fun handleFido2OriginValidationFail(error: Fido2ValidateOriginResult.Error) {
-        val messageResId = when (error) {
-            Fido2ValidateOriginResult.Error.ApplicationNotFound -> {
-                R.string.passkey_operation_failed_because_app_not_found_in_asset_links
-            }
-
-            Fido2ValidateOriginResult.Error.ApplicationFingerprintNotVerified -> {
-                R.string.passkey_operation_failed_because_app_could_not_be_verified
-            }
-
-            Fido2ValidateOriginResult.Error.AssetLinkNotFound -> {
-                R.string.passkey_operation_failed_because_of_missing_asset_links
-            }
-
-            Fido2ValidateOriginResult.Error.PrivilegedAppNotAllowed -> {
-                R.string.passkey_operation_failed_because_browser_is_not_privileged
-            }
-
-            Fido2ValidateOriginResult.Error.PasskeyNotSupportedForApp -> {
-                R.string.passkeys_not_supported_for_this_app
-            }
-
-            Fido2ValidateOriginResult.Error.PrivilegedAppSignatureNotFound -> {
-                R.string.passkey_operation_failed_because_browser_signature_does_not_match
-            }
-
-            Fido2ValidateOriginResult.Error.Unknown -> {
-                Timber.tag("PASSKEY").e("FIDO2 origin validation failed with unknown error.")
-                R.string.generic_error_message
-            }
-        }
         mutableStateFlow.update {
             it.copy(
                 dialogState = VaultItemListingState.DialogState.Fido2OperationFail(
                     title = R.string.an_error_has_occurred.asText(),
-                    message = messageResId.asText(),
+                    message = error.messageResId.asText(),
                 ),
             )
         }
diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml
@@ -1170,4 +1170,7 @@ Do you want to switch to this account?</string>
   <string name="passkey_registration_failed_due_to_an_internal_error">Passkey registration failed due to an internal error.</string>
   <string name="passkey_operation_failed_because_relying_party_cannot_be_identified">Passkey operation failed because relying party cannot be identified.</string>
   <string name="passkey_authentication_failed_due_to_an_internal_error">Passkey authentication failed due to an internal error.</string>
+    <string name="copy_passkey_logs">Copy passkey logs</string>
+  <string name="passkey_logs">Passkey logs</string>
+  <string name="error_copying_logs">Error copying logs</string>
 </resources>
diff --git a/app/src/standard/java/com/x8bit/bitwarden/data/platform/manager/LogsManagerImpl.kt b/app/src/standard/java/com/x8bit/bitwarden/data/platform/manager/LogsManagerImpl.kt
