-
-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Variant of `PasswordInput` that only allows the password to be unmasked after the user has authenticated using `BiometricPrompt`.
- Loading branch information
Showing
7 changed files
with
292 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
72 changes: 72 additions & 0 deletions
72
...ain/kotlin/app/k9mail/feature/account/server/settings/ui/common/BiometricPasswordInput.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| package app.k9mail.feature.account.server.settings.ui.common | ||
|
|
||
| import androidx.biometric.BiometricPrompt | ||
| import androidx.compose.foundation.layout.PaddingValues | ||
| import androidx.compose.foundation.layout.fillMaxWidth | ||
| import androidx.compose.runtime.Composable | ||
| import androidx.compose.runtime.LaunchedEffect | ||
| import androidx.compose.runtime.getValue | ||
| import androidx.compose.runtime.mutableStateOf | ||
| import androidx.compose.runtime.remember | ||
| import androidx.compose.runtime.setValue | ||
| import androidx.compose.ui.Modifier | ||
| import androidx.compose.ui.res.stringResource | ||
| import androidx.fragment.app.FragmentActivity | ||
| import app.k9mail.core.ui.compose.designsystem.molecule.input.InputLayout | ||
| import app.k9mail.core.ui.compose.designsystem.molecule.input.PasswordInput | ||
| import app.k9mail.core.ui.compose.designsystem.molecule.input.inputContentPadding | ||
| import app.k9mail.feature.account.server.settings.R | ||
| import kotlinx.coroutines.delay | ||
| import app.k9mail.core.ui.compose.designsystem.R as RDesign | ||
|
|
||
| private const val SHOW_WARNING_DURATION = 5000L | ||
|
|
||
| /** | ||
| * Variant of [PasswordInput] that only allows the password to be unmasked after the user has authenticated using | ||
| * [BiometricPrompt]. | ||
| * | ||
| * Note: Due to limitations of [BiometricPrompt] this composable can only be used inside a [FragmentActivity]. | ||
| */ | ||
| @Composable | ||
| fun BiometricPasswordInput( | ||
| onPasswordChange: (String) -> Unit, | ||
| modifier: Modifier = Modifier, | ||
| password: String = "", | ||
| isRequired: Boolean = false, | ||
| errorMessage: String? = null, | ||
| contentPadding: PaddingValues = inputContentPadding(), | ||
| ) { | ||
| var biometricWarning by remember { mutableStateOf<String?>(value = null) } | ||
|
|
||
| LaunchedEffect(key1 = biometricWarning) { | ||
| if (biometricWarning != null) { | ||
| delay(SHOW_WARNING_DURATION) | ||
| biometricWarning = null | ||
| } | ||
| } | ||
|
|
||
| InputLayout( | ||
| modifier = modifier, | ||
| contentPadding = contentPadding, | ||
| errorMessage = errorMessage, | ||
| warningMessage = biometricWarning, | ||
| ) { | ||
| val title = stringResource(R.string.account_server_settings_password_authentication_title) | ||
| val subtitle = stringResource(R.string.account_server_settings_password_authentication_subtitle) | ||
| val needScreenLockMessage = | ||
| stringResource(R.string.account_server_settings_password_authentication_screen_lock_required) | ||
|
|
||
| TextFieldOutlinedPasswordBiometric( | ||
| value = password, | ||
| onValueChange = onPasswordChange, | ||
| authenticationTitle = title, | ||
| authenticationSubtitle = subtitle, | ||
| needScreenLockMessage = needScreenLockMessage, | ||
| onWarningChange = { biometricWarning = it?.toString() }, | ||
| label = stringResource(id = RDesign.string.designsystem_molecule_password_input_label), | ||
| isRequired = isRequired, | ||
| hasError = errorMessage != null, | ||
| modifier = Modifier.fillMaxWidth(), | ||
| ) | ||
| } | ||
| } |
131 changes: 131 additions & 0 deletions
131
...pp/k9mail/feature/account/server/settings/ui/common/TextFieldOutlinedPasswordBiometric.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| package app.k9mail.feature.account.server.settings.ui.common | ||
|
|
||
| import android.view.WindowManager | ||
| import androidx.biometric.BiometricManager | ||
| import androidx.biometric.BiometricPrompt | ||
| import androidx.compose.runtime.Composable | ||
| import androidx.compose.runtime.DisposableEffect | ||
| import androidx.compose.runtime.getValue | ||
| import androidx.compose.runtime.mutableStateOf | ||
| import androidx.compose.runtime.saveable.rememberSaveable | ||
| import androidx.compose.runtime.setValue | ||
| import androidx.compose.ui.Modifier | ||
| import androidx.fragment.app.FragmentActivity | ||
| import app.k9mail.core.ui.compose.common.activity.LocalActivity | ||
| import app.k9mail.core.ui.compose.designsystem.atom.textfield.TextFieldOutlinedPassword | ||
|
|
||
| /** | ||
| * Variant of [TextFieldOutlinedPassword] that only allows the password to be unmasked after the user has authenticated | ||
| * using [BiometricPrompt]. | ||
| * | ||
| * Note: Due to limitations of [BiometricPrompt] this composable can only be used inside a [FragmentActivity]. | ||
| */ | ||
| @Suppress("LongParameterList") | ||
| @Composable | ||
| fun TextFieldOutlinedPasswordBiometric( | ||
| value: String, | ||
| onValueChange: (String) -> Unit, | ||
| authenticationTitle: String, | ||
| authenticationSubtitle: String, | ||
| needScreenLockMessage: String, | ||
| onWarningChange: (CharSequence?) -> Unit, | ||
| modifier: Modifier = Modifier, | ||
| label: String? = null, | ||
| isEnabled: Boolean = true, | ||
| isReadOnly: Boolean = false, | ||
| isRequired: Boolean = false, | ||
| hasError: Boolean = false, | ||
| ) { | ||
| var isPasswordVisible by rememberSaveable { mutableStateOf(false) } | ||
| var isAuthenticated by rememberSaveable { mutableStateOf(false) } | ||
| var isAuthenticationRequired by rememberSaveable { mutableStateOf(true) } | ||
|
|
||
| // If the entire password was removed, we allow the user to unmask the text field without requiring authentication. | ||
| if (value.isEmpty()) { | ||
| isAuthenticationRequired = false | ||
| } | ||
|
|
||
| val activity = LocalActivity.current as FragmentActivity | ||
|
|
||
| TextFieldOutlinedPassword( | ||
| value = value, | ||
| onValueChange = onValueChange, | ||
| modifier = modifier, | ||
| label = label, | ||
| isEnabled = isEnabled, | ||
| isReadOnly = isReadOnly, | ||
| isRequired = isRequired, | ||
| hasError = hasError, | ||
| isPasswordVisible = isPasswordVisible, | ||
| onPasswordVisibilityToggleClicked = { | ||
| if (!isAuthenticationRequired || isAuthenticated) { | ||
| isPasswordVisible = !isPasswordVisible | ||
| activity.setSecure(isPasswordVisible) | ||
| } else { | ||
| showBiometricPrompt( | ||
| activity, | ||
| authenticationTitle, | ||
| authenticationSubtitle, | ||
| needScreenLockMessage, | ||
| onAuthSuccess = { | ||
| isAuthenticated = true | ||
| isPasswordVisible = true | ||
| onWarningChange(null) | ||
| activity.setSecure(true) | ||
| }, | ||
| onAuthError = onWarningChange, | ||
| ) | ||
| } | ||
| }, | ||
| ) | ||
|
|
||
| DisposableEffect(key1 = "secureWindow") { | ||
| activity.setSecure(isPasswordVisible) | ||
|
|
||
| onDispose { | ||
| activity.setSecure(false) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private fun showBiometricPrompt( | ||
| activity: FragmentActivity, | ||
| title: String, | ||
| subtitle: String, | ||
| needScreenLockMessage: String, | ||
| onAuthSuccess: () -> Unit, | ||
| onAuthError: (CharSequence) -> Unit, | ||
| ) { | ||
| val authenticationCallback = object : BiometricPrompt.AuthenticationCallback() { | ||
| override fun onAuthenticationSucceeded(result: BiometricPrompt.AuthenticationResult) { | ||
| onAuthSuccess() | ||
| } | ||
|
|
||
| override fun onAuthenticationError(errorCode: Int, errString: CharSequence) { | ||
| if (errorCode == BiometricPrompt.ERROR_HW_NOT_PRESENT || | ||
| errorCode == BiometricPrompt.ERROR_NO_DEVICE_CREDENTIAL || | ||
| errorCode == BiometricPrompt.ERROR_NO_BIOMETRICS | ||
| ) { | ||
| onAuthError(needScreenLockMessage) | ||
| } else if (errString.isNotEmpty()) { | ||
| onAuthError(errString) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| val promptInfo = BiometricPrompt.PromptInfo.Builder() | ||
| .setAllowedAuthenticators( | ||
| BiometricManager.Authenticators.BIOMETRIC_STRONG or | ||
| BiometricManager.Authenticators.BIOMETRIC_WEAK or | ||
| BiometricManager.Authenticators.DEVICE_CREDENTIAL, | ||
| ) | ||
| .setTitle(title) | ||
| .setSubtitle(subtitle) | ||
| .build() | ||
|
|
||
| BiometricPrompt(activity, authenticationCallback).authenticate(promptInfo) | ||
| } | ||
|
|
||
| private fun FragmentActivity.setSecure(secure: Boolean) { | ||
| window.setFlags(if (secure) WindowManager.LayoutParams.FLAG_SECURE else 0, WindowManager.LayoutParams.FLAG_SECURE) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters