[webview_flutter] Support for handling basic authentication requests by andreisas06 · Pull Request #4140 · flutter/packages

andreisas06 · 2023-06-05T11:48:36Z

Description

This pull request introduces the handling of HTTP Basic Authentication in our WebView implementation. Specifically, it includes the following changes:

Added setHttpAuthCredentials() function: This function allows developers to programmatically set credentials (username and password) for a given host and realm.
Implemented onReceivedHttpAuthRequest() callback: This callback is invoked when the WebView encounters a website that requires HTTP Basic Authentication. The host and realm information from the authentication request is utilized to match and use the stored credentials.

Issues fixed by PR:

Closes flutter/flutter#83556

Pre-launch Checklist

andreisas06 · 2023-06-14T09:42:18Z

@bparrishMines should I proceed with the PR containing only the platform interface package?

bparrishMines

This also needs an implementation for webview_flutter_wkwebview. Using https://developer.apple.com/documentation/webkit/wknavigationdelegate/3601237-webview?language=objc I believe.

bparrishMines · 2023-06-15T14:01:35Z

...webview_flutter/webview_flutter_platform_interface/lib/src/platform_navigation_delegate.dart

nit:

Suggested change

/// Signature for callbacks that report basic auth events by the native web view

/// Signature for callbacks that report basic auth events by the native web view.

bparrishMines · 2023-06-15T14:03:08Z

.../webview_flutter/webview_flutter_platform_interface/lib/src/platform_webview_controller.dart

nit:

Suggested change

/// Sets the auth credentials for basic authentication and can be used on onReceiveHttpAuthRequest with NavigationDelegate.

/// Sets the auth credentials for basic authentication and can be used with

/// [PlatformNavigationDelegate.onReceiveHttpAuthRequest].

bparrishMines · 2023-06-15T14:11:21Z

...ndroid/android/src/main/java/io/flutter/plugins/webviewflutter/WebViewClientHostApiImpl.java

The FlutterAPI should pass back the HttpAuthHandler instead of adding a setAuthCredentials method. Mainly because the HttpAuthHandler has multiple methods that could be used. e.g. cancel and useHttpAuthUsernamePassword.

andreisas06 · 2023-06-20T09:15:40Z

Hey @bparrishMines , @JeroenWeener will be taking over for the IOS implementation of this PR.

cyanglaz · 2023-07-17T19:53:48Z

packages/webview_flutter/webview_flutter_wkwebview/ios/Classes/FWFNavigationDelegateHostApi.m

When there is an error, don't we also need to call completionHandler in production?

…/packages into webview-auth-request

mvanbeusekom · 2023-11-01T14:01:46Z

Hi @stuartmorgan,

This PR is ready for review, we are keeping it up to date until then.

stuartmorgan-g

I didn't review the implementations, but I'm happy with the overall structure. Once @bparrishMines has done another full review of the PR it should be ready to break up.

