Support Process Death in WebAuthProvider (#784)

pmathew92 · web-flow · commit b9bfe0a703af · 2025-02-11T10:19:24.000+05:30
diff --git a/auth0/src/main/java/com/auth0/android/provider/AuthenticationActivity.kt b/auth0/src/main/java/com/auth0/android/provider/AuthenticationActivity.kt
@@ -34,11 +34,13 @@ public open class AuthenticationActivity : Activity() {
     override fun onSaveInstanceState(outState: Bundle) {
         super.onSaveInstanceState(outState)
         outState.putBoolean(EXTRA_INTENT_LAUNCHED, intentLaunched)
+        WebAuthProvider.onSaveInstanceState(outState)
     }
 
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
         if (savedInstanceState != null) {
+            WebAuthProvider.onRestoreInstanceState(savedInstanceState)
             intentLaunched = savedInstanceState.getBoolean(EXTRA_INTENT_LAUNCHED, false)
         }
     }
diff --git a/auth0/src/main/java/com/auth0/android/provider/OAuthManager.kt b/auth0/src/main/java/com/auth0/android/provider/OAuthManager.kt
@@ -2,6 +2,7 @@ package com.auth0.android.provider
 
 import android.content.Context
 import android.net.Uri
+import android.os.Bundle
 import android.text.TextUtils
 import android.util.Base64
 import android.util.Log
@@ -186,6 +187,19 @@ internal class OAuthManager(
         SignatureVerifier.forAsymmetricAlgorithm(tokenKeyId, apiClient, signatureVerifierCallback)
     }
 
+    internal fun toState(): OAuthManagerState {
+        return OAuthManagerState(
+            parameters = parameters.toMap(),
+            headers = headers.toMap(),
+            requestCode = requestCode,
+            ctOptions = ctOptions,
+            pkce = pkce,
+            auth0 = account,
+            idTokenVerificationIssuer = idTokenVerificationIssuer,
+            idTokenVerificationLeeway = idTokenVerificationLeeway,
+        )
+    }
+
     //Helper Methods
     @Throws(AuthenticationException::class)
     private fun assertNoError(errorValue: String?, errorDescription: String?) {
@@ -333,4 +347,23 @@ internal class OAuthManager(
         apiClient = AuthenticationAPIClient(account)
         this.ctOptions = ctOptions
     }
+}
+
+internal fun OAuthManager.Companion.fromState(
+    state: OAuthManagerState,
+    callback: Callback<Credentials, AuthenticationException>
+): OAuthManager {
+    return OAuthManager(
+        account = state.auth0,
+        ctOptions = state.ctOptions,
+        parameters = state.parameters,
+        callback = callback
+    ).apply {
+        setHeaders(
+            state.headers
+        )
+        setPKCE(state.pkce)
+        setIdTokenVerificationIssuer(state.idTokenVerificationIssuer)
+        setIdTokenVerificationLeeway(state.idTokenVerificationLeeway)
+    }
 }
diff --git a/auth0/src/main/java/com/auth0/android/provider/OAuthManagerState.kt b/auth0/src/main/java/com/auth0/android/provider/OAuthManagerState.kt
@@ -0,0 +1,112 @@
+package com.auth0.android.provider
+
+import android.os.Parcel
+import android.os.Parcelable
+import android.util.Base64
+import androidx.core.os.ParcelCompat
+import com.auth0.android.Auth0
+import com.auth0.android.authentication.AuthenticationAPIClient
+import com.auth0.android.request.internal.GsonProvider
+import com.google.gson.Gson
+
+internal data class OAuthManagerState(
+    val auth0: Auth0,
+    val parameters: Map<String, String>,
+    val headers: Map<String, String>,
+    val requestCode: Int = 0,
+    val ctOptions: CustomTabsOptions,
+    val pkce: PKCE?,
+    val idTokenVerificationLeeway: Int?,
+    val idTokenVerificationIssuer: String?
+) {
+
+    private class OAuthManagerJson(
+        val auth0ClientId: String,
+        val auth0DomainUrl: String,
+        val auth0ConfigurationUrl: String?,
+        val parameters: Map<String, String>,
+        val headers: Map<String, String>,
+        val requestCode: Int = 0,
+        val ctOptions: String,
+        val redirectUri: String,
+        val codeChallenge: String,
+        val codeVerifier: String,
+        val idTokenVerificationLeeway: Int?,
+        val idTokenVerificationIssuer: String?
+    )
+
+    fun serializeToJson(
+        gson: Gson = GsonProvider.gson,
+    ): String {
+        val parcel = Parcel.obtain()
+        try {
+            parcel.writeParcelable(ctOptions, Parcelable.PARCELABLE_WRITE_RETURN_VALUE)
+            val ctOptionsEncoded = Base64.encodeToString(parcel.marshall(), Base64.DEFAULT)
+
+            val json = OAuthManagerJson(
+                auth0ClientId = auth0.clientId,
+                auth0ConfigurationUrl = auth0.configurationDomain,
+                auth0DomainUrl = auth0.domain,
+                parameters = parameters,
+                headers = headers,
+                requestCode = requestCode,
+                ctOptions = ctOptionsEncoded,
+                redirectUri = pkce?.redirectUri.orEmpty(),
+                codeVerifier = pkce?.codeVerifier.orEmpty(),
+                codeChallenge = pkce?.codeChallenge.orEmpty(),
+                idTokenVerificationIssuer = idTokenVerificationIssuer,
+                idTokenVerificationLeeway = idTokenVerificationLeeway,
+            )
+            return gson.toJson(json)
+        } finally {
+            parcel.recycle()
+        }
+    }
+
+    companion object {
+        fun deserializeState(
+            json: String,
+            gson: Gson = GsonProvider.gson,
+        ): OAuthManagerState {
+            val parcel = Parcel.obtain()
+            try {
+                val oauthManagerJson = gson.fromJson(json, OAuthManagerJson::class.java)
+
+                val decodedCtOptionsBytes = Base64.decode(oauthManagerJson.ctOptions, Base64.DEFAULT)
+                parcel.unmarshall(decodedCtOptionsBytes, 0, decodedCtOptionsBytes.size)
+                parcel.setDataPosition(0)
+
+                val customTabsOptions = ParcelCompat.readParcelable(
+                    parcel,
+                    CustomTabsOptions::class.java.classLoader,
+                    CustomTabsOptions::class.java
+                ) ?: error("Couldn't deserialize from Parcel")
+
+                val auth0 = Auth0.getInstance(
+                    clientId = oauthManagerJson.auth0ClientId,
+                    domain = oauthManagerJson.auth0DomainUrl,
+                    configurationDomain = oauthManagerJson.auth0ConfigurationUrl,
+                )
+
+                return OAuthManagerState(
+                    auth0 = auth0,
+                    parameters = oauthManagerJson.parameters,
+                    headers = oauthManagerJson.headers,
+                    requestCode = oauthManagerJson.requestCode,
+                    ctOptions = customTabsOptions,
+                    pkce = PKCE(
+                        AuthenticationAPIClient(auth0),
+                        oauthManagerJson.codeVerifier,
+                        oauthManagerJson.redirectUri,
+                        oauthManagerJson.codeChallenge,
+                        oauthManagerJson.headers,
+                    ),
+                    idTokenVerificationIssuer = oauthManagerJson.idTokenVerificationIssuer,
+                    idTokenVerificationLeeway = oauthManagerJson.idTokenVerificationLeeway,
+                )
+            } finally {
+                parcel.recycle()
+            }
+        }
+    }
+}
diff --git a/auth0/src/main/java/com/auth0/android/provider/PKCE.java b/auth0/src/main/java/com/auth0/android/provider/PKCE.java
@@ -47,6 +47,18 @@ public PKCE(@NonNull AuthenticationAPIClient apiClient, String redirectUri, @Non
         this.headers = headers;
     }
 
+    PKCE(@NonNull AuthenticationAPIClient apiClient,
+                @NonNull String codeVerifier,
+                @NonNull String redirectUri,
+                @NonNull String codeChallenge,
+                @NonNull Map<String, String> headers) {
+        this.apiClient = apiClient;
+        this.codeVerifier = codeVerifier;
+        this.redirectUri = redirectUri;
+        this.codeChallenge = codeChallenge;
+        this.headers = headers;
+    }
+
     /**
      * Returns the Code Challenge generated using a Code Verifier.
      *
@@ -56,6 +68,14 @@ public String getCodeChallenge() {
         return codeChallenge;
     }
 
+    public String getCodeVerifier() {
+        return codeVerifier;
+    }
+
+    public String getRedirectUri() {
+        return redirectUri;
+    }
+
     /**
      * Performs a request to the Auth0 API to get the OAuth Token and end the PKCE flow.
      * The instance of this class must be disposed after this method is called.
diff --git a/auth0/src/main/java/com/auth0/android/provider/WebAuthProvider.kt b/auth0/src/main/java/com/auth0/android/provider/WebAuthProvider.kt
@@ -3,6 +3,7 @@ package com.auth0.android.provider
 import android.content.Context
 import android.content.Intent
 import android.net.Uri
+import android.os.Bundle
 import android.util.Log
 import androidx.annotation.VisibleForTesting
 import com.auth0.android.Auth0
@@ -14,6 +15,7 @@ import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.suspendCancellableCoroutine
 import kotlinx.coroutines.withContext
 import java.util.Locale
+import java.util.concurrent.CopyOnWriteArraySet
 import kotlin.coroutines.CoroutineContext
 import kotlin.coroutines.resume
 import kotlin.coroutines.resumeWithException
@@ -26,12 +28,25 @@ import kotlin.coroutines.resumeWithException
  */
 public object WebAuthProvider {
     private val TAG: String? = WebAuthProvider::class.simpleName
+    private const val KEY_BUNDLE_OAUTH_MANAGER_STATE = "oauth_manager_state"
+
+    private val callbacks = CopyOnWriteArraySet<Callback<Credentials, AuthenticationException>>()
 
     @JvmStatic
     @get:VisibleForTesting(otherwise = VisibleForTesting.PRIVATE)
     internal var managerInstance: ResumableManager? = null
         private set
 
+    @JvmStatic
+    public fun addCallback(callback: Callback<Credentials, AuthenticationException>) {
+        callbacks += callback
+    }
+
+    @JvmStatic
+    public fun removeCallback(callback: Callback<Credentials, AuthenticationException>) {
+        callbacks -= callback
+    }
+
     // Public methods
     /**
      * Initialize the WebAuthProvider instance for logging out the user using an account. Additional settings can be configured
@@ -89,6 +104,39 @@ public object WebAuthProvider {
         managerInstance!!.failure(exception)
     }
 
+    internal fun onSaveInstanceState(bundle: Bundle) {
+        val manager = managerInstance
+        if (manager is OAuthManager) {
+            val managerState = manager.toState()
+            bundle.putString(KEY_BUNDLE_OAUTH_MANAGER_STATE, managerState.serializeToJson())
+        }
+    }
+
+    internal fun onRestoreInstanceState(bundle: Bundle) {
+        if (managerInstance == null) {
+            val stateJson = bundle.getString(KEY_BUNDLE_OAUTH_MANAGER_STATE).orEmpty()
+            if (stateJson.isNotBlank()) {
+                val state = OAuthManagerState.deserializeState(stateJson)
+                managerInstance = OAuthManager.fromState(
+                    state,
+                    object : Callback<Credentials, AuthenticationException> {
+                        override fun onSuccess(result: Credentials) {
+                            for (callback in callbacks) {
+                                callback.onSuccess(result)
+                            }
+                        }
+
+                        override fun onFailure(error: AuthenticationException) {
+                            for (callback in callbacks) {
+                                callback.onFailure(error)
+                            }
+                        }
+                    }
+                )
+            }
+        }
+    }
+
     @JvmStatic
     @VisibleForTesting(otherwise = VisibleForTesting.PRIVATE)
     internal fun resetManagerInstance() {
diff --git a/auth0/src/test/java/com/auth0/android/provider/OAuthManagerStateTest.kt b/auth0/src/test/java/com/auth0/android/provider/OAuthManagerStateTest.kt
@@ -0,0 +1,47 @@
+package com.auth0.android.provider
+
+import android.graphics.Color
+import com.auth0.android.Auth0
+import com.nhaarman.mockitokotlin2.mock
+import org.junit.Assert
+import org.junit.Test
+import org.junit.runner.RunWith
+import org.robolectric.RobolectricTestRunner
+
+@RunWith(RobolectricTestRunner::class)
+internal class OAuthManagerStateTest {
+
+    @Test
+    fun `serialize should work`() {
+        val auth0 = Auth0.getInstance("clientId", "domain")
+        val state = OAuthManagerState(
+            auth0 = auth0,
+            parameters = mapOf("param1" to "value1"),
+            headers = mapOf("header1" to "value1"),
+            requestCode = 1,
+            ctOptions = CustomTabsOptions.newBuilder()
+                .showTitle(true)
+                .withToolbarColor(Color.RED)
+                .withBrowserPicker(
+                    BrowserPicker.newBuilder().withAllowedPackages(emptyList()).build()
+                )
+                .build(),
+            pkce = PKCE(mock(), "redirectUri", mapOf("header1" to "value1")),
+            idTokenVerificationLeeway = 1,
+            idTokenVerificationIssuer = "issuer"
+        )
+
+        val json = state.serializeToJson()
+
+        Assert.assertTrue(json.isNotBlank())
+
+        val deserializedState = OAuthManagerState.deserializeState(json)
+
+        Assert.assertEquals(mapOf("param1" to "value1"), deserializedState.parameters)
+        Assert.assertEquals(mapOf("header1" to "value1"), deserializedState.headers)
+        Assert.assertEquals(1, deserializedState.requestCode)
+        Assert.assertEquals("redirectUri", deserializedState.pkce?.redirectUri)
+        Assert.assertEquals(1, deserializedState.idTokenVerificationLeeway)
+        Assert.assertEquals("issuer", deserializedState.idTokenVerificationIssuer)
+    }
+}
diff --git a/sample/src/main/java/com/auth0/sample/DatabaseLoginFragment.kt b/sample/src/main/java/com/auth0/sample/DatabaseLoginFragment.kt
@@ -102,6 +102,22 @@ class DatabaseLoginFragment : Fragment() {
             .setDeviceCredentialFallback(true)
             .build()
 
+    private val callback = object: Callback<Credentials, AuthenticationException> {
+        override fun onSuccess(result: Credentials) {
+            credentialsManager.saveCredentials(result)
+            Snackbar.make(
+                requireView(),
+                "Hello ${result.user.name}",
+                Snackbar.LENGTH_LONG
+            ).show()
+        }
+
+        override fun onFailure(error: AuthenticationException) {
+            Snackbar.make(requireView(), error.getDescription(), Snackbar.LENGTH_LONG)
+                .show()
+        }
+    }
+
     override fun onCreateView(
         inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?
     ): View {
@@ -188,6 +204,16 @@ class DatabaseLoginFragment : Fragment() {
         return binding.root
     }
 
+    override fun onStart() {
+        super.onStart()
+        WebAuthProvider.addCallback(callback)
+    }
+
+    override fun onStop() {
+        super.onStop()
+        WebAuthProvider.removeCallback(callback)
+    }
+
     private suspend fun dbLoginAsync(email: String, password: String) {
         try {
             val result =

Original file line number	Diff line number	Diff line change
`@@ -34,11 +34,13 @@ public open class AuthenticationActivity : Activity() {`
`34`	`34`	`override fun onSaveInstanceState(outState: Bundle) {`
`35`	`35`	`super.onSaveInstanceState(outState)`
`36`	`36`	`outState.putBoolean(EXTRA_INTENT_LAUNCHED, intentLaunched)`
	`37`	`+ WebAuthProvider.onSaveInstanceState(outState)`
`37`	`38`	`}`
`38`	`39`
`39`	`40`	`override fun onCreate(savedInstanceState: Bundle?) {`
`40`	`41`	`super.onCreate(savedInstanceState)`
`41`	`42`	`if (savedInstanceState != null) {`
	`43`	`+ WebAuthProvider.onRestoreInstanceState(savedInstanceState)`
`42`	`44`	`intentLaunched = savedInstanceState.getBoolean(EXTRA_INTENT_LAUNCHED, false)`
`43`	`45`	`}`
`44`	`46`	`}`