BIT-809: Generate fingerprint on Login with Device (#781)

This commit is contained in:
Caleb Derosier
2024-06-20 17:08:07 +01:00
committed by Álison Fernandes
parent cd020f2af9
commit 3635d368f9
18 changed files with 396 additions and 39 deletions
@@ -1,10 +1,13 @@
package com.x8bit.bitwarden.data.auth.datasource.sdk
import com.bitwarden.core.AuthRequestResponse
import com.bitwarden.core.FingerprintRequest
import com.bitwarden.core.MasterPasswordPolicyOptions
import com.bitwarden.core.RegisterKeyResponse
import com.bitwarden.crypto.HashPurpose
import com.bitwarden.crypto.Kdf
import com.bitwarden.sdk.ClientAuth
import com.bitwarden.sdk.ClientPlatform
import com.x8bit.bitwarden.data.auth.datasource.sdk.model.PasswordStrength
import com.x8bit.bitwarden.data.platform.util.asSuccess
import io.mockk.coEvery
@@ -17,11 +20,61 @@ import org.junit.jupiter.api.Test
class AuthSdkSourceTest {
private val clientAuth = mockk<ClientAuth>()
private val clientPlatform = mockk<ClientPlatform>()
private val authSkdSource: AuthSdkSource = AuthSdkSourceImpl(
clientAuth = clientAuth,
clientPlatform = clientPlatform,
)
@Test
fun `getNewAuthRequest should call SDK and return a Result with correct data`() = runBlocking {
val email = "test@gmail.com"
val expectedResult = mockk<AuthRequestResponse>()
coEvery {
clientAuth.newAuthRequest(email)
} returns expectedResult
val result = authSkdSource.getNewAuthRequest(email)
assertEquals(
expectedResult.asSuccess(),
result,
)
coVerify {
clientAuth.newAuthRequest(email)
}
}
@Test
fun `getUserFingerprint should call SDK and return a Result with correct data`() = runBlocking {
val email = "email@gmail.com"
val publicKey = "publicKey"
val expectedResult = "fingerprint"
coEvery {
clientPlatform.fingerprint(
req = FingerprintRequest(
fingerprintMaterial = email,
publicKey = publicKey,
),
)
} returns expectedResult
val result = authSkdSource.getUserFingerprint(email, publicKey)
assertEquals(
expectedResult.asSuccess(),
result,
)
coVerify {
clientPlatform.fingerprint(
req = FingerprintRequest(
fingerprintMaterial = email,
publicKey = publicKey,
),
)
}
}
@Test
fun `hashPassword should call SDK and return a Result with the correct data`() = runBlocking {
val email = "email"
@@ -1,6 +1,7 @@
package com.x8bit.bitwarden.data.auth.repository
import app.cash.turbine.test
import com.bitwarden.core.AuthRequestResponse
import com.bitwarden.core.RegisterKeyResponse
import com.bitwarden.crypto.HashPurpose
import com.bitwarden.crypto.Kdf
@@ -44,6 +45,7 @@ import com.x8bit.bitwarden.data.auth.repository.model.PasswordStrengthResult
import com.x8bit.bitwarden.data.auth.repository.model.PrevalidateSsoResult
import com.x8bit.bitwarden.data.auth.repository.model.RegisterResult
import com.x8bit.bitwarden.data.auth.repository.model.SwitchAccountResult
import com.x8bit.bitwarden.data.auth.repository.model.UserFingerprintResult
import com.x8bit.bitwarden.data.auth.repository.model.UserOrganizations
import com.x8bit.bitwarden.data.auth.repository.model.VaultUnlockType
import com.x8bit.bitwarden.data.auth.repository.util.CaptchaCallbackTokenResult
@@ -1374,6 +1376,68 @@ class AuthRepositoryTest {
assertEquals(expected, result)
}
@Test
fun `getUserFingerprint should return failure when source returns failure`() = runTest {
coEvery {
authSdkSource.getNewAuthRequest(EMAIL)
} returns Result.success(
mockk<AuthRequestResponse> {
every { publicKey } returns PUBLIC_KEY
},
)
coEvery {
authSdkSource.getUserFingerprint(
email = EMAIL,
publicKey = PUBLIC_KEY,
)
} returns Result.failure(Throwable())
fakeAuthDiskSource.userState = SINGLE_USER_STATE_1
val result = repository.getFingerprintPhrase(EMAIL)
coVerify(exactly = 1) {
authSdkSource.getNewAuthRequest(EMAIL)
authSdkSource.getUserFingerprint(
email = EMAIL,
publicKey = PUBLIC_KEY,
)
}
assertEquals(UserFingerprintResult.Error, result)
}
@Test
fun `getUserFingerprint should return success when source returns success`() = runTest {
val fingerprint = "fingerprint"
coEvery {
authSdkSource.getNewAuthRequest(EMAIL)
} returns Result.success(
AuthRequestResponse(
fingerprint = fingerprint,
publicKey = PUBLIC_KEY,
privateKey = "key",
accessCode = "accessCode",
),
)
coEvery {
authSdkSource.getUserFingerprint(
email = EMAIL,
publicKey = PUBLIC_KEY,
)
} returns Result.success(fingerprint)
fakeAuthDiskSource.userState = SINGLE_USER_STATE_1
val result = repository.getFingerprintPhrase(EMAIL)
coVerify(exactly = 1) {
authSdkSource.getNewAuthRequest(EMAIL)
authSdkSource.getUserFingerprint(
email = EMAIL,
publicKey = PUBLIC_KEY,
)
}
assertEquals(UserFingerprintResult.Success(fingerprint), result)
}
@Test
fun `getIsKnownDevice should return failure when service returns failure`() = runTest {
coEvery {
@@ -297,15 +297,16 @@ class LoginScreenTest : BaseComposeTest() {
@Test
fun `NavigateToLoginWithDevice should call onNavigateToLoginWithDevice`() {
mutableEventFlow.tryEmit(LoginEvent.NavigateToLoginWithDevice)
mutableEventFlow.tryEmit(LoginEvent.NavigateToLoginWithDevice(EMAIL))
assertTrue(onNavigateToLoginWithDeviceCalled)
}
}
private const val EMAIL = "active@bitwarden.com"
private val ACTIVE_ACCOUNT_SUMMARY = AccountSummary(
userId = "activeUserId",
name = "Active User",
email = "active@bitwarden.com",
email = EMAIL,
avatarColorHex = "#aa00aa",
environmentLabel = "bitwarden.com",
isActive = true,
@@ -315,7 +316,7 @@ private val ACTIVE_ACCOUNT_SUMMARY = AccountSummary(
private val DEFAULT_STATE =
LoginState(
emailAddress = "",
emailAddress = EMAIL,
captchaToken = null,
isLoginButtonEnabled = false,
passwordInput = "",
@@ -40,14 +40,14 @@ import org.junit.jupiter.api.Test
class LoginViewModelTest : BaseViewModelTest() {
private val savedStateHandle = SavedStateHandle().also {
it["email_address"] = "test@gmail.com"
it["email_address"] = EMAIL
}
private val mutableCaptchaTokenResultFlow =
bufferedMutableSharedFlow<CaptchaCallbackTokenResult>()
private val mutableUserStateFlow = MutableStateFlow<UserState?>(null)
private val authRepository: AuthRepository = mockk(relaxed = true) {
coEvery {
getIsKnownDevice("test@gmail.com")
getIsKnownDevice(EMAIL)
} returns KnownDeviceResult.Success(false)
every { captchaTokenResultFlow } returns mutableCaptchaTokenResultFlow
every { userStateFlow } returns mutableUserStateFlow
@@ -160,7 +160,7 @@ class LoginViewModelTest : BaseViewModelTest() {
shouldShowLoginWithDevice = true,
)
coEvery {
authRepository.getIsKnownDevice("test@gmail.com")
authRepository.getIsKnownDevice(EMAIL)
} returns KnownDeviceResult.Success(true)
val viewModel = createViewModel()
@@ -172,7 +172,7 @@ class LoginViewModelTest : BaseViewModelTest() {
@Test
fun `should have default state when isKnownDevice returns error`() = runTest {
coEvery {
authRepository.getIsKnownDevice("test@gmail.com")
authRepository.getIsKnownDevice(EMAIL)
} returns KnownDeviceResult.Error
val viewModel = createViewModel()
@@ -246,7 +246,7 @@ class LoginViewModelTest : BaseViewModelTest() {
fun `LoginButtonClick login returns error should update errorDialogState`() = runTest {
coEvery {
authRepository.login(
email = "test@gmail.com",
email = EMAIL,
password = "",
captchaToken = null,
)
@@ -275,7 +275,7 @@ class LoginViewModelTest : BaseViewModelTest() {
)
}
coVerify {
authRepository.login(email = "test@gmail.com", password = "", captchaToken = null)
authRepository.login(email = EMAIL, password = "", captchaToken = null)
}
}
@@ -283,7 +283,7 @@ class LoginViewModelTest : BaseViewModelTest() {
fun `LoginButtonClick login returns success should update loadingDialogState`() = runTest {
coEvery {
authRepository.login(
email = "test@gmail.com",
email = EMAIL,
password = "",
captchaToken = null,
)
@@ -306,7 +306,7 @@ class LoginViewModelTest : BaseViewModelTest() {
)
}
coVerify {
authRepository.login(email = "test@gmail.com", password = "", captchaToken = null)
authRepository.login(email = EMAIL, password = "", captchaToken = null)
}
}
@@ -319,7 +319,7 @@ class LoginViewModelTest : BaseViewModelTest() {
} returns mockkUri
coEvery {
authRepository.login(
email = "test@gmail.com",
email = EMAIL,
password = "",
captchaToken = null,
)
@@ -331,7 +331,7 @@ class LoginViewModelTest : BaseViewModelTest() {
assertEquals(LoginEvent.NavigateToCaptcha(uri = mockkUri), awaitItem())
}
coVerify {
authRepository.login(email = "test@gmail.com", password = "", captchaToken = null)
authRepository.login(email = EMAIL, password = "", captchaToken = null)
}
}
@@ -342,7 +342,7 @@ class LoginViewModelTest : BaseViewModelTest() {
viewModel.actionChannel.trySend(LoginAction.MasterPasswordHintClick)
assertEquals(DEFAULT_STATE, viewModel.stateFlow.value)
assertEquals(
LoginEvent.NavigateToMasterPasswordHint("test@gmail.com"),
LoginEvent.NavigateToMasterPasswordHint(EMAIL),
awaitItem(),
)
}
@@ -355,7 +355,7 @@ class LoginViewModelTest : BaseViewModelTest() {
viewModel.actionChannel.trySend(LoginAction.LoginWithDeviceButtonClick)
assertEquals(DEFAULT_STATE, viewModel.stateFlow.value)
assertEquals(
LoginEvent.NavigateToLoginWithDevice,
LoginEvent.NavigateToLoginWithDevice(EMAIL),
awaitItem(),
)
}
@@ -435,7 +435,7 @@ class LoginViewModelTest : BaseViewModelTest() {
fun `captchaTokenFlow success update should trigger a login`() = runTest {
coEvery {
authRepository.login(
email = "test@gmail.com",
email = EMAIL,
password = "",
captchaToken = "token",
)
@@ -443,7 +443,7 @@ class LoginViewModelTest : BaseViewModelTest() {
createViewModel()
mutableCaptchaTokenResultFlow.tryEmit(CaptchaCallbackTokenResult.Success("token"))
coVerify {
authRepository.login(email = "test@gmail.com", password = "", captchaToken = "token")
authRepository.login(email = EMAIL, password = "", captchaToken = "token")
}
}
@@ -456,8 +456,9 @@ class LoginViewModelTest : BaseViewModelTest() {
)
companion object {
private const val EMAIL = "test@gmail.com"
private val DEFAULT_STATE = LoginState(
emailAddress = "test@gmail.com",
emailAddress = EMAIL,
passwordInput = "",
isLoginButtonEnabled = false,
environmentLabel = Environment.Us.label,
@@ -105,7 +105,9 @@ class LoginWithDeviceScreenTest : BaseComposeTest() {
}
companion object {
private const val EMAIL = "test@gmail.com"
private val DEFAULT_STATE = LoginWithDeviceState(
emailAddress = EMAIL,
viewState = LoginWithDeviceState.ViewState.Content(
fingerprintPhrase = "alabster-drinkable-mystified-rapping-irrigate",
),
@@ -2,14 +2,25 @@ package com.x8bit.bitwarden.ui.auth.feature.loginwithdevice
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.UserFingerprintResult
import com.x8bit.bitwarden.ui.platform.base.BaseViewModelTest
import com.x8bit.bitwarden.ui.platform.base.util.asText
import io.mockk.coEvery
import io.mockk.coVerify
import io.mockk.mockk
import kotlinx.coroutines.test.runTest
import org.junit.jupiter.api.Assertions.assertEquals
import org.junit.jupiter.api.Test
class LoginWithDeviceViewModelTest : BaseViewModelTest() {
private val savedStateHandle = SavedStateHandle()
private val authRepository = mockk<AuthRepository> {
coEvery {
getFingerprintPhrase(EMAIL)
} returns UserFingerprintResult.Success("initialFingerprint")
}
@Test
fun `initial state should be correct`() = runTest {
@@ -17,6 +28,26 @@ class LoginWithDeviceViewModelTest : BaseViewModelTest() {
viewModel.stateFlow.test {
assertEquals(DEFAULT_STATE, awaitItem())
}
coVerify { authRepository.getFingerprintPhrase(EMAIL) }
}
@Test
fun `initial state should be correct when set`() = runTest {
val newEmail = "newEmail@gmail.com"
coEvery {
authRepository.getFingerprintPhrase(newEmail)
} returns UserFingerprintResult.Success("initialFingerprint")
val state = LoginWithDeviceState(
emailAddress = newEmail,
viewState = LoginWithDeviceState.ViewState.Content(
fingerprintPhrase = "initialFingerprint",
),
)
val viewModel = createViewModel(state)
viewModel.stateFlow.test {
assertEquals(state, awaitItem())
}
coVerify { authRepository.getFingerprintPhrase(newEmail) }
}
@Test
@@ -57,15 +88,59 @@ class LoginWithDeviceViewModelTest : BaseViewModelTest() {
}
}
private fun createViewModel(): LoginWithDeviceViewModel =
@Test
fun `on fingerprint result success received should show content`() = runTest {
val newFingerprint = "newFingerprint"
val viewModel = createViewModel()
assertEquals(DEFAULT_STATE, viewModel.stateFlow.value)
viewModel.actionChannel.trySend(
LoginWithDeviceAction.Internal.FingerprintPhraseReceived(
result = UserFingerprintResult.Success(newFingerprint),
),
)
assertEquals(
DEFAULT_STATE.copy(
viewState = LoginWithDeviceState.ViewState.Content(
fingerprintPhrase = newFingerprint,
),
),
viewModel.stateFlow.value,
)
}
@Test
fun `on fingerprint result failure received should show error`() = runTest {
val viewModel = createViewModel()
assertEquals(DEFAULT_STATE, viewModel.stateFlow.value)
viewModel.actionChannel.trySend(
LoginWithDeviceAction.Internal.FingerprintPhraseReceived(
result = UserFingerprintResult.Error,
),
)
assertEquals(
DEFAULT_STATE.copy(
viewState = LoginWithDeviceState.ViewState.Error(
message = R.string.generic_error_message.asText(),
),
),
viewModel.stateFlow.value,
)
}
private fun createViewModel(
state: LoginWithDeviceState = DEFAULT_STATE,
): LoginWithDeviceViewModel =
LoginWithDeviceViewModel(
savedStateHandle = savedStateHandle,
authRepository = authRepository,
savedStateHandle = SavedStateHandle().apply { set("state", state) },
)
companion object {
private const val EMAIL = "test@gmail.com"
private val DEFAULT_STATE = LoginWithDeviceState(
emailAddress = EMAIL,
viewState = LoginWithDeviceState.ViewState.Content(
fingerprintPhrase = "alabster-drinkable-mystified-rapping-irrigate",
fingerprintPhrase = "initialFingerprint",
),
)
}