stuartmorgan-g · 2023-11-02T15:01:04Z

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

    if (WebViewPlatform.instance is WebKitWebViewPlatform) {
      params = WebKitWebViewControllerCreationParams(
        allowsInlineMediaPlayback: true,
-        mediaTypesRequiringUserAction: const <PlaybackMediaTypes>{},


Bad merge, or was this intentionally removed?

stuartmorgan-g · 2023-11-02T15:05:35Z

...ages/webview_flutter/webview_flutter_platform_interface/lib/src/types/http_auth_request.dart

+  /// The callback to proceed with, or cancel an auth request.
+  ///
+  /// If `credential` is `null`, the request will be canceled.
+  final void Function(WebViewCredential? credential) onAuthenticate;


I think the outcome of #4140 (comment) was that we were going to go back to onProceed and onCancel? I'll defer to @bparrishMines on the exact callback structure though.

Correct. I think we should separate this into onCancel and onProceed again. And then iOS can add its additional method.

…b/src/types/http_auth_request.dart

…request

…s into webview-auth-request

bparrishMines · 2023-11-08T22:18:45Z

I went ahead and added the changes mentioned in #4140 (comment) and updated the PR with the pigeon upgrade from #5271

bparrishMines

LGTM

I think this is ready to be split into separate PRs. @andreisas06 @mvanbeusekom let me know if you would like to do this or have me finish this part.

JeroenWeener · 2023-11-10T09:54:04Z

Hi @bparrishMines, thank you for the changes and the review.

Could you tell me how you usually deal with splitting PRs? I find myself a bit lost when trying to separate the platform interface changes from the other changes.

stuartmorgan-g · 2023-11-10T12:59:35Z

Could you tell me how you usually deal with splitting PRs? I find myself a bit lost when trying to separate the platform interface changes from the other changes.

FWIW my workflow is:

Make a new local branch from the combo PR branch (e.g., git checkout -t webview-auth-request -b webview-auth-request-interface)
Merge in main so it's up to date
Revert the other packages to the state on main (git checkout main -- packages/webview_flutter/webview_flutter packages/webview_flutter/webview_flutter_android packages/webview_flutter/webview_flutter_wkwebview; git commit)

That should given you a branch that is exactly the platform interface subset of this PR. (I prefer this to trying to apply a patch file to a new clean branch because I find that more error-prone.)

JeroenWeener · 2023-11-10T13:20:45Z

Thanks @stuartmorgan, learned something new today 👍

JeroenWeener · 2023-11-10T14:07:23Z

@bparrishMines the platform interface PR is up! You can find it here: #5362.

JeroenWeener · 2023-12-20T09:48:43Z

Thank @stuartmorgan and @bparrishMines for merging the related PRs. The final PR that exposes the iOS and Android implementations can be found here: #5727.

@andreisas06 could you close this PR?

jmagman · 2024-01-31T21:58:25Z

@bparrishMines and @stuartmorgan can this be closed in favor of #5727 (review) and friends? Seems like this is zombied.

andreisas06 requested a review from bparrishMines as a code owner June 5, 2023 11:48

github-actions bot added p: webview_flutter platform-android labels Jun 5, 2023

andreisas06 force-pushed the webview-auth-request branch 2 times, most recently from 9f79b3b to 38311df Compare June 14, 2023 07:29

bparrishMines reviewed Jun 15, 2023

View reviewed changes

JeroenWeener force-pushed the webview-auth-request branch from 38311df to 3fb8d80 Compare June 23, 2023 10:11

bparrishMines requested a review from cyanglaz as a code owner July 6, 2023 10:15

github-actions bot added the platform-ios label Jul 6, 2023

stuartmorgan-g changed the title ~~[webview_flutter_android] Support for handling basic authentication requests~~ [webview_flutter] Support for handling basic authentication requests Jul 17, 2023

cyanglaz reviewed Jul 17, 2023

View reviewed changes

JeroenWeener mentioned this pull request Jul 19, 2023

[webview_flutter] There is no callback for "Basic Authentication" on navigating to a URI flutter/flutter#83556

Closed

bparrishMines added the federated: all_changes PR that contains changes for all packages for a federated plugin change label Jul 19, 2023

JeroenWeener requested review from Hixie, Piinks, camsim99, cbracken, chunhtai, ditman, domesticmouse, gmackall, goderbauer, gspencergoog, hellohuanlin, reidbaker, stuartmorgan-g and tarrinneal as code owners August 10, 2023 11:33

github-actions bot added the p: extension_google_sign_in_as_googleapis_auth label Aug 10, 2023

JeroenWeener added 4 commits November 1, 2023 10:37

Remove redundant key in Info.plist

467feb3

Update example apps

dad8ae6

Merge branch 'webview-auth-request' of https://github.com/andreisas06…

6f3d802

…/packages into webview-auth-request

Add platform interface dev dependency to example

0fef591

Merge branch 'main' into webview-auth-request

b2a4fbb

stuartmorgan-g reviewed Nov 2, 2023

View reviewed changes

bparrishMines added 7 commits November 7, 2023 19:31

Update packages/webview_flutter/webview_flutter_platform_interface/li…

ce35d9b

…b/src/types/http_auth_request.dart

Merge branch 'main' of github.com:flutter/packages into webview-auth-…

fc32898

…request

Merge branch 'webview-auth-request' of github.com:andreisas06/package…

4673e65

…s into webview-auth-request

Fix some lints, errros and call on errors

580521a

fix lints

d1f305b

fix tests

a3f74be

add onProceed and onCancel back

ed3798f

dont require realm to be nonnull

154c1f8

bparrishMines approved these changes Nov 8, 2023

View reviewed changes

add line back

3c61dbc

JeroenWeener mentioned this pull request Nov 10, 2023

[webview_flutter] Support for handling basic authentication requests (Platform Interface) #5362

Merged

11 tasks

JeroenWeener added 2 commits November 21, 2023 12:12

Merge remote-tracking branch 'upstream/main' into webview-auth-request

7cf0d7e

Update changelogs

a21f29a

This was referenced Nov 21, 2023

[webview_flutter] Support for handling basic authentication requests (Android) #5454

Merged

[webview_flutter] Support for handling basic authentication requests (iOS) #5455

Merged

Merge main

8f7603a

	/// Signature for callbacks that report basic auth events by the native web view
	/// Signature for callbacks that report basic auth events by the native web view.

	/// Sets the auth credentials for basic authentication and can be used on onReceiveHttpAuthRequest with NavigationDelegate.
	/// Sets the auth credentials for basic authentication and can be used with
	/// [PlatformNavigationDelegate.onReceiveHttpAuthRequest].

Conversation

andreisas06 commented Jun 5, 2023

Description

Issues fixed by PR:

Pre-launch Checklist

Uh oh!

andreisas06 commented Jun 14, 2023

Uh oh!

bparrishMines left a comment

Choose a reason for hiding this comment

Uh oh!

bparrishMines Jun 15, 2023

Choose a reason for hiding this comment

Uh oh!

bparrishMines Jun 15, 2023

Choose a reason for hiding this comment

Uh oh!

bparrishMines Jun 15, 2023

Choose a reason for hiding this comment

Uh oh!

andreisas06 commented Jun 20, 2023

Uh oh!

cyanglaz Jul 17, 2023

Choose a reason for hiding this comment

Uh oh!

mvanbeusekom commented Nov 1, 2023

Uh oh!

stuartmorgan-g left a comment

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g Nov 2, 2023

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g Nov 2, 2023

Choose a reason for hiding this comment

Uh oh!

bparrishMines Nov 8, 2023

Choose a reason for hiding this comment

Uh oh!

bparrishMines commented Nov 8, 2023

Uh oh!

bparrishMines left a comment

Choose a reason for hiding this comment

Uh oh!

JeroenWeener commented Nov 10, 2023

Uh oh!

stuartmorgan-g commented Nov 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JeroenWeener commented Nov 10, 2023

Uh oh!

JeroenWeener commented Nov 10, 2023

Uh oh!

JeroenWeener commented Dec 20, 2023

Uh oh!

jmagman commented Jan 31, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

stuartmorgan-g commented Nov 10, 2023 •

edited

Loading