BIT-785: Vault timeout policy (#924)

This commit is contained in:
Shannon Draeker
2024-06-20 17:08:07 +01:00
committed by Álison Fernandes
parent c7f063a306
commit 89dd552908
12 changed files with 498 additions and 37 deletions
@@ -5,9 +5,9 @@ import com.x8bit.bitwarden.data.auth.repository.model.PolicyInformation
import com.x8bit.bitwarden.data.vault.datasource.network.model.PolicyTypeJson
import com.x8bit.bitwarden.data.vault.datasource.network.model.createMockOrganization
import com.x8bit.bitwarden.data.vault.datasource.network.model.createMockPolicy
import kotlinx.serialization.ExperimentalSerializationApi
import kotlinx.serialization.json.buildJsonObject
import kotlinx.serialization.json.put
import kotlinx.serialization.json.Json
import kotlinx.serialization.json.encodeToJsonElement
import kotlinx.serialization.json.jsonObject
import org.junit.jupiter.api.Assertions.assertEquals
import org.junit.jupiter.api.Assertions.assertNull
import org.junit.jupiter.api.Test
@@ -46,21 +46,7 @@ class SyncResponseJsonExtensionsTest {
}
@Test
@OptIn(ExperimentalSerializationApi::class)
fun `policyInformation converts the Json data to policy information`() {
val masterPasswordData = buildJsonObject {
put(key = "minLength", value = 10)
put(key = "minComplexity", value = 3)
put(key = "requireUpper", value = null)
put(key = "requireLower", value = null)
put(key = "requireNumbers", value = true)
put(key = "requireSpecial", value = null)
put(key = "enforceOnLogin", value = true)
}
val masterPasswordPolicy = createMockPolicy(
type = PolicyTypeJson.MASTER_PASSWORD,
data = masterPasswordData,
)
fun `policyInformation converts the MasterPassword Json data to policy information`() {
val policyInformation = PolicyInformation.MasterPassword(
minLength = 10,
minComplexity = 3,
@@ -70,10 +56,57 @@ class SyncResponseJsonExtensionsTest {
requireSpecial = null,
enforceOnLogin = true,
)
val policy = createMockPolicy(
type = PolicyTypeJson.MASTER_PASSWORD,
data = Json.encodeToJsonElement(policyInformation).jsonObject,
)
assertEquals(
policyInformation,
masterPasswordPolicy.policyInformation,
policy.policyInformation,
)
}
@Test
fun `policyInformation converts the PasswordGenerator Json data to policy information`() {
val policyInformation = PolicyInformation.PasswordGenerator(
defaultType = "password",
minLength = null,
useUpper = true,
useLower = true,
useNumbers = null,
useSpecial = null,
minNumbers = null,
minSpecial = null,
minNumberWords = 4,
capitalize = true,
includeNumber = null,
)
val policy = createMockPolicy(
type = PolicyTypeJson.PASSWORD_GENERATOR,
data = Json.encodeToJsonElement(policyInformation).jsonObject,
)
assertEquals(
policyInformation,
policy.policyInformation,
)
}
@Test
fun `policyInformation converts the VaultTimeout Json data to policy information`() {
val policyInformation = PolicyInformation.VaultTimeout(
minutes = 10,
action = "lock",
)
val policy = createMockPolicy(
type = PolicyTypeJson.MAXIMUM_VAULT_TIMEOUT,
data = Json.encodeToJsonElement(policyInformation).jsonObject,
)
assertEquals(
policyInformation,
policy.policyInformation,
)
}
@@ -11,13 +11,17 @@ import com.x8bit.bitwarden.data.autofill.manager.AutofillEnabledManagerImpl
import com.x8bit.bitwarden.data.platform.base.FakeDispatcherManager
import com.x8bit.bitwarden.data.platform.datasource.disk.util.FakeSettingsDiskSource
import com.x8bit.bitwarden.data.platform.manager.BiometricsEncryptionManager
import com.x8bit.bitwarden.data.platform.manager.PolicyManager
import com.x8bit.bitwarden.data.platform.repository.model.BiometricsKeyResult
import com.x8bit.bitwarden.data.platform.repository.model.ClearClipboardFrequency
import com.x8bit.bitwarden.data.platform.repository.model.UriMatchType
import com.x8bit.bitwarden.data.platform.repository.model.VaultTimeout
import com.x8bit.bitwarden.data.platform.repository.model.VaultTimeoutAction
import com.x8bit.bitwarden.data.platform.repository.util.bufferedMutableSharedFlow
import com.x8bit.bitwarden.data.platform.util.asFailure
import com.x8bit.bitwarden.data.platform.util.asSuccess
import com.x8bit.bitwarden.data.vault.datasource.network.model.PolicyTypeJson
import com.x8bit.bitwarden.data.vault.datasource.network.model.SyncResponseJson
import com.x8bit.bitwarden.data.vault.datasource.sdk.VaultSdkSource
import com.x8bit.bitwarden.ui.platform.feature.settings.appearance.model.AppLanguage
import com.x8bit.bitwarden.ui.platform.feature.settings.appearance.model.AppTheme
@@ -46,6 +50,12 @@ class SettingsRepositoryTest {
private val fakeSettingsDiskSource = FakeSettingsDiskSource()
private val vaultSdkSource: VaultSdkSource = mockk()
private val biometricsEncryptionManager: BiometricsEncryptionManager = mockk()
private val mutableActivePolicyFlow = bufferedMutableSharedFlow<List<SyncResponseJson.Policy>>()
private val policyManager: PolicyManager = mockk {
every {
getActivePoliciesFlow(type = PolicyTypeJson.MAXIMUM_VAULT_TIMEOUT)
} returns mutableActivePolicyFlow
}
private val settingsRepository = SettingsRepositoryImpl(
autofillManager = autofillManager,
@@ -55,6 +65,7 @@ class SettingsRepositoryTest {
vaultSdkSource = vaultSdkSource,
biometricsEncryptionManager = biometricsEncryptionManager,
dispatcherManager = FakeDispatcherManager(),
policyManager = policyManager,
)
@Test
@@ -10,6 +10,7 @@ import androidx.compose.ui.test.hasAnyAncestor
import androidx.compose.ui.test.hasClickAction
import androidx.compose.ui.test.hasTextExactly
import androidx.compose.ui.test.isDialog
import androidx.compose.ui.test.isDisplayed
import androidx.compose.ui.test.onAllNodesWithText
import androidx.compose.ui.test.onNodeWithContentDescription
import androidx.compose.ui.test.onNodeWithText
@@ -634,6 +635,35 @@ class AccountSecurityScreenTest : BaseComposeTest() {
composeTestRule.onNodeWithText("Unlock with PIN code").assertIsOn()
}
@Test
fun `session timeout policy warning should update according to state`() {
mutableStateFlow.update {
it.copy(
vaultTimeoutPolicyMinutes = 100,
)
}
val timeOnlyText = "Your organization policies have set your maximum allowed " +
"vault timeout to 1 hour(s) and 40 minute(s)."
composeTestRule
.onNodeWithText(timeOnlyText)
.performScrollTo()
.assertIsDisplayed()
mutableStateFlow.update {
it.copy(
vaultTimeoutPolicyMinutes = 100,
vaultTimeoutPolicyAction = "lock",
)
}
val bothText = "Your organization policies are affecting your vault timeout. " +
"Maximum allowed vault timeout is 1 hour(s) and 40 minute(s). Your vault " +
"timeout action is set to Lock."
composeTestRule
.onNodeWithText(bothText)
.performScrollTo()
.assertIsDisplayed()
}
@Test
fun `session timeout should be updated on or off according to state`() {
composeTestRule
@@ -708,6 +738,66 @@ class AccountSecurityScreenTest : BaseComposeTest() {
.assertIsDisplayed()
}
@Test
fun `on session timeout click should update according to state`() {
composeTestRule.assertNoDialogExists()
mutableStateFlow.update {
it.copy(
vaultTimeoutPolicyMinutes = 100,
)
}
composeTestRule
.onAllNodesWithText("Session timeout")
.filterToOne(hasClickAction())
.performScrollTo()
.performClick()
composeTestRule
.onAllNodesWithText("Immediately")
.filterToOne(hasAnyAncestor(isDialog()))
.assertIsDisplayed()
composeTestRule
.onAllNodesWithText("1 minute")
.filterToOne(hasAnyAncestor(isDialog()))
.assertIsDisplayed()
composeTestRule
.onAllNodesWithText("5 minutes")
.filterToOne(hasAnyAncestor(isDialog()))
.assertIsDisplayed()
composeTestRule
.onAllNodesWithText("15 minutes")
.filterToOne(hasAnyAncestor(isDialog()))
.assertIsDisplayed()
composeTestRule
.onAllNodesWithText("30 minutes")
.filterToOne(hasAnyAncestor(isDialog()))
.assertIsDisplayed()
composeTestRule
.onAllNodesWithText("1 hour")
.filterToOne(hasAnyAncestor(isDialog()))
.assertIsDisplayed()
composeTestRule
.onNodeWithText("4 hours")
.assertDoesNotExist()
composeTestRule
.onNodeWithText("On app restart")
.assertDoesNotExist()
composeTestRule
.onNodeWithText("Never")
.assertDoesNotExist()
composeTestRule
.onAllNodesWithText("Custom")
.filterToOne(hasAnyAncestor(isDialog()))
.performScrollTo()
.assertIsDisplayed()
composeTestRule
.onAllNodesWithText("Cancel")
.filterToOne(hasAnyAncestor(isDialog()))
.assertIsDisplayed()
}
@Test
fun `on session timeout selection dialog cancel click should close the dialog`() {
composeTestRule.assertNoDialogExists()
@@ -960,6 +1050,47 @@ class AccountSecurityScreenTest : BaseComposeTest() {
composeTestRule.assertNoDialogExists()
}
@Suppress("MaxLineLength")
@Test
fun `custom session timeout dialog Ok click should dismiss the dialog and show an error if value exceeds policy limit`() {
composeTestRule.assertNoDialogExists()
mutableStateFlow.update {
it.copy(
vaultTimeout = VaultTimeout.Custom(vaultTimeoutInMinutes = 123),
vaultTimeoutPolicyMinutes = 100,
)
}
composeTestRule
.onNode(hasTextExactly("Custom", "02:03"))
.performScrollTo()
.performClick()
composeTestRule
.onAllNodesWithText("Ok")
.filterToOne(hasAnyAncestor(isDialog()))
.performClick()
composeTestRule
.onNodeWithText("Your vault timeout exceeds the restrictions set by your organization.")
.assert(hasAnyAncestor(isDialog()))
.isDisplayed()
composeTestRule
.onAllNodesWithText("Ok")
.filterToOne(hasAnyAncestor(isDialog()))
.performClick()
verify {
viewModel.trySendAction(
AccountSecurityAction.CustomVaultTimeoutSelect(
VaultTimeout.Custom(vaultTimeoutInMinutes = 100),
),
)
}
composeTestRule.assertNoDialogExists()
}
@Test
fun `on session timeout action click should show a selection dialog`() {
composeTestRule.assertNoDialogExists()
@@ -1354,6 +1485,8 @@ class AccountSecurityScreenTest : BaseComposeTest() {
isUnlockWithPinEnabled = false,
vaultTimeout = VaultTimeout.ThirtyMinutes,
vaultTimeoutAction = VaultTimeoutAction.LOCK,
vaultTimeoutPolicyMinutes = null,
vaultTimeoutPolicyAction = null,
)
}
}
@@ -4,7 +4,9 @@ import androidx.lifecycle.SavedStateHandle
import app.cash.turbine.test
import com.x8bit.bitwarden.R
import com.x8bit.bitwarden.data.auth.repository.AuthRepository
import com.x8bit.bitwarden.data.auth.repository.model.PolicyInformation
import com.x8bit.bitwarden.data.auth.repository.model.UserFingerprintResult
import com.x8bit.bitwarden.data.platform.manager.PolicyManager
import com.x8bit.bitwarden.data.platform.repository.EnvironmentRepository
import com.x8bit.bitwarden.data.platform.repository.SettingsRepository
import com.x8bit.bitwarden.data.platform.repository.model.BiometricsKeyResult
@@ -12,6 +14,10 @@ import com.x8bit.bitwarden.data.platform.repository.model.Environment
import com.x8bit.bitwarden.data.platform.repository.model.VaultTimeout
import com.x8bit.bitwarden.data.platform.repository.model.VaultTimeoutAction
import com.x8bit.bitwarden.data.platform.repository.util.FakeEnvironmentRepository
import com.x8bit.bitwarden.data.platform.repository.util.bufferedMutableSharedFlow
import com.x8bit.bitwarden.data.vault.datasource.network.model.PolicyTypeJson
import com.x8bit.bitwarden.data.vault.datasource.network.model.SyncResponseJson
import com.x8bit.bitwarden.data.vault.datasource.network.model.createMockPolicy
import com.x8bit.bitwarden.data.vault.repository.VaultRepository
import com.x8bit.bitwarden.ui.platform.base.BaseViewModelTest
import com.x8bit.bitwarden.ui.platform.base.util.asText
@@ -23,6 +29,9 @@ import io.mockk.mockk
import io.mockk.runs
import io.mockk.verify
import kotlinx.coroutines.test.runTest
import kotlinx.serialization.json.Json
import kotlinx.serialization.json.encodeToJsonElement
import kotlinx.serialization.json.jsonObject
import org.junit.jupiter.api.Assertions.assertEquals
import org.junit.jupiter.api.Assertions.assertFalse
import org.junit.jupiter.api.Assertions.assertTrue
@@ -41,6 +50,12 @@ class AccountSecurityViewModelTest : BaseViewModelTest() {
every { vaultTimeoutAction } returns VaultTimeoutAction.LOCK
coEvery { getUserFingerprint() } returns UserFingerprintResult.Success(FINGERPRINT)
}
private val mutableActivePolicyFlow = bufferedMutableSharedFlow<List<SyncResponseJson.Policy>>()
private val policyManager: PolicyManager = mockk {
every {
getActivePoliciesFlow(type = PolicyTypeJson.MAXIMUM_VAULT_TIMEOUT)
} returns mutableActivePolicyFlow
}
@Test
fun `initial state should be correct when saved state is set`() {
@@ -60,6 +75,35 @@ class AccountSecurityViewModelTest : BaseViewModelTest() {
coVerify { settingsRepository.getUserFingerprint() }
}
@Test
fun `state updates when policies change`() = runTest {
val viewModel = createViewModel()
val policyInformation = PolicyInformation.VaultTimeout(
minutes = 10,
action = "lock",
)
mutableActivePolicyFlow.emit(
listOf(
createMockPolicy(
isEnabled = true,
type = PolicyTypeJson.MAXIMUM_VAULT_TIMEOUT,
data = Json.encodeToJsonElement(policyInformation).jsonObject,
),
),
)
viewModel.stateFlow.test {
assertEquals(
DEFAULT_STATE.copy(
vaultTimeoutPolicyMinutes = 10,
vaultTimeoutPolicyAction = "lock",
),
awaitItem(),
)
}
}
@Test
fun `on FingerprintResultReceive should update the fingerprint phrase`() = runTest {
val fingerprint = "fingerprint"
@@ -488,17 +532,20 @@ class AccountSecurityViewModelTest : BaseViewModelTest() {
}
}
@Suppress("LongParameterList")
private fun createViewModel(
initialState: AccountSecurityState? = DEFAULT_STATE,
authRepository: AuthRepository = this.authRepository,
vaultRepository: VaultRepository = this.vaultRepository,
environmentRepository: EnvironmentRepository = this.fakeEnvironmentRepository,
settingsRepository: SettingsRepository = this.settingsRepository,
policyManager: PolicyManager = this.policyManager,
): AccountSecurityViewModel = AccountSecurityViewModel(
authRepository = authRepository,
vaultRepository = vaultRepository,
settingsRepository = settingsRepository,
environmentRepository = environmentRepository,
policyManager = policyManager,
savedStateHandle = SavedStateHandle().apply {
set("state", initialState)
},
@@ -515,4 +562,6 @@ private val DEFAULT_STATE: AccountSecurityState = AccountSecurityState(
isUnlockWithPinEnabled = false,
vaultTimeout = VaultTimeout.ThirtyMinutes,
vaultTimeoutAction = VaultTimeoutAction.LOCK,
vaultTimeoutPolicyMinutes = null,
vaultTimeoutPolicyAction = null,
)
@@ -28,4 +28,26 @@ class VaultTimeoutExtensionsTest {
)
}
}
@Test
fun `minutes should return the correct value for each type`() {
mapOf(
VaultTimeout.Type.IMMEDIATELY to 0,
VaultTimeout.Type.ONE_MINUTE to 1,
VaultTimeout.Type.FIVE_MINUTES to 5,
VaultTimeout.Type.FIFTEEN_MINUTES to 15,
VaultTimeout.Type.THIRTY_MINUTES to 30,
VaultTimeout.Type.ONE_HOUR to 60,
VaultTimeout.Type.FOUR_HOURS to 240,
VaultTimeout.Type.ON_APP_RESTART to Int.MAX_VALUE,
VaultTimeout.Type.NEVER to Int.MAX_VALUE,
VaultTimeout.Type.CUSTOM to 0,
)
.forEach { (type, value) ->
assertEquals(
value,
type.minutes,
)
}
}
}