Skip to content

Privacy-first password manager with built-in email aliasing. Fully encrypted and self-hostable.

Add vault sync hold mechanism to mobile app (#2469)

Leendert de Borst07f307c7ca3e
diff --git a/apps/mobile-app/android/app/src/main/java/net/aliasvault/app/nativevaultmanager/NativeVaultManager.kt b/apps/mobile-app/android/app/src/main/java/net/aliasvault/app/nativevaultmanager/NativeVaultManager.kt
index 017e8eed8..27fad1538 100644
--- a/apps/mobile-app/android/app/src/main/java/net/aliasvault/app/nativevaultmanager/NativeVaultManager.kt
+++ b/apps/mobile-app/android/app/src/main/java/net/aliasvault/app/nativevaultmanager/NativeVaultManager.kt
@@ -1344,6 +1344,22 @@ class NativeVaultManager(reactContext: ReactApplicationContext) :
}
}
+ /**
+ * Hold vault syncing while an operation runs that a sync must not race, or release it with null.
+ * @param reason The operation taking the hold, or null to release it.
+ * @param promise The promise to resolve.
+ */
+ @ReactMethod
+ override fun setVaultSyncHold(reason: String?, promise: Promise) {
+ try {
+ vaultStore.setVaultSyncHold(reason)
+ promise.resolve(null)
+ } catch (e: Exception) {
+ Log.e(TAG, "Error setting the vault sync hold", e)
+ promise.reject("ERR_SET_VAULT_SYNC_HOLD", "Failed to set the vault sync hold: ${e.message}", e)
+ }
+ }
+
/**
* Get offline mode flag.
* @param promise The promise to resolve.
diff --git a/apps/mobile-app/android/app/src/main/java/net/aliasvault/app/vaultstore/VaultStore.kt b/apps/mobile-app/android/app/src/main/java/net/aliasvault/app/vaultstore/VaultStore.kt
index 2134731d5..eb8145006 100644
--- a/apps/mobile-app/android/app/src/main/java/net/aliasvault/app/vaultstore/VaultStore.kt
+++ b/apps/mobile-app/android/app/src/main/java/net/aliasvault/app/vaultstore/VaultStore.kt
@@ -12,6 +12,7 @@ import net.aliasvault.app.vaultstore.models.StoreVaultResult
import net.aliasvault.app.vaultstore.models.TotpCode
import net.aliasvault.app.vaultstore.models.VaultMutationScope
import net.aliasvault.app.vaultstore.storageprovider.StorageProvider
+import org.json.JSONObject
import uniffi.aliasvault_core.VaultException
import uniffi.aliasvault_core.rsaDecrypt
import kotlin.coroutines.resume
@@ -56,6 +57,9 @@ class VaultStore(
*/
private const val MAX_AUTH_RECENCY_WINDOW_SECONDS: Double = 15.0
+ /** How long a sync hold stays valid without being released, so a crashed holder is forgotten. */
+ private const val VAULT_SYNC_HOLD_TTL_MS = 2 * 60 * 1000L
+
/**
* Get the instance of the vault store.
* @param keystoreProvider The keystore provider
@@ -620,6 +624,24 @@ class VaultStore(
return metadata.getOfflineMode()
}
+ /**
+ * Hold vault syncing while an operation runs that a sync must not race (e.g. a password change), or release it with null.
+ */
+ fun setVaultSyncHold(reason: String?) {
+ storageProvider.setVaultSyncHold(reason?.let { JSONObject().put("reason", it).put("heldAt", System.currentTimeMillis()).toString() })
+ }
+
+ /**
+ * The reason syncing is on hold, or null when no unexpired hold is held.
+ */
+ fun getVaultSyncHoldReason(): String? {
+ val hold = storageProvider.getVaultSyncHold()?.let { JSONObject(it) } ?: return null
+ if (System.currentTimeMillis() - hold.optLong("heldAt") >= VAULT_SYNC_HOLD_TTL_MS) {
+ return null
+ }
+ return hold.optString("reason").takeIf { it.isNotEmpty() }
+ }
+
// endregion
// region Sync Methods
diff --git a/apps/mobile-app/android/app/src/main/java/net/aliasvault/app/vaultstore/VaultSync.kt b/apps/mobile-app/android/app/src/main/java/net/aliasvault/app/vaultstore/VaultSync.kt
index b8fa6cd53..db1df1312 100644
--- a/apps/mobile-app/android/app/src/main/java/net/aliasvault/app/vaultstore/VaultSync.kt
+++ b/apps/mobile-app/android/app/src/main/java/net/aliasvault/app/vaultstore/VaultSync.kt
@@ -1,6 +1,7 @@
package net.aliasvault.app.vaultstore
import android.util.Log
+import kotlinx.coroutines.delay
import net.aliasvault.app.vaultstore.models.VaultMetadata
import net.aliasvault.app.vaultstore.storageprovider.StorageProvider
import net.aliasvault.app.webapi.WebApiService
@@ -24,6 +25,9 @@ class VaultSync(
companion object {
private const val TAG = "VaultSync"
+ /** How often a run waiting for a sync hold checks whether it was released. */
+ private const val SYNC_HOLD_POLL_MS = 100L
+
/** The engine operations the sharing screen may ask for. */
private val SHARING_OPERATIONS = setOf("createSharedManifest", "inviteToSharedManifest", "updateSharedManifest")
}
@@ -167,11 +171,25 @@ class VaultSync(
}
}
+ /**
+ * Wait while a sync hold is held (see VaultStore.setVaultSyncHold), so the run sees the state its holder leaves
+ * behind. `resolveVaultKey` never waits: the password change runs it while holding the hold.
+ */
+ private suspend fun waitForSyncHoldRelease(operation: String) {
+ if (operation == "resolveVaultKey") return
+ val reason = vaultStore.getVaultSyncHoldReason() ?: return
+ Log.d(TAG, "$operation waits: on hold for $reason")
+ while (vaultStore.getVaultSyncHoldReason() != null) {
+ delay(SYNC_HOLD_POLL_MS)
+ }
+ }
+
/**
* Run one engine operation and persist what it reported. A driver failure surfaces as the native error.
*/
@Suppress("TooGenericExceptionCaught")
private suspend fun run(operation: String, webApiService: WebApiService, encryptionKey: String? = null, sharing: JSONObject? = null): JSONObject {
+ waitForSyncHoldRelease(operation)
val result = try {
VaultSyncEngine(vaultStore, storageProvider, webApiService).run(operation, encryptionKey = encryptionKey, sharing = sharing)
} catch (e: Exception) {
diff --git a/apps/mobile-app/android/app/src/main/java/net/aliasvault/app/vaultstore/storageprovider/AndroidStorageProvider.kt b/apps/mobile-app/android/app/src/main/java/net/aliasvault/app/vaultstore/storageprovider/AndroidStorageProvider.kt
index 2b410bb6a..16057af2e 100644
--- a/apps/mobile-app/android/app/src/main/java/net/aliasvault/app/vaultstore/storageprovider/AndroidStorageProvider.kt
+++ b/apps/mobile-app/android/app/src/main/java/net/aliasvault/app/vaultstore/storageprovider/AndroidStorageProvider.kt
@@ -140,6 +140,18 @@ class AndroidStorageProvider(private val context: Context) : StorageProvider {
return sharedPreferences.getBoolean("offline_mode", false)
}
+ override fun getVaultSyncHold(): String? {
+ val sharedPreferences = context.getSharedPreferences("aliasvault", Context.MODE_PRIVATE)
+ return sharedPreferences.getString("vault_sync_hold", null)
+ }
+
+ override fun setVaultSyncHold(json: String?) {
+ val sharedPreferences = context.getSharedPreferences("aliasvault", Context.MODE_PRIVATE)
+ sharedPreferences.edit {
+ if (json == null) remove("vault_sync_hold") else putString("vault_sync_hold", json)
+ }
+ }
+
override fun setServerVersion(version: String) {
val sharedPreferences = context.getSharedPreferences("aliasvault", Context.MODE_PRIVATE)
sharedPreferences.edit {
diff --git a/apps/mobile-app/android/app/src/main/java/net/aliasvault/app/vaultstore/storageprovider/StorageProvider.kt b/apps/mobile-app/android/app/src/main/java/net/aliasvault/app/vaultstore/storageprovider/StorageProvider.kt
index de2d8acba..c5052ae47 100644
--- a/apps/mobile-app/android/app/src/main/java/net/aliasvault/app/vaultstore/storageprovider/StorageProvider.kt
+++ b/apps/mobile-app/android/app/src/main/java/net/aliasvault/app/vaultstore/storageprovider/StorageProvider.kt
@@ -121,6 +121,18 @@ interface StorageProvider {
*/
fun getOfflineMode(): Boolean
+ /**
+ * Get the sync hold record (JSON with reason and heldAt), see VaultStore.setVaultSyncHold.
+ * @return The record, or null when no hold is held
+ */
+ fun getVaultSyncHold(): String?
+
+ /**
+ * Set or clear the sync hold record.
+ * @param json The record, or null to clear it
+ */
+ fun setVaultSyncHold(json: String?)
+
/**
* Set the server API version.
* @param version The server version to store
diff --git a/apps/mobile-app/android/app/src/main/java/net/aliasvault/app/vaultstore/storageprovider/TestStorageProvider.kt b/apps/mobile-app/android/app/src/main/java/net/aliasvault/app/vaultstore/storageprovider/TestStorageProvider.kt
index 2c0442bef..bd3d8f249 100644
--- a/apps/mobile-app/android/app/src/main/java/net/aliasvault/app/vaultstore/storageprovider/TestStorageProvider.kt
+++ b/apps/mobile-app/android/app/src/main/java/net/aliasvault/app/vaultstore/storageprovider/TestStorageProvider.kt
@@ -17,6 +17,7 @@ class TestStorageProvider : StorageProvider {
private var tempAutoLockTimeout = defaultAutoLockTimeout
private var username: String? = null
private var offlineMode: Boolean = false
+ private var vaultSyncHold: String? = null
private var serverVersion: String? = null
private var capabilities: String? = null
private var isDirty: Boolean = false
@@ -101,6 +102,14 @@ class TestStorageProvider : StorageProvider {
return offlineMode
}
+ override fun getVaultSyncHold(): String? {
+ return vaultSyncHold
+ }
+
+ override fun setVaultSyncHold(json: String?) {
+ vaultSyncHold = json
+ }
+
override fun setServerVersion(version: String) {
serverVersion = version
}
diff --git a/apps/mobile-app/hooks/useVaultMutate.ts b/apps/mobile-app/hooks/useVaultMutate.ts
index cd978e76b..146f7d4b4 100644
--- a/apps/mobile-app/hooks/useVaultMutate.ts
+++ b/apps/mobile-app/hooks/useVaultMutate.ts
@@ -6,6 +6,7 @@ import type { UnlockKeyDerivationParams } from '@aliasvault/models/metadata';
import type { PasswordChangeInitiateResponse, PasswordChangeRequest } from '@aliasvault/models/webapi';
import { MasterPasswordService, PasswordChangedElsewhereError } from '@aliasvault/client/auth/MasterPasswordService';
import { SrpAuthService } from '@aliasvault/client/auth/SrpAuthService';
+import { VaultSyncHoldReason } from '@aliasvault/client/sync/VaultSyncHold';
import { useVaultSync } from '@/hooks/useVaultSync';
@@ -192,7 +193,13 @@ export function useVaultMutate() : {
try {
setIsLoading(true);
setSyncStatus(t('settings.securitySettings.changePassword.initiatingChange'));
- await executePasswordChangeOperation(currentUnlockKeyBase64, newPasswordPlainText);
+ // Hold the vault sync so no sync compares the server's new salt with the stored old one in between.
+ await NativeVaultManager.setVaultSyncHold(VaultSyncHoldReason.PasswordChange);
+ try {
+ await executePasswordChangeOperation(currentUnlockKeyBase64, newPasswordPlainText);
+ } finally {
+ await NativeVaultManager.setVaultSyncHold(null);
+ }
} finally {
setIsLoading(false);
setSyncStatus('');
diff --git a/apps/mobile-app/ios/NativeVaultManager/RCTNativeVaultManager.mm b/apps/mobile-app/ios/NativeVaultManager/RCTNativeVaultManager.mm
index 8e13e3d30..b28b7edd2 100644
--- a/apps/mobile-app/ios/NativeVaultManager/RCTNativeVaultManager.mm
+++ b/apps/mobile-app/ios/NativeVaultManager/RCTNativeVaultManager.mm
@@ -275,6 +275,10 @@
[vaultManager setOfflineMode:isOffline resolver:resolve rejecter:reject];
}
+- (void)setVaultSyncHold:(NSString *)reason resolve:(RCTPromiseResolveBlock)resolve reject:(RCTPromiseRejectBlock)reject {
+ [vaultManager setVaultSyncHold:reason resolver:resolve rejecter:reject];
+}
+
- (void)getOfflineMode:(RCTPromiseResolveBlock)resolve reject:(RCTPromiseRejectBlock)reject {
[vaultManager getOfflineMode:resolve rejecter:reject];
}
diff --git a/apps/mobile-app/ios/NativeVaultManager/VaultManager.swift b/apps/mobile-app/ios/NativeVaultManager/VaultManager.swift
index 19f9ca796..9feda8b0a 100644
--- a/apps/mobile-app/ios/NativeVaultManager/VaultManager.swift
+++ b/apps/mobile-app/ios/NativeVaultManager/VaultManager.swift
@@ -724,6 +724,15 @@ public class VaultManager: NSObject {
resolve(nil)
}
+ /// Hold vault syncing while an operation runs that a sync must not race, or release it with nil.
+ @objc
+ func setVaultSyncHold(_ reason: String?,
+ resolver resolve: @escaping RCTPromiseResolveBlock,
+ rejecter reject: @escaping RCTPromiseRejectBlock) {
+ vaultStore.setVaultSyncHold(reason)
+ resolve(nil)
+ }
+
@objc
func getOfflineMode(_ resolve: @escaping RCTPromiseResolveBlock,
rejecter reject: @escaping RCTPromiseRejectBlock) {
diff --git a/apps/mobile-app/ios/VaultStoreKit/Services/VaultSync.swift b/apps/mobile-app/ios/VaultStoreKit/Services/VaultSync.swift
index 487711261..d31a781f1 100644
--- a/apps/mobile-app/ios/VaultStoreKit/Services/VaultSync.swift
+++ b/apps/mobile-app/ios/VaultStoreKit/Services/VaultSync.swift
@@ -142,6 +142,7 @@ internal final class VaultSync {
/// Run one engine operation and persist what it reported. A driver failure surfaces as the native error.
private func run(_ operation: String, using webApiService: WebApiService, encryptionKey: String? = nil, sharing: [String: Any]? = nil) async throws -> [String: Any] {
+ await waitForSyncHoldRelease(operation)
let result: [String: Any]
do {
result = try await VaultSyncEngine(vaultStore: vaultStore, webApiService: webApiService).run(operation: operation, encryptionKey: encryptionKey, sharing: sharing)
@@ -152,6 +153,16 @@ internal final class VaultSync {
return result
}
+ /// Wait while a sync hold is held (see VaultStore.setVaultSyncHold), so the run sees the state its holder leaves
+ /// behind. `resolveVaultKey` never waits: the password change runs it while holding the hold.
+ private func waitForSyncHoldRelease(_ operation: String) async {
+ guard operation != "resolveVaultKey", let reason = vaultStore.getVaultSyncHoldReason() else { return }
+ print("[VaultSync] \(operation) waits: on hold for \(reason)")
+ while vaultStore.getVaultSyncHoldReason() != nil {
+ try? await Task.sleep(nanoseconds: 100_000_000)
+ }
+ }
+
/// Persist what the engine reported: server version and capabilities, offline mode, session values it changed,
/// and the email routing a pulled vault came with.
private func persistSyncResult(_ result: [String: Any]) {
diff --git a/apps/mobile-app/ios/VaultStoreKit/VaultStore+Sync.swift b/apps/mobile-app/ios/VaultStoreKit/VaultStore+Sync.swift
index 4bf2bf44c..0840aa10d 100644
--- a/apps/mobile-app/ios/VaultStoreKit/VaultStore+Sync.swift
+++ b/apps/mobile-app/ios/VaultStoreKit/VaultStore+Sync.swift
@@ -9,6 +9,29 @@ extension VaultStore {
return await sync.syncVaultWithServer(using: webApiService)
}
+ /// How long a sync hold stays valid without being released, so a crashed holder is forgotten.
+ private static let vaultSyncHoldTtl: TimeInterval = 2 * 60
+
+ /// Hold vault syncing while an operation runs that a sync must not race (e.g. a password change), or release it with nil.
+ public func setVaultSyncHold(_ reason: String?) {
+ if let reason = reason {
+ userDefaults.set(["reason": reason, "heldAt": Date().timeIntervalSince1970], forKey: VaultConstants.vaultSyncHoldKey)
+ } else {
+ userDefaults.removeObject(forKey: VaultConstants.vaultSyncHoldKey)
+ }
+ }
+
+ /// The reason syncing is on hold, or nil when no unexpired hold is held.
+ public func getVaultSyncHoldReason() -> String? {
+ guard let hold = userDefaults.dictionary(forKey: VaultConstants.vaultSyncHoldKey),
+ let reason = hold["reason"] as? String,
+ let heldAt = hold["heldAt"] as? TimeInterval,
+ Date().timeIntervalSince1970 - heldAt < Self.vaultSyncHoldTtl else {
+ return nil
+ }
+ return reason
+ }
+
/// One status call: whether the server holds newer state than this device.
public func checkVaultVersion(using webApiService: WebApiService) async throws -> VaultVersionCheckResult {
return try await sync.checkVaultVersion(using: webApiService)
diff --git a/apps/mobile-app/ios/VaultStoreKit/VaultStore.swift b/apps/mobile-app/ios/VaultStoreKit/VaultStore.swift
index b6e44e283..b7eaa637f 100644
--- a/apps/mobile-app/ios/VaultStoreKit/VaultStore.swift
+++ b/apps/mobile-app/ios/VaultStoreKit/VaultStore.swift
@@ -86,7 +86,7 @@ public class VaultStore {
/// Whether the vault is currently unlocked
public var isVaultUnlocked: Bool {
- return unlockKey != nil
+ return accountKey != nil
}
// MARK: - Authentication Recency
diff --git a/apps/mobile-app/ios/VaultUtils/VaultConstants.swift b/apps/mobile-app/ios/VaultUtils/VaultConstants.swift
index 9c9285212..7c9d7e485 100644
--- a/apps/mobile-app/ios/VaultUtils/VaultConstants.swift
+++ b/apps/mobile-app/ios/VaultUtils/VaultConstants.swift
@@ -23,6 +23,7 @@ public struct VaultConstants {
public static let isDirtyKey = "aliasvault_is_dirty"
public static let mutationSequenceKey = "aliasvault_mutation_sequence"
public static let isSyncingKey = "aliasvault_is_syncing"
+ public static let vaultSyncHoldKey = "aliasvault_vault_sync_hold"
public static let dirtyScopesKey = "aliasvault_dirty_scopes"
public static let syncLogsKey = "aliasvault_sync_logs"
diff --git a/apps/mobile-app/specs/NativeVaultManager.ts b/apps/mobile-app/specs/NativeVaultManager.ts
index 4372b05cd..f908dc9b2 100644
--- a/apps/mobile-app/specs/NativeVaultManager.ts
+++ b/apps/mobile-app/specs/NativeVaultManager.ts
@@ -109,6 +109,9 @@ export interface Spec extends TurboModule {
setOfflineMode(isOffline: boolean): Promise<void>;
getOfflineMode(): Promise<boolean>;
+ // Hold vault syncing while an operation runs that a sync must not race (e.g. a password change); null releases it.
+ setVaultSyncHold(reason: string | null): Promise<void>;
+
// Server version management
getServerVersion(): Promise<string | null>;