Implement http basic auth

packages/webview_flutter/webview_flutter/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 4.5.0
+
+* Adds support for HTTP basic authentication. See `NavigationDelegate(onReceivedHttpAuthRequest)`.
+
 ## 4.4.1
 
 * Exposes `JavaScriptLogLevel` from platform interface.

packages/webview_flutter/webview_flutter/example/integration_test/webview_flutter_test.dart

@@ -32,6 +32,15 @@ Future<void> main() async {
       request.response.writeln('${request.headers}');
     } else if (request.uri.path == '/favicon.ico') {
       request.response.statusCode = HttpStatus.notFound;
+    } else if (request.uri.path == '/http-basic-authentication') {
+      final bool isAuthenticating = request.headers['Authorization'] != null;
+      if (isAuthenticating) {
+        request.response.writeln('Authorized');
+      } else {
+        request.response.headers
+            .add('WWW-Authenticate', 'Basic realm="Test realm"');
+        request.response.statusCode = HttpStatus.unauthorized;
+      }
     } else {
       fail('unexpected request: ${request.method} ${request.uri}');
     }
@@ -41,6 +50,7 @@ Future<void> main() async {
   final String primaryUrl = '$prefixUrl/hello.txt';
   final String secondaryUrl = '$prefixUrl/secondary.txt';
   final String headersUrl = '$prefixUrl/headers';
+  final String basicAuthUrl = '$prefixUrl/http-basic-authentication';
 
   testWidgets('loadRequest', (WidgetTester tester) async {
     final Completer<void> pageFinished = Completer<void>();
@@ -49,12 +59,9 @@ Future<void> main() async {
     unawaited(controller.setNavigationDelegate(
       NavigationDelegate(onPageFinished: (_) => pageFinished.complete()),
     ));
-    unawaited(controller.loadRequest(Uri.parse(primaryUrl)));
-
     await tester.pumpWidget(WebViewWidget(controller: controller));
-
+    unawaited(controller.loadRequest(Uri.parse(primaryUrl)));
     await pageFinished.future;
-
     final String? currentUrl = await controller.currentUrl();
     expect(currentUrl, primaryUrl);
   });
@@ -761,6 +768,49 @@ Future<void> main() async {
 
       await expectLater(urlChangeCompleter.future, completion(secondaryUrl));
     });
+
+    testWidgets('can receive HTTP basic auth requests',
+        (WidgetTester tester) async {
+      final Completer<void> authRequested = Completer<void>();
+      final WebViewController controller = WebViewController();
+
+      unawaited(
+        controller.setNavigationDelegate(
+          NavigationDelegate(
+            onHttpBasicAuthRequest: (HttpBasicAuthRequest request) =>
+                authRequested.complete(),
+          ),
+        ),
+      );
+
+      await tester.pumpWidget(WebViewWidget(controller: controller));
+
+      unawaited(controller.loadRequest(Uri.parse(basicAuthUrl)));
+
+      await expectLater(authRequested.future, completes);
+    });
+
+    testWidgets('can reply to HTTP basic auth requests',
+        (WidgetTester tester) async {
+      final WebViewController controller = WebViewController();
+      final Completer<void> pageFinished = Completer<void>();
+
+      unawaited(
+        controller.setNavigationDelegate(
+          NavigationDelegate(
+            onHttpBasicAuthRequest: (HttpBasicAuthRequest request) =>
+                request.onProceed('user', 'pass'),
+            onPageFinished: (_) => pageFinished.complete(),
+          ),
+        ),
+      );
+
+      await tester.pumpWidget(WebViewWidget(controller: controller));
+
+      unawaited(controller.loadRequest(Uri.parse(basicAuthUrl)));
+
+      await expectLater(pageFinished.future, completes);
+    });
   });
 
   testWidgets('target _blank opens in same window',

packages/webview_flutter/webview_flutter/example/ios/Runner.xcodeproj/project.pbxproj

@@ -274,7 +274,7 @@
 			isa = PBXProject;
 			attributes = {
 				DefaultBuildSystemTypeForWorkspace = Original;
-				LastUpgradeCheck = 1300;
+				LastUpgradeCheck = 1430;
 				ORGANIZATIONNAME = "The Flutter Authors";
 				TargetAttributes = {
 					68BDCAE823C3F7CB00D9C032 = {

packages/webview_flutter/webview_flutter/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1300"
+   LastUpgradeVersion = "1430"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"

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

@@ -129,7 +129,6 @@ class _WebViewExampleState extends State<WebViewExample> {
     if (WebViewPlatform.instance is WebKitWebViewPlatform) {
       params = WebKitWebViewControllerCreationParams(
         allowsInlineMediaPlayback: true,
-        mediaTypesRequiringUserAction: const <PlaybackMediaTypes>{},
       );
     } else {
       params = const PlatformWebViewControllerCreationParams();
@@ -173,6 +172,11 @@ Page resource error:
           onUrlChange: (UrlChange change) {
             debugPrint('url change to ${change.url}');
           },
+          onHttpBasicAuthRequest: (HttpBasicAuthRequest request) {
+            debugPrint(
+                'HTTP basic auth request with host ${request.host} and realm ${request.realm}');
+            openDialog(request);
+          },
         ),
       )
       ..addJavaScriptChannel(
@@ -226,6 +230,60 @@ Page resource error:
       child: const Icon(Icons.favorite),
     );
   }
+
+  Future<void> openDialog(HttpBasicAuthRequest httpRequest) async {
+    final TextEditingController usernameTextController =
+        TextEditingController();
+    final TextEditingController passwordTextController =
+        TextEditingController();
+
+    return showDialog(
+      context: context,
+      barrierDismissible: false,
+      builder: (BuildContext context) {
+        return AlertDialog(
+          title: Text('${httpRequest.host}: ${httpRequest.realm}'),
+          content: SingleChildScrollView(
+            child: Column(
+              mainAxisSize: MainAxisSize.min,
+              children: <Widget>[
+                TextField(
+                  decoration: const InputDecoration(labelText: 'Username'),
+                  autofocus: true,
+                  controller: usernameTextController,
+                ),
+                TextField(
+                  decoration: const InputDecoration(labelText: 'Password'),
+                  controller: passwordTextController,
+                ),
+              ],
+            ),
+          ),
+          actions: <Widget>[
+            // Explicitly cancel the request on iOS as the OS does not emit new
+            // requests when a previous request is pending.
+            TextButton(
+              onPressed: () {
+                httpRequest.onCancel();
+                Navigator.of(context).pop();
+              },
+              child: const Text('Cancel'),
+            ),
+            TextButton(
+              onPressed: () {
+                httpRequest.onProceed(
+                  usernameTextController.text,
+                  passwordTextController.text,
+                );
+                Navigator.of(context).pop();
+              },
+              child: const Text('Authenticate'),
+            ),
+          ],
+        );
+      },
+    );
+  }
 }
 
 enum MenuOptions {
@@ -243,6 +301,7 @@ enum MenuOptions {
   transparentBackground,
   setCookie,
   logExample,
+  basicAuthentication,
 }
 
 class SampleMenu extends StatelessWidget {
@@ -302,6 +361,9 @@ class SampleMenu extends StatelessWidget {
           case MenuOptions.logExample:
             _onLogExample();
             break;
+          case MenuOptions.basicAuthentication:
+            _basicAuthExample();
+            break;
         }
       },
       itemBuilder: (BuildContext context) => <PopupMenuItem<MenuOptions>>[
@@ -362,6 +424,10 @@ class SampleMenu extends StatelessWidget {
           value: MenuOptions.logExample,
           child: Text('Log example'),
         ),
+        const PopupMenuItem<MenuOptions>(
+          value: MenuOptions.basicAuthentication,
+          child: Text('Basic Authentication Example'),
+        ),
       ],
     );
   }
@@ -515,6 +581,11 @@ class SampleMenu extends StatelessWidget {
 
     return webViewController.loadHtmlString(kLogExamplePage);
   }
+
+  Future<void> _basicAuthExample() {
+    return webViewController.loadRequest(Uri.parse(
+        'https://www.httpwatch.com/httpgallery/authentication/#showExample10'));
+  }
 }
 
 class NavigationControls extends StatelessWidget {

packages/webview_flutter/webview_flutter/example/pubspec.yaml

@@ -36,3 +36,8 @@ flutter:
     - assets/sample_video.mp4
     - assets/www/index.html
     - assets/www/styles/style.css
+
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#changing-federated-plugins
+dependency_overrides:
+   {webview_flutter_android: {path: ../../../webview_flutter/webview_flutter_android}, webview_flutter_platform_interface: {path: ../../../webview_flutter/webview_flutter_platform_interface}, webview_flutter_wkwebview: {path: ../../../webview_flutter/webview_flutter_wkwebview}}

packages/webview_flutter/webview_flutter/example/test/main_test.dart

@@ -116,4 +116,9 @@ class FakeNavigationDelegate extends PlatformNavigationDelegate {
 
   @override
   Future<void> setOnUrlChange(UrlChangeCallback onUrlChange) async {}
+
+  @override
+  Future<void> setOnHttpBasicAuthRequest(
+    HttpAuthRequestCallback handler,
+  ) async {}
 }

packages/webview_flutter/webview_flutter/lib/src/navigation_delegate.dart

@@ -48,6 +48,7 @@ class NavigationDelegate {
     void Function(int progress)? onProgress,
     void Function(WebResourceError error)? onWebResourceError,
     void Function(UrlChange change)? onUrlChange,
+    void Function(HttpBasicAuthRequest request)? onHttpBasicAuthRequest,
   }) : this.fromPlatformCreationParams(
           const PlatformNavigationDelegateCreationParams(),
           onNavigationRequest: onNavigationRequest,
@@ -56,6 +57,7 @@ class NavigationDelegate {
           onProgress: onProgress,
           onWebResourceError: onWebResourceError,
           onUrlChange: onUrlChange,
+          onHttpBasicAuthRequest: onHttpBasicAuthRequest,
         );
 
   /// Constructs a [NavigationDelegate] from creation params for a specific
@@ -98,6 +100,7 @@ class NavigationDelegate {
     void Function(int progress)? onProgress,
     void Function(WebResourceError error)? onWebResourceError,
     void Function(UrlChange change)? onUrlChange,
+    void Function(HttpBasicAuthRequest request)? onHttpBasicAuthRequest,
   }) : this.fromPlatform(
           PlatformNavigationDelegate(params),
           onNavigationRequest: onNavigationRequest,
@@ -106,6 +109,7 @@ class NavigationDelegate {
           onProgress: onProgress,
           onWebResourceError: onWebResourceError,
           onUrlChange: onUrlChange,
+          onHttpBasicAuthRequest: onHttpBasicAuthRequest,
         );
 
   /// Constructs a [NavigationDelegate] from a specific platform implementation.
@@ -119,6 +123,7 @@ class NavigationDelegate {
     this.onProgress,
     this.onWebResourceError,
     void Function(UrlChange change)? onUrlChange,
+    this.onHttpBasicAuthRequest,
   }) {
     if (onNavigationRequest != null) {
       platform.setOnNavigationRequest(onNavigationRequest!);
@@ -138,6 +143,9 @@ class NavigationDelegate {
     if (onUrlChange != null) {
       platform.setOnUrlChange(onUrlChange);
     }
+    if (onHttpBasicAuthRequest != null) {
+      platform.setOnHttpBasicAuthRequest(onHttpBasicAuthRequest!);
+    }
   }
 
   /// Implementation of [PlatformNavigationDelegate] for the current platform.
@@ -166,4 +174,7 @@ class NavigationDelegate {
 
   /// Invoked when a resource loading error occurred.
   final WebResourceErrorCallback? onWebResourceError;
+
+  /// Invoked when a resource required HTTP basic authentication.
+  final HttpAuthRequestCallback? onHttpBasicAuthRequest;
 }

packages/webview_flutter/webview_flutter/lib/webview_flutter.dart

@@ -6,6 +6,7 @@ library webview_flutter;
 
 export 'package:webview_flutter_platform_interface/webview_flutter_platform_interface.dart'
     show
+        HttpBasicAuthRequest,
         JavaScriptConsoleMessage,
         JavaScriptLogLevel,
         JavaScriptMessage,

packages/webview_flutter/webview_flutter/pubspec.yaml

@@ -2,7 +2,7 @@ name: webview_flutter
 description: A Flutter plugin that provides a WebView widget on Android and iOS.
 repository: https://github.com/flutter/packages/tree/main/packages/webview_flutter/webview_flutter
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+webview%22
-version: 4.4.1
+version: 4.5.0
 
 environment:
   sdk: ">=2.19.0 <4.0.0"
@@ -20,7 +20,7 @@ dependencies:
   flutter:
     sdk: flutter
   webview_flutter_android: ^3.12.0
-  webview_flutter_platform_interface: ^2.6.0
+  webview_flutter_platform_interface: ^2.7.0
   webview_flutter_wkwebview: ^3.9.0
 
 dev_dependencies:
@@ -34,3 +34,8 @@ topics:
   - html
   - webview
   - webview-flutter
+
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/wiki/Contributing-to-Plugins-and-Packages#changing-federated-plugins
+dependency_overrides:
+   {webview_flutter_android: {path: ../../webview_flutter/webview_flutter_android}, webview_flutter_platform_interface: {path: ../../webview_flutter/webview_flutter_platform_interface}, webview_flutter_wkwebview: {path: ../../webview_flutter/webview_flutter_wkwebview}}

packages/webview_flutter/webview_flutter/test/navigation_delegate_test.dart

@@ -87,6 +87,19 @@ void main() {
 
       verify(delegate.platform.setOnUrlChange(onUrlChange));
     });
+
+    test('onHttpBasicAuthRequest', () {
+      WebViewPlatform.instance = TestWebViewPlatform();
+
+      void onHttpBasicAuthRequest(HttpBasicAuthRequest request) {}
+
+      final NavigationDelegate delegate = NavigationDelegate(
+        onHttpBasicAuthRequest: onHttpBasicAuthRequest,
+      );
+
+      verify(
+          delegate.platform.setOnHttpBasicAuthRequest(onHttpBasicAuthRequest));
+    });
   });
 }
 

