PM-37879: feat: Add SDK state bridge #7204
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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,137 @@ | ||
| package com.x8bit.bitwarden.data.platform.manager.sdk.statebridge | ||
|
|
||
| import com.bitwarden.core.MasterPasswordUnlockData | ||
| import com.bitwarden.core.StateBridgeForeignImpl | ||
| import com.bitwarden.core.V2UpgradeToken | ||
| import com.bitwarden.core.WrappedAccountCryptographicState | ||
| import com.bitwarden.crypto.EncString | ||
| import com.bitwarden.crypto.PasswordProtectedKeyEnvelope | ||
| import com.bitwarden.crypto.SymmetricCryptoKey | ||
| import com.x8bit.bitwarden.data.auth.datasource.disk.AuthDiskSource | ||
| import com.x8bit.bitwarden.data.auth.repository.util.updateMasterPasswordUnlock | ||
| import com.x8bit.bitwarden.data.vault.repository.util.toSdkMasterPasswordUnlock | ||
| import com.x8bit.bitwarden.data.vault.repository.util.toV2UpgradeToken | ||
| import com.x8bit.bitwarden.data.vault.repository.util.toV2UpgradeTokenJson | ||
|
|
||
| /** | ||
| * A user-scoped implementation of a Bitwarden SDK [StateBridgeForeignImpl]. | ||
| */ | ||
| @Suppress("TooManyFunctions") | ||
| internal class SdkStateBridge( | ||
| private val userId: String, | ||
| private val authDiskSource: AuthDiskSource, | ||
| ) : StateBridgeForeignImpl { | ||
| @Volatile | ||
| private var inMemoryUserKey: SymmetricCryptoKey? = null | ||
|
|
||
| override suspend fun setUserKey(value: SymmetricCryptoKey) { | ||
| inMemoryUserKey = value | ||
| } | ||
|
|
||
| override suspend fun getUserKey(): SymmetricCryptoKey? = inMemoryUserKey | ||
|
|
||
| override suspend fun clearUserKey() { | ||
| inMemoryUserKey = null | ||
| } | ||
|
|
||
| override suspend fun setPersistentPinEnvelope(value: PasswordProtectedKeyEnvelope) { | ||
| authDiskSource.storePersistentPinProtectedUserKeyEnvelope( | ||
| userId = userId, | ||
| pinProtectedUserKeyEnvelope = value, | ||
| ) | ||
| } | ||
|
|
||
| override suspend fun getPersistentPinEnvelope(): PasswordProtectedKeyEnvelope? = | ||
| authDiskSource.getPersistentPinProtectedUserKeyEnvelope(userId = userId) | ||
|
|
||
| override suspend fun clearPersistentPinEnvelope() { | ||
| authDiskSource.storePersistentPinProtectedUserKeyEnvelope( | ||
| userId = userId, | ||
| pinProtectedUserKeyEnvelope = null, | ||
| ) | ||
| } | ||
|
|
||
| override suspend fun setEphemeralPinEnvelope(value: PasswordProtectedKeyEnvelope) { | ||
| authDiskSource.storeEphemeralPinProtectedUserKeyEnvelope( | ||
| userId = userId, | ||
| pinProtectedUserKeyEnvelope = value, | ||
| ) | ||
| } | ||
|
|
||
| override suspend fun getEphemeralPinEnvelope(): PasswordProtectedKeyEnvelope? = | ||
| authDiskSource.getEphemeralPinProtectedUserKeyEnvelope(userId = userId) | ||
|
|
||
| override suspend fun clearEphemeralPinEnvelope() { | ||
| authDiskSource.storeEphemeralPinProtectedUserKeyEnvelope( | ||
| userId = userId, | ||
| pinProtectedUserKeyEnvelope = null, | ||
| ) | ||
| } | ||
|
|
||
| override suspend fun setEncryptedPin(value: EncString) { | ||
| authDiskSource.storeEncryptedPin(userId = userId, encryptedPin = value) | ||
| } | ||
|
|
||
| override suspend fun getEncryptedPin(): EncString? = | ||
| authDiskSource.getEncryptedPin(userId = userId) | ||
|
|
||
| override suspend fun clearEncryptedPin() { | ||
| authDiskSource.storeEncryptedPin(userId = userId, encryptedPin = null) | ||
| } | ||
|
|
||
| override suspend fun setV2UpgradeToken(value: V2UpgradeToken) { | ||
| authDiskSource.storeV2UpgradeToken( | ||
| userId = userId, | ||
| v2UpgradeToken = value.toV2UpgradeTokenJson(), | ||
| ) | ||
| } | ||
|
|
||
| override suspend fun getV2UpgradeToken(): V2UpgradeToken? = | ||
| authDiskSource | ||
| .getV2UpgradeToken(userId = userId) | ||
| ?.toV2UpgradeToken() | ||
|
|
||
| override suspend fun clearV2UpgradeToken() { | ||
| authDiskSource.storeV2UpgradeToken(userId = userId, v2UpgradeToken = null) | ||
| } | ||
|
|
||
| override suspend fun setAccountCryptographicState(value: WrappedAccountCryptographicState) { | ||
| authDiskSource.storeAccountCryptographicState( | ||
| userId = userId, | ||
| accountCryptographicState = value, | ||
| ) | ||
| } | ||
|
|
||
| override suspend fun getAccountCryptographicState(): WrappedAccountCryptographicState? = | ||
| authDiskSource.getAccountCryptographicState(userId = userId) | ||
|
|
||
| override suspend fun clearAccountCryptographicState() { | ||
| authDiskSource.storeAccountCryptographicState( | ||
| userId = userId, | ||
| accountCryptographicState = null, | ||
| ) | ||
| } | ||
|
|
||
| override suspend fun setMasterpasswordUnlockData(value: MasterPasswordUnlockData) { | ||
| authDiskSource.userState = authDiskSource.userState?.updateMasterPasswordUnlock( | ||
| userId = userId, | ||
| masterPasswordUnlock = value, | ||
| ) | ||
| } | ||
|
Comment on lines
+115
to
+120
Contributor
There was a problem hiding this comment.
Details and fix
Nothing restores the flag afterwards: on sync, Consider a helper that updates only Related: |
||
|
|
||
| override suspend fun getMasterpasswordUnlockData(): MasterPasswordUnlockData? = | ||
| authDiskSource | ||
| .userState | ||
| ?.accounts[userId] | ||
| ?.profile | ||
| ?.userDecryptionOptions | ||
| ?.masterPasswordUnlock | ||
| ?.toSdkMasterPasswordUnlock() | ||
|
|
||
| override suspend fun clearMasterpasswordUnlockData() { | ||
| authDiskSource.userState = authDiskSource.userState?.updateMasterPasswordUnlock( | ||
| userId = userId, | ||
| masterPasswordUnlock = null, | ||
| ) | ||
| } | ||
| } | ||
This file contains hidden or 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 hidden or 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 hidden or 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,22 @@ | ||
| package com.x8bit.bitwarden.data.vault.repository.util | ||
|
|
||
| import com.bitwarden.core.V2UpgradeToken | ||
| import com.bitwarden.network.model.V2UpgradeTokenJson | ||
|
|
||
| /** | ||
| * Converts the [V2UpgradeToken] into a [V2UpgradeTokenJson]. | ||
| */ | ||
| fun V2UpgradeToken.toV2UpgradeTokenJson(): V2UpgradeTokenJson = | ||
| V2UpgradeTokenJson( | ||
| wrappedUserKey1 = this.wrappedUserKey1, | ||
| wrappedUserKey2 = this.wrappedUserKey2, | ||
| ) | ||
|
|
||
| /** | ||
| * Converts the [V2UpgradeTokenJson] into a [V2UpgradeToken]. | ||
| */ | ||
| fun V2UpgradeTokenJson.toV2UpgradeToken(): V2UpgradeToken = | ||
| V2UpgradeToken( | ||
| wrappedUserKey1 = this.wrappedUserKey1, | ||
| wrappedUserKey2 = this.wrappedUserKey2, | ||
| ) |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we have a updateMasterPasswordUnlock function here, why not also make a getMasterPasswordUnlock, instead of having the log
.chain in the get below?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Setting the data is a more complicated process that we want abstracted for reusability, fetching the data is not particularly complicated, so we never bothered to abstract it.
For whatever it's worth, I am working on migrating the master password unlock data out of the
userState. Once that work is done, they with both be simple get and set functions on theauthDiskSource.