feat: added support for webview as a provider for webauth #875
+628
−111
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,9 @@ | ||
| #if WEB_AUTH_PLATFORM | ||
| import Foundation | ||
| import Combine | ||
| #if os(iOS) | ||
| import UIKit | ||
| #endif | ||
|
|
||
| final class Auth0WebAuth: WebAuth { | ||
|
|
||
|
|
@@ -33,6 +36,11 @@ | |
| private(set) var overrideAuthorizeURL: URL? | ||
| private(set) var provider: WebAuthProvider? | ||
| private(set) var onCloseCallback: (() -> Void)? | ||
|
|
||
| #if os(iOS) | ||
| private(set) var useWebViewProvider = false | ||
| private(set) var webViewProviderPresentationStyle: UIModalPresentationStyle = .fullScreen | ||
| #endif | ||
|
There was a problem hiding this comment. Using a func like https://github.com/auth0/Auth0.swift/blob/master/Auth0/SafariProvider.swift#L37 also has the advantage of being on its own (gated) file, so there's no need to have these conditionals here. There was a problem hiding this comment. changed accordingly |
||
|
|
||
| var state: String { | ||
| return self.parameters["state"] ?? self.generateDefaultState() | ||
|
|
@@ -144,6 +152,14 @@ | |
| self.ephemeralSession = true | ||
| return self | ||
| } | ||
|
|
||
| #if os(iOS) | ||
| func useWebViewProvider(style: UIModalPresentationStyle = .fullScreen) -> Self { | ||
| self.useWebViewProvider = true | ||
| self.webViewProviderPresentationStyle = style | ||
| return self | ||
| } | ||
| #endif | ||
|
|
||
| func invitationURL(_ invitationURL: URL) -> Self { | ||
| self.invitationURL = invitationURL | ||
|
|
@@ -196,8 +212,12 @@ | |
| state: state, | ||
| organization: organization, | ||
| invitation: invitation) | ||
|
|
||
| #if os(iOS) | ||
|
There was a problem hiding this comment. changed accordingly |
||
| let provider = useWebViewProvider ? WebAuthentication.webViewProvider(redirectionURL: redirectURL, style: webViewProviderPresentationStyle) : (self.provider ?? WebAuthentication.asProvider(redirectURL: redirectURL, ephemeralSession: ephemeralSession)) | ||
| #else | ||
| let provider = self.provider ?? WebAuthentication.asProvider(redirectURL: redirectURL, ephemeralSession: ephemeralSession) | ||
| #endif | ||
| let userAgent = provider(authorizeURL) { [storage, onCloseCallback] result in | ||
| storage.clear() | ||
|
|
||
|
|
@@ -238,7 +258,11 @@ | |
| return callback(.failure(WebAuthError(code: .noBundleIdentifier))) | ||
| } | ||
|
|
||
| #if os(iOS) | ||
| let provider = useWebViewProvider ? WebAuthentication.webViewProvider(redirectionURL: redirectURL, style: webViewProviderPresentationStyle) : (self.provider ?? WebAuthentication.asProvider(redirectURL: redirectURL)) | ||
| #else | ||
| let provider = self.provider ?? WebAuthentication.asProvider(redirectURL: redirectURL) | ||
| #endif | ||
| let userAgent = provider(logoutURL) { [storage] result in | ||
| storage.clear() | ||
| callback(result) | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| // | ||
| // WebViewProvider.swift | ||
| // Auth0 | ||
| // | ||
| // Created by Desu Sai Venkat on 18/09/24. | ||
| // Copyright © 2024 Auth0. All rights reserved. | ||
| // | ||
|
|
||
| #if os(iOS) | ||
|
|
||
| @preconcurrency import WebKit | ||
|
|
||
|
|
||
| extension WebAuthentication { | ||
| static func webViewProvider(redirectionURL: URL, style: UIModalPresentationStyle = .fullScreen) -> WebAuthProvider { | ||
| return { url, callback in | ||
| WebViewUserAgent(authorizeURL: url, redirectURL: redirectionURL, modalPresentationStyle: style, callback: callback) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| extension WebViewUserAgent { | ||
| var topViewController: UIViewController? { | ||
|
There was a problem hiding this comment. We already have this logic here: https://github.com/auth0/Auth0.swift/blob/master/Auth0/SafariProvider.swift#L50-L77 There was a problem hiding this comment. agreed, moved this to a shared helper |
||
| guard let root = UIApplication.shared()?.windows.last(where: \.isKeyWindow)?.rootViewController else { | ||
| return nil | ||
| } | ||
| return self.findTopViewController(from: root) | ||
| } | ||
|
|
||
| private func findTopViewController(from root: UIViewController) -> UIViewController? { | ||
| if let presented = root.presentedViewController { return self.findTopViewController(from: presented) } | ||
|
|
||
| switch root { | ||
| case let split as UISplitViewController: | ||
| guard let last = split.viewControllers.last else { return split } | ||
| return self.findTopViewController(from: last) | ||
| case let navigation as UINavigationController: | ||
| guard let top = navigation.topViewController else { return navigation } | ||
| return self.findTopViewController(from: top) | ||
| case let tab as UITabBarController: | ||
| guard let selected = tab.selectedViewController else { return tab } | ||
| return self.findTopViewController(from: selected) | ||
| default: | ||
| return root | ||
| } | ||
| } | ||
| } | ||
|
|
||
| class WebViewUserAgent: NSObject, WebAuthUserAgent { | ||
|
|
||
| static let customSchemeRedirectionSuccessMessage = "com.auth0.webview.redirection_success" | ||
| static let customSchemeRedirectionFailureMessage = "com.auth0.webview.redirection_failure" | ||
| let defaultSchemesSupportedByWKWebview = ["http", "https"] | ||
|
There was a problem hiding this comment. I'd suggest checking with somebody from the security team if we should be supporting |
||
|
|
||
| let request: URLRequest | ||
| var webview: WKWebView! | ||
| let viewController: UIViewController | ||
| let redirectURL: URL | ||
| let callback: WebAuthProviderCallback | ||
|
|
||
|
|
||
| init(authorizeURL: URL, redirectURL: URL, viewController: UIViewController = UIViewController(), modalPresentationStyle: UIModalPresentationStyle = .fullScreen, callback: @escaping WebAuthProviderCallback) { | ||
| self.request = URLRequest(url: authorizeURL) | ||
| self.redirectURL = redirectURL | ||
| self.callback = callback | ||
| self.viewController = viewController | ||
| self.viewController.modalPresentationStyle = modalPresentationStyle | ||
|
|
||
| super.init() | ||
| if !defaultSchemesSupportedByWKWebview.contains(redirectURL.scheme!) { | ||
| self.setupWebViewWithCustomScheme() | ||
| } else { | ||
| self.setupWebViewWithHTTPS() | ||
| } | ||
| } | ||
|
|
||
| private func setupWebViewWithCustomScheme() { | ||
| let configuration = WKWebViewConfiguration() | ||
| configuration.setURLSchemeHandler(self, forURLScheme: redirectURL.scheme!) | ||
| self.webview = WKWebView(frame: .zero, configuration: configuration) | ||
| self.viewController.view = webview | ||
| webview.navigationDelegate = self | ||
| } | ||
|
|
||
| private func setupWebViewWithHTTPS() { | ||
| self.webview = WKWebView(frame: .zero) | ||
| self.viewController.view = webview | ||
| webview.navigationDelegate = self | ||
| } | ||
|
|
||
| func start() { | ||
| self.webview.load(self.request) | ||
| self.topViewController?.present(self.viewController, animated: true) | ||
| } | ||
|
|
||
| func finish(with result: WebAuthResult<Void>) { | ||
| DispatchQueue.main.async { [weak webview, weak viewController, callback] in | ||
| webview?.removeFromSuperview() | ||
| guard let presenting = viewController?.presentingViewController else { | ||
| let error = WebAuthError(code: .unknown("Cannot dismiss WKWebView")) | ||
| return callback(.failure(error)) | ||
| } | ||
| presenting.dismiss(animated: true) { | ||
| callback(result) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public override var description: String { | ||
| return String(describing: WKWebView.self) | ||
| } | ||
| } | ||
|
|
||
| /// Handling Custom Scheme Callbacks | ||
| extension WebViewUserAgent: WKURLSchemeHandler { | ||
| func webView(_ webView: WKWebView, start urlSchemeTask: any WKURLSchemeTask) { | ||
| _ = TransactionStore.shared.resume(urlSchemeTask.request.url!) | ||
| let error = NSError(domain: WebViewUserAgent.customSchemeRedirectionSuccessMessage, code: 200, userInfo: [ | ||
| NSLocalizedDescriptionKey: "WebViewProvider: WKURLSchemeHandler: Succesfully redirected back to the app" | ||
| ]) | ||
| urlSchemeTask.didFailWithError(error) | ||
| } | ||
|
|
||
| func webView(_ webView: WKWebView, stop urlSchemeTask: any WKURLSchemeTask) { | ||
| let error = NSError(domain: WebViewUserAgent.customSchemeRedirectionFailureMessage, code: 400, userInfo: [ | ||
| NSLocalizedDescriptionKey: "WebViewProvider: WKURLSchemeHandler: Webview Resource Loading has been stopped" | ||
| ]) | ||
| urlSchemeTask.didFailWithError(error) | ||
| self.finish(with: .failure(WebAuthError(code: .webViewResourceLoadingStopped))) | ||
|
There was a problem hiding this comment. Should this error case be There was a problem hiding this comment. yes, updated accordingly |
||
| } | ||
| } | ||
|
|
||
| /// Handling HTTPS Callbacks | ||
| extension WebViewUserAgent: WKNavigationDelegate { | ||
| func webView(_ webView: WKWebView, decidePolicyFor navigationAction: WKNavigationAction, decisionHandler: @escaping (WKNavigationActionPolicy) -> Void) { | ||
| if let callbackUrl = navigationAction.request.url, callbackUrl.absoluteString.starts(with: redirectURL.absoluteString) { | ||
| _ = TransactionStore.shared.resume(callbackUrl) | ||
| decisionHandler(.cancel) | ||
| } else { | ||
| decisionHandler(.allow) | ||
| } | ||
| } | ||
|
|
||
| func webView(_ webView: WKWebView, didFail navigation: WKNavigation!, withError error: any Error) { | ||
| if (error as NSError).domain == WebViewUserAgent.customSchemeRedirectionSuccessMessage { | ||
| return | ||
| } | ||
| self.finish(with: .failure(WebAuthError(code: .webViewNavigationFailed, cause: error))) | ||
| } | ||
|
|
||
| func webView(_ webView: WKWebView, didFailProvisionalNavigation navigation: WKNavigation!, withError error: any Error) { | ||
| if (error as NSError).domain == WebViewUserAgent.customSchemeRedirectionSuccessMessage { | ||
| return | ||
| } | ||
| self.finish(with: .failure(WebAuthError(code: .webViewProvisionalNavigationFailed, cause: error))) | ||
| } | ||
|
|
||
| func webViewWebContentProcessDidTerminate(_ webView: WKWebView) { | ||
| self.finish(with: .failure(WebAuthError(code: .webViewContentProcessTerminated))) | ||
| } | ||
| } | ||
|
|
||
| #endif | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -451,7 +451,7 @@ class CredentialsManagerSpec: QuickSpec { | |
| credentials = Credentials(accessToken: AccessToken, tokenType: TokenType, idToken: IdToken, refreshToken: RefreshToken, expiresIn: Date(timeIntervalSinceNow: -ExpiresIn)) | ||
| _ = credentialsManager.store(credentials: credentials) | ||
|
|
||
| waitUntil(timeout: .seconds(5)) { done in | ||
| credentialsManager.credentials { result in | ||
| expect(result).to(haveCredentialsManagerError(expectedError)) | ||
| done() | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd suggest adding a new static func to the
WebAuthenticationstruct like https://github.com/auth0/Auth0.swift/blob/master/Auth0/SafariProvider.swift#L37, as that:useX()methods that have the disadvantage of being mutually exclusive (e.g. these can be chained and it's not clear which one will end up being used)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
agreed, changed accordingly