[webview_flutter_android] Set support for web authentication

packages/webview_flutter/webview_flutter_android/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 4.14.0
+* Adds support for configuring Web Authentication in `AndroidWebViewController` with `setWebAuthenticationSupport` to enable Passkey and other related Authentication.
+
 ## 4.13.0
 
 * Adds new method for accessing a native `WebView` from a `FlutterPluginBinding`.

packages/webview_flutter/webview_flutter_android/README.md

@@ -84,6 +84,34 @@ Add intent filters to your AndroidManifest.xml to discover and invoke Android pa
 </queries>
 ```
 
+## Enable Web Authentication in WebView
+
+WebAuthentication (WebAuthn) can be configured by calling
+`AndroidWebViewController.setWebAuthenticationSupport` after checking
+`AndroidWebViewController.isWebViewFeatureSupported`.
+
+The WebAuthentication support level can be set to one of three values:
+- **[WebAuthenticationSupport.none]**: Disables all WebAuthn requests
+- **[WebAuthenticationSupport.forApp]**: Allows WebAuthn for the embedded application (default)
+- **[WebAuthenticationSupport.forBrowser]**: Allows WebAuthn for any website (browser-like behavior)
+
+<?code-excerpt "example/lib/readme_excerpts.dart (web_authentication_example)"?>
+```dart
+final bool webAuthenticationSupported = await androidController
+    .isWebViewFeatureSupported(WebViewFeatureType.webAuthentication);
+
+if (webAuthenticationSupported) {
+  // Enable WebAuthn for the embedded app
+  await androidController.setWebAuthenticationSupport(
+    WebAuthenticationSupport.forApp,
+  );
+  // Or for browser-like behavior supporting any website:
+  // await androidController.setWebAuthenticationSupport(
+  //   WebAuthenticationSupport.forBrowser,
+  // );
+}
+```
+
 ## Fullscreen Video
 
 To display a video as fullscreen, an app must manually handle the notification that the current page

packages/webview_flutter/webview_flutter_android/android/src/main/java/io/flutter/plugins/webviewflutter/AndroidWebkitLibrary.g.kt

@@ -6826,6 +6826,8 @@ abstract class PigeonApiWebSettingsCompat(
 ) {
   abstract fun setPaymentRequestEnabled(webSettings: android.webkit.WebSettings, enabled: Boolean)
 
+  abstract fun setWebAuthenticationSupport(webSettings: android.webkit.WebSettings, support: Long)
+
   companion object {
     @Suppress("LocalVariableName")
     fun setUpMessageHandlers(binaryMessenger: BinaryMessenger, api: PigeonApiWebSettingsCompat?) {
@@ -6854,6 +6856,30 @@ abstract class PigeonApiWebSettingsCompat(
           channel.setMessageHandler(null)
         }
       }
+      run {
+        val channel =
+            BasicMessageChannel<Any?>(
+                binaryMessenger,
+                "dev.flutter.pigeon.webview_flutter_android.WebSettingsCompat.setWebAuthenticationSupport",
+                codec)
+        if (api != null) {
+          channel.setMessageHandler { message, reply ->
+            val args = message as List<Any?>
+            val webSettingsArg = args[0] as android.webkit.WebSettings
+            val supportArg = args[1] as Long
+            val wrapped: List<Any?> =
+                try {
+                  api.setWebAuthenticationSupport(webSettingsArg, supportArg)
+                  listOf(null)
+                } catch (exception: Throwable) {
+                  AndroidWebkitLibraryPigeonUtils.wrapError(exception)
+                }
+            reply.reply(wrapped)
+          }
+        } else {
+          channel.setMessageHandler(null)
+        }
+      }
     }
   }
 

packages/webview_flutter/webview_flutter_android/android/src/main/java/io/flutter/plugins/webviewflutter/WebSettingsCompatProxyApi.java

@@ -29,4 +29,28 @@ public WebSettingsCompatProxyApi(@NonNull ProxyApiRegistrar pigeonRegistrar) {
   public void setPaymentRequestEnabled(@NonNull WebSettings webSettings, boolean enabled) {
     WebSettingsCompat.setPaymentRequestEnabled(webSettings, enabled);
   }
+
+  /**
+   * This method should only be called if {@link WebViewFeatureProxyApi#isFeatureSupported(String)}
+   * with WEB_AUTHENTICATION returns true.
+   *
+   * <p>The {@code support} parameter is a {@code long} to accommodate Dart's integer type, but is
+   * safely converted to {@code int} for the underlying Android API call. {@link
+   * Math#toIntExact(long)} is used to verify the value fits in the {@code int} range and throw
+   * {@link ArithmeticException} if it overflows. This is safe because the valid support levels are
+   * constants (0, 1, 2) that well within the integer range.
+   *
+   * <p>Note: {@link Math#toIntExact(long)} requires API level 24 or higher. This is compatible with
+   * this plugin's minimum SDK version.
+   *
+   * @param webSettings the WebSettings instance
+   * @param support the WebAuthentication support level (0, 1, or 2)
+   * @throws ArithmeticException if {@code support} exceeds {@link Integer#MAX_VALUE}
+   */
+  @SuppressLint("RequiresFeature")
+  @Override
+  public void setWebAuthenticationSupport(@NonNull WebSettings webSettings, long support) {
+    final int supportValue = Math.toIntExact(support);
+    WebSettingsCompat.setWebAuthenticationSupport(webSettings, supportValue);
+  }
 }

packages/webview_flutter/webview_flutter_android/android/src/test/java/io/flutter/plugins/webviewflutter/WebSettingsCompatTest.java

@@ -4,6 +4,7 @@
 
 package io.flutter.plugins.webviewflutter;
 
+import static org.junit.Assert.assertThrows;
 import static org.junit.Assert.fail;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.mockStatic;
@@ -36,4 +37,38 @@ public void setPaymentRequestEnabled() {
       fail(e.toString());
     }
   }
+
+  @Test
+  public void setWebAuthenticationSupport() {
+    final PigeonApiWebSettingsCompat api =
+        new TestProxyApiRegistrar().getPigeonApiWebSettingsCompat();
+
+    final WebSettings webSettings = mock(WebSettings.class);
+
+    try (MockedStatic<WebSettingsCompat> mockedStatic = mockStatic(WebSettingsCompat.class);
+        MockedStatic<WebViewFeature> mockedWebViewFeature = mockStatic(WebViewFeature.class)) {
+      mockedWebViewFeature
+          .when(() -> WebViewFeature.isFeatureSupported(WebViewFeature.WEB_AUTHENTICATION))
+          .thenReturn(true);
+      api.setWebAuthenticationSupport(webSettings, 2L);
+      mockedStatic.verify(() -> WebSettingsCompat.setWebAuthenticationSupport(webSettings, 2));
+    }
+  }
+
+  @Test
+  public void setWebAuthenticationSupportWithLongOutsideIntRangeThrows() {
+    final PigeonApiWebSettingsCompat api =
+        new TestProxyApiRegistrar().getPigeonApiWebSettingsCompat();
+
+    final WebSettings webSettings = mock(WebSettings.class);
+
+    try (MockedStatic<WebViewFeature> mockedWebViewFeature = mockStatic(WebViewFeature.class)) {
+      mockedWebViewFeature
+          .when(() -> WebViewFeature.isFeatureSupported(WebViewFeature.WEB_AUTHENTICATION))
+          .thenReturn(true);
+      assertThrows(
+          ArithmeticException.class,
+          () -> api.setWebAuthenticationSupport(webSettings, Integer.MAX_VALUE + 1L));
+    }
+  }
 }

packages/webview_flutter/webview_flutter_android/example/integration_test/webview_flutter_test_legacy.dart

@@ -101,26 +101,28 @@ Future<void> main() async {
     );
   });
 
-  testWidgets('withWeakRefenceTo allows encapsulating class to be garbage collected', (
-    WidgetTester tester,
-  ) async {
-    final gcCompleter = Completer<int>();
-    final instanceManager = android.PigeonInstanceManager(
-      onWeakReferenceRemoved: gcCompleter.complete,
-    );
+  testWidgets(
+    'withWeakRefenceTo allows encapsulating class to be garbage collected',
+    (WidgetTester tester) async {
+      final gcCompleter = Completer<int>();
+      final instanceManager = android.PigeonInstanceManager(
+        onWeakReferenceRemoved: gcCompleter.complete,
+      );
 
-    ClassWithCallbackClass? instance = ClassWithCallbackClass();
-    instanceManager.addHostCreatedInstance(instance.callbackClass, 0);
-    instance = null;
+      ClassWithCallbackClass? instance = ClassWithCallbackClass();
+      instanceManager.addHostCreatedInstance(instance.callbackClass, 0);
+      instance = null;
 
-    // Force garbage collection.
-    await IntegrationTestWidgetsFlutterBinding.instance.watchPerformance(() async {
-      await tester.pumpAndSettle();
-    });
+      // Force garbage collection.
+      await IntegrationTestWidgetsFlutterBinding.instance.watchPerformance(() async {
+        await tester.pumpAndSettle();
+      });
 
-    final int gcIdentifier = await gcCompleter.future;
-    expect(gcIdentifier, 0);
-  }, timeout: const Timeout(Duration(seconds: 10)));
+      final int gcIdentifier = await gcCompleter.future;
+      expect(gcIdentifier, 0);
+    },
+    timeout: const Timeout(Duration(seconds: 10)),
+  );
 
   // TODO(bparrishMines): This test is skipped because of
   // https://github.com/flutter/flutter/issues/123327

packages/webview_flutter/webview_flutter_android/example/lib/main.dart

@@ -329,6 +329,7 @@ enum MenuOptions {
   videoExample,
   logExample,
   basicAuthentication,
+  webAuthentication,
   javaScriptAlert,
   viewportMeta,
 }
@@ -383,6 +384,8 @@ class SampleMenu extends StatelessWidget {
             _onLogExample();
           case MenuOptions.basicAuthentication:
             _promptForUrl(context);
+          case MenuOptions.webAuthentication:
+            _onWebAuthenticationExample(context);
           case MenuOptions.javaScriptAlert:
             _onJavaScriptAlertExample(context);
           case MenuOptions.viewportMeta:
@@ -443,6 +446,10 @@ class SampleMenu extends StatelessWidget {
           value: MenuOptions.basicAuthentication,
           child: Text('Basic Authentication Example'),
         ),
+        const PopupMenuItem<MenuOptions>(
+          value: MenuOptions.webAuthentication,
+          child: Text('Web Authentication Example'),
+        ),
         const PopupMenuItem<MenuOptions>(
           value: MenuOptions.javaScriptAlert,
           child: Text('JavaScript Alert Example'),
@@ -564,6 +571,30 @@ class SampleMenu extends StatelessWidget {
     );
   }
 
+  Future<void> _onWebAuthenticationExample(BuildContext context) async {
+    final androidController = webViewController as AndroidWebViewController;
+    final bool supported = await androidController.isWebViewFeatureSupported(
+      WebViewFeatureType.webAuthentication,
+    );
+
+    if (!supported) {
+      if (context.mounted) {
+        ScaffoldMessenger.of(context).showSnackBar(
+          const SnackBar(content: Text('Web Authentication is not supported on this device.')),
+        );
+      }
+      return;
+    }
+
+    await androidController.setWebAuthenticationSupport(WebAuthenticationSupport.forApp);
+
+    if (context.mounted) {
+      ScaffoldMessenger.of(
+        context,
+      ).showSnackBar(const SnackBar(content: Text('Web Authentication enabled.')));
+    }
+  }
+
   Future<void> _onDoPostRequest() {
     return webViewController.loadRequest(
       LoadRequestParams(

packages/webview_flutter/webview_flutter_android/example/lib/readme_excerpts.dart

@@ -20,6 +20,26 @@ Future<void> enablePaymentRequest() async {
   // #enddocregion payment_request_example
 }
 
+/// Example function for README demonstration of Web Authentication support.
+Future<void> enableWebAuthentication() async {
+  final controller = PlatformWebViewController(AndroidWebViewControllerCreationParams());
+  final androidController = controller as AndroidWebViewController;
+  // #docregion web_authentication_example
+  final bool webAuthenticationSupported = await androidController.isWebViewFeatureSupported(
+    WebViewFeatureType.webAuthentication,
+  );
+
+  if (webAuthenticationSupported) {
+    // Enable WebAuthn for the embedded app
+    await androidController.setWebAuthenticationSupport(WebAuthenticationSupport.forApp);
+    // Or for browser-like behavior supporting any website:
+    // await androidController.setWebAuthenticationSupport(
+    //   WebAuthenticationSupport.forBrowser,
+    // );
+  }
+  // #enddocregion web_authentication_example
+}
+
 /// Example function for README demonstration of geolocation permissions for
 /// a use case where the content is always trusted (for example, it only shows
 /// content from a domain controlled by the app developer) and geolocation

packages/webview_flutter/webview_flutter_android/lib/src/android_webkit.g.dart

@@ -217,6 +217,9 @@ class PigeonOverrides {
   /// Overrides [WebSettingsCompat.setPaymentRequestEnabled].
   static Future<void> Function(WebSettings, bool)? webSettingsCompat_setPaymentRequestEnabled;
 
+  /// Overrides [WebSettingsCompat.setWebAuthenticationSupport].
+  static Future<void> Function(WebSettings, int)? webSettingsCompat_setWebAuthenticationSupport;
+
   /// Overrides [WebViewFeature.isFeatureSupported].
   static Future<bool> Function(String)? webViewFeature_isFeatureSupported;
 
@@ -232,6 +235,7 @@ class PigeonOverrides {
     flutterAssetManager_instance = null;
     webStorage_instance = null;
     webSettingsCompat_setPaymentRequestEnabled = null;
+    webSettingsCompat_setWebAuthenticationSupport = null;
     webViewFeature_isFeatureSupported = null;
   }
 }
@@ -7188,6 +7192,35 @@ class WebSettingsCompat extends PigeonInternalProxyApiBaseClass {
     _extractReplyValueOrThrow(pigeonVar_replyList, pigeonVar_channelName, isNullValid: true);
   }
 
+  static Future<void> setWebAuthenticationSupport(
+    WebSettings webSettings,
+    int support, {
+    BinaryMessenger? pigeon_binaryMessenger,
+    PigeonInstanceManager? pigeon_instanceManager,
+  }) async {
+    if (PigeonOverrides.webSettingsCompat_setWebAuthenticationSupport != null) {
+      return PigeonOverrides.webSettingsCompat_setWebAuthenticationSupport!(webSettings, support);
+    }
+    final _PigeonInternalProxyApiBaseCodec pigeonChannelCodec = _PigeonInternalProxyApiBaseCodec(
+      pigeon_instanceManager ?? PigeonInstanceManager.instance,
+    );
+    final BinaryMessenger? pigeonVar_binaryMessenger = pigeon_binaryMessenger;
+    const pigeonVar_channelName =
+        'dev.flutter.pigeon.webview_flutter_android.WebSettingsCompat.setWebAuthenticationSupport';
+    final pigeonVar_channel = BasicMessageChannel<Object?>(
+      pigeonVar_channelName,
+      pigeonChannelCodec,
+      binaryMessenger: pigeonVar_binaryMessenger,
+    );
+    final Future<Object?> pigeonVar_sendFuture = pigeonVar_channel.send(<Object?>[
+      webSettings,
+      support,
+    ]);
+    final pigeonVar_replyList = await pigeonVar_sendFuture as List<Object?>?;
+
+    _extractReplyValueOrThrow(pigeonVar_replyList, pigeonVar_channelName, isNullValid: true);
+  }
+
   @override
   WebSettingsCompat pigeon_copy() {
     return WebSettingsCompat.pigeon_detached(

packages/webview_flutter/webview_flutter_android/lib/src/android_webkit_constants.dart

@@ -126,4 +126,9 @@ class WebViewFeatureConstants {
   ///
   /// See https://developer.android.com/reference/androidx/webkit/WebViewFeature#PAYMENT_REQUEST.
   static const String paymentRequest = 'PAYMENT_REQUEST';
+
+  /// This feature covers [WebSettingsCompat.setWebAuthenticationSupport].
+  ///
+  /// See https://developer.android.com/reference/androidx/webkit/WebViewFeature#WEB_AUTHENTICATION.
+  static const String webAuthentication = 'WEB_AUTHENTICATION';
 }