Add App Lock settings screen (#1917)

2026-11-02 21:33:26 +00:00 · 2023-10-19 12:26:34 +01:00
parent 99c28784a9
commit ebd9f4c916
36 changed files with 777 additions and 78 deletions
@@ -16,40 +16,6 @@

 import LocalAuthentication

-enum AppLockServiceError: Error {
-    /// The operation failed to access the keychain.
-    case keychainError
-    /// The PIN code was rejected because it isn't long enough, or contains invalid characters.
-    case invalidPIN
-    /// The PIN code was rejected as an insecure choice.
-    case weakPIN
-}
-
-@MainActor
-protocol AppLockServiceProtocol {
-    /// The app has been configured to automatically lock with a PIN code.
-    var isEnabled: Bool { get }
-    /// The type of biometric authentication supported by the device.
-    var biometryType: LABiometryType { get }
-    /// Whether or not the user has enabled unlock via TouchID, FaceID or (possibly) OpticID.
-    var biometricUnlockEnabled: Bool { get set }
-    
-    /// Sets the user's PIN code used to unlock the app.
-    func setupPINCode(_ pinCode: String) -> Result<Void, AppLockServiceError>
-    /// Disables the App Lock feature, removing the user's stored PIN code.
-    func disable()
-    
-    /// Informs the service that the app has entered the background.
-    func applicationDidEnterBackground()
-    /// Decides whether the app should be unlocked with a PIN code/biometrics on foregrounding.
-    func computeNeedsUnlock(willEnterForegroundAt date: Date) -> Bool
-    
-    /// Attempt to unlock the app with the supplied PIN code.
-    func unlock(with pinCode: String) -> Bool
-    /// Attempt to unlock the app using FaceID or TouchID.
-    func unlockWithBiometrics() -> Bool
-}
-
 /// The service responsible for locking and unlocking the app.
 class AppLockService: AppLockServiceProtocol {
    private let keychainController: KeychainControllerProtocol
@@ -76,6 +42,8 @@ class AppLockService: AppLockServiceProtocol {
        self.keychainController = keychainController
        self.appSettings = appSettings
        timer = AppLockTimer(gracePeriod: appSettings.appLockGracePeriod)
+        
+        configureBiometrics()
    }
    
    func setupPINCode(_ pinCode: String) -> Result<Void, AppLockServiceError> {
@@ -116,6 +84,16 @@ class AppLockService: AppLockServiceProtocol {
    
    // MARK: - Private
    
+    /// Queries the context for supported biometrics.
+    private func configureBiometrics() {
+        var error: NSError?
+        context.canEvaluatePolicy(.deviceOwnerAuthenticationWithBiometrics, error: &error)
+        
+        if let error {
+            MXLog.error("Biometrics error: \(error)")
+        }
+    }
+    
    /// Ensures that a provided PIN code is long enough and only contains digits.
    private func validate(_ pinCode: String) -> Bool {
        pinCode.count == 4 && pinCode.allSatisfy(\.isNumber)
@@ -0,0 +1,65 @@
+//
+// Copyright 2023 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import LocalAuthentication
+
+enum AppLockServiceError: Error {
+    /// The operation failed to access the keychain.
+    case keychainError
+    /// The PIN code was rejected because it isn't long enough, or contains invalid characters.
+    case invalidPIN
+    /// The PIN code was rejected as an insecure choice.
+    case weakPIN
+}
+
+@MainActor
+protocol AppLockServiceProtocol: AnyObject {
+    /// The app has been configured to automatically lock with a PIN code.
+    var isEnabled: Bool { get }
+    /// The type of biometric authentication supported by the device.
+    var biometryType: LABiometryType { get }
+    /// Whether or not the user has enabled unlock via TouchID, FaceID or (possibly) OpticID.
+    var biometricUnlockEnabled: Bool { get set }
+    
+    /// Sets the user's PIN code used to unlock the app.
+    func setupPINCode(_ pinCode: String) -> Result<Void, AppLockServiceError>
+    /// Disables the App Lock feature, removing the user's stored PIN code.
+    func disable()
+    
+    /// Informs the service that the app has entered the background.
+    func applicationDidEnterBackground()
+    /// Decides whether the app should be unlocked with a PIN code/biometrics on foregrounding.
+    func computeNeedsUnlock(willEnterForegroundAt date: Date) -> Bool
+    
+    /// Attempt to unlock the app with the supplied PIN code.
+    func unlock(with pinCode: String) -> Bool
+    /// Attempt to unlock the app using FaceID or TouchID.
+    func unlockWithBiometrics() -> Bool
+}
+
+// sourcery: AutoMockable
+extension AppLockServiceProtocol { }
+
+extension AppLockServiceMock {
+    static func mock(pinCode: String? = "2023", biometryType: LABiometryType = .faceID) -> AppLockServiceMock {
+        let mock = AppLockServiceMock()
+        mock.isEnabled = pinCode != nil
+        mock.underlyingBiometryType = biometryType
+        mock.underlyingBiometricUnlockEnabled = biometryType != .none
+        mock.unlockWithClosure = { $0 == pinCode }
+        return mock
+    }
+}