Merge branch 'main' into authentication-validity-73

.github/workflows/dart.yml

@@ -5,7 +5,7 @@ on: [push]
 jobs:
   test:
 
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
 
     steps:
     - uses: actions/checkout@v1
@@ -35,9 +35,9 @@ jobs:
       fail-fast: false
       matrix:
         buildcommand: [linux]
-        os: [ubuntu-20.04]
+        os: [ubuntu-22.04]
         exclude:
-          - os: ubuntu-20.04
+          - os: ubuntu-22.04
             buildcommand: linux
         include:
 #          No macos build for now, have to configure code signing..
@@ -61,10 +61,11 @@ jobs:
       - uses: subosito/flutter-action@v2
         with:
           channel: 'stable' # or: 'dev' or 'beta'
-      - uses: actions/setup-java@v1
+      - uses: actions/setup-java@v3
         if: matrix.buildcommand == 'appbundle'
         with:
-          java-version: '12.x'
+          java-version: '17'
+          distribution: 'oracle'
       - name: Patch for linux build
         if: matrix.buildcommand == 'linux'
         run: |

CHANGELOG.md

@@ -1,10 +1,31 @@
-## unreleased
+## 5.0.1
+
+* Add option for iOS/MacOS to allow non-biometric authentication (`darwinBiometricOnly`) #101
+  * Improve [canAuthenticate] to differentiate between no available biometry and no available 
+    user code.
+* Bump dart sdk requirement to `3.2`.
+
+## 5.0.0+4
+
+* Add topics to pubspec.yaml
+
+## 5.0.0+3
+
+* Android: Upgrade AGP, fix building with AGP 8
+* Android: Depend on slf4j-api.
+
+## 5.0.0+1
+
+* MacOS: fix building on MacOS
+
+## 5.0.0
 
 * Allow overriding of `promptInfo` during `read`/`write` thanks @luckyrat
 * Android: (POTENTIALLY BREAKING): Completely removed deprecated old file backend 
   based on `androidx.security`. This was deprecated since version 3.0.0 and users 
   should have been migrated on every read or write. (this is only internally, does not change
   anything of the API).
+* Update dependencies.
 
 ## 4.1.3
 

README.md

@@ -30,29 +30,33 @@ makes heavy use of this plugin.
     * `android/build.gradle`: `ext.kotlin_version = '1.4.31'`
   * MainActivity must extend FlutterFragmentActivity
   * Theme for the main activity must use `Theme.AppCompat` thme.
-    (Otherwise there will be crases on Android < 29)
+    (Otherwise there will be crashes on Android < 29)
     For example: 
 
-    **AndroidManifest.xml**:
+    **android/app/src/main/AndroidManifest.xml**:
     ```xml
     <activity
-    android:name=".MainActivity"
-    android:launchMode="singleTop"
-    android:theme="@style/LaunchTheme"
+        android:name=".MainActivity"
+        android:launchMode="singleTop"
+        android:theme="@style/LaunchTheme">
+        [...]
+        <meta-data
+              android:name="io.flutter.embedding.android.NormalTheme"
+              android:resource="@style/NormalTheme"
+              />
+    </activity>
     ```
 
-    **xml/styles.xml**:
+    **android/app/src/main/res/values/styles.xml**:
     ```xml
-        <style name="LaunchTheme" parent="Theme.AppCompat.NoActionBar">
-        <!-- Show a splash screen on the activity. Automatically removed when
-             Flutter draws its first frame -->
-        <item name="android:windowBackground">@drawable/launch_background</item>
-
-        <item name="android:windowNoTitle">true</item>
-        <item name="android:windowActionBar">false</item>
-        <item name="android:windowFullscreen">true</item>
-        <item name="android:windowContentOverlay">@null</item>
-    </style>
+    <resources>
+      <style name="LaunchTheme" parent="Theme.AppCompat.NoActionBar">
+        ...
+      </style>
+      <style name="NormalTheme" parent="Theme.AppCompat.NoActionBar">
+        ...
+      </style>
+    </resources>
     ```
 
 ##### Resources
