Token Migration #2837
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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,111 @@ | ||
| /* | ||
| * Copyright (c) 2026-present, salesforce.com, inc. | ||
| * All rights reserved. | ||
| * Redistribution and use of this software in source and binary forms, with or | ||
| * without modification, are permitted provided that the following conditions | ||
| * are met: | ||
| * - Redistributions of source code must retain the above copyright notice, this | ||
| * list of conditions and the following disclaimer. | ||
| * - Redistributions in binary form must reproduce the above copyright notice, | ||
| * this list of conditions and the following disclaimer in the documentation | ||
| * and/or other materials provided with the distribution. | ||
| * - Neither the name of salesforce.com, inc. nor the names of its contributors | ||
| * may be used to endorse or promote products derived from this software without | ||
| * specific prior written permission of salesforce.com, inc. | ||
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" | ||
| * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
| * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE | ||
| * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR | ||
| * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF | ||
| * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | ||
| * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN | ||
| * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
| * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | ||
| * POSSIBILITY OF SUCH DAMAGE. | ||
| */ | ||
| package com.salesforce.androidsdk.accounts | ||
|
|
||
| import android.content.Intent | ||
| import com.salesforce.androidsdk.accounts.UserAccountManager.getInstance | ||
| import com.salesforce.androidsdk.app.SalesforceSDKManager | ||
| import com.salesforce.androidsdk.config.OAuthConfig | ||
| import com.salesforce.androidsdk.ui.TokenMigrationActivity | ||
| import com.salesforce.androidsdk.util.SalesforceSDKLogger | ||
| import java.util.UUID | ||
|
|
||
| const val TAG = "UserAccountManager" | ||
|
|
||
| /** | ||
| * Attempts to migrate the [userAccount] to the provided Connected App or | ||
| * External Client Application [appConfig]. | ||
| * | ||
| * This might cause the approve/deny screen to be presented to the user to authorize the | ||
| * new app. If successful a new set of credentials (refresh token, access token) are obtained | ||
| * and replace the existing credentials for the user. | ||
| */ | ||
| @Suppress("UnusedReceiverParameter") | ||
| fun UserAccountManager.migrateRefreshToken( | ||
|
Contributor
There was a problem hiding this comment. Taking the success and error callbacks as up-front parameters works so no change required. I wondered if this could benefit from returning a
Contributor
Author
There was a problem hiding this comment. I had the same thought. Originally I had a function in the AppFlowTester's I don't think it makes sense to change the signature to Result since the lambdas passed in flow all the way through |
||
| userAccount: UserAccount? = getInstance().currentUser, | ||
| appConfig: OAuthConfig, | ||
| onMigrationSuccess: (userAccount: UserAccount) -> Unit, | ||
| onMigrationError: (error: String, errorDesc: String?, e: Throwable?) -> Unit, | ||
| ) { | ||
| val loggedOnSuccess: (userAccount: UserAccount) -> Unit = { user -> | ||
| SalesforceSDKLogger.i(TAG, "Token Migration Successful \n\nUser ${user.username} " + | ||
| "(${user.instanceServer}) successfully migrated to: \n$appConfig.") | ||
| onMigrationSuccess.invoke(user) | ||
| } | ||
| val userId = userAccount?.userId | ||
| val orgId = userAccount?.orgId | ||
|
|
||
| if (userId == null || orgId == null) { | ||
| val message = "User account, userId or orgId is null." | ||
| SalesforceSDKLogger.e(TAG, message) | ||
| onMigrationError(message, null, null) | ||
| return | ||
| } | ||
|
|
||
| val callbackKey = MigrationCallbackRegistry.register( | ||
| callbacks = MigrationCallbackRegistry.MigrationCallbacks( | ||
| onMigrationSuccess = loggedOnSuccess, | ||
| onMigrationError = onMigrationError, | ||
| ) | ||
| ) | ||
|
|
||
| with(SalesforceSDKManager.getInstance().appContext) { | ||
| startActivity( | ||
| Intent(/* packageContext = */ this, TokenMigrationActivity::class.java).apply { | ||
| addFlags(Intent.FLAG_ACTIVITY_NEW_TASK) | ||
| putExtra(TokenMigrationActivity.EXTRA_ORG_ID, orgId) | ||
| putExtra(TokenMigrationActivity.EXTRA_USER_ID, userId) | ||
| putExtra(TokenMigrationActivity.EXTRA_OAUTH_CONFIG, appConfig) | ||
| putExtra(TokenMigrationActivity.EXTRA_CALLBACK_ID, callbackKey) | ||
| } | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| /* | ||
| This mechanism is used to pass a _string_ id to the Activity to retrieve callback functions. | ||
|
|
||
| Lambda functions may appear Parcelable/Serializable but since we cannot guarantee the | ||
| content are they should not be passed. For instance, if the lambda function contains | ||
| compose state an exception will be thrown. | ||
| */ | ||
| internal object MigrationCallbackRegistry { | ||
| private val callbacks = mutableMapOf<String, MigrationCallbacks>() | ||
|
|
||
| data class MigrationCallbacks( | ||
| val onMigrationSuccess: (UserAccount) -> Unit, | ||
| val onMigrationError: (String, String?, Throwable?) -> Unit | ||
| ) | ||
|
|
||
| fun register(callbacks: MigrationCallbacks): String { | ||
| val key = UUID.randomUUID().toString() | ||
| this.callbacks[key] = callbacks | ||
| return key | ||
| } | ||
|
|
||
| fun consume(key: String): MigrationCallbacks? = callbacks.remove(key) | ||
| } | ||
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -47,7 +47,6 @@ import com.salesforce.androidsdk.app.SalesforceSDKManager | |
| import com.salesforce.androidsdk.auth.OAuth2.TokenEndpointResponse | ||
| import com.salesforce.androidsdk.auth.OAuth2.addAuthorizationHeader | ||
| import com.salesforce.androidsdk.auth.OAuth2.callIdentityService | ||
| import com.salesforce.androidsdk.config.LoginServerManager | ||
| import com.salesforce.androidsdk.config.RuntimeConfig | ||
| import com.salesforce.androidsdk.config.RuntimeConfig.getRuntimeConfig | ||
|
|
@@ -98,6 +97,7 @@ internal suspend fun onAuthFlowComplete( | |
| onAuthFlowSuccess: (userAccount: UserAccount) -> Unit, | ||
| buildAccountName: (username: String?, instanceServer: String?) -> String = ::defaultBuildAccountName, | ||
| nativeLogin: Boolean = false, | ||
| tokenMigration: Boolean = false, | ||
| context: Context = SalesforceSDKManager.getInstance().appContext, | ||
| userAccountManager: UserAccountManager = SalesforceSDKManager.getInstance().userAccountManager, | ||
| blockIntegrationUser: Boolean = (SalesforceSDKManager.getInstance().shouldBlockSalesforceIntegrationUser && | ||
|
|
@@ -110,7 +110,8 @@ internal suspend fun onAuthFlowComplete( | |
| addAccount: (account: UserAccount) -> Unit = ::addAccountHelper, | ||
| handleScreenLockPolicy: (userIdentity: OAuth2.IdServiceResponse?, account: UserAccount) -> Unit = ::handleScreenLockPolicy, | ||
| handleBiometricAuthPolicy: (userIdentity: OAuth2.IdServiceResponse?, account: UserAccount) -> Unit = ::handleBiometricAuthPolicy, | ||
| handleDuplicateUserAccount: (userAccountManager: UserAccountManager, account: UserAccount, userIdentity: OAuth2.IdServiceResponse?) -> Unit | ||
| = { uam, acct, identity -> com.salesforce.androidsdk.auth.handleDuplicateUserAccount(uam, acct, identity) }, | ||
| ) { | ||
| // Reset Dev Support LoginOptionsActivity override | ||
| SalesforceSDKManager.getInstance().debugOverrideAppConfig = null | ||
|
|
@@ -189,9 +190,11 @@ internal suspend fun onAuthFlowComplete( | |
| } | ||
| userAccountManager.sendUserSwitchIntent(userSwitchType, null) | ||
|
|
||
| if (!tokenMigration) { | ||
| // Kickoff the end of the flow before storing mobile policy to prevent launching | ||
| // the main activity over/after the screen lock. | ||
| startMainActivity() | ||
| } | ||
|
|
||
| // Let the calling process resume | ||
| onAuthFlowSuccess(account) | ||
|
|
@@ -371,36 +374,51 @@ private fun updateLoggingPrefsHelper(account: UserAccount) { | |
| /** | ||
| * Helper method to handle screen lock mobile policy. | ||
| */ | ||
| @VisibleForTesting | ||
| internal fun handleScreenLockPolicy( | ||
| userIdentity: OAuth2.IdServiceResponse?, | ||
| account: UserAccount, | ||
| ) { | ||
| val internalScreenLockManager = | ||
| SalesforceSDKManager.getInstance().screenLockManager as ScreenLockManager? | ||
|
|
||
| // compareTo(0) is used to check if screenLockTimeout is non-null and greater than 0. | ||
| if (userIdentity?.screenLockTimeout?.compareTo(0) == 1) { | ||
| SalesforceSDKManager.getInstance().registerUsedAppFeature(FEATURE_SCREEN_LOCK) | ||
| val timeoutInMills = userIdentity.screenLockTimeout * 1000 * 60 | ||
| internalScreenLockManager?.storeMobilePolicy( | ||
| account, | ||
| enabled = userIdentity.screenLock, | ||
| timeoutInMills, | ||
| ) | ||
| } else if (internalScreenLockManager?.enabled == true) { | ||
| SalesforceSDKManager.getInstance().unregisterUsedAppFeature(FEATURE_SCREEN_LOCK) | ||
| internalScreenLockManager.cleanUp(account) | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Helper method to handle biometric authentication mobile policy. | ||
| */ | ||
| @VisibleForTesting | ||
| internal fun handleBiometricAuthPolicy( | ||
| userIdentity: OAuth2.IdServiceResponse?, | ||
| account: UserAccount, | ||
| ) { | ||
| val internalBiometricAuthenticationManager = | ||
| SalesforceSDKManager.getInstance().biometricAuthenticationManager as BiometricAuthenticationManager? | ||
|
|
||
| if (userIdentity?.biometricAuth == true) { | ||
| SalesforceSDKManager.getInstance().registerUsedAppFeature(FEATURE_BIOMETRIC_AUTH) | ||
| val timeoutInMills = userIdentity.biometricAuthTimeout * 60 * 1000 | ||
| internalBiometricAuthenticationManager?.storeMobilePolicy( | ||
| account, | ||
| enabled = userIdentity.biometricAuth, | ||
| timeoutInMills | ||
| ) | ||
| } else if (internalBiometricAuthenticationManager?.enabled == true) { | ||
| SalesforceSDKManager.getInstance().unregisterUsedAppFeature(FEATURE_BIOMETRIC_AUTH) | ||
| internalBiometricAuthenticationManager.cleanUp(account) | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -426,10 +444,12 @@ private fun addAccountHelper( | |
| * - Unlocking biometric authentication for the duplicate user | ||
| * - Signing out other users with biometric auth when a new biometric user is added | ||
| */ | ||
| @VisibleForTesting | ||
| internal fun handleDuplicateUserAccount( | ||
| userAccountManager: UserAccountManager, | ||
| account: UserAccount, | ||
| userIdentity: OAuth2.IdServiceResponse?, | ||
| revokeRefreshToken: (HttpAccess, URI, String, OAuth2.LogoutReason) -> Unit = OAuth2::revokeRefreshToken, | ||
| ) { | ||
| userAccountManager.authenticatedUsers?.let { existingUsers -> | ||
| // Check if the user already exists | ||
|
|
@@ -451,14 +471,12 @@ private fun handleDuplicateUserAccount( | |
| as? BiometricAuthenticationManager)?.onUnlock() | ||
| } | ||
| CoroutineScope(IO).launch { | ||
| revokeRefreshToken( | ||
| HttpAccess.DEFAULT, | ||
| uri, | ||
| duplicateUserAccount.refreshToken, | ||
| OAuth2.LogoutReason.REFRESH_TOKEN_ROTATED, | ||
| ) | ||
| } | ||
| } | ||
| } | ||
|
|
||
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -133,6 +133,7 @@ public class OAuth2 { | |
| private static final String QUESTION = "?"; | ||
| private static final String TOUCH = "touch"; | ||
| private static final String FRONTDOOR = "/secur/frontdoor.jsp?"; | ||
| public static final String FRONTDOOR_URL_KEY = "frontdoor_uri"; | ||
| private static final String SID = "sid"; | ||
| private static final String RETURL = "retURL"; | ||
| protected static final String AUTHORIZATION = "Authorization"; | ||
|
|
||
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -33,6 +33,7 @@ import android.webkit.WebViewClient | |
| import com.salesforce.androidsdk.R | ||
| import com.salesforce.androidsdk.accounts.UserAccount | ||
| import com.salesforce.androidsdk.app.SalesforceSDKManager | ||
| import com.salesforce.androidsdk.auth.OAuth2.FRONTDOOR_URL_KEY | ||
| import com.salesforce.androidsdk.auth.OAuth2.getAuthorizationUrl | ||
| import com.salesforce.androidsdk.rest.ClientManager | ||
| import com.salesforce.androidsdk.rest.RestClient | ||
|
|
@@ -132,7 +133,7 @@ internal class IDPAuthCodeHelper private constructor( | |
| SalesforceSDKLogger.e(TAG, "Failed to obtain valid front door url", e) | ||
| null | ||
| } | ||
| return if (restResponse == null || !restResponse.isSuccess) null else restResponse.asJSONObject().getString(FRONTDOOR_URL_KEY) | ||
| } | ||
|
|
||
| private fun onError(error: String, exception: java.lang.Exception? = null) { | ||
|
|
||
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -26,11 +26,15 @@ | |
| */ | ||
| package com.salesforce.androidsdk.config | ||
|
|
||
| import android.os.Parcelable | ||
| import kotlinx.parcelize.Parcelize | ||
|
|
||
| @Parcelize | ||
|
Contributor
Author
There was a problem hiding this comment. This is Kotlin magic ✨. The compiler is able to implement the required functions to satisfy the We should do this for |
||
| data class OAuthConfig( | ||
| val consumerKey: String, | ||
| val redirectUri: String, | ||
| val scopes: List<String>? = null, | ||
| ): Parcelable { | ||
|
|
||
| internal constructor(bootConfig: BootConfig): this( | ||
| bootConfig.remoteAccessConsumerKey, | ||
|
|
||
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.
Should I rename this style to something more generic?