Skip to content

[PM-40488] fix: clear clipboard setting does not clear the clipboard on Android 13+ #7169

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

Open
mvanhorn wants to merge 3 commits into
base: main
Choose a base branch
from
+110 −2
Open

[PM-40488] fix: clear clipboard setting does not clear the clipboard on Android 13+ #7169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ed73cf4
fix: clear clipboard setting does not clear the clipboard on Android 13+
mvanhorn Jul 16, 2026
5e2465c
refactor: drop redundant version check in ClearClipboardWorker
mvanhorn Jul 23, 2026
a0302ac
test: inline ClearClipboardWorkerTest setup
mvanhorn Jul 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions ...c/main/kotlin/com/x8bit/bitwarden/data/platform/manager/clipboard/ClearClipboardWorker.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
package com.x8bit.bitwarden.data.platform.manager.clipboard

import android.content.ClipData
import android.content.ClipDescription
import android.content.ClipboardManager
import android.content.Context
import android.content.Context.CLIPBOARD_SERVICE
import android.os.Build
import androidx.core.os.persistableBundleOf
import androidx.work.Worker
import androidx.work.WorkerParameters
import com.bitwarden.annotation.OmitFromCoverage
import com.bitwarden.core.util.isBuildVersionAtLeast

/**
* A worker to clear the clipboard manager.
*/
@OmitFromCoverage
class ClearClipboardWorker(
appContext: Context,
workerParams: WorkerParameters,
Expand All @@ -20,6 +23,19 @@ class ClearClipboardWorker(
appContext.getSystemService(CLIPBOARD_SERVICE) as ClipboardManager

override fun doWork(): Result {
clipboardManager.setPrimaryClip(

@fnc314 fnc314 Aug 31, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To make sure I'm on the up-and-up... The idea is to set "nothing" to the clipboard, overwriting what sensitive information was there, and then invoke .clearPrimaryClip (removing the new empty content) as per Android platforms on which the method is not a no-op.

Is this correct?

ClipData
.newPlainText("", "")
.apply {
description.extras = persistableBundleOf(

@david-livefront david-livefront Sep 4, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this function is deprecated, can we do something like this:

                    description.extras = PersistableBundle().apply {
                        putBoolean(
                            if (isBuildVersionAtLeast(version = Build.VERSION_CODES.TIRAMISU)) {
                                ClipDescription.EXTRA_IS_SENSITIVE
                            } else {
                                "android.content.extra.IS_SENSITIVE"
                            },
                            true,
                        )
                    }

if (isBuildVersionAtLeast(version = Build.VERSION_CODES.TIRAMISU)) {
ClipDescription.EXTRA_IS_SENSITIVE to true
} else {
"android.content.extra.IS_SENSITIVE" to true
},
)
},
)
clipboardManager.clearPrimaryClip()
return Result.success()
}
Expand Down
92 changes: 92 additions & 0 deletions ...st/kotlin/com/x8bit/bitwarden/data/platform/manager/clipboard/ClearClipboardWorkerTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
package com.x8bit.bitwarden.data.platform.manager.clipboard

import android.content.ClipData
import android.content.ClipDescription
import android.content.ClipboardManager
import android.os.Build
import androidx.core.content.getSystemService
import androidx.work.ListenableWorker
import com.bitwarden.ui.platform.base.BaseRobolectricTest
import io.mockk.mockk
import org.junit.Assert.assertEquals
import org.junit.Assert.assertFalse
import org.junit.Assert.assertTrue
import org.junit.Test
import org.robolectric.RuntimeEnvironment
import org.robolectric.annotation.Config

class ClearClipboardWorkerTest : BaseRobolectricTest() {

private val context = RuntimeEnvironment.getApplication()
private val clipboardManager = requireNotNull(context.getSystemService<ClipboardManager>())
private val worker: ClearClipboardWorker = ClearClipboardWorker(
appContext = context,
workerParams = mockk(relaxed = true),
)

@Test
fun `doWork should clear a populated clipboard and return success`() {
clipboardManager.setPrimaryClip(ClipData.newPlainText("", "password"))

val result = worker.doWork()

assertTrue(clipboardManager.primaryClip?.getItemAt(0)?.text.isNullOrEmpty())
assertEquals(ListenableWorker.Result.success(), result)
}

@Test
fun `doWork should return success when the clipboard is already empty`() {
clipboardManager.clearPrimaryClip()

val result = worker.doWork()

assertFalse(clipboardManager.hasPrimaryClip())
assertEquals(ListenableWorker.Result.success(), result)
}

@Config(sdk = [Build.VERSION_CODES.TIRAMISU])
@Test
fun `doWork should overwrite the clipboard with sensitive empty content before clearing`() {
val overwrittenClip = captureEmptyClipboardOverwrite()

assertTrue(
overwrittenClip
?.description
?.extras
?.getBoolean(ClipDescription.EXTRA_IS_SENSITIVE) == true,
)
}

@Config(sdk = [Build.VERSION_CODES.S_V2])
@Test
fun `doWork should use the legacy sensitive extra before Android 13`() {
val overwrittenClip = captureEmptyClipboardOverwrite()

assertTrue(
overwrittenClip
?.description
?.extras
?.getBoolean("android.content.extra.IS_SENSITIVE") == true,
)
}

private fun captureEmptyClipboardOverwrite(): ClipData? {
var overwrittenClip: ClipData? = null
val listener = ClipboardManager.OnPrimaryClipChangedListener {
val currentClip = clipboardManager.primaryClip
if (
overwrittenClip == null &&
currentClip?.getItemAt(0)?.text.isNullOrEmpty()
) {
overwrittenClip = currentClip
}
}
clipboardManager.setPrimaryClip(ClipData.newPlainText("", "password"))
clipboardManager.addPrimaryClipChangedListener(listener)

worker.doWork()

clipboardManager.removePrimaryClipChangedListener(listener)
return overwrittenClip
}
}