@@ -65,7 +69,7 @@ makes heavy use of this plugin.
 https://developer.apple.com/documentation/localauthentication/logging_a_user_into_your_app_with_face_id_or_touch_id
 
 * include the NSFaceIDUsageDescription key in your app’s Info.plist file
-* Requires at least iOS 9
+* Supports all iOS versions supported by Flutter. (ie. iOS 12)
 
 **Known Issue**: since iOS 15 the simulator seem to no longer support local authentication:
     https://developer.apple.com/forums/thread/685773
@@ -76,7 +80,7 @@ https://developer.apple.com/documentation/localauthentication/logging_a_user_int
 * enable keychain sharing and signing. (not sure why this is required. but without it
     You will probably see an error like: 
     > SecurityError, Error while writing data: -34018: A required entitlement isn't present.
-* Requires at least Mac OS 10.12
+* Supports all MacOS Versions supported by Flutter (ie. >= MacOS 10.14)
 
 ### Usage
 

analysis_options.yaml

@@ -1,12 +1,6 @@
-# Defines a default set of lint rules enforced for
-# projects at Google. For details and rationale,
-# see https://github.com/dart-lang/pedantic#enabled-lints.
-include: package:lints/recommended.yaml
+include: package:flutter_lints/flutter.yaml
 
 analyzer:
-  strong-mode:
-    implicit-casts: false
-    implicit-dynamic: false
   errors:
     # treat missing required parameters as a warning (not a hint)
     missing_required_param: warning
@@ -17,159 +11,9 @@ analyzer:
   exclude:
     - lib/generated_plugin_registrant.dart
     - example/lib/generated_plugin_registrant.dart
+  language:
+    strict-casts: true
+    strict-raw-types: true
 
 linter:
   rules:
-    # these rules are documented on and in the same order as
-    # the Dart Lint rules page to make maintenance easier
-    # http://dart-lang.github.io/linter/lints/
-
-    # HP mostly in sync with https://github.com/flutter/flutter/blob/master/analysis_options.yaml
-
-    - always_declare_return_types
-    - always_put_control_body_on_new_line
-    # - always_put_required_named_parameters_first # we prefer having parameters in the same order as fields https://github.com/flutter/flutter/issues/10219
-    - always_require_non_null_named_parameters
-    #- always_specify_types
-    - annotate_overrides
-    # - avoid_annotating_with_dynamic # not yet tested
-    # - avoid_as
-    - avoid_bool_literals_in_conditional_expressions
-    # - avoid_catches_without_on_clauses # not yet tested
-    # - avoid_catching_errors # not yet tested
-    # - avoid_classes_with_only_static_members # not yet tested
-    # - avoid_double_and_int_checks # only useful when targeting JS runtime
-    - avoid_empty_else
-    - avoid_field_initializers_in_const_classes
-    - avoid_function_literals_in_foreach_calls
-    # - avoid_implementing_value_types # not yet tested
-    - avoid_init_to_null
-    # - avoid_js_rounded_ints # only useful when targeting JS runtime
-    - avoid_null_checks_in_equality_operators
-    # - avoid_positional_boolean_parameters # not yet tested
-    # - avoid_private_typedef_functions # we prefer having typedef (discussion in https://github.com/flutter/flutter/pull/16356)
-    - avoid_relative_lib_imports
-    - avoid_renaming_method_parameters
-    - avoid_return_types_on_setters
-    # - avoid_returning_null # not yet tested
-    # - avoid_returning_null_for_future # not yet tested
-    - avoid_returning_null_for_void
-    # - avoid_returning_this # not yet tested
-    # - avoid_setters_without_getters # not yet tested
-    # - avoid_shadowing_type_parameters # not yet tested
-    # - avoid_single_cascade_in_expression_statements # not yet tested
-    - avoid_slow_async_io
-    - avoid_types_as_parameter_names
-    # - avoid_types_on_closure_parameters # not yet tested
-    - avoid_unused_constructor_parameters
-    - avoid_void_async
-    - await_only_futures
-    - camel_case_types
-    - cancel_subscriptions
-    # - cascade_invocations # not yet tested
-    # - close_sinks # not reliable enough
-    # - comment_references # blocked on https://github.com/flutter/flutter/issues/20765
-    # - constant_identifier_names # https://github.com/dart-lang/linter/issues/204
-    - control_flow_in_finally
-    - curly_braces_in_flow_control_structures
-    # - diagnostic_describe_all_properties # not yet tested
-    - directives_ordering
-    - empty_catches
-    - empty_constructor_bodies
-    - empty_statements
-    # - file_names # not yet tested
-    # - flutter_style_todos TODO(HP)
-    - hash_and_equals
-    - implementation_imports
-    # - invariant_booleans # too many false positives: https://github.com/dart-lang/linter/issues/811
-    - iterable_contains_unrelated_type
-    # - join_return_with_assignment # not yet tested
-    - library_names
-    - library_prefixes
-    # - lines_longer_than_80_chars # not yet tested
-    - list_remove_unrelated_type
-    # - literal_only_boolean_expressions # too many false positives: https://github.com/dart-lang/sdk/issues/34181
-    - no_adjacent_strings_in_list
-    - no_duplicate_case_values
-    - non_constant_identifier_names
-    # - null_closures  # not yet tested
-    # - omit_local_variable_types # opposite of always_specify_types
-    # - one_member_abstracts # too many false positives
-    # - only_throw_errors # https://github.com/flutter/flutter/issues/5792
-    - overridden_fields
-    - package_api_docs
-    - package_names
-    - package_prefixed_library_names
-    # - parameter_assignments # we do this commonly
-    - prefer_adjacent_string_concatenation
-    - prefer_asserts_in_initializer_lists
-    # - prefer_asserts_with_message # not yet tested
-    - prefer_collection_literals
-    - prefer_conditional_assignment
-    - prefer_const_constructors
-    - prefer_const_constructors_in_immutables
-    - prefer_const_declarations
-    - prefer_const_literals_to_create_immutables
-    # - prefer_constructors_over_static_methods # not yet tested
-    - prefer_contains
-    # - prefer_double_quotes # opposite of prefer_single_quotes
-    - prefer_equal_for_default_values
-    # - prefer_expression_function_bodies # conflicts with https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo#consider-using--for-short-functions-and-methods
-    - prefer_final_fields
-    # - prefer_final_in_for_each # not yet tested
-    - prefer_final_locals
-    # - prefer_for_elements_to_map_fromIterable # not yet tested
-    - prefer_foreach
-    # - prefer_function_declarations_over_variables # not yet tested
-    - prefer_generic_function_type_aliases
-    # - prefer_if_elements_to_conditional_expressions # not yet tested
-    - prefer_if_null_operators
-    - prefer_initializing_formals
-    - prefer_inlined_adds
-    # - prefer_int_literals # not yet tested
-    # - prefer_interpolation_to_compose_strings # not yet tested
-    - prefer_is_empty
-    - prefer_is_not_empty
-    - prefer_iterable_whereType
-    # - prefer_mixin # https://github.com/dart-lang/language/issues/32
-    # - prefer_null_aware_operators # disable until NNBD, see https://github.com/flutter/flutter/pull/32711#issuecomment-492930932
-    - prefer_single_quotes
-    - prefer_spread_collections
-    - prefer_typing_uninitialized_variables
-    - prefer_void_to_null
-    # - provide_deprecation_message # not yet tested
-    # - public_member_api_docs # enabled on a case-by-case basis; see e.g. packages/analysis_options.yaml
-    - recursive_getters
-    - slash_for_doc_comments
-    # - sort_child_properties_last # not yet tested
-    - sort_constructors_first
-    #- sort_pub_dependencies
-    - sort_unnamed_constructors_first
-    - test_types_in_equals
-    - throw_in_finally
-    # - type_annotate_public_apis # subset of always_specify_types
-    - type_init_formals
-    # - unawaited_futures # https://github.com/flutter/flutter/issues/5793
-    # - unnecessary_await_in_return # not yet tested
-    - unnecessary_brace_in_string_interps
-    - unnecessary_const
-    - unnecessary_getters_setters
-    # - unnecessary_lambdas # https://github.com/dart-lang/linter/issues/498
-    - unnecessary_new
-    - unnecessary_null_aware_assignments
-    - unnecessary_null_in_if_null_operators
-    - unnecessary_overrides
-    #- unnecessary_parenthesis HP: I like parenthesis :-)
-    - unnecessary_statements
-    - unnecessary_this
-    - unrelated_type_equality_checks
-    # - unsafe_html # not yet tested
-    - use_full_hex_values_for_flutter_colors
-    # - use_function_type_syntax_for_parameters # not yet tested
-    - use_rethrow_when_possible
-    # - use_setters_to_change_properties # not yet tested
-    # - use_string_buffers # https://github.com/dart-lang/linter/pull/664
-    # - use_to_and_as_if_applicable # has false positives, so we prefer to catch this by code-review
-    - valid_regexps
-  # - void_checks # not yet tested
-

android/build.gradle

@@ -2,14 +2,14 @@ group 'design.codeux.biometric_storage'
 version '1.0-SNAPSHOT'
 
 buildscript {
-    ext.kotlin_version = '1.7.0'
+    ext.kotlin_version = '1.8.10'
     repositories {
         google()
         mavenCentral()
     }
 
     dependencies {
-        classpath 'com.android.tools.build:gradle:7.1.3'
+        classpath 'com.android.tools.build:gradle:8.1.0'
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
     }
 }
@@ -25,8 +25,13 @@ apply plugin: 'com.android.library'
 apply plugin: 'kotlin-android'
 apply plugin: 'kotlin-kapt'
 
+kotlin {
+    jvmToolchain(17)
+}
+
 android {
-    compileSdkVersion 31
+    namespace "design.codeux.biometric_storage"
+    compileSdk 31
 
     sourceSets {
         main.java.srcDirs += 'src/main/kotlin'
@@ -42,12 +47,12 @@ android {
 }
 
 dependencies {
-    def biometric_version = "1.2.0-alpha04"
+    def biometric_version = "1.2.0-alpha05"
 
-    api "androidx.core:core-ktx:1.8.0"
-    api "androidx.fragment:fragment-ktx:1.5.0"
+    api "androidx.core:core-ktx:1.10.1"
+    api "androidx.fragment:fragment-ktx:1.6.1"
 
-    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
+    implementation "org.slf4j:slf4j-api:2.0.7"
     implementation "androidx.biometric:biometric:$biometric_version"
-    implementation "io.github.microutils:kotlin-logging:1.7.6"
+    implementation "io.github.oshai:kotlin-logging-jvm:5.0.1"
 }

android/src/main/AndroidManifest.xml

@@ -1,5 +1,4 @@
-<manifest xmlns:android="http://schemas.android.com/apk/res/android"
-  package="design.codeux.biometric_storage">
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
 
     <!--suppress DeprecatedClassUsageInspection -->
     <uses-permission android:name="android.permission.USE_FINGERPRINT" />

android/src/main/kotlin/design/codeux/biometric_storage/BiometricStorageFile.kt

@@ -4,7 +4,7 @@ import android.content.Context
 import android.content.pm.PackageManager
 import android.os.Build
 import android.security.keystore.KeyProperties
-import mu.KotlinLogging
+import io.github.oshai.kotlinlogging.KotlinLogging
 import java.io.File
 import java.io.IOException
 import javax.crypto.Cipher