feat(mobile): add biometric plugin (#829)

* chore: update deps, make mobile script paths relative

* feat(biometric): setup plugin folder

* feat: implement iOS

* add api

* android

* fix plugin name

* also check empty info.plist entry

* add example

* fix android

* supress

* lint

* better explanation

* add partners & contributed by

* change ext

* license headers

* update vite

* add covector setup

* tauri/dox removed

* add example

* docs

---------

Co-authored-by: Lucas Nogueira <lucas@tauri.app>

plugins/biometric/ios/.gitignore

@@ -0,0 +1,10 @@
+.DS_Store
+/.build
+/Packages
+/*.xcodeproj
+xcuserdata/
+DerivedData/
+.swiftpm/config/registries.json
+.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
+.netrc
+Package.resolved

plugins/biometric/ios/Package.swift

@@ -0,0 +1,33 @@
+// swift-tools-version:5.3
+// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+import PackageDescription
+
+let package = Package(
+  name: "tauri-plugin-biometric",
+  platforms: [
+    .iOS(.v13)
+  ],
+  products: [
+    // Products define the executables and libraries a package produces, and make them visible to other packages.
+    .library(
+      name: "tauri-plugin-biometric",
+      type: .static,
+      targets: ["tauri-plugin-biometric"])
+  ],
+  dependencies: [
+    .package(name: "Tauri", path: "../.tauri/tauri-api")
+  ],
+  targets: [
+    // Targets are the basic building blocks of a package. A target can define a module or a test suite.
+    // Targets can depend on other targets in this package, and on products in packages this package depends on.
+    .target(
+      name: "tauri-plugin-biometric",
+      dependencies: [
+        .byName(name: "Tauri")
+      ],
+      path: "Sources")
+  ]
+)

plugins/biometric/ios/README.md

@@ -0,0 +1,3 @@
+# Tauri Plugin {{ plugin_name_original }}
+
+A description of this package.

plugins/biometric/ios/Sources/BiometricPlugin.swift

@@ -0,0 +1,152 @@
+// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+import LocalAuthentication
+import SwiftRs
+import Tauri
+import UIKit
+import WebKit
+
+class BiometricStatus {
+  let available: Bool
+  let biometryType: LABiometryType
+  let errorReason: String?
+  let errorCode: String?
+
+  init(available: Bool, biometryType: LABiometryType, errorReason: String?, errorCode: String?) {
+    self.available = available
+    self.biometryType = biometryType
+    self.errorReason = errorReason
+    self.errorCode = errorCode
+  }
+}
+
+struct AuthOptions: Decodable {
+  let reason: String
+  var allowDeviceCredential: Bool?
+  let fallbackTitle: String?
+  let cancelTitle: String?
+}
+
+class BiometricPlugin: Plugin {
+  let authenticationErrorCodeMap: [Int: String] = [
+    0: "",
+    LAError.appCancel.rawValue: "appCancel",
+    LAError.authenticationFailed.rawValue: "authenticationFailed",
+    LAError.invalidContext.rawValue: "invalidContext",
+    LAError.notInteractive.rawValue: "notInteractive",
+    LAError.passcodeNotSet.rawValue: "passcodeNotSet",
+    LAError.systemCancel.rawValue: "systemCancel",
+    LAError.userCancel.rawValue: "userCancel",
+    LAError.userFallback.rawValue: "userFallback",
+    LAError.biometryLockout.rawValue: "biometryLockout",
+    LAError.biometryNotAvailable.rawValue: "biometryNotAvailable",
+    LAError.biometryNotEnrolled.rawValue: "biometryNotEnrolled",
+  ]
+
+  var status: BiometricStatus!
+
+  public override func load(webview: WKWebView) {
+    let context = LAContext()
+    var error: NSError?
+    var available = context.canEvaluatePolicy(
+      .deviceOwnerAuthenticationWithBiometrics, error: &error)
+    var reason: String? = nil
+    var errorCode: String? = nil
+
+    if available && context.biometryType == .faceID {
+      let entry = Bundle.main.infoDictionary?["NSFaceIDUsageDescription"] as? String
+
+      if entry == nil || entry?.count == 0 {
+        available = false
+        reason = "NSFaceIDUsageDescription is not in the app Info.plist"
+        errorCode = authenticationErrorCodeMap[LAError.biometryNotAvailable.rawValue] ?? ""
+      }
+    } else if !available, let error = error {
+      reason = error.localizedDescription
+      if let failureReason = error.localizedFailureReason {
+        reason = "\(reason ?? ""): \(failureReason)"
+      }
+      errorCode =
+        authenticationErrorCodeMap[error.code] ?? authenticationErrorCodeMap[
+          LAError.biometryNotAvailable.rawValue] ?? ""
+    }
+
+    self.status = BiometricStatus(
+      available: available,
+      biometryType: context.biometryType,
+      errorReason: reason,
+      errorCode: errorCode
+    )
+  }
+
+  @objc func status(_ invoke: Invoke) {
+    if self.status.available {
+      invoke.resolve([
+        "isAvailable": self.status.available,
+        "biometryType": self.status.biometryType.rawValue,
+      ])
+    } else {
+      invoke.resolve([
+        "isAvailable": self.status.available,
+        "biometryType": self.status.biometryType.rawValue,
+        "error": self.status.errorReason ?? "",
+        "errorCode": self.status.errorCode ?? "",
+      ])
+    }
+  }
+
+  @objc func authenticate(_ invoke: Invoke) throws {
+    guard self.status.available else {
+      invoke.reject(
+        self.status.errorReason ?? "",
+        code: self.status.errorCode ?? ""
+      )
+      return
+    }
+
+    let args = try invoke.parseArgs(AuthOptions.self)
+
+    let context = LAContext()
+    context.localizedFallbackTitle = args.fallbackTitle
+    context.localizedCancelTitle = args.cancelTitle
+    context.touchIDAuthenticationAllowableReuseDuration = 0
+
+    let allowDeviceCredential = args.allowDeviceCredential ?? false
+
+    // force system default fallback title if an empty string is provided (the OS hides the fallback button in this case)
+    if allowDeviceCredential,
+      let fallbackTitle = context.localizedFallbackTitle,
+      fallbackTitle.isEmpty
+    {
+      context.localizedFallbackTitle = nil
+    }
+
+    context.evaluatePolicy(
+      allowDeviceCredential
+        ? .deviceOwnerAuthentication : .deviceOwnerAuthenticationWithBiometrics,
+      localizedReason: args.reason
+    ) { success, error in
+      if success {
+        invoke.resolve()
+      } else {
+        if let policyError = error as? LAError {
+          let code = self.authenticationErrorCodeMap[policyError.code.rawValue]
+          invoke.reject(policyError.localizedDescription, code: code)
+        } else {
+          invoke.reject(
+            "Unknown error",
+            code: self.authenticationErrorCodeMap[LAError.authenticationFailed.rawValue]
+          )
+        }
+      }
+    }
+
+  }
+}
+
+@_cdecl("init_plugin_biometric")
+func initPlugin() -> Plugin {
+  return BiometricPlugin()
+}

plugins/biometric/ios/Tests/PluginTests/PluginTests.swift

@@ -0,0 +1,12 @@
+// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
+// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
+
+import XCTest
+@testable import ExamplePlugin
+
+final class ExamplePluginTests: XCTestCase {
+    func testExample() throws {
+        let plugin = ExamplePlugin()
+    }
+}