flet-local-auth 1.0.0.dev2__tar.gz

flet_local_auth-1.0.0.dev2/LICENSE

@@ -0,0 +1,3 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/

flet_local_auth-1.0.0.dev2/PKG-INFO

@@ -0,0 +1,18 @@
+Metadata-Version: 2.4
+Name: flet-local-auth
+Version: 1.0.0.dev2
+Summary: Local authentication service for Flet
+Author-email: "Appveyor Systems Inc." <hello@flet.dev>
+Project-URL: Homepage, https://flet.dev
+Project-URL: Documentation, https://flet.dev/docs/services/localauthentication
+Project-URL: Repository, https://github.com/flet-dev/flet/tree/main/sdk/python/packages/flet-local-auth
+Project-URL: Issues, https://github.com/flet-dev/flet/issues
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: flet==1.0.0.dev2
+Dynamic: license-file
+
+# Flet Local Authentication
+
+`LocalAuthentication` service for Flet apps. Authenticate users with biometrics, PIN, passcode, or pattern via the [`local_auth`](https://pub.dev/packages/local_auth) Flutter plugin.

flet_local_auth-1.0.0.dev2/README.md

@@ -0,0 +1,3 @@
+# Flet Local Authentication
+
+`LocalAuthentication` service for Flet apps. Authenticate users with biometrics, PIN, passcode, or pattern via the [`local_auth`](https://pub.dev/packages/local_auth) Flutter plugin.

flet_local_auth-1.0.0.dev2/pyproject.toml

@@ -0,0 +1,26 @@
+[project]
+name = "flet-local-auth"
+version = "1.0.0.dev2"
+description = "Local authentication service for Flet"
+authors = [{name = "Appveyor Systems Inc.", email = "hello@flet.dev"}]
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "flet==1.0.0.dev2",
+]
+
+[project.urls]
+Homepage = "https://flet.dev"
+Documentation = "https://flet.dev/docs/services/localauthentication"
+Repository = "https://github.com/flet-dev/flet/tree/main/sdk/python/packages/flet-local-auth"
+Issues = "https://github.com/flet-dev/flet/issues"
+
+[tool.setuptools.package-data]
+"flutter.flet_local_auth" = [
+    "pubspec.yaml",
+    "lib/**",
+]
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"

flet_local_auth-1.0.0.dev2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

flet_local_auth-1.0.0.dev2/src/flet_local_auth/__init__.py

@@ -0,0 +1,19 @@
+from flet_local_auth.local_auth import LocalAuthentication
+from flet_local_auth.types import (
+    AndroidAuthMessages,
+    BiometricType,
+    IOSAuthMessages,
+    LocalAuthErrorCode,
+    LocalAuthException,
+    WindowsAuthMessages,
+)
+
+__all__ = [
+    "AndroidAuthMessages",
+    "BiometricType",
+    "IOSAuthMessages",
+    "LocalAuthErrorCode",
+    "LocalAuthentication",
+    "LocalAuthException",
+    "WindowsAuthMessages",
+]

flet_local_auth-1.0.0.dev2/src/flet_local_auth/local_auth.py

@@ -0,0 +1,134 @@
+from typing import Optional
+
+import flet as ft
+from flet.controls.base_control import control
+from flet.controls.services.service import Service
+from flet_local_auth.types import (
+    AndroidAuthMessages,
+    BiometricType,
+    IOSAuthMessages,
+    LocalAuthErrorCode,
+    LocalAuthException,
+    WindowsAuthMessages,
+)
+
+__all__ = [
+    "AndroidAuthMessages",
+    "BiometricType",
+    "IOSAuthMessages",
+    "LocalAuthErrorCode",
+    "LocalAuthentication",
+    "LocalAuthException",
+    "WindowsAuthMessages",
+]
+
+
+@control("LocalAuthentication")
+class LocalAuthentication(Service):
+    """
+    Authenticates the user with on-device biometrics or device credentials.
+
+    Danger: Platform support
+        Supported on Android, iOS, macOS, and Windows. Not supported on Linux or Web.
+
+    Raises:
+        FletUnsupportedPlatformException: If the platform is not supported.
+        LocalAuthException: If authentication fails.
+    """
+
+    def before_update(self):
+        super().before_update()
+
+        if self.page.web or self.page.platform == ft.PagePlatform.LINUX:
+            raise ft.FletUnsupportedPlatformException(
+                "LocalAuthentication is not supported on Linux or Web platforms."
+            )
+
+    async def is_device_supported(self) -> bool:
+        """
+        Returns whether the device can authenticate with biometrics or credentials.
+        """
+        return await self._invoke_method("is_device_supported")
+
+    async def can_check_biometrics(self) -> bool:
+        """
+        Returns whether the device has biometric hardware available.
+        """
+        return await self._invoke_method("can_check_biometrics")
+
+    async def get_available_biometrics(self) -> list[BiometricType]:
+        """
+        Returns the biometrics currently enrolled on the device.
+        """
+        result = await self._invoke_method("get_available_biometrics")
+        return [BiometricType(value) for value in result or []]
+
+    async def authenticate(
+        self,
+        reason: str,
+        *,
+        biometric_only: bool = False,
+        sensitive_transaction: bool = True,
+        persist_across_backgrounding: bool = False,
+        android_messages: Optional[AndroidAuthMessages] = None,
+        ios_messages: Optional[IOSAuthMessages] = None,
+        windows_messages: Optional[WindowsAuthMessages] = None,
+    ) -> bool:
+        """
+        Prompts the user to authenticate locally.
+
+        Args:
+            reason: The message shown in the system authentication dialog.
+            biometric_only: Whether to allow only biometric authentication.
+            sensitive_transaction: Whether to treat the transaction as sensitive.
+            persist_across_backgrounding: Whether to retry after the app is
+                foregrounded again if authentication was interrupted.
+            android_messages: Optional Android dialog customization.
+            ios_messages: Optional iOS dialog customization.
+            windows_messages: Optional Windows dialog customization.
+
+        Returns:
+            `True` when authentication succeeds.
+
+        Raises:
+            LocalAuthException: If authentication fails or is canceled.
+        """
+        result = await self._invoke_method(
+            method_name="authenticate",
+            arguments={
+                "reason": reason,
+                "biometric_only": biometric_only,
+                "sensitive_transaction": sensitive_transaction,
+                "persist_across_backgrounding": persist_across_backgrounding,
+                "android_messages": android_messages,
+                "ios_messages": ios_messages,
+                "windows_messages": windows_messages,
+            },
+        )
+        self._raise_for_error(result)
+        return bool(result)
+
+    async def stop_authentication(self) -> bool:
+        """
+        Cancels any in-progress authentication prompt.
+
+        Returns:
+            `True` if authentication was canceled successfully.
+        """
+        return await self._invoke_method("stop_authentication")
+
+    @staticmethod
+    def _raise_for_error(result: object) -> None:
+        if not isinstance(result, dict) or "error_code" not in result:
+            return
+
+        code_value = result.get("error_code")
+        try:
+            code = LocalAuthErrorCode(code_value)
+        except ValueError:
+            code = LocalAuthErrorCode.UNKNOWN_ERROR
+
+        raise LocalAuthException(
+            code=code,
+            description=result.get("error_description"),
+        )

flet_local_auth-1.0.0.dev2/src/flet_local_auth/types.py

@@ -0,0 +1,85 @@
+from enum import Enum
+from typing import Optional
+
+import flet as ft
+
+
+class BiometricType(Enum):
+    """
+    Biometric types reported by the device.
+    """
+
+    FACE = "face"
+    FINGERPRINT = "fingerprint"
+    IRIS = "iris"
+    WEAK = "weak"
+    STRONG = "strong"
+
+
+class LocalAuthErrorCode(Enum):
+    """
+    Error codes reported by local authentication failures.
+    """
+
+    AUTH_IN_PROGRESS = "authInProgress"
+    UI_UNAVAILABLE = "uiUnavailable"
+    USER_CANCELED = "userCanceled"
+    TIMEOUT = "timeout"
+    SYSTEM_CANCELED = "systemCanceled"
+    NO_CREDENTIALS_SET = "noCredentialsSet"
+    NO_BIOMETRICS_ENROLLED = "noBiometricsEnrolled"
+    NO_BIOMETRIC_HARDWARE = "noBiometricHardware"
+    BIOMETRIC_HARDWARE_TEMPORARILY_UNAVAILABLE = (
+        "biometricHardwareTemporarilyUnavailable"
+    )
+    TEMPORARY_LOCKOUT = "temporaryLockout"
+    BIOMETRIC_LOCKOUT = "biometricLockout"
+    USER_REQUESTED_FALLBACK = "userRequestedFallback"
+    DEVICE_ERROR = "deviceError"
+    UNKNOWN_ERROR = "unknownError"
+
+
+@ft.value
+class AndroidAuthMessages:
+    """
+    Customizable Android authentication dialog strings.
+    """
+
+    sign_in_hint: Optional[str] = None
+    cancel_button: Optional[str] = None
+    sign_in_title: Optional[str] = None
+
+
+@ft.value
+class IOSAuthMessages:
+    """
+    Customizable iOS authentication dialog strings.
+    """
+
+    cancel_button: Optional[str] = None
+    localized_fallback_title: Optional[str] = None
+
+
+@ft.value
+class WindowsAuthMessages:
+    """
+    Placeholder for Windows authentication messages.
+
+    `local_auth` 3.x does not currently expose customizable Windows dialog strings.
+    """
+
+
+class LocalAuthException(ft.FletException):
+    """
+    Raised when local authentication fails.
+    """
+
+    def __init__(
+        self,
+        code: LocalAuthErrorCode,
+        description: Optional[str] = None,
+    ):
+        self.code = code
+        self.description = description
+        message = description or code.value
+        super().__init__(message)

flet_local_auth-1.0.0.dev2/src/flet_local_auth.egg-info/PKG-INFO

@@ -0,0 +1,18 @@
+Metadata-Version: 2.4
+Name: flet-local-auth
+Version: 1.0.0.dev2
+Summary: Local authentication service for Flet
+Author-email: "Appveyor Systems Inc." <hello@flet.dev>
+Project-URL: Homepage, https://flet.dev
+Project-URL: Documentation, https://flet.dev/docs/services/localauthentication
+Project-URL: Repository, https://github.com/flet-dev/flet/tree/main/sdk/python/packages/flet-local-auth
+Project-URL: Issues, https://github.com/flet-dev/flet/issues
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: flet==1.0.0.dev2
+Dynamic: license-file
+
+# Flet Local Authentication
+
+`LocalAuthentication` service for Flet apps. Authenticate users with biometrics, PIN, passcode, or pattern via the [`local_auth`](https://pub.dev/packages/local_auth) Flutter plugin.

flet_local_auth-1.0.0.dev2/src/flet_local_auth.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+LICENSE
+README.md
+pyproject.toml
+src/flet_local_auth/__init__.py
+src/flet_local_auth/local_auth.py
+src/flet_local_auth/types.py
+src/flet_local_auth.egg-info/PKG-INFO
+src/flet_local_auth.egg-info/SOURCES.txt
+src/flet_local_auth.egg-info/dependency_links.txt
+src/flet_local_auth.egg-info/requires.txt
+src/flet_local_auth.egg-info/top_level.txt
+src/flutter/flet_local_auth/pubspec.yaml
+src/flutter/flet_local_auth/lib/flet_local_auth.dart
+src/flutter/flet_local_auth/lib/src/extension.dart
+src/flutter/flet_local_auth/lib/src/local_auth.dart
+src/flutter/flet_local_auth/lib/src/utils/local_auth.dart

flet_local_auth-1.0.0.dev2/src/flet_local_auth.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

flet_local_auth-1.0.0.dev2/src/flet_local_auth.egg-info/requires.txt

@@ -0,0 +1 @@
+flet==1.0.0.dev2

flet_local_auth-1.0.0.dev2/src/flet_local_auth.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+flet_local_auth
+flutter

flet_local_auth-1.0.0.dev2/src/flutter/flet_local_auth/lib/flet_local_auth.dart

@@ -0,0 +1,3 @@
+library flet_local_auth;
+
+export "src/extension.dart" show Extension;

flet_local_auth-1.0.0.dev2/src/flutter/flet_local_auth/lib/src/extension.dart

@@ -0,0 +1,15 @@
+import 'package:flet/flet.dart';
+
+import 'local_auth.dart';
+
+class Extension extends FletExtension {
+  @override
+  FletService? createService(Control control) {
+    switch (control.type) {
+      case "LocalAuthentication":
+        return LocalAuthenticationService(control: control);
+      default:
+        return null;
+    }
+  }
+}

flet_local_auth-1.0.0.dev2/src/flutter/flet_local_auth/lib/src/local_auth.dart

@@ -0,0 +1,59 @@
+import 'package:flet/flet.dart';
+import 'package:flutter/material.dart';
+import 'package:local_auth/local_auth.dart';
+
+import 'utils/local_auth.dart';
+
+class LocalAuthenticationService extends FletService {
+  LocalAuthenticationService({required super.control});
+
+  final LocalAuthentication _auth = LocalAuthentication();
+
+  @override
+  void init() {
+    super.init();
+    debugPrint(
+      "LocalAuthenticationService(${control.id}).init: ${control.properties}",
+    );
+    control.addInvokeMethodListener(_invokeMethod);
+  }
+
+  Future<dynamic> _invokeMethod(String name, dynamic args) async {
+    debugPrint("LocalAuthentication.$name($args)");
+    switch (name) {
+      case "is_device_supported":
+        return await _auth.isDeviceSupported();
+      case "can_check_biometrics":
+        return await _auth.canCheckBiometrics;
+      case "get_available_biometrics":
+        return (await _auth.getAvailableBiometrics())
+            .map(parseBiometricTypeName)
+            .toList();
+      case "authenticate":
+        try {
+          return await _auth.authenticate(
+            localizedReason: args["reason"]!,
+            authMessages: parseAuthMessages(args),
+            biometricOnly: args["biometric_only"] as bool? ?? false,
+            sensitiveTransaction:
+                args["sensitive_transaction"] as bool? ?? true,
+            persistAcrossBackgrounding:
+                args["persist_across_backgrounding"] as bool? ?? false,
+          );
+        } on LocalAuthException catch (e) {
+          return localAuthErrorMap(e);
+        }
+      case "stop_authentication":
+        return await _auth.stopAuthentication();
+      default:
+        throw Exception("Unknown LocalAuthentication method: $name");
+    }
+  }
+
+  @override
+  void dispose() {
+    debugPrint("LocalAuthenticationService(${control.id}).dispose()");
+    control.removeInvokeMethodListener(_invokeMethod);
+    super.dispose();
+  }
+}

flet_local_auth-1.0.0.dev2/src/flutter/flet_local_auth/lib/src/utils/local_auth.dart

@@ -0,0 +1,81 @@
+import 'package:local_auth/local_auth.dart';
+import 'package:local_auth_android/local_auth_android.dart';
+import 'package:local_auth_darwin/local_auth_darwin.dart';
+import 'package:local_auth_windows/local_auth_windows.dart';
+
+AndroidAuthMessages? parseAndroidAuthMessages(Map? value) {
+  if (value == null) {
+    return null;
+  }
+  return AndroidAuthMessages(
+    signInHint: value["sign_in_hint"],
+    cancelButton: value["cancel_button"],
+    signInTitle: value["sign_in_title"],
+  );
+}
+
+IOSAuthMessages? parseIosAuthMessages(Map? value) {
+  if (value == null) {
+    return null;
+  }
+  return IOSAuthMessages(
+    cancelButton: value["cancel_button"],
+    localizedFallbackTitle: value["localized_fallback_title"],
+  );
+}
+
+WindowsAuthMessages? parseWindowsAuthMessages(Map? value) {
+  if (value == null) {
+    return null;
+  }
+  return const WindowsAuthMessages();
+}
+
+List<AuthMessages> parseAuthMessages(
+  Map? args, {
+  List<AuthMessages> defaults = const [
+    IOSAuthMessages(),
+    AndroidAuthMessages(),
+    WindowsAuthMessages(),
+  ],
+}) {
+  final android = parseAndroidAuthMessages(args?["android_messages"]);
+  final ios = parseIosAuthMessages(args?["ios_messages"]);
+  final windows = parseWindowsAuthMessages(args?["windows_messages"]);
+
+  if (android == null && ios == null && windows == null) {
+    return defaults;
+  }
+
+  final messages = <AuthMessages>[];
+  for (final message in defaults) {
+    if (message is AndroidAuthMessages) {
+      messages.add(android ?? message);
+    } else if (message is IOSAuthMessages) {
+      messages.add(ios ?? message);
+    } else if (message is WindowsAuthMessages) {
+      messages.add(windows ?? message);
+    } else {
+      messages.add(message);
+    }
+  }
+  return messages;
+}
+
+String? parseBiometricTypeName(BiometricType type) {
+  return type.name;
+}
+
+LocalAuthExceptionCode parseLocalAuthExceptionCode(String? value) {
+  return LocalAuthExceptionCode.values.firstWhere(
+    (code) => code.name == value,
+    orElse: () => LocalAuthExceptionCode.unknownError,
+  );
+}
+
+Map<String, Object?> localAuthErrorMap(LocalAuthException exception) {
+  return {
+    "error_code": exception.code.name,
+    "error_description": exception.description,
+  };
+}

flet_local_auth-1.0.0.dev2/src/flutter/flet_local_auth/pubspec.yaml

@@ -0,0 +1,25 @@
+name: flet_local_auth
+description: Flet Local Authentication service
+version: 0.1.0
+publish_to: none
+
+environment:
+  sdk: '>=3.3.0 <4.0.0'
+  flutter: ">=1.17.0"
+
+dependencies:
+  flutter:
+    sdk: flutter
+
+  local_auth: 3.0.2
+  local_auth_android: 2.0.9
+  local_auth_darwin: 2.0.3
+  local_auth_windows: 2.0.1
+
+  flet:
+    path: ../../../../../../../packages/flet
+
+dev_dependencies:
+  flutter_test:
+    sdk: flutter
+  flutter_lints: ^3.0.0