packages/webview_flutter/webview_flutter/test/navigation_delegate_test.mocks.dart

@@ -250,4 +250,15 @@ class MockPlatformNavigationDelegate extends _i1.Mock
         returnValue: _i8.Future<void>.value(),
         returnValueForMissingStub: _i8.Future<void>.value(),
       ) as _i8.Future<void>);
+  @override
+  _i8.Future<void> setOnHttpBasicAuthRequest(
+          _i3.HttpAuthRequestCallback? onHttpAuthRequest) =>
+      (super.noSuchMethod(
+        Invocation.method(
+          #setOnHttpBasicAuthRequest,
+          [onHttpAuthRequest],
+        ),
+        returnValue: _i8.Future<void>.value(),
+        returnValueForMissingStub: _i8.Future<void>.value(),
+      ) as _i8.Future<void>);
 }

packages/webview_flutter/webview_flutter/test/webview_controller_test.mocks.dart

@@ -466,4 +466,15 @@ class MockPlatformNavigationDelegate extends _i1.Mock
         returnValue: _i5.Future<void>.value(),
         returnValueForMissingStub: _i5.Future<void>.value(),
       ) as _i5.Future<void>);
+  @override
+  _i5.Future<void> setOnHttpBasicAuthRequest(
+          _i6.HttpAuthRequestCallback? onHttpAuthRequest) =>
+      (super.noSuchMethod(
+        Invocation.method(
+          #setOnHttpBasicAuthRequest,
+          [onHttpAuthRequest],
+        ),
+        returnValue: _i5.Future<void>.value(),
+        returnValueForMissingStub: _i5.Future<void>.value(),
+      ) as _i5.Future<void>);
 }