BIT-1273: Validate master password (#814)

This commit is contained in:
Shannon Draeker
2024-06-20 17:08:07 +01:00
committed by Álison Fernandes
parent 78a256ae3f
commit 5ce45a8069
19 changed files with 415 additions and 21 deletions
@@ -713,6 +713,45 @@ class AuthDiskSourceTest {
json.parseToJsonElement(requireNotNull(actual)),
)
}
@Test
fun `getMasterPasswordHash should pull from SharedPreferences`() {
val passwordHashBaseKey = "bwPreferencesStorage:keyHash"
val mockUserId = "mockUserId"
val mockPasswordHash = "mockPasswordHash"
fakeSharedPreferences
.edit {
putString(
"${passwordHashBaseKey}_$mockUserId",
mockPasswordHash,
)
}
val actual = authDiskSource.getMasterPasswordHash(userId = mockUserId)
assertEquals(
mockPasswordHash,
actual,
)
}
@Test
fun `storeMasterPasswordHash should update SharedPreferences`() {
val passwordHashBaseKey = "bwPreferencesStorage:keyHash"
val mockUserId = "mockUserId"
val mockPasswordHash = "mockPasswordHash"
authDiskSource.storeMasterPasswordHash(
userId = mockUserId,
passwordHash = mockPasswordHash,
)
val actual = fakeSharedPreferences
.getString(
"${passwordHashBaseKey}_$mockUserId",
null,
)
assertEquals(
mockPasswordHash,
actual,
)
}
}
private const val USER_STATE_JSON = """
@@ -32,6 +32,7 @@ class FakeAuthDiskSource : AuthDiskSource {
mutableMapOf<String, List<SyncResponseJson.Profile.Organization>?>()
private val storedOrganizationKeys = mutableMapOf<String, Map<String, String>?>()
private val storedBiometricKeys = mutableMapOf<String, String?>()
private val storedMasterPasswordHashes = mutableMapOf<String, String?>()
override var userState: UserStateJson? = null
set(value) {
@@ -156,6 +157,13 @@ class FakeAuthDiskSource : AuthDiskSource {
storedBiometricKeys[userId] = biometricsKey
}
override fun getMasterPasswordHash(userId: String): String? =
storedMasterPasswordHashes[userId]
override fun storeMasterPasswordHash(userId: String, passwordHash: String?) {
storedMasterPasswordHashes[userId] = passwordHash
}
/**
* Assert that the given [userState] matches the currently tracked value.
*/
@@ -230,6 +238,13 @@ class FakeAuthDiskSource : AuthDiskSource {
assertEquals(organizationKeys, storedOrganizationKeys[userId])
}
/**
* Assert that the [passwordHash] was stored successfully using the [userId].
*/
fun assertMasterPasswordHash(userId: String, passwordHash: String?) {
assertEquals(passwordHash, storedMasterPasswordHashes[userId])
}
/**
* Assert that the [organizations] were stored successfully using the [userId].
*/
@@ -129,6 +129,14 @@ class AuthRepositoryTest {
purpose = HashPurpose.SERVER_AUTHORIZATION,
)
} returns Result.success(PASSWORD_HASH)
coEvery {
hashPassword(
email = EMAIL,
password = PASSWORD,
kdf = ACCOUNT_1.profile.toSdkParams(),
purpose = HashPurpose.LOCAL_AUTHORIZATION,
)
} returns Result.success(PASSWORD_HASH)
coEvery {
makeRegisterKeys(
email = EMAIL,
@@ -638,6 +646,10 @@ class AuthRepositoryTest {
userId = USER_ID_1,
userKey = "key",
)
fakeAuthDiskSource.assertMasterPasswordHash(
userId = USER_ID_1,
passwordHash = PASSWORD_HASH,
)
coVerify {
identityService.getToken(
email = EMAIL,
@@ -2475,6 +2487,7 @@ class AuthRepositoryTest {
private const val EMAIL_2 = "test2@bitwarden.com"
private const val PASSWORD = "password"
private const val PASSWORD_HASH = "passwordHash"
private const val PASSWORD_HASH_LOCAL = "passwordHashLocal"
private const val ACCESS_TOKEN = "accessToken"
private const val ACCESS_TOKEN_2 = "accessToken2"
private const val REFRESH_TOKEN = "refreshToken"
@@ -800,6 +800,40 @@ class SettingsRepositoryTest {
assertEquals(false, fakeSettingsDiskSource.getScreenCaptureAllowed(userId))
}
}
@Test
fun `validatePassword returns the validate password result`() = runTest {
val userId = "userId"
val password = "password"
val passwordHash = "passwordHash"
fakeAuthDiskSource.userState = MOCK_USER_STATE
fakeAuthDiskSource.storeMasterPasswordHash(userId = userId, passwordHash = passwordHash)
coEvery {
vaultSdkSource.validatePassword(
userId = userId,
password = password,
passwordHash = passwordHash,
)
} returns true
val result = settingsRepository
.validatePassword(
password = password,
)
assertTrue(result)
}
@Test
fun `validatePassword returns false if there's no stored password hash`() = runTest {
fakeAuthDiskSource.userState = MOCK_USER_STATE
val password = "password"
val result = settingsRepository
.validatePassword(
password = password,
)
assertFalse(result)
}
}
private val MOCK_USER_STATE =
@@ -20,6 +20,7 @@ import com.bitwarden.core.SendView
import com.bitwarden.core.TotpResponse
import com.bitwarden.sdk.BitwardenException
import com.bitwarden.sdk.Client
import com.bitwarden.sdk.ClientAuth
import com.bitwarden.sdk.ClientCrypto
import com.bitwarden.sdk.ClientPasswordHistory
import com.bitwarden.sdk.ClientPlatform
@@ -38,10 +39,12 @@ import io.mockk.verify
import kotlinx.coroutines.runBlocking
import kotlinx.coroutines.test.runTest
import org.junit.jupiter.api.Assertions.assertEquals
import org.junit.jupiter.api.Assertions.assertTrue
import org.junit.jupiter.api.Test
@Suppress("LargeClass")
class VaultSdkSourceTest {
private val clientAuth = mockk<ClientAuth>()
private val clientCrypto = mockk<ClientCrypto>()
private val clientPlatform = mockk<ClientPlatform>()
private val clientPasswordHistory = mockk<ClientPasswordHistory>()
@@ -49,6 +52,7 @@ class VaultSdkSourceTest {
every { passwordHistory() } returns clientPasswordHistory
}
private val client = mockk<Client>() {
every { auth() } returns clientAuth
every { vault() } returns clientVault
every { platform() } returns clientPlatform
every { crypto() } returns clientCrypto
@@ -708,4 +712,24 @@ class VaultSdkSourceTest {
verify { sdkClientManager.getOrCreateClient(userId = userId) }
}
@Test
fun `validatePassword should call SDK and return the expected Boolean`() = runTest {
val userId = "userId"
val password = "password"
val passwordHash = "passwordHash"
coEvery {
clientAuth.validatePassword(
password = password,
passwordHash = passwordHash,
)
} returns true
val result = vaultSdkSource.validatePassword(
userId = userId,
password = password,
passwordHash = passwordHash,
)
assertTrue(result)
}
}
@@ -3,9 +3,11 @@ package com.x8bit.bitwarden.data.vault.manager
import com.bitwarden.core.InitOrgCryptoRequest
import com.bitwarden.core.InitUserCryptoMethod
import com.bitwarden.core.InitUserCryptoRequest
import com.bitwarden.crypto.HashPurpose
import com.x8bit.bitwarden.data.auth.datasource.disk.model.AccountJson
import com.x8bit.bitwarden.data.auth.datasource.disk.model.UserStateJson
import com.x8bit.bitwarden.data.auth.datasource.disk.util.FakeAuthDiskSource
import com.x8bit.bitwarden.data.auth.datasource.sdk.AuthSdkSource
import com.x8bit.bitwarden.data.auth.manager.UserLogoutManager
import com.x8bit.bitwarden.data.auth.repository.util.toSdkParams
import com.x8bit.bitwarden.data.platform.base.FakeDispatcherManager
@@ -42,6 +44,16 @@ import org.junit.jupiter.api.Test
class VaultLockManagerTest {
private val fakeAuthDiskSource = FakeAuthDiskSource()
private val fakeAppForegroundManager = FakeAppForegroundManager()
private val authSdkSource: AuthSdkSource = mockk {
coEvery {
hashPassword(
email = MOCK_PROFILE.email,
password = "drowssap",
kdf = MOCK_PROFILE.toSdkParams(),
purpose = HashPurpose.LOCAL_AUTHORIZATION,
)
} returns Result.success("hashedPassword")
}
private val vaultSdkSource: VaultSdkSource = mockk {
every { clearCrypto(userId = any()) } just runs
}
@@ -62,6 +74,7 @@ class VaultLockManagerTest {
private val vaultLockManager: VaultLockManager = VaultLockManagerImpl(
authDiskSource = fakeAuthDiskSource,
authSdkSource = authSdkSource,
vaultSdkSource = vaultSdkSource,
settingsRepository = settingsRepository,
appForegroundManager = fakeAppForegroundManager,
@@ -748,6 +761,10 @@ class VaultLockManagerTest {
userId = userId,
userAutoUnlockKey = null,
)
fakeAuthDiskSource.assertMasterPasswordHash(
userId = userId,
passwordHash = "hashedPassword",
)
coVerify(exactly = 1) {
vaultSdkSource.initializeCrypto(
userId = userId,
@@ -25,6 +25,7 @@ import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.update
import org.junit.Before
import org.junit.Test
import org.junit.jupiter.api.Assertions.assertTrue
class ExportVaultScreenTest : BaseComposeTest() {
private var onNavigateBackCalled = false
@@ -165,6 +166,12 @@ class ExportVaultScreenTest : BaseComposeTest() {
composeTestRule.onNodeWithText("Loading...").isDisplayed()
}
@Test
fun `NavigateBack event should call onNavigateBack`() {
mutableEventFlow.tryEmit(ExportVaultEvent.NavigateBack)
assertTrue(onNavigateBackCalled)
}
@Test
fun `password input change should send PasswordInputChange action`() {
val input = "Test123"
@@ -173,12 +180,10 @@ class ExportVaultScreenTest : BaseComposeTest() {
viewModel.trySendAction(ExportVaultAction.PasswordInputChanged("Test123"))
}
}
companion object {
private val DEFAULT_STATE = ExportVaultState(
dialogState = null,
exportFormat = ExportVaultFormat.JSON,
passwordInput = "",
)
}
}
private val DEFAULT_STATE = ExportVaultState(
dialogState = null,
exportFormat = ExportVaultFormat.JSON,
passwordInput = "",
)
@@ -2,13 +2,20 @@ package com.x8bit.bitwarden.ui.platform.feature.settings.exportvault
import androidx.lifecycle.SavedStateHandle
import app.cash.turbine.test
import com.x8bit.bitwarden.R
import com.x8bit.bitwarden.data.platform.repository.SettingsRepository
import com.x8bit.bitwarden.ui.platform.base.BaseViewModelTest
import com.x8bit.bitwarden.ui.platform.base.util.asText
import com.x8bit.bitwarden.ui.platform.feature.settings.exportvault.model.ExportVaultFormat
import io.mockk.coEvery
import io.mockk.mockk
import kotlinx.coroutines.test.runTest
import org.junit.jupiter.api.Assertions.assertEquals
import org.junit.jupiter.api.Test
class ExportVaultViewModelTest : BaseViewModelTest() {
private val settingsRepository: SettingsRepository = mockk()
private val savedStateHandle = SavedStateHandle()
@Test
@@ -31,6 +38,79 @@ class ExportVaultViewModelTest : BaseViewModelTest() {
}
}
@Test
fun `ConfirmExportVaultClicked correct password should emit ShowToast`() = runTest {
val password = "password"
coEvery {
settingsRepository.validatePassword(
password = password,
)
} returns true
val viewModel = createViewModel()
viewModel.eventFlow.test {
viewModel.trySendAction(ExportVaultAction.PasswordInputChanged(password))
viewModel.trySendAction(ExportVaultAction.ConfirmExportVaultClicked)
assertEquals(
ExportVaultEvent.ShowToast("Not yet implemented".asText()),
awaitItem(),
)
}
}
@Test
fun `ConfirmExportVaultClicked blank password should show an error`() = runTest {
val viewModel = createViewModel()
viewModel.eventFlow.test {
viewModel.trySendAction(ExportVaultAction.ConfirmExportVaultClicked)
assertEquals(
DEFAULT_STATE.copy(
dialogState = ExportVaultState.DialogState.Error(
title = null,
message = R.string.validation_field_required.asText(
R.string.master_password.asText(),
),
),
),
viewModel.stateFlow.value,
)
viewModel.trySendAction(ExportVaultAction.DialogDismiss)
assertEquals(
DEFAULT_STATE,
viewModel.stateFlow.value,
)
}
}
@Test
fun `ConfirmExportVaultClicked invalid password should show an error`() = runTest {
val password = "password"
coEvery {
settingsRepository.validatePassword(
password = password,
)
} returns false
val viewModel = createViewModel()
viewModel.eventFlow.test {
viewModel.trySendAction(ExportVaultAction.PasswordInputChanged(password))
viewModel.trySendAction(ExportVaultAction.ConfirmExportVaultClicked)
assertEquals(
DEFAULT_STATE.copy(
dialogState = ExportVaultState.DialogState.Error(
title = null,
message = R.string.invalid_master_password.asText(),
),
passwordInput = password,
),
viewModel.stateFlow.value,
)
}
}
@Test
fun `ExportFormatOptionSelect should update the selected export format in the state`() =
runTest {
@@ -66,14 +146,13 @@ class ExportVaultViewModelTest : BaseViewModelTest() {
private fun createViewModel(): ExportVaultViewModel =
ExportVaultViewModel(
settingsRepository = settingsRepository,
savedStateHandle = savedStateHandle,
)
companion object {
private val DEFAULT_STATE = ExportVaultState(
dialogState = null,
exportFormat = ExportVaultFormat.JSON,
passwordInput = "",
)
}
}
private val DEFAULT_STATE = ExportVaultState(
dialogState = null,
exportFormat = ExportVaultFormat.JSON,
passwordInput = "",
)