Skip to content

Commit

Permalink
Support both OAuth variants in native flows
Browse files Browse the repository at this point in the history
  • Loading branch information
@shilgapira
shilgapira committed Oct 20, 2024
1 parent 85f7cdd commit 1e4571c
Show file tree
Hide file tree
Showing 13 changed files with 345 additions and 144 deletions.
150 changes: 91 additions & 59 deletions src/flows/FlowBridge.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,25 @@ protocol FlowBridgeDelegate: AnyObject {
func bridgeDidFailLoading(_ bridge: FlowBridge, error: DescopeError)
func bridgeDidFinishLoading(_ bridge: FlowBridge)
func bridgeDidBecomeReady(_ bridge: FlowBridge)
func bridgeDidInterceptNavigation(_ bridge: FlowBridge, to url: URL, external: Bool)
func bridgeDidReceiveRequest(_ bridge: FlowBridge, request: FlowBridgeRequest)
func bridgeDidFailAuthentication(_ bridge: FlowBridge, error: DescopeError)
func bridgeDidFinishAuthentication(_ bridge: FlowBridge, data: Data)
}

enum FlowBridgeRequest {
case oauthNative(clientId: String, stateId: String, nonce: String, implicit: Bool)
case oauthWeb(url: String, defaultProvider: String?)
case oauthWeb(startURL: URL, finishURL: URL?)
}

enum FlowBridgeResponse {
case oauthNative(stateId: String, authorizationCode: String?, identityToken: String?, user: String?)
case oauthWeb(exchangeCode: String)
}

@MainActor
class FlowBridge: NSObject {
var log: DescopeLogger? = Descope.sdk.config.logger
var logger: DescopeLogger? = Descope.sdk.config.logger

weak var delegate: FlowBridgeDelegate?

Expand All @@ -44,9 +46,6 @@ class FlowBridge: NSObject {
func prepare(configuration: WKWebViewConfiguration) {
let setup = WKUserScript(source: setupScript, injectionTime: .atDocumentStart, forMainFrameOnly: false)
configuration.userContentController.addUserScript(setup)
if #available(iOS 14.5, *) {
configuration.preferences.isTextInteractionEnabled = false
}
if #available(iOS 17.0, *) {
configuration.preferences.inactiveSchedulingPolicy = .none
}
Expand All @@ -57,119 +56,126 @@ class FlowBridge: NSObject {
}

func send(response: FlowBridgeResponse) {
webView?.evaluateJavaScript("""
let component = findWebComponent()
if (component) {
component.nativeComplete(`\(response.stringValue)`)
}
""")
webView?.evaluateJavaScript("\(namespace)_send(`\(response.stringValue)`)")
}
}

extension FlowBridge: WKScriptMessageHandler {
func userContentController(_ userContentController: WKUserContentController, didReceive message: WKScriptMessage) {
switch FlowBridgeMessage(rawValue: message.name) {
case .log:
log(.debug, "Console Log", message.body)
case .warn:
log(.debug, "Console Warn", message.body)
case .error:
log(.debug, "Console Error", message.body)
#if DEBUG
if let json = message.body as? [String: Any], let tag = json["tag"] as? String, let message = json["message"] as? String {
logger(.debug, "Console", "\(tag): \(message)")
}
#endif
case .ready:
log(.info, "Bridge received ready event")
logger(.info, "Bridge received ready event")
delegate?.bridgeDidBecomeReady(self)
case .native:
log(.info, "Bridge received native event")
case .bridge:
logger(.info, "Bridge received native event")
guard let json = message.body as? [String: Any], let request = FlowBridgeRequest(json: json) else {
log(.error, "Invalid JSON data in flow native event", message.body)
logger(.error, "Invalid JSON data in flow native event", message.body)
delegate?.bridgeDidFailAuthentication(self, error: DescopeError.flowFailed.with(message: "Invalid JSON data in flow native event"))
return
}
delegate?.bridgeDidReceiveRequest(self, request: request)
case .failure:
log(.error, "Bridge received failure event", message.body)
logger(.error, "Bridge received failure event", message.body)
delegate?.bridgeDidFailAuthentication(self, error: DescopeError.flowFailed.with(message: "Unexpected authentication failure [\(message.body)]"))
case .success:
log(.info, "Bridge received success event")
logger(.info, "Bridge received success event")
guard let json = message.body as? String, case let data = Data(json.utf8) else {
log(.error, "Invalid JSON data in flow success event", message.body)
logger(.error, "Invalid JSON data in flow success event", message.body)
delegate?.bridgeDidFailAuthentication(self, error: DescopeError.flowFailed.with(message: "Invalid JSON data in flow success event"))
return
}
delegate?.bridgeDidFinishAuthentication(self, data: data)
case nil:
log(.error, "Bridge received unexpected message", message.name)
logger(.error, "Bridge received unexpected message", message.name)
}
}
}

extension FlowBridge: WKNavigationDelegate {
func webView(_ webView: WKWebView, decidePolicyFor navigationAction: WKNavigationAction) async -> WKNavigationActionPolicy {
log(.info, "Webview will load url", navigationAction.navigationType == .other ? nil : "type=\(navigationAction.navigationType.rawValue)", navigationAction.request.url?.absoluteString)
return .allow
switch navigationAction.navigationType {
case .linkActivated:
logger(.info, "Webview intercepted link", navigationAction.request.url?.absoluteString)
if let url = navigationAction.request.url {
delegate?.bridgeDidInterceptNavigation(self, to: url, external: false)
}
return .cancel
default:
logger(.info, "Webview will load url", navigationAction.navigationType == .other ? nil : "type=\(navigationAction.navigationType.rawValue)", navigationAction.request.url?.absoluteString)
return .allow
}
}

func webView(_ webView: WKWebView, didStartProvisionalNavigation navigation: WKNavigation) {
log(.info, "Webview started loading webpage")
logger(.info, "Webview started loading webpage")
delegate?.bridgeDidStartLoading(self)
}

func webView(_ webView: WKWebView, didReceiveServerRedirectForProvisionalNavigation navigation: WKNavigation) {
log(.info, "Webview received server redirect", webView.url)
logger(.info, "Webview received server redirect", webView.url)
}

func webView(_ webView: WKWebView, decidePolicyFor navigationResponse: WKNavigationResponse) async -> WKNavigationResponsePolicy {
log(.info, "Webview will receive response")
logger(.info, "Webview will receive response")
return .allow
}

func webView(_ webView: WKWebView, didFailProvisionalNavigation navigation: WKNavigation, withError error: Error) {
log(.error, "Webview failed loading url", error)
logger(.error, "Webview failed loading url", error)
delegate?.bridgeDidFailLoading(self, error: DescopeError.networkError.with(cause: error))
}

func webView(_ webView: WKWebView, didCommit navigation: WKNavigation) {
log(.info, "Webview received response")
logger(.info, "Webview received response")
}

func webView(_ webView: WKWebView, didFinish navigation: WKNavigation) {
log(.info, "Webview finished loading webpage")
logger(.info, "Webview finished loading webpage")
delegate?.bridgeDidFinishLoading(self)
webView.evaluateJavaScript("waitWebComponent()")
webView.evaluateJavaScript("\(namespace)_wait()")
}

func webView(_ webView: WKWebView, didFail navigation: WKNavigation, withError error: Error) {
log(.error, "Webview failed loading webpage", error)
logger(.error, "Webview failed loading webpage", error)
delegate?.bridgeDidFailLoading(self, error: DescopeError.networkError.with(cause: error))
}
}

extension FlowBridge: WKUIDelegate {
func webView(_ webView: WKWebView, createWebViewWith configuration: WKWebViewConfiguration, for navigationAction: WKNavigationAction, windowFeatures: WKWindowFeatures) -> WKWebView? {
// TODO
log(.info, "Webview createWebViewWith", navigationAction.request, navigationAction, windowFeatures)
logger(.info, "Webview intercepted external link", navigationAction.request.url?.absoluteString)
if let url = navigationAction.request.url {
delegate?.bridgeDidInterceptNavigation(self, to: url, external: true)
}
return nil
}
}

private enum FlowBridgeMessage: String, CaseIterable {
case log, warn, error, ready, native, failure, success
case log, ready, bridge, failure, success
}

private extension FlowBridgeRequest {
init?(json: [String: Any]) {
guard let payload = json["payload"] as? [String: Any] else { return nil }
switch json["type"] as? String {
case "oauthNative":
guard let start = json["response"] as? [String: Any] else { return nil }
guard let start = payload["start"] as? [String: Any] else { return nil }
guard let clientId = start["clientId"] as? String, let stateId = start["stateId"] as? String, let nonce = start["nonce"] as? String, let implicit = start["implicit"] as? Bool else { return nil }
self = .oauthNative(clientId: clientId, stateId: stateId, nonce: nonce, implicit: implicit)
case "oauthWeb":
guard let url = json["url"] as? String else { return nil }
var defaultProvider: String?
if let value = json["defaultProvider"] as? String, !value.isEmpty {
defaultProvider = value
guard let startString = payload["startUrl"] as? String, let startURL = URL(string: startString) else { return nil }
var finishURL: URL?
if let str = payload["finishUrl"] as? String, !str.isEmpty, let url = URL(string: str) {
finishURL = url
}
self = .oauthWeb(url: url, defaultProvider: defaultProvider)
self = .oauthWeb(startURL: startURL, finishURL: finishURL)
default:
return nil
}
Expand All @@ -183,14 +189,19 @@ private extension FlowBridgeResponse {
case let .oauthNative(stateId, authorizationCode, identityToken, user):
dict["stateId"] = stateId
if let authorizationCode {
dict["code"] = authorizationCode
dict["authorizationCode"] = authorizationCode
}
if let identityToken {
dict["idToken"] = identityToken
}
if let user {
dict["user"] = user
dict["userData"] = user
}
case let .oauthWeb(exchangeCode):
return [
"exchangeCode": exchangeCode,
"idpInitiated": true,
]
}
return dict
}
Expand All @@ -204,25 +215,33 @@ private extension FlowBridgeResponse {
}
}

private let namespace = "_Descope_Bridge"

private let setupScript = """

/* Javascript code that's executed once the page finished loading */
// Redirect console logs to bridge
window.console.log = (s) => { window.webkit.messageHandlers.log.postMessage(s) }
window.console.warn = (s) => { window.webkit.messageHandlers.warn.postMessage(s) }
window.console.error = (s) => { window.webkit.messageHandlers.error.postMessage(s) }
// Redirect console to bridge
window.console.log = (s) => { window.webkit.messageHandlers.\(FlowBridgeMessage.log.rawValue).postMessage({ tag: 'log', message: s }) }
window.console.debug = (s) => { window.webkit.messageHandlers.\(FlowBridgeMessage.log.rawValue).postMessage({ tag: 'debug', message: s }) }
window.console.info = (s) => { window.webkit.messageHandlers.\(FlowBridgeMessage.log.rawValue).postMessage({ tag: 'info', message: s }) }
window.console.warn = (s) => { window.webkit.messageHandlers.\(FlowBridgeMessage.log.rawValue).postMessage({ tag: 'warn', message: s }) }
window.console.error = (s) => { window.webkit.messageHandlers.\(FlowBridgeMessage.log.rawValue).postMessage({ tag: 'error', message: s }) }
// Finds the Descope web-component in the webpage
function findWebComponent() {
function \(namespace)_find() {
return document.getElementsByTagName('descope-wc')[0]
}
// Called by bridge when the WebView finished loading
function waitWebComponent() {
function \(namespace)_wait() {
document.body.style.background = 'transparent'
const styles = `
* {
-webkit-touch-callout: none;
-webkit-user-select: none;
}
:root {
color-scheme: light dark;
}
Expand All @@ -234,38 +253,51 @@ function waitWebComponent() {
let interval
interval = setInterval(() => {
let component = findWebComponent()
let component = \(namespace)_find()
if (component) {
clearInterval(interval)
prepareWebComponent(component)
\(namespace)_prepare(component)
}
}, 20)
}
// Attaches event listeners once the Descope web-component is ready
function prepareWebComponent(component) {
function \(namespace)_prepare(component) {
const parent = component.parentElement?.parentElement
if (parent) {
parent.style.boxShadow = 'unset'
}
component.addEventListener('ready', () => {
window.webkit.messageHandlers.ready.postMessage('')
component.initNativeState({
platform: 'ios',
oauthProvider: 'apple',
oauthRedirect: 'oauth://redirect',
})
window.webkit.messageHandlers.\(FlowBridgeMessage.ready.rawValue).postMessage('')
})
component.addEventListener('native', (event) => {
window.webkit.messageHandlers.native.postMessage(event.detail)
component.addEventListener('bridge', (event) => {
window.webkit.messageHandlers.\(FlowBridgeMessage.bridge.rawValue).postMessage(event.detail)
})
component.addEventListener('error', (event) => {
window.webkit.messageHandlers.failure.postMessage(event.detail)
window.webkit.messageHandlers.\(FlowBridgeMessage.failure.rawValue).postMessage(event.detail)
})
component.addEventListener('success', (event) => {
window.webkit.messageHandlers.success.postMessage(JSON.stringify(event.detail))
window.webkit.messageHandlers.\(FlowBridgeMessage.success.rawValue).postMessage(JSON.stringify(event.detail))
})
}
// Sends a response from the bridge to complete a native request
function \(namespace)_send(response) {
let component = \(namespace)_find()
if (component) {
component.nativeComplete(response)
}
}
"""

#endif
Loading

0 comments on commit 1e4571c

Please sign in to comment.