[local_auth] Refactor package to make use of new platform interface and native implementations (#4701)

Author: BeMacized

packages/local_auth/local_auth/AUTHORS

@@ -64,3 +64,4 @@ Aleksandr Yurkovskiy <[email protected]>
 Anton Borries <[email protected]>
 Alex Li <[email protected]>
 Rahul Raj <[email protected]>
+Bodhi Mulders <[email protected]>

packages/local_auth/local_auth/CHANGELOG.md

@@ -1,7 +1,42 @@
-## NEXT
+## 2.0.0
 
+* Migrates plugin to federated architecture.
 * Adds OS version support information to README.
-* Switches over to default method implementation in new platform interface.
+* BREAKING CHANGE: Deprecated method `authenticateWithBiometrics` has been removed.
+  Use `authenticate` instead.
+* BREAKING CHANGE: Enum `BiometricType` has been expanded with options for `strong` and `weak`,
+  and applications should be updated to handle these accordingly. 
+* BREAKING CHANGE: Parameters of `authenticate` have been changed.
+  
+  Example:
+  ```dart  
+  // Old way of calling `authenticate`.
+  Future<bool> authenticate(
+    localizedReason: 'localized reason',
+    useErrorDialogs: true,
+    stickyAuth: false,
+    androidAuthStrings: const AndroidAuthMessages(),
+    iOSAuthStrings: const IOSAuthMessages(),
+    sensitiveTransaction: true,
+    biometricOnly: false,
+  );
+  // New way of calling `authenticate`.
+  Future<bool> authenticate(
+    localizedReason: 'localized reason',
+    authMessages: const <AuthMessages>[
+      IOSAuthMessages(),
+      AndroidAuthMessages()
+    ],
+    options: const AuthenticationOptions(
+      useErrorDialogs: true,
+      stickyAuth: false,
+      sensitiveTransaction: true,
+      biometricOnly: false,
+    ),
+  );
+  ```
+
+
 
 ## 1.1.11
 

packages/local_auth/local_auth/example/lib/main.dart

@@ -79,9 +79,12 @@ class _MyAppState extends State<MyApp> {
         _authorized = 'Authenticating';
       });
       authenticated = await auth.authenticate(
-          localizedReason: 'Let OS determine authentication method',
+        localizedReason: 'Let OS determine authentication method',
+        options: const AuthenticationOptions(
           useErrorDialogs: true,
-          stickyAuth: true);
+          stickyAuth: true,
+        ),
+      );
       setState(() {
         _isAuthenticating = false;
       });
