Skip to content

[webview_flutter] Support for handling basic authentication requests #4140

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 31 commits into from
Closed

[webview_flutter] Support for handling basic authentication requests #4140

wants to merge 31 commits into from

Conversation

andreisas06
Copy link
Contributor

Description

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

  1. Added setHttpAuthCredentials() function: This function allows developers to programmatically set credentials (username and password) for a given host and realm.
  2. 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

  • I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
  • I read the [Tree Hygiene] wiki page, which explains my responsibilities.
  • I read and followed the [relevant style guides] and ran the auto-formatter. (Unlike the flutter/flutter repo, the flutter/packages repo does use dart format.)
  • I signed the [CLA].
  • The title of the PR starts with the name of the package surrounded by square brackets, e.g. [shared_preferences]
  • I listed at least one issue that this PR fixes in the description above.
  • I updated pubspec.yaml with an appropriate new version according to the [pub versioning philosophy], or this PR is [exempt from version changes].
  • I updated CHANGELOG.md to add a description of the change, [following repository CHANGELOG style].
  • I updated/added relevant documentation (doc comments with ///).
  • I added new tests to check the change I am making, or this PR is [test-exempt].
  • All existing and new tests are passing.

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

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

bparrishMines
bparrishMines reviewed Jun 15, 2023
View reviewed changes
Copy link
Contributor

@bparrishMines bparrishMines left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

...webview_flutter/webview_flutter_platform_interface/lib/src/platform_navigation_delegate.dart Outdated
@@ -30,6 +30,9 @@ typedef WebResourceErrorCallback = void Function(WebResourceError error);
/// url of the web view.
typedef UrlChangeCallback = void Function(UrlChange change);

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

.../webview_flutter/webview_flutter_platform_interface/lib/src/platform_webview_controller.dart Outdated
@@ -261,6 +261,13 @@ abstract class PlatformWebViewController extends PlatformInterface {
'setUserAgent is not implemented on the current platform');
}

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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].

...ndroid/android/src/main/java/io/flutter/plugins/webviewflutter/WebViewClientHostApiImpl.java Outdated
@@ -95,6 +98,13 @@ public void doUpdateVisitedHistory(
flutterApi.doUpdateVisitedHistory(this, view, url, isReload, reply -> {});
}

@Override
public void onReceivedHttpAuthRequest(
@NonNull WebView view, HttpAuthHandler handler, String host, String realm) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Contributor Author

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

@JeroenWeener JeroenWeener force-pushed the webview-auth-request branch from 38311df to 3fb8d80 Compare June 23, 2023 10:11
@bparrishMines bparrishMines requested a review from cyanglaz as a code owner July 6, 2023 10:15
@stuartmorgan-g 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
cyanglaz reviewed Jul 17, 2023
View reviewed changes
packages/webview_flutter/webview_flutter_wkwebview/ios/Classes/FWFNavigationDelegateHostApi.m Outdated
: nil;

completionHandler(disposition, credential);
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@JeroenWeener JeroenWeener mentioned this pull request Jul 19, 2023
Closed
@bparrishMines bparrishMines added the federated: all_changes PR that contains changes for all packages for a federated plugin change label Jul 19, 2023
@JeroenWeener
Copy link
Contributor

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?

ChopinDavid pushed a commit to wwt/flutter-packages that referenced this pull request Dec 28, 2023
@JeroenWeener @ChopinDavid
[webview_flutter] Support for handling basic authentication requests …
b78c341 
…(iOS) (flutter#5455)

Adds the iOS implementation for basic http authentication.

This PR is part of a series of PRs that aim to close flutter/flutter#83556.
The PR that contains all changes can be found at flutter#4140.
@jmagman
Copy link
Member

jmagman commented Jan 31, 2024

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

arc-yong pushed a commit to Arctuition/packages-arc that referenced this pull request Jun 14, 2024
@JeroenWeener @arc-yong
[webview_flutter] Support for handling basic authentication requests …
998816c 
…(Platform Interface) (flutter#5362)

Adds the platform interface implementation for basic http authentication.

This PR is part of a series of PRs that aim to close flutter/flutter#83556.
The PR that contains all changes can be found at flutter#4140.
arc-yong pushed a commit to Arctuition/packages-arc that referenced this pull request Jun 14, 2024
@JeroenWeener @arc-yong
[webview_flutter] Support for handling basic authentication requests …
a83d4e9 
…(Android) (flutter#5454)

Adds the Android implementation for basic http authentication.

This PR is part of a series of PRs that aim to close flutter/flutter#83556.
The PR that contains all changes can be found at flutter#4140.
arc-yong pushed a commit to Arctuition/packages-arc that referenced this pull request Jun 14, 2024
@JeroenWeener @arc-yong
[webview_flutter] Support for handling basic authentication requests …
50baa12 
…(iOS) (flutter#5455)

Adds the iOS implementation for basic http authentication.

This PR is part of a series of PRs that aim to close flutter/flutter#83556.
The PR that contains all changes can be found at flutter#4140.
bill-skdnd pushed a commit to skdnd-metaspace/webview_flutter_wkwebview that referenced this pull request Aug 2, 2024
@JeroenWeener
[webview_flutter] Support for handling basic authentication requests …
0c021cc 
…(iOS) (#5455)

Adds the iOS implementation for basic http authentication.

This PR is part of a series of PRs that aim to close flutter/flutter#83556.
The PR that contains all changes can be found at flutter/packages#4140.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stuartmorgan-g stuartmorgan-g stuartmorgan-g requested changes

@JeroenWeener JeroenWeener JeroenWeener left review comments

@bparrishMines bparrishMines bparrishMines approved these changes

@cyanglaz cyanglaz Awaiting requested review from cyanglaz

@vashworth vashworth Awaiting requested review from vashworth vashworth is a code owner

@jmagman jmagman Awaiting requested review from jmagman

@LouiseHsu LouiseHsu Awaiting requested review from LouiseHsu LouiseHsu is a code owner

@yjbanov yjbanov Awaiting requested review from yjbanov yjbanov is a code owner

@dnfield dnfield Awaiting requested review from dnfield

@keyonghan keyonghan Awaiting requested review from keyonghan

Assignees
No one assigned
Labels
federated: all_changes PR that contains changes for all packages for a federated plugin change p: animations p: camera p: cross_file p: css_colors p: dynamic_layouts The dynamic_layouts package p: espresso p: extension_google_sign_in_as_googleapis_auth p: file_selector p: flutter_adaptive_scaffold p: flutter_image p: flutter_markdown p: flutter_plugin_android_lifecycle p: go_router_builder p: go_router p: google_maps_flutter p: google_sign_in p: image_picker p: in_app_purchase p: ios_platform_images p: local_auth p: metrics_center p: multicast_dns p: palette_generator p: path_provider p: pigeon p: plugin_platform_interface p: pointer_interceptor p: quick_actions p: rfw Remote Flutter Widgets p: shared_preferences p: url_launcher p: video_player p: web_benchmarks p: webview_flutter platform-android platform-ios platform-linux platform-macos platform-web platform-windows
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[webview_flutter] There is no callback for "Basic Authentication" on navigating to a URI
7 participants
@andreisas06 @JeroenWeener @mvanbeusekom @bparrishMines @stuartmorgan-g @jmagman @cyanglaz