Skip to content

armgit / ente

Public Imported from GitHub
0

πŸ’š End-to-end encrypted cloud for everything.

[mobile] Fix app locks surviving Auth and Locker logout (#13427)

aman-pilot513e6e4ab5a1
diff --git a/mobile/apps/auth/changes/clear-app-lock-on-logout.md b/mobile/apps/auth/changes/clear-app-lock-on-logout.md
new file mode 100644
index 0000000000..99ca0d8b1e
--- /dev/null
+++ b/mobile/apps/auth/changes/clear-app-lock-on-logout.md
@@ -0,0 +1 @@
+- Fixed app locks remaining enabled after logout.
diff --git a/mobile/apps/auth/lib/core/configuration.dart b/mobile/apps/auth/lib/core/configuration.dart
index 50b7375b5e..500fa85bc9 100644
--- a/mobile/apps/auth/lib/core/configuration.dart
+++ b/mobile/apps/auth/lib/core/configuration.dart
@@ -6,6 +6,7 @@ import 'package:ente_base/models/database.dart';
import 'package:ente_configuration/base_configuration.dart';
import 'package:ente_crypto_api/ente_crypto_api.dart';
import 'package:ente_lock_screen/lock_screen_host.dart';
+import 'package:ente_lock_screen/lock_screen_settings.dart';
import 'package:flutter_secure_storage/flutter_secure_storage.dart';
import 'package:shared_preferences/shared_preferences.dart';
import 'package:sqflite_common_ffi/sqflite_ffi.dart';
@@ -42,6 +43,15 @@ class Configuration extends BaseConfiguration
accessibility: KeychainAccessibility.first_unlock_this_device,
),
);
+ if (!isLoggedIn() && !hasOptedForOfflineMode()) {
+ for (final key in lockScreenSecureStorageKeys) {
+ await _secureStorage.delete(key: key);
+ }
+ await _preferences.remove(LockScreenSettings.keyAppLockSet);
+ await _preferences.remove(LockScreenSettings.keyShouldShowLockScreen);
+ await _preferences.remove(LockScreenSettings.keyInvalidAttempts);
+ await _preferences.remove(LockScreenSettings.lastInvalidAttemptTime);
+ }
sqfliteFfiInit();
await _initOfflineAccount();
await _initOnlineAccount();
@@ -66,6 +76,13 @@ class Configuration extends BaseConfiguration
// as it persists across logouts for offline mode
];
+ @override
+ List<String> get lockScreenSecureStorageKeys => [
+ LockScreenSettings.saltKey,
+ LockScreenSettings.pin,
+ LockScreenSettings.password,
+ ];
+
@override
Future<void> logout({bool autoLogout = false}) async {
_authSecretKey = null;
diff --git a/mobile/apps/auth/test/core/configuration_logout_test.dart b/mobile/apps/auth/test/core/configuration_logout_test.dart
new file mode 100644
index 0000000000..8b614ea8b6
--- /dev/null
+++ b/mobile/apps/auth/test/core/configuration_logout_test.dart
@@ -0,0 +1,63 @@
+import 'dart:io';
+
+import 'package:ente_auth/core/configuration.dart';
+import 'package:ente_lock_screen/lock_screen_settings.dart';
+import 'package:flutter/services.dart';
+import 'package:flutter_secure_storage/flutter_secure_storage.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:shared_preferences/shared_preferences.dart';
+
+void main() {
+ TestWidgetsFlutterBinding.ensureInitialized();
+
+ test('offline PIN lock survives sign-in and reinitialization', () async {
+ final root = await Directory.systemTemp.createTemp('auth_offline_lock_');
+ const paths = MethodChannel('plugins.flutter.io/path_provider');
+ final messenger =
+ TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger;
+ messenger.setMockMethodCallHandler(paths, (_) async => root.path);
+ addTearDown(() async {
+ messenger.setMockMethodCallHandler(paths, null);
+ await root.delete(recursive: true);
+ });
+
+ SharedPreferences.setMockInitialValues({
+ Configuration.hasOptedForOfflineModeKey: true,
+ LockScreenSettings.keyAppLockSet: true,
+ LockScreenSettings.keyHasMigratedLockScreenChanges: true,
+ });
+ FlutterSecureStorage.setMockInitialValues({
+ Configuration.offlineAuthSecretKey: 'offline-key',
+ LockScreenSettings.pin: 'pin-hash',
+ LockScreenSettings.saltKey: 'salt',
+ });
+ final config = Configuration.instance;
+ final lock = LockScreenSettings.instance;
+ const storage = FlutterSecureStorage();
+
+ Future<void> expectPinLockPreserved() async {
+ expect(await storage.read(key: LockScreenSettings.pin), 'pin-hash');
+ expect(await storage.read(key: LockScreenSettings.saltKey), 'salt');
+ expect(lock.getIsAppLockSet(), true);
+ expect(await lock.shouldShowLockScreen(), true);
+ }
+
+ await config.init([]);
+ await lock.init(config, hasOptedForOfflineMode: true);
+ expect(config.isLoggedIn(), false);
+ await expectPinLockPreserved();
+
+ await config.setKey('account-key');
+ await config.setToken('token');
+ expect(config.hasConfiguredAccount(), true);
+ await expectPinLockPreserved();
+
+ await config.init([]);
+ await lock.init(
+ config,
+ hasOptedForOfflineMode: config.hasOptedForOfflineMode(),
+ );
+ expect(config.hasConfiguredAccount(), true);
+ await expectPinLockPreserved();
+ });
+}
diff --git a/mobile/apps/locker/changes/clear-app-lock-on-logout.md b/mobile/apps/locker/changes/clear-app-lock-on-logout.md
new file mode 100644
index 0000000000..99ca0d8b1e
--- /dev/null
+++ b/mobile/apps/locker/changes/clear-app-lock-on-logout.md
@@ -0,0 +1 @@
+- Fixed app locks remaining enabled after logout.
diff --git a/mobile/apps/locker/lib/services/configuration.dart b/mobile/apps/locker/lib/services/configuration.dart
index 9191205be7..c7b557ab76 100644
--- a/mobile/apps/locker/lib/services/configuration.dart
+++ b/mobile/apps/locker/lib/services/configuration.dart
@@ -1,11 +1,14 @@
import 'package:ente_account_deletion/account_deletion.dart';
+import 'package:ente_base/models/database.dart';
import 'package:ente_configuration/base_configuration.dart';
import 'package:ente_lock_screen/lock_screen_host.dart';
+import 'package:ente_lock_screen/lock_screen_settings.dart';
import 'package:locker/services/authenticated_session.dart';
import 'package:locker/services/collections/collections_service.dart';
import 'package:locker/services/favorites_service.dart';
import 'package:locker/services/files/offline/offline_file_storage.dart';
import 'package:logging/logging.dart';
+import 'package:shared_preferences/shared_preferences.dart';
class Configuration extends BaseConfiguration
implements LockScreenHost, AccountDeletionHost {
@@ -14,6 +17,18 @@ class Configuration extends BaseConfiguration
final _logger = Logger('Configuration');
+ @override
+ Future<void> init(List<EnteBaseDatabase> dbs) async {
+ await super.init(dbs);
+ if (!isLoggedIn()) {
+ final preferences = await SharedPreferences.getInstance();
+ await preferences.remove(LockScreenSettings.keyAppLockSet);
+ await preferences.remove(LockScreenSettings.keyShouldShowLockScreen);
+ await preferences.remove(LockScreenSettings.keyInvalidAttempts);
+ await preferences.remove(LockScreenSettings.lastInvalidAttemptTime);
+ }
+ }
+
@override
EnteAppIdentity get appIdentity => const EnteAppIdentity(
app: "locker",
@@ -23,8 +38,12 @@ class Configuration extends BaseConfiguration
);
@override
- List<String> get secureStorageKeys =>
- BaseConfiguration.accountSecureStorageKeys;
+ List<String> get secureStorageKeys => [
+ ...BaseConfiguration.accountSecureStorageKeys,
+ LockScreenSettings.saltKey,
+ LockScreenSettings.pin,
+ LockScreenSettings.password,
+ ];
@override
Future<void> logout({bool autoLogout = false}) async {
diff --git a/mobile/packages/configuration/lib/base_configuration.dart b/mobile/packages/configuration/lib/base_configuration.dart
index d2c61e88eb..f4e3848ba4 100644
--- a/mobile/packages/configuration/lib/base_configuration.dart
+++ b/mobile/packages/configuration/lib/base_configuration.dart
@@ -58,6 +58,8 @@ abstract class BaseConfiguration {
List<String> get secureStorageKeys;
+ List<String> get lockScreenSecureStorageKeys => const [];
+
Future<void> init(List<EnteBaseDatabase> dbs) async {
_databases = dbs;
_tempDocumentsDirPath =
@@ -79,6 +81,9 @@ abstract class BaseConfiguration {
await _clearTempFolderOnLogout();
await _preferences.clear();
await resetSecureStorage();
+ for (final key in lockScreenSecureStorageKeys) {
+ await _secureStorage.delete(key: key);
+ }
for (final db in _databases) {
await db.clearTable();
}
diff --git a/mobile/packages/lock_screen/lib/lock_screen_settings.dart b/mobile/packages/lock_screen/lib/lock_screen_settings.dart
index 0ccf02d656..b01ace9fec 100644
--- a/mobile/packages/lock_screen/lib/lock_screen_settings.dart
+++ b/mobile/packages/lock_screen/lib/lock_screen_settings.dart
@@ -3,8 +3,6 @@ import "dart:io";
import "dart:typed_data";
import "package:ente_crypto_api/ente_crypto_api.dart";
-import "package:ente_events/event_bus.dart";
-import "package:ente_events/models/signed_out_event.dart";
import "package:ente_lock_screen/lock_screen_host.dart";
import "package:ente_pure_utils/ente_pure_utils.dart";
import "package:ente_screen_cover/ente_screen_cover.dart";
@@ -70,10 +68,6 @@ class LockScreenSettings {
await runLockScreenChangesMigration();
await _clearLsDataInKeychainIfFreshInstall(hasOptedForOfflineMode);
-
- Bus.instance.on<SignedOutEvent>().listen((event) {
- removePinAndPassword();
- });
}
Future<void> setOfflineModeWarningStatus(bool value) async {
diff --git a/mobile/packages/lock_screen/pubspec.yaml b/mobile/packages/lock_screen/pubspec.yaml
index 66589a8ed5..ff3ab5b726 100644
--- a/mobile/packages/lock_screen/pubspec.yaml
+++ b/mobile/packages/lock_screen/pubspec.yaml
@@ -15,8 +15,6 @@ dependencies:
path: ../configuration
ente_crypto_api:
path: ../ente_crypto_api
- ente_events:
- path: ../events
ente_pure_utils:
path: ../ente_pure_utils
ente_screen_cover: