SONARKT-618 Rule S7410: Keyboard cache should be disabled for password inputs

antonioaversa · web-flow · commit a12d01fada3d · 2025-03-25T16:35:59.000+01:00
diff --git a/kotlin-checks-test-sources/src/main/kotlin/androidx/compose/foundation/text/KeyboardOptions.kt b/kotlin-checks-test-sources/src/main/kotlin/androidx/compose/foundation/text/KeyboardOptions.kt
@@ -0,0 +1,26 @@
+package androidx.compose.foundation.text
+
+import androidx.compose.ui.text.input.KeyboardCapitalization
+import androidx.compose.ui.text.input.KeyboardType
+
+// Partial stubbing of the primary constructor
+class KeyboardOptions(
+    val capitalization: KeyboardCapitalization = KeyboardCapitalization.Unspecified,
+    val autoCorrectEnabled: Boolean? = null,
+    val keyboardType: KeyboardType = KeyboardType.Unspecified,
+    // ...
+) {
+    companion object {
+        val Default = KeyboardOptions()
+    }
+
+    // Partial stubbing of parameters
+    fun copy(
+        capitalization: KeyboardCapitalization = this.capitalization,
+        autoCorrectEnabled: Boolean? = this.autoCorrectEnabled,
+        keyboardType: KeyboardType = this.keyboardType,
+        // ...
+    ) : KeyboardOptions {
+        throw Exception("Stub!")
+    }
+}
diff --git a/kotlin-checks-test-sources/src/main/kotlin/androidx/compose/foundation/text/input/TextFieldState.kt b/kotlin-checks-test-sources/src/main/kotlin/androidx/compose/foundation/text/input/TextFieldState.kt
@@ -0,0 +1,14 @@
+package androidx.compose.foundation.text.input
+
+import androidx.compose.ui.text.TextRange
+
+// Partial stubbing of the primary constructor
+class TextFieldState {
+    constructor(
+        initialText: String = "",
+        initialSelection: TextRange = TextRange(initialText.length)
+        // ...
+    ) {
+        throw Exception("Stub!")
+    }
+}
diff --git a/kotlin-checks-test-sources/src/main/kotlin/androidx/compose/material/OutlinedTextField.kt b/kotlin-checks-test-sources/src/main/kotlin/androidx/compose/material/OutlinedTextField.kt
@@ -0,0 +1,30 @@
+package androidx.compose.material
+
+import androidx.compose.foundation.text.KeyboardOptions
+import androidx.compose.foundation.text.input.TextFieldState
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.text.input.VisualTransformation
+
+// Partial stubbing of parameters
+fun OutlinedTextField(
+    state: TextFieldState,
+    modifier: Modifier = Modifier,
+    enabled: Boolean = true,
+    readOnly: Boolean = false,
+    // ...
+) {
+    throw Exception("Stub!")
+}
+
+// Partial stubbing of parameters
+fun OutlinedTextField(
+    value: String,
+    onValueChange: (String) -> Unit,
+    // ...
+    visualTransformation: VisualTransformation = VisualTransformation.None,
+    keyboardOptions: KeyboardOptions = KeyboardOptions.Default,
+    // ...
+) {
+    throw Exception("Stub!")
+}
+
diff --git a/kotlin-checks-test-sources/src/main/kotlin/androidx/compose/material/SecureTextField.kt b/kotlin-checks-test-sources/src/main/kotlin/androidx/compose/material/SecureTextField.kt
@@ -0,0 +1,8 @@
+package androidx.compose.material
+
+// Partial stubbing of parameters
+fun SecureTextField(
+    // ...
+) {
+    throw Exception("Stub!")
+}
diff --git a/kotlin-checks-test-sources/src/main/kotlin/androidx/compose/material/TextField.kt b/kotlin-checks-test-sources/src/main/kotlin/androidx/compose/material/TextField.kt
@@ -0,0 +1,17 @@
+package androidx.compose.material
+
+import androidx.compose.foundation.text.KeyboardOptions
+import androidx.compose.ui.text.input.VisualTransformation
+
+// Partial stubbing of parameters
+fun TextField(
+    value: String,
+    onValueChange: (String) -> Unit,
+    // ...
+    visualTransformation: VisualTransformation = VisualTransformation.None,
+    keyboardOptions: KeyboardOptions = KeyboardOptions.Default,
+    // ...
+) {
+    throw Exception("Stub!")
+}
+
diff --git a/kotlin-checks-test-sources/src/main/kotlin/androidx/compose/material3/OutlinedTextField.kt b/kotlin-checks-test-sources/src/main/kotlin/androidx/compose/material3/OutlinedTextField.kt
@@ -0,0 +1,30 @@
+package androidx.compose.material3
+
+import androidx.compose.foundation.text.KeyboardOptions
+import androidx.compose.foundation.text.input.TextFieldState
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.text.input.VisualTransformation
+
+// Partial stubbing of parameters
+fun OutlinedTextField(
+    state: TextFieldState,
+    modifier: Modifier = Modifier,
+    enabled: Boolean = true,
+    readOnly: Boolean = false,
+    // ...
+) {
+    throw Exception("Stub!")
+}
+
+// Partial stubbing of parameters
+fun OutlinedTextField(
+    value: String,
+    onValueChange: (String) -> Unit,
+    // ...
+    visualTransformation: VisualTransformation = VisualTransformation.None,
+    keyboardOptions: KeyboardOptions = KeyboardOptions.Default,
+    // ...
+) {
+    throw Exception("Stub!")
+}
+
diff --git a/kotlin-checks-test-sources/src/main/kotlin/androidx/compose/material3/SecureTextField.kt b/kotlin-checks-test-sources/src/main/kotlin/androidx/compose/material3/SecureTextField.kt
@@ -0,0 +1,8 @@
+package androidx.compose.material3
+
+// Partial stubbing of parameters
+fun SecureTextField(
+    // ...
+) {
+    throw Exception("Stub!")
+}
diff --git a/kotlin-checks-test-sources/src/main/kotlin/androidx/compose/material3/TextField.kt b/kotlin-checks-test-sources/src/main/kotlin/androidx/compose/material3/TextField.kt
@@ -0,0 +1,17 @@
+package androidx.compose.material3
+
+import androidx.compose.foundation.text.KeyboardOptions
+import androidx.compose.ui.text.input.VisualTransformation
+
+// Partial stubbing of parameters
+fun TextField(
+    value: String,
+    onValueChange: (String) -> Unit,
+    // ...
+    visualTransformation: VisualTransformation = VisualTransformation.None,
+    keyboardOptions: KeyboardOptions = KeyboardOptions.Default,
+    // ...
+) {
+    throw Exception("Stub!")
+}
+
diff --git a/kotlin-checks-test-sources/src/main/kotlin/androidx/compose/ui/AnnotatedString.kt b/kotlin-checks-test-sources/src/main/kotlin/androidx/compose/ui/AnnotatedString.kt
@@ -0,0 +1,3 @@
+package androidx.compose.ui
+
+class AnnotatedString
diff --git a/kotlin-checks-test-sources/src/main/kotlin/androidx/compose/ui/Modifier.kt b/kotlin-checks-test-sources/src/main/kotlin/androidx/compose/ui/Modifier.kt
@@ -0,0 +1,5 @@
+package androidx.compose.ui
+
+interface Modifier {
+    companion object : Modifier
+}
diff --git a/kotlin-checks-test-sources/src/main/kotlin/androidx/compose/ui/TransformedText.kt b/kotlin-checks-test-sources/src/main/kotlin/androidx/compose/ui/TransformedText.kt
@@ -0,0 +1,3 @@
+package androidx.compose.ui
+
+class TransformedText
diff --git a/kotlin-checks-test-sources/src/main/kotlin/androidx/compose/ui/text/TextRange.kt b/kotlin-checks-test-sources/src/main/kotlin/androidx/compose/ui/text/TextRange.kt
@@ -0,0 +1,12 @@
+package androidx.compose.ui.text
+
+fun TextRange(index: Int): TextRange {
+    throw Exception("Stub!")
+}
+
+fun TextRange(start: Int, end: Int): TextRange {
+    throw Exception("Stub!")
+}
+
+@JvmInline
+value class TextRange internal constructor(private val packedValue: Long)
diff --git a/kotlin-checks-test-sources/src/main/kotlin/androidx/compose/ui/text/input/KeyboardCapitalization.kt b/kotlin-checks-test-sources/src/main/kotlin/androidx/compose/ui/text/input/KeyboardCapitalization.kt
@@ -0,0 +1,12 @@
+package androidx.compose.ui.text.input
+
+@JvmInline
+value class KeyboardCapitalization private constructor(private val value: Int) {
+    companion object {
+        val Unspecified = KeyboardCapitalization(-1)
+        val None = KeyboardCapitalization(0)
+        val Characters = KeyboardCapitalization(1)
+        val Words = KeyboardCapitalization(2)
+        val Sentences = KeyboardCapitalization(3)
+    }
+}
diff --git a/kotlin-checks-test-sources/src/main/kotlin/androidx/compose/ui/text/input/KeyboardType.kt b/kotlin-checks-test-sources/src/main/kotlin/androidx/compose/ui/text/input/KeyboardType.kt
@@ -0,0 +1,17 @@
+package androidx.compose.ui.text.input
+
+@JvmInline
+value class KeyboardType private constructor(private val value: Int) {
+    companion object {
+        val Unspecified: KeyboardType = KeyboardType(0)
+        val Text: KeyboardType = KeyboardType(1)
+        val Ascii: KeyboardType = KeyboardType(2)
+        val Number: KeyboardType = KeyboardType(3)
+        val Phone: KeyboardType = KeyboardType(4)
+        val Uri: KeyboardType = KeyboardType(5)
+        val Email: KeyboardType = KeyboardType(6)
+        val Password: KeyboardType = KeyboardType(7)
+        val NumberPassword: KeyboardType = KeyboardType(8)
+        val Decimal: KeyboardType = KeyboardType(9)
+    }
+}
diff --git a/kotlin-checks-test-sources/src/main/kotlin/androidx/compose/ui/text/input/OffsetMapping.kt b/kotlin-checks-test-sources/src/main/kotlin/androidx/compose/ui/text/input/OffsetMapping.kt
@@ -0,0 +1,17 @@
+package androidx.compose.ui.text.input
+
+interface OffsetMapping {
+    fun originalToTransformed(offset: Int): Int
+    fun transformedToOriginal(offset: Int): Int
+
+    companion object {
+        val Identity = object : OffsetMapping {
+            override fun originalToTransformed(offset: Int): Int {
+                throw Exception("Stub!")
+            }
+            override fun transformedToOriginal(offset: Int): Int {
+                throw Exception("Stub!")
+            }
+        }
+    }
+}
diff --git a/kotlin-checks-test-sources/src/main/kotlin/androidx/compose/ui/text/input/VisualTransformation.kt b/kotlin-checks-test-sources/src/main/kotlin/androidx/compose/ui/text/input/VisualTransformation.kt
@@ -0,0 +1,21 @@
+package androidx.compose.ui.text.input
+
+import androidx.compose.ui.AnnotatedString
+
+class TransformedText(val text: AnnotatedString, val offsetMapping: OffsetMapping)
+
+fun interface VisualTransformation {
+    fun filter(text: AnnotatedString): TransformedText
+
+    companion object {
+        val None: VisualTransformation = VisualTransformation {
+            throw Exception("Stub!")
+        }
+    }
+}
+
+class PasswordVisualTransformation(val mask: Char = '\u2022') : VisualTransformation {
+    override fun filter(text: AnnotatedString): TransformedText {
+        throw Exception("Stub!")
+    }
+}
diff --git a/kotlin-checks-test-sources/src/main/kotlin/checks/AndroidKeyboardCacheOnPasswordInputCheckSample.kt b/kotlin-checks-test-sources/src/main/kotlin/checks/AndroidKeyboardCacheOnPasswordInputCheckSample.kt
diff --git a/sonar-kotlin-checks/src/main/java/org/sonarsource/kotlin/checks/AndroidKeyboardCacheOnPasswordInputCheck.kt b/sonar-kotlin-checks/src/main/java/org/sonarsource/kotlin/checks/AndroidKeyboardCacheOnPasswordInputCheck.kt
diff --git a/sonar-kotlin-checks/src/test/java/org/sonarsource/kotlin/checks/AndroidKeyboardCacheOnPasswordInputCheckTest.kt b/sonar-kotlin-checks/src/test/java/org/sonarsource/kotlin/checks/AndroidKeyboardCacheOnPasswordInputCheckTest.kt
diff --git a/sonar-kotlin-plugin/src/main/java/org/sonarsource/kotlin/plugin/KotlinCheckList.kt b/sonar-kotlin-plugin/src/main/java/org/sonarsource/kotlin/plugin/KotlinCheckList.kt
diff --git a/sonar-kotlin-plugin/src/main/resources/org/sonar/l10n/kotlin/rules/kotlin/S7410.html b/sonar-kotlin-plugin/src/main/resources/org/sonar/l10n/kotlin/rules/kotlin/S7410.html
diff --git a/sonar-kotlin-plugin/src/main/resources/org/sonar/l10n/kotlin/rules/kotlin/S7410.json b/sonar-kotlin-plugin/src/main/resources/org/sonar/l10n/kotlin/rules/kotlin/S7410.json
diff --git a/sonar-kotlin-plugin/src/main/resources/org/sonar/l10n/kotlin/rules/kotlin/Sonar_way_profile.json b/sonar-kotlin-plugin/src/main/resources/org/sonar/l10n/kotlin/rules/kotlin/Sonar_way_profile.json

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+package androidx.compose.ui`
	`2`	`+`
	`3`	`+class AnnotatedString`