@@ -109,11 +112,14 @@ class _MyAppState extends State<MyApp> {
         _authorized = 'Authenticating';
       });
       authenticated = await auth.authenticate(
-          localizedReason:
-              'Scan your fingerprint (or face or whatever) to authenticate',
+        localizedReason:
+            'Scan your fingerprint (or face or whatever) to authenticate',
+        options: const AuthenticationOptions(
           useErrorDialogs: true,
           stickyAuth: true,
-          biometricOnly: true);
+          biometricOnly: true,
+        ),
+      );
       setState(() {
         _isAuthenticating = false;
         _authorized = 'Authenticating';

packages/local_auth/local_auth/lib/auth_strings.dart

@@ -2,144 +2,8 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-// This is a temporary ignore to allow us to land a new set of linter rules in a
-// series of manageable patches instead of one gigantic PR. It disables some of
-// the new lints that are already failing on this plugin, for this plugin. It
-// should be deleted and the failing lints addressed as soon as possible.
-// ignore_for_file: public_member_api_docs
-
-import 'dart:async';
-
-import 'package:flutter/foundation.dart' show visibleForTesting;
-import 'package:flutter/services.dart';
-import 'package:local_auth_platform_interface/local_auth_platform_interface.dart';
-import 'package:platform/platform.dart';
-import 'auth_strings.dart';
-
-export 'package:local_auth_platform_interface/types/biometric_type.dart';
-
-Platform _platform = const LocalPlatform();
-
-@visibleForTesting
-void setMockPathProviderPlatform(Platform platform) {
-  _platform = platform;
-}
-
-/// A Flutter plugin for authenticating the user identity locally.
-class LocalAuthentication {
-  /// The `authenticateWithBiometrics` method has been deprecated.
-  /// Use `authenticate` with `biometricOnly: true` instead.
-  @Deprecated('Use `authenticate` with `biometricOnly: true` instead')
-  Future<bool> authenticateWithBiometrics({
-    required String localizedReason,
-    bool useErrorDialogs = true,
-    bool stickyAuth = false,
-    AndroidAuthMessages androidAuthStrings = const AndroidAuthMessages(),
-    IOSAuthMessages iOSAuthStrings = const IOSAuthMessages(),
-    bool sensitiveTransaction = true,
-  }) =>
-      LocalAuthPlatform.instance.authenticate(
-        localizedReason: localizedReason,
-        authMessages: <AuthMessages>[iOSAuthStrings, androidAuthStrings],
-        options: AuthenticationOptions(
-          useErrorDialogs: useErrorDialogs,
-          stickyAuth: stickyAuth,
-          sensitiveTransaction: sensitiveTransaction,
-          biometricOnly: true,
-        ),
-      );
-
-  /// Authenticates the user with biometrics available on the device while also
-  /// allowing the user to use device authentication - pin, pattern, passcode.
-  ///
-  /// Returns true, if the user successfully authenticated, false otherwise.
-  ///
-  /// [localizedReason] is the message to show to user while prompting them
-  /// for authentication. This is typically along the lines of: 'Please scan
-  /// your finger to access MyApp.'. This must not be empty.
-  ///
-  /// [useErrorDialogs] = true means the system will attempt to handle user
-  /// fixable issues encountered while authenticating. For instance, if
-  /// fingerprint reader exists on the phone but there's no fingerprint
-  /// registered, the plugin will attempt to take the user to settings to add
-  /// one. Anything that is not user fixable, such as no biometric sensor on
-  /// device, will be returned as a [PlatformException].
-  ///
-  /// [stickyAuth] is used when the application goes into background for any
-  /// reason while the authentication is in progress. Due to security reasons,
-  /// the authentication has to be stopped at that time. If stickyAuth is set
-  /// to true, authentication resumes when the app is resumed. If it is set to
-  /// false (default), then as soon as app is paused a failure message is sent
-  /// back to Dart and it is up to the client app to restart authentication or
-  /// do something else.
-  ///
-  /// Construct [AndroidAuthStrings] and [IOSAuthStrings] if you want to
-  /// customize messages in the dialogs.
-  ///
-  /// Setting [sensitiveTransaction] to true enables platform specific
-  /// precautions. For instance, on face unlock, Android opens a confirmation
-  /// dialog after the face is recognized to make sure the user meant to unlock
-  /// their phone.
-  ///
-  /// Setting [biometricOnly] to true prevents authenticates from using non-biometric
-  /// local authentication such as pin, passcode, and passcode.
-  ///
-  /// Throws an [PlatformException] if there were technical problems with local
-  /// authentication (e.g. lack of relevant hardware). This might throw
-  /// [PlatformException] with error code [otherOperatingSystem] on the iOS
-  /// simulator.
-  Future<bool> authenticate({
-    required String localizedReason,
-    bool useErrorDialogs = true,
-    bool stickyAuth = false,
-    AndroidAuthMessages androidAuthStrings = const AndroidAuthMessages(),
-    IOSAuthMessages iOSAuthStrings = const IOSAuthMessages(),
-    bool sensitiveTransaction = true,
-    bool biometricOnly = false,
-  }) {
-    return LocalAuthPlatform.instance.authenticate(
-      localizedReason: localizedReason,
-      authMessages: <AuthMessages>[iOSAuthStrings, androidAuthStrings],
-      options: AuthenticationOptions(
-        useErrorDialogs: useErrorDialogs,
-        stickyAuth: stickyAuth,
-        sensitiveTransaction: sensitiveTransaction,
-        biometricOnly: biometricOnly,
-      ),
-    );
-  }
-
-  /// Returns true if auth was cancelled successfully.
-  /// This api only works for Android.
-  /// Returns false if there was some error or no auth in progress.
-  ///
-  /// Returns [Future] bool true or false:
-  Future<bool> stopAuthentication() async {
-    if (_platform.isAndroid) {
-      return LocalAuthPlatform.instance.stopAuthentication();
-    }
-    return true;
-  }
-
-  /// Returns true if device is capable of checking biometrics
-  ///
-  /// Returns a [Future] bool true or false:
-  Future<bool> get canCheckBiometrics =>
-      LocalAuthPlatform.instance.deviceSupportsBiometrics();
-
-  /// Returns true if device is capable of checking biometrics or is able to
-  /// fail over to device credentials.
-  ///
-  /// Returns a [Future] bool true or false:
-  Future<bool> isDeviceSupported() async =>
-      LocalAuthPlatform.instance.isDeviceSupported();
-
-  /// Returns a list of enrolled biometrics
-  ///
-  /// Returns a [Future] List<BiometricType> with the following possibilities:
-  /// - BiometricType.face
-  /// - BiometricType.fingerprint
-  /// - BiometricType.iris (not yet implemented)
-  Future<List<BiometricType>> getAvailableBiometrics() =>
-      LocalAuthPlatform.instance.getEnrolledBiometrics();
-}
+export 'package:local_auth/src/local_auth.dart' show LocalAuthentication;
+export 'package:local_auth_platform_interface/types/auth_options.dart'
+    show AuthenticationOptions;
+export 'package:local_auth_platform_interface/types/biometric_type.dart'
+    show BiometricType;